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