docs: Generate grammar and option summaries from manpage.
[fwd] / fw.c
diff --git a/fw.c b/fw.c
index 5a5db0f..f626c6e 100644 (file)
--- a/fw.c
+++ b/fw.c
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: fw.c,v 1.15 2003/11/25 14:46:50 mdw Exp $
+ * $Id$
  *
  * Port forwarding thingy
  *
  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  */
 
-/*----- Revision history --------------------------------------------------* 
- *
- * $Log: fw.c,v $
- * Revision 1.15  2003/11/25 14:46:50  mdw
- * Update docco for new options.
- *
- * Revision 1.14  2003/01/24 20:12:40  mdw
- * Correctly cast uid and gid sentinel values.
- *
- * Revision 1.13  2002/02/22 23:45:20  mdw
- * Add option to change the listen(2) parameter.  Receive `fw'-specific
- * code from `conf.c'.
- *
- * Revision 1.12  2002/01/13 14:49:17  mdw
- * Track @dstr_vputf@ change.
- *
- * Revision 1.11  2001/02/03 20:33:26  mdw
- * Fix flags to be unsigned.
- *
- * Revision 1.10  2001/02/03 20:30:03  mdw
- * Support re-reading config files on SIGHUP.
- *
- * Revision 1.9  2001/01/20 11:55:17  mdw
- * Handle select errors more robustly.
- *
- * Revision 1.8  2000/03/23 23:19:19  mdw
- * Fix changed options in parser table.
- *
- * Revision 1.7  2000/03/23 00:37:33  mdw
- * Add option to change user and group after initialization.  Naughtily
- * reassign short equivalents of --grammar and --options.
- *
- * Revision 1.6  1999/12/22 15:44:10  mdw
- * Make syslog a separate option, and do it better.
- *
- * Revision 1.5  1999/10/22 22:47:50  mdw
- * Grammar changes.  Also, don't enable SIGINT if it's currently ignored.
- *
- * Revision 1.4  1999/10/10 16:46:12  mdw
- * New resolver to initialize.  Also, include options for grammar and
- * options references.
- *
- * Revision 1.3  1999/07/26 23:30:42  mdw
- * Major reconstruction work for new design.
- *
- * Revision 1.2  1999/07/03 13:55:17  mdw
- * Various changes.  Add configuration grammar to help text.  Change to
- * root directory and open syslog when forking into background.
- *
- * Revision 1.1.1.1  1999/07/01 08:56:23  mdw
- * Initial revision.
- *
- */
-
 /*----- Header files ------------------------------------------------------*/
 
 #include "config.h"
 #include "fattr.h"
 #include "file.h"
 #include "fw.h"
+#include "mantext.h"
+#include "privconn.h"
 #include "scan.h"
 #include "socket.h"
 #include "source.h"
@@ -247,6 +195,8 @@ void parse(scanner *sc)
       /* --- Combine the source and target --- */
 
       s->ops->attach(s, sc, t);
