Struct webauthn_rs::prelude::SecurityKey

pub struct SecurityKey { /* private fields */ }

A Security Key for a user.

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

Implementations

impl SecurityKey

pub fn cred_id(&self) -> &CredentialID

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

pub fn cred_algorithm(&self) -> &COSEAlgorithm

Retrieve the type of cryptographic algorithm used by this key

pub fn attestation(&self) -> &ParsedAttestation

Retrieve a reference to the attestation used during this Credential’s registration. This can tell you information about the manufacterer and what type of credential it is.

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(). Generally this will always be true as this class of key will maintain an activation counter which allows (limited) protection against device cloning.

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 SecurityKey

fn clone(&self) -> SecurityKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SecurityKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecurityKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<SecurityKey> for SecurityKey

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 SecurityKey

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

Serialize this value into the given Serde serializer.