Module webauthn_rs::prelude
source · [−]Expand description
A prelude of types that are used by Webauthn
Re-exports
pub use crate::Webauthn;pub use crate::WebauthnBuilder;Structs
A structure representing an Attestation CA and other options associated to this CA.
A list of AttestationCas and associated options.
Information about the authentication that occured.
The in progress state of an authentication attempt. You must persist this associated to the UserID requesting the registration.
A container for binary that should be base64 encoded in serialisation. In reverse when deserializing, will decode from many different types of base64 possible.
A JSON serializable challenge which is issued to the user’s webbrowser for handling. This is meant to be opaque, that is, you should not need to inspect or alter the content of the struct - you should serialise it and transmit it to the client only.
A device key belonging to a user
An in progress registration session for a DeviceKey.
An in progress registration session for a DeviceKey.
An in progress authentication session for a DiscoverableKey. Passkey and DeviceKey can be used with these workflows.
A key that can be used in discoverable workflows.
The processed attestation and its metadata
A Passkey for a user.
An in progress authentication session for a Passkey.
An in progress registration session for a Passkey.
A passwordless key for a user
An in progress registration session for a PasswordlessKey.
An in progress registration session for a PasswordlessKey.
A client response to an authentication challenge. This contains all required information to asses and assert trust in a credentials legitimacy, followed by authentication to a user.
A client response to a registration challenge. This contains all required information to asses and assert trust in a credentials legitimacy, followed by registration to a user.
A JSON serializable challenge which is issued to the user’s webbrowser for handling. This is meant to be opaque, that is, you should not need to inspect or alter the content of the struct - you should serialise it and transmit it to the client only.
A Security Key for a user.
An in progress authentication session for a SecurityKey.
An in progress registration session for a SecurityKey.
A parsed URL record.
A Universally Unique Identifier (UUID).
Enums
The type of attestation on the credential
The processed Attestation that the Authenticator is providing in it’s AttestedCredentialData. This metadata may allow identification of the device and it’s specific properties.
The authenticator attachment hint. This is NOT enforced, and is only used to help a user select a relevant authenticator type.
The processed Attestation that the Authenticator is providing in it’s AttestedCredentialData
Possible errors that may occur during Webauthn Operation processing.
Type Definitions
A credential ID type. At the moment this is a vector of bytes, but it could also be a future change for this to be base64 string instead.
A wrapper for Result<T, WebauthnError>