* keygen.c (ask_algo): Remove ability to generate Elgamal sign+encrypt
[gnupg.git] / g10 / getkey.c
1 /* getkey.c -  Get a key from the database
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002,
3  *               2003 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  */
21
22 #include <config.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <assert.h>
27 #include <ctype.h>
28 #include "util.h"
29 #include "packet.h"
30 #include "memory.h"
31 #include "iobuf.h"
32 #include "keydb.h"
33 #include "options.h"
34 #include "main.h"
35 #include "trustdb.h"
36 #include "i18n.h"
37
38 #define MAX_PK_CACHE_ENTRIES   200
39 #define MAX_UID_CACHE_ENTRIES  200
40
41 #if MAX_PK_CACHE_ENTRIES < 2
42 #error We need the cache for key creation
43 #endif
44
45
46 struct getkey_ctx_s {
47     int exact;
48     KBNODE keyblock;
49     KBPOS  kbpos;
50     KBNODE found_key; /* pointer into some keyblock */
51     int last_rc;
52     int req_usage;
53     int req_algo;
54     KEYDB_HANDLE kr_handle;
55     int not_allocated;
56     int nitems;
57     KEYDB_SEARCH_DESC items[1];
58 };
59
60 #if 0
61 static struct {
62     int any;
63     int okay_count;
64     int nokey_count;
65     int error_count;
66 } lkup_stats[21];
67 #endif
68
69 typedef struct keyid_list {
70     struct keyid_list *next;
71     u32 keyid[2];
72 } *keyid_list_t;
73
74
75 #if MAX_PK_CACHE_ENTRIES
76   typedef struct pk_cache_entry {
77       struct pk_cache_entry *next;
78       u32 keyid[2];
79       PKT_public_key *pk;
80   } *pk_cache_entry_t;
81   static pk_cache_entry_t pk_cache;
82   static int pk_cache_entries;   /* number of entries in pk cache */
83   static int pk_cache_disabled;
84 #endif
85
86 #if MAX_UID_CACHE_ENTRIES < 5
87 #error we really need the userid cache
88 #endif
89 typedef struct user_id_db {
90     struct user_id_db *next;
91     keyid_list_t keyids;
92     int len;
93     char name[1];
94 } *user_id_db_t;
95 static user_id_db_t user_id_db;
96 static int uid_cache_entries;   /* number of entries in uid cache */
97
98 static void merge_selfsigs( KBNODE keyblock );
99 static int lookup( GETKEY_CTX ctx, KBNODE *ret_keyblock, int secmode );
100
101 #if 0
102 static void
103 print_stats()
104 {
105     int i;
106     for(i=0; i < DIM(lkup_stats); i++ ) {
107         if( lkup_stats[i].any )
108             fprintf(stderr,
109                     "lookup stats: mode=%-2d  ok=%-6d  nokey=%-6d  err=%-6d\n",
110                     i,
111                     lkup_stats[i].okay_count,
112                     lkup_stats[i].nokey_count,
113                     lkup_stats[i].error_count );
114     }
115 }
116 #endif
117
118
119 void
120 cache_public_key( PKT_public_key *pk )
121 {
122 #if MAX_PK_CACHE_ENTRIES
123     pk_cache_entry_t ce;
124     u32 keyid[2];
125
126     if( pk_cache_disabled )
127         return;
128
129     if( pk->dont_cache )
130         return;
131
132     if( is_ELGAMAL(pk->pubkey_algo)
133         || pk->pubkey_algo == PUBKEY_ALGO_DSA
134         || is_RSA(pk->pubkey_algo) ) {
135         keyid_from_pk( pk, keyid );
136     }
137     else
138         return; /* don't know how to get the keyid */
139
140     for( ce = pk_cache; ce; ce = ce->next )
141         if( ce->keyid[0] == keyid[0] && ce->keyid[1] == keyid[1] ) {
142             if( DBG_CACHE )
143                 log_debug("cache_public_key: already in cache\n");
144             return;
145         }
146
147     if( pk_cache_entries >= MAX_PK_CACHE_ENTRIES ) {
148         /* fixme: use another algorithm to free some cache slots */
149         pk_cache_disabled=1;
150         if( opt.verbose > 1 )
151             log_info(_("too many entries in pk cache - disabled\n"));
152         return;
153     }
154     pk_cache_entries++;
155     ce = m_alloc( sizeof *ce );
156     ce->next = pk_cache;
157     pk_cache = ce;
158     ce->pk = copy_public_key( NULL, pk );
159     ce->keyid[0] = keyid[0];
160     ce->keyid[1] = keyid[1];
161 #endif
162 }
163
164
165 /*
166  * Return the user ID from the given keyblock.
167  * We use the primary uid flag which has been set by the merge_selfsigs
168  * function.  The returned value is only valid as long as then given
169  * keyblock is not changed
170  */
171 static const char *
172 get_primary_uid ( KBNODE keyblock, size_t *uidlen )
173 {
174     KBNODE k;
175     const char *s;
176
177     for (k=keyblock; k; k=k->next ) {
178         if ( k->pkt->pkttype == PKT_USER_ID
179              && !k->pkt->pkt.user_id->attrib_data
180              && k->pkt->pkt.user_id->is_primary ) {
181             *uidlen = k->pkt->pkt.user_id->len;
182             return k->pkt->pkt.user_id->name;
183         }
184     } 
185     /* fixme: returning translatable constants instead of a user ID is 
186      * not good because they are probably not utf-8 encoded. */
187     s = _("[User id not found]");
188     *uidlen = strlen (s);
189     return s;
190 }
191
192
193 static void
194 release_keyid_list ( keyid_list_t k )
195 {
196     while (  k ) {
197         keyid_list_t k2 = k->next;
198         m_free (k);
199         k = k2;
200     }
201 }
202
203 /****************
204  * Store the association of keyid and userid
205  * Feed only public keys to this function.
206  */
207 static void
208 cache_user_id( KBNODE keyblock )
209 {
210     user_id_db_t r;
211     const char *uid;
212     size_t uidlen;
213     keyid_list_t keyids = NULL;
214     KBNODE k;
215
216     for (k=keyblock; k; k = k->next ) {
217         if ( k->pkt->pkttype == PKT_PUBLIC_KEY
218              || k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
219             keyid_list_t a = m_alloc_clear ( sizeof *a );
220             /* Hmmm: For a long list of keyids it might be an advantage
221              * to append the keys */
222             keyid_from_pk( k->pkt->pkt.public_key, a->keyid );
223             /* first check for duplicates */
224             for(r=user_id_db; r; r = r->next ) {
225                 keyid_list_t b = r->keyids;
226                 for ( b = r->keyids; b; b = b->next ) {
227                     if( b->keyid[0] == a->keyid[0]
228                         && b->keyid[1] == a->keyid[1] ) {
229                         if( DBG_CACHE )
230                             log_debug("cache_user_id: already in cache\n");
231                         release_keyid_list ( keyids );
232                         m_free ( a );
233                         return;
234                     }
235                 }
236             }
237             /* now put it into the cache */
238             a->next = keyids;
239             keyids = a;
240         }
241     }
242     if ( !keyids )
243         BUG (); /* No key no fun */
244
245
246     uid = get_primary_uid ( keyblock, &uidlen );
247
248     if( uid_cache_entries >= MAX_UID_CACHE_ENTRIES ) {
249         /* fixme: use another algorithm to free some cache slots */
250         r = user_id_db;
251         user_id_db = r->next;
252         release_keyid_list ( r->keyids );
253         m_free(r);
254         uid_cache_entries--;
255     }
256     r = m_alloc( sizeof *r + uidlen-1 );
257     r->keyids = keyids;
258     r->len = uidlen;
259     memcpy(r->name, uid, r->len);
260     r->next = user_id_db;
261     user_id_db = r;
262     uid_cache_entries++;
263 }
264
265
266 void
267 getkey_disable_caches()
268 {
269 #if MAX_PK_CACHE_ENTRIES
270     {
271         pk_cache_entry_t ce, ce2;
272
273         for( ce = pk_cache; ce; ce = ce2 ) {
274             ce2 = ce->next;
275             free_public_key( ce->pk );
276             m_free( ce );
277         }
278         pk_cache_disabled=1;
279         pk_cache_entries = 0;
280         pk_cache = NULL;
281     }
282 #endif
283     /* fixme: disable user id cache ? */
284 }
285
286
287 static void
288 pk_from_block ( GETKEY_CTX ctx, PKT_public_key *pk, KBNODE keyblock )
289 {
290     KBNODE a = ctx->found_key ? ctx->found_key : keyblock;
291
292     assert ( a->pkt->pkttype == PKT_PUBLIC_KEY
293              ||  a->pkt->pkttype == PKT_PUBLIC_SUBKEY );
294      
295     copy_public_key ( pk, a->pkt->pkt.public_key );
296 }
297
298 static void
299 sk_from_block ( GETKEY_CTX ctx,
300                 PKT_secret_key *sk, KBNODE keyblock )
301 {
302     KBNODE a = ctx->found_key ? ctx->found_key : keyblock;
303
304     assert ( a->pkt->pkttype == PKT_SECRET_KEY
305              ||  a->pkt->pkttype == PKT_SECRET_SUBKEY );
306      
307     copy_secret_key( sk, a->pkt->pkt.secret_key);
308 }
309
310
311 /****************
312  * Get a public key and store it into the allocated pk
313  * can be called with PK set to NULL to just read it into some
314  * internal structures.
315  */
316 int
317 get_pubkey( PKT_public_key *pk, u32 *keyid )
318 {
319     int internal = 0;
320     int rc = 0;
321
322 #if MAX_PK_CACHE_ENTRIES
323     {   /* Try to get it from the cache */
324         pk_cache_entry_t ce;
325         for( ce = pk_cache; ce; ce = ce->next ) {
326             if( ce->keyid[0] == keyid[0] && ce->keyid[1] == keyid[1] ) {
327                 if( pk )
328                     copy_public_key( pk, ce->pk );
329                 return 0;
330             }
331         }
332     }
333 #endif
334     /* more init stuff */
335     if( !pk ) {
336         pk = m_alloc_clear( sizeof *pk );
337         internal++;
338     }
339
340
341     /* do a lookup */
342     {   struct getkey_ctx_s ctx;
343         KBNODE kb = NULL;
344         memset( &ctx, 0, sizeof ctx );
345         ctx.exact = 1; /* use the key ID exactly as given */
346         ctx.not_allocated = 1;
347         ctx.kr_handle = keydb_new (0);
348         ctx.nitems = 1;
349         ctx.items[0].mode = KEYDB_SEARCH_MODE_LONG_KID;
350         ctx.items[0].u.kid[0] = keyid[0];
351         ctx.items[0].u.kid[1] = keyid[1];
352         ctx.req_algo  = pk->req_algo;
353         ctx.req_usage = pk->req_usage;
354         rc = lookup( &ctx, &kb, 0 );
355         if ( !rc ) {
356             pk_from_block ( &ctx, pk, kb );
357         }
358         get_pubkey_end( &ctx );
359         release_kbnode ( kb );
360     }
361     if( !rc )
362         goto leave;
363
364     rc = G10ERR_NO_PUBKEY;
365
366   leave:
367     if( !rc )
368         cache_public_key( pk );
369     if( internal )
370         free_public_key(pk);
371     return rc;
372 }
373
374
375 /* Get a public key and store it into the allocated pk.  This function
376    differs from get_pubkey() in that it does not do a check of the key
377    to avoid recursion.  It should be used only in very certain cases.  */
378 int
379 get_pubkey_fast (PKT_public_key *pk, u32 *keyid)
380 {
381   int rc = 0;
382   KEYDB_HANDLE hd;
383   KBNODE keyblock;
384   
385   assert (pk);
386 #if MAX_PK_CACHE_ENTRIES
387   { /* Try to get it from the cache */
388     pk_cache_entry_t ce;
389
390     for (ce = pk_cache; ce; ce = ce->next)
391       {
392         if (ce->keyid[0] == keyid[0] && ce->keyid[1] == keyid[1])
393           {
394             if (pk)
395               copy_public_key (pk, ce->pk);
396             return 0;
397           }
398       }
399   }
400 #endif
401
402   hd = keydb_new (0);
403   rc = keydb_search_kid (hd, keyid);
404   if (rc == -1)
405     {
406       keydb_release (hd);
407       return G10ERR_NO_PUBKEY;
408     }
409   rc = keydb_get_keyblock (hd, &keyblock);
410   keydb_release (hd);
411   if (rc) 
412     {
413       log_error ("keydb_get_keyblock failed: %s\n", g10_errstr(rc));
414       return G10ERR_NO_PUBKEY;
415     }
416   
417   assert ( keyblock->pkt->pkttype == PKT_PUBLIC_KEY
418            ||  keyblock->pkt->pkttype == PKT_PUBLIC_SUBKEY );
419   copy_public_key (pk, keyblock->pkt->pkt.public_key );
420   release_kbnode (keyblock);
421
422   /* Not caching key here since it won't have all of the fields
423      properly set. */
424
425   return 0;
426 }
427
428
429
430 KBNODE
431 get_pubkeyblock( u32 *keyid )
432 {
433     struct getkey_ctx_s ctx;
434     int rc = 0;
435     KBNODE keyblock = NULL;
436
437     memset( &ctx, 0, sizeof ctx );
438     /* no need to set exact here because we want the entire block */
439     ctx.not_allocated = 1;
440     ctx.kr_handle = keydb_new (0);
441     ctx.nitems = 1;
442     ctx.items[0].mode = KEYDB_SEARCH_MODE_LONG_KID;
443     ctx.items[0].u.kid[0] = keyid[0];
444     ctx.items[0].u.kid[1] = keyid[1];
445     rc = lookup( &ctx, &keyblock, 0 );
446     get_pubkey_end( &ctx );
447
448     return rc ? NULL : keyblock;
449 }
450
451
452
453
454 /****************
455  * Get a secret key and store it into sk
456  */
457 int
458 get_seckey( PKT_secret_key *sk, u32 *keyid )
459 {
460     int rc;
461     struct getkey_ctx_s ctx;
462     KBNODE kb = NULL;
463
464     memset( &ctx, 0, sizeof ctx );
465     ctx.exact = 1; /* use the key ID exactly as given */
466     ctx.not_allocated = 1;
467     ctx.kr_handle = keydb_new (1);
468     ctx.nitems = 1;
469     ctx.items[0].mode = KEYDB_SEARCH_MODE_LONG_KID;
470     ctx.items[0].u.kid[0] = keyid[0];
471     ctx.items[0].u.kid[1] = keyid[1];
472     ctx.req_algo  = sk->req_algo;
473     ctx.req_usage = sk->req_usage;
474     rc = lookup( &ctx, &kb, 1 );
475     if ( !rc ) {
476         sk_from_block ( &ctx, sk, kb );
477     }
478     get_seckey_end( &ctx );
479     release_kbnode ( kb );
480
481     if( !rc ) {
482         /* check the secret key (this may prompt for a passprase to
483          * unlock the secret key
484          */
485         rc = check_secret_key( sk, 0 );
486     }
487
488     return rc;
489 }
490
491
492 /****************
493  * Check whether the secret key is available.  This is just a fast
494  * check and does not tell us whether the secret key is valid.  It
495  * merely tells other whether there is some secret key.
496  * Returns: 0 := key is available
497  * G10ERR_NO_SECKEY := not availabe
498  */
499 int
500 seckey_available( u32 *keyid )
501 {
502     int rc;
503     KEYDB_HANDLE hd = keydb_new (1);
504
505     rc = keydb_search_kid (hd, keyid);
506     if ( rc == -1 )
507         rc = G10ERR_NO_SECKEY;
508     keydb_release (hd);
509     return rc;
510 }
511
512
513 /****************
514  * Return the type of the user id:
515  *
516  * Please use the constants KEYDB_SERCH_MODE_xxx
517  *  0 = Invalid user ID
518  *  1 = exact match
519  *  2 = match a substring
520  *  3 = match an email address
521  *  4 = match a substring of an email address
522  *  5 = match an email address, but compare from end
523  *  6 = word match mode
524  * 10 = it is a short KEYID (don't care about keyid[0])
525  * 11 = it is a long  KEYID
526  * 12 = it is a trustdb index (keyid is looked up)
527  * 16 = it is a 16 byte fingerprint
528  * 20 = it is a 20 byte fingerprint
529  * 21 = Unified fingerprint :fpr:pk_algo:
530  *      (We don't use pk_algo yet)
531  *
532  * Rules used:
533  * - If the username starts with 8,9,16 or 17 hex-digits (the first one
534  *   must be in the range 0..9), this is considered a keyid; depending
535  *   on the length a short or complete one.
536  * - If the username starts with 32,33,40 or 41 hex-digits (the first one
537  *   must be in the range 0..9), this is considered a fingerprint.
538  * - If the username starts with a left angle, we assume it is a complete
539  *   email address and look only at this part.
540  * - If the username starts with a colon we assume it is a unified 
541  *   key specfification. 
542  * - If the username starts with a '.', we assume it is the ending
543  *   part of an email address
544  * - If the username starts with an '@', we assume it is a part of an
545  *   email address
546  * - If the userid start with an '=' an exact compare is done.
547  * - If the userid starts with a '*' a case insensitive substring search is
548  *   done (This is the default).
549  * - If the userid starts with a '+' we will compare individual words
550  *   and a match requires that all the words are in the userid.
551  *   Words are delimited by white space or "()<>[]{}.@-+_,;/&!"
552  *   (note that you can't search for these characters). Compare
553  *   is not case sensitive.
554  */
555
556 int
557 classify_user_id( const char *name, KEYDB_SEARCH_DESC *desc )
558 {
559     const char *s;
560     int hexprefix = 0;
561     int hexlength;
562     int mode = 0;   
563     KEYDB_SEARCH_DESC dummy_desc;
564
565     if (!desc)
566         desc = &dummy_desc;
567
568     /* clear the structure so that the mode field is set to zero unless
569      * we set it to the correct value right at the end of this function */
570     memset (desc, 0, sizeof *desc);
571
572     /* skip leading spaces.  Fixme: what is with trailing spaces? */
573     for(s = name; *s && spacep (s); s++ )
574         ;
575
576     switch (*s) {
577         case 0:    /* empty string is an error */
578             return 0;
579
580         case '.':  /* an email address, compare from end */
581             mode = KEYDB_SEARCH_MODE_MAILEND;
582             s++;
583             desc->u.name = s;
584             break;
585
586         case '<':  /* an email address */
587             mode = KEYDB_SEARCH_MODE_MAIL;
588             desc->u.name = s;
589             break;
590
591         case '@':  /* part of an email address */
592             mode = KEYDB_SEARCH_MODE_MAILSUB;
593             s++;
594             desc->u.name = s;
595             break;
596
597         case '=':  /* exact compare */
598             mode = KEYDB_SEARCH_MODE_EXACT;
599             s++;
600             desc->u.name = s;
601             break;
602
603         case '*':  /* case insensitive substring search */
604             mode = KEYDB_SEARCH_MODE_SUBSTR;
605             s++;
606             desc->u.name = s;
607             break;
608
609         case '+':  /* compare individual words */
610             mode = KEYDB_SEARCH_MODE_WORDS;
611             s++;
612             desc->u.name = s;
613             break;
614
615         case '#':  /* local user id */
616             return 0; /* This is now obsolete and van't not be used anymore*/
617         
618         case ':': /*Unified fingerprint */
619             {  
620                 const char *se, *si;
621                 int i;
622                 
623                 se = strchr( ++s,':');
624                 if ( !se )
625                     return 0;
626                 for (i=0,si=s; si < se; si++, i++ ) {
627                     if ( !strchr("01234567890abcdefABCDEF", *si ) )
628                         return 0; /* invalid digit */
629                 }
630                 if (i != 32 && i != 40)
631                     return 0; /* invalid length of fpr*/
632                 for (i=0,si=s; si < se; i++, si +=2) 
633                     desc->u.fpr[i] = hextobyte(si);
634                 for ( ; i < 20; i++)
635                     desc->u.fpr[i]= 0;
636                 s = se + 1;
637                 mode = KEYDB_SEARCH_MODE_FPR;
638             } 
639             break;
640            
641         default:
642             if (s[0] == '0' && s[1] == 'x') {
643                 hexprefix = 1;
644                 s += 2;
645             }
646
647             hexlength = strspn(s, "0123456789abcdefABCDEF");
648             if (hexlength >= 8 && s[hexlength] =='!') {
649                 desc->exact = 1;
650                 hexlength++; /* just for the following check */
651             }
652
653             /* check if a hexadecimal number is terminated by EOS or blank */
654             if (hexlength && s[hexlength] && !spacep(s+hexlength)) {
655                 if (hexprefix)      /* a "0x" prefix without correct */
656                     return 0;       /* termination is an error */
657                 else                /* The first chars looked like */
658                     hexlength = 0;  /* a hex number, but really were not. */
659             }
660
661             if (desc->exact)
662                 hexlength--;
663
664             if (hexlength == 8
665                 || (!hexprefix && hexlength == 9 && *s == '0')){
666                 /* short keyid */
667                 if (hexlength == 9)
668                     s++;
669                 desc->u.kid[0] = 0;
670                 desc->u.kid[1] = strtoul( s, NULL, 16 );
671                 mode = KEYDB_SEARCH_MODE_SHORT_KID;
672             }
673             else if (hexlength == 16
674                      || (!hexprefix && hexlength == 17 && *s == '0')) {
675                 /* complete keyid */
676                 char buf[9];
677                 if (hexlength == 17)
678                     s++;
679                 mem2str(buf, s, 9 );
680                 desc->u.kid[0] = strtoul( buf, NULL, 16 );
681                 desc->u.kid[1] = strtoul( s+8, NULL, 16 );
682                 mode = KEYDB_SEARCH_MODE_LONG_KID;
683             }
684             else if (hexlength == 32 || (!hexprefix && hexlength == 33
685                                                             && *s == '0')) {
686                 /* md5 fingerprint */
687                 int i;
688                 if (hexlength == 33)
689                     s++;
690                 memset(desc->u.fpr+16, 0, 4); 
691                 for (i=0; i < 16; i++, s+=2) {
692                     int c = hextobyte(s);
693                     if (c == -1)
694                         return 0;
695                     desc->u.fpr[i] = c;
696                 }
697                 mode = KEYDB_SEARCH_MODE_FPR16;
698             }
699             else if (hexlength == 40 || (!hexprefix && hexlength == 41
700                                                               && *s == '0')) {
701                 /* sha1/rmd160 fingerprint */
702                 int i;
703                 if (hexlength == 41)
704                     s++;
705                 for (i=0; i < 20; i++, s+=2) {
706                     int c = hextobyte(s);
707                     if (c == -1)
708                         return 0;
709                     desc->u.fpr[i] = c;
710                 }
711                 mode = KEYDB_SEARCH_MODE_FPR20;
712             }
713             else {
714                 if (hexprefix)  /* This was a hex number with a prefix */
715                     return 0;   /* and a wrong length */
716
717                 desc->exact = 0;
718                 desc->u.name = s;
719                 mode = KEYDB_SEARCH_MODE_SUBSTR;   /* default mode */
720             }
721     }
722
723     desc->mode = mode;
724     return mode;
725 }
726
727
728 static int
729 skip_unusable(void *dummy,u32 *keyid,PKT_user_id *uid)
730 {
731   int unusable=0;
732   KBNODE keyblock;
733
734   keyblock=get_pubkeyblock(keyid);
735   if(!keyblock)
736     {
737       log_error("error checking usability status of %08lX\n",(ulong)keyid[1]);
738       goto leave;
739     }
740
741   /* Is the user ID in question revoked/expired? */
742   if(uid)
743     {
744       KBNODE node;
745
746       for(node=keyblock;node;node=node->next)
747         {
748           if(node->pkt->pkttype==PKT_USER_ID)
749             {
750               if(cmp_user_ids(uid,node->pkt->pkt.user_id)==0
751                  && (node->pkt->pkt.user_id->is_revoked
752                      || node->pkt->pkt.user_id->is_expired))
753                 {
754                   unusable=1;
755                   break;
756                 }
757             }
758         }
759     }
760
761   if(!unusable)
762     unusable=pk_is_disabled(keyblock->pkt->pkt.public_key);
763
764  leave:
765   release_kbnode(keyblock);
766   return unusable;
767 }
768
769 /****************
770  * Try to get the pubkey by the userid. This function looks for the
771  * first pubkey certificate which has the given name in a user_id.
772  * if pk/sk has the pubkey algo set, the function will only return
773  * a pubkey with that algo.
774  * The caller should provide storage for either the pk or the sk.
775  * If ret_kb is not NULL the function will return the keyblock there.
776  */
777
778 static int
779 key_byname( GETKEY_CTX *retctx, STRLIST namelist,
780             PKT_public_key *pk, PKT_secret_key *sk,
781             int secmode, int include_unusable,
782             KBNODE *ret_kb, KEYDB_HANDLE *ret_kdbhd )
783 {
784     int rc = 0;
785     int n;
786     STRLIST r;
787     GETKEY_CTX ctx;
788     KBNODE help_kb = NULL;
789     
790     if( retctx ) {/* reset the returned context in case of error */
791         assert (!ret_kdbhd);  /* not allowed because the handle is
792                                  stored in the context */
793         *retctx = NULL;
794     }
795     if (ret_kdbhd)
796         *ret_kdbhd = NULL;
797
798     /* build the search context */
799     for(n=0, r=namelist; r; r = r->next )
800         n++;
801     ctx = m_alloc_clear (sizeof *ctx + (n-1)*sizeof ctx->items );
802     ctx->nitems = n;
803
804     for(n=0, r=namelist; r; r = r->next, n++ ) {
805         classify_user_id (r->d, &ctx->items[n]);
806         
807         if (ctx->items[n].exact)
808             ctx->exact = 1;
809         if (!ctx->items[n].mode) {
810             m_free (ctx);
811             return G10ERR_INV_USER_ID;
812         }
813         if(!include_unusable
814            && ctx->items[n].mode!=KEYDB_SEARCH_MODE_SHORT_KID
815            && ctx->items[n].mode!=KEYDB_SEARCH_MODE_LONG_KID
816            && ctx->items[n].mode!=KEYDB_SEARCH_MODE_FPR16
817            && ctx->items[n].mode!=KEYDB_SEARCH_MODE_FPR20
818            && ctx->items[n].mode!=KEYDB_SEARCH_MODE_FPR)
819           ctx->items[n].skipfnc=skip_unusable;
820     }
821
822     ctx->kr_handle = keydb_new (secmode);
823     if ( !ret_kb ) 
824         ret_kb = &help_kb;
825
826     if( secmode ) {
827         if (sk) {
828             ctx->req_algo  = sk->req_algo;
829             ctx->req_usage = sk->req_usage;
830         }
831         rc = lookup( ctx, ret_kb, 1 );
832         if ( !rc && sk ) {
833             sk_from_block ( ctx, sk, *ret_kb );
834         }
835     }
836     else {
837         if (pk) {
838             ctx->req_algo  = pk->req_algo;
839             ctx->req_usage = pk->req_usage;
840         }
841         rc = lookup( ctx, ret_kb, 0 );
842         if ( !rc && pk ) {
843             pk_from_block ( ctx, pk, *ret_kb );
844         }
845     }
846
847     release_kbnode ( help_kb );
848
849     if (retctx) /* caller wants the context */
850         *retctx = ctx;
851     else {
852         if (ret_kdbhd) {
853             *ret_kdbhd = ctx->kr_handle;
854             ctx->kr_handle = NULL;
855         }
856         get_pubkey_end (ctx);
857     }
858
859     return rc;
860 }
861
862 /*
863  * Find a public key from NAME and returh the keyblock or the key.
864  * If ret_kdb is not NULL, the KEYDB handle used to locate this keyblock is
865  * returned and the caller is responsible for closing it.
866  */
867 int
868 get_pubkey_byname (PKT_public_key *pk,
869                    const char *name, KBNODE *ret_keyblock,
870                    KEYDB_HANDLE *ret_kdbhd, int include_unusable )
871 {
872     int rc;
873     STRLIST namelist = NULL;
874
875     add_to_strlist( &namelist, name );
876     rc = key_byname( NULL, namelist, pk, NULL, 0,
877                      include_unusable, ret_keyblock, ret_kdbhd);
878     free_strlist( namelist );
879     return rc;
880 }
881
882 int
883 get_pubkey_bynames( GETKEY_CTX *retctx, PKT_public_key *pk,
884                     STRLIST names, KBNODE *ret_keyblock )
885 {
886     return key_byname( retctx, names, pk, NULL, 0, 1, ret_keyblock, NULL);
887 }
888
889 int
890 get_pubkey_next( GETKEY_CTX ctx, PKT_public_key *pk, KBNODE *ret_keyblock )
891 {
892     int rc;
893
894     rc = lookup( ctx, ret_keyblock, 0 );
895     if ( !rc && pk && ret_keyblock )
896         pk_from_block ( ctx, pk, *ret_keyblock );
897     
898     return rc;
899 }
900
901
902 void
903 get_pubkey_end( GETKEY_CTX ctx )
904 {
905     if( ctx ) {
906         memset (&ctx->kbpos, 0, sizeof ctx->kbpos);
907         keydb_release (ctx->kr_handle);
908         if( !ctx->not_allocated )
909             m_free( ctx );
910     }
911 }
912
913
914
915
916 /****************
917  * Search for a key with the given fingerprint.
918  * FIXME:
919  * We should replace this with the _byname function.  Thiscsan be done
920  * by creating a userID conforming to the unified fingerprint style. 
921  */
922 int
923 get_pubkey_byfprint( PKT_public_key *pk,
924                      const byte *fprint, size_t fprint_len)
925 {
926     int rc;
927
928     if( fprint_len == 20 || fprint_len == 16 ) {
929         struct getkey_ctx_s ctx;
930         KBNODE kb = NULL;
931
932         memset( &ctx, 0, sizeof ctx );
933         ctx.exact = 1 ;
934         ctx.not_allocated = 1;
935         ctx.kr_handle = keydb_new (0);
936         ctx.nitems = 1;
937         ctx.items[0].mode = fprint_len==16? KEYDB_SEARCH_MODE_FPR16
938                                           : KEYDB_SEARCH_MODE_FPR20;
939         memcpy( ctx.items[0].u.fpr, fprint, fprint_len );
940         rc = lookup( &ctx, &kb, 0 );
941         if (!rc && pk )
942             pk_from_block ( &ctx, pk, kb );
943         release_kbnode ( kb );
944         get_pubkey_end( &ctx );
945     }
946     else
947         rc = G10ERR_GENERAL; /* Oops */
948     return rc;
949 }
950
951
952 /* Get a public key and store it into the allocated pk.  This function
953    differs from get_pubkey_byfprint() in that it does not do a check
954    of the key to avoid recursion.  It should be used only in very
955    certain cases.  PK may be NULL to check just for the existance of
956    the key. */
957 int
958 get_pubkey_byfprint_fast (PKT_public_key *pk,
959                           const byte *fprint, size_t fprint_len)
960 {
961   int rc = 0;
962   KEYDB_HANDLE hd;
963   KBNODE keyblock;
964   byte fprbuf[MAX_FINGERPRINT_LEN];
965   int i;
966   
967   for (i=0; i < MAX_FINGERPRINT_LEN && i < fprint_len; i++)
968     fprbuf[i] = fprint[i];
969   while (i < MAX_FINGERPRINT_LEN) 
970     fprbuf[i++] = 0;
971
972   hd = keydb_new (0);
973   rc = keydb_search_fpr (hd, fprbuf);
974   if (rc == -1)
975     {
976       keydb_release (hd);
977       return G10ERR_NO_PUBKEY;
978     }
979   rc = keydb_get_keyblock (hd, &keyblock);
980   keydb_release (hd);
981   if (rc) 
982     {
983       log_error ("keydb_get_keyblock failed: %s\n", g10_errstr(rc));
984       return G10ERR_NO_PUBKEY;
985     }
986   
987   assert ( keyblock->pkt->pkttype == PKT_PUBLIC_KEY
988            ||  keyblock->pkt->pkttype == PKT_PUBLIC_SUBKEY );
989   if (pk)
990     copy_public_key (pk, keyblock->pkt->pkt.public_key );
991   release_kbnode (keyblock);
992
993   /* Not caching key here since it won't have all of the fields
994      properly set. */
995
996   return 0;
997 }
998
999 /****************
1000  * Search for a key with the given fingerprint and return the
1001  * complete keyblock which may have more than only this key.
1002  */
1003 int
1004 get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
1005                                                 size_t fprint_len )
1006 {
1007     int rc;
1008
1009     if( fprint_len == 20 || fprint_len == 16 ) {
1010         struct getkey_ctx_s ctx;
1011
1012         memset( &ctx, 0, sizeof ctx );
1013         ctx.not_allocated = 1;
1014         ctx.kr_handle = keydb_new (0);
1015         ctx.nitems = 1;
1016         ctx.items[0].mode = fprint_len==16? KEYDB_SEARCH_MODE_FPR16
1017                                           : KEYDB_SEARCH_MODE_FPR20;
1018         memcpy( ctx.items[0].u.fpr, fprint, fprint_len );
1019         rc = lookup( &ctx, ret_keyblock, 0 );
1020         get_pubkey_end( &ctx );
1021     }
1022     else
1023         rc = G10ERR_GENERAL; /* Oops */
1024
1025     return rc;
1026 }
1027
1028
1029 /****************
1030  * Get a secret key by name and store it into sk
1031  * If NAME is NULL use the default key
1032  */
1033 static int
1034 get_seckey_byname2( GETKEY_CTX *retctx,
1035                    PKT_secret_key *sk, const char *name, int unprotect,
1036                    KBNODE *retblock )
1037 {
1038     STRLIST namelist = NULL;
1039     int rc;
1040
1041     if( !name && opt.def_secret_key && *opt.def_secret_key ) {
1042         add_to_strlist( &namelist, opt.def_secret_key );
1043         rc = key_byname( retctx, namelist, NULL, sk, 1, 1, retblock, NULL );
1044     }
1045     else if( !name ) { /* use the first one as default key */
1046         struct getkey_ctx_s ctx;
1047         KBNODE kb = NULL;
1048
1049         assert (!retctx ); /* do we need this at all */
1050         assert (!retblock);
1051         memset( &ctx, 0, sizeof ctx );
1052         ctx.not_allocated = 1;
1053         ctx.kr_handle = keydb_new (1);
1054         ctx.nitems = 1;
1055         ctx.items[0].mode = KEYDB_SEARCH_MODE_FIRST;
1056         rc = lookup( &ctx, &kb, 1 );
1057         if (!rc && sk )
1058             sk_from_block ( &ctx, sk, kb );
1059         release_kbnode ( kb );
1060         get_seckey_end( &ctx );
1061     }
1062     else {
1063         add_to_strlist( &namelist, name );
1064         rc = key_byname( retctx, namelist, NULL, sk, 1, 1, retblock, NULL );
1065     }
1066
1067     free_strlist( namelist );
1068
1069     if( !rc && unprotect )
1070         rc = check_secret_key( sk, 0 );
1071
1072     return rc;
1073 }
1074
1075 int 
1076 get_seckey_byname( PKT_secret_key *sk, const char *name, int unlock )
1077 {
1078     return get_seckey_byname2 ( NULL, sk, name, unlock, NULL );
1079 }
1080
1081
1082 int
1083 get_seckey_bynames( GETKEY_CTX *retctx, PKT_secret_key *sk,
1084                     STRLIST names, KBNODE *ret_keyblock )
1085 {
1086     return key_byname( retctx, names, NULL, sk, 1, 1, ret_keyblock, NULL );
1087 }
1088
1089
1090 int
1091 get_seckey_next( GETKEY_CTX ctx, PKT_secret_key *sk, KBNODE *ret_keyblock )
1092 {
1093     int rc;
1094
1095     rc = lookup( ctx, ret_keyblock, 1 );
1096     if ( !rc && sk && ret_keyblock )
1097         sk_from_block ( ctx, sk, *ret_keyblock );
1098
1099     return rc;
1100 }
1101
1102
1103 void
1104 get_seckey_end( GETKEY_CTX ctx )
1105 {
1106     get_pubkey_end( ctx );
1107 }
1108
1109
1110 /****************
1111  * Search for a key with the given fingerprint.
1112  * FIXME:
1113  * We should replace this with the _byname function.  Thiscsan be done
1114  * by creating a userID conforming to the unified fingerprint style. 
1115  */
1116 int
1117 get_seckey_byfprint( PKT_secret_key *sk,
1118                      const byte *fprint, size_t fprint_len)
1119 {
1120     int rc;
1121
1122     if( fprint_len == 20 || fprint_len == 16 ) {
1123         struct getkey_ctx_s ctx;
1124         KBNODE kb = NULL;
1125
1126         memset( &ctx, 0, sizeof ctx );
1127         ctx.exact = 1 ;
1128         ctx.not_allocated = 1;
1129         ctx.kr_handle = keydb_new (1);
1130         ctx.nitems = 1;
1131         ctx.items[0].mode = fprint_len==16? KEYDB_SEARCH_MODE_FPR16
1132                                           : KEYDB_SEARCH_MODE_FPR20;
1133         memcpy( ctx.items[0].u.fpr, fprint, fprint_len );
1134         rc = lookup( &ctx, &kb, 1 );
1135         if (!rc && sk )
1136             sk_from_block ( &ctx, sk, kb );
1137         release_kbnode ( kb );
1138         get_pubkey_end( &ctx );
1139     }
1140     else
1141         rc = G10ERR_GENERAL; /* Oops */
1142     return rc;
1143 }
1144
1145 \f
1146 /************************************************
1147  ************* Merging stuff ********************
1148  ************************************************/
1149
1150 /****************
1151  * merge all selfsignatures with the keys.
1152  * FIXME: replace this at least for the public key parts
1153  *        by merge_selfsigs.
1154  *        It is still used in keyedit.c and
1155  *        at 2 or 3 other places - check whether it is really needed.
1156  *        It might be needed by the key edit and import stuff because
1157  *        the keylock is changed.
1158  */
1159 void
1160 merge_keys_and_selfsig( KBNODE keyblock )
1161 {
1162     PKT_public_key *pk = NULL;
1163     PKT_secret_key *sk = NULL;
1164     PKT_signature *sig;
1165     KBNODE k;
1166     u32 kid[2] = { 0, 0 };
1167     u32 sigdate = 0;
1168
1169     if (keyblock && keyblock->pkt->pkttype == PKT_PUBLIC_KEY ) {
1170         /* divert to our new function */
1171         merge_selfsigs (keyblock);
1172         return;
1173     }
1174     /* still need the old one because the new one can't handle secret keys */
1175
1176     for(k=keyblock; k; k = k->next ) {
1177         if( k->pkt->pkttype == PKT_PUBLIC_KEY
1178             || k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
1179             pk = k->pkt->pkt.public_key; sk = NULL;
1180             if( pk->version < 4 )
1181                 pk = NULL; /* not needed for old keys */
1182             else if( k->pkt->pkttype == PKT_PUBLIC_KEY )
1183                 keyid_from_pk( pk, kid );
1184             else if( !pk->expiredate ) { /* and subkey */
1185                 /* insert the expiration date here */
1186                 /*FIXME!!! pk->expiredate = subkeys_expiretime( k, kid );*/
1187             }
1188             sigdate = 0;
1189         }
1190         else if( k->pkt->pkttype == PKT_SECRET_KEY
1191             || k->pkt->pkttype == PKT_SECRET_SUBKEY ) {
1192             pk = NULL; sk = k->pkt->pkt.secret_key;
1193             if( sk->version < 4 )
1194                 sk = NULL;
1195             else if( k->pkt->pkttype == PKT_SECRET_KEY )
1196                 keyid_from_sk( sk, kid );
1197             sigdate = 0;
1198         }
1199         else if( (pk || sk ) && k->pkt->pkttype == PKT_SIGNATURE
1200                  && (sig=k->pkt->pkt.signature)->sig_class >= 0x10
1201                  && sig->sig_class <= 0x30 && sig->version > 3
1202                  && !(sig->sig_class == 0x18 || sig->sig_class == 0x28)
1203                  && sig->keyid[0] == kid[0] && sig->keyid[1] == kid[1] ) {
1204             /* okay this is a self-signature which can be used.
1205              * This is not used for subkey binding signature, becuase this
1206              * is done above.
1207              * FIXME: We should only use this if the signature is valid
1208              *        but this is time consuming - we must provide another
1209              *        way to handle this
1210              */
1211             const byte *p;
1212             u32 ed;
1213
1214             p = parse_sig_subpkt( sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL );
1215             if( pk ) {
1216                 ed = p? pk->timestamp + buffer_to_u32(p):0;
1217                 if( sig->timestamp > sigdate ) {
1218                     pk->expiredate = ed;
1219                     sigdate = sig->timestamp;
1220                 }
1221             }
1222             else {
1223                 ed = p? sk->timestamp + buffer_to_u32(p):0;
1224                 if( sig->timestamp > sigdate ) {
1225                     sk->expiredate = ed;
1226                     sigdate = sig->timestamp;
1227                 }
1228             }
1229         }
1230
1231         if(pk && (pk->expiredate==0 ||
1232                   (pk->max_expiredate && pk->expiredate>pk->max_expiredate)))
1233           pk->expiredate=pk->max_expiredate;
1234
1235         if(sk && (sk->expiredate==0 ||
1236                   (sk->max_expiredate && sk->expiredate>sk->max_expiredate)))
1237           sk->expiredate=sk->max_expiredate;
1238     }
1239 }
1240
1241 /*
1242  * Apply information from SIGNODE (which is the valid self-signature
1243  * associated with that UID) to the UIDNODE:
1244  * - wether the UID has been revoked
1245  * - assumed creation date of the UID
1246  * - temporary store the keyflags here
1247  * - temporary store the key expiration time here
1248  * - mark whether the primary user ID flag hat been set.
1249  * - store the preferences
1250  */
1251 static void
1252 fixup_uidnode ( KBNODE uidnode, KBNODE signode, u32 keycreated )
1253 {
1254     PKT_user_id   *uid = uidnode->pkt->pkt.user_id;
1255     PKT_signature *sig = signode->pkt->pkt.signature;
1256     const byte *p, *sym, *hash, *zip;
1257     size_t n, nsym, nhash, nzip;
1258
1259     uid->created = 0; /* not created == invalid */
1260     if ( IS_UID_REV ( sig ) ) {
1261         uid->is_revoked = 1;
1262         return; /* has been revoked */
1263     }
1264
1265     uid->created = sig->timestamp; /* this one is okay */
1266     uid->selfsigversion = sig->version;
1267     /* If we got this far, it's not expired :) */
1268     uid->is_expired = 0;
1269     uid->expiredate = sig->expiredate;
1270
1271     /* store the key flags in the helper variable for later processing */
1272     uid->help_key_usage = 0;
1273     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_FLAGS, &n );
1274     if ( p && n ) {
1275         /* first octet of the keyflags */   
1276         if ( (*p & 3) )
1277             uid->help_key_usage |= PUBKEY_USAGE_SIG;
1278         if ( (*p & 12) )    
1279             uid->help_key_usage |= PUBKEY_USAGE_ENC;
1280         /* Note: we do not set the CERT flag here because it can be assumed
1281          * that thre is no real policy to set it. */
1282         if ( (*p & 0x20) )    
1283             uid->help_key_usage |= PUBKEY_USAGE_AUTH;
1284     }
1285
1286     /* ditto or the key expiration */
1287     uid->help_key_expire = 0;
1288     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
1289     if ( p ) { 
1290         uid->help_key_expire = keycreated + buffer_to_u32(p);
1291     }
1292
1293     /* Set the primary user ID flag - we will later wipe out some
1294      * of them to only have one in our keyblock */
1295     uid->is_primary = 0;
1296     p = parse_sig_subpkt ( sig->hashed, SIGSUBPKT_PRIMARY_UID, NULL );
1297     if ( p && *p )
1298         uid->is_primary = 2;
1299     /* We could also query this from the unhashed area if it is not in
1300      * the hased area and then later try to decide which is the better
1301      * there should be no security problem with this.
1302      * For now we only look at the hashed one. 
1303      */
1304
1305     /* Now build the preferences list.  These must come from the
1306        hashed section so nobody can modify the ciphers a key is
1307        willing to accept. */
1308     p = parse_sig_subpkt ( sig->hashed, SIGSUBPKT_PREF_SYM, &n );
1309     sym = p; nsym = p?n:0;
1310     p = parse_sig_subpkt ( sig->hashed, SIGSUBPKT_PREF_HASH, &n );
1311     hash = p; nhash = p?n:0;
1312     p = parse_sig_subpkt ( sig->hashed, SIGSUBPKT_PREF_COMPR, &n );
1313     zip = p; nzip = p?n:0;
1314     if (uid->prefs) 
1315         m_free (uid->prefs);
1316     n = nsym + nhash + nzip;
1317     if (!n)
1318         uid->prefs = NULL;
1319     else {
1320         uid->prefs = m_alloc (sizeof (*uid->prefs) * (n+1));
1321         n = 0;
1322         for (; nsym; nsym--, n++) {
1323             uid->prefs[n].type = PREFTYPE_SYM;
1324             uid->prefs[n].value = *sym++;
1325         }
1326         for (; nhash; nhash--, n++) {
1327             uid->prefs[n].type = PREFTYPE_HASH;
1328             uid->prefs[n].value = *hash++;
1329         }
1330         for (; nzip; nzip--, n++) {
1331             uid->prefs[n].type = PREFTYPE_ZIP;
1332             uid->prefs[n].value = *zip++;
1333         }
1334         uid->prefs[n].type = PREFTYPE_NONE; /* end of list marker */
1335         uid->prefs[n].value = 0;
1336     }
1337
1338     /* see whether we have the MDC feature */
1339     uid->mdc_feature = 0;
1340     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_FEATURES, &n);
1341     if (p && n && (p[0] & 0x01))
1342         uid->mdc_feature = 1;
1343
1344     /* and the keyserver modify flag */
1345     uid->ks_modify = 1;
1346     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KS_FLAGS, &n);
1347     if (p && n && (p[0] & 0x80))
1348         uid->ks_modify = 0;
1349 }
1350
1351 static void
1352 merge_selfsigs_main( KBNODE keyblock, int *r_revoked )
1353 {
1354     PKT_public_key *pk = NULL;
1355     KBNODE k;
1356     u32 kid[2];
1357     u32 sigdate, uiddate, uiddate2;
1358     KBNODE signode, uidnode, uidnode2;
1359     u32 curtime = make_timestamp ();
1360     unsigned int key_usage = 0;
1361     u32 keytimestamp = 0;
1362     u32 key_expire = 0;
1363     int key_expire_seen = 0;
1364     byte sigversion = 0;
1365
1366     *r_revoked = 0;
1367     if ( keyblock->pkt->pkttype != PKT_PUBLIC_KEY )
1368         BUG ();
1369     pk = keyblock->pkt->pkt.public_key;
1370     keytimestamp = pk->timestamp;
1371
1372     keyid_from_pk( pk, kid );
1373     pk->main_keyid[0] = kid[0];
1374     pk->main_keyid[1] = kid[1];
1375
1376     if ( pk->version < 4 ) {
1377         /* before v4 the key packet itself contains the expiration
1378          * date and there was no way to change it, so we start with
1379          * the one from the key packet */
1380         key_expire = pk->max_expiredate;
1381         key_expire_seen = 1;
1382     }
1383
1384     /* first pass: find the latest direct key self-signature.
1385      * We assume that the newest one overrides all others
1386      */
1387
1388     /* In case this key was already merged */
1389     m_free(pk->revkey);
1390     pk->revkey=NULL;
1391     pk->numrevkeys=0;
1392
1393     signode = NULL;
1394     sigdate = 0; /* helper to find the latest signature */
1395     for(k=keyblock; k && k->pkt->pkttype != PKT_USER_ID; k = k->next ) {
1396         if ( k->pkt->pkttype == PKT_SIGNATURE ) {
1397             PKT_signature *sig = k->pkt->pkt.signature;
1398             if ( sig->keyid[0] == kid[0] && sig->keyid[1]==kid[1] ) { 
1399                 if ( check_key_signature( keyblock, k, NULL ) )
1400                     ; /* signature did not verify */
1401                 else if ( IS_KEY_REV (sig) ){
1402                     /* key has been revoked - there is no way to override
1403                      * such a revocation, so we theoretically can stop now.
1404                      * We should not cope with expiration times for revocations
1405                      * here because we have to assume that an attacker can
1406                      * generate all kinds of signatures.  However due to the
1407                      * fact that the key has been revoked it does not harm
1408                      * either and by continuing we gather some more info on 
1409                      * that key.
1410                      */ 
1411                     *r_revoked = 1;
1412                 }
1413                 else if ( IS_KEY_SIG (sig) ) {
1414                   /* Add any revocation keys onto the pk.  This is
1415                      particularly interesting since we normally only
1416                      get data from the most recent 1F signature, but
1417                      you need multiple 1F sigs to properly handle
1418                      revocation keys (PGP does it this way, and a
1419                      revocation key could be sensitive and hence in a
1420                      different signature). */
1421                   if(sig->revkey) {
1422                     int i;
1423
1424                     pk->revkey=
1425                       m_realloc(pk->revkey,sizeof(struct revocation_key)*
1426                                 (pk->numrevkeys+sig->numrevkeys));
1427
1428                     for(i=0;i<sig->numrevkeys;i++)
1429                       memcpy(&pk->revkey[pk->numrevkeys++],
1430                              sig->revkey[i],
1431                              sizeof(struct revocation_key));
1432                   }
1433
1434                   if( sig->timestamp >= sigdate ) {
1435                     if(sig->flags.expired)
1436                         ; /* signature has expired - ignore it */
1437                     else {
1438                         sigdate = sig->timestamp;
1439                         signode = k;
1440                         if( sig->version > sigversion )
1441                           sigversion = sig->version;
1442
1443                     }
1444                   }
1445                 }
1446             }
1447         }
1448     }
1449
1450     /* Remove dupes from the revocation keys */
1451
1452     if(pk->revkey)
1453       {
1454         int i,j,x,changed=0;
1455
1456         for(i=0;i<pk->numrevkeys;i++)
1457           {
1458             for(j=i+1;j<pk->numrevkeys;j++)
1459               {
1460                 if(memcmp(&pk->revkey[i],&pk->revkey[j],
1461                           sizeof(struct revocation_key))==0)
1462                   {
1463                     /* remove j */
1464
1465                     for(x=j;x<pk->numrevkeys-1;x++)
1466                       pk->revkey[x]=pk->revkey[x+1];
1467
1468                     pk->numrevkeys--;
1469                     j--;
1470                     changed=1;
1471                   }
1472               }
1473           }
1474
1475         if(changed)
1476           pk->revkey=m_realloc(pk->revkey,
1477                                pk->numrevkeys*sizeof(struct revocation_key));
1478       }
1479
1480     if ( signode ) {
1481         /* some information from a direct key signature take precedence
1482          * over the same information given in UID sigs.
1483          */
1484         PKT_signature *sig = signode->pkt->pkt.signature;
1485         const byte *p;
1486         size_t n;
1487         
1488         p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_FLAGS, &n );
1489         if ( p && n ) {
1490             /* first octet of the keyflags */   
1491             if ( (*p & 3) )
1492                 key_usage |= PUBKEY_USAGE_SIG;
1493             if ( (*p & 12) )    
1494                 key_usage |= PUBKEY_USAGE_ENC;
1495             if ( (*p & 0x20) )    
1496                 key_usage |= PUBKEY_USAGE_AUTH;
1497         }
1498
1499         p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
1500         if ( p ) {
1501           key_expire = keytimestamp + buffer_to_u32(p);
1502           key_expire_seen = 1;
1503         }
1504
1505         /* mark that key as valid: one direct key signature should 
1506          * render a key as valid */
1507         pk->is_valid = 1;
1508     }
1509
1510     /* pass 1.5: look for key revocation signatures that were not made
1511        by the key (i.e. did a revocation key issue a revocation for
1512        us?).  Only bother to do this if there is a revocation key in
1513        the first place. */
1514
1515     if(pk->revkey)
1516       for(k=keyblock; k && k->pkt->pkttype != PKT_USER_ID; k = k->next )
1517         {
1518           if ( k->pkt->pkttype == PKT_SIGNATURE )
1519             {
1520               PKT_signature *sig = k->pkt->pkt.signature;
1521
1522               if(IS_KEY_REV(sig) &&
1523                  (sig->keyid[0]!=kid[0] || sig->keyid[1]!=kid[1]))
1524                 { 
1525                   /* Failure here means the sig did not verify, is was
1526                      not issued by a revocation key, or a revocation
1527                      key loop was broken. */
1528
1529                   if(check_revocation_keys(pk,sig)==0)
1530                     *r_revoked=1;
1531
1532                   /* In the future handle subkey and cert revocations?
1533                      PGP doesn't, but it's in 2440. */
1534                 }
1535             }
1536         }
1537
1538     /* second pass: look at the self-signature of all user IDs */
1539     signode = uidnode = NULL;
1540     sigdate = 0; /* helper to find the latest signature in one user ID */
1541     for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next ) {
1542         if ( k->pkt->pkttype == PKT_USER_ID ) {
1543             if ( uidnode && signode ) 
1544               {
1545                 fixup_uidnode ( uidnode, signode, keytimestamp );
1546                 pk->is_valid=1;
1547               }
1548             uidnode = k;
1549             signode = NULL;
1550             sigdate = 0;
1551         }
1552         else if ( k->pkt->pkttype == PKT_SIGNATURE && uidnode ) {
1553             PKT_signature *sig = k->pkt->pkt.signature;
1554             if ( sig->keyid[0] == kid[0] && sig->keyid[1]==kid[1] ) { 
1555                 if ( check_key_signature( keyblock, k, NULL ) )
1556                     ; /* signature did not verify */
1557                 else if ( (IS_UID_SIG (sig) || IS_UID_REV (sig))
1558                           && sig->timestamp >= sigdate ) {
1559                     /* Note: we allow to invalidate cert revocations
1560                      * by a newer signature.  An attacker can't use this
1561                      * because a key should be revoced with a key revocation.
1562                      * The reason why we have to allow for that is that at
1563                      * one time an email address may become invalid but later
1564                      * the same email address may become valid again (hired,
1565                      * fired, hired again).
1566                      */
1567                     if(sig->flags.expired) {
1568                       /* Expired uids don't get to be primary unless
1569                          they are the only uid there is. */
1570                       uidnode->pkt->pkt.user_id->is_primary=0;
1571                       uidnode->pkt->pkt.user_id->is_expired=1;
1572                       uidnode->pkt->pkt.user_id->expiredate=sig->expiredate;
1573                     }
1574                     else {
1575                         sigdate = sig->timestamp;
1576                         signode = k;
1577                         if( sig->version > sigversion )
1578                           sigversion = sig->version;
1579                     }
1580                 }
1581             }
1582         }
1583     }
1584     if ( uidnode && signode ) {
1585         fixup_uidnode ( uidnode, signode, keytimestamp );
1586         pk->is_valid = 1;
1587     }
1588
1589     /* If the key isn't valid yet, and we have
1590        --allow-non-selfsigned-uid set, then force it valid. */
1591     if(!pk->is_valid && opt.allow_non_selfsigned_uid)
1592       {
1593         if(opt.verbose)
1594           log_info(_("Invalid key %08lX made valid by "
1595                      "--allow-non-selfsigned-uid\n"),
1596                    (ulong)keyid_from_pk(pk,NULL));
1597
1598         pk->is_valid = 1;
1599       }
1600
1601     /* The key STILL isn't valid, so try and find an ultimately
1602        trusted signature. */
1603     if(!pk->is_valid)
1604       {
1605         uidnode=NULL;
1606
1607         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k=k->next)
1608           {
1609             if ( k->pkt->pkttype == PKT_USER_ID )
1610               uidnode = k;
1611             else if ( k->pkt->pkttype == PKT_SIGNATURE && uidnode )
1612               {
1613                 PKT_signature *sig = k->pkt->pkt.signature;
1614
1615                 if(sig->keyid[0] != kid[0] || sig->keyid[1]!=kid[1])
1616                   {
1617                     PKT_public_key *ultimate_pk;
1618
1619                     ultimate_pk=m_alloc_clear(sizeof(*ultimate_pk));
1620
1621                     /* We don't want to use the full get_pubkey to
1622                        avoid infinite recursion in certain cases.
1623                        There is no reason to check that an ultimately
1624                        trusted key is still valid - if it has been
1625                        revoked or the user should also renmove the
1626                        ultimate trust flag.  */
1627                     if(get_pubkey_fast(ultimate_pk,sig->keyid)==0
1628                        && check_key_signature2(keyblock,k,ultimate_pk,
1629                                                NULL,NULL,NULL,NULL)==0
1630                        && get_ownertrust(ultimate_pk)==TRUST_ULTIMATE)
1631                       {
1632                         free_public_key(ultimate_pk);
1633                         pk->is_valid=1;
1634                         break;
1635                       }
1636
1637                     free_public_key(ultimate_pk);
1638                   }
1639               }
1640           }
1641       }
1642
1643     /* Record the highest selfsig version so we know if this is a v3
1644        key through and through, or a v3 key with a v4 selfsig
1645        somewhere.  This is useful in a few places to know if the key
1646        must be treated as PGP2-style or OpenPGP-style.  Note that a
1647        selfsig revocation with a higher version number will also raise
1648        this value.  This is okay since such a revocation must be
1649        issued by the user (i.e. it cannot be issued by someone else to
1650        modify the key behavior.) */
1651
1652     pk->selfsigversion=sigversion;
1653
1654     /* Now that we had a look at all user IDs we can now get some information
1655      * from those user IDs.
1656      */
1657     
1658     if ( !key_usage ) {
1659         /* find the latest user ID with key flags set */
1660         uiddate = 0; /* helper to find the latest user ID */
1661         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1662             k = k->next ) {
1663             if ( k->pkt->pkttype == PKT_USER_ID ) {
1664                 PKT_user_id *uid = k->pkt->pkt.user_id;
1665                 if ( uid->help_key_usage && uid->created > uiddate ) {
1666                     key_usage = uid->help_key_usage;
1667                     uiddate = uid->created;
1668                 }
1669             }
1670         }
1671     }
1672     if ( !key_usage ) { /* no key flags at all: get it from the algo */
1673         key_usage = openpgp_pk_algo_usage ( pk->pubkey_algo );
1674     }
1675     else { /* check that the usage matches the usage as given by the algo */
1676         int x = openpgp_pk_algo_usage ( pk->pubkey_algo );
1677         if ( x ) /* mask it down to the actual allowed usage */
1678             key_usage &= x; 
1679     }
1680
1681     /* Type 20 Elgamal keys are not usable. */
1682     if(pk->pubkey_algo==PUBKEY_ALGO_ELGAMAL)
1683       key_usage=0;
1684
1685     pk->pubkey_usage = key_usage;
1686
1687     if ( !key_expire_seen ) {
1688         /* find the latest valid user ID with a key expiration set 
1689          * Note, that this may be a different one from the above because
1690          * some user IDs may have no expiration date set */
1691         uiddate = 0; 
1692         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1693             k = k->next ) {
1694             if ( k->pkt->pkttype == PKT_USER_ID ) {
1695                 PKT_user_id *uid = k->pkt->pkt.user_id;
1696                 if ( uid->help_key_expire && uid->created > uiddate ) {
1697                     key_expire = uid->help_key_expire;
1698                     uiddate = uid->created;
1699                 }
1700             }
1701         }
1702     }
1703
1704     /* Currently only v3 keys have a maximum expiration date, but I'll
1705        bet v5 keys get this feature again. */
1706     if(key_expire==0 || (pk->max_expiredate && key_expire>pk->max_expiredate))
1707       key_expire=pk->max_expiredate;
1708
1709     pk->has_expired = key_expire >= curtime? 0 : key_expire;
1710     pk->expiredate = key_expire;
1711
1712     /* Fixme: we should see how to get rid of the expiretime fields  but
1713      * this needs changes at other places too. */
1714
1715     /* and now find the real primary user ID and delete all others */
1716     uiddate = uiddate2 = 0;
1717     uidnode = uidnode2 = NULL;
1718     for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next ) {
1719         if ( k->pkt->pkttype == PKT_USER_ID &&
1720              !k->pkt->pkt.user_id->attrib_data) {
1721             PKT_user_id *uid = k->pkt->pkt.user_id;
1722             if (uid->is_primary)
1723               {
1724                 if(uid->created > uiddate)
1725                   {
1726                     uiddate = uid->created;
1727                     uidnode = k;
1728                   }
1729                 else if(uid->created==uiddate && uidnode)
1730                   {
1731                     /* The dates are equal, so we need to do a
1732                        different (and arbitrary) comparison.  This
1733                        should rarely, if ever, happen.  It's good to
1734                        try and guarantee that two different GnuPG
1735                        users with two different keyrings at least pick
1736                        the same primary. */
1737                     if(cmp_user_ids(uid,uidnode->pkt->pkt.user_id)>0)
1738                       uidnode=k;
1739                   }
1740               }
1741             else
1742               {
1743                 if(uid->created > uiddate2)
1744                   {
1745                     uiddate2 = uid->created;
1746                     uidnode2 = k;
1747                   }
1748                 else if(uid->created==uiddate2 && uidnode2)
1749                   {
1750                     if(cmp_user_ids(uid,uidnode2->pkt->pkt.user_id)>0)
1751                       uidnode2=k;
1752                   }
1753               }
1754         }
1755     }
1756     if ( uidnode ) {
1757         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1758             k = k->next ) {
1759             if ( k->pkt->pkttype == PKT_USER_ID &&
1760                  !k->pkt->pkt.user_id->attrib_data) {
1761                 PKT_user_id *uid = k->pkt->pkt.user_id;
1762                 if ( k != uidnode ) 
1763                     uid->is_primary = 0;
1764             }
1765         }
1766     }
1767     else if( uidnode2 ) {
1768         /* none is flagged primary - use the latest user ID we have,
1769            and disambiguate with the arbitrary packet comparison. */
1770         uidnode2->pkt->pkt.user_id->is_primary = 1;
1771     }
1772     else
1773       {
1774         /* None of our uids were self-signed, so pick the one that
1775            sorts first to be the primary.  This is the best we can do
1776            here since there are no self sigs to date the uids. */
1777
1778         uidnode = NULL;
1779
1780         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1781             k = k->next )
1782           {
1783             if(k->pkt->pkttype==PKT_USER_ID
1784                && !k->pkt->pkt.user_id->attrib_data)
1785               {
1786                 if(!uidnode)
1787                   {
1788                     uidnode=k;
1789                     uidnode->pkt->pkt.user_id->is_primary=1;
1790                     continue;
1791                   }
1792                 else
1793                   {
1794                     if(cmp_user_ids(k->pkt->pkt.user_id,
1795                                     uidnode->pkt->pkt.user_id)>0)
1796                       {
1797                         uidnode->pkt->pkt.user_id->is_primary=0;
1798                         uidnode=k;
1799                         uidnode->pkt->pkt.user_id->is_primary=1;
1800                       }
1801                     else
1802                       k->pkt->pkt.user_id->is_primary=0; /* just to be
1803                                                             safe */
1804                   }
1805               }
1806           }
1807       }
1808 }
1809
1810
1811 static void
1812 merge_selfsigs_subkey( KBNODE keyblock, KBNODE subnode )
1813 {
1814     PKT_public_key *mainpk = NULL, *subpk = NULL;
1815     PKT_signature *sig;
1816     KBNODE k;
1817     u32 mainkid[2];
1818     u32 sigdate = 0;
1819     KBNODE signode;
1820     u32 curtime = make_timestamp ();
1821     unsigned int key_usage = 0;
1822     u32 keytimestamp = 0;
1823     u32 key_expire = 0;
1824     const byte *p;
1825     size_t n;
1826
1827     if ( subnode->pkt->pkttype != PKT_PUBLIC_SUBKEY )
1828         BUG ();
1829     mainpk = keyblock->pkt->pkt.public_key;
1830     if ( mainpk->version < 4 )
1831         return; /* (actually this should never happen) */
1832     keyid_from_pk( mainpk, mainkid );
1833     subpk = subnode->pkt->pkt.public_key;
1834     keytimestamp = subpk->timestamp;
1835
1836     subpk->is_valid = 0;
1837     subpk->main_keyid[0] = mainpk->main_keyid[0];
1838     subpk->main_keyid[1] = mainpk->main_keyid[1];
1839
1840     /* find the latest key binding self-signature. */
1841     signode = NULL;
1842     sigdate = 0; /* helper to find the latest signature */
1843     for(k=subnode->next; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1844                                                         k = k->next ) {
1845         if ( k->pkt->pkttype == PKT_SIGNATURE ) {
1846             sig = k->pkt->pkt.signature;
1847             if ( sig->keyid[0] == mainkid[0] && sig->keyid[1]==mainkid[1] ) { 
1848                 if ( check_key_signature( keyblock, k, NULL ) )
1849                     ; /* signature did not verify */
1850                 else if ( IS_SUBKEY_REV (sig) ) {
1851                   /* Note that this means that the date on a
1852                      revocation sig does not matter - even if the
1853                      binding sig is dated after the revocation sig,
1854                      the subkey is still marked as revoked.  This
1855                      seems ok, as it is just as easy to make new
1856                      subkeys rather than re-sign old ones as the
1857                      problem is in the distribution.  Plus, PGP (7)
1858                      does this the same way.  */
1859                     subpk->is_revoked = 1;
1860                     /* although we could stop now, we continue to 
1861                      * figure out other information like the old expiration
1862                      * time */
1863                 }
1864                 else if ( IS_SUBKEY_SIG (sig) && sig->timestamp >= sigdate ) {
1865                     if(sig->flags.expired)
1866                         ; /* signature has expired - ignore it */
1867                     else {
1868                         sigdate = sig->timestamp;
1869                         signode = k;
1870                     }
1871                 }
1872             }
1873         }
1874     }
1875
1876     if ( !signode ) {
1877         return;  /* no valid key binding */
1878     }
1879
1880     subpk->is_valid = 1;
1881     sig = signode->pkt->pkt.signature;
1882         
1883     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_FLAGS, &n );
1884     if ( p && n ) {
1885         /* first octet of the keyflags */   
1886         if ( (*p & 3) )
1887             key_usage |= PUBKEY_USAGE_SIG;
1888         if ( (*p & 12) )    
1889             key_usage |= PUBKEY_USAGE_ENC;
1890         if ( (*p & 0x20) )    
1891             key_usage |= PUBKEY_USAGE_AUTH;
1892     }
1893     if ( !key_usage ) { /* no key flags at all: get it from the algo */
1894         key_usage = openpgp_pk_algo_usage ( subpk->pubkey_algo );
1895     }
1896     else { /* check that the usage matches the usage as given by the algo */
1897         int x = openpgp_pk_algo_usage ( subpk->pubkey_algo );
1898         if ( x ) /* mask it down to the actual allowed usage */
1899             key_usage &= x; 
1900     }
1901
1902     /* Type 20 Elgamal subkeys or any subkey on a type 20 primary are
1903        not usable. */
1904     if(mainpk->pubkey_algo==PUBKEY_ALGO_ELGAMAL
1905        || subpk->pubkey_algo==PUBKEY_ALGO_ELGAMAL)
1906       key_usage=0;
1907
1908     subpk->pubkey_usage = key_usage;
1909     
1910     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
1911     if ( p ) 
1912         key_expire = keytimestamp + buffer_to_u32(p);
1913     else
1914         key_expire = 0;
1915     subpk->has_expired = key_expire >= curtime? 0 : key_expire;
1916     subpk->expiredate = key_expire;
1917 }
1918
1919
1920
1921 /* 
1922  * Merge information from the self-signatures with the key, so that
1923  * we can later use them more easy.
1924  * The function works by first applying the self signatures to the
1925  * primary key and the to each subkey.
1926  * Here are the rules we use to decide which inormation from which
1927  * self-signature is used:
1928  * We check all self signatures or validity and ignore all invalid signatures.
1929  * All signatures are then ordered by their creation date ....
1930  * For the primary key:
1931  *   FIXME the docs    
1932  */
1933 static void
1934 merge_selfsigs( KBNODE keyblock )
1935 {
1936     KBNODE k;
1937     int revoked;
1938     PKT_public_key *main_pk;
1939     prefitem_t *prefs;
1940     int mdc_feature;
1941
1942     if ( keyblock->pkt->pkttype != PKT_PUBLIC_KEY ) {
1943         if (keyblock->pkt->pkttype == PKT_SECRET_KEY ) {
1944             log_error ("expected public key but found secret key "
1945                        "- must stop\n");
1946             /* we better exit here becuase a public key is expected at
1947                other places too.  FIXME: Figure this out earlier and
1948                don't get to here at all */
1949             g10_exit (1);
1950         }
1951         BUG ();
1952     }
1953
1954     merge_selfsigs_main ( keyblock, &revoked );
1955
1956     /* now merge in the data from each of the subkeys */
1957     for(k=keyblock; k; k = k->next ) {
1958         if (  k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
1959             merge_selfsigs_subkey ( keyblock, k );
1960         }
1961     }
1962
1963     main_pk = keyblock->pkt->pkt.public_key;
1964     if ( revoked || main_pk->has_expired || !main_pk->is_valid ) {
1965         /* if the primary key is revoked, expired, or invalid we
1966          * better set the appropriate flags on that key and all
1967          * subkeys */
1968         for(k=keyblock; k; k = k->next ) {
1969             if ( k->pkt->pkttype == PKT_PUBLIC_KEY
1970                 || k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
1971                 PKT_public_key *pk = k->pkt->pkt.public_key;
1972                 if(!main_pk->is_valid)
1973                   pk->is_valid = 0;
1974                 if(revoked)
1975                   pk->is_revoked = 1;
1976                 if(main_pk->has_expired)
1977                   pk->has_expired = main_pk->has_expired;
1978             }
1979         }
1980         return;
1981     }
1982
1983     /* set the preference list of all keys to those of the primary real
1984      * user ID.  Note: we use these preferences when we don't know by
1985      * which user ID the key has been selected.
1986      * fixme: we should keep atoms of commonly used preferences or
1987      * use reference counting to optimize the preference lists storage.
1988      * FIXME: it might be better to use the intersection of 
1989      * all preferences.
1990      * Do a similar thing for the MDC feature flag.
1991      */
1992     prefs = NULL;
1993     mdc_feature = 0;
1994     for (k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next) {
1995         if (k->pkt->pkttype == PKT_USER_ID
1996             && !k->pkt->pkt.user_id->attrib_data
1997             && k->pkt->pkt.user_id->is_primary) {
1998             prefs = k->pkt->pkt.user_id->prefs;
1999             mdc_feature = k->pkt->pkt.user_id->mdc_feature;
2000             break;
2001         }
2002     }    
2003     for(k=keyblock; k; k = k->next ) {
2004         if ( k->pkt->pkttype == PKT_PUBLIC_KEY
2005              || k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
2006             PKT_public_key *pk = k->pkt->pkt.public_key;
2007             if (pk->prefs)
2008                 m_free (pk->prefs);
2009             pk->prefs = copy_prefs (prefs);
2010             pk->mdc_feature = mdc_feature;
2011         }
2012     }
2013 }
2014
2015
2016 /*
2017  * Merge the secret keys from secblock into the pubblock thereby
2018  * replacing the public (sub)keys with their secret counterparts Hmmm:
2019  * It might be better to get away from the concept of entire secret
2020  * keys at all and have a way to store just the real secret parts
2021  * from the key.
2022  */
2023 static void
2024 merge_public_with_secret ( KBNODE pubblock, KBNODE secblock )
2025 {
2026     KBNODE pub;
2027
2028     assert ( pubblock->pkt->pkttype == PKT_PUBLIC_KEY );
2029     assert ( secblock->pkt->pkttype == PKT_SECRET_KEY );
2030     
2031     for (pub=pubblock; pub; pub = pub->next ) {
2032         if ( pub->pkt->pkttype == PKT_PUBLIC_KEY ) {
2033              PKT_public_key *pk = pub->pkt->pkt.public_key;
2034              PKT_secret_key *sk = secblock->pkt->pkt.secret_key;
2035              assert ( pub == pubblock ); /* only in the first node */
2036              /* there is nothing to compare in this case, so just replace
2037               * some information */
2038              copy_public_parts_to_secret_key ( pk, sk );
2039              free_public_key ( pk );
2040              pub->pkt->pkttype = PKT_SECRET_KEY;
2041              pub->pkt->pkt.secret_key = copy_secret_key (NULL, sk);
2042         }
2043         else if ( pub->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
2044             KBNODE sec;
2045             PKT_public_key *pk = pub->pkt->pkt.public_key;
2046
2047             /* this is more complicated: it may happen that the sequence
2048              * of the subkeys dosn't match, so we have to find the
2049              * appropriate secret key */
2050             for (sec=secblock->next; sec; sec = sec->next ) {
2051                 if ( sec->pkt->pkttype == PKT_SECRET_SUBKEY ) {
2052                     PKT_secret_key *sk = sec->pkt->pkt.secret_key;
2053                     if ( !cmp_public_secret_key ( pk, sk ) ) {
2054                         copy_public_parts_to_secret_key ( pk, sk );
2055                         free_public_key ( pk );
2056                         pub->pkt->pkttype = PKT_SECRET_SUBKEY;
2057                         pub->pkt->pkt.secret_key = copy_secret_key (NULL, sk);
2058                         break;
2059                     }
2060                 }
2061             }
2062             if ( !sec ) 
2063                 BUG(); /* already checked in premerge */
2064         }
2065     }
2066 }
2067
2068 /* This function checks that for every public subkey a corresponding
2069  * secret subkey is available and deletes the public subkey otherwise.
2070  * We need this function because we can't delete it later when we
2071  * actually merge the secret parts into the pubring.
2072  * The function also plays some games with the node flags.
2073  */
2074 static void
2075 premerge_public_with_secret ( KBNODE pubblock, KBNODE secblock )
2076 {
2077     KBNODE last, pub;
2078
2079     assert ( pubblock->pkt->pkttype == PKT_PUBLIC_KEY );
2080     assert ( secblock->pkt->pkttype == PKT_SECRET_KEY );
2081     
2082     for (pub=pubblock,last=NULL; pub; last = pub, pub = pub->next ) {
2083         pub->flag &= ~3; /* reset bits 0 and 1 */
2084         if ( pub->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
2085             KBNODE sec;
2086             PKT_public_key *pk = pub->pkt->pkt.public_key;
2087
2088             for (sec=secblock->next; sec; sec = sec->next ) {
2089                 if ( sec->pkt->pkttype == PKT_SECRET_SUBKEY ) {
2090                     PKT_secret_key *sk = sec->pkt->pkt.secret_key;
2091                     if ( !cmp_public_secret_key ( pk, sk ) ) {
2092                         if ( sk->protect.s2k.mode == 1001 ) {
2093                             /* The secret parts are not available so
2094                                we can't use that key for signing etc.
2095                                Fix the pubkey usage */
2096                             pk->pubkey_usage &= ~(PUBKEY_USAGE_SIG
2097                                                   |PUBKEY_USAGE_AUTH);
2098                         }
2099                         /* transfer flag bits 0 and 1 to the pubblock */
2100                         pub->flag |= (sec->flag &3);
2101                         break;
2102                     }
2103                 }
2104             }
2105             if ( !sec ) {
2106                 KBNODE next, ll;
2107
2108                 if (opt.verbose)
2109                   log_info ( _("no secret subkey "
2110                                "for public subkey %08lX - ignoring\n"),  
2111                            (ulong)keyid_from_pk (pk,NULL) );
2112                 /* we have to remove the subkey in this case */
2113                 assert ( last );
2114                 /* find the next subkey */
2115                 for (next=pub->next,ll=pub;
2116                      next && pub->pkt->pkttype != PKT_PUBLIC_SUBKEY;
2117                      ll = next, next = next->next ) 
2118                     ;
2119                 /* make new link */
2120                 last->next = next;
2121                 /* release this public subkey with all sigs */
2122                 ll->next = NULL;
2123                 release_kbnode( pub );
2124                 /* let the loop continue */
2125                 pub = last;
2126             }
2127         }
2128     }
2129     /* We need to copy the found bits (0 and 1) from the secret key to
2130        the public key.  This has already been done for the subkeys but
2131        got lost on the primary key - fix it here *. */
2132     pubblock->flag |= (secblock->flag & 3);
2133 }
2134
2135
2136
2137 \f
2138 /* See see whether the key fits
2139  * our requirements and in case we do not
2140  * request the primary key, we should select
2141  * a suitable subkey.
2142  * FIXME: Check against PGP 7 whether we still need a kludge
2143  *        to favor type 16 keys over type 20 keys when type 20
2144  *        has not been explitely requested.
2145  * Returns: True when a suitable key has been found.
2146  *
2147  * We have to distinguish four cases:  FIXME!
2148  *  1. No usage and no primary key requested
2149  *     Examples for this case are that we have a keyID to be used
2150  *     for decrytion or verification.
2151  *  2. No usage but primary key requested
2152  *     This is the case for all functions which work on an
2153  *     entire keyblock, e.g. for editing or listing
2154  *  3. Usage and primary key requested
2155  *     FXME
2156  *  4. Usage but no primary key requested
2157  *     FIXME
2158  * FIXME: Tell what is going to happen here and something about the rationale
2159  * Note: We don't use this function if no specific usage is requested;
2160  *       This way the getkey functions can be used for plain key listings.
2161  *
2162  * CTX ist the keyblock we are investigating, if FOUNDK is not NULL this
2163  * is the key we actually found by looking at the keyid or a fingerprint and
2164  * may eitehr point to the primary or one of the subkeys.
2165  */
2166
2167 static int
2168 finish_lookup (GETKEY_CTX ctx)
2169 {
2170     KBNODE keyblock = ctx->keyblock;
2171     KBNODE k;
2172     KBNODE foundk = NULL;
2173     PKT_user_id *foundu = NULL;
2174 #define USAGE_MASK  (PUBKEY_USAGE_SIG|PUBKEY_USAGE_ENC)
2175     unsigned int req_usage = ( ctx->req_usage & USAGE_MASK );
2176     /* Request the primary if we're certifying another key, and also
2177        if signing data while --pgp6 or --pgp7 is on since pgp 6 and 7
2178        do not understand signatures made by a signing subkey.  PGP 8
2179        does. */
2180     int req_prim = (ctx->req_usage & PUBKEY_USAGE_CERT) ||
2181       ((PGP6 || PGP7) && (ctx->req_usage & PUBKEY_USAGE_SIG));
2182     u32 latest_date;
2183     KBNODE latest_key;
2184     u32 curtime = make_timestamp ();
2185
2186     assert( keyblock->pkt->pkttype == PKT_PUBLIC_KEY );
2187    
2188     ctx->found_key = NULL;
2189
2190     if (ctx->exact) {
2191         for (k=keyblock; k; k = k->next) {
2192             if ( (k->flag & 1) ) {
2193                 assert ( k->pkt->pkttype == PKT_PUBLIC_KEY
2194                          || k->pkt->pkttype == PKT_PUBLIC_SUBKEY );
2195                 foundk = k;
2196                 break;
2197             }
2198         }
2199     }
2200
2201     for (k=keyblock; k; k = k->next) {
2202         if ( (k->flag & 2) ) {
2203             assert (k->pkt->pkttype == PKT_USER_ID);
2204             foundu = k->pkt->pkt.user_id;
2205             break;
2206         }
2207     }
2208
2209     if ( DBG_CACHE )
2210         log_debug( "finish_lookup: checking key %08lX (%s)(req_usage=%x)\n",
2211                    (ulong)keyid_from_pk( keyblock->pkt->pkt.public_key, NULL),
2212                    foundk? "one":"all", req_usage);
2213
2214     if (!req_usage) {
2215         latest_key = foundk? foundk:keyblock;
2216         goto found;
2217     }
2218     
2219     if (!req_usage) {
2220         PKT_public_key *pk = foundk->pkt->pkt.public_key;
2221         if (pk->user_id)
2222             free_user_id (pk->user_id);
2223         pk->user_id = scopy_user_id (foundu);
2224         ctx->found_key = foundk;
2225         cache_user_id( keyblock );
2226         return 1; /* found */
2227     }
2228     
2229     latest_date = 0;
2230     latest_key  = NULL;
2231     /* do not look at subkeys if a certification key is requested */
2232     if ((!foundk || foundk->pkt->pkttype == PKT_PUBLIC_SUBKEY) && !req_prim) {
2233         KBNODE nextk;
2234         /* either start a loop or check just this one subkey */
2235         for (k=foundk?foundk:keyblock; k; k = nextk ) {
2236             PKT_public_key *pk;
2237             nextk = k->next;
2238             if ( k->pkt->pkttype != PKT_PUBLIC_SUBKEY )
2239                 continue;
2240             if ( foundk )
2241                 nextk = NULL;  /* what a hack */
2242             pk = k->pkt->pkt.public_key;
2243             if (DBG_CACHE)
2244                 log_debug( "\tchecking subkey %08lX\n",
2245                            (ulong)keyid_from_pk( pk, NULL));
2246             if ( !pk->is_valid ) {
2247                 if (DBG_CACHE)
2248                     log_debug( "\tsubkey not valid\n");
2249                 continue;
2250             }
2251             if ( pk->is_revoked ) {
2252                 if (DBG_CACHE)
2253                     log_debug( "\tsubkey has been revoked\n");
2254                 continue;
2255             }
2256             if ( pk->has_expired ) {
2257                 if (DBG_CACHE)
2258                     log_debug( "\tsubkey has expired\n");
2259                 continue;
2260             }
2261             if ( pk->timestamp > curtime && !opt.ignore_valid_from ) {
2262                 if (DBG_CACHE)
2263                     log_debug( "\tsubkey not yet valid\n");
2264                 continue;
2265             }
2266             
2267             if ( !((pk->pubkey_usage&USAGE_MASK) & req_usage) ) {
2268                 if (DBG_CACHE)
2269                     log_debug( "\tusage does not match: want=%x have=%x\n",
2270                                req_usage, pk->pubkey_usage );
2271                 continue;
2272             }
2273
2274             if (DBG_CACHE)
2275                 log_debug( "\tsubkey looks fine\n");
2276             if ( pk->timestamp > latest_date ) {
2277                 latest_date = pk->timestamp;
2278                 latest_key  = k;
2279             }
2280         }
2281     }
2282
2283     /* Okay now try the primary key unless we want an exact 
2284      * key ID match on a subkey */
2285     if ((!latest_key && !(ctx->exact && foundk != keyblock)) || req_prim) {
2286         PKT_public_key *pk;
2287         if (DBG_CACHE && !foundk && !req_prim )
2288             log_debug( "\tno suitable subkeys found - trying primary\n");
2289         pk = keyblock->pkt->pkt.public_key;
2290         if ( !pk->is_valid ) {
2291             if (DBG_CACHE)
2292                 log_debug( "\tprimary key not valid\n");
2293         }
2294         else if ( pk->is_revoked ) {
2295             if (DBG_CACHE)
2296                 log_debug( "\tprimary key has been revoked\n");
2297         }
2298         else if ( pk->has_expired ) {
2299             if (DBG_CACHE)
2300                 log_debug( "\tprimary key has expired\n");
2301         }
2302         else  if ( !((pk->pubkey_usage&USAGE_MASK) & req_usage) ) {
2303             if (DBG_CACHE)
2304                 log_debug( "\tprimary key usage does not match: "
2305                            "want=%x have=%x\n",
2306                            req_usage, pk->pubkey_usage );
2307         }
2308         else { /* okay */
2309             if (DBG_CACHE)
2310                 log_debug( "\tprimary key may be used\n");
2311             latest_key = keyblock;
2312             latest_date = pk->timestamp;
2313         }
2314     }
2315     
2316     if ( !latest_key ) {
2317         if (DBG_CACHE)
2318             log_debug("\tno suitable key found -  giving up\n");
2319         return 0;
2320     }
2321
2322  found:
2323     if (DBG_CACHE)
2324         log_debug( "\tusing key %08lX\n",
2325                 (ulong)keyid_from_pk( latest_key->pkt->pkt.public_key, NULL) );
2326
2327     if (latest_key) {
2328         PKT_public_key *pk = latest_key->pkt->pkt.public_key;
2329         if (pk->user_id)
2330             free_user_id (pk->user_id);
2331         pk->user_id = scopy_user_id (foundu);
2332     }    
2333         
2334     ctx->found_key = latest_key;
2335
2336     if (latest_key != keyblock && opt.verbose) {
2337         log_info(_("using secondary key %08lX "
2338                    "instead of primary key %08lX\n"),
2339                  (ulong)keyid_from_pk( latest_key->pkt->pkt.public_key, NULL),
2340                  (ulong)keyid_from_pk( keyblock->pkt->pkt.public_key, NULL) );
2341     }
2342
2343     cache_user_id( keyblock );
2344     
2345     return 1; /* found */
2346 }
2347
2348
2349 static int
2350 lookup( GETKEY_CTX ctx, KBNODE *ret_keyblock, int secmode )
2351 {
2352     int rc;
2353     KBNODE secblock = NULL; /* helper */
2354     int no_suitable_key = 0;
2355     
2356     rc = 0;
2357     while (!(rc = keydb_search (ctx->kr_handle, ctx->items, ctx->nitems))) {
2358         /* If we are searching for the first key we have to make sure
2359            that the next interation does not no an implicit reset.
2360            This can be triggered by an empty key ring. */
2361         if (ctx->nitems && ctx->items->mode == KEYDB_SEARCH_MODE_FIRST)
2362             ctx->items->mode = KEYDB_SEARCH_MODE_NEXT;
2363
2364         rc = keydb_get_keyblock (ctx->kr_handle, &ctx->keyblock);
2365         if (rc) {
2366             log_error ("keydb_get_keyblock failed: %s\n", g10_errstr(rc));
2367             rc = 0;
2368             goto skip;
2369         }
2370                        
2371         if ( secmode ) {
2372             /* find the correspondig public key and use this 
2373              * this one for the selection process */
2374             u32 aki[2];
2375             KBNODE k = ctx->keyblock;
2376             
2377             if (k->pkt->pkttype != PKT_SECRET_KEY)
2378                 BUG();
2379
2380             keyid_from_sk (k->pkt->pkt.secret_key, aki);
2381             k = get_pubkeyblock (aki);
2382             if( !k ) {
2383                 if (!opt.quiet)
2384                     log_info(_("key %08lX: secret key without public key "
2385                                "- skipped\n"),  (ulong)aki[1] );
2386                 goto skip;
2387             }
2388             secblock = ctx->keyblock;
2389             ctx->keyblock = k;
2390
2391             premerge_public_with_secret ( ctx->keyblock, secblock );
2392         }
2393
2394         /* warning: node flag bits 0 and 1 should be preserved by
2395          * merge_selfsigs.  For secret keys, premerge did tranfer the
2396          * keys to the keyblock */
2397         merge_selfsigs ( ctx->keyblock );
2398         if ( finish_lookup (ctx) ) {
2399             no_suitable_key = 0;
2400             if ( secmode ) {
2401                 merge_public_with_secret ( ctx->keyblock,
2402                                            secblock);
2403                 release_kbnode (secblock);
2404                 secblock = NULL;
2405             }
2406             goto found;
2407         }
2408         else
2409             no_suitable_key = 1;
2410         
2411       skip:
2412         /* release resources and continue search */
2413         if ( secmode ) {
2414             release_kbnode( secblock );
2415             secblock = NULL;
2416         }
2417         release_kbnode( ctx->keyblock );
2418         ctx->keyblock = NULL;
2419     }
2420
2421   found:
2422     if( rc && rc != -1 )
2423         log_error("keydb_search failed: %s\n", g10_errstr(rc));
2424
2425     if( !rc ) {
2426         *ret_keyblock = ctx->keyblock; /* return the keyblock */
2427         ctx->keyblock = NULL;
2428     }
2429     else if (rc == -1 && no_suitable_key)
2430         rc = secmode ? G10ERR_UNU_SECKEY : G10ERR_UNU_PUBKEY;
2431     else if( rc == -1 )
2432         rc = secmode ? G10ERR_NO_SECKEY : G10ERR_NO_PUBKEY;
2433
2434     if ( secmode ) {
2435         release_kbnode( secblock );
2436         secblock = NULL;
2437     }
2438     release_kbnode( ctx->keyblock );
2439     ctx->keyblock = NULL;
2440
2441     ctx->last_rc = rc;
2442     return rc;
2443 }
2444
2445
2446
2447
2448 /****************
2449  * FIXME: Replace by the generic function 
2450  *        It does not work as it is right now - it is used at 
2451  *        2 places:  a) to get the key for an anonyous recipient
2452  *                   b) to get the ultimately trusted keys.
2453  *        The a) usage might have some problems.
2454  *
2455  * set with_subkeys true to include subkeys
2456  * set with_spm true to include secret-parts-missing keys
2457  *
2458  * Enumerate all primary secret keys.  Caller must use these procedure:
2459  *  1) create a void pointer and initialize it to NULL
2460  *  2) pass this void pointer by reference to this function
2461  *     and provide space for the secret key (pass a buffer for sk)
2462  *  3) call this function as long as it does not return -1
2463  *     to indicate EOF.
2464  *  4) Always call this function a last time with SK set to NULL,
2465  *     so that can free it's context.
2466  */
2467 int
2468 enum_secret_keys( void **context, PKT_secret_key *sk,
2469                   int with_subkeys, int with_spm )
2470 {
2471     int rc=0;
2472     struct {
2473         int eof;
2474         int first;
2475         KEYDB_HANDLE hd;
2476         KBNODE keyblock;
2477         KBNODE node;
2478     } *c = *context;
2479
2480
2481     if( !c ) { /* make a new context */
2482         c = m_alloc_clear( sizeof *c );
2483         *context = c;
2484         c->hd = keydb_new (1);
2485         c->first = 1;
2486         c->keyblock = NULL;
2487         c->node = NULL;
2488     }
2489
2490     if( !sk ) { /* free the context */
2491         keydb_release (c->hd);
2492         release_kbnode (c->keyblock);
2493         m_free( c );
2494         *context = NULL;
2495         return 0;
2496     }
2497
2498     if( c->eof )
2499         return -1;
2500
2501     do {
2502         /* get the next secret key from the current keyblock */
2503         for (; c->node; c->node = c->node->next) {
2504             if ((c->node->pkt->pkttype == PKT_SECRET_KEY
2505                 || (with_subkeys
2506                     && c->node->pkt->pkttype == PKT_SECRET_SUBKEY) )
2507                 && !(c->node->pkt->pkt.secret_key->protect.s2k.mode==1001
2508                      && !with_spm)) {
2509                 copy_secret_key (sk, c->node->pkt->pkt.secret_key );
2510                 c->node = c->node->next;
2511                 return 0; /* found */
2512             }
2513         }
2514         release_kbnode (c->keyblock);
2515         c->keyblock = c->node = NULL;
2516         
2517         rc = c->first? keydb_search_first (c->hd) : keydb_search_next (c->hd);
2518         c->first = 0;
2519         if (rc) {
2520             keydb_release (c->hd); c->hd = NULL;
2521             c->eof = 1;
2522             return -1; /* eof */
2523         }
2524         
2525         rc = keydb_get_keyblock (c->hd, &c->keyblock);
2526         c->node = c->keyblock;
2527     } while (!rc);
2528
2529     return rc; /* error */
2530 }
2531
2532
2533 \f
2534 /*********************************************
2535  ***********  user ID printing helpers *******
2536  *********************************************/
2537
2538 /****************
2539  * Return a string with a printable representation of the user_id.
2540  * this string must be freed by m_free.
2541  */
2542 char*
2543 get_user_id_string( u32 *keyid )
2544 {
2545     user_id_db_t r;
2546     char *p;
2547     int pass=0;
2548     /* try it two times; second pass reads from key resources */
2549     do {
2550         for(r=user_id_db; r; r = r->next ) {
2551             keyid_list_t a;
2552             for (a=r->keyids; a; a= a->next ) {
2553                 if( a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1] ) {
2554                     p = m_alloc( r->len + 10 );
2555                     sprintf(p, "%08lX %.*s",
2556                             (ulong)keyid[1], r->len, r->name );
2557                     return p;
2558                 }
2559             }
2560         }
2561     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
2562     p = m_alloc( 15 );
2563     sprintf(p, "%08lX [?]", (ulong)keyid[1] );
2564     return p;
2565 }
2566
2567
2568 char*
2569 get_user_id_string_printable ( u32 *keyid )
2570 {
2571     char *p = get_user_id_string( keyid );
2572     char *p2 = utf8_to_native( p, strlen(p), 0 );
2573     m_free(p);
2574     p = make_printable_string (p2, strlen (p2), 0);
2575     m_free (p2);
2576     return p;
2577 }
2578
2579
2580 char*
2581 get_long_user_id_string( u32 *keyid )
2582 {
2583     user_id_db_t r;
2584     char *p;
2585     int pass=0;
2586     /* try it two times; second pass reads from key resources */
2587     do {
2588         for(r=user_id_db; r; r = r->next ) {
2589             keyid_list_t a;
2590             for (a=r->keyids; a; a= a->next ) {
2591                 if( a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1] ) {
2592                     p = m_alloc( r->len + 20 );
2593                     sprintf(p, "%08lX%08lX %.*s",
2594                             (ulong)keyid[0], (ulong)keyid[1],
2595                             r->len, r->name );
2596                     return p;
2597                 }
2598             }
2599         }
2600     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
2601     p = m_alloc( 25 );
2602     sprintf(p, "%08lX%08lX [?]", (ulong)keyid[0], (ulong)keyid[1] );
2603     return p;
2604 }
2605
2606 char*
2607 get_user_id( u32 *keyid, size_t *rn )
2608 {
2609     user_id_db_t r;
2610     char *p;
2611     int pass=0;
2612
2613     /* try it two times; second pass reads from key resources */
2614     do {
2615         for(r=user_id_db; r; r = r->next ) {
2616             keyid_list_t a;
2617             for (a=r->keyids; a; a= a->next ) {
2618                 if( a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1] ) {
2619                     p = m_alloc( r->len );
2620                     memcpy(p, r->name, r->len );
2621                     *rn = r->len;
2622                     return p;
2623                 }
2624             }
2625         }
2626     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
2627     p = m_strdup( _("[User id not found]") );
2628     *rn = strlen(p);
2629     return p;
2630 }
2631
2632 char*
2633 get_user_id_printable( u32 *keyid )
2634 {
2635     size_t rn;
2636     char *p = get_user_id( keyid, &rn );
2637     char *p2 = utf8_to_native( p, rn, 0 );
2638     m_free(p);
2639     p = make_printable_string (p2, strlen (p2), 0);
2640     m_free (p2);
2641     return p;
2642 }
2643
2644 KEYDB_HANDLE
2645 get_ctx_handle(GETKEY_CTX ctx)
2646 {
2647   return ctx->kr_handle;
2648 }