Struct webauthn_authenticator_rs::ctap2::commands::BioEnrollmentResponse

pub struct BioEnrollmentResponse {
    pub modality: Option<Modality>,
    pub fingerprint_kind: Option<FingerprintKind>,
    pub max_capture_samples_required_for_enroll: Option<u32>,
    pub template_id: Option<Vec<u8>>,
    pub last_enroll_sample_status: Option<EnrollSampleStatus>,
    pub remaining_samples: Option<u32>,
    pub template_infos: Vec<TemplateInfo>,
    pub max_template_friendly_name: Option<usize>,
}

Available on crate features ctap2-management and ctap2 only.

authenticatorBioEnrollment response type.

References:

• https://fidoalliance.org/specs/fido-v2.1-ps-20210615/fido-client-to-authenticator-protocol-v2.1-ps-errata-20220621.html#authenticatorBioEnrollment
• https://fidoalliance.org/specs/fido2/vendor/BioEnrollmentPrototype.pdf

Fields

modality: Option<Modality>

Biometric authentication modality supported by the authenticator.

Returned in response to a BioEnrollmentRequestTrait::GET_MODALITY request.

fingerprint_kind: Option<FingerprintKind>

The kind of fingerprint sensor used on the device.

Returned in response to a BioEnrollmentRequestTrait::GET_FINGERPRINT_SENSOR_INFO request.

max_capture_samples_required_for_enroll: Option<u32>

The maximum number of good fingerprint samples required for enrollment.

Returned in response to a BioEnrollmentRequestTrait::GET_FINGERPRINT_SENSOR_INFO request.

template_id: Option<Vec<u8>>

The identifier for the fingerprint being enrolled.

Returned in response to a BioSubCommand::FingerprintEnrollBegin request.

last_enroll_sample_status: Option<EnrollSampleStatus>

The state of the last collected fingerprint sample.

Returned in response to a BioSubCommand::FingerprintEnrollBegin or BioSubCommand::FingerprintEnrollCaptureNextSample request.

remaining_samples: Option<u32>

The number of good fingerprint samples required to complete enrollment.

Returned in response to a BioSubCommand::FingerprintEnrollBegin or BioSubCommand::FingerprintEnrollCaptureNextSample request.

template_infos: Vec<TemplateInfo>

A list of all enrolled fingerprints on the device.

Returned in response to a BioSubCommand::FingerprintEnumerateEnrollments request.

max_template_friendly_name: Option<usize>

The maximum length for a TemplateInfo::friendly_name used on the device.

Returned in response to a BioEnrollmentRequestTrait::GET_FINGERPRINT_SENSOR_INFO request.

Prefer using the get_max_template_friendly_name() method instead of this field, which also provides a default value if this is missing.

Implementations

impl BioEnrollmentResponse

pub fn get_max_template_friendly_name(&self) -> usize

Gets the maximum template friendly name size in bytes, or the default if none is provided.

This value is only valid as a response to BioEnrollmentRequestTrait::GET_FINGERPRINT_SENSOR_INFO.

Trait Implementations

impl CBORResponse for BioEnrollmentResponse

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

impl Debug for BioEnrollmentResponse

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

Formats the value using the given formatter.

impl Default for BioEnrollmentResponse

fn default() -> BioEnrollmentResponse

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BioEnrollmentResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for BioEnrollmentResponse

fn eq(&self, other: &BioEnrollmentResponse) -> 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 TryFrom<BTreeMap<u32, Value>> for BioEnrollmentResponse

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 Eq for BioEnrollmentResponse

impl StructuralEq for BioEnrollmentResponse

impl StructuralPartialEq for BioEnrollmentResponse