tinc/src/tincd.c

/*
    tincd.c -- the main file for tincd
    Copyright (C) 1998,1999,2000 Ivo Timmermans <itimmermans@bigfoot.com>
                            2000 Guus Sliepen <guus@sliepen.warande.net>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

    $Id: tincd.c,v 1.10 2000/05/31 18:23:06 zarq Exp $
*/

#include "config.h"

#include <errno.h>
#include <fcntl.h> 
#include <getopt.h>
#include <signal.h>
#include <stdio.h>
#include <sys/types.h>
#include <syslog.h>
#include <unistd.h>

#ifdef HAVE_SYS_IOCTL_H
# include <sys/ioctl.h>
#endif

#include <pidfile.h>
#include <utils.h>
#include <xalloc.h>

#include "conf.h"
#include "encr.h"
#include "net.h"
#include "netutl.h"

#include "system.h"

/* The name this program was run with. */
char *program_name;

/* If nonzero, display usage information and exit. */
static int show_help;

/* If nonzero, print the version on standard output and exit.  */
static int show_version;

/* If nonzero, it will attempt to kill a running tincd and exit. */
static int kill_tincd = 0;

/* If zero, don't detach from the terminal. */
static int do_detach = 1;

char *confbase = NULL;           /* directory in which all config files are */
char *configfilename = NULL;     /* configuration file name */
char *identname;                 /* program name for syslog */
char *netname = NULL;            /* name of the vpn network */
char *pidfilename;               /* pid file location */
static pid_t ppid;               /* pid of non-detached part */
char **g_argv;                   /* a copy of the cmdline arguments */

void cleanup_and_exit(int);
int detach(void);
int kill_other(void);
void make_names(void);
RETSIGTYPE parent_exit(int a);
void setup_signals(void);
int write_pidfile(void);

static struct option const long_options[] =
{
  { "kill", no_argument, NULL, 'k' },
  { "net", required_argument, NULL, 'n' },
  { "timeout", required_argument, NULL, 'p' },
  { "help", no_argument, &show_help, 1 },
  { "version", no_argument, &show_version, 1 },
  { "no-detach", no_argument, &do_detach, 0 },
  { NULL, 0, NULL, 0 }
};

static void
usage(int status)
{
  if(status != 0)
    fprintf(stderr, _("Try `%s --help\' for more information.\n"), program_name);
  else
    {
      printf(_("Usage: %s [option]...\n\n"), program_name);
      printf(_("  -c, --config=FILE     Read configuration options from FILE.\n"
	       "  -D, --no-detach       Don't fork and detach.\n"
	       "  -d                    Increase debug level.\n"
	       "  -k, --kill            Attempt to kill a running tincd and exit.\n"
	       "  -n, --net=NETNAME     Connect to net NETNAME.\n"
	       "  -t, --timeout=TIMEOUT Seconds to wait before giving a timeout.\n"));
      printf(_("      --help            Display this help and exit.\n"
 	       "      --version         Output version information and exit.\n\n"));
      printf(_("Report bugs to tinc@nl.linux.org.\n"));
    }
  exit(status);
}

void
parse_options(int argc, char **argv, char **envp)
{
  int r;
  int option_index = 0;
  config_t *p;

  while((r = getopt_long(argc, argv, "c:Ddkn:t:", long_options, &option_index)) != EOF)
    {
      switch(r)
        {
        case 0: /* long option */
          break;
	case 'c': /* config file */
	  configfilename = xmalloc(strlen(optarg)+1);
	  strcpy(configfilename, optarg);
	  break;
	case 'D': /* no detach */
	  do_detach = 0;
	  break;
	case 'd': /* inc debug level */
	  debug_lvl++;
	  break;
	case 'k': /* kill old tincds */
	  kill_tincd = 1;
	  break;
	case 'n': /* net name given */
	  netname = xmalloc(strlen(optarg)+1);
	  strcpy(netname, optarg);
	  break;
	case 't': /* timeout */
	  if(!(p = add_config_val(&config, TYPE_INT, optarg)))
	    {
	      printf(_("Invalid timeout value `%s'.\n"), optarg);
	      usage(1);
	    }
	  break;
        case '?':
          usage(1);
        default:
          break;
        }
    }
}

void memory_full(int size)
{
  syslog(LOG_ERR, _("Memory exhausted (last is %s:%d) (couldn't allocate %d bytes); exiting."), cp_file, cp_line, size);
  exit(1);
}

