assuan: Reorganize waiting for socket.
[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_LOG_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 static gpg_error_t
311 wait_for_sock (int secs, const char *name, const char *sockname, int verbose, assuan_context_t ctx, int *did_success_msg)
312 {
313   int i;
314   gpg_error_t err = 0;
315   for (i=0; i < secs; i++)
316     {
317       if (verbose)
318         log_info (_("waiting for the %s to come up ... (%ds)\n"),
319                   name, secs - i);
320       gnupg_sleep (1);
321       err = assuan_socket_connect (ctx, sockname, 0, 0);
322       if (!err)
323         {
324           if (verbose)
325             {
326               log_info (_("connection to %s established\n"),
327                         name);
328               *did_success_msg = 1;
329             }
330           break;
331         }
332     }
333   return err;
334 }
335
336 /* Try to connect to the agent via socket or start it if it is not
337    running and AUTOSTART is set.  Handle the server's initial
338    greeting.  Returns a new assuan context at R_CTX or an error
339    code. */
340 gpg_error_t
341 start_new_gpg_agent (assuan_context_t *r_ctx,
342                      gpg_err_source_t errsource,
343                      const char *agent_program,
344                      const char *opt_lc_ctype,
345                      const char *opt_lc_messages,
346                      session_env_t session_env,
347                      int autostart, int verbose, int debug,
348                      gpg_error_t (*status_cb)(ctrl_t, int, ...),
349                      ctrl_t status_cb_arg)
350 {
351   gpg_error_t err;
352   assuan_context_t ctx;
353   int did_success_msg = 0;
354   char *sockname;
355   const char *argv[6];
356
357   *r_ctx = NULL;
358
359   err = assuan_new (&ctx);
360   if (err)
361     {
362       log_error ("error allocating assuan context: %s\n", gpg_strerror (err));
363       return err;
364     }
365
366   sockname = make_filename_try (gnupg_socketdir (), GPG_AGENT_SOCK_NAME, NULL);
367   if (!sockname)
368     {
369       err = gpg_err_make (errsource, gpg_err_code_from_syserror ());
370       assuan_release (ctx);
371       return err;
372     }
373
374   err = assuan_socket_connect (ctx, sockname, 0, 0);
375   if (err && autostart)
376     {
377       char *abs_homedir;
378       lock_spawn_t lock;
379       char *program = NULL;
380       const char *program_arg = NULL;
381       char *p;
382       const char *s;
383       int i;
384
385       /* With no success start a new server.  */
386       if (!agent_program || !*agent_program)
387         agent_program = gnupg_module_name (GNUPG_MODULE_NAME_AGENT);
388       else if ((s=strchr (agent_program, '|')) && s[1] == '-' && s[2]=='-')
389         {
390           /* Hack to insert an additional option on the command line.  */
391           program = xtrystrdup (agent_program);
392           if (!program)
393             {
394               gpg_error_t tmperr = gpg_err_make (errsource,
395                                                  gpg_err_code_from_syserror ());
396               xfree (sockname);
397               assuan_release (ctx);
398               return tmperr;
399             }
400           p = strchr (program, '|');
401           *p++ = 0;
402           program_arg = p;
403         }
404
405       if (verbose)
406         log_info (_("no running gpg-agent - starting '%s'\n"),
407                   agent_program);
408
409       if (status_cb)
410         status_cb (status_cb_arg, STATUS_PROGRESS,
411                    "starting_agent ? 0 0", NULL);
412
413       /* We better pass an absolute home directory to the agent just
414          in case gpg-agent does not convert the passed name to an
415          absolute one (which it should do).  */
416       abs_homedir = make_absfilename_try (gnupg_homedir (), NULL);
417       if (!abs_homedir)
418         {
419           gpg_error_t tmperr = gpg_err_make (errsource,
420                                              gpg_err_code_from_syserror ());
421           log_error ("error building filename: %s\n",gpg_strerror (tmperr));
422           xfree (sockname);
423           assuan_release (ctx);
424           xfree (program);
425           return tmperr;
426         }
427
428       if (fflush (NULL))
429         {
430           gpg_error_t tmperr = gpg_err_make (errsource,
431                                              gpg_err_code_from_syserror ());
432           log_error ("error flushing pending output: %s\n",
433                      strerror (errno));
434           xfree (sockname);
435           assuan_release (ctx);
436           xfree (abs_homedir);
437           xfree (program);
438           return tmperr;
439         }
440
441       /* If the agent has been configured for use with a standard
442          socket, an environment variable is not required and thus
443          we can safely start the agent here.  */
444       i = 0;
445       argv[i++] = "--homedir";
446       argv[i++] = abs_homedir;
447       argv[i++] = "--use-standard-socket";
448       if (program_arg)
449         argv[i++] = program_arg;
450       argv[i++] = "--daemon";
451       argv[i++] = NULL;
452
453       if (!(err = lock_spawning (&lock, gnupg_homedir (), "agent", verbose))
454           && assuan_socket_connect (ctx, sockname, 0, 0))
455         {
456           err = gnupg_spawn_process_detached (program? program : agent_program,
457                                               argv, NULL);
458           if (err)
459             log_error ("failed to start agent '%s': %s\n",
460                        agent_program, gpg_strerror (err));
461           else
462             err = wait_for_sock (SECS_TO_WAIT_FOR_AGENT, "agent",
463                                  sockname, verbose, ctx, &did_success_msg);
464         }
465
466       unlock_spawning (&lock, "agent");
467       xfree (abs_homedir);
468       xfree (program);
469     }
470   xfree (sockname);
471   if (err)
472     {
473       if (autostart || gpg_err_code (err) != GPG_ERR_ASS_CONNECT_FAILED)
474         log_error ("can't connect to the agent: %s\n", gpg_strerror (err));
475       assuan_release (ctx);
476       return gpg_err_make (errsource, GPG_ERR_NO_AGENT);
477     }
478
479   if (debug && !did_success_msg)
480     log_debug ("connection to agent established\n");
481
482   err = assuan_transact (ctx, "RESET",
483                          NULL, NULL, NULL, NULL, NULL, NULL);
484   if (!err)
485     {
486       err = send_pinentry_environment (ctx, errsource,
487                                        opt_lc_ctype, opt_lc_messages,
488                                        session_env);
489       if (gpg_err_code (err) == GPG_ERR_FORBIDDEN
490           && gpg_err_source (err) == GPG_ERR_SOURCE_GPGAGENT)
491         {
492           /* Check whether we are in restricted mode.  */
493           if (!assuan_transact (ctx, "GETINFO restricted",
494                                 NULL, NULL, NULL, NULL, NULL, NULL))
495             {
496               if (verbose)
497                 log_info (_("connection to agent is in restricted mode\n"));
498               err = 0;
499             }
500         }
501     }
502   if (err)
503     {
504       assuan_release (ctx);
505       return err;
506     }
507
508   *r_ctx = ctx;
509   return 0;
510 }
511
512
513 /* Try to connect to the dirmngr via a socket.  On platforms
514    supporting it, start it up if needed and if AUTOSTART is true.
515    Returns a new assuan context at R_CTX or an error code. */
516 gpg_error_t
517 start_new_dirmngr (assuan_context_t *r_ctx,
518                    gpg_err_source_t errsource,
519                    const char *dirmngr_program,
520                    int autostart,
521                    int verbose, int debug,
522                    gpg_error_t (*status_cb)(ctrl_t, int, ...),
523                    ctrl_t status_cb_arg)
524 {
525   gpg_error_t err;
526   assuan_context_t ctx;
527   const char *sockname;
528   int did_success_msg = 0;
529
530   *r_ctx = NULL;
531
532   err = assuan_new (&ctx);
533   if (err)
534     {
535       log_error ("error allocating assuan context: %s\n", gpg_strerror (err));
536       return err;
537     }
538
539   sockname = dirmngr_socket_name ();
540   err = assuan_socket_connect (ctx, sockname, 0, 0);
541
542 #ifdef USE_DIRMNGR_AUTO_START
543   if (err && autostart)
544     {
545       lock_spawn_t lock;
546       const char *argv[4];
547       char *abs_homedir;
548
549       /* No connection: Try start a new Dirmngr.  */
550       if (!dirmngr_program || !*dirmngr_program)
551         dirmngr_program = gnupg_module_name (GNUPG_MODULE_NAME_DIRMNGR);
552
553       if (verbose)
554         log_info (_("no running Dirmngr - starting '%s'\n"),
555                   dirmngr_program);
556
557       if (status_cb)
558         status_cb (status_cb_arg, STATUS_PROGRESS,
559                    "starting_dirmngr ? 0 0", NULL);
560
561       abs_homedir = make_absfilename (gnupg_homedir (), NULL);
562       if (!abs_homedir)
563         {
564           gpg_error_t tmperr = gpg_err_make (errsource,
565                                              gpg_err_code_from_syserror ());
566           log_error ("error building filename: %s\n",gpg_strerror (tmperr));
567           assuan_release (ctx);
568           return tmperr;
569         }
570
571       if (fflush (NULL))
572         {
573           gpg_error_t tmperr = gpg_err_make (errsource,
574                                              gpg_err_code_from_syserror ());
575           log_error ("error flushing pending output: %s\n",
576                      strerror (errno));
577           assuan_release (ctx);
578           return tmperr;
579         }
580
581       argv[0] = "--daemon";
582       /* Try starting the daemon.  Versions of dirmngr < 2.1.15 do
583        * this only if the home directory is given on the command line.  */
584       argv[1] = "--homedir";
585       argv[2] = abs_homedir;
586       argv[3] = NULL;
587
588       if (!(err = lock_spawning (&lock, gnupg_homedir (), "dirmngr", verbose))
589           && assuan_socket_connect (ctx, sockname, 0, 0))
590         {
591           err = gnupg_spawn_process_detached (dirmngr_program, argv, NULL);
592           if (err)
593             log_error ("failed to start the dirmngr '%s': %s\n",
594                        dirmngr_program, gpg_strerror (err));
595           else
596             err = wait_for_sock (SECS_TO_WAIT_FOR_DIRMNGR, "dirmngr",
597                                  sockname, verbose, ctx, &did_success_msg);
598         }
599
600       unlock_spawning (&lock, "dirmngr");
601       xfree (abs_homedir);
602     }
603 #else
604   (void)dirmngr_program;
605   (void)verbose;
606   (void)status_cb;
607   (void)status_cb_arg;
608 #endif /*USE_DIRMNGR_AUTO_START*/
609
610   if (err)
611     {
612       if (autostart || gpg_err_code (err) != GPG_ERR_ASS_CONNECT_FAILED)
613         log_error ("connecting dirmngr at '%s' failed: %s\n",
614                    sockname, gpg_strerror (err));
615       assuan_release (ctx);
616       return gpg_err_make (errsource, GPG_ERR_NO_DIRMNGR);
617     }
618
619   if (debug && !did_success_msg)
620     log_debug ("connection to the dirmngr established\n");
621
622   *r_ctx = ctx;
623   return 0;
624 }
625
626
627 /* Return the version of a server using "GETINFO version".  On success
628    0 is returned and R_VERSION receives a malloced string with the
629    version which must be freed by the caller.  On error NULL is stored
630    at R_VERSION and an error code returned.  Mode is in general 0 but
631    certain values may be used to modify the used version command:
632
633       MODE == 0 = Use "GETINFO version"
634       MODE == 2 - Use "SCD GETINFO version"
635  */
636 gpg_error_t
637 get_assuan_server_version (assuan_context_t ctx, int mode, char **r_version)
638 {
639   gpg_error_t err;
640   membuf_t data;
641
642   init_membuf (&data, 64);
643   err = assuan_transact (ctx,
644                          mode == 2? "SCD GETINFO version"
645                          /**/     : "GETINFO version",
646                          put_membuf_cb, &data,
647                          NULL, NULL, NULL, NULL);
648   if (err)
649     {
650       xfree (get_membuf (&data, NULL));
651       *r_version = NULL;
652     }
653   else
654     {
655       put_membuf (&data, "", 1);
656       *r_version = get_membuf (&data, NULL);
657       if (!*r_version)
658         err = gpg_error_from_syserror ();
659     }
660   return err;
661 }