+      if (t->ops->confirm)
+       t->ops->confirm(t);
     }
 
     /* --- Include configuration from a file --- *
@@ -468,7 +418,7 @@ static void version(FILE *fp)
 
 static void usage(FILE *fp)
 {
-  pquis(fp, "Usage: $ [-dql] [-f file] [config statements...]\n");
+  pquis(fp, "Usage: $ [-dql] [-p PIDFILE] [-f FILE] [CONFIG-STMTS...]\n");
 }
 
 static void help(FILE *fp)
@@ -478,22 +428,7 @@ static void help(FILE *fp)
   usage(fp);
   pquis(fp, "\n\
 An excessively full-featured port-forwarder, which subsumes large chunks\n\
-of the functionality of inetd, netcat, and normal cat.  Options available\n\
-are:\n\
-\n\
--h, --help       Display this help message.\n\
--v, --version    Display the program's version number.\n\
--u, --usage      Display a terse usage summary.\n\
-\n\
--G, --grammar    Show a summary of the configuration language.\n\
--O, --options    Show a summary of the source and target options.\n\
-\n\
--f, --file=FILE          Read configuration from a file.\n\
--q, --quiet      Don't emit any logging information.\n\
--d, --daemon     Fork into background after initializing.\n\
--l, --syslog     Send log output to the system logger.\n\
--s, --setuid=USER Change uid to USER after initializing sources.\n\
--g, --setgid=GRP  Change gid to GRP after initializing sources.\n\
+of the functionality of inetd, netcat, and normal cat.\n\
 \n\
 Configuration may be supplied in one or more configuration files, or on\n\
 the command line (or both).  If no `-f' option is present, and no\n\
@@ -506,6 +441,26 @@ to be a separate line.\n\
 \n\
 The grammar is fairly complicated.  For a summary, run `$ --grammar'.\n\
 For a summary of the various options, run `$ --options'.\n\
+\n\
+Options available are:\n\
+\n\
+Help options:\n\
+  -h, --help           Display this help message.\n\
+  -v, --version        Display the program's version number.\n\
+  -u, --usage          Display a terse usage summary.\n\
+\n\
+Configuration summary:\n\
+  -G, --grammar        Show a summary of the configuration language.\n\
+  -O, --options        Show a summary of the source and target options.\n\
+\n\
+Other options:\n\
+  -f, --file=FILE      Read configuration from a file.\n\
+  -q, --quiet          Don't emit any logging information.\n\
+  -d, --daemon         Fork into background after initializing.\n\
+  -p, --pidfile=FILE   Write process-id to the named FILE.\n\
+  -l, --syslog         Send log output to the system logger.\n\
+  -s, --setuid=USER    Change uid to USER after initializing sources.\n\
+  -g, --setgid=GRP     Change gid to GRP after initializing sources.\n\
 ");
 }
 
@@ -514,99 +469,15 @@ For a summary of the various options, run `$ --options'.\n\
 static void grammar(FILE *fp)
 {
   version(fp);
-  pquis(fp, "\n\
-Grammar summary\n\
-\n\
-Basic syntax\n\
-       FILE ::= EMPTY | FILE STMT [`;']\n\
-       STMT ::= OPTION-STMT | FW-STMT\n\
-       FW-STMT ::= `fw' SOURCE OPTIONS [`to'|`->'] TARGET OPTIONS\n\
-       OPTIONS ::= `{' OPTION-SEQ `}'\n\
-       OPTION-SEQ ::= EMPTY | OPTION-STMT [`;'] OPTION-SEQ\n\
-\n\
-Option syntax\n\
-       OPTION-STMT ::= Q-OPTION\n\
-       Q-OPTION ::= OPTION\n\
-            | PREFIX `.' Q-OPTION\n\
-            | PREFIX `{' OPTION-SEQ `}'\n\
-       PREFIX ::= WORD\n\
-\n\
-File source and target\n\
-       SOURCE ::= FILE\n\
-       TARGET ::= FILE\n\
-       FILE ::= `file' [`.'] FSPEC [`,' FSPEC]\n\
-       FSPEC ::= FD-SPEC | NAME-SPEC | NULL-SPEC\n\
-       FD-SPEC ::= [[`:']`fd'[`:']] NUMBER|`stdin'|`stdout'\n\
-       NAME-SPEC ::= [[`:']`file'[`:']] FILE-NAME\n\
-       FILE-NAME ::= PATH-SEQ | [ PATH-SEQ ]\n\
-       PATH-SEQ ::= PATH-ELT | PATH-SEQ PATH-ELT\n\
-       PATH-ELT ::= `/' | WORD\n\
-       NULL-SPEC ::= [`:']`null'[`:']\n\
-\n\
-Exec source and target\n\
-       SOURCE ::= EXEC\n\
-       TARGET ::= EXEC\n\
-       EXEC ::= `exec' [`.'] CMD-SPEC\n\
-       CMD-SPEC ::= SHELL-CMD | [PROG-NAME] `[' ARGV0 ARG-SEQ `]'\n\
-       ARG-SEQ ::= WORD | ARG-SEQ WORD\n\
-       SHELL-CMD ::= WORD\n\
-       ARGV0 ::= WORD\n\
-\n\
-Socket source and target\n\
-       SOURCE ::= SOCKET-SOURCE\n\
-       TARGET ::= SOCKET-TARGET\n\
-       SOCKET-SOURCE ::= [`socket'[`.']] [[`:']ADDR-TYPE[`:']] SOURCE-ADDR\n\
-       SOCKET-TARGET ::= [`socket'[`.']] [[`:']ADDR-TYPE[`:']] TARGET-ADDR\n\
-\n\
-       INET-SOURCE-ADDR ::= [`port'] PORT\n\
-       INET-TARGET-ADDR ::= ADDRESS [`:'] PORT\n\
-       ADDRESS ::= ADDR-ELT | ADDRESS ADDR-ELT\n\
-       ADDR-ELT ::= `.' | WORD\n\
-\n\
-       UNIX-SOURCE-ADDR ::= FILE-NAME\n\
-       UNIX-TARGET-ADDR ::= FILE-NAME\n\
-");
+  fputs("\nGrammar summary\n\n", fp);
+  fputs(grammar_text, fp);
 }
 
 static void options(FILE *fp)
 {
   version(fp);
-  pquis(fp, "\n\
-Options summary\n\
-\n\
-File attributes (`fattr')\n\
-       prefix.FATTR.MODE [=] MODE\n\
-       prefix.FATTR.OWNER [=] USER\n\
-       prefix.FATTR.GROUP [=] GROUP\n\
-\n\
-File options\n\
-       file.create [=] yes|no\n\
-       file.open [=] no|truncate|append\n\
-       file.fattr.*\n\
-\n\
-Exec options\n\
-       exec.logging [=] yes|no\n\
-       exec.dir [=] FILE-NAME\n\
-       exec.root [=] FILE-NAME\n\
-       exec.user [=] USER\n\
-       exec.group [=] GROUP\n\
-       exec.rlimit.LIMIT[.hard|.soft] [=] VALUE\n\
-       exec.env.clear\n\
-       exec.env.unset VAR\n\
-       exec.env.[set] VAR [=] VALUE\n\
-\n\
-Socket options\n\
-       socket.conn [=] NUMBER|unlimited|one-shot\n\
-       socket.listen [=] NUMBER\n\
-       socket.logging [=] yes|no\n\
-\n\
-       socket.inet.source.[allow|deny] [host] ADDR [/ ADDR]\n\
-       socket.inet.source.[allow|deny] priv-port\n\
-       socket.inet.source.addr [=] any|ADDR\n\
-       socket.inet.dest.addr [=] any|ADDR\n\
-\n\
-       socket.unix.fattr.*\n\
-");
+  fputs("\nOption summary\n\n", fp);
+  fputs(option_text, fp);
 }
 
 /* --- @main@ --- *
@@ -627,6 +498,7 @@ int main(int argc, char *argv[])
   scanner sc;
   uid_t drop = -1;
   gid_t dropg = -1;
+  const char *pidfile = 0;
   conffile *cf, **cff = &conffiles;
 
 #define f_bogus 1u
@@ -670,6 +542,7 @@ int main(int argc, char *argv[])
       { "file",                OPTF_ARGREQ,    0,      'f' },
       { "fork",                0,              0,      'd' },
       { "daemon",      0,              0,      'd' },
+      { "pidfile",     OPTF_ARGREQ,    0,      'p' },
       { "syslog",      0,              0,      'l' },
       { "log",         0,              0,      'l' },
       { "quiet",       0,              0,      'q' },
@@ -682,7 +555,7 @@ int main(int argc, char *argv[])
 
       { 0,             0,              0,      0 }
     };
-    int i = mdwopt(argc, argv, "+hvu GO f:dls:g:", opts, 0, 0, 0);
+    int i = mdwopt(argc, argv, "+hvu" "GO" "f:dp:ls:g:", opts, 0, 0, 0);
 
     if (i < 0)
       break;
@@ -725,6 +598,9 @@ int main(int argc, char *argv[])
       case 'd':
        f |= f_fork;
        break;
+      case 'p':
+       pidfile = optarg;
+       break;
       case 'l':
        f |= f_syslog;
        break;
@@ -805,6 +681,8 @@ int main(int argc, char *argv[])
 
   /* --- Drop privileges --- */
 
+  if (drop != (uid_t)-1)
+    privconn_split(sel);
 #ifdef HAVE_SETGROUPS
   if ((dropg != (gid_t)-1 && (setgid(dropg) || setgroups(1, &dropg))) ||
       (drop != (uid_t)-1 && setuid(drop)))
@@ -834,6 +712,18 @@ int main(int argc, char *argv[])
     if (kid != 0)
       _exit(0);
   }
+  if (pidfile) {
+    FILE *fp = fopen(pidfile, "w");
+    if (!fp) {
+      die(EXIT_FAILURE, "couldn't create pidfile `%s': %s",
+         pidfile, strerror(errno));
+    }
+    fprintf(fp, "%lu\n", (unsigned long)getpid());
+    if (fflush(fp) || ferror(fp) || fclose(fp)) {
+      die(EXIT_FAILURE, "couldn't write pidfile `%s': %s",
+         pidfile, strerror(errno));
+    }
+  }
 
   if (f & f_syslog) {
     flags |= FW_SYSLOG;