libptytty/src/ptytty.C

// This file is part of libptytty. Do not make local modifications.
// http://software.schmorp.de/pkg/libptytty

/*----------------------------------------------------------------------*
 * File:        ptytty.C
 *----------------------------------------------------------------------*
 *
 * All portions of code are copyright by their respective author/s.
 * Copyright (c) 1999-2001 Geoff Wing <gcw@pobox.com>
 * Copyright (c) 2004-2006 Marc Lehmann <schmorp@schmorp.de>
 * Copyright (c) 2006      Emanuele Giaquinta <e.giaquinta@glauco.it>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *---------------------------------------------------------------------*/

#include "config.h"

#include "ptytty.h"

#include <cstdlib>
#include <cstring>
#include <csignal>

#include <sys/types.h>
#include <sys/stat.h>
#include <unistd.h>
#include <fcntl.h>

#ifdef HAVE_SYS_IOCTL_H
# include <sys/ioctl.h>
#endif
#if defined(HAVE_DEV_PTMX) && defined(HAVE_SYS_STROPTS_H)
# include <sys/stropts.h>      /* for I_PUSH */
#endif
#if defined(HAVE_ISASTREAM) && defined(HAVE_STROPTS_H)
# include <stropts.h>
#endif
#if defined(HAVE_PTY_H)
# include <pty.h>
#elif defined(HAVE_LIBUTIL_H)
# include <libutil.h>
#elif defined(HAVE_UTIL_H)
# include <util.h>
#endif
#ifdef TTY_GID_SUPPORT
#include <grp.h>
#endif

#include <cstdio>

/////////////////////////////////////////////////////////////////////////////

/* ------------------------------------------------------------------------- *
 *                  GET PSEUDO TELETYPE - MASTER AND SLAVE                   *
 * ------------------------------------------------------------------------- */
/*
 * Returns pty file descriptor, or -1 on failure
 * If successful, ttydev is set to the name of the slave device.
 * fd_tty _may_ also be set to an open fd to the slave device
 */
#if defined(UNIX98_PTY)

  static int
  get_pty (int *fd_tty, char **ttydev)
  {
    int pfd;

# if defined(HAVE_GETPT)
    pfd = getpt();
# elif defined(HAVE_POSIX_OPENPT)
    pfd = posix_openpt (O_RDWR);
# else
    pfd = open (CLONE_DEVICE, O_RDWR | O_NOCTTY, 0);
# endif

    if (pfd >= 0)
      {
        if (grantpt (pfd) == 0  /* change slave permissions */
            && unlockpt (pfd) == 0)
          {
            /* slave now unlocked */
            *ttydev = strdup (ptsname (pfd));   /* get slave's name */
            return pfd;
          }

        close (pfd);
      }

    return -1;
  }

#elif defined(HAVE_OPENPTY)

  static int
  get_pty (int *fd_tty, char **ttydev)
  {
    int pfd;
    int res;

    res = openpty (&pfd, fd_tty, NULL, NULL, NULL);

    if (res != -1)
      {
        *ttydev = strdup (ttyname (*fd_tty));
        return pfd;
      }

    return -1;
  }

#elif defined(HAVE__GETPTY)

  static int
  get_pty (int *fd_tty, char **ttydev)
  {
    int pfd;
    char *slave;

    slave = _getpty (&pfd, O_RDWR | O_NONBLOCK | O_NOCTTY, 0622, 0);

    if (slave != NULL)
      {
        *ttydev = strdup (slave);
        return pfd;
      }

    return -1;
  }

#else

  /* Based on the code in openssh/openbsd-compat/bsd-openpty.c */
  static int
  get_pty (int *fd_tty, char **ttydev)
  {
    int pfd;
    int i;
    char pty_name[32];
    char tty_name[32];
    const char *majors = "pqrstuvwxyzabcde";
    const char *minors = "0123456789abcdef";

    for (i = 0; i < 256; i++)
      {
        snprintf(pty_name, 32, "/dev/pty%c%c", majors[i / 16], minors[i % 16]);
        snprintf(tty_name, 32, "/dev/tty%c%c", majors[i / 16], minors[i % 16]);

        if ((pfd = open (pty_name, O_RDWR | O_NOCTTY, 0)) == -1)
          {
            snprintf(pty_name, 32, "/dev/ptyp%d", i);
            snprintf(tty_name, 32, "/dev/ttyp%d", i);
            if ((pfd = open (pty_name, O_RDWR | O_NOCTTY, 0)) == -1)
              continue;
          }

        if (access (tty_name, R_OK | W_OK) == 0)
          {
            *ttydev = strdup (tty_name);
            return pfd;
          }

        close (pfd);
      }

    return -1;
  }

