|
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-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"/>
<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_VERIFY(3)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">FIDO_ASSERT_VERIFY(3)</td>
<td class="head-vol">FreeBSD Library Functions Manual</td>
<td class="head-rtitle">FIDO_ASSERT_VERIFY(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_verify</code> —
<span class="Nd">verifies the signature of a FIDO2 assertion
statement</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">int</var>
<br/>
<code class="Fn">fido_assert_verify</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>,
<var class="Fa" style="white-space: nowrap;">int cose_alg</var>,
<var class="Fa" style="white-space: nowrap;">const void *pk</var>);</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The
<a class="permalink" href="#fido_assert_verify"><code class="Fn" id="fido_assert_verify">fido_assert_verify</code></a>()
function verifies whether the signature contained in statement index
<var class="Fa">idx</var> of <var class="Fa">assert</var> matches the
parameters of the assertion. Before using
<code class="Fn">fido_assert_verify</code>() in a sensitive context, the
reader is strongly encouraged to make herself familiar with the FIDO2
assertion statement process as defined in the Web Authentication (webauthn)
standard.</p>
<p class="Pp">A brief description follows:</p>
<p class="Pp" id="fido_assert_verify~2">The
<a class="permalink" href="#fido_assert_verify~2"><code class="Fn">fido_assert_verify</code></a>()
function verifies whether the client data hash, relying party ID, user
presence and user verification attributes of <var class="Fa">assert</var>
have been attested by the holder of the private counterpart of the public
key <var class="Fa">pk</var> of COSE type <var class="Fa">cose_alg</var>,
where <var class="Fa">cose_alg</var> is <code class="Dv">COSE_ES256</code>,
<code class="Dv">COSE_ES384</code>, <code class="Dv">COSE_RS256</code>, or
<code class="Dv">COSE_EDDSA</code>, and <var class="Fa">pk</var> points to a
<var class="Vt">es256_pk_t</var>, <var class="Vt">es384_pk_t</var>,
<var class="Vt">rs256_pk_t</var>, or <var class="Vt">eddsa_pk_t</var> type
accordingly.</p>
<p class="Pp">Please note that the first statement in
<var class="Fa">assert</var> has an <var class="Fa">idx</var> 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 error codes returned by
<code class="Fn">fido_assert_verify</code>() are defined in
<code class="In"><<a class="In">fido/err.h</a>></code>. If statement
<var class="Fa">idx</var> of <var class="Fa">assert</var> passes
verification with <var class="Fa">pk</var>, then
<code class="Dv">FIDO_OK</code> is returned.</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_new.html">fido_assert_new(3)</a>,
<a class="Xr" href="fido_assert_set_authdata.html">fido_assert_set_authdata(3)</a></p>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">July 15, 2022</td>
<td class="foot-os">Yubico AB</td>
</tr>
</table>
</body>
</html>