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