|
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-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_CRED_VERIFY(3)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">FIDO_CRED_VERIFY(3)</td>
<td class="head-vol">FreeBSD Library Functions Manual</td>
<td class="head-rtitle">FIDO_CRED_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_cred_verify</code>,
<code class="Nm">fido_cred_verify_self</code> —
<span class="Nd">verify the attestation signature of a FIDO2
credential</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_cred_verify</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">int</var>
<br/>
<code class="Fn">fido_cred_verify_self</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</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_cred_verify"><code class="Fn" id="fido_cred_verify">fido_cred_verify</code></a>()
and <code class="Fn">fido_cred_verify_self</code>() functions verify whether
the attestation signature contained in <var class="Fa">cred</var> matches
the attributes of the credential. Before using
<code class="Fn">fido_cred_verify</code>() or
<code class="Fn">fido_cred_verify_self</code>() in a sensitive context, the
reader is strongly encouraged to make herself familiar with the FIDO2
credential attestation process as defined in the Web Authentication
(webauthn) standard.</p>
<p class="Pp" id="fido_cred_verify~2">The
<a class="permalink" href="#fido_cred_verify~2"><code class="Fn">fido_cred_verify</code></a>()
function verifies whether the client data hash, relying party ID, credential
ID, type, protection policy, minimum PIN length, and resident/discoverable
key and user verification attributes of <var class="Fa">cred</var> have been
attested by the holder of the private counterpart of the public key
contained in the credential's x509 certificate.</p>
<p class="Pp">Please note that the x509 certificate itself is not verified.</p>
<p class="Pp" id="fido_cred_verify~3">The attestation statement formats
supported by
<a class="permalink" href="#fido_cred_verify~3"><code class="Fn">fido_cred_verify</code></a>()
are <i class="Em">packed</i>, <i class="Em">fido-u2f</i>, and
<a class="permalink" href="#tpm"><i class="Em" id="tpm">tpm</i></a>. The
attestation type implemented by <code class="Fn">fido_cred_verify</code>()
is <a class="permalink" href="#Basic"><i class="Em" id="Basic">Basic
Attestation</i></a>.</p>
<p class="Pp" id="fido_cred_verify_self">The
<a class="permalink" href="#fido_cred_verify_self"><code class="Fn">fido_cred_verify_self</code></a>()
function verifies whether the client data hash, relying party ID, credential
ID, type, protection policy, minimum PIN length, and resident/discoverable
key and user verification attributes of <var class="Fa">cred</var> have been
attested by the holder of the credential's private key.</p>
<p class="Pp" id="fido_cred_verify_self~2">The attestation statement formats
supported by
<a class="permalink" href="#fido_cred_verify_self~2"><code class="Fn">fido_cred_verify_self</code></a>()
are <i class="Em">packed</i> and <i class="Em">fido-u2f</i>. The attestation
type implemented by <code class="Fn">fido_cred_verify_self</code>() is
<a class="permalink" href="#Self"><i class="Em" id="Self">Self
Attestation</i></a>.</p>
<p class="Pp">Other attestation formats and types are not supported.</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_cred_verify</code>() and
<code class="Fn">fido_cred_verify_self</code>() are defined in
<code class="In"><<a class="In">fido/err.h</a>></code>. If
<var class="Fa">cred</var> passes verification, 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_cred_new.html">fido_cred_new(3)</a>,
<a class="Xr" href="fido_cred_set_authdata.html">fido_cred_set_authdata(3)</a></p>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">May 23, 2018</td>
<td class="foot-os">Yubico AB</td>
</tr>
</table>
</body>
</html>