Struct webauthn_rs::prelude::SecurityKey
source · [−]pub struct SecurityKey { /* private fields */ }
Expand description
A Security Key for a user.
These can be safely serialised and deserialised from a database for use.
Implementations
sourceimpl SecurityKey
impl SecurityKey
sourcepub fn cred_id(&self) -> &CredentialID
pub fn cred_id(&self) -> &CredentialID
Retrieve a reference to this Security Key’s credential ID.
sourcepub fn cred_algorithm(&self) -> &COSEAlgorithm
pub fn cred_algorithm(&self) -> &COSEAlgorithm
Retrieve the type of cryptographic algorithm used by this key
sourcepub fn attestation(&self) -> &ParsedAttestation
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.
sourcepub fn update_credential(&mut self, res: &AuthenticationResult) -> Option<bool>
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
sourceimpl Clone for SecurityKey
impl Clone for SecurityKey
sourcefn clone(&self) -> SecurityKey
fn clone(&self) -> SecurityKey
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for SecurityKey
impl Debug for SecurityKey
sourceimpl<'de> Deserialize<'de> for SecurityKey
impl<'de> Deserialize<'de> for SecurityKey
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<SecurityKey> for SecurityKey
impl PartialEq<SecurityKey> for SecurityKey
sourceimpl Serialize for SecurityKey
impl Serialize for SecurityKey
Auto Trait Implementations
impl RefUnwindSafe for SecurityKey
impl Send for SecurityKey
impl Sync for SecurityKey
impl Unpin for SecurityKey
impl UnwindSafe for SecurityKey
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more