[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.8 2000/09/07 20:27:55 deraadt Exp $");

#include "packet.h"
#include "ssh.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);
#define SGTTYCHAR(NAME, OP)
#define SGTTYMODE(NAME, FIELD, OP)
#define SGTTYMODEN(NAME, FIELD, OP)

#include "ttymodes.h"

#undef TTYCHAR
#undef TTYMODE
#undef SGTTYCHAR
#undef SGTTYMODE
#undef SGTTYMODEN

	/* 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;
#define SGTTYCHAR(NAME, OP)
#define SGTTYMODE(NAME, FIELD, OP)
#define SGTTYMODEN(NAME, FIELD, OP)

#include "ttymodes.h"

#undef TTYCHAR
#undef TTYMODE
#undef SGTTYCHAR
#undef SGTTYMODE
#undef SGTTYMODEN

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