chiark / gitweb /
@@ -1,3 +1,9 @@
[userv-utils.git] / ipif / service.c
index b7706235d6227e6943b0cf4d596aabff1423e16f..4137794797185fb69ed80b531726ebbe5466b9f6 100644 (file)
 /*
- * userv service (or standalone program)
- * for per-user IP subranges.
+ * userv service (or standalone program) for per-user IP subranges.
+ *
+ * When invoked appropriately, it creates a point-to-point network
+ * interface with specified parameters.  It arranges for packets sent out
+ * via that interface by the kernel to appear on its own stdout in SLIP or
+ * CSLIP encoding, and packets injected into its own stdin to be given to
+ * the kernel as if received on that interface.  Optionally, additional
+ * routes can be set up to arrange for traffic for other address ranges to
+ * be routed through the new interface.
+ *
+ * This is the service program, which is invoked as root from userv (or may
+ * be invoked firectly).
+ *
+ * Its arguments are supposed to be, in order, as follows:
+ *
+ *  The first two arguments are usually supplied by the userv
+ *  configuration.  See the file `ipif/ipif' in the source tree, which
+ *  is installed in /etc/userv/services.d/ipif by `make install':
  *
- * This is invoked as root, directly from userv.
- * Its arguments are supposed to be, in order:
  *  <config>
- *      Specifies address ranges and gids which own them.
- *  --  Indicates that the remaining arguments are user-supplied
- *      and therefore untrusted.
+ *
+ *      Specifies address ranges and gids which own them.  The default
+ *      configuration supplies /etc/userv/ipif-networks, which is then read
+ *      for a list of entries, one per line.
+ *
+ *  --
+ *      Serves to separate the user-supplied and therefore untrusted
+ *      arguments from the trusted first argument.
+ *
+ *  The remaining arguments are supplied by the (untrusted) caller:
+ *
  *  <local-addr>,<peer-addr>,<mtu>,<proto>
+ *
  *      As for slattach.  Supported protocols are slip, cslip, and
- *      adaptive.  Alternatively, set to `debug' to print debugging
- *      info.  <local-addr> is address of the interface on chiark;
- *      <peer-addr> is the address of the point-to-point peer.
+ *      adaptive.  Alternatively, set to `debug' to print debugging info
+ *      and exit.  <local-addr> is address of the interface to be created
+ *      on the local system; <peer-addr> is the address of the
+ *      point-to-point peer.  They must be actual addresses (not
+ *      hostnames).
+ *
  *  <prefix>/<mask>,<prefix>/<mask>,...
- *      List of additional routes to add for this interface.
- *      May be the empty argument.
  *
- * <config> is either
- *    <gid>,<prefix>/<len>[,<junk>]
- *      indicating that that gid may allocate addresses in
- *      the relevant subspace (<junk> is ignored)
- * or #...
- *      which is a comment
- * or /<config-file-name> or ./<config-file-name> or ../<config-file-name>
- *      which refers to a file which contains lines which
- *      are each <config>
- * or *
- *      which means that anything is permitted
- * 
- * Should be run from userv with no-disconnect-hup.
+ *      List of additional routes to add for this interface.  routes will
+ *      be set up on the local system arranging for packets for those
+ *      networks to be sent via the created interface.  <prefix> must be an
+ *      IPv4 address, and mask must be an integer (dotted-quad masks are
+ *      not supported).  If no additional routes are to be set up, use `-'
+ *      or supply an empty argument.
+ *
+ * Each <config> item - whether a line file such as
+ * /etc/userv/ipif-networks, or supplied on the service program
+ * command line - is one of:
+ *
+ *   /<config-file-name>
+ *   ./<config-file-name>
+ *   ../<config-file-name>
+ *
+ *      Reads a file which contains lines which are each <config>
+ *      items.
+ *
+ *   <gid>,[=]<prefix>/<len>[,<junk>]
+ *
+ *      Indicates that <gid> may allocate addresses in the relevant address
+ *      range (<junk> is ignored).  <gid> must be numeric.  To specify a
+ *      single host address, you must specify a mask of /32.  If `=' is
+ *      specified then the specific subrange is only allowed for the local
+ *      endpoint address, but not for remote addresses.
+ *
+ *   *
+ *      Means that anything is to be permitted.  This should not appear in
+ *      /etc/userv/ipif-networks, as that would permit any user on the
+ *      system to create any interfaces with any addresses and routes
+ *      attached.  It is provided so that root can usefully invoke the ipif
+ *      service program directly (not via userv), without needing to set up
+ *      permissions in /etc/userv/ipif-networks.
+ *
+ *   #...
+ *
+ *      Comment.  Blank lines are also ignored.
+ *
+ *   NB: Permission is granted if _any_ config entry matches the request.
+ *
+ * The service program should be run from userv with no-disconnect-hup.
+ */
+/*
+ * Copyright (C) 1999-2000 Ian Jackson
+ *
+ * This 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 userv-utils; if not, write to the Free Software
+ * Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ *
+ * $Id$
  */
 
 #include <stdio.h>
 #include <stdarg.h>
 #include <ctype.h>
 #include <limits.h>
