* rndlinux.c: Removed HAVE_LINUX_RANDOM_H conditional because it
[gnupg.git] / cipher / rndlinux.c
1 /* rndlinux.c  -  raw random number for OSes with /dev/random
2  *      Copyright (C) 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21
22 #include <config.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <assert.h>
26 #include <errno.h>
27 #include <sys/time.h>
28 #include <sys/types.h>
29 #include <sys/stat.h>
30 #ifdef HAVE_GETTIMEOFDAY
31   #include <sys/times.h>
32 #endif
33 #include <string.h>
34 #include <unistd.h>
35 #include <fcntl.h>
36 #if 0
37     #include <sys/ioctl.h>
38     #include <asm/types.h>
39     #include <linux/random.h>
40 #endif
41 #include "types.h"
42 #include "util.h"
43 #include "ttyio.h"
44 #include "dynload.h"
45
46 #ifdef IS_MODULE
47   #define _(a) (a)
48 #else
49   #include "i18n.h"
50 #endif
51
52 static int open_device( const char *name, int minor );
53 static int gather_random( void (*add)(const void*, size_t, int), int requester,
54                                           size_t length, int level );
55
56 #if 0
57 #ifdef HAVE_DEV_RANDOM_IOCTL
58 static ulong
59 get_entropy_count( int fd )
60 {
61     ulong count;
62
63     if( ioctl( fd, RNDGETENTCNT, &count ) == -1 )
64         g10_log_fatal("ioctl(RNDGETENTCNT) failed: %s\n", strerror(errno) );
65     return count;
66 }
67 #endif
68 #endif
69
70 /****************
71  * Used to open the /dev/random devices (Linux, xBSD, Solaris (if it exists), ...)
72  */
73 static int
74 open_device( const char *name, int minor )
75 {
76     int fd;
77     struct stat sb;
78
79     fd = open( name, O_RDONLY );
80     if( fd == -1 )
81         g10_log_fatal("can't open %s: %s\n", name, strerror(errno) );
82     if( fstat( fd, &sb ) )
83         g10_log_fatal("stat() off %s failed: %s\n", name, strerror(errno) );
84     /* Don't check device type for better portability */
85     /*  if( (!S_ISCHR(sb.st_mode)) && (!S_ISFIFO(sb.st_mode)) )
86           g10_log_fatal("invalid random device!\n" ); */
87     return fd;
88 }
89
90
91 /****************
92  * Note:  Using a level of 0 should never block and better add nothing
93  * to the pool.  This is easy to accomplish with /dev/urandom.
94  */
95 static int
96 gather_random( void (*add)(const void*, size_t, int), int requester,
97                                           size_t length, int level )
98 {
99     static int fd_urandom = -1;
100     static int fd_random = -1;
101     int fd;
102     int n;
103     int warn=0;
104     byte buffer[768];
105
106     if( level >= 2 ) {
107         if( fd_random == -1 )
108             fd_random = open_device( NAME_OF_DEV_RANDOM, 8 );
109         fd = fd_random;
110     }
111     else {
112         /* this will also be used for elve 0 but by using /dev/urandom
113          * we can be sure that oit will never block. */
114         if( fd_urandom == -1 )
115             fd_urandom = open_device( NAME_OF_DEV_URANDOM, 9 );
116         fd = fd_urandom;
117     }
118
119   #if 0
120   #ifdef HAVE_DEV_RANDOM_IOCTL
121     g10_log_info("entropy count of %d is %lu\n", fd, get_entropy_count(fd) );
122   #endif
123   #endif
124     while( length ) {
125         fd_set rfds;
126         struct timeval tv;
127         int rc;
128
129         FD_ZERO(&rfds);
130         FD_SET(fd, &rfds);
131         tv.tv_sec = 3;
132         tv.tv_usec = 0;
133         if( !(rc=select(fd+1, &rfds, NULL, NULL, &tv)) ) {
134             if( !warn )
135               #ifdef IS_MODULE
136                 fprintf(stderr,
137               #else
138                 tty_printf(
139               #endif
140 _("\n"
141 "Not enough random bytes available.  Please do some other work to give\n"
142 "the OS a chance to collect more entropy! (Need %d more bytes)\n"), (int)length );
143             warn = 1;
144             continue;
145         }
146         else if( rc == -1 ) {
147           #ifdef IS_MODULE
148             fprintf(stderr,
149           #else
150             tty_printf(
151           #endif
152                        "select() error: %s\n", strerror(errno));
153             continue;
154         }
155
156         do {
157             int nbytes = length < sizeof(buffer)? length : sizeof(buffer);
158             n = read(fd, buffer, nbytes );
159             if( n >= 0 && n > nbytes ) {
160                 g10_log_error("bogus read from random device (n=%d)\n", n );
161                 n = nbytes;
162             }
163         } while( n == -1 && errno == EINTR );
164         if( n == -1 )
165             g10_log_fatal("read error on random device: %s\n", strerror(errno));
166         (*add)( buffer, n, requester );
167         length -= n;
168     }
169     memset(buffer, 0, sizeof(buffer) );
170
171     return 0; /* success */
172 }
173
174
175
176 #ifndef IS_MODULE
177 static
178 #endif
179 const char * const gnupgext_version = "RNDLINUX ($Revision$)";
180
181 static struct {
182     int class;
183     int version;
184     int (*func)(void);
185 } func_table[] = {
186     { 40, 1, (int (*)(void))gather_random },
187 };
188
189
190
191 /****************
192  * Enumerate the names of the functions together with informations about
193  * this function. Set sequence to an integer with a initial value of 0 and
194  * do not change it.
195  * If what is 0 all kind of functions are returned.
196  * Return values: class := class of function:
197  *                         10 = message digest algorithm info function
198  *                         11 = integer with available md algorithms
199  *                         20 = cipher algorithm info function
200  *                         21 = integer with available cipher algorithms
201  *                         30 = public key algorithm info function
202  *                         31 = integer with available pubkey algorithms
203  *                         40 = get gather_random function
204  *                         41 = get fast_random_poll function
205  *                version = interface version of the function/pointer
206  *                          (currently this is 1 for all functions)
207  */
208
209 #ifndef IS_MODULE
210 static
211 #endif
212 void *
213 gnupgext_enum_func( int what, int *sequence, int *class, int *vers )
214 {
215     void *ret;
216     int i = *sequence;
217
218     do {
219         if ( i >= DIM(func_table) || i < 0 ) {
220             return NULL;
221         }
222         *class = func_table[i].class;
223         *vers  = func_table[i].version;
224         ret = func_table[i].func;
225         i++;
226     } while ( what && what != *class );
227
228     *sequence = i;
229     return ret;
230 }
231
232 #ifndef IS_MODULE
233 void
234 rndlinux_constructor(void)
235 {
236     register_internal_cipher_extension( gnupgext_version,
237                                         gnupgext_enum_func );
238 }
239 #endif
240