/*
  Detach from current terminal, write pidfile, kill parent
*/
int detach(void)
{
  int fd;
  pid_t pid;

  if(do_detach)
    {
      ppid = getpid();

      if((pid = fork()) < 0)
	{
	  perror("fork");
	  return -1;
	}
      if(pid) /* parent process */
	{
	  signal(SIGTERM, parent_exit);
	  sleep(600); /* wait 10 minutes */
	  exit(1);
	}
    }
  
  if(write_pidfile())
    return -1;

  if(do_detach)
    {
      if((fd = open("/dev/tty", O_RDWR)) >= 0)
	{
	  if(ioctl(fd, TIOCNOTTY, NULL))
	    {
	      perror("ioctl");
	      return -1;
	    }
	  close(fd);
	}

      if(setsid() < 0)
	return -1;

      kill(ppid, SIGTERM);
    }
  
  chdir("/"); /* avoid keeping a mointpoint busy */

  openlog(identname, LOG_CONS | LOG_PID, LOG_DAEMON);

  if(debug_lvl > 1)
    syslog(LOG_NOTICE, _("tincd %s (%s %s) starting, debug level %d."),
	   VERSION, __DATE__, __TIME__, debug_lvl);
  else
    syslog(LOG_NOTICE, _("tincd %s starting, debug level %d."), VERSION, debug_lvl);

  xalloc_fail_func = memory_full;

  return 0;
}

/*
  Close network connections, and terminate neatly
*/
void cleanup_and_exit(int c)
{
  close_network_connections();

  if(debug_lvl > 0)
    syslog(LOG_INFO, _("Total bytes written: tap %d, socket %d; bytes read: tap %d, socket %d."),
	   total_tap_out, total_socket_out, total_tap_in, total_socket_in);

  closelog();
  kill(ppid, SIGTERM);
  exit(c);
}

/*
  check for an existing tinc for this net, and write pid to pidfile
*/
int write_pidfile(void)
{
  int pid;

  if((pid = check_pid(pidfilename)))
    {
      if(netname)
	fprintf(stderr, _("A tincd is already running for net `%s' with pid %d.\n"),
		netname, pid);
      else
	fprintf(stderr, _("A tincd is already running with pid %d.\n"), pid);
      return 1;
    }

  /* if it's locked, write-protected, or whatever */
  if(!write_pid(pidfilename))
    return 1;

  return 0;
}

/*
  kill older tincd for this net
*/
int kill_other(void)
{
  int pid;

  if(!(pid = read_pid(pidfilename)))
    {
      if(netname)
	fprintf(stderr, _("No other tincd is running for net `%s'.\n"), netname);
      else
	fprintf(stderr, _("No other tincd is running.\n"));
      return 1;
    }

  errno = 0;    /* No error, sometimes errno is only changed on error */
  /* ESRCH is returned when no process with that pid is found */
  if(kill(pid, SIGTERM) && errno == ESRCH)
    fprintf(stderr, _("Removing stale lock file.\n"));
  remove_pid(pidfilename);

  return 0;
}

/*
  Set all files and paths according to netname
*/
void make_names(void)
{
  if(!configfilename)
    {
      if(netname)
	{
	  configfilename = xmalloc(strlen(netname)+18+strlen(CONFDIR));
	  sprintf(configfilename, "%s/tinc/%s/tinc.conf", CONFDIR, netname);
	}
      else
	{
	  configfilename = xmalloc(17+strlen(CONFDIR));
	  sprintf(configfilename, "%s/tinc/tinc.conf", CONFDIR);
	}
    }
  
  if(netname)
    {
      pidfilename = xmalloc(strlen(netname)+20);
      sprintf(pidfilename, "/var/run/tinc.%s.pid", netname);
      confbase = xmalloc(strlen(netname)+8+strlen(CONFDIR));
      sprintf(confbase, "%s/tinc/%s/", CONFDIR, netname);
      identname = xmalloc(strlen(netname)+7);
      sprintf(identname, "tinc.%s", netname);
    }
  else
    {
      pidfilename = "/var/run/tinc.pid";
      confbase = xmalloc(7+strlen(CONFDIR));
      sprintf(confbase, "%s/tinc/", CONFDIR);
      identname = "tinc";
    }
}

