@@ -15,6 +15,7 @@ import (
1515 "time"
1616
1717 "github.com/coreos/go-oidc/v3/oidc"
18+ middlewareapi "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/middleware"
1819 "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/options"
1920 "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/sessions"
2021 "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/authentication/hmacauth"
@@ -53,7 +54,7 @@ func TestRobotsTxt(t *testing.T) {
5354 t.Fatal(err)
5455 }
5556 rw := httptest.NewRecorder()
56− req, _ := http.NewRequest("GET", "/robots.txt", nil)
57+ req, _ := http.NewRequest(http.MethodGet, "/robots.txt", nil)
5758 proxy.ServeHTTP(rw, req)
5859 assert.Equal(t, 200, rw.Code)
5960 assert.Equal(t, "User-agent: *\nDisallow: /\n", rw.Body.String())
@@ -240,7 +241,7 @@ func TestBasicAuthPassword(t *testing.T) {
240241
241242 // Save the required session
242243 rw := httptest.NewRecorder()
243− req, _ := http.NewRequest("GET", "/", nil)
244+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
244245 err = proxy.sessionStore.Save(rw, req, &sessions.SessionState{
245246 Email: emailAddress,
246247 })
@@ -249,7 +250,7 @@ func TestBasicAuthPassword(t *testing.T) {
249250 // Extract the cookie value to inject into the test request
250251 cookie := rw.Header().Values("Set-Cookie")[0]
251252
252− req, _ = http.NewRequest("GET", "/", nil)
253+ req, _ = http.NewRequest(http.MethodGet, "/", nil)
253254 req.Header.Set("Cookie", cookie)
254255 rw = httptest.NewRecorder()
255256 proxy.ServeHTTP(rw, req)
@@ -299,14 +300,14 @@ func TestPassGroupsHeadersWithGroups(t *testing.T) {
299300
300301 // Save the required session
301302 rw := httptest.NewRecorder()
302− req, _ := http.NewRequest("GET", "/", nil)
303+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
303304 err = proxy.sessionStore.Save(rw, req, session)
304305 assert.NoError(t, err)
305306
306307 // Extract the cookie value to inject into the test request
307308 cookie := rw.Header().Values("Set-Cookie")[0]
308309
309− req, _ = http.NewRequest("GET", "/", nil)
310+ req, _ = http.NewRequest(http.MethodGet, "/", nil)
310311 req.Header.Set("Cookie", cookie)
311312 rw = httptest.NewRecorder()
312313 proxy.ServeHTTP(rw, req)
@@ -456,7 +457,7 @@ func (patTest *PassAccessTokenTest) getEndpointWithCookie(cookie string, endpoin
456457 return 0, ""
457458 }
458459
459− req, err := http.NewRequest("GET", endpoint, strings.NewReader(""))
460+ req, err := http.NewRequest(http.MethodGet, endpoint, strings.NewReader(""))
460461 if err != nil {
461462 return 0, ""
462463 }
@@ -607,7 +608,7 @@ func NewSignInPageTest(skipProvider bool) (*SignInPageTest, error) {
607608
608609func (sipTest *SignInPageTest) GetEndpoint(endpoint string) (int, string) {
609610 rw := httptest.NewRecorder()
610− req, _ := http.NewRequest("GET", endpoint, strings.NewReader(""))
611+ req, _ := http.NewRequest(http.MethodGet, endpoint, strings.NewReader(""))
611612 sipTest.proxy.ServeHTTP(rw, req)
612613 return rw.Code, rw.Body.String()
613614}
@@ -712,6 +713,50 @@ func TestManualSignInCorrectCredentials(t *testing.T) {
712713 assert.Equal(t, http.StatusFound, statusCode)
713714}
714715
716+func TestSignInPageClearsExistingSessionCookie(t *testing.T) {
717+ opts := baseTestOptions()
718+ err := validation.Validate(opts)
719+ require.NoError(t, err)
720+
721+ proxy, err := NewOAuthProxy(opts, func(string) bool {
722+ return true
723+ })
724+ require.NoError(t, err)
725+
726+ // Create a real session cookie using the actual session store.
727+ saveRW := httptest.NewRecorder()
728+ saveReq := httptest.NewRequest(http.MethodGet, "/", nil)
729+ err = proxy.sessionStore.Save(saveRW, saveReq, &sessions.SessionState{
730+ Email: "john.doe@example.com",
731+ })
732+ require.NoError(t, err)
733+
734+ cookies := saveRW.Result().Cookies()
735+ require.NotEmpty(t, cookies)
736+
737+ // Send that cookie to the sign-in page.
738+ req := httptest.NewRequest(http.MethodGet, "/oauth2/sign_in", nil)
739+ for _, c := range cookies {
740+ req.AddCookie(c)
741+ }
742+
743+ rw := httptest.NewRecorder()
744+ proxy.ServeHTTP(rw, req)
745+
746+ assert.Equal(t, http.StatusOK, rw.Code)
747+
748+ cleared := false
749+ for _, c := range rw.Result().Cookies() {
750+ if c.Name == proxy.CookieOptions.Name {
751+ cleared = true
752+ assert.Equal(t, "", c.Value)
753+ assert.Less(t, c.MaxAge, 0)
754+ }
755+ }
756+
757+ assert.True(t, cleared, "expected sign-in page to clear existing session cookie")
758+}
759+
715760func TestSignInPageIncludesTargetRedirect(t *testing.T) {
716761 sipTest, err := NewSignInPageTest(false)
717762 if err != nil {
@@ -834,20 +879,8 @@ func NewProcessCookieTest(opts ProcessCookieTestOpts, modifiers ...OptionsModifi
834879 return nil, err
835880 }
836881 testProvider := &TestProvider{
837− ProviderData: &providers.ProviderData{
838− ProviderName: "Test Provider",
839− LoginURL: &url.URL{
840− Scheme: "http",
841− Host: "localhost",
842− Path: "/oauth/authorize",
843− },
844− RedeemURL: &url.URL{
845− Scheme: "http",
846− Host: "localhost",
847− Path: "/oauth/token",
848− },
849− },
850− ValidToken: opts.providerValidateCookieResponse,
882+ ProviderData: &providers.ProviderData{},
883+ ValidToken: opts.providerValidateCookieResponse,
851884 }
852885
853886 groups := pcTest.opts.Providers[0].AllowedGroups
@@ -861,7 +894,7 @@ func NewProcessCookieTest(opts ProcessCookieTestOpts, modifiers ...OptionsModifi
861894 // access_token validation.
862895 pcTest.proxy.CookieOptions.Refresh = time.Duration(0)
863896 pcTest.rw = httptest.NewRecorder()
864− pcTest.req, _ = http.NewRequest("GET", "/", strings.NewReader(""))
897+ pcTest.req, _ = http.NewRequest(http.MethodGet, "/", strings.NewReader(""))
865898 pcTest.validateUser = true
866899 return &pcTest, nil
867900}
@@ -994,7 +1027,7 @@ func NewUserInfoEndpointTest() (*ProcessCookieTest, error) {
9941027 if err != nil {
9951028 return nil, err
9961029 }
997− pcTest.req, _ = http.NewRequest("GET",
1030+ pcTest.req, _ = http.NewRequest(http.MethodGet,
9981031 pcTest.opts.ProxyPrefix+"/userinfo", nil)
9991032 return pcTest, nil
10001033}
@@ -1044,6 +1077,20 @@ func TestUserInfoEndpointAccepted(t *testing.T) {
10441077 },
10451078 expectedResponse: "{\"user\":\"john.doe\",\"email\":\"john.doe@example.com\",\"groups\":[\"example\",\"groups\"],\"preferredUsername\":\"john\"}\n",
10461079 },
1080+ {
1081+ name: "With Additional Claim",
1082+ session: &sessions.SessionState{
1083+ User: "john.doe",
1084+ PreferredUsername: "john",
1085+ Email: "john.doe@example.com",
1086+ Groups: []string{"example", "groups"},
1087+ AccessToken: "my_access_token",
1088+ AdditionalClaims: map[string]interface{}{
1089+ "foo": "bar",
1090+ },
1091+ },
1092+ expectedResponse: "{\"user\":\"john.doe\",\"email\":\"john.doe@example.com\",\"groups\":[\"example\",\"groups\"],\"preferredUsername\":\"john\",\"additionalClaims\":{\"foo\":\"bar\"}}\n",
1093+ },
10471094 }
10481095
10491096 for _, tc := range testCases {
@@ -1088,7 +1135,7 @@ func NewAuthOnlyEndpointTest(querystring string, modifiers ...OptionsModifier) (
10881135 return nil, err
10891136 }
10901137 pcTest.req, _ = http.NewRequest(
1091− "GET",
1138+ http.MethodGet,
10921139 fmt.Sprintf("%s/auth%s", pcTest.opts.ProxyPrefix, querystring),
10931140 nil)
10941141 return pcTest, nil
@@ -1124,35 +1171,6 @@ func TestAuthOnlyEndpointUnauthorizedOnNoCookieSetError(t *testing.T) {
11241171 assert.Equal(t, "Unauthorized\n", string(bodyBytes))
11251172}
11261173
1127−// TestAuthOnlyEndpointRedirectWithSkipProviderButton tests that when SkipProviderButton
1128−// is true and no session exists, the /auth endpoint should return a 302 redirect
1129−// to the OAuth provider instead of 401. This is important for nginx auth_request
1130−// architecture where 401 triggers error_page handling which can break the redirect flow.
1131−// See: https://github.com/oauth2-proxy/oauth2-proxy/issues/334
1132−func TestAuthOnlyEndpointRedirectWithSkipProviderButton(t *testing.T) {
1133− test, err := NewAuthOnlyEndpointTest("", func(opts *options.Options) {
1134− opts.SkipProviderButton = true
1135− })
1136− if err != nil {
1137− t.Fatal(err)
1138− }
1139−
1140− test.proxy.ServeHTTP(test.rw, test.req)
1141−
1142− // With SkipProviderButton=true and no session, should return 302 redirect
1143− // to OAuth provider, NOT 401 Unauthorized
1144− assert.Equal(t, http.StatusFound, test.rw.Code)
1145− location := test.rw.Header().Get("Location")
1146− assert.NotEmpty(t, location, "Expected Location header for redirect")
1147−
1148− // Verify the redirect points to the OAuth provider's authorize endpoint
1149− // and contains key OAuth parameters
1150− assert.Contains(t, location, "/oauth/authorize", "Expected redirect to OAuth authorize endpoint")
1151− assert.Contains(t, location, "client_id=", "Expected client_id in redirect URL")
1152− assert.Contains(t, location, "redirect_uri=", "Expected redirect_uri in redirect URL")
1153− assert.Contains(t, location, "state=", "Expected state parameter in redirect URL")
1154−}
1155−
11561174func TestAuthOnlyEndpointUnauthorizedOnExpiration(t *testing.T) {
11571175 test, err := NewAuthOnlyEndpointTest("", func(opts *options.Options) {
11581176 opts.Cookie.Expire = time.Duration(24) * time.Hour
@@ -1256,7 +1274,7 @@ func TestAuthOnlyEndpointSetXAuthRequestHeaders(t *testing.T) {
12561274 pcTest.validateUser = true
12571275
12581276 pcTest.rw = httptest.NewRecorder()
1259− pcTest.req, _ = http.NewRequest("GET",
1277+ pcTest.req, _ = http.NewRequest(http.MethodGet,
12601278 pcTest.opts.ProxyPrefix+authOnlyPath, nil)
12611279
12621280 created := time.Now()
@@ -1349,7 +1367,7 @@ func TestAuthOnlyEndpointSetBasicAuthTrueRequestHeaders(t *testing.T) {
13491367 pcTest.validateUser = true
13501368
13511369 pcTest.rw = httptest.NewRecorder()
1352− pcTest.req, _ = http.NewRequest("GET",
1370+ pcTest.req, _ = http.NewRequest(http.MethodGet,
13531371 pcTest.opts.ProxyPrefix+authOnlyPath, nil)
13541372
13551373 created := time.Now()
@@ -1429,7 +1447,7 @@ func TestAuthOnlyEndpointSetBasicAuthFalseRequestHeaders(t *testing.T) {
14291447 pcTest.validateUser = true
14301448
14311449 pcTest.rw = httptest.NewRecorder()
1432− pcTest.req, _ = http.NewRequest("GET",
1450+ pcTest.req, _ = http.NewRequest(http.MethodGet,
14331451 pcTest.opts.ProxyPrefix+authOnlyPath, nil)
14341452
14351453 created := time.Now()
@@ -1477,7 +1495,7 @@ func TestAuthSkippedForPreflightRequests(t *testing.T) {
14771495 }
14781496 proxy.provider = NewTestProvider(upstreamURL, "")
14791497 rw := httptest.NewRecorder()
1480− req, _ := http.NewRequest("OPTIONS", "/preflight-request", nil)
1498+ req, _ := http.NewRequest(http.MethodOptions, "/preflight-request", nil)
14811499 proxy.ServeHTTP(rw, req)
14821500
14831501 assert.Equal(t, 200, rw.Code)
@@ -1634,19 +1652,19 @@ func TestRequestSignature(t *testing.T) {
16341652 resp string
16351653 }{
16361654 "No request signature": {
1637− method: "GET",
1655+ method: http.MethodGet,
16381656 body: "",
16391657 key: "",
16401658 resp: "no signature received",
16411659 },
16421660 "Get request": {
1643− method: "GET",
1661+ method: http.MethodGet,
16441662 body: "",
16451663 key: "7d9e1aa87a5954e6f9fc59266b3af9d7c35fda2d",
16461664 resp: "signatures match",
16471665 },
16481666 "Post request": {
1649− method: "POST",
1667+ method: http.MethodPost,
16501668 body: `{ "hello": "world!" }`,
16511669 key: "d90df39e2d19282840252612dd7c81421a372f61",
16521670 resp: "signatures match",
@@ -2069,6 +2087,44 @@ func Test_noCacheHeaders(t *testing.T) {
20692087 })
20702088}
20712089
2090+func TestSignOutCallsBackendLogoutURL(t *testing.T) {
2091+ const testIDToken = "test-id-token-12345"
2092+ var receivedURL string
2093+ backendLogoutServer := httptest.NewServer(http.HandlerFunc(func(rw http.ResponseWriter, req *http.Request) {
2094+ receivedURL = req.URL.String()
2095+ rw.WriteHeader(http.StatusOK)
2096+ }))
2097+ defer backendLogoutServer.Close()
2098+
2099+ opts := baseTestOptions()
2100+ opts.Providers[0].BackendLogoutURL = backendLogoutServer.URL + "/logout?id_token_hint={id_token}"
2101+ err := validation.Validate(opts)
2102+ require.NoError(t, err)
2103+
2104+ proxy, err := NewOAuthProxy(opts, func(string) bool { return true })
2105+ require.NoError(t, err)
2106+
2107+ // Save a session with IDToken so backend logout can use it
2108+ rw := httptest.NewRecorder()
2109+ req := httptest.NewRequest(http.MethodGet, "/", nil)
2110+ err = proxy.sessionStore.Save(rw, req, &sessions.SessionState{
2111+ Email: "user@example.com",
2112+ IDToken: testIDToken,
2113+ })
2114+ require.NoError(t, err)
2115+ cookie := rw.Header().Values("Set-Cookie")[0]
2116+
2117+ // Hit sign_out with the session cookie; backend logout should be called before session is cleared
2118+ signOutReq := httptest.NewRequest(http.MethodGet, "/oauth2/sign_out", nil)
2119+ signOutReq.Header.Set("Cookie", cookie)
2120+ rec := httptest.NewRecorder()
2121+ proxy.ServeHTTP(rec, signOutReq)
2122+
2123+ assert.Equal(t, http.StatusFound, rec.Code, "sign_out should redirect")
2124+ assert.Contains(t, receivedURL, "id_token_hint="+testIDToken,
2125+ "backend logout URL should have been called with id_token from session")
2126+}
2127+
20722128func baseTestOptions() *options.Options {
20732129 opts := options.NewOptions()
20742130 opts.Cookie.Secret = rawCookieSecret
@@ -2133,7 +2189,33 @@ func TestTrustedIPs(t *testing.T) {
21332189 reverseProxy: false,
21342190 realClientIPHeader: "X-Real-IP", // Default value
21352191 req: func() *http.Request {
2136− req, _ := http.NewRequest("GET", "/", nil)
2192+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2193+ return req
2194+ }(),
2195+ expectTrusted: false,
2196+ },
2197+ // Check Unix socket with no trusted IPs configured does not error.
2198+ {
2199+ name: "UnixSocketWithoutTrustedIPs",
2200+ trustedIPs: nil,
2201+ reverseProxy: false,
2202+ realClientIPHeader: "X-Real-IP",
2203+ req: func() *http.Request {
2204+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2205+ req.RemoteAddr = "@"
2206+ return req
2207+ }(),
2208+ expectTrusted: false,
2209+ },
2210+ // Check Unix socket with trusted IPs configured returns false (no IP to match).
2211+ {
2212+ name: "UnixSocketWithTrustedIPs",
2213+ trustedIPs: []string{"127.0.0.1"},
2214+ reverseProxy: false,
2215+ realClientIPHeader: "X-Real-IP",
2216+ req: func() *http.Request {
2217+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2218+ req.RemoteAddr = "@"
21372219 return req
21382220 }(),
21392221 expectTrusted: false,
@@ -2145,7 +2227,7 @@ func TestTrustedIPs(t *testing.T) {
21452227 reverseProxy: false,
21462228 realClientIPHeader: "X-Real-IP", // Default value
21472229 req: func() *http.Request {
2148− req, _ := http.NewRequest("GET", "/", nil)
2230+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
21492231 req.RemoteAddr = "127.0.0.1:43670"
21502232 return req
21512233 }(),
@@ -2158,7 +2240,7 @@ func TestTrustedIPs(t *testing.T) {
21582240 reverseProxy: true,
21592241 realClientIPHeader: "X-Real-IP", // Default value
21602242 req: func() *http.Request {
2161− req, _ := http.NewRequest("GET", "/", nil)
2243+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
21622244 req.RemoteAddr = "127.0.0.1:44324"
21632245 return req
21642246 }(),
@@ -2171,7 +2253,7 @@ func TestTrustedIPs(t *testing.T) {
21712253 reverseProxy: true,
21722254 realClientIPHeader: "X-Forwarded-For",
21732255 req: func() *http.Request {
2174− req, _ := http.NewRequest("GET", "/", nil)
2256+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
21752257 req.Header.Add("X-Forwarded-For", "127.0.0.1")
21762258 return req
21772259 }(),
@@ -2184,7 +2266,7 @@ func TestTrustedIPs(t *testing.T) {
21842266 reverseProxy: true,
21852267 realClientIPHeader: "X-Forwarded-For",
21862268 req: func() *http.Request {
2187− req, _ := http.NewRequest("GET", "/", nil)
2269+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
21882270 req.Header.Add("X-Forwarded-For", "::1")
21892271 return req
21902272 }(),
@@ -2197,7 +2279,7 @@ func TestTrustedIPs(t *testing.T) {
21972279 reverseProxy: true,
21982280 realClientIPHeader: "X-Forwarded-For",
21992281 req: func() *http.Request {
2200− req, _ := http.NewRequest("GET", "/", nil)
2282+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
22012283 req.Header.Add("X-Forwarded-For", "12.34.56.78")
22022284 return req
22032285 }(),
@@ -2210,7 +2292,7 @@ func TestTrustedIPs(t *testing.T) {
22102292 reverseProxy: true,
22112293 realClientIPHeader: "X-Forwarded-For",
22122294 req: func() *http.Request {
2213− req, _ := http.NewRequest("GET", "/", nil)
2295+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
22142296 req.Header.Add("X-Forwarded-For", "::2")
22152297 return req
22162298 }(),
@@ -2223,7 +2305,7 @@ func TestTrustedIPs(t *testing.T) {
22232305 reverseProxy: true,
22242306 realClientIPHeader: "X-Forwarded-For",
22252307 req: func() *http.Request {
2226− req, _ := http.NewRequest("GET", "/", nil)
2308+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
22272309 req.Header.Add("X-Real-IP", "::1")
22282310 return req
22292311 }(),
@@ -2236,7 +2318,7 @@ func TestTrustedIPs(t *testing.T) {
22362318 reverseProxy: true,
22372319 realClientIPHeader: "X-Forwarded-For",
22382320 req: func() *http.Request {
2239− req, _ := http.NewRequest("GET", "/", nil)
2321+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
22402322 req.Header.Add("X-Forwarded-For", "adsfljk29242as!!")
22412323 return req
22422324 }(),
@@ -2249,7 +2331,7 @@ func TestTrustedIPs(t *testing.T) {
22492331 reverseProxy: false,
22502332 realClientIPHeader: "X-Real-IP",
22512333 req: func() *http.Request {
2252− req, _ := http.NewRequest("GET", "/", nil)
2334+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
22532335 req.RemoteAddr = "adsfljk29242as!!"
22542336 return req
22552337 }(),
@@ -2345,12 +2427,12 @@ func Test_buildRoutesAllowlist(t *testing.T) {
23452427 },
23462428 expectedRoutes: []expectedAllowedRoute{
23472429 {
2348− method: "GET",
2430+ method: http.MethodGet,
23492431 negate: false,
23502432 regexString: "^/foo/bar",
23512433 },
23522434 {
2353− method: "POST",
2435+ method: http.MethodPost,
23542436 negate: false,
23552437 regexString: "^/baz/[0-9]+/thing",
23562438 },
@@ -2403,11 +2485,11 @@ func Test_buildRoutesAllowlist(t *testing.T) {
24032485 regexString: "^/baz/[0-9]+/thing/regex",
24042486 },
24052487 {
2406− method: "GET",
2488+ method: http.MethodGet,
24072489 regexString: "^/foo/bar",
24082490 },
24092491 {
2410− method: "POST",
2492+ method: http.MethodPost,
24112493 regexString: "^/baz/[0-9]+/thing",
24122494 },
24132495 {
@@ -2559,7 +2641,7 @@ func TestApiRoutes(t *testing.T) {
25592641
25602642 for _, tc := range testCases {
25612643 t.Run(tc.name, func(t *testing.T) {
2562− req, err := http.NewRequest("GET", tc.url, nil)
2644+ req, err := http.NewRequest(http.MethodGet, tc.url, nil)
25632645 req.Header.Set("Accept", tc.contentType)
25642646 assert.NoError(t, err)
25652647
@@ -2597,9 +2679,11 @@ func TestAllowedRequest(t *testing.T) {
25972679 }
25982680 opts.SkipAuthRegex = []string{
25992681 "^/skip/auth/regex$",
2682+ "^/public/.*/endpoint$",
26002683 }
26012684 opts.SkipAuthRoutes = []string{
26022685 "GET=^/skip/auth/routes/get",
2686+ "^/foo/.*/bar$",
26032687 }
26042688 err := validation.Validate(opts)
26052689 assert.NoError(t, err)
@@ -2616,25 +2700,37 @@ func TestAllowedRequest(t *testing.T) {
26162700 }{
26172701 {
26182702 name: "Regex GET allowed",
2619− method: "GET",
2703+ method: http.MethodGet,
26202704 url: "/skip/auth/regex",
26212705 allowed: true,
26222706 },
26232707 {
26242708 name: "Regex POST allowed ",
2625− method: "POST",
2709+ method: http.MethodPost,
26262710 url: "/skip/auth/regex",
26272711 allowed: true,
26282712 },
26292713 {
26302714 name: "Regex denied",
2631− method: "GET",
2715+ method: http.MethodGet,
26322716 url: "/wrong/denied",
26332717 allowed: false,
26342718 },
2719+ {
2720+ name: "Regex allowed with fragment-free path",
2721+ method: http.MethodGet,
2722+ url: "/public/legit/endpoint",
2723+ allowed: true,
2724+ },
2725+ {
2726+ name: "Regex denied when path contains encoded fragment suffix",
2727+ method: http.MethodGet,
2728+ url: "/public/secret%23/endpoint",
2729+ allowed: false,
2730+ },
26352731 {
26362732 name: "Route allowed",
2637− method: "GET",
2733+ method: http.MethodGet,
26382734 url: "/skip/auth/routes/get",
26392735 allowed: true,
26402736 },
@@ -2646,16 +2742,28 @@ func TestAllowedRequest(t *testing.T) {
26462742 },
26472743 {
26482744 name: "Route denied with wrong path",
2649− method: "GET",
2745+ method: http.MethodGet,
26502746 url: "/skip/auth/routes/wrong/path",
26512747 allowed: false,
26522748 },
26532749 {
26542750 name: "Route denied with wrong path and method",
2655− method: "POST",
2751+ method: http.MethodPost,
26562752 url: "/skip/auth/routes/wrong/path",
26572753 allowed: false,
26582754 },
2755+ {
2756+ name: "Route allowed with fragment-free path",
2757+ method: http.MethodGet,
2758+ url: "/foo/public/bar",
2759+ allowed: true,
2760+ },
2761+ {
2762+ name: "Route denied when path contains encoded fragment suffix",
2763+ method: http.MethodGet,
2764+ url: "/foo/secret%23/bar",
2765+ allowed: false,
2766+ },
26592767 }
26602768
26612769 for _, tc := range testCases {
@@ -2696,9 +2804,11 @@ func TestAllowedRequestWithForwardedUriHeader(t *testing.T) {
26962804 }
26972805 opts.SkipAuthRegex = []string{
26982806 "^/skip/auth/regex$",
2807+ "^/public/.*/endpoint$",
26992808 }
27002809 opts.SkipAuthRoutes = []string{
27012810 "GET=^/skip/auth/routes/get",
2811+ "^/foo/.*/bar$",
27022812 }
27032813 err := validation.Validate(opts)
27042814 assert.NoError(t, err)
@@ -2715,25 +2825,37 @@ func TestAllowedRequestWithForwardedUriHeader(t *testing.T) {
27152825 }{
27162826 {
27172827 name: "Regex GET allowed",
2718− method: "GET",
2828+ method: http.MethodGet,
27192829 url: "/skip/auth/regex",
27202830 allowed: true,
27212831 },
27222832 {
27232833 name: "Regex POST allowed ",
2724− method: "POST",
2834+ method: http.MethodPost,
27252835 url: "/skip/auth/regex",
27262836 allowed: true,
27272837 },
27282838 {
27292839 name: "Regex denied",
2730− method: "GET",
2840+ method: http.MethodGet,
27312841 url: "/wrong/denied",
27322842 allowed: false,
27332843 },
2844+ {
2845+ name: "Regex allowed with fragment-free path",
2846+ method: http.MethodGet,
2847+ url: "/public/legit/endpoint",
2848+ allowed: true,
2849+ },
2850+ {
2851+ name: "Regex denied when X-Forwarded-Uri contains an encoded fragment suffix",
2852+ method: http.MethodGet,
2853+ url: "/public/secret%23/endpoint",
2854+ allowed: false,
2855+ },
27342856 {
27352857 name: "Route allowed",
2736− method: "GET",
2858+ method: http.MethodGet,
27372859 url: "/skip/auth/routes/get",
27382860 allowed: true,
27392861 },
@@ -2745,22 +2867,35 @@ func TestAllowedRequestWithForwardedUriHeader(t *testing.T) {
27452867 },
27462868 {
27472869 name: "Route denied with wrong path",
2748− method: "GET",
2870+ method: http.MethodGet,
27492871 url: "/skip/auth/routes/wrong/path",
27502872 allowed: false,
27512873 },
27522874 {
27532875 name: "Route denied with wrong path and method",
2754− method: "POST",
2876+ method: http.MethodPost,
27552877 url: "/skip/auth/routes/wrong/path",
27562878 allowed: false,
27572879 },
2880+ {
2881+ name: "Route allowed with fragment-free path",
2882+ method: http.MethodGet,
2883+ url: "/foo/public/bar",
2884+ allowed: true,
2885+ },
2886+ {
2887+ name: "Route denied when X-Forwarded-Uri contains an encoded fragment suffix",
2888+ method: http.MethodGet,
2889+ url: "/foo/secret%23/bar",
2890+ allowed: false,
2891+ },
27582892 }
27592893
27602894 for _, tc := range testCases {
27612895 t.Run(tc.name, func(t *testing.T) {
27622896 req, err := http.NewRequest(tc.method, opts.ProxyPrefix+authOnlyPath, nil)
27632897 req.Header.Set("X-Forwarded-Uri", tc.url)
2898+ req.RemoteAddr = "127.0.0.1:4180"
27642899 assert.NoError(t, err)
27652900
27662901 rw := httptest.NewRecorder()
@@ -2775,6 +2910,43 @@ func TestAllowedRequestWithForwardedUriHeader(t *testing.T) {
27752910 }
27762911}
27772912
2913+func TestAllowedRequestWithForwardedUriHeaderRequiresTrustedProxy(t *testing.T) {
2914+ upstreamServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
2915+ w.WriteHeader(200)
2916+ }))
2917+ t.Cleanup(upstreamServer.Close)
2918+
2919+ opts := baseTestOptions()
2920+ opts.ReverseProxy = true
2921+ opts.TrustedProxyIPs = []string{"127.0.0.1/32"}
2922+ opts.UpstreamServers = options.UpstreamConfig{
2923+ Upstreams: []options.Upstream{
2924+ {
2925+ ID: upstreamServer.URL,
2926+ Path: "/",
2927+ URI: upstreamServer.URL,
2928+ },
2929+ },
2930+ }
2931+ opts.SkipAuthRegex = []string{"^/skip/auth/regex$"}
2932+
2933+ err := validation.Validate(opts)
2934+ assert.NoError(t, err)
2935+
2936+ proxy, err := NewOAuthProxy(opts, func(_ string) bool { return true })
2937+ assert.NoError(t, err)
2938+
2939+ req, err := http.NewRequest(http.MethodGet, opts.ProxyPrefix+authOnlyPath, nil)
2940+ assert.NoError(t, err)
2941+ req.RemoteAddr = "192.0.2.10:4180"
2942+ req.Header.Set("X-Forwarded-Uri", "/skip/auth/regex")
2943+
2944+ rw := httptest.NewRecorder()
2945+ proxy.ServeHTTP(rw, req)
2946+
2947+ assert.Equal(t, 401, rw.Code)
2948+}
2949+
27782950func TestAllowedRequestNegateWithoutMethod(t *testing.T) {
27792951 upstreamServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
27802952 w.WriteHeader(200)
@@ -2814,37 +2986,37 @@ func TestAllowedRequestNegateWithoutMethod(t *testing.T) {
28142986 }{
28152987 {
28162988 name: "Some static file allowed",
2817− method: "GET",
2989+ method: http.MethodGet,
28182990 url: "/static/file.txt",
28192991 allowed: true,
28202992 },
28212993 {
28222994 name: "POST to contact form allowed",
2823− method: "POST",
2995+ method: http.MethodPost,
28242996 url: "/contact",
28252997 allowed: true,
28262998 },
28272999 {
28283000 name: "Regex POST allowed",
2829− method: "POST",
3001+ method: http.MethodPost,
28303002 url: "/api/public-entity",
28313003 allowed: true,
28323004 },
28333005 {
28343006 name: "Regex POST with trailing slash allowed",
2835− method: "POST",
3007+ method: http.MethodPost,
28363008 url: "/api/public-entity/",
28373009 allowed: true,
28383010 },
28393011 {
28403012 name: "Regex GET api route denied",
2841− method: "GET",
3013+ method: http.MethodGet,
28423014 url: "/api/users",
28433015 allowed: false,
28443016 },
28453017 {
28463018 name: "Regex POST api route denied",
2847− method: "POST",
3019+ method: http.MethodPost,
28483020 url: "/api/users",
28493021 allowed: false,
28503022 },
@@ -2914,37 +3086,37 @@ func TestAllowedRequestNegateWithMethod(t *testing.T) {
29143086 }{
29153087 {
29163088 name: "Some static file allowed",
2917− method: "GET",
3089+ method: http.MethodGet,
29183090 url: "/static/file.txt",
29193091 allowed: true,
29203092 },
29213093 {
29223094 name: "POST to contact form not allowed",
2923− method: "POST",
3095+ method: http.MethodPost,
29243096 url: "/contact",
29253097 allowed: false,
29263098 },
29273099 {
29283100 name: "Regex POST allowed",
2929− method: "POST",
3101+ method: http.MethodPost,
29303102 url: "/api/public-entity",
29313103 allowed: true,
29323104 },
29333105 {
29343106 name: "Regex POST with trailing slash allowed",
2935− method: "POST",
3107+ method: http.MethodPost,
29363108 url: "/api/public-entity/",
29373109 allowed: true,
29383110 },
29393111 {
29403112 name: "Regex GET api route denied",
2941− method: "GET",
3113+ method: http.MethodGet,
29423114 url: "/api/users",
29433115 allowed: false,
29443116 },
29453117 {
29463118 name: "Regex POST api route denied",
2947− method: "POST",
3119+ method: http.MethodPost,
29483120 url: "/api/users",
29493121 allowed: false,
29503122 },
@@ -3084,7 +3256,7 @@ func TestProxyAllowedGroups(t *testing.T) {
30843256 t.Fatal(err)
30853257 }
30863258
3087− test.req, _ = http.NewRequest("GET", fmt.Sprintf("/%s", tt.querystring), nil)
3259+ test.req, _ = http.NewRequest(http.MethodGet, fmt.Sprintf("/%s", tt.querystring), nil)
30883260
30893261 test.req.Header.Add("accept", applicationJSON)
30903262 err = test.SaveSession(session)
@@ -3228,7 +3400,7 @@ func TestAuthOnlyAllowedGroupsWithSkipMethods(t *testing.T) {
32283400 {
32293401 name: "UserWithGroupSkipAuthPreflight",
32303402 groups: []string{"a", "c"},
3231− method: "OPTIONS",
3403+ method: http.MethodOptions,
32323404 ip: "1.2.3.5:43670",
32333405 withSession: true,
32343406 expectedStatusCode: http.StatusAccepted,
@@ -3236,7 +3408,7 @@ func TestAuthOnlyAllowedGroupsWithSkipMethods(t *testing.T) {
32363408 {
32373409 name: "UserWithGroupTrustedIp",
32383410 groups: []string{"a", "c"},
3239− method: "GET",
3411+ method: http.MethodGet,
32403412 ip: "1.2.3.4:43670",
32413413 withSession: true,
32423414 expectedStatusCode: http.StatusAccepted,
@@ -3244,7 +3416,7 @@ func TestAuthOnlyAllowedGroupsWithSkipMethods(t *testing.T) {
32443416 {
32453417 name: "UserWithoutGroupSkipAuthPreflight",
32463418 groups: []string{"c"},
3247− method: "OPTIONS",
3419+ method: http.MethodOptions,
32483420 ip: "1.2.3.5:43670",
32493421 withSession: true,
32503422 expectedStatusCode: http.StatusForbidden,
@@ -3252,21 +3424,21 @@ func TestAuthOnlyAllowedGroupsWithSkipMethods(t *testing.T) {
32523424 {
32533425 name: "UserWithoutGroupTrustedIp",
32543426 groups: []string{"c"},
3255− method: "GET",
3427+ method: http.MethodGet,
32563428 ip: "1.2.3.4:43670",
32573429 withSession: true,
32583430 expectedStatusCode: http.StatusForbidden,
32593431 },
32603432 {
32613433 name: "UserWithoutSessionSkipAuthPreflight",
3262− method: "OPTIONS",
3434+ method: http.MethodOptions,
32633435 ip: "1.2.3.5:43670",
32643436 withSession: false,
32653437 expectedStatusCode: http.StatusAccepted,
32663438 },
32673439 {
32683440 name: "UserWithoutSessionTrustedIp",
3269− method: "GET",
3441+ method: http.MethodGet,
32703442 ip: "1.2.3.4:43670",
32713443 withSession: false,
32723444 expectedStatusCode: http.StatusAccepted,
@@ -3366,6 +3538,24 @@ func TestAuthOnlyAllowedEmailDomains(t *testing.T) {
33663538 querystring: "?allowed_email_domains=a.b.c.example.com,*.c.example.com",
33673539 expectedStatusCode: http.StatusAccepted,
33683540 },
3541+ {
3542+ name: "UserWithMultipleAtSignsExactDomain",
3543+ email: "attacker@evil.com@example.com",
3544+ querystring: "?allowed_email_domains=example.com",
3545+ expectedStatusCode: http.StatusForbidden,
3546+ },
3547+ {
3548+ name: "UserWithMultipleAtSignsWildcardDomain",
3549+ email: "attacker@evil.com@foo.example.com",
3550+ querystring: "?allowed_email_domains=*.example.com",
3551+ expectedStatusCode: http.StatusForbidden,
3552+ },
3553+ {
3554+ name: "UserWithMultipleAtSignsDotPrefixedDomain",
3555+ email: "attacker@evil.com@foo.example.com",
3556+ querystring: "?allowed_email_domains=.example.com",
3557+ expectedStatusCode: http.StatusForbidden,
3558+ },
33693559 }
33703560
33713561 for _, tc := range testCases {
@@ -3572,3 +3762,49 @@ func TestGetOAuthRedirectURI(t *testing.T) {
35723762 })
35733763 }
35743764}
3765+
3766+func TestIdTokenPlaceholderInSignOut(t *testing.T) {
3767+ opts := baseTestOptions()
3768+ opts.WhitelistDomains = []string{"my-oidc-provider.example.com"}
3769+
3770+ err := validation.Validate(opts)
3771+ assert.NoError(t, err)
3772+
3773+ const emailAddress = "john.doe@example.com"
3774+ const userName = "9fcab5c9b889a557"
3775+ created := time.Now()
3776+
3777+ session := &sessions.SessionState{
3778+ User: userName,
3779+ Groups: []string{"a", "b"},
3780+ Email: emailAddress,
3781+ IDToken: "eYjjjjjj.vvvv.ddd",
3782+ AccessToken: "oauth_token",
3783+ CreatedAt: &created,
3784+ }
3785+
3786+ proxy, err := NewOAuthProxy(opts, func(email string) bool {
3787+ return true
3788+ })
3789+ assert.NoError(t, err)
3790+
3791+ // Save the required session
3792+ rw := httptest.NewRecorder()
3793+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
3794+ err = proxy.sessionStore.Save(rw, req, session)
3795+ assert.NoError(t, err)
3796+
3797+ rw = httptest.NewRecorder()
3798+
3799+ rdUrl := url.QueryEscape("https://my-oidc-provider.example.com/sign_out_page?id_token_hint={id_token}&post_logout_redirect_uri=https://my-app.example.com/")
3800+ req, _ = http.NewRequest(http.MethodGet, "/oauth2/sign_out?rd="+rdUrl, nil)
3801+ req = middlewareapi.AddRequestScope(req, &middlewareapi.RequestScope{
3802+ RequestID: "11111111-2222-4333-8444-555555555555",
3803+ Session: session,
3804+ })
3805+
3806+ proxy.SignOut(rw, req)
3807+ newLocation := rw.Header().Values("Location")[0]
3808+
3809+ assert.Equal(t, "https://my-oidc-provider.example.com/sign_out_page?id_token_hint=eYjjjjjj.vvvv.ddd&post_logout_redirect_uri=https://my-app.example.com/", newLocation)
3810+}