Skip to content

docs(config): clarify forwarded_for_headers configuration #63542

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
joshtrichards wants to merge 1 commit into
base: master
Choose a base branch
from
+17 −7
Open

docs(config): clarify forwarded_for_headers configuration #63542

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
24 changes: 17 additions & 7 deletions config/config.sample.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2679,16 +2679,26 @@
'trusted_proxies' => ['203.0.113.45', '198.51.100.128', '192.168.2.0/24'],

/**
* Headers trusted as containing the client IP address when used with
* ``trusted_proxies``. For example, use ``HTTP_X_FORWARDED_FOR`` for the
* ``X-Forwarded-For`` header.
* HTTP header keys containing the original client IP address as provided by a
* trusted reverse proxy.
*
* Incorrect configuration allows clients to spoof their IP address, bypassing
* access controls and rendering logs unreliable.
* This setting is used only when the request originates from an address listed in
* ``trusted_proxies``. The de facto standard ``X-Forwarded-For`` header, exposed
* as ``HTTP_X_FORWARDED_FOR``, is Nextcloud's default, so this setting often does
* not need to be configured. See
* https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/X-Forwarded-For
* for details.
*
* Defaults to ``['HTTP_X_FORWARDED_FOR']``
* Only add headers that are set or sanitized by a trusted proxy. Incorrect
* configuration allows clients to spoof their IP address, bypass access
* controls, and make logs unreliable.
*
* Header values may contain a comma-separated list of IP addresses. The
* rightmost non-proxy address is used.
*
* Defaults to ``['HTTP_X_FORWARDED_FOR']``.
*/
'forwarded_for_headers' => ['HTTP_X_FORWARDED', 'HTTP_FORWARDED_FOR'],
'forwarded_for_headers' => ['HTTP_X_FORWARDED_FOR'],

/**
* List of trusted IP ranges for admin actions. If non-empty, all admin actions
Expand Down
Loading