[openssh.git] / ttymodes.c

/*
 * Author: Tatu Ylonen <ylo@cs.hut.fi>
 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
 *                    All rights reserved
 * Encoding and decoding of terminal modes in a portable way.
 * Much of the format is defined in ttymodes.h; it is included multiple times
 * into this file with the appropriate macro definitions to generate the
 * suitable code.
 *
 * As far as I am concerned, the code I have written for this software
 * can be used freely for any purpose.  Any derived versions of this
 * software must be clearly marked as such, and if the derived work is
 * incompatible with the protocol description in the RFC file, it must be
 * called by a name other than "ssh" or "Secure Shell".
 */

#include "includes.h"
RCSID("$OpenBSD: ttymodes.c,v 1.11 2001/03/10 15:02:05 stevesk Exp $");

#include "packet.h"
#include "log.h"
#include "ssh1.h"

#define TTY_OP_END	0
#define TTY_OP_ISPEED	192	/* int follows */
#define TTY_OP_OSPEED	193	/* int follows */

/*
 * Converts POSIX speed_t to a baud rate.  The values of the
 * constants for speed_t are not themselves portable.
 */
static int
speed_to_baud(speed_t speed)
{
	switch (speed) {
	case B0:
		return 0;
	case B50:
		return 50;
	case B75:
		return 75;
	case B110:
		return 110;
	case B134:
		return 134;
	case B150:
		return 150;
	case B200:
		return 200;
	case B300:
		return 300;
	case B600:
		return 600;
	case B1200:
		return 1200;
	case B1800:
		return 1800;
	case B2400:
		return 2400;
	case B4800:
		return 4800;
	case B9600:
		return 9600;

#ifdef B19200
	case B19200:
		return 19200;
#else /* B19200 */
#ifdef EXTA
	case EXTA:
		return 19200;
#endif /* EXTA */
#endif /* B19200 */

#ifdef B38400
	case B38400:
		return 38400;
#else /* B38400 */
#ifdef EXTB
	case EXTB:
		return 38400;
#endif /* EXTB */
#endif /* B38400 */

#ifdef B7200
	case B7200:
		return 7200;
#endif /* B7200 */
#ifdef B14400
	case B14400:
		return 14400;
#endif /* B14400 */
#ifdef B28800
	case B28800:
		return 28800;
#endif /* B28800 */
#ifdef B57600
	case B57600:
		return 57600;
#endif /* B57600 */
#ifdef B76800
	case B76800:
		return 76800;
#endif /* B76800 */
#ifdef B115200
	case B115200:
		return 115200;
#endif /* B115200 */
#ifdef B230400
	case B230400:
		return 230400;
#endif /* B230400 */
	default:
		return 9600;
	}
}

/*
 * Converts a numeric baud rate to a POSIX speed_t.
 */
static speed_t
baud_to_speed(int baud)
{
	switch (baud) {
		case 0:
		return B0;
	case 50:
		return B50;
	case 75:
		return B75;
	case 110:
		return B110;
	case 134:
		return B134;
	case 150:
		return B150;
	case 200:
		return B200;
	case 300:
		return B300;
	case 600:
		return B600;
	case 1200:
		return B1200;
	case 1800:
		return B1800;
	case 2400:
		return B2400;
	case 4800:
		return B4800;
	case 9600:
		return B9600;

#ifdef B19200
	case 19200:
		return B19200;
#else /* B19200 */
#ifdef EXTA
	case 19200:
		return EXTA;
#endif /* EXTA */
#endif /* B19200 */

#ifdef B38400
	case 38400:
		return B38400;
#else /* B38400 */
#ifdef EXTB
	case 38400:
		return EXTB;
#endif /* EXTB */
#endif /* B38400 */

#ifdef B7200
	case 7200:
		return B7200;
#endif /* B7200 */
#ifdef B14400
	case 14400:
		return B14400;
#endif /* B14400 */
#ifdef B28800
	case 28800:
		return B28800;
#endif /* B28800 */
#ifdef B57600
	case 57600:
		return B57600;
#endif /* B57600 */
#ifdef B76800
	case 76800:
		return B76800;
#endif /* B76800 */
#ifdef B115200
	case 115200:
		return B115200;
#endif /* B115200 */
#ifdef B230400
	case 230400:
		return B230400;
#endif /* B230400 */
	default:
		return B9600;
	}
}

