libfido2 / Device functions

Device functions

Device functions

Function / manual Role
fido_dev_build Read firmware build version.
fido_dev_cancel Request cancellation of an active transaction.
fido_dev_close Close the authenticator handle.
fido_dev_enable_entattest Enable enterprise attestation for the device.
fido_dev_flags Read device flags.
fido_dev_force_fido2 Select FIDO2 rather than U2F.
fido_dev_force_pin_change Require a PIN change, subject to device support.
fido_dev_force_u2f Select U2F rather than FIDO2.
fido_dev_free Free the device handle; borrowed pointers become invalid.
fido_dev_get_assert Send the configured assertion request to the authenticator.
fido_dev_get_cbor_info Query authenticator capabilities into a CBOR-info object.
fido_dev_get_puat Obtain a PIN/UV authorization token.
fido_dev_get_retry_count Read remaining PIN attempts.
fido_dev_get_touch_begin Begin a device-touch detection operation.
fido_dev_get_touch_status Poll touch detection status.
fido_dev_get_uv_retry_count Read remaining built-in UV attempts.
fido_dev_has_pin Test whether a PIN is configured.
fido_dev_has_uv Test whether built-in UV is available.
fido_dev_io_handle Read the underlying I/O handle.
fido_dev_is_fido2 Test whether FIDO2 is selected.
fido_dev_is_winhello Test whether the backend is Windows Hello.
fido_dev_largeblob_get Read a large blob by credential key.
fido_dev_largeblob_get_array Read the authenticator large-blob array.
fido_dev_largeblob_remove Remove a stored large blob.
fido_dev_largeblob_set Write a large blob for a credential key.
fido_dev_largeblob_set_array Write the authenticator large-blob array.
fido_dev_major Read firmware major version.
fido_dev_make_cred Send the configured credential-creation request.
fido_dev_minor Read firmware minor version.
fido_dev_new Allocate a device handle.
fido_dev_new_with_info Allocate a device handle from discovery metadata.
fido_dev_open Open an authenticator by device path.
fido_dev_open_with_info Open an authenticator from discovery metadata.
fido_dev_protocol Read the selected CTAP protocol.
fido_dev_puat_len Read PIN/UV authorization token length.
fido_dev_puat_ptr Borrow PIN/UV authorization token data; valid while its owner is alive.
fido_dev_reset Reset the authenticator; deletes stored state.
fido_dev_set_io_functions Install custom host I/O callbacks.
fido_dev_set_pin Set or change the device PIN.
fido_dev_set_pin_minlen Configure minimum PIN length.
fido_dev_set_pin_minlen_rpid Set RP IDs permitted to read minimum PIN length.
fido_dev_set_puat Set the PIN/UV authorization token.
fido_dev_set_sigmask Set the signal mask used during device transactions.
fido_dev_set_timeout Set transaction timeout.
fido_dev_set_transport_functions Install custom transport callbacks.
fido_dev_supports_cred_prot Test support for credential protection.
fido_dev_supports_credman Test support for credential management.
fido_dev_supports_permissions Test support for permission-scoped PIN/UV tokens.
fido_dev_supports_pin Test whether PIN operations are supported.
fido_dev_supports_uv Test whether built-in UV is supported.
fido_dev_toggle_always_uv Toggle always-on user verification.

Device discovery functions

Function / manual Role
fido_dev_info_free Free the discovery list; borrowed pointers become invalid.
fido_dev_info_manifest Enumerate connected authenticators into an info list.
fido_dev_info_manufacturer_string Read the USB manufacturer string.
fido_dev_info_new Allocate a discovery list.
fido_dev_info_path Read the device path from a discovery entry.
fido_dev_info_product Read the USB product ID.
fido_dev_info_product_string Read the USB product string.
fido_dev_info_ptr Borrow an entry from the discovery result list.
fido_dev_info_set Populate a device-info entry.
fido_dev_info_vendor Read the USB vendor ID.

Authenticator information functions

