Do something useful when users attempt to become themselves.

[become] / src / become.c

/* -*-c-*-
 *
 * $Id: become.c,v 1.3 1997/08/07 16:28:59 mdw Exp $
 *
 * Main code for `become'
 *
 * (c) 1997 EBI
 */

/*----- Licensing notice --------------------------------------------------*
 *
 * This file is part of `become'
 *
 * `Become' 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.
 *
 * `Become' 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 `become'; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 */

/*----- Revision history --------------------------------------------------*
 *
 * $Log: become.c,v $
 * Revision 1.3  1997/08/07 16:28:59  mdw
 * Do something useful when users attempt to become themselves.
 *
 * Revision 1.2  1997/08/04 10:24:20  mdw
 * Sources placed under CVS control.
 *
 * Revision 1.1  1997/07/21  13:47:54  mdw
 * Initial revision
 *
 */

/*----- Header files ------------------------------------------------------*/

/* --- ANSI headers --- */

#include <ctype.h>
#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>

/* --- Unix headers --- */

#include <sys/types.h>
#include <sys/stat.h>
#include <sys/socket.h>
#include <sys/utsname.h>

#include <netinet/in.h>

#include <arpa/inet.h>

#include <netdb.h>
#include <pwd.h>
#include <syslog.h>
#include <unistd.h>

extern char **environ;

/* --- Local headers --- */

#include "become.h"
#include "config.h"
#include "check.h"
#include "daemon.h"
#include "lexer.h"
#include "mdwopt.h"
#include "name.h"
#include "parser.h"
#include "rule.h"
#include "utils.h"
#include "userdb.h"

/*----- Main code ---------------------------------------------------------*/

/* --- @bc__write@ --- *
 *
 * Arguments:   @FILE *fp@ = pointer to a stream to write on
 *              @const char *p@ = pointer to a string
 *
 * Returns:     ---
 *
 * Use:         Writes the string to the stream, substituting the program
 *              name (as returned by @quis@) for each occurrence of the
 *              character `$'.
 */

static void bc__write(FILE *fp, const char *p)
{
  const char *n = quis();
  size_t l;
  size_t nl = strlen(n);

  /* --- Try to be a little efficient --- *
   *
   * Gather up non-`$' characters using @strcpn@ and spew them out really
   * quickly.
   */

  for (;;) {
    l = strcspn(p, "$");
    if (l)
      fwrite(p, l, 1, fp);
    p += l;
    if (!*p)
      break;
    fwrite(n, nl, 1, fp);
    p++;
  }
}

/* --- @bc__banner@ --- *
 *
 * Arguments:   @FILE *fp@ = stream to write on
 *
 * Returns:     ---
 *
 * Use:         Writes a banner containing copyright information.
 */

static void bc__banner(FILE *fp)
{
  bc__write(fp, "$ version " VERSION "\n");
}

/* --- @bc__usage@ --- *
 *
 * Arguments:   @FILE *fp@ = stream to write on
 *
 * Returns:     ---
 *
 * Use:         Writes a terse reminder of command line syntax.
 */

static void bc__usage(FILE *fp)
{
  bc__write(fp,
            "Usage: \n"
            "   $ -c <shell-command> <user>\n"
            "   $ <user> [<command> [<arguments>]...]\n"
            "   $ -d [-p <port>] [-f <config-file>]\n");
}

/* --- @bc__makeEnv@ --- *
 *
 * Arguments:   @const char *var@ = name of an environment variable
 *              @const char *value@ = value of the variable
 *
 * Returns:     A pointer to an allocated block assigning the value to the
 *              name.
 *
 * Use:         Constructs environment mappings.
 */

static char *bc__makeEnv(const char *var, const char *value)
{
  char *p = xmalloc(strlen(var) + strlen(value) + 2);
  sprintf(p, "%s=%s", var, value);
  return (p);
}

/* --- @bc__help@ --- *
 *
 * Arguments:   @FILE *fp@ = stream to write on
 *
 * Returns:     ---
 *
 * Use:         Displays a help message for this excellent piece of software.
 */

