cprogs/cgi-fcgi-interp.c

   1 /*
   2  * "Interpreter" that you can put in #! like this
   3  *   #!/usr/bin/cgi-fcgi-interp [<options>] <interpreter>
   4  *   #!/usr/bin/cgi-fcgi-interp [<options>],<interpreter>
   5  */
   6 /*
   7  * cgi-fcgi-interp.[ch] - C helpers common to the whole of chiark-utils
   8  *
   9  * Copyright 2016 Ian Jackson
  10  * Copyright 1982,1986,1993 The Regents of the University of California
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public
  23  * License along with this file; if not, consult the Free Software
  24  * Foundation's website at www.fsf.org, or the GNU Project website at
  25  * www.gnu.org.
  26  *
  27  * See below for a BSD 3-clause notice regarding timespeccmp.
  28  */
  29 /*
  30  * The result is a program which looks, when executed via the #!
  31  * line, like a CGI program.  But the script inside will be executed
  32  * via <interpreter> in an fcgi context.
  33  *
  34  * Options:
  35  *
  36  *  <interpreter>
  37  *          The real interpreter to use.  Eg "perl".  Need not
  38  *          be an absolute path; will be fed to execvp.
  39  *
  40  *  -g<ident>
  41  *          Use <ident> rather than hex(sha256(<script>))
  42  *          as the basename of the leafname of the fcgi rendezvous
  43  *          socket.  If <ident> contains only hex digit characters it
  44  *          ought to be no more than 32 characters.  <ident> should
  45  *          not contain spaces or commas (see below).
  46  *
  47  *  -M<numservers>
  48  *         Start <numservers> instances of the program.  This
  49  *         determines the maximum concurrency.  (Note that unlike
  50  *         speedy, the specified number of servers is started
  51  *         right away.)  The default is 4.
  52  *
  53  *  -c<interval>
  54  *         Stale server check interval, in seconds.  The worker
  55  *         process group will get a SIGTERM when it is no longer
  56  *         needed to process new requests.  Ideally it would continue
  57  *         to serve any existing requests.  The SIGTERM will arrive no
  58  *         earlier than <interval> after the last request arrived at
  59  *         the containing webserver.  Default is 300.
  60  *
  61  *  -D
  62  *         Debug mode.  Do not actually run program.  Instead, print
  63  *         out what we would do.
  64  *
  65  * <options> and <interpreter> can be put into a single argument
  66  * to cgi-fcgi-interp, separated by spaces or commas.  <interpreter>
  67  * must come last.
  68  *
  69  * cgi-fcgi-interp automatically expires old sockets, including
  70  * ones where the named script is out of date.
  71  */
  72
  73 /*
  74  * Uses one of two directories
  75  *   /var/run/user/<UID>/cgi-fcgi-interp/
  76  *   ~/.cgi-fcgi-interp/<node>/
  77  * and inside there uses these paths
  78  *   s<ident>
  79  *   l<ident>    used to lock around garbage collection
  80  *
  81  * If -M<ident> is not specified then an initial substricg of the
  82  * lowercase hex of the sha256 of the <script> (ie, our argv[1]) is
  83  * used.  The substring is chosen so that the whole path is 10 bytes
  84  * shorter than sizeof(sun_path).  But always at least 33 characters.
  85  *
  86  * <node> is truncated at the first `.' and after the first 32
  87  * characters.
  88  *
  89  * Algorithm:
  90  *  - see if /var/run/user exists
  91  *       if so, lstat /var/run/user/<UID> and check that
  92  *         we own it and it's X700; if not, fail
  93  *         if it's ok then <base> is /var/run/user/<UID>
  94  *       otherwise, look for and maybe create ~/.cgi-fcgi-interp
  95  *         (where ~ is HOME or from getpwuid)
  96  *         and then <base> is ~/.cgi-fcgi-interp/<node>
  97  *  - calculate pathname (checking <ident> length is OK)
  98  *  - check for and maybe create <base>
  99  *  - stat and lstat the <script>
 100  *  - stat the socket and check its timestamp
 101  *       if it is too old, unlink it
 102  *  - dup stderr, mark no cloexec
 103  *  - run     cgi-fcgi -connect SOCKET       \
 104  *                cgi-fcgi-interp \
 105  *                --stage2 <was-stderr> <socket>      \
 106  -c<check-interval>             \
 107  *               \
 108  *                <interp> <script>
 109  *
 110  * --stage2 does this:
 111  *  - dup2 <was-stderr> to fd 2
 112  *  - open /dev/null and expect fd 1 (and if not, close it)
 113  *  - become a new process group
 114  *  - lstat <socket> to find its inum, mtime
 115  *  - fork/exec <interp> <script>
 116  *  - periodically lstat <interp> and <script> and
 117  *      if mtime is newer than our start time
 118  *      kill process group (at second iteration)
 119  */
 120
 121 #include "common.h"
 122
 123 #include <stdio.h>
 124 #include <stdlib.h>
 125 #include <string.h>
 126 #include <errno.h>
 127 #include <stdbool.h>
 128 #include <assert.h>
 129 #include <limits.h>
 130
 131 #include <sys/types.h>
 132 #include <sys/stat.h>
 133 #include <sys/utsname.h>
 134 #include <sys/socket.h>
 135 #include <sys/un.h>
 136 #include <sys/file.h>
 137 #include <unistd.h>
 138 #include <fcntl.h>
 139 #include <pwd.h>
 140 #include <err.h>
 141 #include <time.h>
 142 #include <signal.h>
 143
 144 #include <nettle/sha.h>
 145
 146 #include "myopt.h"
 147
 148 #define die  common_die
 149 #define diee common_diee
 150
 151 #define MINHEXHASH 33
 152
 153 static const char *interp, *ident;
 154 static int numservers=4, debugmode, stage2;
 155 static int check_interval=300;
 156
 157 void diee(const char *m) {
 158   err(127, "error: %s failed", m);
 159 }
 160
 161 static void fusagemessage(FILE *f) {
 162   fprintf(f, "usage: #!/usr/bin/cgi-fcgi-interp [<options>]\n");
 163 }
 164
 165 void usagemessage(void) { fusagemessage(stderr); }
 166
 167 static void of_help(const struct cmdinfo *ci, const char *val) {
 168   fusagemessage(stdout);
 169   if (ferror(stdout)) diee("write usage message to stdout");
 170   exit(0);
 171 }
 172
 173 static void of_iassign(const struct cmdinfo *ci, const char *val) {
 174   long v;
 175   char *ep;
 176   errno= 0; v= strtol(val,&ep,10);
 177   if (!*val || *ep || errno || v<INT_MIN || v>INT_MAX)
 178     badusage("bad integer argument `%s' for --%s",val,ci->olong);
 179   *ci->iassignto = v;
 180 }
 181
 182 #define MAX_OPTS 5
 183
 184 static const struct cmdinfo cmdinfos[]= {
 185   { "help",   0, .call= of_help               },
 186   { 0, 'g',   1, .sassignto= &ident           },
 187   { 0, 'M',   1, .call=of_iassign, .iassignto= &numservers      },
 188   { 0, 'D',   0, .iassignto= &debugmode, .arg= 1 },
 189   { 0, 'c',   1, .call=of_iassign, .iassignto= &check_interval  },
 190   { "--stage2",0, 0, .iassignto= &stage2, .arg= 1 },
 191   { 0 }
 192 };
 193
 194 static uid_t us;
 195 static const char *run_base, *script, *socket_path;
 196 static int stderr_copy;
 197
 198 static bool find_run_base_var_run(void) {
 199   struct stat stab;
 200   char *try;
 201   int r;
 202
 203   try = m_asprintf("%s/%lu", "/var/run/user", us);
 204   r = lstat(try, &stab);
 205   if (r<0) {
 206     if (errno == ENOENT ||
 207         errno == ENOTDIR ||
 208         errno == EACCES ||
 209         errno == EPERM)
 210       return 0; /* oh well */
 211     diee("stat /var/run/user/UID");
 212   }
 213   if (!S_ISDIR(stab.st_mode)) {
 214     warnx("%s not a directory, falling back to ~\n", try);
 215     return 0;
 216   }
 217   if (stab.st_uid != us) {
 218     warnx("%s not owned by uid %lu, falling back to ~\n", try,
 219           (unsigned long)us);
 220     return 0;
 221   }
 222   if (stab.st_mode & 0077) {
 223     warnx("%s writeable by group or other, falling back to ~\n", try);
 224     return 0;
 225   }
 226   run_base = m_asprintf("%s/%s", try, "cgi-fcgi-interp");
 227   return 1;
 228 }
 229
 230 static bool find_run_base_home(void) {
 231   struct passwd *pw;
 232   struct utsname ut;
 233   char *dot, *try;
 234   int r;
 235
 236   pw = getpwuid(us);  if (!pw) diee("getpwent(uid)");
 237
 238   r = uname(&ut);   if (r) diee("uname(2)");
 239   dot = strchr(ut.nodename, '.');
 240   if (dot) *dot = 0;
 241   if (sizeof(ut.nodename) > 32)
 242     ut.nodename[32] = 0;
 243
 244   try = m_asprintf("%s/%s/%s", pw->pw_dir, ".cgi-fcgi-interp", ut.nodename);
 245   run_base = try;
 246   return 1;
 247 }
 248
 249 static void find_socket_path(void) {
 250   struct sockaddr_un sun;
 251   int r;
 252
 253   us = getuid();  if (us==(uid_t)-1) diee("getuid");
 254
 255   find_run_base_var_run() ||
 256     find_run_base_home() ||
 257     (abort(),0);
 258
 259   int maxidentlen = sizeof(sun.sun_path) - strlen(run_base) - 10 - 2;
 260
 261   if (!ident) {
 262     if (maxidentlen < MINHEXHASH)
 263       errx(127,"base directory `%s'"
 264            " leaves only %d characters for id hash"
 265            " which is too little (<%d)",
 266            run_base, maxidentlen, MINHEXHASH);
 267
 268     int identlen = maxidentlen > 64 ? 64 : maxidentlen;
 269     char *hexident = xmalloc(identlen + 2);
 270     struct sha256_ctx sc;
 271     unsigned char bbuf[32];
 272     int i;
 273
 274     sha256_init(&sc);
 275     sha256_update(&sc,strlen(interp)+1,interp);
 276     sha256_update(&sc,strlen(script)+1,script);
 277     sha256_digest(&sc,sizeof(bbuf),bbuf);
 278
 279     for (i=0; i<identlen; i += 2)
 280       sprintf(hexident+i, "%02x", bbuf[i/2]);
 281
 282     hexident[identlen] = 0;
 283     ident = hexident;
 284   }
 285
 286   if (strlen(ident) > maxidentlen)
 287     errx(127, "base directory `%s' plus ident `%s' too long"
 288          " (with spare) for socket (max ident %d)\n",
 289          run_base, ident, maxidentlen);
 290
 291   r = mkdir(run_base, 0700);
 292   if (r) {
 293     if (!(errno == EEXIST))
 294       err(127,"mkdir %s",run_base);
 295   }
 296
 297   socket_path = m_asprintf("%s/g%s",run_base,ident);
 298 }
 299
 300 /*
 301  * Regarding the macro timespeccmp:
 302  *
 303  * Copyright (c) 1982, 1986, 1993
 304  *      The Regents of the University of California.  All rights reserved.
 305  *
 306  * Redistribution and use in source and binary forms, with or without
 307  * modification, are permitted provided that the following conditions
 308  * are met:
 309  * 1. Redistributions of source code must retain the above copyright
 310  *    notice, this list of conditions and the following disclaimer.
 311  * 2. Redistributions in binary form must reproduce the above copyright
 312  *    notice, this list of conditions and the following disclaimer in the
 313  *    documentation and/or other materials provided with the distribution.
 314  * 4. Neither the name of the University nor the names of its contributors
 315  *    may be used to endorse or promote products derived from this software
 316  *    without specific prior written permission.
 317  *
 318  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 319  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 320  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 321  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 322  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 323  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 324  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 325  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 326  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 327  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 328  * SUCH DAMAGE.
 329  *
 330  *      @(#)time.h      8.5 (Berkeley) 5/4/95
 331  * $FreeBSD: head/sys/sys/time.h 275985 2014-12-21 05:07:11Z imp $
 332  */
 333 #ifndef timespeccmp
 334 #define timespeccmp(tvp, uvp, cmp)                                      \
 335         (((tvp)->tv_sec == (uvp)->tv_sec) ?                             \
 336             ((tvp)->tv_nsec cmp (uvp)->tv_nsec) :                       \
 337             ((tvp)->tv_sec cmp (uvp)->tv_sec))
 338 #endif /*timespeccmp*/
 339
 340
 341
 342 static bool stab_isnewer(const struct stat *a, const struct stat *b) {
 343 #ifdef st_mtime
 344   return timespeccmp(&a->st_mtim, &b->st_mtim, >);
 345 #else
 346   return a->st_mtime > &b->st_mtime;
 347 #endif
 348 }
 349
 350 static bool check_garbage_vs(const struct stat *started) {
 351   struct stat script_stab;
 352   struct stat sock_stab;
 353   int r;
 354
 355   r = lstat(script, &script_stab);
 356   if (r) err(127,"lstat script (%s)",script);
 357
 358   if (stab_isnewer(&script_stab, &sock_stab))
 359     return 1;
 360
 361   if (S_ISLNK(script_stab.st_mode)) {
 362     r = stat(script, &script_stab);
 363     if (r) err(127,"stat script (%s0",script);
 364
 365     if (stab_isnewer(&script_stab, &sock_stab))
 366       return 1;
 367   }
 368
 369   return 0;
 370 }
 371
 372 static bool check_garbage(void) {
 373   struct stat sock_stab;
 374   int r;
 375
 376   r = lstat(socket_path, &sock_stab);
 377   if (r) {
 378     if ((errno == ENOENT))
 379       return 0; /* well, no garbage then */
 380     err(127,"stat socket (%s)",socket_path);
 381   }
 382
 383   return check_garbage_vs(&sock_stab);
 384 }
 385
 386 static void tidy_garbage(void) {
 387   /* We lock l<ident> and re-check.  The effect of this is that each
 388    * stale socket is removed only once.  So unless multiple updates to
 389    * the script happen rapidly, we can't be racing with the cgi-fcgi
 390    * (which is recreating the socket */
 391   int lockfd = -1;
 392   int r;
 393
 394   const char *lock_path = m_asprintf("%s/l%s",run_base,ident);
 395
 396   lockfd = open(lock_path, O_CREAT|O_RDWR, 0600);
 397   if (lockfd<0) err(127,"create lock (%s)", lock_path);
 398
 399   r = flock(lockfd, LOCK_EX);
 400   if (r) err(127,"lock lock (%s)", lock_path);
 401
 402   if (check_garbage()) {
 403     r = unlink(socket_path);
 404     if (r) {
 405       if (!(errno == ENOENT))
 406         err(127,"remove out-of-date socket (%s)", socket_path);
 407     }
 408   }
 409
 410   r = close(lockfd);
 411   if (r) errx(127,"close lock (%s)", lock_path);
 412 }
 413
 414 static void make_stderr_copy(void) {
 415   stderr_copy = dup(2);
 416   if (stderr_copy < 0) err(127,"dup stderr (for copy for stage2)");
 417 }
 418
 419 static void shbang_opts(const char *const **argv_io,
 420                         const struct cmdinfo *cmdinfos) {
 421   myopt(argv_io, cmdinfos);
 422
 423   interp = *(*argv_io)++;
 424   if (!interp) errx(127,"need interpreter argument");
 425 }
 426
 427 /* stage2 predeclarations */
 428 static void record_baseline_time(void);
 429 static void become_pgrp(void);
 430 static void setup_handlers(void);
 431 static void spawn_script(void);
 432 static void queue_alarm(void);
 433 static void await_something(void);
 434
 435 int main(int argc, const char *const *argv) {
 436   const char *smashedopt, *us;
 437   int r;
 438
 439   us = argv[0];
 440
 441   if (argc>=4 && !strcmp(argv[1],"--stage2")) {
 442     ++argv;
 443     stage2 = 1;
 444
 445     int stderrfd = atoi(*++argv);
 446     r = dup2(stderrfd, 2);
 447     assert(r==2);
 448
 449     r = open("/dev/null",O_WRONLY);
 450     if (r<0) err(127,"open /dev/null as stdout");
 451     if (r>=3) close(r);
 452     else if (r!=1) errx(127,"open /dev/null for stdout gave bad fd %d",r);
 453
 454     socket_path = *++argv;
 455   }
 456
 457   if (argc>=2 &&
 458       (smashedopt = argv[1]) &&
 459       smashedopt[0]=='-' &&
 460       (strchr(smashedopt,' ') || strchr(smashedopt,','))) {
 461     /* single argument containg all the options and <interp> */
 462     argv += 2; /* eat argv[0] and smashedopt */
 463     const char *split_args[MAX_OPTS+1];
 464     int split_argc = 0;
 465     split_args[split_argc++] = argv[0];
 466     for (;;) {
 467       if (split_argc >= MAX_OPTS) errx(127,"too many options in combined arg");
 468       split_args[split_argc++] = smashedopt;
 469       if (smashedopt[0] != '-') /* never true on first iteration */
 470         break;
 471       char *delim = strchr(smashedopt,' ');
 472       if (!delim) delim = strchr(smashedopt,',');
 473       if (!delim)
 474         errx(127,"combined arg lacks <interpreter>");
 475       *delim = 0;
 476       smashedopt = delim+1;
 477     }
 478     assert(split_argc <= MAX_OPTS);
 479     split_args[split_argc++] = 0;
 480
 481     const char *const *split_argv = split_args;
 482
 483     shbang_opts(&split_argv, cmdinfos);
 484     /* sets interp */
 485     if (!split_argv) errx(127,"combined arg too many non-option arguments");
 486   } else {
 487     shbang_opts(&argv, cmdinfos);
 488   }
 489
 490   script = *argv++;
 491   if (!script) errx(127,"need script argument");
 492   if (*argv) errx(127,"too many arguments");
 493
 494   if (!stage2) {
 495
 496     find_socket_path();
 497
 498     bool isgarbage = check_garbage();
 499
 500     if (debugmode) {
 501       printf("socket: %s\n",socket_path);
 502       printf("interp: %s\n",interp);
 503       printf("script: %s\n",script);
 504       printf("garbage: %d\n",isgarbage);
 505       exit(0);
 506     }
 507
 508     if (isgarbage)
 509       tidy_garbage();
 510
 511     make_stderr_copy();
 512
 513     execlp("cgi-fcgi",
 514            "cgi-fcti", "-connect", socket_path,
 515            us, "--stage2",
 516            m_asprintf("-c%d", check_interval),
 517            m_asprintf("%d", stderr_copy), socket_path,
 518            interp, script,
 519            (char*)0);
 520     err(127,"exec cgi-fcgi");
 521
 522   } else { /*stage2*/
 523
 524     record_baseline_time();
 525     become_pgrp();
 526     setup_handlers();
 527     spawn_script();
 528     queue_alarm();
 529     await_something();
 530     abort();
 531
 532   }
 533 }
 534
 535 /* stage2 */
 536
 537 /* It is most convenient to handle the recheck timeout, as well as
 538  * child death, in signal handlers.  Our signals all block each other,
 539  * and the main program has signals blocked except in sigsuspend, so
 540  * we don't need to worry about async-signal-safety, or errno. */
 541
 542 static struct stat baseline_time;
 543 static pid_t script_child, stage2_pgrp;
 544 static bool out_of_date;
 545
 546 static void record_baseline_time(void) {
 547 #ifdef st_mtime
 548   int r = clock_gettime(CLOCK_REALTIME, &baseline_time.st_mtim);
 549   if (r) err(127,"(stage2) clock_gettime");
 550 #else
 551   baseline_time.st_mtime = time(NULL);
 552   if (baseline_time.st_mtime == (time_t)-1) err(127,"(stage2) time()");
 553 #endif
 554 }
 555
 556 static void become_pgrp(void) {
 557   int r;
 558
 559   stage2_pgrp = getpid();
 560
 561   r = setpgid(0,0);
 562   if (r) err(127,"(stage2) setpgid");
 563 }
 564
 565 static void atexit_handler(void) {
 566   int r;
 567
 568   sighandler_t sigr = signal(SIGTERM,SIG_IGN);
 569   if (sigr == SIG_ERR) warn("(stage2) signal(SIGTERM,SIG_IGN)");
 570
 571   r = killpg(stage2_pgrp,SIGTERM);
 572   if (r) warn("(stage) killpg failed");
 573 }
 574
 575 static void alarm_handler(int dummy) {
 576   if (out_of_date)
 577     /* second timeout */
 578     exit(0); /* transfers control to atexit_handler */
 579
 580   out_of_date = check_garbage_vs(&baseline_time);
 581   queue_alarm();
 582 }
 583
 584 static void child_handler(int dummy) {
 585   for (;;) {
 586     int status;
 587     pid_t got = waitpid(-1, &status, WNOHANG);
 588     if (got == (pid_t)-1) err(127,"(stage2) waitpid");
 589     if (got != script_child) {
 590       warn("(stage2) waitpid got status %d for unknown child [%lu]",
 591            status, (unsigned long)got);
 592       continue;
 593     }
 594     if (status
 595
 596
 597 static void setup_handlers(void) {
 598   struct sigaction sa;
 599   int r;
 600
 601   r = atexit(atexit_handler);
 602   if (r) err(127,"(stage2) atexit");
 603
 604   sigemptyset(&sa.sa_mask);
 605   sigaddset(&sa.sa_mask, SIGALRM);
 606   sigaddset(&sa.sa_mask, SIGCHLD);
 607   sa.sa_flags = 0;
 608
 609   r = sigprocmask(SIG_BLOCK, &sa.sa_mask, 0);
 610   if (r) err(127,"(stage2) sigprocmask(SIG_BLOCK,)");
 611
 612   sa.sa_handler = alarm_handler;
 613   r = sigaction(SIGALRM, &sa, 0);
 614   if (r) err(127,"(stage2) sigaction SIGALRM");
 615
 616   sa.sa_flags |= SA_NOCLDSTOP;
 617   sa.sa_handler = child_handler;
 618   r = sigaction(SIGCHLD, &sa, 0);
 619   if (r) err(127,"(stage2) sigaction SIGCHLD");
 620 }
 621
 622 static void spawn_script(void) {
 623   script_child = fork();
 624   if (script_child == (pid_t)-1) err(127,"(stage2) fork");
 625   if (!script_child) {
 626     execlp(interp,
 627            interp, script, (char*)0);
 628     err(127,"(stage2) exec interpreter (`%s', for `%s')\n",interp,script);
 629   }
 630 }
 631
 632 static void queue_alarm(void) {
 633   alarm(check_interval);
 634 }
 635
 636 static void await_something(void) {
 637   int r;
 638   sigset_t mask;
 639   sigemptyset(&mask);
 640
 641   for (;;) {
 642     r = sigsuspend(&mask);
 643     assert(r==-1);
 644     if (r != EINTR) err(127,"(stage2) sigsuspend");
 645   }
 646 }