xref: /freebsd/share/man/man4/rndtest.4 (revision f5463265955b829775bbb32e1fd0bc11dafc36ce)
1.\"-
2.\" Copyright (c) 2003 Sam Leffler, Errno Consulting
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.Dd May 11, 2020
27.Dt RNDTEST 4
28.Os
29.Sh NAME
30.Nm rndtest
31.Nd FIPS 140-2 random number generator test monitor
32.Sh SYNOPSIS
33.Cd "device rndtest"
34.Sh DESCRIPTION
35The
36.Nm
37driver
38.Dq "hooks up"
39to hardware crypto devices to monitor the
40entropy data passed to the
41.Xr random 4
42subsystem.
43This data is periodically tested for FIPS 140-2 compliance and
44statistics are collected.
45If the harvested entropy fails any of the FIPS test suite, then
46it is discarded and testing is continuously applied until
47.Dq "good data"
48is received from the device.
49Failures are optionally reported on the console.
50.Sh SEE ALSO
51.Xr crypto 4 ,
52.Xr hifn 4 ,
53.Xr random 4 ,
54.Xr safe 4 ,
55.Xr crypto 9
56.Sh HISTORY
57The idea for this and the original code came from
58.An "Jason L. Wright" .
59The
60.Nm
61device driver first appeared in
62.Fx 5.0 .
63.Sh BUGS
64Crypto device drivers must be compiled specially to make use of this driver;
65this should not be necessary.
66This feature might better be integrated into the
67.Xr random 4
68subsystem where it can be applied to devices that claim to supply
69.Dq "pure entropy" .
70