doc/man3/RAND_load_file.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 RAND_load_file, RAND_write_file, RAND_file_name - PRNG seed file
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/rand.h>
  10
  11  int RAND_load_file(const char *filename, long max_bytes);
  12
  13  int RAND_write_file(const char *filename);
  14
  15  const char *RAND_file_name(char *buf, size_t num);
  16
  17 =head1 DESCRIPTION
  18
  19 RAND_load_file() reads a number of bytes from file B<filename> and
  20 adds them to the PRNG. If B<max_bytes> is non-negative,
  21 up to B<max_bytes> are read;
  22 if B<max_bytes> is -1, the complete file is read.
  23
  24 RAND_write_file() writes a number of random bytes (currently 256) to
  25 file B<filename> which can be used to initialize the PRNG by calling
  26 RAND_load_file() in a later session.
  27
  28 RAND_file_name() generates a default path for the random seed
  29 file. B<buf> points to a buffer of size B<num> in which to store the
  30 filename.
  31
  32 On all systems, if the environment variable B<RANDFILE> is set, its
  33 value will be used as the seed file name.
  34 Otherwise, the file is called C<.rnd>, found in platform dependent locations:
  35
  36 =over 4
  37
  38 =item On Windows (in order of preference)
  39
  40  %HOME%, %USERPROFILE%, %SYSTEMROOT%, C:\
  41
  42 =item On VMS
  43
  44  SYS$LOGIN:
  45
  46 =item On all other systems
  47
  48  $HOME
  49
  50 =back
  51
  52 If C<$HOME> (on non-Windows and non-VMS system) is not set either, or
  53 B<num> is too small for the path name, an error occurs.
  54
  55 =head1 RETURN VALUES
  56
  57 RAND_load_file() returns the number of bytes read.
  58
  59 RAND_write_file() returns the number of bytes written, and -1 if the
  60 bytes written were generated without appropriate seed.
  61
  62 RAND_file_name() returns a pointer to B<buf> on success, and NULL on
  63 error.
  64
  65 =head1 SEE ALSO
  66
  67 L<RAND_bytes(3)>, L<RAND_add(3)>
  68
  69 =head1 HISTORY
  70
  71 A comment in the source since at least OpenSSL version 1.0.2 said that
  72 RAND_load_file() and RAND_write_file() were only intended for regular files,
  73 and not really device special files such as C</dev/random>.  This was
  74 poorly enforced before OpenSSL version 1.1.1.
  75
  76 =head1 COPYRIGHT
  77
  78 Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved.
  79
  80 Licensed under the OpenSSL license (the "License").  You may not use
  81 this file except in compliance with the License.  You can obtain a copy
  82 in the file LICENSE in the source distribution or at
  83 L<https://www.openssl.org/source/license.html>.
  84
  85 =cut