internal: add more outpost tests, add support for X-Original-URL
Signed-off-by: Jens Langhammer <jens.langhammer@beryju.org>
This commit is contained in:
parent
e70e031a1f
commit
07b09df3fe
3
Makefile
3
Makefile
|
@ -15,6 +15,9 @@ test-e2e-provider:
|
||||||
test-e2e-rest:
|
test-e2e-rest:
|
||||||
coverage run manage.py test tests/e2e/test_flows* tests/e2e/test_source*
|
coverage run manage.py test tests/e2e/test_flows* tests/e2e/test_source*
|
||||||
|
|
||||||
|
test-go:
|
||||||
|
go test -timeout 0 -v -race ./...
|
||||||
|
|
||||||
test:
|
test:
|
||||||
coverage run manage.py test authentik
|
coverage run manage.py test authentik
|
||||||
coverage html
|
coverage html
|
||||||
|
|
|
@ -2,6 +2,7 @@ package application
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"encoding/base64"
|
"encoding/base64"
|
||||||
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/url"
|
"net/url"
|
||||||
|
@ -57,6 +58,7 @@ func (a *Application) addHeaders(headers http.Header, c *Claims) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// getTraefikForwardUrl See https://doc.traefik.io/traefik/middlewares/forwardauth/
|
||||||
func (a *Application) getTraefikForwardUrl(r *http.Request) *url.URL {
|
func (a *Application) getTraefikForwardUrl(r *http.Request) *url.URL {
|
||||||
u, err := url.Parse(fmt.Sprintf(
|
u, err := url.Parse(fmt.Sprintf(
|
||||||
"%s://%s%s",
|
"%s://%s%s",
|
||||||
|
@ -72,26 +74,32 @@ func (a *Application) getTraefikForwardUrl(r *http.Request) *url.URL {
|
||||||
return u
|
return u
|
||||||
}
|
}
|
||||||
|
|
||||||
func (a *Application) IsAllowlisted(r *http.Request) bool {
|
// getNginxForwardUrl See https://github.com/kubernetes/ingress-nginx/blob/main/rootfs/etc/nginx/template/nginx.tmpl#L1044
|
||||||
url := r.URL
|
func (a *Application) getNginxForwardUrl(r *http.Request) *url.URL {
|
||||||
// In Forward auth mode, we can't directly match against the requested URL
|
h := r.Header.Get("X-Original-URI")
|
||||||
// Since that would be /akprox/auth/...
|
if len(h) < 1 {
|
||||||
if a.Mode() == api.PROXYMODE_FORWARD_SINGLE || a.Mode() == api.PROXYMODE_FORWARD_DOMAIN {
|
a.log.WithError(errors.New("blank URL")).Warning("blank URL")
|
||||||
// For traefik, we can get the Upstream URL from headers
|
return r.URL
|
||||||
// For nginx we can attempt to as well, but it's not guaranteed to work.
|
|
||||||
if strings.HasPrefix(r.URL.Path, "/akprox/auth") {
|
|
||||||
url = a.getTraefikForwardUrl(r)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
for _, u := range a.UnauthenticatedRegex {
|
u, err := url.Parse(h)
|
||||||
|
if err != nil {
|
||||||
|
a.log.WithError(err).Warning("failed to parse URL from nginx")
|
||||||
|
return r.URL
|
||||||
|
}
|
||||||
|
a.log.WithField("url", u.String()).Trace("nginx forwarded url")
|
||||||
|
return u
|
||||||
|
}
|
||||||
|
|
||||||
|
func (a *Application) IsAllowlisted(u *url.URL) bool {
|
||||||
|
for _, ur := range a.UnauthenticatedRegex {
|
||||||
var testString string
|
var testString string
|
||||||
if a.Mode() == api.PROXYMODE_PROXY || a.Mode() == api.PROXYMODE_FORWARD_SINGLE {
|
if a.Mode() == api.PROXYMODE_PROXY || a.Mode() == api.PROXYMODE_FORWARD_SINGLE {
|
||||||
testString = url.Path
|
testString = u.Path
|
||||||
} else {
|
} else {
|
||||||
testString = url.String()
|
testString = u.String()
|
||||||
}
|
}
|
||||||
a.log.WithField("regex", u.String()).WithField("url", testString).Trace("Matching URL against allow list")
|
a.log.WithField("regex", u.String()).WithField("url", testString).Trace("Matching URL against allow list")
|
||||||
if u.MatchString(testString) {
|
if ur.MatchString(testString) {
|
||||||
return true
|
return true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -25,13 +25,14 @@ func (a *Application) configureForward() error {
|
||||||
}
|
}
|
||||||
|
|
||||||
func (a *Application) forwardHandleTraefik(rw http.ResponseWriter, r *http.Request) {
|
func (a *Application) forwardHandleTraefik(rw http.ResponseWriter, r *http.Request) {
|
||||||
|
fwd := a.getTraefikForwardUrl(r)
|
||||||
claims, err := a.getClaims(r)
|
claims, err := a.getClaims(r)
|
||||||
if claims != nil && err == nil {
|
if claims != nil && err == nil {
|
||||||
a.addHeaders(rw.Header(), claims)
|
a.addHeaders(rw.Header(), claims)
|
||||||
rw.Header().Set("User-Agent", r.Header.Get("User-Agent"))
|
rw.Header().Set("User-Agent", r.Header.Get("User-Agent"))
|
||||||
a.log.WithField("headers", rw.Header()).Trace("headers written to forward_auth")
|
a.log.WithField("headers", rw.Header()).Trace("headers written to forward_auth")
|
||||||
return
|
return
|
||||||
} else if claims == nil && a.IsAllowlisted(r) {
|
} else if claims == nil && a.IsAllowlisted(fwd) {
|
||||||
a.log.Trace("path can be accessed without authentication")
|
a.log.Trace("path can be accessed without authentication")
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
@ -51,9 +52,8 @@ func (a *Application) forwardHandleTraefik(rw http.ResponseWriter, r *http.Reque
|
||||||
// set the redirect flag to the current URL we have, since we redirect
|
// set the redirect flag to the current URL we have, since we redirect
|
||||||
// to a (possibly) different domain, but we want to be redirected back
|
// to a (possibly) different domain, but we want to be redirected back
|
||||||
// to the application
|
// to the application
|
||||||
// see https://doc.traefik.io/traefik/middlewares/forwardauth/
|
|
||||||
// X-Forwarded-Uri is only the path, so we need to build the entire URL
|
// X-Forwarded-Uri is only the path, so we need to build the entire URL
|
||||||
s.Values[constants.SessionRedirect] = a.getTraefikForwardUrl(r).String()
|
s.Values[constants.SessionRedirect] = fwd.String()
|
||||||
err = s.Save(r, rw)
|
err = s.Save(r, rw)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
a.log.WithError(err).Warning("failed to save session before redirect")
|
a.log.WithError(err).Warning("failed to save session before redirect")
|
||||||
|
@ -69,6 +69,7 @@ func (a *Application) forwardHandleTraefik(rw http.ResponseWriter, r *http.Reque
|
||||||
}
|
}
|
||||||
|
|
||||||
func (a *Application) forwardHandleNginx(rw http.ResponseWriter, r *http.Request) {
|
func (a *Application) forwardHandleNginx(rw http.ResponseWriter, r *http.Request) {
|
||||||
|
fwd := a.getNginxForwardUrl(r)
|
||||||
claims, err := a.getClaims(r)
|
claims, err := a.getClaims(r)
|
||||||
if claims != nil && err == nil {
|
if claims != nil && err == nil {
|
||||||
a.addHeaders(rw.Header(), claims)
|
a.addHeaders(rw.Header(), claims)
|
||||||
|
@ -76,13 +77,20 @@ func (a *Application) forwardHandleNginx(rw http.ResponseWriter, r *http.Request
|
||||||
rw.WriteHeader(200)
|
rw.WriteHeader(200)
|
||||||
a.log.WithField("headers", rw.Header()).Trace("headers written to forward_auth")
|
a.log.WithField("headers", rw.Header()).Trace("headers written to forward_auth")
|
||||||
return
|
return
|
||||||
} else if claims == nil && a.IsAllowlisted(r) {
|
} else if claims == nil && a.IsAllowlisted(fwd) {
|
||||||
a.log.Trace("path can be accessed without authentication")
|
a.log.Trace("path can be accessed without authentication")
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
fwu := a.getTraefikForwardUrl(r)
|
|
||||||
if fwu.String() != r.URL.String() {
|
s, _ := a.sessions.Get(r, constants.SeesionName)
|
||||||
if strings.HasPrefix(fwu.Path, "/akprox") {
|
s.Values[constants.SessionRedirect] = fwd.String()
|
||||||
|
err = s.Save(r, rw)
|
||||||
|
if err != nil {
|
||||||
|
a.log.WithError(err).Warning("failed to save session before redirect")
|
||||||
|
}
|
||||||
|
|
||||||
|
if fwd.String() != r.URL.String() {
|
||||||
|
if strings.HasPrefix(fwd.Path, "/akprox") {
|
||||||
a.log.WithField("url", r.URL.String()).Trace("path begins with /akprox, allowing access")
|
a.log.WithField("url", r.URL.String()).Trace("path begins with /akprox, allowing access")
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
|
@ -6,6 +6,7 @@ import (
|
||||||
"testing"
|
"testing"
|
||||||
|
|
||||||
"github.com/quasoft/memstore"
|
"github.com/quasoft/memstore"
|
||||||
|
"github.com/sirupsen/logrus"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
"goauthentik.io/api"
|
"goauthentik.io/api"
|
||||||
"goauthentik.io/internal/outpost/ak"
|
"goauthentik.io/internal/outpost/ak"
|
||||||
|
@ -15,13 +16,16 @@ import (
|
||||||
func newTestApplication() *Application {
|
func newTestApplication() *Application {
|
||||||
a, _ := NewApplication(
|
a, _ := NewApplication(
|
||||||
api.ProxyOutpostConfig{
|
api.ProxyOutpostConfig{
|
||||||
Name: *api.PtrString(ak.TestSecret()),
|
Name: ak.TestSecret(),
|
||||||
ClientId: api.PtrString(ak.TestSecret()),
|
ClientId: api.PtrString(ak.TestSecret()),
|
||||||
ClientSecret: api.PtrString(ak.TestSecret()),
|
ClientSecret: api.PtrString(ak.TestSecret()),
|
||||||
CookieSecret: api.PtrString(ak.TestSecret()),
|
CookieSecret: api.PtrString(ak.TestSecret()),
|
||||||
CookieDomain: api.PtrString(""),
|
CookieDomain: api.PtrString(""),
|
||||||
Mode: api.PROXYMODE_FORWARD_SINGLE.Ptr(),
|
Mode: api.PROXYMODE_FORWARD_SINGLE.Ptr(),
|
||||||
SkipPathRegex: api.PtrString(""),
|
SkipPathRegex: api.PtrString("/skip.*"),
|
||||||
|
BasicAuthEnabled: api.PtrBool(true),
|
||||||
|
BasicAuthUserAttribute: api.PtrString("username"),
|
||||||
|
BasicAuthPasswordAttribute: api.PtrString("password"),
|
||||||
},
|
},
|
||||||
http.DefaultClient,
|
http.DefaultClient,
|
||||||
nil,
|
nil,
|
||||||
|
@ -47,13 +51,27 @@ func TestForwardHandleTraefik_Blank(t *testing.T) {
|
||||||
rr := httptest.NewRecorder()
|
rr := httptest.NewRecorder()
|
||||||
a.forwardHandleTraefik(rr, req)
|
a.forwardHandleTraefik(rr, req)
|
||||||
|
|
||||||
assert.Equal(t, rr.Code, http.StatusTemporaryRedirect)
|
assert.Equal(t, http.StatusTemporaryRedirect, rr.Code)
|
||||||
loc, _ := rr.Result().Location()
|
loc, _ := rr.Result().Location()
|
||||||
assert.Equal(t, loc.String(), "/akprox/start")
|
assert.Equal(t, "/akprox/start", loc.String())
|
||||||
|
|
||||||
s, _ := a.sessions.Get(req, constants.SeesionName)
|
s, _ := a.sessions.Get(req, constants.SeesionName)
|
||||||
// Since we're not setting the traefik specific headers, expect it to redirect to the auth URL
|
// Since we're not setting the traefik specific headers, expect it to redirect to the auth URL
|
||||||
assert.Equal(t, s.Values[constants.SessionRedirect], "/akprox/auth/traefik")
|
assert.Equal(t, "/akprox/auth/traefik", s.Values[constants.SessionRedirect])
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestForwardHandleTraefik_Skip(t *testing.T) {
|
||||||
|
logrus.SetLevel(logrus.TraceLevel)
|
||||||
|
a := newTestApplication()
|
||||||
|
req, _ := http.NewRequest("GET", "/akprox/auth/traefik", nil)
|
||||||
|
req.Header.Set("X-Forwarded-Proto", "http")
|
||||||
|
req.Header.Set("X-Forwarded-Host", "test.goauthentik.io")
|
||||||
|
req.Header.Set("X-Forwarded-Uri", "/skip")
|
||||||
|
|
||||||
|
rr := httptest.NewRecorder()
|
||||||
|
a.forwardHandleTraefik(rr, req)
|
||||||
|
|
||||||
|
assert.Equal(t, http.StatusOK, rr.Code)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestForwardHandleTraefik_Headers(t *testing.T) {
|
func TestForwardHandleTraefik_Headers(t *testing.T) {
|
||||||
|
@ -71,7 +89,51 @@ func TestForwardHandleTraefik_Headers(t *testing.T) {
|
||||||
assert.Equal(t, loc.String(), "http://test.goauthentik.io/akprox/start")
|
assert.Equal(t, loc.String(), "http://test.goauthentik.io/akprox/start")
|
||||||
|
|
||||||
s, _ := a.sessions.Get(req, constants.SeesionName)
|
s, _ := a.sessions.Get(req, constants.SeesionName)
|
||||||
assert.Equal(t, s.Values[constants.SessionRedirect], "http://test.goauthentik.io/")
|
assert.Equal(t, "http://test.goauthentik.io/", s.Values[constants.SessionRedirect])
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestForwardHandleTraefik_Claims(t *testing.T) {
|
||||||
|
a := newTestApplication()
|
||||||
|
req, _ := http.NewRequest("GET", "/akprox/auth/traefik", nil)
|
||||||
|
|
||||||
|
rr := httptest.NewRecorder()
|
||||||
|
a.forwardHandleTraefik(rr, req)
|
||||||
|
|
||||||
|
s, _ := a.sessions.Get(req, constants.SeesionName)
|
||||||
|
s.Values[constants.SessionClaims] = Claims{
|
||||||
|
Sub: "foo",
|
||||||
|
Proxy: ProxyClaims{
|
||||||
|
UserAttributes: map[string]interface{}{
|
||||||
|
"username": "foo",
|
||||||
|
"password": "bar",
|
||||||
|
"additionalHeaders": map[string]interface{}{
|
||||||
|
"foo": "bar",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
err := a.sessions.Save(req, rr, s)
|
||||||
|
if err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
rr = httptest.NewRecorder()
|
||||||
|
a.forwardHandleTraefik(rr, req)
|
||||||
|
|
||||||
|
h := rr.Result().Header
|
||||||
|
|
||||||
|
assert.Equal(t, []string{"Basic Zm9vOmJhcg=="}, h["Authorization"])
|
||||||
|
assert.Equal(t, []string{"bar"}, h["Foo"])
|
||||||
|
assert.Equal(t, []string{""}, h["User-Agent"])
|
||||||
|
assert.Equal(t, []string{""}, h["X-Authentik-Email"])
|
||||||
|
assert.Equal(t, []string{""}, h["X-Authentik-Groups"])
|
||||||
|
assert.Equal(t, []string{""}, h["X-Authentik-Jwt"])
|
||||||
|
assert.Equal(t, []string{""}, h["X-Authentik-Meta-App"])
|
||||||
|
assert.Equal(t, []string{""}, h["X-Authentik-Meta-Jwks"])
|
||||||
|
assert.Equal(t, []string{""}, h["X-Authentik-Meta-Outpost"])
|
||||||
|
assert.Equal(t, []string{""}, h["X-Authentik-Name"])
|
||||||
|
assert.Equal(t, []string{"foo"}, h["X-Authentik-Uid"])
|
||||||
|
assert.Equal(t, []string{""}, h["X-Authentik-Username"])
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestForwardHandleNginx_Blank(t *testing.T) {
|
func TestForwardHandleNginx_Blank(t *testing.T) {
|
||||||
|
@ -81,5 +143,74 @@ func TestForwardHandleNginx_Blank(t *testing.T) {
|
||||||
rr := httptest.NewRecorder()
|
rr := httptest.NewRecorder()
|
||||||
a.forwardHandleNginx(rr, req)
|
a.forwardHandleNginx(rr, req)
|
||||||
|
|
||||||
assert.Equal(t, rr.Code, http.StatusUnauthorized)
|
assert.Equal(t, http.StatusUnauthorized, rr.Code)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestForwardHandleNginx_Skip(t *testing.T) {
|
||||||
|
a := newTestApplication()
|
||||||
|
req, _ := http.NewRequest("GET", "/akprox/auth/nginx", nil)
|
||||||
|
req.Header.Set("X-Original-URI", "http://test.goauthentik.io/skip")
|
||||||
|
|
||||||
|
rr := httptest.NewRecorder()
|
||||||
|
a.forwardHandleNginx(rr, req)
|
||||||
|
|
||||||
|
assert.Equal(t, http.StatusOK, rr.Code)
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestForwardHandleNginx_Headers(t *testing.T) {
|
||||||
|
a := newTestApplication()
|
||||||
|
req, _ := http.NewRequest("GET", "/akprox/auth/nginx", nil)
|
||||||
|
req.Header.Set("X-Original-URI", "http://test.goauthentik.io")
|
||||||
|
|
||||||
|
rr := httptest.NewRecorder()
|
||||||
|
a.forwardHandleNginx(rr, req)
|
||||||
|
|
||||||
|
assert.Equal(t, rr.Code, http.StatusUnauthorized)
|
||||||
|
|
||||||
|
s, _ := a.sessions.Get(req, constants.SeesionName)
|
||||||
|
assert.Equal(t, "http://test.goauthentik.io", s.Values[constants.SessionRedirect])
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestForwardHandleNginx_Claims(t *testing.T) {
|
||||||
|
a := newTestApplication()
|
||||||
|
req, _ := http.NewRequest("GET", "/akprox/auth/nginx", nil)
|
||||||
|
|
||||||
|
rr := httptest.NewRecorder()
|
||||||
|
a.forwardHandleNginx(rr, req)
|
||||||
|
|
||||||
|
s, _ := a.sessions.Get(req, constants.SeesionName)
|
||||||
|
s.Values[constants.SessionClaims] = Claims{
|
||||||
|
Sub: "foo",
|
||||||
|
Proxy: ProxyClaims{
|
||||||
|
UserAttributes: map[string]interface{}{
|
||||||
|
"username": "foo",
|
||||||
|
"password": "bar",
|
||||||
|
"additionalHeaders": map[string]interface{}{
|
||||||
|
"foo": "bar",
|
||||||
|
},
|
||||||
|
},
|
||||||
|
},
|
||||||
|
}
|
||||||
|
err := a.sessions.Save(req, rr, s)
|
||||||
|
if err != nil {
|
||||||
|
panic(err)
|
||||||
|
}
|
||||||
|
|
||||||
|
rr = httptest.NewRecorder()
|
||||||
|
a.forwardHandleTraefik(rr, req)
|
||||||
|
|
||||||
|
h := rr.Result().Header
|
||||||
|
|
||||||
|
assert.Equal(t, []string{"Basic Zm9vOmJhcg=="}, h["Authorization"])
|
||||||
|
assert.Equal(t, []string{"bar"}, h["Foo"])
|
||||||
|
assert.Equal(t, []string{""}, h["User-Agent"])
|
||||||
|
assert.Equal(t, []string{""}, h["X-Authentik-Email"])
|
||||||
|
assert.Equal(t, []string{""}, h["X-Authentik-Groups"])
|
||||||
|
assert.Equal(t, []string{""}, h["X-Authentik-Jwt"])
|
||||||
|
assert.Equal(t, []string{""}, h["X-Authentik-Meta-App"])
|
||||||
|
assert.Equal(t, []string{""}, h["X-Authentik-Meta-Jwks"])
|
||||||
|
assert.Equal(t, []string{""}, h["X-Authentik-Meta-Outpost"])
|
||||||
|
assert.Equal(t, []string{""}, h["X-Authentik-Name"])
|
||||||
|
assert.Equal(t, []string{"foo"}, h["X-Authentik-Uid"])
|
||||||
|
assert.Equal(t, []string{""}, h["X-Authentik-Username"])
|
||||||
}
|
}
|
||||||
|
|
|
@ -35,7 +35,7 @@ func (a *Application) configureProxy() error {
|
||||||
rp.ModifyResponse = a.proxyModifyResponse
|
rp.ModifyResponse = a.proxyModifyResponse
|
||||||
a.mux.PathPrefix("/").HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
|
a.mux.PathPrefix("/").HandlerFunc(func(rw http.ResponseWriter, r *http.Request) {
|
||||||
claims, err := a.getClaims(r)
|
claims, err := a.getClaims(r)
|
||||||
if claims == nil && a.IsAllowlisted(r) {
|
if claims == nil && a.IsAllowlisted(r.URL) {
|
||||||
a.log.Trace("path can be accessed without authentication")
|
a.log.Trace("path can be accessed without authentication")
|
||||||
} else if claims == nil && err != nil {
|
} else if claims == nil && err != nil {
|
||||||
a.redirectToStart(rw, r)
|
a.redirectToStart(rw, r)
|
||||||
|
|
Reference in New Issue