/*
 * Encodes terminal modes for the terminal referenced by fd
 * in a portable manner, and appends the modes to a packet
 * being constructed.
 */
void
tty_make_modes(int fd)
{
	struct termios tio;
	int baud;

	if (tcgetattr(fd, &tio) < 0) {
		packet_put_char(TTY_OP_END);
		log("tcgetattr: %.100s", strerror(errno));
		return;
	}
	/* Store input and output baud rates. */
	baud = speed_to_baud(cfgetospeed(&tio));
	packet_put_char(TTY_OP_OSPEED);
	packet_put_int(baud);
	baud = speed_to_baud(cfgetispeed(&tio));
	packet_put_char(TTY_OP_ISPEED);
	packet_put_int(baud);

	/* Store values of mode flags. */
#define TTYCHAR(NAME, OP) \
  packet_put_char(OP); packet_put_char(tio.c_cc[NAME]);
#define TTYMODE(NAME, FIELD, OP) \
  packet_put_char(OP); packet_put_char((tio.FIELD & NAME) != 0);

#include "ttymodes.h"

#undef TTYCHAR
#undef TTYMODE

	/* Mark end of mode data. */
	packet_put_char(TTY_OP_END);
}

/*
 * Decodes terminal modes for the terminal referenced by fd in a portable
 * manner from a packet being read.
 */
void
tty_parse_modes(int fd, int *n_bytes_ptr)
{
	struct termios tio;
	int opcode, baud;
	int n_bytes = 0;
	int failure = 0;

	/*
	 * Get old attributes for the terminal.  We will modify these
	 * flags. I am hoping that if there are any machine-specific
	 * modes, they will initially have reasonable values.
	 */
	if (tcgetattr(fd, &tio) < 0)
		failure = -1;

	for (;;) {
		n_bytes += 1;
		opcode = packet_get_char();
		switch (opcode) {
		case TTY_OP_END:
			goto set;

		case TTY_OP_ISPEED:
			n_bytes += 4;
			baud = packet_get_int();
			if (failure != -1 && cfsetispeed(&tio, baud_to_speed(baud)) < 0)
				error("cfsetispeed failed for %d", baud);
			break;

		case TTY_OP_OSPEED:
			n_bytes += 4;
			baud = packet_get_int();
			if (failure != -1 && cfsetospeed(&tio, baud_to_speed(baud)) < 0)
				error("cfsetospeed failed for %d", baud);
			break;

#define TTYCHAR(NAME, OP) 				\
	case OP:					\
	  n_bytes += 1;					\
	  tio.c_cc[NAME] = packet_get_char();		\
	  break;
#define TTYMODE(NAME, FIELD, OP)		       	\
	case OP:					\
	  n_bytes += 1;					\
	  if (packet_get_char())			\
	    tio.FIELD |= NAME;				\
	  else						\
	    tio.FIELD &= ~NAME;				\
	  break;

#include "ttymodes.h"

#undef TTYCHAR
#undef TTYMODE

		default:
			debug("Ignoring unsupported tty mode opcode %d (0x%x)",
			      opcode, opcode);
			/*
			 * Opcodes 0 to 127 are defined to have
			 * a one-byte argument.
			 */
			if (opcode >= 0 && opcode < 128) {
				n_bytes += 1;
				(void) packet_get_char();
				break;
			} else {
				/*
				 * Opcodes 128 to 159 are defined to have
				 * an integer argument.
				 */
				if (opcode >= 128 && opcode < 160) {
					n_bytes += 4;
					(void) packet_get_int();
					break;
				}
			}
			/*
			 * It is a truly undefined opcode (160 to 255).
			 * We have no idea about its arguments.  So we
			 * must stop parsing.  Note that some data may be
			 * left in the packet; hopefully there is nothing
			 * more coming after the mode data.
			 */
			log("parse_tty_modes: unknown opcode %d", opcode);
			packet_integrity_check(0, 1, SSH_CMSG_REQUEST_PTY);
			goto set;
		}
	}

set:
	if (*n_bytes_ptr != n_bytes) {
		*n_bytes_ptr = n_bytes;
		return;		/* Don't process bytes passed */
	}
	if (failure == -1)
		return;		/* Packet parsed ok but tty stuff failed */

	/* Set the new modes for the terminal. */
	if (tcsetattr(fd, TCSANOW, &tio) < 0)
		log("Setting tty modes failed: %.100s", strerror(errno));
	return;
}
Commit	Line	Data
8efc0c15	1	/*
5260325f	2	* Author: Tatu Ylonen <ylo@cs.hut.fi>
	3	* Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
	4	* All rights reserved
5260325f	5	* Encoding and decoding of terminal modes in a portable way.
	6	* Much of the format is defined in ttymodes.h; it is included multiple times
	7	* into this file with the appropriate macro definitions to generate the
	8	* suitable code.
bcbf86ec	9	*
	10	* As far as I am concerned, the code I have written for this software
	11	* can be used freely for any purpose. Any derived versions of this
	12	* software must be clearly marked as such, and if the derived work is
	13	* incompatible with the protocol description in the RFC file, it must be
	14	* called by a name other than "ssh" or "Secure Shell".
5260325f	15	*/
8efc0c15	16
8efc0c15	17	#include "includes.h"
2f778758	18	RCSID("$OpenBSD: ttymodes.c,v 1.11 2001/03/10 15:02:05 stevesk Exp $");
8efc0c15	19
8efc0c15	20	#include "packet.h"
42f11eb2	21	#include "log.h"
42f11eb2	22	#include "ssh1.h"
8efc0c15	23
8efc0c15	24	#define TTY_OP_END 0
5260325f	25	#define TTY_OP_ISPEED 192 /* int follows */
5260325f	26	#define TTY_OP_OSPEED 193 /* int follows */
8efc0c15	27
5260325f	28	/*
	29	* Converts POSIX speed_t to a baud rate. The values of the
	30	* constants for speed_t are not themselves portable.
	31	*/
