|
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) 2018-2023 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_ASSERT_NEW(3)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">FIDO_ASSERT_NEW(3)</td>
<td class="head-vol">FreeBSD Library Functions Manual</td>
<td class="head-rtitle">FIDO_ASSERT_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_assert_new</code>,
<code class="Nm">fido_assert_free</code>,
<code class="Nm">fido_assert_count</code>,
<code class="Nm">fido_assert_rp_id</code>,
<code class="Nm">fido_assert_user_display_name</code>,
<code class="Nm">fido_assert_user_icon</code>,
<code class="Nm">fido_assert_user_name</code>,
<code class="Nm">fido_assert_authdata_ptr</code>,
<code class="Nm">fido_assert_authdata_raw_ptr</code>,
<code class="Nm">fido_assert_blob_ptr</code>,
<code class="Nm">fido_assert_clientdata_hash_ptr</code>,
<code class="Nm">fido_assert_hmac_secret_ptr</code>,
<code class="Nm">fido_assert_largeblob_key_ptr</code>,
<code class="Nm">fido_assert_user_id_ptr</code>,
<code class="Nm">fido_assert_sig_ptr</code>,
<code class="Nm">fido_assert_id_ptr</code>,
<code class="Nm">fido_assert_authdata_len</code>,
<code class="Nm">fido_assert_authdata_raw_len</code>,
<code class="Nm">fido_assert_blob_len</code>,
<code class="Nm">fido_assert_clientdata_hash_len</code>,
<code class="Nm">fido_assert_hmac_secret_len</code>,
<code class="Nm">fido_assert_largeblob_key_len</code>,
<code class="Nm">fido_assert_user_id_len</code>,
<code class="Nm">fido_assert_sig_len</code>,
<code class="Nm">fido_assert_id_len</code>,
<code class="Nm">fido_assert_sigcount</code>,
<code class="Nm">fido_assert_flags</code> — <span class="Nd">FIDO2
assertion 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></p>
<p class="Pp"><var class="Ft">fido_assert_t *</var>
<br/>
<code class="Fn">fido_assert_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_assert_free</code>(<var class="Fa" style="white-space: nowrap;">fido_assert_t
**assert_p</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_assert_count</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</var>);</p>
<p class="Pp"><var class="Ft">const char *</var>
<br/>
<code class="Fn">fido_assert_rp_id</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</var>);</p>
<p class="Pp"><var class="Ft">const char *</var>
<br/>
<code class="Fn">fido_assert_user_display_name</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</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_assert_user_icon</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</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_assert_user_name</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</var>,
<var class="Fa" style="white-space: nowrap;">size_t idx</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_assert_authdata_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</var>,
<var class="Fa" style="white-space: nowrap;">size_t idx</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_assert_authdata_raw_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</var>,
<var class="Fa" style="white-space: nowrap;">size_t idx</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_assert_clientdata_hash_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_assert_blob_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</var>,
<var class="Fa" style="white-space: nowrap;">size_t idx</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_assert_hmac_secret_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</var>,
<var class="Fa" style="white-space: nowrap;">size_t idx</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_assert_largeblob_key_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</var>,
<var class="Fa" style="white-space: nowrap;">size_t idx</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_assert_user_id_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</var>,
<var class="Fa" style="white-space: nowrap;">size_t idx</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_assert_sig_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</var>,
<var class="Fa" style="white-space: nowrap;">size_t idx</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_assert_id_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</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_assert_authdata_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</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_assert_authdata_raw_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</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_assert_clientdata_hash_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_assert_blob_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</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_assert_hmac_secret_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</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_assert_largeblob_key_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</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_assert_user_id_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</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_assert_sig_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</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_assert_id_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</var>,
<var class="Fa" style="white-space: nowrap;">size_t idx</var>);</p>
<p class="Pp"><var class="Ft">uint32_t</var>
<br/>
<code class="Fn">fido_assert_sigcount</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</var>,
<var class="Fa" style="white-space: nowrap;">size_t idx</var>);</p>
<p class="Pp"><var class="Ft">uint8_t</var>
<br/>
<code class="Fn">fido_assert_flags</code>(<var class="Fa" style="white-space: nowrap;">const
fido_assert_t *assert</var>,
<var class="Fa" style="white-space: nowrap;">size_t idx</var>);</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">A FIDO2 assertion is a collection of statements, each statement a
map between a challenge, a credential, a signature, and ancillary
attributes. In
<a class="permalink" href="#libfido2"><i class="Em" id="libfido2">libfido2</i></a>,
a FIDO2 assertion is abstracted by the <var class="Vt">fido_assert_t</var>
type. The functions described in this page allow a
<var class="Vt">fido_assert_t</var> type to be allocated, deallocated, and
inspected. For other operations on <var class="Vt">fido_assert_t</var>,
please refer to
<a class="Xr" href="fido_assert_set_authdata.html">fido_assert_set_authdata(3)</a>,
<a class="Xr" href="fido_assert_allow_cred.html">fido_assert_allow_cred(3)</a>,
<a class="Xr" href="fido_assert_verify.html">fido_assert_verify(3)</a>, and
<a class="Xr" href="fido_dev_get_assert.html">fido_dev_get_assert(3)</a>.</p>
<p class="Pp" id="fido_assert_new">The
<a class="permalink" href="#fido_assert_new"><code class="Fn">fido_assert_new</code></a>()
function returns a pointer to a newly allocated, empty
<var class="Vt">fido_assert_t</var> type. If memory cannot be allocated,
NULL is returned.</p>
<p class="Pp" id="fido_assert_free">The
<a class="permalink" href="#fido_assert_free"><code class="Fn">fido_assert_free</code></a>()
function releases the memory backing <var class="Fa">*assert_p</var>, where
<var class="Fa">*assert_p</var> must have been previously allocated by
<code class="Fn">fido_assert_new</code>(). On return,
<var class="Fa">*assert_p</var> is set to NULL. Either
<var class="Fa">assert_p</var> or <var class="Fa">*assert_p</var> may be
NULL, in which case <code class="Fn">fido_assert_free</code>() is a NOP.</p>
<p class="Pp" id="fido_assert_count">The
<a class="permalink" href="#fido_assert_count"><code class="Fn">fido_assert_count</code></a>()
function returns the number of statements in
<var class="Fa">assert</var>.</p>
<p class="Pp" id="fido_assert_rp_id">The
<a class="permalink" href="#fido_assert_rp_id"><code class="Fn">fido_assert_rp_id</code></a>()
function returns a pointer to a NUL-terminated string holding the relying
party ID of <var class="Fa">assert</var>.</p>
<p class="Pp" id="fido_assert_user_display_name">The
<a class="permalink" href="#fido_assert_user_display_name"><code class="Fn">fido_assert_user_display_name</code></a>(),
<a class="permalink" href="#fido_assert_user_icon"><code class="Fn" id="fido_assert_user_icon">fido_assert_user_icon</code></a>(),
and
<a class="permalink" href="#fido_assert_user_name"><code class="Fn" id="fido_assert_user_name">fido_assert_user_name</code></a>(),
functions return pointers to the user display name, icon, and name
attributes of statement <var class="Fa">idx</var> in
<var class="Fa">assert</var>. If not NULL, the values returned by these
functions point to NUL-terminated UTF-8 strings. The user display name,
icon, and name attributes will typically only be returned by the
authenticator if user verification was performed by the authenticator and
multiple resident/discoverable credentials were involved in the
assertion.</p>
<p class="Pp" id="fido_assert_authdata_ptr">The
<a class="permalink" href="#fido_assert_authdata_ptr"><code class="Fn">fido_assert_authdata_ptr</code></a>(),
<a class="permalink" href="#fido_assert_authdata_raw_ptr"><code class="Fn" id="fido_assert_authdata_raw_ptr">fido_assert_authdata_raw_ptr</code></a>(),
<a class="permalink" href="#fido_assert_clientdata_hash_ptr"><code class="Fn" id="fido_assert_clientdata_hash_ptr">fido_assert_clientdata_hash_ptr</code></a>(),
<a class="permalink" href="#fido_assert_id_ptr"><code class="Fn" id="fido_assert_id_ptr">fido_assert_id_ptr</code></a>(),
<a class="permalink" href="#fido_assert_user_id_ptr"><code class="Fn" id="fido_assert_user_id_ptr">fido_assert_user_id_ptr</code></a>(),
<a class="permalink" href="#fido_assert_sig_ptr"><code class="Fn" id="fido_assert_sig_ptr">fido_assert_sig_ptr</code></a>(),
<a class="permalink" href="#fido_assert_sigcount"><code class="Fn" id="fido_assert_sigcount">fido_assert_sigcount</code></a>(),
and
<a class="permalink" href="#fido_assert_flags"><code class="Fn" id="fido_assert_flags">fido_assert_flags</code></a>()
functions return pointers to the CBOR-encoded and raw authenticator data,
client data hash, credential ID, user ID, signature, signature count, and
authenticator data flags of statement <var class="Fa">idx</var> in
<var class="Fa">assert</var>.</p>
<p class="Pp" id="fido_assert_hmac_secret_ptr">The
<a class="permalink" href="#fido_assert_hmac_secret_ptr"><code class="Fn">fido_assert_hmac_secret_ptr</code></a>()
function returns a pointer to the hmac-secret attribute of statement
<var class="Fa">idx</var> in <var class="Fa">assert</var>. The HMAC Secret
Extension (hmac-secret) is a CTAP 2.0 extension. Note that the resulting
hmac-secret varies according to whether user verification was performed by
the authenticator.</p>
<p class="Pp" id="fido_assert_blob_ptr">The
<a class="permalink" href="#fido_assert_blob_ptr"><code class="Fn">fido_assert_blob_ptr</code></a>()
and
<a class="permalink" href="#fido_assert_largeblob_key_ptr"><code class="Fn" id="fido_assert_largeblob_key_ptr">fido_assert_largeblob_key_ptr</code></a>()
functions return pointers to the “credBlob” and
“largeBlobKey” attributes of statement
<var class="Fa">idx</var> in <var class="Fa">assert</var>. Credential Blob
(credBlob) and Large Blob Key (largeBlobKey) are CTAP 2.1 extensions.</p>
<p class="Pp" id="fido_assert_authdata_len">The
<a class="permalink" href="#fido_assert_authdata_len"><code class="Fn">fido_assert_authdata_len</code></a>(),
<a class="permalink" href="#fido_assert_authdata_raw_len"><code class="Fn" id="fido_assert_authdata_raw_len">fido_assert_authdata_raw_len</code></a>(),
<a class="permalink" href="#fido_assert_clientdata_hash_len"><code class="Fn" id="fido_assert_clientdata_hash_len">fido_assert_clientdata_hash_len</code></a>(),
<a class="permalink" href="#fido_assert_id_len"><code class="Fn" id="fido_assert_id_len">fido_assert_id_len</code></a>(),
<a class="permalink" href="#fido_assert_user_id_len"><code class="Fn" id="fido_assert_user_id_len">fido_assert_user_id_len</code></a>(),
<a class="permalink" href="#fido_assert_sig_len"><code class="Fn" id="fido_assert_sig_len">fido_assert_sig_len</code></a>(),
<a class="permalink" href="#fido_assert_hmac_secret_len"><code class="Fn" id="fido_assert_hmac_secret_len">fido_assert_hmac_secret_len</code></a>(),
<a class="permalink" href="#fido_assert_blob_len"><code class="Fn" id="fido_assert_blob_len">fido_assert_blob_len</code></a>(),
and
<a class="permalink" href="#fido_assert_largeblob_key_len"><code class="Fn" id="fido_assert_largeblob_key_len">fido_assert_largeblob_key_len</code></a>()
functions return the length of a given attribute.</p>
<p class="Pp">Please note that the first statement in
<var class="Fa">assert</var> has an <var class="Fa">idx</var> (index) value
of 0.</p>
<p class="Pp">The authenticator data and signature parts of an assertion
statement are typically passed to a FIDO2 server for verification.</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 authenticator data returned by
<code class="Fn">fido_assert_authdata_ptr</code>() is a CBOR-encoded byte
string, as obtained from the authenticator.</p>
<p class="Pp" id="const">The <code class="Fn">fido_assert_rp_id</code>(),
<code class="Fn">fido_assert_user_display_name</code>(),
<code class="Fn">fido_assert_user_icon</code>(),
<code class="Fn">fido_assert_user_name</code>(),
<code class="Fn">fido_assert_authdata_ptr</code>(),
<code class="Fn">fido_assert_clientdata_hash_ptr</code>(),
<code class="Fn">fido_assert_id_ptr</code>(),
<code class="Fn">fido_assert_user_id_ptr</code>(),
<code class="Fn">fido_assert_sig_ptr</code>(),
<code class="Fn">fido_assert_hmac_secret_ptr</code>(),
<code class="Fn">fido_assert_blob_ptr</code>(), and
<code class="Fn">fido_assert_largeblob_key_ptr</code>() functions may return
NULL if the respective field in <var class="Fa">assert</var> is not set. If
not NULL, returned pointers are guaranteed to exist until any API function
that takes <var class="Fa">assert</var> without the
<a class="permalink" href="#const"><i class="Em">const</i></a> qualifier is
invoked.</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_assert_allow_cred.html">fido_assert_allow_cred(3)</a>,
<a class="Xr" href="fido_assert_set_authdata.html">fido_assert_set_authdata(3)</a>,
<a class="Xr" href="fido_assert_verify.html">fido_assert_verify(3)</a>,
<a class="Xr" href="fido_dev_get_assert.html">fido_dev_get_assert(3)</a>,
<a class="Xr" href="fido_dev_largeblob_get.html">fido_dev_largeblob_get(3)</a></p>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">June 19, 2023</td>
<td class="foot-os">Yubico AB</td>
</tr>
</table>
</body>
</html>