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_CRED_EXCLUDE(3)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">FIDO_CRED_EXCLUDE(3)</td>
<td class="head-vol">FreeBSD Library Functions Manual</td>
<td class="head-rtitle">FIDO_CRED_EXCLUDE(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_cred_exclude</code>,
<code class="Nm">fido_cred_empty_exclude_list</code> —
<div class="Nd">manage exclude lists in a FIDO2 credential</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">int</var>
<br/>
<code class="Fn">fido_cred_exclude</code>(<var class="Fa" style="white-space: nowrap;">fido_cred_t
*cred</var>, <var class="Fa" style="white-space: nowrap;">const unsigned
char *ptr</var>, <var class="Fa" style="white-space: nowrap;">size_t
len</var>);</p>
<p class="Pp"><var class="Ft">int</var>
<br/>
<code class="Fn">fido_cred_empty_exclude_list</code>(<var class="Fa" style="white-space: nowrap;">fido_cred_t
*cred</var>);</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
The <code class="Fn">fido_cred_exclude</code>() function adds
<var class="Fa">ptr</var> to the list of credentials excluded by
<var class="Fa">cred</var>, where <var class="Fa">ptr</var> points to a
credential ID of <var class="Fa">len</var> bytes. A copy of
<var class="Fa">ptr</var> is made, and no references to the passed pointer are
kept. If <code class="Fn">fido_cred_exclude</code>() fails, the existing list
of excluded credentials is preserved.
<p class="Pp">If <code class="Nm">fido_cred_exclude</code> returns success and
<var class="Fa">cred</var> is later passed to
<a class="Xr" href="fido_dev_make_cred.html">fido_dev_make_cred(3)</a> on a
device that contains the credential denoted by <var class="Fa">ptr</var>,
then <a class="Xr" href="fido_dev_make_cred.html">fido_dev_make_cred(3)</a>
will fail.</p>
<p class="Pp">For the format of a FIDO2 credential ID, please refer to the Web
Authentication (webauthn) standard.</p>
<p class="Pp">The <code class="Fn">fido_cred_empty_exclude_list</code>()
function empties the list of credentials excluded by
<var class="Fa">cred</var>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="RETURN_VALUES"><a class="permalink" href="#RETURN_VALUES">RETURN
VALUES</a></h1>
The error codes returned by <code class="Fn">fido_cred_exclude</code>() and
<code class="Fn">fido_cred_empty_exclude_list</code>() are defined in
<code class="In"><<a class="In">fido/err.h</a>></code>. On success,
<code class="Dv">FIDO_OK</code> is returned.
</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_cred_new.html">fido_cred_new(3)</a>,
<a class="Xr" href="fido_cred_set_authdata.html">fido_cred_set_authdata(3)</a>,
<a class="Xr" href="fido_dev_make_cred.html">fido_dev_make_cred(3)</a>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">December 2, 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