Merge pull request #29 from 3v0k4/x-forwarded

Set X-Forwarded-* headers

CHANGELOG.md

@@ -1,3 +1,7 @@
+## Unreleased
+
+* Set in the outbound request `X-Forwarded-For` (to the client IP address), `X-Forwarded-Host` (to the host name requested by the client), and `X-Forwarded-Proto` (to "http" or "https" depending on whether the inbound request was made on a TLS-enabled connection) (#29)
+
 ## v0.1.4 / 2024-04-26
 
 * [BREAKING] Rename the `SSL_DOMAIN` env to `TLS_DOMAIN` (#13)

internal/handler_test.go

@@ -155,6 +155,50 @@ func TestHandlerMaxRequestBody(t *testing.T) {
  assert.Equal(t, http.StatusOK, w.Code)
 }
 
+func TestHandlerPreserveInboundHostHeaderWhenProxying(t *testing.T) {
+ upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ assert.Equal(t, "example.org", r.Host)
+ }))
+ defer upstream.Close()
+
+ h := NewHandler(handlerOptions(upstream.URL))
+
+ w := httptest.NewRecorder()
+ r := httptest.NewRequest("GET", "http://example.org", nil)
+ h.ServeHTTP(w, r)
+}
+
+func TestHandlerAppendInboundXFFHeaderWhenProxying(t *testing.T) {
+ upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ assert.Equal(t, "0.0.0.0, 0.0.0.1", r.Header.Get("X-Forwarded-For"))
+ }))
+ defer upstream.Close()
+
+ h := NewHandler(handlerOptions(upstream.URL))
+
+ w := httptest.NewRecorder()
+ r := httptest.NewRequest("GET", "http://example.org", nil)
+ r.RemoteAddr = "0.0.0.1:1234"
+ r.Header.Set("X-Forwarded-For", "0.0.0.0")
+ h.ServeHTTP(w, r)
+}
+
+func TestHandlerXForwardedHeadersWhenProxying(t *testing.T) {
+ upstream := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+ assert.Equal(t, "1.2.3.4", r.Header.Get("X-Forwarded-For"))
+ assert.Equal(t, "example.org", r.Header.Get("X-Forwarded-Host"))
+ assert.Equal(t, "https", r.Header.Get("X-Forwarded-Proto"))
+ }))
+ defer upstream.Close()
+
+ h := NewHandler(handlerOptions(upstream.URL))
+
+ w := httptest.NewRecorder()
+ r := httptest.NewRequest("GET", "https://example.org", nil)
+ r.RemoteAddr = "1.2.3.4:1234"
+ h.ServeHTTP(w, r)
+}
+
 // Helpers
 
 func handlerOptions(targetUrl string) HandlerOptions {

internal/proxy_handler.go

@@ -10,11 +10,16 @@ import (
 )
 
 func NewProxyHandler(targetUrl *url.URL, badGatewayPage string) http.Handler {
- proxy := httputil.NewSingleHostReverseProxy(targetUrl)
- proxy.ErrorHandler = ProxyErrorHandler(badGatewayPage)
- proxy.Transport = createProxyTransport()
-
- return proxy
+ return &httputil.ReverseProxy{
+ Rewrite: func(r *httputil.ProxyRequest) {
+ r.SetURL(targetUrl)
+ r.Out.Host = r.In.Host
+ r.Out.Header["X-Forwarded-For"] = r.In.Header["X-Forwarded-For"]
+ r.SetXForwarded()
+ },
+ ErrorHandler: ProxyErrorHandler(badGatewayPage),
+ Transport: createProxyTransport(),
+ }
 }
 
 func ProxyErrorHandler(badGatewayPage string) func(w http.ResponseWriter, r *http.Request, err error) {