@@ -15,6 +15,7 @@ import (
17 "github.com/coreos/go-oidc/v3/oidc"
17 "github.com/coreos/go-oidc/v3/oidc"
18+ middlewareapi "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/middleware"
18 "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/options"
19 "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/options"
19 "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/sessions"
20 "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/apis/sessions"
20 "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/authentication/hmacauth"
21 "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/authentication/hmacauth"
@@ -53,7 +54,7 @@ func TestRobotsTxt(t *testing.T) {
53 t.Fatal(err)
54 t.Fatal(err)
55 rw := httptest.NewRecorder()
56 rw := httptest.NewRecorder()
56− req, _ := http.NewRequest("GET", "/robots.txt", nil)
57+ req, _ := http.NewRequest(http.MethodGet, "/robots.txt", nil)
57 proxy.ServeHTTP(rw, req)
58 proxy.ServeHTTP(rw, req)
58 assert.Equal(t, 200, rw.Code)
59 assert.Equal(t, 200, rw.Code)
59 assert.Equal(t, "User-agent: *\nDisallow: /\n", rw.Body.String())
60 assert.Equal(t, "User-agent: *\nDisallow: /\n", rw.Body.String())
@@ -240,7 +241,7 @@ func TestBasicAuthPassword(t *testing.T) {
241 // Save the required session
242 // Save the required session
242 rw := httptest.NewRecorder()
243 rw := httptest.NewRecorder()
243− req, _ := http.NewRequest("GET", "/", nil)
244+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
244 err = proxy.sessionStore.Save(rw, req, &sessions.SessionState{
245 err = proxy.sessionStore.Save(rw, req, &sessions.SessionState{
245 Email: emailAddress,
246 Email: emailAddress,
@@ -249,7 +250,7 @@ func TestBasicAuthPassword(t *testing.T) {
249 // Extract the cookie value to inject into the test request
250 // Extract the cookie value to inject into the test request
250 cookie := rw.Header().Values("Set-Cookie")[0]
251 cookie := rw.Header().Values("Set-Cookie")[0]
252− req, _ = http.NewRequest("GET", "/", nil)
253+ req, _ = http.NewRequest(http.MethodGet, "/", nil)
253 req.Header.Set("Cookie", cookie)
254 req.Header.Set("Cookie", cookie)
254 rw = httptest.NewRecorder()
255 rw = httptest.NewRecorder()
255 proxy.ServeHTTP(rw, req)
256 proxy.ServeHTTP(rw, req)
@@ -299,14 +300,14 @@ func TestPassGroupsHeadersWithGroups(t *testing.T) {
300 // Save the required session
301 // Save the required session
301 rw := httptest.NewRecorder()
302 rw := httptest.NewRecorder()
302− req, _ := http.NewRequest("GET", "/", nil)
303+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
303 err = proxy.sessionStore.Save(rw, req, session)
304 err = proxy.sessionStore.Save(rw, req, session)
304 assert.NoError(t, err)
305 assert.NoError(t, err)
306 // Extract the cookie value to inject into the test request
307 // Extract the cookie value to inject into the test request
307 cookie := rw.Header().Values("Set-Cookie")[0]
308 cookie := rw.Header().Values("Set-Cookie")[0]
309− req, _ = http.NewRequest("GET", "/", nil)
310+ req, _ = http.NewRequest(http.MethodGet, "/", nil)
310 req.Header.Set("Cookie", cookie)
311 req.Header.Set("Cookie", cookie)
311 rw = httptest.NewRecorder()
312 rw = httptest.NewRecorder()
312 proxy.ServeHTTP(rw, req)
313 proxy.ServeHTTP(rw, req)
@@ -456,7 +457,7 @@ func (patTest *PassAccessTokenTest) getEndpointWithCookie(cookie string, endpoin
456 return 0, ""
457 return 0, ""
459− req, err := http.NewRequest("GET", endpoint, strings.NewReader(""))
460+ req, err := http.NewRequest(http.MethodGet, endpoint, strings.NewReader(""))
460 if err != nil {
461 if err != nil {
461 return 0, ""
462 return 0, ""
@@ -607,7 +608,7 @@ func NewSignInPageTest(skipProvider bool) (*SignInPageTest, error) {
608func (sipTest *SignInPageTest) GetEndpoint(endpoint string) (int, string) {
609func (sipTest *SignInPageTest) GetEndpoint(endpoint string) (int, string) {
609 rw := httptest.NewRecorder()
610 rw := httptest.NewRecorder()
610− req, _ := http.NewRequest("GET", endpoint, strings.NewReader(""))
611+ req, _ := http.NewRequest(http.MethodGet, endpoint, strings.NewReader(""))
611 sipTest.proxy.ServeHTTP(rw, req)
612 sipTest.proxy.ServeHTTP(rw, req)
612 return rw.Code, rw.Body.String()
613 return rw.Code, rw.Body.String()
@@ -712,6 +713,50 @@ func TestManualSignInCorrectCredentials(t *testing.T) {
712 assert.Equal(t, http.StatusFound, statusCode)
713 assert.Equal(t, http.StatusFound, statusCode)
716+func TestSignInPageClearsExistingSessionCookie(t *testing.T) {
717+ opts := baseTestOptions()
718+ err := validation.Validate(opts)
719+ require.NoError(t, err)
721+ proxy, err := NewOAuthProxy(opts, func(string) bool {
724+ require.NoError(t, err)
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",
732+ require.NoError(t, err)
734+ cookies := saveRW.Result().Cookies()
735+ require.NotEmpty(t, cookies)
737+ // Send that cookie to the sign-in page.
738+ req := httptest.NewRequest(http.MethodGet, "/oauth2/sign_in", nil)
739+ for _, c := range cookies {
743+ rw := httptest.NewRecorder()
744+ proxy.ServeHTTP(rw, req)
746+ assert.Equal(t, http.StatusOK, rw.Code)
749+ for _, c := range rw.Result().Cookies() {
750+ if c.Name == proxy.CookieOptions.Name {
752+ assert.Equal(t, "", c.Value)
753+ assert.Less(t, c.MaxAge, 0)
757+ assert.True(t, cleared, "expected sign-in page to clear existing session cookie")
715func TestSignInPageIncludesTargetRedirect(t *testing.T) {
760func TestSignInPageIncludesTargetRedirect(t *testing.T) {
716 sipTest, err := NewSignInPageTest(false)
761 sipTest, err := NewSignInPageTest(false)
717 if err != nil {
762 if err != nil {
@@ -849,7 +894,7 @@ func NewProcessCookieTest(opts ProcessCookieTestOpts, modifiers ...OptionsModifi
849 // access_token validation.
894 // access_token validation.
850 pcTest.proxy.CookieOptions.Refresh = time.Duration(0)
895 pcTest.proxy.CookieOptions.Refresh = time.Duration(0)
851 pcTest.rw = httptest.NewRecorder()
896 pcTest.rw = httptest.NewRecorder()
852− pcTest.req, _ = http.NewRequest("GET", "/", strings.NewReader(""))
897+ pcTest.req, _ = http.NewRequest(http.MethodGet, "/", strings.NewReader(""))
853 pcTest.validateUser = true
898 pcTest.validateUser = true
854 return &pcTest, nil
899 return &pcTest, nil
@@ -982,7 +1027,7 @@ func NewUserInfoEndpointTest() (*ProcessCookieTest, error) {
982 if err != nil {
1027 if err != nil {
983 return nil, err
1028 return nil, err
985− pcTest.req, _ = http.NewRequest("GET",
1030+ pcTest.req, _ = http.NewRequest(http.MethodGet,
986 pcTest.opts.ProxyPrefix+"/userinfo", nil)
1031 pcTest.opts.ProxyPrefix+"/userinfo", nil)
987 return pcTest, nil
1032 return pcTest, nil
@@ -1032,6 +1077,20 @@ func TestUserInfoEndpointAccepted(t *testing.T) {
1033 expectedResponse: "{\"user\":\"john.doe\",\"email\":\"john.doe@example.com\",\"groups\":[\"example\",\"groups\"],\"preferredUsername\":\"john\"}\n",
1078 expectedResponse: "{\"user\":\"john.doe\",\"email\":\"john.doe@example.com\",\"groups\":[\"example\",\"groups\"],\"preferredUsername\":\"john\"}\n",
1081+ name: "With Additional Claim",
1082+ session: &sessions.SessionState{
1084+ PreferredUsername: "john",
1085+ Email: "john.doe@example.com",
1086+ Groups: []string{"example", "groups"},
1087+ AccessToken: "my_access_token",
1088+ AdditionalClaims: map[string]interface{}{
1092+ expectedResponse: "{\"user\":\"john.doe\",\"email\":\"john.doe@example.com\",\"groups\":[\"example\",\"groups\"],\"preferredUsername\":\"john\",\"additionalClaims\":{\"foo\":\"bar\"}}\n",
1037 for _, tc := range testCases {
1096 for _, tc := range testCases {
@@ -1076,7 +1135,7 @@ func NewAuthOnlyEndpointTest(querystring string, modifiers ...OptionsModifier) (
1076 return nil, err
1135 return nil, err
1078 pcTest.req, _ = http.NewRequest(
1137 pcTest.req, _ = http.NewRequest(
1079− "GET",
1138+ http.MethodGet,
1080 fmt.Sprintf("%s/auth%s", pcTest.opts.ProxyPrefix, querystring),
1139 fmt.Sprintf("%s/auth%s", pcTest.opts.ProxyPrefix, querystring),
1082 return pcTest, nil
1141 return pcTest, nil
@@ -1215,7 +1274,7 @@ func TestAuthOnlyEndpointSetXAuthRequestHeaders(t *testing.T) {
1215 pcTest.validateUser = true
1274 pcTest.validateUser = true
1217 pcTest.rw = httptest.NewRecorder()
1276 pcTest.rw = httptest.NewRecorder()
1218− pcTest.req, _ = http.NewRequest("GET",
1277+ pcTest.req, _ = http.NewRequest(http.MethodGet,
1219 pcTest.opts.ProxyPrefix+authOnlyPath, nil)
1278 pcTest.opts.ProxyPrefix+authOnlyPath, nil)
1221 created := time.Now()
1280 created := time.Now()
@@ -1308,7 +1367,7 @@ func TestAuthOnlyEndpointSetBasicAuthTrueRequestHeaders(t *testing.T) {
1308 pcTest.validateUser = true
1367 pcTest.validateUser = true
1310 pcTest.rw = httptest.NewRecorder()
1369 pcTest.rw = httptest.NewRecorder()
1311− pcTest.req, _ = http.NewRequest("GET",
1370+ pcTest.req, _ = http.NewRequest(http.MethodGet,
1312 pcTest.opts.ProxyPrefix+authOnlyPath, nil)
1371 pcTest.opts.ProxyPrefix+authOnlyPath, nil)
1314 created := time.Now()
1373 created := time.Now()
@@ -1388,7 +1447,7 @@ func TestAuthOnlyEndpointSetBasicAuthFalseRequestHeaders(t *testing.T) {
1388 pcTest.validateUser = true
1447 pcTest.validateUser = true
1390 pcTest.rw = httptest.NewRecorder()
1449 pcTest.rw = httptest.NewRecorder()
1391− pcTest.req, _ = http.NewRequest("GET",
1450+ pcTest.req, _ = http.NewRequest(http.MethodGet,
1392 pcTest.opts.ProxyPrefix+authOnlyPath, nil)
1451 pcTest.opts.ProxyPrefix+authOnlyPath, nil)
1394 created := time.Now()
1453 created := time.Now()
@@ -1436,7 +1495,7 @@ func TestAuthSkippedForPreflightRequests(t *testing.T) {
1437 proxy.provider = NewTestProvider(upstreamURL, "")
1496 proxy.provider = NewTestProvider(upstreamURL, "")
1438 rw := httptest.NewRecorder()
1497 rw := httptest.NewRecorder()
1439− req, _ := http.NewRequest("OPTIONS", "/preflight-request", nil)
1498+ req, _ := http.NewRequest(http.MethodOptions, "/preflight-request", nil)
1440 proxy.ServeHTTP(rw, req)
1499 proxy.ServeHTTP(rw, req)
1442 assert.Equal(t, 200, rw.Code)
1501 assert.Equal(t, 200, rw.Code)
@@ -1593,19 +1652,19 @@ func TestRequestSignature(t *testing.T) {
1593 resp string
1652 resp string
1595 "No request signature": {
1654 "No request signature": {
1596− method: "GET",
1655+ method: http.MethodGet,
1597 body: "",
1656 body: "",
1598 key: "",
1657 key: "",
1599 resp: "no signature received",
1658 resp: "no signature received",
1601 "Get request": {
1660 "Get request": {
1602− method: "GET",
1661+ method: http.MethodGet,
1603 body: "",
1662 body: "",
1604 key: "7d9e1aa87a5954e6f9fc59266b3af9d7c35fda2d",
1663 key: "7d9e1aa87a5954e6f9fc59266b3af9d7c35fda2d",
1605 resp: "signatures match",
1664 resp: "signatures match",
1607 "Post request": {
1666 "Post request": {
1608− method: "POST",
1667+ method: http.MethodPost,
1609 body: `{ "hello": "world!" }`,
1668 body: `{ "hello": "world!" }`,
1610 key: "d90df39e2d19282840252612dd7c81421a372f61",
1669 key: "d90df39e2d19282840252612dd7c81421a372f61",
1611 resp: "signatures match",
1670 resp: "signatures match",
@@ -2028,6 +2087,44 @@ func Test_noCacheHeaders(t *testing.T) {
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)
2097+ defer backendLogoutServer.Close()
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)
2104+ proxy, err := NewOAuthProxy(opts, func(string) bool { return true })
2105+ require.NoError(t, err)
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,
2114+ require.NoError(t, err)
2115+ cookie := rw.Header().Values("Set-Cookie")[0]
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)
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")
2031func baseTestOptions() *options.Options {
2128func baseTestOptions() *options.Options {
2032 opts := options.NewOptions()
2129 opts := options.NewOptions()
2033 opts.Cookie.Secret = rawCookieSecret
2130 opts.Cookie.Secret = rawCookieSecret
@@ -2092,7 +2189,33 @@ func TestTrustedIPs(t *testing.T) {
2092 reverseProxy: false,
2189 reverseProxy: false,
2093 realClientIPHeader: "X-Real-IP", // Default value
2190 realClientIPHeader: "X-Real-IP", // Default value
2094 req: func() *http.Request {
2191 req: func() *http.Request {
2095− req, _ := http.NewRequest("GET", "/", nil)
2192+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2195+ expectTrusted: false,
2197+ // Check Unix socket with no trusted IPs configured does not error.
2199+ name: "UnixSocketWithoutTrustedIPs",
2201+ reverseProxy: false,
2202+ realClientIPHeader: "X-Real-IP",
2203+ req: func() *http.Request {
2204+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2205+ req.RemoteAddr = "@"
2208+ expectTrusted: false,
2210+ // Check Unix socket with trusted IPs configured returns false (no IP to match).
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 = "@"
2096 return req
2219 return req
2098 expectTrusted: false,
2221 expectTrusted: false,
@@ -2104,7 +2227,7 @@ func TestTrustedIPs(t *testing.T) {
2104 reverseProxy: false,
2227 reverseProxy: false,
2105 realClientIPHeader: "X-Real-IP", // Default value
2228 realClientIPHeader: "X-Real-IP", // Default value
2106 req: func() *http.Request {
2229 req: func() *http.Request {
2107− req, _ := http.NewRequest("GET", "/", nil)
2230+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2108 req.RemoteAddr = "127.0.0.1:43670"
2231 req.RemoteAddr = "127.0.0.1:43670"
2109 return req
2232 return req
@@ -2117,7 +2240,7 @@ func TestTrustedIPs(t *testing.T) {
2117 reverseProxy: true,
2240 reverseProxy: true,
2118 realClientIPHeader: "X-Real-IP", // Default value
2241 realClientIPHeader: "X-Real-IP", // Default value
2119 req: func() *http.Request {
2242 req: func() *http.Request {
2120− req, _ := http.NewRequest("GET", "/", nil)
2243+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2121 req.RemoteAddr = "127.0.0.1:44324"
2244 req.RemoteAddr = "127.0.0.1:44324"
2122 return req
2245 return req
@@ -2130,7 +2253,7 @@ func TestTrustedIPs(t *testing.T) {
2130 reverseProxy: true,
2253 reverseProxy: true,
2131 realClientIPHeader: "X-Forwarded-For",
2254 realClientIPHeader: "X-Forwarded-For",
2132 req: func() *http.Request {
2255 req: func() *http.Request {
2133− req, _ := http.NewRequest("GET", "/", nil)
2256+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2134 req.Header.Add("X-Forwarded-For", "127.0.0.1")
2257 req.Header.Add("X-Forwarded-For", "127.0.0.1")
2135 return req
2258 return req
@@ -2143,7 +2266,7 @@ func TestTrustedIPs(t *testing.T) {
2143 reverseProxy: true,
2266 reverseProxy: true,
2144 realClientIPHeader: "X-Forwarded-For",
2267 realClientIPHeader: "X-Forwarded-For",
2145 req: func() *http.Request {
2268 req: func() *http.Request {
2146− req, _ := http.NewRequest("GET", "/", nil)
2269+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2147 req.Header.Add("X-Forwarded-For", "::1")
2270 req.Header.Add("X-Forwarded-For", "::1")
2148 return req
2271 return req
@@ -2156,7 +2279,7 @@ func TestTrustedIPs(t *testing.T) {
2156 reverseProxy: true,
2279 reverseProxy: true,
2157 realClientIPHeader: "X-Forwarded-For",
2280 realClientIPHeader: "X-Forwarded-For",
2158 req: func() *http.Request {
2281 req: func() *http.Request {
2159− req, _ := http.NewRequest("GET", "/", nil)
2282+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2160 req.Header.Add("X-Forwarded-For", "12.34.56.78")
2283 req.Header.Add("X-Forwarded-For", "12.34.56.78")
2161 return req
2284 return req
@@ -2169,7 +2292,7 @@ func TestTrustedIPs(t *testing.T) {
2169 reverseProxy: true,
2292 reverseProxy: true,
2170 realClientIPHeader: "X-Forwarded-For",
2293 realClientIPHeader: "X-Forwarded-For",
2171 req: func() *http.Request {
2294 req: func() *http.Request {
2172− req, _ := http.NewRequest("GET", "/", nil)
2295+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2173 req.Header.Add("X-Forwarded-For", "::2")
2296 req.Header.Add("X-Forwarded-For", "::2")
2174 return req
2297 return req
@@ -2182,7 +2305,7 @@ func TestTrustedIPs(t *testing.T) {
2182 reverseProxy: true,
2305 reverseProxy: true,
2183 realClientIPHeader: "X-Forwarded-For",
2306 realClientIPHeader: "X-Forwarded-For",
2184 req: func() *http.Request {
2307 req: func() *http.Request {
2185− req, _ := http.NewRequest("GET", "/", nil)
2308+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2186 req.Header.Add("X-Real-IP", "::1")
2309 req.Header.Add("X-Real-IP", "::1")
2187 return req
2310 return req
@@ -2195,7 +2318,7 @@ func TestTrustedIPs(t *testing.T) {
2195 reverseProxy: true,
2318 reverseProxy: true,
2196 realClientIPHeader: "X-Forwarded-For",
2319 realClientIPHeader: "X-Forwarded-For",
2197 req: func() *http.Request {
2320 req: func() *http.Request {
2198− req, _ := http.NewRequest("GET", "/", nil)
2321+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2199 req.Header.Add("X-Forwarded-For", "adsfljk29242as!!")
2322 req.Header.Add("X-Forwarded-For", "adsfljk29242as!!")
2200 return req
2323 return req
@@ -2208,7 +2331,7 @@ func TestTrustedIPs(t *testing.T) {
2208 reverseProxy: false,
2331 reverseProxy: false,
2209 realClientIPHeader: "X-Real-IP",
2332 realClientIPHeader: "X-Real-IP",
2210 req: func() *http.Request {
2333 req: func() *http.Request {
2211− req, _ := http.NewRequest("GET", "/", nil)
2334+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2212 req.RemoteAddr = "adsfljk29242as!!"
2335 req.RemoteAddr = "adsfljk29242as!!"
2213 return req
2336 return req
@@ -2304,12 +2427,12 @@ func Test_buildRoutesAllowlist(t *testing.T) {
2305 expectedRoutes: []expectedAllowedRoute{
2428 expectedRoutes: []expectedAllowedRoute{
2307− method: "GET",
2430+ method: http.MethodGet,
2308 negate: false,
2431 negate: false,
2309 regexString: "^/foo/bar",
2432 regexString: "^/foo/bar",
2312− method: "POST",
2435+ method: http.MethodPost,
2313 negate: false,
2436 negate: false,
2314 regexString: "^/baz/[0-9]+/thing",
2437 regexString: "^/baz/[0-9]+/thing",
@@ -2362,11 +2485,11 @@ func Test_buildRoutesAllowlist(t *testing.T) {
2362 regexString: "^/baz/[0-9]+/thing/regex",
2485 regexString: "^/baz/[0-9]+/thing/regex",
2365− method: "GET",
2488+ method: http.MethodGet,
2366 regexString: "^/foo/bar",
2489 regexString: "^/foo/bar",
2369− method: "POST",
2492+ method: http.MethodPost,
2370 regexString: "^/baz/[0-9]+/thing",
2493 regexString: "^/baz/[0-9]+/thing",
@@ -2518,7 +2641,7 @@ func TestApiRoutes(t *testing.T) {
2519 for _, tc := range testCases {
2642 for _, tc := range testCases {
2520 t.Run(tc.name, func(t *testing.T) {
2643 t.Run(tc.name, func(t *testing.T) {
2521− req, err := http.NewRequest("GET", tc.url, nil)
2644+ req, err := http.NewRequest(http.MethodGet, tc.url, nil)
2522 req.Header.Set("Accept", tc.contentType)
2645 req.Header.Set("Accept", tc.contentType)
2523 assert.NoError(t, err)
2646 assert.NoError(t, err)
@@ -2556,9 +2679,11 @@ func TestAllowedRequest(t *testing.T) {
2557 opts.SkipAuthRegex = []string{
2680 opts.SkipAuthRegex = []string{
2558 "^/skip/auth/regex$",
2681 "^/skip/auth/regex$",
2682+ "^/public/.*/endpoint$",
2560 opts.SkipAuthRoutes = []string{
2684 opts.SkipAuthRoutes = []string{
2561 "GET=^/skip/auth/routes/get",
2685 "GET=^/skip/auth/routes/get",
2563 err := validation.Validate(opts)
2688 err := validation.Validate(opts)
2564 assert.NoError(t, err)
2689 assert.NoError(t, err)
@@ -2575,25 +2700,37 @@ func TestAllowedRequest(t *testing.T) {
2577 name: "Regex GET allowed",
2702 name: "Regex GET allowed",
2578− method: "GET",
2703+ method: http.MethodGet,
2579 url: "/skip/auth/regex",
2704 url: "/skip/auth/regex",
2580 allowed: true,
2705 allowed: true,
2583 name: "Regex POST allowed ",
2708 name: "Regex POST allowed ",
2584− method: "POST",
2709+ method: http.MethodPost,
2585 url: "/skip/auth/regex",
2710 url: "/skip/auth/regex",
2586 allowed: true,
2711 allowed: true,
2589 name: "Regex denied",
2714 name: "Regex denied",
2590− method: "GET",
2715+ method: http.MethodGet,
2591 url: "/wrong/denied",
2716 url: "/wrong/denied",
2592 allowed: false,
2717 allowed: false,
2720+ name: "Regex allowed with fragment-free path",
2721+ method: http.MethodGet,
2722+ url: "/public/legit/endpoint",
2726+ name: "Regex denied when path contains encoded fragment suffix",
2727+ method: http.MethodGet,
2728+ url: "/public/secret%23/endpoint",
2595 name: "Route allowed",
2732 name: "Route allowed",
2596− method: "GET",
2733+ method: http.MethodGet,
2597 url: "/skip/auth/routes/get",
2734 url: "/skip/auth/routes/get",
2598 allowed: true,
2735 allowed: true,
@@ -2605,16 +2742,28 @@ func TestAllowedRequest(t *testing.T) {
2607 name: "Route denied with wrong path",
2744 name: "Route denied with wrong path",
2608− method: "GET",
2745+ method: http.MethodGet,
2609 url: "/skip/auth/routes/wrong/path",
2746 url: "/skip/auth/routes/wrong/path",
2610 allowed: false,
2747 allowed: false,
2613 name: "Route denied with wrong path and method",
2750 name: "Route denied with wrong path and method",
2614− method: "POST",
2751+ method: http.MethodPost,
2615 url: "/skip/auth/routes/wrong/path",
2752 url: "/skip/auth/routes/wrong/path",
2616 allowed: false,
2753 allowed: false,
2756+ name: "Route allowed with fragment-free path",
2757+ method: http.MethodGet,
2758+ url: "/foo/public/bar",
2762+ name: "Route denied when path contains encoded fragment suffix",
2763+ method: http.MethodGet,
2764+ url: "/foo/secret%23/bar",
2620 for _, tc := range testCases {
2769 for _, tc := range testCases {
@@ -2655,9 +2804,11 @@ func TestAllowedRequestWithForwardedUriHeader(t *testing.T) {
2656 opts.SkipAuthRegex = []string{
2805 opts.SkipAuthRegex = []string{
2657 "^/skip/auth/regex$",
2806 "^/skip/auth/regex$",
2807+ "^/public/.*/endpoint$",
2659 opts.SkipAuthRoutes = []string{
2809 opts.SkipAuthRoutes = []string{
2660 "GET=^/skip/auth/routes/get",
2810 "GET=^/skip/auth/routes/get",
2662 err := validation.Validate(opts)
2813 err := validation.Validate(opts)
2663 assert.NoError(t, err)
2814 assert.NoError(t, err)
@@ -2674,25 +2825,37 @@ func TestAllowedRequestWithForwardedUriHeader(t *testing.T) {
2676 name: "Regex GET allowed",
2827 name: "Regex GET allowed",
2677− method: "GET",
2828+ method: http.MethodGet,
2678 url: "/skip/auth/regex",
2829 url: "/skip/auth/regex",
2679 allowed: true,
2830 allowed: true,
2682 name: "Regex POST allowed ",
2833 name: "Regex POST allowed ",
2683− method: "POST",
2834+ method: http.MethodPost,
2684 url: "/skip/auth/regex",
2835 url: "/skip/auth/regex",
2685 allowed: true,
2836 allowed: true,
2688 name: "Regex denied",
2839 name: "Regex denied",
2689− method: "GET",
2840+ method: http.MethodGet,
2690 url: "/wrong/denied",
2841 url: "/wrong/denied",
2691 allowed: false,
2842 allowed: false,
2845+ name: "Regex allowed with fragment-free path",
2846+ method: http.MethodGet,
2847+ url: "/public/legit/endpoint",
2851+ name: "Regex denied when X-Forwarded-Uri contains an encoded fragment suffix",
2852+ method: http.MethodGet,
2853+ url: "/public/secret%23/endpoint",
2694 name: "Route allowed",
2857 name: "Route allowed",
2695− method: "GET",
2858+ method: http.MethodGet,
2696 url: "/skip/auth/routes/get",
2859 url: "/skip/auth/routes/get",
2697 allowed: true,
2860 allowed: true,
@@ -2704,22 +2867,35 @@ func TestAllowedRequestWithForwardedUriHeader(t *testing.T) {
2706 name: "Route denied with wrong path",
2869 name: "Route denied with wrong path",
2707− method: "GET",
2870+ method: http.MethodGet,
2708 url: "/skip/auth/routes/wrong/path",
2871 url: "/skip/auth/routes/wrong/path",
2709 allowed: false,
2872 allowed: false,
2712 name: "Route denied with wrong path and method",
2875 name: "Route denied with wrong path and method",
2713− method: "POST",
2876+ method: http.MethodPost,
2714 url: "/skip/auth/routes/wrong/path",
2877 url: "/skip/auth/routes/wrong/path",
2715 allowed: false,
2878 allowed: false,
2881+ name: "Route allowed with fragment-free path",
2882+ method: http.MethodGet,
2883+ url: "/foo/public/bar",
2887+ name: "Route denied when X-Forwarded-Uri contains an encoded fragment suffix",
2888+ method: http.MethodGet,
2889+ url: "/foo/secret%23/bar",
2719 for _, tc := range testCases {
2894 for _, tc := range testCases {
2720 t.Run(tc.name, func(t *testing.T) {
2895 t.Run(tc.name, func(t *testing.T) {
2721 req, err := http.NewRequest(tc.method, opts.ProxyPrefix+authOnlyPath, nil)
2896 req, err := http.NewRequest(tc.method, opts.ProxyPrefix+authOnlyPath, nil)
2722 req.Header.Set("X-Forwarded-Uri", tc.url)
2897 req.Header.Set("X-Forwarded-Uri", tc.url)
2898+ req.RemoteAddr = "127.0.0.1:4180"
2723 assert.NoError(t, err)
2899 assert.NoError(t, err)
2725 rw := httptest.NewRecorder()
2901 rw := httptest.NewRecorder()
@@ -2734,6 +2910,43 @@ func TestAllowedRequestWithForwardedUriHeader(t *testing.T) {
2913+func TestAllowedRequestWithForwardedUriHeaderRequiresTrustedProxy(t *testing.T) {
2914+ upstreamServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
2917+ t.Cleanup(upstreamServer.Close)
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{
2925+ ID: upstreamServer.URL,
2927+ URI: upstreamServer.URL,
2931+ opts.SkipAuthRegex = []string{"^/skip/auth/regex$"}
2933+ err := validation.Validate(opts)
2934+ assert.NoError(t, err)
2936+ proxy, err := NewOAuthProxy(opts, func(_ string) bool { return true })
2937+ assert.NoError(t, err)
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")
2944+ rw := httptest.NewRecorder()
2945+ proxy.ServeHTTP(rw, req)
2947+ assert.Equal(t, 401, rw.Code)
2737func TestAllowedRequestNegateWithoutMethod(t *testing.T) {
2950func TestAllowedRequestNegateWithoutMethod(t *testing.T) {
2738 upstreamServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
2951 upstreamServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
2739 w.WriteHeader(200)
2952 w.WriteHeader(200)
@@ -2773,37 +2986,37 @@ func TestAllowedRequestNegateWithoutMethod(t *testing.T) {
2775 name: "Some static file allowed",
2988 name: "Some static file allowed",
2776− method: "GET",
2989+ method: http.MethodGet,
2777 url: "/static/file.txt",
2990 url: "/static/file.txt",
2778 allowed: true,
2991 allowed: true,
2781 name: "POST to contact form allowed",
2994 name: "POST to contact form allowed",
2782− method: "POST",
2995+ method: http.MethodPost,
2783 url: "/contact",
2996 url: "/contact",
2784 allowed: true,
2997 allowed: true,
2787 name: "Regex POST allowed",
3000 name: "Regex POST allowed",
2788− method: "POST",
3001+ method: http.MethodPost,
2789 url: "/api/public-entity",
3002 url: "/api/public-entity",
2790 allowed: true,
3003 allowed: true,
2793 name: "Regex POST with trailing slash allowed",
3006 name: "Regex POST with trailing slash allowed",
2794− method: "POST",
3007+ method: http.MethodPost,
2795 url: "/api/public-entity/",
3008 url: "/api/public-entity/",
2796 allowed: true,
3009 allowed: true,
2799 name: "Regex GET api route denied",
3012 name: "Regex GET api route denied",
2800− method: "GET",
3013+ method: http.MethodGet,
2801 url: "/api/users",
3014 url: "/api/users",
2802 allowed: false,
3015 allowed: false,
2805 name: "Regex POST api route denied",
3018 name: "Regex POST api route denied",
2806− method: "POST",
3019+ method: http.MethodPost,
2807 url: "/api/users",
3020 url: "/api/users",
2808 allowed: false,
3021 allowed: false,
@@ -2873,37 +3086,37 @@ func TestAllowedRequestNegateWithMethod(t *testing.T) {
2875 name: "Some static file allowed",
3088 name: "Some static file allowed",
2876− method: "GET",
3089+ method: http.MethodGet,
2877 url: "/static/file.txt",
3090 url: "/static/file.txt",
2878 allowed: true,
3091 allowed: true,
2881 name: "POST to contact form not allowed",
3094 name: "POST to contact form not allowed",
2882− method: "POST",
3095+ method: http.MethodPost,
2883 url: "/contact",
3096 url: "/contact",
2884 allowed: false,
3097 allowed: false,
2887 name: "Regex POST allowed",
3100 name: "Regex POST allowed",
2888− method: "POST",
3101+ method: http.MethodPost,
2889 url: "/api/public-entity",
3102 url: "/api/public-entity",
2890 allowed: true,
3103 allowed: true,
2893 name: "Regex POST with trailing slash allowed",
3106 name: "Regex POST with trailing slash allowed",
2894− method: "POST",
3107+ method: http.MethodPost,
2895 url: "/api/public-entity/",
3108 url: "/api/public-entity/",
2896 allowed: true,
3109 allowed: true,
2899 name: "Regex GET api route denied",
3112 name: "Regex GET api route denied",
2900− method: "GET",
3113+ method: http.MethodGet,
2901 url: "/api/users",
3114 url: "/api/users",
2902 allowed: false,
3115 allowed: false,
2905 name: "Regex POST api route denied",
3118 name: "Regex POST api route denied",
2906− method: "POST",
3119+ method: http.MethodPost,
2907 url: "/api/users",
3120 url: "/api/users",
2908 allowed: false,
3121 allowed: false,
@@ -3043,7 +3256,7 @@ func TestProxyAllowedGroups(t *testing.T) {
3043 t.Fatal(err)
3256 t.Fatal(err)
3046− test.req, _ = http.NewRequest("GET", fmt.Sprintf("/%s", tt.querystring), nil)
3259+ test.req, _ = http.NewRequest(http.MethodGet, fmt.Sprintf("/%s", tt.querystring), nil)
3048 test.req.Header.Add("accept", applicationJSON)
3261 test.req.Header.Add("accept", applicationJSON)
3049 err = test.SaveSession(session)
3262 err = test.SaveSession(session)
@@ -3187,7 +3400,7 @@ func TestAuthOnlyAllowedGroupsWithSkipMethods(t *testing.T) {
3188 name: "UserWithGroupSkipAuthPreflight",
3401 name: "UserWithGroupSkipAuthPreflight",
3189 groups: []string{"a", "c"},
3402 groups: []string{"a", "c"},
3190− method: "OPTIONS",
3403+ method: http.MethodOptions,
3191 ip: "1.2.3.5:43670",
3404 ip: "1.2.3.5:43670",
3192 withSession: true,
3405 withSession: true,
3193 expectedStatusCode: http.StatusAccepted,
3406 expectedStatusCode: http.StatusAccepted,
@@ -3195,7 +3408,7 @@ func TestAuthOnlyAllowedGroupsWithSkipMethods(t *testing.T) {
3196 name: "UserWithGroupTrustedIp",
3409 name: "UserWithGroupTrustedIp",
3197 groups: []string{"a", "c"},
3410 groups: []string{"a", "c"},
3198− method: "GET",
3411+ method: http.MethodGet,
3199 ip: "1.2.3.4:43670",
3412 ip: "1.2.3.4:43670",
3200 withSession: true,
3413 withSession: true,
3201 expectedStatusCode: http.StatusAccepted,
3414 expectedStatusCode: http.StatusAccepted,
@@ -3203,7 +3416,7 @@ func TestAuthOnlyAllowedGroupsWithSkipMethods(t *testing.T) {
3204 name: "UserWithoutGroupSkipAuthPreflight",
3417 name: "UserWithoutGroupSkipAuthPreflight",
3205 groups: []string{"c"},
3418 groups: []string{"c"},
3206− method: "OPTIONS",
3419+ method: http.MethodOptions,
3207 ip: "1.2.3.5:43670",
3420 ip: "1.2.3.5:43670",
3208 withSession: true,
3421 withSession: true,
3209 expectedStatusCode: http.StatusForbidden,
3422 expectedStatusCode: http.StatusForbidden,
@@ -3211,21 +3424,21 @@ func TestAuthOnlyAllowedGroupsWithSkipMethods(t *testing.T) {
3212 name: "UserWithoutGroupTrustedIp",
3425 name: "UserWithoutGroupTrustedIp",
3213 groups: []string{"c"},
3426 groups: []string{"c"},
3214− method: "GET",
3427+ method: http.MethodGet,
3215 ip: "1.2.3.4:43670",
3428 ip: "1.2.3.4:43670",
3216 withSession: true,
3429 withSession: true,
3217 expectedStatusCode: http.StatusForbidden,
3430 expectedStatusCode: http.StatusForbidden,
3220 name: "UserWithoutSessionSkipAuthPreflight",
3433 name: "UserWithoutSessionSkipAuthPreflight",
3221− method: "OPTIONS",
3434+ method: http.MethodOptions,
3222 ip: "1.2.3.5:43670",
3435 ip: "1.2.3.5:43670",
3223 withSession: false,
3436 withSession: false,
3224 expectedStatusCode: http.StatusAccepted,
3437 expectedStatusCode: http.StatusAccepted,
3227 name: "UserWithoutSessionTrustedIp",
3440 name: "UserWithoutSessionTrustedIp",
3228− method: "GET",
3441+ method: http.MethodGet,
3229 ip: "1.2.3.4:43670",
3442 ip: "1.2.3.4:43670",
3230 withSession: false,
3443 withSession: false,
3231 expectedStatusCode: http.StatusAccepted,
3444 expectedStatusCode: http.StatusAccepted,
@@ -3325,6 +3538,24 @@ func TestAuthOnlyAllowedEmailDomains(t *testing.T) {
3325 querystring: "?allowed_email_domains=a.b.c.example.com,*.c.example.com",
3538 querystring: "?allowed_email_domains=a.b.c.example.com,*.c.example.com",
3326 expectedStatusCode: http.StatusAccepted,
3539 expectedStatusCode: http.StatusAccepted,
3542+ name: "UserWithMultipleAtSignsExactDomain",
3543+ email: "attacker@evil.com@example.com",
3544+ querystring: "?allowed_email_domains=example.com",
3545+ expectedStatusCode: http.StatusForbidden,
3548+ name: "UserWithMultipleAtSignsWildcardDomain",
3549+ email: "attacker@evil.com@foo.example.com",
3550+ querystring: "?allowed_email_domains=*.example.com",
3551+ expectedStatusCode: http.StatusForbidden,
3554+ name: "UserWithMultipleAtSignsDotPrefixedDomain",
3555+ email: "attacker@evil.com@foo.example.com",
3556+ querystring: "?allowed_email_domains=.example.com",
3557+ expectedStatusCode: http.StatusForbidden,
3330 for _, tc := range testCases {
3561 for _, tc := range testCases {
@@ -3531,3 +3762,49 @@ func TestGetOAuthRedirectURI(t *testing.T) {
3766+func TestIdTokenPlaceholderInSignOut(t *testing.T) {
3767+ opts := baseTestOptions()
3768+ opts.WhitelistDomains = []string{"my-oidc-provider.example.com"}
3770+ err := validation.Validate(opts)
3771+ assert.NoError(t, err)
3773+ const emailAddress = "john.doe@example.com"
3774+ const userName = "9fcab5c9b889a557"
3775+ created := time.Now()
3777+ session := &sessions.SessionState{
3779+ Groups: []string{"a", "b"},
3780+ Email: emailAddress,
3781+ IDToken: "eYjjjjjj.vvvv.ddd",
3782+ AccessToken: "oauth_token",
3783+ CreatedAt: &created,
3786+ proxy, err := NewOAuthProxy(opts, func(email string) bool {
3789+ assert.NoError(t, err)
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)
3797+ rw = httptest.NewRecorder()
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",
3806+ proxy.SignOut(rw, req)
3807+ newLocation := rw.Header().Values("Location")[0]
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)