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