cprogs/cgi-fcgi-interp.c

   1 /*
   2  * "Interpreter" that you can put in #! like this
   3  *   #!/usr/bin/cgi-fcgi-interp [<options>] <interpreter>
   4  *
   5  * Usages:
   6  *   cgi-fcgi-interp  [<option> ..] <interpreter>  <script> [<ignored> ...]
   7  *   cgi-fcgi-interp  [<option>,..],<interpreter>  <script> [<ignored> ...]
   8  *   cgi-fcgi-interp '[<option> ..] <interpreter>' <script> [<ignored> ...]
   9  */
  10 /*
  11  * cgi-fcgi-interp.[ch] - Convenience wrapper for cgi-fcgi
  12  *
  13  * Copyright 2016 Ian Jackson
  14  * Copyright 1982,1986,1993 The Regents of the University of California
  15  *
  16  * This program is free software; you can redistribute it and/or modify
  17  * it under the terms of the GNU General Public License as published by
  18  * the Free Software Foundation; either version 3 of the License, or
  19  * (at your option) any later version.
  20  *
  21  * This program is distributed in the hope that it will be useful,
  22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  24  * GNU General Public License for more details.
  25  *
  26  * You should have received a copy of the GNU General Public
  27  * License along with this file; if not, consult the Free Software
  28  * Foundation's website at www.fsf.org, or the GNU Project website at
  29  * www.gnu.org.
  30  *
  31  * See below for a BSD 3-clause notice regarding timespeccmp.
  32  */
  33 /*
  34  * The result is a program which looks, when executed via the #!
  35  * line, like a CGI program.  But the script inside will be executed
  36  * via <interpreter> in an fcgi context.
  37  *
  38  * Options:
  39  *
  40  *  <interpreter>
  41  *          The real interpreter to use.  Eg "perl".  Need not
  42  *          be an absolute path; will be fed to execvp.
  43  *
  44  *  -G<ident-info>
  45  *          Add <ident-info> to the unique identifying information for
  46  *          this fcgi program.  May be repeated; order is significant.
  47  *
  48  *  -E<ident-info-env-var>
  49  *          Look <ident-info-env-var> up in the environment and add
  50  *          <ident-info-env-var>=<value> as if specified with -G.  If
  51  *          the variable is unset in the environment, it is as if
  52  *          -G<ident-info-env-var> was specified.
  53  *
  54  *  -g<ident>
  55  *          Use <ident> rather than hex(sha256(<interp>\0<script>\0))
  56  *          as the basename of the leafname of the fcgi rendezvous
  57  *          socket.  If <ident> contains only hex digit characters it
  58  *          ought to be no more than 32 characters.  <ident> should
  59  *          not contain spaces or commas (see below).
  60  *
  61  *  -M<numservers>
  62  *         Start <numservers> instances of the program.  This
  63  *         determines the maximum concurrency.  (Note that unlike
  64  *         speedy, the specified number of servers is started
  65  *         right away.)  The default is 4.
  66  *
  67  *  -c<interval>
  68  *         Stale server check interval, in seconds.  The worker
  69  *         process group will get a SIGTERM when it is no longer
  70  *         needed to process new requests.  Ideally it would continue
  71  *         to serve any existing requests.  The SIGTERM will arrive no
  72  *         earlier than <interval> after the last request arrived at
  73  *         the containing webserver.  Default is 300.
  74  *
  75  *  -D
  76  *         Debug mode.  Do not actually run program.  Instead, print
  77  *         out what we would do.
  78  *
  79  * <options> and <interpreter> can be put into a single argument
  80  * to cgi-fcgi-interp, separated by spaces or commas.  <interpreter>
  81  * must come last.
  82  *
  83  * cgi-fcgi-interp automatically expires old sockets, including
  84  * ones where the named script is out of date.
  85  */
  86 /*
  87  * Uses one of two directories
  88  *   /var/run/user/<UID>/cgi-fcgi-interp/
  89  *   ~/.cgi-fcgi-interp/<node>/
  90  * and inside there uses these paths
  91  *   s<ident>
  92  *   l<ident>    used to lock around garbage collection
  93  *
  94  * If -M<ident> is not specified then an initial substring of the
  95  * lowercase hex of the sha256 of <interp>\0<script>\0 is
  96  * used.  The substring is chosen so that the whole path is 10 bytes
  97  * shorter than sizeof(sun_path).  But always at least 33 characters.
  98  *
  99  * <node> is truncated at the first `.' and after the first 32
 100  * characters.
 101  *
 102  * Algorithm:
 103  *  - see if /var/run/user exists
 104  *       if so, lstat /var/run/user/<UID> and check that
 105  *         we own it and it's X700; if not, fail
 106  *         if it's ok then <base> is /var/run/user/<UID>
 107  *       otherwise, look for and maybe create ~/.cgi-fcgi-interp
 108  *         (where ~ is HOME or from getpwuid)
 109  *         and then <base> is ~/.cgi-fcgi-interp/<node>
 110  *  - calculate pathname (checking <ident> length is OK)
 111  *  - check for and maybe create <base>
 112  *  - stat and lstat the <script>
 113  *  - stat the socket and check its timestamp
 114  *       if it is too old, unlink it
 115  *  - dup stderr, mark no cloexec
 116  *  - set CHIARKUTILS_CGIFCGIINTERP_STAGE2=<stderr-copy-fd>
 117  *  - run     cgi-fcgi -connect SOCKET <script>
 118  *
 119  * When CHIARKUTILS_CGIFCGIINTERP_STAGE2 is set, --stage2 does this:
 120  *  - dup2 <was-stderr> to fd 2
 121  *  - open /dev/null and expect fd 1 (and if not, close it)
 122  *  - become a new process group
 123  *  - lstat <socket> to find its inum, mtime
 124  *  - fork/exec <interp> <script>
 125  *  - periodically lstat <interp> and <script> and
 126  *      if mtime is newer than our start time
 127  *      kill process group (at second iteration)
 128  */
 129
 130 #include "prefork.h"
 131
 132 #define STAGE2_VAR "CHIARKUTILS_CGIFCGIINTERP_STAGE2"
 133
 134 static const char *stage2;
 135
 136 const char our_name[] = "cgi-fcgi-interp";
 137
 138 const struct cmdinfo cmdinfos[]= {
 139   { "help",   0, .call=of_help                                         },
 140   { 0, 'g',   1,                    .sassignto= &ident                 },
 141   { 0, 'G',   1, .call= ident_addstring                                },
 142   { 0, 'E',   1, .call= off_ident_addenv                               },
 143   { 0, 'M',   1, .call=of_iassign,  .iassignto= &numservers            },
 144   { 0, 'D',   0,                    .iassignto= &debugmode,    .arg= 1 },
 145   { 0, 'c',   1, .call=of_iassign,  .iassignto= &check_interval        },
 146   { 0 }
 147 };
 148
 149 void fusagemessage(FILE *f) {
 150   fprintf(f, "usage: #!/usr/bin/cgi-fcgi-interp [<options>]\n");
 151 }
 152
 153 static int stderr_copy;
 154
 155 static void make_stderr_copy(void) {
 156   stderr_copy = dup(2);
 157   if (stderr_copy < 0) diee("dup stderr (for copy for stage2)");
 158 }
 159
 160 static void prep_stage2(void) {
 161   int r;
 162
 163   const char *stage2_val = m_asprintf("%d", stderr_copy);
 164   r = setenv(STAGE2_VAR, stage2_val, 1);
 165   if (r) diee("set %s (to announce to stage2)", STAGE2_VAR);
 166 }
 167
 168 /* stage2 predeclarations */
 169 static void record_baseline_time(void);
 170 static void become_pgrp(void);
 171 static void setup_handlers(void);
 172 static void spawn_script(void);
 173 static void queue_alarm(void);
 174 static void start_logging(void);
 175 static void await_something(void);
 176
 177 int main(int argc, const char *const *argv) {
 178   int r;
 179
 180   stage2 = getenv(STAGE2_VAR);
 181   if (stage2) {
 182     int stderrfd = atoi(stage2);
 183     assert(stderrfd>2);
 184
 185     r = dup2(stderrfd, 2);
 186     assert(r==2);
 187
 188     r = open("/dev/null",O_WRONLY);
 189     if (r<0) diee("open /dev/null as stdout");
 190     if (r>=3) close(r);
 191     else if (r!=1) die("open /dev/null for stdout gave bad fd %d",r);
 192
 193     r = close(stderrfd);
 194     if (r) diee("close saved stderr fd");
 195   }
 196
 197   script = process_opts(argc, argv);
 198
 199   if (!stage2) {
 200
 201     find_socket_path();
 202
 203     bool isgarbage = check_garbage();
 204
 205     if (debugmode) {
 206       printf("socket: %s\n",socket_path);
 207       printf("interp: %s\n",interp);
 208       printf("script: %s\n",script);
 209       printf("garbage: %d\n",isgarbage);
 210       exit(0);
 211     }
 212
 213     if (isgarbage)
 214       tidy_garbage();
 215
 216     make_stderr_copy();
 217     prep_stage2();
 218
 219     execlp("cgi-fcgi",
 220            "cgi-fcgi", "-connect", socket_path,
 221            script,
 222            m_asprintf("%d", numservers),
 223            (char*)0);
 224     diee("exec cgi-fcgi");
 225
 226   } else { /*stage2*/
 227
 228     record_baseline_time();
 229     become_pgrp();
 230     setup_handlers();
 231     spawn_script();
 232     queue_alarm();
 233     start_logging();
 234     await_something();
 235     abort();
 236
 237   }
 238 }
 239
 240 /* stage2 */
 241
 242 /* It is most convenient to handle the recheck timeout, as well as
 243  * child death, in signal handlers.  Our signals all block each other,
 244  * and the main program has signals blocked except in sigsuspend, so
 245  * we don't need to worry about async-signal-safety, or errno. */
 246
 247 static struct stat baseline_time;
 248 static pid_t script_child, stage2_pgrp;
 249 static bool out_of_date;
 250 static int errpipe;
 251
 252 static void record_baseline_time(void) {
 253   stab_mtimenow(&baseline_time);
 254 }
 255
 256 static void become_pgrp(void) {
 257   int r;
 258
 259   stage2_pgrp = getpid();
 260
 261   r = setpgid(0,0);
 262   if (r) diee("(stage2) setpgid");
 263 }
 264
 265 static void atexit_handler(void) {
 266   int r;
 267
 268   sighandler_t sigr = signal(SIGTERM,SIG_IGN);
 269   if (sigr == SIG_ERR) warninge("(stage2) signal(SIGTERM,SIG_IGN)");
 270
 271   r = killpg(stage2_pgrp,SIGTERM);
 272   if (r) warninge("(stage) killpg failed");
 273 }
 274
 275 static void alarm_handler(int dummy) {
 276   if (out_of_date)
 277     /* second timeout */
 278     exit(0); /* transfers control to atexit_handler */
 279
 280   out_of_date = check_garbage_vs(&baseline_time);
 281   queue_alarm();
 282 }
 283
 284 static void child_handler(int dummy) {
 285   for (;;) {
 286     int status;
 287     pid_t got = waitpid(-1, &status, WNOHANG);
 288     if (got == (pid_t)-1) diee("(stage2) waitpid");
 289     if (got != script_child) {
 290       warning("(stage2) waitpid got status %d for unknown child [%lu]",
 291               status, (unsigned long)got);
 292       continue;
 293     }
 294     if (WIFEXITED(status)) {
 295       int v = WEXITSTATUS(status);
 296       if (v) warning("program failed with error exit status %d", v);
 297       exit(status);
 298     } else if (WIFSIGNALED(status)) {
 299       int s = WTERMSIG(status);
 300       warning("program died due to fatal signal %s%s",
 301               strsignal(s), WCOREDUMP(status) ? " (core dumped" : "");
 302       assert(status & 0xff);
 303       exit(status & 0xff);
 304     } else {
 305       die("program failed with crazy wait status %#x", status);
 306     }
 307   }
 308   exit(127);
 309 }
 310
 311 static void setup_handlers(void) {
 312   struct sigaction sa;
 313   int r;
 314
 315   r = atexit(atexit_handler);
 316   if (r) diee("(stage2) atexit");
 317
 318   sigemptyset(&sa.sa_mask);
 319   sigaddset(&sa.sa_mask, SIGALRM);
 320   sigaddset(&sa.sa_mask, SIGCHLD);
 321   sa.sa_flags = 0;
 322
 323   r = sigprocmask(SIG_BLOCK, &sa.sa_mask, 0);
 324   if (r) diee("(stage2) sigprocmask(SIG_BLOCK,)");
 325
 326   sa.sa_handler = alarm_handler;
 327   r = sigaction(SIGALRM, &sa, 0);
 328   if (r) diee("(stage2) sigaction SIGALRM");
 329
 330   sa.sa_flags |= SA_NOCLDSTOP;
 331   sa.sa_handler = child_handler;
 332   r = sigaction(SIGCHLD, &sa, 0);
 333   if (r) diee("(stage2) sigaction SIGCHLD");
 334 }
 335
 336 static void spawn_script(void) {
 337   int r;
 338   int errpipes[2];
 339
 340   r = pipe(errpipes);
 341   if (r) diee("(stage2) pipe");
 342
 343   script_child = fork();
 344   if (script_child == (pid_t)-1) diee("(stage2) fork");
 345   if (!script_child) {
 346     r = close(errpipes[0]);
 347     if (r) diee("(stage2 child) close errpipes[0]");
 348
 349     r = dup2(errpipes[1], 2);
 350     if (r != 2) diee("(stage2 child) dup2 stderr");
 351
 352     execlp(interp,
 353            interp, script, (char*)0);
 354     diee("(stage2) exec interpreter (`%s', for `%s')\n",interp,script);
 355   }
 356
 357   r = close(errpipes[1]);
 358   if (r) diee("(stage2) close errpipes[1]");
 359
 360   errpipe = errpipes[0];
 361   r = fcntl(errpipe, F_SETFL, O_NONBLOCK);
 362   if (r) diee("(stage2) set errpipe nonblocking");
 363 }
 364
 365 static void queue_alarm(void) {
 366   alarm(check_interval);
 367 }
 368
 369 static void start_logging(void) {
 370   int r;
 371
 372   openlog(script, LOG_NOWAIT|LOG_PID, LOG_USER);
 373   logging = 1;
 374   r = dup2(1,2);
 375   if (r!=2) diee("dup2 stdout to stderr");
 376 }
 377
 378 static void errpipe_readable(void) {
 379   static char buf[1024];
 380   static int pending;
 381
 382   /* %: does not contain newlines
 383    * _: empty (garbage)
 384    */
 385
 386   /*           %%%%%%%%%%%__________________ */
 387   /*                      ^ pending          */
 388
 389   for (;;) {
 390     int avail = sizeof(buf) - pending;
 391     ssize_t got = read(errpipe, buf+pending, avail);
 392     if (got==-1) {
 393       if (errno==EINTR) continue;
 394       else if (errno==EWOULDBLOCK || errno==EAGAIN) return;
 395       else diee("(stage2) errpipe read");
 396       got = 0;
 397     } else if (got==0) {
 398       warning("program closed its stderr fd");
 399       errpipe = -1;
 400       return;
 401     }
 402     int scanned = pending;
 403     pending += got;
 404     int eaten = 0;
 405     for (;;) {
 406       const char *newline = memchr(buf+scanned, '\n', pending-scanned);
 407       int printupto, eat;
 408       if (newline) {
 409         printupto = newline-buf;
 410         eat = printupto + 1;
 411       } else if (!eaten && pending==sizeof(buf)) { /* overflow */
 412         printupto = pending;
 413         eat = printupto;
 414       } else {
 415         break;
 416       }
 417       syslog(LOG_ERR,"stderr: %.*s", printupto-eaten, buf+eaten);
 418       eaten += eat;
 419       scanned = eaten;
 420     }
 421     pending -= eaten;
 422     memmove(buf, buf+eaten, pending);
 423   }
 424 }
 425
 426 static void await_something(void) {
 427   int r;
 428   sigset_t mask;
 429   sigemptyset(&mask);
 430
 431   for (;;) {
 432     fd_set rfds;
 433     FD_ZERO(&rfds);
 434     if (errpipe >= 0)
 435       FD_SET(errpipe, &rfds);
 436     r = pselect(errpipe+1, &rfds,0,0, 0, &mask);
 437     if (r==-1) {
 438       if (errno != EINTR) diee("(stage2) sigsuspend");
 439       continue;
 440     }
 441     assert(r>0);
 442     assert(FD_ISSET(errpipe, &rfds));
 443     errpipe_readable();
 444   }
 445 }