|
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 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_INIT(3)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">FIDO_INIT(3)</td>
<td class="head-vol">FreeBSD Library Functions Manual</td>
<td class="head-rtitle">FIDO_INIT(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_init</code>,
<code class="Nm">fido_set_log_handler</code> —
<span class="Nd">initialise the FIDO2 library</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>
<div class="Bd Pp Li">
<pre>typedef void fido_log_handler_t(const char *);</pre>
</div>
<p class="Pp">
<br/>
<var class="Ft">void</var>
<br/>
<code class="Fn">fido_init</code>(<var class="Fa" style="white-space: nowrap;">int
flags</var>);</p>
<p class="Pp"><var class="Ft">void</var>
<br/>
<code class="Fn">fido_set_log_handler</code>(<var class="Fa" style="white-space: nowrap;">fido_log_handler_t
*handler</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_init"><code class="Fn" id="fido_init">fido_init</code></a>()
function initialises the <i class="Em">libfido2</i> library. Its invocation
must precede that of any other <i class="Em">libfido2</i> function in the
context of the executing thread.</p>
<p class="Pp">If <code class="Dv">FIDO_DEBUG</code> is set in
<var class="Fa">flags</var>, then debug output will be emitted by
<i class="Em">libfido2</i> on <i class="Em">stderr</i>. Alternatively, the
<code class="Ev">FIDO_DEBUG</code> environment variable may be set.</p>
<p class="Pp">If <code class="Dv">FIDO_DISABLE_U2F_FALLBACK</code> is set in
<var class="Fa">flags</var>, then <i class="Em">libfido2</i> will not
fallback to U2F in
<a class="Xr" href="fido_dev_open.html">fido_dev_open(3)</a> if a device
claims to support FIDO2 but fails to respond to a CTAP 2.0 greeting.</p>
<p class="Pp" id="fido_set_log_handler">The
<a class="permalink" href="#fido_set_log_handler"><code class="Fn">fido_set_log_handler</code></a>()
function causes <var class="Fa">handler</var> to be called for each log line
generated in the context of the executing thread. Lines passed to
<var class="Fa">handler</var> include a trailing newline character and are
not printed by <i class="Em">libfido2</i> on <i class="Em">stderr</i>.</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_cred_new.html">fido_cred_new(3)</a>,
<a class="Xr" href="fido_dev_info_manifest.html">fido_dev_info_manifest(3)</a>,
<a class="Xr" href="fido_dev_open.html">fido_dev_open(3)</a></p>
</section>
</div>
<table class="foot">
<tr>
<td class="foot-date">May 25, 2018</td>
<td class="foot-os">Yubico AB</td>
</tr>
</table>
</body>
</html>