Struct webauthn_authenticator_rs::ctap2::commands::ClientPinRequest

pub struct ClientPinRequest {
    pub pin_uv_protocol: Option<u32>,
    pub sub_command: ClientPinSubCommand,
    pub key_agreement: Option<COSEKey>,
    pub pin_uv_auth_param: Option<Vec<u8>>,
    pub new_pin_enc: Option<Vec<u8>>,
    pub pin_hash_enc: Option<Vec<u8>>,
    pub permissions: Permissions,
    pub rp_id: Option<String>,
}

Available on crate feature ctap2 only.

authenticatorclientPin request type.

See:

• ClientPinSubCommand for command types
• crate::ctap2::pin_uv constructs this command

Reference: https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-errata-20220621.html#authnrClientPin-cmd-dfn

Fields

pin_uv_protocol: Option<u32>

PIN / UV protocol version chosen by the platform

sub_command: ClientPinSubCommand

Action being requested

key_agreement: Option<COSEKey>

The platform-agreement key

pin_uv_auth_param: Option<Vec<u8>>

Output of calling “Authenticate” on some context specific to sub_command

new_pin_enc: Option<Vec<u8>>

An encrypted PIN

pin_hash_enc: Option<Vec<u8>>

An encrypted proof-of-knowledge of a PIN

permissions: Permissions

Permissions bitfield for GetPinUvAuthTokenUsingUvWithPermissions and GetPinUvAuthTokenUsingPinWithPermissions.

Field is omitted if 0.

rp_id: Option<String>

The RP ID to assign as the permissions RP ID

Trait Implementations

impl CBORCommand for ClientPinRequest

const CMD: u8 = 6u8

CTAP comand byte

type Response = ClientPinResponse

The response type associated with this command.

const HAS_PAYLOAD: bool = true

If true (default), then the command has a payload, which will be serialized into CBOR format.

fn cbor(&self) -> Result<Vec<u8>, Error>

Converts a CTAP v2 command into a binary form.

impl Clone for ClientPinRequest

fn clone(&self) -> ClientPinRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClientPinRequest

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

Formats the value using the given formatter.

impl Default for ClientPinRequest

fn default() -> ClientPinRequest

Returns the “default value” for a type.

impl From<ClientPinRequest> for BTreeMap<u32, Value>

fn from(value: ClientPinRequest) -> Self

Converts to this type from the input type.

impl PartialEq for ClientPinRequest

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ClientPinRequest

impl StructuralEq for ClientPinRequest

impl StructuralPartialEq for ClientPinRequest