6ae2364d	32	static int
5260325f	33	speed_to_baud(speed_t speed)
8efc0c15	34	{
5260325f	35	switch (speed) {
	36	case B0:
	37	return 0;
	38	case B50:
	39	return 50;
	40	case B75:
	41	return 75;
	42	case B110:
	43	return 110;
	44	case B134:
	45	return 134;
	46	case B150:
	47	return 150;
	48	case B200:
	49	return 200;
	50	case B300:
	51	return 300;
	52	case B600:
	53	return 600;
	54	case B1200:
	55	return 1200;
	56	case B1800:
	57	return 1800;
	58	case B2400:
	59	return 2400;
	60	case B4800:
	61	return 4800;
	62	case B9600:
	63	return 9600;
8efc0c15	64
8efc0c15	65	#ifdef B19200
5260325f	66	case B19200:
5260325f	67	return 19200;
8efc0c15	68	#else /* B19200 */
8efc0c15	69	#ifdef EXTA
5260325f	70	case EXTA:
5260325f	71	return 19200;
8efc0c15	72	#endif /* EXTA */
	73	#endif /* B19200 */
	74
	75	#ifdef B38400
5260325f	76	case B38400:
5260325f	77	return 38400;
8efc0c15	78	#else /* B38400 */
8efc0c15	79	#ifdef EXTB
5260325f	80	case EXTB:
5260325f	81	return 38400;
8efc0c15	82	#endif /* EXTB */
	83	#endif /* B38400 */
	84
	85	#ifdef B7200
5260325f	86	case B7200:
5260325f	87	return 7200;
8efc0c15	88	#endif /* B7200 */
8efc0c15	89	#ifdef B14400
5260325f	90	case B14400:
5260325f	91	return 14400;
8efc0c15	92	#endif /* B14400 */
8efc0c15	93	#ifdef B28800
5260325f	94	case B28800:
5260325f	95	return 28800;
8efc0c15	96	#endif /* B28800 */
8efc0c15	97	#ifdef B57600
5260325f	98	case B57600:
5260325f	99	return 57600;
8efc0c15	100	#endif /* B57600 */
8efc0c15	101	#ifdef B76800
5260325f	102	case B76800:
5260325f	103	return 76800;
8efc0c15	104	#endif /* B76800 */
8efc0c15	105	#ifdef B115200
5260325f	106	case B115200:
5260325f	107	return 115200;
8efc0c15	108	#endif /* B115200 */
8efc0c15	109	#ifdef B230400
5260325f	110	case B230400:
5260325f	111	return 230400;
8efc0c15	112	#endif /* B230400 */
5260325f	113	default:
	114	return 9600;
	115	}
8efc0c15	116	}
8efc0c15	117
5260325f	118	/*
	119	* Converts a numeric baud rate to a POSIX speed_t.
	120	*/
