Sindbad~EG File Manager
<!DOCTYPE html>
<html>
<!-- This is an automatically generated file. Do not edit.
Copyright (c) 2018-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_CBOR_INFO_NEW(3)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">FIDO_CBOR_INFO_NEW(3)</td>
<td class="head-vol">FreeBSD Library Functions Manual</td>
<td class="head-rtitle">FIDO_CBOR_INFO_NEW(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_cbor_info_new</code>,
<code class="Nm">fido_cbor_info_free</code>,
<code class="Nm">fido_dev_get_cbor_info</code>,
<code class="Nm">fido_cbor_info_aaguid_ptr</code>,
<code class="Nm">fido_cbor_info_extensions_ptr</code>,
<code class="Nm">fido_cbor_info_protocols_ptr</code>,
<code class="Nm">fido_cbor_info_transports_ptr</code>,
<code class="Nm">fido_cbor_info_versions_ptr</code>,
<code class="Nm">fido_cbor_info_options_name_ptr</code>,
<code class="Nm">fido_cbor_info_options_value_ptr</code>,
<code class="Nm">fido_cbor_info_algorithm_type</code>,
<code class="Nm">fido_cbor_info_algorithm_cose</code>,
<code class="Nm">fido_cbor_info_algorithm_count</code>,
<code class="Nm">fido_cbor_info_certs_name_ptr</code>,
<code class="Nm">fido_cbor_info_certs_value_ptr</code>,
<code class="Nm">fido_cbor_info_certs_len</code>,
<code class="Nm">fido_cbor_info_aaguid_len</code>,
<code class="Nm">fido_cbor_info_extensions_len</code>,
<code class="Nm">fido_cbor_info_protocols_len</code>,
<code class="Nm">fido_cbor_info_transports_len</code>,
<code class="Nm">fido_cbor_info_versions_len</code>,
<code class="Nm">fido_cbor_info_options_len</code>,
<code class="Nm">fido_cbor_info_maxmsgsiz</code>,
<code class="Nm">fido_cbor_info_maxcredbloblen</code>,
<code class="Nm">fido_cbor_info_maxcredcntlst</code>,
<code class="Nm">fido_cbor_info_maxcredidlen</code>,
<code class="Nm">fido_cbor_info_maxlargeblob</code>,
<code class="Nm">fido_cbor_info_maxrpid_minpinlen</code>,
<code class="Nm">fido_cbor_info_minpinlen</code>,
<code class="Nm">fido_cbor_info_fwversion</code>,
<code class="Nm">fido_cbor_info_uv_attempts</code>,
<code class="Nm">fido_cbor_info_uv_modality</code>,
<code class="Nm">fido_cbor_info_rk_remaining</code>,
<code class="Nm">fido_cbor_info_new_pin_required</code> —
<div class="Nd">FIDO2 CBOR Info 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>
<p class="Pp"><var class="Ft">fido_cbor_info_t *</var>
<br/>
<code class="Fn">fido_cbor_info_new</code>(<var class="Fa" style="white-space: nowrap;">void</var>);</p>
<p class="Pp"><var class="Ft">void</var>
<br/>
<code class="Fn">fido_cbor_info_free</code>(<var class="Fa" style="white-space: nowrap;">fido_cbor_info_t
**ci_p</var>);</p>
<p class="Pp"><var class="Ft">int</var>
<br/>
<code class="Fn">fido_dev_get_cbor_info</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
*dev</var>, <var class="Fa" style="white-space: nowrap;">fido_cbor_info_t
*ci</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_cbor_info_aaguid_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">char **</var>
<br/>
<code class="Fn">fido_cbor_info_extensions_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">const uint8_t *</var>
<br/>
<code class="Fn">fido_cbor_info_protocols_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">char **</var>
<br/>
<code class="Fn">fido_cbor_info_transports_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">char **</var>
<br/>
<code class="Fn">fido_cbor_info_versions_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">char **</var>
<br/>
<code class="Fn">fido_cbor_info_options_name_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">const bool *</var>
<br/>
<code class="Fn">fido_cbor_info_options_value_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">const char *</var>
<br/>
<code class="Fn">fido_cbor_info_algorithm_type</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>,
<var class="Fa" style="white-space: nowrap;">size_t idx</var>);</p>
<p class="Pp"><var class="Ft">int</var>
<br/>
<code class="Fn">fido_cbor_info_algorithm_cose</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>,
<var class="Fa" style="white-space: nowrap;">size_t idx</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cbor_info_algorithm_count</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">char **</var>
<br/>
<code class="Fn">fido_cbor_info_certs_name_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">const uint64_t *</var>
<br/>
<code class="Fn">fido_cbor_info_certs_value_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cbor_info_certs_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cbor_info_aaguid_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cbor_info_extensions_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cbor_info_protocols_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cbor_info_transports_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cbor_info_versions_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cbor_info_options_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">uint64_t</var>
<br/>
<code class="Fn">fido_cbor_info_maxmsgsiz</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">uint64_t</var>
<br/>
<code class="Fn">fido_cbor_info_maxcredbloblen</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">uint64_t</var>
<br/>
<code class="Fn">fido_cbor_info_maxcredcntlst</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">uint64_t</var>
<br/>
<code class="Fn">fido_cbor_info_maxcredidlen</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">uint64_t</var>
<br/>
<code class="Fn">fido_cbor_info_maxlargeblob</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">uint64_t</var>
<br/>
<code class="Fn">fido_cbor_info_maxrpid_minpinlen</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">uint64_t</var>
<br/>
<code class="Fn">fido_cbor_info_minpinlen</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">uint64_t</var>
<br/>
<code class="Fn">fido_cbor_info_fwversion</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">uint64_t</var>
<br/>
<code class="Fn">fido_cbor_info_uv_attempts</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">uint64_t</var>
<br/>
<code class="Fn">fido_cbor_info_uv_modality</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">int64_t</var>
<br/>
<code class="Fn">fido_cbor_info_rk_remaining</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
<p class="Pp"><var class="Ft">bool</var>
<br/>
<code class="Fn">fido_cbor_info_new_pin_required</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cbor_info_t *ci</var>);</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
The <code class="Fn">fido_cbor_info_new</code>() function returns a pointer to a
newly allocated, empty <var class="Vt">fido_cbor_info_t</var> type. If memory
cannot be allocated, NULL is returned.
<p class="Pp">The <code class="Fn">fido_cbor_info_free</code>() function
releases the memory backing <var class="Fa">*ci_p</var>, where
<var class="Fa">*ci_p</var> must have been previously allocated by
<code class="Fn">fido_cbor_info_new</code>(). On return,
<var class="Fa">*ci_p</var> is set to NULL. Either
<var class="Fa">ci_p</var> or <var class="Fa">*ci_p</var> may be NULL, in
which case <code class="Fn">fido_cbor_info_free</code>() is a NOP.</p>
<p class="Pp">The <code class="Fn">fido_dev_get_cbor_info</code>() function
transmits a <code class="Dv">CTAP_CBOR_GETINFO</code> command to
<var class="Fa">dev</var> and fills <var class="Fa">ci</var> with attributes
retrieved from the command's response. The
<code class="Fn">fido_dev_get_cbor_info</code>() function may block.</p>
<p class="Pp">The <code class="Fn">fido_cbor_info_aaguid_ptr</code>(),
<code class="Fn">fido_cbor_info_extensions_ptr</code>(),
<code class="Fn">fido_cbor_info_protocols_ptr</code>(),
<code class="Fn">fido_cbor_info_transports_ptr</code>(), and
<code class="Fn">fido_cbor_info_versions_ptr</code>() functions return
pointers to the authenticator attestation GUID, supported extensions, PIN
protocol, transports, and CTAP version strings of <var class="Fa">ci</var>.
The corresponding length of a given attribute can be obtained by
<code class="Fn">fido_cbor_info_aaguid_len</code>(),
<code class="Fn">fido_cbor_info_extensions_len</code>(),
<code class="Fn">fido_cbor_info_protocols_len</code>(),
<code class="Fn">fido_cbor_info_transports_len</code>(), or
<code class="Fn">fido_cbor_info_versions_len</code>().</p>
<p class="Pp">The <code class="Fn">fido_cbor_info_options_name_ptr</code>() and
<code class="Fn">fido_cbor_info_options_value_ptr</code>() functions return
pointers to the array of option names and their respective values in
<var class="Fa">ci</var>. The length of the options array is returned by
<code class="Fn">fido_cbor_info_options_len</code>().</p>
<p class="Pp">The <code class="Fn">fido_cbor_info_algorithm_count</code>()
function returns the number of supported algorithms in
<var class="Fa">ci</var>. The
<code class="Fn">fido_cbor_info_algorithm_cose</code>() function returns the
COSE identifier of algorithm <var class="Fa">idx</var> in
<var class="Fa">ci</var>, or 0 if the COSE identifier is unknown or unset.
The <code class="Fn">fido_cbor_info_algorithm_type</code>() function returns
the type of algorithm <var class="Fa">idx</var> in <var class="Fa">ci</var>,
or NULL if the type is unset. Please note that the first algorithm in
<var class="Fa">ci</var> has an <var class="Fa">idx</var> (index) value of
0.</p>
<p class="Pp">The <code class="Fn">fido_cbor_info_certs_name_ptr</code>() and
<code class="Fn">fido_cbor_info_certs_value_ptr</code>() functions return
pointers to the array of certification names and their respective values in
<var class="Fa">ci</var>. The length of the certifications array is returned
by <code class="Fn">fido_cbor_info_certs_len</code>().</p>
<p class="Pp">The <code class="Fn">fido_cbor_info_maxmsgsiz</code>() function
returns the maximum message size attribute of <var class="Fa">ci</var>.</p>
<p class="Pp">The <code class="Fn">fido_cbor_info_maxcredbloblen</code>()
function returns the maximum “credBlob” length in bytes
supported by the authenticator as reported in <var class="Fa">ci</var>.</p>
<p class="Pp">The <code class="Fn">fido_cbor_info_maxcredcntlst</code>()
function returns the maximum supported number of credentials in a single
credential ID list as reported in <var class="Fa">ci</var>.</p>
<p class="Pp">The <code class="Fn">fido_cbor_info_maxcredidlen</code>() function
returns the maximum supported length of a credential ID as reported in
<var class="Fa">ci</var>.</p>
<p class="Pp">The <code class="Fn">fido_cbor_info_maxrpid_minpinlen</code>()
function returns the maximum number of RP IDs that may be passed to
<a class="Xr" href="fido_dev_set_pin_minlen_rpid.html">fido_dev_set_pin_minlen_rpid(3)</a>,
as reported in <var class="Fa">ci</var>. The minimum PIN length attribute is
a CTAP 2.1 addition. If the attribute is not advertised by the
authenticator, the
<code class="Fn">fido_cbor_info_maxrpid_minpinlen</code>() function returns
zero.</p>
<p class="Pp">The <code class="Fn">fido_cbor_info_maxlargeblob</code>() function
returns the maximum length in bytes of an authenticator's serialized
largeBlob array as reported in <var class="Fa">ci</var>.</p>
<p class="Pp">The <code class="Fn">fido_cbor_info_minpinlen</code>() function
returns the minimum PIN length enforced by the authenticator as reported in
<var class="Fa">ci</var>. The minimum PIN length attribute is a CTAP 2.1
addition. If the attribute is not advertised by the authenticator, the
<code class="Fn">fido_cbor_info_minpinlen</code>() function returns
zero.</p>
<p class="Pp">The <code class="Fn">fido_cbor_info_fwversion</code>() function
returns the firmware version attribute of <var class="Fa">ci</var>.</p>
<p class="Pp">The <code class="Fn">fido_cbor_info_uv_attempts</code>() function
returns the number of UV attempts that the platform may attempt before
falling back to PIN authentication. If 1, then all
<a class="Xr" href="fido_dev_get_uv_retry_count.html">fido_dev_get_uv_retry_count(3)</a>
retries are handled internally by the authenticator and the platform may
only attempt non-PIN UV once. The UV attempts attribute is a CTAP 2.1
addition. If the attribute is not advertised by the authenticator, the
<code class="Fn">fido_cbor_info_uv_attempts</code>() function returns
zero.</p>
<p class="Pp">The <code class="Fn">fido_cbor_info_uv_modality</code>() function
returns a bitmask representing different UV modes supported by the
authenticator, as defined in the FIDO Registry of Predefined Values and
reported in <var class="Fa">ci</var>. See the
<i class="Em">FIDO_UV_MODE_*</i> definitions in
<code class="In"><<a class="In">fido/param.h</a>></code> for the set
of values defined by libfido2 and a brief description of each. The UV
modality attribute is a CTAP 2.1 addition. If the attribute is not
advertised by the authenticator, the
<code class="Fn">fido_cbor_info_uv_modality</code>() function returns
zero.</p>
<p class="Pp">The <code class="Fn">fido_cbor_info_rk_remaining</code>() function
returns the estimated number of additional resident/discoverable credentials
that can be stored on the authenticator as reported in
<var class="Fa">ci</var>. The estimated number of remaining resident
credentials is a CTAP 2.1 addition. If the attribute is not advertised by
the authenticator, the <code class="Fn">fido_cbor_info_rk_remaining</code>()
function returns -1.</p>
<p class="Pp">The <code class="Fn">fido_cbor_info_new_pin_required</code>()
function returns whether a new PIN is required by the authenticator as
reported in <var class="Fa">ci</var>. If
<code class="Fn">fido_cbor_info_new_pin_required</code>() returns true,
operations requiring PIN authentication will fail until a new PIN is set on
the authenticator. The
<a class="Xr" href="fido_dev_set_pin.html">fido_dev_set_pin(3)</a> function
can be used to set a new PIN.</p>
<p class="Pp">A complete example of how to use these functions can be found in
the <span class="Pa">example/info.c</span> file shipped with
<i class="Em">libfido2</i>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN
VALUES</a></h1>
The <code class="Fn">fido_cbor_info_aaguid_ptr</code>(),
<code class="Fn">fido_cbor_info_extensions_ptr</code>(),
<code class="Fn">fido_cbor_info_protocols_ptr</code>(),
<code class="Fn">fido_cbor_info_transports_ptr</code>(),
<code class="Fn">fido_cbor_info_versions_ptr</code>(),
<code class="Fn">fido_cbor_info_options_name_ptr</code>(), and
<code class="Fn">fido_cbor_info_options_value_ptr</code>() functions return
NULL if the respective field in <var class="Fa">ci</var> is absent. If not
NULL, returned pointers are guaranteed to exist until any API function that
takes <var class="Fa">ci</var> without the <i class="Em">const</i> qualifier
is invoked.
</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_dev_get_uv_retry_count.html">fido_dev_get_uv_retry_count(3)</a>,
<a class="Xr" href="fido_dev_open.html">fido_dev_open(3)</a>,
<a class="Xr" href="fido_dev_set_pin.html">fido_dev_set_pin(3)</a>,
<a class="Xr" href="fido_dev_set_pin_minlen_rpid.html">fido_dev_set_pin_minlen_rpid(3)</a>
<p class="Pp"><cite class="Rs"><span class="RsR">FIDO Registry of Predefined
Values</span>,
<a class="RsU" href="https://fidoalliance.org/specs/common-specs/fido-registry-v2.2-rd-20210525.html">https://fidoalliance.org/specs/common-specs/fido-registry-v2.2-rd-20210525.html</a>,
<span class="RsQ">FIDO Alliance</span>, <span class="RsD">2021-05-25</span>,
<span class="RsO">Review Draft, Version 2.2</span>.</cite></p>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">April 22, 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