81b15b2e21638e2d28f9d17f03dfbfc769ca501a
[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   STRLIST namelist = NULL;
909
910   add_to_strlist( &namelist, name );
911
912   rc = key_byname( NULL, namelist, pk, NULL, 0,
913                    include_unusable, ret_keyblock, ret_kdbhd);
914
915   /* If the requested name resembles a valid mailbox and automatic
916      retrieval has been enabled, we try to import the key. */
917
918   if (rc == G10ERR_NO_PUBKEY && is_valid_mailbox(name))
919     {
920       int res;
921       struct akl *akl;
922
923       for(akl=opt.auto_key_locate;akl;akl=akl->next)
924         {
925           switch(akl->type)
926             {
927             case AKL_CERT:
928               glo_ctrl.in_auto_key_retrieve++;
929               res=keyserver_import_cert(name);
930               glo_ctrl.in_auto_key_retrieve--;
931
932               if(res==0)
933                 log_info(_("Automatically retrieved `%s' via %s\n"),
934                          name,"DNS CERT");
935               break;
936
937             case AKL_PKA:
938               {
939                 unsigned char fpr[MAX_FINGERPRINT_LEN];
940
941                 glo_ctrl.in_auto_key_retrieve++;
942                 res=keyserver_import_pka(name,fpr);
943                 glo_ctrl.in_auto_key_retrieve--;
944
945                 if(res==0)
946                   {
947                     int i;
948                     char fpr_string[MAX_FINGERPRINT_LEN*2+1];
949
950                     log_info(_("Automatically retrieved `%s' via %s\n"),
951                              name,"PKA");
952
953                     free_strlist(namelist);
954                     namelist=NULL;
955
956                     for(i=0;i<MAX_FINGERPRINT_LEN;i++)
957                       sprintf(fpr_string+2*i,"%02X",fpr[i]);
958
959                     add_to_strlist( &namelist, fpr_string );
960                   }
961               }
962               break;
963
964             case AKL_LDAP:
965               glo_ctrl.in_auto_key_retrieve++;
966               res=keyserver_import_ldap(name);
967               glo_ctrl.in_auto_key_retrieve--;
968
969               if(res==0)
970                 log_info(_("Automatically retrieved `%s' via %s\n"),
971                          name,"LDAP");
972               break;
973
974             case AKL_KEYSERVER:
975               /* Strictly speaking, we don't need to only use a valid
976                  mailbox for the getname search, but it helps cut down
977                  on the problem of searching for something like "john"
978                  and getting a whole lot of keys back. */
979               if(opt.keyserver)
980                 {
981                   glo_ctrl.in_auto_key_retrieve++;
982                   res=keyserver_import_name(name,opt.keyserver);
983                   glo_ctrl.in_auto_key_retrieve--;
984
985                   if(res==0)
986                     log_info(_("Automatically retrieved `%s' via %s\n"),
987                              name,opt.keyserver->uri);
988                 }
989               break;
990
991             case AKL_SPEC:
992               glo_ctrl.in_auto_key_retrieve++;
993               res=keyserver_import_name(name,akl->spec);
994               glo_ctrl.in_auto_key_retrieve--;
995
996               if(res==0)
997                 log_info(_("Automatically retrieved `%s' via %s\n"),
998                          name,akl->spec->uri);
999               break;
1000             }
1001
1002           rc = key_byname( NULL, namelist, pk, NULL, 0,
1003                            include_unusable, ret_keyblock, ret_kdbhd);
1004           if(rc!=G10ERR_NO_PUBKEY)
1005             break;
1006         }
1007     }
1008
1009   free_strlist( namelist );
1010   return rc;
1011 }
1012
1013 int
1014 get_pubkey_bynames( GETKEY_CTX *retctx, PKT_public_key *pk,
1015                     STRLIST names, KBNODE *ret_keyblock )
1016 {
1017     return key_byname( retctx, names, pk, NULL, 0, 1, ret_keyblock, NULL);
1018 }
1019
1020 int
1021 get_pubkey_next( GETKEY_CTX ctx, PKT_public_key *pk, KBNODE *ret_keyblock )
1022 {
1023     int rc;
1024
1025     rc = lookup( ctx, ret_keyblock, 0 );
1026     if ( !rc && pk && ret_keyblock )
1027         pk_from_block ( ctx, pk, *ret_keyblock );
1028     
1029     return rc;
1030 }
1031
1032 void
1033 get_pubkey_end( GETKEY_CTX ctx )
1034 {
1035     if( ctx ) {
1036         memset (&ctx->kbpos, 0, sizeof ctx->kbpos);
1037         keydb_release (ctx->kr_handle);
1038         if( !ctx->not_allocated )
1039             xfree( ctx );
1040     }
1041 }
1042
1043
1044 /****************
1045  * Search for a key with the given fingerprint.
1046  * FIXME:
1047  * We should replace this with the _byname function.  Thiscsan be done
1048  * by creating a userID conforming to the unified fingerprint style. 
1049  */
1050 int
1051 get_pubkey_byfprint( PKT_public_key *pk,
1052                      const byte *fprint, size_t fprint_len)
1053 {
1054     int rc;
1055
1056     if( fprint_len == 20 || fprint_len == 16 ) {
1057         struct getkey_ctx_s ctx;
1058         KBNODE kb = NULL;
1059
1060         memset( &ctx, 0, sizeof ctx );
1061         ctx.exact = 1 ;
1062         ctx.not_allocated = 1;
1063         ctx.kr_handle = keydb_new (0);
1064         ctx.nitems = 1;
1065         ctx.items[0].mode = fprint_len==16? KEYDB_SEARCH_MODE_FPR16
1066                                           : KEYDB_SEARCH_MODE_FPR20;
1067         memcpy( ctx.items[0].u.fpr, fprint, fprint_len );
1068         rc = lookup( &ctx, &kb, 0 );
1069         if (!rc && pk )
1070             pk_from_block ( &ctx, pk, kb );
1071         release_kbnode ( kb );
1072         get_pubkey_end( &ctx );
1073     }
1074     else
1075         rc = G10ERR_GENERAL; /* Oops */
1076     return rc;
1077 }
1078
1079
1080 /* Get a public key and store it into the allocated pk.  This function
1081    differs from get_pubkey_byfprint() in that it does not do a check
1082    of the key to avoid recursion.  It should be used only in very
1083    certain cases.  PK may be NULL to check just for the existance of
1084    the key. */
1085 int
1086 get_pubkey_byfprint_fast (PKT_public_key *pk,
1087                           const byte *fprint, size_t fprint_len)
1088 {
1089   int rc = 0;
1090   KEYDB_HANDLE hd;
1091   KBNODE keyblock;
1092   byte fprbuf[MAX_FINGERPRINT_LEN];
1093   int i;
1094   
1095   for (i=0; i < MAX_FINGERPRINT_LEN && i < fprint_len; i++)
1096     fprbuf[i] = fprint[i];
1097   while (i < MAX_FINGERPRINT_LEN) 
1098     fprbuf[i++] = 0;
1099
1100   hd = keydb_new (0);
1101   rc = keydb_search_fpr (hd, fprbuf);
1102   if (rc == -1)
1103     {
1104       keydb_release (hd);
1105       return G10ERR_NO_PUBKEY;
1106     }
1107   rc = keydb_get_keyblock (hd, &keyblock);
1108   keydb_release (hd);
1109   if (rc) 
1110     {
1111       log_error ("keydb_get_keyblock failed: %s\n", g10_errstr(rc));
1112       return G10ERR_NO_PUBKEY;
1113     }
1114   
1115   assert ( keyblock->pkt->pkttype == PKT_PUBLIC_KEY
1116            ||  keyblock->pkt->pkttype == PKT_PUBLIC_SUBKEY );
1117   if (pk)
1118     copy_public_key (pk, keyblock->pkt->pkt.public_key );
1119   release_kbnode (keyblock);
1120
1121   /* Not caching key here since it won't have all of the fields
1122      properly set. */
1123
1124   return 0;
1125 }
1126
1127 /****************
1128  * Search for a key with the given fingerprint and return the
1129  * complete keyblock which may have more than only this key.
1130  */
1131 int
1132 get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
1133                                                 size_t fprint_len )
1134 {
1135     int rc;
1136
1137     if( fprint_len == 20 || fprint_len == 16 ) {
1138         struct getkey_ctx_s ctx;
1139
1140         memset( &ctx, 0, sizeof ctx );
1141         ctx.not_allocated = 1;
1142         ctx.kr_handle = keydb_new (0);
1143         ctx.nitems = 1;
1144         ctx.items[0].mode = fprint_len==16? KEYDB_SEARCH_MODE_FPR16
1145                                           : KEYDB_SEARCH_MODE_FPR20;
1146         memcpy( ctx.items[0].u.fpr, fprint, fprint_len );
1147         rc = lookup( &ctx, ret_keyblock, 0 );
1148         get_pubkey_end( &ctx );
1149     }
1150     else
1151         rc = G10ERR_GENERAL; /* Oops */
1152
1153     return rc;
1154 }
1155
1156
1157 /****************
1158  * Get a secret key by name and store it into sk
1159  * If NAME is NULL use the default key
1160  */
1161 static int
1162 get_seckey_byname2( GETKEY_CTX *retctx,
1163                     PKT_secret_key *sk, const char *name, int unprotect,
1164                     KBNODE *retblock )
1165 {
1166   STRLIST namelist = NULL;
1167   int rc,include_unusable=1;
1168
1169   /* If we have no name, try to use the default secret key.  If we
1170      have no default, we'll use the first usable one. */
1171
1172   if( !name && opt.def_secret_key && *opt.def_secret_key )
1173     add_to_strlist( &namelist, opt.def_secret_key );
1174   else if(name)
1175     add_to_strlist( &namelist, name );
1176   else
1177     include_unusable=0;
1178
1179   rc = key_byname( retctx, namelist, NULL, sk, 1, include_unusable,
1180                    retblock, NULL );
1181
1182   free_strlist( namelist );
1183
1184   if( !rc && unprotect )
1185     rc = check_secret_key( sk, 0 );
1186
1187   return rc;
1188 }
1189
1190 int 
1191 get_seckey_byname( PKT_secret_key *sk, const char *name, int unlock )
1192 {
1193     return get_seckey_byname2 ( NULL, sk, name, unlock, NULL );
1194 }
1195
1196
1197 int
1198 get_seckey_bynames( GETKEY_CTX *retctx, PKT_secret_key *sk,
1199                     STRLIST names, KBNODE *ret_keyblock )
1200 {
1201     return key_byname( retctx, names, NULL, sk, 1, 1, ret_keyblock, NULL );
1202 }
1203
1204
1205 int
1206 get_seckey_next( GETKEY_CTX ctx, PKT_secret_key *sk, KBNODE *ret_keyblock )
1207 {
1208     int rc;
1209
1210     rc = lookup( ctx, ret_keyblock, 1 );
1211     if ( !rc && sk && ret_keyblock )
1212         sk_from_block ( ctx, sk, *ret_keyblock );
1213
1214     return rc;
1215 }
1216
1217
1218 void
1219 get_seckey_end( GETKEY_CTX ctx )
1220 {
1221     get_pubkey_end( ctx );
1222 }
1223
1224
1225 /****************
1226  * Search for a key with the given fingerprint.
1227  * FIXME:
1228  * We should replace this with the _byname function.  Thiscsan be done
1229  * by creating a userID conforming to the unified fingerprint style. 
1230  */
1231 int
1232 get_seckey_byfprint( PKT_secret_key *sk,
1233                      const byte *fprint, size_t fprint_len)
1234 {
1235     int rc;
1236
1237     if( fprint_len == 20 || fprint_len == 16 ) {
1238         struct getkey_ctx_s ctx;
1239         KBNODE kb = NULL;
1240
1241         memset( &ctx, 0, sizeof ctx );
1242         ctx.exact = 1 ;
1243         ctx.not_allocated = 1;
1244         ctx.kr_handle = keydb_new (1);
1245         ctx.nitems = 1;
1246         ctx.items[0].mode = fprint_len==16? KEYDB_SEARCH_MODE_FPR16
1247                                           : KEYDB_SEARCH_MODE_FPR20;
1248         memcpy( ctx.items[0].u.fpr, fprint, fprint_len );
1249         rc = lookup( &ctx, &kb, 1 );
1250         if (!rc && sk )
1251             sk_from_block ( &ctx, sk, kb );
1252         release_kbnode ( kb );
1253         get_seckey_end( &ctx );
1254     }
1255     else
1256         rc = G10ERR_GENERAL; /* Oops */
1257     return rc;
1258 }
1259
1260
1261 /* Search for a secret key with the given fingerprint and return the
1262    complete keyblock which may have more than only this key. */
1263 int
1264 get_seckeyblock_byfprint (KBNODE *ret_keyblock, const byte *fprint,
1265                           size_t fprint_len )
1266 {
1267   int rc;
1268   struct getkey_ctx_s ctx;
1269   
1270   if (fprint_len != 20 && fprint_len == 16)
1271     return G10ERR_GENERAL; /* Oops */
1272     
1273   memset (&ctx, 0, sizeof ctx);
1274   ctx.not_allocated = 1;
1275   ctx.kr_handle = keydb_new (1);
1276   ctx.nitems = 1;
1277   ctx.items[0].mode = (fprint_len==16
1278                        ? KEYDB_SEARCH_MODE_FPR16
1279                        : KEYDB_SEARCH_MODE_FPR20);
1280   memcpy (ctx.items[0].u.fpr, fprint, fprint_len);
1281   rc = lookup (&ctx, ret_keyblock, 1);
1282   get_seckey_end (&ctx);
1283   
1284   return rc;
1285 }
1286
1287
1288 \f
1289 /************************************************
1290  ************* Merging stuff ********************
1291  ************************************************/
1292
1293 /****************
1294  * merge all selfsignatures with the keys.
1295  * FIXME: replace this at least for the public key parts
1296  *        by merge_selfsigs.
1297  *        It is still used in keyedit.c and
1298  *        at 2 or 3 other places - check whether it is really needed.
1299  *        It might be needed by the key edit and import stuff because
1300  *        the keylock is changed.
1301  */
1302 void
1303 merge_keys_and_selfsig( KBNODE keyblock )
1304 {
1305     PKT_public_key *pk = NULL;
1306     PKT_secret_key *sk = NULL;
1307     PKT_signature *sig;
1308     KBNODE k;
1309     u32 kid[2] = { 0, 0 };
1310     u32 sigdate = 0;
1311
1312     if (keyblock && keyblock->pkt->pkttype == PKT_PUBLIC_KEY ) {
1313         /* divert to our new function */
1314         merge_selfsigs (keyblock);
1315         return;
1316     }
1317     /* still need the old one because the new one can't handle secret keys */
1318
1319     for(k=keyblock; k; k = k->next ) {
1320         if( k->pkt->pkttype == PKT_PUBLIC_KEY
1321             || k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
1322             pk = k->pkt->pkt.public_key; sk = NULL;
1323             if( pk->version < 4 )
1324                 pk = NULL; /* not needed for old keys */
1325             else if( k->pkt->pkttype == PKT_PUBLIC_KEY )
1326                 keyid_from_pk( pk, kid );
1327             else if( !pk->expiredate ) { /* and subkey */
1328                 /* insert the expiration date here */
1329                 /*FIXME!!! pk->expiredate = subkeys_expiretime( k, kid );*/
1330             }
1331             sigdate = 0;
1332         }
1333         else if( k->pkt->pkttype == PKT_SECRET_KEY
1334             || k->pkt->pkttype == PKT_SECRET_SUBKEY ) {
1335             pk = NULL; sk = k->pkt->pkt.secret_key;
1336             if( sk->version < 4 )
1337                 sk = NULL;
1338             else if( k->pkt->pkttype == PKT_SECRET_KEY )
1339                 keyid_from_sk( sk, kid );
1340             sigdate = 0;
1341         }
1342         else if( (pk || sk ) && k->pkt->pkttype == PKT_SIGNATURE
1343                  && (sig=k->pkt->pkt.signature)->sig_class >= 0x10
1344                  && sig->sig_class <= 0x30 && sig->version > 3
1345                  && !(sig->sig_class == 0x18 || sig->sig_class == 0x28)
1346                  && sig->keyid[0] == kid[0] && sig->keyid[1] == kid[1] ) {
1347             /* okay this is a self-signature which can be used.
1348              * This is not used for subkey binding signature, becuase this
1349              * is done above.
1350              * FIXME: We should only use this if the signature is valid
1351              *        but this is time consuming - we must provide another
1352              *        way to handle this
1353              */
1354             const byte *p;
1355             u32 ed;
1356
1357             p = parse_sig_subpkt( sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL );
1358             if( pk ) {
1359                 ed = p? pk->timestamp + buffer_to_u32(p):0;
1360                 if( sig->timestamp > sigdate ) {
1361                     pk->expiredate = ed;
1362                     sigdate = sig->timestamp;
1363                 }
1364             }
1365             else {
1366                 ed = p? sk->timestamp + buffer_to_u32(p):0;
1367                 if( sig->timestamp > sigdate ) {
1368                     sk->expiredate = ed;
1369                     sigdate = sig->timestamp;
1370                 }
1371             }
1372         }
1373
1374         if(pk && (pk->expiredate==0 ||
1375                   (pk->max_expiredate && pk->expiredate>pk->max_expiredate)))
1376           pk->expiredate=pk->max_expiredate;
1377
1378         if(sk && (sk->expiredate==0 ||
1379                   (sk->max_expiredate && sk->expiredate>sk->max_expiredate)))
1380           sk->expiredate=sk->max_expiredate;
1381     }
1382 }
1383
1384 static int
1385 parse_key_usage(PKT_signature *sig)
1386 {
1387   int key_usage=0;
1388   const byte *p;
1389   size_t n;
1390   byte flags;
1391
1392   p=parse_sig_subpkt(sig->hashed,SIGSUBPKT_KEY_FLAGS,&n);
1393   if(p && n)
1394     {
1395       /* first octet of the keyflags */
1396       flags=*p;
1397
1398       if(flags & 1)
1399         {
1400           key_usage |= PUBKEY_USAGE_CERT;
1401           flags&=~1;
1402         }
1403
1404       if(flags & 2)
1405         {
1406           key_usage |= PUBKEY_USAGE_SIG;
1407           flags&=~2;
1408         }
1409
1410       /* We do not distinguish between encrypting communications and
1411          encrypting storage. */
1412       if(flags & (0x04|0x08))
1413         {
1414           key_usage |= PUBKEY_USAGE_ENC;
1415           flags&=~(0x04|0x08);
1416         }
1417
1418       if(flags & 0x20)
1419         {
1420           key_usage |= PUBKEY_USAGE_AUTH;
1421           flags&=~0x20;
1422         }
1423
1424       if(flags)
1425         key_usage |= PUBKEY_USAGE_UNKNOWN;
1426     }
1427
1428   /* We set PUBKEY_USAGE_UNKNOWN to indicate that this key has a
1429      capability that we do not handle.  This serves to distinguish
1430      between a zero key usage which we handle as the default
1431      capabilities for that algorithm, and a usage that we do not
1432      handle. */
1433
1434   return key_usage;
1435 }
1436
1437 /*
1438  * Apply information from SIGNODE (which is the valid self-signature
1439  * associated with that UID) to the UIDNODE:
1440  * - wether the UID has been revoked
1441  * - assumed creation date of the UID
1442  * - temporary store the keyflags here
1443  * - temporary store the key expiration time here
1444  * - mark whether the primary user ID flag hat been set.
1445  * - store the preferences
1446  */
1447 static void
1448 fixup_uidnode ( KBNODE uidnode, KBNODE signode, u32 keycreated )
1449 {
1450     PKT_user_id   *uid = uidnode->pkt->pkt.user_id;
1451     PKT_signature *sig = signode->pkt->pkt.signature;
1452     const byte *p, *sym, *hash, *zip;
1453     size_t n, nsym, nhash, nzip;
1454
1455     sig->flags.chosen_selfsig = 1; /* we chose this one */
1456     uid->created = 0; /* not created == invalid */
1457     if ( IS_UID_REV ( sig ) ) {
1458         uid->is_revoked = 1;
1459         return; /* has been revoked */
1460     }
1461
1462     uid->expiredate = sig->expiredate;
1463
1464     if(sig->flags.expired)
1465       {
1466         uid->is_expired = 1;
1467         return; /* has expired */
1468       }
1469
1470     uid->created = sig->timestamp; /* this one is okay */
1471     uid->selfsigversion = sig->version;
1472     /* If we got this far, it's not expired :) */
1473     uid->is_expired = 0;
1474
1475     /* store the key flags in the helper variable for later processing */
1476     uid->help_key_usage=parse_key_usage(sig);
1477
1478     /* ditto or the key expiration */
1479     uid->help_key_expire = 0;
1480     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
1481     if ( p ) { 
1482         uid->help_key_expire = keycreated + buffer_to_u32(p);
1483     }
1484
1485     /* Set the primary user ID flag - we will later wipe out some
1486      * of them to only have one in our keyblock */
1487     uid->is_primary = 0;
1488     p = parse_sig_subpkt ( sig->hashed, SIGSUBPKT_PRIMARY_UID, NULL );
1489     if ( p && *p )
1490         uid->is_primary = 2;
1491     /* We could also query this from the unhashed area if it is not in
1492      * the hased area and then later try to decide which is the better
1493      * there should be no security problem with this.
1494      * For now we only look at the hashed one. 
1495      */
1496
1497     /* Now build the preferences list.  These must come from the
1498        hashed section so nobody can modify the ciphers a key is
1499        willing to accept. */
1500     p = parse_sig_subpkt ( sig->hashed, SIGSUBPKT_PREF_SYM, &n );
1501     sym = p; nsym = p?n:0;
1502     p = parse_sig_subpkt ( sig->hashed, SIGSUBPKT_PREF_HASH, &n );
1503     hash = p; nhash = p?n:0;
1504     p = parse_sig_subpkt ( sig->hashed, SIGSUBPKT_PREF_COMPR, &n );
1505     zip = p; nzip = p?n:0;
1506     if (uid->prefs) 
1507         xfree (uid->prefs);
1508     n = nsym + nhash + nzip;
1509     if (!n)
1510         uid->prefs = NULL;
1511     else {
1512         uid->prefs = xmalloc (sizeof (*uid->prefs) * (n+1));
1513         n = 0;
1514         for (; nsym; nsym--, n++) {
1515             uid->prefs[n].type = PREFTYPE_SYM;
1516             uid->prefs[n].value = *sym++;
1517         }
1518         for (; nhash; nhash--, n++) {
1519             uid->prefs[n].type = PREFTYPE_HASH;
1520             uid->prefs[n].value = *hash++;
1521         }
1522         for (; nzip; nzip--, n++) {
1523             uid->prefs[n].type = PREFTYPE_ZIP;
1524             uid->prefs[n].value = *zip++;
1525         }
1526         uid->prefs[n].type = PREFTYPE_NONE; /* end of list marker */
1527         uid->prefs[n].value = 0;
1528     }
1529
1530     /* see whether we have the MDC feature */
1531     uid->flags.mdc = 0;
1532     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_FEATURES, &n);
1533     if (p && n && (p[0] & 0x01))
1534         uid->flags.mdc = 1;
1535
1536     /* and the keyserver modify flag */
1537     uid->flags.ks_modify = 1;
1538     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KS_FLAGS, &n);
1539     if (p && n && (p[0] & 0x80))
1540         uid->flags.ks_modify = 0;
1541 }
1542
1543 static void
1544 sig_to_revoke_info(PKT_signature *sig,struct revoke_info *rinfo)
1545 {
1546   rinfo->date = sig->timestamp;
1547   rinfo->algo = sig->pubkey_algo;
1548   rinfo->keyid[0] = sig->keyid[0];
1549   rinfo->keyid[1] = sig->keyid[1];
1550 }
1551
1552 static void
1553 merge_selfsigs_main(KBNODE keyblock, int *r_revoked, struct revoke_info *rinfo)
1554 {
1555     PKT_public_key *pk = NULL;
1556     KBNODE k;
1557     u32 kid[2];
1558     u32 sigdate, uiddate, uiddate2;
1559     KBNODE signode, uidnode, uidnode2;
1560     u32 curtime = make_timestamp ();
1561     unsigned int key_usage = 0;
1562     u32 keytimestamp = 0;
1563     u32 key_expire = 0;
1564     int key_expire_seen = 0;
1565     byte sigversion = 0;
1566
1567     *r_revoked = 0;
1568     memset(rinfo,0,sizeof(*rinfo));
1569
1570     if ( keyblock->pkt->pkttype != PKT_PUBLIC_KEY )
1571         BUG ();
1572     pk = keyblock->pkt->pkt.public_key;
1573     keytimestamp = pk->timestamp;
1574
1575     keyid_from_pk( pk, kid );
1576     pk->main_keyid[0] = kid[0];
1577     pk->main_keyid[1] = kid[1];
1578
1579     if ( pk->version < 4 ) {
1580         /* before v4 the key packet itself contains the expiration
1581          * date and there was no way to change it, so we start with
1582          * the one from the key packet */
1583         key_expire = pk->max_expiredate;
1584         key_expire_seen = 1;
1585     }
1586
1587     /* first pass: find the latest direct key self-signature.
1588      * We assume that the newest one overrides all others
1589      */
1590
1591     /* In case this key was already merged */
1592     xfree(pk->revkey);
1593     pk->revkey=NULL;
1594     pk->numrevkeys=0;
1595
1596     signode = NULL;
1597     sigdate = 0; /* helper to find the latest signature */
1598     for(k=keyblock; k && k->pkt->pkttype != PKT_USER_ID; k = k->next ) {
1599         if ( k->pkt->pkttype == PKT_SIGNATURE ) {
1600             PKT_signature *sig = k->pkt->pkt.signature;
1601             if ( sig->keyid[0] == kid[0] && sig->keyid[1]==kid[1] ) { 
1602                 if ( check_key_signature( keyblock, k, NULL ) )
1603                     ; /* signature did not verify */
1604                 else if ( IS_KEY_REV (sig) ){
1605                     /* key has been revoked - there is no way to override
1606                      * such a revocation, so we theoretically can stop now.
1607                      * We should not cope with expiration times for revocations
1608                      * here because we have to assume that an attacker can
1609                      * generate all kinds of signatures.  However due to the
1610                      * fact that the key has been revoked it does not harm
1611                      * either and by continuing we gather some more info on 
1612                      * that key.
1613                      */ 
1614                     *r_revoked = 1;
1615                     sig_to_revoke_info(sig,rinfo);
1616                 }
1617                 else if ( IS_KEY_SIG (sig) ) {
1618                   /* Add any revocation keys onto the pk.  This is
1619                      particularly interesting since we normally only
1620                      get data from the most recent 1F signature, but
1621                      you need multiple 1F sigs to properly handle
1622                      revocation keys (PGP does it this way, and a
1623                      revocation key could be sensitive and hence in a
1624                      different signature). */
1625                   if(sig->revkey) {
1626                     int i;
1627
1628                     pk->revkey=
1629                       xrealloc(pk->revkey,sizeof(struct revocation_key)*
1630                                 (pk->numrevkeys+sig->numrevkeys));
1631
1632                     for(i=0;i<sig->numrevkeys;i++)
1633                       memcpy(&pk->revkey[pk->numrevkeys++],
1634                              sig->revkey[i],
1635                              sizeof(struct revocation_key));
1636                   }
1637
1638                   if( sig->timestamp >= sigdate ) {
1639                     if(sig->flags.expired)
1640                         ; /* signature has expired - ignore it */
1641                     else {
1642                         sigdate = sig->timestamp;
1643                         signode = k;
1644                         if( sig->version > sigversion )
1645                           sigversion = sig->version;
1646
1647                     }
1648                   }
1649                 }
1650             }
1651         }
1652     }
1653
1654     /* Remove dupes from the revocation keys */
1655
1656     if(pk->revkey)
1657       {
1658         int i,j,x,changed=0;
1659
1660         for(i=0;i<pk->numrevkeys;i++)
1661           {
1662             for(j=i+1;j<pk->numrevkeys;j++)
1663               {
1664                 if(memcmp(&pk->revkey[i],&pk->revkey[j],
1665                           sizeof(struct revocation_key))==0)
1666                   {
1667                     /* remove j */
1668
1669                     for(x=j;x<pk->numrevkeys-1;x++)
1670                       pk->revkey[x]=pk->revkey[x+1];
1671
1672                     pk->numrevkeys--;
1673                     j--;
1674                     changed=1;
1675                   }
1676               }
1677           }
1678
1679         if(changed)
1680           pk->revkey=xrealloc(pk->revkey,
1681                                pk->numrevkeys*sizeof(struct revocation_key));
1682       }
1683
1684     if ( signode )
1685       {
1686         /* some information from a direct key signature take precedence
1687          * over the same information given in UID sigs.
1688          */
1689         PKT_signature *sig = signode->pkt->pkt.signature;
1690         const byte *p;
1691
1692         key_usage=parse_key_usage(sig);
1693
1694         p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
1695         if ( p )
1696           {
1697             key_expire = keytimestamp + buffer_to_u32(p);
1698             key_expire_seen = 1;
1699           }
1700
1701         /* mark that key as valid: one direct key signature should 
1702          * render a key as valid */
1703         pk->is_valid = 1;
1704       }
1705
1706     /* pass 1.5: look for key revocation signatures that were not made
1707        by the key (i.e. did a revocation key issue a revocation for
1708        us?).  Only bother to do this if there is a revocation key in
1709        the first place and we're not revoked already. */
1710
1711     if(!*r_revoked && pk->revkey)
1712       for(k=keyblock; k && k->pkt->pkttype != PKT_USER_ID; k = k->next )
1713         {
1714           if ( k->pkt->pkttype == PKT_SIGNATURE )
1715             {
1716               PKT_signature *sig = k->pkt->pkt.signature;
1717
1718               if(IS_KEY_REV(sig) &&
1719                  (sig->keyid[0]!=kid[0] || sig->keyid[1]!=kid[1]))
1720                 { 
1721                   int rc=check_revocation_keys(pk,sig);
1722                   if(rc==0)
1723                     {
1724                       *r_revoked=2;
1725                       sig_to_revoke_info(sig,rinfo);
1726                       /* don't continue checking since we can't be any
1727                          more revoked than this */
1728                       break;
1729                     }
1730                   else if(rc==G10ERR_NO_PUBKEY)
1731                     pk->maybe_revoked=1;
1732
1733                   /* A failure here means the sig did not verify, was
1734                      not issued by a revocation key, or a revocation
1735                      key loop was broken.  If a revocation key isn't
1736                      findable, however, the key might be revoked and
1737                      we don't know it. */
1738
1739                   /* TODO: In the future handle subkey and cert
1740                      revocations?  PGP doesn't, but it's in 2440. */
1741                 }
1742             }
1743         }
1744
1745     /* second pass: look at the self-signature of all user IDs */
1746     signode = uidnode = NULL;
1747     sigdate = 0; /* helper to find the latest signature in one user ID */
1748     for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next ) {
1749         if ( k->pkt->pkttype == PKT_USER_ID ) {
1750             if ( uidnode && signode ) 
1751               {
1752                 fixup_uidnode ( uidnode, signode, keytimestamp );
1753                 pk->is_valid=1;
1754               }
1755             uidnode = k;
1756             signode = NULL;
1757             sigdate = 0;
1758         }
1759         else if ( k->pkt->pkttype == PKT_SIGNATURE && uidnode ) {
1760             PKT_signature *sig = k->pkt->pkt.signature;
1761             if ( sig->keyid[0] == kid[0] && sig->keyid[1]==kid[1] ) { 
1762                 if ( check_key_signature( keyblock, k, NULL ) )
1763                     ; /* signature did not verify */
1764                 else if ( (IS_UID_SIG (sig) || IS_UID_REV (sig))
1765                           && sig->timestamp >= sigdate )
1766                   {
1767                     /* Note: we allow to invalidate cert revocations
1768                      * by a newer signature.  An attacker can't use this
1769                      * because a key should be revoced with a key revocation.
1770                      * The reason why we have to allow for that is that at
1771                      * one time an email address may become invalid but later
1772                      * the same email address may become valid again (hired,
1773                      * fired, hired again).
1774                      */
1775
1776                     sigdate = sig->timestamp;
1777                     signode = k;
1778                     signode->pkt->pkt.signature->flags.chosen_selfsig=0;
1779                     if( sig->version > sigversion )
1780                       sigversion = sig->version;
1781                   }
1782             }
1783         }
1784     }
1785     if ( uidnode && signode ) {
1786         fixup_uidnode ( uidnode, signode, keytimestamp );
1787         pk->is_valid = 1;
1788     }
1789
1790     /* If the key isn't valid yet, and we have
1791        --allow-non-selfsigned-uid set, then force it valid. */
1792     if(!pk->is_valid && opt.allow_non_selfsigned_uid)
1793       {
1794         if(opt.verbose)
1795           log_info(_("Invalid key %s made valid by"
1796                      " --allow-non-selfsigned-uid\n"),keystr_from_pk(pk));
1797         pk->is_valid = 1;
1798       }
1799
1800     /* The key STILL isn't valid, so try and find an ultimately
1801        trusted signature. */
1802     if(!pk->is_valid)
1803       {
1804         uidnode=NULL;
1805
1806         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k=k->next)
1807           {
1808             if ( k->pkt->pkttype == PKT_USER_ID )
1809               uidnode = k;
1810             else if ( k->pkt->pkttype == PKT_SIGNATURE && uidnode )
1811               {
1812                 PKT_signature *sig = k->pkt->pkt.signature;
1813
1814                 if(sig->keyid[0] != kid[0] || sig->keyid[1]!=kid[1])
1815                   {
1816                     PKT_public_key *ultimate_pk;
1817
1818                     ultimate_pk=xmalloc_clear(sizeof(*ultimate_pk));
1819
1820                     /* We don't want to use the full get_pubkey to
1821                        avoid infinite recursion in certain cases.
1822                        There is no reason to check that an ultimately
1823                        trusted key is still valid - if it has been
1824                        revoked or the user should also renmove the
1825                        ultimate trust flag.  */
1826                     if(get_pubkey_fast(ultimate_pk,sig->keyid)==0
1827                        && check_key_signature2(keyblock,k,ultimate_pk,
1828                                                NULL,NULL,NULL,NULL)==0
1829                        && get_ownertrust(ultimate_pk)==TRUST_ULTIMATE)
1830                       {
1831                         free_public_key(ultimate_pk);
1832                         pk->is_valid=1;
1833                         break;
1834                       }
1835
1836                     free_public_key(ultimate_pk);
1837                   }
1838               }
1839           }
1840       }
1841
1842     /* Record the highest selfsig version so we know if this is a v3
1843        key through and through, or a v3 key with a v4 selfsig
1844        somewhere.  This is useful in a few places to know if the key
1845        must be treated as PGP2-style or OpenPGP-style.  Note that a
1846        selfsig revocation with a higher version number will also raise
1847        this value.  This is okay since such a revocation must be
1848        issued by the user (i.e. it cannot be issued by someone else to
1849        modify the key behavior.) */
1850
1851     pk->selfsigversion=sigversion;
1852
1853     /* Now that we had a look at all user IDs we can now get some information
1854      * from those user IDs.
1855      */
1856     
1857     if ( !key_usage ) {
1858         /* find the latest user ID with key flags set */
1859         uiddate = 0; /* helper to find the latest user ID */
1860         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1861             k = k->next ) {
1862             if ( k->pkt->pkttype == PKT_USER_ID ) {
1863                 PKT_user_id *uid = k->pkt->pkt.user_id;
1864                 if ( uid->help_key_usage && uid->created > uiddate ) {
1865                     key_usage = uid->help_key_usage;
1866                     uiddate = uid->created;
1867                 }
1868             }
1869         }
1870     }
1871     if ( !key_usage ) { /* no key flags at all: get it from the algo */
1872         key_usage = openpgp_pk_algo_usage ( pk->pubkey_algo );
1873     }
1874     else { /* check that the usage matches the usage as given by the algo */
1875         int x = openpgp_pk_algo_usage ( pk->pubkey_algo );
1876         if ( x ) /* mask it down to the actual allowed usage */
1877             key_usage &= x; 
1878     }
1879
1880     /* Whatever happens, it's a primary key, so it can certify. */
1881     pk->pubkey_usage = key_usage|PUBKEY_USAGE_CERT;
1882
1883     if ( !key_expire_seen ) {
1884         /* find the latest valid user ID with a key expiration set 
1885          * Note, that this may be a different one from the above because
1886          * some user IDs may have no expiration date set */
1887         uiddate = 0; 
1888         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1889             k = k->next ) {
1890             if ( k->pkt->pkttype == PKT_USER_ID ) {
1891                 PKT_user_id *uid = k->pkt->pkt.user_id;
1892                 if ( uid->help_key_expire && uid->created > uiddate ) {
1893                     key_expire = uid->help_key_expire;
1894                     uiddate = uid->created;
1895                 }
1896             }
1897         }
1898     }
1899
1900     /* Currently only v3 keys have a maximum expiration date, but I'll
1901        bet v5 keys get this feature again. */
1902     if(key_expire==0 || (pk->max_expiredate && key_expire>pk->max_expiredate))
1903       key_expire=pk->max_expiredate;
1904
1905     pk->has_expired = key_expire >= curtime? 0 : key_expire;
1906     pk->expiredate = key_expire;
1907
1908     /* Fixme: we should see how to get rid of the expiretime fields  but
1909      * this needs changes at other places too. */
1910
1911     /* and now find the real primary user ID and delete all others */
1912     uiddate = uiddate2 = 0;
1913     uidnode = uidnode2 = NULL;
1914     for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next ) {
1915         if ( k->pkt->pkttype == PKT_USER_ID &&
1916              !k->pkt->pkt.user_id->attrib_data) {
1917             PKT_user_id *uid = k->pkt->pkt.user_id;
1918             if (uid->is_primary)
1919               {
1920                 if(uid->created > uiddate)
1921                   {
1922                     uiddate = uid->created;
1923                     uidnode = k;
1924                   }
1925                 else if(uid->created==uiddate && uidnode)
1926                   {
1927                     /* The dates are equal, so we need to do a
1928                        different (and arbitrary) comparison.  This
1929                        should rarely, if ever, happen.  It's good to
1930                        try and guarantee that two different GnuPG
1931                        users with two different keyrings at least pick
1932                        the same primary. */
1933                     if(cmp_user_ids(uid,uidnode->pkt->pkt.user_id)>0)
1934                       uidnode=k;
1935                   }
1936               }
1937             else
1938               {
1939                 if(uid->created > uiddate2)
1940                   {
1941                     uiddate2 = uid->created;
1942                     uidnode2 = k;
1943                   }
1944                 else if(uid->created==uiddate2 && uidnode2)
1945                   {
1946                     if(cmp_user_ids(uid,uidnode2->pkt->pkt.user_id)>0)
1947                       uidnode2=k;
1948                   }
1949               }
1950         }
1951     }
1952     if ( uidnode ) {
1953         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1954             k = k->next ) {
1955             if ( k->pkt->pkttype == PKT_USER_ID &&
1956                  !k->pkt->pkt.user_id->attrib_data) {
1957                 PKT_user_id *uid = k->pkt->pkt.user_id;
1958                 if ( k != uidnode ) 
1959                     uid->is_primary = 0;
1960             }
1961         }
1962     }
1963     else if( uidnode2 ) {
1964         /* none is flagged primary - use the latest user ID we have,
1965            and disambiguate with the arbitrary packet comparison. */
1966         uidnode2->pkt->pkt.user_id->is_primary = 1;
1967     }
1968     else
1969       {
1970         /* None of our uids were self-signed, so pick the one that
1971            sorts first to be the primary.  This is the best we can do
1972            here since there are no self sigs to date the uids. */
1973
1974         uidnode = NULL;
1975
1976         for(k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1977             k = k->next )
1978           {
1979             if(k->pkt->pkttype==PKT_USER_ID
1980                && !k->pkt->pkt.user_id->attrib_data)
1981               {
1982                 if(!uidnode)
1983                   {
1984                     uidnode=k;
1985                     uidnode->pkt->pkt.user_id->is_primary=1;
1986                     continue;
1987                   }
1988                 else
1989                   {
1990                     if(cmp_user_ids(k->pkt->pkt.user_id,
1991                                     uidnode->pkt->pkt.user_id)>0)
1992                       {
1993                         uidnode->pkt->pkt.user_id->is_primary=0;
1994                         uidnode=k;
1995                         uidnode->pkt->pkt.user_id->is_primary=1;
1996                       }
1997                     else
1998                       k->pkt->pkt.user_id->is_primary=0; /* just to be
1999                                                             safe */
2000                   }
2001               }
2002           }
2003       }
2004 }
2005
2006
2007 static void
2008 merge_selfsigs_subkey( KBNODE keyblock, KBNODE subnode )
2009 {
2010     PKT_public_key *mainpk = NULL, *subpk = NULL;
2011     PKT_signature *sig;
2012     KBNODE k;
2013     u32 mainkid[2];
2014     u32 sigdate = 0;
2015     KBNODE signode;
2016     u32 curtime = make_timestamp ();
2017     unsigned int key_usage = 0;
2018     u32 keytimestamp = 0;
2019     u32 key_expire = 0;
2020     const byte *p;
2021
2022     if ( subnode->pkt->pkttype != PKT_PUBLIC_SUBKEY )
2023         BUG ();
2024     mainpk = keyblock->pkt->pkt.public_key;
2025     if ( mainpk->version < 4 )
2026         return; /* (actually this should never happen) */
2027     keyid_from_pk( mainpk, mainkid );
2028     subpk = subnode->pkt->pkt.public_key;
2029     keytimestamp = subpk->timestamp;
2030
2031     subpk->is_valid = 0;
2032     subpk->main_keyid[0] = mainpk->main_keyid[0];
2033     subpk->main_keyid[1] = mainpk->main_keyid[1];
2034
2035     /* find the latest key binding self-signature. */
2036     signode = NULL;
2037     sigdate = 0; /* helper to find the latest signature */
2038     for(k=subnode->next; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
2039                                                         k = k->next ) {
2040         if ( k->pkt->pkttype == PKT_SIGNATURE ) {
2041             sig = k->pkt->pkt.signature;
2042             if ( sig->keyid[0] == mainkid[0] && sig->keyid[1]==mainkid[1] ) { 
2043                 if ( check_key_signature( keyblock, k, NULL ) )
2044                     ; /* signature did not verify */
2045                 else if ( IS_SUBKEY_REV (sig) ) {
2046                   /* Note that this means that the date on a
2047                      revocation sig does not matter - even if the
2048                      binding sig is dated after the revocation sig,
2049                      the subkey is still marked as revoked.  This
2050                      seems ok, as it is just as easy to make new
2051                      subkeys rather than re-sign old ones as the
2052                      problem is in the distribution.  Plus, PGP (7)
2053                      does this the same way.  */
2054                     subpk->is_revoked = 1;
2055                     sig_to_revoke_info(sig,&subpk->revoked);
2056                     /* although we could stop now, we continue to 
2057                      * figure out other information like the old expiration
2058                      * time */
2059                 }
2060                 else if ( IS_SUBKEY_SIG (sig) && sig->timestamp >= sigdate )
2061                   {
2062                     if(sig->flags.expired)
2063                       ; /* signature has expired - ignore it */
2064                     else
2065                       {
2066                         sigdate = sig->timestamp;
2067                         signode = k;
2068                         signode->pkt->pkt.signature->flags.chosen_selfsig=0;
2069                       }
2070                   }
2071             }
2072         }
2073     }
2074
2075     /* no valid key binding */
2076     if ( !signode )
2077       return;
2078
2079     sig = signode->pkt->pkt.signature;
2080     sig->flags.chosen_selfsig=1; /* so we know which selfsig we chose later */
2081
2082     key_usage=parse_key_usage(sig);
2083     if ( !key_usage )
2084       {
2085         /* no key flags at all: get it from the algo */
2086         key_usage = openpgp_pk_algo_usage ( subpk->pubkey_algo );
2087       }
2088     else
2089       {
2090         /* check that the usage matches the usage as given by the algo */
2091         int x = openpgp_pk_algo_usage ( subpk->pubkey_algo );
2092         if ( x ) /* mask it down to the actual allowed usage */
2093           key_usage &= x; 
2094       }
2095
2096     subpk->pubkey_usage = key_usage;
2097     
2098     p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
2099     if ( p ) 
2100         key_expire = keytimestamp + buffer_to_u32(p);
2101     else
2102         key_expire = 0;
2103     subpk->has_expired = key_expire >= curtime? 0 : key_expire;
2104     subpk->expiredate = key_expire;
2105
2106     /* algo doesn't exist */
2107     if(check_pubkey_algo(subpk->pubkey_algo))
2108       return;
2109
2110     subpk->is_valid = 1;
2111
2112     /* Find the first 0x19 embedded signature on our self-sig. */
2113     if(subpk->backsig==0)
2114       {
2115         int seq=0;
2116         size_t n;
2117
2118         /* We do this while() since there may be other embedded
2119            signatures in the future.  We only want 0x19 here. */
2120         while((p=enum_sig_subpkt(sig->hashed,
2121                                  SIGSUBPKT_SIGNATURE,&n,&seq,NULL)))
2122           if(n>3 && ((p[0]==3 && p[2]==0x19) || (p[0]==4 && p[1]==0x19)))
2123             break;
2124
2125         if(p==NULL)
2126           {
2127             seq=0;
2128             /* It is safe to have this in the unhashed area since the
2129                0x19 is located on the selfsig for convenience, not
2130                security. */
2131             while((p=enum_sig_subpkt(sig->unhashed,SIGSUBPKT_SIGNATURE,
2132                                      &n,&seq,NULL)))
2133               if(n>3 && ((p[0]==3 && p[2]==0x19) || (p[0]==4 && p[1]==0x19)))
2134                 break;
2135           }
2136
2137         if(p)
2138           {
2139             PKT_signature *backsig=xmalloc_clear(sizeof(PKT_signature));
2140             IOBUF backsig_buf=iobuf_temp_with_content(p,n);
2141
2142             if(parse_signature(backsig_buf,PKT_SIGNATURE,n,backsig)==0)
2143               {
2144                 if(check_backsig(mainpk,subpk,backsig)==0)
2145                   subpk->backsig=2;
2146                 else
2147                   subpk->backsig=1;
2148               }
2149
2150             iobuf_close(backsig_buf);
2151             free_seckey_enc(backsig);
2152           }
2153       }
2154 }
2155
2156
2157 /* 
2158  * Merge information from the self-signatures with the key, so that
2159  * we can later use them more easy.
2160  * The function works by first applying the self signatures to the
2161  * primary key and the to each subkey.
2162  * Here are the rules we use to decide which inormation from which
2163  * self-signature is used:
2164  * We check all self signatures or validity and ignore all invalid signatures.
2165  * All signatures are then ordered by their creation date ....
2166  * For the primary key:
2167  *   FIXME the docs    
2168  */
2169 static void
2170 merge_selfsigs( KBNODE keyblock )
2171 {
2172     KBNODE k;
2173     int revoked;
2174     struct revoke_info rinfo;
2175     PKT_public_key *main_pk;
2176     prefitem_t *prefs;
2177     int mdc_feature;
2178
2179     if ( keyblock->pkt->pkttype != PKT_PUBLIC_KEY ) {
2180         if (keyblock->pkt->pkttype == PKT_SECRET_KEY ) {
2181             log_error ("expected public key but found secret key "
2182                        "- must stop\n");
2183             /* we better exit here becuase a public key is expected at
2184                other places too.  FIXME: Figure this out earlier and
2185                don't get to here at all */
2186             g10_exit (1);
2187         }
2188         BUG ();
2189     }
2190
2191     merge_selfsigs_main ( keyblock, &revoked, &rinfo );
2192
2193     /* now merge in the data from each of the subkeys */
2194     for(k=keyblock; k; k = k->next ) {
2195         if (  k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
2196             merge_selfsigs_subkey ( keyblock, k );
2197         }
2198     }
2199
2200     main_pk = keyblock->pkt->pkt.public_key;
2201     if ( revoked || main_pk->has_expired || !main_pk->is_valid ) {
2202         /* if the primary key is revoked, expired, or invalid we
2203          * better set the appropriate flags on that key and all
2204          * subkeys */
2205         for(k=keyblock; k; k = k->next ) {
2206             if ( k->pkt->pkttype == PKT_PUBLIC_KEY
2207                 || k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
2208                 PKT_public_key *pk = k->pkt->pkt.public_key;
2209                 if(!main_pk->is_valid)
2210                   pk->is_valid = 0;
2211                 if(revoked && !pk->is_revoked)
2212                   {
2213                     pk->is_revoked = revoked;
2214                     memcpy(&pk->revoked,&rinfo,sizeof(rinfo));
2215                   }
2216                 if(main_pk->has_expired)
2217                   pk->has_expired = main_pk->has_expired;
2218             }
2219         }
2220         return;
2221     }
2222
2223     /* set the preference list of all keys to those of the primary real
2224      * user ID.  Note: we use these preferences when we don't know by
2225      * which user ID the key has been selected.
2226      * fixme: we should keep atoms of commonly used preferences or
2227      * use reference counting to optimize the preference lists storage.
2228      * FIXME: it might be better to use the intersection of 
2229      * all preferences.
2230      * Do a similar thing for the MDC feature flag.
2231      */
2232     prefs = NULL;
2233     mdc_feature = 0;
2234     for (k=keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next) {
2235         if (k->pkt->pkttype == PKT_USER_ID
2236             && !k->pkt->pkt.user_id->attrib_data
2237             && k->pkt->pkt.user_id->is_primary) {
2238             prefs = k->pkt->pkt.user_id->prefs;
2239             mdc_feature = k->pkt->pkt.user_id->flags.mdc;
2240             break;
2241         }
2242     }    
2243     for(k=keyblock; k; k = k->next ) {
2244         if ( k->pkt->pkttype == PKT_PUBLIC_KEY
2245              || k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
2246             PKT_public_key *pk = k->pkt->pkt.public_key;
2247             if (pk->prefs)
2248                 xfree (pk->prefs);
2249             pk->prefs = copy_prefs (prefs);
2250             pk->mdc_feature = mdc_feature;
2251         }
2252     }
2253 }
2254
2255
2256 /*
2257  * Merge the secret keys from secblock into the pubblock thereby
2258  * replacing the public (sub)keys with their secret counterparts Hmmm:
2259  * It might be better to get away from the concept of entire secret
2260  * keys at all and have a way to store just the real secret parts
2261  * from the key.
2262  */
2263 static void
2264 merge_public_with_secret ( KBNODE pubblock, KBNODE secblock )
2265 {
2266     KBNODE pub;
2267
2268     assert ( pubblock->pkt->pkttype == PKT_PUBLIC_KEY );
2269     assert ( secblock->pkt->pkttype == PKT_SECRET_KEY );
2270     
2271     for (pub=pubblock; pub; pub = pub->next ) {
2272         if ( pub->pkt->pkttype == PKT_PUBLIC_KEY ) {
2273              PKT_public_key *pk = pub->pkt->pkt.public_key;
2274              PKT_secret_key *sk = secblock->pkt->pkt.secret_key;
2275              assert ( pub == pubblock ); /* only in the first node */
2276              /* there is nothing to compare in this case, so just replace
2277               * some information */
2278              copy_public_parts_to_secret_key ( pk, sk );
2279              free_public_key ( pk );
2280              pub->pkt->pkttype = PKT_SECRET_KEY;
2281              pub->pkt->pkt.secret_key = copy_secret_key (NULL, sk);
2282         }
2283         else if ( pub->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
2284             KBNODE sec;
2285             PKT_public_key *pk = pub->pkt->pkt.public_key;
2286
2287             /* this is more complicated: it may happen that the sequence
2288              * of the subkeys dosn't match, so we have to find the
2289              * appropriate secret key */
2290             for (sec=secblock->next; sec; sec = sec->next ) {
2291                 if ( sec->pkt->pkttype == PKT_SECRET_SUBKEY ) {
2292                     PKT_secret_key *sk = sec->pkt->pkt.secret_key;
2293                     if ( !cmp_public_secret_key ( pk, sk ) ) {
2294                         copy_public_parts_to_secret_key ( pk, sk );
2295                         free_public_key ( pk );
2296                         pub->pkt->pkttype = PKT_SECRET_SUBKEY;
2297                         pub->pkt->pkt.secret_key = copy_secret_key (NULL, sk);
2298                         break;
2299                     }
2300                 }
2301             }
2302             if ( !sec ) 
2303                 BUG(); /* already checked in premerge */
2304         }
2305     }
2306 }
2307
2308 /* This function checks that for every public subkey a corresponding
2309  * secret subkey is available and deletes the public subkey otherwise.
2310  * We need this function because we can't delete it later when we
2311  * actually merge the secret parts into the pubring.
2312  * The function also plays some games with the node flags.
2313  */
2314 static void
2315 premerge_public_with_secret ( KBNODE pubblock, KBNODE secblock )
2316 {
2317     KBNODE last, pub;
2318
2319     assert ( pubblock->pkt->pkttype == PKT_PUBLIC_KEY );
2320     assert ( secblock->pkt->pkttype == PKT_SECRET_KEY );
2321     
2322     for (pub=pubblock,last=NULL; pub; last = pub, pub = pub->next ) {
2323         pub->flag &= ~3; /* reset bits 0 and 1 */
2324         if ( pub->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
2325             KBNODE sec;
2326             PKT_public_key *pk = pub->pkt->pkt.public_key;
2327
2328             for (sec=secblock->next; sec; sec = sec->next ) {
2329                 if ( sec->pkt->pkttype == PKT_SECRET_SUBKEY ) {
2330                     PKT_secret_key *sk = sec->pkt->pkt.secret_key;
2331                     if ( !cmp_public_secret_key ( pk, sk ) ) {
2332                         if ( sk->protect.s2k.mode == 1001 ) {
2333                             /* The secret parts are not available so
2334                                we can't use that key for signing etc.
2335                                Fix the pubkey usage */
2336                             pk->pubkey_usage &= ~(PUBKEY_USAGE_SIG
2337                                                   |PUBKEY_USAGE_AUTH);
2338                         }
2339                         /* transfer flag bits 0 and 1 to the pubblock */
2340                         pub->flag |= (sec->flag &3);
2341                         break;
2342                     }
2343                 }
2344             }
2345             if ( !sec ) {
2346                 KBNODE next, ll;
2347
2348                 if (opt.verbose)
2349                   log_info (_("no secret subkey"
2350                               " for public subkey %s - ignoring\n"),  
2351                             keystr_from_pk (pk));
2352                 /* we have to remove the subkey in this case */
2353                 assert ( last );
2354                 /* find the next subkey */
2355                 for (next=pub->next,ll=pub;
2356                      next && next->pkt->pkttype != PKT_PUBLIC_SUBKEY;
2357                      ll = next, next = next->next ) 
2358                     ;
2359                 /* make new link */
2360                 last->next = next;
2361                 /* release this public subkey with all sigs */
2362                 ll->next = NULL;
2363                 release_kbnode( pub );
2364                 /* let the loop continue */
2365                 pub = last;
2366             }
2367         }
2368     }
2369     /* We need to copy the found bits (0 and 1) from the secret key to
2370        the public key.  This has already been done for the subkeys but
2371        got lost on the primary key - fix it here *. */
2372     pubblock->flag |= (secblock->flag & 3);
2373 }
2374
2375
2376
2377 \f
2378 /* See see whether the key fits
2379  * our requirements and in case we do not
2380  * request the primary key, we should select
2381  * a suitable subkey.
2382  * FIXME: Check against PGP 7 whether we still need a kludge
2383  *        to favor type 16 keys over type 20 keys when type 20
2384  *        has not been explitely requested.
2385  * Returns: True when a suitable key has been found.
2386  *
2387  * We have to distinguish four cases:  FIXME!
2388  *  1. No usage and no primary key requested
2389  *     Examples for this case are that we have a keyID to be used
2390  *     for decrytion or verification.
2391  *  2. No usage but primary key requested
2392  *     This is the case for all functions which work on an
2393  *     entire keyblock, e.g. for editing or listing
2394  *  3. Usage and primary key requested
2395  *     FXME
2396  *  4. Usage but no primary key requested
2397  *     FIXME
2398  * FIXME: Tell what is going to happen here and something about the rationale
2399  * Note: We don't use this function if no specific usage is requested;
2400  *       This way the getkey functions can be used for plain key listings.
2401  *
2402  * CTX ist the keyblock we are investigating, if FOUNDK is not NULL this
2403  * is the key we actually found by looking at the keyid or a fingerprint and
2404  * may eitehr point to the primary or one of the subkeys.
2405  */
2406
2407 static int
2408 finish_lookup (GETKEY_CTX ctx)
2409 {
2410     KBNODE keyblock = ctx->keyblock;
2411     KBNODE k;
2412     KBNODE foundk = NULL;
2413     PKT_user_id *foundu = NULL;
2414 #define USAGE_MASK  (PUBKEY_USAGE_SIG|PUBKEY_USAGE_ENC|PUBKEY_USAGE_CERT)
2415     unsigned int req_usage = ( ctx->req_usage & USAGE_MASK );
2416     /* Request the primary if we're certifying another key, and also
2417        if signing data while --pgp6 or --pgp7 is on since pgp 6 and 7
2418        do not understand signatures made by a signing subkey.  PGP 8
2419        does. */
2420     int req_prim = (ctx->req_usage & PUBKEY_USAGE_CERT) ||
2421       ((PGP6 || PGP7) && (ctx->req_usage & PUBKEY_USAGE_SIG));
2422     u32 latest_date;
2423     KBNODE latest_key;
2424     u32 curtime = make_timestamp ();
2425
2426     assert( keyblock->pkt->pkttype == PKT_PUBLIC_KEY );
2427    
2428     ctx->found_key = NULL;
2429
2430     if (ctx->exact) {
2431         for (k=keyblock; k; k = k->next) {
2432             if ( (k->flag & 1) ) {
2433                 assert ( k->pkt->pkttype == PKT_PUBLIC_KEY
2434                          || k->pkt->pkttype == PKT_PUBLIC_SUBKEY );
2435                 foundk = k;
2436                 break;
2437             }
2438         }
2439     }
2440
2441     for (k=keyblock; k; k = k->next) {
2442         if ( (k->flag & 2) ) {
2443             assert (k->pkt->pkttype == PKT_USER_ID);
2444             foundu = k->pkt->pkt.user_id;
2445             break;
2446         }
2447     }
2448
2449     if ( DBG_CACHE )
2450         log_debug( "finish_lookup: checking key %08lX (%s)(req_usage=%x)\n",
2451                    (ulong)keyid_from_pk( keyblock->pkt->pkt.public_key, NULL),
2452                    foundk? "one":"all", req_usage);
2453
2454     if (!req_usage) {
2455         latest_key = foundk? foundk:keyblock;
2456         goto found;
2457     }
2458     
2459     if (!req_usage) {
2460         PKT_public_key *pk = foundk->pkt->pkt.public_key;
2461         if (pk->user_id)
2462             free_user_id (pk->user_id);
2463         pk->user_id = scopy_user_id (foundu);
2464         ctx->found_key = foundk;
2465         cache_user_id( keyblock );
2466         return 1; /* found */
2467     }
2468     
2469     latest_date = 0;
2470     latest_key  = NULL;
2471     /* do not look at subkeys if a certification key is requested */
2472     if ((!foundk || foundk->pkt->pkttype == PKT_PUBLIC_SUBKEY) && !req_prim) {
2473         KBNODE nextk;
2474         /* either start a loop or check just this one subkey */
2475         for (k=foundk?foundk:keyblock; k; k = nextk ) {
2476             PKT_public_key *pk;
2477             nextk = k->next;
2478             if ( k->pkt->pkttype != PKT_PUBLIC_SUBKEY )
2479                 continue;
2480             if ( foundk )
2481                 nextk = NULL;  /* what a hack */
2482             pk = k->pkt->pkt.public_key;
2483             if (DBG_CACHE)
2484                 log_debug( "\tchecking subkey %08lX\n",
2485                            (ulong)keyid_from_pk( pk, NULL));
2486             if ( !pk->is_valid ) {
2487                 if (DBG_CACHE)
2488                     log_debug( "\tsubkey not valid\n");
2489                 continue;
2490             }
2491             if ( pk->is_revoked ) {
2492                 if (DBG_CACHE)
2493                     log_debug( "\tsubkey has been revoked\n");
2494                 continue;
2495             }
2496             if ( pk->has_expired ) {
2497                 if (DBG_CACHE)
2498                     log_debug( "\tsubkey has expired\n");
2499                 continue;
2500             }
2501             if ( pk->timestamp > curtime && !opt.ignore_valid_from ) {
2502                 if (DBG_CACHE)
2503                     log_debug( "\tsubkey not yet valid\n");
2504                 continue;
2505             }
2506             
2507             if ( !((pk->pubkey_usage&USAGE_MASK) & req_usage) ) {
2508                 if (DBG_CACHE)
2509                     log_debug( "\tusage does not match: want=%x have=%x\n",
2510                                req_usage, pk->pubkey_usage );
2511                 continue;
2512             }
2513
2514             if (DBG_CACHE)
2515                 log_debug( "\tsubkey looks fine\n");
2516             if ( pk->timestamp > latest_date ) {
2517                 latest_date = pk->timestamp;
2518                 latest_key  = k;
2519             }
2520         }
2521     }
2522
2523     /* Okay now try the primary key unless we want an exact 
2524      * key ID match on a subkey */
2525     if ((!latest_key && !(ctx->exact && foundk != keyblock)) || req_prim) {
2526         PKT_public_key *pk;
2527         if (DBG_CACHE && !foundk && !req_prim )
2528             log_debug( "\tno suitable subkeys found - trying primary\n");
2529         pk = keyblock->pkt->pkt.public_key;
2530         if ( !pk->is_valid ) {
2531             if (DBG_CACHE)
2532                 log_debug( "\tprimary key not valid\n");
2533         }
2534         else if ( pk->is_revoked ) {
2535             if (DBG_CACHE)
2536                 log_debug( "\tprimary key has been revoked\n");
2537         }
2538         else if ( pk->has_expired ) {
2539             if (DBG_CACHE)
2540                 log_debug( "\tprimary key has expired\n");
2541         }
2542         else  if ( !((pk->pubkey_usage&USAGE_MASK) & req_usage) ) {
2543             if (DBG_CACHE)
2544                 log_debug( "\tprimary key usage does not match: "
2545                            "want=%x have=%x\n",
2546                            req_usage, pk->pubkey_usage );
2547         }
2548         else { /* okay */
2549             if (DBG_CACHE)
2550                 log_debug( "\tprimary key may be used\n");
2551             latest_key = keyblock;
2552             latest_date = pk->timestamp;
2553         }
2554     }
2555     
2556     if ( !latest_key ) {
2557         if (DBG_CACHE)
2558             log_debug("\tno suitable key found -  giving up\n");
2559         return 0;
2560     }
2561
2562  found:
2563     if (DBG_CACHE)
2564         log_debug( "\tusing key %08lX\n",
2565                 (ulong)keyid_from_pk( latest_key->pkt->pkt.public_key, NULL) );
2566
2567     if (latest_key) {
2568         PKT_public_key *pk = latest_key->pkt->pkt.public_key;
2569         if (pk->user_id)
2570             free_user_id (pk->user_id);
2571         pk->user_id = scopy_user_id (foundu);
2572     }    
2573         
2574     ctx->found_key = latest_key;
2575
2576     if (latest_key != keyblock && opt.verbose)
2577       {
2578         char *tempkeystr=
2579           xstrdup(keystr_from_pk(latest_key->pkt->pkt.public_key));
2580         log_info(_("using subkey %s instead of primary key %s\n"),
2581                  tempkeystr, keystr_from_pk(keyblock->pkt->pkt.public_key));
2582         xfree(tempkeystr);
2583       }
2584
2585     cache_user_id( keyblock );
2586     
2587     return 1; /* found */
2588 }
2589
2590
2591 static int
2592 lookup( GETKEY_CTX ctx, KBNODE *ret_keyblock, int secmode )
2593 {
2594     int rc;
2595     KBNODE secblock = NULL; /* helper */
2596     int no_suitable_key = 0;
2597     
2598     rc = 0;
2599     while (!(rc = keydb_search (ctx->kr_handle, ctx->items, ctx->nitems))) {
2600         /* If we are searching for the first key we have to make sure
2601            that the next interation does not no an implicit reset.
2602            This can be triggered by an empty key ring. */
2603         if (ctx->nitems && ctx->items->mode == KEYDB_SEARCH_MODE_FIRST)
2604             ctx->items->mode = KEYDB_SEARCH_MODE_NEXT;
2605
2606         rc = keydb_get_keyblock (ctx->kr_handle, &ctx->keyblock);
2607         if (rc) {
2608             log_error ("keydb_get_keyblock failed: %s\n", g10_errstr(rc));
2609             rc = 0;
2610             goto skip;
2611         }
2612                        
2613         if ( secmode ) {
2614             /* find the correspondig public key and use this 
2615              * this one for the selection process */
2616             u32 aki[2];
2617             KBNODE k = ctx->keyblock;
2618             
2619             if (k->pkt->pkttype != PKT_SECRET_KEY)
2620                 BUG();
2621
2622             keyid_from_sk (k->pkt->pkt.secret_key, aki);
2623             k = get_pubkeyblock (aki);
2624             if( !k )
2625               {
2626                 if (!opt.quiet)
2627                   log_info(_("key %s: secret key without public key"
2628                              " - skipped\n"), keystr(aki));
2629                 goto skip;
2630               }
2631             secblock = ctx->keyblock;
2632             ctx->keyblock = k;
2633
2634             premerge_public_with_secret ( ctx->keyblock, secblock );
2635         }
2636
2637         /* warning: node flag bits 0 and 1 should be preserved by
2638          * merge_selfsigs.  For secret keys, premerge did tranfer the
2639          * keys to the keyblock */
2640         merge_selfsigs ( ctx->keyblock );
2641         if ( finish_lookup (ctx) ) {
2642             no_suitable_key = 0;
2643             if ( secmode ) {
2644                 merge_public_with_secret ( ctx->keyblock,
2645                                            secblock);
2646                 release_kbnode (secblock);
2647                 secblock = NULL;
2648             }
2649             goto found;
2650         }
2651         else
2652             no_suitable_key = 1;
2653         
2654       skip:
2655         /* release resources and continue search */
2656         if ( secmode ) {
2657             release_kbnode( secblock );
2658             secblock = NULL;
2659         }
2660         release_kbnode( ctx->keyblock );
2661         ctx->keyblock = NULL;
2662     }
2663
2664   found:
2665     if( rc && rc != -1 )
2666         log_error("keydb_search failed: %s\n", g10_errstr(rc));
2667
2668     if( !rc ) {
2669         *ret_keyblock = ctx->keyblock; /* return the keyblock */
2670         ctx->keyblock = NULL;
2671     }
2672     else if (rc == -1 && no_suitable_key)
2673         rc = secmode ? G10ERR_UNU_SECKEY : G10ERR_UNU_PUBKEY;
2674     else if( rc == -1 )
2675         rc = secmode ? G10ERR_NO_SECKEY : G10ERR_NO_PUBKEY;
2676
2677     if ( secmode ) {
2678         release_kbnode( secblock );
2679         secblock = NULL;
2680     }
2681     release_kbnode( ctx->keyblock );
2682     ctx->keyblock = NULL;
2683
2684     ctx->last_rc = rc;
2685     return rc;
2686 }
2687
2688
2689
2690
2691 /****************
2692  * FIXME: Replace by the generic function 
2693  *        It does not work as it is right now - it is used at 
2694  *        2 places:  a) to get the key for an anonyous recipient
2695  *                   b) to get the ultimately trusted keys.
2696  *        The a) usage might have some problems.
2697  *
2698  * set with_subkeys true to include subkeys
2699  * set with_spm true to include secret-parts-missing keys
2700  *
2701  * Enumerate all primary secret keys.  Caller must use these procedure:
2702  *  1) create a void pointer and initialize it to NULL
2703  *  2) pass this void pointer by reference to this function
2704  *     and provide space for the secret key (pass a buffer for sk)
2705  *  3) call this function as long as it does not return -1
2706  *     to indicate EOF.
2707  *  4) Always call this function a last time with SK set to NULL,
2708  *     so that can free it's context.
2709  */
2710 int
2711 enum_secret_keys( void **context, PKT_secret_key *sk,
2712                   int with_subkeys, int with_spm )
2713 {
2714     int rc=0;
2715     struct {
2716         int eof;
2717         int first;
2718         KEYDB_HANDLE hd;
2719         KBNODE keyblock;
2720         KBNODE node;
2721     } *c = *context;
2722
2723
2724     if( !c ) { /* make a new context */
2725         c = xmalloc_clear( sizeof *c );
2726         *context = c;
2727         c->hd = keydb_new (1);
2728         c->first = 1;
2729         c->keyblock = NULL;
2730         c->node = NULL;
2731     }
2732
2733     if( !sk ) { /* free the context */
2734         keydb_release (c->hd);
2735         release_kbnode (c->keyblock);
2736         xfree( c );
2737         *context = NULL;
2738         return 0;
2739     }
2740
2741     if( c->eof )
2742         return -1;
2743
2744     do {
2745         /* get the next secret key from the current keyblock */
2746         for (; c->node; c->node = c->node->next) {
2747             if ((c->node->pkt->pkttype == PKT_SECRET_KEY
2748                 || (with_subkeys
2749                     && c->node->pkt->pkttype == PKT_SECRET_SUBKEY) )
2750                 && !(c->node->pkt->pkt.secret_key->protect.s2k.mode==1001
2751                      && !with_spm)) {
2752                 copy_secret_key (sk, c->node->pkt->pkt.secret_key );
2753                 c->node = c->node->next;
2754                 return 0; /* found */
2755             }
2756         }
2757         release_kbnode (c->keyblock);
2758         c->keyblock = c->node = NULL;
2759         
2760         rc = c->first? keydb_search_first (c->hd) : keydb_search_next (c->hd);
2761         c->first = 0;
2762         if (rc) {
2763             keydb_release (c->hd); c->hd = NULL;
2764             c->eof = 1;
2765             return -1; /* eof */
2766         }
2767         
2768         rc = keydb_get_keyblock (c->hd, &c->keyblock);
2769         c->node = c->keyblock;
2770     } while (!rc);
2771
2772     return rc; /* error */
2773 }
2774
2775
2776 \f
2777 /*********************************************
2778  ***********  user ID printing helpers *******
2779  *********************************************/
2780
2781 /****************
2782  * Return a string with a printable representation of the user_id.
2783  * this string must be freed by xfree.
2784  */
2785 char*
2786 get_user_id_string( u32 *keyid )
2787 {
2788   user_id_db_t r;
2789   char *p;
2790   int pass=0;
2791   /* try it two times; second pass reads from key resources */
2792   do
2793     {
2794       for(r=user_id_db; r; r = r->next )
2795         {
2796           keyid_list_t a;
2797           for (a=r->keyids; a; a= a->next )
2798             {
2799               if( a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1] )
2800                 {
2801                   p = xmalloc( keystrlen() + 1 + r->len + 1 );
2802                   sprintf(p, "%s %.*s", keystr(keyid), r->len, r->name );
2803                   return p;
2804                 }
2805             }
2806         }
2807     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
2808   p = xmalloc( keystrlen() + 5 );
2809   sprintf(p, "%s [?]", keystr(keyid));
2810   return p;
2811 }
2812
2813
2814 char*
2815 get_user_id_string_native ( u32 *keyid )
2816 {
2817   char *p = get_user_id_string( keyid );
2818   char *p2 = utf8_to_native( p, strlen(p), 0 );
2819   xfree(p);
2820   return p2;
2821 }
2822
2823
2824 char*
2825 get_long_user_id_string( u32 *keyid )
2826 {
2827     user_id_db_t r;
2828     char *p;
2829     int pass=0;
2830     /* try it two times; second pass reads from key resources */
2831     do {
2832         for(r=user_id_db; r; r = r->next ) {
2833             keyid_list_t a;
2834             for (a=r->keyids; a; a= a->next ) {
2835                 if( a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1] ) {
2836                     p = xmalloc( r->len + 20 );
2837                     sprintf(p, "%08lX%08lX %.*s",
2838                             (ulong)keyid[0], (ulong)keyid[1],
2839                             r->len, r->name );
2840                     return p;
2841                 }
2842             }
2843         }
2844     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
2845     p = xmalloc( 25 );
2846     sprintf(p, "%08lX%08lX [?]", (ulong)keyid[0], (ulong)keyid[1] );
2847     return p;
2848 }
2849
2850 char*
2851 get_user_id( u32 *keyid, size_t *rn )
2852 {
2853     user_id_db_t r;
2854     char *p;
2855     int pass=0;
2856
2857     /* try it two times; second pass reads from key resources */
2858     do {
2859         for(r=user_id_db; r; r = r->next ) {
2860             keyid_list_t a;
2861             for (a=r->keyids; a; a= a->next ) {
2862                 if( a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1] ) {
2863                     p = xmalloc( r->len );
2864                     memcpy(p, r->name, r->len );
2865                     *rn = r->len;
2866                     return p;
2867                 }
2868             }
2869         }
2870     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
2871     p = xstrdup( _("[User ID not found]") );
2872     *rn = strlen(p);
2873     return p;
2874 }
2875
2876 char*
2877 get_user_id_native( u32 *keyid )
2878 {
2879   size_t rn;
2880   char *p = get_user_id( keyid, &rn );
2881   char *p2 = utf8_to_native( p, rn, 0 );
2882   xfree(p);
2883   return p2;
2884 }
2885
2886 KEYDB_HANDLE
2887 get_ctx_handle(GETKEY_CTX ctx)
2888 {
2889   return ctx->kr_handle;
2890 }
2891
2892 static void
2893 free_akl(struct akl *akl)
2894 {
2895   if(akl->spec)
2896     free_keyserver_spec(akl->spec);
2897
2898   xfree(akl);
2899 }
2900
2901 int
2902 parse_auto_key_locate(char *options)
2903 {
2904   char *tok;
2905
2906   while((tok=optsep(&options)))
2907     {
2908       struct akl *akl,*last;
2909
2910       if(tok[0]=='\0')
2911         continue;
2912
2913       akl=xmalloc_clear(sizeof(*akl));
2914
2915       if(ascii_strcasecmp(tok,"cert")==0)
2916         akl->type=AKL_CERT;
2917       else if(ascii_strcasecmp(tok,"pka")==0)
2918         akl->type=AKL_PKA;
2919       else if(ascii_strcasecmp(tok,"ldap")==0)
2920         akl->type=AKL_LDAP;
2921       else if(ascii_strcasecmp(tok,"keyserver")==0)
2922         akl->type=AKL_KEYSERVER;
2923       else if((akl->spec=parse_keyserver_uri(tok,1,NULL,0)))
2924         akl->type=AKL_SPEC;
2925       else
2926         {
2927           free_akl(akl);
2928           return 0;
2929         }
2930
2931       /* We must maintain the order the user gave us */
2932       for(last=opt.auto_key_locate;last && last->next;last=last->next)
2933         {
2934           /* Check for duplicates */
2935           if(last && last->type==akl->type
2936              && (akl->type!=AKL_SPEC
2937                  || (akl->type==AKL_SPEC
2938                      && strcmp(last->spec->uri,akl->spec->uri)==0)))
2939             {
2940               free_akl(akl);
2941               return 0;
2942             }
2943         }
2944
2945       if(last)
2946         last->next=akl;
2947       else
2948         opt.auto_key_locate=akl;
2949     }
2950
2951   return 1;
2952 }