Function / manual Role
fido_cbor_info_aaguid_len Read AAGUID length.
fido_cbor_info_aaguid_ptr Borrow AAGUID data; valid while its owner is alive.
fido_cbor_info_algorithm_cose Read a supported COSE algorithm identifier.
fido_cbor_info_algorithm_count Number of advertised algorithms.
fido_cbor_info_algorithm_type Read an advertised algorithm type.
fido_cbor_info_attfmts_len Read attfmts length.
fido_cbor_info_attfmts_ptr Borrow attfmts data; valid while its owner is alive.
fido_cbor_info_certs_len Read certs length.
fido_cbor_info_certs_name_ptr Borrow certs name data; valid while its owner is alive.
fido_cbor_info_certs_value_ptr Borrow certs value data; valid while its owner is alive.
fido_cbor_info_cfgcmds_len Read cfgcmds length.
fido_cbor_info_cfgcmds_ptr Borrow cfgcmds data; valid while its owner is alive.
fido_cbor_info_decrypt Decrypt GetInfo fields with a persistent PIN/UV authorization token.
fido_cbor_info_encid_len Read encid length.
fido_cbor_info_encid_ptr Borrow encid data; valid while its owner is alive.
fido_cbor_info_encstate_len Read encstate length.
fido_cbor_info_encstate_ptr Borrow encstate data; valid while its owner is alive.
fido_cbor_info_extensions_len Read extensions length.
fido_cbor_info_extensions_ptr Borrow extensions data; valid while its owner is alive.
fido_cbor_info_free Free the CBOR-info object; borrowed pointers become invalid.
fido_cbor_info_fwversion Read authenticator firmware version.
fido_cbor_info_id_len Read credential ID length.
fido_cbor_info_id_ptr Borrow credential ID data; valid while its owner is alive.
fido_cbor_info_long_touch_reset Read long-touch reset support.
fido_cbor_info_maxcredbloblen Read maximum credential-blob length.
fido_cbor_info_maxcredcntlst Read maximum credential-list count.
fido_cbor_info_maxcredidlen Read maximum credential-ID length.
fido_cbor_info_maxlargeblob Read maximum large-blob storage size.
fido_cbor_info_maxmsgsiz Read maximum message size.
fido_cbor_info_maxpinlen Read maximum PIN length.
fido_cbor_info_maxrpid_minpinlen Read maximum RP IDs for minimum-PIN policy.
fido_cbor_info_minpinlen Read configured minimum PIN length.
fido_cbor_info_new Allocate a CBOR-info object.
fido_cbor_info_new_pin_required Read whether new PIN configuration is required.
fido_cbor_info_options_len Read options length.
fido_cbor_info_options_name_ptr Borrow options name data; valid while its owner is alive.
fido_cbor_info_options_value_ptr Borrow options value data; valid while its owner is alive.
fido_cbor_info_pin_policy Read the PIN policy.
fido_cbor_info_pin_policy_url_len Read pin policy url length.
fido_cbor_info_pin_policy_url_ptr Borrow pin policy url data; valid while its owner is alive.
fido_cbor_info_protocols_len Read protocols length.
fido_cbor_info_protocols_ptr Borrow protocols data; valid while its owner is alive.
fido_cbor_info_reset_transports_len Read reset transports length.
fido_cbor_info_reset_transports_ptr Borrow reset transports data; valid while its owner is alive.
fido_cbor_info_rk_remaining Read remaining discoverable-credential slots.
fido_cbor_info_state_len Read state length.
fido_cbor_info_state_ptr Borrow state data; valid while its owner is alive.
fido_cbor_info_transports_len Read transports length.
fido_cbor_info_transports_ptr Borrow transports data; valid while its owner is alive.
fido_cbor_info_uv_attempts Read available UV attempts.
fido_cbor_info_uv_count_since_pin Read UV count since PIN authorization.
fido_cbor_info_uv_modality Read supported user-verification modalities.
fido_cbor_info_versions_len Read versions length.
fido_cbor_info_versions_ptr Borrow versions data; valid while its owner is alive.