rngd.8.in

   1 .\" Copyright (C) 2001 Jeff Garzik -- jgarzik@pobox.com
   2 .\"
   3 .TH RNGD 8 "March 2001" "@PACKAGE@ @VERSION@"
   4
   5 .SH NAME
   6 rngd \- Check and feed random data from hardware device to kernel random device
   7
   8 .SH SYNOPSIS
   9 .B rngd
  10 [\fB\-b\fR, \fB\-\-background\fR]
  11 [\fB\-f\fR, \fB\-\-foreground\fR]
  12 [\fB\-o\fR, \fB\-\-random-device=\fIfile\fR]
  13 [\fB\-r\fR, \fB\-\-rng-device=\fIfile\fR]
  14 [\fB\-s\fR, \fB\-\-random-step=\fInnn\fR]
  15 [\fB\-W\fR, \fB\-\-fill-watermark=\fInnn\fR]
  16 [\fB\-n\fR, \fB\-\-no-tpm=\fI1|0\fR]
  17 [\fB\-q\fR, \fB\-\-quiet\fR]
  18 [\fB\-v\fR, \fB\-\-verbose\fR]
  19 [\fB\-t\fR, \fB\-\-timeout=\fInnn\fR]
  20 [\fB\-?\fR, \fB\-\-help\fR]
  21 [\fB\-V\fR, \fB\-\-version\fR]
  22 .RI
  23
  24 .SH DESCRIPTION
  25 This daemon feeds data from a random number generator to the kernel's
  26 random number entropy pool, after first checking the data to ensure that
  27 it is properly random.
  28 .PP
  29 The \fB\-f\fR or \fB\-\-foreground\fR options can be used to tell
  30 \fBrngd\fR to avoid forking on startup.  This is typically used for
  31 debugging.  The \fB\-b\fR or \fB\-\-background\fR options, which fork and put
  32 \fBrngd\fR into the background automatically, are the default.
  33 .PP
  34 The \fB\-r\fR or \fB\-\-rng-device\fR options can be used to select an
  35 alternate source of input, besides the default /dev/hwrandom.
  36 The \fB\-o\fR or \fB\-\-random-device\fR options can be used to select
  37 an alternate entropy output device, besides the default /dev/random.
  38 Note that this device must support the Linux kernel /dev/random
  39 ioctl API.
  40 .PP
  41 FIXME: document random-step and timeout
  42
  43 .SH OPTIONS
  44 .TP
  45 \fB\-b\fR, \fB\-\-background\fR
  46 Become a daemon (default)
  47 .TP
  48 \fB\-f\fR, \fB\-\-foreground\fR
  49 Do not fork and become a daemon
  50 .TP
  51 \fB\-o\fI file\fR, \fB\-\-random-device=\fIfile\fR
  52 Kernel device used for random number output
  53 (default: /dev/random)
  54 .TP
  55 \fB\-r\fI file\fR, \fB\-\-rng-device=\fIfile\fR
  56 Kernel device used for random number input
  57 (default: /dev/hwrandom)
  58 .TP
  59 \fB\-s\fI nnn\fR, \fB\-\-random-step=\fInnn\fR
  60 Number of bytes written to random-device at a time (default: 64)
  61 .TP
  62 \fB\-W\fI n\fR, \fB\-\-fill\-watermark=\fInnn\fR
  63 Once we start doing it, feed entropy to \fIrandom-device\fR until at least
  64 \fIfill-watermark\fR bits of entropy are available in its entropy pool (default: 2048).
  65 Setting this too high will cause \fIrngd\fR to dominate the contents of the
  66 entropy pool.  Low values will hurt system performance during entropy
  67 starves.  Do not set \fIfill-watermark\fR above the size of the
  68 entropy pool (usually 4096 bits).
  69 .TP
  70 \fB\-n\fI 1|0\fR, \fB\-\-no-tpm=\fI1|0\fR
  71 Do not use tpm as a source of random number input (default:0)
  72 .TP
  73 \fB\-q\fR, \fB\-\-quiet\fR
  74 Suppress error messages
  75 .TP
  76 \fB\-v\fR, \fB\-\-verbose\fR
  77 Report available entropy sources
  78 .TP
  79 \fB\-t\fI nnn\fR, \fB\-\-timeout=\fInnn\fR
  80 Interval written to random-device when the entropy pool is full, in seconds, or 0 to disable (default: 60)
  81 .TP
  82 \fB\-?\fR, \fB\-\-help\fR
  83 Give a short summary of all program options.
  84 .TP
  85 \fB\-V\fR, \fB\-\-version\fR
  86 Print program version
  87
  88 .SH AUTHORS
  89 Philipp Rumpf
  90 .br
  91 Jeff Garzik \- jgarzik@pobox.com
  92 .br
  93 Matt Sottek
  94 .br
  95 Brad Hill