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