Skip to content
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.

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

Avoid including header values in header validation failure exceptions #12642

Merged
merged 1 commit into from
Jul 27, 2022

Conversation

chrisvest
Copy link
Contributor

Motivation:
Exception messages may end up in logs, or other error reporting mechanisms, and we cannot necessarily tell at header validation time if the header value is sensitive information or not.
Hence, it's better to not include it, and instead rely on the header name as a debugging aid.

Modification:
Remove the inclusion of the header value that fails header validation.
And instead add the name of the header that fails validation.

Result:
If sensitive information fails header validation, it will no longer be exposed through the exception messages.

@chrisvest chrisvest added this to the 4.1.80.Final milestone Jul 25, 2022
Motivation:
Exception messages may end up in logs, or other error reporting mechanisms, and we cannot necessarily tell at header validation time if the header value is sensitive information or not.
Hence, it's better to not include it, and instead rely on the header name as a debugging aid.

Modification:
Remove the inclusion of the header value that fails header validation.
And instead add the name of the header that fails validation.

Result:
If sensitive information fails header validation, it will no longer be exposed through the exception messages.
@chrisvest chrisvest merged commit c37c637 into netty:4.1 Jul 27, 2022
@chrisvest chrisvest deleted the 41-header-convert branch July 27, 2022 20:41
chrisvest added a commit that referenced this pull request Jul 27, 2022
…#12642)

Motivation:
Exception messages may end up in logs, or other error reporting mechanisms, and we cannot necessarily tell at header validation time if the header value is sensitive information or not.
Hence, it's better to not include it, and instead rely on the header name as a debugging aid.

Modification:
Remove the inclusion of the header value that fails header validation.
And instead add the name of the header that fails validation.

Result:
If sensitive information fails header validation, it will no longer be exposed through the exception messages.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant