ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/ptytty.C
Revision: 1.49
Committed: Thu Jan 19 16:40:42 2006 UTC (18 years, 4 months ago) by ayin
Content type: text/plain
Branch: MAIN
Changes since 1.48: +10 -32 lines
Log Message:
*** empty log message ***

File Contents

# User Rev Content
1 pcg 1.1 /*--------------------------------*-C-*---------------------------------*
2 pcg 1.11 * File: ptytty.C
3 pcg 1.1 *----------------------------------------------------------------------*
4     *
5     * All portions of code are copyright by their respective author/s.
6     * Copyright (c) 1999-2001 Geoff Wing <gcw@pobox.com>
7 root 1.30 * Copyright (c) 2004-2006 Marc Lehmann <pcg@goof.com>
8 pcg 1.1 *
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 root 1.16 #include "rxvt.h"
26 pcg 1.1
27 root 1.40 #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 root 1.31
35 pcg 1.1 #ifdef HAVE_SYS_IOCTL_H
36     # include <sys/ioctl.h>
37     #endif
38 root 1.12 #if defined(PTYS_ARE_PTMX) && defined(HAVE_SYS_STROPTS_H)
39 pcg 1.1 # include <sys/stropts.h> /* for I_PUSH */
40     #endif
41 pcg 1.10 #ifdef HAVE_ISASTREAM
42     # include <stropts.h>
43     #endif
44 root 1.31 #if defined(HAVE_PTY_H)
45 root 1.22 # include <pty.h>
46 root 1.31 #elif defined(HAVE_LIBUTIL_H)
47 root 1.16 # include <libutil.h>
48 root 1.31 #elif defined(HAVE_UTIL_H)
49 root 1.17 # include <util.h>
50 pcg 1.1 #endif
51    
52 root 1.16 #include <cstdio>
53     #include <grp.h>
54    
55 root 1.40 #include "rxvtutil.h"
56     #include "fdpass.h"
57 root 1.39 #include "ptytty.h"
58    
59 root 1.36 /////////////////////////////////////////////////////////////////////////////
60    
61 pcg 1.1 /* ------------------------------------------------------------------------- *
62     * GET PSEUDO TELETYPE - MASTER AND SLAVE *
63     * ------------------------------------------------------------------------- */
64     /*
65     * Returns pty file descriptor, or -1 on failure
66     * If successful, ttydev is set to the name of the slave device.
67     * fd_tty _may_ also be set to an open fd to the slave device
68     */
69 ayin 1.44 static inline int
70     get_pty_streams (int *fd_tty, char **ttydev)
71 pcg 1.1 {
72 ayin 1.49 #if defined(HAVE_GRANTPT) && defined(HAVE_UNLOCKPT)
73     # if defined(PTYS_ARE_GETPT) || defined(PTYS_ARE_POSIX) || defined(PTYS_ARE_PTMX)
74 pcg 1.4 int pfd;
75 pcg 1.1
76 root 1.45 # if defined(PTYS_ARE_GETPT)
77 ayin 1.44 pfd = getpt();
78 root 1.45 # elif defined(PTYS_ARE_POSIX)
79 ayin 1.44 pfd = posix_openpt (O_RDWR);
80     # else
81     pfd = open ("/dev/ptmx", O_RDWR | O_NOCTTY, 0);
82     # endif
83     if (pfd >= 0)
84     {
85     if (grantpt (pfd) == 0 /* change slave permissions */
86     && unlockpt (pfd) == 0)
87     { /* slave now unlocked */
88     *ttydev = strdup (ptsname (pfd)); /* get slave's name */
89     return pfd;
90     }
91 root 1.45
92 ayin 1.44 close (pfd);
93     }
94 ayin 1.49 # endif
95 ayin 1.44 #endif
96 root 1.45
97 ayin 1.44 return -1;
98     }
99    
100     static inline int
101     get_pty_openpty (int *fd_tty, char **ttydev)
102     {
103 pcg 1.1 #ifdef PTYS_ARE_OPENPTY
104 ayin 1.44 int pfd;
105     int res;
106 root 1.26 char tty_name[sizeof "/dev/pts/????\0"];
107 ayin 1.44
108     res = openpty (&pfd, fd_tty, tty_name, NULL, NULL);
109 root 1.27 if (res != -1)
110 pcg 1.4 {
111 pcg 1.6 *ttydev = strdup (tty_name);
112 pcg 1.4 return pfd;
113 pcg 1.1 }
114     #endif
115 root 1.45
116 ayin 1.44 return -1;
117     }
118 pcg 1.1
119 ayin 1.44 static inline int
120     get_pty__getpty (int *fd_tty, char **ttydev)
121     {
122 pcg 1.1 #ifdef PTYS_ARE__GETPTY
123 ayin 1.44 int pfd;
124    
125 pcg 1.6 *ttydev = _getpty (&pfd, O_RDWR | O_NONBLOCK | O_NOCTTY, 0622, 0);
126 pcg 1.4 if (*ttydev != NULL)
127     return pfd;
128 pcg 1.1 #endif
129 root 1.45
130 ayin 1.44 return -1;
131     }
132 pcg 1.1
133 ayin 1.44 static inline int
134     get_pty_ptc (int *fd_tty, char **ttydev)
135     {
136     #ifdef PTYS_ARE_PTC
137     int pfd;
138 pcg 1.4
139 pcg 1.6 if ((pfd = open ("/dev/ptc", O_RDWR | O_NOCTTY, 0)) >= 0)
140 pcg 1.4 {
141 root 1.16 *ttydev = strdup (ttyname (pfd));
142 pcg 1.4 return pfd;
143 pcg 1.1 }
144     #endif
145 root 1.45
146 ayin 1.44 return -1;
147     }
148 pcg 1.1
149 ayin 1.44 static inline int
150     get_pty_clone (int *fd_tty, char **ttydev)
151     {
152 pcg 1.1 #ifdef PTYS_ARE_CLONE
153 ayin 1.44 int pfd;
154    
155 pcg 1.6 if ((pfd = open ("/dev/ptym/clone", O_RDWR | O_NOCTTY, 0)) >= 0)
156 pcg 1.4 {
157 root 1.16 *ttydev = strdup (ptsname (pfd));
158 pcg 1.4 return pfd;
159 pcg 1.1 }
160     #endif
161 root 1.45
162 ayin 1.44 return -1;
163     }
164 pcg 1.1
165 ayin 1.44 static inline int
166     get_pty_numeric (int *fd_tty, char **ttydev)
167     {
168 pcg 1.1 #ifdef PTYS_ARE_NUMERIC
169 root 1.45 int pfd;
170     int idx;
171     char *c1, *c2;
172     char pty_name[] = "/dev/ptyp???";
173     char tty_name[] = "/dev/ttyp???";
174    
175     c1 = &(pty_name[sizeof (pty_name) - 4]);
176     c2 = &(tty_name[sizeof (tty_name) - 4]);
177    
178     for (idx = 0; idx < 256; idx++)
179     {
180     sprintf (c1, "%d", idx);
181     sprintf (c2, "%d", idx);
182    
183     if (access (tty_name, F_OK) < 0)
184     {
185     idx = 256;
186     break;
187     }
188    
189     if ((pfd = open (pty_name, O_RDWR | O_NOCTTY, 0)) >= 0)
190     {
191     if (access (tty_name, R_OK | W_OK) == 0)
192     {
193     *ttydev = strdup (tty_name);
194     return pfd;
195     }
196    
197     close (pfd);
198     }
199     }
200 pcg 1.1 #endif
201 root 1.45
202     return -1;
203 ayin 1.44 }
204 root 1.16
205 ayin 1.44 static inline int
206     get_pty_searched (int *fd_tty, char **ttydev)
207     {
208 pcg 1.1 #ifdef PTYS_ARE_SEARCHED
209     # ifndef PTYCHAR1
210     # define PTYCHAR1 "pqrstuvwxyz"
211     # endif
212     # ifndef PTYCHAR2
213     # define PTYCHAR2 "0123456789abcdef"
214     # endif
215 root 1.45 int pfd;
216     const char *c1, *c2;
217     char pty_name[] = "/dev/pty??";
218     char tty_name[] = "/dev/tty??";
219    
220     for (c1 = PTYCHAR1; *c1; c1++)
221     {
222     pty_name[ (sizeof (pty_name) - 3)] =
223     tty_name[ (sizeof (pty_name) - 3)] = *c1;
224    
225     for (c2 = PTYCHAR2; *c2; c2++)
226     {
227     pty_name[ (sizeof (pty_name) - 2)] =
228     tty_name[ (sizeof (pty_name) - 2)] = *c2;
229    
230     if ((pfd = open (pty_name, O_RDWR | O_NOCTTY, 0)) >= 0)
231     {
232     if (access (tty_name, R_OK | W_OK) == 0)
233     {
234     *ttydev = strdup (tty_name);
235     return pfd;
236     }
237    
238     close (pfd);
239     }
240     }
241     }
242 pcg 1.1 #endif
243 root 1.45
244     return -1;
245 ayin 1.44 }
246 root 1.16
247 ayin 1.44 static int
248     get_pty (int *fd_tty, char **ttydev)
249     {
250     int pfd;
251    
252     if ((pfd = get_pty_streams (fd_tty, ttydev)) != -1
253     || (pfd = get_pty_openpty (fd_tty, ttydev)) != -1
254     || (pfd = get_pty__getpty (fd_tty, ttydev)) != -1
255     || (pfd = get_pty_ptc (fd_tty, ttydev)) != -1
256     || (pfd = get_pty_clone (fd_tty, ttydev)) != -1
257     || (pfd = get_pty_numeric (fd_tty, ttydev)) != -1
258     || (pfd = get_pty_searched (fd_tty, ttydev)) != -1)
259     return pfd;
260 root 1.45
261 pcg 1.4 return -1;
262 pcg 1.1 }
263    
264     /*----------------------------------------------------------------------*/
265     /*
266     * Returns tty file descriptor, or -1 on failure
267     */
268 root 1.16 static int
269     get_tty (char *ttydev)
270 pcg 1.1 {
271 pcg 1.4 return open (ttydev, O_RDWR | O_NOCTTY, 0);
272 pcg 1.1 }
273    
274     /*----------------------------------------------------------------------*/
275     /*
276     * Make our tty a controlling tty so that /dev/tty points to us
277     */
278 root 1.16 static int
279 root 1.36 control_tty (int fd_tty)
280 pcg 1.1 {
281 pcg 1.4 setsid ();
282 root 1.16
283 root 1.47 #if defined(PTYS_ARE_PTMX) && defined(I_PUSH)
284 pcg 1.4 /*
285     * Push STREAMS modules:
286     * ptem: pseudo-terminal hardware emulation module.
287     * ldterm: standard terminal line discipline.
288     * ttcompat: V7, 4BSD and XENIX STREAMS compatibility module.
289     *
290 pcg 1.6 * After we push the STREAMS modules, the first open () on the slave side
291 pcg 1.4 * (i.e. the next section between the dashes giving us "tty opened OK")
292     * should make the "ptem" (or "ldterm" depending upon either which OS
293     * version or which set of manual pages you have) module give us a
294 pcg 1.6 * controlling terminal. We must already have close ()d the master side
295 pcg 1.4 * fd in this child process before we push STREAMS modules on because the
296 pcg 1.6 * documentation is really unclear about whether it is any close () on
297     * the master side or the last close () - i.e. a proper STREAMS dismantling
298     * close () - on the master side which causes a hang up to be sent
299 pcg 1.4 * through - Geoff Wing
300     */
301 root 1.47 # ifdef HAVE_ISASTREAM
302 pcg 1.4 if (isastream (fd_tty) == 1)
303 root 1.47 # endif
304 pcg 1.1 {
305 pcg 1.4 ioctl (fd_tty, I_PUSH, "ptem");
306     ioctl (fd_tty, I_PUSH, "ldterm");
307     ioctl (fd_tty, I_PUSH, "ttcompat");
308 pcg 1.1 }
309 root 1.47 #endif
310 root 1.45
311     ioctl (fd_tty, TIOCSCTTY, NULL);
312    
313     int fd = open ("/dev/tty", O_WRONLY);
314 pcg 1.4 if (fd < 0)
315     return -1; /* fatal */
316 root 1.45
317 pcg 1.4 close (fd);
318    
319     return 0;
320 pcg 1.1 }
321 root 1.16
322 root 1.36 void
323     rxvt_ptytty::close_tty ()
324     {
325     if (tty < 0)
326     return;
327    
328     close (tty);
329     tty = -1;
330     }
331    
332     bool
333     rxvt_ptytty::make_controlling_tty ()
334     {
335     return control_tty (tty) >= 0;
336     }
337    
338     void
339     rxvt_ptytty::set_utf8_mode (bool on)
340     {
341     #ifdef IUTF8
342     if (pty < 0)
343     return;
344    
345     struct termios tio;
346    
347     if (tcgetattr (pty, &tio) != -1)
348     {
349     tcflag_t new_cflag = tio.c_iflag;
350    
351     if (on)
352     new_cflag |= IUTF8;
353     else
354     new_cflag &= ~IUTF8;
355    
356     if (new_cflag != tio.c_iflag)
357     {
358     tio.c_iflag = new_cflag;
359     tcsetattr (pty, TCSANOW, &tio);
360     }
361     }
362     #endif
363     }
364    
365 root 1.16 static struct ttyconf {
366     gid_t gid;
367     mode_t mode;
368    
369     ttyconf ()
370     {
371     #ifdef TTY_GID_SUPPORT
372     struct group *gr = getgrnam ("tty");
373    
374     if (gr)
375     { /* change group ownership of tty to "tty" */
376     mode = S_IRUSR | S_IWUSR | S_IWGRP;
377     gid = gr->gr_gid;
378     }
379     else
380     #endif /* TTY_GID_SUPPORT */
381     {
382     mode = S_IRUSR | S_IWUSR | S_IWGRP | S_IWOTH;
383 ayin 1.48 gid = 0;
384 root 1.16 }
385     }
386     } ttyconf;
387    
388 root 1.36 rxvt_ptytty_unix::rxvt_ptytty_unix ()
389 root 1.16 {
390     pty = tty = -1;
391     name = 0;
392 root 1.35 #if UTMP_SUPPORT
393     cmd_pid = 0;
394     #endif
395 root 1.16 }
396    
397 root 1.36 rxvt_ptytty_unix::~rxvt_ptytty_unix ()
398 root 1.16 {
399 root 1.43 #if UTMP_SUPPORT
400 root 1.35 logout ();
401 root 1.43 #endif
402 root 1.16 put ();
403     }
404    
405     void
406 root 1.36 rxvt_ptytty_unix::put ()
407 root 1.16 {
408 ayin 1.49 chmod (name, RESTORE_TTY_MODE);
409     chown (name, 0, ttyconf.gid);
410 root 1.16
411     if (pty >= 0) close (pty);
412     close_tty ();
413     free (name);
414    
415     pty = tty = -1;
416     name = 0;
417     }
418    
419     bool
420 root 1.36 rxvt_ptytty_unix::get ()
421 root 1.16 {
422     /* get master (pty) */
423     if ((pty = get_pty (&tty, &name)) < 0)
424     return false;
425    
426     fcntl (pty, F_SETFL, O_NONBLOCK);
427    
428     /* get slave (tty) */
429     if (tty < 0)
430     {
431     #ifndef NO_SETOWNER_TTYDEV
432 ayin 1.49 chown (name, getuid (), ttyconf.gid); /* fail silently */
433     chmod (name, ttyconf.mode);
434     # ifdef HAVE_REVOKE
435     revoke (name);
436     # endif
437 root 1.16 #endif
438    
439     if ((tty = get_tty (name)) < 0)
440     {
441     put ();
442     return false;
443     }
444     }
445    
446     return true;
447     }
448    
449 root 1.40 #if PTYTTY_HELPER
450    
451     static int sock_fd;
452     static int pid;
453    
454     struct command
455     {
456     enum { get, login, destroy } type;
457    
458     rxvt_ptytty *id;
459    
460     bool login_shell;
461     int cmd_pid;
462     char hostname[512]; // arbitrary, but should be plenty
463     };
464    
465     struct rxvt_ptytty_proxy : zero_initialized, rxvt_ptytty
466     {
467     rxvt_ptytty *id;
468    
469     ~rxvt_ptytty_proxy ();
470    
471     bool get ();
472     void login (int cmd_pid, bool login_shell, const char *hostname);
473     };
474    
475     bool
476     rxvt_ptytty_proxy::get ()
477     {
478     command cmd;
479    
480     cmd.type = command::get;
481    
482     write (sock_fd, &cmd, sizeof (cmd));
483    
484     if (read (sock_fd, &id, sizeof (id)) != sizeof (id))
485     rxvt_fatal ("protocol error while creating pty using helper process, aborting.\n");
486    
487     if (!id)
488     return false;
489    
490     if ((pty = rxvt_recv_fd (sock_fd)) < 0
491     || (tty = rxvt_recv_fd (sock_fd)) < 0)
492     rxvt_fatal ("protocol error while reading pty/tty fds from helper process, aborting.\n");
493    
494     return true;
495     }
496    
497     void
498     rxvt_ptytty_proxy::login (int cmd_pid, bool login_shell, const char *hostname)
499     {
500     command cmd;
501    
502     cmd.type = command::login;
503     cmd.id = id;
504     cmd.cmd_pid = cmd_pid;
505     cmd.login_shell = login_shell;
506     strncpy (cmd.hostname, hostname, sizeof (cmd.hostname));
507    
508     write (sock_fd, &cmd, sizeof (cmd));
509     }
510    
511     rxvt_ptytty_proxy::~rxvt_ptytty_proxy ()
512     {
513     command cmd;
514    
515     cmd.type = command::destroy;
516     cmd.id = id;
517    
518     write (sock_fd, &cmd, sizeof (cmd));
519     }
520    
521     static
522     void serve ()
523     {
524     command cmd;
525     vector<rxvt_ptytty *> ptys;
526    
527     while (read (sock_fd, &cmd, sizeof (command)) == sizeof (command))
528     {
529     if (cmd.type == command::get)
530     {
531     // -> id ptyfd ttyfd
532     cmd.id = new rxvt_ptytty_unix;
533    
534     if (cmd.id->get ())
535     {
536     write (sock_fd, &cmd.id, sizeof (cmd.id));
537     ptys.push_back (cmd.id);
538    
539     rxvt_send_fd (sock_fd, cmd.id->pty);
540     rxvt_send_fd (sock_fd, cmd.id->tty);
541     }
542     else
543     {
544     delete cmd.id;
545     cmd.id = 0;
546     write (sock_fd, &cmd.id, sizeof (cmd.id));
547     }
548     }
549     else if (cmd.type == command::login)
550     {
551 root 1.43 #if UTMP_SUPPORT
552 root 1.40 if (find (ptys.begin (), ptys.end (), cmd.id))
553     {
554     cmd.hostname[sizeof (cmd.hostname) - 1] = 0;
555     cmd.id->login (cmd.cmd_pid, cmd.login_shell, cmd.hostname);
556     }
557 root 1.43 #endif
558 root 1.40 }
559     else if (cmd.type == command::destroy)
560     {
561     rxvt_ptytty **pty = find (ptys.begin (), ptys.end (), cmd.id);
562    
563 root 1.42 if (pty)
564 root 1.40 {
565 root 1.42 delete *pty;
566 root 1.40 ptys.erase (pty);
567     }
568     }
569     else
570     break;
571     }
572    
573     // destroy all ptys
574     for (rxvt_ptytty **i = ptys.end (); i-- > ptys.begin (); )
575     delete *i;
576     }
577    
578     void rxvt_ptytty_server ()
579     {
580     int sv[2];
581    
582     if (socketpair (AF_UNIX, SOCK_STREAM, 0, sv))
583     rxvt_fatal ("could not create socket to communicate with pty/sessiondb helper, aborting.\n");
584    
585     pid = fork ();
586    
587     if (pid < 0)
588     rxvt_fatal ("could not create pty/sessiondb helper process, aborting.\n");
589    
590     if (pid)
591     {
592     // client, urxvt
593     sock_fd = sv[0];
594     close (sv[1]);
595     fcntl (sock_fd, F_SETFD, FD_CLOEXEC);
596     }
597     else
598     {
599     // server, pty-helper
600     sock_fd = sv[1];
601    
602 root 1.41 for (int fd = 0; fd < 1023; fd++)
603 root 1.46 if (fd != sock_fd)
604 root 1.41 close (fd);
605 root 1.40
606     serve ();
607     _exit (EXIT_SUCCESS);
608     }
609     }
610     #endif
611    
612 root 1.39 // a "factory" *g*
613 root 1.40 rxvt_ptytty *
614     rxvt_new_ptytty ()
615 root 1.39 {
616 root 1.40 #if PTYTTY_HELPER
617     if (pid > 0)
618 root 1.41 // use helper process
619     return new rxvt_ptytty_proxy;
620 root 1.40 else
621     #endif
622     return new rxvt_ptytty_unix;
623 root 1.39 }
624    
625 pcg 1.1 /*----------------------- end-of-file (C source) -----------------------*/
626 root 1.16