share/man/man4/rndtest.4

   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: src/share/man/man4/rndtest.4,v 1.2.4.1 2003/06/04 17:10:30 sam Exp $
  27 .\"
  28 .Dd March 11, 2003
  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
  37 The
  38 .Nm
  39 driver ``hooks up'' to hardware crypto devices to monitor the
  40 entropy data passed to the
  41 .Xr random 4
  42 subsystem.
  43 This data is periodically tested for FIPS 140-2 compliance and
  44 statistics are collected.
  45 If the harvested entropy fails any of the FIPS test suite, then
  46 it is discarded and testing is continuously applied until ``good data''
  47 is received from the device.
  48 Failures are optionally reported on the console.
  49 .Sh SEE ALSO
  50 .Xr crypto 4 ,
  51 .Xr hifn 4 ,
  52 .Xr random 4 ,
  53 .Xr ubsec 4 ,
  54 .Xr crypto 9
  55 .Sh HISTORY
  56 The idea for this and the original code came from Jason L. Wright.
  57 The
  58 .Nm
  59 device driver first appeared in
  60 .Fx 5.0 .
  61 .Sh BUGS
  62 Crypto device drivers must be compiled specially to make use of this driver;
  63 this should not be necessary.
  64 This feature might better be integrated into the
  65 .Xr random 4
  66 subsystem where it can be used applied to devices that claim to supply
  67 ``pure entropy''.