Changes needed to support smartcards. Well, only _support_. There is
[gnupg.git] / scd / scdaemon.c
1 /* scdaemon.c  -  The GnuPG Smartcard Daemon
2  *      Copyright (C) 2001, 2002 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
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/socket.h>
33 #include <sys/un.h>
34 #include <unistd.h>
35 #include <signal.h>
36
37 #include <ksba.h>
38 #include <gcrypt.h>
39
40 #define JNLIB_NEED_LOG_LOGV
41 #include "scdaemon.h"
42 #include "../assuan/assuan.h" /* malloc hooks */
43
44 #include "sysutils.h"
45
46
47 #define N_(a) a
48 #define _(a) a
49
50
51 enum cmd_and_opt_values 
52 { aNull = 0,
53   oCsh            = 'c',
54   oQuiet          = 'q',
55   oSh             = 's',
56   oVerbose        = 'v',
57   
58   oNoVerbose = 500,
59   oOptions,
60   oDebug,
61   oDebugAll,
62   oDebugWait,
63   oNoGreeting,
64   oNoOptions,
65   oHomedir,
66   oNoDetach,
67   oNoGrab,
68   oLogFile,
69   oServer,
70   oBatch,
71
72 aTest };
73
74
75
76 static ARGPARSE_OPTS opts[] = {
77   
78   { 301, NULL, 0, N_("@Options:\n ") },
79
80   { oServer,   "server",     0, N_("run in server mode") },
81   { oVerbose, "verbose",   0, N_("verbose") },
82   { oQuiet,     "quiet",     0, N_("be somewhat more quiet") },
83   { oSh,        "sh",        0, N_("sh-style command output") },
84   { oCsh,       "csh",       0, N_("csh-style command output") },
85   { oOptions, "options"  , 2, N_("read options from file")},
86   { oDebug,     "debug"     ,4|16, N_("set debugging flags")},
87   { oDebugAll, "debug-all" ,0, N_("enable full debugging")},
88   { oDebugWait,"debug-wait",1, "@"},
89   { oNoDetach, "no-detach" ,0, N_("do not detach from the console")},
90   { oLogFile, "log-file"   ,2, N_("use a log file for the server")},
91
92
93   {0}
94 };
95
96
97 static volatile int caught_fatal_sig = 0;
98
99 /* It is possible that we are currently running under setuid permissions */
100 static int maybe_setuid = 1;
101
102 /* Name of the communication socket */
103 static char socket_name[128];
104
105 static const char *
106 my_strusage (int level)
107 {
108   const char *p;
109   switch (level)
110     {
111     case 11: p = "scdaemon (GnuPG)";
112       break;
113     case 13: p = VERSION; break;
114     case 17: p = PRINTABLE_OS_NAME; break;
115     case 19: p = _("Please report bugs to <" PACKAGE_BUGREPORT ">.\n");
116       break;
117     case 1:
118     case 40: p =  _("Usage: scdaemon [options] (-h for help)");
119       break;
120     case 41: p =  _("Syntax: scdaemon [options] [command [args]]\n"
121                     "Smartcard daemon for GnuPG\n");
122     break;
123     
124     default: p = NULL;
125     }
126   return p;
127 }
128
129
130
131 static void
132 i18n_init (void)
133 {
134 #ifdef USE_SIMPLE_GETTEXT
135     set_gettext_file( PACKAGE );
136 #else
137 #ifdef ENABLE_NLS
138     /* gtk_set_locale (); HMMM: We have not yet called gtk_init */
139     bindtextdomain( PACKAGE, GNUPG_LOCALEDIR );
140     textdomain( PACKAGE );
141 #endif
142 #endif
143 }
144
145
146
147 /* Used by gcry for logging */
148 static void
149 my_gcry_logger (void *dummy, int level, const char *fmt, va_list arg_ptr)
150 {
151   /* translate the log levels */
152   switch (level)
153     {
154     case GCRY_LOG_CONT: level = JNLIB_LOG_CONT; break;
155     case GCRY_LOG_INFO: level = JNLIB_LOG_INFO; break;
156     case GCRY_LOG_WARN: level = JNLIB_LOG_WARN; break;
157     case GCRY_LOG_ERROR:level = JNLIB_LOG_ERROR; break;
158     case GCRY_LOG_FATAL:level = JNLIB_LOG_FATAL; break;
159     case GCRY_LOG_BUG:  level = JNLIB_LOG_BUG; break;
160     case GCRY_LOG_DEBUG:level = JNLIB_LOG_DEBUG; break;
161     default:            level = JNLIB_LOG_ERROR; break;  
162     }
163   log_logv (level, fmt, arg_ptr);
164 }
165
166
167 static void
168 cleanup (void)
169 {
170   if (*socket_name)
171     {
172       char *p;
173
174       remove (socket_name);
175       p = strrchr (socket_name, '/');
176       if (p)
177         {
178           *p = 0;
179           rmdir (socket_name);
180           *p = '/';
181         }
182       *socket_name = 0;
183     }
184 }
185
186
187 static RETSIGTYPE
188 cleanup_sh (int sig)
189 {
190   if (caught_fatal_sig)
191     raise (sig);
192   caught_fatal_sig = 1;
193
194   /* gcry_control( GCRYCTL_TERM_SECMEM );*/
195   cleanup ();
196
197 #ifndef HAVE_DOSISH_SYSTEM
198   {     /* reset action to default action and raise signal again */
199     struct sigaction nact;
200     nact.sa_handler = SIG_DFL;
201     sigemptyset( &nact.sa_mask );
202     nact.sa_flags = 0;
203     sigaction( sig, &nact, NULL);
204   }
205 #endif
206   raise( sig );
207 }
208
209 int
210 main (int argc, char **argv )
211 {
212   ARGPARSE_ARGS pargs;
213   int orig_argc;
214   int may_coredump;
215   char **orig_argv;
216   FILE *configfp = NULL;
217   char *configname = NULL;
218   const char *shell;
219   unsigned configlineno;
220   int parse_debug = 0;
221   int default_config =1;
222   int greeting = 0;
223   int nogreeting = 0;
224   int pipe_server = 0;
225   int nodetach = 0;
226   int csh_style = 0;
227   char *logfile = NULL;
228   int debug_wait = 0;
229
230   set_strusage (my_strusage);
231   gcry_control (GCRYCTL_SUSPEND_SECMEM_WARN);
232   /* Please note that we may running SUID(ROOT), so be very CAREFUL
233      when adding any stuff between here and the call to INIT_SECMEM()
234      somewhere after the option parsing */
235   log_set_prefix ("scdaemon", 1|4); 
236   i18n_init ();
237
238   /* check that the libraries are suitable.  Do it here because
239      the option parsing may need services of the library */
240   if (!gcry_check_version ( "1.1.5" ) )
241     {
242       log_fatal( _("libgcrypt is too old (need %s, have %s)\n"),
243                    "1.1.5", gcry_check_version (NULL) );
244     }
245
246   ksba_set_malloc_hooks (gcry_malloc, gcry_realloc, gcry_free);
247   assuan_set_malloc_hooks (gcry_malloc, gcry_realloc, gcry_free);
248   gcry_set_log_handler (my_gcry_logger, NULL);
249   gcry_control (GCRYCTL_USE_SECURE_RNDPOOL);
250
251   may_coredump = disable_core_dumps ();
252
253   shell = getenv ("SHELL");
254   if (shell && strlen (shell) >= 3 && !strcmp (shell+strlen (shell)-3, "csh") )
255     csh_style = 1;
256   
257   /* FIXME: Using this homedir option does only make sense when not
258      running as a system service.  We might want to check for this by
259      looking at the uid or ebtter use an explict option for this */
260   opt.homedir = getenv("GNUPGHOME");
261   if (!opt.homedir || !*opt.homedir)
262     {
263 #ifdef HAVE_DRIVE_LETTERS
264       opt.homedir = "c:/gnupg-test";
265 #else
266       opt.homedir = "~/.gnupg-test";
267 #endif
268     }
269
270   /* check whether we have a config file on the commandline */
271   orig_argc = argc;
272   orig_argv = argv;
273   pargs.argc = &argc;
274   pargs.argv = &argv;
275   pargs.flags= 1|(1<<6);  /* do not remove the args, ignore version */
276   while (arg_parse( &pargs, opts))
277     {
278       if (pargs.r_opt == oDebug || pargs.r_opt == oDebugAll)
279         parse_debug++;
280       else if (pargs.r_opt == oOptions)
281         { /* yes there is one, so we do not try the default one, but
282              read the option file when it is encountered at the
283              commandline */
284           default_config = 0;
285         }
286         else if (pargs.r_opt == oNoOptions)
287           default_config = 0; /* --no-options */
288         else if (pargs.r_opt == oHomedir)
289           opt.homedir = pargs.r.ret_str;
290     }
291
292   /* initialize the secure memory. */
293   gcry_control (GCRYCTL_INIT_SECMEM, 16384, 0);
294   maybe_setuid = 0;
295
296   /* 
297      Now we are working under our real uid 
298   */
299
300
301   if (default_config)
302     configname = make_filename (opt.homedir, "scdaemon.conf", NULL );
303   
304   argc = orig_argc;
305   argv = orig_argv;
306   pargs.argc = &argc;
307   pargs.argv = &argv;
308   pargs.flags=  1;  /* do not remove the args */
309  next_pass:
310   if (configname)
311     {
312       configlineno = 0;
313       configfp = fopen (configname, "r");
314       if (!configfp)
315         {
316           if (default_config)
317             {
318               if( parse_debug )
319                 log_info (_("NOTE: no default option file `%s'\n"),
320                           configname );
321             }
322           else
323             {
324               log_error (_("option file `%s': %s\n"),
325                          configname, strerror(errno) );
326               exit(2);
327             }
328           xfree (configname); 
329           configname = NULL;
330         }
331       if (parse_debug && configname )
332         log_info (_("reading options from `%s'\n"), configname );
333       default_config = 0;
334     }
335
336   while (optfile_parse( configfp, configname, &configlineno, &pargs, opts) )
337     {
338       switch (pargs.r_opt)
339         {
340         case oQuiet: opt.quiet = 1; break;
341         case oVerbose: opt.verbose++; break;
342         case oBatch: opt.batch=1; break;
343
344         case oDebug: opt.debug |= pargs.r.ret_ulong; break;
345         case oDebugAll: opt.debug = ~0; break;
346         case oDebugWait: debug_wait = pargs.r.ret_int; break;
347
348         case oOptions:
349           /* config files may not be nested (silently ignore them) */
350           if (!configfp)
351             {
352                 xfree(configname);
353                 configname = xstrdup(pargs.r.ret_str);
354                 goto next_pass;
355             }
356           break;
357         case oNoGreeting: nogreeting = 1; break;
358         case oNoVerbose: opt.verbose = 0; break;
359         case oNoOptions: break; /* no-options */
360         case oHomedir: opt.homedir = pargs.r.ret_str; break;
361         case oNoDetach: nodetach = 1; break;
362         case oLogFile: logfile = pargs.r.ret_str; break;
363         case oCsh: csh_style = 1; break;
364         case oSh: csh_style = 0; break;
365         case oServer: pipe_server = 1; break;
366
367         default : pargs.err = configfp? 1:2; break;
368         }
369     }
370   if (configfp)
371     {
372       fclose( configfp );
373       configfp = NULL;
374       xfree(configname);
375       configname = NULL;
376       goto next_pass;
377     }
378   xfree (configname);
379   configname = NULL;
380   if (log_get_errorcount(0))
381     exit(2);
382   if (nogreeting )
383     greeting = 0;
384
385   if (greeting)
386     {
387       fprintf (stderr, "%s %s; %s\n",
388                  strusage(11), strusage(13), strusage(14) );
389       fprintf (stderr, "%s\n", strusage(15) );
390     }
391 #ifdef IS_DEVELOPMENT_VERSION
392   log_info ("NOTE: this is a development version!\n");
393 #endif
394
395   
396   if (atexit (cleanup))
397     {
398       log_error ("atexit failed\n");
399       cleanup ();
400       exit (1);
401     }
402
403   if (debug_wait && pipe_server)
404     {
405       log_debug ("waiting for debugger - my pid is %u .....\n",
406                  (unsigned int)getpid());
407       sleep (debug_wait);
408       log_debug ("... okay\n");
409     }
410   
411   /* now start with logging to a file if this is desired */
412   if (logfile)
413     {
414       log_set_file (logfile);
415       log_set_prefix (NULL, 1|2|4);
416     }
417
418
419   if (pipe_server)
420     { /* this is the simple pipe based server */
421       scd_command_handler (-1);
422     }
423   else
424     { /* regular server mode */
425       int fd;
426       pid_t pid;
427       int i;
428       int len;
429       struct sockaddr_un serv_addr;
430       char *p;
431
432       /* fixme: if there is already a running gpg-agent we should
433          sahre the same directory - and vice versa */
434       *socket_name = 0;
435       snprintf (socket_name, DIM(socket_name)-1,
436                 "/tmp/gpg-XXXXXX/S.scdaemon");
437       socket_name[DIM(socket_name)-1] = 0;
438       p = strrchr (socket_name, '/');
439       if (!p)
440         BUG ();
441       *p = 0;;
442       if (!mkdtemp(socket_name))
443         {
444           log_error ("can't create directory `%s': %s\n",
445                      socket_name, strerror(errno) );
446           exit (1);
447         }
448       *p = '/';
449
450       if (strchr (socket_name, ':') )
451         {
452           log_error ("colons are not allowed in the socket name\n");
453           exit (1);
454         }
455       if (strlen (socket_name)+1 >= sizeof serv_addr.sun_path ) 
456         {
457           log_error ("name of socket to long\n");
458           exit (1);
459         }
460    
461
462       fd = socket (AF_UNIX, SOCK_STREAM, 0);
463       if (fd == -1)
464         {
465           log_error ("can't create socket: %s\n", strerror(errno) );
466           exit (1);
467         }
468
469       memset (&serv_addr, 0, sizeof serv_addr);
470       serv_addr.sun_family = AF_UNIX;
471       strcpy (serv_addr.sun_path, socket_name);
472       len = (offsetof (struct sockaddr_un, sun_path)
473              + strlen(serv_addr.sun_path) + 1);
474
475       if (bind (fd, (struct sockaddr*)&serv_addr, len) == -1)
476         {
477           log_error ("error binding socket to `%s': %s\n",
478                      serv_addr.sun_path, strerror (errno) );
479           close (fd);
480           exit (1);
481         }
482   
483       if (listen (fd, 5 ) == -1)
484         {
485           log_error ("listen() failed: %s\n", strerror (errno));
486           close (fd);
487           exit (1);
488         }
489
490       if (opt.verbose)
491         log_info ("listening on socket `%s'\n", socket_name );
492
493
494       fflush (NULL);
495       pid = fork ();
496       if (pid == (pid_t)-1) 
497         {
498           log_fatal ("fork failed: %s\n", strerror (errno) );
499           exit (1);
500         }
501       else if (pid) 
502         { /* we are the parent */
503           char *infostr;
504           
505           close (fd);
506           
507           /* create the info string: <name>:<pid>:<protocol_version> */
508           if (asprintf (&infostr, "SCDAEMON_INFO=%s:%lu:1",
509                         socket_name, (ulong)pid ) < 0)
510             {
511               log_error ("out of core\n");
512               kill (pid, SIGTERM);
513               exit (1);
514             }
515           *socket_name = 0; /* don't let cleanup() remove the socket -
516                                the child should do this from now on */
517           if (argc) 
518             { /* run the program given on the commandline */
519               if (putenv (infostr))
520                 {
521                   log_error ("failed to set environment: %s\n",
522                              strerror (errno) );
523                   kill (pid, SIGTERM );
524                   exit (1);
525                 }
526               execvp (argv[0], argv);
527               log_error ("failed to run the command: %s\n", strerror (errno));
528               kill (pid, SIGTERM);
529               exit (1);
530             }
531           else
532             {
533               /* print the environment string, so that the caller can use
534                  shell's eval to set it */
535               if (csh_style)
536                 {
537                   *strchr (infostr, '=') = ' ';
538                   printf ( "setenv %s\n", infostr);
539                 }
540               else
541                 {
542                   printf ( "%s; export SCDAEMON_INFO;\n", infostr);
543                 }
544               free (infostr);
545               exit (0); 
546             }
547           /* NOTREACHED */
548         } /* end parent */
549       
550       /* this is the child */
551
552       /* detach from tty and put process into a new session */
553       if (!nodetach )
554         {  /* close stdin, stdout and stderr unless it is the log stream */
555           for (i=0; i <= 2; i++) 
556             {
557               if ( log_get_fd () != i)
558                 close (i);
559             }
560           if (setsid() == -1)
561             {
562               log_error ("setsid() failed: %s\n", strerror(errno) );
563               cleanup ();
564               exit (1);
565             }
566         }
567
568       /* setup signals */
569       {
570         struct sigaction oact, nact;
571         
572         nact.sa_handler = cleanup_sh;
573         sigemptyset (&nact.sa_mask);
574         nact.sa_flags = 0;
575         
576         sigaction (SIGHUP, NULL, &oact);
577         if (oact.sa_handler != SIG_IGN)
578           sigaction (SIGHUP, &nact, NULL);
579         sigaction( SIGTERM, NULL, &oact );
580         if (oact.sa_handler != SIG_IGN)
581           sigaction (SIGTERM, &nact, NULL);
582         nact.sa_handler = SIG_IGN;
583         sigaction (SIGPIPE, &nact, NULL);
584         sigaction (SIGINT, &nact, NULL);
585       }
586
587       if (chdir("/"))
588         {
589           log_error ("chdir to / failed: %s\n", strerror (errno));
590           exit (1);
591         }
592
593       scd_command_handler (fd);
594
595       close (fd);
596     }
597   
598   return 0;
599 }
600
601 void
602 scd_exit (int rc)
603 {
604   #if 0
605 #warning no update_random_seed_file
606   update_random_seed_file();
607   #endif
608 #if 0
609   /* at this time a bit annoying */
610   if (opt.debug & DBG_MEMSTAT_VALUE)
611     {
612       gcry_control( GCRYCTL_DUMP_MEMORY_STATS );
613       gcry_control( GCRYCTL_DUMP_RANDOM_STATS );
614     }
615   if (opt.debug)
616     gcry_control (GCRYCTL_DUMP_SECMEM_STATS );
617 #endif
618   gcry_control (GCRYCTL_TERM_SECMEM );
619   rc = rc? rc : log_get_errorcount(0)? 2 : 0;
620   exit (rc);
621 }
622
623
624 void
625 scd_init_default_ctrl (CTRL ctrl)
626 {
627
628 }
629