Sindbad~EG File Manager

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

<!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"/>
  <link rel="stylesheet" href="style.css" type="text/css" media="all"/>
  <title>FIDO_DEV_GET_ASSERT(3)</title>
</head>
<body>
<table class="head">
  <tr>
    <td class="head-ltitle">FIDO_DEV_GET_ASSERT(3)</td>
    <td class="head-vol">FreeBSD Library Functions Manual</td>
    <td class="head-rtitle">FIDO_DEV_GET_ASSERT(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_dev_get_assert</code> &#x2014;
<div class="Nd">obtains an assertion from a FIDO2 device</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>
<p class="Pp"><var class="Ft">int</var>
  <br/>
  <code class="Fn">fido_dev_get_assert</code>(<var class="Fa" style="white-space: nowrap;">fido_dev_t
    *dev</var>, <var class="Fa" style="white-space: nowrap;">fido_assert_t
    *assert</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 <code class="Fn">fido_dev_get_assert</code>() function asks the FIDO2 device
  represented by <var class="Fa">dev</var> for an assertion according to the
  following parameters defined in <var class="Fa">assert</var>:
<p class="Pp"></p>
<ul class="Bl-dash Bl-compact">
  <li><code class="Nm">relying party ID</code>;</li>
  <li><code class="Nm">client data hash</code>;</li>
  <li><code class="Nm">list of allowed credential IDs</code>;</li>
  <li><code class="Nm">user presence and user verification
    attributes</code>.</li>
</ul>
<p class="Pp">See
    <a class="Xr" href="fido_assert_set_authdata.html">fido_assert_set_authdata(3)</a>
    for information on how these values are set.</p>
<p class="Pp">If a PIN is not needed to authenticate the request against
    <var class="Fa">dev</var>, then <var class="Fa">pin</var> may be NULL.
    Otherwise <var class="Fa">pin</var> must point to a NUL-terminated UTF-8
    string.</p>
<p class="Pp">After a successful call to
    <code class="Fn">fido_dev_get_assert</code>(), the
    <a class="Xr" href="fido_assert_count.html">fido_assert_count(3)</a>,
    <a class="Xr" href="fido_assert_user_display_name.html">fido_assert_user_display_name(3)</a>,
    <a class="Xr" href="fido_assert_user_icon.html">fido_assert_user_icon(3)</a>,
    <a class="Xr" href="fido_assert_user_name.html">fido_assert_user_name(3)</a>,
    <a class="Xr" href="fido_assert_authdata_ptr.html">fido_assert_authdata_ptr(3)</a>,
    <a class="Xr" href="fido_assert_user_id_ptr.html">fido_assert_user_id_ptr(3)</a>,
    <a class="Xr" href="fido_assert_sig_ptr.html">fido_assert_sig_ptr(3)</a>,
    and
    <a class="Xr" href="fido_assert_sigcount.html">fido_assert_sigcount(3)</a>
    functions may be invoked on <var class="Fa">assert</var> to retrieve the
    various attributes of the generated assertion.</p>
<p class="Pp">Please note that <code class="Fn">fido_dev_get_assert</code>() is
    synchronous and will block if necessary.</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_dev_get_assert</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_assert_new.html">fido_assert_new(3)</a>,
  <a class="Xr" href="fido_assert_set_authdata.html">fido_assert_set_authdata(3)</a>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">May 24, 2018</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