#endif

/*----------------------------------------------------------------------*/
/*
 * Returns tty file descriptor, or -1 on failure
 */
static int
get_tty (char *ttydev)
{
  return open (ttydev, O_RDWR | O_NOCTTY, 0);
}

/*----------------------------------------------------------------------*/
/*
 * Make our tty a controlling tty so that /dev/tty points to us
 */
static int
control_tty (int fd_tty)
{
  int fd;

  setsid ();

#ifdef TIOCSCTTY
  ioctl (fd_tty, TIOCSCTTY, NULL);
#else
  fd = open (ttyname (fd_tty), O_RDWR);
  if (fd >= 0)
    close (fd);
#endif

  fd = open ("/dev/tty", O_WRONLY);
  if (fd < 0)
    return -1; /* fatal */

  close (fd);

  return 0;
}

void
ptytty::close_tty ()
{
  if (tty < 0)
    return;

  close (tty);
  tty = -1;
}

bool
ptytty::make_controlling_tty ()
{
  return control_tty (tty) >= 0;
}

void
ptytty::set_utf8_mode (bool on)
{
#ifdef IUTF8
  if (pty < 0)
    return;

  struct termios tio;

  if (tcgetattr (pty, &tio) != -1)
    {
      tcflag_t new_cflag = tio.c_iflag;

      if (on)
        new_cflag |= IUTF8;
      else
        new_cflag &= ~IUTF8;

      if (new_cflag != tio.c_iflag)
        {
          tio.c_iflag = new_cflag;
          tcsetattr (pty, TCSANOW, &tio);
        }
    }
#endif
}

static struct ttyconf {
  gid_t gid;
  mode_t mode;

  ttyconf ()
    {
#ifdef TTY_GID_SUPPORT
      struct group *gr = getgrnam ("tty");

      if (gr)
        {
          /* change group ownership of tty to "tty" */
          mode = S_IRUSR | S_IWUSR | S_IWGRP;
          gid = gr->gr_gid;
        }
      else
#endif /* TTY_GID_SUPPORT */
        {
          mode = S_IRUSR | S_IWUSR | S_IWGRP | S_IWOTH;
          gid = 0;
        }
    }
} ttyconf;

ptytty_unix::ptytty_unix ()
{
  name = 0;
#if UTMP_SUPPORT
  cmd_pid = 0;
#endif
}

ptytty_unix::~ptytty_unix ()
{
#if UTMP_SUPPORT
  logout ();
#endif
  put ();
}

void
ptytty_unix::put ()
{
  if (name)
    {
      chmod (name, RESTORE_TTY_MODE);
      chown (name, 0, ttyconf.gid);
    }

  close_tty ();

  if (pty >= 0)
    close (pty);

  free (name);

  pty = tty = -1;
  name = 0;
}

