Man page - fido_dev_cancel(3)
Packages contains this manual
- fido_cred_set_uv(3)
- fido_cred_flags(3)
- fido_cred_type(3)
- fido_assert_set_count(3)
- es384_pk_from_ptr(3)
- fido_credman_rk_new(3)
- fido_assert_blob_ptr(3)
- fido_dev_set_timeout(3)
- fido_assert_user_id_len(3)
- fido_assert_set_extensions(3)
- fido_cbor_info_certs_value_ptr(3)
- fido_dev_close(3)
- fido_dev_info_set(3)
- fido_cred_sigcount(3)
- fido_cred_x5c_ptr(3)
- fido_cbor_info_maxcredbloblen(3)
- fido_bio_info_type(3)
- fido_dev_get_cbor_info(3)
- fido_cbor_info_protocols_ptr(3)
- fido_dev_info_product_string(3)
- fido_credman_rp_id(3)
- fido_dev_info_manufacturer_string(3)
- fido_bio_template_id_len(3)
- es384_pk_new(3)
- fido_credman_get_dev_rk(3)
- fido_bio_template_set_id(3)
- fido_cred_set_clientdata(3)
- fido_dev_largeblob_get(3)
- eddsa_pk_new(3)
- fido_dev_set_pin(3)
- fido_assert_set_authdata_raw(3)
- fido_cbor_info_extensions_len(3)
- fido_cred_set_rp(3)
- fido_cred_id_len(3)
- fido_cbor_info_algorithm_type(3)
- rs256_pk_from_ptr(3)
- fido_assert_id_len(3)
- fido_cbor_info_maxcredidlen(3)
- fido_cred_authdata_len(3)
- fido_cred_set_attstmt(3)
- fido_dev_get_retry_count(3)
- fido_credman_rp_name(3)
- fido_assert_set_hmac_secret(3)
- fido_cred_verify(3)
- fido_credman_rk_remaining(3)
- fido_cred_set_user(3)
- fido_dev_force_fido2(3)
- fido_bio_template_name(3)
- es256_pk_free(3)
- fido_cbor_info_certs_name_ptr(3)
- fido_cbor_info_uv_modality(3)
- fido_dev_flags(3)
- fido_cred_clientdata_hash_len(3)
- fido_dev_supports_permissions(3)
- fido_dev_open_with_info(3)
- fido_dev_is_winhello(3)
- fido_bio_template_free(3)
- fido_cred_pin_minlen(3)
- rs256_pk_free(3)
- fido_dev_largeblob_set(3)
- fido_dev_supports_pin(3)
- fido_dev_is_fido2(3)
- fido_bio_template_array_new(3)
- fido_cred_attstmt_ptr(3)
- fido_assert_sig_ptr(3)
- fido_credman_rk(3)
- fido_cbor_info_free(3)
- fido_bio_dev_get_template_array(3)
- fido_assert_allow_cred(3)
- fido_dev_set_pin_minlen(3)
- fido_cred_exclude(3)
- fido_cred_aaguid_ptr(3)
- fido_cbor_info_algorithm_count(3)
- fido_bio_info_max_samples(3)
- fido_credman_rp_id_hash_ptr(3)
- fido_cred_new(3)
- fido_bio_template(3)
- fido_dev_info_product(3)
- fido_credman_rp_id_hash_len(3)
- fido_cred_verify_self(3)
- eddsa_pk_free(3)
- fido_assert_set_winhello_appid(3)
- fido_cred_x5c_list_count(3)
- fido_bio_dev_get_info(3)
- fido_dev_get_assert(3)
- fido_credman_rk_count(3)
- fido_dev_reset(3)
- fido_credman_rp_free(3)
- fido_assert_set_sig(3)
- es384_pk_free(3)
- fido_cbor_info_maxmsgsiz(3)
- fido_cbor_info_transports_ptr(3)
- fido_cred_set_clientdata_hash(3)
- fido_cred_authdata_raw_ptr(3)
- fido_cred_set_sig(3)
- fido_assert_hmac_secret_len(3)
- fido_cbor_info_maxcredcntlst(3)
- fido_dev_info_ptr(3)
- fido_bio_dev_set_template_name(3)
- fido_dev_info_free(3)
- fido_cbor_info_extensions_ptr(3)
- fido_cbor_info_new_pin_required(3)
- fido_dev_has_uv(3)
- fido_assert_set_hmac_salt(3)
- fido_cbor_info_fwversion(3)
- fido_cred_set_authdata_raw(3)
- fido_cred_display_name(3)
- fido_credman_get_dev_metadata(3)
- fido_cred_user_id_ptr(3)
- fido_bio_info_free(3)
- fido_dev_largeblob_remove(3)
- fido_dev_info_manifest(3)
- fido_strerr(3)
- fido_cred_empty_exclude_list(3)
- fido_cred_set_fmt(3)
- fido_assert_authdata_raw_len(3)
- fido_assert_hmac_secret_ptr(3)
- fido_cred_set_type(3)
- fido_dev_set_transport_functions(3)
- es256_pk_from_ptr(3)
- fido_cred_prot(3)
- rs256_pk_new(3)
- fido_assert_rp_id(3)
- fido_assert_set_authdata(3)
- fido_dev_supports_uv(3)
- fido_dev_free(3)
- fido_dev_cancel(3)
- fido_cred_free(3)
- fido_cred_user_name(3)
- fido_cbor_info_algorithm_cose(3)
- fido_cred_set_prot(3)
- fido_assert_authdata_len(3)
- fido_dev_toggle_always_uv(3)
- fido_assert_largeblob_key_len(3)
- fido_cred_set_authdata(3)
- fido_assert_authdata_ptr(3)
- fido_dev_get_touch_status(3)
- fido_assert_set_uv(3)
- fido_cred_pubkey_len(3)
- fido_dev_open(3)
- fido_cbor_info_aaguid_len(3)
- fido_set_log_handler(3)
- fido_assert_free(3)
- fido_dev_supports_credman(3)
- fido_bio_enroll_remaining_samples(3)
- fido_assert_user_icon(3)
- fido_assert_sigcount(3)
- fido_credman_metadata_new(3)
- fido_cbor_info_new(3)
- fido_cred_x5c_list_len(3)
- es256_pk_new(3)
- fido_cred_fmt(3)
- fido_assert_count(3)
- fido_bio_dev_enroll_begin(3)
- fido_init(3)
- fido_assert_sig_len(3)
- fido_dev_largeblob_set_array(3)
- fido_dev_minor(3)
- fido_cbor_info_versions_len(3)
- fido_dev_info_vendor(3)
- fido_credman_metadata_free(3)
- fido_bio_dev_enroll_continue(3)
- fido_bio_dev_enroll_cancel(3)
- fido_cred_authdata_raw_len(3)
- fido_cred_set_id(3)
- fido_dev_new(3)
- fido_dev_force_pin_change(3)
- fido_cbor_info_options_name_ptr(3)
- fido_credman_rk_existing(3)
- fido_assert_empty_allow_list(3)
- fido_cbor_info_options_len(3)
- fido_bio_template_id_ptr(3)
- fido_cred_largeblob_key_ptr(3)
- fido_cred_aaguid_len(3)
- fido_cred_set_x509(3)
- fido_bio_template_new(3)
- fido_dev_get_uv_retry_count(3)
- fido_dev_enable_entattest(3)
- fido_credman_get_dev_rp(3)
- fido_cred_sig_len(3)
- fido_dev_get_touch_begin(3)
- fido_dev_new_with_info(3)
- fido_cred_authdata_ptr(3)
- fido_cred_set_attobj(3)
- fido_cbor_info_rk_remaining(3)
- fido_bio_dev_enroll_remove(3)
- fido_cbor_info_transports_len(3)
- fido_cbor_info_aaguid_ptr(3)
- fido_cred_set_rk(3)
- fido_assert_blob_len(3)
- fido_bio_template_array_count(3)
- fido_dev_make_cred(3)
- fido_cred_attstmt_len(3)
- fido_assert_flags(3)
- fido_dev_set_io_functions(3)
- fido_assert_set_rp(3)
- fido_cred_user_id_len(3)
- fido_dev_info_new(3)
- fido_cbor_info_maxlargeblob(3)
- fido_cbor_info_protocols_len(3)
- fido_credman_set_dev_rk(3)
- eddsa_pk_from_ptr(3)
- fido_assert_user_id_ptr(3)
- fido_cbor_info_certs_len(3)
- fido_credman_del_dev_rk(3)
- fido_bio_info_new(3)
- fido_bio_enroll_free(3)
- fido_dev_major(3)
- fido_assert_verify(3)
- fido_cbor_info_options_value_ptr(3)
- fido_cred_pubkey_ptr(3)
- fido_cbor_info_versions_ptr(3)
- fido_cred_rp_name(3)
- fido_cbor_info_uv_attempts(3)
- fido_dev_supports_cred_prot(3)
- fido_credman_rp_count(3)
- fido_cred_largeblob_key_len(3)
- fido_assert_id_ptr(3)
- fido_assert_largeblob_key_ptr(3)
- fido_assert_clientdata_hash_ptr(3)
- fido_assert_set_up(3)
- fido_cbor_info_maxrpid_minpinlen(3)
- fido_assert_set_clientdata(3)
- fido_cred_set_pin_minlen(3)
- fido_assert_user_name(3)
- fido_dev_force_u2f(3)
- fido_cred_rp_id(3)
- fido_assert_user_display_name(3)
- fido_cred_id_ptr(3)
- fido_dev_set_sigmask(3)
- fido_bio_enroll_new(3)
- fido_dev_info_path(3)
- fido_cred_x5c_len(3)
- fido_cred_x5c_list_ptr(3)
- fido_assert_new(3)
- fido_assert_authdata_raw_ptr(3)
- fido_dev_has_pin(3)
- fido_assert_set_clientdata_hash(3)
- fido_dev_build(3)
- fido_dev_protocol(3)
- fido_credman_rk_free(3)
- fido_bio_template_array_free(3)
- fido_dev_set_pin_minlen_rpid(3)
- fido_assert_clientdata_hash_len(3)
- fido_cred_set_blob(3)
- fido_cred_clientdata_hash_ptr(3)
- fido_bio_enroll_last_status(3)
- fido_cbor_info_minpinlen(3)
- fido_dev_largeblob_get_array(3)
- fido_cred_set_extensions(3)
- fido_cred_sig_ptr(3)
- fido_dev_io_handle(3)
- fido_bio_template_set_name(3)
- fido_credman_rp_new(3)
apt-get install libfido2-doc
Manual
FIDO_DEV_OPEN (3) Library Functions Manual FIDO_DEV_OPEN (3)
NAME
fido_dev_open, fido_dev_open_with_info, fido_dev_close, fido_dev_cancel, fido_dev_new, fido_dev_new_with_info, fido_dev_free, fido_dev_force_fido2, fido_dev_force_u2f, fido_dev_is_fido2, fido_dev_is_winhello, fido_dev_supports_credman, fido_dev_supports_cred_prot, fido_dev_supports_permissions, fido_dev_supports_pin, fido_dev_supports_uv, fido_dev_has_pin, fido_dev_has_uv, fido_dev_protocol, fido_dev_build, fido_dev_flags, fido_dev_major, fido_dev_minor — FIDO2 device open/close and related functions
SYNOPSIS
#include <fido.h>
int
fido_dev_open ( fido_dev_t *dev , const char *path );
int
fido_dev_open_with_info ( fido_dev_t *dev );
int
fido_dev_close ( fido_dev_t *dev );
int
fido_dev_cancel ( fido_dev_t *dev );
fido_dev_t *
fido_dev_new ( void );
fido_dev_t *
fido_dev_new_with_info ( const fido_dev_info_t * );
void
fido_dev_free ( fido_dev_t **dev_p );
void
fido_dev_force_fido2 ( fido_dev_t *dev );
void
fido_dev_force_u2f ( fido_dev_t *dev );
bool
fido_dev_is_fido2 ( const fido_dev_t *dev );
bool
fido_dev_is_winhello ( const fido_dev_t *dev );
bool
fido_dev_supports_credman ( const fido_dev_t *dev );
bool
fido_dev_supports_cred_prot ( const fido_dev_t *dev );
bool
fido_dev_supports_permissions ( const fido_dev_t *dev );
bool
fido_dev_supports_pin ( const fido_dev_t *dev );
bool
fido_dev_supports_uv ( const fido_dev_t *dev );
bool
fido_dev_has_pin ( const fido_dev_t *dev );
bool
fido_dev_has_uv ( const fido_dev_t *dev );
uint8_t
fido_dev_protocol ( const fido_dev_t *dev );
uint8_t
fido_dev_build ( const fido_dev_t *dev );
uint8_t
fido_dev_flags ( const fido_dev_t *dev );
uint8_t
fido_dev_major ( const fido_dev_t *dev );
uint8_t
fido_dev_minor ( const fido_dev_t *dev );
DESCRIPTION
The fido_dev_open () function opens the device pointed to by path , where dev is a freshly allocated or otherwise closed fido_dev_t . If dev claims to be FIDO2, libfido2 will attempt to speak FIDO2 to dev . If that fails, libfido2 will fallback to U2F unless the FIDO_DISABLE_U2F_FALLBACK flag was set in fido_init (3).
The fido_dev_open_with_info () function opens dev as previously allocated using fido_dev_new_with_info ().
The fido_dev_close () function closes the device represented by dev . If dev is already closed, fido_dev_close () is a NOP.
The fido_dev_cancel () function cancels any pending requests on dev .
The fido_dev_new () function returns a pointer to a newly allocated, empty fido_dev_t . If memory cannot be allocated, NULL is returned.
The fido_dev_new_with_info () function returns a pointer to a newly allocated fido_dev_t with fido_dev_info_t parameters, for use with fido_dev_info_manifest (3) and fido_dev_open_with_info (). If memory cannot be allocated, NULL is returned.
The fido_dev_free () function releases the memory backing *dev_p , where *dev_p must have been previously allocated by fido_dev_new (). On return, *dev_p is set to NULL. Either dev_p or *dev_p may be NULL, in which case fido_dev_free () is a NOP.
The fido_dev_force_fido2 () function can be used to force CTAP2 communication with dev , where dev is an open device.
The fido_dev_force_u2f () function can be used to force CTAP1 (U2F) communication with dev , where dev is an open device.
The fido_dev_is_fido2 () function returns true if dev is a FIDO2 device.
The fido_dev_is_winhello () function returns true if dev is a Windows Hello device.
The fido_dev_supports_credman () function returns true if dev supports CTAP 2.1 Credential Management.
The fido_dev_supports_cred_prot () function returns true if dev supports CTAP 2.1 Credential Protection.
The fido_dev_supports_permissions () function returns true if dev supports CTAP 2.1 UV token permissions.
The fido_dev_supports_pin () function returns true if dev supports CTAP 2.0 Client PINs.
The fido_dev_supports_uv () function returns true if dev supports a built-in user verification method.
The fido_dev_has_pin () function returns true if dev has a CTAP 2.0 Client PIN set.
The fido_dev_has_uv () function returns true if dev supports built-in user verification and its user verification feature is configured.
The fido_dev_protocol () function returns the CTAPHID protocol version identifier of dev .
The fido_dev_build () function returns the CTAPHID build version number of dev .
The fido_dev_flags () function returns the CTAPHID capabilities flags of dev .
The fido_dev_major () function returns the CTAPHID major version number of dev .
The fido_dev_minor () function returns the CTAPHID minor version number of dev .
For the format and meaning of the CTAPHID parameters returned by functions above, please refer to the FIDO Client to Authenticator Protocol (CTAP) specification.
RETURN VALUES
On success, fido_dev_open (), fido_dev_open_with_info (), and fido_dev_close () return FIDO_OK. On error, a different error code defined in < fido/err.h > is returned.
SEE ALSO
fido_dev_info_manifest (3), fido_dev_set_io_functions (3), fido_init (3) Debian May 25, 2018 FIDO_DEV_OPEN (3)