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