static void bc__help(FILE *fp)
{
  bc__banner(fp);
  putc('\n', fp);
  bc__usage(fp);
  putc('\n', fp);
  bc__write(fp,
"The `$' program allows you to run a process as another user.\n"
"If a command name is given, this is the process executed.  If the `-c'\n"
"option is used, the process is assumed to be `/bin/sh'.  If no command is\n"
"given, your default login shell is used.\n"
"\n"
"Your user id, the user id you wish to become, the name of the process\n"
"you wish to run, and the identity of the current host are looked up to\n"
"ensure that you have permission to do this.\n"
"\n"
"Note that logs are kept of all uses of this program.\n"
"\n"
"Options available are:\n"
"\n"
"-h, --help             Display this help text\n"
"-v, --version          Display the version number of this copy of $\n"
"-l, --login            Really log in as the user\n"
"-c, --command=CMD      Run the (Bourne) shell command CMD\n"
"-d, --daemon           Start up a daemon, to accept requests from clients\n"
"-p, --port=PORT                In daemon mode, listen on PORT\n"
"-f, --config-file=FILE In daemon mode, read config from FILE\n"
#ifdef TRACING
"--impersonate=USER     Claim to be USER when asking the server\n"
"--trace=FILE           Dump trace information to FILE (boring)\n"
"--trace-level=OPTS     Set level of tracing information\n"
#endif
);
}

/* --- @main@ --- *
 *
 * Arguments:   @int argc@ = number of command line arguments
 *              @char *argv[]@ = pointer to the various arguments
 *
 * Returns:     Zero if successful.
 *
 * Use:         Allows a user to change UID.
 */

