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