docs: ADR 0005 — trusted-proxy-gated client-IP resolution#193
Merged
Conversation
Records the decision behind #190: the auth 401 logs resolve the client IP from forwarding headers only when the TCP peer is in a configured trusted-proxy set (TRUSTED_PROXIES), taking the rightmost-untrusted XFF entry with an X-Real-IP fallback. Captures the rejected alternatives and notes the availability-biased fallback so it isn't later tightened. This was generated by AI
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Records the design decision from #190 (auth 401 logs report the proxy address instead of the client).
The API runs behind a TLS-terminating reverse proxy, so
r.RemoteAddris always the proxy. ADR 0005 establishes that the client IP is resolved from forwarding headers only when the TCP peer is in a configured trusted-proxy set (TRUSTED_PROXIES, default empty = trust nothing), taking the right-most-untrustedX-Forwarded-Forentry with anX-Real-IPfallback. It records the rejected alternatives and flags the malformed-XFF fallback as availability-biased so it isn't later "tightened."Doc-only; no code change. The implementation lands with #190.
Refs #190.
This was generated by AI