gpg,sm: Implement keybox compression run and release lock in gpgsm
[gnupg.git] / common / asshelp.c
1 /* asshelp.c - Helper functions for Assuan
2  * Copyright (C) 2002, 2004, 2007, 2009, 2010 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * This file is free software; you can redistribute it and/or modify
7  * it under the terms of either
8  *
9  *   - the GNU Lesser General Public License as published by the Free
10  *     Software Foundation; either version 3 of the License, or (at
11  *     your option) any later version.
12  *
13  * or
14  *
15  *   - the GNU General Public License as published by the Free
16  *     Software Foundation; either version 2 of the License, or (at
17  *     your option) any later version.
18  *
19  * or both in parallel, as here.
20  *
21  * This file is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24  * GNU General Public License for more details.
25  *
26  * You should have received a copy of the GNU General Public License
27  * along with this program; if not, see <https://www.gnu.org/licenses/>.
28  */
29
30 #include <config.h>
31 #include <stdio.h>
32 #include <stdlib.h>
33 #include <string.h>
34 #include <unistd.h>
35 #include <errno.h>
36 #ifdef HAVE_LOCALE_H
37 #include <locale.h>
38 #endif
39
40 #include "i18n.h"
41 #include "util.h"
42 #include "exechelp.h"
43 #include "sysutils.h"
44 #include "status.h"
45 #include "membuf.h"
46 #include "asshelp.h"
47
48 /* The type we use for lock_agent_spawning.  */
49 #ifdef HAVE_W32_SYSTEM
50 # define lock_spawn_t HANDLE
51 #else
52 # define lock_spawn_t dotlock_t
53 #endif
54
55 /* The time we wait until the agent or the dirmngr are ready for
56    operation after we started them before giving up.  */
57 #ifdef HAVE_W32CE_SYSTEM
58 # define SECS_TO_WAIT_FOR_AGENT 30
59 # define SECS_TO_WAIT_FOR_DIRMNGR 30
60 #else
61 # define SECS_TO_WAIT_FOR_AGENT 5
62 # define SECS_TO_WAIT_FOR_DIRMNGR 5
63 #endif
64
65 /* A bitfield that specifies the assuan categories to log.  This is
66    identical to the default log handler of libassuan.  We need to do
67    it ourselves because we use a custom log handler and want to use
68    the same assuan variables to select the categories to log. */
69 static int log_cats;
70 #define TEST_LOG_CAT(x) (!! (log_cats & (1 << (x - 1))))
71
72 /* The assuan log monitor used to temporary inhibit log messages from
73  * assuan.  */
74 static int (*my_log_monitor) (assuan_context_t ctx,
75                               unsigned int cat,
76                               const char *msg);
77
78
79 static int
80 my_libassuan_log_handler (assuan_context_t ctx, void *hook,
81                           unsigned int cat, const char *msg)
82 {
83   unsigned int dbgval;
84
85   if (! TEST_LOG_CAT (cat))
86     return 0;
87
88   dbgval = hook? *(unsigned int*)hook : 0;
89   if (!(dbgval & 1024))
90     return 0; /* Assuan debugging is not enabled.  */
91
92   if (ctx && my_log_monitor && !my_log_monitor (ctx, cat, msg))
93     return 0; /* Temporary disabled.  */
94
95   if (msg)
96     log_string (GPGRT_LOGLVL_DEBUG, msg);
97
98   return 1;
99 }
100
101
102 /* Setup libassuan to use our own logging functions.  Should be used
103    early at startup.  */
104 void
105 setup_libassuan_logging (unsigned int *debug_var_address,
106                          int (*log_monitor)(assuan_context_t ctx,
107                                             unsigned int cat,
108                                             const char *msg))
109 {
110   char *flagstr;
111
112   flagstr = getenv ("ASSUAN_DEBUG");
113   if (flagstr)
114     log_cats = atoi (flagstr);
115   else /* Default to log the control channel.  */
116     log_cats = (1 << (ASSUAN_LOG_CONTROL - 1));
117   my_log_monitor = log_monitor;
118   assuan_set_log_cb (my_libassuan_log_handler, debug_var_address);
119 }
120
121
122 /* Change the Libassuan log categories to those given by NEWCATS.
123    NEWCATS is 0 the default category of ASSUAN_LOG_CONTROL is
124    selected.  Note, that setup_libassuan_logging overrides the values
125    given here.  */
126 void
127 set_libassuan_log_cats (unsigned int newcats)
128 {
129   if (newcats)
130     log_cats = newcats;
131   else /* Default to log the control channel.  */
132     log_cats = (1 << (ASSUAN_LOG_CONTROL - 1));
133 }
134
135
136
137 static gpg_error_t
138 send_one_option (assuan_context_t ctx, gpg_err_source_t errsource,
139                  const char *name, const char *value, int use_putenv)
140 {
141   gpg_error_t err;
142   char *optstr;
143
144   (void)errsource;
145
146   if (!value || !*value)
147     err = 0;  /* Avoid sending empty strings.  */
148   else if (asprintf (&optstr, "OPTION %s%s=%s",
149                      use_putenv? "putenv=":"", name, value) < 0)
150     err = gpg_error_from_syserror ();
151   else
152     {
153       err = assuan_transact (ctx, optstr, NULL, NULL, NULL, NULL, NULL, NULL);
154       xfree (optstr);
155     }
156
157   return err;
158 }
159
160
161 /* Send the assuan commands pertaining to the pinentry environment.  The
162    OPT_* arguments are optional and may be used to override the
163    defaults taken from the current locale. */
164 gpg_error_t
165 send_pinentry_environment (assuan_context_t ctx,
166                            gpg_err_source_t errsource,
167                            const char *opt_lc_ctype,
168                            const char *opt_lc_messages,
169                            session_env_t session_env)
170
171 {
172   gpg_error_t err = 0;
173 #if defined(HAVE_SETLOCALE)
174   char *old_lc = NULL;
175 #endif
176   char *dft_lc = NULL;
177   const char *dft_ttyname;
178   int iterator;
179   const char *name, *assname, *value;
180   int is_default;
181
182   iterator = 0;
183   while ((name = session_env_list_stdenvnames (&iterator, &assname)))
184     {
185       value = session_env_getenv_or_default (session_env, name, NULL);
186       if (!value)
187         continue;
188
189       if (assname)
190         err = send_one_option (ctx, errsource, assname, value, 0);
191       else
192         {
193           err = send_one_option (ctx, errsource, name, value, 1);
194           if (gpg_err_code (err) == GPG_ERR_UNKNOWN_OPTION)
195             err = 0;  /* Server too old; can't pass the new envvars.  */
196         }
197       if (err)
198         return err;
199     }
200
201
202   dft_ttyname = session_env_getenv_or_default (session_env, "GPG_TTY",
203                                                &is_default);
204   if (dft_ttyname && !is_default)
205     dft_ttyname = NULL;  /* We need the default value.  */
206
207   /* Send the value for LC_CTYPE.  */
208 #if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
209   old_lc = setlocale (LC_CTYPE, NULL);
210   if (old_lc)
211     {
212       old_lc = xtrystrdup (old_lc);
213       if (!old_lc)
214         return gpg_error_from_syserror ();
215     }
216   dft_lc = setlocale (LC_CTYPE, "");
217 #endif
218   if (opt_lc_ctype || (dft_ttyname && dft_lc))
219     {
220       err = send_one_option (ctx, errsource, "lc-ctype",
221                              opt_lc_ctype ? opt_lc_ctype : dft_lc, 0);
222     }
223 #if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
224   if (old_lc)
225     {
226       setlocale (LC_CTYPE, old_lc);
227       xfree (old_lc);
228     }
229 #endif
230   if (err)
231     return err;
232
233   /* Send the value for LC_MESSAGES.  */
234 #if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
235   old_lc = setlocale (LC_MESSAGES, NULL);
236   if (old_lc)
237     {
238       old_lc = xtrystrdup (old_lc);
239       if (!old_lc)
240         return gpg_error_from_syserror ();
241     }
242   dft_lc = setlocale (LC_MESSAGES, "");
243 #endif
244   if (opt_lc_messages || (dft_ttyname && dft_lc))
245     {
246       err = send_one_option (ctx, errsource, "lc-messages",
247                              opt_lc_messages ? opt_lc_messages : dft_lc, 0);
248     }
249 #if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
250   if (old_lc)
251     {
252       setlocale (LC_MESSAGES, old_lc);
253       xfree (old_lc);
254     }
255 #endif
256   if (err)
257     return err;
258
259   return 0;
260 }
261
262
263 /* Lock a spawning process.  The caller needs to provide the address
264    of a variable to store the lock information and the name or the
265    process.  */
266 static gpg_error_t
267 lock_spawning (lock_spawn_t *lock, const char *homedir, const char *name,
268                int verbose)
269 {
270   char *fname;
271   (void)verbose;
272
273   *lock = NULL;
274
275   fname = make_absfilename_try
276     (homedir,
277      !strcmp (name, "agent")?   "gnupg_spawn_agent_sentinel":
278      !strcmp (name, "dirmngr")? "gnupg_spawn_dirmngr_sentinel":
279      /*                    */   "gnupg_spawn_unknown_sentinel",
280      NULL);
281   if (!fname)
282     return gpg_error_from_syserror ();
283
284   *lock = dotlock_create (fname, 0);
285   xfree (fname);
286   if (!*lock)
287     return gpg_error_from_syserror ();
288
289   /* FIXME: We should use a timeout of 5000 here - however
290      make_dotlock does not yet support values other than -1 and 0.  */
291   if (dotlock_take (*lock, -1))
292     return gpg_error_from_syserror ();
293
294   return 0;
295 }
296
297
298 /* Unlock the spawning process.  */
299 static void
300 unlock_spawning (lock_spawn_t *lock, const char *name)
301 {
302   if (*lock)
303     {
304       (void)name;
305       dotlock_destroy (*lock);
306       *lock = NULL;
307     }
308 }
309
310
311 /* Helper for start_new_gpg_agent and start_new_dirmngr.
312  * Values for WHICH are:
313  *   0 - Start gpg-agent
314  *   1 - Start dirmngr
315  * SECS give the number of seconds to wait.  SOCKNAME is the name of
316  * the socket to connect.  VERBOSE is the usual verbose flag. CTX is
317  * the assuan context.  DID_SUCCESS_MSG will be set to 1 if a success
318  * messages has been printed.
319  */
320 static gpg_error_t
321 wait_for_sock (int secs, int which, const char *sockname,
322                int verbose, assuan_context_t ctx, int *did_success_msg)
323 {
324   gpg_error_t err = 0;
325   int target_us = secs * 1000000;
326   int elapsed_us = 0;
327   /*
328    * 977us * 1024 = just a little more than 1s.
329    * so we will double this timeout 10 times in the first
330    * second, and then switch over to 1s checkins.
331    */
332   int next_sleep_us = 977;
333   int lastalert = secs+1;
334   int secsleft;
335
336   while (elapsed_us < target_us)
337     {
338       if (verbose)
339         {
340           secsleft = (target_us - elapsed_us + 999999)/1000000;
341           /* log_clock ("left=%d last=%d targ=%d elap=%d next=%d\n", */
342           /*            secsleft, lastalert, target_us, elapsed_us, */
343           /*            next_sleep_us); */
344           if (secsleft < lastalert)
345             {
346               log_info (which == 1?
347                         _("waiting for the dirmngr to come up ... (%ds)\n"):
348                         _("waiting for the agent to come up ... (%ds)\n"),
349                         secsleft);
350               lastalert = secsleft;
351             }
352         }
353       gnupg_usleep (next_sleep_us);
354       elapsed_us += next_sleep_us;
355       err = assuan_socket_connect (ctx, sockname, 0, 0);
356       if (!err)
357         {
358           if (verbose)
359             {
360               log_info (which == 1?
361                         _("connection to the dirmngr established\n"):
362                         _("connection to the agent established\n"));
363               *did_success_msg = 1;
364             }
365           break;
366         }
367       next_sleep_us *= 2;
368       if (next_sleep_us > 1000000)
369         next_sleep_us = 1000000;
370     }
371   return err;
372 }
373
374
375 /* Try to connect to the agent via socket or start it if it is not
376    running and AUTOSTART is set.  Handle the server's initial
377    greeting.  Returns a new assuan context at R_CTX or an error
378    code. */
379 gpg_error_t
380 start_new_gpg_agent (assuan_context_t *r_ctx,
381                      gpg_err_source_t errsource,
382                      const char *agent_program,
383                      const char *opt_lc_ctype,
384                      const char *opt_lc_messages,
385                      session_env_t session_env,
386                      int autostart, int verbose, int debug,
387                      gpg_error_t (*status_cb)(ctrl_t, int, ...),
388                      ctrl_t status_cb_arg)
389 {
390   gpg_error_t err;
391   assuan_context_t ctx;
392   int did_success_msg = 0;
393   char *sockname;
394   const char *argv[6];
395
396   *r_ctx = NULL;
397
398   err = assuan_new (&ctx);
399   if (err)
400     {
401       log_error ("error allocating assuan context: %s\n", gpg_strerror (err));
402       return err;
403     }
404
405   sockname = make_filename_try (gnupg_socketdir (), GPG_AGENT_SOCK_NAME, NULL);
406   if (!sockname)
407     {
408       err = gpg_err_make (errsource, gpg_err_code_from_syserror ());
409       assuan_release (ctx);
410       return err;
411     }
412
413   err = assuan_socket_connect (ctx, sockname, 0, 0);
414   if (err && autostart)
415     {
416       char *abs_homedir;
417       lock_spawn_t lock;
418       char *program = NULL;
419       const char *program_arg = NULL;
420       char *p;
421       const char *s;
422       int i;
423
424       /* With no success start a new server.  */
425       if (!agent_program || !*agent_program)
426         agent_program = gnupg_module_name (GNUPG_MODULE_NAME_AGENT);
427       else if ((s=strchr (agent_program, '|')) && s[1] == '-' && s[2]=='-')
428         {
429           /* Hack to insert an additional option on the command line.  */
430           program = xtrystrdup (agent_program);
431           if (!program)
432             {
433               gpg_error_t tmperr = gpg_err_make (errsource,
434                                                  gpg_err_code_from_syserror ());
435               xfree (sockname);
436               assuan_release (ctx);
437               return tmperr;
438             }
439           p = strchr (program, '|');
440           *p++ = 0;
441           program_arg = p;
442         }
443
444       if (verbose)
445         log_info (_("no running gpg-agent - starting '%s'\n"),
446                   agent_program);
447
448       if (status_cb)
449         status_cb (status_cb_arg, STATUS_PROGRESS,
450                    "starting_agent ? 0 0", NULL);
451
452       /* We better pass an absolute home directory to the agent just
453          in case gpg-agent does not convert the passed name to an
454          absolute one (which it should do).  */
455       abs_homedir = make_absfilename_try (gnupg_homedir (), NULL);
456       if (!abs_homedir)
457         {
458           gpg_error_t tmperr = gpg_err_make (errsource,
459                                              gpg_err_code_from_syserror ());
460           log_error ("error building filename: %s\n",gpg_strerror (tmperr));
461           xfree (sockname);
462           assuan_release (ctx);
463           xfree (program);
464           return tmperr;
465         }
466
467       if (fflush (NULL))
468         {
469           gpg_error_t tmperr = gpg_err_make (errsource,
470                                              gpg_err_code_from_syserror ());
471           log_error ("error flushing pending output: %s\n",
472                      strerror (errno));
473           xfree (sockname);
474           assuan_release (ctx);
475           xfree (abs_homedir);
476           xfree (program);
477           return tmperr;
478         }
479
480       /* If the agent has been configured for use with a standard
481          socket, an environment variable is not required and thus
482          we can safely start the agent here.  */
483       i = 0;
484       argv[i++] = "--homedir";
485       argv[i++] = abs_homedir;
486       argv[i++] = "--use-standard-socket";
487       if (program_arg)
488         argv[i++] = program_arg;
489       argv[i++] = "--daemon";
490       argv[i++] = NULL;
491
492       if (!(err = lock_spawning (&lock, gnupg_homedir (), "agent", verbose))
493           && assuan_socket_connect (ctx, sockname, 0, 0))
494         {
495 #ifdef HAVE_W32_SYSTEM
496           err = gnupg_spawn_process_detached (program? program : agent_program,
497                                               argv, NULL);
498 #else
499           pid_t pid;
500
501           err = gnupg_spawn_process_fd (program? program : agent_program,
502                                         argv, -1, -1, -1, &pid);
503           if (!err)
504             err = gnupg_wait_process (program? program : agent_program,
505                                       pid, 1, NULL);
506 #endif
507           if (err)
508             log_error ("failed to start agent '%s': %s\n",
509                        agent_program, gpg_strerror (err));
510           else
511             err = wait_for_sock (SECS_TO_WAIT_FOR_AGENT, 0,
512                                  sockname, verbose, ctx, &did_success_msg);
513         }
514
515       unlock_spawning (&lock, "agent");
516       xfree (abs_homedir);
517       xfree (program);
518     }
519   xfree (sockname);
520   if (err)
521     {
522       if (autostart || gpg_err_code (err) != GPG_ERR_ASS_CONNECT_FAILED)
523         log_error ("can't connect to the agent: %s\n", gpg_strerror (err));
524       assuan_release (ctx);
525       return gpg_err_make (errsource, GPG_ERR_NO_AGENT);
526     }
527
528   if (debug && !did_success_msg)
529     log_debug ("connection to the agent established\n");
530
531   err = assuan_transact (ctx, "RESET",
532                          NULL, NULL, NULL, NULL, NULL, NULL);
533   if (!err)
534     {
535       err = send_pinentry_environment (ctx, errsource,
536                                        opt_lc_ctype, opt_lc_messages,
537                                        session_env);
538       if (gpg_err_code (err) == GPG_ERR_FORBIDDEN
539           && gpg_err_source (err) == GPG_ERR_SOURCE_GPGAGENT)
540         {
541           /* Check whether we are in restricted mode.  */
542           if (!assuan_transact (ctx, "GETINFO restricted",
543                                 NULL, NULL, NULL, NULL, NULL, NULL))
544             {
545               if (verbose)
546                 log_info (_("connection to the agent is in restricted mode\n"));
547               err = 0;
548             }
549         }
550     }
551   if (err)
552     {
553       assuan_release (ctx);
554       return err;
555     }
556
557   *r_ctx = ctx;
558   return 0;
559 }
560
561
562 /* Try to connect to the dirmngr via a socket.  On platforms
563    supporting it, start it up if needed and if AUTOSTART is true.
564    Returns a new assuan context at R_CTX or an error code. */
565 gpg_error_t
566 start_new_dirmngr (assuan_context_t *r_ctx,
567                    gpg_err_source_t errsource,
568                    const char *dirmngr_program,
569                    int autostart,
570                    int verbose, int debug,
571                    gpg_error_t (*status_cb)(ctrl_t, int, ...),
572                    ctrl_t status_cb_arg)
573 {
574   gpg_error_t err;
575   assuan_context_t ctx;
576   const char *sockname;
577   int did_success_msg = 0;
578
579   *r_ctx = NULL;
580
581   err = assuan_new (&ctx);
582   if (err)
583     {
584       log_error ("error allocating assuan context: %s\n", gpg_strerror (err));
585       return err;
586     }
587
588   sockname = dirmngr_socket_name ();
589   err = assuan_socket_connect (ctx, sockname, 0, 0);
590
591 #ifdef USE_DIRMNGR_AUTO_START
592   if (err && autostart)
593     {
594       lock_spawn_t lock;
595       const char *argv[4];
596       char *abs_homedir;
597
598       /* No connection: Try start a new Dirmngr.  */
599       if (!dirmngr_program || !*dirmngr_program)
600         dirmngr_program = gnupg_module_name (GNUPG_MODULE_NAME_DIRMNGR);
601
602       if (verbose)
603         log_info (_("no running dirmngr - starting '%s'\n"),
604                   dirmngr_program);
605
606       if (status_cb)
607         status_cb (status_cb_arg, STATUS_PROGRESS,
608                    "starting_dirmngr ? 0 0", NULL);
609
610       abs_homedir = make_absfilename (gnupg_homedir (), NULL);
611       if (!abs_homedir)
612         {
613           gpg_error_t tmperr = gpg_err_make (errsource,
614                                              gpg_err_code_from_syserror ());
615           log_error ("error building filename: %s\n",gpg_strerror (tmperr));
616           assuan_release (ctx);
617           return tmperr;
618         }
619
620       if (fflush (NULL))
621         {
622           gpg_error_t tmperr = gpg_err_make (errsource,
623                                              gpg_err_code_from_syserror ());
624           log_error ("error flushing pending output: %s\n",
625                      strerror (errno));
626           assuan_release (ctx);
627           return tmperr;
628         }
629
630       argv[0] = "--daemon";
631       /* Try starting the daemon.  Versions of dirmngr < 2.1.15 do
632        * this only if the home directory is given on the command line.  */
633       argv[1] = "--homedir";
634       argv[2] = abs_homedir;
635       argv[3] = NULL;
636
637       if (!(err = lock_spawning (&lock, gnupg_homedir (), "dirmngr", verbose))
638           && assuan_socket_connect (ctx, sockname, 0, 0))
639         {
640 #ifdef HAVE_W32_SYSTEM
641           err = gnupg_spawn_process_detached (dirmngr_program, argv, NULL);
642 #else
643           pid_t pid;
644
645           err = gnupg_spawn_process_fd (dirmngr_program, argv,
646                                         -1, -1, -1, &pid);
647           if (!err)
648             err = gnupg_wait_process (dirmngr_program, pid, 1, NULL);
649 #endif
650           if (err)
651             log_error ("failed to start the dirmngr '%s': %s\n",
652                        dirmngr_program, gpg_strerror (err));
653           else
654             err = wait_for_sock (SECS_TO_WAIT_FOR_DIRMNGR, 1,
655                                  sockname, verbose, ctx, &did_success_msg);
656         }
657
658       unlock_spawning (&lock, "dirmngr");
659       xfree (abs_homedir);
660     }
661 #else
662   (void)dirmngr_program;
663   (void)verbose;
664   (void)status_cb;
665   (void)status_cb_arg;
666 #endif /*USE_DIRMNGR_AUTO_START*/
667
668   if (err)
669     {
670       if (autostart || gpg_err_code (err) != GPG_ERR_ASS_CONNECT_FAILED)
671         log_error ("connecting dirmngr at '%s' failed: %s\n",
672                    sockname, gpg_strerror (err));
673       assuan_release (ctx);
674       return gpg_err_make (errsource, GPG_ERR_NO_DIRMNGR);
675     }
676
677   if (debug && !did_success_msg)
678     log_debug ("connection to the dirmngr established\n");
679
680   *r_ctx = ctx;
681   return 0;
682 }
683
684
685 /* Return the version of a server using "GETINFO version".  On success
686    0 is returned and R_VERSION receives a malloced string with the
687    version which must be freed by the caller.  On error NULL is stored
688    at R_VERSION and an error code returned.  Mode is in general 0 but
689    certain values may be used to modify the used version command:
690
691       MODE == 0 = Use "GETINFO version"
692       MODE == 2 - Use "SCD GETINFO version"
693  */
694 gpg_error_t
695 get_assuan_server_version (assuan_context_t ctx, int mode, char **r_version)
696 {
697   gpg_error_t err;
698   membuf_t data;
699
700   init_membuf (&data, 64);
701   err = assuan_transact (ctx,
702                          mode == 2? "SCD GETINFO version"
703                          /**/     : "GETINFO version",
704                          put_membuf_cb, &data,
705                          NULL, NULL, NULL, NULL);
706   if (err)
707     {
708       xfree (get_membuf (&data, NULL));
709       *r_version = NULL;
710     }
711   else
712     {
713       put_membuf (&data, "", 1);
714       *r_version = get_membuf (&data, NULL);
715       if (!*r_version)
716         err = gpg_error_from_syserror ();
717     }
718   return err;
719 }