docs: warn that RegExp audiences should be anchored#1040
Open
Hashim1999164 wants to merge 1 commit into
Open
Conversation
String audience checks are exact matches, but RegExp audiences use RegExp#test and can match unintended values when unanchored. Document this and show anchored examples. Fixes auth0#1019
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.
By submitting a PR to this repository, you agree to the terms within the Auth0 Code of Conduct. Please see the contributing guidelines for how to create and submit a high-quality PR for this repo.
Description
Documents that
audienceRegExp checks useRegExp#test(partial match) while string checks use exact equality, so unanchored patterns can accept unintended audiences. Updates the README examples to use anchored regexes and adds a short security note.References
Testing
Docs-only change; no runtime behavior changed.
Reviewed README rendering of the updated
audienceoption text.This change adds test coverage for new/changed/fixed functionality
Checklist