common: Add new helper function, strsplit.
[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"spawn_"GNUPG_NAME"_agent_sentinel":
269      !strcmp (name, "dirmngr")? L"spawn_"GNUPG_NAME"_dirmngr_sentinel":
270      /*                    */   L"spawn_"GNUPG_NAME"_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_absfilename_try
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 start it if it is not
348    running and AUTOSTART is set.  Handle the server's initial
349    greeting.  Returns a new assuan context at R_CTX or an error
350    code. */
351 gpg_error_t
352 start_new_gpg_agent (assuan_context_t *r_ctx,
353                      gpg_err_source_t errsource,
354                      const char *homedir,
355                      const char *agent_program,
356                      const char *opt_lc_ctype,
357                      const char *opt_lc_messages,
358                      session_env_t session_env,
359                      int autostart, int verbose, int debug,
360                      gpg_error_t (*status_cb)(ctrl_t, int, ...),
361                      ctrl_t status_cb_arg)
362 {
363   gpg_error_t err;
364   assuan_context_t ctx;
365   int did_success_msg = 0;
366   char *sockname;
367   const char *argv[6];
368
369   *r_ctx = NULL;
370
371   err = assuan_new (&ctx);
372   if (err)
373     {
374       log_error ("error allocating assuan context: %s\n", gpg_strerror (err));
375       return err;
376     }
377
378   sockname = make_absfilename (homedir, GPG_AGENT_SOCK_NAME, NULL);
379   err = assuan_socket_connect (ctx, sockname, 0, 0);
380   if (err && autostart)
381     {
382       char *abs_homedir;
383       lock_spawn_t lock;
384       char *program = NULL;
385       const char *program_arg = NULL;
386       char *p;
387       const char *s;
388       int i;
389
390       /* With no success start a new server.  */
391       if (!agent_program || !*agent_program)
392         agent_program = gnupg_module_name (GNUPG_MODULE_NAME_AGENT);
393       else if ((s=strchr (agent_program, '|')) && s[1] == '-' && s[2]=='-')
394         {
395           /* Hack to insert an additional option on the command line.  */
396           program = xtrystrdup (agent_program);
397           if (!program)
398             {
399               gpg_error_t tmperr = gpg_err_make (errsource,
400                                                  gpg_err_code_from_syserror ());
401               xfree (sockname);
402               assuan_release (ctx);
403               return tmperr;
404             }
405           p = strchr (program, '|');
406           *p++ = 0;
407           program_arg = p;
408         }
409
410       if (verbose)
411         log_info (_("no running gpg-agent - starting '%s'\n"),
412                   agent_program);
413
414       if (status_cb)
415         status_cb (status_cb_arg, STATUS_PROGRESS,
416                    "starting_agent ? 0 0", NULL);
417
418       /* We better pass an absolute home directory to the agent just
419          in case gpg-agent does not convert the passed name to an
420          absolute one (which it should do).  */
421       abs_homedir = make_absfilename_try (homedir, NULL);
422       if (!abs_homedir)
423         {
424           gpg_error_t tmperr = gpg_err_make (errsource,
425                                              gpg_err_code_from_syserror ());
426           log_error ("error building filename: %s\n",gpg_strerror (tmperr));
427           xfree (sockname);
428           assuan_release (ctx);
429           xfree (program);
430           return tmperr;
431         }
432
433       if (fflush (NULL))
434         {
435           gpg_error_t tmperr = gpg_err_make (errsource,
436                                              gpg_err_code_from_syserror ());
437           log_error ("error flushing pending output: %s\n",
438                      strerror (errno));
439           xfree (sockname);
440           assuan_release (ctx);
441           xfree (abs_homedir);
442           xfree (program);
443           return tmperr;
444         }
445
446       /* If the agent has been configured for use with a standard
447          socket, an environment variable is not required and thus
448          we we can savely start the agent here.  */
449       i = 0;
450       argv[i++] = "--homedir";
451       argv[i++] = abs_homedir;
452       argv[i++] = "--use-standard-socket";
453       if (program_arg)
454         argv[i++] = program_arg;
455       argv[i++] = "--daemon";
456       argv[i++] = NULL;
457
458       if (!(err = lock_spawning (&lock, homedir, "agent", verbose))
459           && assuan_socket_connect (ctx, sockname, 0, 0))
460         {
461           err = gnupg_spawn_process_detached (program? program : agent_program,
462                                               argv, NULL);
463           if (err)
464             log_error ("failed to start agent '%s': %s\n",
465                        agent_program, gpg_strerror (err));
466           else
467             {
468               for (i=0; i < SECS_TO_WAIT_FOR_AGENT; i++)
469                 {
470                   if (verbose)
471                     log_info (_("waiting for the agent to come up ... (%ds)\n"),
472                               SECS_TO_WAIT_FOR_AGENT - i);
473                   gnupg_sleep (1);
474                   err = assuan_socket_connect (ctx, sockname, 0, 0);
475                   if (!err)
476                     {
477                       if (verbose)
478                         {
479                           log_info (_("connection to agent established\n"));
480                           did_success_msg = 1;
481                         }
482                       break;
483                     }
484                 }
485             }
486         }
487
488       unlock_spawning (&lock, "agent");
489       xfree (abs_homedir);
490       xfree (program);
491     }
492   xfree (sockname);
493   if (err)
494     {
495       if (autostart || gpg_err_code (err) != GPG_ERR_ASS_CONNECT_FAILED)
496         log_error ("can't connect to the agent: %s\n", gpg_strerror (err));
497       assuan_release (ctx);
498       return gpg_err_make (errsource, GPG_ERR_NO_AGENT);
499     }
500
501   if (debug && !did_success_msg)
502     log_debug (_("connection to agent established\n"));
503
504   err = assuan_transact (ctx, "RESET",
505                          NULL, NULL, NULL, NULL, NULL, NULL);
506   if (!err)
507     {
508       err = send_pinentry_environment (ctx, errsource,
509                                        opt_lc_ctype, opt_lc_messages,
510                                        session_env);
511       if (gpg_err_code (err) == GPG_ERR_FORBIDDEN
512           && gpg_err_source (err) == GPG_ERR_SOURCE_GPGAGENT)
513         {
514           /* Check whether we are in restricted mode.  */
515           if (!assuan_transact (ctx, "GETINFO restricted",
516                                 NULL, NULL, NULL, NULL, NULL, NULL))
517             {
518               if (verbose)
519                 log_info (_("connection to agent is in restricted mode\n"));
520               err = 0;
521             }
522         }
523     }
524   if (err)
525     {
526       assuan_release (ctx);
527       return err;
528     }
529
530   *r_ctx = ctx;
531   return 0;
532 }
533
534
535 /* Try to connect to the dirmngr via a socket.  On platforms
536    supporting it, start it up if needed and if AUTOSTART is true.
537    Returns a new assuan context at R_CTX or an error code. */
538 gpg_error_t
539 start_new_dirmngr (assuan_context_t *r_ctx,
540                    gpg_err_source_t errsource,
541                    const char *homedir,
542                    const char *dirmngr_program,
543                    int autostart,
544                    int verbose, int debug,
545                    gpg_error_t (*status_cb)(ctrl_t, int, ...),
546                    ctrl_t status_cb_arg)
547 {
548   gpg_error_t err;
549   assuan_context_t ctx;
550   const char *sockname;
551   int did_success_msg = 0;
552
553   *r_ctx = NULL;
554
555   err = assuan_new (&ctx);
556   if (err)
557     {
558       log_error ("error allocating assuan context: %s\n", gpg_strerror (err));
559       return err;
560     }
561
562   sockname = dirmngr_user_socket_name ();
563   if (sockname)
564     {
565       /* First try the local socket name and only if that fails try
566          the system socket.  */
567       err = assuan_socket_connect (ctx, sockname, 0, 0);
568       if (err)
569         sockname = dirmngr_sys_socket_name ();
570     }
571   else
572     sockname = dirmngr_sys_socket_name ();
573
574   err = assuan_socket_connect (ctx, sockname, 0, 0);
575
576 #ifdef USE_DIRMNGR_AUTO_START
577   if (err && autostart)
578     {
579       lock_spawn_t lock;
580       const char *argv[4];
581       int try_system_daemon = 0;
582       char *abs_homedir;
583
584       /* No connection: Try start a new Dirmngr.  On Windows this will
585          fail because the Dirmngr is expected to be a system service.
586          However on WinCE we don't distinguish users and thus we can
587          start it.  */
588
589       /* We prefer to start it as a user daemon.  */
590       sockname = dirmngr_user_socket_name ();
591       if (!sockname)
592         {
593           sockname = dirmngr_sys_socket_name ();
594           try_system_daemon = 1;
595         }
596
597       if (!dirmngr_program || !*dirmngr_program)
598         dirmngr_program = gnupg_module_name (GNUPG_MODULE_NAME_DIRMNGR);
599
600       if (verbose)
601         log_info (_("no running Dirmngr - starting '%s'\n"),
602                   dirmngr_program);
603
604       if (status_cb)
605         status_cb (status_cb_arg, STATUS_PROGRESS,
606                    "starting_dirmngr ? 0 0", NULL);
607
608       abs_homedir = make_absfilename (homedir, NULL);
609       if (!abs_homedir)
610         {
611           gpg_error_t tmperr = gpg_err_make (errsource,
612                                              gpg_err_code_from_syserror ());
613           log_error ("error building filename: %s\n",gpg_strerror (tmperr));
614           assuan_release (ctx);
615           return tmperr;
616         }
617
618       if (fflush (NULL))
619         {
620           gpg_error_t tmperr = gpg_err_make (errsource,
621                                              gpg_err_code_from_syserror ());
622           log_error ("error flushing pending output: %s\n",
623                      strerror (errno));
624           assuan_release (ctx);
625           return tmperr;
626         }
627
628       argv[0] = "--daemon";
629       if (try_system_daemon)
630         argv[1] = NULL;
631       else
632         { /* Try starting as user daemon - dirmngr does this if the
633              home directory is given on the command line.  */
634           argv[1] = "--homedir";
635           argv[2] = abs_homedir;
636           argv[3] = NULL;
637         }
638
639       /* On the use of HOMEDIR for locking: Under Windows HOMEDIR is
640          not used thus it does not matter.  Under Unix we should
641          TRY_SYSTEM_DAEMON should never be true because
642          dirmngr_user_socket_name() won't return NULL.  */
643
644       if (!(err = lock_spawning (&lock, homedir, "dirmngr", verbose))
645           && assuan_socket_connect (ctx, sockname, 0, 0))
646         {
647           err = gnupg_spawn_process_detached (dirmngr_program, argv, NULL);
648           if (err)
649             log_error ("failed to start the dirmngr '%s': %s\n",
650                        dirmngr_program, gpg_strerror (err));
651           else
652             {
653               int i;
654
655               for (i=0; i < SECS_TO_WAIT_FOR_DIRMNGR; i++)
656                 {
657                   if (verbose)
658                     log_info (_("waiting for the dirmngr "
659                                 "to come up ... (%ds)\n"),
660                               SECS_TO_WAIT_FOR_DIRMNGR - i);
661                   gnupg_sleep (1);
662                   err = assuan_socket_connect (ctx, sockname, 0, 0);
663                   if (!err)
664                     {
665                       if (verbose)
666                         {
667                           log_info (_("connection to the dirmngr"
668                                       " established\n"));
669                           did_success_msg = 1;
670                         }
671                       break;
672                     }
673                 }
674             }
675         }
676
677       unlock_spawning (&lock, "dirmngr");
678       xfree (abs_homedir);
679     }
680 #else
681   (void)homedir;
682   (void)dirmngr_program;
683   (void)verbose;
684   (void)status_cb;
685   (void)status_cb_arg;
686 #endif /*USE_DIRMNGR_AUTO_START*/
687
688   if (err)
689     {
690       if (autostart || gpg_err_code (err) != GPG_ERR_ASS_CONNECT_FAILED)
691         log_error ("connecting dirmngr at '%s' failed: %s\n",
692                    sockname, gpg_strerror (err));
693       assuan_release (ctx);
694       return gpg_err_make (errsource, GPG_ERR_NO_DIRMNGR);
695     }
696
697   if (debug && !did_success_msg)
698     log_debug (_("connection to the dirmngr established\n"));
699
700   *r_ctx = ctx;
701   return 0;
702 }