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