Print warnings if old daemon versions are used.
[gnupg.git] / g10 / call-dirmngr.c
1 /* call-dirmngr.c - GPG operations to the Dirmngr.
2  * Copyright (C) 2011 Free Software Foundation, Inc.
3  * Copyright (C) 2015  g10 Code GmbH
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 <errno.h>
26 #include <unistd.h>
27 #include <time.h>
28 #include <assert.h>
29 #ifdef HAVE_LOCALE_H
30 # include <locale.h>
31 #endif
32
33 #include "gpg.h"
34 #include <assuan.h>
35 #include "util.h"
36 #include "membuf.h"
37 #include "options.h"
38 #include "i18n.h"
39 #include "asshelp.h"
40 #include "keyserver.h"
41 #include "status.h"
42 #include "call-dirmngr.h"
43
44
45 /* Parameter structure used to gather status info.  */
46 struct ks_status_parm_s
47 {
48   const char *keyword; /* Look for this keyword or NULL for "SOURCE". */
49   char *source;
50 };
51
52
53 /* Parameter structure used with the KS_SEARCH command.  */
54 struct ks_search_parm_s
55 {
56   gpg_error_t lasterr;  /* Last error code.  */
57   membuf_t saveddata;   /* Buffer to build complete lines.  */
58   char *helpbuf;        /* NULL or malloced buffer.  */
59   size_t helpbufsize;   /* Allocated size of HELPBUF.  */
60   gpg_error_t (*data_cb)(void*, int, char*);  /* Callback.  */
61   void *data_cb_value;  /* First argument for DATA_CB.  */
62   struct ks_status_parm_s *stparm; /* Link to the status parameter.  */
63 };
64
65
66 /* Parameter structure used with the KS_GET command.  */
67 struct ks_get_parm_s
68 {
69   estream_t memfp;
70 };
71
72
73 /* Parameter structure used with the KS_PUT command.  */
74 struct ks_put_parm_s
75 {
76   assuan_context_t ctx;
77   kbnode_t keyblock;  /* The optional keyblock.  */
78   const void *data;   /* The key in OpenPGP binary format.  */
79   size_t datalen;     /* The length of DATA.  */
80 };
81
82
83 /* Parameter structure used with the DNS_CERT command.  */
84 struct dns_cert_parm_s
85 {
86   estream_t memfp;
87   unsigned char *fpr;
88   size_t fprlen;
89   char *url;
90 };
91
92
93 /* Data used to associate an session with dirmngr contexts.  We can't
94    use a simple one to one mapping because we sometimes need two
95    connections to the dirmngr; for example while doing a listing and
96    being in a data callback we may want to retrieve a key.  The local
97    dirmngr data takes care of this.  At the end of the session the
98    function dirmngr_deinit_session_data is called by gpg.c to cleanup
99    these resources.  Note that gpg.h defines a typedef dirmngr_local_t
100    for this structure. */
101 struct dirmngr_local_s
102 {
103   /* Link to other contexts which are used simultaneously.  */
104   struct dirmngr_local_s *next;
105
106   /* The active Assuan context. */
107   assuan_context_t ctx;
108
109   /* Flag set when the keyserver names have been send.  */
110   int set_keyservers_done;
111
112   /* Flag set to true while an operation is running on CTX.  */
113   int is_active;
114 };
115
116
117 \f
118 /* Deinitialize all session data of dirmngr pertaining to CTRL.  */
119 void
120 gpg_dirmngr_deinit_session_data (ctrl_t ctrl)
121 {
122   dirmngr_local_t dml;
123
124   while ((dml = ctrl->dirmngr_local))
125     {
126       ctrl->dirmngr_local = dml->next;
127       if (dml->is_active)
128         log_error ("oops: trying to cleanup an active dirmngr context\n");
129       else
130         assuan_release (dml->ctx);
131       xfree (dml);
132     }
133 }
134
135
136 /* Print a warning if the server's version number is less than our
137    version number.  Returns an error code on a connection problem.  */
138 static gpg_error_t
139 warn_version_mismatch (assuan_context_t ctx, const char *servername)
140 {
141   gpg_error_t err;
142   char *serverversion;
143   const char *myversion = strusage (13);
144
145   err = get_assuan_server_version (ctx, 0, &serverversion);
146   if (err)
147     log_error (_("error getting version from '%s': %s\n"),
148                servername, gpg_strerror (err));
149   else if (!compare_version_strings (serverversion, myversion))
150     {
151       char *warn;
152
153       warn = xtryasprintf (_("server '%s' is older than us (%s < %s)"),
154                            servername, serverversion, myversion);
155       if (!warn)
156         err = gpg_error_from_syserror ();
157       else
158         {
159           log_info (_("WARNING: %s\n"), warn);
160           write_status_strings (STATUS_WARNING, "server_version_mismatch 0",
161                                 " ", warn, NULL);
162           xfree (warn);
163         }
164     }
165   xfree (serverversion);
166   return err;
167 }
168
169
170 /* Try to connect to the Dirmngr via a socket or spawn it if possible.
171    Handle the server's initial greeting and set global options.  */
172 static gpg_error_t
173 create_context (ctrl_t ctrl, assuan_context_t *r_ctx)
174 {
175   gpg_error_t err;
176   assuan_context_t ctx;
177
178   *r_ctx = NULL;
179   err = start_new_dirmngr (&ctx,
180                            GPG_ERR_SOURCE_DEFAULT,
181                            opt.homedir,
182                            opt.dirmngr_program,
183                            opt.autostart, opt.verbose, DBG_IPC,
184                            NULL /*gpg_status2*/, ctrl);
185   if (!opt.autostart && gpg_err_code (err) == GPG_ERR_NO_DIRMNGR)
186     {
187       static int shown;
188
189       if (!shown)
190         {
191           shown = 1;
192           log_info (_("no dirmngr running in this session\n"));
193         }
194     }
195   else if (!err && !(err = warn_version_mismatch (ctx, DIRMNGR_NAME)))
196     {
197       char *line;
198
199       /* Tell the dirmngr that we want to collect audit event. */
200       /* err = assuan_transact (agent_ctx, "OPTION audit-events=1", */
201       /*                        NULL, NULL, NULL, NULL, NULL, NULL); */
202       if (opt.keyserver_options.http_proxy)
203         {
204           line = xtryasprintf ("OPTION http-proxy=%s",
205                                opt.keyserver_options.http_proxy);
206           if (!line)
207             err = gpg_error_from_syserror ();
208           else
209             {
210               err = assuan_transact (ctx, line, NULL, NULL, NULL,
211                                      NULL, NULL, NULL);
212               xfree (line);
213             }
214         }
215
216       if (err)
217         ;
218       else if ((opt.keyserver_options.options & KEYSERVER_HONOR_KEYSERVER_URL))
219         {
220           /* Tell the dirmngr that this possibly privacy invading
221              option is in use.  If Dirmngr is running in Tor mode, it
222              will return an error.  */
223           err = assuan_transact (ctx, "OPTION honor-keyserver-url-used",
224                                  NULL, NULL, NULL, NULL, NULL, NULL);
225           if (gpg_err_code (err) == GPG_ERR_FORBIDDEN)
226             log_error (_("keyserver option \"honor-keyserver-url\""
227                          " may not be used in Tor mode\n"));
228           else if (gpg_err_code (err) == GPG_ERR_UNKNOWN_OPTION)
229             err = 0; /* Old dirmngr versions do not support this option.  */
230         }
231     }
232
233   if (err)
234     assuan_release (ctx);
235   else
236     {
237       /* audit_log_ok (ctrl->audit, AUDIT_DIRMNGR_READY, err); */
238       *r_ctx = ctx;
239     }
240
241   return err;
242 }
243
244
245 /* Get a context for accessing dirmngr.  If no context is available a
246    new one is created and - if required - dirmngr started.  On success
247    an assuan context is stored at R_CTX.  This context may only be
248    released by means of close_context.  Note that NULL is stored at
249    R_CTX on error.  */
250 static gpg_error_t
251 open_context (ctrl_t ctrl, assuan_context_t *r_ctx)
252 {
253   gpg_error_t err;
254   dirmngr_local_t dml;
255
256   *r_ctx = NULL;
257   for (;;)
258     {
259       for (dml = ctrl->dirmngr_local; dml && dml->is_active; dml = dml->next)
260         ;
261       if (dml)
262         {
263           /* Found an inactive local session - return that.  */
264           assert (!dml->is_active);
265
266           /* But first do the per session init if not yet done.  */
267           if (!dml->set_keyservers_done)
268             {
269               keyserver_spec_t ksi;
270
271               /* Set all configured keyservers.  We clear existing
272                  keyservers so that any keyserver configured in GPG
273                  overrides keyservers possibly still configured in Dirmngr
274                  for the session (Note that the keyserver list of a
275                  session in Dirmngr survives a RESET. */
276               for (ksi = opt.keyserver; ksi; ksi = ksi->next)
277                 {
278                   char *line;
279
280                   line = xtryasprintf
281                     ("KEYSERVER%s %s",
282                      ksi == opt.keyserver? " --clear":"", ksi->uri);
283                   if (!line)
284                     err = gpg_error_from_syserror ();
285                   else
286                     {
287                       err = assuan_transact (dml->ctx, line, NULL, NULL, NULL,
288                                              NULL, NULL, NULL);
289                       xfree (line);
290                     }
291
292                   if (err)
293                     return err;
294                 }
295
296               dml->set_keyservers_done = 1;
297             }
298
299           dml->is_active = 1;
300
301           *r_ctx = dml->ctx;
302           return 0;
303         }
304
305       dml = xtrycalloc (1, sizeof *dml);
306       if (!dml)
307         return gpg_error_from_syserror ();
308       err = create_context (ctrl, &dml->ctx);
309       if (err)
310         {
311           xfree (dml);
312           return err;
313         }
314
315       /* To be on the nPth thread safe site we need to add it to a
316          list; this is far easier than to have a lock for this
317          function.  It should not happen anyway but the code is free
318          because we need it for the is_active check above.  */
319       dml->next = ctrl->dirmngr_local;
320       ctrl->dirmngr_local = dml;
321     }
322 }
323
324
325 /* Close the assuan context CTX or return it to a pool of unused
326    contexts.  If CTX is NULL, the function does nothing.  */
327 static void
328 close_context (ctrl_t ctrl, assuan_context_t ctx)
329 {
330   dirmngr_local_t dml;
331
332   if (!ctx)
333     return;
334
335   for (dml = ctrl->dirmngr_local; dml; dml = dml->next)
336     {
337       if (dml->ctx == ctx)
338         {
339           if (!dml->is_active)
340             log_fatal ("closing inactive dirmngr context %p\n", ctx);
341           dml->is_active = 0;
342           return;
343         }
344     }
345   log_fatal ("closing unknown dirmngr ctx %p\n", ctx);
346 }
347
348
349 /* Clear the set_keyservers_done flag on context CTX.  */
350 static void
351 clear_context_flags (ctrl_t ctrl, assuan_context_t ctx)
352 {
353   dirmngr_local_t dml;
354
355   if (!ctx)
356     return;
357
358   for (dml = ctrl->dirmngr_local; dml; dml = dml->next)
359     {
360       if (dml->ctx == ctx)
361         {
362           if (!dml->is_active)
363             log_fatal ("clear_context_flags on inactive dirmngr ctx %p\n", ctx);
364           dml->set_keyservers_done = 0;
365           return;
366         }
367     }
368   log_fatal ("clear_context_flags on unknown dirmngr ctx %p\n", ctx);
369 }
370
371
372 \f
373 /* Status callback for ks_list, ks_get and ks_search.  */
374 static gpg_error_t
375 ks_status_cb (void *opaque, const char *line)
376 {
377   struct ks_status_parm_s *parm = opaque;
378   gpg_error_t err = 0;
379   const char *s;
380
381   if ((s = has_leading_keyword (line, parm->keyword? parm->keyword : "SOURCE")))
382     {
383       if (!parm->source)
384         {
385           parm->source = xtrystrdup (s);
386           if (!parm->source)
387             err = gpg_error_from_syserror ();
388         }
389     }
390
391   return err;
392 }
393
394
395 \f
396 /* Run the "KEYSERVER" command to return the name of the used
397    keyserver at R_KEYSERVER.  */
398 gpg_error_t
399 gpg_dirmngr_ks_list (ctrl_t ctrl, char **r_keyserver)
400 {
401   gpg_error_t err;
402   assuan_context_t ctx;
403   struct ks_status_parm_s stparm;
404
405   memset (&stparm, 0, sizeof stparm);
406   stparm.keyword = "KEYSERVER";
407   *r_keyserver = NULL;
408
409   err = open_context (ctrl, &ctx);
410   if (err)
411     return err;
412
413   err = assuan_transact (ctx, "KEYSERVER", NULL, NULL,
414                          NULL, NULL, ks_status_cb, &stparm);
415   if (err)
416     goto leave;
417   if (!stparm.source)
418     {
419       err = gpg_error (GPG_ERR_NO_KEYSERVER);
420       goto leave;
421     }
422
423   *r_keyserver = stparm.source;
424   stparm.source = NULL;
425
426  leave:
427   xfree (stparm.source);
428   close_context (ctrl, ctx);
429   return err;
430 }
431
432
433 \f
434 /* Data callback for the KS_SEARCH command. */
435 static gpg_error_t
436 ks_search_data_cb (void *opaque, const void *data, size_t datalen)
437 {
438   gpg_error_t err = 0;
439   struct ks_search_parm_s *parm = opaque;
440   const char *line, *s;
441   size_t rawlen, linelen;
442   char fixedbuf[256];
443
444   if (parm->lasterr)
445     return 0;
446
447   if (parm->stparm->source)
448     {
449       err = parm->data_cb (parm->data_cb_value, 1, parm->stparm->source);
450       if (err)
451         {
452           parm->lasterr = err;
453           return err;
454         }
455       /* Clear it so that we won't get back here unless the server
456          accidentally sends a second source status line.  Note that
457          will not see all accidentally sent source lines because it
458          depends on whether data lines have been send in between.  */
459       xfree (parm->stparm->source);
460       parm->stparm->source = NULL;
461     }
462
463   if (!data)
464     return 0;  /* Ignore END commands.  */
465
466   put_membuf (&parm->saveddata, data, datalen);
467
468  again:
469   line = peek_membuf (&parm->saveddata, &rawlen);
470   if (!line)
471     {
472       parm->lasterr = gpg_error_from_syserror ();
473       return parm->lasterr; /* Tell the server about our problem.  */
474     }
475   if ((s = memchr (line, '\n', rawlen)))
476     {
477       linelen = s - line;  /* That is the length excluding the LF.  */
478       if (linelen + 1 < sizeof fixedbuf)
479         {
480           /* We can use the static buffer.  */
481           memcpy (fixedbuf, line, linelen);
482           fixedbuf[linelen] = 0;
483           if (linelen && fixedbuf[linelen-1] == '\r')
484             fixedbuf[linelen-1] = 0;
485           err = parm->data_cb (parm->data_cb_value, 0, fixedbuf);
486         }
487       else
488         {
489           if (linelen + 1 >= parm->helpbufsize)
490             {
491               xfree (parm->helpbuf);
492               parm->helpbufsize = linelen + 1 + 1024;
493               parm->helpbuf = xtrymalloc (parm->helpbufsize);
494               if (!parm->helpbuf)
495                 {
496                   parm->lasterr = gpg_error_from_syserror ();
497                   return parm->lasterr;
498                 }
499             }
500           memcpy (parm->helpbuf, line, linelen);
501           parm->helpbuf[linelen] = 0;
502           if (linelen && parm->helpbuf[linelen-1] == '\r')
503             parm->helpbuf[linelen-1] = 0;
504           err = parm->data_cb (parm->data_cb_value, 0, parm->helpbuf);
505         }
506       if (err)
507         parm->lasterr = err;
508       else
509         {
510           clear_membuf (&parm->saveddata, linelen+1);
511           goto again;  /* There might be another complete line.  */
512         }
513     }
514
515   return err;
516 }
517
518
519 /* Run the KS_SEARCH command using the search string SEARCHSTR.  All
520    data lines are passed to the CB function.  That function is called
521    with CB_VALUE as its first argument, a 0 as second argument, and
522    the decoded data line as third argument.  The callback function may
523    modify the data line and it is guaranteed that this data line is a
524    complete line with a terminating 0 character but without the
525    linefeed.  NULL is passed to the callback to indicate EOF.  */
526 gpg_error_t
527 gpg_dirmngr_ks_search (ctrl_t ctrl, const char *searchstr,
528                        gpg_error_t (*cb)(void*, int, char *), void *cb_value)
529 {
530   gpg_error_t err;
531   assuan_context_t ctx;
532   struct ks_status_parm_s stparm;
533   struct ks_search_parm_s parm;
534   char line[ASSUAN_LINELENGTH];
535
536   err = open_context (ctrl, &ctx);
537   if (err)
538     return err;
539
540   {
541     char *escsearchstr = percent_plus_escape (searchstr);
542     if (!escsearchstr)
543       {
544         err = gpg_error_from_syserror ();
545         close_context (ctrl, ctx);
546         return err;
547       }
548     snprintf (line, sizeof line, "KS_SEARCH -- %s", escsearchstr);
549     xfree (escsearchstr);
550   }
551
552   memset (&stparm, 0, sizeof stparm);
553   memset (&parm, 0, sizeof parm);
554   init_membuf (&parm.saveddata, 1024);
555   parm.data_cb = cb;
556   parm.data_cb_value = cb_value;
557   parm.stparm = &stparm;
558
559   err = assuan_transact (ctx, line, ks_search_data_cb, &parm,
560                         NULL, NULL, ks_status_cb, &stparm);
561   if (!err)
562     err = cb (cb_value, 0, NULL);  /* Send EOF.  */
563
564   xfree (get_membuf (&parm.saveddata, NULL));
565   xfree (parm.helpbuf);
566   xfree (stparm.source);
567
568   close_context (ctrl, ctx);
569   return err;
570 }
571
572
573 \f
574 /* Data callback for the KS_GET and KS_FETCH commands. */
575 static gpg_error_t
576 ks_get_data_cb (void *opaque, const void *data, size_t datalen)
577 {
578   gpg_error_t err = 0;
579   struct ks_get_parm_s *parm = opaque;
580   size_t nwritten;
581
582   if (!data)
583     return 0;  /* Ignore END commands.  */
584
585   if (es_write (parm->memfp, data, datalen, &nwritten))
586     err = gpg_error_from_syserror ();
587
588   return err;
589 }
590
591
592 /* Run the KS_GET command using the patterns in the array PATTERN.  On
593    success an estream object is returned to retrieve the keys.  On
594    error an error code is returned and NULL stored at R_FP.
595
596    The pattern may only use search specification which a keyserver can
597    use to retrieve keys.  Because we know the format of the pattern we
598    don't need to escape the patterns before sending them to the
599    server.
600
601    If R_SOURCE is not NULL the source of the data is stored as a
602    malloced string there.  If a source is not known NULL is stored.
603
604    If there are too many patterns the function returns an error.  That
605    could be fixed by issuing several search commands or by
606    implementing a different interface.  However with long keyids we
607    are able to ask for (1000-10-1)/(2+8+1) = 90 keys at once.  */
608 gpg_error_t
609 gpg_dirmngr_ks_get (ctrl_t ctrl, char **pattern,
610                     keyserver_spec_t override_keyserver,
611                     estream_t *r_fp, char **r_source)
612 {
613   gpg_error_t err;
614   assuan_context_t ctx;
615   struct ks_status_parm_s stparm;
616   struct ks_get_parm_s parm;
617   char *line = NULL;
618   size_t linelen;
619   membuf_t mb;
620   int idx;
621
622   memset (&stparm, 0, sizeof stparm);
623   memset (&parm, 0, sizeof parm);
624
625   *r_fp = NULL;
626   if (r_source)
627     *r_source = NULL;
628
629   err = open_context (ctrl, &ctx);
630   if (err)
631     return err;
632
633   /* If we have an override keyserver we first indicate that the next
634      user of the context needs to again setup the global keyservers and
635      them we send the override keyserver.  */
636   if (override_keyserver)
637     {
638       clear_context_flags (ctrl, ctx);
639       line = xtryasprintf ("KEYSERVER --clear %s", override_keyserver->uri);
640       if (!line)
641         {
642           err = gpg_error_from_syserror ();
643           goto leave;
644         }
645       err = assuan_transact (ctx, line, NULL, NULL, NULL,
646                              NULL, NULL, NULL);
647       if (err)
648         goto leave;
649
650       xfree (line);
651       line = NULL;
652     }
653
654   /* Lump all patterns into one string.  */
655   init_membuf (&mb, 1024);
656   put_membuf_str (&mb, "KS_GET --");
657   for (idx=0; pattern[idx]; idx++)
658     {
659       put_membuf (&mb, " ", 1); /* Append Delimiter.  */
660       put_membuf_str (&mb, pattern[idx]);
661     }
662   put_membuf (&mb, "", 1); /* Append Nul.  */
663   line = get_membuf (&mb, &linelen);
664   if (!line)
665     {
666       err = gpg_error_from_syserror ();
667       goto leave;
668     }
669   if (linelen + 2 >= ASSUAN_LINELENGTH)
670     {
671       err = gpg_error (GPG_ERR_TOO_MANY);
672       goto leave;
673     }
674
675   parm.memfp = es_fopenmem (0, "rwb");
676   if (!parm.memfp)
677     {
678       err = gpg_error_from_syserror ();
679       goto leave;
680     }
681   err = assuan_transact (ctx, line, ks_get_data_cb, &parm,
682                          NULL, NULL, ks_status_cb, &stparm);
683   if (err)
684     goto leave;
685
686   es_rewind (parm.memfp);
687   *r_fp = parm.memfp;
688   parm.memfp = NULL;
689
690   if (r_source)
691     {
692       *r_source = stparm.source;
693       stparm.source = NULL;
694     }
695
696  leave:
697   es_fclose (parm.memfp);
698   xfree (stparm.source);
699   xfree (line);
700   close_context (ctrl, ctx);
701   return err;
702 }
703
704
705 /* Run the KS_FETCH and pass URL as argument.  On success an estream
706    object is returned to retrieve the keys.  On error an error code is
707    returned and NULL stored at R_FP.
708
709    The url is expected to point to a small set of keys; in many cases
710    only to one key.  However, schemes like finger may return several
711    keys.  Note that the configured keyservers are ignored by the
712    KS_FETCH command.  */
713 gpg_error_t
714 gpg_dirmngr_ks_fetch (ctrl_t ctrl, const char *url, estream_t *r_fp)
715 {
716   gpg_error_t err;
717   assuan_context_t ctx;
718   struct ks_get_parm_s parm;
719   char *line = NULL;
720
721   memset (&parm, 0, sizeof parm);
722
723   *r_fp = NULL;
724
725   err = open_context (ctrl, &ctx);
726   if (err)
727     return err;
728
729   line = strconcat ("KS_FETCH -- ", url, NULL);
730   if (!line)
731     {
732       err = gpg_error_from_syserror ();
733       goto leave;
734     }
735   if (strlen (line) + 2 >= ASSUAN_LINELENGTH)
736     {
737       err = gpg_error (GPG_ERR_TOO_LARGE);
738       goto leave;
739     }
740
741   parm.memfp = es_fopenmem (0, "rwb");
742   if (!parm.memfp)
743     {
744       err = gpg_error_from_syserror ();
745       goto leave;
746     }
747   err = assuan_transact (ctx, line, ks_get_data_cb, &parm,
748                          NULL, NULL, NULL, NULL);
749   if (err)
750     goto leave;
751
752   es_rewind (parm.memfp);
753   *r_fp = parm.memfp;
754   parm.memfp = NULL;
755
756  leave:
757   es_fclose (parm.memfp);
758   xfree (line);
759   close_context (ctrl, ctx);
760   return err;
761 }
762
763
764 \f
765 static void
766 record_output (estream_t output,
767                pkttype_t type,
768                const char *validity,
769                /* The public key length or -1.  */
770                int pub_key_length,
771                /* The public key algo or -1.  */
772                int pub_key_algo,
773                /* 2 ulongs or NULL.  */
774                const u32 *keyid,
775                /* The creation / expiration date or 0.  */
776                u32 creation_date,
777                u32 expiration_date,
778                const char *userid)
779 {
780   const char *type_str = NULL;
781   char *pub_key_length_str = NULL;
782   char *pub_key_algo_str = NULL;
783   char *keyid_str = NULL;
784   char *creation_date_str = NULL;
785   char *expiration_date_str = NULL;
786   char *userid_escaped = NULL;
787
788   switch (type)
789     {
790     case PKT_PUBLIC_KEY:
791       type_str = "pub";
792       break;
793     case PKT_PUBLIC_SUBKEY:
794       type_str = "sub";
795       break;
796     case PKT_USER_ID:
797       type_str = "uid";
798       break;
799     case PKT_SIGNATURE:
800       type_str = "sig";
801       break;
802     default:
803       assert (! "Unhandled type.");
804     }
805
806   if (pub_key_length > 0)
807     pub_key_length_str = xasprintf ("%d", pub_key_length);
808
809   if (pub_key_algo != -1)
810     pub_key_algo_str = xasprintf ("%d", pub_key_algo);
811
812   if (keyid)
813     keyid_str = xasprintf ("%08lX%08lX", (ulong) keyid[0], (ulong) keyid[1]);
814
815   if (creation_date)
816     creation_date_str = xstrdup (colon_strtime (creation_date));
817
818   if (expiration_date)
819     expiration_date_str = xstrdup (colon_strtime (expiration_date));
820
821   /* Quote ':', '%', and any 8-bit characters.  */
822   if (userid)
823     {
824       int r;
825       int w = 0;
826
827       int len = strlen (userid);
828       /* A 100k character limit on the uid should be way more than
829          enough.  */
830       if (len > 100 * 1024)
831         len = 100 * 1024;
832
833       /* The minimum amount of space that we need.  */
834       userid_escaped = xmalloc (len * 3 + 1);
835
836       for (r = 0; r < len; r++)
837         {
838           if (userid[r] == ':' || userid[r]== '%' || (userid[r] & 0x80))
839             {
840               sprintf (&userid_escaped[w], "%%%02X", (byte) userid[r]);
841               w += 3;
842             }
843           else
844             userid_escaped[w ++] = userid[r];
845         }
846       userid_escaped[w] = '\0';
847     }
848
849   es_fprintf (output, "%s:%s:%s:%s:%s:%s:%s:%s:%s:%s:%s:%s:%s:%s:%s:%s:%s\n",
850               type_str,
851               validity ?: "",
852               pub_key_length_str ?: "",
853               pub_key_algo_str ?: "",
854               keyid_str ?: "",
855               creation_date_str ?: "",
856               expiration_date_str ?: "",
857               "" /* Certificate S/N */,
858               "" /* Ownertrust.  */,
859               userid_escaped ?: "",
860               "" /* Signature class.  */,
861               "" /* Key capabilities.  */,
862               "" /* Issuer certificate fingerprint.  */,
863               "" /* Flag field.  */,
864               "" /* S/N of a token.  */,
865               "" /* Hash algo.  */,
866               "" /* Curve name.  */);
867
868   xfree (userid_escaped);
869   xfree (expiration_date_str);
870   xfree (creation_date_str);
871   xfree (keyid_str);
872   xfree (pub_key_algo_str);
873   xfree (pub_key_length_str);
874 }
875
876 /* Handle the KS_PUT inquiries. */
877 static gpg_error_t
878 ks_put_inq_cb (void *opaque, const char *line)
879 {
880   struct ks_put_parm_s *parm = opaque;
881   gpg_error_t err = 0;
882
883   if (has_leading_keyword (line, "KEYBLOCK"))
884     {
885       if (parm->data)
886         err = assuan_send_data (parm->ctx, parm->data, parm->datalen);
887     }
888   else if (has_leading_keyword (line, "KEYBLOCK_INFO"))
889     {
890       kbnode_t node;
891       estream_t fp;
892
893       /* Parse the keyblock and send info lines back to the server.  */
894       fp = es_fopenmem (0, "rw,samethread");
895       if (!fp)
896         err = gpg_error_from_syserror ();
897
898       /* Note: the output format for the INFO block follows the colon
899          format as described in doc/DETAILS.  We don't actually reuse
900          the functionality from g10/keylist.c to produce the output,
901          because we don't need all of it and some of it is quite
902          expensive to generate.
903
904          The fields are (the starred fields are the ones we need):
905
906            * Field 1 - Type of record
907            * Field 2 - Validity
908            * Field 3 - Key length
909            * Field 4 - Public key algorithm
910            * Field 5 - KeyID
911            * Field 6 - Creation date
912            * Field 7 - Expiration date
913              Field 8 - Certificate S/N, UID hash, trust signature info
914              Field 9 -  Ownertrust
915            * Field 10 - User-ID
916              Field 11 - Signature class
917              Field 12 - Key capabilities
918              Field 13 - Issuer certificate fingerprint or other info
919              Field 14 - Flag field
920              Field 15 - S/N of a token
921              Field 16 - Hash algorithm
922              Field 17 - Curve name
923        */
924       for (node = parm->keyblock; !err && node; node=node->next)
925         {
926           switch (node->pkt->pkttype)
927             {
928             case PKT_PUBLIC_KEY:
929             case PKT_PUBLIC_SUBKEY:
930               {
931                 PKT_public_key *pk = node->pkt->pkt.public_key;
932
933                 char validity[3];
934                 int i;
935
936                 i = 0;
937                 if (pk->flags.revoked)
938                   validity[i ++] = 'r';
939                 if (pk->has_expired)
940                   validity[i ++] = 'e';
941                 validity[i] = '\0';
942
943                 keyid_from_pk (pk, NULL);
944
945                 record_output (fp, node->pkt->pkttype, validity,
946                                nbits_from_pk (pk), pk->pubkey_algo,
947                                pk->keyid, pk->timestamp, pk->expiredate,
948                                NULL);
949               }
950               break;
951
952             case PKT_USER_ID:
953               {
954                 PKT_user_id *uid = node->pkt->pkt.user_id;
955
956                 if (!uid->attrib_data)
957                   {
958                     char validity[3];
959                     int i;
960
961                     i = 0;
962                     if (uid->is_revoked)
963                       validity[i ++] = 'r';
964                     if (uid->is_expired)
965                       validity[i ++] = 'e';
966                     validity[i] = '\0';
967
968                     record_output (fp, node->pkt->pkttype, validity,
969                                    -1, -1, NULL,
970                                    uid->created, uid->expiredate,
971                                    uid->name);
972                   }
973               }
974               break;
975
976               /* This bit is really for the benefit of people who
977                  store their keys in LDAP servers.  It makes it easy
978                  to do queries for things like "all keys signed by
979                  Isabella".  */
980             case PKT_SIGNATURE:
981               {
982                 PKT_signature *sig = node->pkt->pkt.signature;
983
984                 if (IS_UID_SIG (sig))
985                   record_output (fp, node->pkt->pkttype, NULL,
986                                  -1, -1, sig->keyid,
987                                  sig->timestamp, sig->expiredate, NULL);
988               }
989               break;
990
991             default:
992               continue;
993             }
994           /* Given that the last operation was an es_fprintf we should
995              get the correct ERRNO if ferror indicates an error.  */
996           if (es_ferror (fp))
997             err = gpg_error_from_syserror ();
998         }
999
1000       /* Without an error and if we have an keyblock at all, send the
1001          data back.  */
1002       if (!err && parm->keyblock)
1003         {
1004           int rc;
1005           char buffer[512];
1006           size_t nread;
1007
1008           es_rewind (fp);
1009           while (!(rc=es_read (fp, buffer, sizeof buffer, &nread)) && nread)
1010             {
1011               err = assuan_send_data (parm->ctx, buffer, nread);
1012               if (err)
1013                 break;
1014             }
1015           if (!err && rc)
1016             err = gpg_error_from_syserror ();
1017         }
1018       es_fclose (fp);
1019     }
1020   else
1021     return gpg_error (GPG_ERR_ASS_UNKNOWN_INQUIRE);
1022
1023   return err;
1024 }
1025
1026
1027 /* Send a key to the configured server.  {DATA,DATLEN} contains the
1028    key in OpenPGP binary transport format.  If KEYBLOCK is not NULL it
1029    has the internal representaion of that key; this is for example
1030    used to convey meta data to LDAP keyservers.  */
1031 gpg_error_t
1032 gpg_dirmngr_ks_put (ctrl_t ctrl, void *data, size_t datalen, kbnode_t keyblock)
1033 {
1034   gpg_error_t err;
1035   assuan_context_t ctx;
1036   struct ks_put_parm_s parm;
1037
1038   memset (&parm, 0, sizeof parm);
1039
1040   /* We are going to parse the keyblock, thus we better make sure the
1041      all information is readily available.  */
1042   if (keyblock)
1043     merge_keys_and_selfsig (keyblock);
1044
1045   err = open_context (ctrl, &ctx);
1046   if (err)
1047     return err;
1048
1049   parm.ctx = ctx;
1050   parm.keyblock = keyblock;
1051   parm.data = data;
1052   parm.datalen = datalen;
1053
1054   err = assuan_transact (ctx, "KS_PUT", NULL, NULL,
1055                          ks_put_inq_cb, &parm, NULL, NULL);
1056
1057   close_context (ctrl, ctx);
1058   return err;
1059 }
1060
1061
1062 \f
1063 /* Data callback for the DNS_CERT command. */
1064 static gpg_error_t
1065 dns_cert_data_cb (void *opaque, const void *data, size_t datalen)
1066 {
1067   struct dns_cert_parm_s *parm = opaque;
1068   gpg_error_t err = 0;
1069   size_t nwritten;
1070
1071   if (!data)
1072     return 0;  /* Ignore END commands.  */
1073   if (!parm->memfp)
1074     return 0;  /* Data is not required.  */
1075
1076   if (es_write (parm->memfp, data, datalen, &nwritten))
1077     err = gpg_error_from_syserror ();
1078
1079   return err;
1080 }
1081
1082
1083 /* Status callback for the DNS_CERT command.  */
1084 static gpg_error_t
1085 dns_cert_status_cb (void *opaque, const char *line)
1086 {
1087   struct dns_cert_parm_s *parm = opaque;
1088   gpg_error_t err = 0;
1089   const char *s;
1090   size_t nbytes;
1091
1092   if ((s = has_leading_keyword (line, "FPR")))
1093     {
1094       char *buf;
1095
1096       if (!(buf = xtrystrdup (s)))
1097         err = gpg_error_from_syserror ();
1098       else if (parm->fpr)
1099         err = gpg_error (GPG_ERR_DUP_KEY);
1100       else if (!hex2str (buf, buf, strlen (buf)+1, &nbytes))
1101         err = gpg_error_from_syserror ();
1102       else if (nbytes < 20)
1103         err = gpg_error (GPG_ERR_TOO_SHORT);
1104       else
1105         {
1106           parm->fpr = xtrymalloc (nbytes);
1107           if (!parm->fpr)
1108             err = gpg_error_from_syserror ();
1109           else
1110             memcpy (parm->fpr, buf, (parm->fprlen = nbytes));
1111         }
1112       xfree (buf);
1113     }
1114   else if ((s = has_leading_keyword (line, "URL")) && *s)
1115     {
1116       if (parm->url)
1117         err = gpg_error (GPG_ERR_DUP_KEY);
1118       else if (!(parm->url = xtrystrdup (s)))
1119         err = gpg_error_from_syserror ();
1120     }
1121
1122   return err;
1123 }
1124
1125 /* Ask the dirmngr for a DNS CERT record.  Depending on the found
1126    subtypes different return values are set:
1127
1128    - For a PGP subtype a new estream with that key will be returned at
1129      R_KEY and the other return parameters are set to NULL/0.
1130
1131    - For an IPGP subtype the fingerprint is stored as a malloced block
1132      at (R_FPR,R_FPRLEN).  If an URL is available it is stored as a
1133      malloced string at R_URL; NULL is stored if there is no URL.
1134
1135    If CERTTYPE is DNS_CERTTYPE_ANY this function returns the first
1136    CERT record found with a supported type; it is expected that only
1137    one CERT record is used.  If CERTTYPE is one of the supported
1138    certtypes, only records with this certtype are considered and the
1139    first one found is returned.  All R_* args are optional.
1140
1141    If CERTTYPE is NULL the DANE method is used to fetch the key.
1142  */
1143 gpg_error_t
1144 gpg_dirmngr_dns_cert (ctrl_t ctrl, const char *name, const char *certtype,
1145                       estream_t *r_key,
1146                       unsigned char **r_fpr, size_t *r_fprlen,
1147                       char **r_url)
1148 {
1149   gpg_error_t err;
1150   assuan_context_t ctx;
1151   struct dns_cert_parm_s parm;
1152   char *line = NULL;
1153
1154   memset (&parm, 0, sizeof parm);
1155   if (r_key)
1156     *r_key = NULL;
1157   if (r_fpr)
1158     *r_fpr = NULL;
1159   if (r_fprlen)
1160     *r_fprlen = 0;
1161   if (r_url)
1162     *r_url = NULL;
1163
1164   err = open_context (ctrl, &ctx);
1165   if (err)
1166     return err;
1167
1168   line = es_bsprintf ("DNS_CERT %s %s", certtype? certtype : "--dane", name);
1169   if (!line)
1170     {
1171       err = gpg_error_from_syserror ();
1172       goto leave;
1173     }
1174   if (strlen (line) + 2 >= ASSUAN_LINELENGTH)
1175     {
1176       err = gpg_error (GPG_ERR_TOO_LARGE);
1177       goto leave;
1178     }
1179
1180   parm.memfp = es_fopenmem (0, "rwb");
1181   if (!parm.memfp)
1182     {
1183       err = gpg_error_from_syserror ();
1184       goto leave;
1185     }
1186   err = assuan_transact (ctx, line, dns_cert_data_cb, &parm,
1187                          NULL, NULL, dns_cert_status_cb, &parm);
1188   if (err)
1189     goto leave;
1190
1191   if (r_key)
1192     {
1193       es_rewind (parm.memfp);
1194       *r_key = parm.memfp;
1195       parm.memfp = NULL;
1196     }
1197
1198   if (r_fpr && parm.fpr)
1199     {
1200       *r_fpr = parm.fpr;
1201       parm.fpr = NULL;
1202     }
1203   if (r_fprlen)
1204     *r_fprlen = parm.fprlen;
1205
1206   if (r_url && parm.url)
1207     {
1208       *r_url = parm.url;
1209       parm.url = NULL;
1210     }
1211
1212  leave:
1213   xfree (parm.fpr);
1214   xfree (parm.url);
1215   es_fclose (parm.memfp);
1216   xfree (line);
1217   close_context (ctrl, ctx);
1218   return err;
1219 }
1220
1221
1222 /* Ask the dirmngr for PKA info.  On success the retrieved fingerprint
1223    is returned in a malloced buffer at R_FPR and its length is stored
1224    at R_FPRLEN.  If an URL is available it is stored as a malloced
1225    string at R_URL.  On error all return values are set to NULL/0.  */
1226 gpg_error_t
1227 gpg_dirmngr_get_pka (ctrl_t ctrl, const char *userid,
1228                      unsigned char **r_fpr, size_t *r_fprlen,
1229                      char **r_url)
1230 {
1231   gpg_error_t err;
1232   assuan_context_t ctx;
1233   struct dns_cert_parm_s parm;
1234   char *line = NULL;
1235
1236   memset (&parm, 0, sizeof parm);
1237   if (r_fpr)
1238     *r_fpr = NULL;
1239   if (r_fprlen)
1240     *r_fprlen = 0;
1241   if (r_url)
1242     *r_url = NULL;
1243
1244   err = open_context (ctrl, &ctx);
1245   if (err)
1246     return err;
1247
1248   line = es_bsprintf ("DNS_CERT --pka -- %s", userid);
1249   if (!line)
1250     {
1251       err = gpg_error_from_syserror ();
1252       goto leave;
1253     }
1254   if (strlen (line) + 2 >= ASSUAN_LINELENGTH)
1255     {
1256       err = gpg_error (GPG_ERR_TOO_LARGE);
1257       goto leave;
1258     }
1259
1260   err = assuan_transact (ctx, line, dns_cert_data_cb, &parm,
1261                          NULL, NULL, dns_cert_status_cb, &parm);
1262   if (err)
1263     goto leave;
1264
1265   if (r_fpr && parm.fpr)
1266     {
1267       *r_fpr = parm.fpr;
1268       parm.fpr = NULL;
1269     }
1270   if (r_fprlen)
1271     *r_fprlen = parm.fprlen;
1272
1273   if (r_url && parm.url)
1274     {
1275       *r_url = parm.url;
1276       parm.url = NULL;
1277     }
1278
1279  leave:
1280   xfree (parm.fpr);
1281   xfree (parm.url);
1282   xfree (line);
1283   close_context (ctrl, ctx);
1284   return err;
1285 }