fix(state): log a digest of the OAuth state instead of the raw value - #138
Merged
Merged
Conversation
The state comes straight from the callback query string. Logging it raw leaked live tokens and let a caller forge log lines with CR/LF. Log lines now carry state_ref (first 12 hex chars of its SHA-256). Unknown or expired states log at INFO, and malformed stored data logs once at WARNING without a traceback. Closes #107
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.
Closes #107
Problem
StateManagerlogged the raw state, which comes straight from the OAuth callback query string:consume_state()logged an unknown or expired state at WARNING, so a caller could embed CR/LF and write forged lines into the logs.Change
state_ref, the first 12 hex characters of its SHA-256. An operator can compute it from a known state to find the matching lines.consume_state()logs an unknown or expired state at INFO instead of WARNING._decode_state()no longer logs. Its callers (consume_state,validate_state,get_state_metadata) log a malformed entry once, at WARNING, withoutexc_info.consume_state()still raisesStateDataError.docs/STATE.mdnotes describe the logging behaviour, and there is a CHANGELOG entry under Fixed.Not breaking: no public signature changes. Only log levels and log content change.
Tests
The new tests in
tests/state/test_manager.pyfail on the old code and pass with this change:Full suite with live Redis and Memcached: 759 passed. The docs build passes with
--strict.