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