secure/lib/libcrypto/man/RAND_DRBG_set_callbacks.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_SET_CALLBACKS 3"
 132 .TH RAND_DRBG_SET_CALLBACKS 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_set_callbacks, RAND_DRBG_get_entropy_fn, RAND_DRBG_cleanup_entropy_fn, RAND_DRBG_get_nonce_fn, RAND_DRBG_cleanup_nonce_fn \&\- set callbacks for reseeding
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/rand_drbg.h>
 143 \&
 144 \&
 145 \& int RAND_DRBG_set_callbacks(RAND_DRBG *drbg,
 146 \&                             RAND_DRBG_get_entropy_fn get_entropy,
 147 \&                             RAND_DRBG_cleanup_entropy_fn cleanup_entropy,
 148 \&                             RAND_DRBG_get_nonce_fn get_nonce,
 149 \&                             RAND_DRBG_cleanup_nonce_fn cleanup_nonce);
 150 .Ve
 151 .SS "Callback Functions"
 152 .IX Subsection "Callback Functions"
 153 .Vb 6
 154 \& typedef size_t (*RAND_DRBG_get_entropy_fn)(
 155 \&                       RAND_DRBG *drbg,
 156 \&                       unsigned char **pout,
 157 \&                       int entropy,
 158 \&                       size_t min_len, size_t max_len,
 159 \&                       int prediction_resistance);
 160 \&
 161 \& typedef void (*RAND_DRBG_cleanup_entropy_fn)(
 162 \&                     RAND_DRBG *drbg,
 163 \&                     unsigned char *out, size_t outlen);
 164 \&
 165 \& typedef size_t (*RAND_DRBG_get_nonce_fn)(
 166 \&                       RAND_DRBG *drbg,
 167 \&                       unsigned char **pout,
 168 \&                       int entropy,
 169 \&                       size_t min_len, size_t max_len);
 170 \&
 171 \& typedef void (*RAND_DRBG_cleanup_nonce_fn)(
 172 \&                     RAND_DRBG *drbg,
 173 \&                     unsigned char *out, size_t outlen);
 174 .Ve
 175 .SH "DESCRIPTION"
 176 .IX Header "DESCRIPTION"
 177 \&\fIRAND_DRBG_set_callbacks()\fR sets the callbacks for obtaining fresh entropy and
 178 the nonce when reseeding the given \fBdrbg\fR.
 179 The callback functions are implemented and provided by the caller.
 180 Their parameter lists need to match the function prototypes above.
 181 .PP
 182 Setting the callbacks is allowed only if the \s-1DRBG\s0 has not been initialized yet.
 183 Otherwise, the operation will fail.
 184 To change the settings for one of the three shared DRBGs it is necessary to call
 185 \&\fIRAND_DRBG_uninstantiate()\fR first.
 186 .PP
 187 The \fBget_entropy\fR() callback is called by the \fBdrbg\fR when it requests fresh
 188 random input.
 189 It is expected that the callback allocates and fills a random buffer of size
 190 \&\fBmin_len\fR <= size <= \fBmax_len\fR (in bytes) which contains at least \fBentropy\fR
 191 bits of randomness.
 192 The \fBprediction_resistance\fR flag indicates whether the reseeding was
 193 triggered by a prediction resistance request.
 194 .PP
 195 The buffer's address is to be returned in *\fBpout\fR and the number of collected
 196 randomness bytes as return value.
 197 .PP
 198 If the callback fails to acquire at least \fBentropy\fR bits of randomness,
 199 it must indicate an error by returning a buffer length of 0.
 200 .PP
 201 If \fBprediction_resistance\fR was requested and the random source of the \s-1DRBG\s0
 202 does not satisfy the conditions requested by [\s-1NIST SP 800\-90C\s0], then
 203 it must also indicate an error by returning a buffer length of 0.
 204 See \s-1NOTES\s0 section for more details.
 205 .PP
 206 The \fBcleanup_entropy\fR() callback is called from the \fBdrbg\fR to to clear and
 207 free the buffer allocated previously by \fIget_entropy()\fR.
 208 The values \fBout\fR and \fBoutlen\fR are the random buffer's address and length,
 209 as returned by the \fIget_entropy()\fR callback.
 210 .PP
 211 The \fBget_nonce\fR() and \fBcleanup_nonce\fR() callbacks are used to obtain a nonce
 212 and free it again. A nonce is only required for instantiation (not for reseeding)
 213 and only in the case where the \s-1DRBG\s0 uses a derivation function.
 214 The callbacks are analogous to \fIget_entropy()\fR and \fIcleanup_entropy()\fR,
 215 except for the missing prediction_resistance flag.
 216 .PP
 217 If the derivation function is disabled, then no nonce is used for instantiation,
 218 and the \fBget_nonce\fR() and \fBcleanup_nonce\fR() callbacks can be omitted by
 219 setting them to \s-1NULL.\s0
 220 .SH "RETURN VALUES"
 221 .IX Header "RETURN VALUES"
 222 \&\fIRAND_DRBG_set_callbacks()\fR return 1 on success, and 0 on failure
 223 .SH "NOTES"
 224 .IX Header "NOTES"
 225 It is important that \fBcleanup_entropy\fR() and \fBcleanup_nonce\fR() clear the buffer
 226 contents safely before freeing it, in order not to leave sensitive information
 227 about the \s-1DRBG\s0's state in memory.
 228 .PP
 229 A request for prediction resistance can only be satisfied by pulling fresh
 230 entropy from one of the approved entropy sources listed in section 5.5.2 of
 231 [\s-1NIST SP 800\-90C\s0].
 232 Since the default implementation of the get_entropy callback does not have access
 233 to such an approved entropy source, a request for prediction resistance will
 234 always fail.
 235 In other words, prediction resistance is currently not supported yet by the \s-1DRBG.\s0
 236 .PP
 237 The derivation function is disabled during initialization by calling the
 238 \&\fIRAND_DRBG_set()\fR function with the \s-1RAND_DRBG_FLAG_CTR_NO_DF\s0 flag.
 239 For more information on the derivation function and when it can be omitted,
 240 see [\s-1NIST SP 800\-90A\s0 Rev. 1]. Roughly speeking it can be omitted if the random
 241 source has \*(L"full entropy\*(R", i.e., contains 8 bits of entropy per byte.
 242 .PP
 243 Even if a nonce is required, the \fBget_nonce\fR() and \fBcleanup_nonce\fR()
 244 callbacks can be omitted by setting them to \s-1NULL.\s0
 245 In this case the \s-1DRBG\s0 will automatically request an extra amount of entropy
 246 (using the \fBget_entropy\fR() and \fBcleanup_entropy\fR() callbacks) which it will
 247 utilize for the nonce, following the recommendations of [\s-1NIST SP 800\-90A\s0 Rev. 1],
 248 section 8.6.7.
 249 .SH "HISTORY"
 250 .IX Header "HISTORY"
 251 The \s-1RAND_DRBG\s0 functions were added in OpenSSL 1.1.1.
 252 .SH "SEE ALSO"
 253 .IX Header "SEE ALSO"
 254 \&\fIRAND_DRBG_new\fR\|(3),
 255 \&\fIRAND_DRBG_reseed\fR\|(3),
 256 \&\s-1\fIRAND_DRBG\s0\fR\|(7)
 257 .SH "COPYRIGHT"
 258 .IX Header "COPYRIGHT"
 259 Copyright 2017\-2018 The OpenSSL Project Authors. All Rights Reserved.
 260 .PP
 261 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 262 this file except in compliance with the License.  You can obtain a copy
 263 in the file \s-1LICENSE\s0 in the source distribution or at
 264 <https://www.openssl.org/source/license.html>.