+#include <signal.h>
+#include <unistd.h>
+
+#include <sys/types.h>
+#include <sys/wait.h>
+#include <sys/stat.h>
 
 #define NARGS 4
 #define MAXEXROUTES 5
-#define ATXTLEN 12
+#define ATXTLEN 16
 
 static const unsigned long gidmaxval= (unsigned long)((gid_t)-2);
 static const char *const protos_ok[]= { "slip", "cslip", "adaptive", 0 };
+static const int signals[]= { SIGHUP, SIGINT, SIGTERM, 0 };
 
 static const char *configstr, *proto;
 static unsigned long localaddr, peeraddr, mtu;
@@ -67,6 +145,58 @@ static struct pplace {
   int lineno;
 } *cpplace;
 
+
+static int slpipe[2], ptmaster, undoslattach;
+static const char *ifname;
+static const char *ptyname;
+
+#define NPIDS 4
+
+static union {
+  struct { pid_t sl, cout, cin, task; } byname;
+  pid_t bynumber[NPIDS];
+} pids;
+sigset_t emptyset, fullset;
+
+
+static int cleantask(void) {
+  pid_t pid;
+
+  pid= fork();
+  if (!pid) return 1;
+  if (pid == (pid_t)-1)
+    perror("userv-ipif: fork for undo slattach failed - cannot clean up properly");
+  return 0;
+}
+
+static void terminate(int estatus) {
+  int i, status;
+  pid_t pid;
+  
+  for (i=0; i<NPIDS; i++)
+    if (pids.bynumber[i]) kill(pids.bynumber[i], SIGTERM);
+
+  if (undoslattach) {
+    if (cleantask()) {
+      execlp("slattach", "slattach", "-p", "tty", ptyname, (char*)0);
+      perror("userv-ipif: exec slattach for undo slattach failed");
+      exit(-1);
+    }
+    if (ifname && cleantask()) {
+      execlp("ifconfig", "ifconfig", ifname, "down", (char*)0);
+      perror("userv-ipif: exec ifconfig for undo ifconfig failed");
+      exit(-1);
+    }
+  }
+
+  for (;;) {
+    pid= waitpid(-1,&status,0);
+    if (pid == (pid_t)-1) break;
+  }
+  exit(estatus);
+}
+
+
 static void fatal(const char *fmt, ...)
      __attribute__((format(printf,1,2)));
 static void fatal(const char *fmt, ...) {
@@ -76,7 +206,7 @@ static void fatal(const char *fmt, ...) {
   fputs("userv-ipif service: fatal error: ",stderr);
   vfprintf(stderr, fmt, al);
   putc('\n',stderr);
-  exit(8);
+  terminate(8);
 }
   
 static void sysfatal(const char *fmt, ...)
@@ -88,10 +218,10 @@ static void sysfatal(const char *fmt, ...) {
   e= errno;
   va_start(al,fmt);
 
-  fputs("userv-ipif service: fatal system error",stderr);
+  fputs("userv-ipif service: fatal system error",stderr);
   vfprintf(stderr, fmt, al);
-  fprintf(stderr,"%s\n", strerror(e));
-  exit(12);
+  fprintf(stderr,"%s\n", strerror(e));
+  terminate(12);
 }
 
 
@@ -119,7 +249,7 @@ static void badusage(const char *fmt, ...) {
              cpp->filename, cpp->lineno);
     }
   }
