Debian Codegraph @

upstream/debian-unstable/man3/RAND_load_file.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "RAND_LOAD_FILE 3SSL"
58 .TH RAND_LOAD_FILE 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 RAND_load_file, RAND_write_file, RAND_file_name \- PRNG seed file
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/rand.h>
69 \&
70 \& int RAND_load_file(const char *filename, long max_bytes);
71 \&
72 \& int RAND_write_file(const char *filename);
73 \&
74 \& const char *RAND_file_name(char *buf, size_t num);
75 .Ve
76 .SH DESCRIPTION
77 .IX Header "DESCRIPTION"
78 \&\fBRAND_load_file()\fR reads a number of bytes from file \fBfilename\fR and
79 adds them to the PRNG. If \fBmax_bytes\fR is nonnegative,
80 up to \fBmax_bytes\fR are read;
81 if \fBmax_bytes\fR is \-1, the complete file is read (unless the file
82 is not a regular file, in that case a fixed number of bytes,
83 256 in the current implementation, is attempted to be read).
84 \&\fBRAND_load_file()\fR can read less than the complete file or the requested number
85 of bytes if it doesn't fit in the return value type.
86 Do not load the same file multiple times unless its contents have
87 been updated by \fBRAND_write_file()\fR between reads.
88 Also, note that \fBfilename\fR should be adequately protected so that an
89 attacker cannot replace or examine the contents.
90 If \fBfilename\fR is not a regular file, then user is considered to be
91 responsible for any side effects, e.g. non-anticipated blocking or
92 capture of controlling terminal.
93 .PP
94 \&\fBRAND_write_file()\fR writes a number of random bytes (currently 128) to
95 file \fBfilename\fR which can be used to initialize the PRNG by calling
96 \&\fBRAND_load_file()\fR in a later session.
97 .PP
98 \&\fBRAND_file_name()\fR generates a default path for the random seed
99 file. \fBbuf\fR points to a buffer of size \fBnum\fR in which to store the
100 filename.
101 .PP
102 On all systems, if the environment variable \fBRANDFILE\fR is set, its
103 value will be used as the seed filename.
104 Otherwise, the file is called \f(CW\*(C`.rnd\*(C'\fR, found in platform dependent locations:
105 .IP "On Windows (in order of preference)" 4
106 .IX Item "On Windows (in order of preference)"
107 .Vb 1
108 \& %HOME%, %USERPROFILE%, %SYSTEMROOT%, C:\e
109 .Ve
110 .IP "On VMS" 4
111 .IX Item "On VMS"
112 .Vb 1
113 \& SYS$LOGIN:
114 .Ve
115 .IP "On all other systems" 4
116 .IX Item "On all other systems"
117 .Vb 1
118 \& $HOME
119 .Ve
120 .PP
121 If \f(CW$HOME\fR (on non-Windows and non-VMS system) is not set either, or
122 \&\fBnum\fR is too small for the pathname, an error occurs.
123 .SH "RETURN VALUES"
124 .IX Header "RETURN VALUES"
125 \&\fBRAND_load_file()\fR returns the number of bytes read or \-1 on error.
126 .PP
127 \&\fBRAND_write_file()\fR returns the number of bytes written, or \-1 if the
128 bytes written were generated without appropriate seeding.
129 .PP
130 \&\fBRAND_file_name()\fR returns a pointer to \fBbuf\fR on success, and NULL on
131 error.
132 .SH "SEE ALSO"
133 .IX Header "SEE ALSO"
134 \&\fBRAND_add\fR\|(3),
135 \&\fBRAND_bytes\fR\|(3),
136 \&\fBRAND\fR\|(7)
137 .SH COPYRIGHT
138 .IX Header "COPYRIGHT"
139 Copyright 2000\-2025 The OpenSSL Project Authors. All Rights Reserved.
140 .PP
141 Licensed under the Apache License 2.0 (the "License"). You may not use
142 this file except in compliance with the License. You can obtain a copy
143 in the file LICENSE in the source distribution or at
144 <https://www.openssl.org/source/license.html>.