Minor cleanups.
[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 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 and NAME is a valid RFC822 mailbox and --auto-key-locate
916    has been enabled, we try to import the key via the online mechanisms
917    defined by --auto-key-locate.  */
918 int
919 get_pubkey_byname (PKT_public_key *pk,
920                    const char *name, KBNODE *ret_keyblock,
921                    KEYDB_HANDLE *ret_kdbhd, int include_unusable )
922 {
923   int rc;
924   strlist_t namelist = NULL;
925
926   add_to_strlist( &namelist, name );
927
928   rc = key_byname( NULL, namelist, pk, NULL, 0,
929                    include_unusable, ret_keyblock, ret_kdbhd);
930
931   /* If the requested name resembles a valid mailbox and automatic
932      retrieval has been enabled, we try to import the key. */
933
934   if (rc == G10ERR_NO_PUBKEY && is_valid_mailbox(name))
935     {
936       struct akl *akl;
937
938       for(akl=opt.auto_key_locate;akl;akl=akl->next)
939         {
940           unsigned char *fpr=NULL;
941           size_t fpr_len;
942
943           switch(akl->type)
944             {
945             case AKL_CERT:
946               glo_ctrl.in_auto_key_retrieve++;
947               rc=keyserver_import_cert(name,&fpr,&fpr_len);
948               glo_ctrl.in_auto_key_retrieve--;
949
950               if(rc==0)
951                 log_info(_("automatically retrieved `%s' via %s\n"),
952                          name,"DNS CERT");
953               break;
954
955             case AKL_PKA:
956               glo_ctrl.in_auto_key_retrieve++;
957               rc=keyserver_import_pka(name,&fpr,&fpr_len);
958               glo_ctrl.in_auto_key_retrieve--;
959
960               if(rc==0)
961                 log_info(_("automatically retrieved `%s' via %s\n"),
962                          name,"PKA");
963               break;
964
965             case AKL_LDAP:
966               glo_ctrl.in_auto_key_retrieve++;
967               rc=keyserver_import_ldap(name,&fpr,&fpr_len);
968               glo_ctrl.in_auto_key_retrieve--;
969
970               if(rc==0)
971                 log_info(_("automatically retrieved `%s' via %s\n"),
972                          name,"LDAP");
973               break;
974
975             case AKL_KEYSERVER:
976               /* Strictly speaking, we don't need to only use a valid
977                  mailbox for the getname search, but it helps cut down
978                  on the problem of searching for something like "john"
979                  and getting a whole lot of keys back. */
980               if(opt.keyserver)
981                 {
982                   glo_ctrl.in_auto_key_retrieve++;
983                   rc=keyserver_import_name(name,&fpr,&fpr_len,opt.keyserver);
984                   glo_ctrl.in_auto_key_retrieve--;
985
986                   if(rc==0)
987                     log_info(_("automatically retrieved `%s' via %s\n"),
988                              name,opt.keyserver->uri);
989                 }
990               break;
991
992             case AKL_SPEC:
993               {
994                 struct keyserver_spec *keyserver;
995
996                 keyserver=keyserver_match(akl->spec);
997                 glo_ctrl.in_auto_key_retrieve++;
998                 rc=keyserver_import_name(name,&fpr,&fpr_len,keyserver);
999                 glo_ctrl.in_auto_key_retrieve--;
1000
1001                 if(rc==0)
1002                   log_info(_("automatically retrieved `%s' via %s\n"),
1003                            name,akl->spec->uri);
1004               }
1005               break;
1006             }
1007
1008           /* Use the fingerprint of the key that we actually fetched.
1009              This helps prevent problems where the key that we fetched
1010              doesn't have the same name that we used to fetch it.  In
1011              the case of CERT and PKA, this is an actual security
1012              requirement as the URL might point to a key put in by an
1013              attacker.  By forcing the use of the fingerprint, we
1014              won't use the attacker's key here. */
1015           if (!rc && fpr)
1016             {
1017               char fpr_string[MAX_FINGERPRINT_LEN*2+1];
1018
1019               assert(fpr_len<=MAX_FINGERPRINT_LEN);
1020
1021               free_strlist(namelist);
1022               namelist=NULL;
1023
1024               bin2hex (fpr, fpr_len, fpr_string);
1025               
1026               if(opt.verbose)
1027                 log_info("auto-key-locate found fingerprint %s\n",fpr_string);
1028
1029               add_to_strlist( &namelist, fpr_string );
1030
1031               xfree(fpr);
1032             }
1033
1034           rc = key_byname( NULL, namelist, pk, NULL, 0,
1035                            include_unusable, ret_keyblock, ret_kdbhd);
1036           if(rc!=G10ERR_NO_PUBKEY)
1037             break;
1038         }
1039     }
1040
1041   free_strlist( namelist );
1042   return rc;
1043 }
1044
1045 int
1046 get_pubkey_bynames( GETKEY_CTX *retctx, PKT_public_key *pk,
1047                     strlist_t names, KBNODE *ret_keyblock )
1048 {
1049     return key_byname( retctx, names, pk, NULL, 0, 1, ret_keyblock, NULL);
1050 }
1051
1052 int
1053 get_pubkey_next( GETKEY_CTX ctx, PKT_public_key *pk, KBNODE *ret_keyblock )
1054 {
1055     int rc;
1056
1057     rc = lookup( ctx, ret_keyblock, 0 );
1058     if ( !rc && pk && ret_keyblock )
1059         pk_from_block ( ctx, pk, *ret_keyblock );
1060     
1061     return rc;
1062 }
1063
1064 void
1065 get_pubkey_end( GETKEY_CTX ctx )
1066 {
1067     if( ctx ) {
1068         memset (&ctx->kbpos, 0, sizeof ctx->kbpos);
1069         keydb_release (ctx->kr_handle);
1070         if( !ctx->not_allocated )
1071             xfree( ctx );
1072     }
1073 }
1074
1075
1076 /****************
1077  * Search for a key with the given fingerprint.
1078  * FIXME:
1079  * We should replace this with the _byname function.  Thiscsan be done
1080  * by creating a userID conforming to the unified fingerprint style. 
1081  */
1082 int
1083 get_pubkey_byfprint( PKT_public_key *pk,
1084                      const byte *fprint, size_t fprint_len)
1085 {
1086     int rc;
1087
1088     if( fprint_len == 20 || fprint_len == 16 ) {
1089         struct getkey_ctx_s ctx;
1090         KBNODE kb = NULL;
1091
1092         memset( &ctx, 0, sizeof ctx );
1093         ctx.exact = 1 ;
1094         ctx.not_allocated = 1;
1095         ctx.kr_handle = keydb_new (0);
1096         ctx.nitems = 1;
1097         ctx.items[0].mode = fprint_len==16? KEYDB_SEARCH_MODE_FPR16
1098                                           : KEYDB_SEARCH_MODE_FPR20;
1099         memcpy( ctx.items[0].u.fpr, fprint, fprint_len );
1100         rc = lookup( &ctx, &kb, 0 );
1101         if (!rc && pk )
1102             pk_from_block ( &ctx, pk, kb );
1103         release_kbnode ( kb );
1104         get_pubkey_end( &ctx );
1105     }
1106     else
1107         rc = G10ERR_GENERAL; /* Oops */
1108     return rc;
1109 }
1110
1111
1112 /* Get a public key and store it into the allocated pk.  This function
1113    differs from get_pubkey_byfprint() in that it does not do a check
1114    of the key to avoid recursion.  It should be used only in very
1115    certain cases.  PK may be NULL to check just for the existance of
1116    the key. */
1117 int
1118 get_pubkey_byfprint_fast (PKT_public_key *pk,
1119                           const byte *fprint, size_t fprint_len)
1120 {
1121   int rc = 0;
1122   KEYDB_HANDLE hd;
1123   KBNODE keyblock;
1124   byte fprbuf[MAX_FINGERPRINT_LEN];
1125   int i;
1126   
1127   for (i=0; i < MAX_FINGERPRINT_LEN && i < fprint_len; i++)
1128     fprbuf[i] = fprint[i];
1129   while (i < MAX_FINGERPRINT_LEN) 
1130     fprbuf[i++] = 0;
1131
1132   hd = keydb_new (0);
1133   rc = keydb_search_fpr (hd, fprbuf);
1134   if (rc == -1)
1135     {
1136       keydb_release (hd);
1137       return G10ERR_NO_PUBKEY;
1138     }
1139   rc = keydb_get_keyblock (hd, &keyblock);
1140   keydb_release (hd);
1141   if (rc) 
1142     {
1143       log_error ("keydb_get_keyblock failed: %s\n", g10_errstr(rc));
1144       return G10ERR_NO_PUBKEY;
1145     }
1146   
1147   assert ( keyblock->pkt->pkttype == PKT_PUBLIC_KEY
1148            ||  keyblock->pkt->pkttype == PKT_PUBLIC_SUBKEY );
1149   if (pk)
1150     copy_public_key (pk, keyblock->pkt->pkt.public_key );
1151   release_kbnode (keyblock);
1152
1153   /* Not caching key here since it won't have all of the fields
1154      properly set. */
1155
1156   return 0;
1157 }
1158
1159 /****************
1160  * Search for a key with the given fingerprint and return the
1161  * complete keyblock which may have more than only this key.
1162  */
1163 int
1164 get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
1165                                                 size_t fprint_len )
1166 {
1167     int rc;
1168
1169     if( fprint_len == 20 || fprint_len == 16 ) {
1170         struct getkey_ctx_s ctx;
1171
1172         memset( &ctx, 0, sizeof ctx );
1173         ctx.not_allocated = 1;
1174         ctx.kr_handle = keydb_new (0);
1175         ctx.nitems = 1;
1176         ctx.items[0].mode = fprint_len==16? KEYDB_SEARCH_MODE_FPR16
1177                                           : KEYDB_SEARCH_MODE_FPR20;
1178         memcpy( ctx.items[0].u.fpr, fprint, fprint_len );
1179         rc = lookup( &ctx, ret_keyblock, 0 );
1180         get_pubkey_end( &ctx );
1181     }
1182     else
1183         rc = G10ERR_GENERAL; /* Oops */
1184
1185     return rc;
1186 }
1187
1188
1189 /****************
1190  * Get a secret key by name and store it into sk
1191  * If NAME is NULL use the default key
1192  */
1193 static int
1194 get_seckey_byname2( GETKEY_CTX *retctx,
1195                     PKT_secret_key *sk, const char *name, int unprotect,
1196                     KBNODE *retblock )
1197 {
1198   strlist_t namelist = NULL;
1199   int rc,include_unusable=1;
1200
1201   /* If we have no name, try to use the default secret key.  If we
1202      have no default, we'll use the first usable one. */
1203
1204   if( !name && opt.def_secret_key && *opt.def_secret_key )
1205     add_to_strlist( &namelist, opt.def_secret_key );
1206   else if(name)
1207     add_to_strlist( &namelist, name );
1208   else
1209     include_unusable=0;
1210
1211   rc = key_byname( retctx, namelist, NULL, sk, 1, include_unusable,
1212                    retblock, NULL );
1213
1214   free_strlist( namelist );
1215
1216   if( !rc && unprotect )
1217     rc = check_secret_key( sk, 0 );
1218
1219   return rc;
1220 }
1221
1222 int 
1223 get_seckey_byname( PKT_secret_key *sk, const char *name, int unlock )
1224 {
1225     return get_seckey_byname2 ( NULL, sk, name, unlock, NULL );
1226 }
1227
1228
1229 int
1230 get_seckey_bynames( GETKEY_CTX *retctx, PKT_secret_key *sk,
1231                     strlist_t names, KBNODE *ret_keyblock )
1232 {
1233     return key_byname( retctx, names, NULL, sk, 1, 1, ret_keyblock, NULL );
1234 }
1235
1236
1237 int
1238 get_seckey_next( GETKEY_CTX ctx, PKT_secret_key *sk, KBNODE *ret_keyblock )
1239 {
1240     int rc;
1241
1242     rc = lookup( ctx, ret_keyblock, 1 );
1243     if ( !rc && sk && ret_keyblock )
1244         sk_from_block ( ctx, sk, *ret_keyblock );
1245
1246     return rc;
1247 }
1248
1249
1250 void
1251 get_seckey_end( GETKEY_CTX ctx )
1252 {
1253     get_pubkey_end( ctx );
1254 }
1255
1256
1257 /****************
1258  * Search for a key with the given fingerprint.
1259  * FIXME:
1260  * We should replace this with the _byname function.  Thiscsan be done
1261  * by creating a userID conforming to the unified fingerprint style. 
1262  */
1263 int
1264 get_seckey_byfprint( PKT_secret_key *sk,
1265                      const byte *fprint, size_t fprint_len)
1266 {
1267     int rc;
1268
1269     if( fprint_len == 20 || fprint_len == 16 ) {
1270         struct getkey_ctx_s ctx;
1271         KBNODE kb = NULL;
1272
1273         memset( &ctx, 0, sizeof ctx );
1274         ctx.exact = 1 ;
1275         ctx.not_allocated = 1;
1276         ctx.kr_handle = keydb_new (1);
1277         ctx.nitems = 1;
1278         ctx.items[0].mode = fprint_len==16? KEYDB_SEARCH_MODE_FPR16
1279                                           : KEYDB_SEARCH_MODE_FPR20;
1280         memcpy( ctx.items[0].u.fpr, fprint, fprint_len );
1281         rc = lookup( &ctx, &kb, 1 );
1282         if (!rc && sk )
1283             sk_from_block ( &ctx, sk, kb );
1284         release_kbnode ( kb );
1285         get_seckey_end( &ctx );
1286     }
1287     else
1288         rc = G10ERR_GENERAL; /* Oops */
1289     return rc;
1290 }
1291
1292
1293 /* Search for a secret key with the given fingerprint and return the
1294    complete keyblock which may have more than only this key. */
1295 int
1296 get_seckeyblock_byfprint (KBNODE *ret_keyblock, const byte *fprint,
1297                           size_t fprint_len )
1298 {
1299   int rc;
1300   struct getkey_ctx_s ctx;
1301   
1302   if (fprint_len != 20 && fprint_len == 16)
1303     return G10ERR_GENERAL; /* Oops */
1304     
1305   memset (&ctx, 0, sizeof ctx);
1306   ctx.not_allocated = 1;
1307   ctx.kr_handle = keydb_new (1);
1308   ctx.nitems = 1;
1309   ctx.items[0].mode = (fprint_len==16
1310                        ? KEYDB_SEARCH_MODE_FPR16
1311                        : KEYDB_SEARCH_MODE_FPR20);
1312   memcpy (ctx.items[0].u.fpr, fprint, fprint_len);
1313   rc = lookup (&ctx, ret_keyblock, 1);
1314   get_seckey_end (&ctx);
1315   
1316   return rc;
1317 }
1318
1319
1320 \f
1321 /************************************************
1322  ************* Merging stuff ********************
1323  ************************************************/
1324
1325 /****************
1326  * merge all selfsignatures with the keys.
1327  * FIXME: replace this at least for the public key parts
1328  *        by merge_selfsigs.
1329  *        It is still used in keyedit.c and
1330  *        at 2 or 3 other places - check whether it is really needed.
1331  *        It might be needed by the key edit and import stuff because
1332  *        the keylock is changed.
1333  */
1334 void
1335 merge_keys_and_selfsig( KBNODE keyblock )
1336 {
1337     PKT_public_key *pk = NULL;
1338     PKT_secret_key *sk = NULL;
1339     PKT_signature *sig;
1340     KBNODE k;
1341     u32 kid[2] = { 0, 0 };
1342     u32 sigdate = 0;
1343
1344     if (keyblock && keyblock->pkt->pkttype == PKT_PUBLIC_KEY ) {
1345         /* divert to our new function */
1346         merge_selfsigs (keyblock);
1347         return;
1348     }
1349     /* still need the old one because the new one can't handle secret keys */
1350
1351     for(k=keyblock; k; k = k->next ) {
1352         if( k->pkt->pkttype == PKT_PUBLIC_KEY
1353             || k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
1354             pk = k->pkt->pkt.public_key; sk = NULL;
1355             if( pk->version < 4 )
1356                 pk = NULL; /* not needed for old keys */
1357             else if( k->pkt->pkttype == PKT_PUBLIC_KEY )
1358                 keyid_from_pk( pk, kid );
1359             else if( !pk->expiredate ) { /* and subkey */
1360                 /* insert the expiration date here */
1361                 /*FIXME!!! pk->expiredate = subkeys_expiretime( k, kid );*/
1362             }
1363             sigdate = 0;
1364         }
1365         else if( k->pkt->pkttype == PKT_SECRET_KEY
1366             || k->pkt->pkttype == PKT_SECRET_SUBKEY ) {
1367             pk = NULL; sk = k->pkt->pkt.secret_key;
1368             if( sk->version < 4 )
1369                 sk = NULL;
1370             else if( k->pkt->pkttype == PKT_SECRET_KEY )
1371                 keyid_from_sk( sk, kid );
1372             sigdate = 0;
1373         }
1374         else if( (pk || sk ) && k->pkt->pkttype == PKT_SIGNATURE
1375                  && (sig=k->pkt->pkt.signature)->sig_class >= 0x10
1376                  && sig->sig_class <= 0x30 && sig->version > 3
1377                  && !(sig->sig_class == 0x18 || sig->sig_class == 0x28)
1378                  && sig->keyid[0] == kid[0] && sig->keyid[1] == kid[1] ) {
1379             /* okay this is a self-signature which can be used.
1380              * This is not used for subkey binding signature, becuase this
1381              * is done above.
1382              * FIXME: We should only use this if the signature is valid
1383              *        but this is time consuming - we must provide another
1384              *        way to handle this
1385              */
1386             const byte *p;
1387             u32 ed;
1388
1389             p = parse_sig_subpkt( sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL );
1390             if( pk ) {
1391                 ed = p? pk->timestamp + buffer_to_u32(p):0;
1392                 if( sig->timestamp > sigdate ) {
1393                     pk->expiredate = ed;
1394                     sigdate = sig->timestamp;
1395                 }
1396             }
1397             else {
1398                 ed = p? sk->timestamp + buffer_to_u32(p):0;
1399                 if( sig->timestamp > sigdate ) {
1400                     sk->expiredate = ed;
1401                     sigdate = sig->timestamp;
1402                 }
1403             }
1404         }
1405
1406         if(pk && (pk->expiredate==0 ||
1407                   (pk->max_expiredate && pk->expiredate>pk->max_expiredate)))
1408           pk->expiredate=pk->max_expiredate;
1409
1410         if(sk && (sk->expiredate==0 ||
1411                   (sk->max_expiredate && sk->expiredate>sk->max_expiredate)))
1412           sk->expiredate=sk->max_expiredate;
1413     }
1414 }
1415
1416 static int
1417 parse_key_usage(PKT_signature *sig)
1418 {
1419   int key_usage=0;
1420   const byte *p;
1421   size_t n;
1422   byte flags;
1423
1424   p=parse_sig_subpkt(sig->hashed,SIGSUBPKT_KEY_FLAGS,&n);
1425   if(p && n)
1426     {
1427       /* first octet of the keyflags */
1428       flags=*p;
1429
1430       if(flags & 1)
1431         {
1432           key_usage |= PUBKEY_USAGE_CERT;
1433           flags&=~1;
1434         }
1435
1436       if(flags & 2)
1437         {
1438           key_usage |= PUBKEY_USAGE_SIG;
1439           flags&=~2;
1440         }
1441
1442       /* We do not distinguish between encrypting communications and
1443          encrypting storage. */
1444       if(flags & (0x04|0x08))
1445         {
1446           key_usage |= PUBKEY_USAGE_ENC;
1447           flags&=~(0x04|0x08);
1448         }
1449
1450       if(flags & 0x20)
1451         {
1452           key_usage |= PUBKEY_USAGE_AUTH;
1453           flags&=~0x20;
1454         }
1455
1456       if(flags)
1457         key_usage |= PUBKEY_USAGE_UNKNOWN;
1458     }
1459
1460   /* We set PUBKEY_USAGE_UNKNOWN to indicate that this key has a
1461      capability that we do not handle.  This serves to distinguish
1462      between a zero key usage which we handle as the default
1463      capabilities for that algorithm, and a usage that we do not
1464      handle. */
1465
1466   return key_usage;
1467 }
1468
1469 /*
1470  * Apply information from SIGNODE (which is the valid self-signature
1471  * associated with that UID) to the UIDNODE:
1472  * - wether the UID has been revoked
1473  * - assumed creation date of the UID
1474  * - temporary store the keyflags here
1475  * - temporary store the key expiration time here
1476  * - mark whether the primary user ID flag hat been set.
1477  * - store the preferences
1478  */
1479 static void
1480 fixup_uidnode ( KBNODE uidnode, KBNODE signode, u32 keycreated )
1481 {
1482     PKT_user_id   *uid = uidnode->pkt->pkt.user_id;
1483     PKT_signature *sig = signode->pkt->pkt.signature;
1484     const byte *p, *sym, *hash, *zip;
1485     size_t n, nsym, nhash, nzip;
1486
1487     sig->flags.chosen_selfsig = 1; /* we chose this one */
1488     uid->created = 0; /* not created == invalid */
1489     if ( IS_UID_REV ( sig ) ) 
1490       {
1491         uid->is_revoked = 1;
1492         return; /* has been revoked */
1493       }
1494     else
1495       uid->is_revoked = 0;
1496
1497     uid->expiredate = sig->expiredate;
1498
1499     if (sig->flags.expired)
1500       {
1501         uid->is_expired = 1;
1502         return; /* has expired */
1503       }
1504     else
1505       uid->is_expired = 0;
1506
1507     uid->created = sig->timestamp; /* this one is okay */
1508     uid->selfsigversion = sig->version;
1509     /* If we got this far, it's not expired :) */
1510     uid->is_expired = 0;
1511
1512     /* store the key flags in the helper variable for later processing */
1513     uid->help_key_usage=parse_key_usage(sig);
1514
1515     /* ditto for the key expiration */
1516     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
1517     if( p && buffer_to_u32(p) )
1518       uid->help_key_expire = keycreated + buffer_to_u32(p);
1519     else
1520       uid->help_key_expire = 0;
1521
1522     /* Set the primary user ID flag - we will later wipe out some
1523      * of them to only have one in our keyblock */
1524     uid->is_primary = 0;
1525     p = parse_sig_subpkt ( sig->hashed, SIGSUBPKT_PRIMARY_UID, NULL );
1526     if ( p && *p )
1527         uid->is_primary = 2;
1528     /* We could also query this from the unhashed area if it is not in
1529      * the hased area and then later try to decide which is the better
1530      * there should be no security problem with this.
1531      * For now we only look at the hashed one. 
1532      */
1533
1534     /* Now build the preferences list.  These must come from the
1535        hashed section so nobody can modify the ciphers a key is
1536        willing to accept. */
1537     p = parse_sig_subpkt ( sig->hashed, SIGSUBPKT_PREF_SYM, &n );
1538     sym = p; nsym = p?n:0;
1539     p = parse_sig_subpkt ( sig->hashed, SIGSUBPKT_PREF_HASH, &n );
1540     hash = p; nhash = p?n:0;
1541     p = parse_sig_subpkt ( sig->hashed, SIGSUBPKT_PREF_COMPR, &n );
1542     zip = p; nzip = p?n:0;
1543     if (uid->prefs) 
1544         xfree (uid->prefs);
1545     n = nsym + nhash + nzip;
1546     if (!n)
1547         uid->prefs = NULL;
1548     else {
1549         uid->prefs = xmalloc (sizeof (*uid->prefs) * (n+1));
1550         n = 0;
1551         for (; nsym; nsym--, n++) {
1552             uid->prefs[n].type = PREFTYPE_SYM;
1553             uid->prefs[n].value = *sym++;
1554         }
1555         for (; nhash; nhash--, n++) {
1556             uid->prefs[n].type = PREFTYPE_HASH;
1557             uid->prefs[n].value = *hash++;
1558         }
1559         for (; nzip; nzip--, n++) {
1560             uid->prefs[n].type = PREFTYPE_ZIP;
1561             uid->prefs[n].value = *zip++;
1562         }
1563         uid->prefs[n].type = PREFTYPE_NONE; /* end of list marker */
1564         uid->prefs[n].value = 0;
1565     }
1566
1567     /* see whether we have the MDC feature */
1568     uid->flags.mdc = 0;
1569     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_FEATURES, &n);
1570     if (p && n && (p[0] & 0x01))
1571         uid->flags.mdc = 1;
1572
1573     /* and the keyserver modify flag */
1574     uid->flags.ks_modify = 1;
1575     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KS_FLAGS, &n);
1576     if (p && n && (p[0] & 0x80))
1577         uid->flags.ks_modify = 0;
1578 }
1579
1580 static void
1581 sig_to_revoke_info(PKT_signature *sig,struct revoke_info *rinfo)
1582 {
1583   rinfo->date = sig->timestamp;
1584   rinfo->algo = sig->pubkey_algo;
1585   rinfo->keyid[0] = sig->keyid[0];
1586   rinfo->keyid[1] = sig->keyid[1];
1587 }
1588
1589 static void
1590 merge_selfsigs_main(KBNODE keyblock, int *r_revoked, struct revoke_info *rinfo)
1591 {
1592     PKT_public_key *pk = NULL;
1593     KBNODE k;
1594     u32 kid[2];
1595     u32 sigdate, uiddate, uiddate2;
1596     KBNODE signode, uidnode, uidnode2;
1597     u32 curtime = make_timestamp ();
1598     unsigned int key_usage = 0;
1599     u32 keytimestamp = 0;
1600     u32 key_expire = 0;
1601     int key_expire_seen = 0;
1602     byte sigversion = 0;
1603
1604     *r_revoked = 0;
1605     memset(rinfo,0,sizeof(*rinfo));
1606
1607     if ( keyblock->pkt->pkttype != PKT_PUBLIC_KEY )
1608         BUG ();
1609     pk = keyblock->pkt->pkt.public_key;
1610     keytimestamp = pk->timestamp;
1611
1612     keyid_from_pk( pk, kid );
1613     pk->main_keyid[0] = kid[0];
1614     pk->main_keyid[1] = kid[1];
1615
1616     if ( pk->version < 4 ) {
1617         /* before v4 the key packet itself contains the expiration
1618          * date and there was no way to change it, so we start with
1619          * the one from the key packet */
1620         key_expire = pk->max_expiredate;
1621         key_expire_seen = 1;
1622     }
1623
1624     /* first pass: find the latest direct key self-signature.
1625      * We assume that the newest one overrides all others
1626      */
1627
1628     /* In case this key was already merged */
1629     xfree(pk->revkey);
1630     pk->revkey=NULL;
1631     pk->numrevkeys=0;
1632
1633     signode = NULL;
1634     sigdate = 0; /* helper to find the latest signature */
1635     for(k=keyblock; k && k->pkt->pkttype != PKT_USER_ID; k = k->next ) {
1636         if ( k->pkt->pkttype == PKT_SIGNATURE ) {
1637             PKT_signature *sig = k->pkt->pkt.signature;
1638             if ( sig->keyid[0] == kid[0] && sig->keyid[1]==kid[1] ) { 
1639                 if ( check_key_signature( keyblock, k, NULL ) )
1640                     ; /* signature did not verify */
1641                 else if ( IS_KEY_REV (sig) ){
1642                     /* key has been revoked - there is no way to override
1643                      * such a revocation, so we theoretically can stop now.
1644                      * We should not cope with expiration times for revocations
1645                      * here because we have to assume that an attacker can
1646                      * generate all kinds of signatures.  However due to the
1647                      * fact that the key has been revoked it does not harm
1648                      * either and by continuing we gather some more info on 
1649                      * that key.
1650                      */ 
1651                     *r_revoked = 1;
1652                     sig_to_revoke_info(sig,rinfo);
1653                 }
1654                 else if ( IS_KEY_SIG (sig) ) {
1655                   /* Add any revocation keys onto the pk.  This is
1656                      particularly interesting since we normally only
1657                      get data from the most recent 1F signature, but
1658                      you need multiple 1F sigs to properly handle
1659                      revocation keys (PGP does it this way, and a
1660                      revocation key could be sensitive and hence in a
1661                      different signature). */
1662                   if(sig->revkey) {
1663                     int i;
1664
1665                     pk->revkey=
1666                       xrealloc(pk->revkey,sizeof(struct revocation_key)*
1667                                 (pk->numrevkeys+sig->numrevkeys));
1668
1669                     for(i=0;i<sig->numrevkeys;i++)
1670                       memcpy(&pk->revkey[pk->numrevkeys++],
1671                              sig->revkey[i],
1672                              sizeof(struct revocation_key));
1673                   }
1674
1675                   if( sig->timestamp >= sigdate ) {
1676                     if(sig->flags.expired)
1677                         ; /* signature has expired - ignore it */
1678                     else {
1679                         sigdate = sig->timestamp;
1680                         signode = k;
1681                         if( sig->version > sigversion )
1682                           sigversion = sig->version;
1683
1684                     }
1685                   }
1686                 }
1687             }
1688         }
1689     }
1690
1691     /* Remove dupes from the revocation keys */
1692
1693     if(pk->revkey)
1694       {
1695         int i,j,x,changed=0;
1696
1697         for(i=0;i<pk->numrevkeys;i++)
1698           {
1699             for(j=i+1;j<pk->numrevkeys;j++)
1700               {
1701                 if(memcmp(&pk->revkey[i],&pk->revkey[j],
1702                           sizeof(struct revocation_key))==0)
1703                   {
1704                     /* remove j */
1705
1706                     for(x=j;x<pk->numrevkeys-1;x++)
1707                       pk->revkey[x]=pk->revkey[x+1];
1708
1709                     pk->numrevkeys--;
1710                     j--;
1711                     changed=1;
1712                   }
1713               }
1714           }
1715
1716         if(changed)
1717           pk->revkey=xrealloc(pk->revkey,
1718                                pk->numrevkeys*sizeof(struct revocation_key));
1719       }
1720
1721     if ( signode )
1722       {
1723         /* some information from a direct key signature take precedence
1724          * over the same information given in UID sigs.
1725          */
1726         PKT_signature *sig = signode->pkt->pkt.signature;
1727         const byte *p;
1728
1729         key_usage=parse_key_usage(sig);
1730
1731         p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
1732         if( p && buffer_to_u32(p) )
1733           {
1734             key_expire = keytimestamp + buffer_to_u32(p);
1735             key_expire_seen = 1;
1736           }
1737
1738         /* mark that key as valid: one direct key signature should 
1739          * render a key as valid */
1740         pk->is_valid = 1;
1741       }
1742
1743     /* pass 1.5: look for key revocation signatures that were not made
1744        by the key (i.e. did a revocation key issue a revocation for
1745        us?).  Only bother to do this if there is a revocation key in
1746        the first place and we're not revoked already. */
1747
1748     if(!*r_revoked && pk->revkey)
1749       for(k=keyblock; k && k->pkt->pkttype != PKT_USER_ID; k = k->next )
1750         {
1751           if ( k->pkt->pkttype == PKT_SIGNATURE )
1752             {
1753               PKT_signature *sig = k->pkt->pkt.signature;
1754
1755               if(IS_KEY_REV(sig) &&
1756                  (sig->keyid[0]!=kid[0] || sig->keyid[1]!=kid[1]))
1757                 { 
1758                   int rc=check_revocation_keys(pk,sig);
1759                   if(rc==0)
1760                     {
1761                       *r_revoked=2;
1762                       sig_to_revoke_info(sig,rinfo);
1763                       /* don't continue checking since we can't be any
1764                          more revoked than this */
1765                       break;
1766                     }
1767                   else if(rc==G10ERR_NO_PUBKEY)
1768                     pk->maybe_revoked=1;
1769
1770                   /* A failure here means the sig did not verify, was
1771                      not issued by a revocation key, or a revocation
1772                      key loop was broken.  If a revocation key isn't
1773                      findable, however, the key might be revoked and
1774                      we don't know it. */
1775
1776                   /* TODO: In the future handle subkey and cert
1777                      revocations?  PGP doesn't, but it's in 2440. */
1778                 }
1779             }
1780         }
1781
1782     /* second pass: look at the self-signature of all user IDs */
1783     signode = uidnode = NULL;
1784     sigdate = 0; /* helper to find the latest signature in one user ID */
1785     for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next ) {
1786         if ( k->pkt->pkttype == PKT_USER_ID ) {
1787             if ( uidnode && signode ) 
1788               {
1789                 fixup_uidnode ( uidnode, signode, keytimestamp );
1790                 pk->is_valid=1;
1791               }
1792             uidnode = k;
1793             signode = NULL;
1794             sigdate = 0;
1795         }
1796         else if ( k->pkt->pkttype == PKT_SIGNATURE && uidnode ) {
1797             PKT_signature *sig = k->pkt->pkt.signature;
1798             if ( sig->keyid[0] == kid[0] && sig->keyid[1]==kid[1] ) { 
1799                 if ( check_key_signature( keyblock, k, NULL ) )
1800                     ; /* signature did not verify */
1801                 else if ( (IS_UID_SIG (sig) || IS_UID_REV (sig))
1802                           && sig->timestamp >= sigdate )
1803                   {
1804                     /* Note: we allow to invalidate cert revocations
1805                      * by a newer signature.  An attacker can't use this
1806                      * because a key should be revoced with a key revocation.
1807                      * The reason why we have to allow for that is that at
1808                      * one time an email address may become invalid but later
1809                      * the same email address may become valid again (hired,
1810                      * fired, hired again).
1811                      */
1812
1813                     sigdate = sig->timestamp;
1814                     signode = k;
1815                     signode->pkt->pkt.signature->flags.chosen_selfsig=0;
1816                     if( sig->version > sigversion )
1817                       sigversion = sig->version;
1818                   }
1819             }
1820         }
1821     }
1822     if ( uidnode && signode ) {
1823         fixup_uidnode ( uidnode, signode, keytimestamp );
1824         pk->is_valid = 1;
1825     }
1826
1827     /* If the key isn't valid yet, and we have
1828        --allow-non-selfsigned-uid set, then force it valid. */
1829     if(!pk->is_valid && opt.allow_non_selfsigned_uid)
1830       {
1831         if(opt.verbose)
1832           log_info(_("Invalid key %s made valid by"
1833                      " --allow-non-selfsigned-uid\n"),keystr_from_pk(pk));
1834         pk->is_valid = 1;
1835       }
1836
1837     /* The key STILL isn't valid, so try and find an ultimately
1838        trusted signature. */
1839     if(!pk->is_valid)
1840       {
1841         uidnode=NULL;
1842
1843         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k=k->next)
1844           {
1845             if ( k->pkt->pkttype == PKT_USER_ID )
1846               uidnode = k;
1847             else if ( k->pkt->pkttype == PKT_SIGNATURE && uidnode )
1848               {
1849                 PKT_signature *sig = k->pkt->pkt.signature;
1850
1851                 if(sig->keyid[0] != kid[0] || sig->keyid[1]!=kid[1])
1852                   {
1853                     PKT_public_key *ultimate_pk;
1854
1855                     ultimate_pk=xmalloc_clear(sizeof(*ultimate_pk));
1856
1857                     /* We don't want to use the full get_pubkey to
1858                        avoid infinite recursion in certain cases.
1859                        There is no reason to check that an ultimately
1860                        trusted key is still valid - if it has been
1861                        revoked or the user should also renmove the
1862                        ultimate trust flag.  */
1863                     if(get_pubkey_fast(ultimate_pk,sig->keyid)==0
1864                        && check_key_signature2(keyblock,k,ultimate_pk,
1865                                                NULL,NULL,NULL,NULL)==0
1866                        && get_ownertrust(ultimate_pk)==TRUST_ULTIMATE)
1867                       {
1868                         free_public_key(ultimate_pk);
1869                         pk->is_valid=1;
1870                         break;
1871                       }
1872
1873                     free_public_key(ultimate_pk);
1874                   }
1875               }
1876           }
1877       }
1878
1879     /* Record the highest selfsig version so we know if this is a v3
1880        key through and through, or a v3 key with a v4 selfsig
1881        somewhere.  This is useful in a few places to know if the key
1882        must be treated as PGP2-style or OpenPGP-style.  Note that a
1883        selfsig revocation with a higher version number will also raise
1884        this value.  This is okay since such a revocation must be
1885        issued by the user (i.e. it cannot be issued by someone else to
1886        modify the key behavior.) */
1887
1888     pk->selfsigversion=sigversion;
1889
1890     /* Now that we had a look at all user IDs we can now get some information
1891      * from those user IDs.
1892      */
1893     
1894     if ( !key_usage ) {
1895         /* find the latest user ID with key flags set */
1896         uiddate = 0; /* helper to find the latest user ID */
1897         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1898             k = k->next ) {
1899             if ( k->pkt->pkttype == PKT_USER_ID ) {
1900                 PKT_user_id *uid = k->pkt->pkt.user_id;
1901                 if ( uid->help_key_usage && uid->created > uiddate ) {
1902                     key_usage = uid->help_key_usage;
1903                     uiddate = uid->created;
1904                 }
1905             }
1906         }
1907     }
1908     if ( !key_usage ) { /* no key flags at all: get it from the algo */
1909         key_usage = openpgp_pk_algo_usage ( pk->pubkey_algo );
1910     }
1911     else { /* check that the usage matches the usage as given by the algo */
1912         int x = openpgp_pk_algo_usage ( pk->pubkey_algo );
1913         if ( x ) /* mask it down to the actual allowed usage */
1914             key_usage &= x; 
1915     }
1916
1917     /* Whatever happens, it's a primary key, so it can certify. */
1918     pk->pubkey_usage = key_usage|PUBKEY_USAGE_CERT;
1919
1920     if ( !key_expire_seen ) {
1921         /* find the latest valid user ID with a key expiration set 
1922          * Note, that this may be a different one from the above because
1923          * some user IDs may have no expiration date set */
1924         uiddate = 0; 
1925         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1926             k = k->next ) {
1927             if ( k->pkt->pkttype == PKT_USER_ID ) {
1928                 PKT_user_id *uid = k->pkt->pkt.user_id;
1929                 if ( uid->help_key_expire && uid->created > uiddate ) {
1930                     key_expire = uid->help_key_expire;
1931                     uiddate = uid->created;
1932                 }
1933             }
1934         }
1935     }
1936
1937     /* Currently only v3 keys have a maximum expiration date, but I'll
1938        bet v5 keys get this feature again. */
1939     if(key_expire==0 || (pk->max_expiredate && key_expire>pk->max_expiredate))
1940       key_expire=pk->max_expiredate;
1941
1942     pk->has_expired = key_expire >= curtime? 0 : key_expire;
1943     pk->expiredate = key_expire;
1944
1945     /* Fixme: we should see how to get rid of the expiretime fields  but
1946      * this needs changes at other places too. */
1947
1948     /* and now find the real primary user ID and delete all others */
1949     uiddate = uiddate2 = 0;
1950     uidnode = uidnode2 = NULL;
1951     for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next ) {
1952         if ( k->pkt->pkttype == PKT_USER_ID &&
1953              !k->pkt->pkt.user_id->attrib_data) {
1954             PKT_user_id *uid = k->pkt->pkt.user_id;
1955             if (uid->is_primary)
1956               {
1957                 if(uid->created > uiddate)
1958                   {
1959                     uiddate = uid->created;
1960                     uidnode = k;
1961                   }
1962                 else if(uid->created==uiddate && uidnode)
1963                   {
1964                     /* The dates are equal, so we need to do a
1965                        different (and arbitrary) comparison.  This
1966                        should rarely, if ever, happen.  It's good to
1967                        try and guarantee that two different GnuPG
1968                        users with two different keyrings at least pick
1969                        the same primary. */
1970                     if(cmp_user_ids(uid,uidnode->pkt->pkt.user_id)>0)
1971                       uidnode=k;
1972                   }
1973               }
1974             else
1975               {
1976                 if(uid->created > uiddate2)
1977                   {
1978                     uiddate2 = uid->created;
1979                     uidnode2 = k;
1980                   }
1981                 else if(uid->created==uiddate2 && uidnode2)
1982                   {
1983                     if(cmp_user_ids(uid,uidnode2->pkt->pkt.user_id)>0)
1984                       uidnode2=k;
1985                   }
1986               }
1987         }
1988     }
1989     if ( uidnode ) {
1990         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1991             k = k->next ) {
1992             if ( k->pkt->pkttype == PKT_USER_ID &&
1993                  !k->pkt->pkt.user_id->attrib_data) {
1994                 PKT_user_id *uid = k->pkt->pkt.user_id;
1995                 if ( k != uidnode ) 
1996                     uid->is_primary = 0;
1997             }
1998         }
1999     }
2000     else if( uidnode2 ) {
2001         /* none is flagged primary - use the latest user ID we have,
2002            and disambiguate with the arbitrary packet comparison. */
2003         uidnode2->pkt->pkt.user_id->is_primary = 1;
2004     }
2005     else
2006       {
2007         /* None of our uids were self-signed, so pick the one that
2008            sorts first to be the primary.  This is the best we can do
2009            here since there are no self sigs to date the uids. */
2010
2011         uidnode = NULL;
2012
2013         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
2014             k = k->next )
2015           {
2016             if(k->pkt->pkttype==PKT_USER_ID
2017                && !k->pkt->pkt.user_id->attrib_data)
2018               {
2019                 if(!uidnode)
2020                   {
2021                     uidnode=k;
2022                     uidnode->pkt->pkt.user_id->is_primary=1;
2023                     continue;
2024                   }
2025                 else
2026                   {
2027                     if(cmp_user_ids(k->pkt->pkt.user_id,
2028                                     uidnode->pkt->pkt.user_id)>0)
2029                       {
2030                         uidnode->pkt->pkt.user_id->is_primary=0;
2031                         uidnode=k;
2032                         uidnode->pkt->pkt.user_id->is_primary=1;
2033                       }
2034                     else
2035                       k->pkt->pkt.user_id->is_primary=0; /* just to be
2036                                                             safe */
2037                   }
2038               }
2039           }
2040       }
2041 }
2042
2043
2044 static void
2045 merge_selfsigs_subkey( KBNODE keyblock, KBNODE subnode )
2046 {
2047     PKT_public_key *mainpk = NULL, *subpk = NULL;
2048     PKT_signature *sig;
2049     KBNODE k;
2050     u32 mainkid[2];
2051     u32 sigdate = 0;
2052     KBNODE signode;
2053     u32 curtime = make_timestamp ();
2054     unsigned int key_usage = 0;
2055     u32 keytimestamp = 0;
2056     u32 key_expire = 0;
2057     const byte *p;
2058
2059     if ( subnode->pkt->pkttype != PKT_PUBLIC_SUBKEY )
2060         BUG ();
2061     mainpk = keyblock->pkt->pkt.public_key;
2062     if ( mainpk->version < 4 )
2063         return; /* (actually this should never happen) */
2064     keyid_from_pk( mainpk, mainkid );
2065     subpk = subnode->pkt->pkt.public_key;
2066     keytimestamp = subpk->timestamp;
2067
2068     subpk->is_valid = 0;
2069     subpk->main_keyid[0] = mainpk->main_keyid[0];
2070     subpk->main_keyid[1] = mainpk->main_keyid[1];
2071
2072     /* find the latest key binding self-signature. */
2073     signode = NULL;
2074     sigdate = 0; /* helper to find the latest signature */
2075     for(k=subnode->next; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
2076                                                         k = k->next ) {
2077         if ( k->pkt->pkttype == PKT_SIGNATURE ) {
2078             sig = k->pkt->pkt.signature;
2079             if ( sig->keyid[0] == mainkid[0] && sig->keyid[1]==mainkid[1] ) { 
2080                 if ( check_key_signature( keyblock, k, NULL ) )
2081                     ; /* signature did not verify */
2082                 else if ( IS_SUBKEY_REV (sig) ) {
2083                   /* Note that this means that the date on a
2084                      revocation sig does not matter - even if the
2085                      binding sig is dated after the revocation sig,
2086                      the subkey is still marked as revoked.  This
2087                      seems ok, as it is just as easy to make new
2088                      subkeys rather than re-sign old ones as the
2089                      problem is in the distribution.  Plus, PGP (7)
2090                      does this the same way.  */
2091                     subpk->is_revoked = 1;
2092                     sig_to_revoke_info(sig,&subpk->revoked);
2093                     /* although we could stop now, we continue to 
2094                      * figure out other information like the old expiration
2095                      * time */
2096                 }
2097                 else if ( IS_SUBKEY_SIG (sig) && sig->timestamp >= sigdate )
2098                   {
2099                     if(sig->flags.expired)
2100                       ; /* signature has expired - ignore it */
2101                     else
2102                       {
2103                         sigdate = sig->timestamp;
2104                         signode = k;
2105                         signode->pkt->pkt.signature->flags.chosen_selfsig=0;
2106                       }
2107                   }
2108             }
2109         }
2110     }
2111
2112     /* no valid key binding */
2113     if ( !signode )
2114       return;
2115
2116     sig = signode->pkt->pkt.signature;
2117     sig->flags.chosen_selfsig=1; /* so we know which selfsig we chose later */
2118
2119     key_usage=parse_key_usage(sig);
2120     if ( !key_usage )
2121       {
2122         /* no key flags at all: get it from the algo */
2123         key_usage = openpgp_pk_algo_usage ( subpk->pubkey_algo );
2124       }
2125     else
2126       {
2127         /* check that the usage matches the usage as given by the algo */
2128         int x = openpgp_pk_algo_usage ( subpk->pubkey_algo );
2129         if ( x ) /* mask it down to the actual allowed usage */
2130           key_usage &= x; 
2131       }
2132
2133     subpk->pubkey_usage = key_usage;
2134     
2135     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
2136     if ( p && buffer_to_u32(p) )
2137         key_expire = keytimestamp + buffer_to_u32(p);
2138     else
2139         key_expire = 0;
2140     subpk->has_expired = key_expire >= curtime? 0 : key_expire;
2141     subpk->expiredate = key_expire;
2142
2143     /* algo doesn't exist */
2144     if(openpgp_pk_test_algo(subpk->pubkey_algo))
2145       return;
2146
2147     subpk->is_valid = 1;
2148
2149     /* Find the first 0x19 embedded signature on our self-sig. */
2150     if(subpk->backsig==0)
2151       {
2152         int seq=0;
2153         size_t n;
2154
2155         /* We do this while() since there may be other embedded
2156            signatures in the future.  We only want 0x19 here. */
2157         while((p=enum_sig_subpkt(sig->hashed,
2158                                  SIGSUBPKT_SIGNATURE,&n,&seq,NULL)))
2159           if(n>3 && ((p[0]==3 && p[2]==0x19) || (p[0]==4 && p[1]==0x19)))
2160             break;
2161
2162         if(p==NULL)
2163           {
2164             seq=0;
2165             /* It is safe to have this in the unhashed area since the
2166                0x19 is located on the selfsig for convenience, not
2167                security. */
2168             while((p=enum_sig_subpkt(sig->unhashed,SIGSUBPKT_SIGNATURE,
2169                                      &n,&seq,NULL)))
2170               if(n>3 && ((p[0]==3 && p[2]==0x19) || (p[0]==4 && p[1]==0x19)))
2171                 break;
2172           }
2173
2174         if(p)
2175           {
2176             PKT_signature *backsig=xmalloc_clear(sizeof(PKT_signature));
2177             IOBUF backsig_buf=iobuf_temp_with_content(p,n);
2178             int save_mode=set_packet_list_mode(0);
2179
2180             if(parse_signature(backsig_buf,PKT_SIGNATURE,n,backsig)==0)
2181               {
2182                 if(check_backsig(mainpk,subpk,backsig)==0)
2183                   subpk->backsig=2;
2184                 else
2185                   subpk->backsig=1;
2186               }
2187
2188             set_packet_list_mode(save_mode);
2189
2190             iobuf_close(backsig_buf);
2191             free_seckey_enc(backsig);
2192           }
2193       }
2194 }
2195
2196
2197 /* 
2198  * Merge information from the self-signatures with the key, so that
2199  * we can later use them more easy.
2200  * The function works by first applying the self signatures to the
2201  * primary key and the to each subkey.
2202  * Here are the rules we use to decide which inormation from which
2203  * self-signature is used:
2204  * We check all self signatures or validity and ignore all invalid signatures.
2205  * All signatures are then ordered by their creation date ....
2206  * For the primary key:
2207  *   FIXME the docs    
2208  */
2209 static void
2210 merge_selfsigs( KBNODE keyblock )
2211 {
2212     KBNODE k;
2213     int revoked;
2214     struct revoke_info rinfo;
2215     PKT_public_key *main_pk;
2216     prefitem_t *prefs;
2217     int mdc_feature;
2218
2219     if ( keyblock->pkt->pkttype != PKT_PUBLIC_KEY ) {
2220         if (keyblock->pkt->pkttype == PKT_SECRET_KEY ) {
2221             log_error ("expected public key but found secret key "
2222                        "- must stop\n");
2223             /* we better exit here becuase a public key is expected at
2224                other places too.  FIXME: Figure this out earlier and
2225                don't get to here at all */
2226             g10_exit (1);
2227         }
2228         BUG ();
2229     }
2230
2231     merge_selfsigs_main ( keyblock, &revoked, &rinfo );
2232
2233     /* now merge in the data from each of the subkeys */
2234     for(k=keyblock; k; k = k->next ) {
2235         if (  k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
2236             merge_selfsigs_subkey ( keyblock, k );
2237         }
2238     }
2239
2240     main_pk = keyblock->pkt->pkt.public_key;
2241     if ( revoked || main_pk->has_expired || !main_pk->is_valid ) {
2242         /* if the primary key is revoked, expired, or invalid we
2243          * better set the appropriate flags on that key and all
2244          * subkeys */
2245         for(k=keyblock; k; k = k->next ) {
2246             if ( k->pkt->pkttype == PKT_PUBLIC_KEY
2247                 || k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
2248                 PKT_public_key *pk = k->pkt->pkt.public_key;
2249                 if(!main_pk->is_valid)
2250                   pk->is_valid = 0;
2251                 if(revoked && !pk->is_revoked)
2252                   {
2253                     pk->is_revoked = revoked;
2254                     memcpy(&pk->revoked,&rinfo,sizeof(rinfo));
2255                   }
2256                 if(main_pk->has_expired)
2257                   pk->has_expired = main_pk->has_expired;
2258             }
2259         }
2260         return;
2261     }
2262
2263     /* set the preference list of all keys to those of the primary real
2264      * user ID.  Note: we use these preferences when we don't know by
2265      * which user ID the key has been selected.
2266      * fixme: we should keep atoms of commonly used preferences or
2267      * use reference counting to optimize the preference lists storage.
2268      * FIXME: it might be better to use the intersection of 
2269      * all preferences.
2270      * Do a similar thing for the MDC feature flag.
2271      */
2272     prefs = NULL;
2273     mdc_feature = 0;
2274     for (k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next) {
2275         if (k->pkt->pkttype == PKT_USER_ID
2276             && !k->pkt->pkt.user_id->attrib_data
2277             && k->pkt->pkt.user_id->is_primary) {
2278             prefs = k->pkt->pkt.user_id->prefs;
2279             mdc_feature = k->pkt->pkt.user_id->flags.mdc;
2280             break;
2281         }
2282     }    
2283     for(k=keyblock; k; k = k->next ) {
2284         if ( k->pkt->pkttype == PKT_PUBLIC_KEY
2285              || k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
2286             PKT_public_key *pk = k->pkt->pkt.public_key;
2287             if (pk->prefs)
2288                 xfree (pk->prefs);
2289             pk->prefs = copy_prefs (prefs);
2290             pk->mdc_feature = mdc_feature;
2291         }
2292     }
2293 }
2294
2295
2296 /*
2297  * Merge the secret keys from secblock into the pubblock thereby
2298  * replacing the public (sub)keys with their secret counterparts Hmmm:
2299  * It might be better to get away from the concept of entire secret
2300  * keys at all and have a way to store just the real secret parts
2301  * from the key.
2302  */
2303 static void
2304 merge_public_with_secret ( KBNODE pubblock, KBNODE secblock )
2305 {
2306     KBNODE pub;
2307
2308     assert ( pubblock->pkt->pkttype == PKT_PUBLIC_KEY );
2309     assert ( secblock->pkt->pkttype == PKT_SECRET_KEY );
2310     
2311     for (pub=pubblock; pub; pub = pub->next ) {
2312         if ( pub->pkt->pkttype == PKT_PUBLIC_KEY ) {
2313              PKT_public_key *pk = pub->pkt->pkt.public_key;
2314              PKT_secret_key *sk = secblock->pkt->pkt.secret_key;
2315              assert ( pub == pubblock ); /* only in the first node */
2316              /* there is nothing to compare in this case, so just replace
2317               * some information */
2318              copy_public_parts_to_secret_key ( pk, sk );
2319              free_public_key ( pk );
2320              pub->pkt->pkttype = PKT_SECRET_KEY;
2321              pub->pkt->pkt.secret_key = copy_secret_key (NULL, sk);
2322         }
2323         else if ( pub->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
2324             KBNODE sec;
2325             PKT_public_key *pk = pub->pkt->pkt.public_key;
2326
2327             /* this is more complicated: it may happen that the sequence
2328              * of the subkeys dosn't match, so we have to find the
2329              * appropriate secret key */
2330             for (sec=secblock->next; sec; sec = sec->next ) {
2331                 if ( sec->pkt->pkttype == PKT_SECRET_SUBKEY ) {
2332                     PKT_secret_key *sk = sec->pkt->pkt.secret_key;
2333                     if ( !cmp_public_secret_key ( pk, sk ) ) {
2334                         copy_public_parts_to_secret_key ( pk, sk );
2335                         free_public_key ( pk );
2336                         pub->pkt->pkttype = PKT_SECRET_SUBKEY;
2337                         pub->pkt->pkt.secret_key = copy_secret_key (NULL, sk);
2338                         break;
2339                     }
2340                 }
2341             }
2342             if ( !sec ) 
2343                 BUG(); /* already checked in premerge */
2344         }
2345     }
2346 }
2347
2348 /* This function checks that for every public subkey a corresponding
2349  * secret subkey is available and deletes the public subkey otherwise.
2350  * We need this function because we can't delete it later when we
2351  * actually merge the secret parts into the pubring.
2352  * The function also plays some games with the node flags.
2353  */
2354 static void
2355 premerge_public_with_secret ( KBNODE pubblock, KBNODE secblock )
2356 {
2357     KBNODE last, pub;
2358
2359     assert ( pubblock->pkt->pkttype == PKT_PUBLIC_KEY );
2360     assert ( secblock->pkt->pkttype == PKT_SECRET_KEY );
2361     
2362     for (pub=pubblock,last=NULL; pub; last = pub, pub = pub->next ) {
2363         pub->flag &= ~3; /* reset bits 0 and 1 */
2364         if ( pub->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
2365             KBNODE sec;
2366             PKT_public_key *pk = pub->pkt->pkt.public_key;
2367
2368             for (sec=secblock->next; sec; sec = sec->next ) {
2369                 if ( sec->pkt->pkttype == PKT_SECRET_SUBKEY ) {
2370                     PKT_secret_key *sk = sec->pkt->pkt.secret_key;
2371                     if ( !cmp_public_secret_key ( pk, sk ) ) {
2372                         if ( sk->protect.s2k.mode == 1001 ) {
2373                             /* The secret parts are not available so
2374                                we can't use that key for signing etc.
2375                                Fix the pubkey usage */
2376                             pk->pubkey_usage &= ~(PUBKEY_USAGE_SIG
2377                                                   |PUBKEY_USAGE_AUTH);
2378                         }
2379                         /* transfer flag bits 0 and 1 to the pubblock */
2380                         pub->flag |= (sec->flag &3);
2381                         break;
2382                     }
2383                 }
2384             }
2385             if ( !sec ) {
2386                 KBNODE next, ll;
2387
2388                 if (opt.verbose)
2389                   log_info (_("no secret subkey"
2390                               " for public subkey %s - ignoring\n"),  
2391                             keystr_from_pk (pk));
2392                 /* we have to remove the subkey in this case */
2393                 assert ( last );
2394                 /* find the next subkey */
2395                 for (next=pub->next,ll=pub;
2396                      next && next->pkt->pkttype != PKT_PUBLIC_SUBKEY;
2397                      ll = next, next = next->next ) 
2398                     ;
2399                 /* make new link */
2400                 last->next = next;
2401                 /* release this public subkey with all sigs */
2402                 ll->next = NULL;
2403                 release_kbnode( pub );
2404                 /* let the loop continue */
2405                 pub = last;
2406             }
2407         }
2408     }
2409     /* We need to copy the found bits (0 and 1) from the secret key to
2410        the public key.  This has already been done for the subkeys but
2411        got lost on the primary key - fix it here *. */
2412     pubblock->flag |= (secblock->flag & 3);
2413 }
2414
2415
2416
2417 \f
2418 /* See see whether the key fits
2419  * our requirements and in case we do not
2420  * request the primary key, we should select
2421  * a suitable subkey.
2422  * FIXME: Check against PGP 7 whether we still need a kludge
2423  *        to favor type 16 keys over type 20 keys when type 20
2424  *        has not been explitely requested.
2425  * Returns: True when a suitable key has been found.
2426  *
2427  * We have to distinguish four cases:  FIXME!
2428  *  1. No usage and no primary key requested
2429  *     Examples for this case are that we have a keyID to be used
2430  *     for decrytion or verification.
2431  *  2. No usage but primary key requested
2432  *     This is the case for all functions which work on an
2433  *     entire keyblock, e.g. for editing or listing
2434  *  3. Usage and primary key requested
2435  *     FXME
2436  *  4. Usage but no primary key requested
2437  *     FIXME
2438  * FIXME: Tell what is going to happen here and something about the rationale
2439  * Note: We don't use this function if no specific usage is requested;
2440  *       This way the getkey functions can be used for plain key listings.
2441  *
2442  * CTX ist the keyblock we are investigating, if FOUNDK is not NULL this
2443  * is the key we actually found by looking at the keyid or a fingerprint and
2444  * may eitehr point to the primary or one of the subkeys.
2445  */
2446
2447 static int
2448 finish_lookup (GETKEY_CTX ctx)
2449 {
2450     KBNODE keyblock = ctx->keyblock;
2451     KBNODE k;
2452     KBNODE foundk = NULL;
2453     PKT_user_id *foundu = NULL;
2454 #define USAGE_MASK  (PUBKEY_USAGE_SIG|PUBKEY_USAGE_ENC|PUBKEY_USAGE_CERT)
2455     unsigned int req_usage = ( ctx->req_usage & USAGE_MASK );
2456     /* Request the primary if we're certifying another key, and also
2457        if signing data while --pgp6 or --pgp7 is on since pgp 6 and 7
2458        do not understand signatures made by a signing subkey.  PGP 8
2459        does. */
2460     int req_prim = (ctx->req_usage & PUBKEY_USAGE_CERT) ||
2461       ((PGP6 || PGP7) && (ctx->req_usage & PUBKEY_USAGE_SIG));
2462     u32 latest_date;
2463     KBNODE latest_key;
2464     u32 curtime = make_timestamp ();
2465
2466     assert( keyblock->pkt->pkttype == PKT_PUBLIC_KEY );
2467    
2468     ctx->found_key = NULL;
2469
2470     if (ctx->exact) {
2471         for (k=keyblock; k; k = k->next) {
2472             if ( (k->flag & 1) ) {
2473                 assert ( k->pkt->pkttype == PKT_PUBLIC_KEY
2474                          || k->pkt->pkttype == PKT_PUBLIC_SUBKEY );
2475                 foundk = k;
2476                 break;
2477             }
2478         }
2479     }
2480
2481     for (k=keyblock; k; k = k->next) {
2482         if ( (k->flag & 2) ) {
2483             assert (k->pkt->pkttype == PKT_USER_ID);
2484             foundu = k->pkt->pkt.user_id;
2485             break;
2486         }
2487     }
2488
2489     if ( DBG_CACHE )
2490         log_debug( "finish_lookup: checking key %08lX (%s)(req_usage=%x)\n",
2491                    (ulong)keyid_from_pk( keyblock->pkt->pkt.public_key, NULL),
2492                    foundk? "one":"all", req_usage);
2493
2494     if (!req_usage) {
2495         latest_key = foundk? foundk:keyblock;
2496         goto found;
2497     }
2498     
2499     if (!req_usage) {
2500         PKT_public_key *pk = foundk->pkt->pkt.public_key;
2501         if (pk->user_id)
2502             free_user_id (pk->user_id);
2503         pk->user_id = scopy_user_id (foundu);
2504         ctx->found_key = foundk;
2505         cache_user_id( keyblock );
2506         return 1; /* found */
2507     }
2508     
2509     latest_date = 0;
2510     latest_key  = NULL;
2511     /* do not look at subkeys if a certification key is requested */
2512     if ((!foundk || foundk->pkt->pkttype == PKT_PUBLIC_SUBKEY) && !req_prim) {
2513         KBNODE nextk;
2514         /* either start a loop or check just this one subkey */
2515         for (k=foundk?foundk:keyblock; k; k = nextk ) {
2516             PKT_public_key *pk;
2517             nextk = k->next;
2518             if ( k->pkt->pkttype != PKT_PUBLIC_SUBKEY )
2519                 continue;
2520             if ( foundk )
2521                 nextk = NULL;  /* what a hack */
2522             pk = k->pkt->pkt.public_key;
2523             if (DBG_CACHE)
2524                 log_debug( "\tchecking subkey %08lX\n",
2525                            (ulong)keyid_from_pk( pk, NULL));
2526             if ( !pk->is_valid ) {
2527                 if (DBG_CACHE)
2528                     log_debug( "\tsubkey not valid\n");
2529                 continue;
2530             }
2531             if ( pk->is_revoked ) {
2532                 if (DBG_CACHE)
2533                     log_debug( "\tsubkey has been revoked\n");
2534                 continue;
2535             }
2536             if ( pk->has_expired ) {
2537                 if (DBG_CACHE)
2538                     log_debug( "\tsubkey has expired\n");
2539                 continue;
2540             }
2541             if ( pk->timestamp > curtime && !opt.ignore_valid_from ) {
2542                 if (DBG_CACHE)
2543                     log_debug( "\tsubkey not yet valid\n");
2544                 continue;
2545             }
2546             
2547             if ( !((pk->pubkey_usage&USAGE_MASK) & req_usage) ) {
2548                 if (DBG_CACHE)
2549                     log_debug( "\tusage does not match: want=%x have=%x\n",
2550                                req_usage, pk->pubkey_usage );
2551                 continue;
2552             }
2553
2554             if (DBG_CACHE)
2555                 log_debug( "\tsubkey looks fine\n");
2556             if ( pk->timestamp > latest_date ) {
2557                 latest_date = pk->timestamp;
2558                 latest_key  = k;
2559             }
2560         }
2561     }
2562
2563     /* Okay now try the primary key unless we want an exact 
2564      * key ID match on a subkey */
2565     if ((!latest_key && !(ctx->exact && foundk != keyblock)) || req_prim) {
2566         PKT_public_key *pk;
2567         if (DBG_CACHE && !foundk && !req_prim )
2568             log_debug( "\tno suitable subkeys found - trying primary\n");
2569         pk = keyblock->pkt->pkt.public_key;
2570         if ( !pk->is_valid ) {
2571             if (DBG_CACHE)
2572                 log_debug( "\tprimary key not valid\n");
2573         }
2574         else if ( pk->is_revoked ) {
2575             if (DBG_CACHE)
2576                 log_debug( "\tprimary key has been revoked\n");
2577         }
2578         else if ( pk->has_expired ) {
2579             if (DBG_CACHE)
2580                 log_debug( "\tprimary key has expired\n");
2581         }
2582         else  if ( !((pk->pubkey_usage&USAGE_MASK) & req_usage) ) {
2583             if (DBG_CACHE)
2584                 log_debug( "\tprimary key usage does not match: "
2585                            "want=%x have=%x\n",
2586                            req_usage, pk->pubkey_usage );
2587         }
2588         else { /* okay */
2589             if (DBG_CACHE)
2590                 log_debug( "\tprimary key may be used\n");
2591             latest_key = keyblock;
2592             latest_date = pk->timestamp;
2593         }
2594     }
2595     
2596     if ( !latest_key ) {
2597         if (DBG_CACHE)
2598             log_debug("\tno suitable key found -  giving up\n");
2599         return 0;
2600     }
2601
2602  found:
2603     if (DBG_CACHE)
2604         log_debug( "\tusing key %08lX\n",
2605                 (ulong)keyid_from_pk( latest_key->pkt->pkt.public_key, NULL) );
2606
2607     if (latest_key) {
2608         PKT_public_key *pk = latest_key->pkt->pkt.public_key;
2609         if (pk->user_id)
2610             free_user_id (pk->user_id);
2611         pk->user_id = scopy_user_id (foundu);
2612     }    
2613         
2614     ctx->found_key = latest_key;
2615
2616     if (latest_key != keyblock && opt.verbose)
2617       {
2618         char *tempkeystr=
2619           xstrdup(keystr_from_pk(latest_key->pkt->pkt.public_key));
2620         log_info(_("using subkey %s instead of primary key %s\n"),
2621                  tempkeystr, keystr_from_pk(keyblock->pkt->pkt.public_key));
2622         xfree(tempkeystr);
2623       }
2624
2625     cache_user_id( keyblock );
2626     
2627     return 1; /* found */
2628 }
2629
2630
2631 static int
2632 lookup( GETKEY_CTX ctx, KBNODE *ret_keyblock, int secmode )
2633 {
2634     int rc;
2635     KBNODE secblock = NULL; /* helper */
2636     int no_suitable_key = 0;
2637     
2638     rc = 0;
2639     while (!(rc = keydb_search (ctx->kr_handle, ctx->items, ctx->nitems))) {
2640         /* If we are searching for the first key we have to make sure
2641            that the next interation does not no an implicit reset.
2642            This can be triggered by an empty key ring. */
2643         if (ctx->nitems && ctx->items->mode == KEYDB_SEARCH_MODE_FIRST)
2644             ctx->items->mode = KEYDB_SEARCH_MODE_NEXT;
2645
2646         rc = keydb_get_keyblock (ctx->kr_handle, &ctx->keyblock);
2647         if (rc) {
2648             log_error ("keydb_get_keyblock failed: %s\n", g10_errstr(rc));
2649             rc = 0;
2650             goto skip;
2651         }
2652                        
2653         if ( secmode ) {
2654             /* find the correspondig public key and use this 
2655              * this one for the selection process */
2656             u32 aki[2];
2657             KBNODE k = ctx->keyblock;
2658             
2659             if (k->pkt->pkttype != PKT_SECRET_KEY)
2660                 BUG();
2661
2662             keyid_from_sk (k->pkt->pkt.secret_key, aki);
2663             k = get_pubkeyblock (aki);
2664             if( !k )
2665               {
2666                 if (!opt.quiet)
2667                   log_info(_("key %s: secret key without public key"
2668                              " - skipped\n"), keystr(aki));
2669                 goto skip;
2670               }
2671             secblock = ctx->keyblock;
2672             ctx->keyblock = k;
2673
2674             premerge_public_with_secret ( ctx->keyblock, secblock );
2675         }
2676
2677         /* warning: node flag bits 0 and 1 should be preserved by
2678          * merge_selfsigs.  For secret keys, premerge did tranfer the
2679          * keys to the keyblock */
2680         merge_selfsigs ( ctx->keyblock );
2681         if ( finish_lookup (ctx) ) {
2682             no_suitable_key = 0;
2683             if ( secmode ) {
2684                 merge_public_with_secret ( ctx->keyblock,
2685                                            secblock);
2686                 release_kbnode (secblock);
2687                 secblock = NULL;
2688             }
2689             goto found;
2690         }
2691         else
2692             no_suitable_key = 1;
2693         
2694       skip:
2695         /* release resources and continue search */
2696         if ( secmode ) {
2697             release_kbnode( secblock );
2698             secblock = NULL;
2699         }
2700         release_kbnode( ctx->keyblock );
2701         ctx->keyblock = NULL;
2702     }
2703
2704   found:
2705     if( rc && rc != -1 )
2706         log_error("keydb_search failed: %s\n", g10_errstr(rc));
2707
2708     if( !rc ) {
2709         *ret_keyblock = ctx->keyblock; /* return the keyblock */
2710         ctx->keyblock = NULL;
2711     }
2712     else if (rc == -1 && no_suitable_key)
2713         rc = secmode ? G10ERR_UNU_SECKEY : G10ERR_UNU_PUBKEY;
2714     else if( rc == -1 )
2715         rc = secmode ? G10ERR_NO_SECKEY : G10ERR_NO_PUBKEY;
2716
2717     if ( secmode ) {
2718         release_kbnode( secblock );
2719         secblock = NULL;
2720     }
2721     release_kbnode( ctx->keyblock );
2722     ctx->keyblock = NULL;
2723
2724     ctx->last_rc = rc;
2725     return rc;
2726 }
2727
2728
2729
2730
2731 /****************
2732  * FIXME: Replace by the generic function 
2733  *        It does not work as it is right now - it is used at 
2734  *        2 places:  a) to get the key for an anonyous recipient
2735  *                   b) to get the ultimately trusted keys.
2736  *        The a) usage might have some problems.
2737  *
2738  * set with_subkeys true to include subkeys
2739  * set with_spm true to include secret-parts-missing keys
2740  *
2741  * Enumerate all primary secret keys.  Caller must use these procedure:
2742  *  1) create a void pointer and initialize it to NULL
2743  *  2) pass this void pointer by reference to this function
2744  *     and provide space for the secret key (pass a buffer for sk)
2745  *  3) call this function as long as it does not return -1
2746  *     to indicate EOF.
2747  *  4) Always call this function a last time with SK set to NULL,
2748  *     so that can free it's context.
2749  */
2750 int
2751 enum_secret_keys( void **context, PKT_secret_key *sk,
2752                   int with_subkeys, int with_spm )
2753 {
2754     int rc=0;
2755     struct {
2756         int eof;
2757         int first;
2758         KEYDB_HANDLE hd;
2759         KBNODE keyblock;
2760         KBNODE node;
2761     } *c = *context;
2762
2763
2764     if( !c ) { /* make a new context */
2765         c = xmalloc_clear( sizeof *c );
2766         *context = c;
2767         c->hd = keydb_new (1);
2768         c->first = 1;
2769         c->keyblock = NULL;
2770         c->node = NULL;
2771     }
2772
2773     if( !sk ) { /* free the context */
2774         keydb_release (c->hd);
2775         release_kbnode (c->keyblock);
2776         xfree( c );
2777         *context = NULL;
2778         return 0;
2779     }
2780
2781     if( c->eof )
2782         return -1;
2783
2784     do {
2785         /* get the next secret key from the current keyblock */
2786         for (; c->node; c->node = c->node->next) {
2787             if ((c->node->pkt->pkttype == PKT_SECRET_KEY
2788                 || (with_subkeys
2789                     && c->node->pkt->pkttype == PKT_SECRET_SUBKEY) )
2790                 && !(c->node->pkt->pkt.secret_key->protect.s2k.mode==1001
2791                      && !with_spm)) {
2792                 copy_secret_key (sk, c->node->pkt->pkt.secret_key );
2793                 c->node = c->node->next;
2794                 return 0; /* found */
2795             }
2796         }
2797         release_kbnode (c->keyblock);
2798         c->keyblock = c->node = NULL;
2799         
2800         rc = c->first? keydb_search_first (c->hd) : keydb_search_next (c->hd);
2801         c->first = 0;
2802         if (rc) {
2803             keydb_release (c->hd); c->hd = NULL;
2804             c->eof = 1;
2805             return -1; /* eof */
2806         }
2807         
2808         rc = keydb_get_keyblock (c->hd, &c->keyblock);
2809         c->node = c->keyblock;
2810     } while (!rc);
2811
2812     return rc; /* error */
2813 }
2814
2815
2816 \f
2817 /*********************************************
2818  ***********  user ID printing helpers *******
2819  *********************************************/
2820
2821 /****************
2822  * Return a string with a printable representation of the user_id.
2823  * this string must be freed by xfree.
2824  */
2825 char*
2826 get_user_id_string( u32 *keyid )
2827 {
2828   user_id_db_t r;
2829   char *p;
2830   int pass=0;
2831   /* try it two times; second pass reads from key resources */
2832   do
2833     {
2834       for(r=user_id_db; r; r = r->next )
2835         {
2836           keyid_list_t a;
2837           for (a=r->keyids; a; a= a->next )
2838             {
2839               if( a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1] )
2840                 {
2841                   p = xmalloc( keystrlen() + 1 + r->len + 1 );
2842                   sprintf(p, "%s %.*s", keystr(keyid), r->len, r->name );
2843                   return p;
2844                 }
2845             }
2846         }
2847     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
2848   p = xmalloc( keystrlen() + 5 );
2849   sprintf(p, "%s [?]", keystr(keyid));
2850   return p;
2851 }
2852
2853
2854 char*
2855 get_user_id_string_native ( u32 *keyid )
2856 {
2857   char *p = get_user_id_string( keyid );
2858   char *p2 = utf8_to_native( p, strlen(p), 0 );
2859   xfree(p);
2860   return p2;
2861 }
2862
2863
2864 char*
2865 get_long_user_id_string( u32 *keyid )
2866 {
2867     user_id_db_t r;
2868     char *p;
2869     int pass=0;
2870     /* try it two times; second pass reads from key resources */
2871     do {
2872         for(r=user_id_db; r; r = r->next ) {
2873             keyid_list_t a;
2874             for (a=r->keyids; a; a= a->next ) {
2875                 if( a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1] ) {
2876                     p = xmalloc( r->len + 20 );
2877                     sprintf(p, "%08lX%08lX %.*s",
2878                             (ulong)keyid[0], (ulong)keyid[1],
2879                             r->len, r->name );
2880                     return p;
2881                 }
2882             }
2883         }
2884     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
2885     p = xmalloc( 25 );
2886     sprintf(p, "%08lX%08lX [?]", (ulong)keyid[0], (ulong)keyid[1] );
2887     return p;
2888 }
2889
2890 char*
2891 get_user_id( u32 *keyid, size_t *rn )
2892 {
2893     user_id_db_t r;
2894     char *p;
2895     int pass=0;
2896
2897     /* try it two times; second pass reads from key resources */
2898     do {
2899         for(r=user_id_db; r; r = r->next ) {
2900             keyid_list_t a;
2901             for (a=r->keyids; a; a= a->next ) {
2902                 if( a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1] ) {
2903                     p = xmalloc( r->len );
2904                     memcpy(p, r->name, r->len );
2905                     *rn = r->len;
2906                     return p;
2907                 }
2908             }
2909         }
2910     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
2911     p = xstrdup( user_id_not_found_utf8 () );
2912     *rn = strlen(p);
2913     return p;
2914 }
2915
2916 char*
2917 get_user_id_native( u32 *keyid )
2918 {
2919   size_t rn;
2920   char *p = get_user_id( keyid, &rn );
2921   char *p2 = utf8_to_native( p, rn, 0 );
2922   xfree(p);
2923   return p2;
2924 }
2925
2926 KEYDB_HANDLE
2927 get_ctx_handle(GETKEY_CTX ctx)
2928 {
2929   return ctx->kr_handle;
2930 }
2931
2932 static void
2933 free_akl(struct akl *akl)
2934 {
2935   if(akl->spec)
2936     free_keyserver_spec(akl->spec);
2937
2938   xfree(akl);
2939 }
2940
2941 void
2942 release_akl(void)
2943 {
2944   while(opt.auto_key_locate)
2945     {
2946       struct akl *akl2=opt.auto_key_locate;
2947       opt.auto_key_locate=opt.auto_key_locate->next;
2948       free_akl(akl2);
2949     }
2950 }
2951
2952 int
2953 parse_auto_key_locate(char *options)
2954 {
2955   char *tok;
2956
2957   while((tok=optsep(&options)))
2958     {
2959       struct akl *akl,*check,*last=NULL;
2960       int dupe=0;
2961
2962       if(tok[0]=='\0')
2963         continue;
2964
2965       akl=xmalloc_clear(sizeof(*akl));
2966
2967       if(ascii_strcasecmp(tok,"ldap")==0)
2968         akl->type=AKL_LDAP;
2969       else if(ascii_strcasecmp(tok,"keyserver")==0)
2970         akl->type=AKL_KEYSERVER;
2971 #ifdef USE_DNS_CERT
2972       else if(ascii_strcasecmp(tok,"cert")==0)
2973         akl->type=AKL_CERT;
2974 #endif
2975 #ifdef USE_DNS_PKA
2976       else if(ascii_strcasecmp(tok,"pka")==0)
2977         akl->type=AKL_PKA;
2978 #endif
2979       else if((akl->spec=parse_keyserver_uri(tok,1,NULL,0)))
2980         akl->type=AKL_SPEC;
2981       else
2982         {
2983           free_akl(akl);
2984           return 0;
2985         }
2986
2987       /* We must maintain the order the user gave us */
2988       for(check=opt.auto_key_locate;check;last=check,check=check->next)
2989         {
2990           /* Check for duplicates */
2991           if(check->type==akl->type
2992              && (akl->type!=AKL_SPEC
2993                  || (akl->type==AKL_SPEC
2994                      && strcmp(check->spec->uri,akl->spec->uri)==0)))
2995             {
2996               dupe=1;
2997               free_akl(akl);
2998               break;
2999             }
3000         }
3001
3002       if(!dupe)
3003         {
3004           if(last)
3005             last->next=akl;
3006           else
3007             opt.auto_key_locate=akl;
3008         }
3009     }
3010
3011   return 1;
3012 }