gpg: Distinguish between missing and cleared key flags.
[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       if (!key_usage)
1281         key_usage |= PUBKEY_USAGE_NONE;
1282     }
1283   else if (p) /* Key flags of length zero.  */
1284     key_usage |= PUBKEY_USAGE_NONE;
1285
1286   /* We set PUBKEY_USAGE_UNKNOWN to indicate that this key has a
1287      capability that we do not handle.  This serves to distinguish
1288      between a zero key usage which we handle as the default
1289      capabilities for that algorithm, and a usage that we do not
1290      handle.  Likewise we use PUBKEY_USAGE_NONE to indicate that
1291      key_flags have been given but they do not specify any usage.  */
1292
1293   return key_usage;
1294 }
1295
1296
1297 /* Apply information from SIGNODE (which is the valid self-signature
1298  * associated with that UID) to the UIDNODE:
1299  * - wether the UID has been revoked
1300  * - assumed creation date of the UID
1301  * - temporary store the keyflags here
1302  * - temporary store the key expiration time here
1303  * - mark whether the primary user ID flag hat been set.
1304  * - store the preferences
1305  */
1306 static void
1307 fixup_uidnode (KBNODE uidnode, KBNODE signode, u32 keycreated)
1308 {
1309   PKT_user_id *uid = uidnode->pkt->pkt.user_id;
1310   PKT_signature *sig = signode->pkt->pkt.signature;
1311   const byte *p, *sym, *hash, *zip;
1312   size_t n, nsym, nhash, nzip;
1313
1314   sig->flags.chosen_selfsig = 1;/* We chose this one. */
1315   uid->created = 0;             /* Not created == invalid. */
1316   if (IS_UID_REV (sig))
1317     {
1318       uid->is_revoked = 1;
1319       return; /* Has been revoked.  */
1320     }
1321   else
1322     uid->is_revoked = 0;
1323
1324   uid->expiredate = sig->expiredate;
1325
1326   if (sig->flags.expired)
1327     {
1328       uid->is_expired = 1;
1329       return; /* Has expired.  */
1330     }
1331   else
1332     uid->is_expired = 0;
1333
1334   uid->created = sig->timestamp; /* This one is okay. */
1335   uid->selfsigversion = sig->version;
1336   /* If we got this far, it's not expired :) */
1337   uid->is_expired = 0;
1338
1339   /* Store the key flags in the helper variable for later processing.  */
1340   uid->help_key_usage = parse_key_usage (sig);
1341
1342   /* Ditto for the key expiration.  */
1343   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
1344   if (p && buffer_to_u32 (p))
1345     uid->help_key_expire = keycreated + buffer_to_u32 (p);
1346   else
1347     uid->help_key_expire = 0;
1348
1349   /* Set the primary user ID flag - we will later wipe out some
1350    * of them to only have one in our keyblock.  */
1351   uid->is_primary = 0;
1352   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_PRIMARY_UID, NULL);
1353   if (p && *p)
1354     uid->is_primary = 2;
1355
1356   /* We could also query this from the unhashed area if it is not in
1357    * the hased area and then later try to decide which is the better
1358    * there should be no security problem with this.
1359    * For now we only look at the hashed one.  */
1360
1361   /* Now build the preferences list.  These must come from the
1362      hashed section so nobody can modify the ciphers a key is
1363      willing to accept.  */
1364   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_PREF_SYM, &n);
1365   sym = p;
1366   nsym = p ? n : 0;
1367   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_PREF_HASH, &n);
1368   hash = p;
1369   nhash = p ? n : 0;
1370   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_PREF_COMPR, &n);
1371   zip = p;
1372   nzip = p ? n : 0;
1373   if (uid->prefs)
1374     xfree (uid->prefs);
1375   n = nsym + nhash + nzip;
1376   if (!n)
1377     uid->prefs = NULL;
1378   else
1379     {
1380       uid->prefs = xmalloc (sizeof (*uid->prefs) * (n + 1));
1381       n = 0;
1382       for (; nsym; nsym--, n++)
1383         {
1384           uid->prefs[n].type = PREFTYPE_SYM;
1385           uid->prefs[n].value = *sym++;
1386         }
1387       for (; nhash; nhash--, n++)
1388         {
1389           uid->prefs[n].type = PREFTYPE_HASH;
1390           uid->prefs[n].value = *hash++;
1391         }
1392       for (; nzip; nzip--, n++)
1393         {
1394           uid->prefs[n].type = PREFTYPE_ZIP;
1395           uid->prefs[n].value = *zip++;
1396         }
1397       uid->prefs[n].type = PREFTYPE_NONE; /* End of list marker  */
1398       uid->prefs[n].value = 0;
1399     }
1400
1401   /* See whether we have the MDC feature.  */
1402   uid->flags.mdc = 0;
1403   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_FEATURES, &n);
1404   if (p && n && (p[0] & 0x01))
1405     uid->flags.mdc = 1;
1406
1407   /* And the keyserver modify flag.  */
1408   uid->flags.ks_modify = 1;
1409   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KS_FLAGS, &n);
1410   if (p && n && (p[0] & 0x80))
1411     uid->flags.ks_modify = 0;
1412 }
1413
1414 static void
1415 sig_to_revoke_info (PKT_signature * sig, struct revoke_info *rinfo)
1416 {
1417   rinfo->date = sig->timestamp;
1418   rinfo->algo = sig->pubkey_algo;
1419   rinfo->keyid[0] = sig->keyid[0];
1420   rinfo->keyid[1] = sig->keyid[1];
1421 }
1422
1423
1424 /* Note that R_REVOKED may be set to 0, 1 or 2.  */
1425 static void
1426 merge_selfsigs_main (KBNODE keyblock, int *r_revoked,
1427                      struct revoke_info *rinfo)
1428 {
1429   PKT_public_key *pk = NULL;
1430   KBNODE k;
1431   u32 kid[2];
1432   u32 sigdate, uiddate, uiddate2;
1433   KBNODE signode, uidnode, uidnode2;
1434   u32 curtime = make_timestamp ();
1435   unsigned int key_usage = 0;
1436   u32 keytimestamp = 0;
1437   u32 key_expire = 0;
1438   int key_expire_seen = 0;
1439   byte sigversion = 0;
1440
1441   *r_revoked = 0;
1442   memset (rinfo, 0, sizeof (*rinfo));
1443
1444   if (keyblock->pkt->pkttype != PKT_PUBLIC_KEY)
1445     BUG ();
1446   pk = keyblock->pkt->pkt.public_key;
1447   keytimestamp = pk->timestamp;
1448
1449   keyid_from_pk (pk, kid);
1450   pk->main_keyid[0] = kid[0];
1451   pk->main_keyid[1] = kid[1];
1452
1453   if (pk->version < 4)
1454     {
1455       /* Before v4 the key packet itself contains the expiration date
1456        * and there was no way to change it, so we start with the one
1457        * from the key packet.  */
1458       key_expire = pk->max_expiredate;
1459       key_expire_seen = 1;
1460     }
1461
1462   /* First pass: Find the latest direct key self-signature.  We assume
1463    * that the newest one overrides all others.  */
1464
1465   /* In case this key was already merged. */
1466   xfree (pk->revkey);
1467   pk->revkey = NULL;
1468   pk->numrevkeys = 0;
1469
1470   signode = NULL;
1471   sigdate = 0; /* Helper variable to find the latest signature.  */
1472   for (k = keyblock; k && k->pkt->pkttype != PKT_USER_ID; k = k->next)
1473     {
1474       if (k->pkt->pkttype == PKT_SIGNATURE)
1475         {
1476           PKT_signature *sig = k->pkt->pkt.signature;
1477           if (sig->keyid[0] == kid[0] && sig->keyid[1] == kid[1])
1478             {
1479               if (check_key_signature (keyblock, k, NULL))
1480                 ; /* Signature did not verify.  */
1481               else if (IS_KEY_REV (sig))
1482                 {
1483                   /* Key has been revoked - there is no way to
1484                    * override such a revocation, so we theoretically
1485                    * can stop now.  We should not cope with expiration
1486                    * times for revocations here because we have to
1487                    * assume that an attacker can generate all kinds of
1488                    * signatures.  However due to the fact that the key
1489                    * has been revoked it does not harm either and by
1490                    * continuing we gather some more info on that
1491                    * key.  */
1492                   *r_revoked = 1;
1493                   sig_to_revoke_info (sig, rinfo);
1494                 }
1495               else if (IS_KEY_SIG (sig))
1496                 {
1497                   /* Add any revocation keys onto the pk.  This is
1498                      particularly interesting since we normally only
1499                      get data from the most recent 1F signature, but
1500                      you need multiple 1F sigs to properly handle
1501                      revocation keys (PGP does it this way, and a
1502                      revocation key could be sensitive and hence in a
1503                      different signature). */
1504                   if (sig->revkey)
1505                     {
1506                       int i;
1507
1508                       pk->revkey =
1509                         xrealloc (pk->revkey, sizeof (struct revocation_key) *
1510                                   (pk->numrevkeys + sig->numrevkeys));
1511
1512                       for (i = 0; i < sig->numrevkeys; i++)
1513                         memcpy (&pk->revkey[pk->numrevkeys++],
1514                                 sig->revkey[i],
1515                                 sizeof (struct revocation_key));
1516                     }
1517
1518                   if (sig->timestamp >= sigdate)
1519                     {
1520                       if (sig->flags.expired)
1521                         ; /* Signature has expired - ignore it.  */
1522                       else
1523                         {
1524                           sigdate = sig->timestamp;
1525                           signode = k;
1526                           if (sig->version > sigversion)
1527                             sigversion = sig->version;
1528
1529                         }
1530                     }
1531                 }
1532             }
1533         }
1534     }
1535
1536   /* Remove dupes from the revocation keys.  */
1537
1538   if (pk->revkey)
1539     {
1540       int i, j, x, changed = 0;
1541
1542       for (i = 0; i < pk->numrevkeys; i++)
1543         {
1544           for (j = i + 1; j < pk->numrevkeys; j++)
1545             {
1546               if (memcmp (&pk->revkey[i], &pk->revkey[j],
1547                           sizeof (struct revocation_key)) == 0)
1548                 {
1549                   /* remove j */
1550
1551                   for (x = j; x < pk->numrevkeys - 1; x++)
1552                     pk->revkey[x] = pk->revkey[x + 1];
1553
1554                   pk->numrevkeys--;
1555                   j--;
1556                   changed = 1;
1557                 }
1558             }
1559         }
1560
1561       if (changed)
1562         pk->revkey = xrealloc (pk->revkey,
1563                                pk->numrevkeys *
1564                                sizeof (struct revocation_key));
1565     }
1566
1567   if (signode)
1568     {
1569       /* Some information from a direct key signature take precedence
1570        * over the same information given in UID sigs.  */
1571       PKT_signature *sig = signode->pkt->pkt.signature;
1572       const byte *p;
1573
1574       key_usage = parse_key_usage (sig);
1575
1576       p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
1577       if (p && buffer_to_u32 (p))
1578         {
1579           key_expire = keytimestamp + buffer_to_u32 (p);
1580           key_expire_seen = 1;
1581         }
1582
1583       /* Mark that key as valid: One direct key signature should
1584        * render a key as valid.  */
1585       pk->flags.valid = 1;
1586     }
1587
1588   /* Pass 1.5: Look for key revocation signatures that were not made
1589      by the key (i.e. did a revocation key issue a revocation for
1590      us?).  Only bother to do this if there is a revocation key in the
1591      first place and we're not revoked already.  */
1592
1593   if (!*r_revoked && pk->revkey)
1594     for (k = keyblock; k && k->pkt->pkttype != PKT_USER_ID; k = k->next)
1595       {
1596         if (k->pkt->pkttype == PKT_SIGNATURE)
1597           {
1598             PKT_signature *sig = k->pkt->pkt.signature;
1599
1600             if (IS_KEY_REV (sig) &&
1601                 (sig->keyid[0] != kid[0] || sig->keyid[1] != kid[1]))
1602               {
1603                 int rc = check_revocation_keys (pk, sig);
1604                 if (rc == 0)
1605                   {
1606                     *r_revoked = 2;
1607                     sig_to_revoke_info (sig, rinfo);
1608                     /* Don't continue checking since we can't be any
1609                        more revoked than this.  */
1610                     break;
1611                   }
1612                 else if (rc == G10ERR_NO_PUBKEY)
1613                   pk->flags.maybe_revoked = 1;
1614
1615                 /* A failure here means the sig did not verify, was
1616                    not issued by a revocation key, or a revocation
1617                    key loop was broken.  If a revocation key isn't
1618                    findable, however, the key might be revoked and
1619                    we don't know it.  */
1620
1621                 /* TODO: In the future handle subkey and cert
1622                    revocations?  PGP doesn't, but it's in 2440. */
1623               }
1624           }
1625       }
1626
1627   /* Second pass: Look at the self-signature of all user IDs.  */
1628   signode = uidnode = NULL;
1629   sigdate = 0; /* Helper variable to find the latest signature in one UID. */
1630   for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next)
1631     {
1632       if (k->pkt->pkttype == PKT_USER_ID)
1633         {
1634           if (uidnode && signode)
1635             {
1636               fixup_uidnode (uidnode, signode, keytimestamp);
1637               pk->flags.valid = 1;
1638             }
1639           uidnode = k;
1640           signode = NULL;
1641           sigdate = 0;
1642         }
1643       else if (k->pkt->pkttype == PKT_SIGNATURE && uidnode)
1644         {
1645           PKT_signature *sig = k->pkt->pkt.signature;
1646           if (sig->keyid[0] == kid[0] && sig->keyid[1] == kid[1])
1647             {
1648               if (check_key_signature (keyblock, k, NULL))
1649                 ;               /* signature did not verify */
1650               else if ((IS_UID_SIG (sig) || IS_UID_REV (sig))
1651                        && sig->timestamp >= sigdate)
1652                 {
1653                   /* Note: we allow to invalidate cert revocations
1654                    * by a newer signature.  An attacker can't use this
1655                    * because a key should be revoced with a key revocation.
1656                    * The reason why we have to allow for that is that at
1657                    * one time an email address may become invalid but later
1658                    * the same email address may become valid again (hired,
1659                    * fired, hired again).  */
1660
1661                   sigdate = sig->timestamp;
1662                   signode = k;
1663                   signode->pkt->pkt.signature->flags.chosen_selfsig = 0;
1664                   if (sig->version > sigversion)
1665                     sigversion = sig->version;
1666                 }
1667             }
1668         }
1669     }
1670   if (uidnode && signode)
1671     {
1672       fixup_uidnode (uidnode, signode, keytimestamp);
1673       pk->flags.valid = 1;
1674     }
1675
1676   /* If the key isn't valid yet, and we have
1677      --allow-non-selfsigned-uid set, then force it valid. */
1678   if (!pk->flags.valid && opt.allow_non_selfsigned_uid)
1679     {
1680       if (opt.verbose)
1681         log_info (_("Invalid key %s made valid by"
1682                     " --allow-non-selfsigned-uid\n"), keystr_from_pk (pk));
1683       pk->flags.valid = 1;
1684     }
1685
1686   /* The key STILL isn't valid, so try and find an ultimately
1687      trusted signature. */
1688   if (!pk->flags.valid)
1689     {
1690       uidnode = NULL;
1691
1692       for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1693            k = k->next)
1694         {
1695           if (k->pkt->pkttype == PKT_USER_ID)
1696             uidnode = k;
1697           else if (k->pkt->pkttype == PKT_SIGNATURE && uidnode)
1698             {
1699               PKT_signature *sig = k->pkt->pkt.signature;
1700
1701               if (sig->keyid[0] != kid[0] || sig->keyid[1] != kid[1])
1702                 {
1703                   PKT_public_key *ultimate_pk;
1704
1705                   ultimate_pk = xmalloc_clear (sizeof (*ultimate_pk));
1706
1707                   /* We don't want to use the full get_pubkey to
1708                      avoid infinite recursion in certain cases.
1709                      There is no reason to check that an ultimately
1710                      trusted key is still valid - if it has been
1711                      revoked or the user should also renmove the
1712                      ultimate trust flag.  */
1713                   if (get_pubkey_fast (ultimate_pk, sig->keyid) == 0
1714                       && check_key_signature2 (keyblock, k, ultimate_pk,
1715                                                NULL, NULL, NULL, NULL) == 0
1716                       && get_ownertrust (ultimate_pk) == TRUST_ULTIMATE)
1717                     {
1718                       free_public_key (ultimate_pk);
1719                       pk->flags.valid = 1;
1720                       break;
1721                     }
1722
1723                   free_public_key (ultimate_pk);
1724                 }
1725             }
1726         }
1727     }
1728
1729   /* Record the highest selfsig version so we know if this is a v3
1730      key through and through, or a v3 key with a v4 selfsig
1731      somewhere.  This is useful in a few places to know if the key
1732      must be treated as PGP2-style or OpenPGP-style.  Note that a
1733      selfsig revocation with a higher version number will also raise
1734      this value.  This is okay since such a revocation must be
1735      issued by the user (i.e. it cannot be issued by someone else to
1736      modify the key behavior.) */
1737
1738   pk->selfsigversion = sigversion;
1739
1740   /* Now that we had a look at all user IDs we can now get some information
1741    * from those user IDs.
1742    */
1743
1744   if (!key_usage)
1745     {
1746       /* Find the latest user ID with key flags set. */
1747       uiddate = 0; /* Helper to find the latest user ID.  */
1748       for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1749            k = k->next)
1750         {
1751           if (k->pkt->pkttype == PKT_USER_ID)
1752             {
1753               PKT_user_id *uid = k->pkt->pkt.user_id;
1754               if (uid->help_key_usage && uid->created > uiddate)
1755                 {
1756                   key_usage = uid->help_key_usage;
1757                   uiddate = uid->created;
1758                 }
1759             }
1760         }
1761     }
1762   if (!key_usage)
1763     {
1764       /* No key flags at all: get it from the algo.  */
1765       key_usage = openpgp_pk_algo_usage (pk->pubkey_algo);
1766     }
1767   else
1768     {
1769       /* Check that the usage matches the usage as given by the algo.  */
1770       int x = openpgp_pk_algo_usage (pk->pubkey_algo);
1771       if (x) /* Mask it down to the actual allowed usage.  */
1772         key_usage &= x;
1773     }
1774
1775   /* Whatever happens, it's a primary key, so it can certify. */
1776   pk->pubkey_usage = key_usage | PUBKEY_USAGE_CERT;
1777
1778   if (!key_expire_seen)
1779     {
1780       /* Find the latest valid user ID with a key expiration set
1781        * Note, that this may be a different one from the above because
1782        * some user IDs may have no expiration date set.  */
1783       uiddate = 0;
1784       for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1785            k = k->next)
1786         {
1787           if (k->pkt->pkttype == PKT_USER_ID)
1788             {
1789               PKT_user_id *uid = k->pkt->pkt.user_id;
1790               if (uid->help_key_expire && uid->created > uiddate)
1791                 {
1792                   key_expire = uid->help_key_expire;
1793                   uiddate = uid->created;
1794                 }
1795             }
1796         }
1797     }
1798
1799   /* Currently only v3 keys have a maximum expiration date, but I'll
1800      bet v5 keys get this feature again. */
1801   if (key_expire == 0
1802       || (pk->max_expiredate && key_expire > pk->max_expiredate))
1803     key_expire = pk->max_expiredate;
1804
1805   pk->has_expired = key_expire >= curtime ? 0 : key_expire;
1806   pk->expiredate = key_expire;
1807
1808   /* Fixme: we should see how to get rid of the expiretime fields  but
1809    * this needs changes at other places too. */
1810
1811   /* And now find the real primary user ID and delete all others.  */
1812   uiddate = uiddate2 = 0;
1813   uidnode = uidnode2 = NULL;
1814   for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next)
1815     {
1816       if (k->pkt->pkttype == PKT_USER_ID && !k->pkt->pkt.user_id->attrib_data)
1817         {
1818           PKT_user_id *uid = k->pkt->pkt.user_id;
1819           if (uid->is_primary)
1820             {
1821               if (uid->created > uiddate)
1822                 {
1823                   uiddate = uid->created;
1824                   uidnode = k;
1825                 }
1826               else if (uid->created == uiddate && uidnode)
1827                 {
1828                   /* The dates are equal, so we need to do a
1829                      different (and arbitrary) comparison.  This
1830                      should rarely, if ever, happen.  It's good to
1831                      try and guarantee that two different GnuPG
1832                      users with two different keyrings at least pick
1833                      the same primary. */
1834                   if (cmp_user_ids (uid, uidnode->pkt->pkt.user_id) > 0)
1835                     uidnode = k;
1836                 }
1837             }
1838           else
1839             {
1840               if (uid->created > uiddate2)
1841                 {
1842                   uiddate2 = uid->created;
1843                   uidnode2 = k;
1844                 }
1845               else if (uid->created == uiddate2 && uidnode2)
1846                 {
1847                   if (cmp_user_ids (uid, uidnode2->pkt->pkt.user_id) > 0)
1848                     uidnode2 = k;
1849                 }
1850             }
1851         }
1852     }
1853   if (uidnode)
1854     {
1855       for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1856            k = k->next)
1857         {
1858           if (k->pkt->pkttype == PKT_USER_ID &&
1859               !k->pkt->pkt.user_id->attrib_data)
1860             {
1861               PKT_user_id *uid = k->pkt->pkt.user_id;
1862               if (k != uidnode)
1863                 uid->is_primary = 0;
1864             }
1865         }
1866     }
1867   else if (uidnode2)
1868     {
1869       /* None is flagged primary - use the latest user ID we have,
1870          and disambiguate with the arbitrary packet comparison. */
1871       uidnode2->pkt->pkt.user_id->is_primary = 1;
1872     }
1873   else
1874     {
1875       /* None of our uids were self-signed, so pick the one that
1876          sorts first to be the primary.  This is the best we can do
1877          here since there are no self sigs to date the uids. */
1878
1879       uidnode = NULL;
1880
1881       for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1882            k = k->next)
1883         {
1884           if (k->pkt->pkttype == PKT_USER_ID
1885               && !k->pkt->pkt.user_id->attrib_data)
1886             {
1887               if (!uidnode)
1888                 {
1889                   uidnode = k;
1890                   uidnode->pkt->pkt.user_id->is_primary = 1;
1891                   continue;
1892                 }
1893               else
1894                 {
1895                   if (cmp_user_ids (k->pkt->pkt.user_id,
1896                                     uidnode->pkt->pkt.user_id) > 0)
1897                     {
1898                       uidnode->pkt->pkt.user_id->is_primary = 0;
1899                       uidnode = k;
1900                       uidnode->pkt->pkt.user_id->is_primary = 1;
1901                     }
1902                   else
1903                     k->pkt->pkt.user_id->is_primary = 0;        /* just to be
1904                                                                    safe */
1905                 }
1906             }
1907         }
1908     }
1909 }
1910
1911 /* Convert a buffer to a signature.  Useful for 0x19 embedded sigs.
1912    Caller must free the signature when they are done. */
1913 static PKT_signature *
1914 buf_to_sig (const byte * buf, size_t len)
1915 {
1916   PKT_signature *sig = xmalloc_clear (sizeof (PKT_signature));
1917   IOBUF iobuf = iobuf_temp_with_content (buf, len);
1918   int save_mode = set_packet_list_mode (0);
1919
1920   if (parse_signature (iobuf, PKT_SIGNATURE, len, sig) != 0)
1921     {
1922       xfree (sig);
1923       sig = NULL;
1924     }
1925
1926   set_packet_list_mode (save_mode);
1927   iobuf_close (iobuf);
1928
1929   return sig;
1930 }
1931
1932 static void
1933 merge_selfsigs_subkey (KBNODE keyblock, KBNODE subnode)
1934 {
1935   PKT_public_key *mainpk = NULL, *subpk = NULL;
1936   PKT_signature *sig;
1937   KBNODE k;
1938   u32 mainkid[2];
1939   u32 sigdate = 0;
1940   KBNODE signode;
1941   u32 curtime = make_timestamp ();
1942   unsigned int key_usage = 0;
1943   u32 keytimestamp = 0;
1944   u32 key_expire = 0;
1945   const byte *p;
1946
1947   if (subnode->pkt->pkttype != PKT_PUBLIC_SUBKEY)
1948     BUG ();
1949   mainpk = keyblock->pkt->pkt.public_key;
1950   if (mainpk->version < 4)
1951     return;/* (actually this should never happen) */
1952   keyid_from_pk (mainpk, mainkid);
1953   subpk = subnode->pkt->pkt.public_key;
1954   keytimestamp = subpk->timestamp;
1955
1956   subpk->flags.valid = 0;
1957   subpk->main_keyid[0] = mainpk->main_keyid[0];
1958   subpk->main_keyid[1] = mainpk->main_keyid[1];
1959
1960   /* Find the latest key binding self-signature.  */
1961   signode = NULL;
1962   sigdate = 0; /* Helper to find the latest signature.  */
1963   for (k = subnode->next; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY;
1964        k = k->next)
1965     {
1966       if (k->pkt->pkttype == PKT_SIGNATURE)
1967         {
1968           sig = k->pkt->pkt.signature;
1969           if (sig->keyid[0] == mainkid[0] && sig->keyid[1] == mainkid[1])
1970             {
1971               if (check_key_signature (keyblock, k, NULL))
1972                 ; /* Signature did not verify.  */
1973               else if (IS_SUBKEY_REV (sig))
1974                 {
1975                   /* Note that this means that the date on a
1976                      revocation sig does not matter - even if the
1977                      binding sig is dated after the revocation sig,
1978                      the subkey is still marked as revoked.  This
1979                      seems ok, as it is just as easy to make new
1980                      subkeys rather than re-sign old ones as the
1981                      problem is in the distribution.  Plus, PGP (7)
1982                      does this the same way.  */
1983                   subpk->flags.revoked = 1;
1984                   sig_to_revoke_info (sig, &subpk->revoked);
1985                   /* Although we could stop now, we continue to
1986                    * figure out other information like the old expiration
1987                    * time.  */
1988                 }
1989               else if (IS_SUBKEY_SIG (sig) && sig->timestamp >= sigdate)
1990                 {
1991                   if (sig->flags.expired)
1992                     ; /* Signature has expired - ignore it.  */
1993                   else
1994                     {
1995                       sigdate = sig->timestamp;
1996                       signode = k;
1997                       signode->pkt->pkt.signature->flags.chosen_selfsig = 0;
1998                     }
1999                 }
2000             }
2001         }
2002     }
2003
2004   /* No valid key binding.  */
2005   if (!signode)
2006     return;
2007
2008   sig = signode->pkt->pkt.signature;
2009   sig->flags.chosen_selfsig = 1; /* So we know which selfsig we chose later.  */
2010
2011   key_usage = parse_key_usage (sig);
2012   if (!key_usage)
2013     {
2014       /* No key flags at all: get it from the algo.  */
2015       key_usage = openpgp_pk_algo_usage (subpk->pubkey_algo);
2016     }
2017   else
2018     {
2019       /* Check that the usage matches the usage as given by the algo.  */
2020       int x = openpgp_pk_algo_usage (subpk->pubkey_algo);
2021       if (x) /* Mask it down to the actual allowed usage.  */
2022         key_usage &= x;
2023     }
2024
2025   subpk->pubkey_usage = key_usage;
2026
2027   p = parse_sig_subpkt (sig->hashed, SIGSUBPKT_KEY_EXPIRE, NULL);
2028   if (p && buffer_to_u32 (p))
2029     key_expire = keytimestamp + buffer_to_u32 (p);
2030   else
2031     key_expire = 0;
2032   subpk->has_expired = key_expire >= curtime ? 0 : key_expire;
2033   subpk->expiredate = key_expire;
2034
2035   /* Algo doesn't exist.  */
2036   if (openpgp_pk_test_algo (subpk->pubkey_algo))
2037     return;
2038
2039   subpk->flags.valid = 1;
2040
2041   /* Find the most recent 0x19 embedded signature on our self-sig. */
2042   if (!subpk->flags.backsig)
2043     {
2044       int seq = 0;
2045       size_t n;
2046       PKT_signature *backsig = NULL;
2047
2048       sigdate = 0;
2049
2050       /* We do this while() since there may be other embedded
2051          signatures in the future.  We only want 0x19 here. */
2052
2053       while ((p = enum_sig_subpkt (sig->hashed,
2054                                    SIGSUBPKT_SIGNATURE, &n, &seq, NULL)))
2055         if (n > 3
2056             && ((p[0] == 3 && p[2] == 0x19) || (p[0] == 4 && p[1] == 0x19)))
2057           {
2058             PKT_signature *tempsig = buf_to_sig (p, n);
2059             if (tempsig)
2060               {
2061                 if (tempsig->timestamp > sigdate)
2062                   {
2063                     if (backsig)
2064                       free_seckey_enc (backsig);
2065
2066                     backsig = tempsig;
2067                     sigdate = backsig->timestamp;
2068                   }
2069                 else
2070                   free_seckey_enc (tempsig);
2071               }
2072           }
2073
2074       seq = 0;
2075
2076       /* It is safe to have this in the unhashed area since the 0x19
2077          is located on the selfsig for convenience, not security. */
2078
2079       while ((p = enum_sig_subpkt (sig->unhashed, SIGSUBPKT_SIGNATURE,
2080                                    &n, &seq, NULL)))
2081         if (n > 3
2082             && ((p[0] == 3 && p[2] == 0x19) || (p[0] == 4 && p[1] == 0x19)))
2083           {
2084             PKT_signature *tempsig = buf_to_sig (p, n);
2085             if (tempsig)
2086               {
2087                 if (tempsig->timestamp > sigdate)
2088                   {
2089                     if (backsig)
2090                       free_seckey_enc (backsig);
2091
2092                     backsig = tempsig;
2093                     sigdate = backsig->timestamp;
2094                   }
2095                 else
2096                   free_seckey_enc (tempsig);
2097               }
2098           }
2099
2100       if (backsig)
2101         {
2102           /* At ths point, backsig contains the most recent 0x19 sig.
2103              Let's see if it is good. */
2104
2105           /* 2==valid, 1==invalid, 0==didn't check */
2106           if (check_backsig (mainpk, subpk, backsig) == 0)
2107             subpk->flags.backsig = 2;
2108           else
2109             subpk->flags.backsig = 1;
2110
2111           free_seckey_enc (backsig);
2112         }
2113     }
2114 }
2115
2116
2117 /*
2118  * Merge information from the self-signatures with the key, so that
2119  * we can later use them more easy.
2120  * The function works by first applying the self signatures to the
2121  * primary key and the to each subkey.
2122  * Here are the rules we use to decide which inormation from which
2123  * self-signature is used:
2124  * We check all self signatures or validity and ignore all invalid signatures.
2125  * All signatures are then ordered by their creation date ....
2126  * For the primary key:
2127  *   FIXME the docs
2128  */
2129 static void
2130 merge_selfsigs (KBNODE keyblock)
2131 {
2132   KBNODE k;
2133   int revoked;
2134   struct revoke_info rinfo;
2135   PKT_public_key *main_pk;
2136   prefitem_t *prefs;
2137   unsigned int mdc_feature;
2138
2139   if (keyblock->pkt->pkttype != PKT_PUBLIC_KEY)
2140     {
2141       if (keyblock->pkt->pkttype == PKT_SECRET_KEY)
2142         {
2143           log_error ("expected public key but found secret key "
2144                      "- must stop\n");
2145           /* We better exit here because a public key is expected at
2146              other places too.  FIXME: Figure this out earlier and
2147              don't get to here at all */
2148           g10_exit (1);
2149         }
2150       BUG ();
2151     }
2152
2153   merge_selfsigs_main (keyblock, &revoked, &rinfo);
2154
2155   /* Now merge in the data from each of the subkeys.  */
2156   for (k = keyblock; k; k = k->next)
2157     {
2158       if (k->pkt->pkttype == PKT_PUBLIC_SUBKEY)
2159         {
2160           merge_selfsigs_subkey (keyblock, k);
2161         }
2162     }
2163
2164   main_pk = keyblock->pkt->pkt.public_key;
2165   if (revoked || main_pk->has_expired || !main_pk->flags.valid)
2166     {
2167       /* If the primary key is revoked, expired, or invalid we
2168        * better set the appropriate flags on that key and all
2169        * subkeys.  */
2170       for (k = keyblock; k; k = k->next)
2171         {
2172           if (k->pkt->pkttype == PKT_PUBLIC_KEY
2173               || k->pkt->pkttype == PKT_PUBLIC_SUBKEY)
2174             {
2175               PKT_public_key *pk = k->pkt->pkt.public_key;
2176               if (!main_pk->flags.valid)
2177                 pk->flags.valid = 0;
2178               if (revoked && !pk->flags.revoked)
2179                 {
2180                   pk->flags.revoked = revoked;
2181                   memcpy (&pk->revoked, &rinfo, sizeof (rinfo));
2182                 }
2183               if (main_pk->has_expired)
2184                 pk->has_expired = main_pk->has_expired;
2185             }
2186         }
2187       return;
2188     }
2189
2190   /* Set the preference list of all keys to those of the primary real
2191    * user ID.  Note: we use these preferences when we don't know by
2192    * which user ID the key has been selected.
2193    * fixme: we should keep atoms of commonly used preferences or
2194    * use reference counting to optimize the preference lists storage.
2195    * FIXME: it might be better to use the intersection of
2196    * all preferences.
2197    * Do a similar thing for the MDC feature flag.  */
2198   prefs = NULL;
2199   mdc_feature = 0;
2200   for (k = keyblock; k && k->pkt->pkttype != PKT_PUBLIC_SUBKEY; k = k->next)
2201     {
2202       if (k->pkt->pkttype == PKT_USER_ID
2203           && !k->pkt->pkt.user_id->attrib_data
2204           && k->pkt->pkt.user_id->is_primary)
2205         {
2206           prefs = k->pkt->pkt.user_id->prefs;
2207           mdc_feature = k->pkt->pkt.user_id->flags.mdc;
2208           break;
2209         }
2210     }
2211   for (k = keyblock; k; k = k->next)
2212     {
2213       if (k->pkt->pkttype == PKT_PUBLIC_KEY
2214           || k->pkt->pkttype == PKT_PUBLIC_SUBKEY)
2215         {
2216           PKT_public_key *pk = k->pkt->pkt.public_key;
2217           if (pk->prefs)
2218             xfree (pk->prefs);
2219           pk->prefs = copy_prefs (prefs);
2220           pk->flags.mdc = mdc_feature;
2221         }
2222     }
2223 }
2224
2225
2226 \f
2227 /* See whether the key fits our requirements and in case we do not
2228  * request the primary key, select a suitable subkey.
2229  *
2230  * Returns: True when a suitable key has been found.
2231  *
2232  * We have to distinguish four cases:  FIXME!
2233  *  1. No usage and no primary key requested
2234  *     Examples for this case are that we have a keyID to be used
2235  *     for decrytion or verification.
2236  *  2. No usage but primary key requested
2237  *     This is the case for all functions which work on an
2238  *     entire keyblock, e.g. for editing or listing
2239  *  3. Usage and primary key requested
2240  *     FXME
2241  *  4. Usage but no primary key requested
2242  *     FIXME
2243  * FIXME: Tell what is going to happen here and something about the rationale
2244  * Note: We don't use this function if no specific usage is requested;
2245  *       This way the getkey functions can be used for plain key listings.
2246  *
2247  * CTX ist the keyblock we are investigating, if FOUNDK is not NULL this
2248  * is the key we actually found by looking at the keyid or a fingerprint and
2249  * may either point to the primary or one of the subkeys.  */
2250 static int
2251 finish_lookup (GETKEY_CTX ctx)
2252 {
2253   KBNODE keyblock = ctx->keyblock;
2254   KBNODE k;
2255   KBNODE foundk = NULL;
2256   PKT_user_id *foundu = NULL;
2257 #define USAGE_MASK  (PUBKEY_USAGE_SIG|PUBKEY_USAGE_ENC|PUBKEY_USAGE_CERT)
2258   unsigned int req_usage = (ctx->req_usage & USAGE_MASK);
2259   /* Request the primary if we're certifying another key, and also
2260      if signing data while --pgp6 or --pgp7 is on since pgp 6 and 7
2261      do not understand signatures made by a signing subkey.  PGP 8
2262      does. */
2263   int req_prim = (ctx->req_usage & PUBKEY_USAGE_CERT) ||
2264     ((PGP6 || PGP7) && (ctx->req_usage & PUBKEY_USAGE_SIG));
2265   u32 latest_date;
2266   KBNODE latest_key;
2267   u32 curtime = make_timestamp ();
2268
2269   assert (keyblock->pkt->pkttype == PKT_PUBLIC_KEY);
2270
2271   ctx->found_key = NULL;
2272
2273   if (ctx->exact)
2274     {
2275       for (k = keyblock; k; k = k->next)
2276         {
2277           if ((k->flag & 1))
2278             {
2279               assert (k->pkt->pkttype == PKT_PUBLIC_KEY
2280                       || k->pkt->pkttype == PKT_PUBLIC_SUBKEY);
2281               foundk = k;
2282               break;
2283             }
2284         }
2285     }
2286
2287   for (k = keyblock; k; k = k->next)
2288     {
2289       if ((k->flag & 2))
2290         {
2291           assert (k->pkt->pkttype == PKT_USER_ID);
2292           foundu = k->pkt->pkt.user_id;
2293           break;
2294         }
2295     }
2296
2297   if (DBG_CACHE)
2298     log_debug ("finish_lookup: checking key %08lX (%s)(req_usage=%x)\n",
2299                (ulong) keyid_from_pk (keyblock->pkt->pkt.public_key, NULL),
2300                foundk ? "one" : "all", req_usage);
2301
2302   if (!req_usage)
2303     {
2304       latest_key = foundk ? foundk : keyblock;
2305       goto found;
2306     }
2307
2308   latest_date = 0;
2309   latest_key = NULL;
2310   /* Do not look at subkeys if a certification key is requested.  */
2311   if ((!foundk || foundk->pkt->pkttype == PKT_PUBLIC_SUBKEY) && !req_prim)
2312     {
2313       KBNODE nextk;
2314       /* Either start a loop or check just this one subkey.  */
2315       for (k = foundk ? foundk : keyblock; k; k = nextk)
2316         {
2317           PKT_public_key *pk;
2318           nextk = k->next;
2319           if (k->pkt->pkttype != PKT_PUBLIC_SUBKEY)
2320             continue;
2321           if (foundk)
2322             nextk = NULL; /* what a hack */
2323           pk = k->pkt->pkt.public_key;
2324           if (DBG_CACHE)
2325             log_debug ("\tchecking subkey %08lX\n",
2326                        (ulong) keyid_from_pk (pk, NULL));
2327           if (!pk->flags.valid)
2328             {
2329               if (DBG_CACHE)
2330                 log_debug ("\tsubkey not valid\n");
2331               continue;
2332             }
2333           if (pk->flags.revoked)
2334             {
2335               if (DBG_CACHE)
2336                 log_debug ("\tsubkey has been revoked\n");
2337               continue;
2338             }
2339           if (pk->has_expired)
2340             {
2341               if (DBG_CACHE)
2342                 log_debug ("\tsubkey has expired\n");
2343               continue;
2344             }
2345           if (pk->timestamp > curtime && !opt.ignore_valid_from)
2346             {
2347               if (DBG_CACHE)
2348                 log_debug ("\tsubkey not yet valid\n");
2349               continue;
2350             }
2351
2352           if (!((pk->pubkey_usage & USAGE_MASK) & req_usage))
2353             {
2354               if (DBG_CACHE)
2355                 log_debug ("\tusage does not match: want=%x have=%x\n",
2356                            req_usage, pk->pubkey_usage);
2357               continue;
2358             }
2359
2360           if (DBG_CACHE)
2361             log_debug ("\tsubkey might be fine\n");
2362           /* In case a key has a timestamp of 0 set, we make sure
2363              that it is used.  A better change would be to compare
2364              ">=" but that might also change the selected keys and
2365              is as such a more intrusive change.  */
2366           if (pk->timestamp > latest_date || (!pk->timestamp && !latest_date))
2367             {
2368               latest_date = pk->timestamp;
2369               latest_key = k;
2370             }
2371         }
2372     }
2373
2374   /* Okay now try the primary key unless we want an exact
2375    * key ID match on a subkey */
2376   if ((!latest_key && !(ctx->exact && foundk != keyblock)) || req_prim)
2377     {
2378       PKT_public_key *pk;
2379       if (DBG_CACHE && !foundk && !req_prim)
2380         log_debug ("\tno suitable subkeys found - trying primary\n");
2381       pk = keyblock->pkt->pkt.public_key;
2382       if (!pk->flags.valid)
2383         {
2384           if (DBG_CACHE)
2385             log_debug ("\tprimary key not valid\n");
2386         }
2387       else if (pk->flags.revoked)
2388         {
2389           if (DBG_CACHE)
2390             log_debug ("\tprimary key has been revoked\n");
2391         }
2392       else if (pk->has_expired)
2393         {
2394           if (DBG_CACHE)
2395             log_debug ("\tprimary key has expired\n");
2396         }
2397       else if (!((pk->pubkey_usage & USAGE_MASK) & req_usage))
2398         {
2399           if (DBG_CACHE)
2400             log_debug ("\tprimary key usage does not match: "
2401                        "want=%x have=%x\n", req_usage, pk->pubkey_usage);
2402         }
2403       else /* Okay.  */
2404         {
2405           if (DBG_CACHE)
2406             log_debug ("\tprimary key may be used\n");
2407           latest_key = keyblock;
2408           latest_date = pk->timestamp;
2409         }
2410     }
2411
2412   if (!latest_key)
2413     {
2414       if (DBG_CACHE)
2415         log_debug ("\tno suitable key found -  giving up\n");
2416       return 0; /* Not found.  */
2417     }
2418
2419 found:
2420   if (DBG_CACHE)
2421     log_debug ("\tusing key %08lX\n",
2422                (ulong) keyid_from_pk (latest_key->pkt->pkt.public_key, NULL));
2423
2424   if (latest_key)
2425     {
2426       PKT_public_key *pk = latest_key->pkt->pkt.public_key;
2427       if (pk->user_id)
2428         free_user_id (pk->user_id);
2429       pk->user_id = scopy_user_id (foundu);
2430     }
2431
2432   ctx->found_key = latest_key;
2433
2434   if (latest_key != keyblock && opt.verbose)
2435     {
2436       char *tempkeystr =
2437         xstrdup (keystr_from_pk (latest_key->pkt->pkt.public_key));
2438       log_info (_("using subkey %s instead of primary key %s\n"),
2439                 tempkeystr, keystr_from_pk (keyblock->pkt->pkt.public_key));
2440       xfree (tempkeystr);
2441     }
2442
2443   cache_user_id (keyblock);
2444
2445   return 1; /* Found.  */
2446 }
2447
2448
2449 /* The main function to lookup a key.  On success the found keyblock
2450    is stored at RET_KEYBLOCK and also in CTX.  If WANT_SECRET is true
2451    a corresponding secret key is required.  */
2452 static int
2453 lookup (getkey_ctx_t ctx, kbnode_t *ret_keyblock, int want_secret)
2454 {
2455   int rc;
2456   int no_suitable_key = 0;
2457
2458   rc = 0;
2459   while (!(rc = keydb_search (ctx->kr_handle, ctx->items, ctx->nitems)))
2460     {
2461       /* If we are searching for the first key we have to make sure
2462          that the next iteration does not do an implicit reset.
2463          This can be triggered by an empty key ring. */
2464       if (ctx->nitems && ctx->items->mode == KEYDB_SEARCH_MODE_FIRST)
2465         ctx->items->mode = KEYDB_SEARCH_MODE_NEXT;
2466
2467       rc = keydb_get_keyblock (ctx->kr_handle, &ctx->keyblock);
2468       if (rc)
2469         {
2470           log_error ("keydb_get_keyblock failed: %s\n", g10_errstr (rc));
2471           rc = 0;
2472           goto skip;
2473         }
2474
2475       if (want_secret && agent_probe_any_secret_key (NULL, ctx->keyblock))
2476         goto skip; /* No secret key available.  */
2477
2478       /* Warning: node flag bits 0 and 1 should be preserved by
2479        * merge_selfsigs.  For secret keys, premerge did tranfer the
2480        * keys to the keyblock.  */
2481       merge_selfsigs (ctx->keyblock);
2482       if (finish_lookup (ctx))
2483         {
2484           no_suitable_key = 0;
2485           goto found;
2486         }
2487       else
2488         no_suitable_key = 1;
2489
2490     skip:
2491       /* Release resources and continue search. */
2492       release_kbnode (ctx->keyblock);
2493       ctx->keyblock = NULL;
2494     }
2495
2496 found:
2497   if (rc && gpg_err_code (rc) != GPG_ERR_NOT_FOUND)
2498     log_error ("keydb_search failed: %s\n", g10_errstr (rc));
2499
2500   if (!rc)
2501     {
2502       *ret_keyblock = ctx->keyblock; /* Return the keyblock.  */
2503       ctx->keyblock = NULL;
2504     }
2505   else if (gpg_err_code (rc) == GPG_ERR_NOT_FOUND && no_suitable_key)
2506     rc = want_secret? G10ERR_UNU_SECKEY : G10ERR_UNU_PUBKEY;
2507   else if (gpg_err_code (rc) == GPG_ERR_NOT_FOUND)
2508     rc = want_secret? G10ERR_NO_SECKEY : G10ERR_NO_PUBKEY;
2509
2510   release_kbnode (ctx->keyblock);
2511   ctx->keyblock = NULL;
2512
2513   ctx->last_rc = rc;
2514   return rc;
2515 }
2516
2517
2518
2519
2520 /*
2521  * Enumerate certain secret keys.  Caller must use these procedure:
2522  *  1) create a void pointer and initialize it to NULL
2523  *  2) pass this void pointer by reference to this function
2524  *     and provide space for the secret key (pass a buffer for sk)
2525  *  3) call this function as long as it does not return an error.
2526  *     The error code GPG_ERR_EOF indicates the end of the listing.
2527  *  4) Always call this function a last time with SK set to NULL,
2528  *     so that can free it's context.
2529  */
2530 gpg_error_t
2531 enum_secret_keys (void **context, PKT_public_key *sk)
2532 {
2533   gpg_error_t err = 0;
2534   const char *name;
2535   struct
2536   {
2537     int eof;
2538     int state;
2539     strlist_t sl;
2540     kbnode_t keyblock;
2541     kbnode_t node;
2542   } *c = *context;
2543
2544   if (!c)
2545     {
2546       /* Make a new context.  */
2547       c = xtrycalloc (1, sizeof *c);
2548       if (!c)
2549         return gpg_error_from_syserror ();
2550       *context = c;
2551     }
2552
2553   if (!sk)
2554     {
2555       /* Free the context.  */
2556       release_kbnode (c->keyblock);
2557       xfree (c);
2558       *context = NULL;
2559       return 0;
2560     }
2561
2562   if (c->eof)
2563     return gpg_error (GPG_ERR_EOF);
2564
2565   for (;;)
2566     {
2567       /* Loop until we have a keyblock.  */
2568       while (!c->keyblock)
2569         {
2570           /* Loop over the list of secret keys.  */
2571           do
2572             {
2573               name = NULL;
2574               switch (c->state)
2575                 {
2576                 case 0: /* First try to use the --default-key.  */
2577                   if (opt.def_secret_key && *opt.def_secret_key)
2578                     name = opt.def_secret_key;
2579                   c->state = 1;
2580                   break;
2581
2582                 case 1: /* Init list of keys to try.  */
2583                   c->sl = opt.secret_keys_to_try;
2584                   c->state++;
2585                   break;
2586
2587                 case 2: /* Get next item from list.  */
2588                   if (c->sl)
2589                     {
2590                       name = c->sl->d;
2591                       c->sl = c->sl->next;
2592                     }
2593                   else
2594                     c->state++;
2595                   break;
2596
2597                 default: /* No more names to check - stop.  */
2598                   c->eof = 1;
2599                   return gpg_error (GPG_ERR_EOF);
2600                 }
2601             }
2602           while (!name || !*name);
2603
2604           err = getkey_byname (NULL, NULL, name, 1, &c->keyblock);
2605           if (err)
2606             {
2607               /* getkey_byname might return a keyblock even in the
2608                  error case - I have not checked.  Thus better release
2609                  it.  */
2610               release_kbnode (c->keyblock);
2611               c->keyblock = NULL;
2612             }
2613           else
2614             c->node = c->keyblock;
2615         }
2616
2617       /* Get the next key from the current keyblock.  */
2618       for (; c->node; c->node = c->node->next)
2619         {
2620           if (c->node->pkt->pkttype == PKT_PUBLIC_KEY
2621               || c->node->pkt->pkttype == PKT_PUBLIC_SUBKEY)
2622             {
2623               copy_public_key (sk, c->node->pkt->pkt.public_key);
2624               c->node = c->node->next;
2625               return 0; /* Found.  */
2626             }
2627         }
2628
2629       /* Dispose the keyblock and continue.  */
2630       release_kbnode (c->keyblock);
2631       c->keyblock = NULL;
2632     }
2633 }
2634
2635 \f
2636 /*********************************************
2637  ***********  User ID printing helpers *******
2638  *********************************************/
2639
2640 /* Return a string with a printable representation of the user_id.
2641  * this string must be freed by xfree.   */
2642 char *
2643 get_user_id_string (u32 * keyid)
2644 {
2645   user_id_db_t r;
2646   char *p;
2647   int pass = 0;
2648   /* Try it two times; second pass reads from key resources.  */
2649   do
2650     {
2651       for (r = user_id_db; r; r = r->next)
2652         {
2653           keyid_list_t a;
2654           for (a = r->keyids; a; a = a->next)
2655             {
2656               if (a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1])
2657                 {
2658                   p = xmalloc (keystrlen () + 1 + r->len + 1);
2659                   sprintf (p, "%s %.*s", keystr (keyid), r->len, r->name);
2660                   return p;
2661                 }
2662             }
2663         }
2664     }
2665   while (++pass < 2 && !get_pubkey (NULL, keyid));
2666   p = xmalloc (keystrlen () + 5);
2667   sprintf (p, "%s [?]", keystr (keyid));
2668   return p;
2669 }
2670
2671
2672 char *
2673 get_user_id_string_native (u32 * keyid)
2674 {
2675   char *p = get_user_id_string (keyid);
2676   char *p2 = utf8_to_native (p, strlen (p), 0);
2677   xfree (p);
2678   return p2;
2679 }
2680
2681
2682 char *
2683 get_long_user_id_string (u32 * keyid)
2684 {
2685   user_id_db_t r;
2686   char *p;
2687   int pass = 0;
2688   /* Try it two times; second pass reads from key resources.  */
2689   do
2690     {
2691       for (r = user_id_db; r; r = r->next)
2692         {
2693           keyid_list_t a;
2694           for (a = r->keyids; a; a = a->next)
2695             {
2696               if (a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1])
2697                 {
2698                   p = xmalloc (r->len + 20);
2699                   sprintf (p, "%08lX%08lX %.*s",
2700                            (ulong) keyid[0], (ulong) keyid[1],
2701                            r->len, r->name);
2702                   return p;
2703                 }
2704             }
2705         }
2706     }
2707   while (++pass < 2 && !get_pubkey (NULL, keyid));
2708   p = xmalloc (25);
2709   sprintf (p, "%08lX%08lX [?]", (ulong) keyid[0], (ulong) keyid[1]);
2710   return p;
2711 }
2712
2713 char *
2714 get_user_id (u32 * keyid, size_t * rn)
2715 {
2716   user_id_db_t r;
2717   char *p;
2718   int pass = 0;
2719
2720   /* Try it two times; second pass reads from key resources.  */
2721   do
2722     {
2723       for (r = user_id_db; r; r = r->next)
2724         {
2725           keyid_list_t a;
2726           for (a = r->keyids; a; a = a->next)
2727             {
2728               if (a->keyid[0] == keyid[0] && a->keyid[1] == keyid[1])
2729                 {
2730                   p = xmalloc (r->len);
2731                   memcpy (p, r->name, r->len);
2732                   *rn = r->len;
2733                   return p;
2734                 }
2735             }
2736         }
2737     }
2738   while (++pass < 2 && !get_pubkey (NULL, keyid));
2739   p = xstrdup (user_id_not_found_utf8 ());
2740   *rn = strlen (p);
2741   return p;
2742 }
2743
2744 char *
2745 get_user_id_native (u32 * keyid)
2746 {
2747   size_t rn;
2748   char *p = get_user_id (keyid, &rn);
2749   char *p2 = utf8_to_native (p, rn, 0);
2750   xfree (p);
2751   return p2;
2752 }
2753
2754 KEYDB_HANDLE
2755 get_ctx_handle (GETKEY_CTX ctx)
2756 {
2757   return ctx->kr_handle;
2758 }
2759
2760 static void
2761 free_akl (struct akl *akl)
2762 {
2763   if (akl->spec)
2764     free_keyserver_spec (akl->spec);
2765
2766   xfree (akl);
2767 }
2768
2769 void
2770 release_akl (void)
2771 {
2772   while (opt.auto_key_locate)
2773     {
2774       struct akl *akl2 = opt.auto_key_locate;
2775       opt.auto_key_locate = opt.auto_key_locate->next;
2776       free_akl (akl2);
2777     }
2778 }
2779
2780 /* Returns false on error. */
2781 int
2782 parse_auto_key_locate (char *options)
2783 {
2784   char *tok;
2785
2786   while ((tok = optsep (&options)))
2787     {
2788       struct akl *akl, *check, *last = NULL;
2789       int dupe = 0;
2790
2791       if (tok[0] == '\0')
2792         continue;
2793
2794       akl = xmalloc_clear (sizeof (*akl));
2795
2796       if (ascii_strcasecmp (tok, "nodefault") == 0)
2797         akl->type = AKL_NODEFAULT;
2798       else if (ascii_strcasecmp (tok, "local") == 0)
2799         akl->type = AKL_LOCAL;
2800       else if (ascii_strcasecmp (tok, "ldap") == 0)
2801         akl->type = AKL_LDAP;
2802       else if (ascii_strcasecmp (tok, "keyserver") == 0)
2803         akl->type = AKL_KEYSERVER;
2804 #ifdef USE_DNS_CERT
2805       else if (ascii_strcasecmp (tok, "cert") == 0)
2806         akl->type = AKL_CERT;
2807 #endif
2808 #ifdef USE_DNS_PKA
2809       else if (ascii_strcasecmp (tok, "pka") == 0)
2810         akl->type = AKL_PKA;
2811 #endif
2812       else if ((akl->spec = parse_keyserver_uri (tok, 1, NULL, 0)))
2813         akl->type = AKL_SPEC;
2814       else
2815         {
2816           free_akl (akl);
2817           return 0;
2818         }
2819
2820       /* We must maintain the order the user gave us */
2821       for (check = opt.auto_key_locate; check;
2822            last = check, check = check->next)
2823         {
2824           /* Check for duplicates */
2825           if (check->type == akl->type
2826               && (akl->type != AKL_SPEC
2827                   || (akl->type == AKL_SPEC
2828                       && strcmp (check->spec->uri, akl->spec->uri) == 0)))
2829             {
2830               dupe = 1;
2831               free_akl (akl);
2832               break;
2833             }
2834         }
2835
2836       if (!dupe)
2837         {
2838           if (last)
2839             last->next = akl;
2840           else
2841             opt.auto_key_locate = akl;
2842         }
2843     }
2844
2845   return 1;
2846 }
2847
2848
2849 /* Return true if a secret key or secret subkey is available for one
2850    of the public keys in KEYBLOCK.  */
2851 int
2852 have_any_secret_key (ctrl_t ctrl, kbnode_t keyblock)
2853 {
2854   kbnode_t node;
2855
2856   for (node = keyblock; node; node = node->next)
2857     if ((node->pkt->pkttype == PKT_PUBLIC_KEY
2858          || node->pkt->pkttype == PKT_PUBLIC_SUBKEY)
2859         && !agent_probe_secret_key (ctrl, node->pkt->pkt.public_key))
2860       return 1;
2861   return 0;
2862 }
2863
2864
2865 /* Return true if a secret key is available for the public key with
2866  * the given KEYID.  This is just a fast check and does not tell us
2867  * whether the secret key is valid.  It merely tells os whether there
2868  * is some secret key.  */
2869 int
2870 have_secret_key_with_kid (u32 *keyid)
2871 {
2872   gpg_error_t err;
2873   KEYDB_HANDLE kdbhd;
2874   KEYDB_SEARCH_DESC desc;
2875   kbnode_t keyblock;
2876   kbnode_t node;
2877   int result = 0;
2878
2879   kdbhd = keydb_new ();
2880   memset (&desc, 0, sizeof desc);
2881   desc.mode = KEYDB_SEARCH_MODE_LONG_KID;
2882   desc.u.kid[0] = keyid[0];
2883   desc.u.kid[1] = keyid[1];
2884   while (!result && !(err = keydb_search (kdbhd, &desc, 1)))
2885     {
2886       desc.mode = KEYDB_SEARCH_MODE_NEXT;
2887       err = keydb_get_keyblock (kdbhd, &keyblock);
2888       if (err)
2889         {
2890           log_error (_("error reading keyblock: %s\n"), g10_errstr (err));
2891           break;
2892         }
2893
2894       for (node = keyblock; node; node = node->next)
2895         {
2896           /* Bit 0 of the flags is set if the search found the key
2897              using that key or subkey.  */
2898           if ((node->flag & 1))
2899             {
2900               assert (node->pkt->pkttype == PKT_PUBLIC_KEY
2901                       || node->pkt->pkttype == PKT_PUBLIC_SUBKEY);
2902
2903               if (!agent_probe_secret_key (NULL, node->pkt->pkt.public_key))
2904                 {
2905                   result = 1;
2906                   break;
2907                 }
2908             }
2909         }
2910       release_kbnode (keyblock);
2911     }
2912   keydb_release (kdbhd);
2913   return result;
2914 }
2915
2916
2917
2918 #if 0
2919 /*
2920  * Merge the secret keys from secblock into the pubblock thereby
2921  * replacing the public (sub)keys with their secret counterparts Hmmm:
2922  * It might be better to get away from the concept of entire secret
2923  * keys at all and have a way to store just the real secret parts
2924  * from the key.
2925  *
2926  * FIXME: this is not anymore needed but we keep it as example code for the
2927  * new code we need to write for the import/export feature.
2928  */
2929 static void
2930 merge_public_with_secret (KBNODE pubblock, KBNODE secblock)
2931 {
2932   KBNODE pub;
2933
2934   assert (pubblock->pkt->pkttype == PKT_PUBLIC_KEY);
2935   assert (secblock->pkt->pkttype == PKT_SECRET_KEY);
2936
2937   for (pub = pubblock; pub; pub = pub->next)
2938     {
2939       if (pub->pkt->pkttype == PKT_PUBLIC_KEY)
2940         {
2941           PKT_public_key *pk = pub->pkt->pkt.public_key;
2942           PKT_secret_key *sk = secblock->pkt->pkt.secret_key;
2943           assert (pub == pubblock); /* Only in the first node.  */
2944           /* There is nothing to compare in this case, so just replace
2945            * some information.  */
2946           copy_public_parts_to_secret_key (pk, sk);
2947           free_public_key (pk);
2948           pub->pkt->pkttype = PKT_SECRET_KEY;
2949           pub->pkt->pkt.secret_key = copy_secret_key (NULL, sk);
2950         }
2951       else if (pub->pkt->pkttype == PKT_PUBLIC_SUBKEY)
2952         {
2953           KBNODE sec;
2954           PKT_public_key *pk = pub->pkt->pkt.public_key;
2955
2956           /* This is more complicated: It may happen that the sequence
2957            * of the subkeys dosn't match, so we have to find the
2958            * appropriate secret key.  */
2959           for (sec = secblock->next; sec; sec = sec->next)
2960             {
2961               if (sec->pkt->pkttype == PKT_SECRET_SUBKEY)
2962                 {
2963                   PKT_secret_key *sk = sec->pkt->pkt.secret_key;
2964                   if (!cmp_public_secret_key (pk, sk))
2965                     {
2966                       copy_public_parts_to_secret_key (pk, sk);
2967                       free_public_key (pk);
2968                       pub->pkt->pkttype = PKT_SECRET_SUBKEY;
2969                       pub->pkt->pkt.secret_key = copy_secret_key (NULL, sk);
2970                       break;
2971                     }
2972                 }
2973             }
2974           if (!sec)
2975             BUG (); /* Already checked in premerge.  */
2976         }
2977     }
2978 }
2979
2980
2981 /* This function checks that for every public subkey a corresponding
2982  * secret subkey is available and deletes the public subkey otherwise.
2983  * We need this function because we can't delete it later when we
2984  * actually merge the secret parts into the pubring.
2985  * The function also plays some games with the node flags.
2986  *
2987  * FIXME: this is not anymore needed but we keep it as example code for the
2988  * new code we need to write for the import/export feature.
2989  */
2990 static void
2991 premerge_public_with_secret (KBNODE pubblock, KBNODE secblock)
2992 {
2993   KBNODE last, pub;
2994
2995   assert (pubblock->pkt->pkttype == PKT_PUBLIC_KEY);
2996   assert (secblock->pkt->pkttype == PKT_SECRET_KEY);
2997
2998   for (pub = pubblock, last = NULL; pub; last = pub, pub = pub->next)
2999     {
3000       pub->flag &= ~3; /* Reset bits 0 and 1.  */
3001       if (pub->pkt->pkttype == PKT_PUBLIC_SUBKEY)
3002         {
3003           KBNODE sec;
3004           PKT_public_key *pk = pub->pkt->pkt.public_key;
3005
3006           for (sec = secblock->next; sec; sec = sec->next)
3007             {
3008               if (sec->pkt->pkttype == PKT_SECRET_SUBKEY)
3009                 {
3010                   PKT_secret_key *sk = sec->pkt->pkt.secret_key;
3011                   if (!cmp_public_secret_key (pk, sk))
3012                     {
3013                       if (sk->protect.s2k.mode == 1001)
3014                         {
3015                           /* The secret parts are not available so
3016                              we can't use that key for signing etc.
3017                              Fix the pubkey usage */
3018                           pk->pubkey_usage &= ~(PUBKEY_USAGE_SIG
3019                                                 | PUBKEY_USAGE_AUTH);
3020                         }
3021                       /* Transfer flag bits 0 and 1 to the pubblock.  */
3022                       pub->flag |= (sec->flag & 3);
3023                       break;
3024                     }
3025                 }
3026             }
3027           if (!sec)
3028             {
3029               KBNODE next, ll;
3030
3031               if (opt.verbose)
3032                 log_info (_("no secret subkey"
3033                             " for public subkey %s - ignoring\n"),
3034                           keystr_from_pk (pk));
3035               /* We have to remove the subkey in this case.  */
3036               assert (last);
3037               /* Find the next subkey.  */
3038               for (next = pub->next, ll = pub;
3039                    next && next->pkt->pkttype != PKT_PUBLIC_SUBKEY;
3040                    ll = next, next = next->next)
3041                 ;
3042               /* Make new link.  */
3043               last->next = next;
3044               /* Release this public subkey with all sigs.  */
3045               ll->next = NULL;
3046               release_kbnode (pub);
3047               /* Let the loop continue.  */
3048               pub = last;
3049             }
3050         }
3051     }
3052   /* We need to copy the found bits (0 and 1) from the secret key to
3053      the public key.  This has already been done for the subkeys but
3054      got lost on the primary key - fix it here.  */
3055   pubblock->flag |= (secblock->flag & 3);
3056 }
3057 #endif /*0*/