lib/libcrypto/man/RAND_load_file.3

   1 .\"     $OpenBSD: RAND_load_file.3,v 1.6 2018/03/27 17:35:50 schwarze Exp $
   2 .\"     OpenSSL b97fdb57 Nov 11 09:33:09 2016 +0100
   3 .\"
   4 .\" This file was written by Ulf Moeller <ulf@openssl.org>.
   5 .\" Copyright (c) 2000, 2001 The OpenSSL Project.  All rights reserved.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\"
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\"
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in
  16 .\"    the documentation and/or other materials provided with the
  17 .\"    distribution.
  18 .\"
  19 .\" 3. All advertising materials mentioning features or use of this
  20 .\"    software must display the following acknowledgment:
  21 .\"    "This product includes software developed by the OpenSSL Project
  22 .\"    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
  23 .\"
  24 .\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
  25 .\"    endorse or promote products derived from this software without
  26 .\"    prior written permission. For written permission, please contact
  27 .\"    openssl-core@openssl.org.
  28 .\"
  29 .\" 5. Products derived from this software may not be called "OpenSSL"
  30 .\"    nor may "OpenSSL" appear in their names without prior written
  31 .\"    permission of the OpenSSL Project.
  32 .\"
  33 .\" 6. Redistributions of any form whatsoever must retain the following
  34 .\"    acknowledgment:
  35 .\"    "This product includes software developed by the OpenSSL Project
  36 .\"    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
  37 .\"
  38 .\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
  39 .\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  40 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  41 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
  42 .\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  43 .\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  44 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  45 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  46 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  47 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  48 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
  49 .\" OF THE POSSIBILITY OF SUCH DAMAGE.
  50 .\"
  51 .Dd $Mdocdate: March 27 2018 $
  52 .Dt RAND_LOAD_FILE 3
  53 .Os
  54 .Sh NAME
  55 .Nm RAND_file_name ,
  56 .Nm RAND_load_file ,
  57 .Nm RAND_write_file
  58 .Nd PRNG seed file
  59 .Sh SYNOPSIS
  60 .In openssl/rand.h
  61 .Ft const char *
  62 .Fo RAND_file_name
  63 .Fa "char *buf"
  64 .Fa "size_t num"
  65 .Fc
  66 .Ft int
  67 .Fo RAND_load_file
  68 .Fa "const char *filename"
  69 .Fa "long max_bytes"
  70 .Fc
  71 .Ft int
  72 .Fo RAND_write_file
  73 .Fa "const char *filename"
  74 .Fc
  75 .Sh DESCRIPTION
  76 .Fn RAND_file_name
  77 returns a default path for the random seed file.
  78 .Fa buf
  79 points to a buffer of size
  80 .Fa num
  81 in which to store the filename.
  82 If
  83 .Fa num
  84 is too small for the path name, an error occurs.
  85 .Pp
  86 .Fn RAND_load_file
  87 used to allow for the state of the random number generator to be
  88 controlled by external sources.
  89 It is kept for ABI compatibility but is no longer functional, and should
  90 not be used in new programs.
  91 .Pp
  92 .Fn RAND_write_file
  93 writes a number of random bytes (currently 1024) to file
  94 .Fa filename .
  95 .Sh RETURN VALUES
  96 .Fn RAND_load_file
  97 returns
  98 .Fa max_bytes ,
  99 or a bogus positive value if
 100 .Fa max_bytes
 101 is -1.
 102 .Pp
 103 .Fn RAND_write_file
 104 returns the number of bytes written, or a number less than or equal
 105 to 1 if an error occurs.
 106 .Pp
 107 .Fn RAND_file_name
 108 returns a pointer to
 109 .Fa buf
 110 on success or
 111 .Dv NULL
 112 on error.
 113 .Sh HISTORY
 114 .Fn RAND_load_file ,
 115 .Fn RAND_write_file ,
 116 and
 117 .Fn RAND_file_name
 118 first appeared in SSLeay 0.5.1 and have been available since
 119 .Ox 2.4 .