Enum passkey_types::webauthn::ResidentKeyRequirement

pub enum ResidentKeyRequirement {
    Discouraged,
    Preferred,
    Required,
}

This enumeration’s values describe the Relying Party’s requirements for client-side [discoverable credentials] (formerly known as resident credentials or resident keys).

https://w3c.github.io/webauthn/#enumdef-residentkeyrequirement

Variants

Discouraged

The Relying Party prefers creating a server-side credential, but will accept a client-side discoverable credential. The client and authenticator SHOULD create a server-side credential if possible.

Note: A Relying Party cannot require that a created credential is a server-side credential and the Credential Properties Extension may not return a value for the rk property. Because of this, it may be the case that it does not know if a credential is a server-side credential or not and thus does not know whether creating a second credential with the same user handle will evict the first.

Preferred

The Relying Party strongly prefers creating a client-side discoverable credential, but will accept a server-side credential. The client and authenticator SHOULD create a discoverable credential if possible. For example, the client SHOULD guide the user through setting up user verification if needed to create a discoverable credential. This takes precedence over the setting of AuthenticatorSelectionCriteria::user_verification

Required

The Relying Party requires a client-side discoverable credential. The client MUST return an error if a client-side discoverable credential cannot be created.

Trait Implementations

impl Clone for ResidentKeyRequirement

fn clone(&self) -> ResidentKeyRequirement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ResidentKeyRequirement

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ResidentKeyRequirement

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ResidentKeyRequirement

fn eq(&self, other: &ResidentKeyRequirement) -> 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 ResidentKeyRequirement

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ResidentKeyRequirement

impl Eq for ResidentKeyRequirement

impl StructuralEq for ResidentKeyRequirement

impl StructuralPartialEq for ResidentKeyRequirement