secure/lib/libcrypto/man/RAND_add.3

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