[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
 * Created: Tue Mar 21 15:59:15 1995 ylo
 * 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.
 */

#include "includes.h"
RCSID("$Id$");

#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;

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