chiark / gitweb /
cleanup: provide helpful FILLZERO macro (for certain memset calls)
[secnet.git] / secnet.c
index 0df6e0919c9befd5353acda7a12b133d61d86ee2..f9808b78b828baf036cd3359bb5246f84bbbe7b4 100644 (file)
--- a/secnet.c
+++ b/secnet.c
@@ -1,49 +1,49 @@
-/* $Log: secnet.c,v $
- * Revision 1.1  1996/03/13 22:27:41  sde1000
- * Initial revision
- *
- */
-
-static char *version="secnet version " VERSION " $Date: 1996/03/13 22:27:41 $";
-
+#include "secnet.h"
 #include <stdio.h>
+#include <assert.h>
+#include <limits.h>
 #include <string.h>
 #include <getopt.h>
-#include <stdarg.h>
 #include <errno.h>
+#include <unistd.h>
 #include <sys/socket.h>
-#include <sys/poll.h>
-#include <sys/time.h>
-#include <netinet/in.h>
 #include <arpa/inet.h>
-#include <adns.h>
 #include <pwd.h>
-#include <sys/types.h>
 
-#include "secnet.h"
 #include "util.h"
 #include "conffile.h"
-#include "modules.h"
+#include "process.h"
+
+#if __APPLE__
+/* apple's poll() does not work on char devs */
+# define USE_SELECT 1
+#endif
 
-/* Command-line options (possibly config-file options too) */
-static char *configfile="/etc/secnet/secnet.conf";
+/* XXX should be from autoconf */
+static const char *configfile="/etc/secnet/secnet.conf";
+static const char *sites_key="sites";
+bool_t just_check_config=False;
 static char *userid=NULL;
 static uid_t uid=0;
-static bool_t background=True;
+bool_t background=True;
 static char *pidfile=NULL;
+bool_t require_root_privileges=False;
+cstring_t require_root_privileges_explanation=NULL;
+
+static pid_t secnet_pid;
 
 /* Structures dealing with poll() call */
 struct poll_interest {
     beforepoll_fn *before;
     afterpoll_fn *after;
     void *state;
-    uint32_t max_nfds;
-    uint32_t nfds;
-    string_t desc;
+    int32_t max_nfds;
+    int32_t nfds;
+    cstring_t desc;
     struct poll_interest *next;
 };
 static struct poll_interest *reg=NULL;
-static uint32_t total_nfds=10;
+static int32_t total_nfds=10;
 
 static bool_t finished=False;
 
@@ -62,12 +62,14 @@ static void parse_options(int argc, char **argv)
            {"nodetach", 0, 0, 'n'},
            {"silent", 0, 0, 'f'},
            {"quiet", 0, 0, 'f'},
-           {"debug", 1, 0, 'd'},
+           {"debug", 0, 0, 'd'},
            {"config", 1, 0, 'c'},
+           {"just-check-config", 0, 0, 'j'},
+           {"sites-key", 1, 0, 's'},
            {0,0,0,0}
        };
 
