secure/lib/libcrypto/man/man3/RAND_DRBG_reseed.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   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 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "RAND_DRBG_RESEED 3"
 136 .TH RAND_DRBG_RESEED 3 "2020-03-31" "1.1.1f" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 RAND_DRBG_reseed, RAND_DRBG_set_reseed_interval, RAND_DRBG_set_reseed_time_interval, RAND_DRBG_set_reseed_defaults \&\- reseed a RAND_DRBG instance
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/rand_drbg.h>
 147 \&
 148 \& int RAND_DRBG_reseed(RAND_DRBG *drbg,
 149 \&                      const unsigned char *adin, size_t adinlen,
 150 \&                      int prediction_resistance);
 151 \&
 152 \& int RAND_DRBG_set_reseed_interval(RAND_DRBG *drbg,
 153 \&                                   unsigned int interval);
 154 \&
 155 \& int RAND_DRBG_set_reseed_time_interval(RAND_DRBG *drbg,
 156 \&                                        time_t interval);
 157 \&
 158 \& int RAND_DRBG_set_reseed_defaults(
 159 \&                                   unsigned int master_reseed_interval,
 160 \&                                   unsigned int slave_reseed_interval,
 161 \&                                   time_t master_reseed_time_interval,
 162 \&                                   time_t slave_reseed_time_interval
 163 \&                                   );
 164 .Ve
 165 .SH "DESCRIPTION"
 166 .IX Header "DESCRIPTION"
 167 \&\fBRAND_DRBG_reseed()\fR
 168 reseeds the given \fBdrbg\fR, obtaining entropy input from its entropy source
 169 and mixing in the specified additional data provided in the buffer \fBadin\fR
 170 of length \fBadinlen\fR.
 171 The additional data can be omitted by setting \fBadin\fR to \s-1NULL\s0 and \fBadinlen\fR
 172 to 0.
 173 An immediate reseeding from a live entropy source can be requested by setting
 174 the \fBprediction_resistance\fR flag to 1.
 175 This feature is not implemented yet, so reseeding with prediction resistance
 176 requested will always fail.
 177 .PP
 178 \&\fBRAND_DRBG_set_reseed_interval()\fR
 179 sets the reseed interval of the \fBdrbg\fR, which is the maximum allowed number
 180 of generate requests between consecutive reseedings.
 181 If \fBinterval\fR > 0, then the \fBdrbg\fR will reseed automatically whenever the
 182 number of generate requests since its last seeding exceeds the given reseed
 183 interval.
 184 If \fBinterval\fR == 0, then this feature is disabled.
 185 .PP
 186 \&\fBRAND_DRBG_set_reseed_time_interval()\fR
 187 sets the reseed time interval of the \fBdrbg\fR, which is the maximum allowed
 188 number of seconds between consecutive reseedings.
 189 If \fBinterval\fR > 0, then the \fBdrbg\fR will reseed automatically whenever the
 190 elapsed time since its last reseeding exceeds the given reseed time interval.
 191 If \fBinterval\fR == 0, then this feature is disabled.
 192 .PP
 193 \&\fBRAND_DRBG_set_reseed_defaults()\fR sets the default values for the reseed interval
 194 (\fBmaster_reseed_interval\fR and \fBslave_reseed_interval\fR)
 195 and the reseed time interval
 196 (\fBmaster_reseed_time_interval\fR and \fBslave_reseed_tme_interval\fR)
 197 of \s-1DRBG\s0 instances.
 198 The default values are set independently for master \s-1DRBG\s0 instances (which don't
 199 have a parent) and slave \s-1DRBG\s0 instances (which are chained to a parent \s-1DRBG\s0).
 200 .SH "RETURN VALUES"
 201 .IX Header "RETURN VALUES"
 202 \&\fBRAND_DRBG_reseed()\fR,
 203 \&\fBRAND_DRBG_set_reseed_interval()\fR, and
 204 \&\fBRAND_DRBG_set_reseed_time_interval()\fR,
 205 return 1 on success, 0 on failure.
 206 .SH "NOTES"
 207 .IX Header "NOTES"
 208 The default OpenSSL random generator is already set up for automatic reseeding,
 209 so in general it is not necessary to reseed it explicitly, or to modify
 210 its reseeding thresholds.
 211 .PP
 212 Normally, the entropy input for seeding a \s-1DRBG\s0 is either obtained from a
 213 trusted os entropy source or from a parent \s-1DRBG\s0 instance, which was seeded
 214 (directly or indirectly) from a trusted os entropy source.
 215 In exceptional cases it is possible to replace the reseeding mechanism entirely
 216 by providing application defined callbacks using \fBRAND_DRBG_set_callbacks()\fR.
 217 .PP
 218 The reseeding default values are applied only during creation of a \s-1DRBG\s0 instance.
 219 To ensure that they are applied to the global and thread-local \s-1DRBG\s0 instances
 220 (<master>, resp. <public> and <private>), it is necessary to call
 221 \&\fBRAND_DRBG_set_reseed_defaults()\fR before creating any thread and before calling any
 222  cryptographic routines that obtain random data directly or indirectly.
 223 .SH "SEE ALSO"
 224 .IX Header "SEE ALSO"
 225 \&\fBRAND_DRBG_generate\fR\|(3),
 226 \&\fBRAND_DRBG_bytes\fR\|(3),
 227 \&\fBRAND_DRBG_set_callbacks\fR\|(3).
 228 \&\s-1\fBRAND_DRBG\s0\fR\|(7)
 229 .SH "HISTORY"
 230 .IX Header "HISTORY"
 231 The \s-1RAND_DRBG\s0 functions were added in OpenSSL 1.1.1.
 232 .SH "COPYRIGHT"
 233 .IX Header "COPYRIGHT"
 234 Copyright 2017\-2019 The OpenSSL Project Authors. All Rights Reserved.
 235 .PP
 236 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 237 this file except in compliance with the License.  You can obtain a copy
 238 in the file \s-1LICENSE\s0 in the source distribution or at
 239 <https://www.openssl.org/source/license.html>.