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