-  exit(16);
+  terminate(16);
 }
 
 static char *ip2txt(unsigned long addr, char *buf) {
@@ -143,13 +273,13 @@ static unsigned long eat_number(const char **argp, const char *what,
   char *ep;
   int endchar;
 
-  if (!*argp) { badusage("missing number %s\n",what); }
+  if (!*argp) { badusage("missing number %s",what); }
   rv= strtoul(*argp,&ep,0);
   if ((endchar= *ep)) {
-    if (!endchars) badusage("junk after number %s\n",what);
+    if (!endchars) badusage("junk after number %s",what);
     if (!strchr(endchars,endchar))
       badusage("invalid character or delimiter `%c' in or after number, %s:"
-              " expected %s (or none?)\n", endchar,what,endchars);
+              " expected %s (or none?)", endchar,what,endchars);
     *argp= ep+1;
   } else {
     *argp= 0;
@@ -199,8 +329,8 @@ static void eat_prefixmask(const char **argp, const char *what,
   sprintf(whatbuf,"%s length",what);
   len= eat_number(argp,whatbuf, 0,32, endchars,endchar_r);
 
-  mask= (~0UL << (32-len));
-  if (prefix & ~mask) badusage("%s prefix %08lx not fully contained in mask %08lx\n",
+  mask= len ? (~0UL << (32-len)) : 0UL;
+  if (prefix & ~mask) badusage("%s prefix %08lx not fully contained in mask %08lx",
                               what,prefix,mask);
   *prefix_r= prefix;
   if (mask_r) *mask_r= mask;
@@ -213,28 +343,31 @@ static int addrnet_isin(unsigned long prefix, unsigned long mask,
 }
   
 
-static void permit(unsigned long pprefix, unsigned long pmask) {
+static void permit(unsigned long pprefix, unsigned long pmask, int localonly) {
   int i, any;
   
   assert(!(pprefix & ~pmask));
+  any= 0;
 
-  if (!proto) fputs("permits",stdout);
+  if (!proto) fputs(localonly ? "permits-l" : "permits",stdout);
   if (addrnet_isin(localaddr,~0UL, pprefix,pmask)) {
     if (!proto) fputs(" local-addr",stdout);
     any= localallow= 1;
   }
-  if (addrnet_isin(peeraddr,~0UL, pprefix,pmask)) {
-    if (!proto) fputs(" peer-addr",stdout);
-    any= peerallow= 1;
-  }
-  for (i=0; i<nexroutes; i++) {
-    if (addrnet_isin(exroutes[i].prefix,exroutes[i].mask, pprefix,pmask)) {
-      if (!proto) printf(" route#%d",i);
-      any= exroutes[i].allow= 1;
+  if (!localonly) {
+    if (addrnet_isin(peeraddr,~0UL, pprefix,pmask)) {
+      if (!proto) fputs(" peer-addr",stdout);
+      any= peerallow= 1;
+    }
+    for (i=0; i<nexroutes; i++) {
+      if (addrnet_isin(exroutes[i].prefix,exroutes[i].mask, pprefix,pmask)) {
+       if (!proto) printf(" route#%d",i);
+       any= exroutes[i].allow= 1;
+      }
     }
   }
   if (!proto) {
-    if (!any) fputs(" nothing!",stderr);
+    if (!any) fputs(" nothing",stdout);
     putchar('\n');
   }
 }
@@ -288,14 +421,14 @@ static void pfile(const char *filename) {
 
 static void pconfig(const char *configstr, int truncated) {
   unsigned long fgid, tgid, pprefix, pmask;
-  int plen;
+  int plen, localonly;
   char ptxt[ATXTLEN];
   const char *gidlist;
   
   switch (configstr[0]) {
   case '*':
     if (strcmp(configstr,"*")) badusage("`*' directive must be only thing on line");
-    permit(0UL,0UL);
+    permit(0UL,0UL,0);
     return;
     
   case '#':
@@ -311,6 +444,12 @@ static void pconfig(const char *configstr, int truncated) {
       badusage("unknown configuration directive");
     
     fgid= eat_number(&configstr,"gid", 0,gidmaxval, ",",0);
+    if (configstr[0] == '=') {
+      localonly= 1;
+      configstr++;
+    } else {
+      localonly= 0;
+    }
     eat_prefixmask(&configstr,"permitted-prefix", ",",0, &pprefix,&pmask,&plen);
     if (!configstr && truncated) badusage("gid,prefix/len,... spec too long");
 
@@ -326,7 +465,7 @@ static void pconfig(const char *configstr, int truncated) {
       tgid= eat_number(&gidlist,"userv-gid", 0,gidmaxval, " ",0);
       if (tgid == fgid) break;
     }
-    permit(pprefix,pmask);
+    permit(pprefix,pmask,localonly);
     return;
   }
 }
@@ -372,29 +511,32 @@ static void parseargs(int argc, const char *const *argv) {
   addrnet_mustdiffer("local-addr",localaddr,~0UL, "peer-addr",peeraddr,~0UL);
   
   carg= *++argv;
-  for (nexroutes=0;
-       carg;
-       nexroutes++) {
-    if (nexroutes == MAXEXROUTES)
-      fatal("too many extra routes (only %d allowed)",MAXEXROUTES);
-    sprintf(erwhatbuf,"route#%d",nexroutes);
+  if (strcmp(carg,"-")) {
+    for (nexroutes=0;
+        carg && *carg;
+        nexroutes++) {
+      if (nexroutes == MAXEXROUTES)
+       fatal("too many extra routes (only %d allowed)",MAXEXROUTES);
+      sprintf(erwhatbuf,"route#%d",nexroutes);
     
-    eat_prefixmask(&carg,erwhatbuf, ",",0, &routeaddr,&routemask,0);
-    if (routemask == ~0UL) {
-      addrnet_mustdiffer(erwhatbuf,routeaddr,routemask, "local-addr",localaddr,~0UL);
-      addrnet_mustdiffer(erwhatbuf,routeaddr,routemask, "peer-addr",peeraddr,~0UL);
-    }
-    for (i=0; i<nexroutes; i++) {
-      sprintf(erwhatbuf2,"route#%d",i);
-      addrnet_mustdiffer(erwhatbuf,routeaddr,routemask,
-                        erwhatbuf2,exroutes[i].prefix,exroutes[i].mask);
+      eat_prefixmask(&carg,erwhatbuf, ",",0, &routeaddr,&routemask,0);
+      if (routemask == ~0UL) {
+       addrnet_mustdiffer(erwhatbuf,routeaddr,routemask, "local-addr",localaddr,~0UL);
+       addrnet_mustdiffer(erwhatbuf,routeaddr,routemask, "peer-addr",peeraddr,~0UL);
+      }
+      for (i=0; i<nexroutes; i++) {
+       sprintf(erwhatbuf2,"route#%d",i);
+       addrnet_mustdiffer(erwhatbuf,routeaddr,routemask,
+                          erwhatbuf2,exroutes[i].prefix,exroutes[i].mask);
+      }
+      exroutes[nexroutes].prefix= routeaddr;
+      exroutes[nexroutes].mask= routemask;
+      exroutes[nexroutes].allow= 0;
+      ip2txt(routeaddr,exroutes[nexroutes].prefixtxt);
+      ip2txt(routemask,exroutes[nexroutes].masktxt);
     }
-    exroutes[nexroutes].prefix= routeaddr;
-    exroutes[nexroutes].mask= routemask;
-    exroutes[nexroutes].allow= 0;
-    ip2txt(routeaddr,exroutes[nexroutes].prefixtxt);
-    ip2txt(routemask,exroutes[nexroutes].masktxt);
   }
+
   ip2txt(localaddr,localtxt);
   ip2txt(peeraddr,peertxt);
 }
@@ -438,11 +580,236 @@ static void dumpdebug(void) {
   exit(0);
 }
 
+
+static void setsigmask(const sigset_t *ss) {
+  int r;
+  
+  r= sigprocmask(SIG_SETMASK, ss, 0);
+  if (r) sysfatal("[un]block signals");
+}  
+
+static void setsignals(void (*handler)(int), struct sigaction *sa, int chldflags) {
+  const int *signalp;
+  int r, sig;
+  
+  sa->sa_handler= handler;
+  sa->sa_flags= 0; 
+  for (signalp=signals; (sig=*signalp); signalp++) {
+    r= sigaction(sig, sa, 0);  if (r) sysfatal("uncatch signal");
+  }
+  sa->sa_flags= chldflags;
+  r= sigaction(SIGCHLD, sa, 0);  if (r) sysfatal("uncatch children");
+}
+
+static void infork(void) {
+  struct sigaction sa;
+
+  memset(&pids,0,sizeof(pids));
+  sigemptyset(&sa.sa_mask);
+  setsignals(SIG_DFL,&sa,0);
+  setsigmask(&emptyset);
+  undoslattach= 0;
+}
+
+static pid_t makesubproc(void (*entry)(void)) {
+  pid_t pid;
+
+  pid= fork();  if (pid == (pid_t)-1) sysfatal("fork for subprocess");
+  if (pid) return pid;
+
+  infork();
+  entry();
+  abort();
+}
+
+static int task(void) {
+  pid_t pid;
+
+  pid= fork();
+  if (pid == (pid_t)-1) sysfatal("fork for task");
+  if (!pid) { infork(); return 1; }
+
+  pids.byname.task= pid;
+  while (pids.byname.task) sigsuspend(&emptyset);
+  return 0;
+}
+
+static void mdup2(int fd1, int fd2, const char *what) {
+  int r;
+
+  for (;;) {
+    r= dup2(fd1,fd2); if (r==fd2) return;
+    if (r!=-1) fatal("dup2 in %s gave wrong answer %d instead of %d",what,r,fd2);
+    if (errno != EINTR) sysfatal("dup2 failed in %s",what);
+  }
+}
+
+static void sl_entry(void) {
+  mdup2(slpipe[1],1,"slattach child");
+  execlp("slattach", "slattach", "-v", "-L", "-p",proto, ptyname, (char*)0);
+  sysfatal("cannot exec slattach");
+}
+
+static void cin_entry(void) {
+  mdup2(ptmaster,1,"cat input child");
+  execlp("cat", "cat", (char*)0);
+  sysfatal("cannot exec cat input");
+}
+
+static void cout_entry(void) {
+  mdup2(ptmaster,0,"cat output child");
+  execlp("cat", "cat", (char*)0);
+  sysfatal("cannot exec cat output");
+}
+
+static void sighandler(int signum) {
+  pid_t pid;
+  int estatus, status;
+  const char *taskfail;
+
+  estatus= 4;
+  
+  if (signum == SIGCHLD) {
+    for (;;) {
+      pid= waitpid(-1,&status,WNOHANG);
+      if (!pid || pid == (pid_t)-1) return;
+
+      if (pid == pids.byname.task) {
+       pids.byname.task= 0;
+       if (!status) return;
+       taskfail= "task";
+      } else if (pid == pids.byname.cin) {
+       pids.byname.cin= 0;
+       if (status) {
+         taskfail= "input cat";
+       } else {
+         taskfail= 0;
+         estatus= 0;
+       }
+      } else if (pid == pids.byname.cout) {
+       pids.byname.cout= 0;
+       taskfail= "output cat";
+      } else if (pid == pids.byname.sl) {
+       pids.byname.sl= 0;
+       taskfail= "slattach";
+      } else {
+       continue;
+      }
+      break;
+    }
+    if (taskfail) {
+      if (WIFEXITED(status)) {
+       fprintf(stderr,
+               "userv-ipif service: %s unexpectedly exited with exit status %d\n",
+               taskfail, WEXITSTATUS(status));
+      } else if (WIFSIGNALED(status)) {
+       fprintf(stderr,
+               "userv-ipif service: %s unexpectedly killed by signal %s%s\n",
+               taskfail, strsignal(WTERMSIG(status)),
+               WCOREDUMP(status) ? " (core dumped)" : "");
+      } else {
+       fprintf(stderr, "userv-ipif service: %s unexpectedly terminated"
+               " with unknown status code %d\n", taskfail, status);
+      }
+    }
+  } else {
+    fprintf(stderr,
+           "userv-ipif service: received signal %d, terminating\n",
+           signum);
+  }
+
+  terminate(estatus);
+}
+
+static void startup(void) {
+  int r;
+  struct sigaction sa;
+  
+  sigfillset(&fullset);
+  sigemptyset(&emptyset);
+
+  ptmaster= getpt();  if (ptmaster==-1) sysfatal("allocate pty master");
+  r= grantpt(ptmaster);  if (r) sysfatal("grab/grant pty slave");
+  ptyname= ptsname(ptmaster);  if (!ptyname) sysfatal("get pty slave name");
+  r= chmod(ptyname,0600);  if (r) sysfatal("chmod pty slave");
+  r= unlockpt(ptmaster);  if (r) sysfatal("unlock pty");
+
+  sigfillset(&sa.sa_mask);
+  setsignals(sighandler,&sa,SA_NOCLDSTOP);
+  setsigmask(&fullset);
+}
+
+static void startslattach(void) {
+  static char ifnbuf[200];
+
+  FILE *piper;
+  int r, l, k;
+
+  r= pipe(slpipe);  if (r) sysfatal("create pipe");
+  piper= fdopen(slpipe[0],"r");  if (!piper) sysfatal("fdopen pipe");
+
+  undoslattach= 1;
+  pids.byname.sl= makesubproc(sl_entry);
+
+  close(slpipe[1]);
+  setsigmask(&emptyset);
+  if (!fgets(ifnbuf,sizeof(ifnbuf),piper)) {
+    if (ferror(piper)) sysfatal("cannot read ifname from slattach");
+    else fatal("cannot read ifname from slattach");
+  }
+  setsigmask(&fullset);
+  l= strlen(ifnbuf);
+  if (l<=0 || ifnbuf[l-1] != '\n') fatal("slattach gave strange output `%s'",ifnbuf);
+  ifnbuf[l-1]= 0;
+  for (k=l; k>0 && ifnbuf[k-1]!=' '; k--);
+  ifname= ifnbuf+k;
+}
+
+static void netconfigure(void) {
+  char mtutxt[100];
+  int i;
+
+  if (task()) {
+    sprintf(mtutxt,"%lu",mtu);
+  
+    execlp("ifconfig", "ifconfig", ifname, localtxt,
+          "netmask","255.255.255.255", "-broadcast", "pointopoint",peertxt,
+          "mtu",mtutxt, "up", (char*)0);
+    sysfatal("cannot exec ifconfig");
+  }
+
+  for (i=0; i<nexroutes; i++) {
+    if (task()) {
+      execlp("route","route", "add", "-net",exroutes[i].prefixtxt,
+            "netmask",exroutes[i].masktxt,
+            "gw",peertxt, "dev",ifname, (char*)0);
+      sysfatal("cannot exec route (for route)");
+    }
+  }
+}
+
+static void copydata(void) __attribute__((noreturn));
+static void copydata(void) {
+  int r;
+  
+  pids.byname.cin= makesubproc(cin_entry);
+  for (;;) {
+    r= write(1, "\300", 1); if (r==1) break;
+    assert(r==-1);  if (errno != EINTR) sysfatal("send initial delim to confirm");
+  }
+  pids.byname.cout= makesubproc(cout_entry);
+
+  for (;;) sigsuspend(&emptyset);
+}
+
 int main(int argc, const char *const *argv) {
   parseargs(argc,argv);
   pconfig(configstr,0);
   checkpermit();
   if (!proto) dumpdebug();
 
-  abort();
+  startup();
+  startslattach();
+  netconfigure();
+  copydata();
 }