* keydb.h, getkey.c (classify_user_id, classify_user_id2): Make 'exact' a
[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             
1300 }
1301
1302 static void
1303 merge_selfsigs_main( KBNODE keyblock, int *r_revoked )
1304 {
1305     PKT_public_key *pk = NULL;
1306     KBNODE k;
1307     u32 kid[2];
1308     u32 sigdate, uiddate, uiddate2;
1309     KBNODE signode, uidnode, uidnode2;
1310     u32 curtime = make_timestamp ();
1311     unsigned int key_usage = 0;
1312     u32 keytimestamp = 0;
1313     u32 key_expire = 0;
1314     int key_expire_seen = 0;
1315     byte sigversion = 0;
1316
1317     *r_revoked = 0;
1318     if ( keyblock->pkt->pkttype != PKT_PUBLIC_KEY )
1319         BUG ();
1320     pk = keyblock->pkt->pkt.public_key;
1321     keytimestamp = pk->timestamp;
1322
1323     keyid_from_pk( pk, kid );
1324     pk->main_keyid[0] = kid[0];
1325     pk->main_keyid[1] = kid[1];
1326
1327     if ( pk->version < 4 ) {
1328         /* before v4 the key packet itself contains the expiration
1329          * date and there was no way to change it, so we start with
1330          * the one from the key packet */
1331         key_expire = pk->max_expiredate;
1332         key_expire_seen = 1;
1333     }
1334
1335     /* first pass: find the latest direct key self-signature.
1336      * We assume that the newest one overrides all others
1337      */
1338
1339     /* In case this key was already merged */
1340     m_free(pk->revkey);
1341     pk->revkey=NULL;
1342     pk->numrevkeys=0;
1343
1344     signode = NULL;
1345     sigdate = 0; /* helper to find the latest signature */
1346     for(k=keyblock; k && k->pkt->pkttype != PKT_USER_ID; k = k->next ) {
1347         if ( k->pkt->pkttype == PKT_SIGNATURE ) {
1348             PKT_signature *sig = k->pkt->pkt.signature;
1349             if ( sig->keyid[0] == kid[0] && sig->keyid[1]==kid[1] ) { 
1350                 if ( check_key_signature( keyblock, k, NULL ) )
1351                     ; /* signature did not verify */
1352                 else if ( IS_KEY_REV (sig) ){
1353                     /* key has been revoked - there is no way to override
1354                      * such a revocation, so we theoretically can stop now.
1355                      * We should not cope with expiration times for revocations
1356                      * here because we have to assume that an attacker can
1357                      * generate all kinds of signatures.  However due to the
1358                      * fact that the key has been revoked it does not harm
1359                      * either and by continuing we gather some more info on 
1360                      * that key.
1361                      */ 
1362                     *r_revoked = 1;
1363                 }
1364                 else if ( IS_KEY_SIG (sig) ) {
1365                   /* Add any revocation keys onto the pk.  This is
1366                      particularly interesting since we normally only
1367                      get data from the most recent 1F signature, but
1368                      you need multiple 1F sigs to properly handle
1369                      revocation keys (PGP does it this way, and a
1370                      revocation key could be sensitive and hence in a
1371                      different signature). */
1372                   if(sig->revkey) {
1373                     int i;
1374
1375                     pk->revkey=
1376                       m_realloc(pk->revkey,sizeof(struct revocation_key)*
1377                                 (pk->numrevkeys+sig->numrevkeys));
1378
1379                     for(i=0;i<sig->numrevkeys;i++)
1380                       memcpy(&pk->revkey[pk->numrevkeys++],
1381                              sig->revkey[i],
1382                              sizeof(struct revocation_key));
1383                   }
1384
1385                   if( sig->timestamp >= sigdate ) {
1386                     if(sig->flags.expired)
1387                         ; /* signature has expired - ignore it */
1388                     else {
1389                         sigdate = sig->timestamp;
1390                         signode = k;
1391                         if( sig->version > sigversion )
1392                           sigversion = sig->version;
1393
1394                     }
1395                   }
1396                 }
1397             }
1398         }
1399     }
1400
1401     /* Remove dupes from the revocation keys */
1402
1403     if(pk->revkey)
1404       {
1405         int i,j,x,changed=0;
1406
1407         for(i=0;i<pk->numrevkeys;i++)
1408           {
1409             for(j=i+1;j<pk->numrevkeys;j++)
1410               {
1411                 if(memcmp(&pk->revkey[i],&pk->revkey[j],
1412                           sizeof(struct revocation_key))==0)
1413                   {
1414                     /* remove j */
1415
1416                     for(x=j;x<pk->numrevkeys-1;x++)
1417                       pk->revkey[x]=pk->revkey[x+1];
1418
1419                     pk->numrevkeys--;
1420                     j--;
1421                     changed=1;
1422                   }
1423               }
1424           }
1425
1426         if(changed)
1427           pk->revkey=m_realloc(pk->revkey,
1428                                pk->numrevkeys*sizeof(struct revocation_key));
1429       }
1430
1431     if ( signode ) {
1432         /* some information from a direct key signature take precedence
1433          * over the same information given in UID sigs.
1434          */
1435         PKT_signature *sig = signode->pkt->pkt.signature;
1436         const byte *p;
1437         size_t n;
1438         
1439         p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_FLAGS, &n );
1440         if ( p && n ) {
1441             /* first octet of the keyflags */   
1442             if ( (*p & 3) )
1443                 key_usage |= PUBKEY_USAGE_SIG;
1444             if ( (*p & 12) )    
1445                 key_usage |= PUBKEY_USAGE_ENC;
1446         }
1447
1448         p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
1449         if ( p ) {
1450           key_expire = keytimestamp + buffer_to_u32(p);
1451           key_expire_seen = 1;
1452         }
1453
1454         /* mark that key as valid: one direct key signature should 
1455          * render a key as valid */
1456         pk->is_valid = 1;
1457     }
1458
1459     /* pass 1.5: look for key revocation signatures that were not made
1460        by the key (i.e. did a revocation key issue a revocation for
1461        us?).  Only bother to do this if there is a revocation key in
1462        the first place. */
1463
1464     if(pk->revkey)
1465       for(k=keyblock; k && k->pkt->pkttype != PKT_USER_ID; k = k->next )
1466         {
1467           if ( k->pkt->pkttype == PKT_SIGNATURE )
1468             {
1469               PKT_signature *sig = k->pkt->pkt.signature;
1470
1471               if(IS_KEY_REV(sig) &&
1472                  (sig->keyid[0]!=kid[0] || sig->keyid[1]!=kid[1]))
1473                 { 
1474                   /* Failure here means the sig did not verify, is was
1475                      not issued by a revocation key, or a revocation
1476                      key loop was broken. */
1477
1478                   if(check_revocation_keys(pk,sig)==0)
1479                     *r_revoked=1;
1480
1481                   /* In the future handle subkey and cert revocations?
1482                      PGP doesn't, but it's in 2440. */
1483                 }
1484             }
1485         }
1486
1487     /* second pass: look at the self-signature of all user IDs */
1488     signode = uidnode = NULL;
1489     sigdate = 0; /* helper to find the latest signature in one user ID */
1490     for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next ) {
1491         if ( k->pkt->pkttype == PKT_USER_ID ) {
1492             if ( uidnode && signode ) 
1493               {
1494                 fixup_uidnode ( uidnode, signode, keytimestamp );
1495                 pk->is_valid=1;
1496               }
1497             uidnode = k;
1498             signode = NULL;
1499             sigdate = 0;
1500         }
1501         else if ( k->pkt->pkttype == PKT_SIGNATURE && uidnode ) {
1502             PKT_signature *sig = k->pkt->pkt.signature;
1503             if ( sig->keyid[0] == kid[0] && sig->keyid[1]==kid[1] ) { 
1504                 if ( check_key_signature( keyblock, k, NULL ) )
1505                     ; /* signature did not verify */
1506                 else if ( (IS_UID_SIG (sig) || IS_UID_REV (sig))
1507                           && sig->timestamp >= sigdate ) {
1508                     /* Note: we allow to invalidate cert revocations
1509                      * by a newer signature.  An attacker can't use this
1510                      * because a key should be revoced with a key revocation.
1511                      * The reason why we have to allow for that is that at
1512                      * one time an email address may become invalid but later
1513                      * the same email address may become valid again (hired,
1514                      * fired, hired again).
1515                      */
1516                     if(sig->flags.expired) {
1517                       /* Expired uids don't get to be primary unless
1518                          they are the only uid there is. */
1519                       uidnode->pkt->pkt.user_id->is_primary=0;
1520                       uidnode->pkt->pkt.user_id->is_expired=1;
1521                       uidnode->pkt->pkt.user_id->expiredate=sig->expiredate;
1522                     }
1523                     else {
1524                         sigdate = sig->timestamp;
1525                         signode = k;
1526                         if( sig->version > sigversion )
1527                           sigversion = sig->version;
1528                     }
1529                 }
1530             }
1531         }
1532     }
1533     if ( uidnode && signode ) {
1534         fixup_uidnode ( uidnode, signode, keytimestamp );
1535         pk->is_valid = 1;
1536     }
1537
1538     /* If the key isn't valid yet, and we have
1539        --allow-non-selfsigned-uid set, then force it valid. */
1540     if(!pk->is_valid && opt.allow_non_selfsigned_uid)
1541       {
1542         if(opt.verbose)
1543           log_info(_("Invalid key %08lX made valid by "
1544                      "--allow-non-selfsigned-uid\n"),
1545                    (ulong)keyid_from_pk(pk,NULL));
1546
1547         pk->is_valid = 1;
1548       }
1549
1550     /* The key STILL isn't valid, so try and find an ultimately
1551        trusted signature. */
1552     if(!pk->is_valid)
1553       {
1554         uidnode=NULL;
1555
1556         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k=k->next)
1557           {
1558             if ( k->pkt->pkttype == PKT_USER_ID )
1559               uidnode = k;
1560             else if ( k->pkt->pkttype == PKT_SIGNATURE && uidnode )
1561               {
1562                 PKT_signature *sig = k->pkt->pkt.signature;
1563                 u32 dummy;
1564                 int dum2;
1565
1566                 if(sig->keyid[0] != kid[0] || sig->keyid[1]!=kid[1])
1567                   {
1568                     PKT_public_key *ultimate_pk;
1569
1570                     ultimate_pk=m_alloc_clear(sizeof(*ultimate_pk));
1571
1572                     /* We don't want to use the full get_pubkey to
1573                        avoid infinite recursion in certain cases.
1574                        There is no reason to check that an ultimately
1575                        trusted key is still valid - if it has been
1576                        revoked or the user should also renmove the
1577                        ultimate trust flag.  */
1578                     if(get_pubkey_fast(ultimate_pk,sig->keyid)==0
1579                        && check_key_signature2(keyblock,k,ultimate_pk,
1580                                                NULL,&dummy,&dum2)==0
1581                        && get_ownertrust(ultimate_pk)==TRUST_ULTIMATE)
1582                       {
1583                         free_public_key(ultimate_pk);
1584                         pk->is_valid=1;
1585                         break;
1586                       }
1587
1588                     free_public_key(ultimate_pk);
1589                   }
1590               }
1591           }
1592       }
1593
1594     /* Record the highest selfsig version so we know if this is a v3
1595        key through and through, or a v3 key with a v4 selfsig
1596        somewhere.  This is useful in a few places to know if the key
1597        must be treated as PGP2-style or OpenPGP-style.  Note that a
1598        selfsig revocation with a higher version number will also raise
1599        this value.  This is okay since such a revocation must be
1600        issued by the user (i.e. it cannot be issued by someone else to
1601        modify the key behavior.) */
1602
1603     pk->selfsigversion=sigversion;
1604
1605     /* Now that we had a look at all user IDs we can now get some information
1606      * from those user IDs.
1607      */
1608     
1609     if ( !key_usage ) {
1610         /* find the latest user ID with key flags set */
1611         uiddate = 0; /* helper to find the latest user ID */
1612         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1613             k = k->next ) {
1614             if ( k->pkt->pkttype == PKT_USER_ID ) {
1615                 PKT_user_id *uid = k->pkt->pkt.user_id;
1616                 if ( uid->help_key_usage && uid->created > uiddate ) {
1617                     key_usage = uid->help_key_usage;
1618                     uiddate = uid->created;
1619                 }
1620             }
1621         }
1622     }
1623     if ( !key_usage ) { /* no key flags at all: get it from the algo */
1624         key_usage = openpgp_pk_algo_usage ( pk->pubkey_algo );
1625     }
1626     else { /* check that the usage matches the usage as given by the algo */
1627         int x = openpgp_pk_algo_usage ( pk->pubkey_algo );
1628         if ( x ) /* mask it down to the actual allowed usage */
1629             key_usage &= x; 
1630     }
1631     pk->pubkey_usage = key_usage;
1632
1633     if ( !key_expire_seen ) {
1634         /* find the latest valid user ID with a key expiration set 
1635          * Note, that this may be a different one from the above because
1636          * some user IDs may have no expiration date set */
1637         uiddate = 0; 
1638         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1639             k = k->next ) {
1640             if ( k->pkt->pkttype == PKT_USER_ID ) {
1641                 PKT_user_id *uid = k->pkt->pkt.user_id;
1642                 if ( uid->help_key_expire && uid->created > uiddate ) {
1643                     key_expire = uid->help_key_expire;
1644                     uiddate = uid->created;
1645                 }
1646             }
1647         }
1648     }
1649
1650     /* Currently only v3 keys have a maximum expiration date, but I'll
1651        bet v5 keys get this feature again. */
1652     if(key_expire==0 || (pk->max_expiredate && key_expire>pk->max_expiredate))
1653       key_expire=pk->max_expiredate;
1654
1655     pk->has_expired = key_expire >= curtime? 0 : key_expire;
1656     pk->expiredate = key_expire;
1657
1658     /* Fixme: we should see how to get rid of the expiretime fields  but
1659      * this needs changes at other places too. */
1660
1661     /* and now find the real primary user ID and delete all others */
1662     uiddate = uiddate2 = 0;
1663     uidnode = uidnode2 = NULL;
1664     for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next ) {
1665         if ( k->pkt->pkttype == PKT_USER_ID &&
1666              !k->pkt->pkt.user_id->attrib_data) {
1667             PKT_user_id *uid = k->pkt->pkt.user_id;
1668             if ( uid->is_primary && uid->created > uiddate ) {
1669                 uiddate = uid->created;
1670                 uidnode = k;
1671             }
1672             if ( !uid->is_primary && uid->created > uiddate2 ) {
1673                 uiddate2 = uid->created;
1674                 uidnode2 = k;
1675             }
1676         }
1677     }
1678     if ( uidnode ) {
1679         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1680             k = k->next ) {
1681             if ( k->pkt->pkttype == PKT_USER_ID &&
1682                  !k->pkt->pkt.user_id->attrib_data) {
1683                 PKT_user_id *uid = k->pkt->pkt.user_id;
1684                 if ( k != uidnode ) 
1685                     uid->is_primary = 0;
1686             }
1687         }
1688     }
1689     else if( uidnode2 ) {
1690         /* none is flagged primary - use the latest user ID we have */
1691         uidnode2->pkt->pkt.user_id->is_primary = 1;
1692     }
1693     else
1694       {
1695         /* None of our uids were self-signed, so pick the first one to
1696            be the primary.  This is the best we can do here since
1697            there are no self sigs to date the uids. */
1698
1699         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1700             k = k->next )
1701           {
1702             if(k->pkt->pkttype==PKT_USER_ID &&
1703                !k->pkt->pkt.user_id->attrib_data)
1704               {
1705                 k->pkt->pkt.user_id->is_primary=1;
1706                 break;
1707               }
1708           }
1709       }
1710 }
1711
1712
1713 static void
1714 merge_selfsigs_subkey( KBNODE keyblock, KBNODE subnode )
1715 {
1716     PKT_public_key *mainpk = NULL, *subpk = NULL;
1717     PKT_signature *sig;
1718     KBNODE k;
1719     u32 mainkid[2];
1720     u32 sigdate = 0;
1721     KBNODE signode;
1722     u32 curtime = make_timestamp ();
1723     unsigned int key_usage = 0;
1724     u32 keytimestamp = 0;
1725     u32 key_expire = 0;
1726     const byte *p;
1727     size_t n;
1728
1729     if ( subnode->pkt->pkttype != PKT_PUBLIC_SUBKEY )
1730         BUG ();
1731     mainpk = keyblock->pkt->pkt.public_key;
1732     if ( mainpk->version < 4 )
1733         return; /* (actually this should never happen) */
1734     keyid_from_pk( mainpk, mainkid );
1735     subpk = subnode->pkt->pkt.public_key;
1736     keytimestamp = subpk->timestamp;
1737
1738     subpk->is_valid = 0;
1739     subpk->main_keyid[0] = mainpk->main_keyid[0];
1740     subpk->main_keyid[1] = mainpk->main_keyid[1];
1741
1742     /* find the latest key binding self-signature. */
1743     signode = NULL;
1744     sigdate = 0; /* helper to find the latest signature */
1745     for(k=subnode->next; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1746                                                         k = k->next ) {
1747         if ( k->pkt->pkttype == PKT_SIGNATURE ) {
1748             sig = k->pkt->pkt.signature;
1749             if ( sig->keyid[0] == mainkid[0] && sig->keyid[1]==mainkid[1] ) { 
1750                 if ( check_key_signature( keyblock, k, NULL ) )
1751                     ; /* signature did not verify */
1752                 else if ( IS_SUBKEY_REV (sig) ) {
1753                   /* Note that this means that the date on a
1754                      revocation sig does not matter - even if the
1755                      binding sig is dated after the revocation sig,
1756                      the subkey is still marked as revoked.  This
1757                      seems ok, as it is just as easy to make new
1758                      subkeys rather than re-sign old ones as the
1759                      problem is in the distribution.  Plus, PGP (7)
1760                      does this the same way.  */
1761                     subpk->is_revoked = 1;
1762                     /* although we could stop now, we continue to 
1763                      * figure out other information like the old expiration
1764                      * time */
1765                 }
1766                 else if ( IS_SUBKEY_SIG (sig) && sig->timestamp >= sigdate ) {
1767                     if(sig->flags.expired)
1768                         ; /* signature has expired - ignore it */
1769                     else {
1770                         sigdate = sig->timestamp;
1771                         signode = k;
1772                     }
1773                 }
1774             }
1775         }
1776     }
1777
1778     if ( !signode ) {
1779         return;  /* no valid key binding */
1780     }
1781
1782     subpk->is_valid = 1;
1783     sig = signode->pkt->pkt.signature;
1784         
1785     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_FLAGS, &n );
1786     if ( p && n ) {
1787         /* first octet of the keyflags */   
1788         if ( (*p & 3) )
1789             key_usage |= PUBKEY_USAGE_SIG;
1790         if ( (*p & 12) )    
1791             key_usage |= PUBKEY_USAGE_ENC;
1792     }
1793     if ( !key_usage ) { /* no key flags at all: get it from the algo */
1794         key_usage = openpgp_pk_algo_usage ( subpk->pubkey_algo );
1795     }
1796     else { /* check that the usage matches the usage as given by the algo */
1797         int x = openpgp_pk_algo_usage ( subpk->pubkey_algo );
1798         if ( x ) /* mask it down to the actual allowed usage */
1799             key_usage &= x; 
1800     }
1801     subpk->pubkey_usage = key_usage;
1802     
1803     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
1804     if ( p ) 
1805         key_expire = keytimestamp + buffer_to_u32(p);
1806     else
1807         key_expire = 0;
1808     subpk->has_expired = key_expire >= curtime? 0 : key_expire;
1809     subpk->expiredate = key_expire;
1810 }
1811
1812
1813
1814 /* 
1815  * Merge information from the self-signatures with the key, so that
1816  * we can later use them more easy.
1817  * The function works by first applying the self signatures to the
1818  * primary key and the to each subkey.
1819  * Here are the rules we use to decide which inormation from which
1820  * self-signature is used:
1821  * We check all self signatures or validity and ignore all invalid signatures.
1822  * All signatures are then ordered by their creation date ....
1823  * For the primary key:
1824  *   FIXME the docs    
1825  */
1826 static void
1827 merge_selfsigs( KBNODE keyblock )
1828 {
1829     KBNODE k;
1830     int revoked;
1831     PKT_public_key *main_pk;
1832     prefitem_t *prefs;
1833     int mdc_feature;
1834
1835     if ( keyblock->pkt->pkttype != PKT_PUBLIC_KEY ) {
1836         if (keyblock->pkt->pkttype == PKT_SECRET_KEY ) {
1837             log_error ("expected public key but found secret key "
1838                        "- must stop\n");
1839             /* we better exit here becuase a public key is expected at
1840                other places too.  FIXME: Figure this out earlier and
1841                don't get to here at all */
1842             g10_exit (1);
1843         }
1844         BUG ();
1845     }
1846
1847     merge_selfsigs_main ( keyblock, &revoked );
1848
1849     /* now merge in the data from each of the subkeys */
1850     for(k=keyblock; k; k = k->next ) {
1851         if (  k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
1852             merge_selfsigs_subkey ( keyblock, k );
1853         }
1854     }
1855
1856     main_pk = keyblock->pkt->pkt.public_key;
1857     if ( revoked || main_pk->has_expired || !main_pk->is_valid ) {
1858         /* if the primary key is revoked, expired, or invalid we
1859          * better set the appropriate flags on that key and all
1860          * subkeys */
1861         for(k=keyblock; k; k = k->next ) {
1862             if ( k->pkt->pkttype == PKT_PUBLIC_KEY
1863                 || k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
1864                 PKT_public_key *pk = k->pkt->pkt.public_key;
1865                 if(!main_pk->is_valid)
1866                   pk->is_valid = 0;
1867                 if(revoked)
1868                   pk->is_revoked = 1;
1869                 if(main_pk->has_expired)
1870                   pk->has_expired = main_pk->has_expired;
1871             }
1872         }
1873         return;
1874     }
1875
1876     /* set the preference list of all keys to those of the primary real
1877      * user ID.  Note: we use these preferences when we don't know by
1878      * which user ID the key has been selected.
1879      * fixme: we should keep atoms of commonly used preferences or
1880      * use reference counting to optimize the preference lists storage.
1881      * FIXME: it might be better to use the intersection of 
1882      * all preferences.
1883      * Do a similar thing for the MDC feature flag.
1884      */
1885     prefs = NULL;
1886     mdc_feature = 0;
1887     for (k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next) {
1888         if (k->pkt->pkttype == PKT_USER_ID
1889             && !k->pkt->pkt.user_id->attrib_data
1890             && k->pkt->pkt.user_id->is_primary) {
1891             prefs = k->pkt->pkt.user_id->prefs;
1892             mdc_feature = k->pkt->pkt.user_id->mdc_feature;
1893             break;
1894         }
1895     }    
1896     for(k=keyblock; k; k = k->next ) {
1897         if ( k->pkt->pkttype == PKT_PUBLIC_KEY
1898              || k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
1899             PKT_public_key *pk = k->pkt->pkt.public_key;
1900             if (pk->prefs)
1901                 m_free (pk->prefs);
1902             pk->prefs = copy_prefs (prefs);
1903             pk->mdc_feature = mdc_feature;
1904         }
1905     }
1906 }
1907
1908
1909 /*
1910  * Merge the secret keys from secblock into the pubblock thereby
1911  * replacing the public (sub)keys with their secret counterparts Hmmm:
1912  * It might be better to get away from the concept of entire secret
1913  * keys at all and have a way to store just the real secret parts
1914  * from the key.
1915  */
1916 static void
1917 merge_public_with_secret ( KBNODE pubblock, KBNODE secblock )
1918 {
1919     KBNODE pub;
1920
1921     assert ( pubblock->pkt->pkttype == PKT_PUBLIC_KEY );
1922     assert ( secblock->pkt->pkttype == PKT_SECRET_KEY );
1923     
1924     for (pub=pubblock; pub; pub = pub->next ) {
1925         if ( pub->pkt->pkttype == PKT_PUBLIC_KEY ) {
1926              PKT_public_key *pk = pub->pkt->pkt.public_key;
1927              PKT_secret_key *sk = secblock->pkt->pkt.secret_key;
1928              assert ( pub == pubblock ); /* only in the first node */
1929              /* there is nothing to compare in this case, so just replace
1930               * some information */
1931              copy_public_parts_to_secret_key ( pk, sk );
1932              free_public_key ( pk );
1933              pub->pkt->pkttype = PKT_SECRET_KEY;
1934              pub->pkt->pkt.secret_key = copy_secret_key (NULL, sk);
1935         }
1936         else if ( pub->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
1937             KBNODE sec;
1938             PKT_public_key *pk = pub->pkt->pkt.public_key;
1939
1940             /* this is more complicated: it may happen that the sequence
1941              * of the subkeys dosn't match, so we have to find the
1942              * appropriate secret key */
1943             for (sec=secblock->next; sec; sec = sec->next ) {
1944                 if ( sec->pkt->pkttype == PKT_SECRET_SUBKEY ) {
1945                     PKT_secret_key *sk = sec->pkt->pkt.secret_key;
1946                     if ( !cmp_public_secret_key ( pk, sk ) ) {
1947                         copy_public_parts_to_secret_key ( pk, sk );
1948                         free_public_key ( pk );
1949                         pub->pkt->pkttype = PKT_SECRET_SUBKEY;
1950                         pub->pkt->pkt.secret_key = copy_secret_key (NULL, sk);
1951                         break;
1952                     }
1953                 }
1954             }
1955             if ( !sec ) 
1956                 BUG(); /* already checked in premerge */
1957         }
1958     }
1959 }
1960
1961 /* This function checks that for every public subkey a corresponding
1962  * secret subkey is available and deletes the public subkey otherwise.
1963  * We need this function because we can't delete it later when we
1964  * actually merge the secret parts into the pubring.
1965  * The function also plays some games with the node flags.
1966  */
1967 static void
1968 premerge_public_with_secret ( KBNODE pubblock, KBNODE secblock )
1969 {
1970     KBNODE last, pub;
1971
1972     assert ( pubblock->pkt->pkttype == PKT_PUBLIC_KEY );
1973     assert ( secblock->pkt->pkttype == PKT_SECRET_KEY );
1974     
1975     for (pub=pubblock,last=NULL; pub; last = pub, pub = pub->next ) {
1976         pub->flag &= ~3; /* reset bits 0 and 1 */
1977         if ( pub->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
1978             KBNODE sec;
1979             PKT_public_key *pk = pub->pkt->pkt.public_key;
1980
1981             for (sec=secblock->next; sec; sec = sec->next ) {
1982                 if ( sec->pkt->pkttype == PKT_SECRET_SUBKEY ) {
1983                     PKT_secret_key *sk = sec->pkt->pkt.secret_key;
1984                     if ( !cmp_public_secret_key ( pk, sk ) ) {
1985                         if ( sk->protect.s2k.mode == 1001 ) {
1986                             /* The secret parts are not available so
1987                                we can't use that key for signing etc.
1988                                Fix the pubkey usage */
1989                             pk->pubkey_usage &= ~PUBKEY_USAGE_SIG;
1990                         }
1991                         /* transfer flag bits 0 and 1 to the pubblock */
1992                         pub->flag |= (sec->flag &3);
1993                         break;
1994                     }
1995                 }
1996             }
1997             if ( !sec ) {
1998                 KBNODE next, ll;
1999
2000                 log_info ( "no secret subkey "
2001                            "for public subkey %08lX - ignoring\n",  
2002                            (ulong)keyid_from_pk (pk,NULL) );
2003                 /* we have to remove the subkey in this case */
2004                 assert ( last );
2005                 /* find the next subkey */
2006                 for (next=pub->next,ll=pub;
2007                      next && pub->pkt->pkttype != PKT_PUBLIC_SUBKEY;
2008                      ll = next, next = next->next ) 
2009                     ;
2010                 /* make new link */
2011                 last->next = next;
2012                 /* release this public subkey with all sigs */
2013                 ll->next = NULL;
2014                 release_kbnode( pub );
2015                 /* let the loop continue */
2016                 pub = last;
2017             }
2018         }
2019     }
2020     /* We need to copy the found bits (0 and 1) from the secret key to
2021        the public key.  This has already been done for the subkeys but
2022        got lost on the primary key - fix it here *. */
2023     pubblock->flag |= (secblock->flag & 3);
2024 }
2025
2026
2027
2028 \f
2029 /* See see whether the key fits
2030  * our requirements and in case we do not
2031  * request the primary key, we should select
2032  * a suitable subkey.
2033  * FIXME: Check against PGP 7 whether we still need a kludge
2034  *        to favor type 16 keys over type 20 keys when type 20
2035  *        has not been explitely requested.
2036  * Returns: True when a suitable key has been found.
2037  *
2038  * We have to distinguish four cases:  FIXME!
2039  *  1. No usage and no primary key requested
2040  *     Examples for this case are that we have a keyID to be used
2041  *     for decrytion or verification.
2042  *  2. No usage but primary key requested
2043  *     This is the case for all functions which work on an
2044  *     entire keyblock, e.g. for editing or listing
2045  *  3. Usage and primary key requested
2046  *     FXME
2047  *  4. Usage but no primary key requested
2048  *     FIXME
2049  * FIXME: Tell what is going to happen here and something about the rationale
2050  * Note: We don't use this function if no specific usage is requested;
2051  *       This way the getkey functions can be used for plain key listings.
2052  *
2053  * CTX ist the keyblock we are investigating, if FOUNDK is not NULL this
2054  * is the key we actually found by looking at the keyid or a fingerprint and
2055  * may eitehr point to the primary or one of the subkeys.
2056  */
2057
2058 static int
2059 finish_lookup (GETKEY_CTX ctx)
2060 {
2061     KBNODE keyblock = ctx->keyblock;
2062     KBNODE k;
2063     KBNODE foundk = NULL;
2064     PKT_user_id *foundu = NULL;
2065   #define USAGE_MASK  (PUBKEY_USAGE_SIG|PUBKEY_USAGE_ENC)
2066     unsigned int req_usage = ( ctx->req_usage & USAGE_MASK );
2067     /* Request the primary if we're certifying another key, and also
2068        if signing data while --pgp6 or --pgp7 is on since pgp 6 and 7
2069        do not understand signatures made by a signing subkey.  PGP 8
2070        does. */
2071     int req_prim = (ctx->req_usage & PUBKEY_USAGE_CERT) ||
2072       ((opt.pgp6 || opt.pgp7) && (ctx->req_usage & PUBKEY_USAGE_SIG));
2073     u32 latest_date;
2074     KBNODE latest_key;
2075     u32 curtime = make_timestamp ();
2076
2077     assert( keyblock->pkt->pkttype == PKT_PUBLIC_KEY );
2078    
2079     ctx->found_key = NULL;
2080
2081     if (ctx->exact) {
2082         for (k=keyblock; k; k = k->next) {
2083             if ( (k->flag & 1) ) {
2084                 assert ( k->pkt->pkttype == PKT_PUBLIC_KEY
2085                          || k->pkt->pkttype == PKT_PUBLIC_SUBKEY );
2086                 foundk = k;
2087                 break;
2088             }
2089         }
2090     }
2091
2092     for (k=keyblock; k; k = k->next) {
2093         if ( (k->flag & 2) ) {
2094             assert (k->pkt->pkttype == PKT_USER_ID);
2095             foundu = k->pkt->pkt.user_id;
2096             break;
2097         }
2098     }
2099
2100     if ( DBG_CACHE )
2101         log_debug( "finish_lookup: checking key %08lX (%s)(req_usage=%x)\n",
2102                    (ulong)keyid_from_pk( keyblock->pkt->pkt.public_key, NULL),
2103                    foundk? "one":"all", req_usage);
2104
2105     if (!req_usage) {
2106         latest_key = foundk? foundk:keyblock;
2107         goto found;
2108     }
2109     
2110     if (!req_usage) {
2111         PKT_public_key *pk = foundk->pkt->pkt.public_key;
2112         if (pk->user_id)
2113             free_user_id (pk->user_id);
2114         pk->user_id = scopy_user_id (foundu);
2115         ctx->found_key = foundk;
2116         cache_user_id( keyblock );
2117         return 1; /* found */
2118     }
2119     
2120     latest_date = 0;
2121     latest_key  = NULL;
2122     /* do not look at subkeys if a certification key is requested */
2123     if ((!foundk || foundk->pkt->pkttype == PKT_PUBLIC_SUBKEY) && !req_prim) {
2124         KBNODE nextk;
2125         /* either start a loop or check just this one subkey */
2126         for (k=foundk?foundk:keyblock; k; k = nextk ) {
2127             PKT_public_key *pk;
2128             nextk = k->next;
2129             if ( k->pkt->pkttype != PKT_PUBLIC_SUBKEY )
2130                 continue;
2131             if ( foundk )
2132                 nextk = NULL;  /* what a hack */
2133             pk = k->pkt->pkt.public_key;
2134             if (DBG_CACHE)
2135                 log_debug( "\tchecking subkey %08lX\n",
2136                            (ulong)keyid_from_pk( pk, NULL));
2137             if ( !pk->is_valid ) {
2138                 if (DBG_CACHE)
2139                     log_debug( "\tsubkey not valid\n");
2140                 continue;
2141             }
2142             if ( pk->is_revoked ) {
2143                 if (DBG_CACHE)
2144                     log_debug( "\tsubkey has been revoked\n");
2145                 continue;
2146             }
2147             if ( pk->has_expired ) {
2148                 if (DBG_CACHE)
2149                     log_debug( "\tsubkey has expired\n");
2150                 continue;
2151             }
2152             if ( pk->timestamp > curtime && !opt.ignore_valid_from ) {
2153                 if (DBG_CACHE)
2154                     log_debug( "\tsubkey not yet valid\n");
2155                 continue;
2156             }
2157             
2158             if ( !((pk->pubkey_usage&USAGE_MASK) & req_usage) ) {
2159                 if (DBG_CACHE)
2160                     log_debug( "\tusage does not match: want=%x have=%x\n",
2161                                req_usage, pk->pubkey_usage );
2162                 continue;
2163             }
2164
2165             if (DBG_CACHE)
2166                 log_debug( "\tsubkey looks fine\n");
2167             if ( pk->timestamp > latest_date ) {
2168                 latest_date = pk->timestamp;
2169                 latest_key  = k;
2170             }
2171         }
2172     }
2173
2174     /* Okay now try the primary key unless we want an exact 
2175      * key ID match on a subkey */
2176     if ((!latest_key && !(ctx->exact && foundk != keyblock)) || req_prim) {
2177         PKT_public_key *pk;
2178         if (DBG_CACHE && !foundk && !req_prim )
2179             log_debug( "\tno suitable subkeys found - trying primary\n");
2180         pk = keyblock->pkt->pkt.public_key;
2181         if ( !pk->is_valid ) {
2182             if (DBG_CACHE)
2183                 log_debug( "\tprimary key not valid\n");
2184         }
2185         else if ( pk->is_revoked ) {
2186             if (DBG_CACHE)
2187                 log_debug( "\tprimary key has been revoked\n");
2188         }
2189         else if ( pk->has_expired ) {
2190             if (DBG_CACHE)
2191                 log_debug( "\tprimary key has expired\n");
2192         }
2193         else  if ( !((pk->pubkey_usage&USAGE_MASK) & req_usage) ) {
2194             if (DBG_CACHE)
2195                 log_debug( "\tprimary key usage does not match: "
2196                            "want=%x have=%x\n",
2197                            req_usage, pk->pubkey_usage );
2198         }
2199         else { /* okay */
2200             if (DBG_CACHE)
2201                 log_debug( "\tprimary key may be used\n");
2202             latest_key = keyblock;
2203             latest_date = pk->timestamp;
2204         }
2205     }
2206     
2207     if ( !latest_key ) {
2208         if (DBG_CACHE)
2209             log_debug("\tno suitable key found -  giving up\n");
2210         return 0;
2211     }
2212
2213  found:
2214     if (DBG_CACHE)
2215         log_debug( "\tusing key %08lX\n",
2216                 (ulong)keyid_from_pk( latest_key->pkt->pkt.public_key, NULL) );
2217
2218     if (latest_key) {
2219         PKT_public_key *pk = latest_key->pkt->pkt.public_key;
2220         if (pk->user_id)
2221             free_user_id (pk->user_id);
2222         pk->user_id = scopy_user_id (foundu);
2223     }    
2224         
2225     ctx->found_key = latest_key;
2226
2227     if (latest_key != keyblock && opt.verbose) {
2228         log_info(_("using secondary key %08lX "
2229                    "instead of primary key %08lX\n"),
2230                  (ulong)keyid_from_pk( latest_key->pkt->pkt.public_key, NULL),
2231                  (ulong)keyid_from_pk( keyblock->pkt->pkt.public_key, NULL) );
2232     }
2233
2234     cache_user_id( keyblock );
2235     
2236     return 1; /* found */
2237 }
2238
2239
2240 static int
2241 lookup( GETKEY_CTX ctx, KBNODE *ret_keyblock, int secmode )
2242 {
2243     int rc;
2244     KBNODE secblock = NULL; /* helper */
2245     int no_suitable_key = 0;
2246     
2247     rc = 0;
2248     while (!(rc = keydb_search (ctx->kr_handle, ctx->items, ctx->nitems))) {
2249         /* If we are searching for the first key we have to make sure
2250            that the next interation does not no an implicit reset.
2251            This can be triggered by an empty key ring. */
2252         if (ctx->nitems && ctx->items->mode == KEYDB_SEARCH_MODE_FIRST)
2253             ctx->items->mode = KEYDB_SEARCH_MODE_NEXT;
2254
2255         rc = keydb_get_keyblock (ctx->kr_handle, &ctx->keyblock);
2256         if (rc) {
2257             log_error ("keydb_get_keyblock failed: %s\n", g10_errstr(rc));
2258             rc = 0;
2259             goto skip;
2260         }
2261                        
2262         if ( secmode ) {
2263             /* find the correspondig public key and use this 
2264              * this one for the selection process */
2265             u32 aki[2];
2266             KBNODE k = ctx->keyblock;
2267             
2268             if (k->pkt->pkttype != PKT_SECRET_KEY)
2269                 BUG();
2270
2271             keyid_from_sk (k->pkt->pkt.secret_key, aki);
2272             k = get_pubkeyblock (aki);
2273             if( !k ) {
2274                 if (!opt.quiet)
2275                     log_info(_("key %08lX: secret key without public key "
2276                                "- skipped\n"),  (ulong)aki[1] );
2277                 goto skip;
2278             }
2279             secblock = ctx->keyblock;
2280             ctx->keyblock = k;
2281
2282             premerge_public_with_secret ( ctx->keyblock, secblock );
2283         }
2284
2285         /* warning: node flag bits 0 and 1 should be preserved by
2286          * merge_selfsigs.  For secret keys, premerge did tranfer the
2287          * keys to the keyblock */
2288         merge_selfsigs ( ctx->keyblock );
2289         if ( finish_lookup (ctx) ) {
2290             no_suitable_key = 0;
2291             if ( secmode ) {
2292                 merge_public_with_secret ( ctx->keyblock,
2293                                            secblock);
2294                 release_kbnode (secblock);
2295                 secblock = NULL;
2296             }
2297             goto found;
2298         }
2299         else
2300             no_suitable_key = 1;
2301         
2302       skip:
2303         /* release resources and continue search */
2304         if ( secmode ) {
2305             release_kbnode( secblock );
2306             secblock = NULL;
2307         }
2308         release_kbnode( ctx->keyblock );
2309         ctx->keyblock = NULL;
2310     }
2311
2312   found:
2313     if( rc && rc != -1 )
2314         log_error("keydb_search failed: %s\n", g10_errstr(rc));
2315
2316     if( !rc ) {
2317         *ret_keyblock = ctx->keyblock; /* return the keyblock */
2318         ctx->keyblock = NULL;
2319     }
2320     else if (rc == -1 && no_suitable_key)
2321         rc = secmode ? G10ERR_UNU_SECKEY : G10ERR_UNU_PUBKEY;
2322     else if( rc == -1 )
2323         rc = secmode ? G10ERR_NO_SECKEY : G10ERR_NO_PUBKEY;
2324
2325     if ( secmode ) {
2326         release_kbnode( secblock );
2327         secblock = NULL;
2328     }
2329     release_kbnode( ctx->keyblock );
2330     ctx->keyblock = NULL;
2331
2332     ctx->last_rc = rc;
2333     return rc;
2334 }
2335
2336
2337
2338
2339 /****************
2340  * FIXME: Replace by the generic function 
2341  *        It does not work as it is right now - it is used at 
2342  *        2 places:  a) to get the key for an anonyous recipient
2343  *                   b) to get the ultimately trusted keys.
2344  *        The a) usage might have some problems.
2345  *
2346  * set with_subkeys true to include subkeys
2347  * set with_spm true to include secret-parts-missing keys
2348  *
2349  * Enumerate all primary secret keys.  Caller must use these procedure:
2350  *  1) create a void pointer and initialize it to NULL
2351  *  2) pass this void pointer by reference to this function
2352  *     and provide space for the secret key (pass a buffer for sk)
2353  *  3) call this function as long as it does not return -1
2354  *     to indicate EOF.
2355  *  4) Always call this function a last time with SK set to NULL,
2356  *     so that can free it's context.
2357  */
2358 int
2359 enum_secret_keys( void **context, PKT_secret_key *sk,
2360                   int with_subkeys, int with_spm )
2361 {
2362     int rc=0;
2363     struct {
2364         int eof;
2365         int first;
2366         KEYDB_HANDLE hd;
2367         KBNODE keyblock;
2368         KBNODE node;
2369     } *c = *context;
2370
2371
2372     if( !c ) { /* make a new context */
2373         c = m_alloc_clear( sizeof *c );
2374         *context = c;
2375         c->hd = keydb_new (1);
2376         c->first = 1;
2377         c->keyblock = NULL;
2378         c->node = NULL;
2379     }
2380
2381     if( !sk ) { /* free the context */
2382         keydb_release (c->hd);
2383         release_kbnode (c->keyblock);
2384         m_free( c );
2385         *context = NULL;
2386         return 0;
2387     }
2388
2389     if( c->eof )
2390         return -1;
2391
2392     do {
2393         /* get the next secret key from the current keyblock */
2394         for (; c->node; c->node = c->node->next) {
2395             if ((c->node->pkt->pkttype == PKT_SECRET_KEY
2396                 || (with_subkeys
2397                     && c->node->pkt->pkttype == PKT_SECRET_SUBKEY) )
2398                 && !(c->node->pkt->pkt.secret_key->protect.s2k.mode==1001
2399                      && !with_spm)) {
2400                 copy_secret_key (sk, c->node->pkt->pkt.secret_key );
2401                 c->node = c->node->next;
2402                 return 0; /* found */
2403             }
2404         }
2405         release_kbnode (c->keyblock);
2406         c->keyblock = c->node = NULL;
2407         
2408         rc = c->first? keydb_search_first (c->hd) : keydb_search_next (c->hd);
2409         c->first = 0;
2410         if (rc) {
2411             keydb_release (c->hd); c->hd = NULL;
2412             c->eof = 1;
2413             return -1; /* eof */
2414         }
2415         
2416         rc = keydb_get_keyblock (c->hd, &c->keyblock);
2417         c->node = c->keyblock;
2418     } while (!rc);
2419
2420     return rc; /* error */
2421 }
2422
2423
2424 \f
2425 /*********************************************
2426  ***********  user ID printing helpers *******
2427  *********************************************/
2428
2429 /****************
2430  * Return a string with a printable representation of the user_id.
2431  * this string must be freed by m_free.
2432  */
2433 char*
2434 get_user_id_string( u32 *keyid )
2435 {
2436     user_id_db_t r;
2437     char *p;
2438     int pass=0;
2439     /* try it two times; second pass reads from key resources */
2440     do {
2441         for(r=user_id_db; r; r = r->next ) {
2442             keyid_list_t a;
2443             for (a=r->keyids; a; a= a->next ) {
2444                 if( a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1] ) {
2445                     p = m_alloc( r->len + 10 );
2446                     sprintf(p, "%08lX %.*s",
2447                             (ulong)keyid[1], r->len, r->name );
2448                     return p;
2449                 }
2450             }
2451         }
2452     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
2453     p = m_alloc( 15 );
2454     sprintf(p, "%08lX [?]", (ulong)keyid[1] );
2455     return p;
2456 }
2457
2458
2459 char*
2460 get_user_id_string_printable ( u32 *keyid )
2461 {
2462     char *p = get_user_id_string( keyid );
2463     char *p2 = utf8_to_native( p, strlen(p), 0 );
2464     m_free(p);
2465     p = make_printable_string (p2, strlen (p2), 0);
2466     m_free (p2);
2467     return p;
2468 }
2469
2470
2471 char*
2472 get_long_user_id_string( u32 *keyid )
2473 {
2474     user_id_db_t r;
2475     char *p;
2476     int pass=0;
2477     /* try it two times; second pass reads from key resources */
2478     do {
2479         for(r=user_id_db; r; r = r->next ) {
2480             keyid_list_t a;
2481             for (a=r->keyids; a; a= a->next ) {
2482                 if( a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1] ) {
2483                     p = m_alloc( r->len + 20 );
2484                     sprintf(p, "%08lX%08lX %.*s",
2485                             (ulong)keyid[0], (ulong)keyid[1],
2486                             r->len, r->name );
2487                     return p;
2488                 }
2489             }
2490         }
2491     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
2492     p = m_alloc( 25 );
2493     sprintf(p, "%08lX%08lX [?]", (ulong)keyid[0], (ulong)keyid[1] );
2494     return p;
2495 }
2496
2497 char*
2498 get_user_id( u32 *keyid, size_t *rn )
2499 {
2500     user_id_db_t r;
2501     char *p;
2502     int pass=0;
2503
2504     /* try it two times; second pass reads from key resources */
2505     do {
2506         for(r=user_id_db; r; r = r->next ) {
2507             keyid_list_t a;
2508             for (a=r->keyids; a; a= a->next ) {
2509                 if( a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1] ) {
2510                     p = m_alloc( r->len );
2511                     memcpy(p, r->name, r->len );
2512                     *rn = r->len;
2513                     return p;
2514                 }
2515             }
2516         }
2517     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
2518     p = m_strdup( _("[User id not found]") );
2519     *rn = strlen(p);
2520     return p;
2521 }
2522
2523 char*
2524 get_user_id_printable( u32 *keyid )
2525 {
2526     size_t rn;
2527     char *p = get_user_id( keyid, &rn );
2528     char *p2 = utf8_to_native( p, rn, 0 );
2529     m_free(p);
2530     p = make_printable_string (p2, strlen (p2), 0);
2531     m_free (p2);
2532     return p;
2533 }
2534
2535 KEYDB_HANDLE
2536 get_ctx_handle(GETKEY_CTX ctx)
2537 {
2538   return ctx->kr_handle;
2539 }