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