Sindbad~EG File Manager
<!DOCTYPE html>
<html>
<!-- This is an automatically generated file. Do not edit.
Copyright (c) 2020-2022 Yubico AB. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
SPDX-License-Identifier: BSD-2-Clause
-->
<head>
<meta charset="utf-8"/>
<link rel="stylesheet" href="style.css" type="text/css" media="all"/>
<title>FIDO_DEV_ENABLE_ENTATTEST(3)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">FIDO_DEV_ENABLE_ENTATTEST(3)</td>
<td class="head-vol">FreeBSD Library Functions Manual</td>
<td class="head-rtitle">FIDO_DEV_ENABLE_ENTATTEST(3)</td>
</tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<code class="Nm">fido_dev_enable_entattest</code>,
<code class="Nm">fido_dev_toggle_always_uv</code>,
<code class="Nm">fido_dev_force_pin_change</code>,
<code class="Nm">fido_dev_set_pin_minlen</code>,
<code class="Nm">fido_dev_set_pin_minlen_rpid</code> —
<div class="Nd">CTAP 2.1 configuration authenticator API</div>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<code class="In">#include <<a class="In">fido.h</a>></code>
<br/>
<code class="In">#include <<a class="In">fido/config.h</a>></code>
<p class="Pp"><var class="Ft">int</var>
<br/>
<code class="Fn">fido_dev_enable_entattest</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
*dev</var>, <var class="Fa" style="white-space: nowrap;">const char
*pin</var>);</p>
<p class="Pp"><var class="Ft">int</var>
<br/>
<code class="Fn">fido_dev_toggle_always_uv</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
*dev</var>, <var class="Fa" style="white-space: nowrap;">const char
*pin</var>);</p>
<p class="Pp"><var class="Ft">int</var>
<br/>
<code class="Fn">fido_dev_force_pin_change</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
*dev</var>, <var class="Fa" style="white-space: nowrap;">const char
*pin</var>);</p>
<p class="Pp"><var class="Ft">int</var>
<br/>
<code class="Fn">fido_dev_set_pin_minlen</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
*dev</var>, <var class="Fa" style="white-space: nowrap;">size_t len</var>,
<var class="Fa" style="white-space: nowrap;">const char *pin</var>);</p>
<p class="Pp"><var class="Ft">int</var>
<br/>
<code class="Fn">fido_dev_set_pin_minlen_rpid</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
*dev</var>, <var class="Fa" style="white-space: nowrap;">const char * const
*rpid</var>, <var class="Fa" style="white-space: nowrap;">size_t n</var>,
<var class="Fa" style="white-space: nowrap;">const char *pin</var>);</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
The functions described in this page allow configuration of a CTAP 2.1
authenticator.
<p class="Pp">The <code class="Fn">fido_dev_enable_entattest</code>() function
enables the <i class="Em">Enterprise Attestation</i> feature on
<var class="Fa">dev</var>. <i class="Em">Enterprise Attestation</i>
instructs the authenticator to include uniquely identifying information in
subsequent attestation statements. The <var class="Fa">pin</var> parameter
may be NULL if <var class="Fa">dev</var> does not have a PIN set.</p>
<p class="Pp">The <code class="Fn">fido_dev_toggle_always_uv</code>() function
toggles the “user verification always” feature on
<var class="Fa">dev</var>. When set, this toggle enforces user verification
at the authenticator level for all known credentials. If
<var class="Fa">dev</var> 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
<var class="Fa">pin</var> parameter may be NULL if <var class="Fa">dev</var>
does not have a PIN set.</p>
<p class="Pp">The <code class="Fn">fido_dev_force_pin_change</code>() function
instructs <var class="Fa">dev</var> to require a PIN change. Subsequent PIN
authentication attempts against <var class="Fa">dev</var> will fail until
its PIN is changed.</p>
<p class="Pp">The <code class="Fn">fido_dev_set_pin_minlen</code>() function
sets the minimum PIN length of <var class="Fa">dev</var> to
<var class="Fa">len</var>. Minimum PIN lengths may only be increased.</p>
<p class="Pp">The <code class="Fn">fido_dev_set_pin_minlen_rpid</code>()
function sets the list of relying party identifiers (RP IDs) that are
allowed to obtain the minimum PIN length of <var class="Fa">dev</var>
through the CTAP 2.1 <code class="Dv">FIDO_EXT_MINPINLEN</code> extension.
The list of RP identifiers is denoted by <var class="Fa">rpid</var>, a
vector of <var class="Fa">n</var> NUL-terminated UTF-8 strings. A copy of
<var class="Fa">rpid</var> is made, and no reference to it or its contents
is kept. The maximum value of <var class="Fa">n</var> supported by the
authenticator can be obtained using
<a class="Xr" href="fido_cbor_info_maxrpid_minpinlen.html">fido_cbor_info_maxrpid_minpinlen(3)</a>.</p>
<p class="Pp">Configuration settings are reflected in the payload returned by
the authenticator in response to a
<a class="Xr" href="fido_dev_get_cbor_info.html">fido_dev_get_cbor_info(3)</a>
call.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN
VALUES</a></h1>
The error codes returned by <code class="Fn">fido_dev_enable_entattest</code>(),
<code class="Fn">fido_dev_toggle_always_uv</code>(),
<code class="Fn">fido_dev_force_pin_change</code>(),
<code class="Fn">fido_dev_set_pin_minlen</code>(), and
<code class="Fn">fido_dev_set_pin_minlen_rpid</code>() are defined in
<code class="In"><<a class="In">fido/err.h</a>></code>. On success,
<code class="Dv">FIDO_OK</code> is returned.
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
ALSO</a></h1>
<a class="Xr" href="fido_cbor_info_maxrpid_minpinlen.html">fido_cbor_info_maxrpid_minpinlen(3)</a>,
<a class="Xr" href="fido_cred_pin_minlen.html">fido_cred_pin_minlen(3)</a>,
<a class="Xr" href="fido_dev_get_cbor_info.html">fido_dev_get_cbor_info(3)</a>,
<a class="Xr" href="fido_dev_reset.html">fido_dev_reset(3)</a>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">March 30, 2022</td>
<td class="foot-os">Yubico AB</td>
</tr>
</table>
</body>
</html>
Sindbad File Manager Version 1.0, Coded By Sindbad EG ~ The Terrorists