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