Compare commits

...

3 Commits

Author SHA1 Message Date
Xe Iaso
9a95031711 fix: SERVE_ROBOTS_TXT works again
Signed-off-by: Xe Iaso <me@xeiaso.net>
2025-10-31 08:52:43 -04:00
Xe Iaso
62c1b80189 chore: tag v1.23.0
Signed-off-by: Xe Iaso <me@xeiaso.net>
2025-10-29 20:38:34 -04:00
Xe Iaso
7ed1753fcc fix(lib): close open redirect when in subrequest mode (#1222)
* test(nginx-external-auth): bring up to code standards

Signed-off-by: Xe Iaso <me@xeiaso.net>

* fix(lib): close open redirect when in subrequest mode

Closes GHSA-cf57-c578-7jvv

Previously Anubis had an open redirect in subrequest auth mode due to an
insufficent fix in GHSA-jhjj-2g64-px7c. This patch adds additional
validation at several steps of the flow to prevent open redirects in
subrequest auth mode as well as implements automated testing to prevent
this from occuring in the future.

* docs: update CHANGELOG

Signed-off-by: Xe Iaso <me@xeiaso.net>

---------

Signed-off-by: Xe Iaso <me@xeiaso.net>
2025-10-29 16:07:31 -04:00
16 changed files with 461 additions and 68 deletions

View File

@@ -23,6 +23,7 @@ jobs:
- i18n
- palemoon/amd64
#- palemoon/i386
- robots_txt
runs-on: ubuntu-latest
steps:
- name: Checkout code

View File

@@ -1 +1 @@
1.23.0-pre2
1.23.0

View File

@@ -13,6 +13,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
<!-- This changes the project to: -->
- Fix `SERVE_ROBOTS_TXT` setting file after the double slash fix broke it.
## v1.23.0: Lyse Hext
- Add default tencent cloud DENY rule.
@@ -40,6 +42,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Allow multiple consecutive slashes in a row in application paths ([#754](https://github.com/TecharoHQ/anubis/issues/754)).
- Add option to set `targetSNI` to special keyword 'auto' to indicate that it should be automatically set to the request Host name ([424](https://github.com/TecharoHQ/anubis/issues/424)).
- The Preact challenge has been removed from the default configuration. It will be deprecated in the future.
- An open redirect when in subrequest mode has been fixed.
### Potentially breaking changes

View File

@@ -296,6 +296,16 @@ func (s *Server) constructRedirectURL(r *http.Request) (string, error) {
if proto == "" || host == "" || uri == "" {
return "", errors.New(localizer.T("missing_required_forwarded_headers"))
}
switch proto {
case "http", "https":
// allowed
default:
lg := internal.GetRequestLogger(s.logger, r)
lg.Warn("invalid protocol in X-Forwarded-Proto", "proto", proto)
return "", errors.New(localizer.T("invalid_redirect"))
}
// Check if host is allowed in RedirectDomains (supports '*' via glob)
if len(s.opts.RedirectDomains) > 0 && !matchRedirectDomain(s.opts.RedirectDomains, host) {
lg := internal.GetRequestLogger(s.logger, r)
@@ -335,6 +345,15 @@ func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
return
}
// Forward robots.txt requests to mux when ServeRobotsTXT is enabled
if s.opts.ServeRobotsTXT {
path := strings.TrimPrefix(r.URL.Path, anubis.BasePrefix)
if path == "/robots.txt" || path == "/.well-known/robots.txt" {
s.mux.ServeHTTP(w, r)
return
}
}
s.maybeReverseProxyOrPage(w, r)
}
@@ -369,16 +388,31 @@ func (s *Server) ServeHTTPNext(w http.ResponseWriter, r *http.Request) {
localizer := localization.GetLocalizer(r)
redir := r.FormValue("redir")
urlParsed, err := r.URL.Parse(redir)
urlParsed, err := url.ParseRequestURI(redir)
if err != nil {
s.respondWithStatus(w, r, localizer.T("redirect_not_parseable"), makeCode(err), http.StatusBadRequest)
// if ParseRequestURI fails, try as relative URL
urlParsed, err = r.URL.Parse(redir)
if err != nil {
s.respondWithStatus(w, r, localizer.T("redirect_not_parseable"), makeCode(err), http.StatusBadRequest)
return
}
}
// validate URL scheme to prevent javascript:, data:, file:, tel:, etc.
switch urlParsed.Scheme {
case "", "http", "https":
// allowed: empty scheme means relative URL
default:
lg := internal.GetRequestLogger(s.logger, r)
lg.Warn("XSS attempt blocked, invalid redirect scheme", "scheme", urlParsed.Scheme, "redir", redir)
s.respondWithStatus(w, r, localizer.T("invalid_redirect"), "", http.StatusBadRequest)
return
}
hostNotAllowed := len(urlParsed.Host) > 0 &&
len(s.opts.RedirectDomains) != 0 &&
!matchRedirectDomain(s.opts.RedirectDomains, urlParsed.Host)
hostMismatch := r.URL.Host != "" && urlParsed.Host != r.URL.Host
hostMismatch := r.URL.Host != "" && urlParsed.Host != "" && urlParsed.Host != r.URL.Host
if hostNotAllowed || hostMismatch {
lg := internal.GetRequestLogger(s.logger, r)

View File

@@ -0,0 +1,296 @@
package lib
import (
"log/slog"
"net/http"
"net/http/httptest"
"net/url"
"strings"
"testing"
"github.com/TecharoHQ/anubis/lib/policy"
)
func TestRedirectSecurity(t *testing.T) {
tests := []struct {
name string
testType string // "constructRedirectURL", "serveHTTPNext", "renderIndex"
// For constructRedirectURL tests
xForwardedProto string
xForwardedHost string
xForwardedUri string
// For serveHTTPNext tests
redirParam string
reqHost string
// For renderIndex tests
returnHTTPStatusOnly bool
// Expected results
expectedStatus int
shouldError bool
shouldNotRedirect bool
shouldBlock bool
errorContains string
}{
// constructRedirectURL tests - X-Forwarded-Proto validation
{
name: "constructRedirectURL: javascript protocol should be rejected",
testType: "constructRedirectURL",
xForwardedProto: "javascript",
xForwardedHost: "example.com",
xForwardedUri: "alert(1)",
shouldError: true,
errorContains: "invalid",
},
{
name: "constructRedirectURL: data protocol should be rejected",
testType: "constructRedirectURL",
xForwardedProto: "data",
xForwardedHost: "text/html",
xForwardedUri: ",<script>alert(1)</script>",
shouldError: true,
errorContains: "invalid",
},
{
name: "constructRedirectURL: file protocol should be rejected",
testType: "constructRedirectURL",
xForwardedProto: "file",
xForwardedHost: "",
xForwardedUri: "/etc/passwd",
shouldError: true,
errorContains: "invalid",
},
{
name: "constructRedirectURL: ftp protocol should be rejected",
testType: "constructRedirectURL",
xForwardedProto: "ftp",
xForwardedHost: "example.com",
xForwardedUri: "/file.txt",
shouldError: true,
errorContains: "invalid",
},
{
name: "constructRedirectURL: https protocol should be allowed",
testType: "constructRedirectURL",
xForwardedProto: "https",
xForwardedHost: "example.com",
xForwardedUri: "/foo",
shouldError: false,
},
{
name: "constructRedirectURL: http protocol should be allowed",
testType: "constructRedirectURL",
xForwardedProto: "http",
xForwardedHost: "example.com",
xForwardedUri: "/bar",
shouldError: false,
},
// serveHTTPNext tests - redir parameter validation
{
name: "serveHTTPNext: javascript: URL should be rejected",
testType: "serveHTTPNext",
redirParam: "javascript:alert(1)",
reqHost: "example.com",
expectedStatus: http.StatusBadRequest,
shouldNotRedirect: true,
},
{
name: "serveHTTPNext: data: URL should be rejected",
testType: "serveHTTPNext",
redirParam: "data:text/html,<script>alert(1)</script>",
reqHost: "example.com",
expectedStatus: http.StatusBadRequest,
shouldNotRedirect: true,
},
{
name: "serveHTTPNext: file: URL should be rejected",
testType: "serveHTTPNext",
redirParam: "file:///etc/passwd",
reqHost: "example.com",
expectedStatus: http.StatusBadRequest,
shouldNotRedirect: true,
},
{
name: "serveHTTPNext: vbscript: URL should be rejected",
testType: "serveHTTPNext",
redirParam: "vbscript:msgbox(1)",
reqHost: "example.com",
expectedStatus: http.StatusBadRequest,
shouldNotRedirect: true,
},
{
name: "serveHTTPNext: valid https URL should work",
testType: "serveHTTPNext",
redirParam: "https://example.com/foo",
reqHost: "example.com",
expectedStatus: http.StatusFound,
},
{
name: "serveHTTPNext: valid relative URL should work",
testType: "serveHTTPNext",
redirParam: "/foo/bar",
reqHost: "example.com",
expectedStatus: http.StatusFound,
},
{
name: "serveHTTPNext: external domain should be blocked",
testType: "serveHTTPNext",
redirParam: "https://evil.com/phishing",
reqHost: "example.com",
expectedStatus: http.StatusBadRequest,
shouldBlock: true,
},
{
name: "serveHTTPNext: relative path should work",
testType: "serveHTTPNext",
redirParam: "/safe/path",
reqHost: "example.com",
expectedStatus: http.StatusFound,
},
{
name: "serveHTTPNext: empty redir should show success page",
testType: "serveHTTPNext",
redirParam: "",
reqHost: "example.com",
expectedStatus: http.StatusOK,
},
// renderIndex tests - full subrequest auth flow
{
name: "renderIndex: javascript protocol in X-Forwarded-Proto",
testType: "renderIndex",
xForwardedProto: "javascript",
xForwardedHost: "example.com",
xForwardedUri: "alert(1)",
returnHTTPStatusOnly: true,
expectedStatus: http.StatusBadRequest,
},
{
name: "renderIndex: data protocol in X-Forwarded-Proto",
testType: "renderIndex",
xForwardedProto: "data",
xForwardedHost: "example.com",
xForwardedUri: "text/html,<script>alert(1)</script>",
returnHTTPStatusOnly: true,
expectedStatus: http.StatusBadRequest,
},
{
name: "renderIndex: valid https redirect",
testType: "renderIndex",
xForwardedProto: "https",
xForwardedHost: "example.com",
xForwardedUri: "/protected/page",
returnHTTPStatusOnly: true,
expectedStatus: http.StatusTemporaryRedirect,
},
}
s := &Server{
opts: Options{
PublicUrl: "https://anubis.example.com",
RedirectDomains: []string{},
},
logger: slog.Default(),
policy: &policy.ParsedConfig{},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
switch tt.testType {
case "constructRedirectURL":
req := httptest.NewRequest("GET", "/", nil)
req.Header.Set("X-Forwarded-Proto", tt.xForwardedProto)
req.Header.Set("X-Forwarded-Host", tt.xForwardedHost)
req.Header.Set("X-Forwarded-Uri", tt.xForwardedUri)
redirectURL, err := s.constructRedirectURL(req)
if tt.shouldError {
if err == nil {
t.Errorf("expected error containing %q, got nil", tt.errorContains)
t.Logf("got redirect URL: %s", redirectURL)
} else if tt.errorContains != "" && !strings.Contains(err.Error(), tt.errorContains) {
t.Logf("expected error containing %q, got: %v", tt.errorContains, err)
}
} else {
if err != nil {
t.Errorf("expected no error, got: %v", err)
}
// Verify the redirect URL is safe
if redirectURL != "" {
parsed, err := url.Parse(redirectURL)
if err != nil {
t.Errorf("failed to parse redirect URL: %v", err)
}
redirParam := parsed.Query().Get("redir")
if redirParam != "" {
redirParsed, err := url.Parse(redirParam)
if err != nil {
t.Errorf("failed to parse redir parameter: %v", err)
}
if redirParsed.Scheme != "http" && redirParsed.Scheme != "https" {
t.Errorf("redir parameter has unsafe scheme: %s", redirParsed.Scheme)
}
}
}
}
case "serveHTTPNext":
req := httptest.NewRequest("GET", "/.within.website/?redir="+url.QueryEscape(tt.redirParam), nil)
req.Host = tt.reqHost
req.URL.Host = tt.reqHost
rr := httptest.NewRecorder()
s.ServeHTTPNext(rr, req)
if rr.Code != tt.expectedStatus {
t.Errorf("expected status %d, got %d", tt.expectedStatus, rr.Code)
t.Logf("body: %s", rr.Body.String())
}
if tt.shouldNotRedirect {
location := rr.Header().Get("Location")
if location != "" {
t.Errorf("expected no redirect, but got Location header: %s", location)
}
}
if tt.shouldBlock {
location := rr.Header().Get("Location")
if location != "" && strings.Contains(location, "evil.com") {
t.Errorf("redirect to evil.com was not blocked: %s", location)
}
}
case "renderIndex":
req := httptest.NewRequest("GET", "/", nil)
req.Header.Set("X-Forwarded-Proto", tt.xForwardedProto)
req.Header.Set("X-Forwarded-Host", tt.xForwardedHost)
req.Header.Set("X-Forwarded-Uri", tt.xForwardedUri)
rr := httptest.NewRecorder()
s.RenderIndex(rr, req, policy.CheckResult{}, nil, tt.returnHTTPStatusOnly)
if rr.Code != tt.expectedStatus {
t.Errorf("expected status %d, got %d", tt.expectedStatus, rr.Code)
}
if tt.expectedStatus == http.StatusTemporaryRedirect {
location := rr.Header().Get("Location")
if location == "" {
t.Error("expected Location header, got none")
} else {
// Verify the location doesn't contain javascript:
if strings.Contains(location, "javascript") {
t.Errorf("Location header contains 'javascript': %s", location)
}
}
}
}
})
}
}

4
package-lock.json generated
View File

@@ -1,12 +1,12 @@
{
"name": "@techaro/anubis",
"version": "1.23.0-pre2",
"version": "1.23.0",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "@techaro/anubis",
"version": "1.23.0-pre2",
"version": "1.23.0",
"license": "ISC",
"dependencies": {
"@aws-crypto/sha256-js": "^5.2.0",

View File

@@ -1,6 +1,6 @@
{
"name": "@techaro/anubis",
"version": "1.23.0-pre2",
"version": "1.23.0",
"description": "",
"main": "index.js",
"scripts": {

View File

@@ -12,39 +12,37 @@ spec:
app: nginx-external-auth
spec:
volumes:
- name: config
configMap:
name: nginx-cfg
containers:
- name: www
image: nginx:alpine
resources:
limits:
memory: "128Mi"
cpu: "500m"
requests:
memory: "128Mi"
cpu: "500m"
ports:
- containerPort: 80
volumeMounts:
- name: config
mountPath: /etc/nginx/conf.d
readOnly: true
- name: anubis
image: ttl.sh/techaro/anubis-external-auth:latest
imagePullPolicy: Always
resources:
limits:
cpu: 500m
memory: 128Mi
requests:
cpu: 250m
memory: 128Mi
env:
- name: TARGET
value: " "
- name: REDIRECT_DOMAINS
value: nginx.local.cetacean.club
configMap:
name: nginx-cfg
containers:
- name: www
image: nginx:alpine
resources:
limits:
memory: "128Mi"
cpu: "500m"
requests:
memory: "128Mi"
cpu: "500m"
ports:
- containerPort: 80
volumeMounts:
- name: config
mountPath: /etc/nginx/conf.d
readOnly: true
- name: anubis
image: ttl.sh/techaro/anubis:latest
imagePullPolicy: Always
resources:
limits:
cpu: 500m
memory: 128Mi
requests:
cpu: 250m
memory: 128Mi
env:
- name: TARGET
value: " "
- name: REDIRECT_DOMAINS
value: nginx.local.cetacean.club

View File

@@ -9,17 +9,17 @@ metadata:
spec:
ingressClassName: traefik
tls:
- hosts:
- nginx.local.cetacean.club
secretName: nginx-local-cetacean-club-public-tls
- hosts:
- nginx.local.cetacean.club
secretName: nginx-local-cetacean-club-public-tls
rules:
- host: nginx.local.cetacean.club
http:
paths:
- pathType: Prefix
path: "/"
backend:
service:
name: nginx-external-auth
port:
name: http
- host: nginx.local.cetacean.club
http:
paths:
- pathType: Prefix
path: "/"
backend:
service:
name: nginx-external-auth
port:
name: http

View File

@@ -7,4 +7,4 @@ configMapGenerator:
- name: nginx-cfg
behavior: create
files:
- ./conf.d/default.conf
- ./conf.d/default.conf

View File

@@ -6,8 +6,8 @@ spec:
selector:
app: nginx-external-auth
ports:
- name: http
protocol: TCP
port: 80
targetPort: 80
- name: http
protocol: TCP
port: 80
targetPort: 80
type: ClusterIP

View File

@@ -4,20 +4,20 @@ set -euo pipefail
# Build container image
(
cd ../.. \
&& npm ci \
&& npm run container -- \
--docker-repo ttl.sh/techaro/anubis-external-auth \
--docker-tags ttl.sh/techaro/anubis-external-auth:latest
cd ../.. &&
npm ci &&
npm run container -- \
--docker-repo ttl.sh/techaro/anubis \
--docker-tags ttl.sh/techaro/anubis:latest
)
kubectl apply -k .
echo "open https://nginx.local.cetacean.club, press control c when done"
control_c() {
kubectl delete -k .
exit
kubectl delete -k .
exit
}
trap control_c SIGINT
sleep infinity
sleep infinity

View File

@@ -0,0 +1,8 @@
bots:
- name: challenge
user_agent_regex: CHALLENGE
action: CHALLENGE
status_codes:
CHALLENGE: 200
DENY: 403

27
test/robots_txt/test.mjs Normal file
View File

@@ -0,0 +1,27 @@
async function getRobotsTxt() {
return fetch("http://localhost:8923/robots.txt", {
headers: {
"Accept-Language": "en",
"User-Agent": "Mozilla/5.0",
}
})
.then(resp => {
if (resp.status !== 200) {
throw new Error(`wanted status 200, got status: ${resp.status}`);
}
return resp;
})
.then(resp => resp.text());
}
(async () => {
const page = await getRobotsTxt();
if (page.includes(`<html>`)) {
console.log(page)
throw new Error("serve robots.txt smoke test failed");
}
console.log("serve-robots-txt serves robots.txt");
process.exit(0);
})();

24
test/robots_txt/test.sh Executable file
View File

@@ -0,0 +1,24 @@
#!/usr/bin/env bash
set -euo pipefail
function cleanup() {
pkill -P $$
}
trap cleanup EXIT SIGINT
# Build static assets
(cd ../.. && npm ci && npm run assets)
go tool anubis --help 2>/dev/null || :
go run ../cmd/unixhttpd &
go tool anubis \
--policy-fname ./anubis.yaml \
--use-remote-address \
--serve-robots-txt \
--target=unix://$(pwd)/unixhttpd.sock &
backoff-retry node ./test.mjs

2
test/robots_txt/var/.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
*
!.gitignore