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