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