648c23040a2519051e472b8b944be28503cba8e8
[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   rc = get_pubkey_byname (ctrl, &ctx, pk, name, ret_keyblock,
1581                           NULL, include_unusable, no_akl);
1582   if (rc)
1583     {
1584       if (ctx)
1585         getkey_end (ctx);
1586       if (retctx)
1587         *retctx = NULL;
1588       return rc;
1589     }
1590
1591   if (is_valid_mailbox (name))
1592     {
1593       /* Rank results and return only the most relevant key.  */
1594       struct pubkey_cmp_cookie best = { 0 }, new;
1595       while (getkey_next (ctx, &new.key, NULL) == 0)
1596         {
1597           KBNODE new_keyblock = get_pubkeyblock (pk_keyid (&new.key));
1598           int diff = pubkey_cmp (ctrl, name, &best, &new, new_keyblock);
1599           release_kbnode (new_keyblock);
1600           if (diff < 0)
1601             {
1602               /* New key is better.  */
1603               release_public_key_parts (&best.key);
1604               best = new;
1605             }
1606           else if (diff > 0)
1607             {
1608               /* Old key is better.  */
1609               release_public_key_parts (&new.key);
1610             }
1611           else
1612             {
1613               /* A tie.  Keep the old key.  */
1614               release_public_key_parts (&new.key);
1615             }
1616         }
1617       getkey_end (ctx);
1618       ctx = NULL;
1619
1620       if (best.valid)
1621         {
1622           if (retctx || ret_keyblock)
1623             {
1624               ctx = xtrycalloc (1, sizeof **retctx);
1625               if (! ctx)
1626                 rc = gpg_error_from_syserror ();
1627               else
1628                 {
1629                   ctx->kr_handle = keydb_new ();
1630                   if (! ctx->kr_handle)
1631                     {
1632                       xfree (ctx);
1633                       *retctx = NULL;
1634                       rc = gpg_error_from_syserror ();
1635                     }
1636                   else
1637                     {
1638                       u32 *keyid = pk_keyid (&best.key);
1639                       ctx->exact = 1;
1640                       ctx->nitems = 1;
1641                       ctx->items[0].mode = KEYDB_SEARCH_MODE_LONG_KID;
1642                       ctx->items[0].u.kid[0] = keyid[0];
1643                       ctx->items[0].u.kid[1] = keyid[1];
1644
1645                       if (ret_keyblock)
1646                         {
1647                           release_kbnode (*ret_keyblock);
1648                           *ret_keyblock = NULL;
1649                           rc = getkey_next (ctx, NULL, ret_keyblock);
1650                         }
1651                     }
1652                 }
1653             }
1654
1655           if (pk)
1656             *pk = best.key;
1657           else
1658             release_public_key_parts (&best.key);
1659         }
1660     }
1661
1662   if (rc && ctx)
1663     {
1664       getkey_end (ctx);
1665       ctx = NULL;
1666     }
1667
1668   if (retctx && ctx)
1669     *retctx = ctx;
1670   else
1671     getkey_end (ctx);
1672
1673   return rc;
1674 }
1675
1676 \f
1677
1678 /* Get a public key from a file.
1679  *
1680  * PK is the buffer to store the key.  The caller needs to make sure
1681  * that PK->REQ_USAGE is valid.  PK->REQ_USAGE is passed through to
1682  * the lookup function and is a mask of PUBKEY_USAGE_SIG,
1683  * PUBKEY_USAGE_ENC and PUBKEY_USAGE_CERT.  If this is non-zero, only
1684  * keys with the specified usage will be returned.
1685  *
1686  * FNAME is the file name.  That file should contain exactly one
1687  * keyblock.
1688  *
1689  * This function returns 0 on success.  Otherwise, an error code is
1690  * returned.  In particular, GPG_ERR_NO_PUBKEY is returned if the key
1691  * is not found.
1692  *
1693  * The self-signed data has already been merged into the public key
1694  * using merge_selfsigs.  The caller must release the content of PK by
1695  * calling release_public_key_parts (or, if PK was malloced, using
1696  * free_public_key).
1697  */
1698 gpg_error_t
1699 get_pubkey_fromfile (ctrl_t ctrl, PKT_public_key *pk, const char *fname)
1700 {
1701   gpg_error_t err;
1702   kbnode_t keyblock;
1703   kbnode_t found_key;
1704   unsigned int infoflags;
1705
1706   err = read_key_from_file (ctrl, fname, &keyblock);
1707   if (!err)
1708     {
1709       /* Warning: node flag bits 0 and 1 should be preserved by
1710        * merge_selfsigs.  FIXME: Check whether this still holds. */
1711       merge_selfsigs (keyblock);
1712       found_key = finish_lookup (keyblock, pk->req_usage, 0, &infoflags);
1713       print_status_key_considered (keyblock, infoflags);
1714       if (found_key)
1715         pk_from_block (pk, keyblock, found_key);
1716       else
1717         err = gpg_error (GPG_ERR_UNUSABLE_PUBKEY);
1718     }
1719
1720   release_kbnode (keyblock);
1721   return err;
1722 }
1723
1724
1725 /* Lookup a key with the specified fingerprint.
1726  *
1727  * If PK is not NULL, the public key of the first result is returned
1728  * in *PK.  Note: this function does an exact search and thus the
1729  * returned public key may be a subkey rather than the primary key.
1730  * Note: The self-signed data has already been merged into the public
1731  * key using merge_selfsigs.  Free *PK by calling
1732  * release_public_key_parts (or, if PK was allocated using xfree, you
1733  * can use free_public_key, which calls release_public_key_parts(PK)
1734  * and then xfree(PK)).
1735  *
1736  * If PK->REQ_USAGE is set, it is used to filter the search results.
1737  * (Thus, if PK is not NULL, PK->REQ_USAGE must be valid!!!)  See the
1738  * documentation for finish_lookup to understand exactly how this is
1739  * used.
1740  *
1741  * If R_KEYBLOCK is not NULL, then the first result's keyblock is
1742  * returned in *R_KEYBLOCK.  This should be freed using
1743  * release_kbnode().
1744  *
1745  * FPRINT is a byte array whose contents is the fingerprint to use as
1746  * the search term.  FPRINT_LEN specifies the length of the
1747  * fingerprint (in bytes).  Currently, only 16 and 20-byte
1748  * fingerprints are supported.
1749  *
1750  * FIXME: We should replace this with the _byname function.  This can
1751  * be done by creating a userID conforming to the unified fingerprint
1752  * style.  */
1753 int
1754 get_pubkey_byfprint (PKT_public_key *pk, kbnode_t *r_keyblock,
1755                      const byte * fprint, size_t fprint_len)
1756 {
1757   int rc;
1758
1759   if (r_keyblock)
1760     *r_keyblock = NULL;
1761
1762   if (fprint_len == 20 || fprint_len == 16)
1763     {
1764       struct getkey_ctx_s ctx;
1765       KBNODE kb = NULL;
1766       KBNODE found_key = NULL;
1767
1768       memset (&ctx, 0, sizeof ctx);
1769       ctx.exact = 1;
1770       ctx.not_allocated = 1;
1771       ctx.kr_handle = keydb_new ();
1772       if (!ctx.kr_handle)
1773         return gpg_error_from_syserror ();
1774
1775       ctx.nitems = 1;
1776       ctx.items[0].mode = fprint_len == 16 ? KEYDB_SEARCH_MODE_FPR16
1777         : KEYDB_SEARCH_MODE_FPR20;
1778       memcpy (ctx.items[0].u.fpr, fprint, fprint_len);
1779       rc = lookup (&ctx, &kb, &found_key, 0);
1780       if (!rc && pk)
1781         pk_from_block (pk, kb, found_key);
1782       if (!rc && r_keyblock)
1783         {
1784           *r_keyblock = kb;
1785           kb = NULL;
1786         }
1787       release_kbnode (kb);
1788       getkey_end (&ctx);
1789     }
1790   else
1791     rc = GPG_ERR_GENERAL; /* Oops */
1792   return rc;
1793 }
1794
1795
1796 /* This function is similar to get_pubkey_byfprint, but it doesn't
1797  * merge the self-signed data into the public key and subkeys or into
1798  * the user ids.  It also doesn't add the key to the user id cache.
1799  * Further, this function ignores PK->REQ_USAGE.
1800  *
1801  * This function is intended to avoid recursion and, as such, should
1802  * only be used in very specific situations.
1803  *
1804  * Like get_pubkey_byfprint, PK may be NULL.  In that case, this
1805  * function effectively just checks for the existence of the key.  */
1806 int
1807 get_pubkey_byfprint_fast (PKT_public_key * pk,
1808                           const byte * fprint, size_t fprint_len)
1809 {
1810   int rc = 0;
1811   KEYDB_HANDLE hd;
1812   KBNODE keyblock;
1813   byte fprbuf[MAX_FINGERPRINT_LEN];
1814   int i;
1815
1816   for (i = 0; i < MAX_FINGERPRINT_LEN && i < fprint_len; i++)
1817     fprbuf[i] = fprint[i];
1818   while (i < MAX_FINGERPRINT_LEN)
1819     fprbuf[i++] = 0;
1820
1821   hd = keydb_new ();
1822   if (!hd)
1823     return gpg_error_from_syserror ();
1824
1825   rc = keydb_search_fpr (hd, fprbuf);
1826   if (gpg_err_code (rc) == GPG_ERR_NOT_FOUND)
1827     {
1828       keydb_release (hd);
1829       return GPG_ERR_NO_PUBKEY;
1830     }
1831   rc = keydb_get_keyblock (hd, &keyblock);
1832   keydb_release (hd);
1833   if (rc)
1834     {
1835       log_error ("keydb_get_keyblock failed: %s\n", gpg_strerror (rc));
1836       return GPG_ERR_NO_PUBKEY;
1837     }
1838
1839   log_assert (keyblock->pkt->pkttype == PKT_PUBLIC_KEY
1840               || keyblock->pkt->pkttype == PKT_PUBLIC_SUBKEY);
1841   if (pk)
1842     copy_public_key (pk, keyblock->pkt->pkt.public_key);
1843   release_kbnode (keyblock);
1844
1845   /* Not caching key here since it won't have all of the fields
1846      properly set. */
1847
1848   return 0;
1849 }
1850
1851 const char *
1852 parse_def_secret_key (ctrl_t ctrl)
1853 {
1854   KEYDB_HANDLE hd = NULL;
1855   strlist_t t;
1856   static int warned;
1857
1858   for (t = opt.def_secret_key; t; t = t->next)
1859     {
1860       gpg_error_t err;
1861       KEYDB_SEARCH_DESC desc;
1862       KBNODE kb;
1863       KBNODE node;
1864
1865       err = classify_user_id (t->d, &desc, 1);
1866       if (err)
1867         {
1868           log_error (_("secret key \"%s\" not found: %s\n"),
1869                      t->d, gpg_strerror (err));
1870           if (!opt.quiet)
1871             log_info (_("(check argument of option '%s')\n"), "--default-key");
1872           continue;
1873         }
1874
1875       if (! hd)
1876         {
1877           hd = keydb_new ();
1878           if (!hd)
1879             return NULL;
1880         }
1881       else
1882         keydb_search_reset (hd);
1883
1884
1885       err = keydb_search (hd, &desc, 1, NULL);
1886       if (gpg_err_code (err) == GPG_ERR_NOT_FOUND)
1887         continue;
1888
1889       if (err)
1890         {
1891           log_error (_("key \"%s\" not found: %s\n"), t->d, gpg_strerror (err));
1892           t = NULL;
1893           break;
1894         }
1895
1896       err = keydb_get_keyblock (hd, &kb);
1897       if (err)
1898         {
1899           log_error (_("error reading keyblock: %s\n"),
1900                      gpg_strerror (err));
1901           continue;
1902         }
1903
1904       merge_selfsigs (kb);
1905
1906       err = gpg_error (GPG_ERR_NO_SECKEY);
1907       node = kb;
1908       do
1909         {
1910           PKT_public_key *pk = node->pkt->pkt.public_key;
1911
1912           /* Check that the key has the signing capability.  */
1913           if (! (pk->pubkey_usage & PUBKEY_USAGE_SIG))
1914             continue;
1915
1916           /* Check if the key is valid.  */
1917           if (pk->flags.revoked)
1918             {
1919               if (DBG_LOOKUP)
1920                 log_debug ("not using %s as default key, %s",
1921                            keystr_from_pk (pk), "revoked");
1922               continue;
1923             }
1924           if (pk->has_expired)
1925             {
1926               if (DBG_LOOKUP)
1927                 log_debug ("not using %s as default key, %s",
1928                            keystr_from_pk (pk), "expired");
1929               continue;
1930             }
1931           if (pk_is_disabled (pk))
1932             {
1933               if (DBG_LOOKUP)
1934                 log_debug ("not using %s as default key, %s",
1935                            keystr_from_pk (pk), "disabled");
1936               continue;
1937             }
1938
1939           err = agent_probe_secret_key (ctrl, pk);
1940           if (! err)
1941             /* This is a valid key.  */
1942             break;
1943         }
1944       while ((node = find_next_kbnode (node, PKT_PUBLIC_SUBKEY)));
1945
1946       release_kbnode (kb);
1947       if (err)
1948         {
1949           if (! warned && ! opt.quiet)
1950             {
1951               log_info (_("Warning: not using '%s' as default key: %s\n"),
1952                         t->d, gpg_strerror (GPG_ERR_NO_SECKEY));
1953               print_reported_error (err, GPG_ERR_NO_SECKEY);
1954             }
1955         }
1956       else
1957         {
1958           if (! warned && ! opt.quiet)
1959             log_info (_("using \"%s\" as default secret key for signing\n"),
1960                       t->d);
1961           break;
1962         }
1963     }
1964
1965   if (! warned && opt.def_secret_key && ! t)
1966     log_info (_("all values passed to '%s' ignored\n"),
1967               "--default-key");
1968
1969   warned = 1;
1970
1971   if (hd)
1972     keydb_release (hd);
1973
1974   if (t)
1975     return t->d;
1976   return NULL;
1977 }
1978
1979
1980 /* Look up a secret key.
1981  *
1982  * If PK is not NULL, the public key of the first result is returned
1983  * in *PK.  Note: PK->REQ_USAGE must be valid!!!  If PK->REQ_USAGE is
1984  * set, it is used to filter the search results.  See the
1985  * documentation for finish_lookup to understand exactly how this is
1986  * used.  Note: The self-signed data has already been merged into the
1987  * public key using merge_selfsigs.  Free *PK by calling
1988  * release_public_key_parts (or, if PK was allocated using xfree, you
1989  * can use free_public_key, which calls release_public_key_parts(PK)
1990  * and then xfree(PK)).
1991  *
1992  * If --default-key was set, then the specified key is looked up.  (In
1993  * this case, the default key is returned even if it is considered
1994  * unusable.  See the documentation for skip_unusable for exactly what
1995  * this means.)
1996  *
1997  * Otherwise, this initiates a DB scan that returns all keys that are
1998  * usable (see previous paragraph for exactly what usable means) and
1999  * for which a secret key is available.
2000  *
2001  * This function returns the first match.  Additional results can be
2002  * returned using getkey_next.  */
2003 gpg_error_t
2004 get_seckey_default (ctrl_t ctrl, PKT_public_key *pk)
2005 {
2006   gpg_error_t err;
2007   strlist_t namelist = NULL;
2008   int include_unusable = 1;
2009
2010
2011   const char *def_secret_key = parse_def_secret_key (ctrl);
2012   if (def_secret_key)
2013     add_to_strlist (&namelist, def_secret_key);
2014   else
2015     include_unusable = 0;
2016
2017   err = key_byname (NULL, namelist, pk, 1, include_unusable, NULL, NULL);
2018
2019   free_strlist (namelist);
2020
2021   return err;
2022 }
2023
2024
2025 \f
2026 /* Search for keys matching some criteria.
2027  *
2028  * If RETCTX is not NULL, then the constructed context is returned in
2029  * *RETCTX so that getpubkey_next can be used to get subsequent
2030  * results.  In this case, getkey_end() must be used to free the
2031  * search context.  If RETCTX is not NULL, then RET_KDBHD must be
2032  * NULL.
2033  *
2034  * If PK is not NULL, the public key of the first result is returned
2035  * in *PK.  Note: PK->REQ_USAGE must be valid!!!  If PK->REQ_USAGE is
2036  * set, it is used to filter the search results.  See the
2037  * documentation for finish_lookup to understand exactly how this is
2038  * used.  Note: The self-signed data has already been merged into the
2039  * public key using merge_selfsigs.  Free *PK by calling
2040  * release_public_key_parts (or, if PK was allocated using xfree, you
2041  * can use free_public_key, which calls release_public_key_parts(PK)
2042  * and then xfree(PK)).
2043  *
2044  * If NAMES is not NULL, then a search query is constructed using
2045  * classify_user_id on each of the strings in the list.  (Recall: the
2046  * database does an OR of the terms, not an AND.)  If NAMES is
2047  * NULL, then all results are returned.
2048  *
2049  * If WANT_SECRET is set, then only keys with an available secret key
2050  * (either locally or via key registered on a smartcard) are returned.
2051  *
2052  * This function does not skip unusable keys (see the documentation
2053  * for skip_unusable for an exact definition).
2054  *
2055  * If RET_KEYBLOCK is not NULL, the keyblock is returned in
2056  * *RET_KEYBLOCK.  This should be freed using release_kbnode().
2057  *
2058  * This function returns 0 on success.  Otherwise, an error code is
2059  * returned.  In particular, GPG_ERR_NO_PUBKEY or GPG_ERR_NO_SECKEY
2060  * (if want_secret is set) is returned if the key is not found.  */
2061 gpg_error_t
2062 getkey_bynames (getkey_ctx_t *retctx, PKT_public_key *pk,
2063                 strlist_t names, int want_secret, kbnode_t *ret_keyblock)
2064 {
2065   return key_byname (retctx, names, pk, want_secret, 1,
2066                      ret_keyblock, NULL);
2067 }
2068
2069
2070 /* Search for one key matching some criteria.
2071  *
2072  * If RETCTX is not NULL, then the constructed context is returned in
2073  * *RETCTX so that getpubkey_next can be used to get subsequent
2074  * results.  In this case, getkey_end() must be used to free the
2075  * search context.  If RETCTX is not NULL, then RET_KDBHD must be
2076  * NULL.
2077  *
2078  * If PK is not NULL, the public key of the first result is returned
2079  * in *PK.  Note: PK->REQ_USAGE must be valid!!!  If PK->REQ_USAGE is
2080  * set, it is used to filter the search results.  See the
2081  * documentation for finish_lookup to understand exactly how this is
2082  * used.  Note: The self-signed data has already been merged into the
2083  * public key using merge_selfsigs.  Free *PK by calling
2084  * release_public_key_parts (or, if PK was allocated using xfree, you
2085  * can use free_public_key, which calls release_public_key_parts(PK)
2086  * and then xfree(PK)).
2087  *
2088  * If NAME is not NULL, then a search query is constructed using
2089  * classify_user_id on the string.  In this case, even unusable keys
2090  * (see the documentation for skip_unusable for an exact definition of
2091  * unusable) are returned.  Otherwise, if --default-key was set, then
2092  * that key is returned (even if it is unusable).  If neither of these
2093  * conditions holds, then the first usable key is returned.
2094  *
2095  * If WANT_SECRET is set, then only keys with an available secret key
2096  * (either locally or via key registered on a smartcard) are returned.
2097  *
2098  * This function does not skip unusable keys (see the documentation
2099  * for skip_unusable for an exact definition).
2100  *
2101  * If RET_KEYBLOCK is not NULL, the keyblock is returned in
2102  * *RET_KEYBLOCK.  This should be freed using release_kbnode().
2103  *
2104  * This function returns 0 on success.  Otherwise, an error code is
2105  * returned.  In particular, GPG_ERR_NO_PUBKEY or GPG_ERR_NO_SECKEY
2106  * (if want_secret is set) is returned if the key is not found.
2107  *
2108  * FIXME: We also have the get_pubkey_byname function which has a
2109  * different semantic.  Should be merged with this one.  */
2110 gpg_error_t
2111 getkey_byname (ctrl_t ctrl, getkey_ctx_t *retctx, PKT_public_key *pk,
2112                const char *name, int want_secret, kbnode_t *ret_keyblock)
2113 {
2114   gpg_error_t err;
2115   strlist_t namelist = NULL;
2116   int with_unusable = 1;
2117   const char *def_secret_key = NULL;
2118
2119   if (want_secret && !name)
2120     def_secret_key = parse_def_secret_key (ctrl);
2121
2122   if (want_secret && !name && def_secret_key)
2123     add_to_strlist (&namelist, def_secret_key);
2124   else if (name)
2125     add_to_strlist (&namelist, name);
2126   else
2127     with_unusable = 0;
2128
2129   err = key_byname (retctx, namelist, pk, want_secret, with_unusable,
2130                     ret_keyblock, NULL);
2131
2132   /* FIXME: Check that we really return GPG_ERR_NO_SECKEY if
2133      WANT_SECRET has been used.  */
2134
2135   free_strlist (namelist);
2136
2137   return err;
2138 }
2139
2140
2141 /* Return the next search result.
2142  *
2143  * If PK is not NULL, the public key of the next result is returned in
2144  * *PK.  Note: The self-signed data has already been merged into the
2145  * public key using merge_selfsigs.  Free *PK by calling
2146  * release_public_key_parts (or, if PK was allocated using xmalloc, you
2147  * can use free_public_key, which calls release_public_key_parts(PK)
2148  * and then xfree(PK)).
2149  *
2150  * RET_KEYBLOCK can be given as NULL; if it is not NULL it the entire
2151  * found keyblock is returned which must be released with
2152  * release_kbnode.  If the function returns an error NULL is stored at
2153  * RET_KEYBLOCK.
2154  *
2155  * The self-signed data has already been merged into the public key
2156  * using merge_selfsigs.  */
2157 gpg_error_t
2158 getkey_next (getkey_ctx_t ctx, PKT_public_key *pk, kbnode_t *ret_keyblock)
2159 {
2160   int rc; /* Fixme:  Make sure this is proper gpg_error */
2161   KBNODE found_key = NULL;
2162
2163   /* We need to disable the caching so that for an exact key search we
2164      won't get the result back from the cache and thus end up in an
2165      endless loop.  The endless loop can occur, because the cache is
2166      used without respecting the current file pointer!  */
2167   keydb_disable_caching (ctx->kr_handle);
2168
2169   rc = lookup (ctx, ret_keyblock, &found_key, ctx->want_secret);
2170   if (!rc && pk)
2171     {
2172       log_assert (found_key);
2173       pk_from_block (pk, NULL, found_key);
2174     }
2175
2176   return rc;
2177 }
2178
2179
2180 /* Release any resources used by a key listing context.  This must be
2181  * called on the context returned by, e.g., getkey_byname.  */
2182 void
2183 getkey_end (getkey_ctx_t ctx)
2184 {
2185   if (ctx)
2186     {
2187       keydb_release (ctx->kr_handle);
2188       free_strlist (ctx->extra_list);
2189       if (!ctx->not_allocated)
2190         xfree (ctx);
2191     }
2192 }
2193
2194
2195 \f
2196 /************************************************
2197  ************* Merging stuff ********************
2198  ************************************************/
2199
2200 /* Set the mainkey_id fields for all keys in KEYBLOCK.  This is
2201  * usually done by merge_selfsigs but at some places we only need the
2202  * main_kid not a full merge.  The function also guarantees that all
2203  * pk->keyids are computed.  */
2204 void
2205 setup_main_keyids (kbnode_t keyblock)
2206 {
2207   u32 kid[2], mainkid[2];
2208   kbnode_t kbctx, node;
2209   PKT_public_key *pk;
2210
2211   if (keyblock->pkt->pkttype != PKT_PUBLIC_KEY)
2212     BUG ();
2213   pk = keyblock->pkt->pkt.public_key;
2214
2215   keyid_from_pk (pk, mainkid);
2216   for (kbctx=NULL; (node = walk_kbnode (keyblock, &kbctx, 0)); )
2217     {
2218       if (!(node->pkt->pkttype == PKT_PUBLIC_KEY
2219             || node->pkt->pkttype == PKT_PUBLIC_SUBKEY))
2220         continue;
2221       pk = node->pkt->pkt.public_key;
2222       keyid_from_pk (pk, kid); /* Make sure pk->keyid is set.  */
2223       if (!pk->main_keyid[0] && !pk->main_keyid[1])
2224         {
2225           pk->main_keyid[0] = mainkid[0];
2226           pk->main_keyid[1] = mainkid[1];
2227         }
2228     }
2229 }
2230
2231
2232 /* KEYBLOCK corresponds to a public key block.  This function merges
2233  * much of the information from the self-signed data into the public
2234  * key, public subkey and user id data structures.  If you use the
2235  * high-level search API (e.g., get_pubkey) for looking up key blocks,
2236  * then you don't need to call this function.  This function is
2237  * useful, however, if you change the keyblock, e.g., by adding or
2238  * removing a self-signed data packet.  */
2239 void
2240 merge_keys_and_selfsig (KBNODE keyblock)
2241 {
2242   if (!keyblock)
2243     ;
2244   else if (keyblock->pkt->pkttype == PKT_PUBLIC_KEY)
2245     merge_selfsigs (keyblock);
2246   else
2247     log_debug ("FIXME: merging secret key blocks is not anymore available\n");
2248 }
2249
2250
2251 static int
2252 parse_key_usage (PKT_signature * sig)
2253 {
2254   int key_usage = 0;
2255   const byte *p;
2256   size_t n;
2257   byte flags;
2258
2259   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_FLAGS, &n);
2260   if (p && n)
2261     {
2262       /* First octet of the keyflags.  */
2263       flags = *p;
2264
2265       if (flags & 1)
2266         {
2267           key_usage |= PUBKEY_USAGE_CERT;
2268           flags &= ~1;
2269         }
2270
2271       if (flags & 2)
2272         {
2273           key_usage |= PUBKEY_USAGE_SIG;
2274           flags &= ~2;
2275         }
2276
2277       /* We do not distinguish between encrypting communications and
2278          encrypting storage. */
2279       if (flags & (0x04 | 0x08))
2280         {
2281           key_usage |= PUBKEY_USAGE_ENC;
2282           flags &= ~(0x04 | 0x08);
2283         }
2284
2285       if (flags & 0x20)
2286         {
2287           key_usage |= PUBKEY_USAGE_AUTH;
2288           flags &= ~0x20;
2289         }
2290
2291       if (flags)
2292         key_usage |= PUBKEY_USAGE_UNKNOWN;
2293
2294       if (!key_usage)
2295         key_usage |= PUBKEY_USAGE_NONE;
2296     }
2297   else if (p) /* Key flags of length zero.  */
2298     key_usage |= PUBKEY_USAGE_NONE;
2299
2300   /* We set PUBKEY_USAGE_UNKNOWN to indicate that this key has a
2301      capability that we do not handle.  This serves to distinguish
2302      between a zero key usage which we handle as the default
2303      capabilities for that algorithm, and a usage that we do not
2304      handle.  Likewise we use PUBKEY_USAGE_NONE to indicate that
2305      key_flags have been given but they do not specify any usage.  */
2306
2307   return key_usage;
2308 }
2309
2310
2311 /* Apply information from SIGNODE (which is the valid self-signature
2312  * associated with that UID) to the UIDNODE:
2313  * - weather the UID has been revoked
2314  * - assumed creation date of the UID
2315  * - temporary store the keyflags here
2316  * - temporary store the key expiration time here
2317  * - mark whether the primary user ID flag hat been set.
2318  * - store the preferences
2319  */
2320 static void
2321 fixup_uidnode (KBNODE uidnode, KBNODE signode, u32 keycreated)
2322 {
2323   PKT_user_id *uid = uidnode->pkt->pkt.user_id;
2324   PKT_signature *sig = signode->pkt->pkt.signature;
2325   const byte *p, *sym, *hash, *zip;
2326   size_t n, nsym, nhash, nzip;
2327
2328   sig->flags.chosen_selfsig = 1;/* We chose this one. */
2329   uid->created = 0;             /* Not created == invalid. */
2330   if (IS_UID_REV (sig))
2331     {
2332       uid->is_revoked = 1;
2333       return; /* Has been revoked.  */
2334     }
2335   else
2336     uid->is_revoked = 0;
2337
2338   uid->expiredate = sig->expiredate;
2339
2340   if (sig->flags.expired)
2341     {
2342       uid->is_expired = 1;
2343       return; /* Has expired.  */
2344     }
2345   else
2346     uid->is_expired = 0;
2347
2348   uid->created = sig->timestamp; /* This one is okay. */
2349   uid->selfsigversion = sig->version;
2350   /* If we got this far, it's not expired :) */
2351   uid->is_expired = 0;
2352
2353   /* Store the key flags in the helper variable for later processing.  */
2354   uid->help_key_usage = parse_key_usage (sig);
2355
2356   /* Ditto for the key expiration.  */
2357   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
2358   if (p && buf32_to_u32 (p))
2359     uid->help_key_expire = keycreated + buf32_to_u32 (p);
2360   else
2361     uid->help_key_expire = 0;
2362
2363   /* Set the primary user ID flag - we will later wipe out some
2364    * of them to only have one in our keyblock.  */
2365   uid->is_primary = 0;
2366   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_PRIMARY_UID, NULL);
2367   if (p && *p)
2368     uid->is_primary = 2;
2369
2370   /* We could also query this from the unhashed area if it is not in
2371    * the hased area and then later try to decide which is the better
2372    * there should be no security problem with this.
2373    * For now we only look at the hashed one.  */
2374
2375   /* Now build the preferences list.  These must come from the
2376      hashed section so nobody can modify the ciphers a key is
2377      willing to accept.  */
2378   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_PREF_SYM, &n);
2379   sym = p;
2380   nsym = p ? n : 0;
2381   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_PREF_HASH, &n);
2382   hash = p;
2383   nhash = p ? n : 0;
2384   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_PREF_COMPR, &n);
2385   zip = p;
2386   nzip = p ? n : 0;
2387   if (uid->prefs)
2388     xfree (uid->prefs);
2389   n = nsym + nhash + nzip;
2390   if (!n)
2391     uid->prefs = NULL;
2392   else
2393     {
2394       uid->prefs = xmalloc (sizeof (*uid->prefs) * (n + 1));
2395       n = 0;
2396       for (; nsym; nsym--, n++)
2397         {
2398           uid->prefs[n].type = PREFTYPE_SYM;
2399           uid->prefs[n].value = *sym++;
2400         }
2401       for (; nhash; nhash--, n++)
2402         {
2403           uid->prefs[n].type = PREFTYPE_HASH;
2404           uid->prefs[n].value = *hash++;
2405         }
2406       for (; nzip; nzip--, n++)
2407         {
2408           uid->prefs[n].type = PREFTYPE_ZIP;
2409           uid->prefs[n].value = *zip++;
2410         }
2411       uid->prefs[n].type = PREFTYPE_NONE; /* End of list marker  */
2412       uid->prefs[n].value = 0;
2413     }
2414
2415   /* See whether we have the MDC feature.  */
2416   uid->flags.mdc = 0;
2417   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_FEATURES, &n);
2418   if (p && n && (p[0] & 0x01))
2419     uid->flags.mdc = 1;
2420
2421   /* And the keyserver modify flag.  */
2422   uid->flags.ks_modify = 1;
2423   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KS_FLAGS, &n);
2424   if (p && n && (p[0] & 0x80))
2425     uid->flags.ks_modify = 0;
2426 }
2427
2428 static void
2429 sig_to_revoke_info (PKT_signature * sig, struct revoke_info *rinfo)
2430 {
2431   rinfo->date = sig->timestamp;
2432   rinfo->algo = sig->pubkey_algo;
2433   rinfo->keyid[0] = sig->keyid[0];
2434   rinfo->keyid[1] = sig->keyid[1];
2435 }
2436
2437
2438 /* Given a keyblock, parse the key block and extract various pieces of
2439    information and save them with the primary key packet and the user
2440    id packets.  For instance, some information is stored in signature
2441    packets.  We find the latest such valid packet (since the user can
2442    change that information) and copy its contents into the
2443    PKT_public_key.
2444
2445    Note that R_REVOKED may be set to 0, 1 or 2.
2446
2447    This function fills in the following fields in the primary key's
2448    keyblock:
2449
2450      main_keyid          (computed)
2451      revkey / numrevkeys (derived from self signed key data)
2452      flags.valid         (whether we have at least 1 self-sig)
2453      flags.maybe_revoked (whether a designed revoked the key, but
2454                           we are missing the key to check the sig)
2455      selfsigversion      (highest version of any valid self-sig)
2456      pubkey_usage        (derived from most recent self-sig or most
2457                           recent user id)
2458      has_expired         (various sources)
2459      expiredate          (various sources)
2460
2461   See the documentation for fixup_uidnode for how the user id packets
2462   are modified.  In addition to that the primary user id's is_primary
2463   field is set to 1 and the other user id's is_primary are set to
2464   0.  */
2465 static void
2466 merge_selfsigs_main (KBNODE keyblock, int *r_revoked,
2467                      struct revoke_info *rinfo)
2468 {
2469   PKT_public_key *pk = NULL;
2470   KBNODE k;
2471   u32 kid[2];
2472   u32 sigdate, uiddate, uiddate2;
2473   KBNODE signode, uidnode, uidnode2;
2474   u32 curtime = make_timestamp ();
2475   unsigned int key_usage = 0;
2476   u32 keytimestamp = 0;
2477   u32 key_expire = 0;
2478   int key_expire_seen = 0;
2479   byte sigversion = 0;
2480
2481   *r_revoked = 0;
2482   memset (rinfo, 0, sizeof (*rinfo));
2483
2484   /* Section 11.1 of RFC 4880 determines the order of packets within a
2485      message.  There are three sections, which must occur in the
2486      following order: the public key, the user ids and user attributes
2487      and the subkeys.  Within each section, each primary packet (e.g.,
2488      a user id packet) is followed by one or more signature packets,
2489      which modify that packet.  */
2490
2491   /* According to Section 11.1 of RFC 4880, the public key must be the
2492      first packet.  */
2493   if (keyblock->pkt->pkttype != PKT_PUBLIC_KEY)
2494     /* parse_keyblock_image ensures that the first packet is the
2495        public key.  */
2496     BUG ();
2497   pk = keyblock->pkt->pkt.public_key;
2498   keytimestamp = pk->timestamp;
2499
2500   keyid_from_pk (pk, kid);
2501   pk->main_keyid[0] = kid[0];
2502   pk->main_keyid[1] = kid[1];
2503
2504   if (pk->version < 4)
2505     {
2506       /* Before v4 the key packet itself contains the expiration date
2507        * and there was no way to change it, so we start with the one
2508        * from the key packet.  */
2509       key_expire = pk->max_expiredate;
2510       key_expire_seen = 1;
2511     }
2512
2513   /* First pass:
2514
2515       - Find the latest direct key self-signature.  We assume that the
2516         newest one overrides all others.
2517
2518       - Determine whether the key has been revoked.
2519
2520       - Gather all revocation keys (unlike other data, we don't just
2521         take them from the latest self-signed packet).
2522
2523       - Determine max (sig[...]->version).
2524    */
2525
2526   /* Reset this in case this key was already merged. */
2527   xfree (pk->revkey);
2528   pk->revkey = NULL;
2529   pk->numrevkeys = 0;
2530
2531   signode = NULL;
2532   sigdate = 0; /* Helper variable to find the latest signature.  */
2533
2534   /* According to Section 11.1 of RFC 4880, the public key comes first
2535      and is immediately followed by any signature packets that modify
2536      it.  */
2537   for (k = keyblock;
2538        k && k->pkt->pkttype != PKT_USER_ID
2539          && k->pkt->pkttype != PKT_ATTRIBUTE
2540          && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
2541        k = k->next)
2542     {
2543       if (k->pkt->pkttype == PKT_SIGNATURE)
2544         {
2545           PKT_signature *sig = k->pkt->pkt.signature;
2546           if (sig->keyid[0] == kid[0] && sig->keyid[1] == kid[1])
2547             /* Self sig.  */
2548             {
2549               if (check_key_signature (keyblock, k, NULL))
2550                 ; /* Signature did not verify.  */
2551               else if (IS_KEY_REV (sig))
2552                 {
2553                   /* Key has been revoked - there is no way to
2554                    * override such a revocation, so we theoretically
2555                    * can stop now.  We should not cope with expiration
2556                    * times for revocations here because we have to
2557                    * assume that an attacker can generate all kinds of
2558                    * signatures.  However due to the fact that the key
2559                    * has been revoked it does not harm either and by
2560                    * continuing we gather some more info on that
2561                    * key.  */
2562                   *r_revoked = 1;
2563                   sig_to_revoke_info (sig, rinfo);
2564                 }
2565               else if (IS_KEY_SIG (sig))
2566                 {
2567                   /* Add the indicated revocations keys from all
2568                      signatures not just the latest.  We do this
2569                      because you need multiple 1F sigs to properly
2570                      handle revocation keys (PGP does it this way, and
2571                      a revocation key could be sensitive and hence in
2572                      a different signature). */
2573                   if (sig->revkey)
2574                     {
2575                       int i;
2576
2577                       pk->revkey =
2578                         xrealloc (pk->revkey, sizeof (struct revocation_key) *
2579                                   (pk->numrevkeys + sig->numrevkeys));
2580
2581                       for (i = 0; i < sig->numrevkeys; i++)
2582                         memcpy (&pk->revkey[pk->numrevkeys++],
2583                                 &sig->revkey[i],
2584                                 sizeof (struct revocation_key));
2585                     }
2586
2587                   if (sig->timestamp >= sigdate)
2588                     /* This is the latest signature so far.  */
2589                     {
2590                       if (sig->flags.expired)
2591                         ; /* Signature has expired - ignore it.  */
2592                       else
2593                         {
2594                           sigdate = sig->timestamp;
2595                           signode = k;
2596                           if (sig->version > sigversion)
2597                             sigversion = sig->version;
2598
2599                         }
2600                     }
2601                 }
2602             }
2603         }
2604     }
2605
2606   /* Remove dupes from the revocation keys.  */
2607   if (pk->revkey)
2608     {
2609       int i, j, x, changed = 0;
2610
2611       for (i = 0; i < pk->numrevkeys; i++)
2612         {
2613           for (j = i + 1; j < pk->numrevkeys; j++)
2614             {
2615               if (memcmp (&pk->revkey[i], &pk->revkey[j],
2616                           sizeof (struct revocation_key)) == 0)
2617                 {
2618                   /* remove j */
2619
2620                   for (x = j; x < pk->numrevkeys - 1; x++)
2621                     pk->revkey[x] = pk->revkey[x + 1];
2622
2623                   pk->numrevkeys--;
2624                   j--;
2625                   changed = 1;
2626                 }
2627             }
2628         }
2629
2630       if (changed)
2631         pk->revkey = xrealloc (pk->revkey,
2632                                pk->numrevkeys *
2633                                sizeof (struct revocation_key));
2634     }
2635
2636   if (signode)
2637     /* SIGNODE is the 1F signature packet with the latest creation
2638        time.  Extract some information from it.  */
2639     {
2640       /* Some information from a direct key signature take precedence
2641        * over the same information given in UID sigs.  */
2642       PKT_signature *sig = signode->pkt->pkt.signature;
2643       const byte *p;
2644
2645       key_usage = parse_key_usage (sig);
2646
2647       p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
2648       if (p && buf32_to_u32 (p))
2649         {
2650           key_expire = keytimestamp + buf32_to_u32 (p);
2651           key_expire_seen = 1;
2652         }
2653
2654       /* Mark that key as valid: One direct key signature should
2655        * render a key as valid.  */
2656       pk->flags.valid = 1;
2657     }
2658
2659   /* Pass 1.5: Look for key revocation signatures that were not made
2660      by the key (i.e. did a revocation key issue a revocation for
2661      us?).  Only bother to do this if there is a revocation key in the
2662      first place and we're not revoked already.  */
2663
2664   if (!*r_revoked && pk->revkey)
2665     for (k = keyblock; k && k->pkt->pkttype != PKT_USER_ID; k = k->next)
2666       {
2667         if (k->pkt->pkttype == PKT_SIGNATURE)
2668           {
2669             PKT_signature *sig = k->pkt->pkt.signature;
2670
2671             if (IS_KEY_REV (sig) &&
2672                 (sig->keyid[0] != kid[0] || sig->keyid[1] != kid[1]))
2673               {
2674                 int rc = check_revocation_keys (pk, sig);
2675                 if (rc == 0)
2676                   {
2677                     *r_revoked = 2;
2678                     sig_to_revoke_info (sig, rinfo);
2679                     /* Don't continue checking since we can't be any
2680                        more revoked than this.  */
2681                     break;
2682                   }
2683                 else if (gpg_err_code (rc) == GPG_ERR_NO_PUBKEY)
2684                   pk->flags.maybe_revoked = 1;
2685
2686                 /* A failure here means the sig did not verify, was
2687                    not issued by a revocation key, or a revocation
2688                    key loop was broken.  If a revocation key isn't
2689                    findable, however, the key might be revoked and
2690                    we don't know it.  */
2691
2692                 /* TODO: In the future handle subkey and cert
2693                    revocations?  PGP doesn't, but it's in 2440. */
2694               }
2695           }
2696       }
2697
2698   /* Second pass: Look at the self-signature of all user IDs.  */
2699
2700   /* According to RFC 4880 section 11.1, user id and attribute packets
2701      are in the second section, after the public key packet and before
2702      the subkey packets.  */
2703   signode = uidnode = NULL;
2704   sigdate = 0; /* Helper variable to find the latest signature in one UID. */
2705   for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next)
2706     {
2707       if (k->pkt->pkttype == PKT_USER_ID || k->pkt->pkttype == PKT_ATTRIBUTE)
2708         /* New user id packet.  */
2709         {
2710           if (uidnode && signode)
2711             /* Apply the data from the most recent self-signed packet
2712                to the preceding user id packet.  */
2713             {
2714               fixup_uidnode (uidnode, signode, keytimestamp);
2715               pk->flags.valid = 1;
2716             }
2717           /* Clear SIGNODE.  The only relevant self-signed data for
2718              UIDNODE follows it.  */
2719           if (k->pkt->pkttype == PKT_USER_ID)
2720             uidnode = k;
2721           else
2722             uidnode = NULL;
2723           signode = NULL;
2724           sigdate = 0;
2725         }
2726       else if (k->pkt->pkttype == PKT_SIGNATURE && uidnode)
2727         {
2728           PKT_signature *sig = k->pkt->pkt.signature;
2729           if (sig->keyid[0] == kid[0] && sig->keyid[1] == kid[1])
2730             {
2731               if (check_key_signature (keyblock, k, NULL))
2732                 ;               /* signature did not verify */
2733               else if ((IS_UID_SIG (sig) || IS_UID_REV (sig))
2734                        && sig->timestamp >= sigdate)
2735                 {
2736                   /* Note: we allow invalidation of cert revocations
2737                    * by a newer signature.  An attacker can't use this
2738                    * because a key should be revoked with a key revocation.
2739                    * The reason why we have to allow for that is that at
2740                    * one time an email address may become invalid but later
2741                    * the same email address may become valid again (hired,
2742                    * fired, hired again).  */
2743
2744                   sigdate = sig->timestamp;
2745                   signode = k;
2746                   signode->pkt->pkt.signature->flags.chosen_selfsig = 0;
2747                   if (sig->version > sigversion)
2748                     sigversion = sig->version;
2749                 }
2750             }
2751         }
2752     }
2753   if (uidnode && signode)
2754     {
2755       fixup_uidnode (uidnode, signode, keytimestamp);
2756       pk->flags.valid = 1;
2757     }
2758
2759   /* If the key isn't valid yet, and we have
2760      --allow-non-selfsigned-uid set, then force it valid. */
2761   if (!pk->flags.valid && opt.allow_non_selfsigned_uid)
2762     {
2763       if (opt.verbose)
2764         log_info (_("Invalid key %s made valid by"
2765                     " --allow-non-selfsigned-uid\n"), keystr_from_pk (pk));
2766       pk->flags.valid = 1;
2767     }
2768
2769   /* The key STILL isn't valid, so try and find an ultimately
2770      trusted signature. */
2771   if (!pk->flags.valid)
2772     {
2773       uidnode = NULL;
2774
2775       for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
2776            k = k->next)
2777         {
2778           if (k->pkt->pkttype == PKT_USER_ID)
2779             uidnode = k;
2780           else if (k->pkt->pkttype == PKT_SIGNATURE && uidnode)
2781             {
2782               PKT_signature *sig = k->pkt->pkt.signature;
2783
2784               if (sig->keyid[0] != kid[0] || sig->keyid[1] != kid[1])
2785                 {
2786                   PKT_public_key *ultimate_pk;
2787
2788                   ultimate_pk = xmalloc_clear (sizeof (*ultimate_pk));
2789
2790                   /* We don't want to use the full get_pubkey to
2791                      avoid infinite recursion in certain cases.
2792                      There is no reason to check that an ultimately
2793                      trusted key is still valid - if it has been
2794                      revoked the user should also remove the
2795                      ultimate trust flag.  */
2796                   if (get_pubkey_fast (ultimate_pk, sig->keyid) == 0
2797                       && check_key_signature2 (keyblock, k, ultimate_pk,
2798                                                NULL, NULL, NULL, NULL) == 0
2799                       && get_ownertrust (ultimate_pk) == TRUST_ULTIMATE)
2800                     {
2801                       free_public_key (ultimate_pk);
2802                       pk->flags.valid = 1;
2803                       break;
2804                     }
2805
2806                   free_public_key (ultimate_pk);
2807                 }
2808             }
2809         }
2810     }
2811
2812   /* Record the highest selfsig version so we know if this is a v3
2813      key through and through, or a v3 key with a v4 selfsig
2814      somewhere.  This is useful in a few places to know if the key
2815      must be treated as PGP2-style or OpenPGP-style.  Note that a
2816      selfsig revocation with a higher version number will also raise
2817      this value.  This is okay since such a revocation must be
2818      issued by the user (i.e. it cannot be issued by someone else to
2819      modify the key behavior.) */
2820
2821   pk->selfsigversion = sigversion;
2822
2823   /* Now that we had a look at all user IDs we can now get some information
2824    * from those user IDs.
2825    */
2826
2827   if (!key_usage)
2828     {
2829       /* Find the latest user ID with key flags set. */
2830       uiddate = 0; /* Helper to find the latest user ID.  */
2831       for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
2832            k = k->next)
2833         {
2834           if (k->pkt->pkttype == PKT_USER_ID)
2835             {
2836               PKT_user_id *uid = k->pkt->pkt.user_id;
2837               if (uid->help_key_usage && uid->created > uiddate)
2838                 {
2839                   key_usage = uid->help_key_usage;
2840                   uiddate = uid->created;
2841                 }
2842             }
2843         }
2844     }
2845   if (!key_usage)
2846     {
2847       /* No key flags at all: get it from the algo.  */
2848       key_usage = openpgp_pk_algo_usage (pk->pubkey_algo);
2849     }
2850   else
2851     {
2852       /* Check that the usage matches the usage as given by the algo.  */
2853       int x = openpgp_pk_algo_usage (pk->pubkey_algo);
2854       if (x) /* Mask it down to the actual allowed usage.  */
2855         key_usage &= x;
2856     }
2857
2858   /* Whatever happens, it's a primary key, so it can certify. */
2859   pk->pubkey_usage = key_usage | PUBKEY_USAGE_CERT;
2860
2861   if (!key_expire_seen)
2862     {
2863       /* Find the latest valid user ID with a key expiration set
2864        * Note, that this may be a different one from the above because
2865        * some user IDs may have no expiration date set.  */
2866       uiddate = 0;
2867       for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
2868            k = k->next)
2869         {
2870           if (k->pkt->pkttype == PKT_USER_ID)
2871             {
2872               PKT_user_id *uid = k->pkt->pkt.user_id;
2873               if (uid->help_key_expire && uid->created > uiddate)
2874                 {
2875                   key_expire = uid->help_key_expire;
2876                   uiddate = uid->created;
2877                 }
2878             }
2879         }
2880     }
2881
2882   /* Currently only v3 keys have a maximum expiration date, but I'll
2883      bet v5 keys get this feature again. */
2884   if (key_expire == 0
2885       || (pk->max_expiredate && key_expire > pk->max_expiredate))
2886     key_expire = pk->max_expiredate;
2887
2888   pk->has_expired = key_expire >= curtime ? 0 : key_expire;
2889   pk->expiredate = key_expire;
2890
2891   /* Fixme: we should see how to get rid of the expiretime fields  but
2892    * this needs changes at other places too. */
2893
2894   /* And now find the real primary user ID and delete all others.  */
2895   uiddate = uiddate2 = 0;
2896   uidnode = uidnode2 = NULL;
2897   for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next)
2898     {
2899       if (k->pkt->pkttype == PKT_USER_ID && !k->pkt->pkt.user_id->attrib_data)
2900         {
2901           PKT_user_id *uid = k->pkt->pkt.user_id;
2902           if (uid->is_primary)
2903             {
2904               if (uid->created > uiddate)
2905                 {
2906                   uiddate = uid->created;
2907                   uidnode = k;
2908                 }
2909               else if (uid->created == uiddate && uidnode)
2910                 {
2911                   /* The dates are equal, so we need to do a
2912                      different (and arbitrary) comparison.  This
2913                      should rarely, if ever, happen.  It's good to
2914                      try and guarantee that two different GnuPG
2915                      users with two different keyrings at least pick
2916                      the same primary. */
2917                   if (cmp_user_ids (uid, uidnode->pkt->pkt.user_id) > 0)
2918                     uidnode = k;
2919                 }
2920             }
2921           else
2922             {
2923               if (uid->created > uiddate2)
2924                 {
2925                   uiddate2 = uid->created;
2926                   uidnode2 = k;
2927                 }
2928               else if (uid->created == uiddate2 && uidnode2)
2929                 {
2930                   if (cmp_user_ids (uid, uidnode2->pkt->pkt.user_id) > 0)
2931                     uidnode2 = k;
2932                 }
2933             }
2934         }
2935     }
2936   if (uidnode)
2937     {
2938       for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
2939            k = k->next)
2940         {
2941           if (k->pkt->pkttype == PKT_USER_ID &&
2942               !k->pkt->pkt.user_id->attrib_data)
2943             {
2944               PKT_user_id *uid = k->pkt->pkt.user_id;
2945               if (k != uidnode)
2946                 uid->is_primary = 0;
2947             }
2948         }
2949     }
2950   else if (uidnode2)
2951     {
2952       /* None is flagged primary - use the latest user ID we have,
2953          and disambiguate with the arbitrary packet comparison. */
2954       uidnode2->pkt->pkt.user_id->is_primary = 1;
2955     }
2956   else
2957     {
2958       /* None of our uids were self-signed, so pick the one that
2959          sorts first to be the primary.  This is the best we can do
2960          here since there are no self sigs to date the uids. */
2961
2962       uidnode = NULL;
2963
2964       for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
2965            k = k->next)
2966         {
2967           if (k->pkt->pkttype == PKT_USER_ID
2968               && !k->pkt->pkt.user_id->attrib_data)
2969             {
2970               if (!uidnode)
2971                 {
2972                   uidnode = k;
2973                   uidnode->pkt->pkt.user_id->is_primary = 1;
2974                   continue;
2975                 }
2976               else
2977                 {
2978                   if (cmp_user_ids (k->pkt->pkt.user_id,
2979                                     uidnode->pkt->pkt.user_id) > 0)
2980                     {
2981                       uidnode->pkt->pkt.user_id->is_primary = 0;
2982                       uidnode = k;
2983                       uidnode->pkt->pkt.user_id->is_primary = 1;
2984                     }
2985                   else
2986                     k->pkt->pkt.user_id->is_primary = 0;        /* just to be
2987                                                                    safe */
2988                 }
2989             }
2990         }
2991     }
2992 }
2993
2994 /* Convert a buffer to a signature.  Useful for 0x19 embedded sigs.
2995    Caller must free the signature when they are done. */
2996 static PKT_signature *
2997 buf_to_sig (const byte * buf, size_t len)
2998 {
2999   PKT_signature *sig = xmalloc_clear (sizeof (PKT_signature));
3000   IOBUF iobuf = iobuf_temp_with_content (buf, len);
3001   int save_mode = set_packet_list_mode (0);
3002
3003   if (parse_signature (iobuf, PKT_SIGNATURE, len, sig) != 0)
3004     {
3005       xfree (sig);
3006       sig = NULL;
3007     }
3008
3009   set_packet_list_mode (save_mode);
3010   iobuf_close (iobuf);
3011
3012   return sig;
3013 }
3014
3015 /* Use the self-signed data to fill in various fields in subkeys.
3016
3017    KEYBLOCK is the whole keyblock.  SUBNODE is the subkey to fill in.
3018
3019    Sets the following fields on the subkey:
3020
3021      main_keyid
3022      flags.valid        if the subkey has a valid self-sig binding
3023      flags.revoked
3024      flags.backsig
3025      pubkey_usage
3026      has_expired
3027      expired_date
3028
3029    On this subkey's most revent valid self-signed packet, the
3030    following field is set:
3031
3032      flags.chosen_selfsig
3033   */
3034 static void
3035 merge_selfsigs_subkey (KBNODE keyblock, KBNODE subnode)
3036 {
3037   PKT_public_key *mainpk = NULL, *subpk = NULL;
3038   PKT_signature *sig;
3039   KBNODE k;
3040   u32 mainkid[2];
3041   u32 sigdate = 0;
3042   KBNODE signode;
3043   u32 curtime = make_timestamp ();
3044   unsigned int key_usage = 0;
3045   u32 keytimestamp = 0;
3046   u32 key_expire = 0;
3047   const byte *p;
3048
3049   if (subnode->pkt->pkttype != PKT_PUBLIC_SUBKEY)
3050     BUG ();
3051   mainpk = keyblock->pkt->pkt.public_key;
3052   if (mainpk->version < 4)
3053     return;/* (actually this should never happen) */
3054   keyid_from_pk (mainpk, mainkid);
3055   subpk = subnode->pkt->pkt.public_key;
3056   keytimestamp = subpk->timestamp;
3057
3058   subpk->flags.valid = 0;
3059   subpk->flags.exact = 0;
3060   subpk->main_keyid[0] = mainpk->main_keyid[0];
3061   subpk->main_keyid[1] = mainpk->main_keyid[1];
3062
3063   /* Find the latest key binding self-signature.  */
3064   signode = NULL;
3065   sigdate = 0; /* Helper to find the latest signature.  */
3066   for (k = subnode->next; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
3067        k = k->next)
3068     {
3069       if (k->pkt->pkttype == PKT_SIGNATURE)
3070         {
3071           sig = k->pkt->pkt.signature;
3072           if (sig->keyid[0] == mainkid[0] && sig->keyid[1] == mainkid[1])
3073             {
3074               if (check_key_signature (keyblock, k, NULL))
3075                 ; /* Signature did not verify.  */
3076               else if (IS_SUBKEY_REV (sig))
3077                 {
3078                   /* Note that this means that the date on a
3079                      revocation sig does not matter - even if the
3080                      binding sig is dated after the revocation sig,
3081                      the subkey is still marked as revoked.  This
3082                      seems ok, as it is just as easy to make new
3083                      subkeys rather than re-sign old ones as the
3084                      problem is in the distribution.  Plus, PGP (7)
3085                      does this the same way.  */
3086                   subpk->flags.revoked = 1;
3087                   sig_to_revoke_info (sig, &subpk->revoked);
3088                   /* Although we could stop now, we continue to
3089                    * figure out other information like the old expiration
3090                    * time.  */
3091                 }
3092               else if (IS_SUBKEY_SIG (sig) && sig->timestamp >= sigdate)
3093                 {
3094                   if (sig->flags.expired)
3095                     ; /* Signature has expired - ignore it.  */
3096                   else
3097                     {
3098                       sigdate = sig->timestamp;
3099                       signode = k;
3100                       signode->pkt->pkt.signature->flags.chosen_selfsig = 0;
3101                     }
3102                 }
3103             }
3104         }
3105     }
3106
3107   /* No valid key binding.  */
3108   if (!signode)
3109     return;
3110
3111   sig = signode->pkt->pkt.signature;
3112   sig->flags.chosen_selfsig = 1; /* So we know which selfsig we chose later.  */
3113
3114   key_usage = parse_key_usage (sig);
3115   if (!key_usage)
3116     {
3117       /* No key flags at all: get it from the algo.  */
3118       key_usage = openpgp_pk_algo_usage (subpk->pubkey_algo);
3119     }
3120   else
3121     {
3122       /* Check that the usage matches the usage as given by the algo.  */
3123       int x = openpgp_pk_algo_usage (subpk->pubkey_algo);
3124       if (x) /* Mask it down to the actual allowed usage.  */
3125         key_usage &= x;
3126     }
3127
3128   subpk->pubkey_usage = key_usage;
3129
3130   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
3131   if (p && buf32_to_u32 (p))
3132     key_expire = keytimestamp + buf32_to_u32 (p);
3133   else
3134     key_expire = 0;
3135   subpk->has_expired = key_expire >= curtime ? 0 : key_expire;
3136   subpk->expiredate = key_expire;
3137
3138   /* Algo doesn't exist.  */
3139   if (openpgp_pk_test_algo (subpk->pubkey_algo))
3140     return;
3141
3142   subpk->flags.valid = 1;
3143
3144   /* Find the most recent 0x19 embedded signature on our self-sig. */
3145   if (!subpk->flags.backsig)
3146     {
3147       int seq = 0;
3148       size_t n;
3149       PKT_signature *backsig = NULL;
3150
3151       sigdate = 0;
3152
3153       /* We do this while() since there may be other embedded
3154          signatures in the future.  We only want 0x19 here. */
3155
3156       while ((p = enum_sig_subpkt (sig->hashed,
3157                                    SIGSUBPKT_SIGNATURE, &n, &seq, NULL)))
3158         if (n > 3
3159             && ((p[0] == 3 && p[2] == 0x19) || (p[0] == 4 && p[1] == 0x19)))
3160           {
3161             PKT_signature *tempsig = buf_to_sig (p, n);
3162             if (tempsig)
3163               {
3164                 if (tempsig->timestamp > sigdate)
3165                   {
3166                     if (backsig)
3167                       free_seckey_enc (backsig);
3168
3169                     backsig = tempsig;
3170                     sigdate = backsig->timestamp;
3171                   }
3172                 else
3173                   free_seckey_enc (tempsig);
3174               }
3175           }
3176
3177       seq = 0;
3178
3179       /* It is safe to have this in the unhashed area since the 0x19
3180          is located on the selfsig for convenience, not security. */
3181
3182       while ((p = enum_sig_subpkt (sig->unhashed, SIGSUBPKT_SIGNATURE,
3183                                    &n, &seq, NULL)))
3184         if (n > 3
3185             && ((p[0] == 3 && p[2] == 0x19) || (p[0] == 4 && p[1] == 0x19)))
3186           {
3187             PKT_signature *tempsig = buf_to_sig (p, n);
3188             if (tempsig)
3189               {
3190                 if (tempsig->timestamp > sigdate)
3191                   {
3192                     if (backsig)
3193                       free_seckey_enc (backsig);
3194
3195                     backsig = tempsig;
3196                     sigdate = backsig->timestamp;
3197                   }
3198                 else
3199                   free_seckey_enc (tempsig);
3200               }
3201           }
3202
3203       if (backsig)
3204         {
3205           /* At this point, backsig contains the most recent 0x19 sig.
3206              Let's see if it is good. */
3207
3208           /* 2==valid, 1==invalid, 0==didn't check */
3209           if (check_backsig (mainpk, subpk, backsig) == 0)
3210             subpk->flags.backsig = 2;
3211           else
3212             subpk->flags.backsig = 1;
3213
3214           free_seckey_enc (backsig);
3215         }
3216     }
3217 }
3218
3219
3220 /* Merge information from the self-signatures with the public key,
3221    subkeys and user ids to make using them more easy.
3222
3223    See documentation for merge_selfsigs_main, merge_selfsigs_subkey
3224    and fixup_uidnode for exactly which fields are updated.  */
3225 static void
3226 merge_selfsigs (KBNODE keyblock)
3227 {
3228   KBNODE k;
3229   int revoked;
3230   struct revoke_info rinfo;
3231   PKT_public_key *main_pk;
3232   prefitem_t *prefs;
3233   unsigned int mdc_feature;
3234
3235   if (keyblock->pkt->pkttype != PKT_PUBLIC_KEY)
3236     {
3237       if (keyblock->pkt->pkttype == PKT_SECRET_KEY)
3238         {
3239           log_error ("expected public key but found secret key "
3240                      "- must stop\n");
3241           /* We better exit here because a public key is expected at
3242              other places too.  FIXME: Figure this out earlier and
3243              don't get to here at all */
3244           g10_exit (1);
3245         }
3246       BUG ();
3247     }
3248
3249   merge_selfsigs_main (keyblock, &revoked, &rinfo);
3250
3251   /* Now merge in the data from each of the subkeys.  */
3252   for (k = keyblock; k; k = k->next)
3253     {
3254       if (k->pkt->pkttype == PKT_PUBLIC_SUBKEY)
3255         {
3256           merge_selfsigs_subkey (keyblock, k);
3257         }
3258     }
3259
3260   main_pk = keyblock->pkt->pkt.public_key;
3261   if (revoked || main_pk->has_expired || !main_pk->flags.valid)
3262     {
3263       /* If the primary key is revoked, expired, or invalid we
3264        * better set the appropriate flags on that key and all
3265        * subkeys.  */
3266       for (k = keyblock; k; k = k->next)
3267         {
3268           if (k->pkt->pkttype == PKT_PUBLIC_KEY
3269               || k->pkt->pkttype == PKT_PUBLIC_SUBKEY)
3270             {
3271               PKT_public_key *pk = k->pkt->pkt.public_key;
3272               if (!main_pk->flags.valid)
3273                 pk->flags.valid = 0;
3274               if (revoked && !pk->flags.revoked)
3275                 {
3276                   pk->flags.revoked = revoked;
3277                   memcpy (&pk->revoked, &rinfo, sizeof (rinfo));
3278                 }
3279               if (main_pk->has_expired)
3280                 pk->has_expired = main_pk->has_expired;
3281             }
3282         }
3283       return;
3284     }
3285
3286   /* Set the preference list of all keys to those of the primary real
3287    * user ID.  Note: we use these preferences when we don't know by
3288    * which user ID the key has been selected.
3289    * fixme: we should keep atoms of commonly used preferences or
3290    * use reference counting to optimize the preference lists storage.
3291    * FIXME: it might be better to use the intersection of
3292    * all preferences.
3293    * Do a similar thing for the MDC feature flag.  */
3294   prefs = NULL;
3295   mdc_feature = 0;
3296   for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next)
3297     {
3298       if (k->pkt->pkttype == PKT_USER_ID
3299           && !k->pkt->pkt.user_id->attrib_data
3300           && k->pkt->pkt.user_id->is_primary)
3301         {
3302           prefs = k->pkt->pkt.user_id->prefs;
3303           mdc_feature = k->pkt->pkt.user_id->flags.mdc;
3304           break;
3305         }
3306     }
3307   for (k = keyblock; k; k = k->next)
3308     {
3309       if (k->pkt->pkttype == PKT_PUBLIC_KEY
3310           || k->pkt->pkttype == PKT_PUBLIC_SUBKEY)
3311         {
3312           PKT_public_key *pk = k->pkt->pkt.public_key;
3313           if (pk->prefs)
3314             xfree (pk->prefs);
3315           pk->prefs = copy_prefs (prefs);
3316           pk->flags.mdc = mdc_feature;
3317         }
3318     }
3319 }
3320
3321
3322 \f
3323 /* See whether the key satisfies any additional requirements specified
3324  * in CTX.  If so, return the node of an appropriate key or subkey.
3325  * Otherwise, return NULL if there was no appropriate key.
3326  *
3327  * In case the primary key is not required, select a suitable subkey.
3328  * We need the primary key if PUBKEY_USAGE_CERT is set in REQ_USAGE or
3329  * we are in PGP6 or PGP7 mode and PUBKEY_USAGE_SIG is set in
3330  * REQ_USAGE.
3331  *
3332  * If any of PUBKEY_USAGE_SIG, PUBKEY_USAGE_ENC and PUBKEY_USAGE_CERT
3333  * are set in REQ_USAGE, we filter by the key's function.  Concretely,
3334  * if PUBKEY_USAGE_SIG and PUBKEY_USAGE_CERT are set, then we only
3335  * return a key if it is (at least) either a signing or a
3336  * certification key.
3337  *
3338  * If REQ_USAGE is set, then we reject any keys that are not good
3339  * (i.e., valid, not revoked, not expired, etc.).  This allows the
3340  * getkey functions to be used for plain key listings.
3341  *
3342  * Sets the matched key's user id field (pk->user_id) to the user id
3343  * that matched the low-level search criteria or NULL.
3344  *
3345  * If R_FLAGS is not NULL set certain flags for more detailed error
3346  * reporting.  Used flags are:
3347  *
3348  * - LOOKUP_ALL_SUBKEYS_EXPIRED :: All Subkeys are expired or have
3349  *                                 been revoked.
3350  * - LOOKUP_NOT_SELECTED :: No suitable key found
3351  *
3352  * This function needs to handle several different cases:
3353  *
3354  *  1. No requested usage and no primary key requested
3355  *     Examples for this case are that we have a keyID to be used
3356  *     for decrytion or verification.
3357  *  2. No usage but primary key requested
3358  *     This is the case for all functions which work on an
3359  *     entire keyblock, e.g. for editing or listing
3360  *  3. Usage and primary key requested
3361  *     FIXME
3362  *  4. Usage but no primary key requested
3363  *     FIXME
3364  *
3365  */
3366 static kbnode_t
3367 finish_lookup (kbnode_t keyblock, unsigned int req_usage, int want_exact,
3368                unsigned int *r_flags)
3369 {
3370   kbnode_t k;
3371
3372   /* If WANT_EXACT is set, the key or subkey that actually matched the
3373      low-level search criteria.  */
3374   kbnode_t foundk = NULL;
3375   /* The user id (if any) that matched the low-level search criteria.  */
3376   PKT_user_id *foundu = NULL;
3377
3378   u32 latest_date;
3379   kbnode_t latest_key;
3380   PKT_public_key *pk;
3381   int req_prim;
3382   u32 curtime = make_timestamp ();
3383
3384   if (r_flags)
3385     *r_flags = 0;
3386
3387 #define USAGE_MASK  (PUBKEY_USAGE_SIG|PUBKEY_USAGE_ENC|PUBKEY_USAGE_CERT)
3388   req_usage &= USAGE_MASK;
3389
3390   /* Request the primary if we're certifying another key, and also if
3391    * signing data while --pgp6 or --pgp7 is on since pgp 6 and 7 do
3392    * not understand signatures made by a signing subkey.  PGP 8 does. */
3393   req_prim = ((req_usage & PUBKEY_USAGE_CERT)
3394               || ((PGP6 || PGP7) && (req_usage & PUBKEY_USAGE_SIG)));
3395
3396
3397   log_assert (keyblock->pkt->pkttype == PKT_PUBLIC_KEY);
3398
3399   /* For an exact match mark the primary or subkey that matched the
3400      low-level search criteria.  */
3401   if (want_exact)
3402     {
3403       for (k = keyblock; k; k = k->next)
3404         {
3405           if ((k->flag & 1))
3406             {
3407               log_assert (k->pkt->pkttype == PKT_PUBLIC_KEY
3408                           || k->pkt->pkttype == PKT_PUBLIC_SUBKEY);
3409               foundk = k;
3410               pk = k->pkt->pkt.public_key;
3411               pk->flags.exact = 1;
3412               break;
3413             }
3414         }
3415     }
3416
3417   /* Get the user id that matched that low-level search criteria.  */
3418   for (k = keyblock; k; k = k->next)
3419     {
3420       if ((k->flag & 2))
3421         {
3422           log_assert (k->pkt->pkttype == PKT_USER_ID);
3423           foundu = k->pkt->pkt.user_id;
3424           break;
3425         }
3426     }
3427
3428   if (DBG_LOOKUP)
3429     log_debug ("finish_lookup: checking key %08lX (%s)(req_usage=%x)\n",
3430                (ulong) keyid_from_pk (keyblock->pkt->pkt.public_key, NULL),
3431                foundk ? "one" : "all", req_usage);
3432
3433   if (!req_usage)
3434     {
3435       latest_key = foundk ? foundk : keyblock;
3436       goto found;
3437     }
3438
3439   latest_date = 0;
3440   latest_key = NULL;
3441   /* Set LATEST_KEY to the latest (the one with the most recent
3442    * timestamp) good (valid, not revoked, not expired, etc.) subkey.
3443    *
3444    * Don't bother if we are only looking for a primary key or we need
3445    * an exact match and the exact match is not a subkey.  */
3446   if (req_prim || (foundk && foundk->pkt->pkttype != PKT_PUBLIC_SUBKEY))
3447     ;
3448   else
3449     {
3450       kbnode_t nextk;
3451       int n_subkeys = 0;
3452       int n_revoked_or_expired = 0;
3453
3454       /* Either start a loop or check just this one subkey.  */
3455       for (k = foundk ? foundk : keyblock; k; k = nextk)
3456         {
3457           if (foundk)
3458             {
3459               /* If FOUNDK is not NULL, then only consider that exact
3460                  key, i.e., don't iterate.  */
3461               nextk = NULL;
3462             }
3463           else
3464             nextk = k->next;
3465
3466           if (k->pkt->pkttype != PKT_PUBLIC_SUBKEY)
3467             continue;
3468
3469           pk = k->pkt->pkt.public_key;
3470           if (DBG_LOOKUP)
3471             log_debug ("\tchecking subkey %08lX\n",
3472                        (ulong) keyid_from_pk (pk, NULL));
3473
3474           if (!pk->flags.valid)
3475             {
3476               if (DBG_LOOKUP)
3477                 log_debug ("\tsubkey not valid\n");
3478               continue;
3479             }
3480           if (!((pk->pubkey_usage & USAGE_MASK) & req_usage))
3481             {
3482               if (DBG_LOOKUP)
3483                 log_debug ("\tusage does not match: want=%x have=%x\n",
3484                            req_usage, pk->pubkey_usage);
3485               continue;
3486             }
3487
3488           n_subkeys++;
3489           if (pk->flags.revoked)
3490             {
3491               if (DBG_LOOKUP)
3492                 log_debug ("\tsubkey has been revoked\n");
3493               n_revoked_or_expired++;
3494               continue;
3495             }
3496           if (pk->has_expired)
3497             {
3498               if (DBG_LOOKUP)
3499                 log_debug ("\tsubkey has expired\n");
3500               n_revoked_or_expired++;
3501               continue;
3502             }
3503           if (pk->timestamp > curtime && !opt.ignore_valid_from)
3504             {
3505               if (DBG_LOOKUP)
3506                 log_debug ("\tsubkey not yet valid\n");
3507               continue;
3508             }
3509
3510           if (DBG_LOOKUP)
3511             log_debug ("\tsubkey might be fine\n");
3512           /* In case a key has a timestamp of 0 set, we make sure
3513              that it is used.  A better change would be to compare
3514              ">=" but that might also change the selected keys and
3515              is as such a more intrusive change.  */
3516           if (pk->timestamp > latest_date || (!pk->timestamp && !latest_date))
3517             {
3518               latest_date = pk->timestamp;
3519               latest_key = k;
3520             }
3521         }
3522       if (n_subkeys == n_revoked_or_expired && r_flags)
3523         *r_flags |= LOOKUP_ALL_SUBKEYS_EXPIRED;
3524     }
3525
3526   /* Check if the primary key is ok (valid, not revoke, not expire,
3527    * matches requested usage) if:
3528    *
3529    *   - we didn't find an appropriate subkey and we're not doing an
3530    *     exact search,
3531    *
3532    *   - we're doing an exact match and the exact match was the
3533    *     primary key, or,
3534    *
3535    *   - we're just considering the primary key.  */
3536   if ((!latest_key && !want_exact) || foundk == keyblock || req_prim)
3537     {
3538       if (DBG_LOOKUP && !foundk && !req_prim)
3539         log_debug ("\tno suitable subkeys found - trying primary\n");
3540       pk = keyblock->pkt->pkt.public_key;
3541       if (!pk->flags.valid)
3542         {
3543           if (DBG_LOOKUP)
3544             log_debug ("\tprimary key not valid\n");
3545         }
3546       else if (!((pk->pubkey_usage & USAGE_MASK) & req_usage))
3547         {
3548           if (DBG_LOOKUP)
3549             log_debug ("\tprimary key usage does not match: "
3550                        "want=%x have=%x\n", req_usage, pk->pubkey_usage);
3551         }
3552       else if (pk->flags.revoked)
3553         {
3554           if (DBG_LOOKUP)
3555             log_debug ("\tprimary key has been revoked\n");
3556         }
3557       else if (pk->has_expired)
3558         {
3559           if (DBG_LOOKUP)
3560             log_debug ("\tprimary key has expired\n");
3561         }
3562       else /* Okay.  */
3563         {
3564           if (DBG_LOOKUP)
3565             log_debug ("\tprimary key may be used\n");
3566           latest_key = keyblock;
3567         }
3568     }
3569
3570   if (!latest_key)
3571     {
3572       if (DBG_LOOKUP)
3573         log_debug ("\tno suitable key found -  giving up\n