1 /* $OpenBSD: ttymodes.c,v 1.30 2016/05/04 14:22:33 markus Exp $ */
3 * Author: Tatu Ylonen <ylo@cs.hut.fi>
4 * Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
7 * As far as I am concerned, the code I have written for this software
8 * can be used freely for any purpose. Any derived versions of this
9 * software must be clearly marked as such, and if the derived work is
10 * incompatible with the protocol description in the RFC file, it must be
11 * called by a name other than "ssh" or "Secure Shell".
15 * SSH2 tty modes support by Kevin Steves.
16 * Copyright (c) 2001 Kevin Steves. All rights reserved.
18 * Redistribution and use in source and binary forms, with or without
19 * modification, are permitted provided that the following conditions
21 * 1. Redistributions of source code must retain the above copyright
22 * notice, this list of conditions and the following disclaimer.
23 * 2. Redistributions in binary form must reproduce the above copyright
24 * notice, this list of conditions and the following disclaimer in the
25 * documentation and/or other materials provided with the distribution.
27 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
28 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
29 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
30 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
31 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
32 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
33 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
34 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
35 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
36 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 * Encoding and decoding of terminal modes in a portable way.
41 * Much of the format is defined in ttymodes.h; it is included multiple times
42 * into this file with the appropriate macro definitions to generate the
48 #include <sys/types.h>
62 * uint32 (u_int) follows speed in SSH1 and SSH2
64 #define TTY_OP_ISPEED_PROTO1 192
65 #define TTY_OP_OSPEED_PROTO1 193
66 #define TTY_OP_ISPEED_PROTO2 128
67 #define TTY_OP_OSPEED_PROTO2 129
70 * Converts POSIX speed_t to a baud rate. The values of the
71 * constants for speed_t are not themselves portable.
74 speed_to_baud(speed_t speed)
160 * Converts a numeric baud rate to a POSIX speed_t.
163 baud_to_speed(int baud)
249 * Encode a special character into SSH line format.
252 special_char_encode(cc_t c)
254 #ifdef _POSIX_VDISABLE
255 if (c == _POSIX_VDISABLE)
257 #endif /* _POSIX_VDISABLE */
262 * Decode a special character from SSH line format.
265 special_char_decode(u_int c)
267 #ifdef _POSIX_VDISABLE
269 return _POSIX_VDISABLE;
270 #endif /* _POSIX_VDISABLE */
275 * Encodes terminal modes for the terminal referenced by fd
276 * or tiop in a portable manner, and appends the modes to a packet
280 tty_make_modes(int fd, struct termios *tiop)
285 int tty_op_ospeed, tty_op_ispeed;
286 void (*put_arg)(Buffer *, u_int);
290 tty_op_ospeed = TTY_OP_OSPEED_PROTO2;
291 tty_op_ispeed = TTY_OP_ISPEED_PROTO2;
292 put_arg = buffer_put_int;
294 tty_op_ospeed = TTY_OP_OSPEED_PROTO1;
295 tty_op_ispeed = TTY_OP_ISPEED_PROTO1;
296 put_arg = (void (*)(Buffer *, u_int)) buffer_put_char;
301 debug("tty_make_modes: no fd or tio");
304 if (tcgetattr(fd, &tio) == -1) {
305 logit("tcgetattr: %.100s", strerror(errno));
311 /* Store input and output baud rates. */
312 baud = speed_to_baud(cfgetospeed(&tio));
313 buffer_put_char(&buf, tty_op_ospeed);
314 buffer_put_int(&buf, baud);
315 baud = speed_to_baud(cfgetispeed(&tio));
316 buffer_put_char(&buf, tty_op_ispeed);
317 buffer_put_int(&buf, baud);
319 /* Store values of mode flags. */
320 #define TTYCHAR(NAME, OP) \
321 buffer_put_char(&buf, OP); \
322 put_arg(&buf, special_char_encode(tio.c_cc[NAME]));
324 #define TTYMODE(NAME, FIELD, OP) \
325 buffer_put_char(&buf, OP); \
326 put_arg(&buf, ((tio.FIELD & NAME) != 0));
328 #include "ttymodes.h"
334 /* Mark end of mode data. */
335 buffer_put_char(&buf, TTY_OP_END);
337 packet_put_string(buffer_ptr(&buf), buffer_len(&buf));
339 packet_put_raw(buffer_ptr(&buf), buffer_len(&buf));
344 * Decodes terminal modes for the terminal referenced by fd in a portable
345 * manner from a packet being read.
348 tty_parse_modes(int fd, int *n_bytes_ptr)
354 u_int (*get_arg)(void);
358 *n_bytes_ptr = packet_get_int();
359 if (*n_bytes_ptr == 0)
361 get_arg = packet_get_int;
364 get_arg = packet_get_char;
369 * Get old attributes for the terminal. We will modify these
370 * flags. I am hoping that if there are any machine-specific
371 * modes, they will initially have reasonable values.
373 if (tcgetattr(fd, &tio) == -1) {
374 logit("tcgetattr: %.100s", strerror(errno));
380 opcode = packet_get_char();
385 /* XXX: future conflict possible */
386 case TTY_OP_ISPEED_PROTO1:
387 case TTY_OP_ISPEED_PROTO2:
389 baud = packet_get_int();
391 cfsetispeed(&tio, baud_to_speed(baud)) == -1)
392 error("cfsetispeed failed for %d", baud);
395 /* XXX: future conflict possible */
396 case TTY_OP_OSPEED_PROTO1:
397 case TTY_OP_OSPEED_PROTO2:
399 baud = packet_get_int();
401 cfsetospeed(&tio, baud_to_speed(baud)) == -1)
402 error("cfsetospeed failed for %d", baud);
405 #define TTYCHAR(NAME, OP) \
407 n_bytes += arg_size; \
408 tio.c_cc[NAME] = special_char_decode(get_arg()); \
410 #define TTYMODE(NAME, FIELD, OP) \
412 n_bytes += arg_size; \
416 tio.FIELD &= ~NAME; \
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
448 * may be left in the packet; hopefully there
449 * is nothing more coming after the mode data.
451 logit("parse_tty_modes: unknown opcode %d",
458 * Opcodes 1 to 159 are defined to have
460 * Opcodes 160 to 255 are undefined and
461 * cause parsing to stop.
463 if (opcode > 0 && opcode < 160) {
465 (void) packet_get_int();
468 logit("parse_tty_modes: unknown opcode %d",
477 if (*n_bytes_ptr != n_bytes) {
478 *n_bytes_ptr = n_bytes;
479 logit("parse_tty_modes: n_bytes_ptr != n_bytes: %d %d",
480 *n_bytes_ptr, n_bytes);
481 return; /* Don't process bytes passed */
484 return; /* Packet parsed ok but tcgetattr() failed */
486 /* Set the new modes for the terminal. */
487 if (tcsetattr(fd, TCSANOW, &tio) == -1)
488 logit("Setting tty modes failed: %.100s", strerror(errno));