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 #ifdef MAC_OS_pre_X
  79 # include <stat.h>
  80 #else
  81 # include <sys/stat.h>
  82 #endif
  83
  84 #ifdef _WIN32
  85 #define stat    _stat
  86 #define chmod   _chmod
  87 #define open    _open
  88 #define fdopen  _fdopen
  89 #endif
  90
  91 #undef BUFSIZE
  92 #define BUFSIZE 1024
  93 #define RAND_DATA 1024
  94
  95 #ifdef OPENSSL_SYS_VMS
  96 /* This declaration is a nasty hack to get around vms' extension to fopen
  97  * for passing in sharing options being disabled by our /STANDARD=ANSI89 */
  98 static FILE *(*const vms_fopen)(const char *, const char *, ...) =
  99     (FILE *(*)(const char *, const char *, ...))fopen;
 100 #define VMS_OPEN_ATTRS "shr=get,put,upd,del","ctx=bin,stm","rfm=stm","rat=none","mrs=0"
 101 #endif
 102
 103 /* #define RFILE ".rnd" - defined in ../../e_os.h */
 104
 105 /* Note that these functions are intended for seed files only.
 106  * Entropy devices and EGD sockets are handled in rand_unix.c */
 107
 108 int RAND_load_file(const char *file, long bytes)
 109         {
 110         /*-
 111          * If bytes >= 0, read up to 'bytes' bytes.
 112          * if bytes == -1, read complete file.
 113          */
 114
 115         MS_STATIC unsigned char buf[BUFSIZE];
 116         struct stat sb;
 117         int i,ret=0,n;
 118         FILE *in;
 119
 120         if (file == NULL) return(0);
 121
 122 #ifdef PURIFY
 123         /* struct stat can have padding and unused fields that may not be
 124          * initialized in the call to stat(). We need to clear the entire
 125          * structure before calling RAND_add() to avoid complaints from
 126          * applications such as Valgrind.
 127          */
 128         memset(&sb, 0, sizeof(sb));
 129 #endif
 130
 131         if (stat(file,&sb) < 0) return(0);
 132         RAND_add(&sb,sizeof(sb),0.0);
 133         if (bytes == 0) return(ret);
 134
 135 #ifdef OPENSSL_SYS_VMS
 136         in=vms_fopen(file,"rb",VMS_OPEN_ATTRS);
 137 #else
 138         in=fopen(file,"rb");
 139 #endif
 140         if (in == NULL) goto err;
 141 #if defined(S_ISBLK) && defined(S_ISCHR)
 142         if (S_ISBLK(sb.st_mode) || S_ISCHR(sb.st_mode)) {
 143           /* this file is a device. we don't want read an infinite number
 144            * of bytes from a random device, nor do we want to use buffered
 145            * I/O because we will waste system entropy.
 146            */
 147           bytes = (bytes == -1) ? 2048 : bytes; /* ok, is 2048 enough? */
 148           setvbuf(in, NULL, _IONBF, 0); /* don't do buffered reads */
 149         }
 150 #endif
 151         for (;;)
 152                 {
 153                 if (bytes > 0)
 154                         n = (bytes < BUFSIZE)?(int)bytes:BUFSIZE;
 155                 else
 156                         n = BUFSIZE;
 157                 i=fread(buf,1,n,in);
 158                 if (i <= 0) break;
 159 #ifdef PURIFY
 160                 RAND_add(buf,i,(double)i);
 161 #else
 162                 /* even if n != i, use the full array */
 163                 RAND_add(buf,n,(double)i);
 164 #endif
 165                 ret+=i;
 166                 if (bytes > 0)
 167                         {
 168                         bytes-=n;
 169                         if (bytes <= 0) break;
 170                         }
 171                 }
 172         fclose(in);
 173         OPENSSL_cleanse(buf,BUFSIZE);
 174 err:
 175         return(ret);
 176         }
 177
 178 int RAND_write_file(const char *file)
 179         {
 180         unsigned char buf[BUFSIZE];
 181         int i,ret=0,rand_err=0;
 182         FILE *out = NULL;
 183         int n;
 184         struct stat sb;
 185
 186         i=stat(file,&sb);
 187         if (i != -1) {
 188 #if defined(S_ISBLK) && defined(S_ISCHR)
 189           if (S_ISBLK(sb.st_mode) || S_ISCHR(sb.st_mode)) {
 190             /* this file is a device. we don't write back to it.
 191              * we "succeed" on the assumption this is some sort
 192              * of random device. Otherwise attempting to write to
 193              * and chmod the device causes problems.
 194              */
 195             return(1);
 196           }
 197 #endif
 198         }
 199
 200 #if defined(O_CREAT) && !defined(OPENSSL_SYS_WIN32) && !defined(OPENSSL_SYS_VMS)
 201         {
 202         /* For some reason Win32 can't write to files created this way */
 203
 204         /* chmod(..., 0600) is too late to protect the file,
 205          * permissions should be restrictive from the start */
 206         int fd = open(file, O_CREAT, 0600);
 207         if (fd != -1)
 208                 out = fdopen(fd, "wb");
 209         }
 210 #endif
 211
 212 #ifdef OPENSSL_SYS_VMS
 213         /* VMS NOTE: Prior versions of this routine created a _new_
 214          * version of the rand file for each call into this routine, then
 215          * deleted all existing versions named ;-1, and finally renamed
 216          * the current version as ';1'. Under concurrent usage, this
 217          * resulted in an RMS race condition in rename() which could
 218          * orphan files (see vms message help for RMS$_REENT). With the
 219          * fopen() calls below, openssl/VMS now shares the top-level
 220          * version of the rand file. Note that there may still be
 221          * conditions where the top-level rand file is locked. If so, this
 222          * code will then create a new version of the rand file. Without
 223          * the delete and rename code, this can result in ascending file
 224          * versions that stop at version 32767, and this routine will then
 225          * return an error. The remedy for this is to recode the calling
 226          * application to avoid concurrent use of the rand file, or
 227          * synchronize usage at the application level. Also consider
 228          * whether or not you NEED a persistent rand file in a concurrent
 229          * use situation.
 230          */
 231
 232         out = vms_fopen(file,"rb+",VMS_OPEN_ATTRS);
 233         if (out == NULL)
 234                 out = vms_fopen(file,"wb",VMS_OPEN_ATTRS);
 235 #else
 236         if (out == NULL)
 237                 out = fopen(file,"wb");
 238 #endif
 239         if (out == NULL) goto err;
 240
 241 #ifndef NO_CHMOD
 242         chmod(file,0600);
 243 #endif
 244         n=RAND_DATA;
 245         for (;;)
 246                 {
 247                 i=(n > BUFSIZE)?BUFSIZE:n;
 248                 n-=BUFSIZE;
 249                 if (RAND_bytes(buf,i) <= 0)
 250                         rand_err=1;
 251                 i=fwrite(buf,1,i,out);
 252                 if (i <= 0)
 253                         {
 254                         ret=0;
 255                         break;
 256                         }
 257                 ret+=i;
 258                 if (n <= 0) break;
 259                 }
 260
 261         fclose(out);
 262         OPENSSL_cleanse(buf,BUFSIZE);
 263 err:
 264         return (rand_err ? -1 : ret);
 265         }
 266
 267 const char *RAND_file_name(char *buf, size_t size)
 268         {
 269         char *s=NULL;
 270 #ifdef __OpenBSD__
 271         int ok = 0;
 272         struct stat sb;
 273 #endif
 274
 275         if (OPENSSL_issetugid() == 0)
 276                 s=getenv("RANDFILE");
 277         if (s != NULL && *s && strlen(s) + 1 < size)
 278                 {
 279                 if (BUF_strlcpy(buf,s,size) >= size)
 280                         return NULL;
 281                 }
 282         else
 283                 {
 284                 if (OPENSSL_issetugid() == 0)
 285                         s=getenv("HOME");
 286 #ifdef DEFAULT_HOME
 287                 if (s == NULL)
 288                         {
 289                         s = DEFAULT_HOME;
 290                         }
 291 #endif
 292                 if (s && *s && strlen(s)+strlen(RFILE)+2 < size)
 293                         {
 294                         BUF_strlcpy(buf,s,size);
 295 #ifndef OPENSSL_SYS_VMS
 296                         BUF_strlcat(buf,"/",size);
 297 #endif
 298                         BUF_strlcat(buf,RFILE,size);
 299 #ifdef __OpenBSD__
 300                         ok = 1;
 301 #endif
 302                         }
 303                 else
 304                         buf[0] = '\0'; /* no file name */
 305                 }
 306
 307 #ifdef __OpenBSD__
 308         /* given that all random loads just fail if the file can't be
 309          * seen on a stat, we stat the file we're returning, if it
 310          * fails, use /dev/arandom instead. this allows the user to
 311          * use their own source for good random data, but defaults
 312          * to something hopefully decent if that isn't available.
 313          */
 314
 315         if (!ok)
 316                 if (BUF_strlcpy(buf,"/dev/arandom",size) >= size) {
 317                         return(NULL);
 318                 }
 319         if (stat(buf,&sb) == -1)
 320                 if (BUF_strlcpy(buf,"/dev/arandom",size) >= size) {
 321                         return(NULL);
 322                 }
 323
 324 #endif
 325         return(buf);
 326         }