Skip to content

feat: consider nginx original header on decision api #1223

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

Open
fidoriel wants to merge 2 commits into
base: master
Choose a base branch
from
+47 −7
Open

feat: consider nginx original header on decision api #1223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
303f2e1
Also consider nginx original header on decision api
fidoriel Mar 20, 2025
10ecfa9
fix test
fidoriel Mar 20, 2025
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
23 changes: 18 additions & 5 deletions api/decision.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ package api

import (
"net/http"
"net/url"
"strings"

"github.com/ory/oathkeeper/pipeline/authn"
Expand All @@ -21,6 +22,8 @@ const (
xForwardedProto = "X-Forwarded-Proto"
xForwardedHost = "X-Forwarded-Host"
xForwardedUri = "X-Forwarded-Uri"
xOriginalMethod = "X-Original-Method"
xOriginalUrl = "X-Original-Url"
)

type decisionHandlerRegistry interface {
Expand All @@ -41,11 +44,21 @@ 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):])
r.Method = x.OrDefaultString(r.Header.Get(xForwardedMethod), x.OrDefaultString(r.Header.Get(xOriginalMethod), r.Method))

originalURL := r.Header.Get(xOriginalUrl)
if originalURL != "" {
if parsedURL, err := url.Parse(originalURL); err == nil {
r.URL.Scheme = parsedURL.Scheme
r.URL.Host = parsedURL.Host
r.URL.Path = parsedURL.Path
}
} else {
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)
} else {
Expand Down
31 changes: 29 additions & 2 deletions api/decision_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -396,7 +396,7 @@ func TestDecisionAPIHeaderUsage(t *testing.T) {
},
},
{
name: "all arguments are taken from the headers",
name: "all arguments are taken from the `forwarded` headers",
expectedUrl: &url.URL{Scheme: "https", Host: "test.dev", Path: "/bar"},
expectedMethod: "POST",
transform: func(req *http.Request) {
Expand All @@ -407,7 +407,16 @@ func TestDecisionAPIHeaderUsage(t *testing.T) {
},
},
{
name: "argument from the headers doesn't get url encoded",
name: "all arguments are taken from the `original` headers",
expectedUrl: &url.URL{Scheme: "https", Host: "test.dev", Path: "/bar"},
expectedMethod: "POST",
transform: func(req *http.Request) {
req.Header.Add("X-Original-Method", "POST")
req.Header.Add("X-Original-Url", "https://test.dev/bar")
},
},
{
name: "argument from the `forwarded` headers doesn't get url encoded",
expectedUrl: &url.URL{Scheme: "https", Host: "test.dev", Path: "/bar"},
expectedMethod: "POST",
transform: func(req *http.Request) {
Expand All @@ -417,6 +426,15 @@ func TestDecisionAPIHeaderUsage(t *testing.T) {
req.Header.Add("X-Forwarded-Uri", "/bar?this=is&a=test")
},
},
{
name: "argument from the `original` headers doesn't get url encoded",
expectedUrl: &url.URL{Scheme: "https", Host: "test.dev", Path: "/bar"},
expectedMethod: "POST",
transform: func(req *http.Request) {
req.Header.Add("X-Original-Method", "POST")
req.Header.Add("X-Original-Url", "https://test.dev/bar?this=is&a=test")
},
},
{
name: "only scheme is taken from the headers",
expectedUrl: &url.URL{Scheme: "https", Host: defaultUrl.Host, Path: defaultUrl.Path},
Expand All @@ -425,6 +443,15 @@ func TestDecisionAPIHeaderUsage(t *testing.T) {
req.Header.Add("X-Forwarded-Proto", "https")
},
},
{
name: "schemethodme is taken from the `forwarded` headers and url from `original` headers",
expectedUrl: &url.URL{Scheme: "https", Host: defaultUrl.Host, Path: defaultUrl.Path},
expectedMethod: defaultMethod,
transform: func(req *http.Request) {
req.Header.Add("X-Forwarded-Method", "POST")
req.Header.Add("X-Original-Url", "https://test.dev/bar")
},
},
{
name: "only method is taken from the headers",
expectedUrl: defaultUrl,
Expand Down