mirror of
https://github.com/freebsd/freebsd-src
synced 2024-10-04 23:50:27 +00:00
2ccfa855b2
Some highlights from NEWS entries: ** Improved OpenSSL 3.0 compatibility. ** Support for hidraw(4) on FreeBSD; gh#597. ** Improved support for FIDO 2.1 authenticators. PR: 273596 Relnotes: Yes Sponsored by: The FreeBSD Foundation
105 lines
2.9 KiB
Groff
105 lines
2.9 KiB
Groff
.\" Copyright (c) 2018-2022 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
|
|
.\"
|
|
.Dd $Mdocdate: July 15 2022 $
|
|
.Dt FIDO_ASSERT_VERIFY 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm fido_assert_verify
|
|
.Nd verifies the signature of a FIDO2 assertion statement
|
|
.Sh SYNOPSIS
|
|
.In fido.h
|
|
.Ft int
|
|
.Fn fido_assert_verify "const fido_assert_t *assert" "size_t idx" "int cose_alg" "const void *pk"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn fido_assert_verify
|
|
function verifies whether the signature contained in statement index
|
|
.Fa idx
|
|
of
|
|
.Fa assert
|
|
matches the parameters of the assertion.
|
|
Before using
|
|
.Fn fido_assert_verify
|
|
in a sensitive context, the reader is strongly encouraged to make
|
|
herself familiar with the FIDO2 assertion statement process
|
|
as defined in the Web Authentication (webauthn) standard.
|
|
.Pp
|
|
A brief description follows:
|
|
.Pp
|
|
The
|
|
.Fn fido_assert_verify
|
|
function verifies whether the client data hash, relying party ID,
|
|
user presence and user verification attributes of
|
|
.Fa assert
|
|
have been attested by the holder of the private counterpart of
|
|
the public key
|
|
.Fa pk
|
|
of COSE type
|
|
.Fa cose_alg ,
|
|
where
|
|
.Fa cose_alg
|
|
is
|
|
.Dv COSE_ES256 ,
|
|
.Dv COSE_ES384 ,
|
|
.Dv COSE_RS256 ,
|
|
or
|
|
.Dv COSE_EDDSA ,
|
|
and
|
|
.Fa pk
|
|
points to a
|
|
.Vt es256_pk_t ,
|
|
.Vt es384_pk_t ,
|
|
.Vt rs256_pk_t ,
|
|
or
|
|
.Vt eddsa_pk_t
|
|
type accordingly.
|
|
.Pp
|
|
Please note that the first statement in
|
|
.Fa assert
|
|
has an
|
|
.Fa idx
|
|
of 0.
|
|
.Sh RETURN VALUES
|
|
The error codes returned by
|
|
.Fn fido_assert_verify
|
|
are defined in
|
|
.In fido/err.h .
|
|
If
|
|
statement
|
|
.Fa idx
|
|
of
|
|
.Fa assert
|
|
passes verification with
|
|
.Fa pk ,
|
|
then
|
|
.Dv FIDO_OK
|
|
is returned.
|
|
.Sh SEE ALSO
|
|
.Xr fido_assert_new 3 ,
|
|
.Xr fido_assert_set_authdata 3
|