Struct webauthn_rs::prelude::Passkey

pub struct Passkey { /* private fields */ }

A Passkey for a user. A passkey is a term that covers all possible authenticators that may exist. These could be roaming credentials such as Apple’s Account back passkeys, they could be a users Yubikey, a Windows Hello TPM, or even a password manager softtoken.

Passkeys may opportunistically have some properties such as discoverability (residence). This is not a guarantee since enforcing residence on devices like yubikeys that have limited storage and no administration of resident keys may break the device.

These can be safely serialised and deserialised from a database for persistance.

Implementations

impl Passkey

pub fn cred_id(&self) -> &CredentialID

Retrieve a reference to this Pass Key’s credential ID.

pub fn cred_algorithm(&self) -> &COSEAlgorithm

Retrieve the type of cryptographic algorithm used by this key

pub fn get_public_key(&self) -> &COSEKey

Retrieve a reference to this Passkey’s credential public key.

pub fn update_credential(&mut self, res: &AuthenticationResult) -> Option<bool>

Post authentication, update this credentials properties.

To determine if this is required, you can inspect the result of authentication_result.needs_update(). Counter intuitively, most passkeys will never need their properties updated! This is because many passkeys lack an internal device activation counter (due to their synchronisation), and the backup-state flags are rarely if ever changed.

If the credential_id does not match, None is returned. If the cred id matches and the credential is updated, Some(true) is returned. If the cred id matches, but the credential is not changed, Some(false) is returned.

Trait Implementations

impl Clone for Passkey

fn clone(&self) -> Passkey

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Passkey

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Passkey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<Credential> for Passkey

Available on crate feature danger-credential-internals only.

fn from(cred: Credential) -> Self

Convert a generic webauthn credential into a Passkey

impl From<Passkey> for Credential

Available on crate feature danger-credential-internals only.

fn from(pk: Passkey) -> Self

Converts to this type from the input type.

impl PartialEq for Passkey

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Passkey

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.