2021-10-02 01:52:55 +02:00
|
|
|
.\" Copyright (c) 2018 Yubico AB. All rights reserved.
|
2023-04-26 18:40:13 +02:00
|
|
|
.\"
|
|
|
|
|
.\" 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
|
2021-10-02 01:52:55 +02:00
|
|
|
.\"
|
|
|
|
|
.Dd $Mdocdate: May 24 2018 $
|
|
|
|
|
.Dt FIDO_DEV_GET_ASSERT 3
|
|
|
|
|
.Os
|
|
|
|
|
.Sh NAME
|
|
|
|
|
.Nm fido_dev_get_assert
|
2023-04-26 18:38:17 +02:00
|
|
|
.Nd obtains an assertion from a FIDO2 device
|
2021-10-02 01:52:55 +02:00
|
|
|
.Sh SYNOPSIS
|
|
|
|
|
.In fido.h
|
|
|
|
|
.Ft int
|
2023-04-26 18:38:17 +02:00
|
|
|
.Fn fido_dev_get_assert "fido_dev_t *dev" "fido_assert_t *assert" "const char *pin"
|
2021-10-02 01:52:55 +02:00
|
|
|
.Sh DESCRIPTION
|
|
|
|
|
The
|
|
|
|
|
.Fn fido_dev_get_assert
|
2023-04-26 18:38:17 +02:00
|
|
|
function asks the FIDO2 device represented by
|
2021-10-02 01:52:55 +02:00
|
|
|
.Fa dev
|
|
|
|
|
for an assertion according to the following parameters defined in
|
|
|
|
|
.Fa assert :
|
|
|
|
|
.Pp
|
|
|
|
|
.Bl -dash -compact
|
|
|
|
|
.It
|
|
|
|
|
.Nm relying party ID ;
|
|
|
|
|
.It
|
|
|
|
|
.Nm client data hash ;
|
|
|
|
|
.It
|
|
|
|
|
.Nm list of allowed credential IDs ;
|
|
|
|
|
.It
|
|
|
|
|
.Nm user presence and user verification attributes .
|
|
|
|
|
.El
|
|
|
|
|
.Pp
|
|
|
|
|
See
|
|
|
|
|
.Xr fido_assert_set_authdata 3
|
|
|
|
|
for information on how these values are set.
|
|
|
|
|
.Pp
|
|
|
|
|
If a PIN is not needed to authenticate the request against
|
|
|
|
|
.Fa dev ,
|
|
|
|
|
then
|
|
|
|
|
.Fa pin
|
|
|
|
|
may be NULL.
|
|
|
|
|
Otherwise
|
|
|
|
|
.Fa pin
|
|
|
|
|
must point to a NUL-terminated UTF-8 string.
|
|
|
|
|
.Pp
|
|
|
|
|
After a successful call to
|
|
|
|
|
.Fn fido_dev_get_assert ,
|
|
|
|
|
the
|
|
|
|
|
.Xr fido_assert_count 3 ,
|
|
|
|
|
.Xr fido_assert_user_display_name 3 ,
|
|
|
|
|
.Xr fido_assert_user_icon 3 ,
|
|
|
|
|
.Xr fido_assert_user_name 3 ,
|
|
|
|
|
.Xr fido_assert_authdata_ptr 3 ,
|
|
|
|
|
.Xr fido_assert_user_id_ptr 3 ,
|
|
|
|
|
.Xr fido_assert_sig_ptr 3 ,
|
|
|
|
|
and
|
|
|
|
|
.Xr fido_assert_sigcount 3
|
|
|
|
|
functions may be invoked on
|
|
|
|
|
.Fa assert
|
|
|
|
|
to retrieve the various attributes of the generated assertion.
|
|
|
|
|
.Pp
|
|
|
|
|
Please note that
|
|
|
|
|
.Fn fido_dev_get_assert
|
|
|
|
|
is synchronous and will block if necessary.
|
|
|
|
|
.Sh RETURN VALUES
|
|
|
|
|
The error codes returned by
|
|
|
|
|
.Fn fido_dev_get_assert
|
|
|
|
|
are defined in
|
|
|
|
|
.In fido/err.h .
|
|
|
|
|
On success,
|
|
|
|
|
.Dv FIDO_OK
|
|
|
|
|
is returned.
|
|
|
|
|
.Sh SEE ALSO
|
|
|
|
|
.Xr fido_assert_new 3 ,
|
|
|
|
|
.Xr fido_assert_set_authdata 3
|
