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