-       c=getopt_long(argc, argv, "vwdnc:ft:",
+       c=getopt_long(argc, argv, "vwdnjc:ft:s:",
                      long_options, &option_index);
        if (c==-1)
            break;
@@ -75,42 +77,51 @@ static void parse_options(int argc, char **argv)
        switch(c) {
        case 2:
            /* Help */
-           fprintf(stderr,
-                   "Usage: secnet [OPTION]...\n\n"
-                   "  -f, --silent, --quiet   suppress error messages\n"
-                   "  -w, --nowarnings        suppress warnings\n"
-                   "  -v, --verbose           output extra diagnostics\n"
-                   "  -c, --config=filename   specify a configuration file\n"
-                   "  -n, --nodetach          do not run in background\n"
-                   "  -d, --debug=item,...    set debug options\n"
-                   "      --help              display this help and exit\n"
-                   "      --version           output version information and exit\n"
+           printf("Usage: secnet [OPTION]...\n\n"
+                  "  -f, --silent, --quiet   suppress error messages\n"
+                  "  -w, --nowarnings        suppress warnings\n"
+                  "  -v, --verbose           output extra diagnostics\n"
+                  "  -c, --config=filename   specify a configuration file\n"
+                  "  -j, --just-check-config stop after reading "
+                  "configuration file\n"
+                  "  -s, --sites-key=name    configuration key that "
+                  "specifies active sites\n"
+                  "  -n, --nodetach          do not run in background\n"
+                  "  -d, --debug             output debug messages\n"
+                  "      --help              display this help and exit\n"
+                  "      --version           output version information "
+                  "and exit\n"
                );
            exit(0);
            break;
       
        case 1:
            /* Version */
-           fprintf(stderr,"%s\n",version);
+           printf("%s\n",version);
            exit(0);
            break;
 
        case 'v':
-           message_level|=M_INFO|M_WARNING|M_ERROR|M_FATAL;
+           message_level|=M_INFO|M_NOTICE|M_WARNING|M_ERR|M_SECURITY|
+               M_FATAL;
            break;
 
-       case 'n':
-           background=False;
+       case 'w':
+           message_level&=(~M_WARNING);
            break;
 
        case 'd':
-           message_level|=M_DEBUG_CONFIG|M_DEBUG_PHASE;
+           message_level|=M_DEBUG_CONFIG|M_DEBUG_PHASE|M_DEBUG;
            break;
 
        case 'f':
            message_level=M_FATAL;
            break;
 
+       case 'n':
+           background=False;
+           break;
+
        case 'c':
            if (optarg)
                configfile=safe_strdup(optarg,"config_filename");
@@ -118,16 +129,28 @@ static void parse_options(int argc, char **argv)
                fatal("secnet: no config filename specified");
            break;
 
+       case 'j':
+           just_check_config=True;
+           break;
+
+       case 's':
+           if (optarg)
+               sites_key=safe_strdup(optarg,"sites-key");
+           else
+               fatal("secnet: no sites key specified");
+           break;
+
        case '?':
+           exit(1);
            break;
 
        default:
-           Message(M_WARNING,"secnet: Unknown getopt code %c\n",c);
+           Message(M_ERR,"secnet: Unknown getopt code %c\n",c);
        }
     }
 
     if (argc-optind != 0) {
-       Message(M_WARNING,"secnet: You gave extra command line parameters, "
+       Message(M_ERR,"secnet: You gave extra command line parameters, "
                "which were ignored.\n");
     }
 }
@@ -137,7 +160,6 @@ static void setup(dict_t *config)
     list_t *l;
     item_t *site;
     dict_t *system;
-    struct log_if *log;
     struct passwd *pw;
     struct cloc loc;
     int i;
@@ -145,7 +167,7 @@ static void setup(dict_t *config)
     l=dict_lookup(config,"system");
 
     if (!l || list_elem(l,0)->type!=t_dict) {
-       fatal("configuration does not include a \"system\" dictionary\n");
+       fatal("configuration does not include a \"system\" dictionary");
     }
     system=list_elem(l,0)->data.dict;
     loc=list_elem(l,0)->loc;
@@ -153,10 +175,9 @@ static void setup(dict_t *config)
     /* Arrange systemwide log facility */
     l=dict_lookup(system,"log");
     if (!l) {
-       fatal("configuration does not include a system/log facility\n");
+       fatal("configuration does not include a system/log facility");
     }
-    log=init_log(l);
-    log->log(log->st,LOG_DEBUG,"setup: logging started");
+    system_log=init_log(l);
 
     /* Who are we supposed to run as? */
     userid=dict_read_string(system,"userid",False,"system",loc);
@@ -170,34 +191,43 @@ static void setup(dict_t *config)
        } while(pw);
        endpwent();
        if (uid==0) {
-           fatal("userid \"%s\" not found\n",userid);
+           fatal("userid \"%s\" not found",userid);
        }
     }
 
     /* Pidfile name */
     pidfile=dict_read_string(system,"pidfile",False,"system",loc);
 
+    /* Check whether we need root privileges */
+    if (require_root_privileges && uid!=0) {
+       fatal("the configured feature \"%s\" requires "
+             "that secnet retain root privileges while running.",
+             require_root_privileges_explanation);
+    }
+
     /* Go along site list, starting sites */
-    l=dict_lookup(config,"sites");
+    l=dict_lookup(config,sites_key);
     if (!l) {
-       fatal("configuration did not define any remote sites\n");
-    }
-    i=0;
-    while ((site=list_elem(l, i++))) {
-       struct site_if *s;
-       if (site->type!=t_closure) {
-           cfgfatal(site->loc,"system","non-closure in site list");
-       }
-       if (site->data.closure->type!=CL_SITE) {
-           cfgfatal(site->loc,"system","non-site closure in site list");
+       Message(M_WARNING,"secnet: configuration key \"%s\" is missing; no "
+               "remote sites are defined\n",sites_key);
+    } else {
+       i=0;
+       while ((site=list_elem(l, i++))) {
+           struct site_if *s;
+           if (site->type!=t_closure) {
+               cfgfatal(site->loc,"system","non-closure in site list");
+           }
+           if (site->data.closure->type!=CL_SITE) {
+               cfgfatal(site->loc,"system","non-site closure in site list");
+           }
+           s=site->data.closure->interface;
+           s->control(s->st,True);
        }
-       s=site->data.closure->interface;
-       s->control(s->st,True);
     }
 }
 
 void register_for_poll(void *st, beforepoll_fn *before,
-                      afterpoll_fn *after, uint32_t max_nfds, string_t desc)
+                      afterpoll_fn *after, int32_t max_nfds, cstring_t desc)
 {
     struct poll_interest *i;
 
@@ -208,6 +238,7 @@ void register_for_poll(void *st, beforepoll_fn *before,
     i->max_nfds=max_nfds;
     i->nfds=0;
     i->desc=desc;
+    assert(total_nfds < INT_MAX - max_nfds);
     total_nfds+=max_nfds;
     i->next=reg;
     reg=i;
@@ -222,28 +253,70 @@ static void system_phase_hook(void *sst, uint32_t newphase)
     }
 }
 
