|
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-2024 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_NEW(3)</title>
</head>
<body>
<table class="head">
<tr>
<td class="head-ltitle">FIDO_CRED_NEW(3)</td>
<td class="head-vol">FreeBSD Library Functions Manual</td>
<td class="head-rtitle">FIDO_CRED_NEW(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_new</code>,
<code class="Nm">fido_cred_free</code>,
<code class="Nm">fido_cred_pin_minlen</code>,
<code class="Nm">fido_cred_prot</code>,
<code class="Nm">fido_cred_fmt</code>,
<code class="Nm">fido_cred_rp_id</code>,
<code class="Nm">fido_cred_rp_name</code>,
<code class="Nm">fido_cred_user_name</code>,
<code class="Nm">fido_cred_display_name</code>,
<code class="Nm">fido_cred_authdata_ptr</code>,
<code class="Nm">fido_cred_authdata_raw_ptr</code>,
<code class="Nm">fido_cred_clientdata_hash_ptr</code>,
<code class="Nm">fido_cred_id_ptr</code>,
<code class="Nm">fido_cred_aaguid_ptr</code>,
<code class="Nm">fido_cred_largeblob_key_ptr</code>,
<code class="Nm">fido_cred_pubkey_ptr</code>,
<code class="Nm">fido_cred_sig_ptr</code>,
<code class="Nm">fido_cred_user_id_ptr</code>,
<code class="Nm">fido_cred_x5c_list_count</code>,
<code class="Nm">fido_cred_x5c_list_ptr</code>,
<code class="Nm">fido_cred_x5c_ptr</code>,
<code class="Nm">fido_cred_attstmt_ptr</code>,
<code class="Nm">fido_cred_authdata_len</code>,
<code class="Nm">fido_cred_authdata_raw_len</code>,
<code class="Nm">fido_cred_clientdata_hash_len</code>,
<code class="Nm">fido_cred_id_len</code>,
<code class="Nm">fido_cred_aaguid_len</code>,
<code class="Nm">fido_cred_largeblob_key_len</code>,
<code class="Nm">fido_cred_pubkey_len</code>,
<code class="Nm">fido_cred_sig_len</code>,
<code class="Nm">fido_cred_user_id_len</code>,
<code class="Nm">fido_cred_x5c_list_len</code>,
<code class="Nm">fido_cred_x5c_len</code>,
<code class="Nm">fido_cred_attstmt_len</code>,
<code class="Nm">fido_cred_type</code>,
<code class="Nm">fido_cred_flags</code>,
<code class="Nm">fido_cred_sigcount</code> — <span class="Nd">FIDO2
credential API</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">fido_cred_t *</var>
<br/>
<code class="Fn">fido_cred_new</code>(<var class="Fa" style="white-space: nowrap;">void</var>);</p>
<p class="Pp"><var class="Ft">void</var>
<br/>
<code class="Fn">fido_cred_free</code>(<var class="Fa" style="white-space: nowrap;">fido_cred_t
**cred_p</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cred_pin_minlen</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_prot</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">const char *</var>
<br/>
<code class="Fn">fido_cred_fmt</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">const char *</var>
<br/>
<code class="Fn">fido_cred_rp_id</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">const char *</var>
<br/>
<code class="Fn">fido_cred_rp_name</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">const char *</var>
<br/>
<code class="Fn">fido_cred_user_name</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">const char *</var>
<br/>
<code class="Fn">fido_cred_display_name</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_cred_authdata_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_cred_authdata_raw_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_cred_clientdata_hash_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_cred_id_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_cred_aaguid_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_cred_largeblob_key_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_cred_pubkey_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_cred_sig_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_cred_user_id_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cred_x5c_list_count</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_cred_x5c_list_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>, <var class="Fa" style="white-space: nowrap;">size_t
idx</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_cred_x5c_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">const unsigned char *</var>
<br/>
<code class="Fn">fido_cred_attstmt_ptr</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cred_authdata_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cred_authdata_raw_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cred_clientdata_hash_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cred_id_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cred_aaguid_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cred_largeblob_key_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cred_pubkey_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cred_sig_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cred_user_id_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cred_x5c_list_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>, <var class="Fa" style="white-space: nowrap;">size_t
idx</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cred_x5c_len</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">size_t</var>
<br/>
<code class="Fn">fido_cred_attstmt_len</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_type</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">uint8_t</var>
<br/>
<code class="Fn">fido_cred_flags</code>(<var class="Fa" style="white-space: nowrap;">const
fido_cred_t *cred</var>);</p>
<p class="Pp"><var class="Ft">uint32_t</var>
<br/>
<code class="Fn">fido_cred_sigcount</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">FIDO2 credentials are abstracted in <i class="Em">libfido2</i> by
the <var class="Vt">fido_cred_t</var> type. The functions described in this
page allow a <var class="Vt">fido_cred_t</var> type to be allocated,
deallocated, and inspected. For other operations on
<var class="Vt">fido_cred_t</var>, please refer to
<a class="Xr" href="fido_cred_set_authdata.html">fido_cred_set_authdata(3)</a>,
<a class="Xr" href="fido_cred_exclude.html">fido_cred_exclude(3)</a>,
<a class="Xr" href="fido_cred_verify.html">fido_cred_verify(3)</a>, and
<a class="Xr" href="fido_dev_make_cred.html">fido_dev_make_cred(3)</a>.</p>
<p class="Pp" id="fido_cred_new">The
<a class="permalink" href="#fido_cred_new"><code class="Fn">fido_cred_new</code></a>()
function returns a pointer to a newly allocated, empty
<var class="Vt">fido_cred_t</var> type. If memory cannot be allocated, NULL
is returned.</p>
<p class="Pp" id="fido_cred_free">The
<a class="permalink" href="#fido_cred_free"><code class="Fn">fido_cred_free</code></a>()
function releases the memory backing <var class="Fa">*cred_p</var>, where
<var class="Fa">*cred_p</var> must have been previously allocated by
<code class="Fn">fido_cred_new</code>(). On return,
<var class="Fa">*cred_p</var> is set to NULL. Either
<var class="Fa">cred_p</var> or <var class="Fa">*cred_p</var> may be NULL,
in which case <code class="Fn">fido_cred_free</code>() is a NOP.</p>
<p class="Pp" id="fido_cred_pin_minlen">If the CTAP 2.1
<code class="Dv">FIDO_EXT_MINPINLEN</code> extension is enabled on
<var class="Fa">cred</var>, then the
<a class="permalink" href="#fido_cred_pin_minlen"><code class="Fn">fido_cred_pin_minlen</code></a>()
function returns the minimum PIN length of <var class="Fa">cred</var>.
Otherwise, <code class="Fn">fido_cred_pin_minlen</code>() returns zero. See
<a class="Xr" href="fido_cred_set_pin_minlen.html">fido_cred_set_pin_minlen(3)</a>
on how to enable this extension.</p>
<p class="Pp" id="fido_cred_prot">If the CTAP 2.1
<code class="Dv">FIDO_EXT_CRED_PROTECT</code> extension is enabled on
<var class="Fa">cred</var>, then the
<a class="permalink" href="#fido_cred_prot"><code class="Fn">fido_cred_prot</code></a>()
function returns the protection of <var class="Fa">cred</var>. Otherwise,
<code class="Fn">fido_cred_prot</code>() returns zero. See
<a class="Xr" href="fido_cred_set_prot.html">fido_cred_set_prot(3)</a> for
the protection policies understood by <i class="Em">libfido2</i>.</p>
<p class="Pp" id="fido_cred_fmt">The
<a class="permalink" href="#fido_cred_fmt"><code class="Fn">fido_cred_fmt</code></a>()
function returns a pointer to a NUL-terminated string containing the
attestation statement format identifier of <var class="Fa">cred</var>, or
NULL if <var class="Fa">cred</var> does not have a format set.</p>
<p class="Pp" id="fido_cred_rp_id">The
<a class="permalink" href="#fido_cred_rp_id"><code class="Fn">fido_cred_rp_id</code></a>(),
<a class="permalink" href="#fido_cred_rp_name"><code class="Fn" id="fido_cred_rp_name">fido_cred_rp_name</code></a>(),
<a class="permalink" href="#fido_cred_user_name"><code class="Fn" id="fido_cred_user_name">fido_cred_user_name</code></a>(),
and
<a class="permalink" href="#fido_cred_display_name"><code class="Fn" id="fido_cred_display_name">fido_cred_display_name</code></a>()
functions return pointers to NUL-terminated strings holding the relying
party ID, relying party name, user name, and user display name attributes of
<var class="Fa">cred</var>, or NULL if the respective entry is not set.</p>
<p class="Pp" id="fido_cred_authdata_ptr">The
<a class="permalink" href="#fido_cred_authdata_ptr"><code class="Fn">fido_cred_authdata_ptr</code></a>(),
<a class="permalink" href="#fido_cred_authdata_raw_ptr"><code class="Fn" id="fido_cred_authdata_raw_ptr">fido_cred_authdata_raw_ptr</code></a>(),
<a class="permalink" href="#fido_cred_clientdata_hash_ptr"><code class="Fn" id="fido_cred_clientdata_hash_ptr">fido_cred_clientdata_hash_ptr</code></a>(),
<a class="permalink" href="#fido_cred_id_ptr"><code class="Fn" id="fido_cred_id_ptr">fido_cred_id_ptr</code></a>(),
<a class="permalink" href="#fido_cred_aaguid_ptr"><code class="Fn" id="fido_cred_aaguid_ptr">fido_cred_aaguid_ptr</code></a>(),
<a class="permalink" href="#fido_cred_largeblob_key_ptr"><code class="Fn" id="fido_cred_largeblob_key_ptr">fido_cred_largeblob_key_ptr</code></a>(),
<a class="permalink" href="#fido_cred_pubkey_ptr"><code class="Fn" id="fido_cred_pubkey_ptr">fido_cred_pubkey_ptr</code></a>(),
<a class="permalink" href="#fido_cred_sig_ptr"><code class="Fn" id="fido_cred_sig_ptr">fido_cred_sig_ptr</code></a>(),
<a class="permalink" href="#fido_cred_user_id_ptr"><code class="Fn" id="fido_cred_user_id_ptr">fido_cred_user_id_ptr</code></a>(),
<code class="Fn">fido_cred_x5c_ptr</code>(), and
<a class="permalink" href="#fido_cred_attstmt_ptr"><code class="Fn" id="fido_cred_attstmt_ptr">fido_cred_attstmt_ptr</code></a>()
functions return pointers to the CBOR-encoded and raw authenticator data,
client data hash, ID, authenticator attestation GUID,
“largeBlobKey”, public key, signature, user ID, x509 leaf
certificate, and attestation statement parts of <var class="Fa">cred</var>,
or NULL if the respective entry is not set.</p>
<p class="Pp" id="fido_cred_authdata_len">The corresponding length can be
obtained by
<a class="permalink" href="#fido_cred_authdata_len"><code class="Fn">fido_cred_authdata_len</code></a>(),
<a class="permalink" href="#fido_cred_authdata_raw_len"><code class="Fn" id="fido_cred_authdata_raw_len">fido_cred_authdata_raw_len</code></a>(),
<a class="permalink" href="#fido_cred_clientdata_hash_len"><code class="Fn" id="fido_cred_clientdata_hash_len">fido_cred_clientdata_hash_len</code></a>(),
<a class="permalink" href="#fido_cred_id_len"><code class="Fn" id="fido_cred_id_len">fido_cred_id_len</code></a>(),
<a class="permalink" href="#fido_cred_aaguid_len"><code class="Fn" id="fido_cred_aaguid_len">fido_cred_aaguid_len</code></a>(),
<a class="permalink" href="#fido_cred_largeblob_key_len"><code class="Fn" id="fido_cred_largeblob_key_len">fido_cred_largeblob_key_len</code></a>(),
<a class="permalink" href="#fido_cred_pubkey_len"><code class="Fn" id="fido_cred_pubkey_len">fido_cred_pubkey_len</code></a>(),
<a class="permalink" href="#fido_cred_sig_len"><code class="Fn" id="fido_cred_sig_len">fido_cred_sig_len</code></a>(),
<a class="permalink" href="#fido_cred_user_id_len"><code class="Fn" id="fido_cred_user_id_len">fido_cred_user_id_len</code></a>(),
<code class="Fn">fido_cred_x5c_len</code>(), and
<a class="permalink" href="#fido_cred_attstmt_len"><code class="Fn" id="fido_cred_attstmt_len">fido_cred_attstmt_len</code></a>().</p>
<p class="Pp" id="fido_cred_x5c_list_count">The
<a class="permalink" href="#fido_cred_x5c_list_count"><code class="Fn">fido_cred_x5c_list_count</code></a>()
function returns the length of the x509 certificate chain in
<var class="Fa">cred</var> and the
<a class="permalink" href="#fido_cred_x5c_list_ptr"><code class="Fn" id="fido_cred_x5c_list_ptr">fido_cred_x5c_list_ptr</code></a>()
and
<a class="permalink" href="#fido_cred_x5c_list_len"><code class="Fn" id="fido_cred_x5c_list_len">fido_cred_x5c_list_len</code></a>()
functions return a pointer to and length of the x509 certificate at index
<var class="Fa">idx</var> respectively. Please note that the leaf
certificate has an <var class="Fa">idx</var> (index) value of 0 and calling
<code class="Fn">fido_cred_x5c_list_ptr</code>(<var class="Fa">cred</var>,
<var class="Fa">0</var>) and
<code class="Fn">fido_cred_x5c_list_len</code>(<var class="Fa">cred</var>,
<var class="Fa">0</var>) is equivalent to
<a class="permalink" href="#fido_cred_x5c_ptr"><code class="Fn" id="fido_cred_x5c_ptr">fido_cred_x5c_ptr</code></a>(<var class="Fa">cred</var>)
and
<a class="permalink" href="#fido_cred_x5c_len"><code class="Fn" id="fido_cred_x5c_len">fido_cred_x5c_len</code></a>(<var class="Fa">cred</var>)
respectively. If <var class="Fa">idx</var> exceeds the return value of
<code class="Fn">fido_cred_x5c_list_count</code>(),
<code class="Fn">fido_cred_x5c_list_ptr</code>() returns NULL and
<code class="Fn">fido_cred_x5c_list_len</code>() returns 0.</p>
<p class="Pp">The authenticator data, x509 certificate, and signature parts of a
credential are typically passed to a FIDO2 server for verification.</p>
<p class="Pp" id="fido_cred_type">The
<a class="permalink" href="#fido_cred_type"><code class="Fn">fido_cred_type</code></a>()
function returns the COSE algorithm of <var class="Fa">cred</var>.</p>
<p class="Pp" id="fido_cred_flags">The
<a class="permalink" href="#fido_cred_flags"><code class="Fn">fido_cred_flags</code></a>()
function returns the authenticator data flags of
<var class="Fa">cred</var>.</p>
<p class="Pp" id="fido_cred_sigcount">The
<a class="permalink" href="#fido_cred_sigcount"><code class="Fn">fido_cred_sigcount</code></a>()
function returns the authenticator data signature counter of
<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>
<p class="Pp">The authenticator data returned by
<code class="Fn">fido_cred_authdata_ptr</code>() is a CBOR-encoded byte
string, as obtained from the authenticator. To obtain the decoded byte
string, use <code class="Fn">fido_cred_authdata_raw_ptr</code>().</p>
<p class="Pp" id="const">If not NULL, pointers returned by
<code class="Fn">fido_cred_fmt</code>(),
<code class="Fn">fido_cred_authdata_ptr</code>(),
<code class="Fn">fido_cred_clientdata_hash_ptr</code>(),
<code class="Fn">fido_cred_id_ptr</code>(),
<code class="Fn">fido_cred_aaguid_ptr</code>(),
<code class="Fn">fido_cred_largeblob_key_ptr</code>(),
<code class="Fn">fido_cred_pubkey_ptr</code>(),
<code class="Fn">fido_cred_sig_ptr</code>(), and
<code class="Fn">fido_cred_x5c_ptr</code>() are guaranteed to exist until
any API function that takes <var class="Fa">cred</var> without the
<a class="permalink" href="#const"><i class="Em">const</i></a> qualifier is
invoked.</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_exclude.html">fido_cred_exclude(3)</a>,
<a class="Xr" href="fido_cred_set_authdata.html">fido_cred_set_authdata(3)</a>,
<a class="Xr" href="fido_cred_set_pin_minlen.html">fido_cred_set_pin_minlen(3)</a>,
<a class="Xr" href="fido_cred_set_prot.html">fido_cred_set_prot(3)</a>,
<a class="Xr" href="fido_cred_verify.html">fido_cred_verify(3)</a>,
<a class="Xr" href="fido_credman_metadata_new.html">fido_credman_metadata_new(3)</a>,
<a class="Xr" href="fido_dev_largeblob_get.html">fido_dev_largeblob_get(3)</a>,
<a class="Xr" href="fido_dev_make_cred.html">fido_dev_make_cred(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>