Module webauthn_rs_core::proto

Protocol bindings

Re-exports

• pub use crate::interface::*;

Modules

• attest
  Types related to attestation (Registration)
• auth
  Types related to authentication (Assertion)
• cose
  Types related to CBOR Object Signing and Encryption (COSE)
• extensions
  Extensions allowing certain types of authenticators to provide supplemental information.
• options
  Types that define options as to how an authenticator may interact with with the server.

Structs

• AllowCredentials
  A descriptor of a credential that can be used.
• AuthenticationExtensions
  The set of extensions that were provided by the client during authentication
• AuthenticationExtensionsClientOutputs
  https://w3c.github.io/webauthn/#dictdef-authenticationextensionsclientoutputs The default option here for Options are None, so it can be derived
• AuthenticatorAssertionResponseRaw
  https://w3c.github.io/webauthn/#authenticatorassertionresponse
• AuthenticatorAttestationResponseRaw
  https://w3c.github.io/webauthn/#authenticatorattestationresponse
• AuthenticatorSelectionCriteria
  https://www.w3.org/TR/webauthn/#dictdef-authenticatorselectioncriteria
• Base64UrlSafeData
  A container for binary that should be base64 encoded in serialisation. In reverse when deserializing, will decode from many different types of base64 possible.
• CollectedClientData
  The data collected and hashed in the operation. https://www.w3.org/TR/webauthn-2/#dictdef-collectedclientdata
• CreationChallengeResponse
  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.
• CredProps
  https://www.w3.org/TR/webauthn-3/#sctn-authenticator-credential-properties-extension
• CredProtect
  The desired options for the client’s use of the credProtect extension
• HmacGetSecretInput
  The inputs to the hmac secret if it was created during registration.
• HmacGetSecretOutput
  The response to a hmac get secret request.
• PubKeyCredParams
  Public key cryptographic parameters
• PublicKeyCredential
  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.
• PublicKeyCredentialCreationOptions
  https://w3c.github.io/webauthn/#dictionary-makecredentialoptions
• PublicKeyCredentialDescriptor
  https://www.w3.org/TR/webauthn/#dictdef-publickeycredentialdescriptor
• PublicKeyCredentialRequestOptions
  The requested options for the authentication
• RegisterPublicKeyCredential
  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.
• RegisteredExtensions
  The set of extensions that were registered by this credential.
• RegistrationExtensionsClientOutputs
  https://w3c.github.io/webauthn/#dictdef-authenticationextensionsclientoutputs The default option here for Options are None, so it can be derived
• RelyingParty
  Relying Party Entity
• RequestAuthenticationExtensions
  Extension option inputs for PublicKeyCredentialRequestOptions
• RequestChallengeResponse
  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.
• RequestRegistrationExtensions
  Extension option inputs for PublicKeyCredentialCreationOptions.
• TokenBinding
  Token binding
• User
  User Entity

Enums

• AttestationConveyancePreference
  https://www.w3.org/TR/webauthn/#enumdef-attestationconveyancepreference
• AuthenticatorAttachment
  The authenticator attachment hint. This is NOT enforced, and is only used to help a user select a relevant authenticator type.
• AuthenticatorTransport
  https://www.w3.org/TR/webauthn/#enumdef-authenticatortransport
• COSEAlgorithm
  A COSE signature algorithm, indicating the type of key and hash type that should be used. You shouldn’t need to alter or use this value.
• CredentialProtectionPolicy
  Valid credential protection policies
• ExtnState
  The result state of an extension as returned from the authenticator.
• Mediation
  Request in residentkey workflows that conditional mediation should be used in the UI, or not.
• ResidentKeyRequirement
  The Relying Party’s requirements for client-side discoverable credentials.
• UserVerificationPolicy
  Defines the User Authenticator Verification policy. This is documented https://w3c.github.io/webauthn/#enumdef-userverificationrequirement, and each variant lists it’s effects.

Type Aliases

• CredentialID
  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.