crypto/rand/randfile.c

   1 /* crypto/rand/randfile.c */
   2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
   3  * All rights reserved.
   4  *
   5  * This package is an SSL implementation written
   6  * by Eric Young (eay@cryptsoft.com).
   7  * The implementation was written so as to conform with Netscapes SSL.
   8  *
   9  * This library is free for commercial and non-commercial use as long as
  10  * the following conditions are aheared to.  The following conditions
  11  * apply to all code found in this distribution, be it the RC4, RSA,
  12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
  13  * included with this distribution is covered by the same copyright terms
  14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
  15  *
  16  * Copyright remains Eric Young's, and as such any Copyright notices in
  17  * the code are not to be removed.
  18  * If this package is used in a product, Eric Young should be given attribution
  19  * as the author of the parts of the library used.
  20  * This can be in the form of a textual message at program startup or
  21  * in documentation (online or textual) provided with the package.
  22  *
  23  * Redistribution and use in source and binary forms, with or without
  24  * modification, are permitted provided that the following conditions
  25  * are met:
  26  * 1. Redistributions of source code must retain the copyright
  27  *    notice, this list of conditions and the following disclaimer.
  28  * 2. Redistributions in binary form must reproduce the above copyright
  29  *    notice, this list of conditions and the following disclaimer in the
  30  *    documentation and/or other materials provided with the distribution.
  31  * 3. All advertising materials mentioning features or use of this software
  32  *    must display the following acknowledgement:
  33  *    "This product includes cryptographic software written by
  34  *     Eric Young (eay@cryptsoft.com)"
  35  *    The word 'cryptographic' can be left out if the rouines from the library
  36  *    being used are not cryptographic related :-).
  37  * 4. If you include any Windows specific code (or a derivative thereof) from
  38  *    the apps directory (application code) you must include an acknowledgement:
  39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
  40  *
  41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
  42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  51  * SUCH DAMAGE.
  52  *
  53  * The licence and distribution terms for any publically available version or
  54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
  55  * copied and put under another distribution licence
  56  * [including the GNU Public Licence.]
  57  */
  58
  59 /* We need to define this to get macros like S_IFBLK and S_IFCHR */
  60 #define _XOPEN_SOURCE 500
  61
  62 #include <errno.h>
  63 #include <stdio.h>
  64 #include <stdlib.h>
  65 #include <string.h>
  66
  67 #include "e_os.h"
  68 #include <openssl/crypto.h>
  69 #include <openssl/rand.h>
  70 #include <openssl/buffer.h>
  71
  72 #ifdef OPENSSL_SYS_VMS
  73 # include <unixio.h>
  74 #endif
  75 #ifndef NO_SYS_TYPES_H
  76 # include <sys/types.h>
  77 #endif
  78 #ifndef OPENSSL_NO_POSIX_IO
  79 # include <sys/stat.h>
  80 # include <fcntl.h>
  81 #endif
  82
  83 #ifdef _WIN32
  84 # define stat    _stat
  85 # define chmod   _chmod
  86 # define open    _open
  87 # define fdopen  _fdopen
  88 #endif
  89
  90 #undef BUFSIZE
  91 #define BUFSIZE 1024
  92 #define RAND_DATA 1024
  93
  94 #ifdef OPENSSL_SYS_VMS
  95 /*
  96  * This declaration is a nasty hack to get around vms' extension to fopen for
  97  * passing in sharing options being disabled by our /STANDARD=ANSI89
  98  */
  99 static FILE *(*const vms_fopen)(const char *, const char *, ...) =
 100     (FILE *(*)(const char *, const char *, ...))fopen;
 101 # define VMS_OPEN_ATTRS "shr=get,put,upd,del","ctx=bin,stm","rfm=stm","rat=none","mrs=0"
 102 #endif
 103
 104 /* #define RFILE ".rnd" - defined in ../../e_os.h */
 105
 106 /*
 107  * Note that these functions are intended for seed files only. Entropy
 108  * devices and EGD sockets are handled in rand_unix.c
 109  */
 110
 111 int RAND_load_file(const char *file, long bytes)
 112 {
 113         /*-
 114          * If bytes >= 0, read up to 'bytes' bytes.
 115          * if bytes == -1, read complete file.
 116          */
 117
 118     MS_STATIC unsigned char buf[BUFSIZE];
 119 #ifndef OPENSSL_NO_POSIX_IO
 120     struct stat sb;
 121 #endif
 122     int i, ret = 0, n;
 123     FILE *in;
 124
 125     if (file == NULL)
 126         return (0);
 127
 128 #ifndef OPENSSL_NO_POSIX_IO
 129 # ifdef PURIFY
 130     /*
 131      * struct stat can have padding and unused fields that may not be
 132      * initialized in the call to stat(). We need to clear the entire
 133      * structure before calling RAND_add() to avoid complaints from
 134      * applications such as Valgrind.
 135      */
 136     memset(&sb, 0, sizeof(sb));
 137 # endif
 138     if (stat(file, &sb) < 0)
 139         return (0);
 140     RAND_add(&sb, sizeof(sb), 0.0);
 141 #endif
 142     if (bytes == 0)
 143         return (ret);
 144
 145 #ifdef OPENSSL_SYS_VMS
 146     in = vms_fopen(file, "rb", VMS_OPEN_ATTRS);
 147 #else
 148     in = fopen(file, "rb");
 149 #endif
 150     if (in == NULL)
 151         goto err;
 152 #if defined(S_IFBLK) && defined(S_IFCHR) && !defined(OPENSSL_NO_POSIX_IO)
 153     if (sb.st_mode & (S_IFBLK | S_IFCHR)) {
 154         /*
 155          * this file is a device. we don't want read an infinite number of
 156          * bytes from a random device, nor do we want to use buffered I/O
 157          * because we will waste system entropy.
 158          */
 159         bytes = (bytes == -1) ? 2048 : bytes; /* ok, is 2048 enough? */
 160 # ifndef OPENSSL_NO_SETVBUF_IONBF
 161         setvbuf(in, NULL, _IONBF, 0); /* don't do buffered reads */
 162 # endif                         /* ndef OPENSSL_NO_SETVBUF_IONBF */
 163     }
 164 #endif
 165     for (;;) {
 166         if (bytes > 0)
 167             n = (bytes < BUFSIZE) ? (int)bytes : BUFSIZE;
 168         else
 169             n = BUFSIZE;
 170         i = fread(buf, 1, n, in);
 171         if (i <= 0)
 172             break;
 173 #ifdef PURIFY
 174         RAND_add(buf, i, (double)i);
 175 #else
 176         /* even if n != i, use the full array */
 177         RAND_add(buf, n, (double)i);
 178 #endif
 179         ret += i;
 180         if (bytes > 0) {
 181             bytes -= n;
 182             if (bytes <= 0)
 183                 break;
 184         }
 185     }
 186     fclose(in);
 187     OPENSSL_cleanse(buf, BUFSIZE);
 188  err:
 189     return (ret);
 190 }
 191
 192 int RAND_write_file(const char *file)
 193 {
 194     unsigned char buf[BUFSIZE];
 195     int i, ret = 0, rand_err = 0;
 196     FILE *out = NULL;
 197     int n;
 198 #ifndef OPENSSL_NO_POSIX_IO
 199     struct stat sb;
 200
 201     i = stat(file, &sb);
 202     if (i != -1) {
 203 # if defined(S_ISBLK) && defined(S_ISCHR)
 204         if (S_ISBLK(sb.st_mode) || S_ISCHR(sb.st_mode)) {
 205             /*
 206              * this file is a device. we don't write back to it. we
 207              * "succeed" on the assumption this is some sort of random
 208              * device. Otherwise attempting to write to and chmod the device
 209              * causes problems.
 210              */
 211             return (1);
 212         }
 213 # endif
 214     }
 215 #endif
 216
 217 #if defined(O_CREAT) && !defined(OPENSSL_NO_POSIX_IO) && !defined(OPENSSL_SYS_VMS)
 218     {
 219 # ifndef O_BINARY
 220 #  define O_BINARY 0
 221 # endif
 222         /*
 223          * chmod(..., 0600) is too late to protect the file, permissions
 224          * should be restrictive from the start
 225          */
 226         int fd = open(file, O_WRONLY | O_CREAT | O_BINARY, 0600);
 227         if (fd != -1)
 228             out = fdopen(fd, "wb");
 229     }
 230 #endif
 231
 232 #ifdef OPENSSL_SYS_VMS
 233     /*
 234      * VMS NOTE: Prior versions of this routine created a _new_ version of
 235      * the rand file for each call into this routine, then deleted all
 236      * existing versions named ;-1, and finally renamed the current version
 237      * as ';1'. Under concurrent usage, this resulted in an RMS race
 238      * condition in rename() which could orphan files (see vms message help
 239      * for RMS$_REENT). With the fopen() calls below, openssl/VMS now shares
 240      * the top-level version of the rand file. Note that there may still be
 241      * conditions where the top-level rand file is locked. If so, this code
 242      * will then create a new version of the rand file. Without the delete
 243      * and rename code, this can result in ascending file versions that stop
 244      * at version 32767, and this routine will then return an error. The
 245      * remedy for this is to recode the calling application to avoid
 246      * concurrent use of the rand file, or synchronize usage at the
 247      * application level. Also consider whether or not you NEED a persistent
 248      * rand file in a concurrent use situation.
 249      */
 250
 251     out = vms_fopen(file, "rb+", VMS_OPEN_ATTRS);
 252     if (out == NULL)
 253         out = vms_fopen(file, "wb", VMS_OPEN_ATTRS);
 254 #else
 255     if (out == NULL)
 256         out = fopen(file, "wb");
 257 #endif
 258     if (out == NULL)
 259         goto err;
 260
 261 #ifndef NO_CHMOD
 262     chmod(file, 0600);
 263 #endif
 264     n = RAND_DATA;
 265     for (;;) {
 266         i = (n > BUFSIZE) ? BUFSIZE : n;
 267         n -= BUFSIZE;
 268         if (RAND_bytes(buf, i) <= 0)
 269             rand_err = 1;
 270         i = fwrite(buf, 1, i, out);
 271         if (i <= 0) {
 272             ret = 0;
 273             break;
 274         }
 275         ret += i;
 276         if (n <= 0)
 277             break;
 278     }
 279
 280     fclose(out);
 281     OPENSSL_cleanse(buf, BUFSIZE);
 282  err:
 283     return (rand_err ? -1 : ret);
 284 }
 285
 286 const char *RAND_file_name(char *buf, size_t size)
 287 {
 288     char *s = NULL;
 289 #ifdef __OpenBSD__
 290     struct stat sb;
 291 #endif
 292
 293     if (OPENSSL_issetugid() == 0)
 294         s = getenv("RANDFILE");
 295     if (s != NULL && *s && strlen(s) + 1 < size) {
 296         if (BUF_strlcpy(buf, s, size) >= size)
 297             return NULL;
 298     } else {
 299         if (OPENSSL_issetugid() == 0)
 300             s = getenv("HOME");
 301 #ifdef DEFAULT_HOME
 302         if (s == NULL) {
 303             s = DEFAULT_HOME;
 304         }
 305 #endif
 306         if (s && *s && strlen(s) + strlen(RFILE) + 2 < size) {
 307             BUF_strlcpy(buf, s, size);
 308 #ifndef OPENSSL_SYS_VMS
 309             BUF_strlcat(buf, "/", size);
 310 #endif
 311             BUF_strlcat(buf, RFILE, size);
 312         } else
 313             buf[0] = '\0';      /* no file name */
 314     }
 315
 316 #ifdef __OpenBSD__
 317     /*
 318      * given that all random loads just fail if the file can't be seen on a
 319      * stat, we stat the file we're returning, if it fails, use /dev/arandom
 320      * instead. this allows the user to use their own source for good random
 321      * data, but defaults to something hopefully decent if that isn't
 322      * available.
 323      */
 324
 325     if (!buf[0])
 326         if (BUF_strlcpy(buf, "/dev/arandom", size) >= size) {
 327             return (NULL);
 328         }
 329     if (stat(buf, &sb) == -1)
 330         if (BUF_strlcpy(buf, "/dev/arandom", size) >= size) {
 331             return (NULL);
 332         }
 333 #endif
 334     return (buf);
 335 }