xref: /openbsd/share/man/man4/uonerng.4 (revision 09467b48)
1.\"	$OpenBSD: uonerng.4,v 1.3 2018/04/28 15:44:59 jasper Exp $
2.\"
3.\" Copyright (c) 2015 Devin Reade <gdr@gno.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: April 28 2018 $
18.Dt ONERNG 4
19.Os
20.Sh NAME
21.Nm uonerng
22.Nd Moonbase Otago OneRNG TRNG
23.Sh SYNOPSIS
24.Cd "uonerng* at uhub?"
25.Sh DESCRIPTION
26The
27.Nm
28driver provides support for the Moonbase Otago OneRNG, a USB true random
29number generator (TRNG).
30.Nm
31reads raw entropy from the OneRNG and uses
32.Xr enqueue_randomness 9
33to add it to the system entropy pool.
34.Pp
35The OneRNG is capable of operating in one of several modes, some of
36which are intended for production use and some of which are for testing
37and validating the hardware.
38.Pp
39.Nm
40operates in the
41.Qq Avalanche noise with whitener
42mode,
43which is also the manufacturer's default mode.
44.Sh SEE ALSO
45.Xr intro 4 ,
46.Xr usb 4 ,
47.Xr enqueue_randomness 9
48.Pp
49Moonbase Otago:
50.Lk http://onerng.info/onerng
51.Sh HISTORY
52The
53.Nm
54driver first appeared in
55.Ox 5.9 .
56.Sh AUTHORS
57The
58.Nm
59driver was written by
60.An Devin Reade Aq Mt gdr@gno.org .
61.Sh BUGS
62The OneRNG permits downloading of the device firmware so that one may check
63the firmware's cryptographic signature as provided by the manufacturer.
64The
65.Nm
66driver does not perform nor support this action.
67In order to currently perform such a validation,
68it would be necessary to disable
69.Nm
70in the kernel and then download the firmware via the OneRNG's
71emulated AT modem command set.
72