Add new custom bytes encoder arg to options_to_json_dict#257
Merged
MasterKale merged 2 commits intomasterfrom Sep 4, 2025
Merged
Add new custom bytes encoder arg to options_to_json_dict#257MasterKale merged 2 commits intomasterfrom
options_to_json_dict#257MasterKale merged 2 commits intomasterfrom
Conversation
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.
Adding
options_to_json_dictopens the door to offering some more control over how options get serialized to simplified, JSON-serializabledictrepresentations.Three years ago issue #135 asked for the ability to get such a representation with
bytesvalues preserved as-is. In subsequent years that use case had been forgotten and I'd inadvertently broken the ability to achieve this.This PR fixes that by adding a new
bytes_encoderarg towebauthn.helpers.options_to_json_dict()that takes inbytesand returns whatever representation of those bytes makes sense for the RP. This arg is optional - it defaults to encoding bytes to Base64URL strings to preserve existing functionality.