2 * Author: Tatu Ylonen <ylo@cs.hut.fi>
3 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
6 * As far as I am concerned, the code I have written for this software
7 * can be used freely for any purpose. Any derived versions of this
8 * software must be clearly marked as such, and if the derived work is
9 * incompatible with the protocol description in the RFC file, it must be
10 * called by a name other than "ssh" or "Secure Shell".
14 * SSH2 tty modes support by Kevin Steves.
15 * Copyright (c) 2001 Kevin Steves. All rights reserved.
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions
20 * 1. Redistributions of source code must retain the above copyright
21 * notice, this list of conditions and the following disclaimer.
22 * 2. Redistributions in binary form must reproduce the above copyright
23 * notice, this list of conditions and the following disclaimer in the
24 * documentation and/or other materials provided with the distribution.
26 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
27 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
30 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
31 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 * Encoding and decoding of terminal modes in a portable way.
40 * Much of the format is defined in ttymodes.h; it is included multiple times
41 * into this file with the appropriate macro definitions to generate the
46 RCSID("$OpenBSD: ttymodes.c,v 1.20 2006/02/07 01:42:00 stevesk Exp $");
59 * uint32 (u_int) follows speed in SSH1 and SSH2
61 #define TTY_OP_ISPEED_PROTO1 192
62 #define TTY_OP_OSPEED_PROTO1 193
63 #define TTY_OP_ISPEED_PROTO2 128
64 #define TTY_OP_OSPEED_PROTO2 129
67 * Converts POSIX speed_t to a baud rate. The values of the
68 * constants for speed_t are not themselves portable.
71 speed_to_baud(speed_t speed)
157 * Converts a numeric baud rate to a POSIX speed_t.
160 baud_to_speed(int baud)
246 * Encode a special character into SSH line format.
249 special_char_encode(cc_t c)
251 #ifdef _POSIX_VDISABLE
252 if (c == _POSIX_VDISABLE)
254 #endif /* _POSIX_VDISABLE */
259 * Decode a special character from SSH line format.
262 special_char_decode(u_int c)
264 #ifdef _POSIX_VDISABLE
266 return _POSIX_VDISABLE;
267 #endif /* _POSIX_VDISABLE */
272 * Encodes terminal modes for the terminal referenced by fd
273 * or tiop in a portable manner, and appends the modes to a packet
277 tty_make_modes(int fd, struct termios *tiop)
282 int tty_op_ospeed, tty_op_ispeed;
283 void (*put_arg)(Buffer *, u_int);
287 tty_op_ospeed = TTY_OP_OSPEED_PROTO2;
288 tty_op_ispeed = TTY_OP_ISPEED_PROTO2;
289 put_arg = buffer_put_int;
291 tty_op_ospeed = TTY_OP_OSPEED_PROTO1;
292 tty_op_ispeed = TTY_OP_ISPEED_PROTO1;
293 put_arg = (void (*)(Buffer *, u_int)) buffer_put_char;
297 if (tcgetattr(fd, &tio) == -1) {
298 logit("tcgetattr: %.100s", strerror(errno));
304 /* Store input and output baud rates. */
305 baud = speed_to_baud(cfgetospeed(&tio));
306 debug3("tty_make_modes: ospeed %d", baud);
307 buffer_put_char(&buf, tty_op_ospeed);
308 buffer_put_int(&buf, baud);
309 baud = speed_to_baud(cfgetispeed(&tio));
310 debug3("tty_make_modes: ispeed %d", baud);
311 buffer_put_char(&buf, tty_op_ispeed);
312 buffer_put_int(&buf, baud);
314 /* Store values of mode flags. */
315 #define TTYCHAR(NAME, OP) \
316 debug3("tty_make_modes: %d %d", OP, tio.c_cc[NAME]); \
317 buffer_put_char(&buf, OP); \
318 put_arg(&buf, special_char_encode(tio.c_cc[NAME]));
320 #define TTYMODE(NAME, FIELD, OP) \
321 debug3("tty_make_modes: %d %d", OP, ((tio.FIELD & NAME) != 0)); \
322 buffer_put_char(&buf, OP); \
323 put_arg(&buf, ((tio.FIELD & NAME) != 0));
325 #include "ttymodes.h"
331 /* Mark end of mode data. */
332 buffer_put_char(&buf, TTY_OP_END);
334 packet_put_string(buffer_ptr(&buf), buffer_len(&buf));
336 packet_put_raw(buffer_ptr(&buf), buffer_len(&buf));
341 * Decodes terminal modes for the terminal referenced by fd in a portable
342 * manner from a packet being read.
345 tty_parse_modes(int fd, int *n_bytes_ptr)
351 u_int (*get_arg)(void);
355 *n_bytes_ptr = packet_get_int();
356 debug3("tty_parse_modes: SSH2 n_bytes %d", *n_bytes_ptr);
357 if (*n_bytes_ptr == 0)
359 get_arg = packet_get_int;
362 get_arg = packet_get_char;
367 * Get old attributes for the terminal. We will modify these
368 * flags. I am hoping that if there are any machine-specific
369 * modes, they will initially have reasonable values.
371 if (tcgetattr(fd, &tio) == -1) {
372 logit("tcgetattr: %.100s", strerror(errno));
378 opcode = packet_get_char();
383 /* XXX: future conflict possible */
384 case TTY_OP_ISPEED_PROTO1:
385 case TTY_OP_ISPEED_PROTO2:
387 baud = packet_get_int();
388 debug3("tty_parse_modes: ispeed %d", baud);
389 if (failure != -1 && cfsetispeed(&tio, baud_to_speed(baud)) == -1)
390 error("cfsetispeed failed for %d", baud);
393 /* XXX: future conflict possible */
394 case TTY_OP_OSPEED_PROTO1:
395 case TTY_OP_OSPEED_PROTO2:
397 baud = packet_get_int();
398 debug3("tty_parse_modes: ospeed %d", baud);
399 if (failure != -1 && cfsetospeed(&tio, baud_to_speed(baud)) == -1)
400 error("cfsetospeed failed for %d", baud);
403 #define TTYCHAR(NAME, OP) \
405 n_bytes += arg_size; \
406 tio.c_cc[NAME] = special_char_decode(get_arg()); \
407 debug3("tty_parse_modes: %d %d", OP, tio.c_cc[NAME]); \
409 #define TTYMODE(NAME, FIELD, OP) \
411 n_bytes += arg_size; \
412 if ((arg = get_arg())) \
415 tio.FIELD &= ~NAME; \
416 debug3("tty_parse_modes: %d %d", OP, arg); \
419 #include "ttymodes.h"
425 debug("Ignoring unsupported tty mode opcode %d (0x%x)",
430 * Opcodes 1 to 127 are defined to have
431 * a one-byte argument.
432 * Opcodes 128 to 159 are defined to have
433 * an integer argument.
435 if (opcode > 0 && opcode < 128) {
437 (void) packet_get_char();
439 } else if (opcode >= 128 && opcode < 160) {
441 (void) packet_get_int();
445 * It is a truly undefined opcode (160 to 255).
446 * We have no idea about its arguments. So we
447 * must stop parsing. Note that some data may be
448 * left in the packet; hopefully there is nothing
449 * more coming after the mode data.
451 logit("parse_tty_modes: unknown opcode %d", opcode);
457 * Opcodes 1 to 159 are defined to have
459 * Opcodes 160 to 255 are undefined and
460 * cause parsing to stop.
462 if (opcode > 0 && opcode < 160) {
464 (void) packet_get_int();
467 logit("parse_tty_modes: unknown opcode %d", opcode);
475 if (*n_bytes_ptr != n_bytes) {
476 *n_bytes_ptr = n_bytes;
477 logit("parse_tty_modes: n_bytes_ptr != n_bytes: %d %d",
478 *n_bytes_ptr, n_bytes);
479 return; /* Don't process bytes passed */
482 return; /* Packet parsed ok but tcgetattr() failed */
484 /* Set the new modes for the terminal. */
485 if (tcsetattr(fd, TCSANOW, &tio) == -1)
486 logit("Setting tty modes failed: %.100s", strerror(errno));