refactor: make challenge/origin arguments less confusing #158
Conversation
This file contains 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
brauliomartinezlm
approved these changes
Apr 9, 2019
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.
Motivated by conversation in #150.
"original" is confusing here. It was intended to mean the original value when the ceremony started, but it might confuse by lead to think that during the Authentication ceremony, this is asking for the original value from the Registration, which is not what we want.
I considered naming them just
challengeandorigin, but I ended up withexpected_challengeandexpected_origin, because I was afraid that readingresponse.verify(challenge, origin)could lead to the potential confusion that this arguments are the ones being verified for correctness, when they are actually the expected values, and the things being verified are the ones "inside" the response.However, not strong on that if someone else prefers shorter names.