fe328549b88db98c88f31fe69891ea13864a69bf
[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 <http://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 #define JNLIB_NEED_LOG_LOGV
41 #include "i18n.h"
42 #include "util.h"
43 #include "exechelp.h"
44 #include "sysutils.h"
45 #include "status.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
73 static int
74 my_libassuan_log_handler (assuan_context_t ctx, void *hook,
75                           unsigned int cat, const char *msg)
76 {
77   unsigned int dbgval;
78
79   (void)ctx;
80
81   if (! TEST_LOG_CAT (cat))
82     return 0;
83
84   dbgval = hook? *(unsigned int*)hook : 0;
85   if (!(dbgval & 1024))
86     return 0; /* Assuan debugging is not enabled.  */
87
88   if (msg)
89     log_string (JNLIB_LOG_DEBUG, msg);
90
91   return 1;
92 }
93
94
95 /* Setup libassuan to use our own logging functions.  Should be used
96    early at startup.  */
97 void
98 setup_libassuan_logging (unsigned int *debug_var_address)
99 {
100   char *flagstr;
101
102   flagstr = getenv ("ASSUAN_DEBUG");
103   if (flagstr)
104     log_cats = atoi (flagstr);
105   else /* Default to log the control channel.  */
106     log_cats = (1 << (ASSUAN_LOG_CONTROL - 1));
107   assuan_set_log_cb (my_libassuan_log_handler, debug_var_address);
108 }
109
110 /* Change the Libassuan log categories to those given by NEWCATS.
111    NEWCATS is 0 the default category of ASSUAN_LOG_CONTROL is
112    selected.  Note, that setup_libassuan_logging overrides the values
113    given here.  */
114 void
115 set_libassuan_log_cats (unsigned int newcats)
116 {
117   if (newcats)
118     log_cats = newcats;
119   else /* Default to log the control channel.  */
120     log_cats = (1 << (ASSUAN_LOG_CONTROL - 1));
121 }
122
123
124
125 static gpg_error_t
126 send_one_option (assuan_context_t ctx, gpg_err_source_t errsource,
127                  const char *name, const char *value, int use_putenv)
128 {
129   gpg_error_t err;
130   char *optstr;
131
132   (void)errsource;
133
134   if (!value || !*value)
135     err = 0;  /* Avoid sending empty strings.  */
136   else if (asprintf (&optstr, "OPTION %s%s=%s",
137                      use_putenv? "putenv=":"", name, value) < 0)
138     err = gpg_error_from_syserror ();
139   else
140     {
141       err = assuan_transact (ctx, optstr, NULL, NULL, NULL, NULL, NULL, NULL);
142       xfree (optstr);
143     }
144
145   return err;
146 }
147
148
149 /* Send the assuan commands pertaining to the pinentry environment.  The
150    OPT_* arguments are optional and may be used to override the
151    defaults taken from the current locale. */
152 gpg_error_t
153 send_pinentry_environment (assuan_context_t ctx,
154                            gpg_err_source_t errsource,
155                            const char *opt_lc_ctype,
156                            const char *opt_lc_messages,
157                            session_env_t session_env)
158
159 {
160   gpg_error_t err = 0;
161 #if defined(HAVE_SETLOCALE)
162   char *old_lc = NULL;
163 #endif
164   char *dft_lc = NULL;
165   const char *dft_ttyname;
166   int iterator;
167   const char *name, *assname, *value;
168   int is_default;
169
170   iterator = 0;
171   while ((name = session_env_list_stdenvnames (&iterator, &assname)))
172     {
173       value = session_env_getenv_or_default (session_env, name, NULL);
174       if (!value)
175         continue;
176
177       if (assname)
178         err = send_one_option (ctx, errsource, assname, value, 0);
179       else
180         {
181           err = send_one_option (ctx, errsource, name, value, 1);
182           if (gpg_err_code (err) == GPG_ERR_UNKNOWN_OPTION)
183             err = 0;  /* Server too old; can't pass the new envvars.  */
184         }
185       if (err)
186         return err;
187     }
188
189
190   dft_ttyname = session_env_getenv_or_default (session_env, "GPG_TTY",
191                                                &is_default);
192   if (dft_ttyname && !is_default)
193     dft_ttyname = NULL;  /* We need the default value.  */
194
195   /* Send the value for LC_CTYPE.  */
196 #if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
197   old_lc = setlocale (LC_CTYPE, NULL);
198   if (old_lc)
199     {
200       old_lc = xtrystrdup (old_lc);
201       if (!old_lc)
202         return gpg_error_from_syserror ();
203     }
204   dft_lc = setlocale (LC_CTYPE, "");
205 #endif
206   if (opt_lc_ctype || (dft_ttyname && dft_lc))
207     {
208       err = send_one_option (ctx, errsource, "lc-ctype",
209                              opt_lc_ctype ? opt_lc_ctype : dft_lc, 0);
210     }
211 #if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
212   if (old_lc)
213     {
214       setlocale (LC_CTYPE, old_lc);
215       xfree (old_lc);
216     }
217 #endif
218   if (err)
219     return err;
220
221   /* Send the value for LC_MESSAGES.  */
222 #if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
223   old_lc = setlocale (LC_MESSAGES, NULL);
224   if (old_lc)
225     {
226       old_lc = xtrystrdup (old_lc);
227       if (!old_lc)
228         return gpg_error_from_syserror ();
229     }
230   dft_lc = setlocale (LC_MESSAGES, "");
231 #endif
232   if (opt_lc_messages || (dft_ttyname && dft_lc))
233     {
234       err = send_one_option (ctx, errsource, "lc-messages",
235                              opt_lc_messages ? opt_lc_messages : dft_lc, 0);
236     }
237 #if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
238   if (old_lc)
239     {
240       setlocale (LC_MESSAGES, old_lc);
241       xfree (old_lc);
242     }
243 #endif
244   if (err)
245     return err;
246
247   return 0;
248 }
249
250
251 /* Lock a spawning process.  The caller needs to provide the address
252    of a variable to store the lock information and the name or the
253    process.  */
254 static gpg_error_t
255 lock_spawning (lock_spawn_t *lock, const char *homedir, const char *name,
256                int verbose)
257 {
258 #ifdef HAVE_W32_SYSTEM
259   int waitrc;
260   int timeout = (!strcmp (name, "agent")
261                  ? SECS_TO_WAIT_FOR_AGENT
262                  : SECS_TO_WAIT_FOR_DIRMNGR);
263
264   (void)homedir; /* Not required. */
265
266   *lock = CreateMutexW
267     (NULL, FALSE,
268      !strcmp (name, "agent")?   L"GnuPG_spawn_agent_sentinel":
269      !strcmp (name, "dirmngr")? L"GnuPG_spawn_dirmngr_sentinel":
270      /*                    */   L"GnuPG_spawn_unknown_sentinel");
271   if (!*lock)
272     {
273       log_error ("failed to create the spawn_%s mutex: %s\n",
274                  name, w32_strerror (-1));
275       return gpg_error (GPG_ERR_GENERAL);
276     }
277
278  retry:
279   waitrc = WaitForSingleObject (*lock, 1000);
280   if (waitrc == WAIT_OBJECT_0)
281     return 0;
282
283   if (waitrc == WAIT_TIMEOUT && timeout)
284     {
285       timeout--;
286       if (verbose)
287         log_info ("another process is trying to start the %s ... (%ds)\n",
288                   name, timeout);
289       goto retry;
290     }
291   if (waitrc == WAIT_TIMEOUT)
292     log_info ("error waiting for the spawn_%s mutex: timeout\n", name);
293   else
294     log_info ("error waiting for the spawn_%s mutex: (code=%d) %s\n",
295               name, waitrc, w32_strerror (-1));
296   return gpg_error (GPG_ERR_GENERAL);
297 #else /*!HAVE_W32_SYSTEM*/
298   char *fname;
299
300   (void)verbose;
301
302   *lock = NULL;
303
304   fname = make_filename
305     (homedir,
306      !strcmp (name, "agent")?   "gnupg_spawn_agent_sentinel":
307      !strcmp (name, "dirmngr")? "gnupg_spawn_dirmngr_sentinel":
308      /*                    */   "gnupg_spawn_unknown_sentinel",
309      NULL);
310   if (!fname)
311     return gpg_error_from_syserror ();
312
313   *lock = dotlock_create (fname, 0);
314   xfree (fname);
315   if (!*lock)
316     return gpg_error_from_syserror ();
317
318   /* FIXME: We should use a timeout of 5000 here - however
319      make_dotlock does not yet support values other than -1 and 0.  */
320   if (dotlock_take (*lock, -1))
321     return gpg_error_from_syserror ();
322
323   return 0;
324 #endif /*!HAVE_W32_SYSTEM*/
325 }
326
327
328 /* Unlock the spawning process.  */
329 static void
330 unlock_spawning (lock_spawn_t *lock, const char *name)
331 {
332   if (*lock)
333     {
334 #ifdef HAVE_W32_SYSTEM
335       if (!ReleaseMutex (*lock))
336         log_error ("failed to release the spawn_%s mutex: %s\n",
337                    name, w32_strerror (-1));
338       CloseHandle (*lock);
339 #else /*!HAVE_W32_SYSTEM*/
340       (void)name;
341       dotlock_destroy (*lock);
342 #endif /*!HAVE_W32_SYSTEM*/
343       *lock = NULL;
344     }
345 }
346
347 /* Try to connect to the agent via socket or fork it off and work by
348    pipes.  Handle the server's initial greeting.  Returns a new assuan
349    context at R_CTX or an error code. */
350 gpg_error_t
351 start_new_gpg_agent (assuan_context_t *r_ctx,
352                      gpg_err_source_t errsource,
353                      const char *homedir,
354                      const char *agent_program,
355                      const char *opt_lc_ctype,
356                      const char *opt_lc_messages,
357                      session_env_t session_env,
358                      int verbose, int debug,
359                      gpg_error_t (*status_cb)(ctrl_t, int, ...),
360                      ctrl_t status_cb_arg)
361 {
362   /* If we ever failed to connect via a socket we will force the use
363      of the pipe based server for the lifetime of the process.  */
364   static int force_pipe_server = 0;
365
366   gpg_error_t err = 0;
367   char *infostr, *p;
368   assuan_context_t ctx;
369   int did_success_msg = 0;
370
371   *r_ctx = NULL;
372
373   err = assuan_new (&ctx);
374   if (err)
375     {
376       log_error ("error allocating assuan context: %s\n", gpg_strerror (err));
377       return err;
378     }
379
380  restart:
381   infostr = force_pipe_server? NULL : getenv ("GPG_AGENT_INFO");
382   if (!infostr || !*infostr)
383     {
384       char *sockname;
385       const char *argv[3];
386       pid_t pid;
387       int excode;
388
389       /* First check whether we can connect at the standard
390          socket.  */
391       sockname = make_filename (homedir, "S.gpg-agent", NULL);
392       err = assuan_socket_connect (ctx, sockname, 0, 0);
393
394       if (err)
395         {
396           /* With no success start a new server.  */
397           if (!agent_program || !*agent_program)
398             agent_program = gnupg_module_name (GNUPG_MODULE_NAME_AGENT);
399
400           if (verbose)
401             log_info (_("no running gpg-agent - starting '%s'\n"),
402                       agent_program);
403
404           if (status_cb)
405             status_cb (status_cb_arg, STATUS_PROGRESS,
406                        "starting_agent ? 0 0", NULL);
407
408           if (fflush (NULL))
409             {
410               gpg_error_t tmperr = gpg_err_make (errsource,
411                                                  gpg_err_code_from_syserror ());
412               log_error ("error flushing pending output: %s\n",
413                          strerror (errno));
414               xfree (sockname);
415               assuan_release (ctx);
416               return tmperr;
417             }
418
419           argv[0] = "--use-standard-socket-p";
420           argv[1] = NULL;
421           err = gnupg_spawn_process_fd (agent_program, argv, -1, -1, -1, &pid);
422           if (err)
423             log_debug ("starting '%s' for testing failed: %s\n",
424                        agent_program, gpg_strerror (err));
425           else if ((err = gnupg_wait_process (agent_program, pid, 1, &excode)))
426             {
427               if (excode == -1)
428                 log_debug ("running '%s' for testing failed (wait): %s\n",
429                            agent_program, gpg_strerror (err));
430             }
431           gnupg_release_process (pid);
432
433           if (!err && !excode)
434             {
435               /* If the agent has been configured for use with a
436                  standard socket, an environment variable is not
437                  required and thus we we can savely start the agent
438                  here.  */
439               lock_spawn_t lock;
440
441               argv[0] = "--daemon";
442               argv[1] = "--use-standard-socket";
443               argv[2] = NULL;
444
445               if (!(err = lock_spawning (&lock, homedir, "agent", verbose))
446                   && assuan_socket_connect (ctx, sockname, 0, 0))
447                 {
448                   err = gnupg_spawn_process_detached (agent_program, argv,NULL);
449                   if (err)
450                     log_error ("failed to start agent '%s': %s\n",
451                                agent_program, gpg_strerror (err));
452                   else
453                     {
454                       int i;
455
456                       for (i=0; i < SECS_TO_WAIT_FOR_AGENT; i++)
457                         {
458                           if (verbose)
459                             log_info (_("waiting for the agent "
460                                         "to come up ... (%ds)\n"),
461                                       SECS_TO_WAIT_FOR_AGENT - i);
462                           gnupg_sleep (1);
463                           err = assuan_socket_connect (ctx, sockname, 0, 0);
464                           if (!err)
465                             {
466                               if (verbose)
467                                 {
468                                   log_info (_("connection to agent "
469                                               "established\n"));
470                                   did_success_msg = 1;
471                                 }
472                               break;
473                             }
474                         }
475                     }
476                 }
477
478               unlock_spawning (&lock, "agent");
479             }
480           else
481             {
482               /* If using the standard socket is not the default we
483                  start the agent as a pipe server which gives us most
484                  of the required features except for passphrase
485                  caching etc.  */
486               const char *pgmname;
487               int no_close_list[3];
488               int i;
489
490               if ( !(pgmname = strrchr (agent_program, '/')))
491                 pgmname = agent_program;
492               else
493                 pgmname++;
494
495               argv[0] = pgmname;
496               argv[1] = "--server";
497               argv[2] = NULL;
498
499               i=0;
500               if (log_get_fd () != -1)
501                 no_close_list[i++] = assuan_fd_from_posix_fd (log_get_fd ());
502               no_close_list[i++] = assuan_fd_from_posix_fd (fileno (stderr));
503               no_close_list[i] = -1;
504
505               /* Connect to the agent and perform initial handshaking. */
506               err = assuan_pipe_connect (ctx, agent_program, argv,
507                                          no_close_list, NULL, NULL, 0);
508             }
509         }
510       xfree (sockname);
511     }
512   else
513     {
514       int prot;
515       int pid;
516
517       infostr = xstrdup (infostr);
518       if ( !(p = strchr (infostr, PATHSEP_C)) || p == infostr)
519         {
520           log_error (_("malformed GPG_AGENT_INFO environment variable\n"));
521           xfree (infostr);
522           force_pipe_server = 1;
523           goto restart;
524         }
525       *p++ = 0;
526       pid = atoi (p);
527       while (*p && *p != PATHSEP_C)
528         p++;
529       prot = *p? atoi (p+1) : 0;
530       if (prot != 1)
531         {
532           log_error (_("gpg-agent protocol version %d is not supported\n"),
533                      prot);
534           xfree (infostr);
535           force_pipe_server = 1;
536           goto restart;
537         }
538
539       err = assuan_socket_connect (ctx, infostr, pid, 0);
540       xfree (infostr);
541       if (gpg_err_code (err) == GPG_ERR_ASS_CONNECT_FAILED)
542         {
543           log_info (_("can't connect to the agent - trying fall back\n"));
544           force_pipe_server = 1;
545           goto restart;
546         }
547     }
548
549   if (err)
550     {
551       log_error ("can't connect to the agent: %s\n", gpg_strerror (err));
552       assuan_release (ctx);
553       return gpg_err_make (errsource, GPG_ERR_NO_AGENT);
554     }
555
556   if (debug && !did_success_msg)
557     log_debug (_("connection to agent established\n"));
558
559   err = assuan_transact (ctx, "RESET",
560                         NULL, NULL, NULL, NULL, NULL, NULL);
561   if (!err)
562     err = send_pinentry_environment (ctx, errsource,
563                                     opt_lc_ctype, opt_lc_messages,
564                                     session_env);
565   if (err)
566     {
567       assuan_release (ctx);
568       return err;
569     }
570
571   *r_ctx = ctx;
572   return 0;
573 }
574
575
576 /* Try to connect to the dirmngr via a socket.  On platforms
577    supporting it, start it up if needed.  Returns a new assuan context
578    at R_CTX or an error code. */
579 gpg_error_t
580 start_new_dirmngr (assuan_context_t *r_ctx,
581                    gpg_err_source_t errsource,
582                    const char *homedir,
583                    const char *dirmngr_program,
584                    int verbose, int debug,
585                    gpg_error_t (*status_cb)(ctrl_t, int, ...),
586                    ctrl_t status_cb_arg)
587 {
588   gpg_error_t err;
589   assuan_context_t ctx;
590   const char *sockname;
591   int did_success_msg = 0;
592
593   *r_ctx = NULL;
594
595   err = assuan_new (&ctx);
596   if (err)
597     {
598       log_error ("error allocating assuan context: %s\n", gpg_strerror (err));
599       return err;
600     }
601
602   sockname = dirmngr_socket_name ();
603   err = assuan_socket_connect (ctx, sockname, 0, 0);
604 #ifdef USE_DIRMNGR_AUTO_START
605   if (err)
606     {
607       lock_spawn_t lock;
608       const char *argv[2];
609
610       /* With no success try start a new Dirmngr.  On most systems
611          this will fail because the Dirmngr is expected to be a system
612          service.  However on Wince we don't distinguish users and
613          thus we can start it.  A future extension might be to use the
614          userv system to start the Dirmngr as a system service.  */
615       if (!dirmngr_program || !*dirmngr_program)
616         dirmngr_program = gnupg_module_name (GNUPG_MODULE_NAME_DIRMNGR);
617
618       if (verbose)
619         log_info (_("no running Dirmngr - starting '%s'\n"),
620                   dirmngr_program);
621
622       if (status_cb)
623         status_cb (status_cb_arg, STATUS_PROGRESS,
624                    "starting_dirmngr ? 0 0", NULL);
625
626       if (fflush (NULL))
627         {
628           gpg_error_t tmperr = gpg_err_make (errsource,
629                                              gpg_err_code_from_syserror ());
630           log_error ("error flushing pending output: %s\n",
631                      strerror (errno));
632           assuan_release (ctx);
633           return tmperr;
634         }
635
636       argv[0] = "--daemon";
637       argv[1] = NULL;
638
639       if (!(err = lock_spawning (&lock, homedir, "dirmngr", verbose))
640           && assuan_socket_connect (ctx, sockname, 0, 0))
641         {
642           err = gnupg_spawn_process_detached (dirmngr_program, argv,NULL);
643           if (err)
644             log_error ("failed to start the dirmngr '%s': %s\n",
645                        dirmngr_program, gpg_strerror (err));
646           else
647             {
648               int i;
649
650               for (i=0; i < SECS_TO_WAIT_FOR_DIRMNGR; i++)
651                 {
652                   if (verbose)
653                     log_info (_("waiting for the dirmngr "
654                                 "to come up ... (%ds)\n"),
655                               SECS_TO_WAIT_FOR_DIRMNGR - i);
656                   gnupg_sleep (1);
657                   err = assuan_socket_connect (ctx, sockname, 0, 0);
658                   if (!err)
659                     {
660                       if (verbose)
661                         {
662                           log_info (_("connection to the dirmngr"
663                                       " established\n"));
664                           did_success_msg = 1;
665                         }
666                       break;
667                     }
668                 }
669             }
670         }
671
672       unlock_spawning (&lock, "dirmngr");
673     }
674 #else
675   (void)homedir;
676   (void)dirmngr_program;
677   (void)verbose;
678   (void)status_cb;
679   (void)status_cb_arg;
680 #endif /*USE_DIRMNGR_AUTO_START*/
681
682   if (err)
683     {
684       log_error ("connecting dirmngr at '%s' failed: %s\n",
685                  sockname, gpg_strerror (err));
686       assuan_release (ctx);
687       return gpg_err_make (errsource, GPG_ERR_NO_DIRMNGR);
688     }
689
690   if (debug && !did_success_msg)
691     log_debug (_("connection to the dirmngr established\n"));
692
693   *r_ctx = ctx;
694   return 0;
695 }