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