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