added fast-import to import-options
[gnupg.git] / g10 / getkey.c
1 /* getkey.c -  Get a key from the database
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <assert.h>
26 #include <ctype.h>
27 #include "util.h"
28 #include "packet.h"
29 #include "memory.h"
30 #include "iobuf.h"
31 #include "keydb.h"
32 #include "options.h"
33 #include "main.h"
34 #include "trustdb.h"
35 #include "i18n.h"
36
37 #define MAX_PK_CACHE_ENTRIES   200
38 #define MAX_UID_CACHE_ENTRIES  200
39
40 #if MAX_PK_CACHE_ENTRIES < 2
41   #error We need the cache for key creation
42 #endif
43
44
45 struct getkey_ctx_s {
46     int exact;
47     KBNODE keyblock;
48     KBPOS  kbpos;
49     KBNODE found_key; /* pointer into some keyblock */
50     int last_rc;
51     int req_usage;
52     int req_algo;
53     KEYDB_HANDLE kr_handle;
54     int not_allocated;
55     int nitems;
56     KEYDB_SEARCH_DESC items[1];
57 };
58
59 #if 0
60 static struct {
61     int any;
62     int okay_count;
63     int nokey_count;
64     int error_count;
65 } lkup_stats[21];
66 #endif
67
68 typedef struct keyid_list {
69     struct keyid_list *next;
70     u32 keyid[2];
71 } *keyid_list_t;
72
73
74 #if MAX_PK_CACHE_ENTRIES
75   typedef struct pk_cache_entry {
76       struct pk_cache_entry *next;
77       u32 keyid[2];
78       PKT_public_key *pk;
79   } *pk_cache_entry_t;
80   static pk_cache_entry_t pk_cache;
81   static int pk_cache_entries;   /* number of entries in pk cache */
82   static int pk_cache_disabled;
83 #endif
84
85 #if MAX_UID_CACHE_ENTRIES < 5
86     #error we really need the userid cache
87 #endif
88 typedef struct user_id_db {
89     struct user_id_db *next;
90     keyid_list_t keyids;
91     int len;
92     char name[1];
93 } *user_id_db_t;
94 static user_id_db_t user_id_db;
95 static int uid_cache_entries;   /* number of entries in uid cache */
96
97 static void merge_selfsigs( KBNODE keyblock );
98 static int lookup( GETKEY_CTX ctx, KBNODE *ret_keyblock, int secmode );
99
100 #if 0
101 static void
102 print_stats()
103 {
104     int i;
105     for(i=0; i < DIM(lkup_stats); i++ ) {
106         if( lkup_stats[i].any )
107             fprintf(stderr,
108                     "lookup stats: mode=%-2d  ok=%-6d  nokey=%-6d  err=%-6d\n",
109                     i,
110                     lkup_stats[i].okay_count,
111                     lkup_stats[i].nokey_count,
112                     lkup_stats[i].error_count );
113     }
114 }
115 #endif
116
117
118 void
119 cache_public_key( PKT_public_key *pk )
120 {
121   #if MAX_PK_CACHE_ENTRIES
122     pk_cache_entry_t ce;
123     u32 keyid[2];
124
125     if( pk_cache_disabled )
126         return;
127
128     if( pk->dont_cache )
129         return;
130
131     if( is_ELGAMAL(pk->pubkey_algo)
132         || pk->pubkey_algo == PUBKEY_ALGO_DSA
133         || is_RSA(pk->pubkey_algo) ) {
134         keyid_from_pk( pk, keyid );
135     }
136     else
137         return; /* don't know how to get the keyid */
138
139     for( ce = pk_cache; ce; ce = ce->next )
140         if( ce->keyid[0] == keyid[0] && ce->keyid[1] == keyid[1] ) {
141             if( DBG_CACHE )
142                 log_debug("cache_public_key: already in cache\n");
143             return;
144         }
145
146     if( pk_cache_entries >= MAX_PK_CACHE_ENTRIES ) {
147         /* fixme: use another algorithm to free some cache slots */
148         pk_cache_disabled=1;
149         if( opt.verbose > 1 )
150             log_info(_("too many entries in pk cache - disabled\n"));
151         return;
152     }
153     pk_cache_entries++;
154     ce = m_alloc( sizeof *ce );
155     ce->next = pk_cache;
156     pk_cache = ce;
157     ce->pk = copy_public_key( NULL, pk );
158     ce->keyid[0] = keyid[0];
159     ce->keyid[1] = keyid[1];
160   #endif
161 }
162
163
164 /*
165  * Return the user ID from the given keyblock.
166  * We use the primary uid flag which has been set by the merge_selfsigs
167  * function.  The returned value is only valid as long as then given
168  * keyblock is not changed
169  */
170 static const char *
171 get_primary_uid ( KBNODE keyblock, size_t *uidlen )
172 {
173     KBNODE k;
174     const char *s;
175
176     for (k=keyblock; k; k=k->next ) {
177         if ( k->pkt->pkttype == PKT_USER_ID
178              && !k->pkt->pkt.user_id->attrib_data
179              && k->pkt->pkt.user_id->is_primary ) {
180             *uidlen = k->pkt->pkt.user_id->len;
181             return k->pkt->pkt.user_id->name;
182         }
183     } 
184     /* fixme: returning translatable constants instead of a user ID is 
185      * not good because they are probably not utf-8 encoded. */
186     s = _("[User id not found]");
187     *uidlen = strlen (s);
188     return s;
189 }
190
191
192 static void
193 release_keyid_list ( keyid_list_t k )
194 {
195     while (  k ) {
196         keyid_list_t k2 = k->next;
197         m_free (k);
198         k = k2;
199     }
200 }
201
202 /****************
203  * Store the association of keyid and userid
204  * Feed only public keys to this function.
205  */
206 static void
207 cache_user_id( KBNODE keyblock )
208 {
209     user_id_db_t r;
210     const char *uid;
211     size_t uidlen;
212     keyid_list_t keyids = NULL;
213     KBNODE k;
214
215     for (k=keyblock; k; k = k->next ) {
216         if ( k->pkt->pkttype == PKT_PUBLIC_KEY
217              || k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
218             keyid_list_t a = m_alloc_clear ( sizeof *a );
219             /* Hmmm: For a long list of keyids it might be an advantage
220              * to append the keys */
221             keyid_from_pk( k->pkt->pkt.public_key, a->keyid );
222             /* first check for duplicates */
223             for(r=user_id_db; r; r = r->next ) {
224                 keyid_list_t b = r->keyids;
225                 for ( b = r->keyids; b; b = b->next ) {
226                     if( b->keyid[0] == a->keyid[0]
227                         && b->keyid[1] == a->keyid[1] ) {
228                         if( DBG_CACHE )
229                             log_debug("cache_user_id: already in cache\n");
230                         release_keyid_list ( keyids );
231                         m_free ( a );
232                         return;
233                     }
234                 }
235             }
236             /* now put it into the cache */
237             a->next = keyids;
238             keyids = a;
239         }
240     }
241     if ( !keyids )
242         BUG (); /* No key no fun */
243
244
245     uid = get_primary_uid ( keyblock, &uidlen );
246
247     if( uid_cache_entries >= MAX_UID_CACHE_ENTRIES ) {
248         /* fixme: use another algorithm to free some cache slots */
249         r = user_id_db;
250         user_id_db = r->next;
251         release_keyid_list ( r->keyids );
252         m_free(r);
253         uid_cache_entries--;
254     }
255     r = m_alloc( sizeof *r + uidlen-1 );
256     r->keyids = keyids;
257     r->len = uidlen;
258     memcpy(r->name, uid, r->len);
259     r->next = user_id_db;
260     user_id_db = r;
261     uid_cache_entries++;
262 }
263
264
265 void
266 getkey_disable_caches()
267 {
268   #if MAX_PK_CACHE_ENTRIES
269     {
270         pk_cache_entry_t ce, ce2;
271
272         for( ce = pk_cache; ce; ce = ce2 ) {
273             ce2 = ce->next;
274             free_public_key( ce->pk );
275             m_free( ce );
276         }
277         pk_cache_disabled=1;
278         pk_cache_entries = 0;
279         pk_cache = NULL;
280     }
281   #endif
282     /* fixme: disable user id cache ? */
283 }
284
285
286 static void
287 pk_from_block ( GETKEY_CTX ctx, PKT_public_key *pk, KBNODE keyblock )
288 {
289     KBNODE a = ctx->found_key ? ctx->found_key : keyblock;
290
291     assert ( a->pkt->pkttype == PKT_PUBLIC_KEY
292              ||  a->pkt->pkttype == PKT_PUBLIC_SUBKEY );
293      
294     copy_public_key ( pk, a->pkt->pkt.public_key );
295 }
296
297 static void
298 sk_from_block ( GETKEY_CTX ctx,
299                 PKT_secret_key *sk, KBNODE keyblock )
300 {
301     KBNODE a = ctx->found_key ? ctx->found_key : keyblock;
302
303     assert ( a->pkt->pkttype == PKT_SECRET_KEY
304              ||  a->pkt->pkttype == PKT_SECRET_SUBKEY );
305      
306     copy_secret_key( sk, a->pkt->pkt.secret_key);
307 }
308
309
310 /****************
311  * Get a public key and store it into the allocated pk
312  * can be called with PK set to NULL to just read it into some
313  * internal structures.
314  */
315 int
316 get_pubkey( PKT_public_key *pk, u32 *keyid )
317 {
318     int internal = 0;
319     int rc = 0;
320
321   #if MAX_PK_CACHE_ENTRIES
322     {   /* Try to get it from the cache */
323         pk_cache_entry_t ce;
324         for( ce = pk_cache; ce; ce = ce->next ) {
325             if( ce->keyid[0] == keyid[0] && ce->keyid[1] == keyid[1] ) {
326                 if( pk )
327                     copy_public_key( pk, ce->pk );
328                 return 0;
329             }
330         }
331     }
332   #endif
333     /* more init stuff */
334     if( !pk ) {
335         pk = m_alloc_clear( sizeof *pk );
336         internal++;
337     }
338
339
340     /* do a lookup */
341     {   struct getkey_ctx_s ctx;
342         KBNODE kb = NULL;
343         memset( &ctx, 0, sizeof ctx );
344         ctx.exact = 1; /* use the key ID exactly as given */
345         ctx.not_allocated = 1;
346         ctx.kr_handle = keydb_new (0);
347         ctx.nitems = 1;
348         ctx.items[0].mode = KEYDB_SEARCH_MODE_LONG_KID;
349         ctx.items[0].u.kid[0] = keyid[0];
350         ctx.items[0].u.kid[1] = keyid[1];
351         ctx.req_algo  = pk->req_algo;
352         ctx.req_usage = pk->req_usage;
353         rc = lookup( &ctx, &kb, 0 );
354         if ( !rc ) {
355             pk_from_block ( &ctx, pk, kb );
356         }
357         get_pubkey_end( &ctx );
358         release_kbnode ( kb );
359     }
360     if( !rc )
361         goto leave;
362
363     rc = G10ERR_NO_PUBKEY;
364
365   leave:
366     if( !rc )
367         cache_public_key( pk );
368     if( internal )
369         free_public_key(pk);
370     return rc;
371 }
372
373
374 KBNODE
375 get_pubkeyblock( u32 *keyid )
376 {
377     struct getkey_ctx_s ctx;
378     int rc = 0;
379     KBNODE keyblock = NULL;
380
381     memset( &ctx, 0, sizeof ctx );
382     /* no need to set exact here because we want the entire block */
383     ctx.not_allocated = 1;
384     ctx.kr_handle = keydb_new (0);
385     ctx.nitems = 1;
386     ctx.items[0].mode = KEYDB_SEARCH_MODE_LONG_KID;
387     ctx.items[0].u.kid[0] = keyid[0];
388     ctx.items[0].u.kid[1] = keyid[1];
389     rc = lookup( &ctx, &keyblock, 0 );
390     get_pubkey_end( &ctx );
391
392     return rc ? NULL : keyblock;
393 }
394
395
396
397
398 /****************
399  * Get a secret key and store it into sk
400  */
401 int
402 get_seckey( PKT_secret_key *sk, u32 *keyid )
403 {
404     int rc;
405     struct getkey_ctx_s ctx;
406     KBNODE kb = NULL;
407
408     memset( &ctx, 0, sizeof ctx );
409     ctx.exact = 1; /* use the key ID exactly as given */
410     ctx.not_allocated = 1;
411     ctx.kr_handle = keydb_new (1);
412     ctx.nitems = 1;
413     ctx.items[0].mode = KEYDB_SEARCH_MODE_LONG_KID;
414     ctx.items[0].u.kid[0] = keyid[0];
415     ctx.items[0].u.kid[1] = keyid[1];
416     ctx.req_algo  = sk->req_algo;
417     ctx.req_usage = sk->req_usage;
418     rc = lookup( &ctx, &kb, 1 );
419     if ( !rc ) {
420         sk_from_block ( &ctx, sk, kb );
421     }
422     get_seckey_end( &ctx );
423     release_kbnode ( kb );
424
425     if( !rc ) {
426         /* check the secret key (this may prompt for a passprase to
427          * unlock the secret key
428          */
429         rc = check_secret_key( sk, 0 );
430     }
431
432     return rc;
433 }
434
435
436 /****************
437  * Check whether the secret key is available.  This is just a fast
438  * check and does not tell us whether the secret key is valid.  It
439  * merely tells other whether there is some secret key.
440  * Returns: 0 := key is available
441  * G10ERR_NO_SECKEY := not availabe
442  */
443 int
444 seckey_available( u32 *keyid )
445 {
446     int rc;
447     KEYDB_HANDLE hd = keydb_new (1);
448
449     rc = keydb_search_kid (hd, keyid);
450     if ( rc == -1 )
451         rc = G10ERR_NO_SECKEY;
452     keydb_release (hd);
453     return rc;
454 }
455
456
457 /****************
458  * Return the type of the user id:
459  *
460  * Please use the constants KEYDB_SERCH_MODE_xxx
461  *  0 = Invalid user ID
462  *  1 = exact match
463  *  2 = match a substring
464  *  3 = match an email address
465  *  4 = match a substring of an email address
466  *  5 = match an email address, but compare from end
467  *  6 = word match mode
468  * 10 = it is a short KEYID (don't care about keyid[0])
469  * 11 = it is a long  KEYID
470  * 12 = it is a trustdb index (keyid is looked up)
471  * 16 = it is a 16 byte fingerprint
472  * 20 = it is a 20 byte fingerprint
473  * 21 = Unified fingerprint :fpr:pk_algo:
474  *      (We don't use pk_algo yet)
475  *
476  * Rules used:
477  * - If the username starts with 8,9,16 or 17 hex-digits (the first one
478  *   must be in the range 0..9), this is considered a keyid; depending
479  *   on the length a short or complete one.
480  * - If the username starts with 32,33,40 or 41 hex-digits (the first one
481  *   must be in the range 0..9), this is considered a fingerprint.
482  * - If the username starts with a left angle, we assume it is a complete
483  *   email address and look only at this part.
484  * - If the username starts with a colon we assume it is a unified 
485  *   key specfification. 
486  * - If the username starts with a '.', we assume it is the ending
487  *   part of an email address
488  * - If the username starts with an '@', we assume it is a part of an
489  *   email address
490  * - If the userid start with an '=' an exact compare is done.
491  * - If the userid starts with a '*' a case insensitive substring search is
492  *   done (This is the default).
493  * - If the userid starts with a '+' we will compare individual words
494  *   and a match requires that all the words are in the userid.
495  *   Words are delimited by white space or "()<>[]{}.@-+_,;/&!"
496  *   (note that you can't search for these characters). Compare
497  *   is not case sensitive.
498  */
499
500 static int
501 classify_user_id2( const char *name, 
502                    KEYDB_SEARCH_DESC *desc,
503                    int *force_exact )
504 {
505     const char *s;
506     int hexprefix = 0;
507     int hexlength;
508     int mode = 0;   
509     
510     /* clear the structure so that the mode field is set to zero unless
511      * we set it to the correct value right at the end of this function */
512     memset (desc, 0, sizeof *desc);
513     *force_exact = 0;
514     /* skip leading spaces.  Fixme: what is with trailing spaces? */
515     for(s = name; *s && isspace(*s); s++ )
516         ;
517
518     switch (*s) {
519         case 0:    /* empty string is an error */
520             return 0;
521
522         case '.':  /* an email address, compare from end */
523             mode = KEYDB_SEARCH_MODE_MAILEND;
524             s++;
525             desc->u.name = s;
526             break;
527
528         case '<':  /* an email address */
529             mode = KEYDB_SEARCH_MODE_MAIL;
530             desc->u.name = s;
531             break;
532
533         case '@':  /* part of an email address */
534             mode = KEYDB_SEARCH_MODE_MAILSUB;
535             s++;
536             desc->u.name = s;
537             break;
538
539         case '=':  /* exact compare */
540             mode = KEYDB_SEARCH_MODE_EXACT;
541             s++;
542             desc->u.name = s;
543             break;
544
545         case '*':  /* case insensitive substring search */
546             mode = KEYDB_SEARCH_MODE_SUBSTR;
547             s++;
548             desc->u.name = s;
549             break;
550
551         case '+':  /* compare individual words */
552             mode = KEYDB_SEARCH_MODE_WORDS;
553             s++;
554             desc->u.name = s;
555             break;
556
557         case '#':  /* local user id */
558             return 0; /* This is now obsolete and van't not be used anymore*/
559         
560         case ':': /*Unified fingerprint */
561             {  
562                 const char *se, *si;
563                 int i;
564                 
565                 se = strchr( ++s,':');
566                 if ( !se )
567                     return 0;
568                 for (i=0,si=s; si < se; si++, i++ ) {
569                     if ( !strchr("01234567890abcdefABCDEF", *si ) )
570                         return 0; /* invalid digit */
571                 }
572                 if (i != 32 && i != 40)
573                     return 0; /* invalid length of fpr*/
574                 for (i=0,si=s; si < se; i++, si +=2) 
575                     desc->u.fpr[i] = hextobyte(si);
576                 for ( ; i < 20; i++)
577                     desc->u.fpr[i]= 0;
578                 s = se + 1;
579                 mode = KEYDB_SEARCH_MODE_FPR;
580             } 
581             break;
582            
583         default:
584             if (s[0] == '0' && s[1] == 'x') {
585                 hexprefix = 1;
586                 s += 2;
587             }
588
589             hexlength = strspn(s, "0123456789abcdefABCDEF");
590             if (hexlength >= 8 && s[hexlength] =='!') {
591                 *force_exact = 1;
592                 hexlength++; /* just for the following check */
593             }
594
595             /* check if a hexadecimal number is terminated by EOS or blank */
596             if (hexlength && s[hexlength] && !isspace(s[hexlength])) {
597                 if (hexprefix)      /* a "0x" prefix without correct */
598                     return 0;       /* termination is an error */
599                 else                /* The first chars looked like */
600                     hexlength = 0;  /* a hex number, but really were not. */
601             }
602
603             if (*force_exact)
604                 hexlength--;
605
606             if (hexlength == 8
607                 || (!hexprefix && hexlength == 9 && *s == '0')){
608                 /* short keyid */
609                 if (hexlength == 9)
610                     s++;
611                 desc->u.kid[0] = 0;
612                 desc->u.kid[1] = strtoul( s, NULL, 16 );
613                 mode = KEYDB_SEARCH_MODE_SHORT_KID;
614             }
615             else if (hexlength == 16
616                      || (!hexprefix && hexlength == 17 && *s == '0')) {
617                 /* complete keyid */
618                 char buf[9];
619                 if (hexlength == 17)
620                     s++;
621                 mem2str(buf, s, 9 );
622                 desc->u.kid[0] = strtoul( buf, NULL, 16 );
623                 desc->u.kid[1] = strtoul( s+8, NULL, 16 );
624                 mode = KEYDB_SEARCH_MODE_LONG_KID;
625             }
626             else if (hexlength == 32 || (!hexprefix && hexlength == 33
627                                                             && *s == '0')) {
628                 /* md5 fingerprint */
629                 int i;
630                 if (hexlength == 33)
631                     s++;
632                 memset(desc->u.fpr+16, 0, 4); 
633                 for (i=0; i < 16; i++, s+=2) {
634                     int c = hextobyte(s);
635                     if (c == -1)
636                         return 0;
637                     desc->u.fpr[i] = c;
638                 }
639                 mode = KEYDB_SEARCH_MODE_FPR16;
640             }
641             else if (hexlength == 40 || (!hexprefix && hexlength == 41
642                                                               && *s == '0')) {
643                 /* sha1/rmd160 fingerprint */
644                 int i;
645                 if (hexlength == 41)
646                     s++;
647                 for (i=0; i < 20; i++, s+=2) {
648                     int c = hextobyte(s);
649                     if (c == -1)
650                         return 0;
651                     desc->u.fpr[i] = c;
652                 }
653                 mode = KEYDB_SEARCH_MODE_FPR20;
654             }
655             else {
656                 if (hexprefix)  /* This was a hex number with a prefix */
657                     return 0;   /* and a wrong length */
658
659                 *force_exact = 0;
660                 desc->u.name = s;
661                 mode = KEYDB_SEARCH_MODE_SUBSTR;   /* default mode */
662             }
663     }
664
665     desc->mode = mode;
666     return mode;
667 }
668
669 int
670 classify_user_id (const char *name, KEYDB_SEARCH_DESC *desc)
671 {
672     int dummy;
673     KEYDB_SEARCH_DESC dummy_desc;
674
675     if (!desc)
676         desc = &dummy_desc;
677     return classify_user_id2 (name, desc, &dummy);
678 }
679
680 /****************
681  * Try to get the pubkey by the userid. This function looks for the
682  * first pubkey certificate which has the given name in a user_id.
683  * if pk/sk has the pubkey algo set, the function will only return
684  * a pubkey with that algo.
685  * The caller should provide storage for either the pk or the sk.
686  * If ret_kb is not NULL the function will return the keyblock there.
687  */
688
689 static int
690 key_byname( GETKEY_CTX *retctx, STRLIST namelist,
691             PKT_public_key *pk, PKT_secret_key *sk, int secmode,
692             KBNODE *ret_kb, KEYDB_HANDLE *ret_kdbhd )
693 {
694     int rc = 0;
695     int n;
696     STRLIST r;
697     GETKEY_CTX ctx;
698     KBNODE help_kb = NULL;
699     int exact;
700     
701     if( retctx ) {/* reset the returned context in case of error */
702         assert (!ret_kdbhd);  /* not allowed because the handle is
703                                  stored in the context */
704         *retctx = NULL;
705     }
706     if (ret_kdbhd)
707         *ret_kdbhd = NULL;
708
709     /* build the search context */
710     for(n=0, r=namelist; r; r = r->next )
711         n++;
712     ctx = m_alloc_clear (sizeof *ctx + (n-1)*sizeof ctx->items );
713     ctx->nitems = n;
714
715     for(n=0, r=namelist; r; r = r->next, n++ ) {
716         classify_user_id2 (r->d, &ctx->items[n], &exact);
717         
718         if (exact)
719             ctx->exact = 1;
720         if (!ctx->items[n].mode) {
721             m_free (ctx);
722             return G10ERR_INV_USER_ID;
723         }
724     }
725
726     ctx->kr_handle = keydb_new (secmode);
727     if ( !ret_kb ) 
728         ret_kb = &help_kb;
729
730     if( secmode ) {
731         if (sk) {
732             ctx->req_algo  = sk->req_algo;
733             ctx->req_usage = sk->req_usage;
734         }
735         rc = lookup( ctx, ret_kb, 1 );
736         if ( !rc && sk ) {
737             sk_from_block ( ctx, sk, *ret_kb );
738         }
739     }
740     else {
741         if (pk) {
742             ctx->req_algo  = pk->req_algo;
743             ctx->req_usage = pk->req_usage;
744         }
745         rc = lookup( ctx, ret_kb, 0 );
746         if ( !rc && pk ) {
747             pk_from_block ( ctx, pk, *ret_kb );
748         }
749     }
750
751     release_kbnode ( help_kb );
752
753     if (retctx) /* caller wants the context */
754         *retctx = ctx;
755     else {
756         if (ret_kdbhd) {
757             *ret_kdbhd = ctx->kr_handle;
758             ctx->kr_handle = NULL;
759         }
760         get_pubkey_end (ctx);
761     }
762
763     return rc;
764 }
765
766 /*
767  * Find a public key from NAME and returh the keyblock or the key.
768  * If ret_kdb is not NULL, the KEYDB handle used to locate this keyblock is
769  * returned and the caller is responsible for closing it.
770  */
771 int
772 get_pubkey_byname (PKT_public_key *pk,
773                    const char *name, KBNODE *ret_keyblock,
774                    KEYDB_HANDLE *ret_kdbhd ) 
775 {
776     int rc;
777     STRLIST namelist = NULL;
778
779     add_to_strlist( &namelist, name );
780     rc = key_byname( NULL, namelist, pk, NULL, 0, ret_keyblock, ret_kdbhd);
781     free_strlist( namelist );
782     return rc;
783 }
784
785 int
786 get_pubkey_bynames( GETKEY_CTX *retctx, PKT_public_key *pk,
787                     STRLIST names, KBNODE *ret_keyblock )
788 {
789     return key_byname( retctx, names, pk, NULL, 0, ret_keyblock, NULL);
790 }
791
792 int
793 get_pubkey_next( GETKEY_CTX ctx, PKT_public_key *pk, KBNODE *ret_keyblock )
794 {
795     int rc;
796
797     rc = lookup( ctx, ret_keyblock, 0 );
798     if ( !rc && pk && ret_keyblock )
799         pk_from_block ( ctx, pk, *ret_keyblock );
800     
801     return rc;
802 }
803
804
805 void
806 get_pubkey_end( GETKEY_CTX ctx )
807 {
808     if( ctx ) {
809         memset (&ctx->kbpos, 0, sizeof ctx->kbpos);
810         keydb_release (ctx->kr_handle);
811         if( !ctx->not_allocated )
812             m_free( ctx );
813     }
814 }
815
816
817
818
819 /****************
820  * Search for a key with the given fingerprint.
821  * FIXME:
822  * We should replace this with the _byname function.  Thiscsan be done
823  * by creating a userID conforming to the unified fingerprint style. 
824  */
825 int
826 get_pubkey_byfprint( PKT_public_key *pk,
827                      const byte *fprint, size_t fprint_len)
828 {
829     int rc;
830
831     if( fprint_len == 20 || fprint_len == 16 ) {
832         struct getkey_ctx_s ctx;
833         KBNODE kb = NULL;
834
835         memset( &ctx, 0, sizeof ctx );
836         ctx.exact = 1 ;
837         ctx.not_allocated = 1;
838         ctx.kr_handle = keydb_new (0);
839         ctx.nitems = 1;
840         ctx.items[0].mode = fprint_len==16? KEYDB_SEARCH_MODE_FPR16
841                                           : KEYDB_SEARCH_MODE_FPR20;
842         memcpy( ctx.items[0].u.fpr, fprint, fprint_len );
843         rc = lookup( &ctx, &kb, 0 );
844         if (!rc && pk )
845             pk_from_block ( &ctx, pk, kb );
846         release_kbnode ( kb );
847         get_pubkey_end( &ctx );
848     }
849     else
850         rc = G10ERR_GENERAL; /* Oops */
851     return rc;
852 }
853
854 /****************
855  * Search for a key with the given fingerprint and return the
856  * complete keyblock which may have more than only this key.
857  */
858 int
859 get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
860                                                 size_t fprint_len )
861 {
862     int rc;
863
864     if( fprint_len == 20 || fprint_len == 16 ) {
865         struct getkey_ctx_s ctx;
866
867         memset( &ctx, 0, sizeof ctx );
868         ctx.not_allocated = 1;
869         ctx.kr_handle = keydb_new (0);
870         ctx.nitems = 1;
871         ctx.items[0].mode = fprint_len==16? KEYDB_SEARCH_MODE_FPR16
872                                           : KEYDB_SEARCH_MODE_FPR20;
873         memcpy( ctx.items[0].u.fpr, fprint, fprint_len );
874         rc = lookup( &ctx, ret_keyblock, 0 );
875         get_pubkey_end( &ctx );
876     }
877     else
878         rc = G10ERR_GENERAL; /* Oops */
879
880     return rc;
881 }
882
883
884 /****************
885  * Get a secret key by name and store it into sk
886  * If NAME is NULL use the default key
887  */
888 static int
889 get_seckey_byname2( GETKEY_CTX *retctx,
890                    PKT_secret_key *sk, const char *name, int unprotect,
891                    KBNODE *retblock )
892 {
893     STRLIST namelist = NULL;
894     int rc;
895
896     if( !name && opt.def_secret_key && *opt.def_secret_key ) {
897         add_to_strlist( &namelist, opt.def_secret_key );
898         rc = key_byname( retctx, namelist, NULL, sk, 1, retblock, NULL );
899     }
900     else if( !name ) { /* use the first one as default key */
901         struct getkey_ctx_s ctx;
902         KBNODE kb = NULL;
903
904         assert (!retctx ); /* do we need this at all */
905         assert (!retblock);
906         memset( &ctx, 0, sizeof ctx );
907         ctx.not_allocated = 1;
908         ctx.kr_handle = keydb_new (1);
909         ctx.nitems = 1;
910         ctx.items[0].mode = KEYDB_SEARCH_MODE_FIRST;
911         rc = lookup( &ctx, &kb, 1 );
912         if (!rc && sk )
913             sk_from_block ( &ctx, sk, kb );
914         release_kbnode ( kb );
915         get_seckey_end( &ctx );
916     }
917     else {
918         add_to_strlist( &namelist, name );
919         rc = key_byname( retctx, namelist, NULL, sk, 1, retblock, NULL );
920     }
921
922     free_strlist( namelist );
923
924     if( !rc && unprotect )
925         rc = check_secret_key( sk, 0 );
926
927     return rc;
928 }
929
930 int 
931 get_seckey_byname( PKT_secret_key *sk, const char *name, int unlock )
932 {
933     return get_seckey_byname2 ( NULL, sk, name, unlock, NULL );
934 }
935
936
937 int
938 get_seckey_bynames( GETKEY_CTX *retctx, PKT_secret_key *sk,
939                     STRLIST names, KBNODE *ret_keyblock )
940 {
941     return key_byname( retctx, names, NULL, sk, 1, ret_keyblock, NULL );
942 }
943
944
945 int
946 get_seckey_next( GETKEY_CTX ctx, PKT_secret_key *sk, KBNODE *ret_keyblock )
947 {
948     int rc;
949
950     rc = lookup( ctx, ret_keyblock, 1 );
951     if ( !rc && sk && ret_keyblock )
952         sk_from_block ( ctx, sk, *ret_keyblock );
953
954     return rc;
955 }
956
957
958 void
959 get_seckey_end( GETKEY_CTX ctx )
960 {
961     get_pubkey_end( ctx );
962 }
963
964
965 /****************
966  * Search for a key with the given fingerprint.
967  * FIXME:
968  * We should replace this with the _byname function.  Thiscsan be done
969  * by creating a userID conforming to the unified fingerprint style. 
970  */
971 int
972 get_seckey_byfprint( PKT_secret_key *sk,
973                      const byte *fprint, size_t fprint_len)
974 {
975     int rc;
976
977     if( fprint_len == 20 || fprint_len == 16 ) {
978         struct getkey_ctx_s ctx;
979         KBNODE kb = NULL;
980
981         memset( &ctx, 0, sizeof ctx );
982         ctx.exact = 1 ;
983         ctx.not_allocated = 1;
984         ctx.kr_handle = keydb_new (1);
985         ctx.nitems = 1;
986         ctx.items[0].mode = fprint_len==16? KEYDB_SEARCH_MODE_FPR16
987                                           : KEYDB_SEARCH_MODE_FPR20;
988         memcpy( ctx.items[0].u.fpr, fprint, fprint_len );
989         rc = lookup( &ctx, &kb, 1 );
990         if (!rc && sk )
991             sk_from_block ( &ctx, sk, kb );
992         release_kbnode ( kb );
993         get_pubkey_end( &ctx );
994     }
995     else
996         rc = G10ERR_GENERAL; /* Oops */
997     return rc;
998 }
999
1000 \f
1001 /************************************************
1002  ************* Merging stuff ********************
1003  ************************************************/
1004
1005 /****************
1006  * merge all selfsignatures with the keys.
1007  * FIXME: replace this at least for the public key parts
1008  *        by merge_selfsigs.
1009  *        It is still used in keyedit.c and
1010  *        at 2 or 3 other places - check whether it is really needed.
1011  *        It might be needed by the key edit and import stuff because
1012  *        the keylock is changed.
1013  */
1014 void
1015 merge_keys_and_selfsig( KBNODE keyblock )
1016 {
1017     PKT_public_key *pk = NULL;
1018     PKT_secret_key *sk = NULL;
1019     PKT_signature *sig;
1020     KBNODE k;
1021     u32 kid[2] = { 0, 0 };
1022     u32 sigdate = 0;
1023
1024     if (keyblock && keyblock->pkt->pkttype == PKT_PUBLIC_KEY ) {
1025         /* divert to our new function */
1026         merge_selfsigs (keyblock);
1027         return;
1028     }
1029     /* still need the old one because the new one can't handle secret keys */
1030
1031     for(k=keyblock; k; k = k->next ) {
1032         if( k->pkt->pkttype == PKT_PUBLIC_KEY
1033             || k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
1034             pk = k->pkt->pkt.public_key; sk = NULL;
1035             if( pk->version < 4 )
1036                 pk = NULL; /* not needed for old keys */
1037             else if( k->pkt->pkttype == PKT_PUBLIC_KEY )
1038                 keyid_from_pk( pk, kid );
1039             else if( !pk->expiredate ) { /* and subkey */
1040                 /* insert the expiration date here */
1041                 /*FIXME!!! pk->expiredate = subkeys_expiretime( k, kid );*/
1042             }
1043             sigdate = 0;
1044         }
1045         else if( k->pkt->pkttype == PKT_SECRET_KEY
1046             || k->pkt->pkttype == PKT_SECRET_SUBKEY ) {
1047             pk = NULL; sk = k->pkt->pkt.secret_key;
1048             if( sk->version < 4 )
1049                 sk = NULL;
1050             else if( k->pkt->pkttype == PKT_SECRET_KEY )
1051                 keyid_from_sk( sk, kid );
1052             sigdate = 0;
1053         }
1054         else if( (pk || sk ) && k->pkt->pkttype == PKT_SIGNATURE
1055                  && (sig=k->pkt->pkt.signature)->sig_class >= 0x10
1056                  && sig->sig_class <= 0x30 && sig->version > 3
1057                  && !(sig->sig_class == 0x18 || sig->sig_class == 0x28)
1058                  && sig->keyid[0] == kid[0] && sig->keyid[1] == kid[1] ) {
1059             /* okay this is a self-signature which can be used.
1060              * This is not used for subkey binding signature, becuase this
1061              * is done above.
1062              * FIXME: We should only use this if the signature is valid
1063              *        but this is time consuming - we must provide another
1064              *        way to handle this
1065              */
1066             const byte *p;
1067             u32 ed;
1068
1069             p = parse_sig_subpkt( sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL );
1070             if( pk ) {
1071                 ed = p? pk->timestamp + buffer_to_u32(p):0;
1072                 if( sig->timestamp > sigdate ) {
1073                     pk->expiredate = ed;
1074                     sigdate = sig->timestamp;
1075                 }
1076             }
1077             else {
1078                 ed = p? sk->timestamp + buffer_to_u32(p):0;
1079                 if( sig->timestamp > sigdate ) {
1080                     sk->expiredate = ed;
1081                     sigdate = sig->timestamp;
1082                 }
1083             }
1084         }
1085
1086         if(pk && (pk->expiredate==0 ||
1087                   (pk->max_expiredate && pk->expiredate>pk->max_expiredate)))
1088           pk->expiredate=pk->max_expiredate;
1089
1090         if(sk && (sk->expiredate==0 ||
1091                   (sk->max_expiredate && sk->expiredate>sk->max_expiredate)))
1092           sk->expiredate=sk->max_expiredate;
1093     }
1094 }
1095
1096 /*
1097  * Apply information from SIGNODE (which is the valid self-signature
1098  * associated with that UID) to the UIDNODE:
1099  * - wether the UID has been revoked
1100  * - assumed creation date of the UID
1101  * - temporary store the keyflags here
1102  * - temporary store the key expiration time here
1103  * - mark whether the primary user ID flag hat been set.
1104  * - store the preferences
1105  */
1106 static void
1107 fixup_uidnode ( KBNODE uidnode, KBNODE signode, u32 keycreated )
1108 {
1109     PKT_user_id   *uid = uidnode->pkt->pkt.user_id;
1110     PKT_signature *sig = signode->pkt->pkt.signature;
1111     const byte *p, *sym, *hash, *zip;
1112     size_t n, nsym, nhash, nzip;
1113
1114     uid->created = 0; /* not created == invalid */
1115     if ( IS_UID_REV ( sig ) ) {
1116         uid->is_revoked = 1;
1117         return; /* has been revoked */
1118     }
1119
1120     uid->created = sig->timestamp; /* this one is okay */
1121     uid->selfsigversion = sig->version;
1122     /* If we got this far, it's not expired :) */
1123     uid->is_expired = 0;
1124     uid->expiredate = sig->expiredate;
1125
1126     /* store the key flags in the helper variable for later processing */
1127     uid->help_key_usage = 0;
1128     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_FLAGS, &n );
1129     if ( p && n ) {
1130         /* first octet of the keyflags */   
1131         if ( (*p & 3) )
1132             uid->help_key_usage |= PUBKEY_USAGE_SIG;
1133         if ( (*p & 12) )    
1134             uid->help_key_usage |= PUBKEY_USAGE_ENC;
1135         /* Note: we do not set the CERT flag here because it can be assumed
1136          * that thre is no real policy to set it. */
1137     }
1138
1139     /* ditto or the key expiration */
1140     uid->help_key_expire = 0;
1141     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
1142     if ( p ) { 
1143         uid->help_key_expire = keycreated + buffer_to_u32(p);
1144     }
1145
1146     /* Set the primary user ID flag - we will later wipe out some
1147      * of them to only have one in our keyblock */
1148     uid->is_primary = 0;
1149     p = parse_sig_subpkt ( sig->hashed, SIGSUBPKT_PRIMARY_UID, NULL );
1150     if ( p && *p )
1151         uid->is_primary = 1;
1152     /* We could also query this from the unhashed area if it is not in
1153      * the hased area and then later try to decide which is the better
1154      * there should be no security problem with this.
1155      * For now we only look at the hashed one. 
1156      */
1157
1158     /* Now build the preferences list.  These must come from the
1159        hashed section so nobody can modify the ciphers a key is
1160        willing to accept. */
1161     p = parse_sig_subpkt ( sig->hashed, SIGSUBPKT_PREF_SYM, &n );
1162     sym = p; nsym = p?n:0;
1163     p = parse_sig_subpkt ( sig->hashed, SIGSUBPKT_PREF_HASH, &n );
1164     hash = p; nhash = p?n:0;
1165     p = parse_sig_subpkt ( sig->hashed, SIGSUBPKT_PREF_COMPR, &n );
1166     zip = p; nzip = p?n:0;
1167     if (uid->prefs) 
1168         m_free (uid->prefs);
1169     n = nsym + nhash + nzip;
1170     if (!n)
1171         uid->prefs = NULL;
1172     else {
1173         uid->prefs = m_alloc (sizeof (*uid->prefs) * (n+1));
1174         n = 0;
1175         for (; nsym; nsym--, n++) {
1176             uid->prefs[n].type = PREFTYPE_SYM;
1177             uid->prefs[n].value = *sym++;
1178         }
1179         for (; nhash; nhash--, n++) {
1180             uid->prefs[n].type = PREFTYPE_HASH;
1181             uid->prefs[n].value = *hash++;
1182         }
1183         for (; nzip; nzip--, n++) {
1184             uid->prefs[n].type = PREFTYPE_ZIP;
1185             uid->prefs[n].value = *zip++;
1186         }
1187         uid->prefs[n].type = PREFTYPE_NONE; /* end of list marker */
1188         uid->prefs[n].value = 0;
1189     }
1190
1191     /* see whether we have the MDC feature */
1192     uid->mdc_feature = 0;
1193     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_FEATURES, &n);
1194     if (p && n && (p[0] & 0x01))
1195         uid->mdc_feature = 1;
1196             
1197 }
1198
1199 static void
1200 merge_selfsigs_main( KBNODE keyblock, int *r_revoked )
1201 {
1202     PKT_public_key *pk = NULL;
1203     KBNODE k;
1204     u32 kid[2];
1205     u32 sigdate = 0, uiddate=0, uiddate2;
1206     KBNODE signode, uidnode, uidnode2;
1207     u32 curtime = make_timestamp ();
1208     unsigned int key_usage = 0;
1209     u32 keytimestamp = 0;
1210     u32 key_expire = 0;
1211     int key_expire_seen = 0;
1212     byte sigversion = 0;
1213
1214     *r_revoked = 0;
1215     if ( keyblock->pkt->pkttype != PKT_PUBLIC_KEY )
1216         BUG ();
1217     pk = keyblock->pkt->pkt.public_key;
1218     keytimestamp = pk->timestamp;
1219
1220     keyid_from_pk( pk, kid );
1221     pk->main_keyid[0] = kid[0];
1222     pk->main_keyid[1] = kid[1];
1223
1224     if ( pk->version < 4 ) {
1225         /* before v4 the key packet itself contains the expiration
1226          * date and there was no way to change it, so we start with
1227          * the one from the key packet */
1228         key_expire = pk->max_expiredate;
1229         key_expire_seen = 1;
1230     }
1231
1232     /* first pass: find the latest direct key self-signature.
1233      * We assume that the newest one overrides all others
1234      */
1235
1236     /* In case this key was already merged */
1237     m_free(pk->revkey);
1238     pk->revkey=NULL;
1239     pk->numrevkeys=0;
1240
1241     signode = NULL;
1242     sigdate = 0; /* helper to find the latest signature */
1243     for(k=keyblock; k && k->pkt->pkttype != PKT_USER_ID; k = k->next ) {
1244         if ( k->pkt->pkttype == PKT_SIGNATURE ) {
1245             PKT_signature *sig = k->pkt->pkt.signature;
1246             if ( sig->keyid[0] == kid[0] && sig->keyid[1]==kid[1] ) { 
1247                 if ( check_key_signature( keyblock, k, NULL ) )
1248                     ; /* signature did not verify */
1249                 else if ( IS_KEY_REV (sig) ){
1250                     /* key has been revoked - there is no way to override
1251                      * such a revocation, so we theoretically can stop now.
1252                      * We should not cope with expiration times for revocations
1253                      * here because we have to assume that an attacker can
1254                      * generate all kinds of signatures.  However due to the
1255                      * fact that the key has been revoked it does not harm
1256                      * either and by continuing we gather some more info on 
1257                      * that key.
1258                      */ 
1259                     *r_revoked = 1;
1260                 }
1261                 else if ( IS_KEY_SIG (sig) ) {
1262                   /* Add any revocation keys onto the pk.  This is
1263                      particularly interesting since we normally only
1264                      get data from the most recent 1F signature, but
1265                      you need multiple 1F sigs to properly handle
1266                      revocation keys (PGP does it this way, and a
1267                      revocation key could be sensitive and hence in a
1268                      different signature). */
1269                   if(sig->revkey) {
1270                     int i;
1271
1272                     pk->revkey=
1273                       m_realloc(pk->revkey,sizeof(struct revocation_key)*
1274                                 (pk->numrevkeys+sig->numrevkeys));
1275
1276                     for(i=0;i<sig->numrevkeys;i++)
1277                       memcpy(&pk->revkey[pk->numrevkeys++],
1278                              sig->revkey[i],
1279                              sizeof(struct revocation_key));
1280                   }
1281
1282                   if( sig->timestamp >= sigdate ) {
1283                     if(sig->flags.expired)
1284                         ; /* signature has expired - ignore it */
1285                     else {
1286                         sigdate = sig->timestamp;
1287                         signode = k;
1288                         sigversion = sig->version;
1289
1290                     }
1291                   }
1292                 }
1293             }
1294         }
1295     }
1296
1297     /* Remove dupes from the revocation keys */
1298
1299     if(pk->revkey)
1300       {
1301         int i,j,x,changed=0;
1302
1303         for(i=0;i<pk->numrevkeys;i++)
1304           {
1305             for(j=i+1;j<pk->numrevkeys;j++)
1306               {
1307                 if(memcmp(&pk->revkey[i],&pk->revkey[j],
1308                           sizeof(struct revocation_key))==0)
1309                   {
1310                     /* remove j */
1311
1312                     for(x=j;x<pk->numrevkeys-1;x++)
1313                       pk->revkey[x]=pk->revkey[x+1];
1314
1315                     pk->numrevkeys--;
1316                     j--;
1317                     changed=1;
1318                   }
1319               }
1320           }
1321
1322         if(changed)
1323           pk->revkey=m_realloc(pk->revkey,
1324                                pk->numrevkeys*sizeof(struct revocation_key));
1325       }
1326
1327     if ( signode ) {
1328         /* some information from a direct key signature take precedence
1329          * over the same information given in UID sigs.
1330          */
1331         PKT_signature *sig = signode->pkt->pkt.signature;
1332         const byte *p;
1333         size_t n;
1334         
1335         p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_FLAGS, &n );
1336         if ( p && n ) {
1337             /* first octet of the keyflags */   
1338             if ( (*p & 3) )
1339                 key_usage |= PUBKEY_USAGE_SIG;
1340             if ( (*p & 12) )    
1341                 key_usage |= PUBKEY_USAGE_ENC;
1342         }
1343
1344         p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
1345         if ( p ) {
1346           key_expire = keytimestamp + buffer_to_u32(p);
1347           key_expire_seen = 1;
1348         }
1349
1350         /* mark that key as valid: one direct key signature should 
1351          * render a key as valid */
1352         pk->is_valid = 1;
1353     }
1354
1355     /* pass 1.5: look for key revocation signatures that were not made
1356        by the key (i.e. did a revocation key issue a revocation for
1357        us?).  Only bother to do this if there is a revocation key in
1358        the first place. */
1359
1360     if(pk->revkey)
1361       for(k=keyblock; k && k->pkt->pkttype != PKT_USER_ID; k = k->next )
1362         {
1363           if ( k->pkt->pkttype == PKT_SIGNATURE )
1364             {
1365               PKT_signature *sig = k->pkt->pkt.signature;
1366
1367               if(IS_KEY_REV(sig) &&
1368                  (sig->keyid[0]!=kid[0] || sig->keyid[1]!=kid[1]))
1369                 { 
1370                   /* Failure here means the sig did not verify, is was
1371                      not issued by a revocation key, or a revocation
1372                      key loop was broken. */
1373
1374                   if(check_revocation_keys(pk,sig)==0)
1375                     *r_revoked=1;
1376
1377                   /* In the future handle subkey and cert revocations?
1378                      PGP doesn't, but it's in 2440. */
1379                 }
1380             }
1381         }
1382
1383     /* second pass: look at the self-signature of all user IDs */
1384     signode = uidnode = NULL;
1385     sigdate = 0; /* helper to find the latest signature in one user ID */
1386     uiddate = 0; /* and over of all user IDs */
1387     for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next ) {
1388         if ( k->pkt->pkttype == PKT_USER_ID ) {
1389             if ( uidnode && signode ) 
1390                 fixup_uidnode ( uidnode, signode, keytimestamp );
1391             uidnode = k;
1392             signode = NULL;
1393             if ( sigdate > uiddate )
1394                 uiddate = sigdate;
1395             sigdate = 0;
1396         }
1397         else if ( k->pkt->pkttype == PKT_SIGNATURE && uidnode ) {
1398             PKT_signature *sig = k->pkt->pkt.signature;
1399             if ( sig->keyid[0] == kid[0] && sig->keyid[1]==kid[1] ) { 
1400                 if ( check_key_signature( keyblock, k, NULL ) )
1401                     ; /* signature did not verify */
1402                 else if ( (IS_UID_SIG (sig) || IS_UID_REV (sig))
1403                           && sig->timestamp >= sigdate ) {
1404                     /* Note: we allow to invalidate cert revocations
1405                      * by a newer signature.  An attacker can't use this
1406                      * because a key should be revoced with a key revocation.
1407                      * The reason why we have to allow for that is that at
1408                      * one time an email address may become invalid but later
1409                      * the same email address may become valid again (hired,
1410                      * fired, hired again).
1411                      */
1412                     if(sig->flags.expired) {
1413                       /* Expired uids don't get to be primary unless
1414                          they are the only uid there is. */
1415                       uidnode->pkt->pkt.user_id->is_primary=0;
1416                       uidnode->pkt->pkt.user_id->is_expired=1;
1417                       uidnode->pkt->pkt.user_id->expiredate=sig->expiredate;
1418                     }
1419                     else {
1420                         sigdate = sig->timestamp;
1421                         signode = k;
1422                         if( sig->version > sigversion )
1423                           sigversion = sig->version;
1424                     }
1425                 }
1426             }
1427         }
1428     }
1429     if ( uidnode && signode ) {
1430         fixup_uidnode ( uidnode, signode, keytimestamp );
1431         pk->is_valid = 1;
1432     }
1433
1434     /* If the key isn't valid yet, and we have
1435        --allow-non-selfsigned-uid set, then force it valid. */
1436     if(!pk->is_valid && opt.allow_non_selfsigned_uid)
1437       {
1438         if(opt.verbose)
1439           log_info(_("Invalid key %08lX made valid by "
1440                      "--allow-non-selfsigned-uid\n"),
1441                    (ulong)keyid_from_pk(pk,NULL));
1442
1443         pk->is_valid = 1;
1444       }
1445
1446     /* The key STILL isn't valid, so try and find an ultimately
1447        trusted signature. */
1448     if(!pk->is_valid)
1449       {
1450         uidnode=NULL;
1451
1452         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k=k->next)
1453           {
1454             if ( k->pkt->pkttype == PKT_USER_ID )
1455               uidnode = k;
1456             else if ( k->pkt->pkttype == PKT_SIGNATURE && uidnode )
1457               {
1458                 PKT_signature *sig = k->pkt->pkt.signature;
1459
1460                 if(sig->keyid[0] != kid[0] || sig->keyid[1]!=kid[1])
1461                   {
1462                     PKT_public_key *ultimate_pk;
1463
1464                     ultimate_pk=m_alloc_clear(sizeof(*ultimate_pk));
1465
1466                     if(get_pubkey(ultimate_pk,sig->keyid)==0 &&
1467                        check_key_signature(keyblock,k,NULL)==0 &&
1468                        get_ownertrust(ultimate_pk)==TRUST_ULTIMATE)
1469                       {
1470                         free_public_key(ultimate_pk);
1471                         pk->is_valid=1;
1472                         break;
1473                       }
1474
1475                     free_public_key(ultimate_pk);
1476                   }
1477               }
1478           }
1479       }
1480
1481     /* Record the highest selfsigversion so we know if this is a v3
1482        key through and through, or a v3 key with a v4 selfsig, which
1483        means we can trust the preferences (if any). */
1484     pk->selfsigversion=sigversion;
1485
1486     /* Now that we had a look at all user IDs we can now get some information
1487      * from those user IDs.
1488      */
1489     
1490     if ( !key_usage ) {
1491         /* find the latest user ID with key flags set */
1492         uiddate = 0; /* helper to find the latest user ID */
1493         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1494             k = k->next ) {
1495             if ( k->pkt->pkttype == PKT_USER_ID ) {
1496                 PKT_user_id *uid = k->pkt->pkt.user_id;
1497                 if ( uid->help_key_usage && uid->created > uiddate ) {
1498                     key_usage = uid->help_key_usage;
1499                     uiddate = uid->created;
1500                 }
1501             }
1502         }
1503     }
1504     if ( !key_usage ) { /* no key flags at all: get it from the algo */
1505         key_usage = openpgp_pk_algo_usage ( pk->pubkey_algo );
1506     }
1507     else { /* check that the usage matches the usage as given by the algo */
1508         int x = openpgp_pk_algo_usage ( pk->pubkey_algo );
1509         if ( x ) /* mask it down to the actual allowed usage */
1510             key_usage &= x; 
1511     }
1512     pk->pubkey_usage = key_usage;
1513
1514     if ( !key_expire_seen ) {
1515         /* find the latest valid user ID with a key expiration set 
1516          * Note, that this may be a different one from the above because
1517          * some user IDs may have no expiration date set */
1518         uiddate = 0; 
1519         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1520             k = k->next ) {
1521             if ( k->pkt->pkttype == PKT_USER_ID ) {
1522                 PKT_user_id *uid = k->pkt->pkt.user_id;
1523                 if ( uid->help_key_expire && uid->created > uiddate ) {
1524                     key_expire = uid->help_key_expire;
1525                     uiddate = uid->created;
1526                 }
1527             }
1528         }
1529     }
1530
1531     /* Currently only v3 keys have a maximum expiration date, but I'll
1532        bet v5 keys get this feature again. */
1533     if(key_expire==0 || (pk->max_expiredate && key_expire>pk->max_expiredate))
1534       key_expire=pk->max_expiredate;
1535
1536     pk->has_expired = key_expire >= curtime? 0 : key_expire;
1537     pk->expiredate = key_expire;
1538
1539     /* Fixme: we should see how to get rid of the expiretime fields  but
1540      * this needs changes at other places too. */
1541
1542     /* and now find the real primary user ID and delete all others */
1543     uiddate = uiddate2 = 0;
1544     uidnode = uidnode2 = NULL;
1545     for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next ) {
1546         if ( k->pkt->pkttype == PKT_USER_ID &&
1547              !k->pkt->pkt.user_id->attrib_data) {
1548             PKT_user_id *uid = k->pkt->pkt.user_id;
1549             if ( uid->is_primary && uid->created > uiddate ) {
1550                 uiddate = uid->created;
1551                 uidnode = k;
1552             }
1553             if ( !uid->is_primary && uid->created > uiddate2 ) {
1554                 uiddate2 = uid->created;
1555                 uidnode2 = k;
1556             }
1557         }
1558     }
1559     if ( uidnode ) {
1560         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1561             k = k->next ) {
1562             if ( k->pkt->pkttype == PKT_USER_ID &&
1563                  !k->pkt->pkt.user_id->attrib_data) {
1564                 PKT_user_id *uid = k->pkt->pkt.user_id;
1565                 if ( k != uidnode ) 
1566                     uid->is_primary = 0;
1567             }
1568         }
1569     }
1570     else if( uidnode2 ) {
1571         /* none is flagged primary - use the latest user ID we have */
1572         uidnode2->pkt->pkt.user_id->is_primary = 1;
1573     }
1574     else
1575       {
1576         /* None of our uids were self-signed, so pick the first one to
1577            be the primary.  This is the best we can do here since
1578            there are no self sigs to date the uids. */
1579
1580         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1581             k = k->next )
1582           {
1583             if(k->pkt->pkttype==PKT_USER_ID &&
1584                !k->pkt->pkt.user_id->attrib_data)
1585               {
1586                 k->pkt->pkt.user_id->is_primary=1;
1587                 break;
1588               }
1589           }
1590       }
1591 }
1592
1593
1594 static void
1595 merge_selfsigs_subkey( KBNODE keyblock, KBNODE subnode )
1596 {
1597     PKT_public_key *mainpk = NULL, *subpk = NULL;
1598     PKT_signature *sig;
1599     KBNODE k;
1600     u32 mainkid[2];
1601     u32 sigdate = 0;
1602     KBNODE signode;
1603     u32 curtime = make_timestamp ();
1604     unsigned int key_usage = 0;
1605     u32 keytimestamp = 0;
1606     u32 key_expire = 0;
1607     const byte *p;
1608     size_t n;
1609
1610     if ( subnode->pkt->pkttype != PKT_PUBLIC_SUBKEY )
1611         BUG ();
1612     mainpk = keyblock->pkt->pkt.public_key;
1613     if ( mainpk->version < 4 )
1614         return; /* (actually this should never happen) */
1615     keyid_from_pk( mainpk, mainkid );
1616     subpk = subnode->pkt->pkt.public_key;
1617     keytimestamp = subpk->timestamp;
1618
1619     subpk->is_valid = 0;
1620     subpk->main_keyid[0] = mainpk->main_keyid[0];
1621     subpk->main_keyid[1] = mainpk->main_keyid[1];
1622
1623     /* find the latest key binding self-signature. */
1624     signode = NULL;
1625     sigdate = 0; /* helper to find the latest signature */
1626     for(k=subnode->next; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1627                                                         k = k->next ) {
1628         if ( k->pkt->pkttype == PKT_SIGNATURE ) {
1629             sig = k->pkt->pkt.signature;
1630             if ( sig->keyid[0] == mainkid[0] && sig->keyid[1]==mainkid[1] ) { 
1631                 if ( check_key_signature( keyblock, k, NULL ) )
1632                     ; /* signature did not verify */
1633                 else if ( IS_SUBKEY_REV (sig) ) {
1634                   /* Note that this means that the date on a
1635                      revocation sig does not matter - even if the
1636                      binding sig is dated after the revocation sig,
1637                      the subkey is still marked as revoked.  This
1638                      seems ok, as it is just as easy to make new
1639                      subkeys rather than re-sign old ones as the
1640                      problem is in the distribution.  Plus, PGP (7)
1641                      does this the same way.  */
1642                     subpk->is_revoked = 1;
1643                     /* although we could stop now, we continue to 
1644                      * figure out other information like the old expiration
1645                      * time */
1646                 }
1647                 else if ( IS_SUBKEY_SIG (sig) && sig->timestamp >= sigdate ) {
1648                     if(sig->flags.expired)
1649                         ; /* signature has expired - ignore it */
1650                     else {
1651                         sigdate = sig->timestamp;
1652                         signode = k;
1653                     }
1654                 }
1655             }
1656         }
1657     }
1658
1659     if ( !signode ) {
1660         return;  /* no valid key binding */
1661     }
1662
1663     subpk->is_valid = 1;
1664     sig = signode->pkt->pkt.signature;
1665         
1666     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_FLAGS, &n );
1667     if ( p && n ) {
1668         /* first octet of the keyflags */   
1669         if ( (*p & 3) )
1670             key_usage |= PUBKEY_USAGE_SIG;
1671         if ( (*p & 12) )    
1672             key_usage |= PUBKEY_USAGE_ENC;
1673     }
1674     if ( !key_usage ) { /* no key flags at all: get it from the algo */
1675         key_usage = openpgp_pk_algo_usage ( subpk->pubkey_algo );
1676     }
1677     else { /* check that the usage matches the usage as given by the algo */
1678         int x = openpgp_pk_algo_usage ( subpk->pubkey_algo );
1679         if ( x ) /* mask it down to the actual allowed usage */
1680             key_usage &= x; 
1681     }
1682     subpk->pubkey_usage = key_usage;
1683     
1684     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
1685     if ( p ) 
1686         key_expire = keytimestamp + buffer_to_u32(p);
1687     else
1688         key_expire = 0;
1689     subpk->has_expired = key_expire >= curtime? 0 : key_expire;
1690     subpk->expiredate = key_expire;
1691 }
1692
1693
1694
1695 /* 
1696  * Merge information from the self-signatures with the key, so that
1697  * we can later use them more easy.
1698  * The function works by first applying the self signatures to the
1699  * primary key and the to each subkey.
1700  * Here are the rules we use to decide which inormation from which
1701  * self-signature is used:
1702  * We check all self signatures or validity and ignore all invalid signatures.
1703  * All signatures are then ordered by their creation date ....
1704  * For the primary key:
1705  *   FIXME the docs    
1706  */
1707 static void
1708 merge_selfsigs( KBNODE keyblock )
1709 {
1710     KBNODE k;
1711     int revoked;
1712     PKT_public_key *main_pk;
1713     prefitem_t *prefs;
1714     int mdc_feature;
1715
1716     if ( keyblock->pkt->pkttype != PKT_PUBLIC_KEY ) {
1717         if (keyblock->pkt->pkttype == PKT_SECRET_KEY ) {
1718             log_error ("expected public key but found secret key "
1719                        "- must stop\n");
1720             /* we better exit here becuase a public key is expected at
1721                other places too.  FIXME: Figure this out earlier and
1722                don't get to here at all */
1723             g10_exit (1);
1724         }
1725         BUG ();
1726     }
1727
1728     merge_selfsigs_main ( keyblock, &revoked );
1729     main_pk = keyblock->pkt->pkt.public_key;
1730     if ( revoked ) {
1731         /* if the primary key has been revoked we better set the revoke
1732          * flag on that key and all subkeys */
1733         for(k=keyblock; k; k = k->next ) {
1734             if ( k->pkt->pkttype == PKT_PUBLIC_KEY
1735                 || k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
1736                 PKT_public_key *pk = k->pkt->pkt.public_key;
1737                 pk->is_revoked = 1;
1738                 pk->main_keyid[0] = main_pk->main_keyid[0];
1739                 pk->main_keyid[1] = main_pk->main_keyid[1];
1740             }
1741         }
1742         return;
1743     }
1744
1745     /* now merge in the data from each of the subkeys */
1746     for(k=keyblock; k; k = k->next ) {
1747         if (  k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
1748             merge_selfsigs_subkey ( keyblock, k );
1749         }
1750     }
1751
1752     /* If the main key is not valid, then the subkeys aren't either,
1753        even if they have binding sigs. */
1754     if(!main_pk->is_valid)
1755       for(k=keyblock; k; k=k->next)
1756         if(k->pkt->pkttype==PKT_PUBLIC_SUBKEY)
1757           k->pkt->pkt.public_key->is_valid=0;
1758
1759     /* set the preference list of all keys to those of the primary real
1760      * user ID.  Note: we use these preferences when we don't know by
1761      * which user ID the key has been selected.
1762      * fixme: we should keep atoms of commonly used preferences or
1763      * use reference counting to optimize the preference lists storage.
1764      * FIXME: it might be better to use the intersection of 
1765      * all preferences.
1766      * Do a similar thing for the MDC feature flag.
1767      */
1768     prefs = NULL;
1769     mdc_feature = 0;
1770     for (k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next) {
1771         if (k->pkt->pkttype == PKT_USER_ID
1772             && !k->pkt->pkt.user_id->attrib_data
1773             && k->pkt->pkt.user_id->is_primary) {
1774             prefs = k->pkt->pkt.user_id->prefs;
1775             mdc_feature = k->pkt->pkt.user_id->mdc_feature;
1776             break;
1777         }
1778     }    
1779     for(k=keyblock; k; k = k->next ) {
1780         if ( k->pkt->pkttype == PKT_PUBLIC_KEY
1781              || k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
1782             PKT_public_key *pk = k->pkt->pkt.public_key;
1783             if (pk->prefs)
1784                 m_free (pk->prefs);
1785             pk->prefs = copy_prefs (prefs);
1786             pk->mdc_feature = mdc_feature;
1787         }
1788     }
1789 }
1790
1791
1792 /*
1793  * Merge the secret keys from secblock into the pubblock thereby
1794  * replacing the public (sub)keys with their secret counterparts Hmmm:
1795  * It might be better to get away from the concept of entire secret
1796  * keys at all and have a way to store just the real secret parts
1797  * from the key.
1798  */
1799 static void
1800 merge_public_with_secret ( KBNODE pubblock, KBNODE secblock )
1801 {
1802     KBNODE pub;
1803
1804     assert ( pubblock->pkt->pkttype == PKT_PUBLIC_KEY );
1805     assert ( secblock->pkt->pkttype == PKT_SECRET_KEY );
1806     
1807     for (pub=pubblock; pub; pub = pub->next ) {
1808         if ( pub->pkt->pkttype == PKT_PUBLIC_KEY ) {
1809              PKT_public_key *pk = pub->pkt->pkt.public_key;
1810              PKT_secret_key *sk = secblock->pkt->pkt.secret_key;
1811              assert ( pub == pubblock ); /* only in the first node */
1812              /* there is nothing to compare in this case, so just replace
1813               * some information */
1814              copy_public_parts_to_secret_key ( pk, sk );
1815              free_public_key ( pk );
1816              pub->pkt->pkttype = PKT_SECRET_KEY;
1817              pub->pkt->pkt.secret_key = copy_secret_key (NULL, sk);
1818         }
1819         else if ( pub->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
1820             KBNODE sec;
1821             PKT_public_key *pk = pub->pkt->pkt.public_key;
1822
1823             /* this is more complicated: it may happen that the sequence
1824              * of the subkeys dosn't match, so we have to find the
1825              * appropriate secret key */
1826             for (sec=secblock->next; sec; sec = sec->next ) {
1827                 if ( sec->pkt->pkttype == PKT_SECRET_SUBKEY ) {
1828                     PKT_secret_key *sk = sec->pkt->pkt.secret_key;
1829                     if ( !cmp_public_secret_key ( pk, sk ) ) {
1830                         copy_public_parts_to_secret_key ( pk, sk );
1831                         free_public_key ( pk );
1832                         pub->pkt->pkttype = PKT_SECRET_SUBKEY;
1833                         pub->pkt->pkt.secret_key = copy_secret_key (NULL, sk);
1834                         break;
1835                     }
1836                 }
1837             }
1838             if ( !sec ) 
1839                 BUG(); /* already checked in premerge */
1840         }
1841     }
1842 }
1843
1844 /* This function checks that for every public subkey a corresponding
1845  * secret subkey is available and deletes the public subkey otherwise.
1846  * We need this function because we can't delete it later when we
1847  * actually merge the secret parts into the pubring.
1848  * The function also plays some games with the node flags.
1849  */
1850 static void
1851 premerge_public_with_secret ( KBNODE pubblock, KBNODE secblock )
1852 {
1853     KBNODE last, pub;
1854
1855     assert ( pubblock->pkt->pkttype == PKT_PUBLIC_KEY );
1856     assert ( secblock->pkt->pkttype == PKT_SECRET_KEY );
1857     
1858     for (pub=pubblock,last=NULL; pub; last = pub, pub = pub->next ) {
1859         pub->flag &= ~3; /* reset bits 0 and 1 */
1860         if ( pub->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
1861             KBNODE sec;
1862             PKT_public_key *pk = pub->pkt->pkt.public_key;
1863
1864             for (sec=secblock->next; sec; sec = sec->next ) {
1865                 if ( sec->pkt->pkttype == PKT_SECRET_SUBKEY ) {
1866                     PKT_secret_key *sk = sec->pkt->pkt.secret_key;
1867                     if ( !cmp_public_secret_key ( pk, sk ) ) {
1868                         if ( sk->protect.s2k.mode == 1001 ) {
1869                             /* The secret parts are not available so
1870                                we can't use that key for signing etc.
1871                                Fix the pubkey usage */
1872                             pk->pubkey_usage &= ~PUBKEY_USAGE_SIG;
1873                         }
1874                         /* transfer flag bits 0 and 1 to the pubblock */
1875                         pub->flag |= (sec->flag &3);
1876                         break;
1877                     }
1878                 }
1879             }
1880             if ( !sec ) {
1881                 KBNODE next, ll;
1882
1883                 log_info ( "no secret subkey "
1884                            "for public subkey %08lX - ignoring\n",  
1885                            (ulong)keyid_from_pk (pk,NULL) );
1886                 /* we have to remove the subkey in this case */
1887                 assert ( last );
1888                 /* find the next subkey */
1889                 for (next=pub->next,ll=pub;
1890                      next && pub->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1891                      ll = next, next = next->next ) 
1892                     ;
1893                 /* make new link */
1894                 last->next = next;
1895                 /* release this public subkey with all sigs */
1896                 ll->next = NULL;
1897                 release_kbnode( pub );
1898                 /* let the loop continue */
1899                 pub = last;
1900             }
1901         }
1902     }
1903     /* We need to copy the found bits (0 and 1) from the secret key to
1904        the public key.  This has already been done for the subkeys but
1905        got lost on the primary key - fix it here *. */
1906     pubblock->flag |= (secblock->flag & 3);
1907 }
1908
1909
1910
1911 \f
1912 /* See see whether the key fits
1913  * our requirements and in case we do not
1914  * request the primary key, we should select
1915  * a suitable subkey.
1916  * FIXME: Check against PGP 7 whether we still need a kludge
1917  *        to favor type 16 keys over type 20 keys when type 20
1918  *        has not been explitely requested.
1919  * Returns: True when a suitable key has been found.
1920  *
1921  * We have to distinguish four cases:  FIXME!
1922  *  1. No usage and no primary key requested
1923  *     Examples for this case are that we have a keyID to be used
1924  *     for decrytion or verification.
1925  *  2. No usage but primary key requested
1926  *     This is the case for all functions which work on an
1927  *     entire keyblock, e.g. for editing or listing
1928  *  3. Usage and primary key requested
1929  *     FXME
1930  *  4. Usage but no primary key requested
1931  *     FIXME
1932  * FIXME: Tell what is going to happen here and something about the rationale
1933  * Note: We don't use this function if no specific usage is requested;
1934  *       This way the getkey functions can be used for plain key listings.
1935  *
1936  * CTX ist the keyblock we are investigating, if FOUNDK is not NULL this
1937  * is the key we actually found by looking at the keyid or a fingerprint and
1938  * may eitehr point to the primary or one of the subkeys.
1939  */
1940
1941 static int
1942 finish_lookup (GETKEY_CTX ctx)
1943 {
1944     KBNODE keyblock = ctx->keyblock;
1945     KBNODE k;
1946     KBNODE foundk = NULL;
1947     PKT_user_id *foundu = NULL;
1948   #define USAGE_MASK  (PUBKEY_USAGE_SIG|PUBKEY_USAGE_ENC)
1949     unsigned int req_usage = ( ctx->req_usage & USAGE_MASK );
1950     /* Request the primary if we're certifying another key, and also
1951        if signing data while --pgp6 or --pgp7 is on since pgp 6 and 7
1952        do not understand signatures made by a signing subkey. */
1953     int req_prim = (ctx->req_usage & PUBKEY_USAGE_CERT) ||
1954       ((opt.pgp6 || opt.pgp7) && (ctx->req_usage & PUBKEY_USAGE_SIG));
1955     u32 latest_date;
1956     KBNODE latest_key;
1957     u32 curtime = make_timestamp ();
1958
1959     assert( keyblock->pkt->pkttype == PKT_PUBLIC_KEY );
1960    
1961     ctx->found_key = NULL;
1962
1963     if (ctx->exact) {
1964         for (k=keyblock; k; k = k->next) {
1965             if ( (k->flag & 1) ) {
1966                 assert ( k->pkt->pkttype == PKT_PUBLIC_KEY
1967                          || k->pkt->pkttype == PKT_PUBLIC_SUBKEY );
1968                 foundk = k;
1969                 break;
1970             }
1971         }
1972     }
1973
1974     for (k=keyblock; k; k = k->next) {
1975         if ( (k->flag & 2) ) {
1976             assert (k->pkt->pkttype == PKT_USER_ID);
1977             foundu = k->pkt->pkt.user_id;
1978             break;
1979         }
1980     }
1981
1982     if ( DBG_CACHE )
1983         log_debug( "finish_lookup: checking key %08lX (%s)(req_usage=%x)\n",
1984                    (ulong)keyid_from_pk( keyblock->pkt->pkt.public_key, NULL),
1985                    foundk? "one":"all", req_usage);
1986
1987     if (!req_usage) {
1988         latest_key = foundk? foundk:keyblock;
1989         goto found;
1990     }
1991     
1992     if (!req_usage) {
1993         PKT_public_key *pk = foundk->pkt->pkt.public_key;
1994         if (pk->user_id)
1995             free_user_id (pk->user_id);
1996         pk->user_id = scopy_user_id (foundu);
1997         ctx->found_key = foundk;
1998         cache_user_id( keyblock );
1999         return 1; /* found */
2000     }
2001     
2002     latest_date = 0;
2003     latest_key  = NULL;
2004     /* do not look at subkeys if a certification key is requested */
2005     if ((!foundk || foundk->pkt->pkttype == PKT_PUBLIC_SUBKEY) && !req_prim) {
2006         KBNODE nextk;
2007         /* either start a loop or check just this one subkey */
2008         for (k=foundk?foundk:keyblock; k; k = nextk ) {
2009             PKT_public_key *pk;
2010             nextk = k->next;
2011             if ( k->pkt->pkttype != PKT_PUBLIC_SUBKEY )
2012                 continue;
2013             if ( foundk )
2014                 nextk = NULL;  /* what a hack */
2015             pk = k->pkt->pkt.public_key;
2016             if (DBG_CACHE)
2017                 log_debug( "\tchecking subkey %08lX\n",
2018                            (ulong)keyid_from_pk( pk, NULL));
2019             if ( !pk->is_valid ) {
2020                 if (DBG_CACHE)
2021                     log_debug( "\tsubkey not valid\n");
2022                 continue;
2023             }
2024             if ( pk->is_revoked ) {
2025                 if (DBG_CACHE)
2026                     log_debug( "\tsubkey has been revoked\n");
2027                 continue;
2028             }
2029             if ( pk->has_expired ) {
2030                 if (DBG_CACHE)
2031                     log_debug( "\tsubkey has expired\n");
2032                 continue;
2033             }
2034             if ( pk->timestamp > curtime && !opt.ignore_valid_from ) {
2035                 if (DBG_CACHE)
2036                     log_debug( "\tsubkey not yet valid\n");
2037                 continue;
2038             }
2039             
2040             if ( !((pk->pubkey_usage&USAGE_MASK) & req_usage) ) {
2041                 if (DBG_CACHE)
2042                     log_debug( "\tusage does not match: want=%x have=%x\n",
2043                                req_usage, pk->pubkey_usage );
2044                 continue;
2045             }
2046
2047             if (DBG_CACHE)
2048                 log_debug( "\tsubkey looks fine\n");
2049             if ( pk->timestamp > latest_date ) {
2050                 latest_date = pk->timestamp;
2051                 latest_key  = k;
2052             }
2053         }
2054     }
2055
2056     /* Okay now try the primary key unless we want an exact 
2057      * key ID match on a subkey */
2058     if ((!latest_key && !(ctx->exact && foundk != keyblock)) || req_prim) {
2059         PKT_public_key *pk;
2060         if (DBG_CACHE && !foundk && !req_prim )
2061             log_debug( "\tno suitable subkeys found - trying primary\n");
2062         pk = keyblock->pkt->pkt.public_key;
2063         if ( !pk->is_valid ) {
2064             if (DBG_CACHE)
2065                 log_debug( "\tprimary key not valid\n");
2066         }
2067         else if ( pk->is_revoked ) {
2068             if (DBG_CACHE)
2069                 log_debug( "\tprimary key has been revoked\n");
2070         }
2071         else if ( pk->has_expired ) {
2072             if (DBG_CACHE)
2073                 log_debug( "\tprimary key has expired\n");
2074         }
2075         else  if ( !((pk->pubkey_usage&USAGE_MASK) & req_usage) ) {
2076             if (DBG_CACHE)
2077                 log_debug( "\tprimary key usage does not match: "
2078                            "want=%x have=%x\n",
2079                            req_usage, pk->pubkey_usage );
2080         }
2081         else { /* okay */
2082             if (DBG_CACHE)
2083                 log_debug( "\tprimary key may be used\n");
2084             latest_key = keyblock;
2085             latest_date = pk->timestamp;
2086         }
2087     }
2088     
2089     if ( !latest_key ) {
2090         if (DBG_CACHE)
2091             log_debug("\tno suitable key found -  giving up\n");
2092         return 0;
2093     }
2094
2095  found:
2096     if (DBG_CACHE)
2097         log_debug( "\tusing key %08lX\n",
2098                 (ulong)keyid_from_pk( latest_key->pkt->pkt.public_key, NULL) );
2099
2100     if (latest_key) {
2101         PKT_public_key *pk = latest_key->pkt->pkt.public_key;
2102         if (pk->user_id)
2103             free_user_id (pk->user_id);
2104         pk->user_id = scopy_user_id (foundu);
2105     }    
2106         
2107     ctx->found_key = latest_key;
2108
2109     if (latest_key != keyblock && opt.verbose) {
2110         log_info(_("using secondary key %08lX "
2111                    "instead of primary key %08lX\n"),
2112                  (ulong)keyid_from_pk( latest_key->pkt->pkt.public_key, NULL),
2113                  (ulong)keyid_from_pk( keyblock->pkt->pkt.public_key, NULL) );
2114     }
2115
2116     cache_user_id( keyblock );
2117     
2118     return 1; /* found */
2119 }
2120
2121
2122 static int
2123 lookup( GETKEY_CTX ctx, KBNODE *ret_keyblock, int secmode )
2124 {
2125     int rc;
2126     KBNODE secblock = NULL; /* helper */
2127     int no_suitable_key = 0;
2128     
2129     rc = 0;
2130     while (!(rc = keydb_search (ctx->kr_handle, ctx->items, ctx->nitems))) {
2131         /* If we are searching for the first key we have to make sure
2132            that the next interation does not no an implicit reset.
2133            This can be triggered by an empty key ring. */
2134         if (ctx->nitems && ctx->items->mode == KEYDB_SEARCH_MODE_FIRST)
2135             ctx->items->mode = KEYDB_SEARCH_MODE_NEXT;
2136
2137         rc = keydb_get_keyblock (ctx->kr_handle, &ctx->keyblock);
2138         if (rc) {
2139             log_error ("keydb_get_keyblock failed: %s\n", g10_errstr(rc));
2140             rc = 0;
2141             goto skip;
2142         }
2143                        
2144         if ( secmode ) {
2145             /* find the correspondig public key and use this 
2146              * this one for the selection process */
2147             u32 aki[2];
2148             KBNODE k = ctx->keyblock;
2149             
2150             if (k->pkt->pkttype != PKT_SECRET_KEY)
2151                 BUG();
2152
2153             keyid_from_sk (k->pkt->pkt.secret_key, aki);
2154             k = get_pubkeyblock (aki);
2155             if( !k ) {
2156                 if (!opt.quiet)
2157                     log_info(_("key %08lX: secret key without public key "
2158                                "- skipped\n"),  (ulong)aki[1] );
2159                 goto skip;
2160             }
2161             secblock = ctx->keyblock;
2162             ctx->keyblock = k;
2163
2164             premerge_public_with_secret ( ctx->keyblock, secblock );
2165         }
2166
2167         /* warning: node flag bits 0 and 1 should be preserved by
2168          * merge_selfsigs.  For secret keys, premerge did tranfer the
2169          * keys to the keyblock */
2170         merge_selfsigs ( ctx->keyblock );
2171         if ( finish_lookup (ctx) ) {
2172             no_suitable_key = 0;
2173             if ( secmode ) {
2174                 merge_public_with_secret ( ctx->keyblock,
2175                                            secblock);
2176                 release_kbnode (secblock);
2177                 secblock = NULL;
2178             }
2179             goto found;
2180         }
2181         else
2182             no_suitable_key = 1;
2183         
2184       skip:
2185         /* release resources and continue search */
2186         if ( secmode ) {
2187             release_kbnode( secblock );
2188             secblock = NULL;
2189         }
2190         release_kbnode( ctx->keyblock );
2191         ctx->keyblock = NULL;
2192     }
2193
2194   found:
2195     if( rc && rc != -1 )
2196         log_error("keydb_search failed: %s\n", g10_errstr(rc));
2197
2198     if( !rc ) {
2199         *ret_keyblock = ctx->keyblock; /* return the keyblock */
2200         ctx->keyblock = NULL;
2201     }
2202     else if (rc == -1 && no_suitable_key)
2203         rc = secmode ? G10ERR_UNU_SECKEY : G10ERR_UNU_PUBKEY;
2204     else if( rc == -1 )
2205         rc = secmode ? G10ERR_NO_SECKEY : G10ERR_NO_PUBKEY;
2206
2207     if ( secmode ) {
2208         release_kbnode( secblock );
2209         secblock = NULL;
2210     }
2211     release_kbnode( ctx->keyblock );
2212     ctx->keyblock = NULL;
2213
2214     ctx->last_rc = rc;
2215     return rc;
2216 }
2217
2218
2219
2220
2221 /****************
2222  * FIXME: Replace by the generic function 
2223  *        It does not work as it is right now - it is used at 
2224  *        2 places:  a) to get the key for an anonyous recipient
2225  *                   b) to get the ultimately trusted keys.
2226  *        The a) usage might have some problems.
2227  *
2228  * Enumerate all primary secret keys.  Caller must use these procedure:
2229  *  1) create a void pointer and initialize it to NULL
2230  *  2) pass this void pointer by reference to this function
2231  *     and provide space for the secret key (pass a buffer for sk)
2232  *  3) call this function as long as it does not return -1
2233  *     to indicate EOF.
2234  *  4) Always call this function a last time with SK set to NULL,
2235  *     so that can free it's context.
2236  */
2237 int
2238 enum_secret_keys( void **context, PKT_secret_key *sk, int with_subkeys )
2239 {
2240     int rc=0;
2241     struct {
2242         int eof;
2243         int first;
2244         KEYDB_HANDLE hd;
2245         KBNODE keyblock;
2246         KBNODE node;
2247     } *c = *context;
2248
2249
2250     if( !c ) { /* make a new context */
2251         c = m_alloc_clear( sizeof *c );
2252         *context = c;
2253         c->hd = keydb_new (1);
2254         c->first = 1;
2255         c->keyblock = NULL;
2256         c->node = NULL;
2257     }
2258
2259     if( !sk ) { /* free the context */
2260         keydb_release (c->hd);
2261         release_kbnode (c->keyblock);
2262         m_free( c );
2263         *context = NULL;
2264         return 0;
2265     }
2266
2267     if( c->eof )
2268         return -1;
2269
2270     do {
2271         /* get the next secret key from the current keyblock */
2272         for (; c->node; c->node = c->node->next) {
2273             if (c->node->pkt->pkttype == PKT_SECRET_KEY
2274                 || (with_subkeys
2275                     && c->node->pkt->pkttype == PKT_SECRET_SUBKEY) ) {
2276                 copy_secret_key (sk, c->node->pkt->pkt.secret_key );
2277                 c->node = c->node->next;
2278                 return 0; /* found */
2279             }
2280         }
2281         release_kbnode (c->keyblock);
2282         c->keyblock = c->node = NULL;
2283         
2284         rc = c->first? keydb_search_first (c->hd) : keydb_search_next (c->hd);
2285         c->first = 0;
2286         if (rc) {
2287             keydb_release (c->hd); c->hd = NULL;
2288             c->eof = 1;
2289             return -1; /* eof */
2290         }
2291         
2292         rc = keydb_get_keyblock (c->hd, &c->keyblock);
2293         c->node = c->keyblock;
2294     } while (!rc);
2295
2296     return rc; /* error */
2297 }
2298
2299
2300 \f
2301 /*********************************************
2302  ***********  user ID printing helpers *******
2303  *********************************************/
2304
2305 /****************
2306  * Return a string with a printable representation of the user_id.
2307  * this string must be freed by m_free.
2308  */
2309 char*
2310 get_user_id_string( u32 *keyid )
2311 {
2312     user_id_db_t r;
2313     char *p;
2314     int pass=0;
2315     /* try it two times; second pass reads from key resources */
2316     do {
2317         for(r=user_id_db; r; r = r->next ) {
2318             keyid_list_t a;
2319             for (a=r->keyids; a; a= a->next ) {
2320                 if( a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1] ) {
2321                     p = m_alloc( r->len + 10 );
2322                     sprintf(p, "%08lX %.*s",
2323                             (ulong)keyid[1], r->len, r->name );
2324                     return p;
2325                 }
2326             }
2327         }
2328     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
2329     p = m_alloc( 15 );
2330     sprintf(p, "%08lX [?]", (ulong)keyid[1] );
2331     return p;
2332 }
2333
2334
2335 char*
2336 get_user_id_string_printable ( u32 *keyid )
2337 {
2338     char *p = get_user_id_string( keyid );
2339     char *p2 = utf8_to_native( p, strlen(p), 0 );
2340     m_free(p);
2341     p = make_printable_string (p2, strlen (p2), 0);
2342     m_free (p2);
2343     return p;
2344 }
2345
2346
2347 char*
2348 get_long_user_id_string( u32 *keyid )
2349 {
2350     user_id_db_t r;
2351     char *p;
2352     int pass=0;
2353     /* try it two times; second pass reads from key resources */
2354     do {
2355         for(r=user_id_db; r; r = r->next ) {
2356             keyid_list_t a;
2357             for (a=r->keyids; a; a= a->next ) {
2358                 if( a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1] ) {
2359                     p = m_alloc( r->len + 20 );
2360                     sprintf(p, "%08lX%08lX %.*s",
2361                             (ulong)keyid[0], (ulong)keyid[1],
2362                             r->len, r->name );
2363                     return p;
2364                 }
2365             }
2366         }
2367     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
2368     p = m_alloc( 25 );
2369     sprintf(p, "%08lX%08lX [?]", (ulong)keyid[0], (ulong)keyid[1] );
2370     return p;
2371 }
2372
2373 char*
2374 get_user_id( u32 *keyid, size_t *rn )
2375 {
2376     user_id_db_t r;
2377     char *p;
2378     int pass=0;
2379
2380     /* try it two times; second pass reads from key resources */
2381     do {
2382         for(r=user_id_db; r; r = r->next ) {
2383             keyid_list_t a;
2384             for (a=r->keyids; a; a= a->next ) {
2385                 if( a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1] ) {
2386                     p = m_alloc( r->len );
2387                     memcpy(p, r->name, r->len );
2388                     *rn = r->len;
2389                     return p;
2390                 }
2391             }
2392         }
2393     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
2394     p = m_strdup( _("[User id not found]") );
2395     *rn = strlen(p);
2396     return p;
2397 }
2398
2399 char*
2400 get_user_id_printable( u32 *keyid )
2401 {
2402     size_t rn;
2403     char *p = get_user_id( keyid, &rn );
2404     char *p2 = utf8_to_native( p, rn, 0 );
2405     m_free(p);
2406     p = make_printable_string (p2, strlen (p2), 0);
2407     m_free (p2);
2408     return p;
2409 }
2410
2411 KEYDB_HANDLE
2412 get_ctx_handle(GETKEY_CTX ctx)
2413 {
2414   return ctx->kr_handle;
2415 }