auto start the agent if --use-standard-socket is in use.
[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_agent_t HANDLE
41 #else
42 # define lock_agent_t dotlock_t
43 #endif
44
45
46 /* A bitfield that specifies the assuan categories to log.  This is
47    identical to the default log handler of libassuan.  We need to do
48    it ourselves because we use a custom log handler and want to use
49    the same assuan variables to select the categories to log. */
50 static int log_cats;
51 #define TEST_LOG_CAT(x) (!! (log_cats & (1 << (x - 1))))
52
53
54 static int
55 my_libassuan_log_handler (assuan_context_t ctx, void *hook,
56                           unsigned int cat, const char *msg)
57 {
58   unsigned int dbgval;
59
60   (void)ctx;
61
62   if (! TEST_LOG_CAT (cat))
63     return 0;
64
65   dbgval = hook? *(unsigned int*)hook : 0;
66   if (!(dbgval & 1024))
67     return 0; /* Assuan debugging is not enabled.  */
68
69   if (msg)
70     log_string (JNLIB_LOG_DEBUG, msg);
71
72   return 1;
73 }
74
75
76 /* Setup libassuan to use our own logging functions.  Should be used
77    early at startup.  */
78 void
79 setup_libassuan_logging (unsigned int *debug_var_address)
80 {
81   char *flagstr;
82
83   flagstr = getenv ("ASSUAN_DEBUG");
84   if (flagstr)
85     log_cats = atoi (flagstr);
86   else /* Default to log the control channel.  */
87     log_cats = (1 << (ASSUAN_LOG_CONTROL - 1));
88   assuan_set_log_cb (my_libassuan_log_handler, debug_var_address);
89 }
90
91
92
93 static gpg_error_t
94 send_one_option (assuan_context_t ctx, gpg_err_source_t errsource,
95                  const char *name, const char *value, int use_putenv)
96 {
97   gpg_error_t err;
98   char *optstr;
99
100   (void)errsource;
101
102   if (!value || !*value)
103     err = 0;  /* Avoid sending empty strings.  */
104   else if (asprintf (&optstr, "OPTION %s%s=%s", 
105                      use_putenv? "putenv=":"", name, value) < 0)
106     err = gpg_error_from_syserror ();
107   else
108     {
109       err = assuan_transact (ctx, optstr, NULL, NULL, NULL, NULL, NULL, NULL);
110       xfree (optstr);
111     }
112
113   return err;
114 }
115
116
117 /* Send the assuan commands pertaining to the pinentry environment.  The
118    OPT_* arguments are optional and may be used to override the
119    defaults taken from the current locale. */
120 gpg_error_t
121 send_pinentry_environment (assuan_context_t ctx,
122                            gpg_err_source_t errsource,
123                            const char *opt_lc_ctype,
124                            const char *opt_lc_messages,
125                            session_env_t session_env)
126
127 {
128   gpg_error_t err = 0;
129 #if defined(HAVE_SETLOCALE)
130   char *old_lc = NULL; 
131 #endif
132   char *dft_lc = NULL;
133   const char *dft_ttyname;
134   int iterator;
135   const char *name, *assname, *value;
136   int is_default;
137
138   iterator = 0; 
139   while ((name = session_env_list_stdenvnames (&iterator, &assname)))
140     {
141       value = session_env_getenv_or_default (session_env, name, NULL);
142       if (!value)
143         continue;
144
145       if (assname)
146         err = send_one_option (ctx, errsource, assname, value, 0);
147       else
148         {
149           err = send_one_option (ctx, errsource, name, value, 1);
150           if (gpg_err_code (err) == GPG_ERR_UNKNOWN_OPTION)
151             err = 0;  /* Server too old; can't pass the new envvars.  */
152         }
153       if (err)
154         return err;
155     }
156
157
158   dft_ttyname = session_env_getenv_or_default (session_env, "GPG_TTY", 
159                                                &is_default);
160   if (dft_ttyname && !is_default)
161     dft_ttyname = NULL;  /* We need the default value.  */
162
163   /* Send the value for LC_CTYPE.  */
164 #if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
165   old_lc = setlocale (LC_CTYPE, NULL);
166   if (old_lc)
167     {
168       old_lc = xtrystrdup (old_lc);
169       if (!old_lc)
170         return gpg_error_from_syserror ();
171     }
172   dft_lc = setlocale (LC_CTYPE, "");
173 #endif
174   if (opt_lc_ctype || (dft_ttyname && dft_lc))
175     {
176       err = send_one_option (ctx, errsource, "lc-ctype", 
177                              opt_lc_ctype ? opt_lc_ctype : dft_lc, 0);
178     }
179 #if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
180   if (old_lc)
181     {
182       setlocale (LC_CTYPE, old_lc);
183       xfree (old_lc);
184     }
185 #endif
186   if (err)
187     return err;
188
189   /* Send the value for LC_MESSAGES.  */
190 #if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
191   old_lc = setlocale (LC_MESSAGES, NULL);
192   if (old_lc)
193     {
194       old_lc = xtrystrdup (old_lc);
195       if (!old_lc)
196         return gpg_error_from_syserror ();
197     }
198   dft_lc = setlocale (LC_MESSAGES, "");
199 #endif
200   if (opt_lc_messages || (dft_ttyname && dft_lc))
201     {
202       err = send_one_option (ctx, errsource, "lc-messages", 
203                              opt_lc_messages ? opt_lc_messages : dft_lc, 0);
204     }
205 #if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
206   if (old_lc)
207     {
208       setlocale (LC_MESSAGES, old_lc);
209       xfree (old_lc);
210     }
211 #endif
212   if (err)
213     return err;
214
215   return 0;
216 }
217
218
219 /* Lock the agent spawning process.  The caller needs to provide the
220    address of a variable to store the lock information.  */
221 static gpg_error_t
222 lock_agent_spawning (lock_agent_t *lock, const char *homedir)
223 {
224 #ifdef HAVE_W32_SYSTEM
225   int waitrc;
226
227   (void)homedir; /* Not required. */
228
229   *lock = CreateMutex (NULL, FALSE, "GnuPG_spawn_agent_sentinel");
230   if (!*lock)
231     {
232       log_error ("failed to create the spawn_agent mutex: %s\n",
233                  w32_strerror (-1));
234       return gpg_error (GPG_ERR_GENERAL);
235     }
236
237   waitrc = WaitForSingleObject (*lock, 5000);
238   if (waitrc == WAIT_OBJECT_0)
239     return 0;
240
241   if (waitrc == WAIT_TIMEOUT)
242     log_info ("error waiting for the spawn_agent mutex: timeout\n");
243   else
244     log_info ("error waiting for the spawn_agent mutex: "
245               "(code=%d) %s\n", waitrc, w32_strerror (-1));
246   return gpg_error (GPG_ERR_GENERAL);
247 #else /*!HAVE_W32_SYSTEM*/
248   char *fname;
249
250   *lock = NULL;
251
252   fname = make_filename (homedir, "gnupg_spawn_agent_sentinel", NULL);
253   if (!fname)
254     return gpg_error_from_syserror ();
255
256   *lock = create_dotlock (fname);
257   xfree (fname);
258   if (!*lock)
259     return gpg_error_from_syserror ();
260
261   /* FIXME: We should use a timeout of 5000 here - however
262      make_dotlock does not yet support values other than -1 and 0.  */
263   if (make_dotlock (*lock, -1))
264     return gpg_error_from_syserror ();
265
266   return 0;
267 #endif /*!HAVE_W32_SYSTEM*/
268 }
269
270
271 /* Unlock the spawning process.  */
272 static void
273 unlock_agent_spawning (lock_agent_t *lock)
274 {
275   if (*lock)
276     {
277 #ifdef HAVE_W32_SYSTEM
278       if (!ReleaseMutex (*lock))
279         log_error ("failed to release the spawn_agent mutex: %s\n",
280                    w32_strerror (-1));
281       CloseHandle (*lock);
282 #else /*!HAVE_W32_SYSTEM*/
283       destroy_dotlock (*lock);
284 #endif /*!HAVE_W32_SYSTEM*/
285       *lock = NULL;
286     }
287 }
288
289
290 /* Try to connect to the agent via socket or fork it off and work by
291    pipes.  Handle the server's initial greeting.  Returns a new assuan
292    context at R_CTX or an error code. */
293 gpg_error_t
294 start_new_gpg_agent (assuan_context_t *r_ctx,
295                      gpg_err_source_t errsource,
296                      const char *homedir,
297                      const char *agent_program,
298                      const char *opt_lc_ctype,
299                      const char *opt_lc_messages,
300                      session_env_t session_env,
301                      int verbose, int debug,
302                      gpg_error_t (*status_cb)(ctrl_t, int, ...),
303                      ctrl_t status_cb_arg)
304 {
305   /* If we ever failed to connect via a socket we will force the use
306      of the pipe based server for the lifetime of the process.  */
307   static int force_pipe_server = 0;
308
309   gpg_error_t err = 0;
310   char *infostr, *p;
311   assuan_context_t ctx;
312
313   *r_ctx = NULL;
314
315   err = assuan_new (&ctx);
316   if (err)
317     {
318       log_error ("error allocating assuan context: %s\n", gpg_strerror (err));
319       return err;
320     }
321
322  restart:
323   infostr = force_pipe_server? NULL : getenv ("GPG_AGENT_INFO");
324   if (!infostr || !*infostr)
325     {
326       char *sockname;
327       const char *argv[3];
328       pid_t pid;
329       int excode;
330
331       /* First check whether we can connect at the standard
332          socket.  */
333       sockname = make_filename (homedir, "S.gpg-agent", NULL);
334       err = assuan_socket_connect (ctx, sockname, 0, 0);
335
336       if (err)
337         {
338           /* With no success start a new server.  */
339           if (verbose)
340             log_info (_("no running gpg-agent - starting one\n"));
341           
342           if (status_cb)
343             status_cb (status_cb_arg, STATUS_PROGRESS, 
344                        "starting_agent ? 0 0", NULL);
345           
346           if (fflush (NULL))
347             {
348               gpg_error_t tmperr = gpg_error (gpg_err_code_from_errno (errno));
349               log_error ("error flushing pending output: %s\n",
350                          strerror (errno));
351               xfree (sockname);
352               assuan_release (ctx);
353               return tmperr;
354             }
355           
356           if (!agent_program || !*agent_program)
357             agent_program = gnupg_module_name (GNUPG_MODULE_NAME_AGENT);
358
359           argv[0] = "--use-standard-socket-p"; 
360           argv[1] = NULL;  
361           err = gnupg_spawn_process_fd (agent_program, argv, -1, -1, -1, &pid);
362           if (err)
363             log_debug ("starting `%s' for testing failed: %s\n",
364                        agent_program, gpg_strerror (err));
365           else if ((err = gnupg_wait_process (agent_program, pid, &excode)))
366             {
367               if (excode == -1)
368                 log_debug ("running `%s' for testing failed: %s\n",
369                            agent_program, gpg_strerror (err));
370             }          
371
372           if (!err && !excode)
373             {
374               /* If the agent has been configured for use with a
375                  standard socket, an environment variable is not
376                  required and thus we we can savely start the agent
377                  here.  */
378               lock_agent_t lock;
379
380               argv[0] = "--daemon";
381               argv[1] = "--use-standard-socket"; 
382               argv[2] = NULL;  
383
384               if (!(err = lock_agent_spawning (&lock, homedir))
385                   && assuan_socket_connect (ctx, sockname, 0, 0))
386                 {
387                   err = gnupg_spawn_process_detached (agent_program, argv,NULL);
388                   if (err)
389                     log_error ("failed to start agent `%s': %s\n",
390                                agent_program, gpg_strerror (err));
391                   else
392                     {
393                       int i;
394
395                       if (verbose)
396                         log_info (_("waiting %d seconds for the agent "
397                                     "to come up\n"), 5);
398                       for (i=0; i < 5; i++)
399                         {
400                           gnupg_sleep (1);
401                           err = assuan_socket_connect (ctx, sockname, 0, 0);
402                           if (!err)
403                             break;
404                         }
405                     }
406                 }
407
408               unlock_agent_spawning (&lock);
409             }
410           else
411             {
412               /* If using the standard socket is not the default we
413                  start the agent as a pipe server which gives us most
414                  of the required features except for passphrase
415                  caching etc.  */
416               const char *pgmname;
417               int no_close_list[3];
418               int i;
419               
420               if ( !(pgmname = strrchr (agent_program, '/')))
421                 pgmname = agent_program;
422               else
423                 pgmname++;
424               
425               argv[0] = pgmname;
426               argv[1] = "--server";
427               argv[2] = NULL;
428               
429               i=0;
430               if (log_get_fd () != -1)
431                 no_close_list[i++] = assuan_fd_from_posix_fd (log_get_fd ());
432               no_close_list[i++] = assuan_fd_from_posix_fd (fileno (stderr));
433               no_close_list[i] = -1;
434               
435               /* Connect to the agent and perform initial handshaking. */
436               err = assuan_pipe_connect (ctx, agent_program, argv,
437                                          no_close_list, NULL, NULL, 0);
438             }
439         }
440       xfree (sockname);
441     }
442   else
443     {
444       int prot;
445       int pid;
446
447       infostr = xstrdup (infostr);
448       if ( !(p = strchr (infostr, PATHSEP_C)) || p == infostr)
449         {
450           log_error (_("malformed GPG_AGENT_INFO environment variable\n"));
451           xfree (infostr);
452           force_pipe_server = 1;
453           goto restart;
454         }
455       *p++ = 0;
456       pid = atoi (p);
457       while (*p && *p != PATHSEP_C)
458         p++;
459       prot = *p? atoi (p+1) : 0;
460       if (prot != 1)
461         {
462           log_error (_("gpg-agent protocol version %d is not supported\n"),
463                      prot);
464           xfree (infostr);
465           force_pipe_server = 1;
466           goto restart;
467         }
468
469       err = assuan_socket_connect (ctx, infostr, pid, 0);
470       xfree (infostr);
471       if (gpg_err_code (err) == GPG_ERR_ASS_CONNECT_FAILED)
472         {
473           log_info (_("can't connect to the agent - trying fall back\n"));
474           force_pipe_server = 1;
475           goto restart;
476         }
477     }
478
479   if (err)
480     {
481       log_error ("can't connect to the agent: %s\n", gpg_strerror (err));
482       assuan_release (ctx);
483       return gpg_error (GPG_ERR_NO_AGENT);
484     }
485
486   if (debug)
487     log_debug ("connection to agent established\n");
488
489   err = assuan_transact (ctx, "RESET",
490                         NULL, NULL, NULL, NULL, NULL, NULL);
491   if (!err)
492     err = send_pinentry_environment (ctx, errsource,
493                                     opt_lc_ctype, opt_lc_messages,
494                                     session_env);
495   if (err)
496     {
497       assuan_release (ctx);
498       return err;
499     }
500
501   *r_ctx = ctx;
502   return 0;
503 }
504