unix/uxpty.c

   1 /*
   2  * Pseudo-tty backend for pterm.
   3  */
   4
   5 #define _GNU_SOURCE
   6
   7 #include <stdio.h>
   8 #include <stdlib.h>
   9 #include <string.h>
  10 #include <unistd.h>
  11 #include <signal.h>
  12 #include <assert.h>
  13 #include <fcntl.h>
  14 #include <termios.h>
  15 #include <grp.h>
  16 #include <utmp.h>
  17 #include <pwd.h>
  18 #include <time.h>
  19 #include <sys/types.h>
  20 #include <sys/stat.h>
  21 #include <sys/wait.h>
  22 #include <sys/ioctl.h>
  23 #include <errno.h>
  24
  25 #include "putty.h"
  26 #include "tree234.h"
  27
  28 #ifndef OMIT_UTMP
  29 #include <utmpx.h>
  30 #endif
  31
  32 #ifndef FALSE
  33 #define FALSE 0
  34 #endif
  35 #ifndef TRUE
  36 #define TRUE 1
  37 #endif
  38
  39 /* updwtmpx() needs the name of the wtmp file.  Try to find it. */
  40 #ifndef WTMPX_FILE
  41 #ifdef _PATH_WTMPX
  42 #define WTMPX_FILE _PATH_WTMPX
  43 #else
  44 #define WTMPX_FILE "/var/log/wtmpx"
  45 #endif
  46 #endif
  47
  48 #ifndef LASTLOG_FILE
  49 #ifdef _PATH_LASTLOG
  50 #define LASTLOG_FILE _PATH_LASTLOG
  51 #else
  52 #define LASTLOG_FILE "/var/log/lastlog"
  53 #endif
  54 #endif
  55
  56 /*
  57  * Set up a default for vaguely sane systems. The idea is that if
  58  * OMIT_UTMP is not defined, then at least one of the symbols which
  59  * enable particular forms of utmp processing should be, if only so
  60  * that a link error can warn you that you should have defined
  61  * OMIT_UTMP if you didn't want any. Currently HAVE_PUTUTLINE is
  62  * the only such symbol.
  63  */
  64 #ifndef OMIT_UTMP
  65 #if !defined HAVE_PUTUTLINE
  66 #define HAVE_PUTUTLINE
  67 #endif
  68 #endif
  69
  70 typedef struct pty_tag *Pty;
  71
  72 /*
  73  * The pty_signal_pipe, along with the SIGCHLD handler, must be
  74  * process-global rather than session-specific.
  75  */
  76 static int pty_signal_pipe[2] = { -1, -1 };   /* obviously bogus initial val */
  77
  78 struct pty_tag {
  79     Config cfg;
  80     int master_fd, slave_fd;
  81     void *frontend;
  82     char name[FILENAME_MAX];
  83     int child_pid;
  84     int term_width, term_height;
  85     int child_dead, finished;
  86     int exit_code;
  87     bufchain output_data;
  88 };
  89
  90 /*
  91  * We store our pty backends in a tree sorted by master fd, so that
  92  * when we get an uxsel notification we know which backend instance
  93  * is the owner of the pty that caused it.
  94  */
  95 static int pty_compare_by_fd(void *av, void *bv)
  96 {
  97     Pty a = (Pty)av;
  98     Pty b = (Pty)bv;
  99
 100     if (a->master_fd < b->master_fd)
 101         return -1;
 102     else if (a->master_fd > b->master_fd)
 103         return +1;
 104     return 0;
 105 }
 106
 107 static int pty_find_by_fd(void *av, void *bv)
 108 {
 109     int a = *(int *)av;
 110     Pty b = (Pty)bv;
 111
 112     if (a < b->master_fd)
 113         return -1;
 114     else if (a > b->master_fd)
 115         return +1;
 116     return 0;
 117 }
 118
 119 static tree234 *ptys_by_fd = NULL;
 120
 121 /*
 122  * We also have a tree sorted by child pid, so that when we wait()
 123  * in response to the signal we know which backend instance is the
 124  * owner of the process that caused the signal.
 125  */
 126 static int pty_compare_by_pid(void *av, void *bv)
 127 {
 128     Pty a = (Pty)av;
 129     Pty b = (Pty)bv;
 130
 131     if (a->child_pid < b->child_pid)
 132         return -1;
 133     else if (a->child_pid > b->child_pid)
 134         return +1;
 135     return 0;
 136 }
 137
 138 static int pty_find_by_pid(void *av, void *bv)
 139 {
 140     int a = *(int *)av;
 141     Pty b = (Pty)bv;
 142
 143     if (a < b->child_pid)
 144         return -1;
 145     else if (a > b->child_pid)
 146         return +1;
 147     return 0;
 148 }
 149
 150 static tree234 *ptys_by_pid = NULL;
 151
 152 /*
 153  * If we are using pty_pre_init(), it will need to have already
 154  * allocated a pty structure, which we must then return from
 155  * pty_init() rather than allocating a new one. Here we store that
 156  * structure between allocation and use.
 157  *
 158  * Note that although most of this module is entirely capable of
 159  * handling multiple ptys in a single process, pty_pre_init() is
 160  * fundamentally _dependent_ on there being at most one pty per
 161  * process, so the normal static-data constraints don't apply.
 162  *
 163  * Likewise, since utmp is only used via pty_pre_init, it too must
 164  * be single-instance, so we can declare utmp-related variables
 165  * here.
 166  */
 167 static Pty single_pty = NULL;
 168
 169 #ifndef OMIT_UTMP
 170 static int pty_utmp_helper_pid, pty_utmp_helper_pipe;
 171 static int pty_stamped_utmp;
 172 static struct utmpx utmp_entry;
 173 #endif
 174
 175 /*
 176  * pty_argv is a grievous hack to allow a proper argv to be passed
 177  * through from the Unix command line. Again, it doesn't really
 178  * make sense outside a one-pty-per-process setup.
 179  */
 180 char **pty_argv;
 181
 182 static void pty_close(Pty pty);
 183 static void pty_try_write(Pty pty);
 184
 185 #ifndef OMIT_UTMP
 186 static void setup_utmp(char *ttyname, char *location)
 187 {
 188 #ifdef HAVE_LASTLOG
 189     struct lastlog lastlog_entry;
 190     FILE *lastlog;
 191 #endif
 192     struct passwd *pw;
 193     struct timeval tv;
 194
 195     pw = getpwuid(getuid());
 196     memset(&utmp_entry, 0, sizeof(utmp_entry));
 197     utmp_entry.ut_type = USER_PROCESS;
 198     utmp_entry.ut_pid = getpid();
 199     strncpy(utmp_entry.ut_line, ttyname+5, lenof(utmp_entry.ut_line));
 200     strncpy(utmp_entry.ut_id, ttyname+8, lenof(utmp_entry.ut_id));
 201     strncpy(utmp_entry.ut_user, pw->pw_name, lenof(utmp_entry.ut_user));
 202     strncpy(utmp_entry.ut_host, location, lenof(utmp_entry.ut_host));
 203     /*
 204      * Apparently there are some architectures where (struct
 205      * utmpx).ut_tv is not essentially struct timeval (e.g. Linux
 206      * amd64). Hence the temporary.
 207      */
 208     gettimeofday(&tv, NULL);
 209     utmp_entry.ut_tv.tv_sec = tv.tv_sec;
 210     utmp_entry.ut_tv.tv_usec = tv.tv_usec;
 211
 212     setutxent();
 213     pututxline(&utmp_entry);
 214     endutxent();
 215
 216     updwtmpx(WTMPX_FILE, &utmp_entry);
 217
 218 #ifdef HAVE_LASTLOG
 219     memset(&lastlog_entry, 0, sizeof(lastlog_entry));
 220     strncpy(lastlog_entry.ll_line, ttyname+5, lenof(lastlog_entry.ll_line));
 221     strncpy(lastlog_entry.ll_host, location, lenof(lastlog_entry.ll_host));
 222     time(&lastlog_entry.ll_time);
 223     if ((lastlog = fopen(LASTLOG_FILE, "r+")) != NULL) {
 224         fseek(lastlog, sizeof(lastlog_entry) * getuid(), SEEK_SET);
 225         fwrite(&lastlog_entry, 1, sizeof(lastlog_entry), lastlog);
 226         fclose(lastlog);
 227     }
 228 #endif
 229
 230     pty_stamped_utmp = 1;
 231
 232 }
 233
 234 static void cleanup_utmp(void)
 235 {
 236     struct timeval tv;
 237
 238     if (!pty_stamped_utmp)
 239         return;
 240
 241     utmp_entry.ut_type = DEAD_PROCESS;
 242     memset(utmp_entry.ut_user, 0, lenof(utmp_entry.ut_user));
 243     gettimeofday(&tv, NULL);
 244     utmp_entry.ut_tv.tv_sec = tv.tv_sec;
 245     utmp_entry.ut_tv.tv_usec = tv.tv_usec;
 246
 247     updwtmpx(WTMPX_FILE, &utmp_entry);
 248
 249     memset(utmp_entry.ut_line, 0, lenof(utmp_entry.ut_line));
 250     utmp_entry.ut_tv.tv_sec = 0;
 251     utmp_entry.ut_tv.tv_usec = 0;
 252
 253     setutxent();
 254     pututxline(&utmp_entry);
 255     endutxent();
 256
 257     pty_stamped_utmp = 0;              /* ensure we never double-cleanup */
 258 }
 259 #endif
 260
 261 static void sigchld_handler(int signum)
 262 {
 263     write(pty_signal_pipe[1], "x", 1);
 264 }
 265
 266 #ifndef OMIT_UTMP
 267 static void fatal_sig_handler(int signum)
 268 {
 269     putty_signal(signum, SIG_DFL);
 270     cleanup_utmp();
 271     setuid(getuid());
 272     raise(signum);
 273 }
 274 #endif
 275
 276 static int pty_open_slave(Pty pty)
 277 {
 278     if (pty->slave_fd < 0) {
 279         pty->slave_fd = open(pty->name, O_RDWR);
 280         cloexec(pty->slave_fd);
 281     }
 282
 283     return pty->slave_fd;
 284 }
 285
 286 static void pty_open_master(Pty pty)
 287 {
 288 #ifdef BSD_PTYS
 289     const char chars1[] = "pqrstuvwxyz";
 290     const char chars2[] = "0123456789abcdef";
 291     const char *p1, *p2;
 292     char master_name[20];
 293     struct group *gp;
 294
 295     for (p1 = chars1; *p1; p1++)
 296         for (p2 = chars2; *p2; p2++) {
 297             sprintf(master_name, "/dev/pty%c%c", *p1, *p2);
 298             pty->master_fd = open(master_name, O_RDWR);
 299             if (pty->master_fd >= 0) {
 300                 if (geteuid() == 0 ||
 301                     access(master_name, R_OK | W_OK) == 0) {
 302                     /*
 303                      * We must also check at this point that we are
 304                      * able to open the slave side of the pty. We
 305                      * wouldn't want to allocate the wrong master,
 306                      * get all the way down to forking, and _then_
 307                      * find we're unable to open the slave.
 308                      */
 309                     strcpy(pty->name, master_name);
 310                     pty->name[5] = 't'; /* /dev/ptyXX -> /dev/ttyXX */
 311
 312                     cloexec(pty->master_fd);
 313
 314                     if (pty_open_slave(pty) >= 0 &&
 315                         access(pty->name, R_OK | W_OK) == 0)
 316                         goto got_one;
 317                     if (pty->slave_fd > 0)
 318                         close(pty->slave_fd);
 319                     pty->slave_fd = -1;
 320                 }
 321                 close(pty->master_fd);
 322             }
 323         }
 324
 325     /* If we get here, we couldn't get a tty at all. */
 326     fprintf(stderr, "pterm: unable to open a pseudo-terminal device\n");
 327     exit(1);
 328
 329     got_one:
 330
 331     /* We need to chown/chmod the /dev/ttyXX device. */
 332     gp = getgrnam("tty");
 333     chown(pty->name, getuid(), gp ? gp->gr_gid : -1);
 334     chmod(pty->name, 0600);
 335 #else
 336     pty->master_fd = open("/dev/ptmx", O_RDWR);
 337
 338     if (pty->master_fd < 0) {
 339         perror("/dev/ptmx: open");
 340         exit(1);
 341     }
 342
 343     if (grantpt(pty->master_fd) < 0) {
 344         perror("grantpt");
 345         exit(1);
 346     }
 347
 348     if (unlockpt(pty->master_fd) < 0) {
 349         perror("unlockpt");
 350         exit(1);
 351     }
 352
 353     cloexec(pty->master_fd);
 354
 355     pty->name[FILENAME_MAX-1] = '\0';
 356     strncpy(pty->name, ptsname(pty->master_fd), FILENAME_MAX-1);
 357 #endif
 358
 359     {
 360         /*
 361          * Set the pty master into non-blocking mode.
 362          */
 363         int fl;
 364         fl = fcntl(pty->master_fd, F_GETFL);
 365         if (fl != -1 && !(fl & O_NONBLOCK))
 366             fcntl(pty->master_fd, F_SETFL, fl | O_NONBLOCK);
 367     }
 368
 369     if (!ptys_by_fd)
 370         ptys_by_fd = newtree234(pty_compare_by_fd);
 371     add234(ptys_by_fd, pty);
 372 }
 373
 374 /*
 375  * Pre-initialisation. This is here to get around the fact that GTK
 376  * doesn't like being run in setuid/setgid programs (probably
 377  * sensibly). So before we initialise GTK - and therefore before we
 378  * even process the command line - we check to see if we're running
 379  * set[ug]id. If so, we open our pty master _now_, chown it as
 380  * necessary, and drop privileges. We can always close it again
 381  * later. If we're potentially going to be doing utmp as well, we
 382  * also fork off a utmp helper process and communicate with it by
 383  * means of a pipe; the utmp helper will keep privileges in order
 384  * to clean up utmp when we exit (i.e. when its end of our pipe
 385  * closes).
 386  */
 387 void pty_pre_init(void)
 388 {
 389     Pty pty;
 390
 391 #ifndef OMIT_UTMP
 392     pid_t pid;
 393     int pipefd[2];
 394 #endif
 395
 396     pty = single_pty = snew(struct pty_tag);
 397     bufchain_init(&pty->output_data);
 398
 399     /* set the child signal handler straight away; it needs to be set
 400      * before we ever fork. */
 401     putty_signal(SIGCHLD, sigchld_handler);
 402     pty->master_fd = pty->slave_fd = -1;
 403 #ifndef OMIT_UTMP
 404     pty_stamped_utmp = FALSE;
 405 #endif
 406
 407     if (geteuid() != getuid() || getegid() != getgid()) {
 408         pty_open_master(pty);
 409     }
 410
 411 #ifndef OMIT_UTMP
 412     /*
 413      * Fork off the utmp helper.
 414      */
 415     if (pipe(pipefd) < 0) {
 416         perror("pterm: pipe");
 417         exit(1);
 418     }
 419     cloexec(pipefd[0]);
 420     cloexec(pipefd[1]);
 421     pid = fork();
 422     if (pid < 0) {
 423         perror("pterm: fork");
 424         exit(1);
 425     } else if (pid == 0) {
 426         char display[128], buffer[128];
 427         int dlen, ret;
 428
 429         close(pipefd[1]);
 430         /*
 431          * Now sit here until we receive a display name from the
 432          * other end of the pipe, and then stamp utmp. Unstamp utmp
 433          * again, and exit, when the pipe closes.
 434          */
 435
 436         dlen = 0;
 437         while (1) {
 438
 439             ret = read(pipefd[0], buffer, lenof(buffer));
 440             if (ret <= 0) {
 441                 cleanup_utmp();
 442                 _exit(0);
 443             } else if (!pty_stamped_utmp) {
 444                 if (dlen < lenof(display))
 445                     memcpy(display+dlen, buffer,
 446                            min(ret, lenof(display)-dlen));
 447                 if (buffer[ret-1] == '\0') {
 448                     /*
 449                      * Now we have a display name. NUL-terminate
 450                      * it, and stamp utmp.
 451                      */
 452                     display[lenof(display)-1] = '\0';
 453                     /*
 454                      * Trap as many fatal signals as we can in the
 455                      * hope of having the best possible chance to
 456                      * clean up utmp before termination. We are
 457                      * unfortunately unprotected against SIGKILL,
 458                      * but that's life.
 459                      */
 460                     putty_signal(SIGHUP, fatal_sig_handler);
 461                     putty_signal(SIGINT, fatal_sig_handler);
 462                     putty_signal(SIGQUIT, fatal_sig_handler);
 463                     putty_signal(SIGILL, fatal_sig_handler);
 464                     putty_signal(SIGABRT, fatal_sig_handler);
 465                     putty_signal(SIGFPE, fatal_sig_handler);
 466                     putty_signal(SIGPIPE, fatal_sig_handler);
 467                     putty_signal(SIGALRM, fatal_sig_handler);
 468                     putty_signal(SIGTERM, fatal_sig_handler);
 469                     putty_signal(SIGSEGV, fatal_sig_handler);
 470                     putty_signal(SIGUSR1, fatal_sig_handler);
 471                     putty_signal(SIGUSR2, fatal_sig_handler);
 472 #ifdef SIGBUS
 473                     putty_signal(SIGBUS, fatal_sig_handler);
 474 #endif
 475 #ifdef SIGPOLL
 476                     putty_signal(SIGPOLL, fatal_sig_handler);
 477 #endif
 478 #ifdef SIGPROF
 479                     putty_signal(SIGPROF, fatal_sig_handler);
 480 #endif
 481 #ifdef SIGSYS
 482                     putty_signal(SIGSYS, fatal_sig_handler);
 483 #endif
 484 #ifdef SIGTRAP
 485                     putty_signal(SIGTRAP, fatal_sig_handler);
 486 #endif
 487 #ifdef SIGVTALRM
 488                     putty_signal(SIGVTALRM, fatal_sig_handler);
 489 #endif
 490 #ifdef SIGXCPU
 491                     putty_signal(SIGXCPU, fatal_sig_handler);
 492 #endif
 493 #ifdef SIGXFSZ
 494                     putty_signal(SIGXFSZ, fatal_sig_handler);
 495 #endif
 496 #ifdef SIGIO
 497                     putty_signal(SIGIO, fatal_sig_handler);
 498 #endif
 499                     setup_utmp(pty->name, display);
 500                 }
 501             }
 502         }
 503     } else {
 504         close(pipefd[0]);
 505         pty_utmp_helper_pid = pid;
 506         pty_utmp_helper_pipe = pipefd[1];
 507     }
 508 #endif
 509
 510     /* Drop privs. */
 511     {
 512 #ifndef HAVE_NO_SETRESUID
 513         int gid = getgid(), uid = getuid();
 514         int setresgid(gid_t, gid_t, gid_t);
 515         int setresuid(uid_t, uid_t, uid_t);
 516         setresgid(gid, gid, gid);
 517         setresuid(uid, uid, uid);
 518 #else
 519         setgid(getgid());
 520         setuid(getuid());
 521 #endif
 522     }
 523 }
 524
 525 int pty_real_select_result(Pty pty, int event, int status)
 526 {
 527     char buf[4096];
 528     int ret;
 529     int finished = FALSE;
 530
 531     if (event < 0) {
 532         /*
 533          * We've been called because our child process did
 534          * something. `status' tells us what.
 535          */
 536         if ((WIFEXITED(status) || WIFSIGNALED(status))) {
 537             /*
 538              * The primary child process died. We could keep
 539              * the terminal open for remaining subprocesses to
 540              * output to, but conventional wisdom seems to feel
 541              * that that's the Wrong Thing for an xterm-alike,
 542              * so we bail out now (though we don't necessarily
 543              * _close_ the window, depending on the state of
 544              * Close On Exit). This would be easy enough to
 545              * change or make configurable if necessary.
 546              */
 547             pty->exit_code = status;
 548             pty->child_dead = TRUE;
 549             del234(ptys_by_pid, pty);
 550             finished = TRUE;
 551         }
 552     } else {
 553         if (event == 1) {
 554
 555             ret = read(pty->master_fd, buf, sizeof(buf));
 556
 557             /*
 558              * Clean termination condition is that either ret == 0, or ret
 559              * < 0 and errno == EIO. Not sure why the latter, but it seems
 560              * to happen. Boo.
 561              */
 562             if (ret == 0 || (ret < 0 && errno == EIO)) {
 563                 /*
 564                  * We assume a clean exit if the pty has closed but the
 565                  * actual child process hasn't. The only way I can
 566                  * imagine this happening is if it detaches itself from
 567                  * the pty and goes daemonic - in which case the
 568                  * expected usage model would precisely _not_ be for
 569                  * the pterm window to hang around!
 570                  */
 571                 finished = TRUE;
 572                 if (!pty->child_dead)
 573                     pty->exit_code = 0;
 574             } else if (ret < 0) {
 575                 perror("read pty master");
 576                 exit(1);
 577             } else if (ret > 0) {
 578                 from_backend(pty->frontend, 0, buf, ret);
 579             }
 580         } else if (event == 2) {
 581             /*
 582              * Attempt to send data down the pty.
 583              */
 584             pty_try_write(pty);
 585         }
 586     }
 587
 588     if (finished && !pty->finished) {
 589         uxsel_del(pty->master_fd);
 590         pty_close(pty);
 591         pty->master_fd = -1;
 592
 593         pty->finished = TRUE;
 594
 595         /*
 596          * This is a slight layering-violation sort of hack: only
 597          * if we're not closing on exit (COE is set to Never, or to
 598          * Only On Clean and it wasn't a clean exit) do we output a
 599          * `terminated' message.
 600          */
 601         if (pty->cfg.close_on_exit == FORCE_OFF ||
 602             (pty->cfg.close_on_exit == AUTO && pty->exit_code != 0)) {
 603             char message[512];
 604             if (WIFEXITED(pty->exit_code))
 605                 sprintf(message, "\r\n[pterm: process terminated with exit"
 606                         " code %d]\r\n", WEXITSTATUS(pty->exit_code));
 607             else if (WIFSIGNALED(pty->exit_code))
 608 #ifdef HAVE_NO_STRSIGNAL
 609                 sprintf(message, "\r\n[pterm: process terminated on signal"
 610                         " %d]\r\n", WTERMSIG(pty->exit_code));
 611 #else
 612                 sprintf(message, "\r\n[pterm: process terminated on signal"
 613                         " %d (%.400s)]\r\n", WTERMSIG(pty->exit_code),
 614                         strsignal(WTERMSIG(pty->exit_code)));
 615 #endif
 616             from_backend(pty->frontend, 0, message, strlen(message));
 617         }
 618
 619         notify_remote_exit(pty->frontend);
 620     }
 621
 622     return !finished;
 623 }
 624
 625 int pty_select_result(int fd, int event)
 626 {
 627     int ret = TRUE;
 628     Pty pty;
 629
 630     if (fd == pty_signal_pipe[0]) {
 631         pid_t pid;
 632         int ipid;
 633         int status;
 634         char c[1];
 635
 636         read(pty_signal_pipe[0], c, 1); /* ignore its value; it'll be `x' */
 637
 638         do {
 639             pid = waitpid(-1, &status, WNOHANG);
 640
 641             ipid = pid;
 642             pty = find234(ptys_by_pid, &pid, pty_find_by_pid);
 643
 644             if (pty)
 645                 ret = ret && pty_real_select_result(pty, -1, status);
 646         } while (pid > 0);
 647     } else {
 648         pty = find234(ptys_by_fd, &fd, pty_find_by_fd);
 649
 650         if (pty)
 651             ret = ret && pty_real_select_result(pty, event, 0);
 652     }
 653
 654     return ret;
 655 }
 656
 657 static void pty_uxsel_setup(Pty pty)
 658 {
 659     int rwx;
 660
 661     rwx = 1;                           /* always want to read from pty */
 662     if (bufchain_size(&pty->output_data))
 663         rwx |= 2;                      /* might also want to write to it */
 664     uxsel_set(pty->master_fd, rwx, pty_select_result);
 665
 666     /*
 667      * In principle this only needs calling once for all pty
 668      * backend instances, but it's simplest just to call it every
 669      * time; uxsel won't mind.
 670      */
 671     uxsel_set(pty_signal_pipe[0], 1, pty_select_result);
 672 }
 673
 674 /*
 675  * Called to set up the pty.
 676  *
 677  * Returns an error message, or NULL on success.
 678  *
 679  * Also places the canonical host name into `realhost'. It must be
 680  * freed by the caller.
 681  */
 682 static const char *pty_init(void *frontend, void **backend_handle, Config *cfg,
 683                             char *host, int port, char **realhost, int nodelay,
 684                             int keepalive)
 685 {
 686     int slavefd;
 687     pid_t pid, pgrp;
 688 #ifndef NOT_X_WINDOWS                  /* for Mac OS X native compilation */
 689     long windowid;
 690 #endif
 691     Pty pty;
 692
 693     if (single_pty) {
 694         pty = single_pty;
 695     } else {
 696         pty = snew(struct pty_tag);
 697         pty->master_fd = pty->slave_fd = -1;
 698 #ifndef OMIT_UTMP
 699         pty_stamped_utmp = FALSE;
 700 #endif
 701     }
 702
 703     pty->frontend = frontend;
 704     *backend_handle = NULL;            /* we can't sensibly use this, sadly */
 705
 706     pty->cfg = *cfg;                   /* structure copy */
 707     pty->term_width = cfg->width;
 708     pty->term_height = cfg->height;
 709
 710     if (pty->master_fd < 0)
 711         pty_open_master(pty);
 712
 713     /*
 714      * Set the backspace character to be whichever of ^H and ^? is
 715      * specified by bksp_is_delete.
 716      */
 717     {
 718         struct termios attrs;
 719         tcgetattr(pty->master_fd, &attrs);
 720         attrs.c_cc[VERASE] = cfg->bksp_is_delete ? '\177' : '\010';
 721         tcsetattr(pty->master_fd, TCSANOW, &attrs);
 722     }
 723
 724 #ifndef OMIT_UTMP
 725     /*
 726      * Stamp utmp (that is, tell the utmp helper process to do so),
 727      * or not.
 728      */
 729     if (!cfg->stamp_utmp) {
 730         close(pty_utmp_helper_pipe);   /* just let the child process die */
 731         pty_utmp_helper_pipe = -1;
 732     } else {
 733         char *location = get_x_display(pty->frontend);
 734         int len = strlen(location)+1, pos = 0;   /* +1 to include NUL */
 735         while (pos < len) {
 736             int ret = write(pty_utmp_helper_pipe, location+pos, len - pos);
 737             if (ret < 0) {
 738                 perror("pterm: writing to utmp helper process");
 739                 close(pty_utmp_helper_pipe);   /* arrgh, just give up */
 740                 pty_utmp_helper_pipe = -1;
 741                 break;
 742             }
 743             pos += ret;
 744         }
 745     }
 746 #endif
 747
 748 #ifndef NOT_X_WINDOWS                  /* for Mac OS X native compilation */
 749     windowid = get_windowid(pty->frontend);
 750 #endif
 751
 752     /*
 753      * Fork and execute the command.
 754      */
 755     pid = fork();
 756     if (pid < 0) {
 757         perror("fork");
 758         exit(1);
 759     }
 760
 761     if (pid == 0) {
 762         /*
 763          * We are the child.
 764          */
 765
 766         slavefd = pty_open_slave(pty);
 767         if (slavefd < 0) {
 768             perror("slave pty: open");
 769             _exit(1);
 770         }
 771
 772         close(pty->master_fd);
 773         fcntl(slavefd, F_SETFD, 0);    /* don't close on exec */
 774         dup2(slavefd, 0);
 775         dup2(slavefd, 1);
 776         dup2(slavefd, 2);
 777         close(slavefd);
 778         setsid();
 779 #ifdef TIOCSCTTY
 780         ioctl(0, TIOCSCTTY, 1);
 781 #endif
 782         pgrp = getpid();
 783         tcsetpgrp(0, pgrp);
 784         setpgid(pgrp, pgrp);
 785         close(open(pty->name, O_WRONLY, 0));
 786         setpgid(pgrp, pgrp);
 787         {
 788             char *term_env_var = dupprintf("TERM=%s", cfg->termtype);
 789             putenv(term_env_var);
 790             /* We mustn't free term_env_var, as putenv links it into the
 791              * environment in place.
 792              */
 793         }
 794 #ifndef NOT_X_WINDOWS                  /* for Mac OS X native compilation */
 795         {
 796             char *windowid_env_var = dupprintf("WINDOWID=%ld", windowid);
 797             putenv(windowid_env_var);
 798             /* We mustn't free windowid_env_var, as putenv links it into the
 799              * environment in place.
 800              */
 801         }
 802 #endif
 803         {
 804             char *e = cfg->environmt;
 805             char *var, *varend, *val, *varval;
 806             while (*e) {
 807                 var = e;
 808                 while (*e && *e != '\t') e++;
 809                 varend = e;
 810                 if (*e == '\t') e++;
 811                 val = e;
 812                 while (*e) e++;
 813                 e++;
 814
 815                 varval = dupprintf("%.*s=%s", varend-var, var, val);
 816                 putenv(varval);
 817                 /*
 818                  * We must not free varval, since putenv links it
 819                  * into the environment _in place_. Weird, but
 820                  * there we go. Memory usage will be rationalised
 821                  * as soon as we exec anyway.
 822                  */
 823             }
 824         }
 825
 826         /*
 827          * SIGINT and SIGQUIT may have been set to ignored by our
 828          * parent, particularly by things like sh -c 'pterm &' and
 829          * some window managers. SIGCHLD, meanwhile, was blocked
 830          * during pt_main() startup. Reverse all this for our child
 831          * process.
 832          */
 833         putty_signal(SIGINT, SIG_DFL);
 834         putty_signal(SIGQUIT, SIG_DFL);
 835         block_signal(SIGCHLD, 0);
 836         if (pty_argv)
 837             execvp(pty_argv[0], pty_argv);
 838         else {
 839             char *shell = getenv("SHELL");
 840             char *shellname;
 841             if (cfg->login_shell) {
 842                 char *p = strrchr(shell, '/');
 843                 shellname = snewn(2+strlen(shell), char);
 844                 p = p ? p+1 : shell;
 845                 sprintf(shellname, "-%s", p);
 846             } else
 847                 shellname = shell;
 848             execl(getenv("SHELL"), shellname, (void *)NULL);
 849         }
 850
 851         /*
 852          * If we're here, exec has gone badly foom.
 853          */
 854         perror("exec");
 855         _exit(127);
 856     } else {
 857         pty->child_pid = pid;
 858         pty->child_dead = FALSE;
 859         pty->finished = FALSE;
 860         if (pty->slave_fd > 0)
 861             close(pty->slave_fd);
 862         if (!ptys_by_pid)
 863             ptys_by_pid = newtree234(pty_compare_by_pid);
 864         add234(ptys_by_pid, pty);
 865     }
 866
 867     if (pty_signal_pipe[0] < 0) {
 868         if (pipe(pty_signal_pipe) < 0) {
 869             perror("pipe");
 870             exit(1);
 871         }
 872         cloexec(pty_signal_pipe[0]);
 873         cloexec(pty_signal_pipe[1]);
 874     }
 875     pty_uxsel_setup(pty);
 876
 877     *backend_handle = pty;
 878
 879     *realhost = dupprintf("\0");
 880
 881     return NULL;
 882 }
 883
 884 static void pty_reconfig(void *handle, Config *cfg)
 885 {
 886     Pty pty = (Pty)handle;
 887     /*
 888      * We don't have much need to reconfigure this backend, but
 889      * unfortunately we do need to pick up the setting of Close On
 890      * Exit so we know whether to give a `terminated' message.
 891      */
 892     pty->cfg = *cfg;                   /* structure copy */
 893 }
 894
 895 /*
 896  * Stub routine (never called in pterm).
 897  */
 898 static void pty_free(void *handle)
 899 {
 900     Pty pty = (Pty)handle;
 901
 902     /* Either of these may fail `not found'. That's fine with us. */
 903     del234(ptys_by_pid, pty);
 904     del234(ptys_by_fd, pty);
 905
 906     sfree(pty);
 907 }
 908
 909 static void pty_try_write(Pty pty)
 910 {
 911     void *data;
 912     int len, ret;
 913
 914     assert(pty->master_fd >= 0);
 915
 916     while (bufchain_size(&pty->output_data) > 0) {
 917         bufchain_prefix(&pty->output_data, &data, &len);
 918         ret = write(pty->master_fd, data, len);
 919
 920         if (ret < 0 && (errno == EWOULDBLOCK)) {
 921             /*
 922              * We've sent all we can for the moment.
 923              */
 924             break;
 925         }
 926         if (ret < 0) {
 927             perror("write pty master");
 928             exit(1);
 929         }
 930         bufchain_consume(&pty->output_data, ret);
 931     }
 932
 933     pty_uxsel_setup(pty);
 934 }
 935
 936 /*
 937  * Called to send data down the pty.
 938  */
 939 static int pty_send(void *handle, char *buf, int len)
 940 {
 941     Pty pty = (Pty)handle;
 942
 943     if (pty->master_fd < 0)
 944         return 0;                      /* ignore all writes if fd closed */
 945
 946     bufchain_add(&pty->output_data, buf, len);
 947     pty_try_write(pty);
 948
 949     return bufchain_size(&pty->output_data);
 950 }
 951
 952 static void pty_close(Pty pty)
 953 {
 954     if (pty->master_fd >= 0) {
 955         close(pty->master_fd);
 956         pty->master_fd = -1;
 957     }
 958 #ifndef OMIT_UTMP
 959     if (pty_utmp_helper_pipe >= 0) {
 960         close(pty_utmp_helper_pipe);   /* this causes utmp to be cleaned up */
 961         pty_utmp_helper_pipe = -1;
 962     }
 963 #endif
 964 }
 965
 966 /*
 967  * Called to query the current socket sendability status.
 968  */
 969 static int pty_sendbuffer(void *handle)
 970 {
 971     /* Pty pty = (Pty)handle; */
 972     return 0;
 973 }
 974
 975 /*
 976  * Called to set the size of the window
 977  */
 978 static void pty_size(void *handle, int width, int height)
 979 {
 980     Pty pty = (Pty)handle;
 981     struct winsize size;
 982
 983     pty->term_width = width;
 984     pty->term_height = height;
 985
 986     size.ws_row = (unsigned short)pty->term_height;
 987     size.ws_col = (unsigned short)pty->term_width;
 988     size.ws_xpixel = (unsigned short) pty->term_width *
 989         font_dimension(pty->frontend, 0);
 990     size.ws_ypixel = (unsigned short) pty->term_height *
 991         font_dimension(pty->frontend, 1);
 992     ioctl(pty->master_fd, TIOCSWINSZ, (void *)&size);
 993     return;
 994 }
 995
 996 /*
 997  * Send special codes.
 998  */
 999 static void pty_special(void *handle, Telnet_Special code)
