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 #include "timespeccmp.h"
 132
 133 #define STAGE2_VAR "CHIARKUTILS_CGIFCGIINTERP_STAGE2"
 134
 135 static const char *stage2;
 136
 137 const char our_name[] = "cgi-fcgi-interp";
 138
 139 static int numservers=4, debugmode;
 140 static int check_interval=300;
 141
 142 const struct cmdinfo cmdinfos[]= {
 143   PREFORK_CMDINFOS
 144   { 0, 'M',   1, .call=of_iassign,  .iassignto= &numservers            },
 145   { 0, 'D',   0,                    .iassignto= &debugmode,    .arg= 1 },
 146   { 0, 'c',   1, .call=of_iassign,  .iassignto= &check_interval        },
 147   { 0 }
 148 };
 149
 150 void fusagemessage(FILE *f) {
 151   fprintf(f, "usage: #!/usr/bin/cgi-fcgi-interp [<options>]\n");
 152 }
 153
 154 void ident_addinit(void) {
 155 }
 156
 157 static int stderr_copy;
 158
 159 static void make_stderr_copy(void) {
 160   stderr_copy = dup(2);
 161   if (stderr_copy < 0) diee("dup stderr (for copy for stage2)");
 162 }
 163
 164 static void prep_stage2(void) {
 165   int r;
 166
 167   const char *stage2_val = m_asprintf("%d", stderr_copy);
 168   r = setenv(STAGE2_VAR, stage2_val, 1);
 169   if (r) diee("set %s (to announce to stage2)", STAGE2_VAR);
 170 }
 171
 172 #ifdef st_mtime
 173
 174 static bool stab_isnewer(const struct stat *a, const struct stat *b) {
 175   if (debugmode)
 176     fprintf(stderr,"stab_isnewer mtim %lu.%06lu %lu.06%lu\n",
 177             (unsigned long)a->st_mtim.tv_sec,
 178             (unsigned long)a->st_mtim.tv_nsec,
 179             (unsigned long)b->st_mtim.tv_sec,
 180             (unsigned long)b->st_mtim.tv_nsec);
 181   return timespeccmp(&a->st_mtim, &b->st_mtim, >);
 182 }
 183
 184 static void stab_mtimenow(struct stat *out) {
 185   int r = clock_gettime(CLOCK_REALTIME, &out->st_mtim);
 186   if (r) diee("(stage2) clock_gettime");
 187   if (debugmode)
 188     fprintf(stderr,"stab_mtimenow mtim %lu.%06lu\n",
 189             (unsigned long)out->st_mtim.tv_sec,
 190             (unsigned long)out->st_mtim.tv_nsec);
 191 }
 192
 193 #else /* !defined(st_mtime) */
 194
 195 static bool stab_isnewer(const struct stat *a, const struct stat *b) {
 196   if (debugmode)
 197     fprintf(stderr,"stab_isnewer mtime %lu %lu\n",
 198             (unsigned long)a->st_mtime,
 199             (unsigned long)b->st_mtime);
 200   return a->st_mtime > b->st_mtime;
 201 }
 202
 203 static void stab_mtimenow(struct stat *out) {
 204   out->st_mtime = time(NULL);
 205   if (out->st_mtime == (time_t)-1) diee("(stage2) time()");
 206   if (debugmode)
 207     fprintf(stderr,"stab_mtimenow mtime %lu\n",
 208             (unsigned long)out->st_mtime);
 209 }
 210
 211 #endif /* !defined(st_mtime) */
 212
 213 static bool check_garbage_vs(const struct stat *started) {
 214   struct stat script_stab;
 215   int r;
 216
 217   r = lstat(script, &script_stab);
 218   if (r) diee("lstat script (%s)",script);
 219
 220   if (stab_isnewer(&script_stab, started))
 221     return 1;
 222
 223   if (S_ISLNK(script_stab.st_mode)) {
 224     r = stat(script, &script_stab);
 225     if (r) diee("stat script (%s0",script);
 226
 227     if (stab_isnewer(&script_stab, started))
 228       return 1;
 229   }
 230
 231   return 0;
 232 }
 233
 234 static bool check_garbage(void) {
 235   struct stat sock_stab;
 236   int r;
 237
 238   r = lstat(socket_path, &sock_stab);
 239   if (r) {
 240     if ((errno == ENOENT))
 241       return 0; /* well, no garbage then */
 242     diee("stat socket (%s)",socket_path);
 243   }
 244
 245   return check_garbage_vs(&sock_stab);
 246 }
 247
 248 static void tidy_garbage(void) {
 249   /* We lock l<ident> and re-check.  The effect of this is that each
 250    * stale socket is removed only once.  So unless multiple updates to
 251    * the script happen rapidly, we can't be racing with the cgi-fcgi
 252    * (which is recreating the socket */
 253   int lockfd = -1;
 254   int r;
 255
 256   lockfd = acquire_lock();
 257
 258   if (check_garbage()) {
 259     r = unlink(socket_path);
 260     if (r) {
 261       if (!(errno == ENOENT))
 262         diee("remove out-of-date socket (%s)", socket_path);
 263     }
 264   }
 265
 266   r = close(lockfd);
 267   if (r) diee("close lock (%s)", lock_path);
 268 }
 269
 270 /* stage2 predeclarations */
 271 static void record_baseline_time(void);
 272 static void become_pgrp(void);
 273 static void setup_handlers(void);
 274 static void spawn_script(void);
 275 static void queue_alarm(void);
 276 static void start_logging(void);
 277 static void await_something(void);
 278
 279 int main(int unused_argc, const char *const *argv) {
 280   int r;
 281
 282   stage2 = getenv(STAGE2_VAR);
 283   if (stage2) {
 284     int stderrfd = atoi(stage2);
 285     assert(stderrfd>2);
 286
 287     r = dup2(stderrfd, 2);
 288     assert(r==2);
 289
 290     r = open("/dev/null",O_WRONLY);
 291     if (r<0) diee("open /dev/null as stdout");
 292     if (r>=3) close(r);
 293     else if (r!=1) die("open /dev/null for stdout gave bad fd %d",r);
 294
 295     r = close(stderrfd);
 296     if (r) diee("close saved stderr fd");
 297   }
 298
 299   process_opts(&argv);
 300   if (!script) badusage("need script argument");
 301
 302   if (!stage2) {
 303
 304     find_socket_path();
 305
 306     bool isgarbage = check_garbage();
 307
 308     if (debugmode) {
 309       printf("socket: %s\n",socket_path);
 310       printf("interp: %s\n",interp);
 311       printf("script: %s\n",script);
 312       printf("garbage: %d\n",isgarbage);
 313       exit(0);
 314     }
 315
 316     if (isgarbage)
 317       tidy_garbage();
 318
 319     make_stderr_copy();
 320     prep_stage2();
 321
 322     execlp("cgi-fcgi",
 323            "cgi-fcgi", "-connect", socket_path,
 324            script,
 325            m_asprintf("%d", numservers),
 326            (char*)0);
 327     diee("exec cgi-fcgi");
 328
 329   } else { /*stage2*/
 330
 331     record_baseline_time();
 332     become_pgrp();
 333     setup_handlers();
 334     spawn_script();
 335     queue_alarm();
 336     start_logging();
 337     await_something();
 338     abort();
 339
 340   }
 341 }
 342
 343 /* stage2 */
 344
 345 /* It is most convenient to handle the recheck timeout, as well as
 346  * child death, in signal handlers.  Our signals all block each other,
 347  * and the main program has signals blocked except in sigsuspend, so
 348  * we don't need to worry about async-signal-safety, or errno. */
 349
 350 static struct stat baseline_time;
 351 static pid_t script_child, stage2_pgrp;
 352 static bool out_of_date;
 353 static int errpipe;
 354
 355 static void record_baseline_time(void) {
 356   stab_mtimenow(&baseline_time);
 357 }
 358
 359 static void become_pgrp(void) {
 360   int r;
 361
 362   stage2_pgrp = getpid();
 363
 364   r = setpgid(0,0);
 365   if (r) diee("(stage2) setpgid");
 366 }
 367
 368 static void atexit_handler(void) {
 369   int r;
 370
 371   sighandler_t sigr = signal(SIGTERM,SIG_IGN);
 372   if (sigr == SIG_ERR) warninge("(stage2) signal(SIGTERM,SIG_IGN)");
 373
 374   r = killpg(stage2_pgrp,SIGTERM);
 375   if (r) warninge("(stage) killpg failed");
 376 }
 377
 378 static void alarm_handler(int dummy) {
 379   if (out_of_date)
 380     /* second timeout */
 381     exit(0); /* transfers control to atexit_handler */
 382
 383   out_of_date = check_garbage_vs(&baseline_time);
 384   queue_alarm();
 385 }
 386
 387 static void child_handler(int dummy) {
 388   for (;;) {
 389     int status;
 390     pid_t got = waitpid(-1, &status, WNOHANG);
 391     if (got == (pid_t)-1) diee("(stage2) waitpid");
 392     if (got != script_child) {
 393       warning("(stage2) waitpid got status %d for unknown child [%lu]",
 394               status, (unsigned long)got);
 395       continue;
 396     }
 397     if (WIFEXITED(status)) {
 398       int v = WEXITSTATUS(status);
 399       if (v) warning("program failed with error exit status %d", v);
 400       exit(status);
 401     } else if (WIFSIGNALED(status)) {
 402       int s = WTERMSIG(status);
 403       warning("program died due to fatal signal %s%s",
 404               strsignal(s), WCOREDUMP(status) ? " (core dumped" : "");
 405       assert(status & 0xff);
 406       exit(status & 0xff);
 407     } else {
 408       die("program failed with crazy wait status %#x", status);
 409     }
 410   }
 411   exit(127);
 412 }
 413
 414 static void setup_handlers(void) {
 415   struct sigaction sa;
 416   int r;
 417
 418   r = atexit(atexit_handler);
 419   if (r) diee("(stage2) atexit");
 420
 421   sigemptyset(&sa.sa_mask);
 422   sigaddset(&sa.sa_mask, SIGALRM);
 423   sigaddset(&sa.sa_mask, SIGCHLD);
 424   sa.sa_flags = 0;
 425
 426   r = sigprocmask(SIG_BLOCK, &sa.sa_mask, 0);
 427   if (r) diee("(stage2) sigprocmask(SIG_BLOCK,)");
 428
 429   sa.sa_handler = alarm_handler;
 430   r = sigaction(SIGALRM, &sa, 0);
 431   if (r) diee("(stage2) sigaction SIGALRM");
 432
 433   sa.sa_flags |= SA_NOCLDSTOP;
 434   sa.sa_handler = child_handler;
 435   r = sigaction(SIGCHLD, &sa, 0);
 436   if (r) diee("(stage2) sigaction SIGCHLD");
 437 }
 438
 439 static void spawn_script(void) {
 440   int r;
 441   int errpipes[2];
 442
 443   r = pipe(errpipes);
 444   if (r) diee("(stage2) pipe");
 445
 446   script_child = fork();
 447   if (script_child == (pid_t)-1) diee("(stage2) fork");
 448   if (!script_child) {
 449     r = close(errpipes[0]);
 450     if (r) diee("(stage2 child) close errpipes[0]");
 451
 452     r = dup2(errpipes[1], 2);
 453     if (r != 2) diee("(stage2 child) dup2 stderr");
 454
 455     execlp(interp,
 456            interp, script, (char*)0);
 457     diee("(stage2) exec interpreter (`%s', for `%s')\n",interp,script);
 458   }
 459
 460   r = close(errpipes[1]);
 461   if (r) diee("(stage2) close errpipes[1]");
 462
 463   errpipe = errpipes[0];
 464   r = fcntl(errpipe, F_SETFL, O_NONBLOCK);
 465   if (r) diee("(stage2) set errpipe nonblocking");
 466 }
 467
 468 static void queue_alarm(void) {
 469   alarm(check_interval);
 470 }
 471
 472 static void start_logging(void) {
 473   int r;
 474
 475   openlog(script, LOG_NOWAIT|LOG_PID, LOG_USER);
 476   logging = 1;
 477   r = dup2(1,2);
 478   if (r!=2) diee("dup2 stdout to stderr");
 479 }
 480
 481 static void errpipe_readable(void) {
 482   static char buf[1024];
 483   static int pending;
 484
 485   /* %: does not contain newlines
 486    * _: empty (garbage)
 487    */
 488
 489   /*           %%%%%%%%%%%__________________ */
 490   /*                      ^ pending          */
 491
 492   for (;;) {
 493     int avail = sizeof(buf) - pending;
 494     ssize_t got = read(errpipe, buf+pending, avail);
 495     if (got==-1) {
 496       if (errno==EINTR) continue;
 497       else if (errno==EWOULDBLOCK || errno==EAGAIN) return;
 498       else diee("(stage2) errpipe read");
 499       got = 0;
 500     } else if (got==0) {
 501       warning("program closed its stderr fd");
 502       errpipe = -1;
 503       return;
 504     }
 505     int scanned = pending;
 506     pending += got;
 507     int eaten = 0;
 508     for (;;) {
 509       const char *newline = memchr(buf+scanned, '\n', pending-scanned);
 510       int printupto, eat;
 511       if (newline) {
 512         printupto = newline-buf;
 513         eat = printupto + 1;
 514       } else if (!eaten && pending==sizeof(buf)) { /* overflow */
 515         printupto = pending;
 516         eat = printupto;
 517       } else {
 518         break;
 519       }
 520       syslog(LOG_ERR,"stderr: %.*s", printupto-eaten, buf+eaten);
 521       eaten += eat;
 522       scanned = eaten;
 523     }
 524     pending -= eaten;
 525     memmove(buf, buf+eaten, pending);
 526   }
 527 }
 528
 529 static void await_something(void) {
 530   int r;
 531   sigset_t mask;
 532   sigemptyset(&mask);
 533
 534   for (;;) {
 535     fd_set rfds;
 536     FD_ZERO(&rfds);
 537     if (errpipe >= 0)
 538       FD_SET(errpipe, &rfds);
 539     r = pselect(errpipe+1, &rfds,0,0, 0, &mask);
 540     if (r==-1) {
 541       if (errno != EINTR) diee("(stage2) sigsuspend");
 542       continue;
 543     }
 544     assert(r>0);
 545     assert(FD_ISSET(errpipe, &rfds));
 546     errpipe_readable();
 547   }
 548 }