refactor: make required credentials creation options more explicit #155
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
These fields are required by the spec, they have meaning in how and when they should be used: https://www.w3.org/TR/2019/PR-webauthn-20190117/#dictionary-pkcredentialentity I think current the defaults are not helpful for users of the gem since they may be shown by the browser in the future. If this happens, the unchanged defaults may lead to authentication prompts like: > Scan fingerprint to authenticate as web-user for web-server To not break backwards compatibility while making the need for explicit configuration more obvious, I've made the keyword arguments optional for now with a note to change this for version 2.0.
bdewater
force-pushed
the
explicit-cred-creation-opts
branch
from
b59615a
to
0444f22
Compare
|
Good call. I think it might be worth considering in the future making RP name and ID configs that can be set just once during boot. While still supporting the override in the |
grzuy
reviewed
Apr 8, 2019
| TYPES = { create: "webauthn.create", get: "webauthn.get" }.freeze | ||
|
|
||
| def self.credential_creation_options | ||
| # TODO: make keyword arguments mandatory in next major version | ||
| def self.credential_creation_options(rp_name: "web-server", user_name: "web-user", display_name: "web-user", id: "1") |
There was a problem hiding this comment.
I think I'll change id to user_id to avoid confusion with RP ID.
Closed
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.
These fields are required by the spec, they have meaning in how and when they should be used: https://www.w3.org/TR/2019/PR-webauthn-20190117/#dictionary-pkcredentialentity
I think current the defaults are not helpful for users of the gem since they may be shown by the browser in the future. If this happens, the unchanged defaults may lead to authentication prompts like:
To not break backwards compatibility while making the need for explicit configuration more obvious, I've made the keyword arguments optional for now with a note to change this for version 2.0.