1000 {
1001     /* Pty pty = (Pty)handle; */
1002     /* Do nothing! */
1003     return;
1004 }
1005
1006 /*
1007  * Return a list of the special codes that make sense in this
1008  * protocol.
1009  */
1010 static const struct telnet_special *pty_get_specials(void *handle)
1011 {
1012     /* Pty pty = (Pty)handle; */
1013     /*
1014      * Hmm. When I get round to having this actually usable, it
1015      * might be quite nice to have the ability to deliver a few
1016      * well chosen signals to the child process - SIGINT, SIGTERM,
1017      * SIGKILL at least.
1018      */
1019     return NULL;
1020 }
1021
1022 static int pty_connected(void *handle)
1023 {
1024     /* Pty pty = (Pty)handle; */
1025     return TRUE;
1026 }
1027
1028 static int pty_sendok(void *handle)
1029 {
1030     /* Pty pty = (Pty)handle; */
1031     return 1;
1032 }
1033
1034 static void pty_unthrottle(void *handle, int backlog)
1035 {
1036     /* Pty pty = (Pty)handle; */
1037     /* do nothing */
1038 }
1039
1040 static int pty_ldisc(void *handle, int option)
1041 {
1042     /* Pty pty = (Pty)handle; */
1043     return 0;                          /* neither editing nor echoing */
1044 }
1045
1046 static void pty_provide_ldisc(void *handle, void *ldisc)
1047 {
1048     /* Pty pty = (Pty)handle; */
1049     /* This is a stub. */
1050 }
1051
1052 static void pty_provide_logctx(void *handle, void *logctx)
1053 {
1054     /* Pty pty = (Pty)handle; */
1055     /* This is a stub. */
1056 }
1057
1058 static int pty_exitcode(void *handle)
1059 {
1060     Pty pty = (Pty)handle;
1061     if (!pty->finished)
1062         return -1;                     /* not dead yet */
1063     else
1064         return pty->exit_code;
1065 }
1066
1067 static int pty_cfg_info(void *handle)
1068 {
1069     /* Pty pty = (Pty)handle; */
1070     return 0;
1071 }
1072
1073 Backend pty_backend = {
1074     pty_init,
1075     pty_free,
1076     pty_reconfig,
1077     pty_send,
1078     pty_sendbuffer,
1079     pty_size,
1080     pty_special,
1081     pty_get_specials,
1082     pty_connected,
1083     pty_exitcode,
1084     pty_sendok,
1085     pty_ldisc,
1086     pty_provide_ldisc,
1087     pty_provide_logctx,
1088     pty_unthrottle,
1089     pty_cfg_info,
1090     "pty",
1091     -1,
1092     0
1093 };