diff options
author | Ed Maste <emaste@FreeBSD.org> | 2021-10-07 01:27:02 +0000 |
---|---|---|
committer | Ed Maste <emaste@FreeBSD.org> | 2021-10-07 01:29:18 +0000 |
commit | 0afa8e065e14bb8fd338d75690e0238c00167d40 (patch) | |
tree | 1912135140a9dce440d48db15145d624c3e66276 /contrib/libfido2/man/fido_dev_enable_entattest.3 | |
parent | d586c978b9b4216869e589daa5bbcc33225a0e35 (diff) | |
parent | a58dee945a5da64d0e97f35a508928e0d17c9cc7 (diff) | |
download | src-0afa8e065e14bb8fd338d75690e0238c00167d40.tar.gz src-0afa8e065e14bb8fd338d75690e0238c00167d40.zip |
Import libfido2 at 'contrib/libfido2/'
git-subtree-dir: contrib/libfido2
git-subtree-mainline: d586c978b9b4216869e589daa5bbcc33225a0e35
git-subtree-split: a58dee945a5da64d0e97f35a508928e0d17c9cc7
Diffstat (limited to 'contrib/libfido2/man/fido_dev_enable_entattest.3')
-rw-r--r-- | contrib/libfido2/man/fido_dev_enable_entattest.3 | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/contrib/libfido2/man/fido_dev_enable_entattest.3 b/contrib/libfido2/man/fido_dev_enable_entattest.3 new file mode 100644 index 000000000000..7cb766d41d0c --- /dev/null +++ b/contrib/libfido2/man/fido_dev_enable_entattest.3 @@ -0,0 +1,98 @@ +.\" Copyright (c) 2020 Yubico AB. All rights reserved. +.\" Use of this source code is governed by a BSD-style +.\" license that can be found in the LICENSE file. +.\" +.Dd $Mdocdate: September 22 2020 $ +.Dt FIDO_DEV_ENABLE_ENTATTEST 3 +.Os +.Sh NAME +.Nm fido_dev_enable_entattest , +.Nm fido_dev_toggle_always_uv , +.Nm fido_dev_force_pin_change , +.Nm fido_dev_set_pin_minlen +.Nd FIDO 2.1 configuration authenticator API +.Sh SYNOPSIS +.In fido.h +.In fido/config.h +.Ft int +.Fn fido_dev_enable_entattest "fido_dev_t *dev" "const char *pin" +.Ft int +.Fn fido_dev_toggle_always_uv "fido_dev_t *dev" "const char *pin" +.Ft int +.Fn fido_dev_force_pin_change "fido_dev_t *dev" "const char *pin" +.Ft int +.Fn fido_dev_set_pin_minlen "fido_dev_t *dev" "size_t len" "const char *pin" +.Sh DESCRIPTION +The functions described in this page allow configuration of a +FIDO 2.1 authenticator. +.Pp +The +.Fn fido_dev_enable_entattest +function enables the +.Em Enterprise Attestation +feature on +.Fa dev . +.Em Enterprise Attestation +instructs the authenticator to include uniquely identifying +information in subsequent attestation statements. +The +.Fa pin +parameter may be NULL if +.Fa dev +does not have a PIN set. +.Pp +The +.Fn fido_dev_toggle_always_uv +function toggles the +.Dq user verification always +feature on +.Fa dev . +When set, this toggle enforces user verification at the +authenticator level for all known credentials. +If +.Fa dev +supports U2F (CTAP1) and the user verification methods supported by +the authenticator do not allow protection of U2F credentials, the +U2F subsystem will be disabled by the authenticator. +The +.Fa pin +parameter may be NULL if +.Fa dev +does not have a PIN set. +.Pp +The +.Fn fido_dev_force_pin_change +instructs +.Fa dev +to require a PIN change. +Subsequent PIN authentication attempts against +.Fa dev +will fail until its PIN is changed. +.Pp +The +.Fn fido_dev_set_pin_minlen +function sets the minimum PIN length of +.Fa dev +to +.Fa len . +Minimum PIN lengths may only be increased. +.Pp +Configuration settings are reflected in the payload returned by the +authenticator in response to a +.Xr fido_dev_get_cbor_info 3 +call. +.Sh RETURN VALUES +The error codes returned by +.Fn fido_dev_enable_entattest , +.Fn fido_dev_toggle_always_uv , +.Fn fido_dev_force_pin_change , +and +.Fn fido_dev_set_pin_minlen +are defined in +.In fido/err.h . +On success, +.Dv FIDO_OK +is returned. +.Sh SEE ALSO +.Xr fido_dev_get_cbor_info 3 , +.Xr fido_dev_reset 3 |