agent: Implement --supervised command (for systemd, etc).
[gnupg.git] / agent / gpg-agent.c
1 /* gpg-agent.c  -  The GnuPG Agent
2  * Copyright (C) 2000-2007, 2009-2010 Free Software Foundation, Inc.
3  * Copyright (C) 2000-2016 Werner Koch
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #include <config.h>
22
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <stddef.h>
26 #include <stdarg.h>
27 #include <string.h>
28 #include <errno.h>
29 #include <assert.h>
30 #include <time.h>
31 #include <fcntl.h>
32 #include <sys/stat.h>
33 #ifdef HAVE_W32_SYSTEM
34 # ifndef WINVER
35 #  define WINVER 0x0500  /* Same as in common/sysutils.c */
36 # endif
37 # ifdef HAVE_WINSOCK2_H
38 #  include <winsock2.h>
39 # endif
40 # include <aclapi.h>
41 # include <sddl.h>
42 #else /*!HAVE_W32_SYSTEM*/
43 # include <sys/socket.h>
44 # include <sys/un.h>
45 #endif /*!HAVE_W32_SYSTEM*/
46 #include <unistd.h>
47 #ifdef HAVE_SIGNAL_H
48 # include <signal.h>
49 #endif
50 #ifdef HAVE_INOTIFY_INIT
51 # include <sys/inotify.h>
52 #endif /*HAVE_INOTIFY_INIT*/
53 #include <npth.h>
54
55 #define GNUPG_COMMON_NEED_AFLOCAL
56 #include "agent.h"
57 #include <assuan.h> /* Malloc hooks  and socket wrappers. */
58
59 #include "i18n.h"
60 #include "sysutils.h"
61 #include "gc-opt-flags.h"
62 #include "exechelp.h"
63 #include "asshelp.h"
64 #include "../common/init.h"
65
66
67 enum cmd_and_opt_values
68 { aNull = 0,
69   oCsh            = 'c',
70   oQuiet          = 'q',
71   oSh             = 's',
72   oVerbose        = 'v',
73
74   oNoVerbose = 500,
75   aGPGConfList,
76   aGPGConfTest,
77   aUseStandardSocketP,
78   oOptions,
79   oDebug,
80   oDebugAll,
81   oDebugLevel,
82   oDebugWait,
83   oDebugQuickRandom,
84   oDebugPinentry,
85   oNoGreeting,
86   oNoOptions,
87   oHomedir,
88   oNoDetach,
89   oNoGrab,
90   oLogFile,
91   oServer,
92   oDaemon,
93   oSupervised,
94   oBatch,
95
96   oPinentryProgram,
97   oPinentryTouchFile,
98   oPinentryInvisibleChar,
99   oPinentryTimeout,
100   oDisplay,
101   oTTYname,
102   oTTYtype,
103   oLCctype,
104   oLCmessages,
105   oXauthority,
106   oScdaemonProgram,
107   oDefCacheTTL,
108   oDefCacheTTLSSH,
109   oMaxCacheTTL,
110   oMaxCacheTTLSSH,
111   oEnforcePassphraseConstraints,
112   oMinPassphraseLen,
113   oMinPassphraseNonalpha,
114   oCheckPassphrasePattern,
115   oMaxPassphraseDays,
116   oEnablePassphraseHistory,
117   oUseStandardSocket,
118   oNoUseStandardSocket,
119   oExtraSocket,
120   oBrowserSocket,
121   oFakedSystemTime,
122
123   oIgnoreCacheForSigning,
124   oAllowMarkTrusted,
125   oNoAllowMarkTrusted,
126   oAllowPresetPassphrase,
127   oAllowLoopbackPinentry,
128   oNoAllowLoopbackPinentry,
129   oNoAllowExternalCache,
130   oAllowEmacsPinentry,
131   oKeepTTY,
132   oKeepDISPLAY,
133   oSSHSupport,
134   oPuttySupport,
135   oDisableScdaemon,
136   oDisableCheckOwnSocket,
137   oWriteEnvFile
138 };
139
140
141 #ifndef ENAMETOOLONG
142 # define ENAMETOOLONG EINVAL
143 #endif
144
145
146 static ARGPARSE_OPTS opts[] = {
147
148   ARGPARSE_c (aGPGConfList, "gpgconf-list", "@"),
149   ARGPARSE_c (aGPGConfTest, "gpgconf-test", "@"),
150   ARGPARSE_c (aUseStandardSocketP, "use-standard-socket-p", "@"),
151
152   ARGPARSE_group (301, N_("@Options:\n ")),
153
154   ARGPARSE_s_n (oDaemon,  "daemon", N_("run in daemon mode (background)")),
155   ARGPARSE_s_n (oServer,  "server", N_("run in server mode (foreground)")),
156   ARGPARSE_s_n (oSupervised,  "supervised", N_("run supervised (e.g., systemd)")),
157   ARGPARSE_s_n (oVerbose, "verbose", N_("verbose")),
158   ARGPARSE_s_n (oQuiet,   "quiet",     N_("be somewhat more quiet")),
159   ARGPARSE_s_n (oSh,      "sh",        N_("sh-style command output")),
160   ARGPARSE_s_n (oCsh,     "csh",       N_("csh-style command output")),
161   ARGPARSE_s_s (oOptions, "options", N_("|FILE|read options from FILE")),
162
163   ARGPARSE_s_s (oDebug,      "debug",       "@"),
164   ARGPARSE_s_n (oDebugAll,   "debug-all",   "@"),
165   ARGPARSE_s_s (oDebugLevel, "debug-level", "@"),
166   ARGPARSE_s_i (oDebugWait,"  debug-wait",  "@"),
167   ARGPARSE_s_n (oDebugQuickRandom, "debug-quick-random", "@"),
168   ARGPARSE_s_n (oDebugPinentry, "debug-pinentry", "@"),
169
170   ARGPARSE_s_n (oNoDetach,  "no-detach", N_("do not detach from the console")),
171   ARGPARSE_s_n (oNoGrab,    "no-grab",   N_("do not grab keyboard and mouse")),
172   ARGPARSE_s_s (oLogFile,   "log-file",  N_("use a log file for the server")),
173   ARGPARSE_s_s (oPinentryProgram, "pinentry-program",
174                 /* */             N_("|PGM|use PGM as the PIN-Entry program")),
175   ARGPARSE_s_s (oPinentryTouchFile, "pinentry-touch-file", "@"),
176   ARGPARSE_s_s (oPinentryInvisibleChar, "pinentry-invisible-char", "@"),
177   ARGPARSE_s_u (oPinentryTimeout, "pinentry-timeout", "@"),
178   ARGPARSE_s_s (oScdaemonProgram, "scdaemon-program",
179                 /* */             N_("|PGM|use PGM as the SCdaemon program") ),
180   ARGPARSE_s_n (oDisableScdaemon, "disable-scdaemon",
181                 /* */             N_("do not use the SCdaemon") ),
182   ARGPARSE_s_n (oDisableCheckOwnSocket, "disable-check-own-socket", "@"),
183
184   ARGPARSE_s_s (oExtraSocket, "extra-socket",
185                 /* */       N_("|NAME|accept some commands via NAME")),
186
187   ARGPARSE_s_s (oBrowserSocket, "browser-socket", "@"),
188
189   ARGPARSE_s_s (oFakedSystemTime, "faked-system-time", "@"),
190
191   ARGPARSE_s_n (oBatch,      "batch",        "@"),
192   ARGPARSE_s_s (oHomedir,    "homedir",      "@"),
193
194   ARGPARSE_s_s (oDisplay,    "display",     "@"),
195   ARGPARSE_s_s (oTTYname,    "ttyname",     "@"),
196   ARGPARSE_s_s (oTTYtype,    "ttytype",     "@"),
197   ARGPARSE_s_s (oLCctype,    "lc-ctype",    "@"),
198   ARGPARSE_s_s (oLCmessages, "lc-messages", "@"),
199   ARGPARSE_s_s (oXauthority, "xauthority",  "@"),
200   ARGPARSE_s_n (oKeepTTY,    "keep-tty",
201                 /* */        N_("ignore requests to change the TTY")),
202   ARGPARSE_s_n (oKeepDISPLAY, "keep-display",
203                 /* */        N_("ignore requests to change the X display")),
204
205   ARGPARSE_s_u (oDefCacheTTL,    "default-cache-ttl",
206                                  N_("|N|expire cached PINs after N seconds")),
207   ARGPARSE_s_u (oDefCacheTTLSSH, "default-cache-ttl-ssh", "@" ),
208   ARGPARSE_s_u (oMaxCacheTTL,    "max-cache-ttl",         "@" ),
209   ARGPARSE_s_u (oMaxCacheTTLSSH, "max-cache-ttl-ssh",     "@" ),
210
211   ARGPARSE_s_n (oEnforcePassphraseConstraints, "enforce-passphrase-constraints",
212                 /* */                          "@"),
213   ARGPARSE_s_u (oMinPassphraseLen,        "min-passphrase-len", "@"),
214   ARGPARSE_s_u (oMinPassphraseNonalpha,   "min-passphrase-nonalpha", "@"),
215   ARGPARSE_s_s (oCheckPassphrasePattern,  "check-passphrase-pattern", "@"),
216   ARGPARSE_s_u (oMaxPassphraseDays,       "max-passphrase-days", "@"),
217   ARGPARSE_s_n (oEnablePassphraseHistory, "enable-passphrase-history", "@"),
218
219   ARGPARSE_s_n (oIgnoreCacheForSigning, "ignore-cache-for-signing",
220                 /* */    N_("do not use the PIN cache when signing")),
221   ARGPARSE_s_n (oNoAllowExternalCache,  "no-allow-external-cache",
222                 /* */    N_("disallow the use of an external password cache")),
223   ARGPARSE_s_n (oNoAllowMarkTrusted, "no-allow-mark-trusted",
224                 /* */    N_("disallow clients to mark keys as \"trusted\"")),
225   ARGPARSE_s_n (oAllowMarkTrusted,   "allow-mark-trusted", "@"),
226   ARGPARSE_s_n (oAllowPresetPassphrase, "allow-preset-passphrase",
227                 /* */                    N_("allow presetting passphrase")),
228   ARGPARSE_s_n (oNoAllowLoopbackPinentry, "no-allow-loopback-pinentry",
229                                 N_("disallow caller to override the pinentry")),
230   ARGPARSE_s_n (oAllowLoopbackPinentry, "allow-loopback-pinentry", "@"),
231   ARGPARSE_s_n (oAllowEmacsPinentry,  "allow-emacs-pinentry",
232                 /* */    N_("allow passphrase to be prompted through Emacs")),
233
234   ARGPARSE_s_n (oSSHSupport,   "enable-ssh-support", N_("enable ssh support")),
235   ARGPARSE_s_n (oPuttySupport, "enable-putty-support",
236 #ifdef HAVE_W32_SYSTEM
237                 /* */           N_("enable putty support")
238 #else
239                 /* */           "@"
240 #endif
241                 ),
242
243   /* Dummy options for backward compatibility.  */
244   ARGPARSE_o_s (oWriteEnvFile, "write-env-file", "@"),
245   ARGPARSE_s_n (oUseStandardSocket, "use-standard-socket", "@"),
246   ARGPARSE_s_n (oNoUseStandardSocket, "no-use-standard-socket", "@"),
247
248   {0} /* End of list */
249 };
250
251
252 /* The list of supported debug flags.  */
253 static struct debug_flags_s debug_flags [] =
254   {
255     { DBG_COMMAND_VALUE, "command"  },
256     { DBG_MPI_VALUE    , "mpi"     },
257     { DBG_CRYPTO_VALUE , "crypto"  },
258     { DBG_MEMORY_VALUE , "memory"  },
259     { DBG_CACHE_VALUE  , "cache"   },
260     { DBG_MEMSTAT_VALUE, "memstat" },
261     { DBG_HASHING_VALUE, "hashing" },
262     { DBG_IPC_VALUE    , "ipc"     },
263     { 77, NULL } /* 77 := Do not exit on "help" or "?".  */
264   };
265
266
267
268 #define DEFAULT_CACHE_TTL     (10*60)  /* 10 minutes */
269 #define DEFAULT_CACHE_TTL_SSH (30*60)  /* 30 minutes */
270 #define MAX_CACHE_TTL         (120*60) /* 2 hours */
271 #define MAX_CACHE_TTL_SSH     (120*60) /* 2 hours */
272 #define MIN_PASSPHRASE_LEN    (8)
273 #define MIN_PASSPHRASE_NONALPHA (1)
274 #define MAX_PASSPHRASE_DAYS   (0)
275
276 /* The timer tick used for housekeeping stuff.  For Windows we use a
277    longer period as the SetWaitableTimer seems to signal earlier than
278    the 2 seconds.  CHECK_OWN_SOCKET_INTERVAL defines how often we
279    check our own socket in standard socket mode.  If that value is 0
280    we don't check at all.   All values are in seconds. */
281 #if defined(HAVE_W32CE_SYSTEM)
282 # define TIMERTICK_INTERVAL         (60)
283 # define CHECK_OWN_SOCKET_INTERVAL   (0)  /* Never */
284 #elif defined(HAVE_W32_SYSTEM)
285 # define TIMERTICK_INTERVAL          (4)
286 # define CHECK_OWN_SOCKET_INTERVAL  (60)
287 #else
288 # define TIMERTICK_INTERVAL          (2)
289 # define CHECK_OWN_SOCKET_INTERVAL  (60)
290 #endif
291
292
293 /* Flag indicating that the ssh-agent subsystem has been enabled.  */
294 static int ssh_support;
295
296 #ifdef HAVE_W32_SYSTEM
297 /* Flag indicating that support for Putty has been enabled.  */
298 static int putty_support;
299 /* A magic value used with WM_COPYDATA.  */
300 #define PUTTY_IPC_MAGIC 0x804e50ba
301 /* To avoid surprises we limit the size of the mapped IPC file to this
302    value.  Putty currently (0.62) uses 8k, thus 16k should be enough
303    for the foreseeable future.  */
304 #define PUTTY_IPC_MAXLEN 16384
305 #endif /*HAVE_W32_SYSTEM*/
306
307 /* The list of open file descriptors at startup.  Note that this list
308    has been allocated using the standard malloc.  */
309 static int *startup_fd_list;
310
311 /* The signal mask at startup and a flag telling whether it is valid.  */
312 #ifdef HAVE_SIGPROCMASK
313 static sigset_t startup_signal_mask;
314 static int startup_signal_mask_valid;
315 #endif
316
317 /* Flag to indicate that a shutdown was requested.  */
318 static int shutdown_pending;
319
320 /* Counter for the currently running own socket checks.  */
321 static int check_own_socket_running;
322
323 /* Flags to indicate that check_own_socket shall not be called.  */
324 static int disable_check_own_socket;
325
326 /* It is possible that we are currently running under setuid permissions */
327 static int maybe_setuid = 1;
328
329 /* Name of the communication socket used for native gpg-agent
330    requests. The second variable is either NULL or a malloced string
331    with the real socket name in case it has been redirected.  */
332 static char *socket_name;
333 static char *redir_socket_name;
334
335 /* Name of the optional extra socket used for native gpg-agent requests.  */
336 static char *socket_name_extra;
337 static char *redir_socket_name_extra;
338
339 /* Name of the optional browser socket used for native gpg-agent requests.  */
340 static char *socket_name_browser;
341 static char *redir_socket_name_browser;
342
343 /* Name of the communication socket used for ssh-agent-emulation.  */
344 static char *socket_name_ssh;
345 static char *redir_socket_name_ssh;
346
347 /* We need to keep track of the server's nonces (these are dummies for
348    POSIX systems). */
349 static assuan_sock_nonce_t socket_nonce;
350 static assuan_sock_nonce_t socket_nonce_extra;
351 static assuan_sock_nonce_t socket_nonce_browser;
352 static assuan_sock_nonce_t socket_nonce_ssh;
353
354
355 /* Default values for options passed to the pinentry. */
356 static char *default_display;
357 static char *default_ttyname;
358 static char *default_ttytype;
359 static char *default_lc_ctype;
360 static char *default_lc_messages;
361 static char *default_xauthority;
362
363 /* Name of a config file, which will be reread on a HUP if it is not NULL. */
364 static char *config_filename;
365
366 /* Helper to implement --debug-level */
367 static const char *debug_level;
368
369 /* Keep track of the current log file so that we can avoid updating
370    the log file after a SIGHUP if it didn't changed. Malloced. */
371 static char *current_logfile;
372
373 /* The handle_tick() function may test whether a parent is still
374    running.  We record the PID of the parent here or -1 if it should be
375    watched. */
376 static pid_t parent_pid = (pid_t)(-1);
377
378 /* Number of active connections.  */
379 static int active_connections;
380
381 /* This object is used to dispatch progress messages from Libgcrypt to
382  * the right thread.  Given that we won't have at max a few dozen
383  * connections at the same time using a linked list is the easiest way
384  * to handle this. */
385 struct progress_dispatch_s
386 {
387   struct progress_dispatch_s *next;
388   /* The control object of the connection.  If this is NULL no
389    * connection is associated with this item and it is free for reuse
390    * by new connections.  */
391   ctrl_t ctrl;
392
393   /* The thread id of (npth_self) of the connection.  */
394   npth_t tid;
395
396   /* The callback set by the connection.  This is similar to the
397    * Libgcrypt callback but with the control object passed as the
398    * first argument.  */
399   void (*cb)(ctrl_t ctrl,
400              const char *what, int printchar,
401              int current, int total);
402 };
403 struct progress_dispatch_s *progress_dispatch_list;
404
405
406
407 \f
408 /*
409    Local prototypes.
410  */
411
412 static char *create_socket_name (char *standard_name, int with_homedir);
413 static gnupg_fd_t create_server_socket (char *name, int primary, int cygwin,
414                                         char **r_redir_name,
415                                         assuan_sock_nonce_t *nonce);
416 static void create_directories (void);
417
418 static void agent_libgcrypt_progress_cb (void *data, const char *what,
419                                          int printchar,
420                                          int current, int total);
421 static void agent_init_default_ctrl (ctrl_t ctrl);
422 static void agent_deinit_default_ctrl (ctrl_t ctrl);
423
424 static void handle_connections (gnupg_fd_t listen_fd,
425                                 gnupg_fd_t listen_fd_extra,
426                                 gnupg_fd_t listen_fd_browser,
427                                 gnupg_fd_t listen_fd_ssh);
428 static void check_own_socket (void);
429 static int check_for_running_agent (int silent);
430
431 /* Pth wrapper function definitions. */
432 ASSUAN_SYSTEM_NPTH_IMPL;
433
434 \f
435 /*
436    Functions.
437  */
438
439 /* Allocate a string describing a library version by calling a GETFNC.
440    This function is expected to be called only once.  GETFNC is
441    expected to have a semantic like gcry_check_version ().  */
442 static char *
443 make_libversion (const char *libname, const char *(*getfnc)(const char*))
444 {
445   const char *s;
446   char *result;
447
448   if (maybe_setuid)
449     {
450       gcry_control (GCRYCTL_INIT_SECMEM, 0, 0);  /* Drop setuid. */
451       maybe_setuid = 0;
452     }
453   s = getfnc (NULL);
454   result = xmalloc (strlen (libname) + 1 + strlen (s) + 1);
455   strcpy (stpcpy (stpcpy (result, libname), " "), s);
456   return result;
457 }
458
459 /* Return strings describing this program.  The case values are
460    described in common/argparse.c:strusage.  The values here override
461    the default values given by strusage.  */
462 static const char *
463 my_strusage (int level)
464 {
465   static char *ver_gcry;
466   const char *p;
467
468   switch (level)
469     {
470     case 11: p = "@GPG_AGENT@ (@GNUPG@)";
471       break;
472     case 13: p = VERSION; break;
473     case 17: p = PRINTABLE_OS_NAME; break;
474       /* TRANSLATORS: @EMAIL@ will get replaced by the actual bug
475          reporting address.  This is so that we can change the
476          reporting address without breaking the translations.  */
477     case 19: p = _("Please report bugs to <@EMAIL@>.\n"); break;
478
479     case 20:
480       if (!ver_gcry)
481         ver_gcry = make_libversion ("libgcrypt", gcry_check_version);
482       p = ver_gcry;
483       break;
484
485     case 1:
486     case 40: p =  _("Usage: @GPG_AGENT@ [options] (-h for help)");
487       break;
488     case 41: p =  _("Syntax: @GPG_AGENT@ [options] [command [args]]\n"
489                     "Secret key management for @GNUPG@\n");
490     break;
491
492     default: p = NULL;
493     }
494   return p;
495 }
496
497
498
499 /* Setup the debugging.  With the global variable DEBUG_LEVEL set to NULL
500    only the active debug flags are propagated to the subsystems.  With
501    DEBUG_LEVEL set, a specific set of debug flags is set; thus overriding
502    all flags already set. Note that we don't fail here, because it is
503    important to keep gpg-agent running even after re-reading the
504    options due to a SIGHUP. */
505 static void
506 set_debug (void)
507 {
508   int numok = (debug_level && digitp (debug_level));
509   int numlvl = numok? atoi (debug_level) : 0;
510
511   if (!debug_level)
512     ;
513   else if (!strcmp (debug_level, "none") || (numok && numlvl < 1))
514     opt.debug = 0;
515   else if (!strcmp (debug_level, "basic") || (numok && numlvl <= 2))
516     opt.debug = DBG_IPC_VALUE;
517   else if (!strcmp (debug_level, "advanced") || (numok && numlvl <= 5))
518     opt.debug = DBG_IPC_VALUE|DBG_COMMAND_VALUE;
519   else if (!strcmp (debug_level, "expert") || (numok && numlvl <= 8))
520     opt.debug = (DBG_IPC_VALUE|DBG_COMMAND_VALUE
521                  |DBG_CACHE_VALUE);
522   else if (!strcmp (debug_level, "guru") || numok)
523     {
524       opt.debug = ~0;
525       /* Unless the "guru" string has been used we don't want to allow
526          hashing debugging.  The rationale is that people tend to
527          select the highest debug value and would then clutter their
528          disk with debug files which may reveal confidential data.  */
529       if (numok)
530         opt.debug &= ~(DBG_HASHING_VALUE);
531     }
532   else
533     {
534       log_error (_("invalid debug-level '%s' given\n"), debug_level);
535       opt.debug = 0; /* Reset debugging, so that prior debug
536                         statements won't have an undesired effect. */
537     }
538
539   if (opt.debug && !opt.verbose)
540     opt.verbose = 1;
541   if (opt.debug && opt.quiet)
542     opt.quiet = 0;
543
544   if (opt.debug & DBG_MPI_VALUE)
545     gcry_control (GCRYCTL_SET_DEBUG_FLAGS, 2);
546   if (opt.debug & DBG_CRYPTO_VALUE )
547     gcry_control (GCRYCTL_SET_DEBUG_FLAGS, 1);
548   gcry_control (GCRYCTL_SET_VERBOSITY, (int)opt.verbose);
549
550   if (opt.debug)
551     parse_debug_flag (NULL, &opt.debug, debug_flags);
552 }
553
554
555 /* Helper for cleanup to remove one socket with NAME.  REDIR_NAME is
556    the corresponding real name if the socket has been redirected.  */
557 static void
558 remove_socket (char *name, char *redir_name)
559 {
560   if (name && *name)
561     {
562       if (redir_name)
563         name = redir_name;
564
565       gnupg_remove (name);
566       *name = 0;
567     }
568 }
569
570
571 /* Cleanup code for this program.  This is either called has an atexit
572    handler or directly.  */
573 static void
574 cleanup (void)
575 {
576   static int done;
577
578   if (done)
579     return;
580   done = 1;
581   deinitialize_module_cache ();
582   remove_socket (socket_name, redir_socket_name);
583   if (opt.extra_socket > 1)
584     remove_socket (socket_name_extra, redir_socket_name_extra);
585   if (opt.browser_socket > 1)
586     remove_socket (socket_name_browser, redir_socket_name_browser);
587   remove_socket (socket_name_ssh, redir_socket_name_ssh);
588 }
589
590
591
592 /* Handle options which are allowed to be reset after program start.
593    Return true when the current option in PARGS could be handled and
594    false if not.  As a special feature, passing a value of NULL for
595    PARGS, resets the options to the default.  REREAD should be set
596    true if it is not the initial option parsing. */
597 static int
598 parse_rereadable_options (ARGPARSE_ARGS *pargs, int reread)
599 {
600   if (!pargs)
601     { /* reset mode */
602       opt.quiet = 0;
603       opt.verbose = 0;
604       opt.debug = 0;
605       opt.no_grab = 0;
606       opt.debug_pinentry = 0;
607       opt.pinentry_program = NULL;
608       opt.pinentry_touch_file = NULL;
609       xfree (opt.pinentry_invisible_char);
610       opt.pinentry_invisible_char = NULL;
611       opt.pinentry_timeout = 0;
612       opt.scdaemon_program = NULL;
613       opt.def_cache_ttl = DEFAULT_CACHE_TTL;
614       opt.def_cache_ttl_ssh = DEFAULT_CACHE_TTL_SSH;
615       opt.max_cache_ttl = MAX_CACHE_TTL;
616       opt.max_cache_ttl_ssh = MAX_CACHE_TTL_SSH;
617       opt.enforce_passphrase_constraints = 0;
618       opt.min_passphrase_len = MIN_PASSPHRASE_LEN;
619       opt.min_passphrase_nonalpha = MIN_PASSPHRASE_NONALPHA;
620       opt.check_passphrase_pattern = NULL;
621       opt.max_passphrase_days = MAX_PASSPHRASE_DAYS;
622       opt.enable_passhrase_history = 0;
623       opt.ignore_cache_for_signing = 0;
624       opt.allow_mark_trusted = 1;
625       opt.allow_external_cache = 1;
626       opt.allow_loopback_pinentry = 1;
627       opt.allow_emacs_pinentry = 0;
628       opt.disable_scdaemon = 0;
629       disable_check_own_socket = 0;
630       return 1;
631     }
632
633   switch (pargs->r_opt)
634     {
635     case oQuiet: opt.quiet = 1; break;
636     case oVerbose: opt.verbose++; break;
637
638     case oDebug:
639       parse_debug_flag (pargs->r.ret_str, &opt.debug, debug_flags);
640       break;
641     case oDebugAll: opt.debug = ~0; break;
642     case oDebugLevel: debug_level = pargs->r.ret_str; break;
643     case oDebugPinentry: opt.debug_pinentry = 1; break;
644
645     case oLogFile:
646       if (!reread)
647         return 0; /* not handeld */
648       if (!current_logfile || !pargs->r.ret_str
649           || strcmp (current_logfile, pargs->r.ret_str))
650         {
651           log_set_file (pargs->r.ret_str);
652           xfree (current_logfile);
653           current_logfile = xtrystrdup (pargs->r.ret_str);
654         }
655       break;
656
657     case oNoGrab: opt.no_grab = 1; break;
658
659     case oPinentryProgram: opt.pinentry_program = pargs->r.ret_str; break;
660     case oPinentryTouchFile: opt.pinentry_touch_file = pargs->r.ret_str; break;
661     case oPinentryInvisibleChar:
662       xfree (opt.pinentry_invisible_char);
663       opt.pinentry_invisible_char = xtrystrdup (pargs->r.ret_str); break;
664       break;
665     case oPinentryTimeout: opt.pinentry_timeout = pargs->r.ret_ulong; break;
666     case oScdaemonProgram: opt.scdaemon_program = pargs->r.ret_str; break;
667     case oDisableScdaemon: opt.disable_scdaemon = 1; break;
668     case oDisableCheckOwnSocket: disable_check_own_socket = 1; break;
669
670     case oDefCacheTTL: opt.def_cache_ttl = pargs->r.ret_ulong; break;
671     case oDefCacheTTLSSH: opt.def_cache_ttl_ssh = pargs->r.ret_ulong; break;
672     case oMaxCacheTTL: opt.max_cache_ttl = pargs->r.ret_ulong; break;
673     case oMaxCacheTTLSSH: opt.max_cache_ttl_ssh = pargs->r.ret_ulong; break;
674
675     case oEnforcePassphraseConstraints:
676       opt.enforce_passphrase_constraints=1;
677       break;
678     case oMinPassphraseLen: opt.min_passphrase_len = pargs->r.ret_ulong; break;
679     case oMinPassphraseNonalpha:
680       opt.min_passphrase_nonalpha = pargs->r.ret_ulong;
681       break;
682     case oCheckPassphrasePattern:
683       opt.check_passphrase_pattern = pargs->r.ret_str;
684       break;
685     case oMaxPassphraseDays:
686       opt.max_passphrase_days = pargs->r.ret_ulong;
687       break;
688     case oEnablePassphraseHistory:
689       opt.enable_passhrase_history = 1;
690       break;
691
692     case oIgnoreCacheForSigning: opt.ignore_cache_for_signing = 1; break;
693
694     case oAllowMarkTrusted: opt.allow_mark_trusted = 1; break;
695     case oNoAllowMarkTrusted: opt.allow_mark_trusted = 0; break;
696
697     case oAllowPresetPassphrase: opt.allow_preset_passphrase = 1; break;
698
699     case oAllowLoopbackPinentry: opt.allow_loopback_pinentry = 1; break;
700     case oNoAllowLoopbackPinentry: opt.allow_loopback_pinentry = 0; break;
701
702     case oNoAllowExternalCache: opt.allow_external_cache = 0;
703       break;
704
705     case oAllowEmacsPinentry: opt.allow_emacs_pinentry = 1;
706       break;
707
708     default:
709       return 0; /* not handled */
710     }
711
712   return 1; /* handled */
713 }
714
715
716 /* Fixup some options after all have been processed.  */
717 static void
718 finalize_rereadable_options (void)
719 {
720 }
721
722
723 static void
724 thread_init_once (void)
725 {
726   static int npth_initialized = 0;
727
728   if (!npth_initialized)
729     {
730       npth_initialized++;
731       npth_init ();
732     }
733 }
734
735
736 static void
737 initialize_modules (void)
738 {
739   thread_init_once ();
740   assuan_set_system_hooks (ASSUAN_SYSTEM_NPTH);
741   initialize_module_cache ();
742   initialize_module_call_pinentry ();
743   initialize_module_call_scd ();
744   initialize_module_trustlist ();
745 }
746
747
748 /* return a malloc'ed string that is the path to the passed unix-domain socket
749    (or return NULL if this is not a valid unix-domain socket) */
750 static char *
751 get_socket_path (gnupg_fd_t fd)
752 {
753 #ifdef HAVE_W32_SYSTEM
754   return NULL;
755 #else
756   struct sockaddr_un un;
757   socklen_t len = sizeof(un);
758   char *ret = NULL;
759
760   if (fd == GNUPG_INVALID_FD)
761     return NULL;
762
763   if (getsockname (fd, (struct sockaddr*)&un, &len) != 0)
764     log_error ("could not getsockname(%d) -- error %d (%s)\n", fd,
765                errno, strerror(errno));
766   else if (un.sun_family != AF_UNIX)
767     log_error ("file descriptor %d is not a unix-domain socket\n", fd);
768   else if (len <= offsetof (struct sockaddr_un, sun_path))
769     log_error ("socket path not present for file descriptor %d\n", fd);
770   else if (len > sizeof(un))
771     log_error ("socket path for file descriptor %d was truncated "
772                "(passed %lu bytes, wanted %u)\n", fd, sizeof(un), len);
773   else
774     {
775       log_debug ("file descriptor %d has path %s (%lu octets)\n", fd,
776                  un.sun_path, len - offsetof (struct sockaddr_un, sun_path));
777       ret = malloc(len - offsetof (struct sockaddr_un, sun_path));
778       if (ret == NULL)
779         log_error ("failed to allocate memory for path to file "
780                    "descriptor %d\n", fd);
781       else
782         memcpy (ret, un.sun_path, len);
783     }
784   return ret;
785 #endif /* HAVE_W32_SYSTEM */
786 }
787
788
789 /* Discover which inherited file descriptors correspond to which
790    services/sockets offered by gpg-agent, using the LISTEN_FDS and
791    LISTEN_FDNAMES convention.  The understood labels are "ssh",
792    "extra", and "browser".  Any other label will be interpreted as the
793    standard socket.
794
795    This function is designed to log errors when the expected file
796    descriptors don't make sense, but to do its best to continue to
797    work even in the face of minor misconfigurations.
798
799    For more information on the LISTEN_FDS convention, see
800    sd_listen_fds(3).
801  */
802 static void
803 map_supervised_sockets (gnupg_fd_t *fd,
804                         gnupg_fd_t *fd_extra,
805                         gnupg_fd_t *fd_browser,
806                         gnupg_fd_t *fd_ssh)
807 {
808   const char *listen_pid = NULL;
809   const char *listen_fds = NULL;
810   const char *listen_fdnames = NULL;
811   int listen_fd_count = -1;
812   int listen_fdnames_colons = 0;
813   const char *fdnamep = NULL;
814
815   listen_pid = getenv ("LISTEN_PID");
816   listen_fds = getenv ("LISTEN_FDS");
817   listen_fdnames = getenv ("LISTEN_FDNAMES");
818
819   if (!listen_pid)
820     log_error ("no $LISTEN_PID environment variable found in "
821                "--supervised mode (ignoring).\n");
822   else if (atoi (listen_pid) != getpid ())
823     log_error ("$LISTEN_PID (%d) does not match process ID (%d) "
824                "in --supervised mode (ignoring).\n",
825                atoi (listen_pid), getpid ());
826   else
827     log_debug ("$LISTEN_PID matches process ID (%d)\n",
828                getpid());
829
830   if (listen_fdnames)
831     for (fdnamep = listen_fdnames; *fdnamep; fdnamep++)
832       if (*fdnamep == ':')
833         listen_fdnames_colons++;
834   log_debug ("%d colon(s) in $LISTEN_FDNAMES: (%s)\n", listen_fdnames_colons, listen_fdnames);
835
836   if (!listen_fds)
837     {
838       if (!listen_fdnames)
839         {
840           log_error ("no LISTEN_FDS or LISTEN_FDNAMES environment variables "
841                      "found in --supervised mode (assuming 1 active descriptor).\n");
842           listen_fd_count = 1;
843         }
844       else
845         {
846           log_error ("no LISTEN_FDS environment variable found in --supervised "
847                      " mode (relying on colons in LISTEN_FDNAMES instead)\n");
848           listen_fd_count = listen_fdnames_colons + 1;
849         }
850     }
851   else
852     listen_fd_count = atoi (listen_fds);
853
854   if (listen_fd_count < 1)
855     {
856       log_error ("--supervised mode expects at least one file descriptor (was told %d) "
857                  "(carrying on as though it were 1)\n", listen_fd_count);
858       listen_fd_count = 1;
859     }
860
861   if (!listen_fdnames)
862     {
863       if (listen_fd_count != 1)
864         log_error ("no LISTEN_FDNAMES and LISTEN_FDS (%d) != 1 in --supervised mode. "
865                    "(ignoring all sockets but the first one)\n", listen_fd_count);
866       *fd = 3;
867     }
868   else
869     {
870       int i;
871       if (listen_fd_count != listen_fdnames_colons + 1)
872         {
873           log_fatal ("number of items in LISTEN_FDNAMES (%d) does not match "
874                      "LISTEN_FDS (%d) in --supervised mode\n",
875                      listen_fdnames_colons + 1, listen_fd_count);
876           exit (1);
877         }
878
879       for (i = 3; i < 3 + listen_fd_count; i++)
880         {
881           int found = 0;
882           char *next = strchrnul(listen_fdnames, ':');
883           *next = '\0';
884 #define match_socket(var) if (!found && strcmp (listen_fdnames, #var) == 0) \
885             {                                                           \
886               found = 1;                                                \
887               if (*fd_ ## var == GNUPG_INVALID_FD)                      \
888                 {                                                       \
889                   *fd_ ## var = i;                                      \
890                   log_info (#var " socket on fd %d\n", i);              \
891                 }                                                       \
892               else                                                      \
893                 {                                                       \
894                   log_error ("cannot listen on more than one " #var " socket. (closing fd %d)\n", i); \
895                   close (i);                                            \
896                 }                                                       \
897             }
898           match_socket(ssh);
899           match_socket(browser);
900           match_socket(extra);
901 #undef match_socket
902           if (!found)
903             {
904               if (*fd == GNUPG_INVALID_FD)
905                 {
906                   *fd = i;
907                   log_info ("standard socket (\"%s\") on fd %d\n",
908                             listen_fdnames, i);
909                 }
910               else
911                 {
912                   log_error ("cannot listen on more than one standard socket. (closing fd %d)\n", i);
913                   close (i);
914                 }
915             }
916           listen_fdnames = next + 1;
917         }
918     }
919 }
920
921
922 /* The main entry point.  */
923 int
924 main (int argc, char **argv )
925 {
926   ARGPARSE_ARGS pargs;
927   int orig_argc;
928   char **orig_argv;
929   FILE *configfp = NULL;
930   char *configname = NULL;
931   const char *shell;
932   unsigned configlineno;
933   int parse_debug = 0;
934   int default_config =1;
935   int pipe_server = 0;
936   int is_daemon = 0;
937   int is_supervised = 0;
938   int nodetach = 0;
939   int csh_style = 0;
940   char *logfile = NULL;
941   int debug_wait = 0;
942   int gpgconf_list = 0;
943   gpg_error_t err;
944   struct assuan_malloc_hooks malloc_hooks;
945
946   early_system_init ();
947
948   /* Before we do anything else we save the list of currently open
949      file descriptors and the signal mask.  This info is required to
950      do the exec call properly. */
951   startup_fd_list = get_all_open_fds ();
952 #ifdef HAVE_SIGPROCMASK
953   if (!sigprocmask (SIG_UNBLOCK, NULL, &startup_signal_mask))
954     startup_signal_mask_valid = 1;
955 #endif /*HAVE_SIGPROCMASK*/
956
957   /* Set program name etc.  */
958   set_strusage (my_strusage);
959   gcry_control (GCRYCTL_SUSPEND_SECMEM_WARN);
960   /* Please note that we may running SUID(ROOT), so be very CAREFUL
961      when adding any stuff between here and the call to INIT_SECMEM()
962      somewhere after the option parsing */
963   log_set_prefix (GPG_AGENT_NAME, GPGRT_LOG_WITH_PREFIX|GPGRT_LOG_WITH_PID);
964
965   /* Make sure that our subsystems are ready.  */
966   i18n_init ();
967   init_common_subsystems (&argc, &argv);
968
969   malloc_hooks.malloc = gcry_malloc;
970   malloc_hooks.realloc = gcry_realloc;
971   malloc_hooks.free = gcry_free;
972   assuan_set_malloc_hooks (&malloc_hooks);
973   assuan_set_gpg_err_source (GPG_ERR_SOURCE_DEFAULT);
974   assuan_sock_init ();
975   setup_libassuan_logging (&opt.debug, NULL);
976
977   setup_libgcrypt_logging ();
978   gcry_control (GCRYCTL_USE_SECURE_RNDPOOL);
979   gcry_set_progress_handler (agent_libgcrypt_progress_cb, NULL);
980
981   disable_core_dumps ();
982
983   /* Set default options.  */
984   parse_rereadable_options (NULL, 0); /* Reset them to default values. */
985
986   shell = getenv ("SHELL");
987   if (shell && strlen (shell) >= 3 && !strcmp (shell+strlen (shell)-3, "csh") )
988     csh_style = 1;
989
990   /* Record some of the original environment strings. */
991   {
992     const char *s;
993     int idx;
994     static const char *names[] =
995       { "DISPLAY", "TERM", "XAUTHORITY", "PINENTRY_USER_DATA", NULL };
996
997     err = 0;
998     opt.startup_env = session_env_new ();
999     if (!opt.startup_env)
1000       err = gpg_error_from_syserror ();
1001     for (idx=0; !err && names[idx]; idx++)
1002       {
1003         s = getenv (names[idx]);
1004         if (s)
1005           err = session_env_setenv (opt.startup_env, names[idx], s);
1006       }
1007     if (!err)
1008       {
1009         s = gnupg_ttyname (0);
1010         if (s)
1011           err = session_env_setenv (opt.startup_env, "GPG_TTY", s);
1012       }
1013     if (err)
1014       log_fatal ("error recording startup environment: %s\n",
1015                  gpg_strerror (err));
1016
1017     /* Fixme: Better use the locale function here.  */
1018     opt.startup_lc_ctype = getenv ("LC_CTYPE");
1019     if (opt.startup_lc_ctype)
1020       opt.startup_lc_ctype = xstrdup (opt.startup_lc_ctype);
1021     opt.startup_lc_messages = getenv ("LC_MESSAGES");
1022     if (opt.startup_lc_messages)
1023       opt.startup_lc_messages = xstrdup (opt.startup_lc_messages);
1024   }
1025
1026   /* Check whether we have a config file on the commandline */
1027   orig_argc = argc;
1028   orig_argv = argv;
1029   pargs.argc = &argc;
1030   pargs.argv = &argv;
1031   pargs.flags= 1|(1<<6);  /* do not remove the args, ignore version */
1032   while (arg_parse( &pargs, opts))
1033     {
1034       if (pargs.r_opt == oDebug || pargs.r_opt == oDebugAll)
1035         parse_debug++;
1036       else if (pargs.r_opt == oOptions)
1037         { /* yes there is one, so we do not try the default one, but
1038              read the option file when it is encountered at the
1039              commandline */
1040           default_config = 0;
1041         }
1042         else if (pargs.r_opt == oNoOptions)
1043           default_config = 0; /* --no-options */
1044         else if (pargs.r_opt == oHomedir)
1045           gnupg_set_homedir (pargs.r.ret_str);
1046         else if (pargs.r_opt == oDebugQuickRandom)
1047           {
1048             gcry_control (GCRYCTL_ENABLE_QUICK_RANDOM, 0);
1049           }
1050
1051     }
1052
1053   /* Initialize the secure memory. */
1054   gcry_control (GCRYCTL_INIT_SECMEM, 32768, 0);
1055   maybe_setuid = 0;
1056
1057   /*
1058      Now we are now working under our real uid
1059   */
1060
1061   if (default_config)
1062     configname = make_filename (gnupg_homedir (),
1063                                 GPG_AGENT_NAME EXTSEP_S "conf", NULL);
1064
1065   argc = orig_argc;
1066   argv = orig_argv;
1067   pargs.argc = &argc;
1068   pargs.argv = &argv;
1069   pargs.flags=  1;  /* do not remove the args */
1070  next_pass:
1071   if (configname)
1072     {
1073       configlineno = 0;
1074       configfp = fopen (configname, "r");
1075       if (!configfp)
1076         {
1077           if (default_config)
1078             {
1079               if( parse_debug )
1080                 log_info (_("Note: no default option file '%s'\n"),
1081                           configname );
1082               /* Save the default conf file name so that
1083                  reread_configuration is able to test whether the
1084                  config file has been created in the meantime.  */
1085               xfree (config_filename);
1086               config_filename = configname;
1087               configname = NULL;
1088             }
1089           else
1090             {
1091               log_error (_("option file '%s': %s\n"),
1092                          configname, strerror(errno) );
1093               exit(2);
1094             }
1095           xfree (configname);
1096           configname = NULL;
1097         }
1098       if (parse_debug && configname )
1099         log_info (_("reading options from '%s'\n"), configname );
1100       default_config = 0;
1101     }
1102
1103   while (optfile_parse( configfp, configname, &configlineno, &pargs, opts) )
1104     {
1105       if (parse_rereadable_options (&pargs, 0))
1106         continue; /* Already handled */
1107       switch (pargs.r_opt)
1108         {
1109         case aGPGConfList: gpgconf_list = 1; break;
1110         case aGPGConfTest: gpgconf_list = 2; break;
1111         case aUseStandardSocketP: gpgconf_list = 3; break;
1112         case oBatch: opt.batch=1; break;
1113
1114         case oDebugWait: debug_wait = pargs.r.ret_int; break;
1115
1116         case oOptions:
1117           /* config files may not be nested (silently ignore them) */
1118           if (!configfp)
1119             {
1120                 xfree(configname);
1121                 configname = xstrdup(pargs.r.ret_str);
1122                 goto next_pass;
1123             }
1124           break;
1125         case oNoGreeting: /* Dummy option.  */ break;
1126         case oNoVerbose: opt.verbose = 0; break;
1127         case oNoOptions: break; /* no-options */
1128         case oHomedir: gnupg_set_homedir (pargs.r.ret_str); break;
1129         case oNoDetach: nodetach = 1; break;
1130         case oLogFile: logfile = pargs.r.ret_str; break;
1131         case oCsh: csh_style = 1; break;
1132         case oSh: csh_style = 0; break;
1133         case oServer: pipe_server = 1; break;
1134         case oDaemon: is_daemon = 1; break;
1135         case oSupervised: is_supervised = 1; break;
1136
1137         case oDisplay: default_display = xstrdup (pargs.r.ret_str); break;
1138         case oTTYname: default_ttyname = xstrdup (pargs.r.ret_str); break;
1139         case oTTYtype: default_ttytype = xstrdup (pargs.r.ret_str); break;
1140         case oLCctype: default_lc_ctype = xstrdup (pargs.r.ret_str); break;
1141         case oLCmessages: default_lc_messages = xstrdup (pargs.r.ret_str);
1142           break;
1143         case oXauthority: default_xauthority = xstrdup (pargs.r.ret_str);
1144           break;
1145
1146         case oUseStandardSocket:
1147         case oNoUseStandardSocket:
1148           obsolete_option (configname, configlineno, "use-standard-socket");
1149           break;
1150
1151         case oFakedSystemTime:
1152           {
1153             time_t faked_time = isotime2epoch (pargs.r.ret_str);
1154             if (faked_time == (time_t)(-1))
1155               faked_time = (time_t)strtoul (pargs.r.ret_str, NULL, 10);
1156             gnupg_set_time (faked_time, 0);
1157           }
1158           break;
1159
1160         case oKeepTTY: opt.keep_tty = 1; break;
1161         case oKeepDISPLAY: opt.keep_display = 1; break;
1162
1163         case oSSHSupport:
1164           ssh_support = 1;
1165           break;
1166         case oPuttySupport:
1167 #        ifdef HAVE_W32_SYSTEM
1168           putty_support = 1;
1169 #        endif
1170           break;
1171
1172         case oExtraSocket:
1173           opt.extra_socket = 1;  /* (1 = points into argv)  */
1174           socket_name_extra = pargs.r.ret_str;
1175           break;
1176
1177         case oBrowserSocket:
1178           opt.browser_socket = 1;  /* (1 = points into argv)  */
1179           socket_name_browser = pargs.r.ret_str;
1180           break;
1181
1182         case oDebugQuickRandom:
1183           /* Only used by the first stage command line parser.  */
1184           break;
1185
1186         case oWriteEnvFile:
1187           obsolete_option (configname, configlineno, "write-env-file");
1188           break;
1189
1190         default : pargs.err = configfp? 1:2; break;
1191         }
1192     }
1193   if (configfp)
1194     {
1195       fclose( configfp );
1196       configfp = NULL;
1197       /* Keep a copy of the name so that it can be read on SIGHUP. */
1198       if (config_filename != configname)
1199         {
1200           xfree (config_filename);
1201           config_filename = configname;
1202         }
1203       configname = NULL;
1204       goto next_pass;
1205     }
1206
1207   xfree (configname);
1208   configname = NULL;
1209   if (log_get_errorcount(0))
1210     exit(2);
1211
1212   finalize_rereadable_options ();
1213
1214   /* Print a warning if an argument looks like an option.  */
1215   if (!opt.quiet && !(pargs.flags & ARGPARSE_FLAG_STOP_SEEN))
1216     {
1217       int i;
1218
1219       for (i=0; i < argc; i++)
1220         if (argv[i][0] == '-' && argv[i][1] == '-')
1221           log_info (_("Note: '%s' is not considered an option\n"), argv[i]);
1222     }
1223
1224 #ifdef ENABLE_NLS
1225   /* gpg-agent usually does not output any messages because it runs in
1226      the background.  For log files it is acceptable to have messages
1227      always encoded in utf-8.  We switch here to utf-8, so that
1228      commands like --help still give native messages.  It is far
1229      easier to switch only once instead of for every message and it
1230      actually helps when more then one thread is active (avoids an
1231      extra copy step). */
1232     bind_textdomain_codeset (PACKAGE_GT, "UTF-8");
1233 #endif
1234
1235   if (!pipe_server && !is_daemon && !gpgconf_list && !is_supervised)
1236     {
1237      /* We have been called without any command and thus we merely
1238         check whether an agent is already running.  We do this right
1239         here so that we don't clobber a logfile with this check but
1240         print the status directly to stderr. */
1241       opt.debug = 0;
1242       set_debug ();
1243       check_for_running_agent (0);
1244       agent_exit (0);
1245     }
1246
1247   if (! opt.extra_socket)
1248     {
1249       opt.extra_socket = 1;
1250     }
1251   else if (socket_name_extra
1252            && (!strcmp (socket_name_extra, "none")
1253                || !strcmp (socket_name_extra, "/dev/null")))
1254     {
1255       /* User requested not to create this socket.  */
1256       opt.extra_socket = 0;
1257       socket_name_extra = NULL;
1258     }
1259
1260   if (! opt.browser_socket)
1261     {
1262       opt.browser_socket = 1;
1263     }
1264   else if (socket_name_browser
1265            && (!strcmp (socket_name_browser, "none")
1266                || !strcmp (socket_name_browser, "/dev/null")))
1267     {
1268       /* User requested not to create this socket.  */
1269       opt.browser_socket = 0;
1270       socket_name_browser = NULL;
1271     }
1272
1273   set_debug ();
1274
1275   if (atexit (cleanup))
1276     {
1277       log_error ("atexit failed\n");
1278       cleanup ();
1279       exit (1);
1280     }
1281
1282   /* Try to create missing directories. */
1283   create_directories ();
1284
1285   if (debug_wait && pipe_server)
1286     {
1287       thread_init_once ();
1288       log_debug ("waiting for debugger - my pid is %u .....\n",
1289                  (unsigned int)getpid());
1290       gnupg_sleep (debug_wait);
1291       log_debug ("... okay\n");
1292     }
1293
1294   if (gpgconf_list == 3)
1295     {
1296       /* We now use the standard socket always - return true for
1297          backward compatibility.  */
1298       agent_exit (0);
1299     }
1300   else if (gpgconf_list == 2)
1301     agent_exit (0);
1302   else if (gpgconf_list)
1303     {
1304       char *filename;
1305       char *filename_esc;
1306
1307       /* List options and default values in the GPG Conf format.  */
1308       filename = make_filename (gnupg_homedir (),
1309                                 GPG_AGENT_NAME EXTSEP_S "conf", NULL);
1310       filename_esc = percent_escape (filename, NULL);
1311
1312       es_printf ("%s-%s.conf:%lu:\"%s\n",
1313                  GPGCONF_NAME, GPG_AGENT_NAME,
1314                  GC_OPT_FLAG_DEFAULT, filename_esc);
1315       xfree (filename);
1316       xfree (filename_esc);
1317
1318       es_printf ("verbose:%lu:\n"
1319               "quiet:%lu:\n"
1320               "debug-level:%lu:\"none:\n"
1321               "log-file:%lu:\n",
1322               GC_OPT_FLAG_NONE|GC_OPT_FLAG_RUNTIME,
1323               GC_OPT_FLAG_NONE|GC_OPT_FLAG_RUNTIME,
1324               GC_OPT_FLAG_DEFAULT|GC_OPT_FLAG_RUNTIME,
1325               GC_OPT_FLAG_NONE|GC_OPT_FLAG_RUNTIME );
1326       es_printf ("default-cache-ttl:%lu:%d:\n",
1327               GC_OPT_FLAG_DEFAULT|GC_OPT_FLAG_RUNTIME, DEFAULT_CACHE_TTL );
1328       es_printf ("default-cache-ttl-ssh:%lu:%d:\n",
1329               GC_OPT_FLAG_DEFAULT|GC_OPT_FLAG_RUNTIME, DEFAULT_CACHE_TTL_SSH );
1330       es_printf ("max-cache-ttl:%lu:%d:\n",
1331               GC_OPT_FLAG_DEFAULT|GC_OPT_FLAG_RUNTIME, MAX_CACHE_TTL );
1332       es_printf ("max-cache-ttl-ssh:%lu:%d:\n",
1333               GC_OPT_FLAG_DEFAULT|GC_OPT_FLAG_RUNTIME, MAX_CACHE_TTL_SSH );
1334       es_printf ("enforce-passphrase-constraints:%lu:\n",
1335               GC_OPT_FLAG_NONE|GC_OPT_FLAG_RUNTIME);
1336       es_printf ("min-passphrase-len:%lu:%d:\n",
1337               GC_OPT_FLAG_DEFAULT|GC_OPT_FLAG_RUNTIME, MIN_PASSPHRASE_LEN );
1338       es_printf ("min-passphrase-nonalpha:%lu:%d:\n",
1339               GC_OPT_FLAG_DEFAULT|GC_OPT_FLAG_RUNTIME,
1340               MIN_PASSPHRASE_NONALPHA);
1341       es_printf ("check-passphrase-pattern:%lu:\n",
1342               GC_OPT_FLAG_DEFAULT|GC_OPT_FLAG_RUNTIME);
1343       es_printf ("max-passphrase-days:%lu:%d:\n",
1344               GC_OPT_FLAG_DEFAULT|GC_OPT_FLAG_RUNTIME,
1345               MAX_PASSPHRASE_DAYS);
1346       es_printf ("enable-passphrase-history:%lu:\n",
1347               GC_OPT_FLAG_NONE|GC_OPT_FLAG_RUNTIME);
1348       es_printf ("no-grab:%lu:\n",
1349               GC_OPT_FLAG_NONE|GC_OPT_FLAG_RUNTIME);
1350       es_printf ("ignore-cache-for-signing:%lu:\n",
1351               GC_OPT_FLAG_NONE|GC_OPT_FLAG_RUNTIME);
1352       es_printf ("no-allow-external-cache:%lu:\n",
1353               GC_OPT_FLAG_NONE|GC_OPT_FLAG_RUNTIME);
1354       es_printf ("no-allow-mark-trusted:%lu:\n",
1355               GC_OPT_FLAG_NONE|GC_OPT_FLAG_RUNTIME);
1356       es_printf ("disable-scdaemon:%lu:\n",
1357               GC_OPT_FLAG_NONE|GC_OPT_FLAG_RUNTIME);
1358       es_printf ("enable-ssh-support:%lu:\n", GC_OPT_FLAG_NONE);
1359 #ifdef HAVE_W32_SYSTEM
1360       es_printf ("enable-putty-support:%lu:\n", GC_OPT_FLAG_NONE);
1361 #endif
1362       es_printf ("no-allow-loopback-pinentry:%lu:\n",
1363               GC_OPT_FLAG_NONE|GC_OPT_FLAG_RUNTIME);
1364       es_printf ("allow-emacs-pinentry:%lu:\n",
1365                  GC_OPT_FLAG_NONE|GC_OPT_FLAG_RUNTIME);
1366       es_printf ("pinentry-timeout:%lu:0:\n",
1367                  GC_OPT_FLAG_DEFAULT|GC_OPT_FLAG_RUNTIME);
1368
1369       agent_exit (0);
1370     }
1371
1372   /* Now start with logging to a file if this is desired. */
1373   if (logfile)
1374     {
1375       log_set_file (logfile);
1376       log_set_prefix (NULL, (GPGRT_LOG_WITH_PREFIX
1377                              | GPGRT_LOG_WITH_TIME
1378                              | GPGRT_LOG_WITH_PID));
1379       current_logfile = xstrdup (logfile);
1380     }
1381
1382   /* Make sure that we have a default ttyname. */
1383   if (!default_ttyname && gnupg_ttyname (1))
1384     default_ttyname = xstrdup (gnupg_ttyname (1));
1385   if (!default_ttytype && getenv ("TERM"))
1386     default_ttytype = xstrdup (getenv ("TERM"));
1387
1388
1389   if (pipe_server)
1390     {
1391       /* This is the simple pipe based server */
1392       ctrl_t ctrl;
1393
1394       initialize_modules ();
1395
1396       ctrl = xtrycalloc (1, sizeof *ctrl);
1397       if (!ctrl)
1398         {
1399           log_error ("error allocating connection control data: %s\n",
1400                      strerror (errno) );
1401           agent_exit (1);
1402         }
1403       ctrl->session_env = session_env_new ();
1404       if (!ctrl->session_env)
1405         {
1406           log_error ("error allocating session environment block: %s\n",
1407                      strerror (errno) );
1408           xfree (ctrl);
1409           agent_exit (1);
1410         }
1411       agent_init_default_ctrl (ctrl);
1412       start_command_handler (ctrl, GNUPG_INVALID_FD, GNUPG_INVALID_FD);
1413       agent_deinit_default_ctrl (ctrl);
1414       xfree (ctrl);
1415     }
1416   else if (is_supervised)
1417     {
1418       gnupg_fd_t fd = GNUPG_INVALID_FD;
1419       gnupg_fd_t fd_extra = GNUPG_INVALID_FD;
1420       gnupg_fd_t fd_browser = GNUPG_INVALID_FD;
1421       gnupg_fd_t fd_ssh = GNUPG_INVALID_FD;
1422
1423       /* when supervised and sending logs to stderr, the process
1424          supervisor should handle log entry metadata (pid, name,
1425          timestamp) */
1426       if (!logfile)
1427         log_set_prefix (NULL, 0);
1428
1429       log_info ("%s %s starting in supervised mode.\n",
1430                 strusage(11), strusage(13) );
1431
1432       map_supervised_sockets (&fd, &fd_extra, &fd_browser, &fd_ssh);
1433       if (fd == GNUPG_INVALID_FD)
1434         {
1435           log_fatal ("no standard socket provided\n");
1436           exit (1);
1437         }
1438       /* record socket names where possible: */
1439       socket_name = get_socket_path (fd);
1440       socket_name_extra = get_socket_path (fd_extra);
1441       if (socket_name_extra)
1442         opt.extra_socket = 2;
1443       socket_name_browser = get_socket_path (fd_browser);
1444       if (socket_name_browser)
1445         opt.browser_socket = 2;
1446       socket_name_ssh = get_socket_path (fd_ssh);
1447
1448 #ifdef HAVE_SIGPROCMASK
1449       if (startup_signal_mask_valid)
1450         {
1451           if (sigprocmask (SIG_SETMASK, &startup_signal_mask, NULL))
1452             log_error ("error restoring signal mask: %s\n",
1453                        strerror (errno));
1454         }
1455       else
1456         log_info ("no saved signal mask\n");
1457 #endif /*HAVE_SIGPROCMASK*/
1458
1459       log_debug ("FDs: std: %d extra: %d browser: %d ssh: %d\n",
1460                  fd, fd_extra, fd_browser, fd_ssh);
1461       handle_connections (fd, fd_extra, fd_browser, fd_ssh);
1462       assuan_sock_close (fd);
1463     }
1464   else if (!is_daemon)
1465     ; /* NOTREACHED */
1466   else
1467     { /* Regular server mode */
1468       gnupg_fd_t fd;
1469       gnupg_fd_t fd_extra = GNUPG_INVALID_FD;
1470       gnupg_fd_t fd_browser = GNUPG_INVALID_FD;
1471       gnupg_fd_t fd_ssh = GNUPG_INVALID_FD;
1472 #ifndef HAVE_W32_SYSTEM
1473       pid_t pid;
1474 #endif
1475
1476       initialize_modules ();
1477
1478       /* Remove the DISPLAY variable so that a pinentry does not
1479          default to a specific display.  There is still a default
1480          display when gpg-agent was started using --display or a
1481          client requested this using an OPTION command.  Note, that we
1482          don't do this when running in reverse daemon mode (i.e. when
1483          exec the program given as arguments). */
1484 #ifndef HAVE_W32_SYSTEM
1485       if (!opt.keep_display && !argc)
1486         gnupg_unsetenv ("DISPLAY");
1487 #endif
1488
1489       /* Remove the INSIDE_EMACS variable so that a pinentry does not
1490          always try to interact with Emacs.  The variable is set when
1491          a client requested this using an OPTION command.  */
1492       gnupg_unsetenv ("INSIDE_EMACS");
1493
1494       /* Create the sockets.  */
1495       socket_name = create_socket_name (GPG_AGENT_SOCK_NAME, 1);
1496       fd = create_server_socket (socket_name, 1, 0,
1497                                  &redir_socket_name, &socket_nonce);
1498
1499       if (opt.extra_socket)
1500         {
1501           if (socket_name_extra)
1502             socket_name_extra = create_socket_name (socket_name_extra, 0);
1503           else
1504             socket_name_extra = create_socket_name
1505               /**/                (GPG_AGENT_EXTRA_SOCK_NAME, 1);
1506           opt.extra_socket = 2; /* Indicate that it has been malloced.  */
1507           fd_extra = create_server_socket (socket_name_extra, 0, 0,
1508                                            &redir_socket_name_extra,
1509                                            &socket_nonce_extra);
1510         }
1511
1512       if (opt.browser_socket)
1513         {
1514           if (socket_name_browser)
1515             socket_name_browser = create_socket_name (socket_name_browser, 0);
1516           else
1517             socket_name_browser= create_socket_name
1518               /**/                 (GPG_AGENT_BROWSER_SOCK_NAME, 1);
1519           opt.browser_socket = 2; /* Indicate that it has been malloced.  */
1520           fd_browser = create_server_socket (socket_name_browser, 0, 0,
1521                                              &redir_socket_name_browser,
1522                                              &socket_nonce_browser);
1523         }
1524
1525       socket_name_ssh = create_socket_name (GPG_AGENT_SSH_SOCK_NAME, 1);
1526       fd_ssh = create_server_socket (socket_name_ssh, 0, 1,
1527                                      &redir_socket_name_ssh,
1528                                      &socket_nonce_ssh);
1529
1530       /* If we are going to exec a program in the parent, we record
1531          the PID, so that the child may check whether the program is
1532          still alive. */
1533       if (argc)
1534         parent_pid = getpid ();
1535
1536       fflush (NULL);
1537 #ifdef HAVE_W32_SYSTEM
1538       (void)csh_style;
1539       (void)nodetach;
1540 #else /*!HAVE_W32_SYSTEM*/
1541       pid = fork ();
1542       if (pid == (pid_t)-1)
1543         {
1544           log_fatal ("fork failed: %s\n", strerror (errno) );
1545           exit (1);
1546         }
1547       else if (pid)
1548         { /* We are the parent */
1549           char *infostr_ssh_sock, *infostr_ssh_valid;
1550
1551           /* Close the socket FD. */
1552           close (fd);
1553
1554           /* The signal mask might not be correct right now and thus
1555              we restore it.  That is not strictly necessary but some
1556              programs falsely assume a cleared signal mask.  */
1557
1558 #ifdef HAVE_SIGPROCMASK
1559           if (startup_signal_mask_valid)
1560             {
1561               if (sigprocmask (SIG_SETMASK, &startup_signal_mask, NULL))
1562                 log_error ("error restoring signal mask: %s\n",
1563                            strerror (errno));
1564             }
1565           else
1566             log_info ("no saved signal mask\n");
1567 #endif /*HAVE_SIGPROCMASK*/
1568
1569           /* Create the SSH info string if enabled. */
1570           if (ssh_support)
1571             {
1572               if (asprintf (&infostr_ssh_sock, "SSH_AUTH_SOCK=%s",
1573                             socket_name_ssh) < 0)
1574                 {
1575                   log_error ("out of core\n");
1576                   kill (pid, SIGTERM);
1577                   exit (1);
1578                 }
1579               if (asprintf (&infostr_ssh_valid, "gnupg_SSH_AUTH_SOCK_by=%lu",
1580                             (unsigned long)getpid()) < 0)
1581                 {
1582                   log_error ("out of core\n");
1583                   kill (pid, SIGTERM);
1584                   exit (1);
1585                 }
1586             }
1587
1588           *socket_name = 0; /* Don't let cleanup() remove the socket -
1589                                the child should do this from now on */
1590           if (opt.extra_socket)
1591             *socket_name_extra = 0;
1592           if (opt.browser_socket)
1593             *socket_name_browser = 0;
1594           *socket_name_ssh = 0;
1595
1596           if (argc)
1597             { /* Run the program given on the commandline.  */
1598               if (ssh_support && (putenv (infostr_ssh_sock)
1599                                   || putenv (infostr_ssh_valid)))
1600                 {
1601                   log_error ("failed to set environment: %s\n",
1602                              strerror (errno) );
1603                   kill (pid, SIGTERM );
1604                   exit (1);
1605                 }
1606
1607               /* Close all the file descriptors except the standard
1608                  ones and those open at startup.  We explicitly don't
1609                  close 0,1,2 in case something went wrong collecting
1610                  them at startup.  */
1611               close_all_fds (3, startup_fd_list);
1612
1613               /* Run the command.  */
1614               execvp (argv[0], argv);
1615               log_error ("failed to run the command: %s\n", strerror (errno));
1616               kill (pid, SIGTERM);
1617               exit (1);
1618             }
1619           else
1620             {
1621               /* Print the environment string, so that the caller can use
1622                  shell's eval to set it */
1623               if (csh_style)
1624                 {
1625                   if (ssh_support)
1626                     {
1627                       *strchr (infostr_ssh_sock, '=') = ' ';
1628                       es_printf ("setenv %s;\n", infostr_ssh_sock);
1629                     }
1630                 }
1631               else
1632                 {
1633                   if (ssh_support)
1634                     {
1635                       es_printf ("%s; export SSH_AUTH_SOCK;\n",
1636                                  infostr_ssh_sock);
1637                     }
1638                 }
1639               if (ssh_support)
1640                 {
1641                   xfree (infostr_ssh_sock);
1642                   xfree (infostr_ssh_valid);
1643                 }
1644               exit (0);
1645             }
1646           /*NOTREACHED*/
1647         } /* End parent */
1648
1649       /*
1650          This is the child
1651        */
1652
1653       initialize_modules ();
1654
1655       /* Detach from tty and put process into a new session */
1656       if (!nodetach )
1657         {
1658           int i;
1659           unsigned int oldflags;
1660
1661           /* Close stdin, stdout and stderr unless it is the log stream */
1662           for (i=0; i <= 2; i++)
1663             {
1664               if (!log_test_fd (i) && i != fd )
1665                 {
1666                   if ( ! close (i)
1667                        && open ("/dev/null", i? O_WRONLY : O_RDONLY) == -1)
1668                     {
1669                       log_error ("failed to open '%s': %s\n",
1670                                  "/dev/null", strerror (errno));
1671                       cleanup ();
1672                       exit (1);
1673                     }
1674                 }
1675             }
1676           if (setsid() == -1)
1677             {
1678               log_error ("setsid() failed: %s\n", strerror(errno) );
1679               cleanup ();
1680               exit (1);
1681             }
1682
1683           log_get_prefix (&oldflags);
1684           log_set_prefix (NULL, oldflags | GPGRT_LOG_RUN_DETACHED);
1685           opt.running_detached = 1;
1686         }
1687
1688       if (chdir("/"))
1689         {
1690           log_error ("chdir to / failed: %s\n", strerror (errno));
1691           exit (1);
1692         }
1693
1694       {
1695         struct sigaction sa;
1696
1697         sa.sa_handler = SIG_IGN;
1698         sigemptyset (&sa.sa_mask);
1699         sa.sa_flags = 0;
1700         sigaction (SIGPIPE, &sa, NULL);
1701       }
1702 #endif /*!HAVE_W32_SYSTEM*/
1703
1704       log_info ("%s %s started\n", strusage(11), strusage(13) );
1705       handle_connections (fd, fd_extra, fd_browser, fd_ssh);
1706       assuan_sock_close (fd);
1707     }
1708
1709   return 0;
1710 }
1711
1712
1713 /* Exit entry point.  This function should be called instead of a
1714    plain exit.  */
1715 void
1716 agent_exit (int rc)
1717 {
1718   /*FIXME: update_random_seed_file();*/
1719
1720   /* We run our cleanup handler because that may close cipher contexts
1721      stored in secure memory and thus this needs to be done before we
1722      explicitly terminate secure memory.  */
1723   cleanup ();
1724
1725 #if 1
1726   /* at this time a bit annoying */
1727   if (opt.debug & DBG_MEMSTAT_VALUE)
1728     {
1729       gcry_control( GCRYCTL_DUMP_MEMORY_STATS );
1730       gcry_control( GCRYCTL_DUMP_RANDOM_STATS );
1731     }
1732   if (opt.debug)
1733     gcry_control (GCRYCTL_DUMP_SECMEM_STATS );
1734 #endif
1735   gcry_control (GCRYCTL_TERM_SECMEM );
1736   rc = rc? rc : log_get_errorcount(0)? 2 : 0;
1737   exit (rc);
1738 }
1739
1740
1741 /* This is our callback function for gcrypt progress messages.  It is
1742    set once at startup and dispatches progress messages to the
1743    corresponding threads of the agent.  */
1744 static void
1745 agent_libgcrypt_progress_cb (void *data, const char *what, int printchar,
1746                              int current, int total)
1747 {
1748   struct progress_dispatch_s *dispatch;
1749   npth_t mytid = npth_self ();
1750
1751   (void)data;
1752
1753   for (dispatch = progress_dispatch_list; dispatch; dispatch = dispatch->next)
1754     if (dispatch->ctrl && dispatch->tid == mytid)
1755       break;
1756   if (dispatch && dispatch->cb)
1757     dispatch->cb (dispatch->ctrl, what, printchar, current, total);
1758 }
1759
1760
1761 /* If a progress dispatcher callback has been associated with the
1762  * current connection unregister it.  */
1763 static void
1764 unregister_progress_cb (void)
1765 {
1766   struct progress_dispatch_s *dispatch;
1767   npth_t mytid = npth_self ();
1768
1769   for (dispatch = progress_dispatch_list; dispatch; dispatch = dispatch->next)
1770     if (dispatch->ctrl && dispatch->tid == mytid)
1771       break;
1772   if (dispatch)
1773     {
1774       dispatch->ctrl = NULL;
1775       dispatch->cb = NULL;
1776     }
1777 }
1778
1779
1780 /* Setup a progress callback CB for the current connection.  Using a
1781  * CB of NULL disables the callback.  */
1782 void
1783 agent_set_progress_cb (void (*cb)(ctrl_t ctrl, const char *what,
1784                                   int printchar, int current, int total),
1785                        ctrl_t ctrl)
1786 {
1787   struct progress_dispatch_s *dispatch, *firstfree;
1788   npth_t mytid = npth_self ();
1789
1790   firstfree = NULL;
1791   for (dispatch = progress_dispatch_list; dispatch; dispatch = dispatch->next)
1792     {
1793       if (dispatch->ctrl && dispatch->tid == mytid)
1794         break;
1795       if (!dispatch->ctrl && !firstfree)
1796         firstfree = dispatch;
1797     }
1798   if (!dispatch) /* None allocated: Reuse or allocate a new one.  */
1799     {
1800       if (firstfree)
1801         {
1802           dispatch = firstfree;
1803         }
1804       else if ((dispatch = xtrycalloc (1, sizeof *dispatch)))
1805         {
1806           dispatch->next = progress_dispatch_list;
1807           progress_dispatch_list = dispatch;
1808         }
1809       else
1810         {
1811           log_error ("error allocating new progress dispatcher slot: %s\n",
1812                      gpg_strerror (gpg_error_from_syserror ()));
1813           return;
1814         }
1815       dispatch->ctrl = ctrl;
1816       dispatch->tid = mytid;
1817     }
1818
1819   dispatch->cb = cb;
1820 }
1821
1822
1823 /* Each thread has its own local variables conveyed by a control
1824    structure usually identified by an argument named CTRL.  This
1825    function is called immediately after allocating the control
1826    structure.  Its purpose is to setup the default values for that
1827    structure.  Note that some values may have already been set.  */
1828 static void
1829 agent_init_default_ctrl (ctrl_t ctrl)
1830 {
1831   assert (ctrl->session_env);
1832
1833   /* Note we ignore malloc errors because we can't do much about it
1834      and the request will fail anyway shortly after this
1835      initialization. */
1836   session_env_setenv (ctrl->session_env, "DISPLAY", default_display);
1837   session_env_setenv (ctrl->session_env, "GPG_TTY", default_ttyname);
1838   session_env_setenv (ctrl->session_env, "TERM", default_ttytype);
1839   session_env_setenv (ctrl->session_env, "XAUTHORITY", default_xauthority);
1840   session_env_setenv (ctrl->session_env, "PINENTRY_USER_DATA", NULL);
1841
1842   if (ctrl->lc_ctype)
1843     xfree (ctrl->lc_ctype);
1844   ctrl->lc_ctype = default_lc_ctype? xtrystrdup (default_lc_ctype) : NULL;
1845
1846   if (ctrl->lc_messages)
1847     xfree (ctrl->lc_messages);
1848   ctrl->lc_messages = default_lc_messages? xtrystrdup (default_lc_messages)
1849                                     /**/ : NULL;
1850   ctrl->cache_ttl_opt_preset = CACHE_TTL_OPT_PRESET;
1851 }
1852
1853
1854 /* Release all resources allocated by default in the control
1855    structure.  This is the counterpart to agent_init_default_ctrl.  */
1856 static void
1857 agent_deinit_default_ctrl (ctrl_t ctrl)
1858 {
1859   unregister_progress_cb ();
1860   session_env_release (ctrl->session_env);
1861
1862   if (ctrl->lc_ctype)
1863     xfree (ctrl->lc_ctype);
1864   if (ctrl->lc_messages)
1865     xfree (ctrl->lc_messages);
1866 }
1867
1868
1869 /* Because the ssh protocol does not send us information about the
1870    current TTY setting, we use this function to use those from startup
1871    or those explicitly set.  This is also used for the restricted mode
1872    where we ignore requests to change the environment.  */
1873 gpg_error_t
1874 agent_copy_startup_env (ctrl_t ctrl)
1875 {
1876   static const char *names[] =
1877     {"GPG_TTY", "DISPLAY", "TERM", "XAUTHORITY", "PINENTRY_USER_DATA", NULL};
1878   gpg_error_t err = 0;
1879   int idx;
1880   const char *value;
1881
1882   for (idx=0; !err && names[idx]; idx++)
1883       if ((value = session_env_getenv (opt.startup_env, names[idx])))
1884       err = session_env_setenv (ctrl->session_env, names[idx], value);
1885
1886   if (!err && !ctrl->lc_ctype && opt.startup_lc_ctype)
1887     if (!(ctrl->lc_ctype = xtrystrdup (opt.startup_lc_ctype)))
1888       err = gpg_error_from_syserror ();
1889
1890   if (!err && !ctrl->lc_messages && opt.startup_lc_messages)
1891     if (!(ctrl->lc_messages = xtrystrdup (opt.startup_lc_messages)))
1892       err = gpg_error_from_syserror ();
1893
1894   if (err)
1895     log_error ("error setting default session environment: %s\n",
1896                gpg_strerror (err));
1897
1898   return err;
1899 }
1900
1901
1902 /* Reread parts of the configuration.  Note, that this function is
1903    obviously not thread-safe and should only be called from the PTH
1904    signal handler.
1905
1906    Fixme: Due to the way the argument parsing works, we create a
1907    memory leak here for all string type arguments.  There is currently
1908    no clean way to tell whether the memory for the argument has been
1909    allocated or points into the process' original arguments.  Unless
1910    we have a mechanism to tell this, we need to live on with this. */
1911 static void
1912 reread_configuration (void)
1913 {
1914   ARGPARSE_ARGS pargs;
1915   FILE *fp;
1916   unsigned int configlineno = 0;
1917   int dummy;
1918
1919   if (!config_filename)
1920     return; /* No config file. */
1921
1922   fp = fopen (config_filename, "r");
1923   if (!fp)
1924     {
1925       log_info (_("option file '%s': %s\n"),
1926                 config_filename, strerror(errno) );
1927       return;
1928     }
1929
1930   parse_rereadable_options (NULL, 1); /* Start from the default values. */
1931
1932   memset (&pargs, 0, sizeof pargs);
1933   dummy = 0;
1934   pargs.argc = &dummy;
1935   pargs.flags = 1;  /* do not remove the args */
1936   while (optfile_parse (fp, config_filename, &configlineno, &pargs, opts) )
1937     {
1938       if (pargs.r_opt < -1)
1939         pargs.err = 1; /* Print a warning. */
1940       else /* Try to parse this option - ignore unchangeable ones. */
1941         parse_rereadable_options (&pargs, 1);
1942     }
1943   fclose (fp);
1944   finalize_rereadable_options ();
1945   set_debug ();
1946 }
1947
1948
1949 /* Return the file name of the socket we are using for native
1950    requests.  */
1951 const char *
1952 get_agent_socket_name (void)
1953 {
1954   const char *s = socket_name;
1955
1956   return (s && *s)? s : NULL;
1957 }
1958
1959 /* Return the file name of the socket we are using for SSH
1960    requests.  */
1961 const char *
1962 get_agent_ssh_socket_name (void)
1963 {
1964   const char *s = socket_name_ssh;
1965
1966   return (s && *s)? s : NULL;
1967 }
1968
1969
1970 /* Return the number of active connections. */
1971 int
1972 get_agent_active_connection_count (void)
1973 {
1974   return active_connections;
1975 }
1976
1977
1978 /* Under W32, this function returns the handle of the scdaemon
1979    notification event.  Calling it the first time creates that
1980    event.  */
1981 #if defined(HAVE_W32_SYSTEM) && !defined(HAVE_W32CE_SYSTEM)
1982 void *
1983 get_agent_scd_notify_event (void)
1984 {
1985   static HANDLE the_event = INVALID_HANDLE_VALUE;
1986
1987   if (the_event == INVALID_HANDLE_VALUE)
1988     {
1989       HANDLE h, h2;
1990       SECURITY_ATTRIBUTES sa = { sizeof (SECURITY_ATTRIBUTES), NULL, TRUE};
1991
1992       /* We need to use a manual reset event object due to the way our
1993          w32-pth wait function works: If we would use an automatic
1994          reset event we are not able to figure out which handle has
1995          been signaled because at the time we single out the signaled
1996          handles using WFSO the event has already been reset due to
1997          the WFMO.  */
1998       h = CreateEvent (&sa, TRUE, FALSE, NULL);
1999       if (!h)
2000         log_error ("can't create scd notify event: %s\n", w32_strerror (-1) );
2001       else if (!DuplicateHandle (GetCurrentProcess(), h,
2002                                  GetCurrentProcess(), &h2,
2003                                  EVENT_MODIFY_STATE|SYNCHRONIZE, TRUE, 0))
2004         {
2005           log_error ("setting syncronize for scd notify event failed: %s\n",
2006                      w32_strerror (-1) );
2007           CloseHandle (h);
2008         }
2009       else
2010         {
2011           CloseHandle (h);
2012           the_event = h2;
2013         }
2014     }
2015
2016   return the_event;
2017 }
2018 #endif /*HAVE_W32_SYSTEM && !HAVE_W32CE_SYSTEM*/
2019
2020
2021
2022 /* Create a name for the socket in the home directory as using
2023    STANDARD_NAME.  We also check for valid characters as well as
2024    against a maximum allowed length for a unix domain socket is done.
2025    The function terminates the process in case of an error.  Returns:
2026    Pointer to an allocated string with the absolute name of the socket
2027    used.  */
2028 static char *
2029 create_socket_name (char *standard_name, int with_homedir)
2030 {
2031   char *name;
2032
2033   if (with_homedir)
2034     name = make_filename (gnupg_socketdir (), standard_name, NULL);
2035   else
2036     name = make_filename (standard_name, NULL);
2037   if (strchr (name, PATHSEP_C))
2038     {
2039       log_error (("'%s' are not allowed in the socket name\n"), PATHSEP_S);
2040       agent_exit (2);
2041     }
2042   return name;
2043 }
2044
2045
2046
2047 /* Create a Unix domain socket with NAME.  Returns the file descriptor
2048    or terminates the process in case of an error.  Note that this
2049    function needs to be used for the regular socket first (indicated
2050    by PRIMARY) and only then for the extra and the ssh sockets.  If
2051    the socket has been redirected the name of the real socket is
2052    stored as a malloced string at R_REDIR_NAME.  If CYGWIN is set a
2053    Cygwin compatible socket is created (Windows only). */
2054 static gnupg_fd_t
2055 create_server_socket (char *name, int primary, int cygwin,
2056                       char **r_redir_name, assuan_sock_nonce_t *nonce)
2057 {
2058   struct sockaddr *addr;
2059   struct sockaddr_un *unaddr;
2060   socklen_t len;
2061   gnupg_fd_t fd;
2062   int rc;
2063
2064   xfree (*r_redir_name);
2065   *r_redir_name = NULL;
2066
2067   fd = assuan_sock_new (AF_UNIX, SOCK_STREAM, 0);
2068   if (fd == ASSUAN_INVALID_FD)
2069     {
2070       log_error (_("can't create socket: %s\n"), strerror (errno));
2071       *name = 0; /* Inhibit removal of the socket by cleanup(). */
2072       agent_exit (2);
2073     }
2074
2075   if (cygwin)
2076     assuan_sock_set_flag (fd, "cygwin", 1);
2077
2078   unaddr = xmalloc (sizeof *unaddr);
2079   addr = (struct sockaddr*)unaddr;
2080
2081   {
2082     int redirected;
2083
2084     if (assuan_sock_set_sockaddr_un (name, addr, &redirected))
2085       {
2086         if (errno == ENAMETOOLONG)
2087           log_error (_("socket name '%s' is too long\n"), name);
2088         else
2089           log_error ("error preparing socket '%s': %s\n",
2090                      name, gpg_strerror (gpg_error_from_syserror ()));
2091         *name = 0; /* Inhibit removal of the socket by cleanup(). */
2092         agent_exit (2);
2093       }
2094     if (redirected)
2095       {
2096         *r_redir_name = xstrdup (unaddr->sun_path);
2097         if (opt.verbose)
2098           log_info ("redirecting socket '%s' to '%s'\n", name, *r_redir_name);
2099       }
2100   }
2101
2102   len = SUN_LEN (unaddr);
2103   rc = assuan_sock_bind (fd, addr, len);
2104
2105   /* Our error code mapping on W32CE returns EEXIST thus we also test
2106      for this. */
2107   if (rc == -1
2108       && (errno == EADDRINUSE
2109 #ifdef HAVE_W32_SYSTEM
2110           || errno == EEXIST
2111 #endif
2112           ))
2113     {
2114       /* Check whether a gpg-agent is already running.  We do this
2115          test only if this is the primary socket.  For secondary
2116          sockets we assume that a test for gpg-agent has already been
2117          done and reuse the requested socket.  Testing the ssh-socket
2118          is not possible because at this point, though we know the new
2119          Assuan socket, the Assuan server and thus the ssh-agent
2120          server is not yet operational; this would lead to a hang.  */
2121       if (primary && !check_for_running_agent (1))
2122         {
2123           log_set_prefix (NULL, GPGRT_LOG_WITH_PREFIX);
2124           log_set_file (NULL);
2125           log_error (_("a gpg-agent is already running - "
2126                        "not starting a new one\n"));
2127           *name = 0; /* Inhibit removal of the socket by cleanup(). */
2128           assuan_sock_close (fd);
2129           agent_exit (2);
2130         }
2131       gnupg_remove (unaddr->sun_path);
2132       rc = assuan_sock_bind (fd, addr, len);
2133     }
2134   if (rc != -1 && (rc=assuan_sock_get_nonce (addr, len, nonce)))
2135     log_error (_("error getting nonce for the socket\n"));
2136   if (rc == -1)
2137     {
2138       /* We use gpg_strerror here because it allows us to get strings
2139          for some W32 socket error codes.  */
2140       log_error (_("error binding socket to '%s': %s\n"),
2141                  unaddr->sun_path,
2142                  gpg_strerror (gpg_error_from_syserror ()));
2143
2144       assuan_sock_close (fd);
2145       *name = 0; /* Inhibit removal of the socket by cleanup(). */
2146       agent_exit (2);
2147     }
2148
2149   if (gnupg_chmod (unaddr->sun_path, "-rwx"))
2150     log_error (_("can't set permissions of '%s': %s\n"),
2151                unaddr->sun_path, strerror (errno));
2152
2153   if (listen (FD2INT(fd), 5 ) == -1)
2154     {
2155       log_error (_("listen() failed: %s\n"), strerror (errno));
2156       *name = 0; /* Inhibit removal of the socket by cleanup(). */
2157       assuan_sock_close (fd);
2158       agent_exit (2);
2159     }
2160
2161   if (opt.verbose)
2162     log_info (_("listening on socket '%s'\n"), unaddr->sun_path);
2163
2164   return fd;
2165 }
2166
2167
2168 /* Check that the directory for storing the private keys exists and
2169    create it if not.  This function won't fail as it is only a
2170    convenience function and not strictly necessary.  */
2171 static void
2172 create_private_keys_directory (const char *home)
2173 {
2174   char *fname;
2175   struct stat statbuf;
2176
2177   fname = make_filename (home, GNUPG_PRIVATE_KEYS_DIR, NULL);
2178   if (stat (fname, &statbuf) && errno == ENOENT)
2179     {
2180       if (gnupg_mkdir (fname, "-rwx"))
2181         log_error (_("can't create directory '%s': %s\n"),
2182                    fname, strerror (errno) );
2183       else if (!opt.quiet)
2184         log_info (_("directory '%s' created\n"), fname);
2185     }
2186   if (gnupg_chmod (fname, "-rwx"))
2187     log_error (_("can't set permissions of '%s': %s\n"),
2188                fname, strerror (errno));
2189   xfree (fname);
2190 }
2191
2192
2193 /* Create the directory only if the supplied directory name is the
2194    same as the default one.  This way we avoid to create arbitrary
2195    directories when a non-default home directory is used.  To cope
2196    with HOME, we compare only the suffix if we see that the default
2197    homedir does start with a tilde.  We don't stop here in case of
2198    problems because other functions will throw an error anyway.*/
2199 static void
2200 create_directories (void)
2201 {
2202   struct stat statbuf;
2203   const char *defhome = standard_homedir ();
2204   char *home;
2205
2206   home = make_filename (gnupg_homedir (), NULL);
2207   if ( stat (home, &statbuf) )
2208     {
2209       if (errno == ENOENT)
2210         {
2211           if (
2212 #ifdef HAVE_W32_SYSTEM
2213               ( !compare_filenames (home, defhome) )
2214 #else
2215               (*defhome == '~'
2216                 && (strlen (home) >= strlen (defhome+1)
2217                     && !strcmp (home + strlen(home)
2218                                 - strlen (defhome+1), defhome+1)))
2219                || (*defhome != '~' && !strcmp (home, defhome) )
2220 #endif
2221                )
2222             {
2223               if (gnupg_mkdir (home, "-rwx"))
2224                 log_error (_("can't create directory '%s': %s\n"),
2225                            home, strerror (errno) );
2226               else
2227                 {
2228                   if (!opt.quiet)
2229                     log_info (_("directory '%s' created\n"), home);
2230                   create_private_keys_directory (home);
2231                 }
2232             }
2233         }
2234       else
2235         log_error (_("stat() failed for '%s': %s\n"), home, strerror (errno));
2236     }
2237   else if ( !S_ISDIR(statbuf.st_mode))
2238     {
2239       log_error (_("can't use '%s' as home directory\n"), home);
2240     }
2241   else /* exists and is a directory. */
2242     {
2243       create_private_keys_directory (home);
2244     }
2245   xfree (home);
2246 }
2247
2248
2249
2250 /* This is the worker for the ticker.  It is called every few seconds
2251    and may only do fast operations. */
2252 static void
2253 handle_tick (void)
2254 {
2255   static time_t last_minute;
2256
2257   if (!last_minute)
2258     last_minute = time (NULL);
2259
2260   /* Check whether the scdaemon has died and cleanup in this case. */
2261   agent_scd_check_aliveness ();
2262
2263   /* If we are running as a child of another process, check whether
2264      the parent is still alive and shutdown if not. */
2265 #ifndef HAVE_W32_SYSTEM
2266   if (parent_pid != (pid_t)(-1))
2267     {
2268       if (kill (parent_pid, 0))
2269         {
2270           shutdown_pending = 2;
2271           log_info ("parent process died - shutting down\n");
2272           log_info ("%s %s stopped\n", strusage(11), strusage(13) );
2273           cleanup ();
2274           agent_exit (0);
2275         }
2276     }
2277 #endif /*HAVE_W32_SYSTEM*/
2278
2279   /* Code to be run from time to time.  */
2280 #if CHECK_OWN_SOCKET_INTERVAL > 0
2281   if (last_minute + CHECK_OWN_SOCKET_INTERVAL <= time (NULL))
2282     {
2283       check_own_socket ();
2284       last_minute = time (NULL);
2285     }
2286 #endif
2287
2288 }
2289
2290
2291 /* A global function which allows us to call the reload stuff from
2292    other places too.  This is only used when build for W32.  */
2293 void
2294 agent_sighup_action (void)
2295 {
2296   log_info ("SIGHUP received - "
2297             "re-reading configuration and flushing cache\n");
2298
2299   agent_flush_cache ();
2300   reread_configuration ();
2301   agent_reload_trustlist ();
2302   /* We flush the module name cache so that after installing a
2303      "pinentry" binary that one can be used in case the
2304      "pinentry-basic" fallback was in use.  */
2305   gnupg_module_name_flush_some ();
2306 }
2307
2308
2309 /* A helper function to handle SIGUSR2.  */
2310 static void
2311 agent_sigusr2_action (void)
2312 {
2313   if (opt.verbose)
2314     log_info ("SIGUSR2 received - updating card event counter\n");
2315   /* Nothing to check right now.  We only increment a counter.  */
2316   bump_card_eventcounter ();
2317 }
2318
2319
2320 #ifndef HAVE_W32_SYSTEM
2321 /* The signal handler for this program.  It is expected to be run in
2322    its own trhead and not in the context of a signal handler.  */
2323 static void
2324 handle_signal (int signo)
2325 {
2326   switch (signo)
2327     {
2328 #ifndef HAVE_W32_SYSTEM
2329     case SIGHUP:
2330       agent_sighup_action ();
2331       break;
2332
2333     case SIGUSR1:
2334       log_info ("SIGUSR1 received - printing internal information:\n");
2335       /* Fixme: We need to see how to integrate pth dumping into our
2336          logging system.  */
2337       /* pth_ctrl (PTH_CTRL_DUMPSTATE, log_get_stream ()); */
2338       agent_query_dump_state ();
2339       agent_scd_dump_state ();
2340       break;
2341
2342     case SIGUSR2:
2343       agent_sigusr2_action ();
2344       break;
2345
2346     case SIGTERM:
2347       if (!shutdown_pending)
2348         log_info ("SIGTERM received - shutting down ...\n");
2349       else
2350         log_info ("SIGTERM received - still %i open connections\n",
2351                   active_connections);
2352       shutdown_pending++;
2353       if (shutdown_pending > 2)
2354         {
2355           log_info ("shutdown forced\n");
2356           log_info ("%s %s stopped\n", strusage(11), strusage(13) );
2357           cleanup ();
2358           agent_exit (0);
2359         }
2360       break;
2361
2362     case SIGINT:
2363       log_info ("SIGINT received - immediate shutdown\n");
2364       log_info( "%s %s stopped\n", strusage(11), strusage(13));
2365       cleanup ();
2366       agent_exit (0);
2367       break;
2368 #endif
2369     default:
2370       log_info ("signal %d received - no action defined\n", signo);
2371     }
2372 }
2373 #endif
2374
2375 /* Check the nonce on a new connection.  This is a NOP unless we we
2376    are using our Unix domain socket emulation under Windows.  */
2377 static int
2378 check_nonce (ctrl_t ctrl, assuan_sock_nonce_t *nonce)
2379 {
2380   if (assuan_sock_check_nonce (ctrl->thread_startup.fd, nonce))
2381     {
2382       log_info (_("error reading nonce on fd %d: %s\n"),
2383                 FD2INT(ctrl->thread_startup.fd), strerror (errno));
2384       assuan_sock_close (ctrl->thread_startup.fd);
2385       xfree (ctrl);
2386       return -1;
2387     }
2388   else
2389     return 0;
2390 }
2391
2392
2393 #ifdef HAVE_W32_SYSTEM
2394 /* The window message processing function for Putty.  Warning: This
2395    code runs as a native Windows thread.  Use of our own functions
2396    needs to be bracket with pth_leave/pth_enter. */
2397 static LRESULT CALLBACK
2398 putty_message_proc (HWND hwnd, UINT msg, WPARAM wparam, LPARAM lparam)
2399 {
2400   int ret = 0;
2401   int w32rc;
2402   COPYDATASTRUCT *cds;
2403   const char *mapfile;
2404   HANDLE maphd;
2405   PSID mysid = NULL;
2406   PSID mapsid = NULL;
2407   void *data = NULL;
2408   PSECURITY_DESCRIPTOR psd = NULL;
2409   ctrl_t ctrl = NULL;
2410
2411   if (msg != WM_COPYDATA)
2412     {
2413       return DefWindowProc (hwnd, msg, wparam, lparam);
2414     }
2415
2416   cds = (COPYDATASTRUCT*)lparam;
2417   if (cds->dwData != PUTTY_IPC_MAGIC)
2418     return 0;  /* Ignore data with the wrong magic.  */
2419   mapfile = cds->lpData;
2420   if (!cds->cbData || mapfile[cds->cbData - 1])
2421     return 0;  /* Ignore empty and non-properly terminated strings.  */
2422
2423   if (DBG_IPC)
2424     {
2425       npth_protect ();
2426       log_debug ("ssh map file '%s'", mapfile);
2427       npth_unprotect ();
2428     }
2429
2430   maphd = OpenFileMapping (FILE_MAP_ALL_ACCESS, FALSE, mapfile);
2431   if (DBG_IPC)
2432     {
2433       npth_protect ();
2434       log_debug ("ssh map handle %p\n", maphd);
2435       npth_unprotect ();
2436     }
2437
2438   if (!maphd || maphd == INVALID_HANDLE_VALUE)
2439     return 0;
2440
2441   npth_protect ();
2442
2443   mysid = w32_get_user_sid ();
2444   if (!mysid)
2445     {
2446       log_error ("error getting my sid\n");
2447       goto leave;
2448     }
2449
2450   w32rc = GetSecurityInfo (maphd, SE_KERNEL_OBJECT,
2451                            OWNER_SECURITY_INFORMATION,
2452                            &mapsid, NULL, NULL, NULL,
2453                            &psd);
2454   if (w32rc)
2455     {
2456       log_error ("error getting sid of ssh map file: rc=%d", w32rc);
2457       goto leave;
2458     }
2459
2460   if (DBG_IPC)
2461     {
2462       char *sidstr;
2463
2464       if (!ConvertSidToStringSid (mysid, &sidstr))
2465         sidstr = NULL;
2466       log_debug ("          my sid: '%s'", sidstr? sidstr: "[error]");
2467       LocalFree (sidstr);
2468       if (!ConvertSidToStringSid (mapsid, &sidstr))
2469         sidstr = NULL;
2470       log_debug ("ssh map file sid: '%s'", sidstr? sidstr: "[error]");
2471       LocalFree (sidstr);
2472     }
2473
2474   if (!EqualSid (mysid, mapsid))
2475     {
2476       log_error ("ssh map file has a non-matching sid\n");
2477       goto leave;
2478     }
2479
2480   data = MapViewOfFile (maphd, FILE_MAP_ALL_ACCESS, 0, 0, 0);
2481   if (DBG_IPC)
2482     log_debug ("ssh IPC buffer at %p\n", data);
2483   if (!data)
2484     goto leave;
2485
2486   /* log_printhex ("request:", data, 20); */
2487
2488   ctrl = xtrycalloc (1, sizeof *ctrl);
2489   if (!ctrl)
2490     {
2491       log_error ("error allocating connection control data: %s\n",
2492                  strerror (errno) );
2493       goto leave;
2494     }
2495   ctrl->session_env = session_env_new ();
2496   if (!ctrl->session_env)
2497     {
2498       log_error ("error allocating session environment block: %s\n",
2499                  strerror (errno) );
2500       goto leave;
2501     }
2502
2503   agent_init_default_ctrl (ctrl);
2504   if (!serve_mmapped_ssh_request (ctrl, data, PUTTY_IPC_MAXLEN))
2505     ret = 1; /* Valid ssh message has been constructed.  */
2506   agent_deinit_default_ctrl (ctrl);
2507   /* log_printhex ("  reply:", data, 20); */
2508
2509  leave:
2510   xfree (ctrl);
2511   if (data)
2512     UnmapViewOfFile (data);
2513   xfree (mapsid);
2514   if (psd)
2515     LocalFree (psd);
2516   xfree (mysid);
2517   CloseHandle (maphd);
2518
2519   npth_unprotect ();
2520
2521   return ret;
2522 }
2523 #endif /*HAVE_W32_SYSTEM*/
2524
2525
2526 #ifdef HAVE_W32_SYSTEM
2527 /* The thread handling Putty's IPC requests.  */
2528 static void *
2529 putty_message_thread (void *arg)
2530 {
2531   WNDCLASS wndwclass = {0, putty_message_proc, 0, 0,
2532                         NULL, NULL, NULL, NULL, NULL, "Pageant"};
2533   HWND hwnd;
2534   MSG msg;
2535
2536   (void)arg;
2537
2538   if (opt.verbose)
2539     log_info ("putty message loop thread started\n");
2540
2541   /* The message loop runs as thread independent from our nPth system.
2542      This also means that we need to make sure that we switch back to
2543      our system before calling any no-windows function.  */
2544   npth_unprotect ();
2545
2546   /* First create a window to make sure that a message queue exists
2547      for this thread.  */
2548   if (!RegisterClass (&wndwclass))
2549     {
2550       npth_protect ();
2551       log_error ("error registering Pageant window class");
2552       return NULL;
2553     }
2554   hwnd = CreateWindowEx (0, "Pageant", "Pageant", 0,
2555                          0, 0, 0, 0,
2556                          HWND_MESSAGE,  /* hWndParent */
2557                          NULL,          /* hWndMenu   */
2558                          NULL,          /* hInstance  */
2559                          NULL);         /* lpParm     */
2560   if (!hwnd)
2561     {
2562       npth_protect ();
2563       log_error ("error creating Pageant window");
2564       return NULL;
2565     }
2566
2567   while (GetMessage(&msg, NULL, 0, 0))
2568     {
2569       TranslateMessage(&msg);
2570       DispatchMessage(&msg);
2571     }
2572
2573   /* Back to nPth.  */
2574   npth_protect ();
2575
2576   if (opt.verbose)
2577     log_info ("putty message loop thread stopped\n");
2578   return NULL;
2579 }
2580 #endif /*HAVE_W32_SYSTEM*/
2581
2582
2583 static void *
2584 do_start_connection_thread (ctrl_t ctrl)
2585 {
2586   active_connections++;
2587   agent_init_default_ctrl (ctrl);
2588   if (opt.verbose && !DBG_IPC)
2589     log_info (_("handler 0x%lx for fd %d started\n"),
2590               (unsigned long) npth_self(), FD2INT(ctrl->thread_startup.fd));
2591
2592   start_command_handler (ctrl, GNUPG_INVALID_FD, ctrl->thread_startup.fd);
2593   if (opt.verbose && !DBG_IPC)
2594     log_info (_("handler 0x%lx for fd %d terminated\n"),
2595               (unsigned long) npth_self(), FD2INT(ctrl->thread_startup.fd));
2596
2597   agent_deinit_default_ctrl (ctrl);
2598   xfree (ctrl);
2599   active_connections--;
2600   return NULL;
2601 }
2602
2603
2604 /* This is the standard connection thread's main function.  */
2605 static void *
2606 start_connection_thread_std (void *arg)
2607 {
2608   ctrl_t ctrl = arg;
2609
2610   if (check_nonce (ctrl, &socket_nonce))
2611     {
2612       log_error ("handler 0x%lx nonce check FAILED\n",
2613                  (unsigned long) npth_self());
2614       return NULL;
2615     }
2616
2617   return do_start_connection_thread (ctrl);
2618 }
2619
2620
2621 /* This is the extra socket connection thread's main function.  */
2622 static void *
2623 start_connection_thread_extra (void *arg)
2624 {
2625   ctrl_t ctrl = arg;
2626
2627   if (check_nonce (ctrl, &socket_nonce_extra))
2628     {
2629       log_error ("handler 0x%lx nonce check FAILED\n",
2630                  (unsigned long) npth_self());
2631       return NULL;
2632     }
2633
2634   ctrl->restricted = 1;
2635   return do_start_connection_thread (ctrl);
2636 }
2637
2638
2639 /* This is the browser socket connection thread's main function.  */
2640 static void *
2641 start_connection_thread_browser (void *arg)
2642 {
2643   ctrl_t ctrl = arg;
2644
2645   if (check_nonce (ctrl, &socket_nonce_browser))
2646     {
2647       log_error ("handler 0x%lx nonce check FAILED\n",
2648                  (unsigned long) npth_self());
2649       return NULL;
2650     }
2651
2652   ctrl->restricted = 2;
2653   return do_start_connection_thread (ctrl);
2654 }
2655
2656
2657 /* This is the ssh connection thread's main function.  */
2658 static void *
2659 start_connection_thread_ssh (void *arg)
2660 {
2661   ctrl_t ctrl = arg;
2662
2663   if (check_nonce (ctrl, &socket_nonce_ssh))
2664     return NULL;
2665
2666   active_connections++;
2667   agent_init_default_ctrl (ctrl);
2668   if (opt.verbose)
2669     log_info (_("ssh handler 0x%lx for fd %d started\n"),
2670               (unsigned long) npth_self(), FD2INT(ctrl->thread_startup.fd));
2671
2672   start_command_handler_ssh (ctrl, ctrl->thread_startup.fd);
2673   if (opt.verbose)
2674     log_info (_("ssh handler 0x%lx for fd %d terminated\n"),
2675               (unsigned long) npth_self(), FD2INT(ctrl->thread_startup.fd));
2676
2677   agent_deinit_default_ctrl (ctrl);
2678   xfree (ctrl);
2679   active_connections--;
2680   return NULL;
2681 }
2682
2683
2684 #ifdef HAVE_INOTIFY_INIT
2685 /* Read an inotify event and return true if it matches NAME.  */
2686 static int
2687 my_inotify_is_name (int fd, const char *name)
2688 {
2689   union {
2690     struct inotify_event ev;
2691     char _buf[sizeof (struct inotify_event) + 100 + 1];
2692   } buf;
2693   int n;
2694
2695   n = npth_read (fd, &buf, sizeof buf);
2696   if (n < sizeof (struct inotify_event))
2697     return 0;
2698   if (buf.ev.len < strlen (name)+1)
2699     return 0;
2700   if (strcmp (buf.ev.name, name))
2701     return 0; /* Not the desired file.  */
2702
2703   return 1; /* Found.  */
2704 }
2705 #endif /*HAVE_INOTIFY_INIT*/
2706
2707
2708
2709 /* Connection handler loop.  Wait for connection requests and spawn a
2710    thread after accepting a connection.  */
2711 static void
2712 handle_connections (gnupg_fd_t listen_fd,
2713                     gnupg_fd_t listen_fd_extra,
2714                     gnupg_fd_t listen_fd_browser,
2715                     gnupg_fd_t listen_fd_ssh)
2716 {
2717   npth_attr_t tattr;
2718   struct sockaddr_un paddr;
2719   socklen_t plen;
2720   fd_set fdset, read_fdset;
2721   int ret;
2722   gnupg_fd_t fd;
2723   int nfd;
2724   int saved_errno;
2725   struct timespec abstime;
2726   struct timespec curtime;
2727   struct timespec timeout;
2728 #ifdef HAVE_W32_SYSTEM
2729   HANDLE events[2];
2730   unsigned int events_set;
2731 #endif
2732 #ifdef HAVE_INOTIFY_INIT
2733   int my_inotify_fd;
2734 #endif /*HAVE_INOTIFY_INIT*/
2735   struct {
2736     const char *name;
2737     void *(*func) (void *arg);
2738     gnupg_fd_t l_fd;
2739   } listentbl[] = {
2740     { "std",     start_connection_thread_std   },
2741     { "extra",   start_connection_thread_extra },
2742     { "browser", start_connection_thread_browser },
2743     { "ssh",    start_connection_thread_ssh   }
2744   };
2745
2746
2747   ret = npth_attr_init(&tattr);
2748   if (ret)
2749     log_fatal ("error allocating thread attributes: %s\n",
2750                strerror (ret));
2751   npth_attr_setdetachstate (&tattr, NPTH_CREATE_DETACHED);
2752
2753 #ifndef HAVE_W32_SYSTEM
2754   npth_sigev_init ();
2755   npth_sigev_add (SIGHUP);
2756   npth_sigev_add (SIGUSR1);
2757   npth_sigev_add (SIGUSR2);
2758   npth_sigev_add (SIGINT);
2759   npth_sigev_add (SIGTERM);
2760   npth_sigev_fini ();
2761 #else
2762 # ifdef HAVE_W32CE_SYSTEM
2763   /* Use a dummy event. */
2764   sigs = 0;
2765   ev = pth_event (PTH_EVENT_SIGS, &sigs, &signo);
2766 # else
2767   events[0] = get_agent_scd_notify_event ();
2768   events[1] = INVALID_HANDLE_VALUE;
2769 # endif
2770 #endif
2771
2772 #ifdef HAVE_INOTIFY_INIT
2773   if (disable_check_own_socket)
2774     my_inotify_fd = -1;
2775   else if ((my_inotify_fd = inotify_init ()) == -1)
2776     log_info ("error enabling fast daemon termination: %s\n",
2777               strerror (errno));
2778   else
2779     {
2780       /* We need to watch the directory for the file because there
2781        * won't be an IN_DELETE_SELF for a socket file.  */
2782       char *slash = strrchr (socket_name, '/');
2783       log_assert (slash && slash[1]);
2784       *slash = 0;
2785       if (inotify_add_watch (my_inotify_fd, socket_name, IN_DELETE) == -1)
2786         {
2787           close (my_inotify_fd);
2788           my_inotify_fd = -1;
2789         }
2790       *slash = '/';
2791     }
2792 #endif /*HAVE_INOTIFY_INIT*/
2793
2794   /* On Windows we need to fire up a separate thread to listen for
2795      requests from Putty (an SSH client), so we can replace Putty's
2796      Pageant (its ssh-agent implementation). */
2797 #ifdef HAVE_W32_SYSTEM
2798   if (putty_support)
2799     {
2800       npth_t thread;
2801
2802       ret = npth_create (&thread, &tattr, putty_message_thread, NULL);
2803       if (ret)
2804         {
2805           log_error ("error spawning putty message loop: %s\n", strerror (ret));
2806         }
2807     }
2808 #endif /*HAVE_W32_SYSTEM*/
2809
2810   /* Set a flag to tell call-scd.c that it may enable event
2811      notifications.  */
2812   opt.sigusr2_enabled = 1;
2813
2814   FD_ZERO (&fdset);
2815   FD_SET (FD2INT (listen_fd), &fdset);
2816   nfd = FD2INT (listen_fd);
2817   if (listen_fd_extra != GNUPG_INVALID_FD)
2818     {
2819       FD_SET ( FD2INT(listen_fd_extra), &fdset);
2820       if (FD2INT (listen_fd_extra) > nfd)
2821         nfd = FD2INT (listen_fd_extra);
2822     }
2823   if (listen_fd_browser != GNUPG_INVALID_FD)
2824     {
2825       FD_SET ( FD2INT(listen_fd_browser), &fdset);
2826       if (FD2INT (listen_fd_browser) > nfd)
2827         nfd = FD2INT (listen_fd_browser);
2828     }
2829   if (listen_fd_ssh != GNUPG_INVALID_FD)
2830     {
2831       FD_SET ( FD2INT(listen_fd_ssh), &fdset);
2832       if (FD2INT (listen_fd_ssh) > nfd)
2833         nfd = FD2INT (listen_fd_ssh);
2834     }
2835 #ifdef HAVE_INOTIFY_INIT
2836   if (my_inotify_fd != -1)
2837     {
2838       FD_SET (my_inotify_fd, &fdset);
2839       if (my_inotify_fd > nfd)
2840         nfd = my_inotify_fd;
2841     }
2842 #endif /*HAVE_INOTIFY_INIT*/
2843
2844   listentbl[0].l_fd = listen_fd;
2845   listentbl[1].l_fd = listen_fd_extra;
2846   listentbl[2].l_fd = listen_fd_browser;
2847   listentbl[3].l_fd = listen_fd_ssh;
2848
2849   npth_clock_gettime (&abstime);
2850   abstime.tv_sec += TIMERTICK_INTERVAL;
2851
2852   for (;;)
2853     {
2854       /* Shutdown test.  */
2855       if (shutdown_pending)
2856         {
2857           if (active_connections == 0)
2858             break; /* ready */
2859
2860           /* Do not accept new connections but keep on running the
2861              loop to cope with the timer events.  */
2862           FD_ZERO (&fdset);
2863         }
2864
2865       /* POSIX says that fd_set should be implemented as a structure,
2866          thus a simple assignment is fine to copy the entire set.  */
2867       read_fdset = fdset;
2868
2869       npth_clock_gettime (&curtime);
2870       if (!(npth_timercmp (&curtime, &abstime, <)))
2871         {
2872           /* Timeout.  */
2873           handle_tick ();
2874           npth_clock_gettime (&abstime);
2875           abstime.tv_sec += TIMERTICK_INTERVAL;
2876         }
2877       npth_timersub (&abstime, &curtime, &timeout);
2878
2879 #ifndef HAVE_W32_SYSTEM
2880       ret = npth_pselect (nfd+1, &read_fdset, NULL, NULL, &timeout,
2881                           npth_sigev_sigmask ());
2882       saved_errno = errno;
2883
2884       {
2885         int signo;
2886         while (npth_sigev_get_pending (&signo))
2887           handle_signal (signo);
2888       }
2889 #else
2890       ret = npth_eselect (nfd+1, &read_fdset, NULL, NULL, &timeout,
2891                           events, &events_set);
2892       saved_errno = errno;
2893
2894       /* This is valid even if npth_eselect returns an error.  */
2895       if (events_set & 1)
2896         agent_sigusr2_action ();
2897 #endif
2898
2899       if (ret == -1 && saved_errno != EINTR)
2900         {
2901           log_error (_("npth_pselect failed: %s - waiting 1s\n"),
2902                      strerror (saved_errno));
2903           npth_sleep (1);
2904           continue;
2905         }
2906       if (ret <= 0)
2907         /* Interrupt or timeout.  Will be handled when calculating the
2908            next timeout.  */
2909         continue;
2910
2911       if (!shutdown_pending)
2912         {
2913           int idx;
2914           ctrl_t ctrl;
2915           npth_t thread;
2916
2917 #ifdef HAVE_INOTIFY_INIT
2918           if (my_inotify_fd != -1 && FD_ISSET (my_inotify_fd, &read_fdset)
2919               && my_inotify_is_name (my_inotify_fd, GPG_AGENT_SOCK_NAME))
2920             {
2921               shutdown_pending = 1;
2922               log_info ("socket file has been removed - shutting down\n");
2923             }
2924 #endif /*HAVE_INOTIFY_INIT*/
2925
2926           for (idx=0; idx < DIM(listentbl); idx++)
2927             {
2928               if (listentbl[idx].l_fd == GNUPG_INVALID_FD)
2929                 continue;
2930               if (!FD_ISSET (FD2INT (listentbl[idx].l_fd), &read_fdset))
2931                 continue;
2932
2933               plen = sizeof paddr;
2934               fd = INT2FD (npth_accept (FD2INT(listentbl[idx].l_fd),
2935                                         (struct sockaddr *)&paddr, &plen));
2936               if (fd == GNUPG_INVALID_FD)
2937                 {
2938                   log_error ("accept failed for %s: %s\n",
2939                              listentbl[idx].name, strerror (errno));
2940                 }
2941               else if ( !(ctrl = xtrycalloc (1, sizeof *ctrl)))
2942                 {
2943                   log_error ("error allocating connection data for %s: %s\n",
2944                              listentbl[idx].name, strerror (errno) );
2945                   assuan_sock_close (fd);
2946                 }
2947               else if ( !(ctrl->session_env = session_env_new ()))
2948                 {
2949                   log_error ("error allocating session env block for %s: %s\n",
2950                              listentbl[idx].name, strerror (errno) );
2951                   xfree (ctrl);
2952                   assuan_sock_close (fd);
2953                 }
2954               else
2955                 {
2956                   ctrl->thread_startup.fd = fd;
2957                   ret = npth_create (&thread, &tattr,
2958                                      listentbl[idx].func, ctrl);
2959                   if (ret)
2960                     {
2961                       log_error ("error spawning connection handler for %s:"
2962                                  " %s\n", listentbl[idx].name, strerror (ret));
2963                       assuan_sock_close (fd);
2964                       xfree (ctrl);
2965                     }
2966                 }
2967               fd = GNUPG_INVALID_FD;
2968             }
2969         }
2970     }
2971
2972 #ifdef HAVE_INOTIFY_INIT
2973   if (my_inotify_fd != -1)
2974     close (my_inotify_fd);
2975 #endif /*HAVE_INOTIFY_INIT*/
2976   cleanup ();
2977   log_info (_("%s %s stopped\n"), strusage(11), strusage(13));
2978   npth_attr_destroy (&tattr);
2979 }
2980
2981
2982
2983 /* Helper for check_own_socket.  */
2984 static gpg_error_t
2985 check_own_socket_pid_cb (void *opaque, const void *buffer, size_t length)
2986 {
2987   membuf_t *mb = opaque;
2988   put_membuf (mb, buffer, length);
2989   return 0;
2990 }
2991
2992
2993 /* The thread running the actual check.  We need to run this in a
2994    separate thread so that check_own_thread can be called from the
2995    timer tick.  */
2996 static void *
2997 check_own_socket_thread (void *arg)
2998 {
2999   int rc;
3000   char *sockname = arg;
3001   assuan_context_t ctx = NULL;
3002   membuf_t mb;
3003   char *buffer;
3004
3005   check_own_socket_running++;
3006
3007   rc = assuan_new (&ctx);
3008   if (rc)
3009     {
3010       log_error ("can't allocate assuan context: %s\n", gpg_strerror (rc));
3011       goto leave;
3012     }
3013   assuan_set_flag (ctx, ASSUAN_NO_LOGGING, 1);
3014
3015   rc = assuan_socket_connect (ctx, sockname, (pid_t)(-1), 0);
3016   if (rc)
3017     {
3018       log_error ("can't connect my own socket: %s\n", gpg_strerror (rc));
3019       goto leave;
3020     }
3021
3022   init_membuf (&mb, 100);
3023   rc = assuan_transact (ctx, "GETINFO pid", check_own_socket_pid_cb, &mb,
3024                         NULL, NULL, NULL, NULL);
3025   put_membuf (&mb, "", 1);
3026   buffer = get_membuf (&mb, NULL);
3027   if (rc || !buffer)
3028     {
3029       log_error ("sending command \"%s\" to my own socket failed: %s\n",
3030                  "GETINFO pid", gpg_strerror (rc));
3031       rc = 1;
3032     }
3033   else if ( (pid_t)strtoul (buffer, NULL, 10) != getpid ())
3034     {
3035       log_error ("socket is now serviced by another server\n");
3036       rc = 1;
3037     }
3038   else if (opt.verbose > 1)
3039     log_error ("socket is still served by this server\n");
3040
3041   xfree (buffer);
3042
3043  leave:
3044   xfree (sockname);
3045   if (ctx)
3046     assuan_release (ctx);
3047   if (rc)
3048     {
3049       /* We may not remove the socket as it is now in use by another
3050          server.  Setting the name to empty does this.  */
3051       if (socket_name)
3052         *socket_name = 0;
3053       if (socket_name_ssh)
3054         *socket_name_ssh = 0;
3055       shutdown_pending = 2;
3056       log_info ("this process is useless - shutting down\n");
3057     }
3058   check_own_socket_running--;
3059   return NULL;
3060 }
3061
3062
3063 /* Check whether we are still listening on our own socket.  In case
3064    another gpg-agent process started after us has taken ownership of
3065    our socket, we would linger around without any real task.  Thus we
3066    better check once in a while whether we are really needed.  */
3067 static void
3068 check_own_socket (void)
3069 {
3070   char *sockname;
3071   npth_t thread;
3072   npth_attr_t tattr;
3073   int err;
3074
3075   if (disable_check_own_socket)
3076     return;
3077
3078   if (check_own_socket_running || shutdown_pending)
3079     return;  /* Still running or already shutting down.  */
3080
3081   sockname = make_filename_try (gnupg_socketdir (), GPG_AGENT_SOCK_NAME, NULL);
3082   if (!sockname)
3083     return; /* Out of memory.  */
3084
3085   err = npth_attr_init (&tattr);
3086   if (err)
3087     return;
3088   npth_attr_setdetachstate (&tattr, NPTH_CREATE_DETACHED);
3089   err = npth_create (&thread, &tattr, check_own_socket_thread, sockname);
3090   if (err)
3091     log_error ("error spawning check_own_socket_thread: %s\n", strerror (err));
3092   npth_attr_destroy (&tattr);
3093 }
3094
3095
3096
3097 /* Figure out whether an agent is available and running. Prints an
3098    error if not.  If SILENT is true, no messages are printed.
3099    Returns 0 if the agent is running. */
3100 static int
3101 check_for_running_agent (int silent)
3102 {
3103   gpg_error_t err;
3104   char *sockname;
3105   assuan_context_t ctx = NULL;
3106
3107   sockname = make_filename_try (gnupg_socketdir (), GPG_AGENT_SOCK_NAME, NULL);
3108   if (!sockname)
3109     return gpg_error_from_syserror ();
3110
3111   err = assuan_new (&ctx);
3112   if (!err)
3113     err = assuan_socket_connect (ctx, sockname, (pid_t)(-1), 0);
3114   xfree (sockname);
3115   if (err)
3116     {
3117       if (!silent)
3118         log_error (_("no gpg-agent running in this session\n"));
3119
3120       if (ctx)
3121         assuan_release (ctx);
3122       return -1;
3123     }
3124
3125   if (!opt.quiet && !silent)
3126     log_info ("gpg-agent running and available\n");
3127
3128   assuan_release (ctx);
3129   return 0;
3130 }