xref: /freebsd/share/man/man4/rndtest.4 (revision dd41de95a84d979615a2ef11df6850622bf6184e)
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.\" $FreeBSD$
27.\"
28.Dd May 11, 2020
29.Dt RNDTEST 4
30.Os
31.Sh NAME
32.Nm rndtest
33.Nd FIPS 140-2 random number generator test monitor
34.Sh SYNOPSIS
35.Cd "device rndtest"
36.Sh DESCRIPTION
37The
38.Nm
39driver
40.Dq "hooks up"
41to hardware crypto devices to monitor the
42entropy data passed to the
43.Xr random 4
44subsystem.
45This data is periodically tested for FIPS 140-2 compliance and
46statistics are collected.
47If the harvested entropy fails any of the FIPS test suite, then
48it is discarded and testing is continuously applied until
49.Dq "good data"
50is received from the device.
51Failures are optionally reported on the console.
52.Sh SEE ALSO
53.Xr crypto 4 ,
54.Xr hifn 4 ,
55.Xr random 4 ,
56.Xr safe 4 ,
57.Xr crypto 9
58.Sh HISTORY
59The idea for this and the original code came from
60.An "Jason L. Wright" .
61The
62.Nm
63device driver first appeared in
64.Fx 5.0 .
65.Sh BUGS
66Crypto device drivers must be compiled specially to make use of this driver;
67this should not be necessary.
68This feature might better be integrated into the
69.Xr random 4
70subsystem where it can be applied to devices that claim to supply
71.Dq "pure entropy" .
72