+#if USE_SELECT
+static int fakepoll(struct pollfd *fds, int nfds, int timeout) {
+    fd_set infds[1], outfds[1];
+    int maxfd = -1, i, rc;
+    struct timeval tvtimeout;
+    FD_ZERO(infds);
+    FD_ZERO(outfds);
+    for(i = 0; i < nfds; ++i) {
+       if(fds[i].events & POLLIN)
+           FD_SET(fds[i].fd, infds);
+       if(fds[i].events & POLLOUT)
+           FD_SET(fds[i].fd, outfds);
+       if(fds[i].fd > maxfd)
+           maxfd = fds[i].fd;
+    }
+    if(timeout != -1) {
+       tvtimeout.tv_sec = timeout / 1000;
+       tvtimeout.tv_usec = 1000 * (timeout % 1000);
+    }
+    rc = select(maxfd + 1, infds, outfds, NULL, 
+               timeout == -1 ? NULL : &tvtimeout);
+    if(rc >= 0) {
+       for(i = 0; i < nfds; ++i) {
+           int revents = 0;
+           if(FD_ISSET(fds[i].fd, infds))
+               revents |= POLLIN;
+           if(FD_ISSET(fds[i].fd, outfds))
+               revents |= POLLOUT;
+           fds[i].revents = revents;
+       }
+    }
+    return rc;
+}
+#endif
+
+struct timeval tv_now_global;
+uint64_t now_global;
+
 static void run(void)
 {
-    struct timeval tv_now;
-    uint64_t now;
     struct poll_interest *i;
     int rv, nfds, remain, idx;
     int timeout;
     struct pollfd *fds;
 
-    fds=alloca(sizeof(*fds)*total_nfds);
-    if (!fds) {
-       fatal("run: couldn't alloca\n");
-    }
+    fds=safe_malloc(sizeof(*fds)*total_nfds, "run");
 
-    while (!finished) {
-       if (gettimeofday(&tv_now, NULL)!=0) {
+    Message(M_NOTICE,"%s [%d]: starting\n",version,secnet_pid);
+
+    do {
+       if (gettimeofday(&tv_now_global, NULL)!=0) {
            fatal_perror("main loop: gettimeofday");
        }
-       now=(tv_now.tv_sec*1000)+(tv_now.tv_usec/1000);
+       now_global=((uint64_t)tv_now_global.tv_sec*(uint64_t)1000)+
+                  ((uint64_t)tv_now_global.tv_usec/(uint64_t)1000);
        idx=0;
        for (i=reg; i; i=i->next) {
-           i->after(i->state, fds+idx, i->nfds, &tv_now, &now);
+           int check;
+           for (check=0; check<i->nfds; check++) {
+               if(fds[idx+check].revents & POLLNVAL) {
+                   fatal("run: poll (%s#%d) set POLLNVAL", i->desc, check);
+               }
+           }
+           i->after(i->state, fds+idx, i->nfds);
            idx+=i->nfds;
        }
        remain=total_nfds;
@@ -251,52 +324,64 @@ static void run(void)
        timeout=-1;
        for (i=reg; i; i=i->next) {
            nfds=remain;
-           rv=i->before(i->state, fds+idx, &nfds, &timeout, &tv_now, &now);
+           rv=i->before(i->state, fds+idx, &nfds, &timeout);
            if (rv!=0) {
                /* XXX we need to handle this properly: increase the
                   nfds available */
-               fatal("run: beforepoll_fn (%s) returns %d\n",i->desc,rv);
+               fatal("run: beforepoll_fn (%s) returns %d",i->desc,rv);
            }
            if (timeout<-1) {
-               fatal("run: beforepoll_fn (%s) set timeout to %d\n",timeout);
+               fatal("run: beforepoll_fn (%s) set timeout to %d",timeout);
            }
            idx+=nfds;
            remain-=nfds;
            i->nfds=nfds;
        }
        do {
+           if (finished) break;
+#if USE_SELECT
+           rv=fakepoll(fds, idx, timeout);
+#else
            rv=poll(fds, idx, timeout);
+#endif
            if (rv<0) {
                if (errno!=EINTR) {
                    fatal_perror("run: poll");
                }
            }
        } while (rv<0);
-    }
+    } while (!finished);
+    free(fds);
 }
 
 static void droppriv(void)
 {
     FILE *pf=NULL;
     pid_t p;
+    int errfds[2];
 
     add_hook(PHASE_SHUTDOWN,system_phase_hook,NULL);
 
-    /* Background now, if we're supposed to: we may be unable to write the
-       pidfile if we don't. */
-    if (background) {
-       printf("goto background\n");
-       /* Open the pidfile before forking - that way the parent can tell
-          whether it succeeds */
-       if (pidfile) {
-           pf=fopen(pidfile,"w");
-           if (!pf) {
-               fatal_perror("cannot open pidfile \"%s\"",pidfile);
-           }
-       } else {
-           Message(M_WARNING,"secnet: no pidfile configured, but "
-                   "backgrounding anyway\n");
+    /* Open the pidfile for writing now: we may be unable to do so
+       once we drop privileges. */
+    if (pidfile) {
+       pf=fopen(pidfile,"w");
+       if (!pf) {
+           fatal_perror("cannot open pidfile \"%s\"",pidfile);
        }
+    }
+    if (!background && pf) {
+       fprintf(pf,"%d\n",getpid());
+       fclose(pf);
+    }
+
+    /* Now drop privileges */
+    if (uid!=0) {
+       if (setuid(uid)!=0) {
+           fatal_perror("can't set uid to \"%s\"",userid);
+       }
+    }
+    if (background) {
        p=fork();
        if (p>0) {
            if (pf) {
@@ -308,29 +393,39 @@ static void droppriv(void)
        } else if (p==0) {
            /* Child process - all done, just carry on */
            if (pf) fclose(pf);
-           printf("child\n");
+           /* Close stdin and stdout; we don't need them any more.
+               stderr is redirected to the system/log facility */
+           if (pipe(errfds)!=0) {
+               fatal_perror("can't create pipe for stderr");
+           }
+           close(0);
+           close(1);
+           close(2);
+           dup2(errfds[1],0);
+           dup2(errfds[1],1);
+           dup2(errfds[1],2);
+           secnet_is_daemon=True;
+           setsid();
+           log_from_fd(errfds[0],"stderr",system_log);
        } else {
            /* Error */
            fatal_perror("cannot fork");
            exit(1);
        }
-    } else {
-       if (pidfile) {
-           pf=fopen(pidfile,"w");
-           if (!pf) {
-               fatal_perror("cannot open pidfile \"%s\"",pidfile);
-           }
-           fprintf(pf,"%d\n",getpid());
-           fclose(pf);
-       }
     }
+    secnet_pid=getpid();
+}
 
-    /* Drop privilege now, if configured to do so */
-    if (uid!=0) {
-       if (setuid(uid)!=0) {
-           fatal_perror("can't set uid to \"%s\"",userid);
-       }
-    }
+static signal_notify_fn finish,ignore_hup;
+static void finish(void *st, int signum)
+{
+    finished=True;
+    Message(M_NOTICE,"%s [%d]: received %s\n",version,secnet_pid,(string_t)st);
+}
+static void ignore_hup(void *st, int signum)
+{
+    Message(M_INFO,"%s [%d]: received SIGHUP\n",version,secnet_pid);
+    return;
 }
 
 int main(int argc, char **argv)
@@ -345,15 +440,28 @@ int main(int argc, char **argv)
 
     enter_phase(PHASE_SETUP);
     setup(config);
+
+    if (just_check_config) {
+       Message(M_INFO,"configuration file check complete\n");
+       exit(0);
+    }
+
+    enter_phase(PHASE_GETRESOURCES);
+    /* Appropriate phase hooks will have been run */
     
     enter_phase(PHASE_DROPPRIV);
     droppriv();
 
+    start_signal_handling();
+    request_signal_notification(SIGTERM,finish,safe_strdup("SIGTERM","run"));
+    if (!background) request_signal_notification(SIGINT,finish,
+                                                safe_strdup("SIGINT","run"));
+    request_signal_notification(SIGHUP,ignore_hup,NULL);
     enter_phase(PHASE_RUN);
     run();
 
     enter_phase(PHASE_SHUTDOWN);
+    Message(M_NOTICE,"%s [%d]: finished\n",version,secnet_pid);
 
     return 0;
 }
-