6ae2364d	121	static speed_t
5260325f	122	baud_to_speed(int baud)
8efc0c15	123	{
5260325f	124	switch (baud) {
	125	case 0:
	126	return B0;
	127	case 50:
	128	return B50;
	129	case 75:
	130	return B75;
	131	case 110:
	132	return B110;
	133	case 134:
	134	return B134;
	135	case 150:
	136	return B150;
	137	case 200:
	138	return B200;
	139	case 300:
	140	return B300;
	141	case 600:
	142	return B600;
	143	case 1200:
	144	return B1200;
	145	case 1800:
	146	return B1800;
	147	case 2400:
	148	return B2400;
	149	case 4800:
	150	return B4800;
	151	case 9600:
	152	return B9600;
8efc0c15	153
8efc0c15	154	#ifdef B19200
5260325f	155	case 19200:
5260325f	156	return B19200;
8efc0c15	157	#else /* B19200 */
8efc0c15	158	#ifdef EXTA
5260325f	159	case 19200:
5260325f	160	return EXTA;
8efc0c15	161	#endif /* EXTA */
	162	#endif /* B19200 */
	163
	164	#ifdef B38400
5260325f	165	case 38400:
5260325f	166	return B38400;
8efc0c15	167	#else /* B38400 */
8efc0c15	168	#ifdef EXTB
5260325f	169	case 38400:
5260325f	170	return EXTB;
8efc0c15	171	#endif /* EXTB */
	172	#endif /* B38400 */
	173
	174	#ifdef B7200
5260325f	175	case 7200:
5260325f	176	return B7200;
8efc0c15	177	#endif /* B7200 */
8efc0c15	178	#ifdef B14400
5260325f	179	case 14400:
5260325f	180	return B14400;
8efc0c15	181	#endif /* B14400 */
8efc0c15	182	#ifdef B28800
5260325f	183	case 28800:
5260325f	184	return B28800;
8efc0c15	185	#endif /* B28800 */
8efc0c15	186	#ifdef B57600
5260325f	187	case 57600:
5260325f	188	return B57600;
8efc0c15	189	#endif /* B57600 */
8efc0c15	190	#ifdef B76800
5260325f	191	case 76800:
5260325f	192	return B76800;
8efc0c15	193	#endif /* B76800 */
8efc0c15	194	#ifdef B115200
5260325f	195	case 115200:
5260325f	196	return B115200;
8efc0c15	197	#endif /* B115200 */
8efc0c15	198	#ifdef B230400
5260325f	199	case 230400:
5260325f	200	return B230400;
8efc0c15	201	#endif /* B230400 */
5260325f	202	default:
	203	return B9600;
	204	}
8efc0c15	205	}
8efc0c15	206
5260325f	207	/*
	208	* Encodes terminal modes for the terminal referenced by fd
	209	* in a portable manner, and appends the modes to a packet
	210	* being constructed.
	211	*/
6ae2364d	212	void
5260325f	213	tty_make_modes(int fd)
8efc0c15	214	{
5260325f	215	struct termios tio;
	216	int baud;
	217
5260325f	218	if (tcgetattr(fd, &tio) < 0) {
	219	packet_put_char(TTY_OP_END);
	220	log("tcgetattr: %.100s", strerror(errno));
	221	return;
	222	}
	223	/* Store input and output baud rates. */
	224	baud = speed_to_baud(cfgetospeed(&tio));
	225	packet_put_char(TTY_OP_OSPEED);
	226	packet_put_int(baud);
	227	baud = speed_to_baud(cfgetispeed(&tio));
	228	packet_put_char(TTY_OP_ISPEED);
	229	packet_put_int(baud);
	230
	231	/* Store values of mode flags. */
8efc0c15	232	#define TTYCHAR(NAME, OP) \
	233	packet_put_char(OP); packet_put_char(tio.c_cc[NAME]);
	234	#define TTYMODE(NAME, FIELD, OP) \
	235	packet_put_char(OP); packet_put_char((tio.FIELD & NAME) != 0);
8efc0c15	236
	237	#include "ttymodes.h"
	238
	239	#undef TTYCHAR
	240	#undef TTYMODE
8efc0c15	241
5260325f	242	/* Mark end of mode data. */
5260325f	243	packet_put_char(TTY_OP_END);
8efc0c15	244	}
8efc0c15	245
5260325f	246	/*
	247	* Decodes terminal modes for the terminal referenced by fd in a portable
	248	* manner from a packet being read.
	249	*/
