Sindbad~EG File Manager

Current Path : /usr/local/share/doc/libfido2/html/
Upload File :
Current File : //usr/local/share/doc/libfido2/html/fido_bio_dev_get_info.html

<!DOCTYPE html>
<html>
<!-- This is an automatically generated file.  Do not edit.
   Copyright (c) 2019 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_BIO_DEV_GET_INFO(3)</title>
</head>
<body>
<table class="head">
  <tr>
    <td class="head-ltitle">FIDO_BIO_DEV_GET_INFO(3)</td>
    <td class="head-vol">FreeBSD Library Functions Manual</td>
    <td class="head-rtitle">FIDO_BIO_DEV_GET_INFO(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_bio_dev_get_info</code>,
  <code class="Nm">fido_bio_dev_enroll_begin</code>,
  <code class="Nm">fido_bio_dev_enroll_continue</code>,
  <code class="Nm">fido_bio_dev_enroll_cancel</code>,
  <code class="Nm">fido_bio_dev_enroll_remove</code>,
  <code class="Nm">fido_bio_dev_get_template_array</code>,
  <code class="Nm">fido_bio_dev_set_template_name</code> &#x2014;
<div class="Nd">FIDO2 biometric authenticator API</div>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<code class="In">#include &lt;<a class="In">fido.h</a>&gt;</code>
<br/>
<code class="In">#include &lt;<a class="In">fido/bio.h</a>&gt;</code>
<p class="Pp"><var class="Ft">int</var>
  <br/>
  <code class="Fn">fido_bio_dev_get_info</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
    *dev</var>, <var class="Fa" style="white-space: nowrap;">fido_bio_info_t
    *info</var>);</p>
<p class="Pp"><var class="Ft">int</var>
  <br/>
  <code class="Fn">fido_bio_dev_enroll_begin</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
    *dev</var>, <var class="Fa" style="white-space: nowrap;">fido_bio_template_t
    *template</var>,
    <var class="Fa" style="white-space: nowrap;">fido_bio_enroll_t
    *enroll</var>, <var class="Fa" style="white-space: nowrap;">uint32_t
    timeout_ms</var>, <var class="Fa" style="white-space: nowrap;">const char
    *pin</var>);</p>
<p class="Pp"><var class="Ft">int</var>
  <br/>
  <code class="Fn">fido_bio_dev_enroll_continue</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
    *dev</var>, <var class="Fa" style="white-space: nowrap;">const
    fido_bio_template_t *template</var>,
    <var class="Fa" style="white-space: nowrap;">fido_bio_enroll_t
    *enroll</var>, <var class="Fa" style="white-space: nowrap;">uint32_t
    timeout_ms</var>);</p>
<p class="Pp"><var class="Ft">int</var>
  <br/>
  <code class="Fn">fido_bio_dev_enroll_cancel</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
    *dev</var>);</p>
<p class="Pp"><var class="Ft">int</var>
  <br/>
  <code class="Fn">fido_bio_dev_enroll_remove</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
    *dev</var>, <var class="Fa" style="white-space: nowrap;">const
    fido_bio_template_t *template</var>,
    <var class="Fa" style="white-space: nowrap;">const char *pin</var>);</p>
<p class="Pp"><var class="Ft">int</var>
  <br/>
  <code class="Fn">fido_bio_dev_get_template_array</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
    *dev</var>,
    <var class="Fa" style="white-space: nowrap;">fido_bio_template_array_t
    *template_array</var>, <var class="Fa" style="white-space: nowrap;">const
    char *pin</var>);</p>
<p class="Pp"><var class="Ft">int</var>
  <br/>
  <code class="Fn">fido_bio_dev_set_template_name</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
    *dev</var>, <var class="Fa" style="white-space: nowrap;">const
    fido_bio_template_t *template</var>,
    <var class="Fa" style="white-space: nowrap;">const char *pin</var>);</p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
The functions described in this page allow biometric templates on a FIDO2
  authenticator to be listed, created, removed, and customised. Please note that
  not all FIDO2 authenticators support biometric enrollment. For a description
  of the types involved, please refer to
  <a class="Xr" href="fido_bio_info_new.html">fido_bio_info_new(3)</a>,
  <a class="Xr" href="fido_bio_enroll_new.html">fido_bio_enroll_new(3)</a>, and
  <a class="Xr" href="fido_bio_template.html">fido_bio_template(3)</a>.
<p class="Pp">The <code class="Fn">fido_bio_dev_get_info</code>() function
    populates <var class="Fa">info</var> with sensor information from
    <var class="Fa">dev</var>.</p>
<p class="Pp">The <code class="Fn">fido_bio_dev_enroll_begin</code>() function
    initiates a biometric enrollment on <var class="Fa">dev</var>, instructing
    the authenticator to wait <var class="Fa">timeout_ms</var> milliseconds. On
    success, <var class="Fa">template</var> and <var class="Fa">enroll</var>
    will be populated with the newly created template's information and
    enrollment status, respectively.</p>
<p class="Pp">The <code class="Fn">fido_bio_dev_enroll_continue</code>()
    function continues an ongoing enrollment on <var class="Fa">dev</var>,
    instructing the authenticator to wait <var class="Fa">timeout_ms</var>
    milliseconds. On success, <var class="Fa">enroll</var> will be updated to
    reflect the status of the biometric enrollment.</p>
<p class="Pp">The <code class="Fn">fido_bio_dev_enroll_cancel</code>() function
    cancels an ongoing enrollment on <var class="Fa">dev</var>.</p>
<p class="Pp">The <code class="Fn">fido_bio_dev_enroll_remove</code>() function
    removes <var class="Fa">template</var> from <var class="Fa">dev</var>.</p>
<p class="Pp">The <code class="Fn">fido_bio_dev_get_template_array</code>()
    function populates <var class="Fa">template_array</var> with the templates
    currently enrolled on <var class="Fa">dev</var>.</p>
<p class="Pp">The <code class="Fn">fido_bio_dev_set_template_name</code>()
    function sets the friendly name of <var class="Fa">template</var> on
    <var class="Fa">dev</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_bio_dev_get_info</code>(),
  <code class="Fn">fido_bio_dev_enroll_begin</code>(),
  <code class="Fn">fido_bio_dev_enroll_continue</code>(),
  <code class="Fn">fido_bio_dev_enroll_cancel</code>(),
  <code class="Fn">fido_bio_dev_enroll_remove</code>(),
  <code class="Fn">fido_bio_dev_get_template_array</code>(), and
  <code class="Fn">fido_bio_dev_set_template_name</code>() are defined in
  <code class="In">&lt;<a class="In">fido/err.h</a>&gt;</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_bio_enroll_new.html">fido_bio_enroll_new(3)</a>,
  <a class="Xr" href="fido_bio_info_new.html">fido_bio_info_new(3)</a>,
  <a class="Xr" href="fido_bio_template.html">fido_bio_template(3)</a>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">September 13, 2019</td>
    <td class="foot-os">Yubico&#x00A0;AB</td>
  </tr>
</table>
</body>
</html>

Sindbad File Manager Version 1.0, Coded By Sindbad EG ~ The Terrorists