xref: /freebsd/share/man/man4/u2f.4 (revision ba61aa417a047c79122539ffb5b0075cbe8af0bf)
1*ba61aa41SAlexander Ziaee.\"
2*ba61aa41SAlexander Ziaee.\" SPDX-License-Identifier: ISC
3*ba61aa41SAlexander Ziaee.\"
44a04e0a6SVladimir Kondratyev.\" $OpenBSD: fido.4,v 1.4 2020/08/21 19:02:46 mglocker Exp $
54a04e0a6SVladimir Kondratyev.\"
64a04e0a6SVladimir Kondratyev.\" Copyright (c) 2019 Reyk Floeter <reyk@openbsd.org>
74a04e0a6SVladimir Kondratyev.\" Copyright (c) 2023 Vladimir Kondratyev <wulf@FreeBSD.org>
84a04e0a6SVladimir Kondratyev.\"
94a04e0a6SVladimir Kondratyev.\" Permission to use, copy, modify, and distribute this software for any
104a04e0a6SVladimir Kondratyev.\" purpose with or without fee is hereby granted, provided that the above
114a04e0a6SVladimir Kondratyev.\" copyright notice and this permission notice appear in all copies.
124a04e0a6SVladimir Kondratyev.\"
134a04e0a6SVladimir Kondratyev.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
144a04e0a6SVladimir Kondratyev.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
154a04e0a6SVladimir Kondratyev.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
164a04e0a6SVladimir Kondratyev.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
174a04e0a6SVladimir Kondratyev.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
184a04e0a6SVladimir Kondratyev.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
194a04e0a6SVladimir Kondratyev.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
204a04e0a6SVladimir Kondratyev.\"
214a04e0a6SVladimir Kondratyev.Dd August 21, 2023
224a04e0a6SVladimir Kondratyev.Dt U2F 4
234a04e0a6SVladimir Kondratyev.Os
244a04e0a6SVladimir Kondratyev.Sh NAME
254a04e0a6SVladimir Kondratyev.Nm u2f
26*ba61aa41SAlexander Ziaee.Nd FIDO/U2F USB security keys
274a04e0a6SVladimir Kondratyev.Sh SYNOPSIS
284a04e0a6SVladimir Kondratyev.Cd "device u2f"
294a04e0a6SVladimir Kondratyev.Pp
30*ba61aa41SAlexander ZiaeeIn
314a04e0a6SVladimir Kondratyev.Xr loader.conf 5 :
32*ba61aa41SAlexander Ziaee.Cd u2f_load="YES"
33*ba61aa41SAlexander Ziaee.Pp
34*ba61aa41SAlexander ZiaeeIn
35*ba61aa41SAlexander Ziaee.Xr sysctl.conf 5 :
36*ba61aa41SAlexander Ziaee.Cd hw.hid.u2f.debug
374a04e0a6SVladimir Kondratyev.Sh DESCRIPTION
384a04e0a6SVladimir KondratyevThe
394a04e0a6SVladimir Kondratyev.Nm
404a04e0a6SVladimir Kondratyevdriver provides support for FIDO/U2F-compatible USB security keys.
414a04e0a6SVladimir KondratyevThey are Human Interface Devices (HID) which can be accessed via the
424a04e0a6SVladimir Kondratyev.Pa /dev/u2f/N
434a04e0a6SVladimir Kondratyevinterface.
444a04e0a6SVladimir Kondratyev.Pp
454a04e0a6SVladimir KondratyevThe driver is compatible with the
464a04e0a6SVladimir Kondratyev.Xr read 2 ,
474a04e0a6SVladimir Kondratyev.Xr write 2 ,
484a04e0a6SVladimir Kondratyevand
494a04e0a6SVladimir Kondratyev.Xr ioctl 2
504a04e0a6SVladimir Kondratyevoperations of the generic
514a04e0a6SVladimir Kondratyev.Xr uhid 4
524a04e0a6SVladimir Kondratyevdevice but only accepts the optional HID
534a04e0a6SVladimir Kondratyev.Xr ioctl 2
544a04e0a6SVladimir Kondratyevcalls from u2f group users.
55*ba61aa41SAlexander Ziaee.Sh HARDWARE
56*ba61aa41SAlexander ZiaeeThe
57*ba61aa41SAlexander Ziaee.Nm
58*ba61aa41SAlexander Ziaeedriver supports FIDO/U2F-compatible USB security keys.
594a04e0a6SVladimir Kondratyev.Sh SYSCTL VARIABLES
604a04e0a6SVladimir KondratyevThe following variables are available as both
614a04e0a6SVladimir Kondratyev.Xr sysctl 8
624a04e0a6SVladimir Kondratyevvariables and
634a04e0a6SVladimir Kondratyev.Xr loader 8
644a04e0a6SVladimir Kondratyevtunables:
654a04e0a6SVladimir Kondratyev.Bl -tag -width indent
664a04e0a6SVladimir Kondratyev.It Va hw.hid.u2f.debug
674a04e0a6SVladimir KondratyevDebug output level, where 0 is debugging disabled and larger values increase
684a04e0a6SVladimir Kondratyevdebug message verbosity.
694a04e0a6SVladimir KondratyevDefault is 0.
704a04e0a6SVladimir Kondratyev.El
714a04e0a6SVladimir Kondratyev.Sh FILES
724a04e0a6SVladimir Kondratyev.Bl -tag -width /dev/u2f/* -compact
734a04e0a6SVladimir Kondratyev.It Pa /dev/u2f/*
744a04e0a6SVladimir Kondratyev.El
754a04e0a6SVladimir Kondratyev.Sh SEE ALSO
764a04e0a6SVladimir Kondratyev.Xr uhid 4 ,
774a04e0a6SVladimir Kondratyev.Xr usbhid 4 ,
784a04e0a6SVladimir Kondratyev.Xr usb 4
794a04e0a6SVladimir Kondratyev.Sh HISTORY
804a04e0a6SVladimir KondratyevThe
814a04e0a6SVladimir Kondratyev.Nm
824a04e0a6SVladimir Kondratyevdriver first appeared in
834a04e0a6SVladimir Kondratyev.Fx 15.0 .
844a04e0a6SVladimir Kondratyev.Sh AUTHORS
854a04e0a6SVladimir Kondratyev.An -nosplit
864a04e0a6SVladimir KondratyevThe
874a04e0a6SVladimir Kondratyev.Nm
884a04e0a6SVladimir Kondratyevdriver was written by
894a04e0a6SVladimir Kondratyev.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org .
904a04e0a6SVladimir Kondratyev.Pp
914a04e0a6SVladimir KondratyevThis manual page was written by
924a04e0a6SVladimir Kondratyev.An Vladimir Kondratyev Aq Mt wulf@FreeBSD.org
934a04e0a6SVladimir Kondratyevbased on the
944a04e0a6SVladimir Kondratyev.Ox
954a04e0a6SVladimir Kondratyev.Xr fido 4
964a04e0a6SVladimir Kondratyevmanual page.
97