Unverified Commit c26c7713 authored by Tom Milewski's avatar Tom Milewski Committed by GitHub

fix: set `x-forwarded-host` based on request (#58500)

Co-authored-by: 's avatar@BRKalow <bryce@clerk.dev>

### What?

A number of our customers have been experiencing issues stemming from an
`x-forwarded-host` header that doesn't match the `host` header.

### Why?

[This PR](https://github.com/vercel/next.js/pull/57815) removes
functionality which sets `x-forwarded-host` to `req.headers['host']` and
relies solely on the server's hostname and port.

This can be seen locally when visiting the app via a localhost
subdomain.

The `x-forwarded-host` header will remain as `localhost:${port}` while
the actual requested host will contain the subdomain.

### Related 

- https://github.com/vercel/next.js/pull/57815#issuecomment-1808496790

---------
Co-authored-by: 's avatarBRKalow <bryce@clerk.dev>
Co-authored-by: 's avatarZack Tanner <zacktanner@gmail.com>
parent 24b2ff16
...@@ -910,7 +910,7 @@ export default abstract class Server<ServerOptions extends Options = Options> { ...@@ -910,7 +910,7 @@ export default abstract class Server<ServerOptions extends Options = Options> {
) )
} }
req.headers['x-forwarded-host'] ??= `${this.hostname}:${this.port}` req.headers['x-forwarded-host'] ??= req.headers['host'] ?? this.hostname
req.headers['x-forwarded-port'] ??= this.port?.toString() req.headers['x-forwarded-port'] ??= this.port?.toString()
const { originalRequest } = req as NodeNextRequest const { originalRequest } = req as NodeNextRequest
req.headers['x-forwarded-proto'] ??= (originalRequest.socket as TLSSocket) req.headers['x-forwarded-proto'] ??= (originalRequest.socket as TLSSocket)
......
...@@ -5,6 +5,7 @@ createNextDescribe('x-forwarded-headers', { files: __dirname }, ({ next }) => { ...@@ -5,6 +5,7 @@ createNextDescribe('x-forwarded-headers', { files: __dirname }, ({ next }) => {
const res = await next.fetch('/') const res = await next.fetch('/')
const headers = await res.json() const headers = await res.json()
const url = new URL(next.url) const url = new URL(next.url)
expect(headers['x-forwarded-host']).toBe(url.host) expect(headers['x-forwarded-host']).toBe(url.host)
expect(headers['x-forwarded-port']).toBe(url.port) expect(headers['x-forwarded-port']).toBe(url.port)
expect(headers['x-forwarded-proto']).toBe(url.protocol.replace(':', '')) expect(headers['x-forwarded-proto']).toBe(url.protocol.replace(':', ''))
...@@ -14,4 +15,53 @@ createNextDescribe('x-forwarded-headers', { files: __dirname }, ({ next }) => { ...@@ -14,4 +15,53 @@ createNextDescribe('x-forwarded-headers', { files: __dirname }, ({ next }) => {
url.protocol.replace(':', '') url.protocol.replace(':', '')
) )
}) })
describe('host header exists', () => {
it('should include x-forwarded-* headers relative to host', async () => {
const url = new URL(next.url)
const reqHeaders = {
host: `subdomain.localhost:${url.port}`,
}
const res = await next.fetch('/', {
headers: reqHeaders,
})
const headers = await res.json()
expect(headers['x-forwarded-host']).toBe(reqHeaders.host)
expect(headers['x-forwarded-port']).toBe(url.port)
expect(headers['x-forwarded-proto']).toBe(url.protocol.replace(':', ''))
expect(headers['middleware-x-forwarded-host']).toBe(reqHeaders.host)
expect(headers['middleware-x-forwarded-port']).toBe(url.port)
expect(headers['middleware-x-forwarded-proto']).toBe(
url.protocol.replace(':', '')
)
})
})
describe('already assigned', () => {
it('should not override existing x-forwarded-* headers', async () => {
const url = new URL(next.url)
const reqHeaders = {
host: `subdomain.localhost:${url.port}`,
port: '1234',
proto: 'https',
}
const res = await next.fetch('/', {
headers: {
host: 'override.localhost',
'x-forwarded-host': reqHeaders.host,
'x-forwarded-port': reqHeaders.port,
'x-forwarded-proto': reqHeaders.proto,
},
})
const headers = await res.json()
expect(headers['x-forwarded-host']).toBe(reqHeaders.host)
expect(headers['x-forwarded-port']).toBe(reqHeaders.port)
expect(headers['x-forwarded-proto']).toBe(reqHeaders.proto)
expect(headers['middleware-x-forwarded-host']).toBe(reqHeaders.host)
expect(headers['middleware-x-forwarded-port']).toBe(reqHeaders.port)
expect(headers['middleware-x-forwarded-proto']).toBe(reqHeaders.proto)
})
})
}) })
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment