g10: Fix crash.
[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, 2016 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 <https://www.gnu.org/licenses/>.
20  */
21
22 #include <config.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <ctype.h>
27
28 #include "gpg.h"
29 #include "util.h"
30 #include "packet.h"
31 #include "iobuf.h"
32 #include "keydb.h"
33 #include "options.h"
34 #include "main.h"
35 #include "trustdb.h"
36 #include "i18n.h"
37 #include "keyserver-internal.h"
38 #include "call-agent.h"
39 #include "host2net.h"
40 #include "mbox-util.h"
41 #include "status.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 /* Flags values returned by the lookup code.  Note that the values are
51  * directly used by the KEY_CONSIDERED status line.  */
52 #define LOOKUP_NOT_SELECTED        (1<<0)
53 #define LOOKUP_ALL_SUBKEYS_EXPIRED (1<<1)  /* or revoked */
54
55
56 /* A context object used by the lookup functions.  */
57 struct getkey_ctx_s
58 {
59   /* Part of the search criteria: whether the search is an exact
60      search or not.  A search that is exact requires that a key or
61      subkey meet all of the specified criteria.  A search that is not
62      exact allows selecting a different key or subkey from the
63      keyblock that matched the critera.  Further, an exact search
64      returns the key or subkey that matched whereas a non-exact search
65      typically returns the primary key.  See finish_lookup for
66      details.  */
67   int exact;
68
69   /* Part of the search criteria: Whether the caller only wants keys
70      with an available secret key.  This is used by getkey_next to get
71      the next result with the same initial criteria.  */
72   int want_secret;
73
74   /* Part of the search criteria: The type of the requested key.  A
75      mask of PUBKEY_USAGE_SIG, PUBKEY_USAGE_ENC and PUBKEY_USAGE_CERT.
76      If non-zero, then for a key to match, it must implement one of
77      the required uses.  */
78   int req_usage;
79
80   /* The database handle.  */
81   KEYDB_HANDLE kr_handle;
82
83   /* Whether we should call xfree() on the context when the context is
84      released using getkey_end()).  */
85   int not_allocated;
86
87   /* This variable is used as backing store for strings which have
88      their address used in ITEMS.  */
89   strlist_t extra_list;
90
91   /* Part of the search criteria: The low-level search specification
92      as passed to keydb_search.  */
93   int nitems;
94   /* This must be the last element in the structure.  When we allocate
95      the structure, we allocate it so that ITEMS can hold NITEMS.  */
96   KEYDB_SEARCH_DESC items[1];
97 };
98
99 #if 0
100 static struct
101 {
102   int any;
103   int okay_count;
104   int nokey_count;
105   int error_count;
106 } lkup_stats[21];
107 #endif
108
109 typedef struct keyid_list
110 {
111   struct keyid_list *next;
112   char fpr[MAX_FINGERPRINT_LEN];
113   u32 keyid[2];
114 } *keyid_list_t;
115
116
117 #if MAX_PK_CACHE_ENTRIES
118 typedef struct pk_cache_entry
119 {
120   struct pk_cache_entry *next;
121   u32 keyid[2];
122   PKT_public_key *pk;
123 } *pk_cache_entry_t;
124 static pk_cache_entry_t pk_cache;
125 static int pk_cache_entries;    /* Number of entries in pk cache.  */
126 static int pk_cache_disabled;
127 #endif
128
129 #if MAX_UID_CACHE_ENTRIES < 5
130 #error we really need the userid cache
131 #endif
132 typedef struct user_id_db
133 {
134   struct user_id_db *next;
135   keyid_list_t keyids;
136   int len;
137   char name[1];
138 } *user_id_db_t;
139 static user_id_db_t user_id_db;
140 static int uid_cache_entries;   /* Number of entries in uid cache. */
141
142 static void merge_selfsigs (kbnode_t keyblock);
143 static int lookup (getkey_ctx_t ctx,
144                    kbnode_t *ret_keyblock, kbnode_t *ret_found_key,
145                    int want_secret);
146 static kbnode_t finish_lookup (kbnode_t keyblock,
147                                unsigned int req_usage, int want_exact,
148                                unsigned int *r_flags);
149 static void print_status_key_considered (kbnode_t keyblock, unsigned int flags);
150
151
152 #if 0
153 static void
154 print_stats ()
155 {
156   int i;
157   for (i = 0; i < DIM (lkup_stats); i++)
158     {
159       if (lkup_stats[i].any)
160         es_fprintf (es_stderr,
161                  "lookup stats: mode=%-2d  ok=%-6d  nokey=%-6d  err=%-6d\n",
162                  i,
163                  lkup_stats[i].okay_count,
164                  lkup_stats[i].nokey_count, lkup_stats[i].error_count);
165     }
166 }
167 #endif
168
169
170 /* Cache a copy of a public key in the public key cache.  PK is not
171  * cached if caching is disabled (via getkey_disable_caches), if
172  * PK->FLAGS.DONT_CACHE is set, we don't know how to derive a key id
173  * from the public key (e.g., unsupported algorithm), or a key with
174  * the key id is already in the cache.
175  *
176  * The public key packet is copied into the cache using
177  * copy_public_key.  Thus, any secret parts are not copied, for
178  * instance.
179  *
180  * This cache is filled by get_pubkey and is read by get_pubkey and
181  * get_pubkey_fast.  */
182 void
183 cache_public_key (PKT_public_key * pk)
184 {
185 #if MAX_PK_CACHE_ENTRIES
186   pk_cache_entry_t ce, ce2;
187   u32 keyid[2];
188
189   if (pk_cache_disabled)
190     return;
191
192   if (pk->flags.dont_cache)
193     return;
194
195   if (is_ELGAMAL (pk->pubkey_algo)
196       || pk->pubkey_algo == PUBKEY_ALGO_DSA
197       || pk->pubkey_algo == PUBKEY_ALGO_ECDSA
198       || pk->pubkey_algo == PUBKEY_ALGO_EDDSA
199       || pk->pubkey_algo == PUBKEY_ALGO_ECDH
200       || is_RSA (pk->pubkey_algo))
201     {
202       keyid_from_pk (pk, keyid);
203     }
204   else
205     return; /* Don't know how to get the keyid.  */
206
207   for (ce = pk_cache; ce; ce = ce->next)
208     if (ce->keyid[0] == keyid[0] && ce->keyid[1] == keyid[1])
209       {
210         if (DBG_CACHE)
211           log_debug ("cache_public_key: already in cache\n");
212         return;
213       }
214
215   if (pk_cache_entries >= MAX_PK_CACHE_ENTRIES)
216     {
217       int n;
218
219       /* Remove the last 50% of the entries.  */
220       for (ce = pk_cache, n = 0; ce && n < pk_cache_entries/2; n++)
221         ce = ce->next;
222       if (ce && ce != pk_cache && ce->next)
223         {
224           ce2 = ce->next;
225           ce->next = NULL;
226           ce = ce2;
227           for (; ce; ce = ce2)
228             {
229               ce2 = ce->next;
230               free_public_key (ce->pk);
231               xfree (ce);
232               pk_cache_entries--;
233             }
234         }
235       log_assert (pk_cache_entries < MAX_PK_CACHE_ENTRIES);
236     }
237   pk_cache_entries++;
238   ce = xmalloc (sizeof *ce);
239   ce->next = pk_cache;
240   pk_cache = ce;
241   ce->pk = copy_public_key (NULL, pk);
242   ce->keyid[0] = keyid[0];
243   ce->keyid[1] = keyid[1];
244 #endif
245 }
246
247
248 /* Return a const utf-8 string with the text "[User ID not found]".
249    This function is required so that we don't need to switch gettext's
250    encoding temporary.  */
251 static const char *
252 user_id_not_found_utf8 (void)
253 {
254   static char *text;
255
256   if (!text)
257     text = native_to_utf8 (_("[User ID not found]"));
258   return text;
259 }
260
261
262
263 /* Return the user ID from the given keyblock.
264  * We use the primary uid flag which has been set by the merge_selfsigs
265  * function.  The returned value is only valid as long as the given
266  * keyblock is not changed.  */
267 static const char *
268 get_primary_uid (KBNODE keyblock, size_t * uidlen)
269 {
270   KBNODE k;
271   const char *s;
272
273   for (k = keyblock; k; k = k->next)
274     {
275       if (k->pkt->pkttype == PKT_USER_ID
276           && !k->pkt->pkt.user_id->attrib_data
277           && k->pkt->pkt.user_id->is_primary)
278         {
279           *uidlen = k->pkt->pkt.user_id->len;
280           return k->pkt->pkt.user_id->name;
281         }
282     }
283   s = user_id_not_found_utf8 ();
284   *uidlen = strlen (s);
285   return s;
286 }
287
288
289 static void
290 release_keyid_list (keyid_list_t k)
291 {
292   while (k)
293     {
294       keyid_list_t k2 = k->next;
295       xfree (k);
296       k = k2;
297     }
298 }
299
300 /****************
301  * Store the association of keyid and userid
302  * Feed only public keys to this function.
303  */
304 static void
305 cache_user_id (KBNODE keyblock)
306 {
307   user_id_db_t r;
308   const char *uid;
309   size_t uidlen;
310   keyid_list_t keyids = NULL;
311   KBNODE k;
312
313   for (k = keyblock; k; k = k->next)
314     {
315       if (k->pkt->pkttype == PKT_PUBLIC_KEY
316           || k->pkt->pkttype == PKT_PUBLIC_SUBKEY)
317         {
318           keyid_list_t a = xmalloc_clear (sizeof *a);
319           /* Hmmm: For a long list of keyids it might be an advantage
320            * to append the keys.  */
321           fingerprint_from_pk (k->pkt->pkt.public_key, a->fpr, NULL);
322           keyid_from_pk (k->pkt->pkt.public_key, a->keyid);
323           /* First check for duplicates.  */
324           for (r = user_id_db; r; r = r->next)
325             {
326               keyid_list_t b;
327
328               for (b = r->keyids; b; b = b->next)
329                 {
330                   if (!memcmp (b->fpr, a->fpr, MAX_FINGERPRINT_LEN))
331                     {
332                       if (DBG_CACHE)
333                         log_debug ("cache_user_id: already in cache\n");
334                       release_keyid_list (keyids);
335                       xfree (a);
336                       return;
337                     }
338                 }
339             }
340           /* Now put it into the cache.  */
341           a->next = keyids;
342           keyids = a;
343         }
344     }
345   if (!keyids)
346     BUG (); /* No key no fun.  */
347
348
349   uid = get_primary_uid (keyblock, &uidlen);
350
351   if (uid_cache_entries >= MAX_UID_CACHE_ENTRIES)
352     {
353       /* fixme: use another algorithm to free some cache slots */
354       r = user_id_db;
355       user_id_db = r->next;
356       release_keyid_list (r->keyids);
357       xfree (r);
358       uid_cache_entries--;
359     }
360   r = xmalloc (sizeof *r + uidlen - 1);
361   r->keyids = keyids;
362   r->len = uidlen;
363   memcpy (r->name, uid, r->len);
364   r->next = user_id_db;
365   user_id_db = r;
366   uid_cache_entries++;
367 }
368
369
370 /* Disable and drop the public key cache (which is filled by
371    cache_public_key and get_pubkey).  Note: there is currently no way
372    to reenable this cache.  */
373 void
374 getkey_disable_caches ()
375 {
376 #if MAX_PK_CACHE_ENTRIES
377   {
378     pk_cache_entry_t ce, ce2;
379
380     for (ce = pk_cache; ce; ce = ce2)
381       {
382         ce2 = ce->next;
383         free_public_key (ce->pk);
384         xfree (ce);
385       }
386     pk_cache_disabled = 1;
387     pk_cache_entries = 0;
388     pk_cache = NULL;
389   }
390 #endif
391   /* fixme: disable user id cache ? */
392 }
393
394
395 void
396 pubkey_free (pubkey_t key)
397 {
398   if (key)
399     {
400       xfree (key->pk);
401       release_kbnode (key->keyblock);
402       xfree (key);
403     }
404 }
405
406 void
407 pubkeys_free (pubkey_t keys)
408 {
409   while (keys)
410     {
411       pubkey_t next = keys->next;
412       pubkey_free (keys);
413       keys = next;
414     }
415 }
416
417 /* Returns all keys that match the search specfication SEARCH_TERMS.
418
419    This function also checks for and warns about duplicate entries in
420    the keydb, which can occur if the user has configured multiple
421    keyrings or keyboxes or if a keyring or keybox was corrupted.
422
423    Note: SEARCH_TERMS will not be expanded (i.e., it may not be a
424    group).
425
426    USE is the operation for which the key is required.  It must be
427    either PUBKEY_USAGE_ENC, PUBKEY_USAGE_SIG, PUBKEY_USAGE_CERT or
428    PUBKEY_USAGE_AUTH.
429
430    XXX: Currently, only PUBKEY_USAGE_ENC and PUBKEY_USAGE_SIG are
431    implemented.
432
433    INCLUDE_UNUSABLE indicates whether disabled keys are allowed.
434    (Recipients specified with --encrypt-to and --hidden-encrypt-to may
435    be disabled.  It is possible to edit disabled keys.)
436
437    SOURCE is the context in which SEARCH_TERMS was specified, e.g.,
438    "--encrypt-to", etc.  If this function is called interactively,
439    then this should be NULL.
440
441    If WARN_POSSIBLY_AMBIGUOUS is set, then emits a warning if the user
442    does not specify a long key id or a fingerprint.
443
444    The results are placed in *KEYS.  *KEYS must be NULL!  */
445 gpg_error_t
446 get_pubkeys (ctrl_t ctrl,
447              char *search_terms, int use, int include_unusable, char *source,
448              int warn_possibly_ambiguous,
449              pubkey_t *r_keys)
450 {
451   /* We show a warning when a key appears multiple times in the DB.
452      This can happen for two reasons:
453
454        - The user has configured multiple keyrings or keyboxes.
455
456        - The keyring or keybox has been corrupted in some way, e.g., a
457          bug or a random process changing them.
458
459      For each duplicate, we only want to show the key once.  Hence,
460      this list.  */
461   static strlist_t key_dups;
462
463   /* USE transformed to a string.  */
464   char *use_str;
465
466   gpg_error_t err;
467
468   KEYDB_SEARCH_DESC desc;
469
470   GETKEY_CTX ctx;
471   pubkey_t results = NULL;
472   pubkey_t r;
473
474   int count;
475
476   char fingerprint[2 * MAX_FINGERPRINT_LEN + 1];
477
478   if (DBG_LOOKUP)
479     {
480       log_debug ("\n");
481       log_debug ("%s: Checking %s=%s\n",
482                  __func__, source ? source : "user input", search_terms);
483     }
484
485   if (*r_keys)
486     log_bug ("%s: KEYS should be NULL!\n", __func__);
487
488   switch (use)
489     {
490     case PUBKEY_USAGE_ENC: use_str = "encrypt"; break;
491     case PUBKEY_USAGE_SIG: use_str = "sign"; break;
492     case PUBKEY_USAGE_CERT: use_str = "cetify"; break;
493     case PUBKEY_USAGE_AUTH: use_str = "authentication"; break;
494     default: log_bug ("%s: Bad value for USE (%d)\n", __func__, use);
495     }
496
497   if (use == PUBKEY_USAGE_CERT || use == PUBKEY_USAGE_AUTH)
498     log_bug ("%s: use=%s is unimplemented.\n", __func__, use_str);
499
500   err = classify_user_id (search_terms, &desc, 1);
501   if (err)
502     {
503       log_info (_("key \"%s\" not found: %s\n"),
504                 search_terms, gpg_strerror (err));
505       if (!opt.quiet && source)
506         log_info (_("(check argument of option '%s')\n"), source);
507       goto out;
508     }
509
510   if (warn_possibly_ambiguous
511       && ! (desc.mode == KEYDB_SEARCH_MODE_LONG_KID
512             || desc.mode == KEYDB_SEARCH_MODE_FPR16
513             || desc.mode == KEYDB_SEARCH_MODE_FPR20
514             || desc.mode == KEYDB_SEARCH_MODE_FPR))
515     {
516       log_info (_("Warning: '%s' should be a long key ID or a fingerprint\n"),
517                 search_terms);
518       if (!opt.quiet && source)
519         log_info (_("(check argument of option '%s')\n"), source);
520     }
521
522   /* Gather all of the results.  */
523   ctx = NULL;
524   count = 0;
525   do
526     {
527       PKT_public_key *pk = xmalloc_clear (sizeof *pk);
528       KBNODE kb;
529       pk->req_usage = use;
530
531       if (! ctx)
532         err = get_pubkey_byname (ctrl, &ctx, pk, search_terms, &kb, NULL,
533                                  include_unusable, 1);
534       else
535         err = getkey_next (ctx, pk, &kb);
536
537       if (gpg_err_code (err) == GPG_ERR_NOT_FOUND)
538         /* No more results.   */
539         {
540           xfree (pk);
541           break;
542         }
543       else if (err)
544         /* An error (other than "not found").  */
545         {
546           log_error (_("error looking up: %s\n"),
547                      gpg_strerror (err));
548           xfree (pk);
549           break;
550         }
551
552       /* Another result!  */
553       count ++;
554
555       r = xmalloc_clear (sizeof (*r));
556       r->pk = pk;
557       r->keyblock = kb;
558       r->next = results;
559       results = r;
560     }
561   while (ctx);
562   getkey_end (ctx);
563
564   if (DBG_LOOKUP)
565     {
566       log_debug ("%s resulted in %d matches.\n", search_terms, count);
567       for (r = results; r; r = r->next)
568         log_debug ("  %s\n",
569                    hexfingerprint (r->keyblock->pkt->pkt.public_key,
570                                    fingerprint, sizeof (fingerprint)));
571     }
572
573   if (! results && gpg_err_code (err) == GPG_ERR_NOT_FOUND)
574     /* No match.  */
575     {
576       if (DBG_LOOKUP)
577         log_debug ("%s: '%s' not found.\n", __func__, search_terms);
578
579       log_info (_("key \"%s\" not found\n"), search_terms);
580       if (!opt.quiet && source)
581         log_info (_("(check argument of option '%s')\n"), source);
582
583       goto out;
584     }
585   else if (gpg_err_code (err) == GPG_ERR_NOT_FOUND)
586     /* No more matches.  */
587     ;
588   else if (err)
589     /* Some other error.  An error message was already printed
590        out.  Free RESULTS and continue.  */
591     goto out;
592
593   /* Check for duplicates.  */
594   if (DBG_LOOKUP)
595     log_debug ("%s: Checking results of %s='%s' for dups\n",
596                __func__, source ? source : "user input", search_terms);
597   count = 0;
598   for (r = results; r; r = r->next)
599     {
600       pubkey_t *prevp;
601       pubkey_t next;
602       pubkey_t r2;
603       int dups = 0;
604
605       prevp = &r->next;
606       next = r->next;
607       while ((r2 = next))
608         {
609           if (cmp_public_keys (r->keyblock->pkt->pkt.public_key,
610                                r2->keyblock->pkt->pkt.public_key) != 0)
611             /* Not a dup.  */
612             {
613               prevp = &r2->next;
614               next = r2->next;
615               continue;
616             }
617
618           dups ++;
619           count ++;
620
621           /* Remove R2 from the list.  */
622           *prevp = r2->next;
623           release_kbnode (r2->keyblock);
624           next = r2->next;
625           xfree (r2);
626         }
627
628       if (dups)
629         {
630           hexfingerprint (r->keyblock->pkt->pkt.public_key,
631                           fingerprint, sizeof fingerprint);
632           if (! strlist_find (key_dups, fingerprint))
633             {
634               char fingerprint_formatted[MAX_FORMATTED_FINGERPRINT_LEN + 1];
635
636               log_info (_("Warning: %s appears in the keyring %d times\n"),
637                         format_hexfingerprint (fingerprint,
638                                                fingerprint_formatted,
639                                                sizeof fingerprint_formatted),
640                         1 + dups);
641               add_to_strlist (&key_dups, fingerprint);
642             }
643         }
644     }
645
646   if (DBG_LOOKUP && count)
647     {
648       log_debug ("After removing %d dups:\n", count);
649       for (r = results, count = 0; r; r = r->next)
650         log_debug ("  %d: %s\n",
651                    count,
652                    hexfingerprint (r->keyblock->pkt->pkt.public_key,
653                                    fingerprint, sizeof fingerprint));
654     }
655
656  out:
657   if (err)
658     pubkeys_free (results);
659   else
660     *r_keys = results;
661
662   return err;
663 }
664
665
666 static void
667 pk_from_block (PKT_public_key *pk, kbnode_t keyblock, kbnode_t found_key)
668 {
669   kbnode_t a = found_key ? found_key : keyblock;
670
671   log_assert (a->pkt->pkttype == PKT_PUBLIC_KEY
672               || a->pkt->pkttype == PKT_PUBLIC_SUBKEY);
673
674   copy_public_key (pk, a->pkt->pkt.public_key);
675 }
676
677
678 /* Return the public key with the key id KEYID and store it at PK.
679  * The resources in *PK should be released using
680  * release_public_key_parts().  This function also stores a copy of
681  * the public key in the user id cache (see cache_public_key).
682  *
683  * If PK is NULL, this function just stores the public key in the
684  * cache and returns the usual return code.
685  *
686  * PK->REQ_USAGE (which is a mask of PUBKEY_USAGE_SIG,
687  * PUBKEY_USAGE_ENC and PUBKEY_USAGE_CERT) is passed through to the
688  * lookup function.  If this is non-zero, only keys with the specified
689  * usage will be returned.  As such, it is essential that
690  * PK->REQ_USAGE be correctly initialized!
691  *
692  * Returns 0 on success, GPG_ERR_NO_PUBKEY if there is no public key
693  * with the specified key id, or another error code if an error
694  * occurs.
695  *
696  * If the data was not read from the cache, then the self-signed data
697  * has definitely been merged into the public key using
698  * merge_selfsigs.  */
699 int
700 get_pubkey (PKT_public_key * pk, u32 * keyid)
701 {
702   int internal = 0;
703   int rc = 0;
704
705 #if MAX_PK_CACHE_ENTRIES
706   if (pk)
707     {
708       /* Try to get it from the cache.  We don't do this when pk is
709          NULL as it does not guarantee that the user IDs are
710          cached. */
711       pk_cache_entry_t ce;
712       for (ce = pk_cache; ce; ce = ce->next)
713         {
714           if (ce->keyid[0] == keyid[0] && ce->keyid[1] == keyid[1])
715             /* XXX: We don't check PK->REQ_USAGE here, but if we don't
716                read from the cache, we do check it!  */
717             {
718               copy_public_key (pk, ce->pk);
719               return 0;
720             }
721         }
722     }
723 #endif
724   /* More init stuff.  */
725   if (!pk)
726     {
727       pk = xmalloc_clear (sizeof *pk);
728       internal++;
729     }
730
731
732   /* Do a lookup.  */
733   {
734     struct getkey_ctx_s ctx;
735     KBNODE kb = NULL;
736     KBNODE found_key = NULL;
737     memset (&ctx, 0, sizeof ctx);
738     ctx.exact = 1; /* Use the key ID exactly as given.  */
739     ctx.not_allocated = 1;
740     ctx.kr_handle = keydb_new ();
741     if (!ctx.kr_handle)
742       {
743         rc = gpg_error_from_syserror ();
744         goto leave;
745       }
746     ctx.nitems = 1;
747     ctx.items[0].mode = KEYDB_SEARCH_MODE_LONG_KID;
748     ctx.items[0].u.kid[0] = keyid[0];
749     ctx.items[0].u.kid[1] = keyid[1];
750     ctx.req_usage = pk->req_usage;
751     rc = lookup (&ctx, &kb, &found_key, 0);
752     if (!rc)
753       {
754         pk_from_block (pk, kb, found_key);
755       }
756     getkey_end (&ctx);
757     release_kbnode (kb);
758   }
759   if (!rc)
760     goto leave;
761
762   rc = GPG_ERR_NO_PUBKEY;
763
764 leave:
765   if (!rc)
766     cache_public_key (pk);
767   if (internal)
768     free_public_key (pk);
769   return rc;
770 }
771
772
773 /* Similar to get_pubkey, but it does not take PK->REQ_USAGE into
774  * account nor does it merge in the self-signed data.  This function
775  * also only considers primary keys.  It is intended to be used as a
776  * quick check of the key to avoid recursion.  It should only be used
777  * in very certain cases.  Like get_pubkey and unlike any of the other
778  * lookup functions, this function also consults the user id cache
779  * (see cache_public_key).
780  *
781  * Return the public key in *PK.  The resources in *PK should be
782  * released using release_public_key_parts().  */
783 int
784 get_pubkey_fast (PKT_public_key * pk, u32 * keyid)
785 {
786   int rc = 0;
787   KEYDB_HANDLE hd;
788   KBNODE keyblock;
789   u32 pkid[2];
790
791   log_assert (pk);
792 #if MAX_PK_CACHE_ENTRIES
793   {
794     /* Try to get it from the cache */
795     pk_cache_entry_t ce;
796
797     for (ce = pk_cache; ce; ce = ce->next)
798       {
799         if (ce->keyid[0] == keyid[0] && ce->keyid[1] == keyid[1]
800             /* Only consider primary keys.  */
801             && ce->pk->keyid[0] == ce->pk->main_keyid[0]
802             && ce->pk->keyid[1] == ce->pk->main_keyid[1])
803           {
804             if (pk)
805               copy_public_key (pk, ce->pk);
806             return 0;
807           }
808       }
809   }
810 #endif
811
812   hd = keydb_new ();
813   if (!hd)
814     return gpg_error_from_syserror ();
815   rc = keydb_search_kid (hd, keyid);
816   if (gpg_err_code (rc) == GPG_ERR_NOT_FOUND)
817     {
818       keydb_release (hd);
819       return GPG_ERR_NO_PUBKEY;
820     }
821   rc = keydb_get_keyblock (hd, &keyblock);
822   keydb_release (hd);
823   if (rc)
824     {
825       log_error ("keydb_get_keyblock failed: %s\n", gpg_strerror (rc));
826       return GPG_ERR_NO_PUBKEY;
827     }
828
829   log_assert (keyblock && keyblock->pkt
830               && keyblock->pkt->pkttype == PKT_PUBLIC_KEY);
831
832   /* We return the primary key.  If KEYID matched a subkey, then we
833      return an error.  */
834   keyid_from_pk (keyblock->pkt->pkt.public_key, pkid);
835   if (keyid[0] == pkid[0] && keyid[1] == pkid[1])
836     copy_public_key (pk, keyblock->pkt->pkt.public_key);
837   else
838     rc = GPG_ERR_NO_PUBKEY;
839
840   release_kbnode (keyblock);
841
842   /* Not caching key here since it won't have all of the fields
843      properly set. */
844
845   return rc;
846 }
847
848
849 /* Return the key block for the key with key id KEYID or NULL, if an
850  * error occurs.  Use release_kbnode() to release the key block.
851  *
852  * The self-signed data has already been merged into the public key
853  * using merge_selfsigs.  */
854 kbnode_t
855 get_pubkeyblock (u32 * keyid)
856 {
857   struct getkey_ctx_s ctx;
858   int rc = 0;
859   KBNODE keyblock = NULL;
860
861   memset (&ctx, 0, sizeof ctx);
862   /* No need to set exact here because we want the entire block.  */
863   ctx.not_allocated = 1;
864   ctx.kr_handle = keydb_new ();
865   if (!ctx.kr_handle)
866     return NULL;
867   ctx.nitems = 1;
868   ctx.items[0].mode = KEYDB_SEARCH_MODE_LONG_KID;
869   ctx.items[0].u.kid[0] = keyid[0];
870   ctx.items[0].u.kid[1] = keyid[1];
871   rc = lookup (&ctx, &keyblock, NULL, 0);
872   getkey_end (&ctx);
873
874   return rc ? NULL : keyblock;
875 }
876
877
878 /* Return the public key with the key id KEYID iff the secret key is
879  * available and store it at PK.  The resources should be released
880  * using release_public_key_parts().
881  *
882  * Unlike other lookup functions, PK may not be NULL.  PK->REQ_USAGE
883  * is passed through to the lookup function and is a mask of
884  * PUBKEY_USAGE_SIG, PUBKEY_USAGE_ENC and PUBKEY_USAGE_CERT.  Thus, it
885  * must be valid!  If this is non-zero, only keys with the specified
886  * usage will be returned.
887  *
888  * Returns 0 on success.  If a public key with the specified key id is
889  * not found or a secret key is not available for that public key, an
890  * error code is returned.  Note: this function ignores legacy keys.
891  * An error code is also return if an error occurs.
892  *
893  * The self-signed data has already been merged into the public key
894  * using merge_selfsigs.  */
895 gpg_error_t
896 get_seckey (PKT_public_key *pk, u32 *keyid)
897 {
898   gpg_error_t err;
899   struct getkey_ctx_s ctx;
900   kbnode_t keyblock = NULL;
901   kbnode_t found_key = NULL;
902
903   memset (&ctx, 0, sizeof ctx);
904   ctx.exact = 1; /* Use the key ID exactly as given.  */
905   ctx.not_allocated = 1;
906   ctx.kr_handle = keydb_new ();
907   if (!ctx.kr_handle)
908     return gpg_error_from_syserror ();
909   ctx.nitems = 1;
910   ctx.items[0].mode = KEYDB_SEARCH_MODE_LONG_KID;
911   ctx.items[0].u.kid[0] = keyid[0];
912   ctx.items[0].u.kid[1] = keyid[1];
913   ctx.req_usage = pk->req_usage;
914   err = lookup (&ctx, &keyblock, &found_key, 1);
915   if (!err)
916     {
917       pk_from_block (pk, keyblock, found_key);
918     }
919   getkey_end (&ctx);
920   release_kbnode (keyblock);
921
922   if (!err)
923     {
924       err = agent_probe_secret_key (/*ctrl*/NULL, pk);
925       if (err)
926         release_public_key_parts (pk);
927     }
928
929   return err;
930 }
931
932
933 /* Skip unusable keys.  A key is unusable if it is revoked, expired or
934    disabled or if the selected user id is revoked or expired.  */
935 static int
936 skip_unusable (void *dummy, u32 * keyid, int uid_no)
937 {
938   int unusable = 0;
939   KBNODE keyblock;
940   PKT_public_key *pk;
941
942   (void) dummy;
943
944   keyblock = get_pubkeyblock (keyid);
945   if (!keyblock)
946     {
947       log_error ("error checking usability status of %s\n", keystr (keyid));
948       goto leave;
949     }
950
951   pk = keyblock->pkt->pkt.public_key;
952
953   /* Is the key revoked or expired?  */
954   if (pk->flags.revoked || pk->has_expired)
955     unusable = 1;
956
957   /* Is the user ID in question revoked or expired? */
958   if (!unusable && uid_no)
959     {
960       KBNODE node;
961       int uids_seen = 0;
962
963       for (node = keyblock; node; node = node->next)
964         {
965           if (node->pkt->pkttype == PKT_USER_ID)
966             {
967               PKT_user_id *user_id = node->pkt->pkt.user_id;
968
969               uids_seen ++;
970               if (uids_seen != uid_no)
971                 continue;
972
973               if (user_id->is_revoked || user_id->is_expired)
974                 unusable = 1;
975
976               break;
977             }
978         }
979
980       /* If UID_NO is non-zero, then the keyblock better have at least
981          that many UIDs.  */
982       log_assert (uids_seen == uid_no);
983     }
984
985   if (!unusable)
986     unusable = pk_is_disabled (pk);
987
988 leave:
989   release_kbnode (keyblock);
990   return unusable;
991 }
992
993
994 /* Search for keys matching some criteria.
995
996    If RETCTX is not NULL, then the constructed context is returned in
997    *RETCTX so that getpubkey_next can be used to get subsequent
998    results.  In this case, getkey_end() must be used to free the
999    search context.  If RETCTX is not NULL, then RET_KDBHD must be
1000    NULL.
1001
1002    If NAMELIST is not NULL, then a search query is constructed using
1003    classify_user_id on each of the strings in the list.  (Recall: the
1004    database does an OR of the terms, not an AND.)  If NAMELIST is
1005    NULL, then all results are returned.
1006
1007    If PK is not NULL, the public key of the first result is returned
1008    in *PK.  Note: PK->REQ_USAGE must be valid!!!  If PK->REQ_USAGE is
1009    set, it is used to filter the search results.  See the
1010    documentation for finish_lookup to understand exactly how this is
1011    used.  Note: The self-signed data has already been merged into the
1012    public key using merge_selfsigs.  Free *PK by calling
1013    release_public_key_parts (or, if PK was allocated using xfree, you
1014    can use free_public_key, which calls release_public_key_parts(PK)
1015    and then xfree(PK)).
1016
1017    If WANT_SECRET is set, then only keys with an available secret key
1018    (either locally or via key registered on a smartcard) are returned.
1019
1020    If INCLUDE_UNUSABLE is set, then unusable keys (see the
1021    documentation for skip_unusable for an exact definition) are
1022    skipped unless they are looked up by key id or by fingerprint.
1023
1024    If RET_KB is not NULL, the keyblock is returned in *RET_KB.  This
1025    should be freed using release_kbnode().
1026
1027    If RET_KDBHD is not NULL, then the new database handle used to
1028    conduct the search is returned in *RET_KDBHD.  This can be used to
1029    get subsequent results using keydb_search_next.  Note: in this
1030    case, no advanced filtering is done for subsequent results (e.g.,
1031    WANT_SECRET and PK->REQ_USAGE are not respected).
1032
1033    This function returns 0 on success.  Otherwise, an error code is
1034    returned.  In particular, GPG_ERR_NO_PUBKEY or GPG_ERR_NO_SECKEY
1035    (if want_secret is set) is returned if the key is not found.  */
1036 static int
1037 key_byname (GETKEY_CTX *retctx, strlist_t namelist,
1038             PKT_public_key *pk,
1039             int want_secret, int include_unusable,
1040             KBNODE * ret_kb, KEYDB_HANDLE * ret_kdbhd)
1041 {
1042   int rc = 0;
1043   int n;
1044   strlist_t r;
1045   GETKEY_CTX ctx;
1046   KBNODE help_kb = NULL;
1047   KBNODE found_key = NULL;
1048
1049   if (retctx)
1050     {
1051       /* Reset the returned context in case of error.  */
1052       log_assert (!ret_kdbhd); /* Not allowed because the handle is stored
1053                                   in the context.  */
1054       *retctx = NULL;
1055     }
1056   if (ret_kdbhd)
1057     *ret_kdbhd = NULL;
1058
1059   if (!namelist)
1060     /* No search terms: iterate over the whole DB.  */
1061     {
1062       ctx = xmalloc_clear (sizeof *ctx);
1063       ctx->nitems = 1;
1064       ctx->items[0].mode = KEYDB_SEARCH_MODE_FIRST;
1065       if (!include_unusable)
1066         ctx->items[0].skipfnc = skip_unusable;
1067     }
1068   else
1069     {
1070       /* Build the search context.  */
1071       for (n = 0, r = namelist; r; r = r->next)
1072         n++;
1073
1074       /* CTX has space for a single search term at the end.  Thus, we
1075          need to allocate sizeof *CTX plus (n - 1) sizeof
1076          CTX->ITEMS.  */
1077       ctx = xmalloc_clear (sizeof *ctx + (n - 1) * sizeof ctx->items);
1078       ctx->nitems = n;
1079
1080       for (n = 0, r = namelist; r; r = r->next, n++)
1081         {
1082           gpg_error_t err;
1083
1084           err = classify_user_id (r->d, &ctx->items[n], 1);
1085
1086           if (ctx->items[n].exact)
1087             ctx->exact = 1;
1088           if (err)
1089             {
1090               xfree (ctx);
1091               return gpg_err_code (err); /* FIXME: remove gpg_err_code.  */
1092             }
1093           if (!include_unusable
1094               && ctx->items[n].mode != KEYDB_SEARCH_MODE_SHORT_KID
1095               && ctx->items[n].mode != KEYDB_SEARCH_MODE_LONG_KID
1096               && ctx->items[n].mode != KEYDB_SEARCH_MODE_FPR16
1097               && ctx->items[n].mode != KEYDB_SEARCH_MODE_FPR20
1098               && ctx->items[n].mode != KEYDB_SEARCH_MODE_FPR)
1099             ctx->items[n].skipfnc = skip_unusable;
1100         }
1101     }
1102
1103   ctx->want_secret = want_secret;
1104   ctx->kr_handle = keydb_new ();
1105   if (!ctx->kr_handle)
1106     {
1107       rc = gpg_error_from_syserror ();
1108       getkey_end (ctx);
1109       return rc;
1110     }
1111
1112   if (!ret_kb)
1113     ret_kb = &help_kb;
1114
1115   if (pk)
1116     {
1117       ctx->req_usage = pk->req_usage;
1118     }
1119
1120   rc = lookup (ctx, ret_kb, &found_key, want_secret);
1121   if (!rc && pk)
1122     {
1123       pk_from_block (pk, *ret_kb, found_key);
1124     }
1125
1126   release_kbnode (help_kb);
1127
1128   if (retctx) /* Caller wants the context.  */
1129     *retctx = ctx;
1130   else
1131     {
1132       if (ret_kdbhd)
1133         {
1134           *ret_kdbhd = ctx->kr_handle;
1135           ctx->kr_handle = NULL;
1136         }
1137       getkey_end (ctx);
1138     }
1139
1140   return rc;
1141 }
1142
1143
1144 /* Find a public key identified by NAME.
1145  *
1146  * If name appears to be a valid valid RFC822 mailbox (i.e., email
1147  * address) and auto key lookup is enabled (no_akl == 0), then the
1148  * specified auto key lookup methods (--auto-key-lookup) are used to
1149  * import the key into the local keyring.  Otherwise, just the local
1150  * keyring is consulted.
1151  *
1152  * If RETCTX is not NULL, then the constructed context is returned in
1153  * *RETCTX so that getpubkey_next can be used to get subsequent
1154  * results.  In this case, getkey_end() must be used to free the
1155  * search context.  If RETCTX is not NULL, then RET_KDBHD must be
1156  * NULL.
1157  *
1158  * If PK is not NULL, the public key of the first result is returned
1159  * in *PK.  Note: PK->REQ_USAGE must be valid!!!  PK->REQ_USAGE is
1160  * passed through to the lookup function and is a mask of
1161  * PUBKEY_USAGE_SIG, PUBKEY_USAGE_ENC and PUBKEY_USAGE_CERT.  If this
1162  * is non-zero, only keys with the specified usage will be returned.
1163  * Note: The self-signed data has already been merged into the public
1164  * key using merge_selfsigs.  Free *PK by calling
1165  * release_public_key_parts (or, if PK was allocated using xfree, you
1166  * can use free_public_key, which calls release_public_key_parts(PK)
1167  * and then xfree(PK)).
1168  *
1169  * NAME is a string, which is turned into a search query using
1170  * classify_user_id.
1171  *
1172  * If RET_KEYBLOCK is not NULL, the keyblock is returned in
1173  * *RET_KEYBLOCK.  This should be freed using release_kbnode().
1174  *
1175  * If RET_KDBHD is not NULL, then the new database handle used to
1176  * conduct the search is returned in *RET_KDBHD.  This can be used to
1177  * get subsequent results using keydb_search_next or to modify the
1178  * returned record.  Note: in this case, no advanced filtering is done
1179  * for subsequent results (e.g., PK->REQ_USAGE is not respected).
1180  * Unlike RETCTX, this is always returned.
1181  *
1182  * If INCLUDE_UNUSABLE is set, then unusable keys (see the
1183  * documentation for skip_unusable for an exact definition) are
1184  * skipped unless they are looked up by key id or by fingerprint.
1185  *
1186  * If NO_AKL is set, then the auto key locate functionality is
1187  * disabled and only the local key ring is considered.  Note: the
1188  * local key ring is consulted even if local is not in the
1189  * --auto-key-locate option list!
1190  *
1191  * This function returns 0 on success.  Otherwise, an error code is
1192  * returned.  In particular, GPG_ERR_NO_PUBKEY or GPG_ERR_NO_SECKEY
1193  * (if want_secret is set) is returned if the key is not found.  */
1194 int
1195 get_pubkey_byname (ctrl_t ctrl, GETKEY_CTX * retctx, PKT_public_key * pk,
1196                    const char *name, KBNODE * ret_keyblock,
1197                    KEYDB_HANDLE * ret_kdbhd, int include_unusable, int no_akl)
1198 {
1199   int rc;
1200   strlist_t namelist = NULL;
1201   struct akl *akl;
1202   int is_mbox;
1203   int nodefault = 0;
1204   int anylocalfirst = 0;
1205
1206   /* If RETCTX is not NULL, then RET_KDBHD must be NULL.  */
1207   log_assert (retctx == NULL || ret_kdbhd == NULL);
1208
1209   if (retctx)
1210     *retctx = NULL;
1211
1212   /* Does NAME appear to be a mailbox (mail address)?  */
1213   is_mbox = is_valid_mailbox (name);
1214
1215   /* The auto-key-locate feature works as follows: there are a number
1216    * of methods to look up keys.  By default, the local keyring is
1217    * tried first.  Then, each method listed in the --auto-key-locate is
1218    * tried in the order it appears.
1219    *
1220    * This can be changed as follows:
1221    *
1222    *   - if nodefault appears anywhere in the list of options, then
1223    *     the local keyring is not tried first, or,
1224    *
1225    *   - if local appears anywhere in the list of options, then the
1226    *     local keyring is not tried first, but in the order in which
1227    *     it was listed in the --auto-key-locate option.
1228    *
1229    * Note: we only save the search context in RETCTX if the local
1230    * method is the first method tried (either explicitly or
1231    * implicitly).  */
1232   if (!no_akl)
1233     {
1234       /* auto-key-locate is enabled.  */
1235
1236       /* nodefault is true if "nodefault" or "local" appear.  */
1237       for (akl = opt.auto_key_locate; akl; akl = akl->next)
1238         if (akl->type == AKL_NODEFAULT || akl->type == AKL_LOCAL)
1239           {
1240             nodefault = 1;
1241             break;
1242           }
1243       /* anylocalfirst is true if "local" appears before any other
1244          search methods (except "nodefault").  */
1245       for (akl = opt.auto_key_locate; akl; akl = akl->next)
1246         if (akl->type != AKL_NODEFAULT)
1247           {
1248             if (akl->type == AKL_LOCAL)
1249               anylocalfirst = 1;
1250             break;
1251           }
1252     }
1253
1254   if (!nodefault)
1255     {
1256       /* "nodefault" didn't occur.  Thus, "local" is implicitly the
1257        *  first method to try.  */
1258       anylocalfirst = 1;
1259     }
1260
1261   if (nodefault && is_mbox)
1262     {
1263       /* Either "nodefault" or "local" (explicitly) appeared in the
1264        * auto key locate list and NAME appears to be an email address.
1265        * Don't try the local keyring.  */
1266       rc = GPG_ERR_NO_PUBKEY;
1267     }
1268   else
1269     {
1270       /* Either "nodefault" and "local" don't appear in the auto key
1271        * locate list (in which case we try the local keyring first) or
1272        * NAME does not appear to be an email address (in which case we
1273        * only try the local keyring).  In this case, lookup NAME in
1274        * the local keyring.  */
1275       add_to_strlist (&namelist, name);
1276       rc = key_byname (retctx, namelist, pk, 0,
1277                        include_unusable, ret_keyblock, ret_kdbhd);
1278     }
1279
1280   /* If the requested name resembles a valid mailbox and automatic
1281      retrieval has been enabled, we try to import the key. */
1282   if (gpg_err_code (rc) == GPG_ERR_NO_PUBKEY && !no_akl && is_mbox)
1283     {
1284       /* NAME wasn't present in the local keyring (or we didn't try
1285        * the local keyring).  Since the auto key locate feature is
1286        * enabled and NAME appears to be an email address, try the auto
1287        * locate feature.  */
1288       for (akl = opt.auto_key_locate; akl; akl = akl->next)
1289         {
1290           unsigned char *fpr = NULL;
1291           size_t fpr_len;
1292           int did_akl_local = 0;
1293           int no_fingerprint = 0;
1294           const char *mechanism = "?";
1295
1296           switch (akl->type)
1297             {
1298             case AKL_NODEFAULT:
1299               /* This is a dummy mechanism.  */
1300               mechanism = "None";
1301               rc = GPG_ERR_NO_PUBKEY;
1302               break;
1303
1304             case AKL_LOCAL:
1305               mechanism = "Local";
1306               did_akl_local = 1;
1307               if (retctx)
1308                 {
1309                   getkey_end (*retctx);
1310                   *retctx = NULL;
1311                 }
1312               add_to_strlist (&namelist, name);
1313               rc = key_byname (anylocalfirst ? retctx : NULL,
1314                                namelist, pk, 0,
1315                                include_unusable, ret_keyblock, ret_kdbhd);
1316               break;
1317
1318             case AKL_CERT:
1319               mechanism = "DNS CERT";
1320               glo_ctrl.in_auto_key_retrieve++;
1321               rc = keyserver_import_cert (ctrl, name, 0, &fpr, &fpr_len);
1322               glo_ctrl.in_auto_key_retrieve--;
1323               break;
1324
1325             case AKL_PKA:
1326               mechanism = "PKA";
1327               glo_ctrl.in_auto_key_retrieve++;
1328               rc = keyserver_import_pka (ctrl, name, &fpr, &fpr_len);
1329               glo_ctrl.in_auto_key_retrieve--;
1330               break;
1331
1332             case AKL_DANE:
1333               mechanism = "DANE";
1334               glo_ctrl.in_auto_key_retrieve++;
1335               rc = keyserver_import_cert (ctrl, name, 1, &fpr, &fpr_len);
1336               glo_ctrl.in_auto_key_retrieve--;
1337               break;
1338
1339             case AKL_WKD:
1340               mechanism = "WKD";
1341               glo_ctrl.in_auto_key_retrieve++;
1342               rc = keyserver_import_wkd (ctrl, name, 0, &fpr, &fpr_len);
1343               glo_ctrl.in_auto_key_retrieve--;
1344               break;
1345
1346             case AKL_LDAP:
1347               mechanism = "LDAP";
1348               glo_ctrl.in_auto_key_retrieve++;
1349               rc = keyserver_import_ldap (ctrl, name, &fpr, &fpr_len);
1350               glo_ctrl.in_auto_key_retrieve--;
1351               break;
1352
1353             case AKL_KEYSERVER:
1354               /* Strictly speaking, we don't need to only use a valid
1355                * mailbox for the getname search, but it helps cut down
1356                * on the problem of searching for something like "john"
1357                * and getting a whole lot of keys back. */
1358               if (keyserver_any_configured (ctrl))
1359                 {
1360                   mechanism = "keyserver";
1361                   glo_ctrl.in_auto_key_retrieve++;
1362                   rc = keyserver_import_name (ctrl, name, &fpr, &fpr_len,
1363                                               opt.keyserver);
1364                   glo_ctrl.in_auto_key_retrieve--;
1365                 }
1366               else
1367                 {
1368                   mechanism = "Unconfigured keyserver";
1369                   rc = GPG_ERR_NO_PUBKEY;
1370                 }
1371               break;
1372
1373             case AKL_SPEC:
1374               {
1375                 struct keyserver_spec *keyserver;
1376
1377                 mechanism = akl->spec->uri;
1378                 keyserver = keyserver_match (akl->spec);
1379                 glo_ctrl.in_auto_key_retrieve++;
1380                 rc = keyserver_import_name (ctrl,
1381                                             name, &fpr, &fpr_len, keyserver);
1382                 glo_ctrl.in_auto_key_retrieve--;
1383               }
1384               break;
1385             }
1386
1387           /* Use the fingerprint of the key that we actually fetched.
1388            * This helps prevent problems where the key that we fetched
1389            * doesn't have the same name that we used to fetch it.  In
1390            * the case of CERT and PKA, this is an actual security
1391            * requirement as the URL might point to a key put in by an
1392            * attacker.  By forcing the use of the fingerprint, we
1393            * won't use the attacker's key here. */
1394           if (!rc && fpr)
1395             {
1396               char fpr_string[MAX_FINGERPRINT_LEN * 2 + 1];
1397
1398               log_assert (fpr_len <= MAX_FINGERPRINT_LEN);
1399
1400               free_strlist (namelist);
1401               namelist = NULL;
1402
1403               bin2hex (fpr, fpr_len, fpr_string);
1404
1405               if (opt.verbose)
1406                 log_info ("auto-key-locate found fingerprint %s\n",
1407                           fpr_string);
1408
1409               add_to_strlist (&namelist, fpr_string);
1410             }
1411           else if (!rc && !fpr && !did_akl_local)
1412             { /* The acquisition method said no failure occurred, but
1413                * it didn't return a fingerprint.  That's a failure.  */
1414               no_fingerprint = 1;
1415               rc = GPG_ERR_NO_PUBKEY;
1416             }
1417           xfree (fpr);
1418           fpr = NULL;
1419
1420           if (!rc && !did_akl_local)
1421             { /* There was no error and we didn't do a local lookup.
1422                * This means that we imported a key into the local
1423                * keyring.  Try to read the imported key from the
1424                * keyring.  */
1425               if (retctx)
1426                 {
1427                   getkey_end (*retctx);
1428                   *retctx = NULL;
1429                 }
1430               rc = key_byname (anylocalfirst ? retctx : NULL,
1431                                namelist, pk, 0,
1432                                include_unusable, ret_keyblock, ret_kdbhd);
1433             }
1434           if (!rc)
1435             {
1436               /* Key found.  */
1437               log_info (_("automatically retrieved '%s' via %s\n"),
1438                         name, mechanism);
1439               break;
1440             }
1441           if (gpg_err_code (rc) != GPG_ERR_NO_PUBKEY
1442               || opt.verbose || no_fingerprint)
1443             log_info (_("error retrieving '%s' via %s: %s\n"),
1444                       name, mechanism,
1445                       no_fingerprint ? _("No fingerprint") : gpg_strerror (rc));
1446         }
1447     }
1448
1449
1450   if (rc && retctx)
1451     {
1452       getkey_end (*retctx);
1453       *retctx = NULL;
1454     }
1455
1456   if (retctx && *retctx)
1457     {
1458       log_assert (!(*retctx)->extra_list);
1459       (*retctx)->extra_list = namelist;
1460     }
1461   else
1462     free_strlist (namelist);
1463
1464   return rc;
1465 }
1466
1467
1468 \f
1469
1470 /* Comparison machinery for get_best_pubkey_byname.  */
1471
1472 /* First we have a struct to cache computed information about the key
1473  * in question.  */
1474 struct pubkey_cmp_cookie
1475 {
1476   int valid;                    /* Is this cookie valid?  */
1477   PKT_public_key key;           /* The key.  */
1478   PKT_user_id *uid;             /* The matching UID packet.  */
1479   unsigned int validity;        /* Computed validity of (KEY, UID).  */
1480   u32 creation_time;            /* Creation time of the newest subkey
1481                                    capable of encryption.  */
1482 };
1483
1484
1485 /* Then we have a series of helper functions.  */
1486 static int
1487 key_is_ok (const PKT_public_key *key)
1488 {
1489   return (! key->has_expired && ! key->flags.revoked
1490           && key->flags.valid && ! key->flags.disabled);
1491 }
1492
1493
1494 static int
1495 uid_is_ok (const PKT_public_key *key, const PKT_user_id *uid)
1496 {
1497   return key_is_ok (key) && ! uid->is_revoked;
1498 }
1499
1500
1501 static int
1502 subkey_is_ok (const PKT_public_key *sub)
1503 {
1504   return ! sub->flags.revoked && sub->flags.valid && ! sub->flags.disabled;
1505 }
1506
1507
1508 /* Finally this function compares a NEW key to the former candidate
1509  * OLD.  Returns < 0 if the old key is worse, > 0 if the old key is
1510  * better, == 0 if it is a tie.  */
1511 static int
1512 pubkey_cmp (ctrl_t ctrl, const char *name, struct pubkey_cmp_cookie *old,
1513             struct pubkey_cmp_cookie *new, KBNODE new_keyblock)
1514 {
1515   kbnode_t n;
1516
1517   new->creation_time = 0;
1518   for (n = find_next_kbnode (new_keyblock, PKT_PUBLIC_SUBKEY);
1519        n; n = find_next_kbnode (n, PKT_PUBLIC_SUBKEY))
1520     {
1521       PKT_public_key *sub = n->pkt->pkt.public_key;
1522
1523       if ((sub->pubkey_usage & PUBKEY_USAGE_ENC) == 0)
1524         continue;
1525
1526       if (! subkey_is_ok (sub))
1527         continue;
1528
1529       if (sub->timestamp > new->creation_time)
1530         new->creation_time = sub->timestamp;
1531     }
1532
1533   for (n = find_next_kbnode (new_keyblock, PKT_USER_ID);
1534        n; n = find_next_kbnode (n, PKT_USER_ID))
1535     {
1536       PKT_user_id *uid = n->pkt->pkt.user_id;
1537       char *mbox = mailbox_from_userid (uid->name);
1538       int match = mbox ? strcasecmp (name, mbox) == 0 : 0;
1539
1540       xfree (mbox);
1541       if (! match)
1542         continue;
1543
1544       new->uid = uid;
1545       new->validity =
1546         get_validity (ctrl, &new->key, uid, NULL, 0) & TRUST_MASK;
1547       new->valid = 1;
1548
1549       if (! old->valid)
1550         return -1;      /* No OLD key.  */
1551
1552       if (! uid_is_ok (&old->key, old->uid) && uid_is_ok (&new->key, uid))
1553         return -1;      /* Validity of the NEW key is better.  */
1554
1555       if (old->validity < new->validity)
1556         return -1;      /* Validity of the NEW key is better.  */
1557
1558       if (old->validity == new->validity && uid_is_ok (&new->key, uid)
1559           && old->creation_time < new->creation_time)
1560         return -1;      /* Both keys are of the same validity, but the
1561                            NEW key is newer.  */
1562     }
1563
1564   /* Stick with the OLD key.  */
1565   return 1;
1566 }
1567
1568
1569 /* This function works like get_pubkey_byname, but if the name
1570  * resembles a mail address, the results are ranked and only the best
1571  * result is returned.  */
1572 int
1573 get_best_pubkey_byname (ctrl_t ctrl, GETKEY_CTX *retctx, PKT_public_key *pk,
1574                         const char *name, KBNODE *ret_keyblock,
1575                         int include_unusable, int no_akl)
1576 {
1577   int rc;
1578   struct getkey_ctx_s *ctx = NULL;
1579
1580   if (retctx)
1581     *retctx = NULL;
1582
1583   rc = get_pubkey_byname (ctrl, &ctx, pk, name, ret_keyblock,
1584                           NULL, include_unusable, no_akl);
1585   if (rc)
1586     {
1587       if (ctx)
1588         getkey_end (ctx);
1589       return rc;
1590     }
1591
1592   if (is_valid_mailbox (name) && ctx)
1593     {
1594       /* Rank results and return only the most relevant key.  */
1595       struct pubkey_cmp_cookie best = { 0 }, new;
1596       while (getkey_next (ctx, &new.key, NULL) == 0)
1597         {
1598           KBNODE new_keyblock = get_pubkeyblock (pk_keyid (&new.key));
1599           int diff = pubkey_cmp (ctrl, name, &best, &new, new_keyblock);
1600           release_kbnode (new_keyblock);
1601           if (diff < 0)
1602             {
1603               /* New key is better.  */
1604               release_public_key_parts (&best.key);
1605               best = new;
1606             }
1607           else if (diff > 0)
1608             {
1609               /* Old key is better.  */
1610               release_public_key_parts (&new.key);
1611             }
1612           else
1613             {
1614               /* A tie.  Keep the old key.  */
1615               release_public_key_parts (&new.key);
1616             }
1617         }
1618       getkey_end (ctx);
1619       ctx = NULL;
1620
1621       if (best.valid)
1622         {
1623           if (retctx || ret_keyblock)
1624             {
1625               ctx = xtrycalloc (1, sizeof **retctx);
1626               if (! ctx)
1627                 rc = gpg_error_from_syserror ();
1628               else
1629                 {
1630                   ctx->kr_handle = keydb_new ();
1631                   if (! ctx->kr_handle)
1632                     {
1633                       xfree (ctx);
1634                       *retctx = NULL;
1635                       rc = gpg_error_from_syserror ();
1636                     }
1637                   else
1638                     {
1639                       u32 *keyid = pk_keyid (&best.key);
1640                       ctx->exact = 1;
1641                       ctx->nitems = 1;
1642                       ctx->items[0].mode = KEYDB_SEARCH_MODE_LONG_KID;
1643                       ctx->items[0].u.kid[0] = keyid[0];
1644                       ctx->items[0].u.kid[1] = keyid[1];
1645
1646                       if (ret_keyblock)
1647                         {
1648                           release_kbnode (*ret_keyblock);
1649                           *ret_keyblock = NULL;
1650                           rc = getkey_next (ctx, NULL, ret_keyblock);
1651                         }
1652                     }
1653                 }
1654             }
1655
1656           if (pk)
1657             *pk = best.key;
1658           else
1659             release_public_key_parts (&best.key);
1660         }
1661     }
1662
1663   if (rc && ctx)
1664     {
1665       getkey_end (ctx);
1666       ctx = NULL;
1667     }
1668
1669   if (retctx && ctx)
1670     *retctx = ctx;
1671   else
1672     getkey_end (ctx);
1673
1674   return rc;
1675 }
1676
1677 \f
1678
1679 /* Get a public key from a file.
1680  *
1681  * PK is the buffer to store the key.  The caller needs to make sure
1682  * that PK->REQ_USAGE is valid.  PK->REQ_USAGE is passed through to
1683  * the lookup function and is a mask of PUBKEY_USAGE_SIG,
1684  * PUBKEY_USAGE_ENC and PUBKEY_USAGE_CERT.  If this is non-zero, only
1685  * keys with the specified usage will be returned.
1686  *
1687  * FNAME is the file name.  That file should contain exactly one
1688  * keyblock.
1689  *
1690  * This function returns 0 on success.  Otherwise, an error code is
1691  * returned.  In particular, GPG_ERR_NO_PUBKEY is returned if the key
1692  * is not found.
1693  *
1694  * The self-signed data has already been merged into the public key
1695  * using merge_selfsigs.  The caller must release the content of PK by
1696  * calling release_public_key_parts (or, if PK was malloced, using
1697  * free_public_key).
1698  */
1699 gpg_error_t
1700 get_pubkey_fromfile (ctrl_t ctrl, PKT_public_key *pk, const char *fname)
1701 {
1702   gpg_error_t err;
1703   kbnode_t keyblock;
1704   kbnode_t found_key;
1705   unsigned int infoflags;
1706
1707   err = read_key_from_file (ctrl, fname, &keyblock);
1708   if (!err)
1709     {
1710       /* Warning: node flag bits 0 and 1 should be preserved by
1711        * merge_selfsigs.  FIXME: Check whether this still holds. */
1712       merge_selfsigs (keyblock);
1713       found_key = finish_lookup (keyblock, pk->req_usage, 0, &infoflags);
1714       print_status_key_considered (keyblock, infoflags);
1715       if (found_key)
1716         pk_from_block (pk, keyblock, found_key);
1717       else
1718         err = gpg_error (GPG_ERR_UNUSABLE_PUBKEY);
1719     }
1720
1721   release_kbnode (keyblock);
1722   return err;
1723 }
1724
1725
1726 /* Lookup a key with the specified fingerprint.
1727  *
1728  * If PK is not NULL, the public key of the first result is returned
1729  * in *PK.  Note: this function does an exact search and thus the
1730  * returned public key may be a subkey rather than the primary key.
1731  * Note: The self-signed data has already been merged into the public
1732  * key using merge_selfsigs.  Free *PK by calling
1733  * release_public_key_parts (or, if PK was allocated using xfree, you
1734  * can use free_public_key, which calls release_public_key_parts(PK)
1735  * and then xfree(PK)).
1736  *
1737  * If PK->REQ_USAGE is set, it is used to filter the search results.
1738  * (Thus, if PK is not NULL, PK->REQ_USAGE must be valid!!!)  See the
1739  * documentation for finish_lookup to understand exactly how this is
1740  * used.
1741  *
1742  * If R_KEYBLOCK is not NULL, then the first result's keyblock is
1743  * returned in *R_KEYBLOCK.  This should be freed using
1744  * release_kbnode().
1745  *
1746  * FPRINT is a byte array whose contents is the fingerprint to use as
1747  * the search term.  FPRINT_LEN specifies the length of the
1748  * fingerprint (in bytes).  Currently, only 16 and 20-byte
1749  * fingerprints are supported.
1750  *
1751  * FIXME: We should replace this with the _byname function.  This can
1752  * be done by creating a userID conforming to the unified fingerprint
1753  * style.  */
1754 int
1755 get_pubkey_byfprint (PKT_public_key *pk, kbnode_t *r_keyblock,
1756                      const byte * fprint, size_t fprint_len)
1757 {
1758   int rc;
1759
1760   if (r_keyblock)
1761     *r_keyblock = NULL;
1762
1763   if (fprint_len == 20 || fprint_len == 16)
1764     {
1765       struct getkey_ctx_s ctx;
1766       KBNODE kb = NULL;
1767       KBNODE found_key = NULL;
1768
1769       memset (&ctx, 0, sizeof ctx);
1770       ctx.exact = 1;
1771       ctx.not_allocated = 1;
1772       ctx.kr_handle = keydb_new ();
1773       if (!ctx.kr_handle)
1774         return gpg_error_from_syserror ();
1775
1776       ctx.nitems = 1;
1777       ctx.items[0].mode = fprint_len == 16 ? KEYDB_SEARCH_MODE_FPR16
1778         : KEYDB_SEARCH_MODE_FPR20;
1779       memcpy (ctx.items[0].u.fpr, fprint, fprint_len);
1780       rc = lookup (&ctx, &kb, &found_key, 0);
1781       if (!rc && pk)
1782         pk_from_block (pk, kb, found_key);
1783       if (!rc && r_keyblock)
1784         {
1785           *r_keyblock = kb;
1786           kb = NULL;
1787         }
1788       release_kbnode (kb);
1789       getkey_end (&ctx);
1790     }
1791   else
1792     rc = GPG_ERR_GENERAL; /* Oops */
1793   return rc;
1794 }
1795
1796
1797 /* This function is similar to get_pubkey_byfprint, but it doesn't
1798  * merge the self-signed data into the public key and subkeys or into
1799  * the user ids.  It also doesn't add the key to the user id cache.
1800  * Further, this function ignores PK->REQ_USAGE.
1801  *
1802  * This function is intended to avoid recursion and, as such, should
1803  * only be used in very specific situations.
1804  *
1805  * Like get_pubkey_byfprint, PK may be NULL.  In that case, this
1806  * function effectively just checks for the existence of the key.  */
1807 int
1808 get_pubkey_byfprint_fast (PKT_public_key * pk,
1809                           const byte * fprint, size_t fprint_len)
1810 {
1811   int rc = 0;
1812   KEYDB_HANDLE hd;
1813   KBNODE keyblock;
1814   byte fprbuf[MAX_FINGERPRINT_LEN];
1815   int i;
1816
1817   for (i = 0; i < MAX_FINGERPRINT_LEN && i < fprint_len; i++)
1818     fprbuf[i] = fprint[i];
1819   while (i < MAX_FINGERPRINT_LEN)
1820     fprbuf[i++] = 0;
1821
1822   hd = keydb_new ();
1823   if (!hd)
1824     return gpg_error_from_syserror ();
1825
1826   rc = keydb_search_fpr (hd, fprbuf);
1827   if (gpg_err_code (rc) == GPG_ERR_NOT_FOUND)
1828     {
1829       keydb_release (hd);
1830       return GPG_ERR_NO_PUBKEY;
1831     }
1832   rc = keydb_get_keyblock (hd, &keyblock);
1833   keydb_release (hd);
1834   if (rc)
1835     {
1836       log_error ("keydb_get_keyblock failed: %s\n", gpg_strerror (rc));
1837       return GPG_ERR_NO_PUBKEY;
1838     }
1839
1840   log_assert (keyblock->pkt->pkttype == PKT_PUBLIC_KEY
1841               || keyblock->pkt->pkttype == PKT_PUBLIC_SUBKEY);
1842   if (pk)
1843     copy_public_key (pk, keyblock->pkt->pkt.public_key);
1844   release_kbnode (keyblock);
1845
1846   /* Not caching key here since it won't have all of the fields
1847      properly set. */
1848
1849   return 0;
1850 }
1851
1852 const char *
1853 parse_def_secret_key (ctrl_t ctrl)
1854 {
1855   KEYDB_HANDLE hd = NULL;
1856   strlist_t t;
1857   static int warned;
1858
1859   for (t = opt.def_secret_key; t; t = t->next)
1860     {
1861       gpg_error_t err;
1862       KEYDB_SEARCH_DESC desc;
1863       KBNODE kb;
1864       KBNODE node;
1865
1866       err = classify_user_id (t->d, &desc, 1);
1867       if (err)
1868         {
1869           log_error (_("secret key \"%s\" not found: %s\n"),
1870                      t->d, gpg_strerror (err));
1871           if (!opt.quiet)
1872             log_info (_("(check argument of option '%s')\n"), "--default-key");
1873           continue;
1874         }
1875
1876       if (! hd)
1877         {
1878           hd = keydb_new ();
1879           if (!hd)
1880             return NULL;
1881         }
1882       else
1883         keydb_search_reset (hd);
1884
1885
1886       err = keydb_search (hd, &desc, 1, NULL);
1887       if (gpg_err_code (err) == GPG_ERR_NOT_FOUND)
1888         continue;
1889
1890       if (err)
1891         {
1892           log_error (_("key \"%s\" not found: %s\n"), t->d, gpg_strerror (err));
1893           t = NULL;
1894           break;
1895         }
1896
1897       err = keydb_get_keyblock (hd, &kb);
1898       if (err)
1899         {
1900           log_error (_("error reading keyblock: %s\n"),
1901                      gpg_strerror (err));
1902           continue;
1903         }
1904
1905       merge_selfsigs (kb);
1906
1907       err = gpg_error (GPG_ERR_NO_SECKEY);
1908       node = kb;
1909       do
1910         {
1911           PKT_public_key *pk = node->pkt->pkt.public_key;
1912
1913           /* Check that the key has the signing capability.  */
1914           if (! (pk->pubkey_usage & PUBKEY_USAGE_SIG))
1915             continue;
1916
1917           /* Check if the key is valid.  */
1918           if (pk->flags.revoked)
1919             {
1920               if (DBG_LOOKUP)
1921                 log_debug ("not using %s as default key, %s",
1922                            keystr_from_pk (pk), "revoked");
1923               continue;
1924             }
1925           if (pk->has_expired)
1926             {
1927               if (DBG_LOOKUP)
1928                 log_debug ("not using %s as default key, %s",
1929                            keystr_from_pk (pk), "expired");
1930               continue;
1931             }
1932           if (pk_is_disabled (pk))
1933             {
1934               if (DBG_LOOKUP)
1935                 log_debug ("not using %s as default key, %s",
1936                            keystr_from_pk (pk), "disabled");
1937               continue;
1938             }
1939
1940           err = agent_probe_secret_key (ctrl, pk);
1941           if (! err)
1942             /* This is a valid key.  */
1943             break;
1944         }
1945       while ((node = find_next_kbnode (node, PKT_PUBLIC_SUBKEY)));
1946
1947       release_kbnode (kb);
1948       if (err)
1949         {
1950           if (! warned && ! opt.quiet)
1951             {
1952               log_info (_("Warning: not using '%s' as default key: %s\n"),
1953                         t->d, gpg_strerror (GPG_ERR_NO_SECKEY));
1954               print_reported_error (err, GPG_ERR_NO_SECKEY);
1955             }
1956         }
1957       else
1958         {
1959           if (! warned && ! opt.quiet)
1960             log_info (_("using \"%s\" as default secret key for signing\n"),
1961                       t->d);
1962           break;
1963         }
1964     }
1965
1966   if (! warned && opt.def_secret_key && ! t)
1967     log_info (_("all values passed to '%s' ignored\n"),
1968               "--default-key");
1969
1970   warned = 1;
1971
1972   if (hd)
1973     keydb_release (hd);
1974
1975   if (t)
1976     return t->d;
1977   return NULL;
1978 }
1979
1980
1981 /* Look up a secret key.
1982  *
1983  * If PK is not NULL, the public key of the first result is returned
1984  * in *PK.  Note: PK->REQ_USAGE must be valid!!!  If PK->REQ_USAGE is
1985  * set, it is used to filter the search results.  See the
1986  * documentation for finish_lookup to understand exactly how this is
1987  * used.  Note: The self-signed data has already been merged into the
1988  * public key using merge_selfsigs.  Free *PK by calling
1989  * release_public_key_parts (or, if PK was allocated using xfree, you
1990  * can use free_public_key, which calls release_public_key_parts(PK)
1991  * and then xfree(PK)).
1992  *
1993  * If --default-key was set, then the specified key is looked up.  (In
1994  * this case, the default key is returned even if it is considered
1995  * unusable.  See the documentation for skip_unusable for exactly what
1996  * this means.)
1997  *
1998  * Otherwise, this initiates a DB scan that returns all keys that are
1999  * usable (see previous paragraph for exactly what usable means) and
2000  * for which a secret key is available.
2001  *
2002  * This function returns the first match.  Additional results can be
2003  * returned using getkey_next.  */
2004 gpg_error_t
2005 get_seckey_default (ctrl_t ctrl, PKT_public_key *pk)
2006 {
2007   gpg_error_t err;
2008   strlist_t namelist = NULL;
2009   int include_unusable = 1;
2010
2011
2012   const char *def_secret_key = parse_def_secret_key (ctrl);
2013   if (def_secret_key)
2014     add_to_strlist (&namelist, def_secret_key);
2015   else
2016     include_unusable = 0;
2017
2018   err = key_byname (NULL, namelist, pk, 1, include_unusable, NULL, NULL);
2019
2020   free_strlist (namelist);
2021
2022   return err;
2023 }
2024
2025
2026 \f
2027 /* Search for keys matching some criteria.
2028  *
2029  * If RETCTX is not NULL, then the constructed context is returned in
2030  * *RETCTX so that getpubkey_next can be used to get subsequent
2031  * results.  In this case, getkey_end() must be used to free the
2032  * search context.  If RETCTX is not NULL, then RET_KDBHD must be
2033  * NULL.
2034  *
2035  * If PK is not NULL, the public key of the first result is returned
2036  * in *PK.  Note: PK->REQ_USAGE must be valid!!!  If PK->REQ_USAGE is
2037  * set, it is used to filter the search results.  See the
2038  * documentation for finish_lookup to understand exactly how this is
2039  * used.  Note: The self-signed data has already been merged into the
2040  * public key using merge_selfsigs.  Free *PK by calling
2041  * release_public_key_parts (or, if PK was allocated using xfree, you
2042  * can use free_public_key, which calls release_public_key_parts(PK)
2043  * and then xfree(PK)).
2044  *
2045  * If NAMES is not NULL, then a search query is constructed using
2046  * classify_user_id on each of the strings in the list.  (Recall: the
2047  * database does an OR of the terms, not an AND.)  If NAMES is
2048  * NULL, then all results are returned.
2049  *
2050  * If WANT_SECRET is set, then only keys with an available secret key
2051  * (either locally or via key registered on a smartcard) are returned.
2052  *
2053  * This function does not skip unusable keys (see the documentation
2054  * for skip_unusable for an exact definition).
2055  *
2056  * If RET_KEYBLOCK is not NULL, the keyblock is returned in
2057  * *RET_KEYBLOCK.  This should be freed using release_kbnode().
2058  *
2059  * This function returns 0 on success.  Otherwise, an error code is
2060  * returned.  In particular, GPG_ERR_NO_PUBKEY or GPG_ERR_NO_SECKEY
2061  * (if want_secret is set) is returned if the key is not found.  */
2062 gpg_error_t
2063 getkey_bynames (getkey_ctx_t *retctx, PKT_public_key *pk,
2064                 strlist_t names, int want_secret, kbnode_t *ret_keyblock)
2065 {
2066   return key_byname (retctx, names, pk, want_secret, 1,
2067                      ret_keyblock, NULL);
2068 }
2069
2070
2071 /* Search for one key matching some criteria.
2072  *
2073  * If RETCTX is not NULL, then the constructed context is returned in
2074  * *RETCTX so that getpubkey_next can be used to get subsequent
2075  * results.  In this case, getkey_end() must be used to free the
2076  * search context.  If RETCTX is not NULL, then RET_KDBHD must be
2077  * NULL.
2078  *
2079  * If PK is not NULL, the public key of the first result is returned
2080  * in *PK.  Note: PK->REQ_USAGE must be valid!!!  If PK->REQ_USAGE is
2081  * set, it is used to filter the search results.  See the
2082  * documentation for finish_lookup to understand exactly how this is
2083  * used.  Note: The self-signed data has already been merged into the
2084  * public key using merge_selfsigs.  Free *PK by calling
2085  * release_public_key_parts (or, if PK was allocated using xfree, you
2086  * can use free_public_key, which calls release_public_key_parts(PK)
2087  * and then xfree(PK)).
2088  *
2089  * If NAME is not NULL, then a search query is constructed using
2090  * classify_user_id on the string.  In this case, even unusable keys
2091  * (see the documentation for skip_unusable for an exact definition of
2092  * unusable) are returned.  Otherwise, if --default-key was set, then
2093  * that key is returned (even if it is unusable).  If neither of these
2094  * conditions holds, then the first usable key is returned.
2095  *
2096  * If WANT_SECRET is set, then only keys with an available secret key
2097  * (either locally or via key registered on a smartcard) are returned.
2098  *
2099  * This function does not skip unusable keys (see the documentation
2100  * for skip_unusable for an exact definition).
2101  *
2102  * If RET_KEYBLOCK is not NULL, the keyblock is returned in
2103  * *RET_KEYBLOCK.  This should be freed using release_kbnode().
2104  *
2105  * This function returns 0 on success.  Otherwise, an error code is
2106  * returned.  In particular, GPG_ERR_NO_PUBKEY or GPG_ERR_NO_SECKEY
2107  * (if want_secret is set) is returned if the key is not found.
2108  *
2109  * FIXME: We also have the get_pubkey_byname function which has a
2110  * different semantic.  Should be merged with this one.  */
2111 gpg_error_t
2112 getkey_byname (ctrl_t ctrl, getkey_ctx_t *retctx, PKT_public_key *pk,
2113                const char *name, int want_secret, kbnode_t *ret_keyblock)
2114 {
2115   gpg_error_t err;
2116   strlist_t namelist = NULL;
2117   int with_unusable = 1;
2118   const char *def_secret_key = NULL;
2119
2120   if (want_secret && !name)
2121     def_secret_key = parse_def_secret_key (ctrl);
2122
2123   if (want_secret && !name && def_secret_key)
2124     add_to_strlist (&namelist, def_secret_key);
2125   else if (name)
2126     add_to_strlist (&namelist, name);
2127   else
2128     with_unusable = 0;
2129
2130   err = key_byname (retctx, namelist, pk, want_secret, with_unusable,
2131                     ret_keyblock, NULL);
2132
2133   /* FIXME: Check that we really return GPG_ERR_NO_SECKEY if
2134      WANT_SECRET has been used.  */
2135
2136   free_strlist (namelist);
2137
2138   return err;
2139 }
2140
2141
2142 /* Return the next search result.
2143  *
2144  * If PK is not NULL, the public key of the next result is returned in
2145  * *PK.  Note: The self-signed data has already been merged into the
2146  * public key using merge_selfsigs.  Free *PK by calling
2147  * release_public_key_parts (or, if PK was allocated using xmalloc, you
2148  * can use free_public_key, which calls release_public_key_parts(PK)
2149  * and then xfree(PK)).
2150  *
2151  * RET_KEYBLOCK can be given as NULL; if it is not NULL it the entire
2152  * found keyblock is returned which must be released with
2153  * release_kbnode.  If the function returns an error NULL is stored at
2154  * RET_KEYBLOCK.
2155  *
2156  * The self-signed data has already been merged into the public key
2157  * using merge_selfsigs.  */
2158 gpg_error_t
2159 getkey_next (getkey_ctx_t ctx, PKT_public_key *pk, kbnode_t *ret_keyblock)
2160 {
2161   int rc; /* Fixme:  Make sure this is proper gpg_error */
2162   KBNODE found_key = NULL;
2163
2164   /* We need to disable the caching so that for an exact key search we
2165      won't get the result back from the cache and thus end up in an
2166      endless loop.  The endless loop can occur, because the cache is
2167      used without respecting the current file pointer!  */
2168   keydb_disable_caching (ctx->kr_handle);
2169
2170   rc = lookup (ctx, ret_keyblock, &found_key, ctx->want_secret);
2171   if (!rc && pk)
2172     {
2173       log_assert (found_key);
2174       pk_from_block (pk, NULL, found_key);
2175     }
2176
2177   return rc;
2178 }
2179
2180
2181 /* Release any resources used by a key listing context.  This must be
2182  * called on the context returned by, e.g., getkey_byname.  */
2183 void
2184 getkey_end (getkey_ctx_t ctx)
2185 {
2186   if (ctx)
2187     {
2188       keydb_release (ctx->kr_handle);
2189       free_strlist (ctx->extra_list);
2190       if (!ctx->not_allocated)
2191         xfree (ctx);
2192     }
2193 }
2194
2195
2196 \f
2197 /************************************************
2198  ************* Merging stuff ********************
2199  ************************************************/
2200
2201 /* Set the mainkey_id fields for all keys in KEYBLOCK.  This is
2202  * usually done by merge_selfsigs but at some places we only need the
2203  * main_kid not a full merge.  The function also guarantees that all
2204  * pk->keyids are computed.  */
2205 void
2206 setup_main_keyids (kbnode_t keyblock)
2207 {
2208   u32 kid[2], mainkid[2];
2209   kbnode_t kbctx, node;
2210   PKT_public_key *pk;
2211
2212   if (keyblock->pkt->pkttype != PKT_PUBLIC_KEY)
2213     BUG ();
2214   pk = keyblock->pkt->pkt.public_key;
2215
2216   keyid_from_pk (pk, mainkid);
2217   for (kbctx=NULL; (node = walk_kbnode (keyblock, &kbctx, 0)); )
2218     {
2219       if (!(node->pkt->pkttype == PKT_PUBLIC_KEY
2220             || node->pkt->pkttype == PKT_PUBLIC_SUBKEY))
2221         continue;
2222       pk = node->pkt->pkt.public_key;
2223       keyid_from_pk (pk, kid); /* Make sure pk->keyid is set.  */
2224       if (!pk->main_keyid[0] && !pk->main_keyid[1])
2225         {
2226           pk->main_keyid[0] = mainkid[0];
2227           pk->main_keyid[1] = mainkid[1];
2228         }
2229     }
2230 }
2231
2232
2233 /* KEYBLOCK corresponds to a public key block.  This function merges
2234  * much of the information from the self-signed data into the public
2235  * key, public subkey and user id data structures.  If you use the
2236  * high-level search API (e.g., get_pubkey) for looking up key blocks,
2237  * then you don't need to call this function.  This function is
2238  * useful, however, if you change the keyblock, e.g., by adding or
2239  * removing a self-signed data packet.  */
2240 void
2241 merge_keys_and_selfsig (KBNODE keyblock)
2242 {
2243   if (!keyblock)
2244     ;
2245   else if (keyblock->pkt->pkttype == PKT_PUBLIC_KEY)
2246     merge_selfsigs (keyblock);
2247   else
2248     log_debug ("FIXME: merging secret key blocks is not anymore available\n");
2249 }
2250
2251
2252 static int
2253 parse_key_usage (PKT_signature * sig)
2254 {
2255   int key_usage = 0;
2256   const byte *p;
2257   size_t n;
2258   byte flags;
2259
2260   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_FLAGS, &n);
2261   if (p && n)
2262     {
2263       /* First octet of the keyflags.  */
2264       flags = *p;
2265
2266       if (flags & 1)
2267         {
2268           key_usage |= PUBKEY_USAGE_CERT;
2269           flags &= ~1;
2270         }
2271
2272       if (flags & 2)
2273         {
2274           key_usage |= PUBKEY_USAGE_SIG;
2275           flags &= ~2;
2276         }
2277
2278       /* We do not distinguish between encrypting communications and
2279          encrypting storage. */
2280       if (flags & (0x04 | 0x08))
2281         {
2282           key_usage |= PUBKEY_USAGE_ENC;
2283           flags &= ~(0x04 | 0x08);
2284         }
2285
2286       if (flags & 0x20)
2287         {
2288           key_usage |= PUBKEY_USAGE_AUTH;
2289           flags &= ~0x20;
2290         }
2291
2292       if (flags)
2293         key_usage |= PUBKEY_USAGE_UNKNOWN;
2294
2295       if (!key_usage)
2296         key_usage |= PUBKEY_USAGE_NONE;
2297     }
2298   else if (p) /* Key flags of length zero.  */
2299     key_usage |= PUBKEY_USAGE_NONE;
2300
2301   /* We set PUBKEY_USAGE_UNKNOWN to indicate that this key has a
2302      capability that we do not handle.  This serves to distinguish
2303      between a zero key usage which we handle as the default
2304      capabilities for that algorithm, and a usage that we do not
2305      handle.  Likewise we use PUBKEY_USAGE_NONE to indicate that
2306      key_flags have been given but they do not specify any usage.  */
2307
2308   return key_usage;
2309 }
2310
2311
2312 /* Apply information from SIGNODE (which is the valid self-signature
2313  * associated with that UID) to the UIDNODE:
2314  * - weather the UID has been revoked
2315  * - assumed creation date of the UID
2316  * - temporary store the keyflags here
2317  * - temporary store the key expiration time here
2318  * - mark whether the primary user ID flag hat been set.
2319  * - store the preferences
2320  */
2321 static void
2322 fixup_uidnode (KBNODE uidnode, KBNODE signode, u32 keycreated)
2323 {
2324   PKT_user_id *uid = uidnode->pkt->pkt.user_id;
2325   PKT_signature *sig = signode->pkt->pkt.signature;
2326   const byte *p, *sym, *hash, *zip;
2327   size_t n, nsym, nhash, nzip;
2328
2329   sig->flags.chosen_selfsig = 1;/* We chose this one. */
2330   uid->created = 0;             /* Not created == invalid. */
2331   if (IS_UID_REV (sig))
2332     {
2333       uid->is_revoked = 1;
2334       return; /* Has been revoked.  */
2335     }
2336   else
2337     uid->is_revoked = 0;
2338
2339   uid->expiredate = sig->expiredate;
2340
2341   if (sig->flags.expired)
2342     {
2343       uid->is_expired = 1;
2344       return; /* Has expired.  */
2345     }
2346   else
2347     uid->is_expired = 0;
2348
2349   uid->created = sig->timestamp; /* This one is okay. */
2350   uid->selfsigversion = sig->version;
2351   /* If we got this far, it's not expired :) */
2352   uid->is_expired = 0;
2353
2354   /* Store the key flags in the helper variable for later processing.  */
2355   uid->help_key_usage = parse_key_usage (sig);
2356
2357   /* Ditto for the key expiration.  */
2358   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
2359   if (p && buf32_to_u32 (p))
2360     uid->help_key_expire = keycreated + buf32_to_u32 (p);
2361   else
2362     uid->help_key_expire = 0;
2363
2364   /* Set the primary user ID flag - we will later wipe out some
2365    * of them to only have one in our keyblock.  */
2366   uid->is_primary = 0;
2367   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_PRIMARY_UID, NULL);
2368   if (p && *p)
2369     uid->is_primary = 2;
2370
2371   /* We could also query this from the unhashed area if it is not in
2372    * the hased area and then later try to decide which is the better
2373    * there should be no security problem with this.
2374    * For now we only look at the hashed one.  */
2375
2376   /* Now build the preferences list.  These must come from the
2377      hashed section so nobody can modify the ciphers a key is
2378      willing to accept.  */
2379   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_PREF_SYM, &n);
2380   sym = p;
2381   nsym = p ? n : 0;
2382   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_PREF_HASH, &n);
2383   hash = p;
2384   nhash = p ? n : 0;
2385   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_PREF_COMPR, &n);
2386   zip = p;
2387   nzip = p ? n : 0;
2388   if (uid->prefs)
2389     xfree (uid->prefs);
2390   n = nsym + nhash + nzip;
2391   if (!n)
2392     uid->prefs = NULL;
2393   else
2394     {
2395       uid->prefs = xmalloc (sizeof (*uid->prefs) * (n + 1));
2396       n = 0;
2397       for (; nsym; nsym--, n++)
2398         {
2399           uid->prefs[n].type = PREFTYPE_SYM;
2400           uid->prefs[n].value = *sym++;
2401         }
2402       for (; nhash; nhash--, n++)
2403         {
2404           uid->prefs[n].type = PREFTYPE_HASH;
2405           uid->prefs[n].value = *hash++;
2406         }
2407       for (; nzip; nzip--, n++)
2408         {
2409           uid->prefs[n].type = PREFTYPE_ZIP;
2410           uid->prefs[n].value = *zip++;
2411         }
2412       uid->prefs[n].type = PREFTYPE_NONE; /* End of list marker  */
2413       uid->prefs[n].value = 0;
2414     }
2415
2416   /* See whether we have the MDC feature.  */
2417   uid->flags.mdc = 0;
2418   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_FEATURES, &n);
2419   if (p && n && (p[0] & 0x01))
2420     uid->flags.mdc = 1;
2421
2422   /* And the keyserver modify flag.  */
2423   uid->flags.ks_modify = 1;
2424   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KS_FLAGS, &n);
2425   if (p && n && (p[0] & 0x80))
2426     uid->flags.ks_modify = 0;
2427 }
2428
2429 static void
2430 sig_to_revoke_info (PKT_signature * sig, struct revoke_info *rinfo)
2431 {
2432   rinfo->date = sig->timestamp;
2433   rinfo->algo = sig->pubkey_algo;
2434   rinfo->keyid[0] = sig->keyid[0];
2435   rinfo->keyid[1] = sig->keyid[1];
2436 }
2437
2438
2439 /* Given a keyblock, parse the key block and extract various pieces of
2440    information and save them with the primary key packet and the user
2441    id packets.  For instance, some information is stored in signature
2442    packets.  We find the latest such valid packet (since the user can
2443    change that information) and copy its contents into the
2444    PKT_public_key.
2445
2446    Note that R_REVOKED may be set to 0, 1 or 2.
2447
2448    This function fills in the following fields in the primary key's
2449    keyblock:
2450
2451      main_keyid          (computed)
2452      revkey / numrevkeys (derived from self signed key data)
2453      flags.valid         (whether we have at least 1 self-sig)
2454      flags.maybe_revoked (whether a designed revoked the key, but
2455                           we are missing the key to check the sig)
2456      selfsigversion      (highest version of any valid self-sig)
2457      pubkey_usage        (derived from most recent self-sig or most
2458                           recent user id)
2459      has_expired         (various sources)
2460      expiredate          (various sources)
2461
2462   See the documentation for fixup_uidnode for how the user id packets
2463   are modified.  In addition to that the primary user id's is_primary
2464   field is set to 1 and the other user id's is_primary are set to
2465   0.  */
2466 static void
2467 merge_selfsigs_main (KBNODE keyblock, int *r_revoked,
2468                      struct revoke_info *rinfo)
2469 {
2470   PKT_public_key *pk = NULL;
2471   KBNODE k;
2472   u32 kid[2];
2473   u32 sigdate, uiddate, uiddate2;
2474   KBNODE signode, uidnode, uidnode2;
2475   u32 curtime = make_timestamp ();
2476   unsigned int key_usage = 0;
2477   u32 keytimestamp = 0;
2478   u32 key_expire = 0;
2479   int key_expire_seen = 0;
2480   byte sigversion = 0;
2481
2482   *r_revoked = 0;
2483   memset (rinfo, 0, sizeof (*rinfo));
2484
2485   /* Section 11.1 of RFC 4880 determines the order of packets within a
2486      message.  There are three sections, which must occur in the
2487      following order: the public key, the user ids and user attributes
2488      and the subkeys.  Within each section, each primary packet (e.g.,
2489      a user id packet) is followed by one or more signature packets,
2490      which modify that packet.  */
2491
2492   /* According to Section 11.1 of RFC 4880, the public key must be the
2493      first packet.  */
2494   if (keyblock->pkt->pkttype != PKT_PUBLIC_KEY)
2495     /* parse_keyblock_image ensures that the first packet is the
2496        public key.  */
2497     BUG ();
2498   pk = keyblock->pkt->pkt.public_key;
2499   keytimestamp = pk->timestamp;
2500
2501   keyid_from_pk (pk, kid);
2502   pk->main_keyid[0] = kid[0];
2503   pk->main_keyid[1] = kid[1];
2504
2505   if (pk->version < 4)
2506     {
2507       /* Before v4 the key packet itself contains the expiration date
2508        * and there was no way to change it, so we start with the one
2509        * from the key packet.  */
2510       key_expire = pk->max_expiredate;
2511       key_expire_seen = 1;
2512     }
2513
2514   /* First pass:
2515
2516       - Find the latest direct key self-signature.  We assume that the
2517         newest one overrides all others.
2518
2519       - Determine whether the key has been revoked.
2520
2521       - Gather all revocation keys (unlike other data, we don't just
2522         take them from the latest self-signed packet).
2523
2524       - Determine max (sig[...]->version).
2525    */
2526
2527   /* Reset this in case this key was already merged. */
2528   xfree (pk->revkey);
2529   pk->revkey = NULL;
2530   pk->numrevkeys = 0;
2531
2532   signode = NULL;
2533   sigdate = 0; /* Helper variable to find the latest signature.  */
2534
2535   /* According to Section 11.1 of RFC 4880, the public key comes first
2536      and is immediately followed by any signature packets that modify
2537      it.  */
2538   for (k = keyblock;
2539        k && k->pkt->pkttype != PKT_USER_ID
2540          && k->pkt->pkttype != PKT_ATTRIBUTE
2541          && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
2542        k = k->next)
2543     {
2544       if (k->pkt->pkttype == PKT_SIGNATURE)
2545         {
2546           PKT_signature *sig = k->pkt->pkt.signature;
2547           if (sig->keyid[0] == kid[0] && sig->keyid[1] == kid[1])
2548             /* Self sig.  */
2549             {
2550               if (check_key_signature (keyblock, k, NULL))
2551                 ; /* Signature did not verify.  */
2552               else if (IS_KEY_REV (sig))
2553                 {
2554                   /* Key has been revoked - there is no way to
2555                    * override such a revocation, so we theoretically
2556                    * can stop now.  We should not cope with expiration
2557                    * times for revocations here because we have to
2558                    * assume that an attacker can generate all kinds of
2559                    * signatures.  However due to the fact that the key
2560                    * has been revoked it does not harm either and by
2561                    * continuing we gather some more info on that
2562                    * key.  */
2563                   *r_revoked = 1;
2564                   sig_to_revoke_info (sig, rinfo);
2565                 }
2566               else if (IS_KEY_SIG (sig))
2567                 {
2568                   /* Add the indicated revocations keys from all
2569                      signatures not just the latest.  We do this
2570                      because you need multiple 1F sigs to properly
2571                      handle revocation keys (PGP does it this way, and
2572                      a revocation key could be sensitive and hence in
2573                      a different signature). */
2574                   if (sig->revkey)
2575                     {
2576                       int i;
2577
2578                       pk->revkey =
2579                         xrealloc (pk->revkey, sizeof (struct revocation_key) *
2580                                   (pk->numrevkeys + sig->numrevkeys));
2581
2582                       for (i = 0; i < sig->numrevkeys; i++)
2583                         memcpy (&pk->revkey[pk->numrevkeys++],
2584                                 &sig->revkey[i],
2585                                 sizeof (struct revocation_key));
2586                     }
2587
2588                   if (sig->timestamp >= sigdate)
2589                     /* This is the latest signature so far.  */
2590                     {
2591                       if (sig->flags.expired)
2592                         ; /* Signature has expired - ignore it.  */
2593                       else
2594                         {
2595                           sigdate = sig->timestamp;
2596                           signode = k;
2597                           if (sig->version > sigversion)
2598                             sigversion = sig->version;
2599
2600                         }
2601                     }
2602                 }
2603             }
2604         }
2605     }
2606
2607   /* Remove dupes from the revocation keys.  */
2608   if (pk->revkey)
2609     {
2610       int i, j, x, changed = 0;
2611
2612       for (i = 0; i < pk->numrevkeys; i++)
2613         {
2614           for (j = i + 1; j < pk->numrevkeys; j++)
2615             {
2616               if (memcmp (&pk->revkey[i], &pk->revkey[j],
2617                           sizeof (struct revocation_key)) == 0)
2618                 {
2619                   /* remove j */
2620
2621                   for (x = j; x < pk->numrevkeys - 1; x++)
2622                     pk->revkey[x] = pk->revkey[x + 1];
2623
2624                   pk->numrevkeys--;
2625                   j--;
2626                   changed = 1;
2627                 }
2628             }
2629         }
2630
2631       if (changed)
2632         pk->revkey = xrealloc (pk->revkey,
2633                                pk->numrevkeys *
2634                                sizeof (struct revocation_key));
2635     }
2636
2637   if (signode)
2638     /* SIGNODE is the 1F signature packet with the latest creation
2639        time.  Extract some information from it.  */
2640     {
2641       /* Some information from a direct key signature take precedence
2642        * over the same information given in UID sigs.  */
2643       PKT_signature *sig = signode->pkt->pkt.signature;
2644       const byte *p;
2645
2646       key_usage = parse_key_usage (sig);
2647
2648       p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
2649       if (p && buf32_to_u32 (p))
2650         {
2651           key_expire = keytimestamp + buf32_to_u32 (p);
2652           key_expire_seen = 1;
2653         }
2654
2655       /* Mark that key as valid: One direct key signature should
2656        * render a key as valid.  */
2657       pk->flags.valid = 1;
2658     }
2659
2660   /* Pass 1.5: Look for key revocation signatures that were not made
2661      by the key (i.e. did a revocation key issue a revocation for
2662      us?).  Only bother to do this if there is a revocation key in the
2663      first place and we're not revoked already.  */
2664
2665   if (!*r_revoked && pk->revkey)
2666     for (k = keyblock; k && k->pkt->pkttype != PKT_USER_ID; k = k->next)
2667       {
2668         if (k->pkt->pkttype == PKT_SIGNATURE)
2669           {
2670             PKT_signature *sig = k->pkt->pkt.signature;
2671
2672             if (IS_KEY_REV (sig) &&
2673                 (sig->keyid[0] != kid[0] || sig->keyid[1] != kid[1]))
2674               {
2675                 int rc = check_revocation_keys (pk, sig);
2676                 if (rc == 0)
2677                   {
2678                     *r_revoked = 2;
2679                     sig_to_revoke_info (sig, rinfo);
2680                     /* Don't continue checking since we can't be any
2681                        more revoked than this.  */
2682                     break;
2683                   }
2684                 else if (gpg_err_code (rc) == GPG_ERR_NO_PUBKEY)
2685                   pk->flags.maybe_revoked = 1;
2686
2687                 /* A failure here means the sig did not verify, was
2688                    not issued by a revocation key, or a revocation
2689                    key loop was broken.  If a revocation key isn't
2690                    findable, however, the key might be revoked and
2691                    we don't know it.  */
2692
2693                 /* TODO: In the future handle subkey and cert
2694                    revocations?  PGP doesn't, but it's in 2440. */
2695               }
2696           }
2697       }
2698
2699   /* Second pass: Look at the self-signature of all user IDs.  */
2700
2701   /* According to RFC 4880 section 11.1, user id and attribute packets
2702      are in the second section, after the public key packet and before
2703      the subkey packets.  */
2704   signode = uidnode = NULL;
2705   sigdate = 0; /* Helper variable to find the latest signature in one UID. */
2706   for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next)
2707     {
2708       if (k->pkt->pkttype == PKT_USER_ID || k->pkt->pkttype == PKT_ATTRIBUTE)
2709         /* New user id packet.  */
2710         {
2711           if (uidnode && signode)
2712             /* Apply the data from the most recent self-signed packet
2713                to the preceding user id packet.  */
2714             {
2715               fixup_uidnode (uidnode, signode, keytimestamp);
2716               pk->flags.valid = 1;
2717             }
2718           /* Clear SIGNODE.  The only relevant self-signed data for
2719              UIDNODE follows it.  */
2720           if (k->pkt->pkttype == PKT_USER_ID)
2721             uidnode = k;
2722           else
2723             uidnode = NULL;
2724           signode = NULL;
2725           sigdate = 0;
2726         }
2727       else if (k->pkt->pkttype == PKT_SIGNATURE && uidnode)
2728         {
2729           PKT_signature *sig = k->pkt->pkt.signature;
2730           if (sig->keyid[0] == kid[0] && sig->keyid[1] == kid[1])
2731             {
2732               if (check_key_signature (keyblock, k, NULL))
2733                 ;               /* signature did not verify */
2734               else if ((IS_UID_SIG (sig) || IS_UID_REV (sig))
2735                        && sig->timestamp >= sigdate)
2736                 {
2737                   /* Note: we allow invalidation of cert revocations
2738                    * by a newer signature.  An attacker can't use this
2739                    * because a key should be revoked with a key revocation.
2740                    * The reason why we have to allow for that is that at
2741                    * one time an email address may become invalid but later
2742                    * the same email address may become valid again (hired,
2743                    * fired, hired again).  */
2744
2745                   sigdate = sig->timestamp;
2746                   signode = k;
2747                   signode->pkt->pkt.signature->flags.chosen_selfsig = 0;
2748                   if (sig->version > sigversion)
2749                     sigversion = sig->version;
2750                 }
2751             }
2752         }
2753     }
2754   if (uidnode && signode)
2755     {
2756       fixup_uidnode (uidnode, signode, keytimestamp);
2757       pk->flags.valid = 1;
2758     }
2759
2760   /* If the key isn't valid yet, and we have
2761      --allow-non-selfsigned-uid set, then force it valid. */
2762   if (!pk->flags.valid && opt.allow_non_selfsigned_uid)
2763     {
2764       if (opt.verbose)
2765         log_info (_("Invalid key %s made valid by"
2766                     " --allow-non-selfsigned-uid\n"), keystr_from_pk (pk));
2767       pk->flags.valid = 1;
2768     }
2769
2770   /* The key STILL isn't valid, so try and find an ultimately
2771      trusted signature. */
2772   if (!pk->flags.valid)
2773     {
2774       uidnode = NULL;
2775
2776       for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
2777            k = k->next)
2778         {
2779           if (k->pkt->pkttype == PKT_USER_ID)
2780             uidnode = k;
2781           else if (k->pkt->pkttype == PKT_SIGNATURE && uidnode)
2782             {
2783               PKT_signature *sig = k->pkt->pkt.signature;
2784
2785               if (sig->keyid[0] != kid[0] || sig->keyid[1] != kid[1])
2786                 {
2787                   PKT_public_key *ultimate_pk;
2788
2789                   ultimate_pk = xmalloc_clear (sizeof (*ultimate_pk));
2790
2791                   /* We don't want to use the full get_pubkey to
2792                      avoid infinite recursion in certain cases.
2793                      There is no reason to check that an ultimately
2794                      trusted key is still valid - if it has been
2795                      revoked the user should also remove the
2796                      ultimate trust flag.  */
2797                   if (get_pubkey_fast (ultimate_pk, sig->keyid) == 0
2798                       && check_key_signature2 (keyblock, k, ultimate_pk,
2799                                                NULL, NULL, NULL, NULL) == 0
2800                       && get_ownertrust (ultimate_pk) == TRUST_ULTIMATE)
2801                     {
2802                       free_public_key (ultimate_pk);
2803                       pk->flags.valid = 1;
2804                       break;
2805                     }
2806
2807                   free_public_key (ultimate_pk);
2808                 }
2809             }
2810         }
2811     }
2812
2813   /* Record the highest selfsig version so we know if this is a v3
2814      key through and through, or a v3 key with a v4 selfsig
2815      somewhere.  This is useful in a few places to know if the key
2816      must be treated as PGP2-style or OpenPGP-style.  Note that a
2817      selfsig revocation with a higher version number will also raise
2818      this value.  This is okay since such a revocation must be
2819      issued by the user (i.e. it cannot be issued by someone else to
2820      modify the key behavior.) */
2821
2822   pk->selfsigversion = sigversion;
2823
2824   /* Now that we had a look at all user IDs we can now get some information
2825    * from those user IDs.
2826    */
2827
2828   if (!key_usage)
2829     {
2830       /* Find the latest user ID with key flags set. */
2831       uiddate = 0; /* Helper to find the latest user ID.  */
2832       for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
2833            k = k->next)
2834         {
2835           if (k->pkt->pkttype == PKT_USER_ID)
2836             {
2837               PKT_user_id *uid = k->pkt->pkt.user_id;
2838               if (uid->help_key_usage && uid->created > uiddate)
2839                 {
2840                   key_usage = uid->help_key_usage;
2841                   uiddate = uid->created;
2842                 }
2843             }
2844         }
2845     }
2846   if (!key_usage)
2847     {
2848       /* No key flags at all: get it from the algo.  */
2849       key_usage = openpgp_pk_algo_usage (pk->pubkey_algo);
2850     }
2851   else
2852     {
2853       /* Check that the usage matches the usage as given by the algo.  */
2854       int x = openpgp_pk_algo_usage (pk->pubkey_algo);
2855       if (x) /* Mask it down to the actual allowed usage.  */
2856         key_usage &= x;
2857     }
2858
2859   /* Whatever happens, it's a primary key, so it can certify. */
2860   pk->pubkey_usage = key_usage | PUBKEY_USAGE_CERT;
2861
2862   if (!key_expire_seen)
2863     {
2864       /* Find the latest valid user ID with a key expiration set
2865        * Note, that this may be a different one from the above because
2866        * some user IDs may have no expiration date set.  */
2867       uiddate = 0;
2868       for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
2869            k = k->next)
2870         {
2871           if (k->pkt->pkttype == PKT_USER_ID)
2872             {
2873               PKT_user_id *uid = k->pkt->pkt.user_id;
2874               if (uid->help_key_expire && uid->created > uiddate)
2875                 {
2876                   key_expire = uid->help_key_expire;
2877                   uiddate = uid->created;
2878                 }
2879             }
2880         }
2881     }
2882
2883   /* Currently only v3 keys have a maximum expiration date, but I'll
2884      bet v5 keys get this feature again. */
2885   if (key_expire == 0
2886       || (pk->max_expiredate && key_expire > pk->max_expiredate))
2887     key_expire = pk->max_expiredate;
2888
2889   pk->has_expired = key_expire >= curtime ? 0 : key_expire;
2890   pk->expiredate = key_expire;
2891
2892   /* Fixme: we should see how to get rid of the expiretime fields  but
2893    * this needs changes at other places too. */
2894
2895   /* And now find the real primary user ID and delete all others.  */
2896   uiddate = uiddate2 = 0;
2897   uidnode = uidnode2 = NULL;
2898   for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next)
2899     {
2900       if (k->pkt->pkttype == PKT_USER_ID && !k->pkt->pkt.user_id->attrib_data)
2901         {
2902           PKT_user_id *uid = k->pkt->pkt.user_id;
2903           if (uid->is_primary)
2904             {
2905               if (uid->created > uiddate)
2906                 {
2907                   uiddate = uid->created;
2908                   uidnode = k;
2909                 }
2910               else if (uid->created == uiddate && uidnode)
2911                 {
2912                   /* The dates are equal, so we need to do a
2913                      different (and arbitrary) comparison.  This
2914                      should rarely, if ever, happen.  It's good to
2915                      try and guarantee that two different GnuPG
2916                      users with two different keyrings at least pick
2917                      the same primary. */
2918                   if (cmp_user_ids (uid, uidnode->pkt->pkt.user_id) > 0)
2919                     uidnode = k;
2920                 }
2921             }
2922           else
2923             {
2924               if (uid->created > uiddate2)
2925                 {
2926                   uiddate2 = uid->created;
2927                   uidnode2 = k;
2928                 }
2929               else if (uid->created == uiddate2 && uidnode2)
2930                 {
2931                   if (cmp_user_ids (uid, uidnode2->pkt->pkt.user_id) > 0)
2932                     uidnode2 = k;
2933                 }
2934             }
2935         }
2936     }
2937   if (uidnode)
2938     {
2939       for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
2940            k = k->next)
2941         {
2942           if (k->pkt->pkttype == PKT_USER_ID &&
2943               !k->pkt->pkt.user_id->attrib_data)
2944             {
2945               PKT_user_id *uid = k->pkt->pkt.user_id;
2946               if (k != uidnode)
2947                 uid->is_primary = 0;
2948             }
2949         }
2950     }
2951   else if (uidnode2)
2952     {
2953       /* None is flagged primary - use the latest user ID we have,
2954          and disambiguate with the arbitrary packet comparison. */
2955       uidnode2->pkt->pkt.user_id->is_primary = 1;
2956     }
2957   else
2958     {
2959       /* None of our uids were self-signed, so pick the one that
2960          sorts first to be the primary.  This is the best we can do
2961          here since there are no self sigs to date the uids. */
2962
2963       uidnode = NULL;
2964
2965       for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
2966            k = k->next)
2967         {
2968           if (k->pkt->pkttype == PKT_USER_ID
2969               && !k->pkt->pkt.user_id->attrib_data)
2970             {
2971               if (!uidnode)
2972                 {
2973                   uidnode = k;
2974                   uidnode->pkt->pkt.user_id->is_primary = 1;
2975                   continue;
2976                 }
2977               else
2978                 {
2979                   if (cmp_user_ids (k->pkt->pkt.user_id,
2980                                     uidnode->pkt->pkt.user_id) > 0)
2981                     {
2982                       uidnode->pkt->pkt.user_id->is_primary = 0;
2983                       uidnode = k;
2984                       uidnode->pkt->pkt.user_id->is_primary = 1;
2985                     }
2986                   else
2987                     k->pkt->pkt.user_id->is_primary = 0;        /* just to be
2988                                                                    safe */
2989                 }
2990             }
2991         }
2992     }
2993 }
2994
2995 /* Convert a buffer to a signature.  Useful for 0x19 embedded sigs.
2996    Caller must free the signature when they are done. */
2997 static PKT_signature *
2998 buf_to_sig (const byte * buf, size_t len)
2999 {
3000   PKT_signature *sig = xmalloc_clear (sizeof (PKT_signature));
3001   IOBUF iobuf = iobuf_temp_with_content (buf, len);
3002   int save_mode = set_packet_list_mode (0);
3003
3004   if (parse_signature (iobuf, PKT_SIGNATURE, len, sig) != 0)
3005     {
3006       xfree (sig);
3007       sig = NULL;
3008     }
3009
3010   set_packet_list_mode (save_mode);
3011   iobuf_close (iobuf);
3012
3013   return sig;
3014 }
3015
3016 /* Use the self-signed data to fill in various fields in subkeys.
3017
3018    KEYBLOCK is the whole keyblock.  SUBNODE is the subkey to fill in.
3019
3020    Sets the following fields on the subkey:
3021
3022      main_keyid
3023      flags.valid        if the subkey has a valid self-sig binding
3024      flags.revoked
3025      flags.backsig
3026      pubkey_usage
3027      has_expired
3028      expired_date
3029
3030    On this subkey's most revent valid self-signed packet, the
3031    following field is set:
3032
3033      flags.chosen_selfsig
3034   */
3035 static void
3036 merge_selfsigs_subkey (KBNODE keyblock, KBNODE subnode)
3037 {
3038   PKT_public_key *mainpk = NULL, *subpk = NULL;
3039   PKT_signature *sig;
3040   KBNODE k;
3041   u32 mainkid[2];
3042   u32 sigdate = 0;
3043   KBNODE signode;
3044   u32 curtime = make_timestamp ();
3045   unsigned int key_usage = 0;
3046   u32 keytimestamp = 0;
3047   u32 key_expire = 0;
3048   const byte *p;
3049
3050   if (subnode->pkt->pkttype != PKT_PUBLIC_SUBKEY)
3051     BUG ();
3052   mainpk = keyblock->pkt->pkt.public_key;
3053   if (mainpk->version < 4)
3054     return;/* (actually this should never happen) */
3055   keyid_from_pk (mainpk, mainkid);
3056   subpk = subnode->pkt->pkt.public_key;
3057   keytimestamp = subpk->timestamp;
3058
3059   subpk->flags.valid = 0;
3060   subpk->flags.exact = 0;
3061   subpk->main_keyid[0] = mainpk->main_keyid[0];
3062   subpk->main_keyid[1] = mainpk->main_keyid[1];
3063
3064   /* Find the latest key binding self-signature.  */
3065   signode = NULL;
3066   sigdate = 0; /* Helper to find the latest signature.  */
3067   for (k = subnode->next; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
3068        k = k->next)
3069     {
3070       if (k->pkt->pkttype == PKT_SIGNATURE)
3071         {
3072           sig = k->pkt->pkt.signature;
3073           if (sig->keyid[0] == mainkid[0] && sig->keyid[1] == mainkid[1])
3074             {
3075               if (check_key_signature (keyblock, k, NULL))
3076                 ; /* Signature did not verify.  */
3077               else if (IS_SUBKEY_REV (sig))
3078                 {
3079                   /* Note that this means that the date on a
3080                      revocation sig does not matter - even if the
3081                      binding sig is dated after the revocation sig,
3082                      the subkey is still marked as revoked.  This
3083                      seems ok, as it is just as easy to make new
3084                      subkeys rather than re-sign old ones as the
3085                      problem is in the distribution.  Plus, PGP (7)
3086                      does this the same way.  */
3087                   subpk->flags.revoked = 1;
3088                   sig_to_revoke_info (sig, &subpk->revoked);
3089                   /* Although we could stop now, we continue to
3090                    * figure out other information like the old expiration
3091                    * time.  */
3092                 }
3093               else if (IS_SUBKEY_SIG (sig) && sig->timestamp >= sigdate)
3094                 {
3095                   if (sig->flags.expired)
3096                     ; /* Signature has expired - ignore it.  */
3097                   else
3098                     {
3099                       sigdate = sig->timestamp;
3100                       signode = k;
3101                       signode->pkt->pkt.signature->flags.chosen_selfsig = 0;
3102                     }
3103                 }
3104             }
3105         }
3106     }
3107
3108   /* No valid key binding.  */
3109   if (!signode)
3110     return;
3111
3112   sig = signode->pkt->pkt.signature;
3113   sig->flags.chosen_selfsig = 1; /* So we know which selfsig we chose later.  */
3114
3115   key_usage = parse_key_usage (sig);
3116   if (!key_usage)
3117     {
3118       /* No key flags at all: get it from the algo.  */
3119       key_usage = openpgp_pk_algo_usage (subpk->pubkey_algo);
3120     }
3121   else
3122     {
3123       /* Check that the usage matches the usage as given by the algo.  */
3124       int x = openpgp_pk_algo_usage (subpk->pubkey_algo);
3125       if (x) /* Mask it down to the actual allowed usage.  */
3126         key_usage &= x;
3127     }
3128
3129   subpk->pubkey_usage = key_usage;
3130
3131   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
3132   if (p && buf32_to_u32 (p))
3133     key_expire = keytimestamp + buf32_to_u32 (p);
3134   else
3135     key_expire = 0;
3136   subpk->has_expired = key_expire >= curtime ? 0 : key_expire;
3137   subpk->expiredate = key_expire;
3138
3139   /* Algo doesn't exist.  */
3140   if (openpgp_pk_test_algo (subpk->pubkey_algo))
3141     return;
3142
3143   subpk->flags.valid = 1;
3144
3145   /* Find the most recent 0x19 embedded signature on our self-sig. */
3146   if (!subpk->flags.backsig)
3147     {
3148       int seq = 0;
3149       size_t n;
3150       PKT_signature *backsig = NULL;
3151
3152       sigdate = 0;
3153
3154       /* We do this while() since there may be other embedded
3155          signatures in the future.  We only want 0x19 here. */
3156
3157       while ((p = enum_sig_subpkt (sig->hashed,
3158                                    SIGSUBPKT_SIGNATURE, &n, &seq, NULL)))
3159         if (n > 3
3160             && ((p[0] == 3 && p[2] == 0x19) || (p[0] == 4 && p[1] == 0x19)))
3161           {
3162             PKT_signature *tempsig = buf_to_sig (p, n);
3163             if (tempsig)
3164               {
3165                 if (tempsig->timestamp > sigdate)
3166                   {
3167                     if (backsig)
3168                       free_seckey_enc (backsig);
3169
3170                     backsig = tempsig;
3171                     sigdate = backsig->timestamp;
3172                   }
3173                 else
3174                   free_seckey_enc (tempsig);
3175               }
3176           }
3177
3178       seq = 0;
3179
3180       /* It is safe to have this in the unhashed area since the 0x19
3181          is located on the selfsig for convenience, not security. */
3182
3183       while ((p = enum_sig_subpkt (sig->unhashed, SIGSUBPKT_SIGNATURE,
3184                                    &n, &seq, NULL)))
3185         if (n > 3
3186             && ((p[0] == 3 && p[2] == 0x19) || (p[0] == 4 && p[1] == 0x19)))
3187           {
3188             PKT_signature *tempsig = buf_to_sig (p, n);
3189             if (tempsig)
3190               {
3191                 if (tempsig->timestamp > sigdate)
3192                   {
3193                     if (backsig)
3194                       free_seckey_enc (backsig);
3195
3196                     backsig = tempsig;
3197                     sigdate = backsig->timestamp;
3198                   }
3199                 else
3200                   free_seckey_enc (tempsig);
3201               }
3202           }
3203
3204       if (backsig)
3205         {
3206           /* At this point, backsig contains the most recent 0x19 sig.
3207              Let's see if it is good. */
3208
3209           /* 2==valid, 1==invalid, 0==didn't check */
3210           if (check_backsig (mainpk, subpk, backsig) == 0)
3211             subpk->flags.backsig = 2;
3212           else
3213             subpk->flags.backsig = 1;
3214
3215           free_seckey_enc (backsig);
3216         }
3217     }
3218 }
3219
3220
3221 /* Merge information from the self-signatures with the public key,
3222    subkeys and user ids to make using them more easy.
3223
3224    See documentation for merge_selfsigs_main, merge_selfsigs_subkey
3225    and fixup_uidnode for exactly which fields are updated.  */
3226 static void
3227 merge_selfsigs (KBNODE keyblock)
3228 {
3229   KBNODE k;
3230   int revoked;
3231   struct revoke_info rinfo;
3232   PKT_public_key *main_pk;
3233   prefitem_t *prefs;
3234   unsigned int mdc_feature;
3235
3236   if (keyblock->pkt->pkttype != PKT_PUBLIC_KEY)
3237     {
3238       if (keyblock->pkt->pkttype == PKT_SECRET_KEY)
3239         {
3240           log_error ("expected public key but found secret key "
3241                      "- must stop\n");
3242           /* We better exit here because a public key is expected at
3243              other places too.  FIXME: Figure this out earlier and
3244              don't get to here at all */
3245           g10_exit (1);
3246         }
3247       BUG ();
3248     }
3249
3250   merge_selfsigs_main (keyblock, &revoked, &rinfo);
3251
3252   /* Now merge in the data from each of the subkeys.  */
3253   for (k = keyblock; k; k = k->next)
3254     {
3255       if (k->pkt->pkttype == PKT_PUBLIC_SUBKEY)
3256         {
3257           merge_selfsigs_subkey (keyblock, k);
3258         }
3259     }
3260
3261   main_pk = keyblock->pkt->pkt.public_key;
3262   if (revoked || main_pk->has_expired || !main_pk->flags.valid)
3263     {
3264       /* If the primary key is revoked, expired, or invalid we
3265        * better set the appropriate flags on that key and all
3266        * subkeys.  */
3267       for (k = keyblock; k; k = k->next)
3268         {
3269           if (k->pkt->pkttype == PKT_PUBLIC_KEY
3270               || k->pkt->pkttype == PKT_PUBLIC_SUBKEY)
3271             {
3272               PKT_public_key *pk = k->pkt->pkt.public_key;
3273               if (!main_pk->flags.valid)
3274                 pk->flags.valid = 0;
3275               if (revoked && !pk->flags.revoked)
3276                 {
3277                   pk->flags.revoked = revoked;
3278                   memcpy (&pk->revoked, &rinfo, sizeof (rinfo));
3279                 }
3280               if (main_pk->has_expired)
3281                 pk->has_expired = main_pk->has_expired;
3282             }
3283         }
3284       return;
3285     }
3286
3287   /* Set the preference list of all keys to those of the primary real
3288    * user ID.  Note: we use these preferences when we don't know by
3289    * which user ID the key has been selected.
3290    * fixme: we should keep atoms of commonly used preferences or
3291    * use reference counting to optimize the preference lists storage.
3292    * FIXME: it might be better to use the intersection of
3293    * all preferences.
3294    * Do a similar thing for the MDC feature flag.  */
3295   prefs = NULL;
3296   mdc_feature = 0;
3297   for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next)
3298     {
3299       if (k->pkt->pkttype == PKT_USER_ID
3300           && !k->pkt->pkt.user_id->attrib_data
3301           && k->pkt->pkt.user_id->is_primary)
3302         {
3303           prefs = k->pkt->pkt.user_id->prefs;
3304           mdc_feature = k->pkt->pkt.user_id->flags.mdc;
3305           break;
3306         }
3307     }
3308   for (k = keyblock; k; k = k->next)
3309     {
3310       if (k->pkt->pkttype == PKT_PUBLIC_KEY
3311           || k->pkt->pkttype == PKT_PUBLIC_SUBKEY)
3312         {
3313           PKT_public_key *pk = k->pkt->pkt.public_key;
3314           if (pk->prefs)
3315             xfree (pk->prefs);
3316           pk->prefs = copy_prefs (prefs);
3317           pk->flags.mdc = mdc_feature;
3318         }
3319     }
3320 }
3321
3322
3323 \f
3324 /* See whether the key satisfies any additional requirements specified
3325  * in CTX.  If so, return the node of an appropriate key or subkey.
3326  * Otherwise, return NULL if there was no appropriate key.
3327  *
3328  * In case the primary key is not required, select a suitable subkey.
3329  * We need the primary key if PUBKEY_USAGE_CERT is set in REQ_USAGE or
3330  * we are in PGP6 or PGP7 mode and PUBKEY_USAGE_SIG is set in
3331  * REQ_USAGE.
3332  *
3333  * If any of PUBKEY_USAGE_SIG, PUBKEY_USAGE_ENC and PUBKEY_USAGE_CERT
3334  * are set in REQ_USAGE, we filter by the key's function.  Concretely,
3335  * if PUBKEY_USAGE_SIG and PUBKEY_USAGE_CERT are set, then we only
3336  * return a key if it is (at least) either a signing or a
3337  * certification key.
3338  *
3339  * If REQ_USAGE is set, then we reject any keys that are not good
3340  * (i.e., valid, not revoked, not expired, etc.).  This allows the
3341  * getkey functions to be used for plain key listings.
3342  *
3343  * Sets the matched key's user id field (pk->user_id) to the user id
3344  * that matched the low-level search criteria or NULL.
3345  *
3346  * If R_FLAGS is not NULL set certain flags for more detailed error
3347  * reporting.  Used flags are:
3348  *
3349  * - LOOKUP_ALL_SUBKEYS_EXPIRED :: All Subkeys are expired or have
3350  *                                 been revoked.
3351  * - LOOKUP_NOT_SELECTED :: No suitable key found
3352  *
3353  * This function needs to handle several different cases:
3354  *
3355  *  1. No requested usage and no primary key requested
3356  *     Examples for this case are that we have a keyID to be used
3357  *     for decrytion or verification.
3358  *  2. No usage but primary key requested
3359  *     This is the case for all functions which work on an
3360  *     entire keyblock, e.g. for editing or listing
3361  *  3. Usage and primary key requested
3362  *     FIXME
3363  *  4. Usage but no primary key requested
3364  *     FIXME
3365  *
3366  */
3367 static kbnode_t
3368 finish_lookup (kbnode_t keyblock, unsigned int req_usage, int want_exact,
3369                unsigned int *r_flags)
3370 {
3371   kbnode_t k;
3372
3373   /* If WANT_EXACT is set, the key or subkey that actually matched the
3374      low-level search criteria.  */
3375   kbnode_t foundk = NULL;
3376   /* The user id (if any) that matched the low-level search criteria.  */
3377   PKT_user_id *foundu = NULL;
3378
3379   u32 latest_date;
3380   kbnode_t latest_key;
3381   PKT_public_key *pk;
3382   int req_prim;
3383   u32 curtime = make_timestamp ();
3384
3385   if (r_flags)
3386     *r_flags = 0;
3387
3388 #define USAGE_MASK  (PUBKEY_USAGE_SIG|PUBKEY_USAGE_ENC|PUBKEY_USAGE_CERT)
3389   req_usage &= USAGE_MASK;
3390
3391   /* Request the primary if we're certifying another key, and also if
3392    * signing data while --pgp6 or --pgp7 is on since pgp 6 and 7 do
3393    * not understand signatures made by a signing subkey.  PGP 8 does. */
3394   req_prim = ((req_usage & PUBKEY_USAGE_CERT)
3395               || ((PGP6 || PGP7) && (req_usage & PUBKEY_USAGE_SIG)));
3396
3397
3398   log_assert (keyblock->pkt->pkttype == PKT_PUBLIC_KEY);
3399
3400   /* For an exact match mark the primary or subkey that matched the
3401      low-level search criteria.  */
3402   if (want_exact)
3403     {
3404       for (k = keyblock; k; k = k->next)
3405         {
3406           if ((k->flag & 1))
3407             {
3408               log_assert (k->pkt->pkttype == PKT_PUBLIC_KEY
3409                           || k->pkt->pkttype == PKT_PUBLIC_SUBKEY);
3410               foundk = k;
3411               pk = k->pkt->pkt.public_key;
3412               pk->flags.exact = 1;
3413               break;
3414             }
3415         }
3416     }
3417
3418   /* Get the user id that matched that low-level search criteria.  */
3419   for (k = keyblock; k; k = k->next)
3420     {
3421       if ((k->flag & 2))
3422         {
3423           log_assert (k->pkt->pkttype == PKT_USER_ID);
3424           foundu = k->pkt->pkt.user_id;
3425           break;
3426         }
3427     }
3428
3429   if (DBG_LOOKUP)
3430     log_debug ("finish_lookup: checking key %08lX (%s)(req_usage=%x)\n",
3431                (ulong) keyid_from_pk (keyblock->pkt->pkt.public_key, NULL),
3432                foundk ? "one" : "all", req_usage);
3433
3434   if (!req_usage)
3435     {
3436       latest_key = foundk ? foundk : keyblock;
3437       goto found;
3438     }
3439
3440   latest_date = 0;
3441   latest_key = NULL;
3442   /* Set LATEST_KEY to the latest (the one with the most recent
3443    * timestamp) good (valid, not revoked, not expired, etc.) subkey.
3444    *
3445    * Don't bother if we are only looking for a primary key or we need
3446    * an exact match and the exact match is not a subkey.  */
3447   if (req_prim || (foundk && foundk->pkt->pkttype != PKT_PUBLIC_SUBKEY))
3448     ;
3449   else
3450     {
3451       kbnode_t nextk;
3452       int n_subkeys = 0;
3453       int n_revoked_or_expired = 0;
3454
3455       /* Either start a loop or check just this one subkey.  */
3456       for (k = foundk ? foundk : keyblock; k; k = nextk)
3457         {
3458           if (foundk)
3459             {
3460               /* If FOUNDK is not NULL, then only consider that exact
3461                  key, i.e., don't iterate.  */
3462               nextk = NULL;
3463             }
3464           else
3465             nextk = k->next;
3466
3467           if (k->pkt->pkttype != PKT_PUBLIC_SUBKEY)
3468             continue;
3469
3470           pk = k->pkt->pkt.public_key;
3471           if (DBG_LOOKUP)
3472             log_debug ("\tchecking subkey %08lX\n",
3473                        (ulong) keyid_from_pk (pk, NULL));
3474
3475           if (!pk->flags.valid)
3476             {
3477               if (DBG_LOOKUP)
3478                 log_debug ("\tsubkey not valid\n");
3479               continue;
3480             }
3481           if (!((pk->pubkey_usage & USAGE_MASK) & req_usage))
3482             {
3483               if (DBG_LOOKUP)
3484                 log_debug ("\tusage does not match: want=%x have=%x\n",
3485                            req_usage, pk->pubkey_usage);
3486               continue;
3487             }
3488
3489           n_subkeys++;
3490           if (pk->flags.revoked)
3491             {
3492               if (DBG_LOOKUP)
3493                 log_debug ("\tsubkey has been revoked\n");
3494               n_revoked_or_expired++;
3495               continue;
3496             }
3497           if (pk->has_expired)
3498             {
3499               if (DBG_LOOKUP)
3500                 log_debug ("\tsubkey has expired\n");
3501               n_revoked_or_expired++;
3502               continue;
3503             }
3504           if (pk->timestamp > curtime && !opt.ignore_valid_from)
3505             {
3506               if (DBG_LOOKUP)
3507                 log_debug ("\tsubkey not yet valid\n");
3508               continue;
3509             }
3510
3511           if (DBG_LOOKUP)
3512             log_debug ("\tsubkey might be fine\n");
3513           /* In case a key has a timestamp of 0 set, we make sure
3514              that it is used.  A better change would be to compare
3515              ">=" but that might also change the selected keys and
3516              is as such a more intrusive change.  */
3517           if (pk->timestamp > latest_date || (!pk->timestamp && !latest_date))
3518             {
3519               latest_date = pk->timestamp;
3520               latest_key = k;
3521             }
3522         }
3523       if (n_subkeys == n_revoked_or_expired && r_flags)
3524         *r_flags |= LOOKUP_ALL_SUBKEYS_EXPIRED;
3525     }
3526
3527   /* Check if the primary key is ok (valid, not revoke, not expire,
3528    * matches requested usage) if:
3529    *
3530    *   - we didn't find an appropriate subkey and we're not doing an
3531    *     exact search,
3532    *
3533    *   - we're doing an exact match and the exact match was the
3534    *     primary key, or,
3535    *
3536    *   - we're just considering the primary key.  */
3537   if ((!latest_key && !want_exact) || foundk == keyblock || req_prim)
3538     {
3539       if (DBG_LOOKUP && !foundk && !req_prim)
3540         log_debug ("\tno suitable subkeys found - trying primary\n");
3541       pk = keyblock->pkt->pkt.public_key;
3542       if (!pk->flags.valid)
3543         {
3544           if (DBG_LOOKUP)
3545             log_debug ("\tprimary key not valid\n");
3546         }
3547       else if (!((pk->pubkey_usage & USAGE_MASK) & req_usage))
3548         {
3549           if (DBG_LOOKUP)
3550             log_debug ("\tprimary key usage does not match: "
3551                        "want=%x have=%x\n", req_usage, pk->pubkey_usage);
3552         }
3553       else if (pk->flags.revoked)
3554         {
3555           if (DBG_LOOKUP)
3556             log_debug ("\tprimary key has been revoked\n");
3557         }
3558       else if (pk->has_expired)
3559         {
3560           if (DBG_LOOKUP)
3561             log_debug ("\tprimary key has expired\n");
3562         }
3563       else /* Okay.  */
3564         {
3565           if (DBG_LOOKUP)
3566             log_debug ("\tprimary key may be used\n");
3567           latest_key = keyblock;
3568         }
3569     }
3570
3571   if (!latest_key)
3572     {
3573       if (DBG_LOOKUP)
3574         log_debug ("\tno suitable key found -  giving up\n");
3575       if (r_flags)
3576         *r_flags |= LOOKUP_NOT_SELECTED;
3577       return NULL; /* Not found.  */
3578     }
3579
3580  found:
3581   if (DBG_LOOKUP)
3582     log_debug ("\tusing key %08lX\n",
3583                (ulong) keyid_from_pk (latest_key->pkt->pkt.public_key, NULL));
3584
3585   if (latest_key)
3586     {
3587       pk = latest_key->pkt->pkt.public_key;
3588       if (pk->user_id)
3589         free_user_id (pk->user_id);
3590       pk->user_id = scopy_user_id (foundu);
3591     }
3592
3593   if (latest_key != keyblock && opt.verbose)
3594     {
3595       char *tempkeystr =
3596         xstrdup (keystr_from_pk (latest_key->pkt->pkt.public_key));
3597       log_info (_("using subkey %s instead of primary key %s\n"),
3598                 tempkeystr, keystr_from_pk (keyblock->pkt->pkt.public_key));
3599       xfree (tempkeystr);
3600     }
3601
3602   cache_user_id (keyblock);
3603
3604   return latest_key ? latest_key : keyblock; /* Found.  */
3605 }
3606
3607
3608 /* Print a KEY_CONSIDERED status line.  */
3609 static void
3610 print_status_key_considered (kbnode_t keyblock, unsigned int flags)
3611 {
3612   char hexfpr[2*MAX_FINGERPRINT_LEN + 1];
3613   kbnode_t node;
3614   char flagbuf[20];
3615
3616   if (!is_status_enabled ())
3617     return;
3618
3619   for (node=keyblock; node; node = node->next)
3620     if (node->pkt->pkttype == PKT_PUBLIC_KEY
3621         || node->pkt->pkttype == PKT_SECRET_KEY)
3622       break;
3623   if (!node)
3624     {
3625       log_error ("%s: keyblock w/o primary key\n", __func__);
3626       return;
3627     }
3628
3629   hexfingerprint (node->pkt->pkt.public_key, hexfpr, sizeof hexfpr);
3630   snprintf (flagbuf, sizeof flagbuf, " %u", flags);
3631   write_status_strings (STATUS_KEY_CONSIDERED, hexfpr, flagbuf, NULL);
3632 }
3633
3634
3635
3636 /* A high-level function to lookup keys.
3637
3638    This function builds on top of the low-level keydb API.  It first
3639    searches the database using the description stored in CTX->ITEMS,
3640    then it filters the results using CTX and, finally, if WANT_SECRET
3641    is set, it ignores any keys for which no secret key is available.
3642
3643    Unlike the low-level search functions, this function also merges
3644    all of the self-signed data into the keys, subkeys and user id
3645    packets (see the merge_selfsigs for details).
3646
3647    On success the key's keyblock is stored at *RET_KEYBLOCK.  */
3648 static int
3649 lookup (getkey_ctx_t ctx, kbnode_t *ret_keyblock, kbnode_t *ret_found_key,
3650         int want_secret)
3651 {
3652   int rc;
3653   int no_suitable_key = 0;
3654   KBNODE keyblock = NULL;
3655   KBNODE found_key = NULL;
3656   unsigned int infoflags;
3657
3658   if (ret_keyblock)
3659     *ret_keyblock = NULL;
3660
3661   for (;;)
3662     {
3663       rc = keydb_search (ctx->kr_handle, ctx->items, ctx->nitems, NULL);
3664       if (rc)
3665         break;
3666
3667       /* If we are iterating over the entire database, then we need to
3668          change from KEYDB_SEARCH_MODE_FIRST, which does an implicit
3669          reset, to KEYDB_SEARCH_MODE_NEXT, which gets the next
3670          record.  */
3671       if (ctx->nitems && ctx->items->mode == KEYDB_SEARCH_MODE_FIRST)
3672         ctx->items->mode = KEYDB_SEARCH_MODE_NEXT;
3673
3674       rc = keydb_get_keyblock (ctx->kr_handle, &keyblock);
3675       if (rc)
3676         {
3677           log_error ("keydb_get_keyblock failed: %s\n", gpg_strerror (rc));
3678           goto skip;
3679         }
3680
3681       if (want_secret && agent_probe_any_secret_key (NULL, keyblock))
3682         goto skip; /* No secret key available.  */
3683
3684       /* Warning: node flag bits 0 and 1 should be preserved by
3685        * merge_selfsigs.  */
3686       merge_selfsigs (keyblock);
3687       found_key = finish_lookup (keyblock, ctx->req_usage, ctx->exact,
3688                                  &infoflags);
3689       print_status_key_considered (keyblock, infoflags);
3690       if (found_key)
3691         {
3692           no_suitable_key = 0;
3693           goto found;
3694         }
3695       else
3696         {
3697           no_suitable_key = 1;
3698         }
3699
3700     skip:
3701       /* Release resources and continue search. */
3702       release_kbnode (keyblock);
3703       keyblock = NULL;
3704       /* The keyblock cache ignores the current "file position".
3705          Thus, if we request the next result and the cache matches
3706          (and it will since it is what we just looked for), we'll get
3707          the same entry back!  We can avoid this infinite loop by
3708          disabling the cache.  */
3709       keydb_disable_caching (ctx->kr_handle);
3710     }
3711
3712  found:
3713   if (rc && gpg_err_code (rc) != GPG_ERR_NOT_FOUND)
3714     log_error ("keydb_search failed: %s\n", gpg_strerror (rc));
3715
3716   if (!rc)
3717     {
3718       if (ret_keyblock)
3719         *ret_keyblock = keyblock; /* Return the keyblock.  */
3720       keyblock = NULL;
3721     }
3722   else if (gpg_err_code (rc) == GPG_ERR_NOT_FOUND && no_suitable_key)
3723     rc = want_secret? GPG_ERR_UNUSABLE_SECKEY : GPG_ERR_UNUSABLE_PUBKEY;
3724   else if (gpg_err_code (rc) == GPG_ERR_NOT_FOUND)
3725     rc = want_secret? GPG_ERR_NO_SECKEY : GPG_ERR_NO_PUBKEY;
3726
3727   release_kbnode (keyblock);
3728
3729   if (ret_found_key)
3730     {
3731       if (! rc)
3732         *ret_found_key = found_key;
3733       else
3734         *ret_found_key = NULL;
3735     }
3736
3737   return rc;
3738 }
3739
3740
3741 /* Enumerate some secret keys (specifically, those specified with
3742  * --default-key and --try-secret-key).  Use the following procedure:
3743  *
3744  *  1) Initialize a void pointer to NULL
3745  *  2) Pass a reference to this pointer to this function (content)
3746  *     and provide space for the secret key (sk)
3747  *  3) Call this function as long as it does not return an error (or
3748  *     until you are done).  The error code GPG_ERR_EOF indicates the
3749  *     end of the listing.
3750  *  4) Call this function a last time with SK set to NULL,
3751  *     so that can free it's context.
3752  *
3753  * In pseudo-code:
3754  *
3755  *   void *ctx = NULL;
3756  *   PKT_public_key *sk = xmalloc_clear (sizeof (*sk));
3757  *
3758  *   while ((err = enum_secret_keys (&ctx, sk)))
3759  *     { // Process SK.
3760  *       if (done)
3761  *         break;
3762  *       free_public_key (sk);
3763  *       sk = xmalloc_clear (sizeof (*sk));
3764  *     }
3765  *
3766  *   // Release any resources used by CTX.
3767  *   enum_secret_keys (&ctx, NULL);
3768  *   free_public_key (sk);
3769  *
3770  *   if (gpg_err_code (err) != GPG_ERR_EOF)
3771  *     ; // An error occurred.
3772  */
3773 gpg_error_t
3774 enum_secret_keys (ctrl_t ctrl, void **context, PKT_public_key *sk)
3775 {
3776   gpg_error_t err = 0;
3777   const char *name;
3778   kbnode_t keyblock;
3779   struct
3780   {
3781     int eof;
3782     int state;
3783     strlist_t sl;
3784     kbnode_t keyblock;
3785     kbnode_t node;
3786     getkey_ctx_t ctx;
3787   } *c = *context;
3788
3789   if (!c)
3790     {
3791       /* Make a new context.  */
3792       c = xtrycalloc (1, sizeof *c);
3793       if (!c)
3794         return gpg_error_from_syserror ();
3795       *context = c;
3796     }
3797
3798   if (!sk)
3799     {
3800       /* Free the context.  */
3801       release_kbnode (c->keyblock);
3802       getkey_end (c->ctx);
3803       xfree (c);
3804       *context = NULL;
3805       return 0;
3806     }
3807
3808   if (c->eof)
3809     return gpg_error (GPG_ERR_EOF);
3810
3811   for (;;)
3812     {
3813       /* Loop until we have a keyblock.  */
3814       while (!c->keyblock)
3815         {
3816           /* Loop over the list of secret keys.  */
3817           do
3818             {
3819               name = NULL;
3820               keyblock = NULL;
3821               switch (c->state)
3822                 {
3823                 case 0: /* First try to use the --default-key.  */
3824                   name = parse_def_secret_key (ctrl);
3825                   c->state = 1;
3826                   break;
3827
3828                 case 1: /* Init list of keys to try.  */
3829                   c->sl = opt.secret_keys_to_try;
3830                   c->state++;
3831                   break;
3832
3833                 case 2: /* Get next item from list.  */
3834                   if (c->sl)
3835                     {
3836                       name = c->sl->d;
3837                       c->sl = c->sl->next;
3838                     }
3839                   else
3840                     c->state++;
3841                   break;
3842
3843                 case 3: /* Init search context to enum all secret keys.  */
3844                   err = getkey_bynames (&c->ctx, NULL, NULL, 1, &keyblock);
3845                   if (err)
3846                     {
3847                       release_kbnode (keyblock);
3848                       keyblock = NULL;
3849                       getkey_end (c->ctx);
3850                       c->ctx = NULL;
3851                     }
3852                   c->state++;
3853                   break;
3854
3855                 case 4: /* Get next item from the context.  */
3856                   if (c->ctx)
3857                     {
3858                       err = getkey_next (c->ctx, NULL, &keyblock);
3859                       if (err)
3860                         {
3861                           release_kbnode (keyblock);
3862                           keyblock = NULL;
3863                           getkey_end (c->ctx);
3864                           c->ctx = NULL;
3865                         }
3866                     }
3867                   else
3868                     c->state++;
3869                   break;
3870
3871                 default: /* No more names to check - stop.  */
3872                   c->eof = 1;
3873                   return gpg_error (GPG_ERR_EOF);
3874                 }
3875             }
3876           while ((!name || !*name) && !keyblock);
3877
3878           if (keyblock)
3879             c->node = c->keyblock = keyblock;
3880           else
3881             {
3882               err = getkey_byname (ctrl, NULL, NULL, name, 1, &c->keyblock);
3883               if (err)
3884                 {
3885                   /* getkey_byname might return a keyblock even in the
3886                      error case - I have not checked.  Thus better release
3887                      it.  */
3888                   release_kbnode (c->keyblock);
3889                   c->keyblock = NULL;
3890                 }
3891               else
3892                 c->node = c->keyblock;
3893             }
3894         }
3895
3896       /* Get the next key from the current keyblock.  */
3897       for (; c->node; c->node = c->node->next)
3898         {
3899           if (c->node->pkt->pkttype == PKT_PUBLIC_KEY
3900               || c->node->pkt->pkttype == PKT_PUBLIC_SUBKEY)
3901             {
3902               copy_public_key (sk, c->node->pkt->pkt.public_key);
3903               c->node = c->node->next;
3904               return 0; /* Found.  */
3905             }
3906         }
3907
3908       /* Dispose the keyblock and continue.  */
3909       release_kbnode (c->keyblock);
3910       c->keyblock = NULL;
3911     }
3912 }
3913
3914 \f
3915 /*********************************************
3916  ***********  User ID printing helpers *******
3917  *********************************************/
3918
3919 /* Return a string with a printable representation of the user_id.
3920  * this string must be freed by xfree.   */
3921 static char *
3922 get_user_id_string (u32 * keyid, int mode, size_t *r_len)
3923 {
3924   user_id_db_t r;
3925   keyid_list_t a;
3926   int pass = 0;
3927   char *p;
3928
3929   /* Try it two times; second pass reads from the database.  */
3930   do
3931     {
3932       for (r = user_id_db; r; r = r->next)
3933         {
3934           for (a = r->keyids; a; a = a->next)
3935             {
3936               if (a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1])
3937                 {
3938                   if (mode == 2)
3939                     {
3940                       /* An empty string as user id is possible.  Make
3941                          sure that the malloc allocates one byte and
3942                          does not bail out.  */
3943                       p = xmalloc (r->len? r->len : 1);
3944                       memcpy (p, r->name, r->len);
3945                       if (r_len)
3946                         *r_len = r->len;
3947                     }
3948                   else
3949                     {
3950                       if (mode)
3951                         p = xasprintf ("%08lX%08lX %.*s",
3952                                        (ulong) keyid[0], (ulong) keyid[1],
3953                                        r->len, r->name);
3954                       else
3955                         p = xasprintf ("%s %.*s", keystr (keyid),
3956                                        r->len, r->name);
3957                       if (r_len)
3958                         *r_len = strlen (p);
3959                     }
3960
3961                   return p;
3962                 }
3963             }
3964         }
3965     }
3966   while (++pass < 2 && !get_pubkey (NULL, keyid));
3967
3968   if (mode == 2)
3969     p = xstrdup (user_id_not_found_utf8 ());
3970   else if (mode)
3971     p = xasprintf ("%08lX%08lX [?]", (ulong) keyid[0], (ulong) keyid[1]);
3972   else
3973     p = xasprintf ("%s [?]", keystr (keyid));
3974
3975   if (r_len)
3976     *r_len = strlen (p);
3977   return p;
3978 }
3979
3980
3981 char *
3982 get_user_id_string_native (u32 * keyid)
3983 {
3984   char *p = get_user_id_string (keyid, 0, NULL);
3985   char *p2 = utf8_to_native (p, strlen (p), 0);
3986   xfree (p);
3987   return p2;
3988 }
3989
3990
3991 char *
3992 get_long_user_id_string (u32 * keyid)
3993 {
3994   return get_user_id_string (keyid, 1, NULL);
3995 }
3996
3997
3998 /* Please try to use get_user_byfpr instead of this one.  */
3999 char *
4000 get_user_id (u32 * keyid, size_t * rn)
4001 {
4002   return get_user_id_string (keyid, 2, rn);
4003 }
4004
4005
4006 /* Please try to use get_user_id_byfpr_native instead of this one.  */
4007 char *
4008 get_user_id_native (u32 * keyid)
4009 {
4010   size_t rn;
4011   char *p = get_user_id (keyid, &rn);
4012   char *p2 = utf8_to_native (p, rn, 0);
4013   xfree (p);
4014   return p2;
4015 }
4016
4017
4018 /* Return the user id for a key designated by its fingerprint, FPR,
4019    which must be MAX_FINGERPRINT_LEN bytes in size.  Note: the
4020    returned string, which must be freed using xfree, may not be NUL
4021    terminated.  To determine the length of the string, you must use
4022    *RN.  */
4023 char *
4024 get_user_id_byfpr (const byte *fpr, size_t *rn)
4025 {
4026   user_id_db_t r;
4027   char *p;
4028   int pass = 0;
4029
4030   /* Try it two times; second pass reads from the database.  */
4031   do
4032     {
4033       for (r = user_id_db; r; r = r->next)
4034         {
4035           keyid_list_t a;
4036           for (a = r->keyids; a; a = a->next)
4037             {
4038               if (!memcmp (a->fpr, fpr, MAX_FINGERPRINT_LEN))
4039                 {
4040                   /* An empty string as user id is possible.  Make
4041                      sure that the malloc allocates one byte and does
4042                      not bail out.  */
4043                   p = xmalloc (r->len? r->len : 1);
4044                   memcpy (p, r->name, r->len);
4045                   *rn = r->len;
4046                   return p;
4047                 }
4048             }
4049         }
4050     }
4051   while (++pass < 2
4052          && !get_pubkey_byfprint (NULL, NULL, fpr, MAX_FINGERPRINT_LEN));
4053   p = xstrdup (user_id_not_found_utf8 ());
4054   *rn = strlen (p);
4055   return p;
4056 }
4057
4058 /* Like get_user_id_byfpr, but convert the string to the native
4059    encoding.  The returned string needs to be freed.  Unlike
4060    get_user_id_byfpr, the returned string is NUL terminated.  */
4061 char *
4062 get_user_id_byfpr_native (const byte *fpr)
4063 {
4064   size_t rn;
4065   char *p = get_user_id_byfpr (fpr, &rn);
4066   char *p2 = utf8_to_native (p, rn, 0);
4067   xfree (p);
4068   return p2;
4069 }
4070
4071
4072 /* Return the database handle used by this context.  The context still
4073    owns the handle.  */
4074 KEYDB_HANDLE
4075 get_ctx_handle (GETKEY_CTX ctx)
4076 {
4077   return ctx->kr_handle;
4078 }
4079
4080 static void
4081 free_akl (struct akl *akl)
4082 {
4083   if (! akl)
4084     return;
4085
4086   if (akl->spec)
4087     free_keyserver_spec (akl->spec);
4088
4089   xfree (akl);
4090 }
4091
4092 void
4093 release_akl (void)
4094 {
4095   while (opt.auto_key_locate)
4096     {
4097       struct akl *akl2 = opt.auto_key_locate;
4098       opt.auto_key_locate = opt.auto_key_locate->next;
4099       free_akl (akl2);
4100     }
4101 }
4102
4103 /* Returns false on error. */
4104 int
4105 parse_auto_key_locate (char *options)
4106 {
4107   char *tok;
4108
4109   while ((tok = optsep (&options)))
4110     {
4111       struct akl *akl, *check, *last = NULL;
4112       int dupe = 0;
4113
4114       if (tok[0] == '\0')
4115         continue;
4116
4117       akl = xmalloc_clear (sizeof (*akl));
4118
4119       if (ascii_strcasecmp (tok, "clear") == 0)
4120         {
4121           xfree (akl);
4122           free_akl (opt.auto_key_locate);
4123           opt.auto_key_locate = NULL;
4124           continue;
4125         }
4126       else if (ascii_strcasecmp (tok, "nodefault") == 0)
4127         akl->type = AKL_NODEFAULT;
4128       else if (ascii_strcasecmp (tok, "local") == 0)
4129         akl->type = AKL_LOCAL;
4130       else if (ascii_strcasecmp (tok, "ldap") == 0)
4131         akl->type = AKL_LDAP;
4132       else if (ascii_strcasecmp (tok, "keyserver") == 0)
4133         akl->type = AKL_KEYSERVER;
4134 #ifdef USE_DNS_CERT
4135       else if (ascii_strcasecmp (tok, "cert") == 0)
4136         akl->type = AKL_CERT;
4137 #endif
4138       else if (ascii_strcasecmp (tok, "pka") == 0)
4139         akl->type = AKL_PKA;
4140       else if (ascii_strcasecmp (tok, "dane") == 0)
4141         akl->type = AKL_DANE;
4142       else if (ascii_strcasecmp (tok, "wkd") == 0)
4143         akl->type = AKL_WKD;
4144       else if ((akl->spec = parse_keyserver_uri (tok, 1)))
4145         akl->type = AKL_SPEC;
4146       else
4147         {
4148           free_akl (akl);
4149           return 0;
4150         }
4151
4152       /* We must maintain the order the user gave us */
4153       for (check = opt.auto_key_locate; check;
4154            last = check, check = check->next)
4155         {
4156           /* Check for duplicates */
4157           if (check->type == akl->type
4158               && (akl->type != AKL_SPEC
4159                   || (akl->type == AKL_SPEC
4160                       && strcmp (check->spec->uri, akl->spec->uri) == 0)))
4161             {
4162               dupe = 1;
4163               free_akl (akl);
4164               break;
4165             }
4166         }
4167
4168       if (!dupe)
4169         {
4170           if (last)
4171             last->next = akl;
4172           else
4173             opt.auto_key_locate = akl;
4174         }
4175     }
4176
4177   return 1;
4178 }
4179
4180
4181 /* Returns true if a secret key is available for the public key with
4182    key id KEYID; returns false if not.  This function ignores legacy
4183    keys.  Note: this is just a fast check and does not tell us whether
4184    the secret key is valid; this check merely indicates whether there
4185    is some secret key with the specified key id.  */
4186 int
4187 have_secret_key_with_kid (u32 *keyid)
4188 {
4189   gpg_error_t err;
4190   KEYDB_HANDLE kdbhd;
4191   KEYDB_SEARCH_DESC desc;
4192   kbnode_t keyblock;
4193   kbnode_t node;
4194   int result = 0;
4195
4196   kdbhd = keydb_new ();