Struct webauthn_authenticator_rs::ctap2::commands::GetInfoResponse

pub struct GetInfoResponse {

    pub versions: BTreeSet<String>,
    pub extensions: Option<Vec<String>>,
    pub aaguid: Option<Uuid>,
    pub options: Option<BTreeMap<String, bool>>,
    pub max_msg_size: Option<u32>,
    pub pin_protocols: Option<Vec<u32>>,
    pub max_cred_count_in_list: Option<u32>,
    pub max_cred_id_len: Option<u32>,
    pub transports: Option<Vec<String>>,
    pub algorithms: Option<Value>,
    pub max_serialized_large_blob_array: Option<usize>,
    pub force_pin_change: bool,
    pub min_pin_length: Option<usize>,
    pub firmware_version: Option<i128>,
    pub max_cred_blob_length: Option<usize>,
    pub max_rpids_for_set_min_pin_length: Option<u32>,
    pub preferred_platform_uv_attempts: Option<u32>,
    pub uv_modality: Option<u32>,
    pub certifications: Option<BTreeMap<String, u8>>,
    pub remaining_discoverable_credentials: Option<u32>,
    pub vendor_prototype_config_commands: Option<BTreeSet<u64>>,
}

Available on crate feature ctap2 only.

authenticatorGetInfo response type.

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

Fields

versions: BTreeSet<String>

All CTAP protocol versions which the token supports.

extensions: Option<Vec<String>>

All protocol extensions which the token supports.

aaguid: Option<Uuid>

The claimed AAGUID.

options: Option<BTreeMap<String, bool>>

List of supported options.

max_msg_size: Option<u32>

Maximum message size supported by the authenticator.

pin_protocols: Option<Vec<u32>>

All PIN/UV auth protocols which the token supports.

max_cred_count_in_list: Option<u32>

max_cred_id_len: Option<u32>

transports: Option<Vec<String>>

List of supported transports as strings.

Use get_transports to get a list of AuthenticatorTransport.

algorithms: Option<Value>

List of supported algorithms for credential generation.

max_serialized_large_blob_array: Option<usize>

force_pin_change: bool

min_pin_length: Option<usize>

Current minimum PIN length, in Unicode code points.

Use get_min_pin_length to get a default value for when this is not present.

firmware_version: Option<i128>

max_cred_blob_length: Option<usize>

max_rpids_for_set_min_pin_length: Option<u32>

preferred_platform_uv_attempts: Option<u32>

uv_modality: Option<u32>

certifications: Option<BTreeMap<String, u8>>

remaining_discoverable_credentials: Option<u32>

Estimated number of additional discoverable credentials which could be created on the authenticator, assuming maximally-sized fields for all requests (ie: errs low).

If a request to create a maximally-sized discoverable credential might fail due to storage constraints, the authenticator reports 0.

This value may vary over time, depending on the size of individual discoverable credentials, and the token’s storage allocation strategy.

CTAP compatibility

This field is optional, and may only be present on authenticators supporting CTAP 2.1 and later.

On authenticators supporting credential management (including CTAP 2.1-PRE), an optimistic estimate (ie: presuming minimally-sized fields) may be available from CredentialStorageMetadata::max_possible_remaining_resident_credentials_count.

vendor_prototype_config_commands: Option<BTreeSet<u64>>

Implementations

impl GetInfoResponse

pub fn get_min_pin_length(&self) -> usize

Current minimum PIN length, in Unicode code points.

If this is not present, defaults to 4.

pub fn get_transports(&self) -> Option<Vec<AuthenticatorTransport>>

Gets all supported transports for this authenticator which match known AuthenticatorTransport values. Unknown values are silently discarded.

pub fn get_option(&self, option: &str) -> Option<bool>

Gets the state of an option.

pub fn ctap21_biometrics(&self) -> Option<bool>

Checks if the authenticator supports and has configured CTAP 2.1 biometric authentication.

See also GetInfoResponse::ctap21pre_biometrics for CTAP 2.1-PRE authenticators.

Returns

• None: if not supported.
• Some(false): if supported, but not configured.
• Some(true): if supported and configured.

pub fn ctap21pre_biometrics(&self) -> Option<bool>

Checks if the authenticator supports and has configured CTAP 2.1-PRE biometric authentication.

See also GetInfoResponse::ctap21_biometrics for CTAP 2.1 authenticators.

Returns

• None: if not supported.
• Some(false): if supported, but not configured.
• Some(true): if supported and configured.

pub fn user_verification_configured(&self) -> bool

Returns true if the authenticator supports built-in user verification, and it has been configured.

pub fn supports_config(&self) -> bool

Returns true if the authenticator supports CTAP 2.1 authenticator configuration commands.

pub fn supports_enterprise_attestation(&self) -> bool

Returns true if the authenticator supports CTAP 2.1 enterprise attestation.

pub fn make_cred_uv_not_required(&self) -> bool

Returns true if user verification is not required for makeCredential requests.

pub fn ctap21_credential_management(&self) -> bool

Returns true if the authenticator supports CTAP 2.1 credential management.

pub fn ctap21pre_credential_management(&self) -> bool

Returns true if the authenticator supports CTAP 2.1-PRE credential management.

Trait Implementations

impl CBORResponse for GetInfoResponse

fn try_from(i: &[u8]) -> Result<Self, WebauthnCError>

impl Clone for GetInfoResponse

fn clone(&self) -> GetInfoResponse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetInfoResponse

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

Formats the value using the given formatter.

impl Default for GetInfoResponse

fn default() -> GetInfoResponse

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GetInfoResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for GetInfoResponse

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

Formats the value using the given formatter.

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

fn from(value: GetInfoResponse) -> Self

Converts to this type from the input type.

impl PartialEq for GetInfoResponse

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<BTreeMap<u32, Value>> for GetInfoResponse

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(raw: BTreeMap<u32, Value>) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for GetInfoResponse