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     Conf *conf;
  80     int master_fd, slave_fd;
  81     void *frontend;
  82     char name[FILENAME_MAX];
  83     pid_t 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     pid_t a = *(pid_t *)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 pid_t pty_utmp_helper_pid = -1;
 171 static int pty_utmp_helper_pipe = -1;
 172 static int pty_stamped_utmp;
 173 static struct utmpx utmp_entry;
 174 #endif
 175
 176 /*
 177  * pty_argv is a grievous hack to allow a proper argv to be passed
 178  * through from the Unix command line. Again, it doesn't really
 179  * make sense outside a one-pty-per-process setup.
 180  */
 181 char **pty_argv;
 182
 183 static void pty_close(Pty pty);
 184 static void pty_try_write(Pty pty);
 185
 186 #ifndef OMIT_UTMP
 187 static void setup_utmp(char *ttyname, char *location)
 188 {
 189 #ifdef HAVE_LASTLOG
 190     struct lastlog lastlog_entry;
 191     FILE *lastlog;
 192 #endif
 193     struct passwd *pw;
 194     struct timeval tv;
 195
 196     pw = getpwuid(getuid());
 197     memset(&utmp_entry, 0, sizeof(utmp_entry));
 198     utmp_entry.ut_type = USER_PROCESS;
 199     utmp_entry.ut_pid = getpid();
 200     strncpy(utmp_entry.ut_line, ttyname+5, lenof(utmp_entry.ut_line));
 201     strncpy(utmp_entry.ut_id, ttyname+8, lenof(utmp_entry.ut_id));
 202     strncpy(utmp_entry.ut_user, pw->pw_name, lenof(utmp_entry.ut_user));
 203     strncpy(utmp_entry.ut_host, location, lenof(utmp_entry.ut_host));
 204     /*
 205      * Apparently there are some architectures where (struct
 206      * utmpx).ut_tv is not essentially struct timeval (e.g. Linux
 207      * amd64). Hence the temporary.
 208      */
 209     gettimeofday(&tv, NULL);
 210     utmp_entry.ut_tv.tv_sec = tv.tv_sec;
 211     utmp_entry.ut_tv.tv_usec = tv.tv_usec;
 212
 213     setutxent();
 214     pututxline(&utmp_entry);
 215     endutxent();
 216
 217     updwtmpx(WTMPX_FILE, &utmp_entry);
 218
 219 #ifdef HAVE_LASTLOG
 220     memset(&lastlog_entry, 0, sizeof(lastlog_entry));
 221     strncpy(lastlog_entry.ll_line, ttyname+5, lenof(lastlog_entry.ll_line));
 222     strncpy(lastlog_entry.ll_host, location, lenof(lastlog_entry.ll_host));
 223     time(&lastlog_entry.ll_time);
 224     if ((lastlog = fopen(LASTLOG_FILE, "r+")) != NULL) {
 225         fseek(lastlog, sizeof(lastlog_entry) * getuid(), SEEK_SET);
 226         fwrite(&lastlog_entry, 1, sizeof(lastlog_entry), lastlog);
 227         fclose(lastlog);
 228     }
 229 #endif
 230
 231     pty_stamped_utmp = 1;
 232
 233 }
 234
 235 static void cleanup_utmp(void)
 236 {
 237     struct timeval tv;
 238
 239     if (!pty_stamped_utmp)
 240         return;
 241
 242     utmp_entry.ut_type = DEAD_PROCESS;
 243     memset(utmp_entry.ut_user, 0, lenof(utmp_entry.ut_user));
 244     gettimeofday(&tv, NULL);
 245     utmp_entry.ut_tv.tv_sec = tv.tv_sec;
 246     utmp_entry.ut_tv.tv_usec = tv.tv_usec;
 247
 248     updwtmpx(WTMPX_FILE, &utmp_entry);
 249
 250     memset(utmp_entry.ut_line, 0, lenof(utmp_entry.ut_line));
 251     utmp_entry.ut_tv.tv_sec = 0;
 252     utmp_entry.ut_tv.tv_usec = 0;
 253
 254     setutxent();
 255     pututxline(&utmp_entry);
 256     endutxent();
 257
 258     pty_stamped_utmp = 0;              /* ensure we never double-cleanup */
 259 }
 260 #endif
 261
 262 #ifndef NO_PTY_PRE_INIT
 263 static void sigchld_handler(int signum)
 264 {
 265     if (write(pty_signal_pipe[1], "x", 1) <= 0)
 266         /* not much we can do about it */;
 267 }
 268 #endif
 269
 270 #ifndef OMIT_UTMP
 271 static void fatal_sig_handler(int signum)
 272 {
 273     putty_signal(signum, SIG_DFL);
 274     cleanup_utmp();
 275     raise(signum);
 276 }
 277 #endif
 278
 279 static int pty_open_slave(Pty pty)
 280 {
 281     if (pty->slave_fd < 0) {
 282         pty->slave_fd = open(pty->name, O_RDWR);
 283         cloexec(pty->slave_fd);
 284     }
 285
 286     return pty->slave_fd;
 287 }
 288
 289 static void pty_open_master(Pty pty)
 290 {
 291 #ifdef BSD_PTYS
 292     const char chars1[] = "pqrstuvwxyz";
 293     const char chars2[] = "0123456789abcdef";
 294     const char *p1, *p2;
 295     char master_name[20];
 296     struct group *gp;
 297
 298     for (p1 = chars1; *p1; p1++)
 299         for (p2 = chars2; *p2; p2++) {
 300             sprintf(master_name, "/dev/pty%c%c", *p1, *p2);
 301             pty->master_fd = open(master_name, O_RDWR);
 302             if (pty->master_fd >= 0) {
 303                 if (geteuid() == 0 ||
 304                     access(master_name, R_OK | W_OK) == 0) {
 305                     /*
 306                      * We must also check at this point that we are
 307                      * able to open the slave side of the pty. We
 308                      * wouldn't want to allocate the wrong master,
 309                      * get all the way down to forking, and _then_
 310                      * find we're unable to open the slave.
 311                      */
 312                     strcpy(pty->name, master_name);
 313                     pty->name[5] = 't'; /* /dev/ptyXX -> /dev/ttyXX */
 314
 315                     cloexec(pty->master_fd);
 316
 317                     if (pty_open_slave(pty) >= 0 &&
 318                         access(pty->name, R_OK | W_OK) == 0)
 319                         goto got_one;
 320                     if (pty->slave_fd > 0)
 321                         close(pty->slave_fd);
 322                     pty->slave_fd = -1;
 323                 }
 324                 close(pty->master_fd);
 325             }
 326         }
 327
 328     /* If we get here, we couldn't get a tty at all. */
 329     fprintf(stderr, "pterm: unable to open a pseudo-terminal device\n");
 330     exit(1);
 331
 332     got_one:
 333
 334     /* We need to chown/chmod the /dev/ttyXX device. */
 335     gp = getgrnam("tty");
 336     chown(pty->name, getuid(), gp ? gp->gr_gid : -1);
 337     chmod(pty->name, 0600);
 338 #else
 339
 340     const int flags = O_RDWR
 341 #ifdef O_NOCTTY
 342         | O_NOCTTY
 343 #endif
 344         ;
 345
 346 #ifdef HAVE_POSIX_OPENPT
 347 #ifdef SET_NONBLOCK_VIA_OPENPT
 348     /*
 349      * OS X, as of 10.10 at least, doesn't permit me to set O_NONBLOCK
 350      * on pty master fds via the usual fcntl mechanism. Fortunately,
 351      * it does let me work around this by adding O_NONBLOCK to the
 352      * posix_openpt flags parameter, which isn't a documented use of
 353      * the API but seems to work. So we'll do that for now.
 354      */
 355     pty->master_fd = posix_openpt(flags | O_NONBLOCK);
 356 #else
 357     pty->master_fd = posix_openpt(flags);
 358 #endif
 359
 360     if (pty->master_fd < 0) {
 361         perror("posix_openpt");
 362         exit(1);
 363     }
 364 #else
 365     pty->master_fd = open("/dev/ptmx", flags);
 366
 367     if (pty->master_fd < 0) {
 368         perror("/dev/ptmx: open");
 369         exit(1);
 370     }
 371 #endif
 372
 373     if (grantpt(pty->master_fd) < 0) {
 374         perror("grantpt");
 375         exit(1);
 376     }
 377
 378     if (unlockpt(pty->master_fd) < 0) {
 379         perror("unlockpt");
 380         exit(1);
 381     }
 382
 383     cloexec(pty->master_fd);
 384
 385     pty->name[FILENAME_MAX-1] = '\0';
 386     strncpy(pty->name, ptsname(pty->master_fd), FILENAME_MAX-1);
 387 #endif
 388
 389 #ifndef SET_NONBLOCK_VIA_OPENPT
 390     nonblock(pty->master_fd);
 391 #endif
 392
 393     if (!ptys_by_fd)
 394         ptys_by_fd = newtree234(pty_compare_by_fd);
 395     add234(ptys_by_fd, pty);
 396 }
 397
 398 static Pty new_pty_struct(void)
 399 {
 400     Pty pty = snew(struct pty_tag);
 401     pty->conf = NULL;
 402     bufchain_init(&pty->output_data);
 403     return pty;
 404 }
 405
 406 /*
 407  * Pre-initialisation. This is here to get around the fact that GTK
 408  * doesn't like being run in setuid/setgid programs (probably
 409  * sensibly). So before we initialise GTK - and therefore before we
 410  * even process the command line - we check to see if we're running
 411  * set[ug]id. If so, we open our pty master _now_, chown it as
 412  * necessary, and drop privileges. We can always close it again
 413  * later. If we're potentially going to be doing utmp as well, we
 414  * also fork off a utmp helper process and communicate with it by
 415  * means of a pipe; the utmp helper will keep privileges in order
 416  * to clean up utmp when we exit (i.e. when its end of our pipe
 417  * closes).
 418  */
 419 void pty_pre_init(void)
 420 {
 421 #ifndef NO_PTY_PRE_INIT
 422
 423     Pty pty;
 424
 425 #ifndef OMIT_UTMP
 426     pid_t pid;
 427     int pipefd[2];
 428 #endif
 429
 430     pty = single_pty = new_pty_struct();
 431
 432     /* set the child signal handler straight away; it needs to be set
 433      * before we ever fork. */
 434     putty_signal(SIGCHLD, sigchld_handler);
 435     pty->master_fd = pty->slave_fd = -1;
 436 #ifndef OMIT_UTMP
 437     pty_stamped_utmp = FALSE;
 438 #endif
 439
 440     if (geteuid() != getuid() || getegid() != getgid()) {
 441         pty_open_master(pty);
 442
 443 #ifndef OMIT_UTMP
 444         /*
 445          * Fork off the utmp helper.
 446          */
 447         if (pipe(pipefd) < 0) {
 448             perror("pterm: pipe");
 449             exit(1);
 450         }
 451         cloexec(pipefd[0]);
 452         cloexec(pipefd[1]);
 453         pid = fork();
 454         if (pid < 0) {
 455             perror("pterm: fork");
 456             exit(1);
 457         } else if (pid == 0) {
 458             char display[128], buffer[128];
 459             int dlen, ret;
 460
 461             close(pipefd[1]);
 462             /*
 463              * Now sit here until we receive a display name from the
 464              * other end of the pipe, and then stamp utmp. Unstamp utmp
 465              * again, and exit, when the pipe closes.
 466              */
 467
 468             dlen = 0;
 469             while (1) {
 470
 471                 ret = read(pipefd[0], buffer, lenof(buffer));
 472                 if (ret <= 0) {
 473                     cleanup_utmp();
 474                     _exit(0);
 475                 } else if (!pty_stamped_utmp) {
 476                     if (dlen < lenof(display))
 477                         memcpy(display+dlen, buffer,
 478                                min(ret, lenof(display)-dlen));
 479                     if (buffer[ret-1] == '\0') {
 480                         /*
 481                          * Now we have a display name. NUL-terminate
 482                          * it, and stamp utmp.
 483                          */
 484                         display[lenof(display)-1] = '\0';
 485                         /*
 486                          * Trap as many fatal signals as we can in the
 487                          * hope of having the best possible chance to
 488                          * clean up utmp before termination. We are
 489                          * unfortunately unprotected against SIGKILL,
 490                          * but that's life.
 491                          */
 492                         putty_signal(SIGHUP, fatal_sig_handler);
 493                         putty_signal(SIGINT, fatal_sig_handler);
 494                         putty_signal(SIGQUIT, fatal_sig_handler);
 495                         putty_signal(SIGILL, fatal_sig_handler);
 496                         putty_signal(SIGABRT, fatal_sig_handler);
 497                         putty_signal(SIGFPE, fatal_sig_handler);
 498                         putty_signal(SIGPIPE, fatal_sig_handler);
 499                         putty_signal(SIGALRM, fatal_sig_handler);
 500                         putty_signal(SIGTERM, fatal_sig_handler);
 501                         putty_signal(SIGSEGV, fatal_sig_handler);
 502                         putty_signal(SIGUSR1, fatal_sig_handler);
 503                         putty_signal(SIGUSR2, fatal_sig_handler);
 504 #ifdef SIGBUS
 505                         putty_signal(SIGBUS, fatal_sig_handler);
 506 #endif
 507 #ifdef SIGPOLL
 508                         putty_signal(SIGPOLL, fatal_sig_handler);
 509 #endif
 510 #ifdef SIGPROF
 511                         putty_signal(SIGPROF, fatal_sig_handler);
 512 #endif
 513 #ifdef SIGSYS
 514                         putty_signal(SIGSYS, fatal_sig_handler);
 515 #endif
 516 #ifdef SIGTRAP
 517                         putty_signal(SIGTRAP, fatal_sig_handler);
 518 #endif
 519 #ifdef SIGVTALRM
 520                         putty_signal(SIGVTALRM, fatal_sig_handler);
 521 #endif
 522 #ifdef SIGXCPU
 523                         putty_signal(SIGXCPU, fatal_sig_handler);
 524 #endif
 525 #ifdef SIGXFSZ
 526                         putty_signal(SIGXFSZ, fatal_sig_handler);
 527 #endif
 528 #ifdef SIGIO
 529                         putty_signal(SIGIO, fatal_sig_handler);
 530 #endif
 531                         setup_utmp(pty->name, display);
 532                     }
 533                 }
 534             }
 535         } else {
 536             close(pipefd[0]);
 537             pty_utmp_helper_pid = pid;
 538             pty_utmp_helper_pipe = pipefd[1];
 539         }
 540 #endif
 541     }
 542
 543     /* Drop privs. */
 544     {
 545 #ifndef HAVE_NO_SETRESUID
 546         int gid = getgid(), uid = getuid();
 547         int setresgid(gid_t, gid_t, gid_t);
 548         int setresuid(uid_t, uid_t, uid_t);
 549         if (setresgid(gid, gid, gid) < 0) {
 550             perror("setresgid");
 551             exit(1);
 552         }
 553         if (setresuid(uid, uid, uid) < 0) {
 554             perror("setresuid");
 555             exit(1);
 556         }
 557 #else
 558         if (setgid(getgid()) < 0) {
 559             perror("setgid");
 560             exit(1);
 561         }
 562         if (setuid(getuid()) < 0) {
 563             perror("setuid");
 564             exit(1);
 565         }
 566 #endif
 567     }
 568
 569 #endif /* NO_PTY_PRE_INIT */
 570
 571 }
 572
 573 int pty_real_select_result(Pty pty, int event, int status)
 574 {
 575     char buf[4096];
 576     int ret;
 577     int finished = FALSE;
 578
 579     if (event < 0) {
 580         /*
 581          * We've been called because our child process did
 582          * something. `status' tells us what.
 583          */
 584         if ((WIFEXITED(status) || WIFSIGNALED(status))) {
 585             /*
 586              * The primary child process died. We could keep
 587              * the terminal open for remaining subprocesses to
 588              * output to, but conventional wisdom seems to feel
 589              * that that's the Wrong Thing for an xterm-alike,
 590              * so we bail out now (though we don't necessarily
 591              * _close_ the window, depending on the state of
 592              * Close On Exit). This would be easy enough to
 593              * change or make configurable if necessary.
 594              */
 595             pty->exit_code = status;
 596             pty->child_dead = TRUE;
 597             del234(ptys_by_pid, pty);
 598             finished = TRUE;
 599         }
 600     } else {
 601         if (event == 1) {
 602
 603             ret = read(pty->master_fd, buf, sizeof(buf));
 604
 605             /*
 606              * Clean termination condition is that either ret == 0, or ret
 607              * < 0 and errno == EIO. Not sure why the latter, but it seems
 608              * to happen. Boo.
 609              */
 610             if (ret == 0 || (ret < 0 && errno == EIO)) {
 611                 /*
 612                  * We assume a clean exit if the pty has closed but the
 613                  * actual child process hasn't. The only way I can
 614                  * imagine this happening is if it detaches itself from
 615                  * the pty and goes daemonic - in which case the
 616                  * expected usage model would precisely _not_ be for
 617                  * the pterm window to hang around!
 618                  */
 619                 finished = TRUE;
 620                 if (!pty->child_dead)
 621                     pty->exit_code = 0;
 622             } else if (ret < 0) {
 623                 perror("read pty master");
 624                 exit(1);
 625             } else if (ret > 0) {
 626                 from_backend(pty->frontend, 0, buf, ret);
 627             }
 628         } else if (event == 2) {
 629             /*
 630              * Attempt to send data down the pty.
 631              */
 632             pty_try_write(pty);
 633         }
 634     }
 635
 636     if (finished && !pty->finished) {
 637         int close_on_exit;
 638
 639         uxsel_del(pty->master_fd);
 640         pty_close(pty);
 641         pty->master_fd = -1;
 642
 643         pty->finished = TRUE;
 644
 645         /*
 646          * This is a slight layering-violation sort of hack: only
 647          * if we're not closing on exit (COE is set to Never, or to
 648          * Only On Clean and it wasn't a clean exit) do we output a
 649          * `terminated' message.
 650          */
 651         close_on_exit = conf_get_int(pty->conf, CONF_close_on_exit);
 652         if (close_on_exit == FORCE_OFF ||
 653             (close_on_exit == AUTO && pty->exit_code != 0)) {
 654             char message[512];
 655             message[0] = '\0';
 656             if (WIFEXITED(pty->exit_code))
 657                 sprintf(message, "\r\n[pterm: process terminated with exit"
 658                         " code %d]\r\n", WEXITSTATUS(pty->exit_code));
 659             else if (WIFSIGNALED(pty->exit_code))
 660 #ifdef HAVE_NO_STRSIGNAL
 661                 sprintf(message, "\r\n[pterm: process terminated on signal"
 662                         " %d]\r\n", WTERMSIG(pty->exit_code));
 663 #else
 664                 sprintf(message, "\r\n[pterm: process terminated on signal"
 665                         " %d (%.400s)]\r\n", WTERMSIG(pty->exit_code),
 666                         strsignal(WTERMSIG(pty->exit_code)));
 667 #endif
 668             from_backend(pty->frontend, 0, message, strlen(message));
 669         }
 670
 671         notify_remote_exit(pty->frontend);
 672     }
 673
 674     return !finished;
 675 }
 676
 677 int pty_select_result(int fd, int event)
 678 {
 679     int ret = TRUE;
 680     Pty pty;
 681
 682     if (fd == pty_signal_pipe[0]) {
 683         pid_t pid;
 684         int status;
 685         char c[1];
 686
 687         if (read(pty_signal_pipe[0], c, 1) <= 0)
 688             /* ignore error */;
 689         /* ignore its value; it'll be `x' */
 690
 691         do {
 692             pid = waitpid(-1, &status, WNOHANG);
 693
 694             pty = find234(ptys_by_pid, &pid, pty_find_by_pid);
 695
 696             if (pty)
 697                 ret = ret && pty_real_select_result(pty, -1, status);
 698         } while (pid > 0);
 699     } else {
 700         pty = find234(ptys_by_fd, &fd, pty_find_by_fd);
 701
 702         if (pty)
 703             ret = ret && pty_real_select_result(pty, event, 0);
 704     }
 705
 706     return ret;
 707 }
 708
 709 static void pty_uxsel_setup(Pty pty)
 710 {
 711     int rwx;
 712
 713     rwx = 1;                           /* always want to read from pty */
 714     if (bufchain_size(&pty->output_data))
 715         rwx |= 2;                      /* might also want to write to it */
 716     uxsel_set(pty->master_fd, rwx, pty_select_result);
 717
 718     /*
 719      * In principle this only needs calling once for all pty
 720      * backend instances, but it's simplest just to call it every
 721      * time; uxsel won't mind.
 722      */
 723     uxsel_set(pty_signal_pipe[0], 1, pty_select_result);
 724 }
 725
 726 /*
 727  * Called to set up the pty.
 728  *
 729  * Returns an error message, or NULL on success.
 730  *
 731  * Also places the canonical host name into `realhost'. It must be
 732  * freed by the caller.
 733  */
 734 static const char *pty_init(void *frontend, void **backend_handle, Conf *conf,
 735                             const char *host, int port, char **realhost,
 736                             int nodelay, int keepalive)
 737 {
 738     int slavefd;
 739     pid_t pid, pgrp;
 740 #ifndef NOT_X_WINDOWS                  /* for Mac OS X native compilation */
 741     long windowid;
 742 #endif
 743     Pty pty;
 744
 745     if (single_pty) {
 746         pty = single_pty;
 747         assert(pty->conf == NULL);
 748     } else {
 749         pty = new_pty_struct();
 750         pty->master_fd = pty->slave_fd = -1;
 751 #ifndef OMIT_UTMP
 752         pty_stamped_utmp = FALSE;
 753 #endif
 754     }
 755
 756     pty->frontend = frontend;
 757     *backend_handle = NULL;            /* we can't sensibly use this, sadly */
 758
 759     pty->conf = conf_copy(conf);
 760     pty->term_width = conf_get_int(conf, CONF_width);
 761     pty->term_height = conf_get_int(conf, CONF_height);
 762
 763     if (pty->master_fd < 0)
 764         pty_open_master(pty);
 765
 766 #ifndef OMIT_UTMP
 767     /*
 768      * Stamp utmp (that is, tell the utmp helper process to do so),
 769      * or not.
 770      */
 771     if (pty_utmp_helper_pipe >= 0) {   /* if it's < 0, we can't anyway */
 772         if (!conf_get_int(conf, CONF_stamp_utmp)) {
 773             close(pty_utmp_helper_pipe);   /* just let the child process die */
 774             pty_utmp_helper_pipe = -1;
 775         } else {
 776             const char *location = get_x_display(pty->frontend);
 777             int len = strlen(location)+1, pos = 0;   /* +1 to include NUL */
 778             while (pos < len) {
 779                 int ret = write(pty_utmp_helper_pipe, location+pos, len - pos);
 780                 if (ret < 0) {
 781                     perror("pterm: writing to utmp helper process");
 782                     close(pty_utmp_helper_pipe);   /* arrgh, just give up */
 783                     pty_utmp_helper_pipe = -1;
 784                     break;
 785                 }
 786                 pos += ret;
 787             }
 788         }
 789     }
 790 #endif
 791
 792 #ifndef NOT_X_WINDOWS                  /* for Mac OS X native compilation */
 793     windowid = get_windowid(pty->frontend);
 794 #endif
 795
 796     /*
 797      * Fork and execute the command.
 798      */
 799     pid = fork();
 800     if (pid < 0) {
 801         perror("fork");
 802         exit(1);
 803     }
 804
 805     if (pid == 0) {
 806         struct termios attrs;
 807
 808         /*
 809          * We are the child.
 810          */
 811
 812         slavefd = pty_open_slave(pty);
 813         if (slavefd < 0) {
 814             perror("slave pty: open");
 815             _exit(1);
 816         }
 817
 818         close(pty->master_fd);
 819         noncloexec(slavefd);
 820         dup2(slavefd, 0);
 821         dup2(slavefd, 1);
 822         dup2(slavefd, 2);
 823         close(slavefd);
 824         setsid();
 825 #ifdef TIOCSCTTY
 826         ioctl(0, TIOCSCTTY, 1);
 827 #endif
 828         pgrp = getpid();
 829         tcsetpgrp(0, pgrp);
 830
 831         /*
 832          * Set up configuration-dependent termios settings on the new
 833          * pty. Linux would have let us do this on the pty master
 834          * before we forked, but that fails on OS X, so we do it here
 835          * instead.
 836          */
 837         if (tcgetattr(0, &attrs) == 0) {
 838             /*
 839              * Set the backspace character to be whichever of ^H and
 840              * ^? is specified by bksp_is_delete.
 841              */
 842             attrs.c_cc[VERASE] = conf_get_int(conf, CONF_bksp_is_delete)
 843                 ? '\177' : '\010';
 844
 845             /*
 846              * Set the IUTF8 bit iff the character set is UTF-8.
 847              */
 848 #ifdef IUTF8
 849             if (frontend_is_utf8(frontend))
 850                 attrs.c_iflag |= IUTF8;
 851             else
 852                 attrs.c_iflag &= ~IUTF8;
 853 #endif
 854
 855             tcsetattr(0, TCSANOW, &attrs);
 856         }
 857
 858         setpgid(pgrp, pgrp);
 859         {
 860             int ptyfd = open(pty->name, O_WRONLY, 0);
 861             if (ptyfd >= 0)
 862                 close(ptyfd);
 863         }
 864         setpgid(pgrp, pgrp);
 865         {
 866             char *term_env_var = dupprintf("TERM=%s",
 867                                            conf_get_str(conf, CONF_termtype));
 868             putenv(term_env_var);
 869             /* We mustn't free term_env_var, as putenv links it into the
 870              * environment in place.
 871              */
 872         }
 873 #ifndef NOT_X_WINDOWS                  /* for Mac OS X native compilation */
 874         {
 875             char *windowid_env_var = dupprintf("WINDOWID=%ld", windowid);
 876             putenv(windowid_env_var);
 877             /* We mustn't free windowid_env_var, as putenv links it into the
 878              * environment in place.
 879              */
 880         }
 881         {
 882             /*
 883              * In case we were invoked with a --display argument that
 884              * doesn't match DISPLAY in our actual environment, we
 885              * should set DISPLAY for processes running inside the
 886              * terminal to match the display the terminal itself is
 887              * on.
 888              */
 889             const char *x_display = get_x_display(pty->frontend);
 890             char *x_display_env_var = dupprintf("DISPLAY=%s", x_display);
 891             putenv(x_display_env_var);
 892             /* As above, we don't free this. */
 893         }
 894 #endif
 895         {
 896             char *key, *val;
 897
 898             for (val = conf_get_str_strs(conf, CONF_environmt, NULL, &key);
 899                  val != NULL;
 900                  val = conf_get_str_strs(conf, CONF_environmt, key, &key)) {
 901                 char *varval = dupcat(key, "=", val, NULL);
 902                 putenv(varval);
 903                 /*
 904                  * We must not free varval, since putenv links it
 905                  * into the environment _in place_. Weird, but
 906                  * there we go. Memory usage will be rationalised
 907                  * as soon as we exec anyway.
 908                  */
 909             }
 910         }
 911
 912         /*
 913          * SIGINT, SIGQUIT and SIGPIPE may have been set to ignored by
 914          * our parent, particularly by things like sh -c 'pterm &' and
 915          * some window or session managers. SIGCHLD, meanwhile, was
 916          * blocked during pt_main() startup. Reverse all this for our
 917          * child process.
 918          */
 919         putty_signal(SIGINT, SIG_DFL);
 920         putty_signal(SIGQUIT, SIG_DFL);
 921         putty_signal(SIGPIPE, SIG_DFL);
 922         block_signal(SIGCHLD, 0);
 923         if (pty_argv) {
 924             /*
 925              * Exec the exact argument list we were given.
 926              */
 927             execvp(pty_argv[0], pty_argv);
 928             /*
 929              * If that fails, and if we had exactly one argument, pass
 930              * that argument to $SHELL -c.
 931              *
 932              * This arranges that we can _either_ follow 'pterm -e'
 933              * with a list of argv elements to be fed directly to
 934              * exec, _or_ with a single argument containing a command
 935              * to be parsed by a shell (but, in cases of doubt, the
 936              * former is more reliable).
 937              *
 938              * A quick survey of other terminal emulators' -e options
 939              * (as of Debian squeeze) suggests that:
 940              *
 941              *  - xterm supports both modes, more or less like this
 942              *  - gnome-terminal will only accept a one-string shell command
 943              *  - Eterm, kterm and rxvt will only accept a list of
 944              *    argv elements (as did older versions of pterm).
 945              *
 946              * It therefore seems important to support both usage
 947              * modes in order to be a drop-in replacement for either
 948              * xterm or gnome-terminal, and hence for anyone's
 949              * plausible uses of the Debian-style alias
 950              * 'x-terminal-emulator'...
 951              */
 952             if (pty_argv[1] == NULL) {
 953                 char *shell = getenv("SHELL");
 954                 if (shell)
 955                     execl(shell, shell, "-c", pty_argv[0], (void *)NULL);
 956             }
 957         } else {
 958             char *shell = getenv("SHELL");
 959             char *shellname;
 960             if (conf_get_int(conf, CONF_login_shell)) {
 961                 char *p = strrchr(shell, '/');
 962                 shellname = snewn(2+strlen(shell), char);
 963                 p = p ? p+1 : shell;
 964                 sprintf(shellname, "-%s", p);
 965             } else
 966                 shellname = shell;
 967             execl(getenv("SHELL"), shellname, (void *)NULL);
 968         }
 969
 970         /*
 971          * If we're here, exec has gone badly foom.
 972          */
 973         perror("exec");
 974         _exit(127);
 975     } else {
 976         pty->child_pid = pid;
 977         pty->child_dead = FALSE;
 978         pty->finished = FALSE;
 979         if (pty->slave_fd > 0)
 980             close(pty->slave_fd);
 981         if (!ptys_by_pid)
 982             ptys_by_pid = newtree234(pty_compare_by_pid);
 983         add234(ptys_by_pid, pty);
 984     }
 985
 986     if (pty_signal_pipe[0] < 0) {
 987         if (pipe(pty_signal_pipe) < 0) {
 988             perror("pipe");
 989             exit(1);
 990         }
 991         cloexec(pty_signal_pipe[0]);
 992         cloexec(pty_signal_pipe[1]);
 993     }
 994     pty_uxsel_setup(pty);
 995
 996     *backend_handle = pty;
 997
 998     *realhost = dupstr("");
 999
1000     return NULL;
1001 }
1002
1003 static void pty_reconfig(void *handle, Conf *conf)
1004 {
1005     Pty pty = (Pty)handle;
1006     /*
1007      * We don't have much need to reconfigure this backend, but
1008      * unfortunately we do need to pick up the setting of Close On
1009      * Exit so we know whether to give a `terminated' message.
1010      */
1011     conf_copy_into(pty->conf, conf);
1012 }
1013
1014 /*
1015  * Stub routine (never called in pterm).
1016  */
1017 static void pty_free(void *handle)
1018 {
1019     Pty pty = (Pty)handle;
1020
1021     /* Either of these may fail `not found'. That's fine with us. */
1022     del234(ptys_by_pid, pty);
1023     del234(ptys_by_fd, pty);
1024
1025     bufchain_clear(&pty->output_data);
1026
1027     conf_free(pty->conf);
1028     pty->conf = NULL;
1029
1030     if (pty == single_pty) {
1031         /*
1032          * Leave this structure around in case we need to Restart
1033          * Session.
1034          */
1035     } else {
1036         sfree(pty);
1037     }
1038 }
1039
1040 static void pty_try_write(Pty pty)
1041 {
1042     void *data;
1043     int len, ret;
1044
1045     assert(pty->master_fd >= 0);
1046
1047     while (bufchain_size(&pty->output_data) > 0) {
1048         bufchain_prefix(&pty->output_data, &data, &len);
1049         ret = write(pty->master_fd, data, len);
1050
1051         if (ret < 0 && (errno == EWOULDBLOCK)) {
1052             /*
1053              * We've sent all we can for the moment.
1054              */
1055             break;
1056         }
1057         if (ret < 0) {
1058             perror("write pty master");
1059             exit(1);
1060         }
1061         bufchain_consume(&pty->output_data, ret);
1062     }
1063
1064     pty_uxsel_setup(pty);
1065 }
1066
1067 /*
1068  * Called to send data down the pty.
1069  */
1070 static int pty_send(void *handle, const char *buf, int len)
1071 {
1072     Pty pty = (Pty)handle;
1073
1074     if (pty->master_fd < 0)
1075         return 0;                      /* ignore all writes if fd closed */
1076
1077     bufchain_add(&pty->output_data, buf, len);
1078     pty_try_write(pty);
1079
1080     return bufchain_size(&pty->output_data);
1081 }
1082
1083 static void pty_close(Pty pty)
1084 {
1085     if (pty->master_fd >= 0) {
1086         close(pty->master_fd);
1087         pty->master_fd = -1;
1088     }
1089 #ifndef OMIT_UTMP
1090     if (pty_utmp_helper_pipe >= 0) {
1091         close(pty_utmp_helper_pipe);   /* this causes utmp to be cleaned up */
1092         pty_utmp_helper_pipe = -1;
1093     }
1094 #endif
1095 }
1096
1097 /*
1098  * Called to query the current socket sendability status.
1099  */
1100 static int pty_sendbuffer(void *handle)
1101 {
1102     /* Pty pty = (Pty)handle; */
1103     return 0;
1104 }
1105
1106 /*
1107  * Called to set the size of the window
1108  */
1109 static void pty_size(void *handle, int width, int height)
1110 {
1111     Pty pty = (Pty)handle;
1112     struct winsize size;
1113
1114     pty->term_width = width;
1115     pty->term_height = height;
1116
1117     size.ws_row = (unsigned short)pty->term_height;
1118     size.ws_col = (unsigned short)pty->term_width;
1119     size.ws_xpixel = (unsigned short) pty->term_width *
1120         font_dimension(pty->frontend, 0);
1121     size.ws_ypixel = (unsigned short) pty->term_height *
1122         font_dimension(pty->frontend, 1);
1123     ioctl(pty->master_fd, TIOCSWINSZ, (void *)&size);
1124     return;
1125 }
1126
1127 /*
1128  * Send special codes.
1129  */
1130 static void pty_special(void *handle, Telnet_Special code)
1131 {
1132     /* Pty pty = (Pty)handle; */
1133     /* Do nothing! */
1134     return;
1135 }
1136
1137 /*
1138  * Return a list of the special codes that make sense in this
1139  * protocol.
1140  */
1141 static const struct telnet_special *pty_get_specials(void *handle)
1142 {
1143     /* Pty pty = (Pty)handle; */
1144     /*
1145      * Hmm. When I get round to having this actually usable, it
1146      * might be quite nice to have the ability to deliver a few
1147      * well chosen signals to the child process - SIGINT, SIGTERM,
1148      * SIGKILL at least.
1149      */
1150     return NULL;
1151 }
1152
1153 static int pty_connected(void *handle)
1154 {
1155     /* Pty pty = (Pty)handle; */
1156     return TRUE;
1157 }
1158
1159 static int pty_sendok(void *handle)
1160 {
1161     /* Pty pty = (Pty)handle; */
1162     return 1;
1163 }
1164
1165 static void pty_unthrottle(void *handle, int backlog)
1166 {
1167     /* Pty pty = (Pty)handle; */
1168     /* do nothing */
1169 }
1170
1171 static int pty_ldisc(void *handle, int option)
1172 {
1173     /* Pty pty = (Pty)handle; */
1174     return 0;                          /* neither editing nor echoing */
1175 }
1176
1177 static void pty_provide_ldisc(void *handle, void *ldisc)
1178 {
1179     /* Pty pty = (Pty)handle; */
1180     /* This is a stub. */
1181 }
1182
1183 static void pty_provide_logctx(void *handle, void *logctx)
1184 {
1185     /* Pty pty = (Pty)handle; */
1186     /* This is a stub. */
1187 }
1188
1189 static int pty_exitcode(void *handle)
1190 {
1191     Pty pty = (Pty)handle;
1192     if (!pty->finished)
1193         return -1;                     /* not dead yet */
1194     else
1195         return pty->exit_code;
1196 }
1197
1198 static int pty_cfg_info(void *handle)
1199 {
1200     /* Pty pty = (Pty)handle; */
1201     return 0;
1202 }
1203
1204 Backend pty_backend = {
1205     pty_init,
1206     pty_free,
1207     pty_reconfig,
1208     pty_send,
1209     pty_sendbuffer,
1210     pty_size,
1211     pty_special,
1212     pty_get_specials,
1213     pty_connected,
1214     pty_exitcode,
1215     pty_sendok,
1216     pty_ldisc,
1217     pty_provide_ldisc,
1218     pty_provide_logctx,
1219     pty_unthrottle,
1220     pty_cfg_info,
1221     NULL /* test_for_upstream */,
1222     "pty",
1223     -1,
1224     0
1225 };