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