@@ -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"
@@ -23,6 +24,7 @@ import (
23 internaloidc "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/providers/oidc"
24 internaloidc "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/providers/oidc"
24 sessionscookie "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/sessions/cookie"
25 sessionscookie "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/sessions/cookie"
25 "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/upstream"
26 "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/upstream"
27+ "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/util/ptr"
26 "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/validation"
28 "github.com/oauth2-proxy/oauth2-proxy/v7/pkg/validation"
27 "github.com/oauth2-proxy/oauth2-proxy/v7/providers"
29 "github.com/oauth2-proxy/oauth2-proxy/v7/providers"
28 "github.com/stretchr/testify/assert"
30 "github.com/stretchr/testify/assert"
@@ -52,7 +54,7 @@ func TestRobotsTxt(t *testing.T) {
52 t.Fatal(err)
54 t.Fatal(err)
54 rw := httptest.NewRecorder()
56 rw := httptest.NewRecorder()
55− req, _ := http.NewRequest("GET", "/robots.txt", nil)
57+ req, _ := http.NewRequest(http.MethodGet, "/robots.txt", nil)
56 proxy.ServeHTTP(rw, req)
58 proxy.ServeHTTP(rw, req)
57 assert.Equal(t, 200, rw.Code)
59 assert.Equal(t, 200, rw.Code)
58 assert.Equal(t, "User-agent: *\nDisallow: /\n", rw.Body.String())
60 assert.Equal(t, "User-agent: *\nDisallow: /\n", rw.Body.String())
@@ -239,7 +241,7 @@ func TestBasicAuthPassword(t *testing.T) {
240 // Save the required session
242 // Save the required session
241 rw := httptest.NewRecorder()
243 rw := httptest.NewRecorder()
242− req, _ := http.NewRequest("GET", "/", nil)
244+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
243 err = proxy.sessionStore.Save(rw, req, &sessions.SessionState{
245 err = proxy.sessionStore.Save(rw, req, &sessions.SessionState{
244 Email: emailAddress,
246 Email: emailAddress,
@@ -248,7 +250,7 @@ func TestBasicAuthPassword(t *testing.T) {
248 // Extract the cookie value to inject into the test request
250 // Extract the cookie value to inject into the test request
249 cookie := rw.Header().Values("Set-Cookie")[0]
251 cookie := rw.Header().Values("Set-Cookie")[0]
251− req, _ = http.NewRequest("GET", "/", nil)
253+ req, _ = http.NewRequest(http.MethodGet, "/", nil)
252 req.Header.Set("Cookie", cookie)
254 req.Header.Set("Cookie", cookie)
253 rw = httptest.NewRecorder()
255 rw = httptest.NewRecorder()
254 proxy.ServeHTTP(rw, req)
256 proxy.ServeHTTP(rw, req)
@@ -298,14 +300,14 @@ func TestPassGroupsHeadersWithGroups(t *testing.T) {
299 // Save the required session
301 // Save the required session
300 rw := httptest.NewRecorder()
302 rw := httptest.NewRecorder()
301− req, _ := http.NewRequest("GET", "/", nil)
303+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
302 err = proxy.sessionStore.Save(rw, req, session)
304 err = proxy.sessionStore.Save(rw, req, session)
303 assert.NoError(t, err)
305 assert.NoError(t, err)
305 // Extract the cookie value to inject into the test request
307 // Extract the cookie value to inject into the test request
306 cookie := rw.Header().Values("Set-Cookie")[0]
308 cookie := rw.Header().Values("Set-Cookie")[0]
308− req, _ = http.NewRequest("GET", "/", nil)
310+ req, _ = http.NewRequest(http.MethodGet, "/", nil)
309 req.Header.Set("Cookie", cookie)
311 req.Header.Set("Cookie", cookie)
310 rw = httptest.NewRecorder()
312 rw = httptest.NewRecorder()
311 proxy.ServeHTTP(rw, req)
313 proxy.ServeHTTP(rw, req)
@@ -455,7 +457,7 @@ func (patTest *PassAccessTokenTest) getEndpointWithCookie(cookie string, endpoin
455 return 0, ""
457 return 0, ""
458− req, err := http.NewRequest("GET", endpoint, strings.NewReader(""))
460+ req, err := http.NewRequest(http.MethodGet, endpoint, strings.NewReader(""))
459 if err != nil {
461 if err != nil {
460 return 0, ""
462 return 0, ""
@@ -506,7 +508,7 @@ func TestStaticProxyUpstream(t *testing.T) {
506 ProxyUpstream: options.Upstream{
508 ProxyUpstream: options.Upstream{
507 ID: "static-proxy",
509 ID: "static-proxy",
508 Path: "/static-proxy",
510 Path: "/static-proxy",
509− Static: true,
511+ Static: ptr.To(true),
512 if err != nil {
514 if err != nil {
@@ -606,7 +608,7 @@ func NewSignInPageTest(skipProvider bool) (*SignInPageTest, error) {
607func (sipTest *SignInPageTest) GetEndpoint(endpoint string) (int, string) {
609func (sipTest *SignInPageTest) GetEndpoint(endpoint string) (int, string) {
608 rw := httptest.NewRecorder()
610 rw := httptest.NewRecorder()
609− req, _ := http.NewRequest("GET", endpoint, strings.NewReader(""))
611+ req, _ := http.NewRequest(http.MethodGet, endpoint, strings.NewReader(""))
610 sipTest.proxy.ServeHTTP(rw, req)
612 sipTest.proxy.ServeHTTP(rw, req)
611 return rw.Code, rw.Body.String()
613 return rw.Code, rw.Body.String()
@@ -711,6 +713,50 @@ func TestManualSignInCorrectCredentials(t *testing.T) {
711 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")
714func TestSignInPageIncludesTargetRedirect(t *testing.T) {
760func TestSignInPageIncludesTargetRedirect(t *testing.T) {
715 sipTest, err := NewSignInPageTest(false)
761 sipTest, err := NewSignInPageTest(false)
716 if err != nil {
762 if err != nil {
@@ -848,7 +894,7 @@ func NewProcessCookieTest(opts ProcessCookieTestOpts, modifiers ...OptionsModifi
848 // access_token validation.
894 // access_token validation.
849 pcTest.proxy.CookieOptions.Refresh = time.Duration(0)
895 pcTest.proxy.CookieOptions.Refresh = time.Duration(0)
850 pcTest.rw = httptest.NewRecorder()
896 pcTest.rw = httptest.NewRecorder()
851− pcTest.req, _ = http.NewRequest("GET", "/", strings.NewReader(""))
897+ pcTest.req, _ = http.NewRequest(http.MethodGet, "/", strings.NewReader(""))
852 pcTest.validateUser = true
898 pcTest.validateUser = true
853 return &pcTest, nil
899 return &pcTest, nil
@@ -981,7 +1027,7 @@ func NewUserInfoEndpointTest() (*ProcessCookieTest, error) {
981 if err != nil {
1027 if err != nil {
982 return nil, err
1028 return nil, err
984− pcTest.req, _ = http.NewRequest("GET",
1030+ pcTest.req, _ = http.NewRequest(http.MethodGet,
985 pcTest.opts.ProxyPrefix+"/userinfo", nil)
1031 pcTest.opts.ProxyPrefix+"/userinfo", nil)
986 return pcTest, nil
1032 return pcTest, nil
@@ -1031,6 +1077,20 @@ func TestUserInfoEndpointAccepted(t *testing.T) {
1032 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",
1036 for _, tc := range testCases {
1096 for _, tc := range testCases {
@@ -1075,7 +1135,7 @@ func NewAuthOnlyEndpointTest(querystring string, modifiers ...OptionsModifier) (
1075 return nil, err
1135 return nil, err
1077 pcTest.req, _ = http.NewRequest(
1137 pcTest.req, _ = http.NewRequest(
1078− "GET",
1138+ http.MethodGet,
1079 fmt.Sprintf("%s/auth%s", pcTest.opts.ProxyPrefix, querystring),
1139 fmt.Sprintf("%s/auth%s", pcTest.opts.ProxyPrefix, querystring),
1081 return pcTest, nil
1141 return pcTest, nil
@@ -1214,7 +1274,7 @@ func TestAuthOnlyEndpointSetXAuthRequestHeaders(t *testing.T) {
1214 pcTest.validateUser = true
1274 pcTest.validateUser = true
1216 pcTest.rw = httptest.NewRecorder()
1276 pcTest.rw = httptest.NewRecorder()
1217− pcTest.req, _ = http.NewRequest("GET",
1277+ pcTest.req, _ = http.NewRequest(http.MethodGet,
1218 pcTest.opts.ProxyPrefix+authOnlyPath, nil)
1278 pcTest.opts.ProxyPrefix+authOnlyPath, nil)
1220 created := time.Now()
1280 created := time.Now()
@@ -1307,7 +1367,7 @@ func TestAuthOnlyEndpointSetBasicAuthTrueRequestHeaders(t *testing.T) {
1307 pcTest.validateUser = true
1367 pcTest.validateUser = true
1309 pcTest.rw = httptest.NewRecorder()
1369 pcTest.rw = httptest.NewRecorder()
1310− pcTest.req, _ = http.NewRequest("GET",
1370+ pcTest.req, _ = http.NewRequest(http.MethodGet,
1311 pcTest.opts.ProxyPrefix+authOnlyPath, nil)
1371 pcTest.opts.ProxyPrefix+authOnlyPath, nil)
1313 created := time.Now()
1373 created := time.Now()
@@ -1387,7 +1447,7 @@ func TestAuthOnlyEndpointSetBasicAuthFalseRequestHeaders(t *testing.T) {
1387 pcTest.validateUser = true
1447 pcTest.validateUser = true
1389 pcTest.rw = httptest.NewRecorder()
1449 pcTest.rw = httptest.NewRecorder()
1390− pcTest.req, _ = http.NewRequest("GET",
1450+ pcTest.req, _ = http.NewRequest(http.MethodGet,
1391 pcTest.opts.ProxyPrefix+authOnlyPath, nil)
1451 pcTest.opts.ProxyPrefix+authOnlyPath, nil)
1393 created := time.Now()
1453 created := time.Now()
@@ -1435,7 +1495,7 @@ func TestAuthSkippedForPreflightRequests(t *testing.T) {
1436 proxy.provider = NewTestProvider(upstreamURL, "")
1496 proxy.provider = NewTestProvider(upstreamURL, "")
1437 rw := httptest.NewRecorder()
1497 rw := httptest.NewRecorder()
1438− req, _ := http.NewRequest("OPTIONS", "/preflight-request", nil)
1498+ req, _ := http.NewRequest(http.MethodOptions, "/preflight-request", nil)
1439 proxy.ServeHTTP(rw, req)
1499 proxy.ServeHTTP(rw, req)
1441 assert.Equal(t, 200, rw.Code)
1501 assert.Equal(t, 200, rw.Code)
@@ -1592,19 +1652,19 @@ func TestRequestSignature(t *testing.T) {
1592 resp string
1652 resp string
1594 "No request signature": {
1654 "No request signature": {
1595− method: "GET",
1655+ method: http.MethodGet,
1596 body: "",
1656 body: "",
1597 key: "",
1657 key: "",
1598 resp: "no signature received",
1658 resp: "no signature received",
1600 "Get request": {
1660 "Get request": {
1601− method: "GET",
1661+ method: http.MethodGet,
1602 body: "",
1662 body: "",
1603 key: "7d9e1aa87a5954e6f9fc59266b3af9d7c35fda2d",
1663 key: "7d9e1aa87a5954e6f9fc59266b3af9d7c35fda2d",
1604 resp: "signatures match",
1664 resp: "signatures match",
1606 "Post request": {
1666 "Post request": {
1607− method: "POST",
1667+ method: http.MethodPost,
1608 body: `{ "hello": "world!" }`,
1668 body: `{ "hello": "world!" }`,
1609 key: "d90df39e2d19282840252612dd7c81421a372f61",
1669 key: "d90df39e2d19282840252612dd7c81421a372f61",
1610 resp: "signatures match",
1670 resp: "signatures match",
@@ -2027,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")
2030func baseTestOptions() *options.Options {
2128func baseTestOptions() *options.Options {
2031 opts := options.NewOptions()
2129 opts := options.NewOptions()
2032 opts.Cookie.Secret = rawCookieSecret
2130 opts.Cookie.Secret = rawCookieSecret
@@ -2091,7 +2189,33 @@ func TestTrustedIPs(t *testing.T) {
2091 reverseProxy: false,
2189 reverseProxy: false,
2092 realClientIPHeader: "X-Real-IP", // Default value
2190 realClientIPHeader: "X-Real-IP", // Default value
2093 req: func() *http.Request {
2191 req: func() *http.Request {
2094− 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 = "@"
2095 return req
2219 return req
2097 expectTrusted: false,
2221 expectTrusted: false,
@@ -2103,7 +2227,7 @@ func TestTrustedIPs(t *testing.T) {
2103 reverseProxy: false,
2227 reverseProxy: false,
2104 realClientIPHeader: "X-Real-IP", // Default value
2228 realClientIPHeader: "X-Real-IP", // Default value
2105 req: func() *http.Request {
2229 req: func() *http.Request {
2106− req, _ := http.NewRequest("GET", "/", nil)
2230+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2107 req.RemoteAddr = "127.0.0.1:43670"
2231 req.RemoteAddr = "127.0.0.1:43670"
2108 return req
2232 return req
@@ -2116,7 +2240,7 @@ func TestTrustedIPs(t *testing.T) {
2116 reverseProxy: true,
2240 reverseProxy: true,
2117 realClientIPHeader: "X-Real-IP", // Default value
2241 realClientIPHeader: "X-Real-IP", // Default value
2118 req: func() *http.Request {
2242 req: func() *http.Request {
2119− req, _ := http.NewRequest("GET", "/", nil)
2243+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2120 req.RemoteAddr = "127.0.0.1:44324"
2244 req.RemoteAddr = "127.0.0.1:44324"
2121 return req
2245 return req
@@ -2129,7 +2253,7 @@ func TestTrustedIPs(t *testing.T) {
2129 reverseProxy: true,
2253 reverseProxy: true,
2130 realClientIPHeader: "X-Forwarded-For",
2254 realClientIPHeader: "X-Forwarded-For",
2131 req: func() *http.Request {
2255 req: func() *http.Request {
2132− req, _ := http.NewRequest("GET", "/", nil)
2256+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2133 req.Header.Add("X-Forwarded-For", "127.0.0.1")
2257 req.Header.Add("X-Forwarded-For", "127.0.0.1")
2134 return req
2258 return req
@@ -2142,7 +2266,7 @@ func TestTrustedIPs(t *testing.T) {
2142 reverseProxy: true,
2266 reverseProxy: true,
2143 realClientIPHeader: "X-Forwarded-For",
2267 realClientIPHeader: "X-Forwarded-For",
2144 req: func() *http.Request {
2268 req: func() *http.Request {
2145− req, _ := http.NewRequest("GET", "/", nil)
2269+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2146 req.Header.Add("X-Forwarded-For", "::1")
2270 req.Header.Add("X-Forwarded-For", "::1")
2147 return req
2271 return req
@@ -2155,7 +2279,7 @@ func TestTrustedIPs(t *testing.T) {
2155 reverseProxy: true,
2279 reverseProxy: true,
2156 realClientIPHeader: "X-Forwarded-For",
2280 realClientIPHeader: "X-Forwarded-For",
2157 req: func() *http.Request {
2281 req: func() *http.Request {
2158− req, _ := http.NewRequest("GET", "/", nil)
2282+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2159 req.Header.Add("X-Forwarded-For", "12.34.56.78")
2283 req.Header.Add("X-Forwarded-For", "12.34.56.78")
2160 return req
2284 return req
@@ -2168,7 +2292,7 @@ func TestTrustedIPs(t *testing.T) {
2168 reverseProxy: true,
2292 reverseProxy: true,
2169 realClientIPHeader: "X-Forwarded-For",
2293 realClientIPHeader: "X-Forwarded-For",
2170 req: func() *http.Request {
2294 req: func() *http.Request {
2171− req, _ := http.NewRequest("GET", "/", nil)
2295+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2172 req.Header.Add("X-Forwarded-For", "::2")
2296 req.Header.Add("X-Forwarded-For", "::2")
2173 return req
2297 return req
@@ -2181,7 +2305,7 @@ func TestTrustedIPs(t *testing.T) {
2181 reverseProxy: true,
2305 reverseProxy: true,
2182 realClientIPHeader: "X-Forwarded-For",
2306 realClientIPHeader: "X-Forwarded-For",
2183 req: func() *http.Request {
2307 req: func() *http.Request {
2184− req, _ := http.NewRequest("GET", "/", nil)
2308+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2185 req.Header.Add("X-Real-IP", "::1")
2309 req.Header.Add("X-Real-IP", "::1")
2186 return req
2310 return req
@@ -2194,7 +2318,7 @@ func TestTrustedIPs(t *testing.T) {
2194 reverseProxy: true,
2318 reverseProxy: true,
2195 realClientIPHeader: "X-Forwarded-For",
2319 realClientIPHeader: "X-Forwarded-For",
2196 req: func() *http.Request {
2320 req: func() *http.Request {
2197− req, _ := http.NewRequest("GET", "/", nil)
2321+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2198 req.Header.Add("X-Forwarded-For", "adsfljk29242as!!")
2322 req.Header.Add("X-Forwarded-For", "adsfljk29242as!!")
2199 return req
2323 return req
@@ -2207,7 +2331,7 @@ func TestTrustedIPs(t *testing.T) {
2207 reverseProxy: false,
2331 reverseProxy: false,
2208 realClientIPHeader: "X-Real-IP",
2332 realClientIPHeader: "X-Real-IP",
2209 req: func() *http.Request {
2333 req: func() *http.Request {
2210− req, _ := http.NewRequest("GET", "/", nil)
2334+ req, _ := http.NewRequest(http.MethodGet, "/", nil)
2211 req.RemoteAddr = "adsfljk29242as!!"
2335 req.RemoteAddr = "adsfljk29242as!!"
2212 return req
2336 return req
@@ -2223,7 +2347,7 @@ func TestTrustedIPs(t *testing.T) {
2224 ID: "static",
2348 ID: "static",
2225 Path: "/",
2349 Path: "/",
2226− Static: true,
2350+ Static: ptr.To(true),
@@ -2303,12 +2427,12 @@ func Test_buildRoutesAllowlist(t *testing.T) {
2304 expectedRoutes: []expectedAllowedRoute{
2428 expectedRoutes: []expectedAllowedRoute{
2306− method: "GET",
2430+ method: http.MethodGet,
2307 negate: false,
2431 negate: false,
2308 regexString: "^/foo/bar",
2432 regexString: "^/foo/bar",
2311− method: "POST",
2435+ method: http.MethodPost,
2312 negate: false,
2436 negate: false,
2313 regexString: "^/baz/[0-9]+/thing",
2437 regexString: "^/baz/[0-9]+/thing",
@@ -2361,11 +2485,11 @@ func Test_buildRoutesAllowlist(t *testing.T) {
2361 regexString: "^/baz/[0-9]+/thing/regex",
2485 regexString: "^/baz/[0-9]+/thing/regex",
2364− method: "GET",
2488+ method: http.MethodGet,
2365 regexString: "^/foo/bar",
2489 regexString: "^/foo/bar",
2368− method: "POST",
2492+ method: http.MethodPost,
2369 regexString: "^/baz/[0-9]+/thing",
2493 regexString: "^/baz/[0-9]+/thing",
@@ -2517,7 +2641,7 @@ func TestApiRoutes(t *testing.T) {
2518 for _, tc := range testCases {
2642 for _, tc := range testCases {
2519 t.Run(tc.name, func(t *testing.T) {
2643 t.Run(tc.name, func(t *testing.T) {
2520− req, err := http.NewRequest("GET", tc.url, nil)
2644+ req, err := http.NewRequest(http.MethodGet, tc.url, nil)
2521 req.Header.Set("Accept", tc.contentType)
2645 req.Header.Set("Accept", tc.contentType)
2522 assert.NoError(t, err)
2646 assert.NoError(t, err)
@@ -2555,9 +2679,11 @@ func TestAllowedRequest(t *testing.T) {
2556 opts.SkipAuthRegex = []string{
2680 opts.SkipAuthRegex = []string{
2557 "^/skip/auth/regex$",
2681 "^/skip/auth/regex$",
2682+ "^/public/.*/endpoint$",
2559 opts.SkipAuthRoutes = []string{
2684 opts.SkipAuthRoutes = []string{
2560 "GET=^/skip/auth/routes/get",
2685 "GET=^/skip/auth/routes/get",
2562 err := validation.Validate(opts)
2688 err := validation.Validate(opts)
2563 assert.NoError(t, err)
2689 assert.NoError(t, err)
@@ -2574,25 +2700,37 @@ func TestAllowedRequest(t *testing.T) {
2576 name: "Regex GET allowed",
2702 name: "Regex GET allowed",
2577− method: "GET",
2703+ method: http.MethodGet,
2578 url: "/skip/auth/regex",
2704 url: "/skip/auth/regex",
2579 allowed: true,
2705 allowed: true,
2582 name: "Regex POST allowed ",
2708 name: "Regex POST allowed ",
2583− method: "POST",
2709+ method: http.MethodPost,
2584 url: "/skip/auth/regex",
2710 url: "/skip/auth/regex",
2585 allowed: true,
2711 allowed: true,
2588 name: "Regex denied",
2714 name: "Regex denied",
2589− method: "GET",
2715+ method: http.MethodGet,
2590 url: "/wrong/denied",
2716 url: "/wrong/denied",
2591 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",
2594 name: "Route allowed",
2732 name: "Route allowed",
2595− method: "GET",
2733+ method: http.MethodGet,
2596 url: "/skip/auth/routes/get",
2734 url: "/skip/auth/routes/get",
2597 allowed: true,
2735 allowed: true,
@@ -2604,16 +2742,28 @@ func TestAllowedRequest(t *testing.T) {
2606 name: "Route denied with wrong path",
2744 name: "Route denied with wrong path",
2607− method: "GET",
2745+ method: http.MethodGet,
2608 url: "/skip/auth/routes/wrong/path",
2746 url: "/skip/auth/routes/wrong/path",
2609 allowed: false,
2747 allowed: false,
2612 name: "Route denied with wrong path and method",
2750 name: "Route denied with wrong path and method",
2613− method: "POST",
2751+ method: http.MethodPost,
2614 url: "/skip/auth/routes/wrong/path",
2752 url: "/skip/auth/routes/wrong/path",
2615 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",
2619 for _, tc := range testCases {
2769 for _, tc := range testCases {
@@ -2654,9 +2804,11 @@ func TestAllowedRequestWithForwardedUriHeader(t *testing.T) {
2655 opts.SkipAuthRegex = []string{
2805 opts.SkipAuthRegex = []string{
2656 "^/skip/auth/regex$",
2806 "^/skip/auth/regex$",
2807+ "^/public/.*/endpoint$",
2658 opts.SkipAuthRoutes = []string{
2809 opts.SkipAuthRoutes = []string{
2659 "GET=^/skip/auth/routes/get",
2810 "GET=^/skip/auth/routes/get",
2661 err := validation.Validate(opts)
2813 err := validation.Validate(opts)
2662 assert.NoError(t, err)
2814 assert.NoError(t, err)
@@ -2673,25 +2825,37 @@ func TestAllowedRequestWithForwardedUriHeader(t *testing.T) {
2675 name: "Regex GET allowed",
2827 name: "Regex GET allowed",
2676− method: "GET",
2828+ method: http.MethodGet,
2677 url: "/skip/auth/regex",
2829 url: "/skip/auth/regex",
2678 allowed: true,
2830 allowed: true,
2681 name: "Regex POST allowed ",
2833 name: "Regex POST allowed ",
2682− method: "POST",
2834+ method: http.MethodPost,
2683 url: "/skip/auth/regex",
2835 url: "/skip/auth/regex",
2684 allowed: true,
2836 allowed: true,
2687 name: "Regex denied",
2839 name: "Regex denied",
2688− method: "GET",
2840+ method: http.MethodGet,
2689 url: "/wrong/denied",
2841 url: "/wrong/denied",
2690 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",
2693 name: "Route allowed",
2857 name: "Route allowed",
2694− method: "GET",
2858+ method: http.MethodGet,
2695 url: "/skip/auth/routes/get",
2859 url: "/skip/auth/routes/get",
2696 allowed: true,
2860 allowed: true,
@@ -2703,22 +2867,35 @@ func TestAllowedRequestWithForwardedUriHeader(t *testing.T) {
2705 name: "Route denied with wrong path",
2869 name: "Route denied with wrong path",
2706− method: "GET",
2870+ method: http.MethodGet,
2707 url: "/skip/auth/routes/wrong/path",
2871 url: "/skip/auth/routes/wrong/path",
2708 allowed: false,
2872 allowed: false,
2711 name: "Route denied with wrong path and method",
2875 name: "Route denied with wrong path and method",
2712− method: "POST",
2876+ method: http.MethodPost,
2713 url: "/skip/auth/routes/wrong/path",
2877 url: "/skip/auth/routes/wrong/path",
2714 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",
2718 for _, tc := range testCases {
2894 for _, tc := range testCases {
2719 t.Run(tc.name, func(t *testing.T) {
2895 t.Run(tc.name, func(t *testing.T) {
2720 req, err := http.NewRequest(tc.method, opts.ProxyPrefix+authOnlyPath, nil)
2896 req, err := http.NewRequest(tc.method, opts.ProxyPrefix+authOnlyPath, nil)
2721 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"
2722 assert.NoError(t, err)
2899 assert.NoError(t, err)
2724 rw := httptest.NewRecorder()
2901 rw := httptest.NewRecorder()
@@ -2733,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)
2736func TestAllowedRequestNegateWithoutMethod(t *testing.T) {
2950func TestAllowedRequestNegateWithoutMethod(t *testing.T) {
2737 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) {
2738 w.WriteHeader(200)
2952 w.WriteHeader(200)
@@ -2772,37 +2986,37 @@ func TestAllowedRequestNegateWithoutMethod(t *testing.T) {
2774 name: "Some static file allowed",
2988 name: "Some static file allowed",
2775− method: "GET",
2989+ method: http.MethodGet,
2776 url: "/static/file.txt",
2990 url: "/static/file.txt",
2777 allowed: true,
2991 allowed: true,
2780 name: "POST to contact form allowed",
2994 name: "POST to contact form allowed",
2781− method: "POST",
2995+ method: http.MethodPost,
2782 url: "/contact",
2996 url: "/contact",
2783 allowed: true,
2997 allowed: true,
2786 name: "Regex POST allowed",
3000 name: "Regex POST allowed",
2787− method: "POST",
3001+ method: http.MethodPost,
2788 url: "/api/public-entity",
3002 url: "/api/public-entity",
2789 allowed: true,
3003 allowed: true,
2792 name: "Regex POST with trailing slash allowed",
3006 name: "Regex POST with trailing slash allowed",
2793− method: "POST",
3007+ method: http.MethodPost,
2794 url: "/api/public-entity/",
3008 url: "/api/public-entity/",
2795 allowed: true,
3009 allowed: true,
2798 name: "Regex GET api route denied",
3012 name: "Regex GET api route denied",
2799− method: "GET",
3013+ method: http.MethodGet,
2800 url: "/api/users",
3014 url: "/api/users",
2801 allowed: false,
3015 allowed: false,
2804 name: "Regex POST api route denied",
3018 name: "Regex POST api route denied",
2805− method: "POST",
3019+ method: http.MethodPost,
2806 url: "/api/users",
3020 url: "/api/users",
2807 allowed: false,
3021 allowed: false,
@@ -2872,37 +3086,37 @@ func TestAllowedRequestNegateWithMethod(t *testing.T) {
2874 name: "Some static file allowed",
3088 name: "Some static file allowed",
2875− method: "GET",
3089+ method: http.MethodGet,
2876 url: "/static/file.txt",
3090 url: "/static/file.txt",
2877 allowed: true,
3091 allowed: true,
2880 name: "POST to contact form not allowed",
3094 name: "POST to contact form not allowed",
2881− method: "POST",
3095+ method: http.MethodPost,
2882 url: "/contact",
3096 url: "/contact",
2883 allowed: false,
3097 allowed: false,
2886 name: "Regex POST allowed",
3100 name: "Regex POST allowed",
2887− method: "POST",
3101+ method: http.MethodPost,
2888 url: "/api/public-entity",
3102 url: "/api/public-entity",
2889 allowed: true,
3103 allowed: true,
2892 name: "Regex POST with trailing slash allowed",
3106 name: "Regex POST with trailing slash allowed",
2893− method: "POST",
3107+ method: http.MethodPost,
2894 url: "/api/public-entity/",
3108 url: "/api/public-entity/",
2895 allowed: true,
3109 allowed: true,
2898 name: "Regex GET api route denied",
3112 name: "Regex GET api route denied",
2899− method: "GET",
3113+ method: http.MethodGet,
2900 url: "/api/users",
3114 url: "/api/users",
2901 allowed: false,
3115 allowed: false,
2904 name: "Regex POST api route denied",
3118 name: "Regex POST api route denied",
2905− method: "POST",
3119+ method: http.MethodPost,
2906 url: "/api/users",
3120 url: "/api/users",
2907 allowed: false,
3121 allowed: false,
@@ -3042,7 +3256,7 @@ func TestProxyAllowedGroups(t *testing.T) {
3042 t.Fatal(err)
3256 t.Fatal(err)
3045− test.req, _ = http.NewRequest("GET", fmt.Sprintf("/%s", tt.querystring), nil)
3259+ test.req, _ = http.NewRequest(http.MethodGet, fmt.Sprintf("/%s", tt.querystring), nil)
3047 test.req.Header.Add("accept", applicationJSON)
3261 test.req.Header.Add("accept", applicationJSON)
3048 err = test.SaveSession(session)
3262 err = test.SaveSession(session)
@@ -3186,7 +3400,7 @@ func TestAuthOnlyAllowedGroupsWithSkipMethods(t *testing.T) {
3187 name: "UserWithGroupSkipAuthPreflight",
3401 name: "UserWithGroupSkipAuthPreflight",
3188 groups: []string{"a", "c"},
3402 groups: []string{"a", "c"},
3189− method: "OPTIONS",
3403+ method: http.MethodOptions,
3190 ip: "1.2.3.5:43670",
3404 ip: "1.2.3.5:43670",
3191 withSession: true,
3405 withSession: true,
3192 expectedStatusCode: http.StatusAccepted,
3406 expectedStatusCode: http.StatusAccepted,
@@ -3194,7 +3408,7 @@ func TestAuthOnlyAllowedGroupsWithSkipMethods(t *testing.T) {
3195 name: "UserWithGroupTrustedIp",
3409 name: "UserWithGroupTrustedIp",
3196 groups: []string{"a", "c"},
3410 groups: []string{"a", "c"},
3197− method: "GET",
3411+ method: http.MethodGet,
3198 ip: "1.2.3.4:43670",
3412 ip: "1.2.3.4:43670",
3199 withSession: true,
3413 withSession: true,
3200 expectedStatusCode: http.StatusAccepted,
3414 expectedStatusCode: http.StatusAccepted,
@@ -3202,7 +3416,7 @@ func TestAuthOnlyAllowedGroupsWithSkipMethods(t *testing.T) {
3203 name: "UserWithoutGroupSkipAuthPreflight",
3417 name: "UserWithoutGroupSkipAuthPreflight",
3204 groups: []string{"c"},
3418 groups: []string{"c"},
3205− method: "OPTIONS",
3419+ method: http.MethodOptions,
3206 ip: "1.2.3.5:43670",
3420 ip: "1.2.3.5:43670",
3207 withSession: true,
3421 withSession: true,
3208 expectedStatusCode: http.StatusForbidden,
3422 expectedStatusCode: http.StatusForbidden,
@@ -3210,21 +3424,21 @@ func TestAuthOnlyAllowedGroupsWithSkipMethods(t *testing.T) {
3211 name: "UserWithoutGroupTrustedIp",
3425 name: "UserWithoutGroupTrustedIp",
3212 groups: []string{"c"},
3426 groups: []string{"c"},
3213− method: "GET",
3427+ method: http.MethodGet,
3214 ip: "1.2.3.4:43670",
3428 ip: "1.2.3.4:43670",
3215 withSession: true,
3429 withSession: true,
3216 expectedStatusCode: http.StatusForbidden,
3430 expectedStatusCode: http.StatusForbidden,
3219 name: "UserWithoutSessionSkipAuthPreflight",
3433 name: "UserWithoutSessionSkipAuthPreflight",
3220− method: "OPTIONS",
3434+ method: http.MethodOptions,
3221 ip: "1.2.3.5:43670",
3435 ip: "1.2.3.5:43670",
3222 withSession: false,
3436 withSession: false,
3223 expectedStatusCode: http.StatusAccepted,
3437 expectedStatusCode: http.StatusAccepted,
3226 name: "UserWithoutSessionTrustedIp",
3440 name: "UserWithoutSessionTrustedIp",
3227− method: "GET",
3441+ method: http.MethodGet,
3228 ip: "1.2.3.4:43670",
3442 ip: "1.2.3.4:43670",
3229 withSession: false,
3443 withSession: false,
3230 expectedStatusCode: http.StatusAccepted,
3444 expectedStatusCode: http.StatusAccepted,
@@ -3324,6 +3538,24 @@ func TestAuthOnlyAllowedEmailDomains(t *testing.T) {
3324 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",
3325 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,
3329 for _, tc := range testCases {
3561 for _, tc := range testCases {
@@ -3530,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)