secure/lib/libcrypto/man/RAND_DRBG_reseed.3

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