bool
ptytty_unix::get ()
{
  /* get master (pty) */
  if ((pty = get_pty (&tty, &name)) < 0)
    return false;

  fcntl (pty, F_SETFL, O_NONBLOCK);

  /* get slave (tty) */
  if (tty < 0)
    {
#ifndef NO_SETOWNER_TTYDEV
      chown (name, getuid (), ttyconf.gid);      /* fail silently */
      chmod (name, ttyconf.mode);
# ifdef HAVE_REVOKE
      revoke (name);
# endif
#endif

      if ((tty = get_tty (name)) < 0)
        {
          put ();
          return false;
        }
    }

#if defined(HAVE_DEV_PTMX) && defined(I_PUSH)
  /*
   * Push STREAMS modules:
   *    ptem: pseudo-terminal hardware emulation module.
   *    ldterm: standard terminal line discipline.
   *    ttcompat: V7, 4BSD and XENIX STREAMS compatibility module.
   *
   * After we push the STREAMS modules, the first open () on the slave side
   * should make the "ptem" (or "ldterm" depending upon either which OS
   * version or which set of manual pages you have) module give us a
   * controlling terminal.  We must already have close ()d the master side
   * fd in this child process before we push STREAMS modules on because the
   * documentation is really unclear about whether it is any close () on
   * the master side or the last close () - i.e. a proper STREAMS dismantling
   * close () - on the master side which causes a hang up to be sent
   * through - Geoff Wing
   */
#if defined(HAVE_ISASTREAM) && defined(HAVE_STROPTS_H)
  if (isastream (tty) == 1)
# endif
    {
      ioctl (tty, I_PUSH, "ptem");
      ioctl (tty, I_PUSH, "ldterm");
      ioctl (tty, I_PUSH, "ttcompat");
    }
#endif

  return true;
}

