1 |
/*--------------------------------*-C-*---------------------------------* |
2 |
* File: ptytty.C |
3 |
*----------------------------------------------------------------------* |
4 |
* |
5 |
* All portions of code are copyright by their respective author/s. |
6 |
* Copyright (c) 1999-2001 Geoff Wing <gcw@pobox.com> |
7 |
* Copyright (c) 2004-2006 Marc Lehmann <pcg@goof.com> |
8 |
* |
9 |
* This program is free software; you can redistribute it and/or modify |
10 |
* it under the terms of the GNU General Public License as published by |
11 |
* the Free Software Foundation; either version 2 of the License, or |
12 |
* (at your option) any later version. |
13 |
* |
14 |
* This program is distributed in the hope that it will be useful, |
15 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
16 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
17 |
* GNU General Public License for more details. |
18 |
* |
19 |
* You should have received a copy of the GNU General Public License |
20 |
* along with this program; if not, write to the Free Software |
21 |
* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. |
22 |
*---------------------------------------------------------------------*/ |
23 |
|
24 |
#include "../config.h" /* NECESSARY */ |
25 |
#include "rxvt.h" |
26 |
|
27 |
#include <cstdlib> |
28 |
#include <cstring> |
29 |
|
30 |
#include <sys/types.h> |
31 |
#include <sys/socket.h> |
32 |
#include <unistd.h> |
33 |
#include <fcntl.h> |
34 |
|
35 |
#ifdef HAVE_SYS_IOCTL_H |
36 |
# include <sys/ioctl.h> |
37 |
#endif |
38 |
#if defined(HAVE_DEV_PTMX) && defined(HAVE_SYS_STROPTS_H) |
39 |
# include <sys/stropts.h> /* for I_PUSH */ |
40 |
#endif |
41 |
#ifdef HAVE_ISASTREAM |
42 |
# include <stropts.h> |
43 |
#endif |
44 |
#if defined(HAVE_PTY_H) |
45 |
# include <pty.h> |
46 |
#elif defined(HAVE_LIBUTIL_H) |
47 |
# include <libutil.h> |
48 |
#elif defined(HAVE_UTIL_H) |
49 |
# include <util.h> |
50 |
#endif |
51 |
#ifdef TTY_GID_SUPPORT |
52 |
#include <grp.h> |
53 |
#endif |
54 |
|
55 |
#include <cstdio> |
56 |
|
57 |
#include "rxvtutil.h" |
58 |
#include "fdpass.h" |
59 |
#include "ptytty.h" |
60 |
|
61 |
///////////////////////////////////////////////////////////////////////////// |
62 |
|
63 |
/* ------------------------------------------------------------------------- * |
64 |
* GET PSEUDO TELETYPE - MASTER AND SLAVE * |
65 |
* ------------------------------------------------------------------------- */ |
66 |
/* |
67 |
* Returns pty file descriptor, or -1 on failure |
68 |
* If successful, ttydev is set to the name of the slave device. |
69 |
* fd_tty _may_ also be set to an open fd to the slave device |
70 |
*/ |
71 |
#if defined(UNIX98_PTY) |
72 |
static int |
73 |
get_pty (int *fd_tty, char **ttydev) |
74 |
{ |
75 |
int pfd; |
76 |
|
77 |
# if defined(HAVE_GETPT) |
78 |
pfd = getpt(); |
79 |
# elif defined(HAVE_POSIX_OPENPT) |
80 |
pfd = posix_openpt (O_RDWR); |
81 |
# else |
82 |
pfd = open (CLONE_DEVICE, O_RDWR | O_NOCTTY, 0); |
83 |
# endif |
84 |
if (pfd >= 0) |
85 |
{ |
86 |
if (grantpt (pfd) == 0 /* change slave permissions */ |
87 |
&& unlockpt (pfd) == 0) |
88 |
{ /* slave now unlocked */ |
89 |
*ttydev = strdup (ptsname (pfd)); /* get slave's name */ |
90 |
return pfd; |
91 |
} |
92 |
|
93 |
close (pfd); |
94 |
} |
95 |
|
96 |
return -1; |
97 |
} |
98 |
#elif defined(HAVE_OPENPTY) |
99 |
static int |
100 |
get_pty (int *fd_tty, char **ttydev) |
101 |
{ |
102 |
int pfd; |
103 |
int res; |
104 |
char tty_name[32]; |
105 |
|
106 |
res = openpty (&pfd, fd_tty, tty_name, NULL, NULL); |
107 |
if (res != -1) |
108 |
{ |
109 |
*ttydev = strdup (tty_name); |
110 |
return pfd; |
111 |
} |
112 |
|
113 |
return -1; |
114 |
} |
115 |
#elif defined(HAVE__GETPTY) |
116 |
static int |
117 |
get_pty (int *fd_tty, char **ttydev) |
118 |
{ |
119 |
int pfd; |
120 |
|
121 |
*ttydev = _getpty (&pfd, O_RDWR | O_NONBLOCK | O_NOCTTY, 0622, 0); |
122 |
if (*ttydev != NULL) |
123 |
return pfd; |
124 |
|
125 |
return -1; |
126 |
} |
127 |
#elif defined(HAVE_DEV_PTC) |
128 |
static int |
129 |
get_pty (int *fd_tty, char **ttydev) |
130 |
{ |
131 |
int pfd; |
132 |
|
133 |
if ((pfd = open ("/dev/ptc", O_RDWR | O_NOCTTY, 0)) >= 0) |
134 |
{ |
135 |
*ttydev = strdup (ttyname (pfd)); |
136 |
return pfd; |
137 |
} |
138 |
|
139 |
return -1; |
140 |
} |
141 |
#elif defined(HAVE_DEV_CLONE) |
142 |
static int |
143 |
get_pty (int *fd_tty, char **ttydev) |
144 |
{ |
145 |
int pfd; |
146 |
|
147 |
if ((pfd = open ("/dev/ptym/clone", O_RDWR | O_NOCTTY, 0)) >= 0) |
148 |
{ |
149 |
*ttydev = strdup (ptsname (pfd)); |
150 |
return pfd; |
151 |
} |
152 |
|
153 |
return -1; |
154 |
} |
155 |
#else |
156 |
/* Based on the code in openssh/openbsd-compat/bsd-openpty.c */ |
157 |
static int |
158 |
get_pty (int *fd_tty, char **ttydev) |
159 |
{ |
160 |
int pfd; |
161 |
int i; |
162 |
char pty_name[32]; |
163 |
char tty_name[32]; |
164 |
const char *majors = "pqrstuvwxyzabcde"; |
165 |
const char *minors = "0123456789abcdef"; |
166 |
for (i = 0; i < 256; i++) |
167 |
{ |
168 |
snprintf(pty_name, 32, "/dev/pty%c%c", majors[i / 16], minors[i % 16]); |
169 |
snprintf(tty_name, 32, "/dev/tty%c%c", majors[i / 16], minors[i % 16]); |
170 |
if ((pfd = open (pty_name, O_RDWR | O_NOCTTY, 0)) == -1) |
171 |
{ |
172 |
snprintf(pty_name, 32, "/dev/ptyp%d", i); |
173 |
snprintf(tty_name, 32, "/dev/ttyp%d", i); |
174 |
if ((pfd = open (pty_name, O_RDWR | O_NOCTTY, 0)) == -1) |
175 |
continue; |
176 |
} |
177 |
if (access (tty_name, R_OK | W_OK) == 0) |
178 |
{ |
179 |
*ttydev = strdup (tty_name); |
180 |
return pfd; |
181 |
} |
182 |
|
183 |
close (pfd); |
184 |
} |
185 |
} |
186 |
#endif |
187 |
|
188 |
/*----------------------------------------------------------------------*/ |
189 |
/* |
190 |
* Returns tty file descriptor, or -1 on failure |
191 |
*/ |
192 |
static int |
193 |
get_tty (char *ttydev) |
194 |
{ |
195 |
return open (ttydev, O_RDWR | O_NOCTTY, 0); |
196 |
} |
197 |
|
198 |
/*----------------------------------------------------------------------*/ |
199 |
/* |
200 |
* Make our tty a controlling tty so that /dev/tty points to us |
201 |
*/ |
202 |
static int |
203 |
control_tty (int fd_tty) |
204 |
{ |
205 |
setsid (); |
206 |
|
207 |
#if defined(HAVE_DEV_PTMX) && defined(I_PUSH) |
208 |
/* |
209 |
* Push STREAMS modules: |
210 |
* ptem: pseudo-terminal hardware emulation module. |
211 |
* ldterm: standard terminal line discipline. |
212 |
* ttcompat: V7, 4BSD and XENIX STREAMS compatibility module. |
213 |
* |
214 |
* After we push the STREAMS modules, the first open () on the slave side |
215 |
* (i.e. the next section between the dashes giving us "tty opened OK") |
216 |
* should make the "ptem" (or "ldterm" depending upon either which OS |
217 |
* version or which set of manual pages you have) module give us a |
218 |
* controlling terminal. We must already have close ()d the master side |
219 |
* fd in this child process before we push STREAMS modules on because the |
220 |
* documentation is really unclear about whether it is any close () on |
221 |
* the master side or the last close () - i.e. a proper STREAMS dismantling |
222 |
* close () - on the master side which causes a hang up to be sent |
223 |
* through - Geoff Wing |
224 |
*/ |
225 |
# ifdef HAVE_ISASTREAM |
226 |
if (isastream (fd_tty) == 1) |
227 |
# endif |
228 |
{ |
229 |
ioctl (fd_tty, I_PUSH, "ptem"); |
230 |
ioctl (fd_tty, I_PUSH, "ldterm"); |
231 |
ioctl (fd_tty, I_PUSH, "ttcompat"); |
232 |
} |
233 |
#endif |
234 |
|
235 |
ioctl (fd_tty, TIOCSCTTY, NULL); |
236 |
|
237 |
int fd = open ("/dev/tty", O_WRONLY); |
238 |
if (fd < 0) |
239 |
return -1; /* fatal */ |
240 |
|
241 |
close (fd); |
242 |
|
243 |
return 0; |
244 |
} |
245 |
|
246 |
void |
247 |
rxvt_ptytty::close_tty () |
248 |
{ |
249 |
if (tty < 0) |
250 |
return; |
251 |
|
252 |
close (tty); |
253 |
tty = -1; |
254 |
} |
255 |
|
256 |
bool |
257 |
rxvt_ptytty::make_controlling_tty () |
258 |
{ |
259 |
return control_tty (tty) >= 0; |
260 |
} |
261 |
|
262 |
void |
263 |
rxvt_ptytty::set_utf8_mode (bool on) |
264 |
{ |
265 |
#ifdef IUTF8 |
266 |
if (pty < 0) |
267 |
return; |
268 |
|
269 |
struct termios tio; |
270 |
|
271 |
if (tcgetattr (pty, &tio) != -1) |
272 |
{ |
273 |
tcflag_t new_cflag = tio.c_iflag; |
274 |
|
275 |
if (on) |
276 |
new_cflag |= IUTF8; |
277 |
else |
278 |
new_cflag &= ~IUTF8; |
279 |
|
280 |
if (new_cflag != tio.c_iflag) |
281 |
{ |
282 |
tio.c_iflag = new_cflag; |
283 |
tcsetattr (pty, TCSANOW, &tio); |
284 |
} |
285 |
} |
286 |
#endif |
287 |
} |
288 |
|
289 |
static struct ttyconf { |
290 |
gid_t gid; |
291 |
mode_t mode; |
292 |
|
293 |
ttyconf () |
294 |
{ |
295 |
#ifdef TTY_GID_SUPPORT |
296 |
struct group *gr = getgrnam ("tty"); |
297 |
|
298 |
if (gr) |
299 |
{ /* change group ownership of tty to "tty" */ |
300 |
mode = S_IRUSR | S_IWUSR | S_IWGRP; |
301 |
gid = gr->gr_gid; |
302 |
} |
303 |
else |
304 |
#endif /* TTY_GID_SUPPORT */ |
305 |
{ |
306 |
mode = S_IRUSR | S_IWUSR | S_IWGRP | S_IWOTH; |
307 |
gid = 0; |
308 |
} |
309 |
} |
310 |
} ttyconf; |
311 |
|
312 |
rxvt_ptytty_unix::rxvt_ptytty_unix () |
313 |
{ |
314 |
name = 0; |
315 |
#if UTMP_SUPPORT |
316 |
cmd_pid = 0; |
317 |
#endif |
318 |
} |
319 |
|
320 |
rxvt_ptytty_unix::~rxvt_ptytty_unix () |
321 |
{ |
322 |
#if UTMP_SUPPORT |
323 |
logout (); |
324 |
#endif |
325 |
put (); |
326 |
} |
327 |
|
328 |
void |
329 |
rxvt_ptytty_unix::put () |
330 |
{ |
331 |
chmod (name, RESTORE_TTY_MODE); |
332 |
chown (name, 0, ttyconf.gid); |
333 |
|
334 |
close_tty (); |
335 |
|
336 |
if (pty >= 0) |
337 |
close (pty); |
338 |
|
339 |
free (name); |
340 |
|
341 |
pty = tty = -1; |
342 |
name = 0; |
343 |
} |
344 |
|
345 |
bool |
346 |
rxvt_ptytty_unix::get () |
347 |
{ |
348 |
/* get master (pty) */ |
349 |
if ((pty = get_pty (&tty, &name)) < 0) |
350 |
return false; |
351 |
|
352 |
fcntl (pty, F_SETFL, O_NONBLOCK); |
353 |
|
354 |
/* get slave (tty) */ |
355 |
if (tty < 0) |
356 |
{ |
357 |
#ifndef NO_SETOWNER_TTYDEV |
358 |
chown (name, getuid (), ttyconf.gid); /* fail silently */ |
359 |
chmod (name, ttyconf.mode); |
360 |
# ifdef HAVE_REVOKE |
361 |
revoke (name); |
362 |
# endif |
363 |
#endif |
364 |
|
365 |
if ((tty = get_tty (name)) < 0) |
366 |
{ |
367 |
put (); |
368 |
return false; |
369 |
} |
370 |
} |
371 |
|
372 |
return true; |
373 |
} |
374 |
|
375 |
#if PTYTTY_HELPER |
376 |
|
377 |
static int sock_fd; |
378 |
static int pid; |
379 |
|
380 |
struct command |
381 |
{ |
382 |
enum { get, login, destroy } type; |
383 |
|
384 |
rxvt_ptytty *id; |
385 |
|
386 |
bool login_shell; |
387 |
int cmd_pid; |
388 |
char hostname[512]; // arbitrary, but should be plenty |
389 |
}; |
390 |
|
391 |
struct rxvt_ptytty_proxy : zero_initialized, rxvt_ptytty |
392 |
{ |
393 |
rxvt_ptytty *id; |
394 |
|
395 |
~rxvt_ptytty_proxy (); |
396 |
|
397 |
bool get (); |
398 |
void login (int cmd_pid, bool login_shell, const char *hostname); |
399 |
}; |
400 |
|
401 |
bool |
402 |
rxvt_ptytty_proxy::get () |
403 |
{ |
404 |
command cmd; |
405 |
|
406 |
cmd.type = command::get; |
407 |
|
408 |
write (sock_fd, &cmd, sizeof (cmd)); |
409 |
|
410 |
if (read (sock_fd, &id, sizeof (id)) != sizeof (id)) |
411 |
rxvt_fatal ("protocol error while creating pty using helper process, aborting.\n"); |
412 |
|
413 |
if (!id) |
414 |
return false; |
415 |
|
416 |
if ((pty = rxvt_recv_fd (sock_fd)) < 0 |
417 |
|| (tty = rxvt_recv_fd (sock_fd)) < 0) |
418 |
rxvt_fatal ("protocol error while reading pty/tty fds from helper process, aborting.\n"); |
419 |
|
420 |
return true; |
421 |
} |
422 |
|
423 |
void |
424 |
rxvt_ptytty_proxy::login (int cmd_pid, bool login_shell, const char *hostname) |
425 |
{ |
426 |
command cmd; |
427 |
|
428 |
cmd.type = command::login; |
429 |
cmd.id = id; |
430 |
cmd.cmd_pid = cmd_pid; |
431 |
cmd.login_shell = login_shell; |
432 |
strncpy (cmd.hostname, hostname, sizeof (cmd.hostname)); |
433 |
|
434 |
write (sock_fd, &cmd, sizeof (cmd)); |
435 |
} |
436 |
|
437 |
rxvt_ptytty_proxy::~rxvt_ptytty_proxy () |
438 |
{ |
439 |
command cmd; |
440 |
|
441 |
cmd.type = command::destroy; |
442 |
cmd.id = id; |
443 |
|
444 |
write (sock_fd, &cmd, sizeof (cmd)); |
445 |
} |
446 |
|
447 |
static |
448 |
void serve () |
449 |
{ |
450 |
command cmd; |
451 |
vector<rxvt_ptytty *> ptys; |
452 |
|
453 |
while (read (sock_fd, &cmd, sizeof (command)) == sizeof (command)) |
454 |
{ |
455 |
if (cmd.type == command::get) |
456 |
{ |
457 |
// -> id ptyfd ttyfd |
458 |
cmd.id = new rxvt_ptytty_unix; |
459 |
|
460 |
if (cmd.id->get ()) |
461 |
{ |
462 |
write (sock_fd, &cmd.id, sizeof (cmd.id)); |
463 |
ptys.push_back (cmd.id); |
464 |
|
465 |
rxvt_send_fd (sock_fd, cmd.id->pty); |
466 |
rxvt_send_fd (sock_fd, cmd.id->tty); |
467 |
} |
468 |
else |
469 |
{ |
470 |
delete cmd.id; |
471 |
cmd.id = 0; |
472 |
write (sock_fd, &cmd.id, sizeof (cmd.id)); |
473 |
} |
474 |
} |
475 |
else if (cmd.type == command::login) |
476 |
{ |
477 |
#if UTMP_SUPPORT |
478 |
if (find (ptys.begin (), ptys.end (), cmd.id)) |
479 |
{ |
480 |
cmd.hostname[sizeof (cmd.hostname) - 1] = 0; |
481 |
cmd.id->login (cmd.cmd_pid, cmd.login_shell, cmd.hostname); |
482 |
} |
483 |
#endif |
484 |
} |
485 |
else if (cmd.type == command::destroy) |
486 |
{ |
487 |
rxvt_ptytty **pty = find (ptys.begin (), ptys.end (), cmd.id); |
488 |
|
489 |
if (pty) |
490 |
{ |
491 |
delete *pty; |
492 |
ptys.erase (pty); |
493 |
} |
494 |
} |
495 |
else |
496 |
break; |
497 |
} |
498 |
|
499 |
// destroy all ptys |
500 |
for (rxvt_ptytty **i = ptys.end (); i-- > ptys.begin (); ) |
501 |
delete *i; |
502 |
} |
503 |
|
504 |
void rxvt_ptytty_server () |
505 |
{ |
506 |
int sv[2]; |
507 |
|
508 |
if (socketpair (AF_UNIX, SOCK_STREAM, 0, sv)) |
509 |
rxvt_fatal ("could not create socket to communicate with pty/sessiondb helper, aborting.\n"); |
510 |
|
511 |
pid = fork (); |
512 |
|
513 |
if (pid < 0) |
514 |
rxvt_fatal ("could not create pty/sessiondb helper process, aborting.\n"); |
515 |
|
516 |
if (pid) |
517 |
{ |
518 |
// client, urxvt |
519 |
sock_fd = sv[0]; |
520 |
close (sv[1]); |
521 |
fcntl (sock_fd, F_SETFD, FD_CLOEXEC); |
522 |
} |
523 |
else |
524 |
{ |
525 |
// server, pty-helper |
526 |
sock_fd = sv[1]; |
527 |
|
528 |
for (int fd = 0; fd < 1023; fd++) |
529 |
if (fd != sock_fd) |
530 |
close (fd); |
531 |
|
532 |
serve (); |
533 |
_exit (EXIT_SUCCESS); |
534 |
} |
535 |
} |
536 |
|
537 |
#endif |
538 |
|
539 |
// a "factory" *g* |
540 |
rxvt_ptytty * |
541 |
rxvt_new_ptytty () |
542 |
{ |
543 |
#if PTYTTY_HELPER |
544 |
if (pid > 0) |
545 |
// use helper process |
546 |
return new rxvt_ptytty_proxy; |
547 |
else |
548 |
#endif |
549 |
return new rxvt_ptytty_unix; |
550 |
} |
551 |
|
552 |
/*----------------------- end-of-file (C source) -----------------------*/ |
553 |
|