Use poll() when possible to gather Unix randomness entropy
[openssl.git] / crypto / rand / rand_unix.c
1 /* crypto/rand/rand_unix.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  * Copyright (c) 1998-2000 The OpenSSL Project.  All rights reserved.
60  *
61  * Redistribution and use in source and binary forms, with or without
62  * modification, are permitted provided that the following conditions
63  * are met:
64  *
65  * 1. Redistributions of source code must retain the above copyright
66  *    notice, this list of conditions and the following disclaimer. 
67  *
68  * 2. Redistributions in binary form must reproduce the above copyright
69  *    notice, this list of conditions and the following disclaimer in
70  *    the documentation and/or other materials provided with the
71  *    distribution.
72  *
73  * 3. All advertising materials mentioning features or use of this
74  *    software must display the following acknowledgment:
75  *    "This product includes software developed by the OpenSSL Project
76  *    for use in the OpenSSL Toolkit. (http://www.openssl.org/)"
77  *
78  * 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to
79  *    endorse or promote products derived from this software without
80  *    prior written permission. For written permission, please contact
81  *    openssl-core@openssl.org.
82  *
83  * 5. Products derived from this software may not be called "OpenSSL"
84  *    nor may "OpenSSL" appear in their names without prior written
85  *    permission of the OpenSSL Project.
86  *
87  * 6. Redistributions of any form whatsoever must retain the following
88  *    acknowledgment:
89  *    "This product includes software developed by the OpenSSL Project
90  *    for use in the OpenSSL Toolkit (http://www.openssl.org/)"
91  *
92  * THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY
93  * EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
94  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
95  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE OpenSSL PROJECT OR
96  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
97  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
98  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
99  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
100  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
101  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
102  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
103  * OF THE POSSIBILITY OF SUCH DAMAGE.
104  * ====================================================================
105  *
106  * This product includes cryptographic software written by Eric Young
107  * (eay@cryptsoft.com).  This product includes software written by Tim
108  * Hudson (tjh@cryptsoft.com).
109  *
110  */
111 #include <stdio.h>
112
113 #define USE_SOCKETS
114 #include "e_os.h"
115 #include "cryptlib.h"
116 #include <openssl/rand.h>
117 #include "rand_lcl.h"
118
119 #if !(defined(OPENSSL_SYS_WINDOWS) || defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_VMS) || defined(OPENSSL_SYS_OS2) || defined(OPENSSL_SYS_VXWORKS) || defined(OPENSSL_SYS_NETWARE)) 
120
121 #include <sys/types.h>
122 #include <sys/time.h>
123 #include <sys/times.h>
124 #include <sys/stat.h>
125 #include <fcntl.h>
126 #include <unistd.h>
127 #include <time.h>
128
129 #if defined(OPENSSL_SYS_LINUX)
130  /* lets use poll() */
131 # include <sys/poll.h>
132 # define IOWAIT_VARS            struct pollfd pset; struct timeval t
133 # define IOWAIT_INIT(f, t)      do {                                    \
134                                         pset.fd = (f);                  \
135                                         pset.events = POLLIN;           \
136                                         pset.revents = 0;               \
137                                         (t)->tv_sec = 0;                \
138                                         (t)->tv_usec = 10*1000;         \
139                                         /* Spend 10ms on each file. */  \
140                                 } while(0)
141 # define IOWAIT_FUNC(f, t)      poll(&pset, 1, ((t)->tv_sec * 1000) + ((t)->tv_usec / 1000))
142 # define IOWAIT_CHECK(f)        ((pset.revents & POLLIN) != 0)
143 #else
144  /* lets use select() */
145
146  /* For each platform we could do with making a guess at
147   *  how many FDs we support.  With glibc/Linux its possible
148   *  to use FD_SETSIZE directly, but this may not be very
149   *  portable. Another options was to use _POSIX_OPEN_MAX
150   *  but that value is a tad dull on modern hardware.  So
151   *  I ended up trying sizeof(fd_set)*8 which should be
152   *  closer to the real value.
153   * If this causes a problem on your platform because we
154   *  can not guess correctly then set it to zero.
155   */
156 # if defined(FD_SETSIZE)
157 #  define IOWAIT_FD_SETSIZE     (FD_SETSIZE)
158 # else
159   /* fallback method */
160 #  define IOWAIT_FD_SETSIZE     (sizeof(fd_set) * 8)
161 # endif
162 # define IOWAIT_VARS            fd_set fset; struct timeval t
163 # define IOWAIT_INIT(f, t)      do {                                    \
164                                         FD_ZERO(&fset);                 \
165                                         if(IOWAIT_FD_SETSIZE > 0        \
166                                            && (f) >= IOWAIT_FD_SETSIZE) \
167                                                 { break; }              \
168                                         FD_SET((f), &fset);             \
169                                         (t)->tv_sec = 0;                \
170                                         (t)->tv_usec = 10*1000;         \
171                                         /* Spend 10ms on each file. */  \
172                                 } while(0)
173 # define IOWAIT_FUNC(f, t)      select((f)+1,&fset,NULL,NULL,(t))
174 # define IOWAIT_CHECK(f)        FD_ISSET((f), &fset)
175 #endif
176
177 #ifdef __OpenBSD__
178 int RAND_poll(void)
179 {
180         u_int32_t rnd = 0, i;
181         unsigned char buf[ENTROPY_NEEDED];
182
183         for (i = 0; i < sizeof(buf); i++) {
184                 if (i % 4 == 0)
185                         rnd = arc4random();
186                 buf[i] = rnd;
187                 rnd >>= 8;
188         }
189         RAND_add(buf, sizeof(buf), ENTROPY_NEEDED);
190         memset(buf, 0, sizeof(buf));
191
192         return 1;
193 }
194 #else
195 int RAND_poll(void)
196 {
197         unsigned long l;
198         pid_t curr_pid = getpid();
199 #if defined(DEVRANDOM) || defined(DEVRANDOM_EGD)
200         unsigned char tmpbuf[ENTROPY_NEEDED];
201         int n = 0;
202 #endif
203 #ifdef DEVRANDOM
204         static const char *randomfiles[] = { DEVRANDOM };
205         struct stat randomstats[sizeof(randomfiles)/sizeof(randomfiles[0])];
206         int fd;
207         unsigned int i;
208 #endif
209 #ifdef DEVRANDOM_EGD
210         static const char *egdsockets[] = { DEVRANDOM_EGD, NULL };
211         const char **egdsocket = NULL;
212 #endif
213
214 #ifdef DEVRANDOM
215         memset(randomstats,0,sizeof(randomstats));
216         /* Use a random entropy pool device. Linux, FreeBSD and OpenBSD
217          * have this. Use /dev/urandom if you can as /dev/random may block
218          * if it runs out of random entries.  */
219
220         for (i = 0; (i < sizeof(randomfiles)/sizeof(randomfiles[0])) &&
221                         (n < ENTROPY_NEEDED); i++)
222                 {
223                 if ((fd = open(randomfiles[i], O_RDONLY
224 #ifdef O_NONBLOCK
225                         |O_NONBLOCK
226 #endif
227 #ifdef O_BINARY
228                         |O_BINARY
229 #endif
230 #ifdef O_NOCTTY /* If it happens to be a TTY (god forbid), do not make it
231                    our controlling tty */
232                         |O_NOCTTY
233 #endif
234                         )) >= 0)
235                         {
236                         int r;
237                         unsigned int j;
238                         IOWAIT_VARS;
239                         struct stat *st=&randomstats[i];
240
241                         /* Avoid using same input... Used to be O_NOFOLLOW
242                          * above, but it's not universally appropriate... */
243                         if (fstat(fd,st) != 0)  { close(fd); continue; }
244                         for (j=0;j<i;j++)
245                                 {
246                                 if (randomstats[j].st_ino==st->st_ino &&
247                                     randomstats[j].st_dev==st->st_dev)
248                                         break;
249                                 }
250                         if (j<i)                { close(fd); continue; }
251
252                         do
253                                 {
254 #if defined(OPENSSL_SYS_BEOS_R5)
255                                 /* select() is broken in BeOS R5, so we simply 
256                                  *  try to read something and snooze if we couldn't: */
257                                 r=read(fd,(unsigned char *)tmpbuf+n,
258                                        ENTROPY_NEEDED-n);
259                                 if (r > 0)
260                                         n += r;
261                                 else if (r == 0)
262                                         snooze(t.tv_usec);
263 #else
264                                 IOWAIT_INIT(fd, &t);
265                                 r = -1;
266
267                                 if (IOWAIT_FUNC(fd, &t) < 0)
268                                         t.tv_usec=0;
269                                 else if (IOWAIT_CHECK(fd))
270                                         {
271                                         r=read(fd,(unsigned char *)tmpbuf+n,
272                                                ENTROPY_NEEDED-n);
273                                         if (r > 0)
274                                                 n += r;
275                                         }
276 #endif
277                                 /* Some Unixen will update t, some
278                                    won't.  For those who won't, give
279                                    up here, otherwise, we will do
280                                    this once again for the remaining
281                                    time. */
282                                 if (t.tv_usec == 10*1000)
283                                         t.tv_usec=0;
284                                 }
285                         while ((r > 0 || (errno == EINTR || errno == EAGAIN))
286                                 && t.tv_usec != 0 && n < ENTROPY_NEEDED);
287
288                         close(fd);
289                         }
290                 }
291 #endif
292
293 #ifdef DEVRANDOM_EGD
294         /* Use an EGD socket to read entropy from an EGD or PRNGD entropy
295          * collecting daemon. */
296
297         for (egdsocket = egdsockets; *egdsocket && n < ENTROPY_NEEDED; egdsocket++)
298                 {
299                 int r;
300
301                 r = RAND_query_egd_bytes(*egdsocket, (unsigned char *)tmpbuf+n,
302                                          ENTROPY_NEEDED-n);
303                 if (r > 0)
304                         n += r;
305                 }
306 #endif
307
308 #if defined(DEVRANDOM) || defined(DEVRANDOM_EGD)
309         if (n > 0)
310                 {
311                 RAND_add(tmpbuf,sizeof tmpbuf,(double)n);
312                 OPENSSL_cleanse(tmpbuf,n);
313                 }
314 #endif
315
316         /* put in some default random data, we need more than just this */
317         l=curr_pid;
318         RAND_add(&l,sizeof(l),0.0);
319         l=getuid();
320         RAND_add(&l,sizeof(l),0.0);
321
322         l=time(NULL);
323         RAND_add(&l,sizeof(l),0.0);
324
325 #if defined(OPENSSL_SYS_BEOS)
326         {
327         system_info sysInfo;
328         get_system_info(&sysInfo);
329         RAND_add(&sysInfo,sizeof(sysInfo),0);
330         }
331 #endif
332
333 #if defined(DEVRANDOM) || defined(DEVRANDOM_EGD)
334         return 1;
335 #else
336         return 0;
337 #endif
338 }
339
340 #endif
341 #endif
342
343 #if defined(OPENSSL_SYS_VXWORKS)
344 int RAND_poll(void)
345 {
346     return 0;
347 }
348 #endif