docs(oauth): document StatelessOAuthStateStore anti-replay caveat#1920
Merged
Conversation
Add a class docstring and consume() docstring to StatelessOAuthStateStore explaining that, unlike the stateful stores, it provides no one-time-use / anti-replay guarantee: a valid, unexpired token passes consume() every time. This is inherent to a self-contained stateless token, which can only be invalidated by expiry. Includes integrator guidance: keep expiration_seconds short (the lifetime is the replay window; 300s/5min recommended, matching the OAuth sample), make the callback idempotent, and a note that CSRF protection is unaffected since it comes from the OAuthStateUtils state cookie rather than one-time-use. Documentation only; no behavior change. Addresses #1919. Co-Authored-By: Claude <svc-devxp-claude@slack-corp.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1920 +/- ##
=======================================
Coverage 84.17% 84.17%
=======================================
Files 118 118
Lines 13423 13423
=======================================
Hits 11299 11299
Misses 2124 2124 ☔ View full report in Codecov by Harness. |
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
2 participants
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.
Summary
Adds documentation to
StatelessOAuthStateStore(introduced in #1916) covering the behavior raised in #1919: unlike the stateful stores (FileOAuthStateStore, the SQLAlchemy/SQLite3 stores, andAmazonS3OAuthStateStore), this store provides no one-time-use / anti-replay guarantee. A valid, unexpired token passesconsume()every time.This is inherent to a self-contained stateless token 😅 it can only be invalidated by expiry, not revoked early, without reintroducing the server-side state. So the fix is to document the contract and give integrators guidance.
Notes