$NetBSD: RAND_load_file.3,v 1.25 2024/09/08 13:08:29 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..

..

.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================

Title "RAND_load_file 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
RAND_load_file, RAND_write_file, RAND_file_name - PRNG seed file Header "SYNOPSIS" .Vb 1 #include <openssl/rand.h> \& int RAND_load_file(const char *filename, long max_bytes); \& int RAND_write_file(const char *filename); \& const char *RAND_file_name(char *buf, size_t num); .Ve Header "DESCRIPTION" \fBRAND_load_file() reads a number of bytes from file filename and adds them to the PRNG. If max_bytes is nonnegative, up to max_bytes are read; if max_bytes is -1, the complete file is read. Do not load the same file multiple times unless its contents have been updated by RAND_write_file() between reads. Also, note that filename should be adequately protected so that an attacker cannot replace or examine the contents. If filename is not a regular file, then user is considered to be responsible for any side effects, e.g. non-anticipated blocking or capture of controlling terminal.

\fBRAND_write_file() writes a number of random bytes (currently 128) to file filename which can be used to initialize the PRNG by calling \fBRAND_load_file() in a later session.

\fBRAND_file_name() generates a default path for the random seed file. buf points to a buffer of size num in which to store the filename.

On all systems, if the environment variable RANDFILE is set, its value will be used as the seed filename. Otherwise, the file is called \*(C`.rnd\*(C', found in platform dependent locations:

Item "On Windows (in order of preference)" .Vb 1 %HOME%, %USERPROFILE%, %SYSTEMROOT%, C:\e .Ve Item "On VMS" .Vb 1 SYS$LOGIN: .Ve Item "On all other systems" .Vb 1 $HOME .Ve

If $HOME (on non-Windows and non-VMS system) is not set either, or \fBnum is too small for the pathname, an error occurs.

Header "RETURN VALUES" \fBRAND_load_file() returns the number of bytes read or -1 on error.

\fBRAND_write_file() returns the number of bytes written, or -1 if the bytes written were generated without appropriate seeding.

\fBRAND_file_name() returns a pointer to buf on success, and NULL on error.

Header "SEE ALSO" \fBRAND_add\|(3), \fBRAND_bytes\|(3), \fBRAND\|(7) Header "COPYRIGHT" Copyright 2000-2020 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.