crypto/rand/randfile.c

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