f59996c4d8f5aedfa0835f55cb4ad3492c40942b
[libgcrypt.git] / cipher / pubkey.c
1 /* pubkey.c  -  pubkey dispatcher
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 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <errno.h>
26 #include <assert.h>
27 #include "util.h"
28 #include "errors.h"
29 #include "mpi.h"
30 #include "cipher.h"
31 #include "elgamal.h"
32 #include "dsa.h"
33 #include "dynload.h"
34
35
36 #define TABLE_SIZE 10
37
38 struct pubkey_table_s {
39     const char *name;
40     int algo;
41     int npkey;
42     int nskey;
43     int nenc;
44     int nsig;
45     int usage;
46     int (*generate)( int algo, unsigned nbits, MPI *skey, MPI **retfactors );
47     int (*check_secret_key)( int algo, MPI *skey );
48     int (*encrypt)( int algo, MPI *resarr, MPI data, MPI *pkey );
49     int (*decrypt)( int algo, MPI *result, MPI *data, MPI *skey );
50     int (*sign)( int algo, MPI *resarr, MPI data, MPI *skey );
51     int (*verify)( int algo, MPI hash, MPI *data, MPI *pkey,
52                    int (*cmp)(void *, MPI), void *opaquev );
53     unsigned (*get_nbits)( int algo, MPI *pkey );
54 };
55
56 static struct pubkey_table_s pubkey_table[TABLE_SIZE];
57
58
59
60 static int
61 dummy_generate( int algo, unsigned nbits, MPI *skey, MPI **retfactors )
62 { log_bug("no generate() for %d\n", algo ); return G10ERR_PUBKEY_ALGO; }
63
64 static int
65 dummy_check_secret_key( int algo, MPI *skey )
66 { log_bug("no check_secret_key() for %d\n", algo ); return G10ERR_PUBKEY_ALGO; }
67
68 static int
69 dummy_encrypt( int algo, MPI *resarr, MPI data, MPI *pkey )
70 { log_bug("no encrypt() for %d\n", algo ); return G10ERR_PUBKEY_ALGO; }
71
72 static int
73 dummy_decrypt( int algo, MPI *result, MPI *data, MPI *skey )
74 { log_bug("no decrypt() for %d\n", algo ); return G10ERR_PUBKEY_ALGO; }
75
76 static int
77 dummy_sign( int algo, MPI *resarr, MPI data, MPI *skey )
78 { log_bug("no sign() for %d\n", algo ); return G10ERR_PUBKEY_ALGO; }
79
80 static int
81 dummy_verify( int algo, MPI hash, MPI *data, MPI *pkey,
82                 int (*cmp)(void *, MPI), void *opaquev )
83 { log_bug("no verify() for %d\n", algo ); return G10ERR_PUBKEY_ALGO; }
84
85 static unsigned
86 dummy_get_nbits( int algo, MPI *pkey )
87 { log_bug("no get_nbits() for %d\n", algo ); return 0; }
88
89
90 /****************
91  * Put the static entries into the table.
92  */
93 static void
94 setup_pubkey_table()
95 {
96     int i;
97
98     i = 0;
99     pubkey_table[i].algo = PUBKEY_ALGO_ELGAMAL;
100     pubkey_table[i].name = elg_get_info( pubkey_table[i].algo,
101                                          &pubkey_table[i].npkey,
102                                          &pubkey_table[i].nskey,
103                                          &pubkey_table[i].nenc,
104                                          &pubkey_table[i].nsig,
105                                          &pubkey_table[i].usage );
106     pubkey_table[i].generate         = elg_generate;
107     pubkey_table[i].check_secret_key = elg_check_secret_key;
108     pubkey_table[i].encrypt          = elg_encrypt;
109     pubkey_table[i].decrypt          = elg_decrypt;
110     pubkey_table[i].sign             = elg_sign;
111     pubkey_table[i].verify           = elg_verify;
112     pubkey_table[i].get_nbits        = elg_get_nbits;
113     if( !pubkey_table[i].name )
114         BUG();
115     i++;
116     pubkey_table[i].algo = PUBKEY_ALGO_ELGAMAL_E;
117     pubkey_table[i].name = elg_get_info( pubkey_table[i].algo,
118                                          &pubkey_table[i].npkey,
119                                          &pubkey_table[i].nskey,
120                                          &pubkey_table[i].nenc,
121                                          &pubkey_table[i].nsig,
122                                          &pubkey_table[i].usage );
123     pubkey_table[i].generate         = elg_generate;
124     pubkey_table[i].check_secret_key = elg_check_secret_key;
125     pubkey_table[i].encrypt          = elg_encrypt;
126     pubkey_table[i].decrypt          = elg_decrypt;
127     pubkey_table[i].sign             = elg_sign;
128     pubkey_table[i].verify           = elg_verify;
129     pubkey_table[i].get_nbits        = elg_get_nbits;
130     if( !pubkey_table[i].name )
131         BUG();
132     i++;
133     pubkey_table[i].algo = PUBKEY_ALGO_DSA;
134     pubkey_table[i].name = dsa_get_info( pubkey_table[i].algo,
135                                          &pubkey_table[i].npkey,
136                                          &pubkey_table[i].nskey,
137                                          &pubkey_table[i].nenc,
138                                          &pubkey_table[i].nsig,
139                                          &pubkey_table[i].usage );
140     pubkey_table[i].generate         = dsa_generate;
141     pubkey_table[i].check_secret_key = dsa_check_secret_key;
142     pubkey_table[i].encrypt          = dummy_encrypt;
143     pubkey_table[i].decrypt          = dummy_decrypt;
144     pubkey_table[i].sign             = dsa_sign;
145     pubkey_table[i].verify           = dsa_verify;
146     pubkey_table[i].get_nbits        = dsa_get_nbits;
147     if( !pubkey_table[i].name )
148         BUG();
149     i++;
150
151     for( ; i < TABLE_SIZE; i++ )
152         pubkey_table[i].name = NULL;
153 }
154
155
156 /****************
157  * Try to load all modules and return true if new modules are available
158  */
159 static int
160 load_pubkey_modules()
161 {
162     static int initialized = 0;
163     static int done = 0;
164     void *context = NULL;
165     struct pubkey_table_s *ct;
166     int ct_idx;
167     int i;
168     const char *name;
169     int any = 0;
170
171
172     if( !initialized ) {
173         setup_pubkey_table();
174         initialized = 1;
175         return 1;
176     }
177     if( done )
178         return 0;
179     done = 1;
180     for(ct_idx=0, ct = pubkey_table; ct_idx < TABLE_SIZE; ct_idx++,ct++ ) {
181         if( !ct->name )
182             break;
183     }
184     if( ct_idx >= TABLE_SIZE-1 )
185         BUG(); /* table already full */
186     /* now load all extensions */
187     while( (name = enum_gnupgext_pubkeys( &context, &ct->algo,
188                                 &ct->npkey, &ct->nskey, &ct->nenc,
189                                 &ct->nsig,  &ct->usage,
190                                 &ct->generate,
191                                 &ct->check_secret_key,
192                                 &ct->encrypt,
193                                 &ct->decrypt,
194                                 &ct->sign,
195                                 &ct->verify,
196                                 &ct->get_nbits )) ) {
197         for(i=0; pubkey_table[i].name; i++ )
198             if( pubkey_table[i].algo == ct->algo )
199                 break;
200         if( pubkey_table[i].name ) {
201             log_info("skipping pubkey %d: already loaded\n", ct->algo );
202             continue;
203         }
204
205         if( !ct->generate  )  ct->generate = dummy_generate;
206         if( !ct->check_secret_key )  ct->check_secret_key =
207                                                     dummy_check_secret_key;
208         if( !ct->encrypt   )  ct->encrypt  = dummy_encrypt;
209         if( !ct->decrypt   )  ct->decrypt  = dummy_decrypt;
210         if( !ct->sign      )  ct->sign     = dummy_sign;
211         if( !ct->verify    )  ct->verify   = dummy_verify;
212         if( !ct->get_nbits )  ct->get_nbits= dummy_get_nbits;
213         /* put it into the table */
214         if( g10_opt_verbose > 1 )
215             log_info("loaded pubkey %d (%s)\n", ct->algo, name);
216         ct->name = name;
217         ct_idx++;
218         ct++;
219         any = 1;
220         /* check whether there are more available table slots */
221         if( ct_idx >= TABLE_SIZE-1 ) {
222             log_info("pubkey table full; ignoring other extensions\n");
223             break;
224         }
225     }
226     enum_gnupgext_pubkeys( &context, NULL, NULL, NULL, NULL, NULL, NULL,
227                                NULL, NULL, NULL, NULL, NULL, NULL, NULL );
228     return any;
229 }
230
231
232 /****************
233  * Map a string to the pubkey algo
234  */
235 int
236 string_to_pubkey_algo( const char *string )
237 {
238     int i;
239     const char *s;
240
241     do {
242         for(i=0; (s=pubkey_table[i].name); i++ )
243             if( !stricmp( s, string ) )
244                 return pubkey_table[i].algo;
245     } while( load_pubkey_modules() );
246     return 0;
247 }
248
249
250 /****************
251  * Map a pubkey algo to a string
252  */
253 const char *
254 pubkey_algo_to_string( int algo )
255 {
256     int i;
257
258     do {
259         for(i=0; pubkey_table[i].name; i++ )
260             if( pubkey_table[i].algo == algo )
261                 return pubkey_table[i].name;
262     } while( load_pubkey_modules() );
263     return NULL;
264 }
265
266
267
268 int
269 check_pubkey_algo( int algo )
270 {
271     return check_pubkey_algo2( algo, 0 );
272 }
273
274 /****************
275  * a usage of 0 means: don't care
276  */
277 int
278 check_pubkey_algo2( int algo, unsigned usage )
279 {
280     int i;
281
282     do {
283         for(i=0; pubkey_table[i].name; i++ )
284             if( pubkey_table[i].algo == algo ) {
285                 if( (usage & 1) && !(pubkey_table[i].usage & 1) )
286                     return G10ERR_WR_PUBKEY_ALGO;
287                 if( (usage & 2) && !(pubkey_table[i].usage & 2) )
288                     return G10ERR_WR_PUBKEY_ALGO;
289                 return 0; /* okay */
290             }
291     } while( load_pubkey_modules() );
292     return G10ERR_PUBKEY_ALGO;
293 }
294
295
296
297
298 /****************
299  * Return the number of public key material numbers
300  */
301 int
302 pubkey_get_npkey( int algo )
303 {
304     int i;
305     do {
306         for(i=0; pubkey_table[i].name; i++ )
307             if( pubkey_table[i].algo == algo )
308                 return pubkey_table[i].npkey;
309     } while( load_pubkey_modules() );
310     return 0;
311 }
312
313 /****************
314  * Return the number of secret key material numbers
315  */
316 int
317 pubkey_get_nskey( int algo )
318 {
319     int i;
320     do {
321         for(i=0; pubkey_table[i].name; i++ )
322             if( pubkey_table[i].algo == algo )
323                 return pubkey_table[i].nskey;
324     } while( load_pubkey_modules() );
325     return 0;
326 }
327
328 /****************
329  * Return the number of signature material numbers
330  */
331 int
332 pubkey_get_nsig( int algo )
333 {
334     int i;
335     do {
336         for(i=0; pubkey_table[i].name; i++ )
337             if( pubkey_table[i].algo == algo )
338                 return pubkey_table[i].nsig;
339     } while( load_pubkey_modules() );
340     return 0;
341 }
342
343 /****************
344  * Return the number of encryption material numbers
345  */
346 int
347 pubkey_get_nenc( int algo )
348 {
349     int i;
350     do {
351         for(i=0; pubkey_table[i].name; i++ )
352             if( pubkey_table[i].algo == algo )
353                 return pubkey_table[i].nenc;
354     } while( load_pubkey_modules() );
355     return 0;
356 }
357
358 /****************
359  * Get the number of nbits from the public key
360  */
361 unsigned
362 pubkey_nbits( int algo, MPI *pkey )
363 {
364     int i;
365
366     do {
367         for(i=0; pubkey_table[i].name; i++ )
368             if( pubkey_table[i].algo == algo )
369                 return (*pubkey_table[i].get_nbits)( algo, pkey );
370     } while( load_pubkey_modules() );
371     return 0;
372 }
373
374
375 int
376 pubkey_generate( int algo, unsigned nbits, MPI *skey, MPI **retfactors )
377 {
378     int i;
379
380     do {
381         for(i=0; pubkey_table[i].name; i++ )
382             if( pubkey_table[i].algo == algo )
383                 return (*pubkey_table[i].generate)( algo, nbits,
384                                                     skey, retfactors );
385     } while( load_pubkey_modules() );
386     return G10ERR_PUBKEY_ALGO;
387 }
388
389
390 int
391 pubkey_check_secret_key( int algo, MPI *skey )
392 {
393     int i;
394
395     do {
396         for(i=0; pubkey_table[i].name; i++ )
397             if( pubkey_table[i].algo == algo )
398                 return (*pubkey_table[i].check_secret_key)( algo, skey );
399     } while( load_pubkey_modules() );
400     return G10ERR_PUBKEY_ALGO;
401 }
402
403
404 /****************
405  * This is the interface to the public key encryption.
406  * Encrypt DATA with PKEY and put it into RESARR which
407  * should be an array of MPIs of size PUBKEY_MAX_NENC (or less if the
408  * algorithm allows this - check with pubkey_get_nenc() )
409  */
410 int
411 pubkey_encrypt( int algo, MPI *resarr, MPI data, MPI *pkey )
412 {
413     int i, rc;
414
415     /* FIXME: check that data fits into the key (in xxx_encrypt)*/
416
417     if( DBG_CIPHER ) {
418         log_debug("pubkey_encrypt: algo=%d\n", algo );
419         for(i=0; i < pubkey_get_npkey(algo); i++ )
420             log_mpidump("  pkey:", pkey[i] );
421         log_mpidump("  data:", data );
422     }
423
424     do {
425         for(i=0; pubkey_table[i].name; i++ )
426             if( pubkey_table[i].algo == algo ) {
427                 rc = (*pubkey_table[i].encrypt)( algo, resarr, data, pkey );
428                 goto ready;
429             }
430     } while( load_pubkey_modules() );
431     rc = G10ERR_PUBKEY_ALGO;
432   ready:
433     if( !rc && DBG_CIPHER ) {
434         for(i=0; i < pubkey_get_nenc(algo); i++ )
435             log_mpidump("  encr:", resarr[i] );
436     }
437     return rc;
438 }
439
440
441
442 /****************
443  * This is the interface to the public key decryption.
444  * ALGO gives the algorithm to use and this implicitly determines
445  * the size of the arrays.
446  * result is a pointer to a mpi variable which will receive a
447  * newly allocated mpi or NULL in case of an error.
448  */
449 int
450 pubkey_decrypt( int algo, MPI *result, MPI *data, MPI *skey )
451 {
452     int i, rc;
453
454     *result = NULL; /* so the caller can always do an mpi_free */
455     if( DBG_CIPHER ) {
456         log_debug("pubkey_decrypt: algo=%d\n", algo );
457         for(i=0; i < pubkey_get_nskey(algo); i++ )
458             log_mpidump("  skey:", skey[i] );
459         for(i=0; i < pubkey_get_nenc(algo); i++ )
460             log_mpidump("  data:", data[i] );
461     }
462
463     do {
464         for(i=0; pubkey_table[i].name; i++ )
465             if( pubkey_table[i].algo == algo ) {
466                 rc = (*pubkey_table[i].decrypt)( algo, result, data, skey );
467                 goto ready;
468             }
469     } while( load_pubkey_modules() );
470     rc = G10ERR_PUBKEY_ALGO;
471   ready:
472     if( !rc && DBG_CIPHER ) {
473         log_mpidump(" plain:", *result );
474     }
475     return rc;
476 }
477
478
479 /****************
480  * This is the interface to the public key signing.
481  * Sign hash with skey and put the result into resarr which
482  * should be an array of MPIs of size PUBKEY_MAX_NSIG (or less if the
483  * algorithm allows this - check with pubkey_get_nsig() )
484  */
485 int
486 pubkey_sign( int algo, MPI *resarr, MPI data, MPI *skey )
487 {
488     int i, rc;
489
490     if( DBG_CIPHER ) {
491         log_debug("pubkey_sign: algo=%d\n", algo );
492         for(i=0; i < pubkey_get_nskey(algo); i++ )
493             log_mpidump("  skey:", skey[i] );
494         log_mpidump("  data:", data );
495     }
496
497     do {
498         for(i=0; pubkey_table[i].name; i++ )
499             if( pubkey_table[i].algo == algo ) {
500                 rc = (*pubkey_table[i].sign)( algo, resarr, data, skey );
501                 goto ready;
502             }
503     } while( load_pubkey_modules() );
504     rc = G10ERR_PUBKEY_ALGO;
505   ready:
506     if( !rc && DBG_CIPHER ) {
507         for(i=0; i < pubkey_get_nsig(algo); i++ )
508             log_mpidump("   sig:", resarr[i] );
509     }
510     return rc;
511 }
512
513 /****************
514  * Verify a public key signature.
515  * Return 0 if the signature is good
516  */
517 int
518 pubkey_verify( int algo, MPI hash, MPI *data, MPI *pkey,
519                     int (*cmp)(void *, MPI), void *opaquev )
520 {
521     int i, rc;
522
523     do {
524         for(i=0; pubkey_table[i].name; i++ )
525             if( pubkey_table[i].algo == algo ) {
526                 rc = (*pubkey_table[i].verify)( algo, hash, data, pkey,
527                                                             cmp, opaquev );
528                 goto ready;
529             }
530     } while( load_pubkey_modules() );
531     rc = G10ERR_PUBKEY_ALGO;
532   ready:
533     return rc;
534 }
535