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