Fix case-insensitive matching of sensitive headers - #379
Draft
ffittschen wants to merge 1 commit into
Draft
ffittschen wants to merge 1 commit into
ffittschen wants to merge 1 commit into
Conversation
processPatterns() builds the sensitiveHeaders regexes with process(_:options: [.caseInsensitive]), but process(_:options:) never passed the options on to Regex, so header names were matched case-sensitively. A configuration with "authorization" didn't redact "Authorization", which is how URLRequest spells the header.
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
1 participant
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.
This PR fixes
NetworkLogger.Configuration.sensitiveHeadersmatching header names case-sensitively. The root cause wasprocessPatterns()passing[.caseInsensitive]toprocess(_:options:), which never forwarded the options toRegex. BecauseURLRequestcanonicalizes well-known names (authorizationbecomesAuthorization), a lowercase configuration left bearer tokens unredacted in the store. The fix passes the options through:Regex(pattern, Regex.Options(options)).Found while working on #378, where HTTP/2 metadata keys are always lowercase.
How to test
sensitiveHeaders = ["authorization"]and send a request with anAuthorizationheader. Assert that the stored request header reads<private>.["X-API-KEY"]) redacts a lowercasex-api-keyheader, and that wildcard patterns match regardless of case.