xref: /freebsd/share/man/man4/u2f.4 (revision ba61aa417a047c79122539ffb5b0075cbe8af0bf)
1.\"
2.\" SPDX-License-Identifier: ISC
3.\"
4.\" $OpenBSD: fido.4,v 1.4 2020/08/21 19:02:46 mglocker Exp $
5.\"
6.\" Copyright (c) 2019 Reyk Floeter <reyk@openbsd.org>
7.\" Copyright (c) 2023 Vladimir Kondratyev <wulf@FreeBSD.org>
8.\"
9.\" Permission to use, copy, modify, and distribute this software for any
10.\" purpose with or without fee is hereby granted, provided that the above
11.\" copyright notice and this permission notice appear in all copies.
12.\"
13.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
14.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
15.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
16.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
17.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
18.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
19.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
20.\"
21.Dd August 21, 2023
22.Dt U2F 4
23.Os
24.Sh NAME
25.Nm u2f
26.Nd FIDO/U2F USB security keys
27.Sh SYNOPSIS
28.Cd "device u2f"
29.Pp
30In
31.Xr loader.conf 5 :
32.Cd u2f_load="YES"
33.Pp
34In
35.Xr sysctl.conf 5 :
36.Cd hw.hid.u2f.debug
37.Sh DESCRIPTION
38The
39.Nm
40driver provides support for FIDO/U2F-compatible USB security keys.
41They are Human Interface Devices (HID) which can be accessed via the
42.Pa /dev/u2f/N
43interface.
44.Pp
45The driver is compatible with the
46.Xr read 2 ,
47.Xr write 2 ,
48and
49.Xr ioctl 2
50operations of the generic
51.Xr uhid 4
52device but only accepts the optional HID
53.Xr ioctl 2
54calls from u2f group users.
55.Sh HARDWARE
56The
57.Nm
58driver supports FIDO/U2F-compatible USB security keys.
59.Sh SYSCTL VARIABLES
60The following variables are available as both
61.Xr sysctl 8
62variables and
63.Xr loader 8
64tunables:
65.Bl -tag -width indent
66.It Va hw.hid.u2f.debug
67Debug output level, where 0 is debugging disabled and larger values increase
68debug message verbosity.
69Default is 0.
70.El
71.Sh FILES
72.Bl -tag -width /dev/u2f/* -compact
73.It Pa /dev/u2f/*
74.El
75.Sh SEE ALSO
76.Xr uhid 4 ,
77.Xr usbhid 4 ,
78.Xr usb 4
79.Sh HISTORY
80The
81.Nm
82driver first appeared in
83.Fx 15.0 .
84.Sh AUTHORS
85.An -nosplit
86The
87.Nm
88driver was written by
89.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
90.Pp
91This manual page was written by
92.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org
93based on the
94.Ox
95.Xr fido 4
96manual page.
97