nitrojs / nitrojs/nitro

Add option to `node` preset for trusting `X-Forwarded-*` headers

Open
#4,330 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement v3
Dominant language
TypeScript
Stars
11.2k
Forks
899
Avg merge
2d 24m
Merged PRs (30d)
40

Description

Describe the feature

For deployment behind a reverse proxy one wants the receiving application to trust and use the X-Forwarded-For (and related) header set by the proxy. However, for edge deployments this is usually not desirable as they already provide the correct IP and attackers could provide false data in those headers. The runtime presets (node_*, bun, and deno) though are commonly deployed behind a reverse proxy and would thus benefit from an option to trust those headers and fill ServerRequest.ip with it's value.

A possible implementation would be to expose this as an environment variable like NITRO_TRUST_XFORWARDED=1 and/or a flag in defineConfig().

Cont'd from the discussion over at the h3 repo: https://github.com/h3js/h3/issues/1366#issuecomment-4588258740

Additional information
  • Would you be willing to help implement this feature?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the node_* runtime presets, along with the bun and deno presets, and see how defineConfig() and ServerRequest.ip are wired. Review the related h3 discussion before choosing between NITRO_TRUST_XFORWARDED=1 and a configuration flag. Done means the selected option consistently controls whether X-Forwarded-* headers populate ServerRequest.ip across the supported presets.

Written by the indexing model from the issue text.

Assessment

Tech stack
bun, deno, node.js, typescript
Domain
backend, networking, security
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.