crypto/external/bsd/openssl/lib/libcrypto/man/RAND_add.3

   1 .\"     $NetBSD: libcrypto.pl,v 1.3 2007/11/27 22:16:03 christos Exp $
   2 .\"
   3 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
   4 .\"
   5 .\" Standard preamble:
   6 .\" ========================================================================
   7 .de Sh \" Subsection heading
   8 .br
   9 .if t .Sp
  10 .ne 5
  11 .PP
  12 \fB\\$1\fR
  13 .PP
  14 ..
  15 .de Sp \" Vertical space (when we can't use .PP)
  16 .if t .sp .5v
  17 .if n .sp
  18 ..
  19 .de Vb \" Begin verbatim text
  20 .ft CW
  21 .nf
  22 .ne \\$1
  23 ..
  24 .de Ve \" End verbatim text
  25 .ft R
  26 .fi
  27 ..
  28 .\" Set up some character translations and predefined strings.  \*(-- will
  29 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  30 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  31 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  32 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  33 .\" nothing in troff, for use with C<>.
  34 .tr \(*W-
  35 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  36 .ie n \{\
  37 .    ds -- \(*W-
  38 .    ds PI pi
  39 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  40 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  41 .    ds L" ""
  42 .    ds R" ""
  43 .    ds C` ""
  44 .    ds C' ""
  45 'br\}
  46 .el\{\
  47 .    ds -- \|\(em\|
  48 .    ds PI \(*p
  49 .    ds L" ``
  50 .    ds R" ''
  51 'br\}
  52 .\"
  53 .\" Escape single quotes in literal strings from groff's Unicode transform.
  54 .ie \n(.g .ds Aq \(aq
  55 .el       .ds Aq '
  56 .\"
  57 .\" If the F register is turned on, we'll generate index entries on stderr for
  58 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  59 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  60 .\" output yourself in some meaningful fashion.
  61 .ie \nF \{\
  62 .    de IX
  63 .    tm Index:\\$1\t\\n%\t"\\$2"
  64 ..
  65 .    nr % 0
  66 .    rr F
  67 .\}
  68 .el \{\
  69 .    de IX
  70 ..
  71 .\}
  72 .\"
  73 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  74 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  75 .    \" fudge factors for nroff and troff
  76 .if n \{\
  77 .    ds #H 0
  78 .    ds #V .8m
  79 .    ds #F .3m
  80 .    ds #[ \f1
  81 .    ds #] \fP
  82 .\}
  83 .if t \{\
  84 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  85 .    ds #V .6m
  86 .    ds #F 0
  87 .    ds #[ \&
  88 .    ds #] \&
  89 .\}
  90 .    \" simple accents for nroff and troff
  91 .if n \{\
  92 .    ds ' \&
  93 .    ds ` \&
  94 .    ds ^ \&
  95 .    ds , \&
  96 .    ds ~ ~
  97 .    ds /
  98 .\}
  99 .if t \{\
 100 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 101 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 102 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 103 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 104 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 105 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 106 .\}
 107 .    \" troff and (daisy-wheel) nroff accents
 108 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 109 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 110 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 111 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 112 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 113 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 114 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 115 .ds ae a\h'-(\w'a'u*4/10)'e
 116 .ds Ae A\h'-(\w'A'u*4/10)'E
 117 .    \" corrections for vroff
 118 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 119 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 120 .    \" for low resolution devices (crt and lpr)
 121 .if \n(.H>23 .if \n(.V>19 \
 122 \{\
 123 .    ds : e
 124 .    ds 8 ss
 125 .    ds o a
 126 .    ds d- d\h'-1'\(ga
 127 .    ds D- D\h'-1'\(hy
 128 .    ds th \o'bp'
 129 .    ds Th \o'LP'
 130 .    ds ae ae
 131 .    ds Ae AE
 132 .\}
 133 .rm #[ #] #H #V #F C
 134 .\" ========================================================================
 135 .\"
 136 .IX Title "RAND_add 3"
 137 .TH RAND_add 3 "2000-03-22" "1.1.0-dev" "OpenSSL"
 138 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 139 .\" way too many mistakes in technical documents.
 140 .if n .ad l
 141 .nh
 142 .SH "NAME"
 143 RAND_add, RAND_seed, RAND_status, RAND_event, RAND_screen \- add
 144 entropy to the PRNG
 145 .SH "LIBRARY"
 146 libcrypto, -lcrypto
 147 .SH "SYNOPSIS"
 148 .IX Header "SYNOPSIS"
 149 .Vb 1
 150 \& #include <openssl/rand.h>
 151 \&
 152 \& void RAND_seed(const void *buf, int num);
 153 \&
 154 \& void RAND_add(const void *buf, int num, double entropy);
 155 \&
 156 \& int  RAND_status(void);
 157 \&
 158 \& int  RAND_event(UINT iMsg, WPARAM wParam, LPARAM lParam);
 159 \& void RAND_screen(void);
 160 .Ve
 161 .SH "DESCRIPTION"
 162 .IX Header "DESCRIPTION"
 163 \&\fIRAND_add()\fR mixes the \fBnum\fR bytes at \fBbuf\fR into the \s-1PRNG\s0 state. Thus,
 164 if the data at \fBbuf\fR are unpredictable to an adversary, this
 165 increases the uncertainty about the state and makes the \s-1PRNG\s0 output
 166 less predictable. Suitable input comes from user interaction (random
 167 key presses, mouse movements) and certain hardware events. The
 168 \&\fBentropy\fR argument is (the lower bound of) an estimate of how much
 169 randomness is contained in \fBbuf\fR, measured in bytes. Details about
 170 sources of randomness and how to estimate their entropy can be found
 171 in the literature, e.g. \s-1RFC\s0 1750.
 172 .PP
 173 \&\fIRAND_add()\fR may be called with sensitive data such as user entered
 174 passwords. The seed values cannot be recovered from the \s-1PRNG\s0 output.
 175 .PP
 176 OpenSSL makes sure that the \s-1PRNG\s0 state is unique for each thread. On
 177 systems that provide \f(CW\*(C`/dev/urandom\*(C'\fR, the randomness device is used
 178 to seed the \s-1PRNG\s0 transparently. However, on all other systems, the
 179 application is responsible for seeding the \s-1PRNG\s0 by calling \fIRAND_add()\fR,
 180 \&\fIRAND_egd\fR\|(3)
 181 or \fIRAND_load_file\fR\|(3).
 182 .PP
 183 \&\fIRAND_seed()\fR is equivalent to \fIRAND_add()\fR when \fBnum == entropy\fR.
 184 .PP
 185 \&\fIRAND_event()\fR collects the entropy from Windows events such as mouse
 186 movements and other user interaction. It should be called with the
 187 \&\fBiMsg\fR, \fBwParam\fR and \fBlParam\fR arguments of \fIall\fR messages sent to
 188 the window procedure. It will estimate the entropy contained in the
 189 event message (if any), and add it to the \s-1PRNG\s0. The program can then
 190 process the messages as usual.
 191 .PP
 192 The \fIRAND_screen()\fR function is available for the convenience of Windows
 193 programmers. It adds the current contents of the screen to the \s-1PRNG\s0.
 194 For applications that can catch Windows events, seeding the \s-1PRNG\s0 by
 195 calling \fIRAND_event()\fR is a significantly better source of
 196 randomness. It should be noted that both methods cannot be used on
 197 servers that run without user interaction.
 198 .SH "RETURN VALUES"
 199 .IX Header "RETURN VALUES"
 200 \&\fIRAND_status()\fR and \fIRAND_event()\fR return 1 if the \s-1PRNG\s0 has been seeded
 201 with enough data, 0 otherwise.
 202 .PP
 203 The other functions do not return values.
 204 .SH "SEE ALSO"
 205 .IX Header "SEE ALSO"
 206 \&\fIopenssl_rand\fR\|(3), \fIRAND_egd\fR\|(3),
 207 \&\fIRAND_load_file\fR\|(3), \fIRAND_cleanup\fR\|(3)
 208 .SH "HISTORY"
 209 .IX Header "HISTORY"
 210 \&\fIRAND_seed()\fR and \fIRAND_screen()\fR are available in all versions of SSLeay
 211 and OpenSSL. \fIRAND_add()\fR and \fIRAND_status()\fR have been added in OpenSSL
 212 0.9.5, \fIRAND_event()\fR in OpenSSL 0.9.5a.