6ae2364d	250	void
5260325f	251	tty_parse_modes(int fd, int *n_bytes_ptr)
8efc0c15	252	{
5260325f	253	struct termios tio;
	254	int opcode, baud;
	255	int n_bytes = 0;
	256	int failure = 0;
	257
	258	/*
	259	* Get old attributes for the terminal. We will modify these
	260	* flags. I am hoping that if there are any machine-specific
	261	* modes, they will initially have reasonable values.
	262	*/
	263	if (tcgetattr(fd, &tio) < 0)
	264	failure = -1;
	265
	266	for (;;) {
	267	n_bytes += 1;
	268	opcode = packet_get_char();
	269	switch (opcode) {
	270	case TTY_OP_END:
	271	goto set;
	272
	273	case TTY_OP_ISPEED:
	274	n_bytes += 4;
	275	baud = packet_get_int();
	276	if (failure != -1 && cfsetispeed(&tio, baud_to_speed(baud)) < 0)
	277	error("cfsetispeed failed for %d", baud);
	278	break;
	279
	280	case TTY_OP_OSPEED:
	281	n_bytes += 4;
	282	baud = packet_get_int();
	283	if (failure != -1 && cfsetospeed(&tio, baud_to_speed(baud)) < 0)
	284	error("cfsetospeed failed for %d", baud);
	285	break;
8efc0c15	286
	287	#define TTYCHAR(NAME, OP) \
	288	case OP: \
	289	n_bytes += 1; \
	290	tio.c_cc[NAME] = packet_get_char(); \
	291	break;
	292	#define TTYMODE(NAME, FIELD, OP) \
	293	case OP: \
	294	n_bytes += 1; \
	295	if (packet_get_char()) \
	296	tio.FIELD \|= NAME; \
	297	else \
	298	tio.FIELD &= ~NAME; \
	299	break;
8efc0c15	300
	301	#include "ttymodes.h"
	302
	303	#undef TTYCHAR
	304	#undef TTYMODE
8efc0c15	305
5260325f	306	default:
	307	debug("Ignoring unsupported tty mode opcode %d (0x%x)",
	308	opcode, opcode);
	309	/*
	310	* Opcodes 0 to 127 are defined to have
	311	* a one-byte argument.
	312	*/
	313	if (opcode >= 0 && opcode < 128) {
	314	n_bytes += 1;
	315	(void) packet_get_char();
	316	break;
	317	} else {
	318	/*
	319	* Opcodes 128 to 159 are defined to have
	320	* an integer argument.
	321	*/
	322	if (opcode >= 128 && opcode < 160) {
	323	n_bytes += 4;
	324	(void) packet_get_int();
	325	break;
	326	}
	327	}
	328	/*
	329	* It is a truly undefined opcode (160 to 255).
	330	* We have no idea about its arguments. So we
	331	* must stop parsing. Note that some data may be
	332	* left in the packet; hopefully there is nothing
	333	* more coming after the mode data.
	334	*/
	335	log("parse_tty_modes: unknown opcode %d", opcode);
	336	packet_integrity_check(0, 1, SSH_CMSG_REQUEST_PTY);
	337	goto set;
8efc0c15	338	}
8efc0c15	339	}
8efc0c15	340
5260325f	341	set:
	342	if (*n_bytes_ptr != n_bytes) {
	343	*n_bytes_ptr = n_bytes;
	344	return; /* Don't process bytes passed */
	345	}
	346	if (failure == -1)
	347	return; /* Packet parsed ok but tty stuff failed */
8efc0c15	348
5260325f	349	/* Set the new modes for the terminal. */
	350	if (tcsetattr(fd, TCSANOW, &tio) < 0)
	351	log("Setting tty modes failed: %.100s", strerror(errno));
	352	return;
8efc0c15	353	}