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