* keydb.h, keyring.c (keyring_search), trustdb.c (search_skipfnc): Expand
[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     }
1283
1284     /* ditto or the key expiration */
1285     uid->help_key_expire = 0;
1286     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
1287     if ( p ) { 
1288         uid->help_key_expire = keycreated + buffer_to_u32(p);
1289     }
1290
1291     /* Set the primary user ID flag - we will later wipe out some
1292      * of them to only have one in our keyblock */
1293     uid->is_primary = 0;
1294     p = parse_sig_subpkt ( sig->hashed, SIGSUBPKT_PRIMARY_UID, NULL );
1295     if ( p && *p )
1296         uid->is_primary = 2;
1297     /* We could also query this from the unhashed area if it is not in
1298      * the hased area and then later try to decide which is the better
1299      * there should be no security problem with this.
1300      * For now we only look at the hashed one. 
1301      */
1302
1303     /* Now build the preferences list.  These must come from the
1304        hashed section so nobody can modify the ciphers a key is
1305        willing to accept. */
1306     p = parse_sig_subpkt ( sig->hashed, SIGSUBPKT_PREF_SYM, &n );
1307     sym = p; nsym = p?n:0;
1308     p = parse_sig_subpkt ( sig->hashed, SIGSUBPKT_PREF_HASH, &n );
1309     hash = p; nhash = p?n:0;
1310     p = parse_sig_subpkt ( sig->hashed, SIGSUBPKT_PREF_COMPR, &n );
1311     zip = p; nzip = p?n:0;
1312     if (uid->prefs) 
1313         m_free (uid->prefs);
1314     n = nsym + nhash + nzip;
1315     if (!n)
1316         uid->prefs = NULL;
1317     else {
1318         uid->prefs = m_alloc (sizeof (*uid->prefs) * (n+1));
1319         n = 0;
1320         for (; nsym; nsym--, n++) {
1321             uid->prefs[n].type = PREFTYPE_SYM;
1322             uid->prefs[n].value = *sym++;
1323         }
1324         for (; nhash; nhash--, n++) {
1325             uid->prefs[n].type = PREFTYPE_HASH;
1326             uid->prefs[n].value = *hash++;
1327         }
1328         for (; nzip; nzip--, n++) {
1329             uid->prefs[n].type = PREFTYPE_ZIP;
1330             uid->prefs[n].value = *zip++;
1331         }
1332         uid->prefs[n].type = PREFTYPE_NONE; /* end of list marker */
1333         uid->prefs[n].value = 0;
1334     }
1335
1336     /* see whether we have the MDC feature */
1337     uid->mdc_feature = 0;
1338     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_FEATURES, &n);
1339     if (p && n && (p[0] & 0x01))
1340         uid->mdc_feature = 1;
1341
1342     /* and the keyserver modify flag */
1343     uid->ks_modify = 1;
1344     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KS_FLAGS, &n);
1345     if (p && n && (p[0] & 0x80))
1346         uid->ks_modify = 0;
1347 }
1348
1349 static void
1350 merge_selfsigs_main( KBNODE keyblock, int *r_revoked )
1351 {
1352     PKT_public_key *pk = NULL;
1353     KBNODE k;
1354     u32 kid[2];
1355     u32 sigdate, uiddate, uiddate2;
1356     KBNODE signode, uidnode, uidnode2;
1357     u32 curtime = make_timestamp ();
1358     unsigned int key_usage = 0;
1359     u32 keytimestamp = 0;
1360     u32 key_expire = 0;
1361     int key_expire_seen = 0;
1362     byte sigversion = 0;
1363
1364     *r_revoked = 0;
1365     if ( keyblock->pkt->pkttype != PKT_PUBLIC_KEY )
1366         BUG ();
1367     pk = keyblock->pkt->pkt.public_key;
1368     keytimestamp = pk->timestamp;
1369
1370     keyid_from_pk( pk, kid );
1371     pk->main_keyid[0] = kid[0];
1372     pk->main_keyid[1] = kid[1];
1373
1374     if ( pk->version < 4 ) {
1375         /* before v4 the key packet itself contains the expiration
1376          * date and there was no way to change it, so we start with
1377          * the one from the key packet */
1378         key_expire = pk->max_expiredate;
1379         key_expire_seen = 1;
1380     }
1381
1382     /* first pass: find the latest direct key self-signature.
1383      * We assume that the newest one overrides all others
1384      */
1385
1386     /* In case this key was already merged */
1387     m_free(pk->revkey);
1388     pk->revkey=NULL;
1389     pk->numrevkeys=0;
1390
1391     signode = NULL;
1392     sigdate = 0; /* helper to find the latest signature */
1393     for(k=keyblock; k && k->pkt->pkttype != PKT_USER_ID; k = k->next ) {
1394         if ( k->pkt->pkttype == PKT_SIGNATURE ) {
1395             PKT_signature *sig = k->pkt->pkt.signature;
1396             if ( sig->keyid[0] == kid[0] && sig->keyid[1]==kid[1] ) { 
1397                 if ( check_key_signature( keyblock, k, NULL ) )
1398                     ; /* signature did not verify */
1399                 else if ( IS_KEY_REV (sig) ){
1400                     /* key has been revoked - there is no way to override
1401                      * such a revocation, so we theoretically can stop now.
1402                      * We should not cope with expiration times for revocations
1403                      * here because we have to assume that an attacker can
1404                      * generate all kinds of signatures.  However due to the
1405                      * fact that the key has been revoked it does not harm
1406                      * either and by continuing we gather some more info on 
1407                      * that key.
1408                      */ 
1409                     *r_revoked = 1;
1410                 }
1411                 else if ( IS_KEY_SIG (sig) ) {
1412                   /* Add any revocation keys onto the pk.  This is
1413                      particularly interesting since we normally only
1414                      get data from the most recent 1F signature, but
1415                      you need multiple 1F sigs to properly handle
1416                      revocation keys (PGP does it this way, and a
1417                      revocation key could be sensitive and hence in a
1418                      different signature). */
1419                   if(sig->revkey) {
1420                     int i;
1421
1422                     pk->revkey=
1423                       m_realloc(pk->revkey,sizeof(struct revocation_key)*
1424                                 (pk->numrevkeys+sig->numrevkeys));
1425
1426                     for(i=0;i<sig->numrevkeys;i++)
1427                       memcpy(&pk->revkey[pk->numrevkeys++],
1428                              sig->revkey[i],
1429                              sizeof(struct revocation_key));
1430                   }
1431
1432                   if( sig->timestamp >= sigdate ) {
1433                     if(sig->flags.expired)
1434                         ; /* signature has expired - ignore it */
1435                     else {
1436                         sigdate = sig->timestamp;
1437                         signode = k;
1438                         if( sig->version > sigversion )
1439                           sigversion = sig->version;
1440
1441                     }
1442                   }
1443                 }
1444             }
1445         }
1446     }
1447
1448     /* Remove dupes from the revocation keys */
1449
1450     if(pk->revkey)
1451       {
1452         int i,j,x,changed=0;
1453
1454         for(i=0;i<pk->numrevkeys;i++)
1455           {
1456             for(j=i+1;j<pk->numrevkeys;j++)
1457               {
1458                 if(memcmp(&pk->revkey[i],&pk->revkey[j],
1459                           sizeof(struct revocation_key))==0)
1460                   {
1461                     /* remove j */
1462
1463                     for(x=j;x<pk->numrevkeys-1;x++)
1464                       pk->revkey[x]=pk->revkey[x+1];
1465
1466                     pk->numrevkeys--;
1467                     j--;
1468                     changed=1;
1469                   }
1470               }
1471           }
1472
1473         if(changed)
1474           pk->revkey=m_realloc(pk->revkey,
1475                                pk->numrevkeys*sizeof(struct revocation_key));
1476       }
1477
1478     if ( signode ) {
1479         /* some information from a direct key signature take precedence
1480          * over the same information given in UID sigs.
1481          */
1482         PKT_signature *sig = signode->pkt->pkt.signature;
1483         const byte *p;
1484         size_t n;
1485         
1486         p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_FLAGS, &n );
1487         if ( p && n ) {
1488             /* first octet of the keyflags */   
1489             if ( (*p & 3) )
1490                 key_usage |= PUBKEY_USAGE_SIG;
1491             if ( (*p & 12) )    
1492                 key_usage |= PUBKEY_USAGE_ENC;
1493         }
1494
1495         p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
1496         if ( p ) {
1497           key_expire = keytimestamp + buffer_to_u32(p);
1498           key_expire_seen = 1;
1499         }
1500
1501         /* mark that key as valid: one direct key signature should 
1502          * render a key as valid */
1503         pk->is_valid = 1;
1504     }
1505
1506     /* pass 1.5: look for key revocation signatures that were not made
1507        by the key (i.e. did a revocation key issue a revocation for
1508        us?).  Only bother to do this if there is a revocation key in
1509        the first place. */
1510
1511     if(pk->revkey)
1512       for(k=keyblock; k && k->pkt->pkttype != PKT_USER_ID; k = k->next )
1513         {
1514           if ( k->pkt->pkttype == PKT_SIGNATURE )
1515             {
1516               PKT_signature *sig = k->pkt->pkt.signature;
1517
1518               if(IS_KEY_REV(sig) &&
1519                  (sig->keyid[0]!=kid[0] || sig->keyid[1]!=kid[1]))
1520                 { 
1521                   /* Failure here means the sig did not verify, is was
1522                      not issued by a revocation key, or a revocation
1523                      key loop was broken. */
1524
1525                   if(check_revocation_keys(pk,sig)==0)
1526                     *r_revoked=1;
1527
1528                   /* In the future handle subkey and cert revocations?
1529                      PGP doesn't, but it's in 2440. */
1530                 }
1531             }
1532         }
1533
1534     /* second pass: look at the self-signature of all user IDs */
1535     signode = uidnode = NULL;
1536     sigdate = 0; /* helper to find the latest signature in one user ID */
1537     for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next ) {
1538         if ( k->pkt->pkttype == PKT_USER_ID ) {
1539             if ( uidnode && signode ) 
1540               {
1541                 fixup_uidnode ( uidnode, signode, keytimestamp );
1542                 pk->is_valid=1;
1543               }
1544             uidnode = k;
1545             signode = NULL;
1546             sigdate = 0;
1547         }
1548         else if ( k->pkt->pkttype == PKT_SIGNATURE && uidnode ) {
1549             PKT_signature *sig = k->pkt->pkt.signature;
1550             if ( sig->keyid[0] == kid[0] && sig->keyid[1]==kid[1] ) { 
1551                 if ( check_key_signature( keyblock, k, NULL ) )
1552                     ; /* signature did not verify */
1553                 else if ( (IS_UID_SIG (sig) || IS_UID_REV (sig))
1554                           && sig->timestamp >= sigdate ) {
1555                     /* Note: we allow to invalidate cert revocations
1556                      * by a newer signature.  An attacker can't use this
1557                      * because a key should be revoced with a key revocation.
1558                      * The reason why we have to allow for that is that at
1559                      * one time an email address may become invalid but later
1560                      * the same email address may become valid again (hired,
1561                      * fired, hired again).
1562                      */
1563                     if(sig->flags.expired) {
1564                       /* Expired uids don't get to be primary unless
1565                          they are the only uid there is. */
1566                       uidnode->pkt->pkt.user_id->is_primary=0;
1567                       uidnode->pkt->pkt.user_id->is_expired=1;
1568                       uidnode->pkt->pkt.user_id->expiredate=sig->expiredate;
1569                     }
1570                     else {
1571                         sigdate = sig->timestamp;
1572                         signode = k;
1573                         if( sig->version > sigversion )
1574                           sigversion = sig->version;
1575                     }
1576                 }
1577             }
1578         }
1579     }
1580     if ( uidnode && signode ) {
1581         fixup_uidnode ( uidnode, signode, keytimestamp );
1582         pk->is_valid = 1;
1583     }
1584
1585     /* If the key isn't valid yet, and we have
1586        --allow-non-selfsigned-uid set, then force it valid. */
1587     if(!pk->is_valid && opt.allow_non_selfsigned_uid)
1588       {
1589         if(opt.verbose)
1590           log_info(_("Invalid key %08lX made valid by "
1591                      "--allow-non-selfsigned-uid\n"),
1592                    (ulong)keyid_from_pk(pk,NULL));
1593
1594         pk->is_valid = 1;
1595       }
1596
1597     /* The key STILL isn't valid, so try and find an ultimately
1598        trusted signature. */
1599     if(!pk->is_valid)
1600       {
1601         uidnode=NULL;
1602
1603         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k=k->next)
1604           {
1605             if ( k->pkt->pkttype == PKT_USER_ID )
1606               uidnode = k;
1607             else if ( k->pkt->pkttype == PKT_SIGNATURE && uidnode )
1608               {
1609                 PKT_signature *sig = k->pkt->pkt.signature;
1610
1611                 if(sig->keyid[0] != kid[0] || sig->keyid[1]!=kid[1])
1612                   {
1613                     PKT_public_key *ultimate_pk;
1614
1615                     ultimate_pk=m_alloc_clear(sizeof(*ultimate_pk));
1616
1617                     /* We don't want to use the full get_pubkey to
1618                        avoid infinite recursion in certain cases.
1619                        There is no reason to check that an ultimately
1620                        trusted key is still valid - if it has been
1621                        revoked or the user should also renmove the
1622                        ultimate trust flag.  */
1623                     if(get_pubkey_fast(ultimate_pk,sig->keyid)==0
1624                        && check_key_signature2(keyblock,k,ultimate_pk,
1625                                                NULL,NULL,NULL,NULL)==0
1626                        && get_ownertrust(ultimate_pk)==TRUST_ULTIMATE)
1627                       {
1628                         free_public_key(ultimate_pk);
1629                         pk->is_valid=1;
1630                         break;
1631                       }
1632
1633                     free_public_key(ultimate_pk);
1634                   }
1635               }
1636           }
1637       }
1638
1639     /* Record the highest selfsig version so we know if this is a v3
1640        key through and through, or a v3 key with a v4 selfsig
1641        somewhere.  This is useful in a few places to know if the key
1642        must be treated as PGP2-style or OpenPGP-style.  Note that a
1643        selfsig revocation with a higher version number will also raise
1644        this value.  This is okay since such a revocation must be
1645        issued by the user (i.e. it cannot be issued by someone else to
1646        modify the key behavior.) */
1647
1648     pk->selfsigversion=sigversion;
1649
1650     /* Now that we had a look at all user IDs we can now get some information
1651      * from those user IDs.
1652      */
1653     
1654     if ( !key_usage ) {
1655         /* find the latest user ID with key flags set */
1656         uiddate = 0; /* helper to find the latest user ID */
1657         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1658             k = k->next ) {
1659             if ( k->pkt->pkttype == PKT_USER_ID ) {
1660                 PKT_user_id *uid = k->pkt->pkt.user_id;
1661                 if ( uid->help_key_usage && uid->created > uiddate ) {
1662                     key_usage = uid->help_key_usage;
1663                     uiddate = uid->created;
1664                 }
1665             }
1666         }
1667     }
1668     if ( !key_usage ) { /* no key flags at all: get it from the algo */
1669         key_usage = openpgp_pk_algo_usage ( pk->pubkey_algo );
1670     }
1671     else { /* check that the usage matches the usage as given by the algo */
1672         int x = openpgp_pk_algo_usage ( pk->pubkey_algo );
1673         if ( x ) /* mask it down to the actual allowed usage */
1674             key_usage &= x; 
1675     }
1676     pk->pubkey_usage = key_usage;
1677
1678     if ( !key_expire_seen ) {
1679         /* find the latest valid user ID with a key expiration set 
1680          * Note, that this may be a different one from the above because
1681          * some user IDs may have no expiration date set */
1682         uiddate = 0; 
1683         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1684             k = k->next ) {
1685             if ( k->pkt->pkttype == PKT_USER_ID ) {
1686                 PKT_user_id *uid = k->pkt->pkt.user_id;
1687                 if ( uid->help_key_expire && uid->created > uiddate ) {
1688                     key_expire = uid->help_key_expire;
1689                     uiddate = uid->created;
1690                 }
1691             }
1692         }
1693     }
1694
1695     /* Currently only v3 keys have a maximum expiration date, but I'll
1696        bet v5 keys get this feature again. */
1697     if(key_expire==0 || (pk->max_expiredate && key_expire>pk->max_expiredate))
1698       key_expire=pk->max_expiredate;
1699
1700     pk->has_expired = key_expire >= curtime? 0 : key_expire;
1701     pk->expiredate = key_expire;
1702
1703     /* Fixme: we should see how to get rid of the expiretime fields  but
1704      * this needs changes at other places too. */
1705
1706     /* and now find the real primary user ID and delete all others */
1707     uiddate = uiddate2 = 0;
1708     uidnode = uidnode2 = NULL;
1709     for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next ) {
1710         if ( k->pkt->pkttype == PKT_USER_ID &&
1711              !k->pkt->pkt.user_id->attrib_data) {
1712             PKT_user_id *uid = k->pkt->pkt.user_id;
1713             if (uid->is_primary)
1714               {
1715                 if(uid->created > uiddate)
1716                   {
1717                     uiddate = uid->created;
1718                     uidnode = k;
1719                   }
1720                 else if(uid->created==uiddate && uidnode)
1721                   {
1722                     /* The dates are equal, so we need to do a
1723                        different (and arbitrary) comparison.  This
1724                        should rarely, if ever, happen.  It's good to
1725                        try and guarantee that two different GnuPG
1726                        users with two different keyrings at least pick
1727                        the same primary. */
1728                     if(cmp_user_ids(uid,uidnode->pkt->pkt.user_id)>0)
1729                       uidnode=k;
1730                   }
1731               }
1732             else
1733               {
1734                 if(uid->created > uiddate2)
1735                   {
1736                     uiddate2 = uid->created;
1737                     uidnode2 = k;
1738                   }
1739                 else if(uid->created==uiddate2 && uidnode2)
1740                   {
1741                     if(cmp_user_ids(uid,uidnode2->pkt->pkt.user_id)>0)
1742                       uidnode2=k;
1743                   }
1744               }
1745         }
1746     }
1747     if ( uidnode ) {
1748         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1749             k = k->next ) {
1750             if ( k->pkt->pkttype == PKT_USER_ID &&
1751                  !k->pkt->pkt.user_id->attrib_data) {
1752                 PKT_user_id *uid = k->pkt->pkt.user_id;
1753                 if ( k != uidnode ) 
1754                     uid->is_primary = 0;
1755             }
1756         }
1757     }
1758     else if( uidnode2 ) {
1759         /* none is flagged primary - use the latest user ID we have,
1760            and disambiguate with the arbitrary packet comparison. */
1761         uidnode2->pkt->pkt.user_id->is_primary = 1;
1762     }
1763     else
1764       {
1765         /* None of our uids were self-signed, so pick the one that
1766            sorts first to be the primary.  This is the best we can do
1767            here since there are no self sigs to date the uids. */
1768
1769         uidnode = NULL;
1770
1771         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1772             k = k->next )
1773           {
1774             if(k->pkt->pkttype==PKT_USER_ID
1775                && !k->pkt->pkt.user_id->attrib_data)
1776               {
1777                 if(!uidnode)
1778                   {
1779                     uidnode=k;
1780                     uidnode->pkt->pkt.user_id->is_primary=1;
1781                     continue;
1782                   }
1783                 else
1784                   {
1785                     if(cmp_user_ids(k->pkt->pkt.user_id,
1786                                     uidnode->pkt->pkt.user_id)>0)
1787                       {
1788                         uidnode->pkt->pkt.user_id->is_primary=0;
1789                         uidnode=k;
1790                         uidnode->pkt->pkt.user_id->is_primary=1;
1791                       }
1792                     else
1793                       k->pkt->pkt.user_id->is_primary=0; /* just to be
1794                                                             safe */
1795                   }
1796               }
1797           }
1798       }
1799 }
1800
1801
1802 static void
1803 merge_selfsigs_subkey( KBNODE keyblock, KBNODE subnode )
1804 {
1805     PKT_public_key *mainpk = NULL, *subpk = NULL;
1806     PKT_signature *sig;
1807     KBNODE k;
1808     u32 mainkid[2];
1809     u32 sigdate = 0;
1810     KBNODE signode;
1811     u32 curtime = make_timestamp ();
1812     unsigned int key_usage = 0;
1813     u32 keytimestamp = 0;
1814     u32 key_expire = 0;
1815     const byte *p;
1816     size_t n;
1817
1818     if ( subnode->pkt->pkttype != PKT_PUBLIC_SUBKEY )
1819         BUG ();
1820     mainpk = keyblock->pkt->pkt.public_key;
1821     if ( mainpk->version < 4 )
1822         return; /* (actually this should never happen) */
1823     keyid_from_pk( mainpk, mainkid );
1824     subpk = subnode->pkt->pkt.public_key;
1825     keytimestamp = subpk->timestamp;
1826
1827     subpk->is_valid = 0;
1828     subpk->main_keyid[0] = mainpk->main_keyid[0];
1829     subpk->main_keyid[1] = mainpk->main_keyid[1];
1830
1831     /* find the latest key binding self-signature. */
1832     signode = NULL;
1833     sigdate = 0; /* helper to find the latest signature */
1834     for(k=subnode->next; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1835                                                         k = k->next ) {
1836         if ( k->pkt->pkttype == PKT_SIGNATURE ) {
1837             sig = k->pkt->pkt.signature;
1838             if ( sig->keyid[0] == mainkid[0] && sig->keyid[1]==mainkid[1] ) { 
1839                 if ( check_key_signature( keyblock, k, NULL ) )
1840                     ; /* signature did not verify */
1841                 else if ( IS_SUBKEY_REV (sig) ) {
1842                   /* Note that this means that the date on a
1843                      revocation sig does not matter - even if the
1844                      binding sig is dated after the revocation sig,
1845                      the subkey is still marked as revoked.  This
1846                      seems ok, as it is just as easy to make new
1847                      subkeys rather than re-sign old ones as the
1848                      problem is in the distribution.  Plus, PGP (7)
1849                      does this the same way.  */
1850                     subpk->is_revoked = 1;
1851                     /* although we could stop now, we continue to 
1852                      * figure out other information like the old expiration
1853                      * time */
1854                 }
1855                 else if ( IS_SUBKEY_SIG (sig) && sig->timestamp >= sigdate ) {
1856                     if(sig->flags.expired)
1857                         ; /* signature has expired - ignore it */
1858                     else {
1859                         sigdate = sig->timestamp;
1860                         signode = k;
1861                     }
1862                 }
1863             }
1864         }
1865     }
1866
1867     if ( !signode ) {
1868         return;  /* no valid key binding */
1869     }
1870
1871     subpk->is_valid = 1;
1872     sig = signode->pkt->pkt.signature;
1873         
1874     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_FLAGS, &n );
1875     if ( p && n ) {
1876         /* first octet of the keyflags */   
1877         if ( (*p & 3) )
1878             key_usage |= PUBKEY_USAGE_SIG;
1879         if ( (*p & 12) )    
1880             key_usage |= PUBKEY_USAGE_ENC;
1881     }
1882     if ( !key_usage ) { /* no key flags at all: get it from the algo */
1883         key_usage = openpgp_pk_algo_usage ( subpk->pubkey_algo );
1884     }
1885     else { /* check that the usage matches the usage as given by the algo */
1886         int x = openpgp_pk_algo_usage ( subpk->pubkey_algo );
1887         if ( x ) /* mask it down to the actual allowed usage */
1888             key_usage &= x; 
1889     }
1890     subpk->pubkey_usage = key_usage;
1891     
1892     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
1893     if ( p ) 
1894         key_expire = keytimestamp + buffer_to_u32(p);
1895     else
1896         key_expire = 0;
1897     subpk->has_expired = key_expire >= curtime? 0 : key_expire;
1898     subpk->expiredate = key_expire;
1899 }
1900
1901
1902
1903 /* 
1904  * Merge information from the self-signatures with the key, so that
1905  * we can later use them more easy.
1906  * The function works by first applying the self signatures to the
1907  * primary key and the to each subkey.
1908  * Here are the rules we use to decide which inormation from which
1909  * self-signature is used:
1910  * We check all self signatures or validity and ignore all invalid signatures.
1911  * All signatures are then ordered by their creation date ....
1912  * For the primary key:
1913  *   FIXME the docs    
1914  */
1915 static void
1916 merge_selfsigs( KBNODE keyblock )
1917 {
1918     KBNODE k;
1919     int revoked;
1920     PKT_public_key *main_pk;
1921     prefitem_t *prefs;
1922     int mdc_feature;
1923
1924     if ( keyblock->pkt->pkttype != PKT_PUBLIC_KEY ) {
1925         if (keyblock->pkt->pkttype == PKT_SECRET_KEY ) {
1926             log_error ("expected public key but found secret key "
1927                        "- must stop\n");
1928             /* we better exit here becuase a public key is expected at
1929                other places too.  FIXME: Figure this out earlier and
1930                don't get to here at all */
1931             g10_exit (1);
1932         }
1933         BUG ();
1934     }
1935
1936     merge_selfsigs_main ( keyblock, &revoked );
1937
1938     /* now merge in the data from each of the subkeys */
1939     for(k=keyblock; k; k = k->next ) {
1940         if (  k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
1941             merge_selfsigs_subkey ( keyblock, k );
1942         }
1943     }
1944
1945     main_pk = keyblock->pkt->pkt.public_key;
1946     if ( revoked || main_pk->has_expired || !main_pk->is_valid ) {
1947         /* if the primary key is revoked, expired, or invalid we
1948          * better set the appropriate flags on that key and all
1949          * subkeys */
1950         for(k=keyblock; k; k = k->next ) {
1951             if ( k->pkt->pkttype == PKT_PUBLIC_KEY
1952                 || k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
1953                 PKT_public_key *pk = k->pkt->pkt.public_key;
1954                 if(!main_pk->is_valid)
1955                   pk->is_valid = 0;
1956                 if(revoked)
1957                   pk->is_revoked = 1;
1958                 if(main_pk->has_expired)
1959                   pk->has_expired = main_pk->has_expired;
1960             }
1961         }
1962         return;
1963     }
1964
1965     /* set the preference list of all keys to those of the primary real
1966      * user ID.  Note: we use these preferences when we don't know by
1967      * which user ID the key has been selected.
1968      * fixme: we should keep atoms of commonly used preferences or
1969      * use reference counting to optimize the preference lists storage.
1970      * FIXME: it might be better to use the intersection of 
1971      * all preferences.
1972      * Do a similar thing for the MDC feature flag.
1973      */
1974     prefs = NULL;
1975     mdc_feature = 0;
1976     for (k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next) {
1977         if (k->pkt->pkttype == PKT_USER_ID
1978             && !k->pkt->pkt.user_id->attrib_data
1979             && k->pkt->pkt.user_id->is_primary) {
1980             prefs = k->pkt->pkt.user_id->prefs;
1981             mdc_feature = k->pkt->pkt.user_id->mdc_feature;
1982             break;
1983         }
1984     }    
1985     for(k=keyblock; k; k = k->next ) {
1986         if ( k->pkt->pkttype == PKT_PUBLIC_KEY
1987              || k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
1988             PKT_public_key *pk = k->pkt->pkt.public_key;
1989             if (pk->prefs)
1990                 m_free (pk->prefs);
1991             pk->prefs = copy_prefs (prefs);
1992             pk->mdc_feature = mdc_feature;
1993         }
1994     }
1995 }
1996
1997
1998 /*
1999  * Merge the secret keys from secblock into the pubblock thereby
2000  * replacing the public (sub)keys with their secret counterparts Hmmm:
2001  * It might be better to get away from the concept of entire secret
2002  * keys at all and have a way to store just the real secret parts
2003  * from the key.
2004  */
2005 static void
2006 merge_public_with_secret ( KBNODE pubblock, KBNODE secblock )
2007 {
2008     KBNODE pub;
2009
2010     assert ( pubblock->pkt->pkttype == PKT_PUBLIC_KEY );
2011     assert ( secblock->pkt->pkttype == PKT_SECRET_KEY );
2012     
2013     for (pub=pubblock; pub; pub = pub->next ) {
2014         if ( pub->pkt->pkttype == PKT_PUBLIC_KEY ) {
2015              PKT_public_key *pk = pub->pkt->pkt.public_key;
2016              PKT_secret_key *sk = secblock->pkt->pkt.secret_key;
2017              assert ( pub == pubblock ); /* only in the first node */
2018              /* there is nothing to compare in this case, so just replace
2019               * some information */
2020              copy_public_parts_to_secret_key ( pk, sk );
2021              free_public_key ( pk );
2022              pub->pkt->pkttype = PKT_SECRET_KEY;
2023              pub->pkt->pkt.secret_key = copy_secret_key (NULL, sk);
2024         }
2025         else if ( pub->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
2026             KBNODE sec;
2027             PKT_public_key *pk = pub->pkt->pkt.public_key;
2028
2029             /* this is more complicated: it may happen that the sequence
2030              * of the subkeys dosn't match, so we have to find the
2031              * appropriate secret key */
2032             for (sec=secblock->next; sec; sec = sec->next ) {
2033                 if ( sec->pkt->pkttype == PKT_SECRET_SUBKEY ) {
2034                     PKT_secret_key *sk = sec->pkt->pkt.secret_key;
2035                     if ( !cmp_public_secret_key ( pk, sk ) ) {
2036                         copy_public_parts_to_secret_key ( pk, sk );
2037                         free_public_key ( pk );
2038                         pub->pkt->pkttype = PKT_SECRET_SUBKEY;
2039                         pub->pkt->pkt.secret_key = copy_secret_key (NULL, sk);
2040                         break;
2041                     }
2042                 }
2043             }
2044             if ( !sec ) 
2045                 BUG(); /* already checked in premerge */
2046         }
2047     }
2048 }
2049
2050 /* This function checks that for every public subkey a corresponding
2051  * secret subkey is available and deletes the public subkey otherwise.
2052  * We need this function because we can't delete it later when we
2053  * actually merge the secret parts into the pubring.
2054  * The function also plays some games with the node flags.
2055  */
2056 static void
2057 premerge_public_with_secret ( KBNODE pubblock, KBNODE secblock )
2058 {
2059     KBNODE last, pub;
2060
2061     assert ( pubblock->pkt->pkttype == PKT_PUBLIC_KEY );
2062     assert ( secblock->pkt->pkttype == PKT_SECRET_KEY );
2063     
2064     for (pub=pubblock,last=NULL; pub; last = pub, pub = pub->next ) {
2065         pub->flag &= ~3; /* reset bits 0 and 1 */
2066         if ( pub->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
2067             KBNODE sec;
2068             PKT_public_key *pk = pub->pkt->pkt.public_key;
2069
2070             for (sec=secblock->next; sec; sec = sec->next ) {
2071                 if ( sec->pkt->pkttype == PKT_SECRET_SUBKEY ) {
2072                     PKT_secret_key *sk = sec->pkt->pkt.secret_key;
2073                     if ( !cmp_public_secret_key ( pk, sk ) ) {
2074                         if ( sk->protect.s2k.mode == 1001 ) {
2075                             /* The secret parts are not available so
2076                                we can't use that key for signing etc.
2077                                Fix the pubkey usage */
2078                             pk->pubkey_usage &= ~PUBKEY_USAGE_SIG;
2079                         }
2080                         /* transfer flag bits 0 and 1 to the pubblock */
2081                         pub->flag |= (sec->flag &3);
2082                         break;
2083                     }
2084                 }
2085             }
2086             if ( !sec ) {
2087                 KBNODE next, ll;
2088
2089                 if (opt.verbose)
2090                   log_info ( _("no secret subkey "
2091                                "for public subkey %08lX - ignoring\n"),  
2092                            (ulong)keyid_from_pk (pk,NULL) );
2093                 /* we have to remove the subkey in this case */
2094                 assert ( last );
2095                 /* find the next subkey */
2096                 for (next=pub->next,ll=pub;
2097                      next && pub->pkt->pkttype != PKT_PUBLIC_SUBKEY;
2098                      ll = next, next = next->next ) 
2099                     ;
2100                 /* make new link */
2101                 last->next = next;
2102                 /* release this public subkey with all sigs */
2103                 ll->next = NULL;
2104                 release_kbnode( pub );
2105                 /* let the loop continue */
2106                 pub = last;
2107             }
2108         }
2109     }
2110     /* We need to copy the found bits (0 and 1) from the secret key to
2111        the public key.  This has already been done for the subkeys but
2112        got lost on the primary key - fix it here *. */
2113     pubblock->flag |= (secblock->flag & 3);
2114 }
2115
2116
2117
2118 \f
2119 /* See see whether the key fits
2120  * our requirements and in case we do not
2121  * request the primary key, we should select
2122  * a suitable subkey.
2123  * FIXME: Check against PGP 7 whether we still need a kludge
2124  *        to favor type 16 keys over type 20 keys when type 20
2125  *        has not been explitely requested.
2126  * Returns: True when a suitable key has been found.
2127  *
2128  * We have to distinguish four cases:  FIXME!
2129  *  1. No usage and no primary key requested
2130  *     Examples for this case are that we have a keyID to be used
2131  *     for decrytion or verification.
2132  *  2. No usage but primary key requested
2133  *     This is the case for all functions which work on an
2134  *     entire keyblock, e.g. for editing or listing
2135  *  3. Usage and primary key requested
2136  *     FXME
2137  *  4. Usage but no primary key requested
2138  *     FIXME
2139  * FIXME: Tell what is going to happen here and something about the rationale
2140  * Note: We don't use this function if no specific usage is requested;
2141  *       This way the getkey functions can be used for plain key listings.
2142  *
2143  * CTX ist the keyblock we are investigating, if FOUNDK is not NULL this
2144  * is the key we actually found by looking at the keyid or a fingerprint and
2145  * may eitehr point to the primary or one of the subkeys.
2146  */
2147
2148 static int
2149 finish_lookup (GETKEY_CTX ctx)
2150 {
2151     KBNODE keyblock = ctx->keyblock;
2152     KBNODE k;
2153     KBNODE foundk = NULL;
2154     PKT_user_id *foundu = NULL;
2155 #define USAGE_MASK  (PUBKEY_USAGE_SIG|PUBKEY_USAGE_ENC)
2156     unsigned int req_usage = ( ctx->req_usage & USAGE_MASK );
2157     /* Request the primary if we're certifying another key, and also
2158        if signing data while --pgp6 or --pgp7 is on since pgp 6 and 7
2159        do not understand signatures made by a signing subkey.  PGP 8
2160        does. */
2161     int req_prim = (ctx->req_usage & PUBKEY_USAGE_CERT) ||
2162       ((PGP6 || PGP7) && (ctx->req_usage & PUBKEY_USAGE_SIG));
2163     u32 latest_date;
2164     KBNODE latest_key;
2165     u32 curtime = make_timestamp ();
2166
2167     assert( keyblock->pkt->pkttype == PKT_PUBLIC_KEY );
2168    
2169     ctx->found_key = NULL;
2170
2171     if (ctx->exact) {
2172         for (k=keyblock; k; k = k->next) {
2173             if ( (k->flag & 1) ) {
2174                 assert ( k->pkt->pkttype == PKT_PUBLIC_KEY
2175                          || k->pkt->pkttype == PKT_PUBLIC_SUBKEY );
2176                 foundk = k;
2177                 break;
2178             }
2179         }
2180     }
2181
2182     for (k=keyblock; k; k = k->next) {
2183         if ( (k->flag & 2) ) {
2184             assert (k->pkt->pkttype == PKT_USER_ID);
2185             foundu = k->pkt->pkt.user_id;
2186             break;
2187         }
2188     }
2189
2190     if ( DBG_CACHE )
2191         log_debug( "finish_lookup: checking key %08lX (%s)(req_usage=%x)\n",
2192                    (ulong)keyid_from_pk( keyblock->pkt->pkt.public_key, NULL),
2193                    foundk? "one":"all", req_usage);
2194
2195     if (!req_usage) {
2196         latest_key = foundk? foundk:keyblock;
2197         goto found;
2198     }
2199     
2200     if (!req_usage) {
2201         PKT_public_key *pk = foundk->pkt->pkt.public_key;
2202         if (pk->user_id)
2203             free_user_id (pk->user_id);
2204         pk->user_id = scopy_user_id (foundu);
2205         ctx->found_key = foundk;
2206         cache_user_id( keyblock );
2207         return 1; /* found */
2208     }
2209     
2210     latest_date = 0;
2211     latest_key  = NULL;
2212     /* do not look at subkeys if a certification key is requested */
2213     if ((!foundk || foundk->pkt->pkttype == PKT_PUBLIC_SUBKEY) && !req_prim) {
2214         KBNODE nextk;
2215         /* either start a loop or check just this one subkey */
2216         for (k=foundk?foundk:keyblock; k; k = nextk ) {
2217             PKT_public_key *pk;
2218             nextk = k->next;
2219             if ( k->pkt->pkttype != PKT_PUBLIC_SUBKEY )
2220                 continue;
2221             if ( foundk )
2222                 nextk = NULL;  /* what a hack */
2223             pk = k->pkt->pkt.public_key;
2224             if (DBG_CACHE)
2225                 log_debug( "\tchecking subkey %08lX\n",
2226                            (ulong)keyid_from_pk( pk, NULL));
2227             if ( !pk->is_valid ) {
2228                 if (DBG_CACHE)
2229                     log_debug( "\tsubkey not valid\n");
2230                 continue;
2231             }
2232             if ( pk->is_revoked ) {
2233                 if (DBG_CACHE)
2234                     log_debug( "\tsubkey has been revoked\n");
2235                 continue;
2236             }
2237             if ( pk->has_expired ) {
2238                 if (DBG_CACHE)
2239                     log_debug( "\tsubkey has expired\n");
2240                 continue;
2241             }
2242             if ( pk->timestamp > curtime && !opt.ignore_valid_from ) {
2243                 if (DBG_CACHE)
2244                     log_debug( "\tsubkey not yet valid\n");
2245                 continue;
2246             }
2247             
2248             if ( !((pk->pubkey_usage&USAGE_MASK) & req_usage) ) {
2249                 if (DBG_CACHE)
2250                     log_debug( "\tusage does not match: want=%x have=%x\n",
2251                                req_usage, pk->pubkey_usage );
2252                 continue;
2253             }
2254
2255             if (DBG_CACHE)
2256                 log_debug( "\tsubkey looks fine\n");
2257             if ( pk->timestamp > latest_date ) {
2258                 latest_date = pk->timestamp;
2259                 latest_key  = k;
2260             }
2261         }
2262     }
2263
2264     /* Okay now try the primary key unless we want an exact 
2265      * key ID match on a subkey */
2266     if ((!latest_key && !(ctx->exact && foundk != keyblock)) || req_prim) {
2267         PKT_public_key *pk;
2268         if (DBG_CACHE && !foundk && !req_prim )
2269             log_debug( "\tno suitable subkeys found - trying primary\n");
2270         pk = keyblock->pkt->pkt.public_key;
2271         if ( !pk->is_valid ) {
2272             if (DBG_CACHE)
2273                 log_debug( "\tprimary key not valid\n");
2274         }
2275         else if ( pk->is_revoked ) {
2276             if (DBG_CACHE)
2277                 log_debug( "\tprimary key has been revoked\n");
2278         }
2279         else if ( pk->has_expired ) {
2280             if (DBG_CACHE)
2281                 log_debug( "\tprimary key has expired\n");
2282         }
2283         else  if ( !((pk->pubkey_usage&USAGE_MASK) & req_usage) ) {
2284             if (DBG_CACHE)
2285                 log_debug( "\tprimary key usage does not match: "
2286                            "want=%x have=%x\n",
2287                            req_usage, pk->pubkey_usage );
2288         }
2289         else { /* okay */
2290             if (DBG_CACHE)
2291                 log_debug( "\tprimary key may be used\n");
2292             latest_key = keyblock;
2293             latest_date = pk->timestamp;
2294         }
2295     }
2296     
2297     if ( !latest_key ) {
2298         if (DBG_CACHE)
2299             log_debug("\tno suitable key found -  giving up\n");
2300         return 0;
2301     }
2302
2303  found:
2304     if (DBG_CACHE)
2305         log_debug( "\tusing key %08lX\n",
2306                 (ulong)keyid_from_pk( latest_key->pkt->pkt.public_key, NULL) );
2307
2308     if (latest_key) {
2309         PKT_public_key *pk = latest_key->pkt->pkt.public_key;
2310         if (pk->user_id)
2311             free_user_id (pk->user_id);
2312         pk->user_id = scopy_user_id (foundu);
2313     }    
2314         
2315     ctx->found_key = latest_key;
2316
2317     if (latest_key != keyblock && opt.verbose) {
2318         log_info(_("using secondary key %08lX "
2319                    "instead of primary key %08lX\n"),
2320                  (ulong)keyid_from_pk( latest_key->pkt->pkt.public_key, NULL),
2321                  (ulong)keyid_from_pk( keyblock->pkt->pkt.public_key, NULL) );
2322     }
2323
2324     cache_user_id( keyblock );
2325     
2326     return 1; /* found */
2327 }
2328
2329
2330 static int
2331 lookup( GETKEY_CTX ctx, KBNODE *ret_keyblock, int secmode )
2332 {
2333     int rc;
2334     KBNODE secblock = NULL; /* helper */
2335     int no_suitable_key = 0;
2336     
2337     rc = 0;
2338     while (!(rc = keydb_search (ctx->kr_handle, ctx->items, ctx->nitems))) {
2339         /* If we are searching for the first key we have to make sure
2340            that the next interation does not no an implicit reset.
2341            This can be triggered by an empty key ring. */
2342         if (ctx->nitems && ctx->items->mode == KEYDB_SEARCH_MODE_FIRST)
2343             ctx->items->mode = KEYDB_SEARCH_MODE_NEXT;
2344
2345         rc = keydb_get_keyblock (ctx->kr_handle, &ctx->keyblock);
2346         if (rc) {
2347             log_error ("keydb_get_keyblock failed: %s\n", g10_errstr(rc));
2348             rc = 0;
2349             goto skip;
2350         }
2351                        
2352         if ( secmode ) {
2353             /* find the correspondig public key and use this 
2354              * this one for the selection process */
2355             u32 aki[2];
2356             KBNODE k = ctx->keyblock;
2357             
2358             if (k->pkt->pkttype != PKT_SECRET_KEY)
2359                 BUG();
2360
2361             keyid_from_sk (k->pkt->pkt.secret_key, aki);
2362             k = get_pubkeyblock (aki);
2363             if( !k ) {
2364                 if (!opt.quiet)
2365                     log_info(_("key %08lX: secret key without public key "
2366                                "- skipped\n"),  (ulong)aki[1] );
2367                 goto skip;
2368             }
2369             secblock = ctx->keyblock;
2370             ctx->keyblock = k;
2371
2372             premerge_public_with_secret ( ctx->keyblock, secblock );
2373         }
2374
2375         /* warning: node flag bits 0 and 1 should be preserved by
2376          * merge_selfsigs.  For secret keys, premerge did tranfer the
2377          * keys to the keyblock */
2378         merge_selfsigs ( ctx->keyblock );
2379         if ( finish_lookup (ctx) ) {
2380             no_suitable_key = 0;
2381             if ( secmode ) {
2382                 merge_public_with_secret ( ctx->keyblock,
2383                                            secblock);
2384                 release_kbnode (secblock);
2385                 secblock = NULL;
2386             }
2387             goto found;
2388         }
2389         else
2390             no_suitable_key = 1;
2391         
2392       skip:
2393         /* release resources and continue search */
2394         if ( secmode ) {
2395             release_kbnode( secblock );
2396             secblock = NULL;
2397         }
2398         release_kbnode( ctx->keyblock );
2399         ctx->keyblock = NULL;
2400     }
2401
2402   found:
2403     if( rc && rc != -1 )
2404         log_error("keydb_search failed: %s\n", g10_errstr(rc));
2405
2406     if( !rc ) {
2407         *ret_keyblock = ctx->keyblock; /* return the keyblock */
2408         ctx->keyblock = NULL;
2409     }
2410     else if (rc == -1 && no_suitable_key)
2411         rc = secmode ? G10ERR_UNU_SECKEY : G10ERR_UNU_PUBKEY;
2412     else if( rc == -1 )
2413         rc = secmode ? G10ERR_NO_SECKEY : G10ERR_NO_PUBKEY;
2414
2415     if ( secmode ) {
2416         release_kbnode( secblock );
2417         secblock = NULL;
2418     }
2419     release_kbnode( ctx->keyblock );
2420     ctx->keyblock = NULL;
2421
2422     ctx->last_rc = rc;
2423     return rc;
2424 }
2425
2426
2427
2428
2429 /****************
2430  * FIXME: Replace by the generic function 
2431  *        It does not work as it is right now - it is used at 
2432  *        2 places:  a) to get the key for an anonyous recipient
2433  *                   b) to get the ultimately trusted keys.
2434  *        The a) usage might have some problems.
2435  *
2436  * set with_subkeys true to include subkeys
2437  * set with_spm true to include secret-parts-missing keys
2438  *
2439  * Enumerate all primary secret keys.  Caller must use these procedure:
2440  *  1) create a void pointer and initialize it to NULL
2441  *  2) pass this void pointer by reference to this function
2442  *     and provide space for the secret key (pass a buffer for sk)
2443  *  3) call this function as long as it does not return -1
2444  *     to indicate EOF.
2445  *  4) Always call this function a last time with SK set to NULL,
2446  *     so that can free it's context.
2447  */
2448 int
2449 enum_secret_keys( void **context, PKT_secret_key *sk,
2450                   int with_subkeys, int with_spm )
2451 {
2452     int rc=0;
2453     struct {
2454         int eof;
2455         int first;
2456         KEYDB_HANDLE hd;
2457         KBNODE keyblock;
2458         KBNODE node;
2459     } *c = *context;
2460
2461
2462     if( !c ) { /* make a new context */
2463         c = m_alloc_clear( sizeof *c );
2464         *context = c;
2465         c->hd = keydb_new (1);
2466         c->first = 1;
2467         c->keyblock = NULL;
2468         c->node = NULL;
2469     }
2470
2471     if( !sk ) { /* free the context */
2472         keydb_release (c->hd);
2473         release_kbnode (c->keyblock);
2474         m_free( c );
2475         *context = NULL;
2476         return 0;
2477     }
2478
2479     if( c->eof )
2480         return -1;
2481
2482     do {
2483         /* get the next secret key from the current keyblock */
2484         for (; c->node; c->node = c->node->next) {
2485             if ((c->node->pkt->pkttype == PKT_SECRET_KEY
2486                 || (with_subkeys
2487                     && c->node->pkt->pkttype == PKT_SECRET_SUBKEY) )
2488                 && !(c->node->pkt->pkt.secret_key->protect.s2k.mode==1001
2489                      && !with_spm)) {
2490                 copy_secret_key (sk, c->node->pkt->pkt.secret_key );
2491                 c->node = c->node->next;
2492                 return 0; /* found */
2493             }
2494         }
2495         release_kbnode (c->keyblock);
2496         c->keyblock = c->node = NULL;
2497         
2498         rc = c->first? keydb_search_first (c->hd) : keydb_search_next (c->hd);
2499         c->first = 0;
2500         if (rc) {
2501             keydb_release (c->hd); c->hd = NULL;
2502             c->eof = 1;
2503             return -1; /* eof */
2504         }
2505         
2506         rc = keydb_get_keyblock (c->hd, &c->keyblock);
2507         c->node = c->keyblock;
2508     } while (!rc);
2509
2510     return rc; /* error */
2511 }
2512
2513
2514 \f
2515 /*********************************************
2516  ***********  user ID printing helpers *******
2517  *********************************************/
2518
2519 /****************
2520  * Return a string with a printable representation of the user_id.
2521  * this string must be freed by m_free.
2522  */
2523 char*
2524 get_user_id_string( u32 *keyid )
2525 {
2526     user_id_db_t r;
2527     char *p;
2528     int pass=0;
2529     /* try it two times; second pass reads from key resources */
2530     do {
2531         for(r=user_id_db; r; r = r->next ) {
2532             keyid_list_t a;
2533             for (a=r->keyids; a; a= a->next ) {
2534                 if( a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1] ) {
2535                     p = m_alloc( r->len + 10 );
2536                     sprintf(p, "%08lX %.*s",
2537                             (ulong)keyid[1], r->len, r->name );
2538                     return p;
2539                 }
2540             }
2541         }
2542     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
2543     p = m_alloc( 15 );
2544     sprintf(p, "%08lX [?]", (ulong)keyid[1] );
2545     return p;
2546 }
2547
2548
2549 char*
2550 get_user_id_string_printable ( u32 *keyid )
2551 {
2552     char *p = get_user_id_string( keyid );
2553     char *p2 = utf8_to_native( p, strlen(p), 0 );
2554     m_free(p);
2555     p = make_printable_string (p2, strlen (p2), 0);
2556     m_free (p2);
2557     return p;
2558 }
2559
2560
2561 char*
2562 get_long_user_id_string( u32 *keyid )
2563 {
2564     user_id_db_t r;
2565     char *p;
2566     int pass=0;
2567     /* try it two times; second pass reads from key resources */
2568     do {
2569         for(r=user_id_db; r; r = r->next ) {
2570             keyid_list_t a;
2571             for (a=r->keyids; a; a= a->next ) {
2572                 if( a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1] ) {
2573                     p = m_alloc( r->len + 20 );
2574                     sprintf(p, "%08lX%08lX %.*s",
2575                             (ulong)keyid[0], (ulong)keyid[1],
2576                             r->len, r->name );
2577                     return p;
2578                 }
2579             }
2580         }
2581     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
2582     p = m_alloc( 25 );
2583     sprintf(p, "%08lX%08lX [?]", (ulong)keyid[0], (ulong)keyid[1] );
2584     return p;
2585 }
2586
2587 char*
2588 get_user_id( u32 *keyid, size_t *rn )
2589 {
2590     user_id_db_t r;
2591     char *p;
2592     int pass=0;
2593
2594     /* try it two times; second pass reads from key resources */
2595     do {
2596         for(r=user_id_db; r; r = r->next ) {
2597             keyid_list_t a;
2598             for (a=r->keyids; a; a= a->next ) {
2599                 if( a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1] ) {
2600                     p = m_alloc( r->len );
2601                     memcpy(p, r->name, r->len );
2602                     *rn = r->len;
2603                     return p;
2604                 }
2605             }
2606         }
2607     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
2608     p = m_strdup( _("[User id not found]") );
2609     *rn = strlen(p);
2610     return p;
2611 }
2612
2613 char*
2614 get_user_id_printable( u32 *keyid )
2615 {
2616     size_t rn;
2617     char *p = get_user_id( keyid, &rn );
2618     char *p2 = utf8_to_native( p, rn, 0 );
2619     m_free(p);
2620     p = make_printable_string (p2, strlen (p2), 0);
2621     m_free (p2);
2622     return p;
2623 }
2624
2625 KEYDB_HANDLE
2626 get_ctx_handle(GETKEY_CTX ctx)
2627 {
2628   return ctx->kr_handle;
2629 }