Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: decision API copies X-Forwarded-Method to incoming requests which breaks traefik forward auth for HEAD requests #1046

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

fix: decision API copies X-Forwarded-Method to incoming requests which breaks traefik forward auth for HEAD requests #1046

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
01a6b16
fix: HEAD is now handled correctly by decision API
jrester Dec 28, 2022
0062d08
feat: merge upstream
jrester Jan 27, 2023
1d1c6f0
fix: clone request
jrester Mar 18, 2023
85e9e36
fix: merge upstream
jrester Mar 18, 2023
f4c0dbb
Merge remote-tracking branch 'upstream/master' into head-fix
jrester Jun 10, 2023
d28b8da
fix: merge upstream
jrester Jun 10, 2023
6e1d6dd
Merge upstream
jrester Oct 15, 2023
004b778
format
jrester Oct 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 10 additions & 7 deletions api/decision.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,16 @@ func NewJudgeHandler(r decisionHandlerRegistry) *DecisionHandler {

func (h *DecisionHandler) ServeHTTP(w http.ResponseWriter, r *http.Request, next http.HandlerFunc) {
if len(r.URL.Path) >= len(DecisionPath) && r.URL.Path[:len(DecisionPath)] == DecisionPath {
r.Method = x.OrDefaultString(r.Header.Get(xForwardedMethod), r.Method)
r.URL.Scheme = x.OrDefaultString(r.Header.Get(xForwardedProto),
x.IfThenElseString(r.TLS != nil, "https", "http"))
r.URL.Host = x.OrDefaultString(r.Header.Get(xForwardedHost), r.Host)
r.URL.Path = x.OrDefaultString(strings.SplitN(r.Header.Get(xForwardedUri), "?", 2)[0], r.URL.Path[len(DecisionPath):])

h.decisions(w, r)
// Clone the request, instead of modifing the incoming request directly.
// This is nevessary because the middleware would otherwise use the method from "X-Forwarded-Method" for the response
// although the original request had another method, which leads to problems with the HEAD method.
// For more information see: https://github.com/thomseddon/traefik-forward-auth/issues/156
forwardedReq := r.Clone(r.Context())
forwardedReq.Method = x.OrDefaultString(r.Header.Get(xForwardedMethod), r.Method)
forwardedReq.URL.Scheme = x.OrDefaultString(r.Header.Get(xForwardedProto), x.IfThenElseString(r.TLS != nil, "https", "http"))
forwardedReq.URL.Host = x.OrDefaultString(r.Header.Get(xForwardedHost), r.Host)
forwardedReq.URL.Path = x.OrDefaultString(strings.SplitN(r.Header.Get(xForwardedUri), "?", 2)[0], r.URL.Path[len(DecisionPath):])
h.decisions(w, forwardedReq)
} else {
next(w, r)
}
Expand Down
32 changes: 30 additions & 2 deletions api/decision_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import (
"net/url"
"strconv"
"testing"
"time"

"github.com/julienschmidt/httprouter"
"github.com/stretchr/testify/assert"
Expand All @@ -22,6 +23,7 @@ import (
"github.com/urfave/negroni"

"github.com/ory/herodot"
"github.com/ory/x/configx"
"github.com/ory/x/logrusx"

"github.com/ory/oathkeeper/api"
Expand All @@ -33,7 +35,7 @@ import (
)

func TestDecisionAPI(t *testing.T) {
conf := internal.NewConfigurationWithDefaults()
conf := internal.NewConfigurationWithDefaults(configx.SkipValidation())
conf.SetForTest(t, configuration.AuthenticatorNoopIsEnabled, true)
conf.SetForTest(t, configuration.AuthenticatorUnauthorizedIsEnabled, true)
conf.SetForTest(t, configuration.AuthenticatorAnonymousIsEnabled, true)
Expand Down Expand Up @@ -299,6 +301,29 @@ func TestDecisionAPI(t *testing.T) {
code: http.StatusOK,
authz: "",
},
{
d: "HEAD request should not result in an read timeout",
url: ts.URL + "/decisions" + "/authn-anon/authz-allow/cred-noop/1234",
rulesRegexp: []rule.Rule{{
Match: &rule.Match{Methods: []string{"HEAD"}, URL: ts.URL + "/authn-anon/authz-allow/cred-noop/<[0-9]+>"},
Authenticators: []rule.Handler{{Handler: "anonymous"}},
Authorizer: rule.Handler{Handler: "allow"},
Mutators: []rule.Handler{{Handler: "noop"}},
Upstream: rule.Upstream{URL: ""},
}},
rulesGlob: []rule.Rule{{
Match: &rule.Match{Methods: []string{"HEAD"}, URL: ts.URL + "/authn-anon/authz-allow/cred-noop/<[0-9]*>"},
Authenticators: []rule.Handler{{Handler: "anonymous"}},
Authorizer: rule.Handler{Handler: "allow"},
Mutators: []rule.Handler{{Handler: "noop"}},
Upstream: rule.Upstream{URL: ""},
}},
transform: func(r *http.Request) {
r.Header.Add("X-Forwarded-Method", "HEAD")
},
code: http.StatusOK,
authz: "",
},
} {
t.Run(fmt.Sprintf("case=%d/description=%s", k, tc.d), func(t *testing.T) {
testFunc := func(strategy configuration.MatchingStrategy) {
Expand All @@ -309,7 +334,10 @@ func TestDecisionAPI(t *testing.T) {
tc.transform(req)
}

res, err := http.DefaultClient.Do(req)
httpClient := http.Client{
Timeout: 2 * time.Second,
}
res, err := httpClient.Do(req)
require.NoError(t, err)

entireBody, err := io.ReadAll(res.Body)
Expand Down