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