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