-
-
Notifications
You must be signed in to change notification settings - Fork 146
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat/webauthn-L3-json-types #320
Merged
Merged
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
MasterKale
commented
Dec 28, 2022
MasterKale
commented
Dec 28, 2022
packages/server/src/authentication/verifyAuthenticationResponse.ts
Outdated
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
package:browser
@simplewebauthn/browser
package:server
@simplewebauthn/server
package:types
@simplewebauthn/typescript-types
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.
This PR updates the typescript-types, browser, and server packages with new JSON serialization-related types and functions as defined in L3 of the WebAuthn specification.
The new
PublicKeyCredential.parseCreationOptionsFromJSON()
,PublicKeyCredential.parseRequestOptionsFromJSON()
, andPublicKeyCredential.toJSON()
methods have been added to typescript-types, but browser package will not make use of them.The "simpler" use of SimpleWebAuthn will always be to pair browser with server, if an RP doesn't want to think about it. However, because of the way in which SimpleWebAuthn methods are being updated in this PR, RP's that choose to eschew use of browser for these JSON methods should gradually become able to spin their own front end logic with the official API methods and still use the values and methods from server for options and verification.
Breaking Changes
RegistrationCredentialJSON
type has been replaced by theRegistrationResponseJSON
typeAuthenticationCredentialJSON
type has been replaced by theAuthenticationResponseJSON
typeRegistrationResponseJSON.transports
has been relocated intoRegistrationCredentialJSON.response.transports
to mirror response structure in the WebAuthn specverifyRegistrationResponse()
method has had itscredential
argument renamed toresponse
verifyAuthenticationResponse()
method has had itscredential
argument renamed toresponse