See ChangeLog: Fri Nov 27 12:39:29 CET 1998 Werner Koch
[gnupg.git] / cipher / rndlinux.c
1 /* rndlinux.c  -  raw random number for OSes with /dev/random
2  *      Copyright (C) 1998 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_GETHRTIME
31   #include <sys/times.h>
32 #endif
33 #ifdef HAVE_GETTIMEOFDAY
34   #include <sys/times.h>
35 #endif
36 #ifdef HAVE_GETRUSAGE
37   #include <sys/resource.h>
38 #endif
39 #include <string.h>
40 #include <unistd.h>
41 #include <fcntl.h>
42 #include "types.h"
43 #ifdef IS_MODULE
44   #include "g10lib.h"
45   #define _(a) (a)
46 #else
47   #include "util.h"
48   #include "ttyio.h"
49   #include "i18n.h"
50   #include "dynload.h"
51 #endif
52
53 static int open_device( const char *name, int minor );
54 static int gather_random( byte *buffer, size_t *r_length, int level );
55
56 #ifdef IS_MODULE
57 static void tty_printf(const char *fmt, ... )
58 {
59     g10_log_info("tty_printf not available (%s)\n", fmt );
60 }
61 #endif
62
63
64 static void
65 fast_poll( void (*add)(const void*, size_t, int) )
66 {
67   #if HAVE_GETHRTIME
68     {   hrtime_t tv;
69         tv = gethrtime();
70         (*add)( &tv, sizeof(tv), 1 );
71     }
72   #elif HAVE_GETTIMEOFDAY
73     {   struct timeval tv;
74         if( gettimeofday( &tv, NULL ) )
75             BUG();
76         (*add)( &tv.tv_sec, sizeof(tv.tv_sec), 1 );
77         (*add)( &tv.tv_usec, sizeof(tv.tv_usec), 1 );
78     }
79   #else /* use times */
80     {   struct tms buf;
81         times( &buf );
82         (*add)( &buf, sizeof buf, 1 );
83     }
84   #endif
85   #ifdef HAVE_GETRUSAGE
86     {   struct rusage buf;
87         if( getrusage( RUSAGE_SELF, &buf ) )
88             BUG();
89         (*add)( &buf, sizeof buf, 1 );
90         memset( &buf, 0, sizeof buf );
91     }
92   #endif
93 }
94
95
96
97 /****************
98  * Used to open the Linux and xBSD /dev/random devices
99  */
100 static int
101 open_device( const char *name, int minor )
102 {
103     int fd;
104     struct stat sb;
105
106     fd = open( name, O_RDONLY );
107     if( fd == -1 )
108         g10_log_fatal("can't open %s: %s\n", name, strerror(errno) );
109     if( fstat( fd, &sb ) )
110         g10_log_fatal("stat() off %s failed: %s\n", name, strerror(errno) );
111   #if defined(__sparc__) && defined(__linux__)
112     #warning something is wrong with UltraPenguin /dev/random
113   #else
114     if( !S_ISCHR(sb.st_mode) )
115         g10_log_fatal("invalid random device!\n" );
116   #endif
117     return fd;
118 }
119
120
121 static int
122 gather_random( byte *buffer, size_t *r_length, int level )
123 {
124     static int fd_urandom = -1;
125     static int fd_random = -1;
126     int fd;
127     int n;
128     int warn=0;
129     size_t length = *r_length;
130     /* note: we will always return the requested length */
131
132     if( level >= 2 ) {
133         if( fd_random == -1 )
134             fd_random = open_device( NAME_OF_DEV_RANDOM, 8 );
135         fd = fd_random;
136     }
137     else {
138         if( fd_urandom == -1 )
139             fd_urandom = open_device( NAME_OF_DEV_URANDOM, 9 );
140         fd = fd_urandom;
141     }
142     do {
143         fd_set rfds;
144         struct timeval tv;
145         int rc;
146
147         FD_ZERO(&rfds);
148         FD_SET(fd, &rfds);
149         tv.tv_sec = 3;
150         tv.tv_usec = 0;
151         if( !(rc=select(fd+1, &rfds, NULL, NULL, &tv)) ) {
152             if( !warn )
153                 tty_printf( _(
154 "\n"
155 "Not enough random bytes available.  Please do some other work to give\n"
156 "the OS a chance to collect more entropy! (Need %d more bytes)\n"), length );
157             warn = 1;
158             continue;
159         }
160         else if( rc == -1 ) {
161             tty_printf("select() error: %s\n", strerror(errno));
162             continue;
163         }
164
165         do {
166             n = read(fd, buffer, length );
167             if( n >= 0 && n > length ) {
168                 g10_log_error("bogus read from random device (n=%d)\n", n );
169                 n = length;
170             }
171         } while( n == -1 && errno == EINTR );
172         if( n == -1 )
173             g10_log_fatal("read error on random device: %s\n", strerror(errno));
174         assert( n <= length );
175         buffer += n;
176         length -= n;
177     } while( length );
178
179     return 100; /* 100% useful at the requested level */
180 }
181
182
183
184 #ifndef IS_MODULE
185 static
186 #endif
187 const char * const gnupgext_version = "RNDLINUX ($Revision$)";
188
189 static struct {
190     int class;
191     int version;
192     void *func;
193 } func_table[] = {
194     { 40, 1, gather_random },
195     { 41, 1, fast_poll },
196 };
197
198
199
200 /****************
201  * Enumerate the names of the functions together with informations about
202  * this function. Set sequence to an integer with a initial value of 0 and
203  * do not change it.
204  * If what is 0 all kind of functions are returned.
205  * Return values: class := class of function:
206  *                         10 = message digest algorithm info function
207  *                         11 = integer with available md algorithms
208  *                         20 = cipher algorithm info function
209  *                         21 = integer with available cipher algorithms
210  *                         30 = public key algorithm info function
211  *                         31 = integer with available pubkey algorithms
212  *                         40 = get gather_random function
213  *                         41 = get fast_random_poll function
214  *                version = interface version of the function/pointer
215  *                          (currently this is 1 for all functions)
216  */
217
218 #ifndef IS_MODULE
219 static
220 #endif
221 void *
222 gnupgext_enum_func( int what, int *sequence, int *class, int *vers )
223 {
224     void *ret;
225     int i = *sequence;
226
227     do {
228         if ( i >= DIM(func_table) || i < 0 ) {
229             return NULL;
230         }
231         *class = func_table[i].class;
232         *vers  = func_table[i].version;
233         ret = func_table[i].func;
234         i++;
235     } while ( what && what != *class );
236
237     *sequence = i;
238     return ret;
239 }
240
241 #ifndef IS_MODULE
242 void
243 rndlinux_constructor(void)
244 {
245     register_internal_cipher_extension( gnupgext_version,
246                                         gnupgext_enum_func );
247 }
248 #endif
249