static/freebsd/man4/u2f.4 4.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

<table class="head">
  <tr>
    <td class="head-ltitle">U2F(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">U2F(4)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">u2f</code> &#x2014; <span class="Nd">FIDO/U2F USB
    security keys</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="Cd">device u2f</code></p>
<p class="Pp">In <a class="Xr">loader.conf(5)</a>:
  <br/>
  <code class="Cd">u2f_load=&quot;YES&quot;</code></p>
<p class="Pp">In <a class="Xr">sysctl.conf(5)</a>:
  <br/>
  <code class="Cd">hw.hid.u2f.debug</code></p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">u2f</code> driver provides support for
    FIDO/U2F-compatible USB security keys. They are Human Interface Devices
    (HID) which can be accessed via the <span class="Pa">/dev/u2f/N</span>
    interface.</p>
<p class="Pp">The driver is compatible with the <a class="Xr">read(2)</a>,
    <a class="Xr">write(2)</a>, and <a class="Xr">ioctl(2)</a> operations of the
    generic <a class="Xr">uhid(4)</a> device but only accepts the optional HID
    <a class="Xr">ioctl(2)</a> calls from u2f group users.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1>
<p class="Pp">The <code class="Nm">u2f</code> driver supports
    FIDO/U2F-compatible USB security keys.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYSCTL_VARIABLES"><a class="permalink" href="#SYSCTL_VARIABLES">SYSCTL
  VARIABLES</a></h1>
<p class="Pp">The following variables are available as both
    <a class="Xr">sysctl(8)</a> variables and <a class="Xr">loader(8)</a>
    tunables:</p>
<dl class="Bl-tag">
  <dt id="hw.hid.u2f.debug"><var class="Va">hw.hid.u2f.debug</var></dt>
  <dd>Debug output level, where 0 is debugging disabled and larger values
      increase debug message verbosity. Default is 0.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1>
<dl class="Bl-tag Bl-compact">
  <dt><span class="Pa">/dev/u2f/*</span></dt>
  <dd style="width: auto;">&#x00A0;</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">uhid(4)</a>, <a class="Xr">usbhid(4)</a>,
    <a class="Xr">usb(4)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp">The <code class="Nm">u2f</code> driver first appeared in
    <span class="Ux">FreeBSD 15.0</span>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
<p class="Pp">The <code class="Nm">u2f</code> driver was written by
    <span class="An">Vladimir Kondratyev</span>
    &lt;<a class="Mt" href="mailto:wulf@FreeBSD.org">wulf@FreeBSD.org</a>&gt;.</p>
<p class="Pp">This manual page was written by <span class="An">Vladimir
    Kondratyev</span>
    &lt;<a class="Mt" href="mailto:wulf@FreeBSD.org">wulf@FreeBSD.org</a>&gt;
    based on the <span class="Ux">OpenBSD</span> <a class="Xr">fido(4)</a>
    manual page.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">August 21, 2023</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>