webauthn library
Classes
- Assertion
- An assertion to prove that the selectedCredentialId is owned by the user who is using the authenticator. The auth server can verify this assertion using the authenticatorData and the signature that is returned.
- AssertionResponse
- Attestation
- This is an attestation that you own the private key for the give credentialId that is in the authData. The public key is included so that verification signatures can be exchanged.
- AttestationResponse
- AuthenticationLocalizationOptions
-
Options to pass custom localized strings to the LocalAuth plugin
See
LocalAuthentication.authenticatefor the messages - Authenticator
- CreateCredentialOptions
- CredentialRequestOptions
- CredTypePubKeyAlgoPair
- A combination of credType and pubKeyAlgo that should be used with the given credential. We only have minimal support for the available combinations
- GetAssertionOptions
- Options to be passed with Getting an Assertion
- MakeCredentialOptions
- Options to be passed when we are Making a new Credential (attestation)
- PublicKeyCredentialDescriptor
- Information that the auth server sends to describe public keys that they have associated with a given username. We can then use this list while creating an Attestation to prove me own the private key associated with id.
- PublicKeyCredentialParameters
- RpEntity
- The relying party information @see https://www.w3.org/TR/webauthn/#webauthn-relying-party
- UserEntity
- Information from the relying party about the user that the operation relates to
- WebAPI
Enums
- AttestationType
- Enum for the types of attestations that are supported
- AuthenticatorTransports
- Transports that can be used for an Authenticator
- PublicKeyCredentialType
- Enum for the types of public keys that are allowed Currently only "public-key" is allowed
Exceptions / Errors
- AuthenticatorException
- Common class for exceptions that happen during attestation or assertion
- CredentialCreationException
- General exception for exceptions happening during attestation
- GetAssertionException
- General exception for exceptions handling during assertion
- InvalidArgumentException
- Exception for when invalid arguments were passed to a method
- KeyPairNotFound
- Exception for when a KeyPair cannot be found in the Secure Storage