|
Server : Apache/2.4.62 System : FreeBSD fbsdweb2.web.rcn.net 14.1-RELEASE FreeBSD 14.1-RELEASE releng/14.1-n267679-10e31f0946d8 GENERIC amd64 User : www ( 80) PHP Version : 8.3.8 Disable Function : NONE Directory : /usr/local/share/doc/libfido2/html/ |
Upload File : |
<!DOCTYPE html>
<html>
<!-- This is an automatically generated file. Do not edit.
Copyright (c) 2019-2021 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"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<link rel="stylesheet" href="style.css" type="text/css" media="all"/>
<title>FIDO_CREDMAN_METADATA_NEW(3)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">FIDO_CREDMAN_METADATA_NEW(3)</td>
<td class="head-vol">FreeBSD Library Functions Manual</td>
<td class="head-rtitle">FIDO_CREDMAN_METADATA_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>
<p class="Pp"><code class="Nm">fido_credman_metadata_new</code>,
<code class="Nm">fido_credman_rk_new</code>,
<code class="Nm">fido_credman_rp_new</code>,
<code class="Nm">fido_credman_metadata_free</code>,
<code class="Nm">fido_credman_rk_free</code>,
<code class="Nm">fido_credman_rp_free</code>,
<code class="Nm">fido_credman_rk_existing</code>,
<code class="Nm">fido_credman_rk_remaining</code>,
<code class="Nm">fido_credman_rk</code>,
<code class="Nm">fido_credman_rk_count</code>,
<code class="Nm">fido_credman_rp_id</code>,
<code class="Nm">fido_credman_rp_name</code>,
<code class="Nm">fido_credman_rp_count</code>,
<code class="Nm">fido_credman_rp_id_hash_ptr</code>,
<code class="Nm">fido_credman_rp_id_hash_len</code>,
<code class="Nm">fido_credman_get_dev_metadata</code>,
<code class="Nm">fido_credman_get_dev_rk</code>,
<code class="Nm">fido_credman_set_dev_rk</code>,
<code class="Nm">fido_credman_del_dev_rk</code>,
<code class="Nm">fido_credman_get_dev_rp</code> —
<span class="Nd">FIDO2 credential management API</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="In">#include <<a class="In">fido.h</a>></code>
<br/>
<code class="In">#include <<a class="In">fido/credman.h</a>></code></p>
<p class="Pp"><var class="Ft">fido_credman_metadata_t *</var>
<br/>
<code class="Fn">fido_credman_metadata_new</code>(<var class="Fa" style="white-space: nowrap;">void</var>);</p>
<p class="Pp"><var class="Ft">fido_credman_rk_t *</var>
<br/>
<code class="Fn">fido_credman_rk_new</code>(<var class="Fa" style="white-space: nowrap;">void</var>);</p>
<p class="Pp"><var class="Ft">fido_credman_rp_t *</var>
<br/>
<code class="Fn">fido_credman_rp_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_credman_metadata_free</code>(<var class="Fa" style="white-space: nowrap;">fido_credman_metadata_t
**metadata_p</var>);</p>
<p class="Pp"><var class="Ft">void</var>
<br/>
<code class="Fn">fido_credman_rk_free</code>(<var class="Fa" style="white-space: nowrap;">fido_credman_rk_t
**rk_p</var>);</p>
<p class="Pp"><var class="Ft">void</var>
<br/>
<code class="Fn">fido_credman_rp_free</code>(<var class="Fa" style="white-space: nowrap;">fido_credman_rp_t
**rp_p</var>);</p>
<p class="Pp"><var class="Ft">uint64_t</var>
<br/>
<code class="Fn">fido_credman_rk_existing</code>(<var class="Fa" style="white-space: nowrap;">const
fido_credman_metadata_t *metadata</var>);</p>
<p class="Pp"><var class="Ft">uint64_t</var>
<br/>
<code class="Fn">fido_credman_rk_remaining</code>(<var class="Fa" style="white-space: nowrap;">const
fido_credman_metadata_t *metadata</var>);</p>
<p class="Pp"><var class="Ft">const fido_cred_t *</var>
<br/>
<code class="Fn">fido_credman_rk</code>(<var class="Fa" style="white-space: nowrap;">const
fido_credman_rk_t *rk</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_credman_rk_count</code>(<var class="Fa" style="white-space: nowrap;">const
fido_credman_rk_t *rk</var>);</p>
<p class="Pp"><var class="Ft">const char *</var>
<br/>
<code class="Fn">fido_credman_rp_id</code>(<var class="Fa" style="white-space: nowrap;">const
fido_credman_rp_t *rp</var>,
<var class="Fa" style="white-space: nowrap;">size_t idx</var>);</p>
<p class="Pp"><var class="Ft">const char *</var>
<br/>
<code class="Fn">fido_credman_rp_name</code>(<var class="Fa" style="white-space: nowrap;">const
fido_credman_rp_t *rp</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_credman_rp_count</code>(<var class="Fa" style="white-space: nowrap;">const
fido_credman_rp_t *rp</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_credman_rp_id_hash_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_credman_rp_t *rp</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_credman_rp_id_hash_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_credman_rp_t *</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_credman_get_dev_metadata</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
*dev</var>,
<var class="Fa" style="white-space: nowrap;">fido_credman_metadata_t
*metadata</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_credman_get_dev_rk</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
*dev</var>, <var class="Fa" style="white-space: nowrap;">const char
*rp_id</var>, <var class="Fa" style="white-space: nowrap;">fido_credman_rk_t
*rk</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_credman_set_dev_rk</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
*dev</var>, <var class="Fa" style="white-space: nowrap;">fido_cred_t
*cred</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_credman_del_dev_rk</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
*dev</var>, <var class="Fa" style="white-space: nowrap;">const unsigned char
*cred_id</var>, <var class="Fa" style="white-space: nowrap;">size_t
cred_id_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_credman_get_dev_rp</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
*dev</var>, <var class="Fa" style="white-space: nowrap;">fido_credman_rp_t
*rp</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>
<p class="Pp">The credential management API of
<a class="permalink" href="#libfido2"><i class="Em" id="libfido2">libfido2</i></a>
allows resident credentials on a FIDO2 authenticator to be listed,
inspected, modified, and removed. Please note that not all FIDO2
authenticators support credential management. To obtain information on what
an authenticator supports, please refer to
<a class="Xr" href="fido_cbor_info_new.html">fido_cbor_info_new(3)</a>.</p>
<p class="Pp">The <var class="Vt">fido_credman_metadata_t</var> type abstracts
credential management metadata.</p>
<p class="Pp" id="fido_credman_metadata_new">The
<a class="permalink" href="#fido_credman_metadata_new"><code class="Fn">fido_credman_metadata_new</code></a>()
function returns a pointer to a newly allocated, empty
<var class="Vt">fido_credman_metadata_t</var> type. If memory cannot be
allocated, NULL is returned.</p>
<p class="Pp" id="fido_credman_metadata_free">The
<a class="permalink" href="#fido_credman_metadata_free"><code class="Fn">fido_credman_metadata_free</code></a>()
function releases the memory backing <var class="Fa">*metadata_p</var>,
where <var class="Fa">*metadata_p</var> must have been previously allocated
by <code class="Fn">fido_credman_metadata_new</code>(). On return,
<var class="Fa">*metadata_p</var> is set to NULL. Either
<var class="Fa">metadata_p</var> or <var class="Fa">*metadata_p</var> may be
NULL, in which case <code class="Fn">fido_credman_metadata_free</code>() is
a NOP.</p>
<p class="Pp" id="fido_credman_get_dev_metadata">The
<a class="permalink" href="#fido_credman_get_dev_metadata"><code class="Fn">fido_credman_get_dev_metadata</code></a>()
function populates <var class="Fa">metadata</var> with information retrieved
from <var class="Fa">dev</var>. A valid <var class="Fa">pin</var> must be
provided.</p>
<p class="Pp" id="fido_credman_rk_existing">The
<a class="permalink" href="#fido_credman_rk_existing"><code class="Fn">fido_credman_rk_existing</code></a>()
function inspects <var class="Fa">metadata</var> and returns the number of
resident credentials on the authenticator. The
<a class="permalink" href="#fido_credman_rk_remaining"><code class="Fn" id="fido_credman_rk_remaining">fido_credman_rk_remaining</code></a>()
function inspects <var class="Fa">metadata</var> and returns the estimated
number of resident credentials that can be created on the authenticator.</p>
<p class="Pp">The <var class="Vt">fido_credman_rk_t</var> type abstracts the set
of resident credentials belonging to a given relying party.</p>
<p class="Pp" id="fido_credman_rk_new">The
<a class="permalink" href="#fido_credman_rk_new"><code class="Fn">fido_credman_rk_new</code></a>()
function returns a pointer to a newly allocated, empty
<var class="Vt">fido_credman_rk_t</var> type. If memory cannot be allocated,
NULL is returned.</p>
<p class="Pp" id="fido_credman_rk_free">The
<a class="permalink" href="#fido_credman_rk_free"><code class="Fn">fido_credman_rk_free</code></a>()
function releases the memory backing <var class="Fa">*rk_p</var>, where
<var class="Fa">*rk_p</var> must have been previously allocated by
<code class="Fn">fido_credman_rk_new</code>(). On return,
<var class="Fa">*rk_p</var> is set to NULL. Either
<var class="Fa">rk_p</var> or <var class="Fa">*rk_p</var> may be NULL, in
which case <code class="Fn">fido_credman_rk_free</code>() is a NOP.</p>
<p class="Pp" id="fido_credman_get_dev_rk">The
<a class="permalink" href="#fido_credman_get_dev_rk"><code class="Fn">fido_credman_get_dev_rk</code></a>()
function populates <var class="Fa">rk</var> with the set of resident
credentials belonging to <var class="Fa">rp_id</var> in
<var class="Fa">dev</var>. A valid <var class="Fa">pin</var> must be
provided.</p>
<p class="Pp" id="fido_credman_rk_count">The
<a class="permalink" href="#fido_credman_rk_count"><code class="Fn">fido_credman_rk_count</code></a>()
function returns the number of resident credentials in
<var class="Fa">rk</var>. The
<a class="permalink" href="#fido_credman_rk"><code class="Fn" id="fido_credman_rk">fido_credman_rk</code></a>()
function returns a pointer to the credential at index
<var class="Fa">idx</var> in <var class="Fa">rk</var>. Please note that the
first credential in <var class="Fa">rk</var> has an
<var class="Fa">idx</var> (index) value of 0.</p>
<p class="Pp" id="fido_credman_set_dev_rk">The
<a class="permalink" href="#fido_credman_set_dev_rk"><code class="Fn">fido_credman_set_dev_rk</code></a>()
function updates the credential pointed to by <var class="Fa">cred</var> in
<var class="Fa">dev</var>. The credential id and user id attributes of
<var class="Fa">cred</var> must be set. See
<a class="Xr" href="fido_cred_set_id.html">fido_cred_set_id(3)</a> and
<a class="Xr" href="fido_cred_set_user.html">fido_cred_set_user(3)</a> for
details. Only a credential's user attributes (name, display name) may be
updated at this time.</p>
<p class="Pp" id="fido_credman_del_dev_rk">The
<a class="permalink" href="#fido_credman_del_dev_rk"><code class="Fn">fido_credman_del_dev_rk</code></a>()
function deletes the resident credential identified by
<var class="Fa">cred_id</var> from <var class="Fa">dev</var>, where
<var class="Fa">cred_id</var> points to <var class="Fa">cred_id_len</var>
bytes. A valid <var class="Fa">pin</var> must be provided.</p>
<p class="Pp">The <var class="Vt">fido_credman_rp_t</var> type abstracts
information about a relying party.</p>
<p class="Pp" id="fido_credman_rp_new">The
<a class="permalink" href="#fido_credman_rp_new"><code class="Fn">fido_credman_rp_new</code></a>()
function returns a pointer to a newly allocated, empty
<var class="Vt">fido_credman_rp_t</var> type. If memory cannot be allocated,
NULL is returned.</p>
<p class="Pp" id="fido_credman_rp_free">The
<a class="permalink" href="#fido_credman_rp_free"><code class="Fn">fido_credman_rp_free</code></a>()
function releases the memory backing <var class="Fa">*rp_p</var>, where
<var class="Fa">*rp_p</var> must have been previously allocated by
<code class="Fn">fido_credman_rp_new</code>(). On return,
<var class="Fa">*rp_p</var> is set to NULL. Either
<var class="Fa">rp_p</var> or <var class="Fa">*rp_p</var> may be NULL, in
which case <code class="Fn">fido_credman_rp_free</code>() is a NOP.</p>
<p class="Pp" id="fido_credman_get_dev_rp">The
<a class="permalink" href="#fido_credman_get_dev_rp"><code class="Fn">fido_credman_get_dev_rp</code></a>()
function populates <var class="Fa">rp</var> with information about relying
parties with resident credentials in <var class="Fa">dev</var>. A valid
<var class="Fa">pin</var> must be provided.</p>
<p class="Pp" id="fido_credman_rp_count">The
<a class="permalink" href="#fido_credman_rp_count"><code class="Fn">fido_credman_rp_count</code></a>()
function returns the number of relying parties in
<var class="Fa">rp</var>.</p>
<p class="Pp" id="fido_credman_rp_id">The
<a class="permalink" href="#fido_credman_rp_id"><code class="Fn">fido_credman_rp_id</code></a>()
and
<a class="permalink" href="#fido_credman_rp_name"><code class="Fn" id="fido_credman_rp_name">fido_credman_rp_name</code></a>()
functions return pointers to the id and name of relying party
<var class="Fa">idx</var> in <var class="Fa">rp</var>. If not NULL, the
values returned by these functions point to NUL-terminated UTF-8 strings.
Please note that the first relying party in <var class="Fa">rp</var> has an
<var class="Fa">idx</var> (index) value of 0.</p>
<p class="Pp" id="fido_credman_rp_id_hash_ptr">The
<a class="permalink" href="#fido_credman_rp_id_hash_ptr"><code class="Fn">fido_credman_rp_id_hash_ptr</code></a>()
function returns a pointer to the hashed id of relying party
<var class="Fa">idx</var> in <var class="Fa">rp</var>. The corresponding
length can be obtained by
<a class="permalink" href="#fido_credman_rp_id_hash_len"><code class="Fn" id="fido_credman_rp_id_hash_len">fido_credman_rp_id_hash_len</code></a>().
Please note that the first relying party in <var class="Fa">rp</var> has an
<var class="Fa">idx</var> (index) value of 0.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN
VALUES</a></h1>
<p class="Pp">The <code class="Fn">fido_credman_get_dev_metadata</code>(),
<code class="Fn">fido_credman_get_dev_rk</code>(),
<code class="Fn">fido_credman_set_dev_rk</code>(),
<code class="Fn">fido_credman_del_dev_rk</code>(), and
<code class="Fn">fido_credman_get_dev_rp</code>() functions return
<code class="Dv">FIDO_OK</code> on success. On error, a different error code
defined in <code class="In"><<a class="In">fido/err.h</a>></code> is
returned. Functions returning pointers are not guaranteed to succeed, and
should have their return values checked for NULL.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
ALSO</a></h1>
<p class="Pp"><a class="Xr" href="fido_cbor_info_new.html">fido_cbor_info_new(3)</a>,
<a class="Xr" href="fido_cred_new.html">fido_cred_new(3)</a>,
<a class="Xr" href="fido_dev_supports_credman.html">fido_dev_supports_credman(3)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="CAVEATS"><a class="permalink" href="#CAVEATS">CAVEATS</a></h1>
<p class="Pp">Resident credentials are called “discoverable
credentials” in CTAP 2.1.</p>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">June 28, 2019</td>
<td class="foot-os">Yubico AB</td>
</tr>
</table>
</body>
</html>