Revision:	1.39
Committed:	Thu Jun 9 14:14:48 2011 UTC (13 years, 1 month ago) by sf-exg
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-9_12, rel-1_4
Changes since 1.38:	+27 -28 lines
Log Message:	Push stream modules in ptytty::get rather than in ptytty::make_controlling_tty. This makes tty ioctls (such as TIOCSWINSZ, to set the window size) work even if make_controlling_tty has not been called.
#	Content
1	// This file is part of libptytty. Do not make local modifications.
2	// http://software.schmorp.de/pkg/libptytty
3
4	/----------------------------------------------------------------------
5	* File: ptytty.C
6	----------------------------------------------------------------------
7	*
8	* All portions of code are copyright by their respective author/s.
9	* Copyright (c) 1999-2001 Geoff Wing <gcw@pobox.com>
10	* Copyright (c) 2004-2006 Marc Lehmann <schmorp@schmorp.de>
11	* Copyright (c) 2006 Emanuele Giaquinta <e.giaquinta@glauco.it>
12	*
13	* This program is free software; you can redistribute it and/or modify
14	* it under the terms of the GNU General Public License as published by
15	* the Free Software Foundation; either version 2 of the License, or
16	* (at your option) any later version.
17	*
18	* This program is distributed in the hope that it will be useful,
19	* but WITHOUT ANY WARRANTY; without even the implied warranty of
20	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21	* GNU General Public License for more details.
22	*
23	* You should have received a copy of the GNU General Public License
24	* along with this program; if not, write to the Free Software
25	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26	---------------------------------------------------------------------/
27
28	#include "config.h"
29
30	#include "ptytty.h"
31
32	#include <cstdlib>
33	#include <cstring>
34	#include <csignal>
35
36	#include <sys/types.h>
37	#include <sys/stat.h>
38	#include <unistd.h>
39	#include <fcntl.h>
40
41	#ifdef HAVE_SYS_IOCTL_H
42	# include <sys/ioctl.h>
43	#endif
44	#if defined(HAVE_DEV_PTMX) && defined(HAVE_SYS_STROPTS_H)
45	# include <sys/stropts.h> /* for I_PUSH */
46	#endif
47	#if defined(HAVE_ISASTREAM) && defined(HAVE_STROPTS_H)
48	# include <stropts.h>
49	#endif
50	#if defined(HAVE_PTY_H)
51	# include <pty.h>
52	#elif defined(HAVE_LIBUTIL_H)
53	# include <libutil.h>
54	#elif defined(HAVE_UTIL_H)
55	# include <util.h>
56	#endif
57	#ifdef TTY_GID_SUPPORT
58	#include <grp.h>
59	#endif
60
61	#include <cstdio>
62
63	/////////////////////////////////////////////////////////////////////////////
64
65	/* ------------------------------------------------------------------------- *
66	* GET PSEUDO TELETYPE - MASTER AND SLAVE *
67	* ------------------------------------------------------------------------- */
68	/*
69	* Returns pty file descriptor, or -1 on failure
70	* If successful, ttydev is set to the name of the slave device.
71	* fd_tty _may_ also be set to an open fd to the slave device
72	*/
73	#if defined(UNIX98_PTY)
74
75	static int
76	get_pty (int fd_tty, char *ttydev)
77	{
78	int pfd;
79
80	# if defined(HAVE_GETPT)
81	pfd = getpt();
82	# elif defined(HAVE_POSIX_OPENPT)
83	pfd = posix_openpt (O_RDWR);
84	# else
85	pfd = open (CLONE_DEVICE, O_RDWR \| O_NOCTTY, 0);
86	# endif
87
88	if (pfd >= 0)
89	{
90	if (grantpt (pfd) == 0 /* change slave permissions */
91	&& unlockpt (pfd) == 0)
92	{
93	/* slave now unlocked */
94	ttydev = strdup (ptsname (pfd)); / get slave's name */
95	return pfd;
96	}
97
98	close (pfd);
99	}
100
101	return -1;
102	}
103
104	#elif defined(HAVE_OPENPTY)
105
106	static int
107	get_pty (int fd_tty, char *ttydev)
108	{
109	int pfd;
110	int res;
111
112	res = openpty (&pfd, fd_tty, NULL, NULL, NULL);
113
114	if (res != -1)
115	{
116	ttydev = strdup (ttyname (fd_tty));
117	return pfd;
118	}
119
120	return -1;
121	}
122
123	#elif defined(HAVE__GETPTY)
124
125	static int
126	get_pty (int fd_tty, char *ttydev)
127	{
128	int pfd;
129	char *slave;
130
131	slave = _getpty (&pfd, O_RDWR \| O_NONBLOCK \| O_NOCTTY, 0622, 0);
132
133	if (slave != NULL)
134	{
135	*ttydev = strdup (slave);
136	return pfd;
137	}
138
139	return -1;
140	}
141
142	#else
143
144	/* Based on the code in openssh/openbsd-compat/bsd-openpty.c */
145	static int
146	get_pty (int fd_tty, char *ttydev)
147	{
148	int pfd;
149	int i;
150	char pty_name[32];
151	char tty_name[32];
152	const char *majors = "pqrstuvwxyzabcde";
153	const char *minors = "0123456789abcdef";
154
155	for (i = 0; i < 256; i++)
156	{
157	snprintf(pty_name, 32, "/dev/pty%c%c", majors[i / 16], minors[i % 16]);
158	snprintf(tty_name, 32, "/dev/tty%c%c", majors[i / 16], minors[i % 16]);
159
160	if ((pfd = open (pty_name, O_RDWR \| O_NOCTTY, 0)) == -1)
161	{
162	snprintf(pty_name, 32, "/dev/ptyp%d", i);
163	snprintf(tty_name, 32, "/dev/ttyp%d", i);
164	if ((pfd = open (pty_name, O_RDWR \| O_NOCTTY, 0)) == -1)
165	continue;
166	}
167
168	if (access (tty_name, R_OK \| W_OK) == 0)
169	{
170	*ttydev = strdup (tty_name);
171	return pfd;
172	}
173
174	close (pfd);
175	}
176
177	return -1;
178	}
179
180	#endif
181
182	/----------------------------------------------------------------------/
183	/*
184	* Returns tty file descriptor, or -1 on failure
185	*/
186	static int
187	get_tty (char *ttydev)
188	{
189	return open (ttydev, O_RDWR \| O_NOCTTY, 0);
190	}
191
192	/----------------------------------------------------------------------/
193	/*
194	* Make our tty a controlling tty so that /dev/tty points to us
195	*/
196	static int
197	control_tty (int fd_tty)
198	{
199	int fd;
200
201	setsid ();
202
203	#ifdef TIOCSCTTY
204	ioctl (fd_tty, TIOCSCTTY, NULL);
205	#else
206	fd = open (ttyname (fd_tty), O_RDWR);
207	if (fd >= 0)
208	close (fd);
209	#endif
210
211	fd = open ("/dev/tty", O_WRONLY);
212	if (fd < 0)
213	return -1; /* fatal */
214
215	close (fd);
216
217	return 0;
218	}
219
220	void
221	ptytty::close_tty ()
222	{
223	if (tty < 0)
224	return;
225
226	close (tty);
227	tty = -1;
228	}
229
230	bool
231	ptytty::make_controlling_tty ()
232	{
233	return control_tty (tty) >= 0;
234	}
235
236	void
237	ptytty::set_utf8_mode (bool on)
238	{
239	#ifdef IUTF8
240	if (pty < 0)
241	return;
242
243	struct termios tio;
244
245	if (tcgetattr (pty, &tio) != -1)
246	{
247	tcflag_t new_cflag = tio.c_iflag;
248
249	if (on)
250	new_cflag \|= IUTF8;
251	else
252	new_cflag &= ~IUTF8;
253
254	if (new_cflag != tio.c_iflag)
255	{
256	tio.c_iflag = new_cflag;
257	tcsetattr (pty, TCSANOW, &tio);
258	}
259	}
260	#endif
261	}
262
263	static struct ttyconf {
264	gid_t gid;
265	mode_t mode;
266
267	ttyconf ()
268	{
269	#ifdef TTY_GID_SUPPORT
270	struct group *gr = getgrnam ("tty");
271
272	if (gr)
273	{
274	/* change group ownership of tty to "tty" */
275	mode = S_IRUSR \| S_IWUSR \| S_IWGRP;
276	gid = gr->gr_gid;
277	}
278	else
279	#endif /* TTY_GID_SUPPORT */
280	{
281	mode = S_IRUSR \| S_IWUSR \| S_IWGRP \| S_IWOTH;
282	gid = 0;
283	}
284	}
285	} ttyconf;
286
287	ptytty_unix::ptytty_unix ()
288	{
289	name = 0;
290	#if UTMP_SUPPORT
291	cmd_pid = 0;
292	#endif
293	}
294
295	ptytty_unix::~ptytty_unix ()
296	{
297	#if UTMP_SUPPORT
298	logout ();
299	#endif
300	put ();
301	}
302
303	void
304	ptytty_unix::put ()
305	{
306	if (name)
307	{
308	chmod (name, RESTORE_TTY_MODE);
309	chown (name, 0, ttyconf.gid);
310	}
311
312	close_tty ();
313
314	if (pty >= 0)
315	close (pty);
316
317	free (name);
318
319	pty = tty = -1;
320	name = 0;
321	}
322
323	bool
324	ptytty_unix::get ()
325	{
326	/* get master (pty) */
327	if ((pty = get_pty (&tty, &name)) < 0)
328	return false;
329
330	fcntl (pty, F_SETFL, O_NONBLOCK);
331
332	/* get slave (tty) */
333	if (tty < 0)
334	{
335	#ifndef NO_SETOWNER_TTYDEV
336	chown (name, getuid (), ttyconf.gid); /* fail silently */
337	chmod (name, ttyconf.mode);
338	# ifdef HAVE_REVOKE
339	revoke (name);
340	# endif
341	#endif
342
343	if ((tty = get_tty (name)) < 0)
344	{
345	put ();
346	return false;
347	}
348	}
349
350	#if defined(HAVE_DEV_PTMX) && defined(I_PUSH)
351	/*
352	* Push STREAMS modules:
353	* ptem: pseudo-terminal hardware emulation module.
354	* ldterm: standard terminal line discipline.
355	* ttcompat: V7, 4BSD and XENIX STREAMS compatibility module.
356	*
357	* After we push the STREAMS modules, the first open () on the slave side
358	* should make the "ptem" (or "ldterm" depending upon either which OS
359	* version or which set of manual pages you have) module give us a
360	* controlling terminal. We must already have close ()d the master side
361	* fd in this child process before we push STREAMS modules on because the
362	* documentation is really unclear about whether it is any close () on
363	* the master side or the last close () - i.e. a proper STREAMS dismantling
364	* close () - on the master side which causes a hang up to be sent
365	* through - Geoff Wing
366	*/
367	#if defined(HAVE_ISASTREAM) && defined(HAVE_STROPTS_H)
368	if (isastream (tty) == 1)
369	# endif
370	{
371	ioctl (tty, I_PUSH, "ptem");
372	ioctl (tty, I_PUSH, "ldterm");
373	ioctl (tty, I_PUSH, "ttcompat");
374	}
375	#endif
376
377	return true;
378	}
379