xref: /freebsd/contrib/libfido2/man/fido_init.3 (revision 29fc4075e69fd27de0cded313ac6000165d99f8b)
1.\" Copyright (c) 2018 Yubico AB. All rights reserved.
2.\" Use of this source code is governed by a BSD-style
3.\" license that can be found in the LICENSE file.
4.\"
5.Dd $Mdocdate: May 25 2018 $
6.Dt FIDO_INIT 3
7.Os
8.Sh NAME
9.Nm fido_init
10.Nd initialise the FIDO 2 library
11.Sh SYNOPSIS
12.In fido.h
13.Ft void
14.Fn fido_init "int flags"
15.Sh DESCRIPTION
16The
17.Fn fido_init
18function initialises the
19.Em libfido2
20library.
21Its invocation must precede that of any other
22.Em libfido2
23function in the context of the executing thread.
24.Pp
25If
26.Dv FIDO_DEBUG
27is set in
28.Fa flags ,
29then
30debug output will be emitted by
31.Em libfido2
32on
33.Em stderr .
34Alternatively, the
35.Ev FIDO_DEBUG
36environment variable may be set.
37.Pp
38If
39.Dv FIDO_DISABLE_U2F_FALLBACK
40is set in
41.Fa flags ,
42then
43.Em libfido2
44will not fallback to U2F in
45.Xr fido_dev_open 3
46if a device claims to be FIDO2 but fails to respond to a
47FIDO2 command.
48.Sh SEE ALSO
49.Xr fido_assert_new 3 ,
50.Xr fido_cred_new 3 ,
51.Xr fido_dev_info_manifest 3 ,
52.Xr fido_dev_open 3
53