Skip to content

prevent sensitive header value being logged #289

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

prevent sensitive header value being logged #289

Show file tree
Hide file tree
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
3 changes: 1 addition & 2 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,9 @@ dev
- Support for Python 3.14 has been added.
- Support for PyPy 3.11 has been added.


**Bugfixes**

-
- Prevent sensitive headers from being leaked

4.1.0 (2025-01-22)
------------------
Expand Down
14 changes: 10 additions & 4 deletions src/hpack/hpack.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -284,16 +284,22 @@ def encode(self,
def add(self, to_add: tuple[bytes, bytes], sensitive: bool, huffman: bool = False) -> bytes:
"""
Serializes a header key-value tuple.

When sensitive is True, the header will not be added to the header table,
furthermore, the header value will be redacted in debug logs, as "SENSITIVE_REDACTED",
to prevent accidental exposure of sensitive information.
"""
name, value = to_add

display_value = value if not sensitive else b"SENSITIVE_REDACTED"
log.debug(
"Adding %s to the header table, sensitive:%s, huffman:%s",
to_add,
"Adding %s=%s to the header table, sensitive:%s, huffman:%s",
name,
display_value,
sensitive,
huffman,
)

name, value = to_add

# Set our indexing mode
indexbit = INDEX_INCREMENTAL if not sensitive else INDEX_NEVER

Expand Down