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