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     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;
 171 static int pty_utmp_helper_pipe;
 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 static void sigchld_handler(int signum)
 263 {
 264     if (write(pty_signal_pipe[1], "x", 1) <= 0)
 265         /* not much we can do about it */;
 266 }
 267
 268 #ifndef OMIT_UTMP
 269 static void fatal_sig_handler(int signum)
 270 {
 271     putty_signal(signum, SIG_DFL);
 272     cleanup_utmp();
 273     setuid(getuid());
 274     raise(signum);
 275 }
 276 #endif
 277
 278 static int pty_open_slave(Pty pty)
 279 {
 280     if (pty->slave_fd < 0) {
 281         pty->slave_fd = open(pty->name, O_RDWR);
 282         cloexec(pty->slave_fd);
 283     }
 284
 285     return pty->slave_fd;
 286 }
 287
 288 static void pty_open_master(Pty pty)
 289 {
 290 #ifdef BSD_PTYS
 291     const char chars1[] = "pqrstuvwxyz";
 292     const char chars2[] = "0123456789abcdef";
 293     const char *p1, *p2;
 294     char master_name[20];
 295     struct group *gp;
 296
 297     for (p1 = chars1; *p1; p1++)
 298         for (p2 = chars2; *p2; p2++) {
 299             sprintf(master_name, "/dev/pty%c%c", *p1, *p2);
 300             pty->master_fd = open(master_name, O_RDWR);
 301             if (pty->master_fd >= 0) {
 302                 if (geteuid() == 0 ||
 303                     access(master_name, R_OK | W_OK) == 0) {
 304                     /*
 305                      * We must also check at this point that we are
 306                      * able to open the slave side of the pty. We
 307                      * wouldn't want to allocate the wrong master,
 308                      * get all the way down to forking, and _then_
 309                      * find we're unable to open the slave.
 310                      */
 311                     strcpy(pty->name, master_name);
 312                     pty->name[5] = 't'; /* /dev/ptyXX -> /dev/ttyXX */
 313
 314                     cloexec(pty->master_fd);
 315
 316                     if (pty_open_slave(pty) >= 0 &&
 317                         access(pty->name, R_OK | W_OK) == 0)
 318                         goto got_one;
 319                     if (pty->slave_fd > 0)
 320                         close(pty->slave_fd);
 321                     pty->slave_fd = -1;
 322                 }
 323                 close(pty->master_fd);
 324             }
 325         }
 326
 327     /* If we get here, we couldn't get a tty at all. */
 328     fprintf(stderr, "pterm: unable to open a pseudo-terminal device\n");
 329     exit(1);
 330
 331     got_one:
 332
 333     /* We need to chown/chmod the /dev/ttyXX device. */
 334     gp = getgrnam("tty");
 335     chown(pty->name, getuid(), gp ? gp->gr_gid : -1);
 336     chmod(pty->name, 0600);
 337 #else
 338     pty->master_fd = open("/dev/ptmx", O_RDWR);
 339
 340     if (pty->master_fd < 0) {
 341         perror("/dev/ptmx: open");
 342         exit(1);
 343     }
 344
 345     if (grantpt(pty->master_fd) < 0) {
 346         perror("grantpt");
 347         exit(1);
 348     }
 349
 350     if (unlockpt(pty->master_fd) < 0) {
 351         perror("unlockpt");
 352         exit(1);
 353     }
 354
 355     cloexec(pty->master_fd);
 356
 357     pty->name[FILENAME_MAX-1] = '\0';
 358     strncpy(pty->name, ptsname(pty->master_fd), FILENAME_MAX-1);
 359 #endif
 360
 361     {
 362         /*
 363          * Set the pty master into non-blocking mode.
 364          */
 365         int fl;
 366         fl = fcntl(pty->master_fd, F_GETFL);
 367         if (fl != -1 && !(fl & O_NONBLOCK))
 368             fcntl(pty->master_fd, F_SETFL, fl | O_NONBLOCK);
 369     }
 370
 371     if (!ptys_by_fd)
 372         ptys_by_fd = newtree234(pty_compare_by_fd);
 373     add234(ptys_by_fd, pty);
 374 }
 375
 376 /*
 377  * Pre-initialisation. This is here to get around the fact that GTK
 378  * doesn't like being run in setuid/setgid programs (probably
 379  * sensibly). So before we initialise GTK - and therefore before we
 380  * even process the command line - we check to see if we're running
 381  * set[ug]id. If so, we open our pty master _now_, chown it as
 382  * necessary, and drop privileges. We can always close it again
 383  * later. If we're potentially going to be doing utmp as well, we
 384  * also fork off a utmp helper process and communicate with it by
 385  * means of a pipe; the utmp helper will keep privileges in order
 386  * to clean up utmp when we exit (i.e. when its end of our pipe
 387  * closes).
 388  */
 389 void pty_pre_init(void)
 390 {
 391     Pty pty;
 392
 393 #ifndef OMIT_UTMP
 394     pid_t pid;
 395     int pipefd[2];
 396 #endif
 397
 398     pty = single_pty = snew(struct pty_tag);
 399     bufchain_init(&pty->output_data);
 400
 401     /* set the child signal handler straight away; it needs to be set
 402      * before we ever fork. */
 403     putty_signal(SIGCHLD, sigchld_handler);
 404     pty->master_fd = pty->slave_fd = -1;
 405 #ifndef OMIT_UTMP
 406     pty_stamped_utmp = FALSE;
 407 #endif
 408
 409     if (geteuid() != getuid() || getegid() != getgid()) {
 410         pty_open_master(pty);
 411     }
 412
 413 #ifndef OMIT_UTMP
 414     /*
 415      * Fork off the utmp helper.
 416      */
 417     if (pipe(pipefd) < 0) {
 418         perror("pterm: pipe");
 419         exit(1);
 420     }
 421     cloexec(pipefd[0]);
 422     cloexec(pipefd[1]);
 423     pid = fork();
 424     if (pid < 0) {
 425         perror("pterm: fork");
 426         exit(1);
 427     } else if (pid == 0) {
 428         char display[128], buffer[128];
 429         int dlen, ret;
 430
 431         close(pipefd[1]);
 432         /*
 433          * Now sit here until we receive a display name from the
 434          * other end of the pipe, and then stamp utmp. Unstamp utmp
 435          * again, and exit, when the pipe closes.
 436          */
 437
 438         dlen = 0;
 439         while (1) {
 440
 441             ret = read(pipefd[0], buffer, lenof(buffer));
 442             if (ret <= 0) {
 443                 cleanup_utmp();
 444                 _exit(0);
 445             } else if (!pty_stamped_utmp) {
 446                 if (dlen < lenof(display))
 447                     memcpy(display+dlen, buffer,
 448                            min(ret, lenof(display)-dlen));
 449                 if (buffer[ret-1] == '\0') {
 450                     /*
 451                      * Now we have a display name. NUL-terminate
 452                      * it, and stamp utmp.
 453                      */
 454                     display[lenof(display)-1] = '\0';
 455                     /*
 456                      * Trap as many fatal signals as we can in the
 457                      * hope of having the best possible chance to
 458                      * clean up utmp before termination. We are
 459                      * unfortunately unprotected against SIGKILL,
 460                      * but that's life.
 461                      */
 462                     putty_signal(SIGHUP, fatal_sig_handler);
 463                     putty_signal(SIGINT, fatal_sig_handler);
 464                     putty_signal(SIGQUIT, fatal_sig_handler);
 465                     putty_signal(SIGILL, fatal_sig_handler);
 466                     putty_signal(SIGABRT, fatal_sig_handler);
 467                     putty_signal(SIGFPE, fatal_sig_handler);
 468                     putty_signal(SIGPIPE, fatal_sig_handler);
 469                     putty_signal(SIGALRM, fatal_sig_handler);
 470                     putty_signal(SIGTERM, fatal_sig_handler);
 471                     putty_signal(SIGSEGV, fatal_sig_handler);
 472                     putty_signal(SIGUSR1, fatal_sig_handler);
 473                     putty_signal(SIGUSR2, fatal_sig_handler);
 474 #ifdef SIGBUS
 475                     putty_signal(SIGBUS, fatal_sig_handler);
 476 #endif
 477 #ifdef SIGPOLL
 478                     putty_signal(SIGPOLL, fatal_sig_handler);
 479 #endif
 480 #ifdef SIGPROF
 481                     putty_signal(SIGPROF, fatal_sig_handler);
 482 #endif
 483 #ifdef SIGSYS
 484                     putty_signal(SIGSYS, fatal_sig_handler);
 485 #endif
 486 #ifdef SIGTRAP
 487                     putty_signal(SIGTRAP, fatal_sig_handler);
 488 #endif
 489 #ifdef SIGVTALRM
 490                     putty_signal(SIGVTALRM, fatal_sig_handler);
 491 #endif
 492 #ifdef SIGXCPU
 493                     putty_signal(SIGXCPU, fatal_sig_handler);
 494 #endif
 495 #ifdef SIGXFSZ
 496                     putty_signal(SIGXFSZ, fatal_sig_handler);
 497 #endif
 498 #ifdef SIGIO
 499                     putty_signal(SIGIO, fatal_sig_handler);
 500 #endif
 501                     setup_utmp(pty->name, display);
 502                 }
 503             }
 504         }
 505     } else {
 506         close(pipefd[0]);
 507         pty_utmp_helper_pid = pid;
 508         pty_utmp_helper_pipe = pipefd[1];
 509     }
 510 #endif
 511
 512     /* Drop privs. */
 513     {
 514 #ifndef HAVE_NO_SETRESUID
 515         int gid = getgid(), uid = getuid();
 516         int setresgid(gid_t, gid_t, gid_t);
 517         int setresuid(uid_t, uid_t, uid_t);
 518         setresgid(gid, gid, gid);
 519         setresuid(uid, uid, uid);
 520 #else
 521         setgid(getgid());
 522         setuid(getuid());
 523 #endif
 524     }
 525 }
 526
 527 int pty_real_select_result(Pty pty, int event, int status)
 528 {
 529     char buf[4096];
 530     int ret;
 531     int finished = FALSE;
 532
 533     if (event < 0) {
 534         /*
 535          * We've been called because our child process did
 536          * something. `status' tells us what.
 537          */
 538         if ((WIFEXITED(status) || WIFSIGNALED(status))) {
 539             /*
 540              * The primary child process died. We could keep
 541              * the terminal open for remaining subprocesses to
 542              * output to, but conventional wisdom seems to feel
 543              * that that's the Wrong Thing for an xterm-alike,
 544              * so we bail out now (though we don't necessarily
 545              * _close_ the window, depending on the state of
 546              * Close On Exit). This would be easy enough to
 547              * change or make configurable if necessary.
 548              */
 549             pty->exit_code = status;
 550             pty->child_dead = TRUE;
 551             del234(ptys_by_pid, pty);
 552             finished = TRUE;
 553         }
 554     } else {
 555         if (event == 1) {
 556
 557             ret = read(pty->master_fd, buf, sizeof(buf));
 558
 559             /*
 560              * Clean termination condition is that either ret == 0, or ret
 561              * < 0 and errno == EIO. Not sure why the latter, but it seems
 562              * to happen. Boo.
 563              */
 564             if (ret == 0 || (ret < 0 && errno == EIO)) {
 565                 /*
 566                  * We assume a clean exit if the pty has closed but the
 567                  * actual child process hasn't. The only way I can
 568                  * imagine this happening is if it detaches itself from
 569                  * the pty and goes daemonic - in which case the
 570                  * expected usage model would precisely _not_ be for
 571                  * the pterm window to hang around!
 572                  */
 573                 finished = TRUE;
 574                 if (!pty->child_dead)
 575                     pty->exit_code = 0;
 576             } else if (ret < 0) {
 577                 perror("read pty master");
 578                 exit(1);
 579             } else if (ret > 0) {
 580                 from_backend(pty->frontend, 0, buf, ret);
 581             }
 582         } else if (event == 2) {
 583             /*
 584              * Attempt to send data down the pty.
 585              */
 586             pty_try_write(pty);
 587         }
 588     }
 589
 590     if (finished && !pty->finished) {
 591         uxsel_del(pty->master_fd);
 592         pty_close(pty);
 593         pty->master_fd = -1;
 594
 595         pty->finished = TRUE;
 596
 597         /*
 598          * This is a slight layering-violation sort of hack: only
 599          * if we're not closing on exit (COE is set to Never, or to
 600          * Only On Clean and it wasn't a clean exit) do we output a
 601          * `terminated' message.
 602          */
 603         if (pty->cfg.close_on_exit == FORCE_OFF ||
 604             (pty->cfg.close_on_exit == AUTO && pty->exit_code != 0)) {
 605             char message[512];
 606             if (WIFEXITED(pty->exit_code))
 607                 sprintf(message, "\r\n[pterm: process terminated with exit"
 608                         " code %d]\r\n", WEXITSTATUS(pty->exit_code));
 609             else if (WIFSIGNALED(pty->exit_code))
 610 #ifdef HAVE_NO_STRSIGNAL
 611                 sprintf(message, "\r\n[pterm: process terminated on signal"
 612                         " %d]\r\n", WTERMSIG(pty->exit_code));
 613 #else
 614                 sprintf(message, "\r\n[pterm: process terminated on signal"
 615                         " %d (%.400s)]\r\n", WTERMSIG(pty->exit_code),
 616                         strsignal(WTERMSIG(pty->exit_code)));
 617 #endif
 618             from_backend(pty->frontend, 0, message, strlen(message));
 619         }
 620
 621         notify_remote_exit(pty->frontend);
 622     }
 623
 624     return !finished;
 625 }
 626
 627 int pty_select_result(int fd, int event)
 628 {
 629     int ret = TRUE;
 630     Pty pty;
 631
 632     if (fd == pty_signal_pipe[0]) {
 633         pid_t pid;
 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             pty = find234(ptys_by_pid, &pid, pty_find_by_pid);
 645
 646             if (pty)
 647                 ret = ret && pty_real_select_result(pty, -1, status);
 648         } while (pid > 0);
 649     } else {
 650         pty = find234(ptys_by_fd, &fd, pty_find_by_fd);
 651
 652         if (pty)
 653             ret = ret && pty_real_select_result(pty, event, 0);
 654     }
 655
 656     return ret;
 657 }
 658
 659 static void pty_uxsel_setup(Pty pty)
 660 {
 661     int rwx;
 662
 663     rwx = 1;                           /* always want to read from pty */
 664     if (bufchain_size(&pty->output_data))
 665         rwx |= 2;                      /* might also want to write to it */
 666     uxsel_set(pty->master_fd, rwx, pty_select_result);
 667
 668     /*
 669      * In principle this only needs calling once for all pty
 670      * backend instances, but it's simplest just to call it every
 671      * time; uxsel won't mind.
 672      */
 673     uxsel_set(pty_signal_pipe[0], 1, pty_select_result);
 674 }
 675
 676 /*
 677  * Called to set up the pty.
 678  *
 679  * Returns an error message, or NULL on success.
 680  *
 681  * Also places the canonical host name into `realhost'. It must be
 682  * freed by the caller.
 683  */
 684 static const char *pty_init(void *frontend, void **backend_handle, Config *cfg,
 685                             char *host, int port, char **realhost, int nodelay,
 686                             int keepalive)
 687 {
 688     int slavefd;
 689     pid_t pid, pgrp;
 690 #ifndef NOT_X_WINDOWS                  /* for Mac OS X native compilation */
 691     long windowid;
 692 #endif
 693     Pty pty;
 694
 695     if (single_pty) {
 696         pty = single_pty;
 697     } else {
 698         pty = snew(struct pty_tag);
 699         pty->master_fd = pty->slave_fd = -1;
 700 #ifndef OMIT_UTMP
 701         pty_stamped_utmp = FALSE;
 702 #endif
 703     }
 704
 705     pty->frontend = frontend;
 706     *backend_handle = NULL;            /* we can't sensibly use this, sadly */
 707
 708     pty->cfg = *cfg;                   /* structure copy */
 709     pty->term_width = cfg->width;
 710     pty->term_height = cfg->height;
 711
 712     if (pty->master_fd < 0)
 713         pty_open_master(pty);
 714
 715     /*
 716      * Set the backspace character to be whichever of ^H and ^? is
 717      * specified by bksp_is_delete.
 718      */
 719     {
 720         struct termios attrs;
 721         tcgetattr(pty->master_fd, &attrs);
 722         attrs.c_cc[VERASE] = cfg->bksp_is_delete ? '\177' : '\010';
 723         tcsetattr(pty->master_fd, TCSANOW, &attrs);
 724     }
 725
 726 #ifndef OMIT_UTMP
 727     /*
 728      * Stamp utmp (that is, tell the utmp helper process to do so),
 729      * or not.
 730      */
 731     if (!cfg->stamp_utmp) {
 732         close(pty_utmp_helper_pipe);   /* just let the child process die */
 733         pty_utmp_helper_pipe = -1;
 734     } else {
 735         char *location = get_x_display(pty->frontend);
 736         int len = strlen(location)+1, pos = 0;   /* +1 to include NUL */
 737         while (pos < len) {
 738             int ret = write(pty_utmp_helper_pipe, location+pos, len - pos);
 739             if (ret < 0) {
 740                 perror("pterm: writing to utmp helper process");
 741                 close(pty_utmp_helper_pipe);   /* arrgh, just give up */
 742                 pty_utmp_helper_pipe = -1;
 743                 break;
 744             }
 745             pos += ret;
 746         }
 747     }
 748 #endif
 749
 750 #ifndef NOT_X_WINDOWS                  /* for Mac OS X native compilation */
 751     windowid = get_windowid(pty->frontend);
 752 #endif
 753
 754     /*
 755      * Fork and execute the command.
 756      */
 757     pid = fork();
 758     if (pid < 0) {
 759         perror("fork");
 760         exit(1);
 761     }
 762
 763     if (pid == 0) {
 764         /*
 765          * We are the child.
 766          */
 767
 768         slavefd = pty_open_slave(pty);
 769         if (slavefd < 0) {
 770             perror("slave pty: open");
 771             _exit(1);
 772         }
 773
 774         close(pty->master_fd);
 775         fcntl(slavefd, F_SETFD, 0);    /* don't close on exec */
 776         dup2(slavefd, 0);
 777         dup2(slavefd, 1);
 778         dup2(slavefd, 2);
 779         close(slavefd);
 780         setsid();
 781 #ifdef TIOCSCTTY
 782         ioctl(0, TIOCSCTTY, 1);
 783 #endif
 784         pgrp = getpid();
 785         tcsetpgrp(0, pgrp);
 786         setpgid(pgrp, pgrp);
 787         close(open(pty->name, O_WRONLY, 0));
 788         setpgid(pgrp, pgrp);
 789         {
 790             char *term_env_var = dupprintf("TERM=%s", cfg->termtype);
 791             putenv(term_env_var);
 792             /* We mustn't free term_env_var, as putenv links it into the
 793              * environment in place.
 794              */
 795         }
 796 #ifndef NOT_X_WINDOWS                  /* for Mac OS X native compilation */
 797         {
 798             char *windowid_env_var = dupprintf("WINDOWID=%ld", windowid);
 799             putenv(windowid_env_var);
 800             /* We mustn't free windowid_env_var, as putenv links it into the
 801              * environment in place.
 802              */
 803         }
 804 #endif
 805         {
 806             char *e = cfg->environmt;
 807             char *var, *varend, *val, *varval;
 808             while (*e) {
 809                 var = e;
 810                 while (*e && *e != '\t') e++;
 811                 varend = e;
 812                 if (*e == '\t') e++;
 813                 val = e;
 814                 while (*e) e++;
 815                 e++;
 816
 817                 varval = dupprintf("%.*s=%s", varend-var, var, val);
 818                 putenv(varval);
 819                 /*
 820                  * We must not free varval, since putenv links it
 821                  * into the environment _in place_. Weird, but
 822                  * there we go. Memory usage will be rationalised
 823                  * as soon as we exec anyway.
 824                  */
 825             }
 826         }
 827
 828         /*
 829          * SIGINT, SIGQUIT and SIGPIPE may have been set to ignored by
 830          * our parent, particularly by things like sh -c 'pterm &' and
 831          * some window or session managers. SIGCHLD, meanwhile, was
 832          * blocked during pt_main() startup. Reverse all this for our
 833          * child process.
 834          */
 835         putty_signal(SIGINT, SIG_DFL);
 836         putty_signal(SIGQUIT, SIG_DFL);
 837         putty_signal(SIGPIPE, 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 };