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