blob: 13d8e6026cc3c5d318dac96cdc60f03fdca7da2a [file] [log] [blame]
Damien Millerd4a8b7e1999-10-27 13:42:43 +10001/*
Damien Miller95def091999-11-25 00:26:21 +11002 * Author: Tatu Ylonen <ylo@cs.hut.fi>
Damien Miller95def091999-11-25 00:26:21 +11003 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
4 * All rights reserved
Damien Miller95def091999-11-25 00:26:21 +11005 * Functions for allocating a pseudo-terminal and making it the controlling
6 * tty.
Damien Millere4340be2000-09-16 13:29:08 +11007 *
8 * As far as I am concerned, the code I have written for this software
9 * can be used freely for any purpose. Any derived versions of this
10 * software must be clearly marked as such, and if the derived work is
11 * incompatible with the protocol description in the RFC file, it must be
12 * called by a name other than "ssh" or "Secure Shell".
Damien Miller95def091999-11-25 00:26:21 +110013 */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100014
Damien Millere4340be2000-09-16 13:29:08 +110015/* RCSID("$OpenBSD: pty.h,v 1.8 2000/09/07 20:27:52 deraadt Exp $"); */
Damien Millerd4a8b7e1999-10-27 13:42:43 +100016
17#ifndef PTY_H
18#define PTY_H
19
Damien Miller5428f641999-11-25 11:54:57 +110020/*
21 * Allocates and opens a pty. Returns 0 if no pty could be allocated, or
22 * nonzero if a pty was successfully allocated. On success, open file
23 * descriptors for the pty and tty sides and the name of the tty side are
24 * returned (the buffer must be able to hold at least 64 characters).
25 */
Damien Miller037a0dc1999-12-07 15:38:31 +110026int pty_allocate(int *ptyfd, int *ttyfd, char *ttyname, int ttynamelen);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100027
Damien Miller5428f641999-11-25 11:54:57 +110028/*
29 * Releases the tty. Its ownership is returned to root, and permissions to
30 * 0666.
31 */
Damien Miller95def091999-11-25 00:26:21 +110032void pty_release(const char *ttyname);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100033
Damien Miller5428f641999-11-25 11:54:57 +110034/*
35 * Makes the tty the processes controlling tty and sets it to sane modes.
36 * This may need to reopen the tty to get rid of possible eavesdroppers.
37 */
Damien Miller95def091999-11-25 00:26:21 +110038void pty_make_controlling_tty(int *ttyfd, const char *ttyname);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100039
40/* Changes the window size associated with the pty. */
Damien Miller4af51302000-04-16 11:18:38 +100041void
Damien Miller95def091999-11-25 00:26:21 +110042pty_change_window_size(int ptyfd, int row, int col,
43 int xpixel, int ypixel);
Damien Millerd4a8b7e1999-10-27 13:42:43 +100044
Damien Millerc7d8dbb2000-03-02 23:30:53 +110045void pty_setowner(struct passwd *pw, const char *ttyname);
46
Damien Miller95def091999-11-25 00:26:21 +110047#endif /* PTY_H */