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