int
main(int argc, char **argv, char **envp)
{
  program_name = argv[0];

  setlocale (LC_ALL, "");
  bindtextdomain (PACKAGE, LOCALEDIR);
  textdomain (PACKAGE);

  parse_options(argc, argv, envp);

  if(show_version)
    {
      printf(_("%s version %s\n"), PACKAGE, VERSION);
      printf(_("Copyright (C) 1998,1999,2000 Ivo Timmermans and others,\n"
	       "see the AUTHORS file for a complete list.\n\n"
	       "tinc comes with ABSOLUTELY NO WARRANTY.  This is free software,\n"
	       "and you are welcome to redistribute it under certain conditions;\n"
	       "see the file COPYING for details.\n\n"));
      printf(_("This product includes software developed by Eric Young (eay@mincom.oz.au)\n"));

      return 0;
    }

  if(show_help)
    usage(0);

  if(geteuid())
    {
      fprintf(stderr, _("You must be root to run this program. sorry.\n"));
      return 1;
    }

  g_argv = argv;

  make_names();

  if(kill_tincd)
    exit(kill_other());

  if(read_config_file(configfilename))
    return 1;

  setup_signals();

  if(detach())
    exit(0);

  if(security_init())
    return 1;

  if(setup_network_connections())
    cleanup_and_exit(1);

  main_loop();

  cleanup_and_exit(1);
  return 1;
}

RETSIGTYPE
sigterm_handler(int a)
{
  if(debug_lvl > 0)
    syslog(LOG_NOTICE, _("Got TERM signal"));
  cleanup_and_exit(0);
}

RETSIGTYPE
sigquit_handler(int a)
{
  if(debug_lvl > 0)
    syslog(LOG_NOTICE, _("Got QUIT signal"));
  cleanup_and_exit(0);
}

RETSIGTYPE
sigsegv_square(int a)
{
  syslog(LOG_NOTICE, _("Got another SEGV signal: not restarting"));
  exit(0);
}

RETSIGTYPE
sigsegv_handler(int a)
{
  if(cp_file)
    syslog(LOG_NOTICE, _("Got SEGV signal after %s line %d. Trying to re-execute."),
	   cp_file, cp_line);
  else
    syslog(LOG_NOTICE, _("Got SEGV signal; trying to re-execute."));

  signal(SIGSEGV, sigsegv_square);

  close_network_connections();
  remove_pid(pidfilename);
  execvp(g_argv[0], g_argv);
}

RETSIGTYPE
sighup_handler(int a)
{
  if(debug_lvl > 0)
    syslog(LOG_NOTICE, _("Got HUP signal"));
  close_network_connections();
  setup_network_connections();
  /* FIXME: read config-file and re-establish network connections */
}

RETSIGTYPE
sigint_handler(int a)
{
  if(debug_lvl > 0)
    syslog(LOG_NOTICE, _("Got INT signal"));
  cleanup_and_exit(0);
}

RETSIGTYPE
sigusr1_handler(int a)
{
  dump_conn_list();
}

RETSIGTYPE
sigusr2_handler(int a)
{
  if(debug_lvl > 1)
    syslog(LOG_NOTICE, _("Forcing new key generation"));
  regenerate_keys();
}

RETSIGTYPE
sighuh(int a)
{
  if(cp_file)
    syslog(LOG_NOTICE, _("Got unexpected signal (%d) after %s line %d."),
	   a, cp_file, cp_line);
  else
    syslog(LOG_NOTICE, _("Got unexpected signal (%d)."), a);
}

void
setup_signals(void)
{
  int i;

  for(i=0;i<32;i++)
    signal(i,sighuh);

  if(signal(SIGTERM, SIG_IGN) != SIG_ERR)
    signal(SIGTERM, sigterm_handler);
  if(signal(SIGQUIT, SIG_IGN) != SIG_ERR)
    signal(SIGQUIT, sigquit_handler);
  if(signal(SIGSEGV, SIG_IGN) != SIG_ERR)
    signal(SIGSEGV, sigsegv_handler);
  if(signal(SIGHUP, SIG_IGN) != SIG_ERR)
    signal(SIGHUP, sighup_handler);
  signal(SIGPIPE, SIG_IGN);
  if(signal(SIGINT, SIG_IGN) != SIG_ERR)
    signal(SIGINT, sigint_handler);
  signal(SIGUSR1, sigusr1_handler);
  signal(SIGUSR2, sigusr2_handler);
  signal(SIGCHLD, parent_exit);
}

RETSIGTYPE parent_exit(int a)
{
  exit(0);
}