secure/lib/libcrypto/man/man3/RAND_load_file.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_LOAD_FILE 3"
 136 .TH RAND_LOAD_FILE 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_load_file, RAND_write_file, RAND_file_name \- PRNG seed file
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/rand.h>
 147 \&
 148 \& int RAND_load_file(const char *filename, long max_bytes);
 149 \&
 150 \& int RAND_write_file(const char *filename);
 151 \&
 152 \& const char *RAND_file_name(char *buf, size_t num);
 153 .Ve
 154 .SH "DESCRIPTION"
 155 .IX Header "DESCRIPTION"
 156 \&\fBRAND_load_file()\fR reads a number of bytes from file \fBfilename\fR and
 157 adds them to the \s-1PRNG.\s0 If \fBmax_bytes\fR is non-negative,
 158 up to \fBmax_bytes\fR are read;
 159 if \fBmax_bytes\fR is \-1, the complete file is read.
 160 Do not load the same file multiple times unless its contents have
 161 been updated by \fBRAND_write_file()\fR between reads.
 162 Also, note that \fBfilename\fR should be adequately protected so that an
 163 attacker cannot replace or examine the contents.
 164 If \fBfilename\fR is not a regular file, then user is considered to be
 165 responsible for any side effects, e.g. non-anticipated blocking or
 166 capture of controlling terminal.
 167 .PP
 168 \&\fBRAND_write_file()\fR writes a number of random bytes (currently 128) to
 169 file \fBfilename\fR which can be used to initialize the \s-1PRNG\s0 by calling
 170 \&\fBRAND_load_file()\fR in a later session.
 171 .PP
 172 \&\fBRAND_file_name()\fR generates a default path for the random seed
 173 file. \fBbuf\fR points to a buffer of size \fBnum\fR in which to store the
 174 filename.
 175 .PP
 176 On all systems, if the environment variable \fB\s-1RANDFILE\s0\fR is set, its
 177 value will be used as the seed file name.
 178 Otherwise, the file is called \f(CW\*(C`.rnd\*(C'\fR, found in platform dependent locations:
 179 .IP "On Windows (in order of preference)" 4
 180 .IX Item "On Windows (in order of preference)"
 181 .Vb 1
 182 \& %HOME%, %USERPROFILE%, %SYSTEMROOT%, C:\e
 183 .Ve
 184 .IP "On \s-1VMS\s0" 4
 185 .IX Item "On VMS"
 186 .Vb 1
 187 \& SYS$LOGIN:
 188 .Ve
 189 .IP "On all other systems" 4
 190 .IX Item "On all other systems"
 191 .Vb 1
 192 \& $HOME
 193 .Ve
 194 .PP
 195 If \f(CW$HOME\fR (on non-Windows and non-VMS system) is not set either, or
 196 \&\fBnum\fR is too small for the path name, an error occurs.
 197 .SH "RETURN VALUES"
 198 .IX Header "RETURN VALUES"
 199 \&\fBRAND_load_file()\fR returns the number of bytes read or \-1 on error.
 200 .PP
 201 \&\fBRAND_write_file()\fR returns the number of bytes written, or \-1 if the
 202 bytes written were generated without appropriate seeding.
 203 .PP
 204 \&\fBRAND_file_name()\fR returns a pointer to \fBbuf\fR on success, and \s-1NULL\s0 on
 205 error.
 206 .SH "SEE ALSO"
 207 .IX Header "SEE ALSO"
 208 \&\fBRAND_add\fR\|(3),
 209 \&\fBRAND_bytes\fR\|(3),
 210 \&\s-1\fBRAND\s0\fR\|(7)
 211 .SH "COPYRIGHT"
 212 .IX Header "COPYRIGHT"
 213 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 214 .PP
 215 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 216 this file except in compliance with the License.  You can obtain a copy
 217 in the file \s-1LICENSE\s0 in the source distribution or at
 218 <https://www.openssl.org/source/license.html>.