secure/lib/libcrypto/man/RAND_set_rand_method.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_set_rand_method 3"
 132 .TH RAND_set_rand_method 3 "2018-08-14" "1.0.2p" "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_set_rand_method, RAND_get_rand_method, RAND_SSLeay \- select RAND method
 139 .SH "SYNOPSIS"
 140 .IX Header "SYNOPSIS"
 141 .Vb 1
 142 \& #include <openssl/rand.h>
 143 \&
 144 \& void RAND_set_rand_method(const RAND_METHOD *meth);
 145 \&
 146 \& const RAND_METHOD *RAND_get_rand_method(void);
 147 \&
 148 \& RAND_METHOD *RAND_SSLeay(void);
 149 .Ve
 150 .SH "DESCRIPTION"
 151 .IX Header "DESCRIPTION"
 152 A \fB\s-1RAND_METHOD\s0\fR specifies the functions that OpenSSL uses for random number
 153 generation. By modifying the method, alternative implementations such as
 154 hardware RNGs may be used. \s-1IMPORTANT:\s0 See the \s-1NOTES\s0 section for important
 155 information about how these \s-1RAND API\s0 functions are affected by the use of
 156 \&\fB\s-1ENGINE\s0\fR \s-1API\s0 calls.
 157 .PP
 158 Initially, the default \s-1RAND_METHOD\s0 is the OpenSSL internal implementation, as
 159 returned by \fIRAND_SSLeay()\fR.
 160 .PP
 161 \&\fIRAND_set_default_method()\fR makes \fBmeth\fR the method for \s-1PRNG\s0 use. \fB\s-1NB\s0\fR: This is
 162 true only whilst no \s-1ENGINE\s0 has been set as a default for \s-1RAND,\s0 so this function
 163 is no longer recommended.
 164 .PP
 165 \&\fIRAND_get_default_method()\fR returns a pointer to the current \s-1RAND_METHOD.\s0
 166 However, the meaningfulness of this result is dependent on whether the \s-1ENGINE
 167 API\s0 is being used, so this function is no longer recommended.
 168 .SH "THE RAND_METHOD STRUCTURE"
 169 .IX Header "THE RAND_METHOD STRUCTURE"
 170 .Vb 9
 171 \& typedef struct rand_meth_st
 172 \& {
 173 \&        void (*seed)(const void *buf, int num);
 174 \&        int (*bytes)(unsigned char *buf, int num);
 175 \&        void (*cleanup)(void);
 176 \&        void (*add)(const void *buf, int num, int entropy);
 177 \&        int (*pseudorand)(unsigned char *buf, int num);
 178 \&        int (*status)(void);
 179 \& } RAND_METHOD;
 180 .Ve
 181 .PP
 182 The components point to the implementation of \fIRAND_seed()\fR,
 183 \&\fIRAND_bytes()\fR, \fIRAND_cleanup()\fR, \fIRAND_add()\fR, \fIRAND_pseudo_rand()\fR
 184 and \fIRAND_status()\fR.
 185 Each component may be \s-1NULL\s0 if the function is not implemented.
 186 .SH "RETURN VALUES"
 187 .IX Header "RETURN VALUES"
 188 \&\fIRAND_set_rand_method()\fR returns no value. \fIRAND_get_rand_method()\fR and
 189 \&\fIRAND_SSLeay()\fR return pointers to the respective methods.
 190 .SH "NOTES"
 191 .IX Header "NOTES"
 192 As of version 0.9.7, \s-1RAND_METHOD\s0 implementations are grouped together with other
 193 algorithmic APIs (eg. \s-1RSA_METHOD, EVP_CIPHER,\s0 etc) in \fB\s-1ENGINE\s0\fR modules. If a
 194 default \s-1ENGINE\s0 is specified for \s-1RAND\s0 functionality using an \s-1ENGINE API\s0 function,
 195 that will override any \s-1RAND\s0 defaults set using the \s-1RAND API\s0 (ie.
 196 \&\fIRAND_set_rand_method()\fR). For this reason, the \s-1ENGINE API\s0 is the recommended way
 197 to control default implementations for use in \s-1RAND\s0 and other cryptographic
 198 algorithms.
 199 .SH "SEE ALSO"
 200 .IX Header "SEE ALSO"
 201 \&\fIrand\fR\|(3), \fIengine\fR\|(3)
 202 .SH "HISTORY"
 203 .IX Header "HISTORY"
 204 \&\fIRAND_set_rand_method()\fR, \fIRAND_get_rand_method()\fR and \fIRAND_SSLeay()\fR are
 205 available in all versions of OpenSSL.
 206 .PP
 207 In the engine version of version 0.9.6, \fIRAND_set_rand_method()\fR was altered to
 208 take an \s-1ENGINE\s0 pointer as its argument. As of version 0.9.7, that has been
 209 reverted as the \s-1ENGINE API\s0 transparently overrides \s-1RAND\s0 defaults if used,
 210 otherwise \s-1RAND API\s0 functions work as before. \fIRAND_set_rand_engine()\fR was also
 211 introduced in version 0.9.7.