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     if (write(pty_signal_pipe[1], "x", 1) <= 0)
 264         /* not much we can do about it */;
 265 }
 266
 267 #ifndef OMIT_UTMP
 268 static void fatal_sig_handler(int signum)
 269 {
 270     putty_signal(signum, SIG_DFL);
 271     cleanup_utmp();
 272     setuid(getuid());
 273     raise(signum);
 274 }
 275 #endif
 276
 277 static int pty_open_slave(Pty pty)
 278 {
 279     if (pty->slave_fd < 0) {
 280         pty->slave_fd = open(pty->name, O_RDWR);
 281         cloexec(pty->slave_fd);
 282     }
 283
 284     return pty->slave_fd;
 285 }
 286
 287 static void pty_open_master(Pty pty)
 288 {
 289 #ifdef BSD_PTYS
 290     const char chars1[] = "pqrstuvwxyz";
 291     const char chars2[] = "0123456789abcdef";
 292     const char *p1, *p2;
 293     char master_name[20];
 294     struct group *gp;
 295
 296     for (p1 = chars1; *p1; p1++)
 297         for (p2 = chars2; *p2; p2++) {
 298             sprintf(master_name, "/dev/pty%c%c", *p1, *p2);
 299             pty->master_fd = open(master_name, O_RDWR);
 300             if (pty->master_fd >= 0) {
 301                 if (geteuid() == 0 ||
 302                     access(master_name, R_OK | W_OK) == 0) {
 303                     /*
 304                      * We must also check at this point that we are
 305                      * able to open the slave side of the pty. We
 306                      * wouldn't want to allocate the wrong master,
 307                      * get all the way down to forking, and _then_
 308                      * find we're unable to open the slave.
 309                      */
 310                     strcpy(pty->name, master_name);
 311                     pty->name[5] = 't'; /* /dev/ptyXX -> /dev/ttyXX */
 312
 313                     cloexec(pty->master_fd);
 314
 315                     if (pty_open_slave(pty) >= 0 &&
 316                         access(pty->name, R_OK | W_OK) == 0)
 317                         goto got_one;
 318                     if (pty->slave_fd > 0)
 319                         close(pty->slave_fd);
 320                     pty->slave_fd = -1;
 321                 }
 322                 close(pty->master_fd);
 323             }
 324         }
 325
 326     /* If we get here, we couldn't get a tty at all. */
 327     fprintf(stderr, "pterm: unable to open a pseudo-terminal device\n");
 328     exit(1);
 329
 330     got_one:
 331
 332     /* We need to chown/chmod the /dev/ttyXX device. */
 333     gp = getgrnam("tty");
 334     chown(pty->name, getuid(), gp ? gp->gr_gid : -1);
 335     chmod(pty->name, 0600);
 336 #else
 337     pty->master_fd = open("/dev/ptmx", O_RDWR);
 338
 339     if (pty->master_fd < 0) {
 340         perror("/dev/ptmx: open");
 341         exit(1);
 342     }
 343
 344     if (grantpt(pty->master_fd) < 0) {
 345         perror("grantpt");
 346         exit(1);
 347     }
 348
 349     if (unlockpt(pty->master_fd) < 0) {
 350         perror("unlockpt");
 351         exit(1);
 352     }
 353
 354     cloexec(pty->master_fd);
 355
 356     pty->name[FILENAME_MAX-1] = '\0';
 357     strncpy(pty->name, ptsname(pty->master_fd), FILENAME_MAX-1);
 358 #endif
 359
 360     {
 361         /*
 362          * Set the pty master into non-blocking mode.
 363          */
 364         int fl;
 365         fl = fcntl(pty->master_fd, F_GETFL);
 366         if (fl != -1 && !(fl & O_NONBLOCK))
 367             fcntl(pty->master_fd, F_SETFL, fl | O_NONBLOCK);
 368     }
 369
 370     if (!ptys_by_fd)
 371         ptys_by_fd = newtree234(pty_compare_by_fd);
 372     add234(ptys_by_fd, pty);
 373 }
 374
 375 /*
 376  * Pre-initialisation. This is here to get around the fact that GTK
 377  * doesn't like being run in setuid/setgid programs (probably
 378  * sensibly). So before we initialise GTK - and therefore before we
 379  * even process the command line - we check to see if we're running
 380  * set[ug]id. If so, we open our pty master _now_, chown it as
 381  * necessary, and drop privileges. We can always close it again
 382  * later. If we're potentially going to be doing utmp as well, we
 383  * also fork off a utmp helper process and communicate with it by
 384  * means of a pipe; the utmp helper will keep privileges in order
 385  * to clean up utmp when we exit (i.e. when its end of our pipe
 386  * closes).
 387  */
 388 void pty_pre_init(void)
 389 {
 390     Pty pty;
 391
 392 #ifndef OMIT_UTMP
 393     pid_t pid;
 394     int pipefd[2];
 395 #endif
 396
 397     pty = single_pty = snew(struct pty_tag);
 398     bufchain_init(&pty->output_data);
 399
 400     /* set the child signal handler straight away; it needs to be set
 401      * before we ever fork. */
 402     putty_signal(SIGCHLD, sigchld_handler);
 403     pty->master_fd = pty->slave_fd = -1;
 404 #ifndef OMIT_UTMP
 405     pty_stamped_utmp = FALSE;
 406 #endif
 407
 408     if (geteuid() != getuid() || getegid() != getgid()) {
 409         pty_open_master(pty);
 410     }
 411
 412 #ifndef OMIT_UTMP
 413     /*
 414      * Fork off the utmp helper.
 415      */
 416     if (pipe(pipefd) < 0) {
 417         perror("pterm: pipe");
 418         exit(1);
 419     }
 420     cloexec(pipefd[0]);
 421     cloexec(pipefd[1]);
 422     pid = fork();
 423     if (pid < 0) {
 424         perror("pterm: fork");
 425         exit(1);
 426     } else if (pid == 0) {
 427         char display[128], buffer[128];
 428         int dlen, ret;
 429
 430         close(pipefd[1]);
 431         /*
 432          * Now sit here until we receive a display name from the
 433          * other end of the pipe, and then stamp utmp. Unstamp utmp
 434          * again, and exit, when the pipe closes.
 435          */
 436
 437         dlen = 0;
 438         while (1) {
 439
 440             ret = read(pipefd[0], buffer, lenof(buffer));
 441             if (ret <= 0) {
 442                 cleanup_utmp();
 443                 _exit(0);
 444             } else if (!pty_stamped_utmp) {
 445                 if (dlen < lenof(display))
 446                     memcpy(display+dlen, buffer,
 447                            min(ret, lenof(display)-dlen));
 448                 if (buffer[ret-1] == '\0') {
 449                     /*
 450                      * Now we have a display name. NUL-terminate
 451                      * it, and stamp utmp.
 452                      */
 453                     display[lenof(display)-1] = '\0';
 454                     /*
 455                      * Trap as many fatal signals as we can in the
 456                      * hope of having the best possible chance to
 457                      * clean up utmp before termination. We are
 458                      * unfortunately unprotected against SIGKILL,
 459                      * but that's life.
 460                      */
 461                     putty_signal(SIGHUP, fatal_sig_handler);
 462                     putty_signal(SIGINT, fatal_sig_handler);
 463                     putty_signal(SIGQUIT, fatal_sig_handler);
 464                     putty_signal(SIGILL, fatal_sig_handler);
 465                     putty_signal(SIGABRT, fatal_sig_handler);
 466                     putty_signal(SIGFPE, fatal_sig_handler);
 467                     putty_signal(SIGPIPE, fatal_sig_handler);
 468                     putty_signal(SIGALRM, fatal_sig_handler);
 469                     putty_signal(SIGTERM, fatal_sig_handler);
 470                     putty_signal(SIGSEGV, fatal_sig_handler);
 471                     putty_signal(SIGUSR1, fatal_sig_handler);
 472                     putty_signal(SIGUSR2, fatal_sig_handler);
 473 #ifdef SIGBUS
 474                     putty_signal(SIGBUS, fatal_sig_handler);
 475 #endif
 476 #ifdef SIGPOLL
 477                     putty_signal(SIGPOLL, fatal_sig_handler);
 478 #endif
 479 #ifdef SIGPROF
 480                     putty_signal(SIGPROF, fatal_sig_handler);
 481 #endif
 482 #ifdef SIGSYS
 483                     putty_signal(SIGSYS, fatal_sig_handler);
 484 #endif
 485 #ifdef SIGTRAP
 486                     putty_signal(SIGTRAP, fatal_sig_handler);
 487 #endif
 488 #ifdef SIGVTALRM
 489                     putty_signal(SIGVTALRM, fatal_sig_handler);
 490 #endif
 491 #ifdef SIGXCPU
 492                     putty_signal(SIGXCPU, fatal_sig_handler);
 493 #endif
 494 #ifdef SIGXFSZ
 495                     putty_signal(SIGXFSZ, fatal_sig_handler);
 496 #endif
 497 #ifdef SIGIO
 498                     putty_signal(SIGIO, fatal_sig_handler);
 499 #endif
 500                     setup_utmp(pty->name, display);
 501                 }
 502             }
 503         }
 504     } else {
 505         close(pipefd[0]);
 506         pty_utmp_helper_pid = pid;
 507         pty_utmp_helper_pipe = pipefd[1];
 508     }
 509 #endif
 510
 511     /* Drop privs. */
 512     {
 513 #ifndef HAVE_NO_SETRESUID
 514         int gid = getgid(), uid = getuid();
 515         int setresgid(gid_t, gid_t, gid_t);
 516         int setresuid(uid_t, uid_t, uid_t);
 517         setresgid(gid, gid, gid);
 518         setresuid(uid, uid, uid);
 519 #else
 520         setgid(getgid());
 521         setuid(getuid());
 522 #endif
 523     }
 524 }
 525
 526 int pty_real_select_result(Pty pty, int event, int status)
 527 {
 528     char buf[4096];
 529     int ret;
 530     int finished = FALSE;
 531
 532     if (event < 0) {
 533         /*
 534          * We've been called because our child process did
 535          * something. `status' tells us what.
 536          */
 537         if ((WIFEXITED(status) || WIFSIGNALED(status))) {
 538             /*
 539              * The primary child process died. We could keep
 540              * the terminal open for remaining subprocesses to
 541              * output to, but conventional wisdom seems to feel
 542              * that that's the Wrong Thing for an xterm-alike,
 543              * so we bail out now (though we don't necessarily
 544              * _close_ the window, depending on the state of
 545              * Close On Exit). This would be easy enough to
 546              * change or make configurable if necessary.
 547              */
 548             pty->exit_code = status;
 549             pty->child_dead = TRUE;
 550             del234(ptys_by_pid, pty);
 551             finished = TRUE;
 552         }
 553     } else {
 554         if (event == 1) {
 555
 556             ret = read(pty->master_fd, buf, sizeof(buf));
 557
 558             /*
 559              * Clean termination condition is that either ret == 0, or ret
 560              * < 0 and errno == EIO. Not sure why the latter, but it seems
 561              * to happen. Boo.
 562              */
 563             if (ret == 0 || (ret < 0 && errno == EIO)) {
 564                 /*
 565                  * We assume a clean exit if the pty has closed but the
 566                  * actual child process hasn't. The only way I can
 567                  * imagine this happening is if it detaches itself from
 568                  * the pty and goes daemonic - in which case the
 569                  * expected usage model would precisely _not_ be for
 570                  * the pterm window to hang around!
 571                  */
 572                 finished = TRUE;
 573                 if (!pty->child_dead)
 574                     pty->exit_code = 0;
 575             } else if (ret < 0) {
 576                 perror("read pty master");
 577                 exit(1);
 578             } else if (ret > 0) {
 579                 from_backend(pty->frontend, 0, buf, ret);
 580             }
 581         } else if (event == 2) {
 582             /*
 583              * Attempt to send data down the pty.
 584              */
 585             pty_try_write(pty);
 586         }
 587     }
 588
 589     if (finished && !pty->finished) {
 590         uxsel_del(pty->master_fd);
 591         pty_close(pty);
 592         pty->master_fd = -1;
 593
 594         pty->finished = TRUE;
 595
 596         /*
 597          * This is a slight layering-violation sort of hack: only
 598          * if we're not closing on exit (COE is set to Never, or to
 599          * Only On Clean and it wasn't a clean exit) do we output a
 600          * `terminated' message.
 601          */
 602         if (pty->cfg.close_on_exit == FORCE_OFF ||
 603             (pty->cfg.close_on_exit == AUTO && pty->exit_code != 0)) {
 604             char message[512];
 605             if (WIFEXITED(pty->exit_code))
 606                 sprintf(message, "\r\n[pterm: process terminated with exit"
 607                         " code %d]\r\n", WEXITSTATUS(pty->exit_code));
 608             else if (WIFSIGNALED(pty->exit_code))
 609 #ifdef HAVE_NO_STRSIGNAL
 610                 sprintf(message, "\r\n[pterm: process terminated on signal"
 611                         " %d]\r\n", WTERMSIG(pty->exit_code));
 612 #else
 613                 sprintf(message, "\r\n[pterm: process terminated on signal"
 614                         " %d (%.400s)]\r\n", WTERMSIG(pty->exit_code),
 615                         strsignal(WTERMSIG(pty->exit_code)));
 616 #endif
 617             from_backend(pty->frontend, 0, message, strlen(message));
 618         }
 619
 620         notify_remote_exit(pty->frontend);
 621     }
 622
 623     return !finished;
 624 }
 625
 626 int pty_select_result(int fd, int event)
 627 {
 628     int ret = TRUE;
 629     Pty pty;
 630
 631     if (fd == pty_signal_pipe[0]) {
 632         pid_t pid;
 633         int ipid;
 634         int status;
 635         char c[1];
 636
 637         if (read(pty_signal_pipe[0], c, 1) <= 0)
 638             /* ignore error */;
 639         /* ignore its value; it'll be `x' */
 640
 641         do {
 642             pid = waitpid(-1, &status, WNOHANG);
 643
 644             ipid = pid;
 645             pty = find234(ptys_by_pid, &pid, pty_find_by_pid);
 646
 647             if (pty)
 648                 ret = ret && pty_real_select_result(pty, -1, status);
 649         } while (pid > 0);
 650     } else {
 651         pty = find234(ptys_by_fd, &fd, pty_find_by_fd);
 652
 653         if (pty)
 654             ret = ret && pty_real_select_result(pty, event, 0);
 655     }
 656
 657     return ret;
 658 }
 659
 660 static void pty_uxsel_setup(Pty pty)
 661 {
 662     int rwx;
 663
 664     rwx = 1;                           /* always want to read from pty */
 665     if (bufchain_size(&pty->output_data))
 666         rwx |= 2;                      /* might also want to write to it */
 667     uxsel_set(pty->master_fd, rwx, pty_select_result);
 668
 669     /*
 670      * In principle this only needs calling once for all pty
 671      * backend instances, but it's simplest just to call it every
 672      * time; uxsel won't mind.
 673      */
 674     uxsel_set(pty_signal_pipe[0], 1, pty_select_result);
 675 }
 676
 677 /*
 678  * Called to set up the pty.
 679  *
 680  * Returns an error message, or NULL on success.
 681  *
 682  * Also places the canonical host name into `realhost'. It must be
 683  * freed by the caller.
 684  */
 685 static const char *pty_init(void *frontend, void **backend_handle, Config *cfg,
 686                             char *host, int port, char **realhost, int nodelay,
 687                             int keepalive)
 688 {
 689     int slavefd;
 690     pid_t pid, pgrp;
 691 #ifndef NOT_X_WINDOWS                  /* for Mac OS X native compilation */
 692     long windowid;
 693 #endif
 694     Pty pty;
 695
 696     if (single_pty) {
 697         pty = single_pty;
 698     } else {
 699         pty = snew(struct pty_tag);
 700         pty->master_fd = pty->slave_fd = -1;
 701 #ifndef OMIT_UTMP
 702         pty_stamped_utmp = FALSE;
 703 #endif
 704     }
 705
 706     pty->frontend = frontend;
 707     *backend_handle = NULL;            /* we can't sensibly use this, sadly */
 708
 709     pty->cfg = *cfg;                   /* structure copy */
 710     pty->term_width = cfg->width;
 711     pty->term_height = cfg->height;
 712
 713     if (pty->master_fd < 0)
 714         pty_open_master(pty);
 715
 716     /*
 717      * Set the backspace character to be whichever of ^H and ^? is
 718      * specified by bksp_is_delete.
 719      */
 720     {
 721         struct termios attrs;
 722         tcgetattr(pty->master_fd, &attrs);
 723         attrs.c_cc[VERASE] = cfg->bksp_is_delete ? '\177' : '\010';
 724         tcsetattr(pty->master_fd, TCSANOW, &attrs);
 725     }
 726
 727 #ifndef OMIT_UTMP
 728     /*
 729      * Stamp utmp (that is, tell the utmp helper process to do so),
 730      * or not.
 731      */
 732     if (!cfg->stamp_utmp) {
 733         close(pty_utmp_helper_pipe);   /* just let the child process die */
 734         pty_utmp_helper_pipe = -1;
 735     } else {
 736         char *location = get_x_display(pty->frontend);
 737         int len = strlen(location)+1, pos = 0;   /* +1 to include NUL */
 738         while (pos < len) {
 739             int ret = write(pty_utmp_helper_pipe, location+pos, len - pos);
 740             if (ret < 0) {
 741                 perror("pterm: writing to utmp helper process");
 742                 close(pty_utmp_helper_pipe);   /* arrgh, just give up */
 743                 pty_utmp_helper_pipe = -1;
 744                 break;
 745             }
 746             pos += ret;
 747         }
 748     }
 749 #endif
 750
 751 #ifndef NOT_X_WINDOWS                  /* for Mac OS X native compilation */
 752     windowid = get_windowid(pty->frontend);
 753 #endif
 754
 755     /*
 756      * Fork and execute the command.
 757      */
 758     pid = fork();
 759     if (pid < 0) {
 760         perror("fork");
 761         exit(1);
 762     }
 763
 764     if (pid == 0) {
 765         /*
 766          * We are the child.
 767          */
 768
 769         slavefd = pty_open_slave(pty);
 770         if (slavefd < 0) {
 771             perror("slave pty: open");
 772             _exit(1);
 773         }
 774
 775         close(pty->master_fd);
 776         fcntl(slavefd, F_SETFD, 0);    /* don't close on exec */
 777         dup2(slavefd, 0);
 778         dup2(slavefd, 1);
 779         dup2(slavefd, 2);
 780         close(slavefd);
 781         setsid();
 782 #ifdef TIOCSCTTY
 783         ioctl(0, TIOCSCTTY, 1);
 784 #endif
 785         pgrp = getpid();
 786         tcsetpgrp(0, pgrp);
 787         setpgid(pgrp, pgrp);
 788         close(open(pty->name, O_WRONLY, 0));
 789         setpgid(pgrp, pgrp);
 790         {
 791             char *term_env_var = dupprintf("TERM=%s", cfg->termtype);
 792             putenv(term_env_var);
 793             /* We mustn't free term_env_var, as putenv links it into the
 794              * environment in place.
 795              */
 796         }
 797 #ifndef NOT_X_WINDOWS                  /* for Mac OS X native compilation */
 798         {
 799             char *windowid_env_var = dupprintf("WINDOWID=%ld", windowid);
 800             putenv(windowid_env_var);
 801             /* We mustn't free windowid_env_var, as putenv links it into the
 802              * environment in place.
 803              */
 804         }
 805 #endif
 806         {
 807             char *e = cfg->environmt;
 808             char *var, *varend, *val, *varval;
 809             while (*e) {
 810                 var = e;
 811                 while (*e && *e != '\t') e++;
 812                 varend = e;
 813                 if (*e == '\t') e++;
 814                 val = e;
 815                 while (*e) e++;
 816                 e++;
 817
 818                 varval = dupprintf("%.*s=%s", varend-var, var, val);
 819                 putenv(varval);
 820                 /*
 821                  * We must not free varval, since putenv links it
 822                  * into the environment _in place_. Weird, but
 823                  * there we go. Memory usage will be rationalised
 824                  * as soon as we exec anyway.
 825                  */
 826             }
 827         }
 828
 829         /*
 830          * SIGINT and SIGQUIT may have been set to ignored by our
 831          * parent, particularly by things like sh -c 'pterm &' and
 832          * some window managers. SIGCHLD, meanwhile, was blocked
 833          * during pt_main() startup. Reverse all this for our child
 834          * process.
 835          */
 836         putty_signal(SIGINT, SIG_DFL);
 837         putty_signal(SIGQUIT, SIG_DFL);
 838         block_signal(SIGCHLD, 0);
 839         if (pty_argv)
 840             execvp(pty_argv[0], pty_argv);
 841         else {
 842             char *shell = getenv("SHELL");
 843             char *shellname;
 844             if (cfg->login_shell) {
 845                 char *p = strrchr(shell, '/');
 846                 shellname = snewn(2+strlen(shell), char);
 847                 p = p ? p+1 : shell;
 848                 sprintf(shellname, "-%s", p);
 849             } else
 850                 shellname = shell;
 851             execl(getenv("SHELL"), shellname, (void *)NULL);
 852         }
 853
 854         /*
 855          * If we're here, exec has gone badly foom.
 856          */
 857         perror("exec");
 858         _exit(127);
 859     } else {
 860         pty->child_pid = pid;
 861         pty->child_dead = FALSE;
 862         pty->finished = FALSE;
 863         if (pty->slave_fd > 0)
 864             close(pty->slave_fd);
 865         if (!ptys_by_pid)
 866             ptys_by_pid = newtree234(pty_compare_by_pid);
 867         add234(ptys_by_pid, pty);
 868     }
 869
 870     if (pty_signal_pipe[0] < 0) {
 871         if (pipe(pty_signal_pipe) < 0) {
 872             perror("pipe");
 873             exit(1);
 874         }
 875         cloexec(pty_signal_pipe[0]);
 876         cloexec(pty_signal_pipe[1]);
 877     }
 878     pty_uxsel_setup(pty);
 879
 880     *backend_handle = pty;
 881
 882     *realhost = dupprintf("\0");
 883
 884     return NULL;
 885 }
 886
 887 static void pty_reconfig(void *handle, Config *cfg)
 888 {
 889     Pty pty = (Pty)handle;
 890     /*
 891      * We don't have much need to reconfigure this backend, but
 892      * unfortunately we do need to pick up the setting of Close On
 893      * Exit so we know whether to give a `terminated' message.
 894      */
 895     pty->cfg = *cfg;                   /* structure copy */
 896 }
 897
 898 /*
 899  * Stub routine (never called in pterm).
 900  */
 901 static void pty_free(void *handle)
 902 {
 903     Pty pty = (Pty)handle;
 904
 905     /* Either of these may fail `not found'. That's fine with us. */
 906     del234(ptys_by_pid, pty);
 907     del234(ptys_by_fd, pty);
 908
 909     sfree(pty);
 910 }
 911
 912 static void pty_try_write(Pty pty)
 913 {
 914     void *data;
 915     int len, ret;
 916
 917     assert(pty->master_fd >= 0);
 918
 919     while (bufchain_size(&pty->output_data) > 0) {
 920         bufchain_prefix(&pty->output_data, &data, &len);
 921         ret = write(pty->master_fd, data, len);
 922
 923         if (ret < 0 && (errno == EWOULDBLOCK)) {
 924             /*
 925              * We've sent all we can for the moment.
 926              */
 927             break;
 928         }
 929         if (ret < 0) {
 930             perror("write pty master");
 931             exit(1);
 932         }
 933         bufchain_consume(&pty->output_data, ret);
 934     }
 935
 936     pty_uxsel_setup(pty);
 937 }
 938
 939 /*
 940  * Called to send data down the pty.
 941  */
 942 static int pty_send(void *handle, char *buf, int len)
 943 {
 944     Pty pty = (Pty)handle;
 945
 946     if (pty->master_fd < 0)
 947         return 0;                      /* ignore all writes if fd closed */
 948
 949     bufchain_add(&pty->output_data, buf, len);
 950     pty_try_write(pty);
 951
 952     return bufchain_size(&pty->output_data);
 953 }
 954
 955 static void pty_close(Pty pty)
 956 {
 957     if (pty->master_fd >= 0) {
 958         close(pty->master_fd);
 959         pty->master_fd = -1;
 960     }
 961 #ifndef OMIT_UTMP
 962     if (pty_utmp_helper_pipe >= 0) {
 963         close(pty_utmp_helper_pipe);   /* this causes utmp to be cleaned up */
 964         pty_utmp_helper_pipe = -1;
 965     }
 966 #endif
 967 }
 968
 969 /*
 970  * Called to query the current socket sendability status.
 971  */
 972 static int pty_sendbuffer(void *handle)
 973 {
 974     /* Pty pty = (Pty)handle; */
 975     return 0;
 976 }
 977
 978 /*
 979  * Called to set the size of the window
 980  */
 981 static void pty_size(void *handle, int width, int height)
 982 {
 983     Pty pty = (Pty)handle;
 984     struct winsize size;
 985
 986     pty->term_width = width;
 987     pty->term_height = height;
 988
 989     size.ws_row = (unsigned short)pty->term_height;
 990     size.ws_col = (unsigned short)pty->term_width;
 991     size.ws_xpixel = (unsigned short) pty->term_width *
 992         font_dimension(pty->frontend, 0);
 993     size.ws_ypixel = (unsigned short) pty->term_height *
 994         font_dimension(pty->frontend, 1);
 995     ioctl(pty->master_fd, TIOCSWINSZ, (void *)&size);
 996     return;
 997 }
 998
 999 /*
1000  * Send special codes.
1001  */
1002 static void pty_special(void *handle, Telnet_Special code)
1003 {
1004     /* Pty pty = (Pty)handle; */
1005     /* Do nothing! */
1006     return;
1007 }
1008
1009 /*
1010  * Return a list of the special codes that make sense in this
1011  * protocol.
1012  */
1013 static const struct telnet_special *pty_get_specials(void *handle)
1014 {
1015     /* Pty pty = (Pty)handle; */
1016     /*
1017      * Hmm. When I get round to having this actually usable, it
1018      * might be quite nice to have the ability to deliver a few
1019      * well chosen signals to the child process - SIGINT, SIGTERM,
1020      * SIGKILL at least.
1021      */
1022     return NULL;
1023 }
1024
1025 static int pty_connected(void *handle)
1026 {
1027     /* Pty pty = (Pty)handle; */
1028     return TRUE;
1029 }
1030
1031 static int pty_sendok(void *handle)
1032 {
1033     /* Pty pty = (Pty)handle; */
1034     return 1;
1035 }
1036
1037 static void pty_unthrottle(void *handle, int backlog)
1038 {
1039     /* Pty pty = (Pty)handle; */
1040     /* do nothing */
1041 }
1042
1043 static int pty_ldisc(void *handle, int option)
1044 {
1045     /* Pty pty = (Pty)handle; */
1046     return 0;                          /* neither editing nor echoing */
1047 }
1048
1049 static void pty_provide_ldisc(void *handle, void *ldisc)
1050 {
1051     /* Pty pty = (Pty)handle; */
1052     /* This is a stub. */
1053 }
1054
1055 static void pty_provide_logctx(void *handle, void *logctx)
1056 {
1057     /* Pty pty = (Pty)handle; */
1058     /* This is a stub. */
1059 }
1060
1061 static int pty_exitcode(void *handle)
1062 {
1063     Pty pty = (Pty)handle;
1064     if (!pty->finished)
1065         return -1;                     /* not dead yet */
1066     else
1067         return pty->exit_code;
1068 }
1069
1070 static int pty_cfg_info(void *handle)
1071 {
1072     /* Pty pty = (Pty)handle; */
1073     return 0;
1074 }
1075
1076 Backend pty_backend = {
1077     pty_init,
1078     pty_free,
1079     pty_reconfig,
1080     pty_send,
1081     pty_sendbuffer,
1082     pty_size,
1083     pty_special,
1084     pty_get_specials,
1085     pty_connected,
1086     pty_exitcode,
1087     pty_sendok,
1088     pty_ldisc,
1089     pty_provide_ldisc,
1090     pty_provide_logctx,
1091     pty_unthrottle,
1092     pty_cfg_info,
1093     "pty",
1094     -1,
1095     0
1096 };