int main(int argc, char *argv[])
{
  /* --- Request block setup parameters --- */

  request rq;                           /* Request buffer to build */
  char *cmd = 0;                        /* Shell command to execute */
  char *binary = "/bin/sh";             /* Default binary to execute */
  char **env = environ;                 /* Default environment to pass */
  char **todo;                          /* Pointer to argument list */
  struct passwd *from_pw = 0;           /* User we are right now */
  struct passwd *to_pw = 0;             /* User we want to become */

  /* --- Become server setup parameters --- */

  char *conffile = file_RULES;          /* Default config file for daemon */
  int port = -1;                        /* Default port for daemon */

  /* --- Miscellanous shared variables --- */

  unsigned flags = 0;                   /* Various useful flags */

  /* --- Default argument list executes a shell command --- */

  static char *shell[] = {
    "/bin/sh",                          /* Bourne shell */
    "-c",                               /* Read from command line */
    0,                                  /* Pointer to shell command */
    0                                   /* Terminator */
  };

  /* --- Login request replaces the environment with this --- */

  static char *mangled_env[] = {
    "PATH=/bin:/usr/bin",               /* Default `clean' path*/
    0,                                  /* User's name (`USER') */
    0,                                  /* User's name (`LOGNAME') */
    0,                                  /* Home directory (`HOME') */
    0                                   /* Terminator */
  };

  /* --- Definitions for the various flags --- */

  enum {
    f_daemon = 1,                       /* Start up in daemon mode */
    f_duff = 2,                         /* Fault in arguments */
    f_login = 4,                        /* Execute as a login shell */
    f_dummy = 8,                        /* Don't actually do anything */
    f_setuid = 16                       /* We're running setuid */
  };

  /* --- Set up the program name --- */

  ego(argv[0]);
  clock();
  if (getuid() != geteuid())
    flags |= f_setuid;

  /* --- Parse some command line arguments --- */

  for (;;) {
    int i;
    static struct option opts[] = {
      { "help",         0,              0,      'h' },
      { "version",      0,              0,      'v' },
      { "login",        0,              0,      'l' },
      { "command",      gFlag_argReq,   0,      'c' },
      { "daemon",       0,              0,      'd' },
      { "port",         gFlag_argReq,   0,      'p' },
      { "config-file",  gFlag_argReq,   0,      'f' },
#ifdef TRACING
      { "impersonate",  gFlag_argReq,   0,      'I' },
      { "trace",        gFlag_argOpt,   0,      'T' },
      { "trace-level",  gFlag_argOpt,   0,      'L' },
#endif
      { 0,              0,              0,      0 }
    };

    i = mdwopt(argc, argv, "+hvlc:p:df:", opts, 0, 0, 0);
    if (i < 0)
      break;

    switch (i) {

      /* --- Standard help and version options --- */

      case 'h':
        bc__help(stdout);
        exit(0);
        break;
      case 'v':
        bc__banner(stdout);
        exit(0);
        break;

      /* --- Various simple options --- */

      case 'l':
        flags |= f_login;
        break;
      case 'c':
        cmd = optarg;
        break;
      case 'p':
        port = atoi(optarg);
        break;
      case 'd':
        flags |= f_daemon;
        break;
      case 'f':
        conffile = optarg;
        break;

      /* --- Pretend to be a different user --- *
       *
       * There are all sorts of nasty implications for this option.  Don't
       * allow it if we're running setuid.  Disable the actual login anyway.
       */

#ifdef TRACING
      case 'I':
        if (flags & f_setuid)
          moan("shan't allow impersonation while running setuid");
        else {
          struct passwd *pw;
          if (isdigit((unsigned char)optarg[0]))
            pw = getpwuid(atoi(optarg));
          else
            pw = getpwnam(optarg);
          if (!pw)
            die("can't impersonate unknown user `%s'", optarg);
          from_pw = userdb_copyUser(pw);
          rq.from = from_pw->pw_uid;
          flags |= f_dummy;
        }
        break;
#endif

      /* --- Tracing support --- *
       *
       * Be careful not to zap a file I wouldn't normally be allowed to write
       * to!
       */

#ifdef TRACING

      case 'T': {
        FILE *fp;

        if (optarg == 0 || strcmp(optarg, "-") == 0)
          fp = stdout;
        else {
          if ((flags & f_setuid) && access(optarg, W_OK)) {
            die("no write permission for trace file file `%s': %s",
                optarg, strerror(errno));
          }
          if ((fp = fopen(optarg, "w")) == 0) {
            die("couldn't open trace file `%s' for writing: %s",
                optarg, strerror(errno));
          }
        }
        traceon(fp, TRACE_DFL);
        trace(TRACE_MISC, "become: tracing enabled");
      } break;

#endif

      /* --- Setting trace levels --- */

#ifdef TRACING

      case 'L': {
        int sense = 1;
        unsigned int lvl = 0, l;
        const char *p = optarg;

        /* --- Table of tracing facilities --- */

        typedef struct tr {
          char ch;
          unsigned int l;
          const char *help;
        } tr;

        static tr lvltbl[] = {
          { 'm', TRACE_MISC,    "miscellaneous messages" },
          { 's', TRACE_SETUP,   "building the request block" },
          { 'd', TRACE_DAEMON,  "server process" },
          { 'r', TRACE_RULE,    "ruleset scanning" },
          { 'c', TRACE_CHECK,   "request checking" },
          { 'l', TRACE_CLIENT,  "client process" },
          { 'R', TRACE_RAND,    "random number generator" },
          { 'C', TRACE_CRYPTO,  "cryptographic processing of requests" },
          { 'y', TRACE_YACC,    "parsing configuration file" },
          { 'D', TRACE_DFL,     "default tracing options" },
          { 'A', TRACE_ALL,     "all tracing options" },
          { 0,   0,             0 }
        };
        tr *tp;

        /* --- Output some help if there's no arguemnt --- */

        if (!optarg) {
          bc__banner(stdout);
          bc__write(stdout,
                    "\n"
                    "Tracing options:\n"
                    "\n");
          for (tp = lvltbl; tp->l; tp++) {
            if ((flags & f_setuid) == 0 || tp->l & ~TRACE_PRIV)
              printf("%c -- %s\n", tp->ch, tp->help);
          }
          bc__write(stdout,
"\n"
"Also, `+' and `-' options are recognised to turn on and off vavrious\n"
"tracing options.  For example, `A-r' enables everything except ruleset\n"
"tracing, and `A-D+c' is everything except the defaults, but with request\n"
"check tracing.\n"
);
          exit(0);
        }

        while (*p) {
          if (*p == '+')
            sense = 1;
          else if (*p == '-')
            sense = 0;
          else {
            for (tp = lvltbl; tp->l && *p != tp->ch; tp++)
              ;
            l = tp->l;
            if (flags & f_setuid)
              l &= ~TRACE_PRIV;
            if (l)
              lvl = sense ? (lvl | l) : (lvl & ~l);
            else
              moan("unknown trace option `%c'", *p);
          }
          p++;
        }

        tracesetlvl(lvl);
        yydebug = ((lvl & TRACE_YACC) != 0);
      } break;

#endif

      /* --- Something I didn't understand has occurred --- */

      case '?':
        flags |= f_duff;
        break;
    }
  }
  if (flags & f_duff) {
    bc__usage(stderr);
    exit(1);
  }

  /* --- Switch to daemon mode if requested --- */

  if (flags & f_daemon) {
    T( trace(TRACE_MISC, "become: daemon mode requested"); )
    daemon_init(conffile, port);
    exit(0);
  }

  /* --- Open a syslog --- */

  openlog(quis(), 0, LOG_AUTH);

  /* --- Pick out the uid --- */

  {
    const char *u;
    struct passwd *pw;

    if (optind >= argc) {
      bc__usage(stderr);
      exit(1);
    }
    u = argv[optind++];

    if (isdigit((unsigned char)u[0]))
      pw = getpwuid(atoi(u));
    else
      pw = getpwnam(u);
    if (!pw)
      die("unknown user `%s'", u);
    to_pw = userdb_copyUser(pw);
    rq.to = pw->pw_uid;
  }

  /* --- Fill in the easy bits of the request --- */

  if (!from_pw) {
    struct passwd *pw;

    rq.from = getuid();
    pw = getpwuid(rq.from);
    if (!pw)
      die("who are you? (can't find user %li)", (long)rq.from);
    from_pw = userdb_copyUser(pw);
  }

  /* --- Find the local host address --- */

  {
    struct utsname u;
    struct hostent *he;
    uname(&u);
    if ((he = gethostbyname(u.nodename)) == 0)
      die("who am I? (can't resolve `%s')", u.nodename);
    memcpy(&rq.host, he->h_addr, sizeof(struct in_addr));
  }

  /* --- Shell commands are easy --- */

  if (cmd) {
    shell[2] = cmd;
    todo = shell;
  }

  /* --- A command given on the command line isn't too hard --- */

  else if (optind < argc) {
    todo = argv + optind;
    binary = todo[0];
  }

  /* --- A login request needs a little bit of work --- */

  else if (flags & f_login) {
    const char *p = strrchr(to_pw->pw_shell, '/');
    if (p)
      p++;
    else
      p = to_pw->pw_shell;
    shell[0] = xmalloc(strlen(p) + 2);
    shell[0][0] = '-';
    strcpy(shell[0] + 1, p);
    shell[1] = 0;
    todo = shell;
    binary = to_pw->pw_shell;
  }

  /* --- An unadorned becoming requires little work --- */

  else {
    shell[0] = from_pw->pw_shell;
    shell[1] = 0;
    todo = shell;
    binary = todo[0];
  }

  /* --- Mangle the environment if login flag given --- */

  if (flags & f_login) {
    env = mangled_env;
    env[1] = bc__makeEnv("USER", to_pw->pw_name);
    env[2] = bc__makeEnv("LOGNAME", to_pw->pw_name);
    env[3] = bc__makeEnv("HOME", to_pw->pw_dir);
  }

  /* --- Trace the command --- */

  IF_TRACING(TRACE_SETUP, {
    int i;

    trace(TRACE_SETUP, "setup: from user %s to user %s",
          from_pw->pw_name, to_pw->pw_name);
    trace(TRACE_SETUP, "setup: binary == `%s'", binary);
    for (i = 0; todo[i]; i++)
      trace(TRACE_SETUP, "setup: arg %i == `%s'", i, todo[i]);
    for (i = 0; env[i]; i++)
      trace(TRACE_SETUP, "setup: env %i == `%s'", i, env[i]);
  })

  /* --- If necessary, resolve the path to the command --- */

  if (!strchr(binary, '/')) {
    char *path, *p;
    struct stat st;

    if ((p = getenv("PATH")) == 0)
      p = "/bin:/usr/bin";
    path = xstrdup(p);

    for (p = strtok(path, ":"); (p = strtok(0, ":")) != 0; ) {

      /* --- SECURITY: check length of string before copying --- */

      if (strlen(p) + strlen(binary) + 2 > sizeof(rq.cmd))
        continue;

      /* --- Now build the pathname and check it --- */

      sprintf(rq.cmd, "%s/%s", p, todo[0]);
      if (stat(rq.cmd, &st) == 0 &&     /* Check it exists */
          st.st_mode & 0111 &&          /* Check it's executable */
          (st.st_mode & S_IFMT) == S_IFREG) /* Check it's a file */
        break;
    }

    if (!p)
      die("couldn't find `%s' in path", todo[0]);
    binary = rq.cmd;
    free(path);
  }
  T( trace(TRACE_SETUP, "setup: resolve binary to `%s'", binary); )

  /* --- Canonicalise the path string, if necessary --- */

  {
    char b[CMDLEN_MAX];
    char *p;
    const char *q;

    /* --- Insert current directory name if path not absolute --- */

    p = b;
    q = binary;
    if (*q != '/') {
      if (!getcwd(b, sizeof(b)))
        die("couldn't read current directory: %s", strerror(errno));
      p += strlen(p);
      *p++ = '/';
    }

    /* --- Now copy over characters from the path string --- */

    while (*q) {

      /* --- SECURITY: check for buffer overflows here --- *
       *
       * I write at most one byte per iteration so this is OK.  Remember to
       * allow one for the null byte.
       */

      if (p >= b + sizeof(b) - 1)
        die("internal error: buffer overflow while canonifying path");

      /* --- Reduce multiple slashes to just one --- */

      if (*q == '/') {
        while (*q == '/')
          q++;
        *p++ = '/';
      }

      /* --- Handle dots in filenames --- *
       *
       * @p[-1]@ is valid here, because if @*q@ is not a `/' then either
       * we've just stuck the current directory on the end of the buffer,
       * or we've just put something else on the end.
       */

      else if (*q == '.' && p[-1] == '/') {

        /* --- A simple `./' just gets removed --- */

        if (q[1] == 0 || q[1] == '/') {
          q++;
          p--;
          continue;
        }

        /* --- A `../' needs to be peeled back to the previous `/' --- */

        if (q[1] == '.' && (q[2] == 0 || q[2] == '/')) {
          q += 2;
          p--;
          while (p > b && p[-1] != '/')
            p--;
          if (p > b)
            p--;
          continue;
        }
      } else
        *p++ = *q++;
    }

    *p++ = 0;
    strcpy(rq.cmd, b);
  }
  T( trace(TRACE_SETUP, "setup: canonify binary to `%s'", rq.cmd); )

  /* --- Run the check --- *
   *
   * If the user is already what she wants to be, then print a warning.
   * Then, if I was just going to spawn a shell, quit, to reduce user
   * confusion.  Otherwise, do what was wanted anyway.
   */

  if (rq.from == rq.to) {
    moan("you already are `%s'!", to_pw->pw_name);
    if (!cmd && todo == shell) {
      moan("(to prevent confusion, I'm not spawning a shell)");
      exit(0);
    }
  } else {
    int a = check(&rq);

    syslog(LOG_INFO,
           "permission %s for %s to become %s to run `%s'",
           a ? "granted" : "denied", from_pw->pw_name, to_pw->pw_name,
           rq.cmd);

    if (!a)
      die("permission denied");
  }

  /* --- Now do the job --- */

  T( trace(TRACE_MISC, "become: permission granted"); )

  if (flags & f_dummy) {
    puts("permission granted");
    return (0);
  } else {
    if (setuid(rq.to) == -1)
      die("couldn't set uid: %s", strerror(errno));
    execve(rq.cmd, todo, env);
    die("couldn't exec `%s': %s", rq.cmd, strerror(errno));
    return (127);
  }
}

/*----- That's all, folks -------------------------------------------------*/