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