1 /* $OpenBSD: ttymodes.c,v 1.33 2018/02/16 04:43:11 dtucker 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>
63 * uint32 (u_int) follows speed.
65 #define TTY_OP_ISPEED 128
66 #define TTY_OP_OSPEED 129
69 * Converts POSIX speed_t to a baud rate. The values of the
70 * constants for speed_t are not themselves portable.
73 speed_to_baud(speed_t speed)
159 * Converts a numeric baud rate to a POSIX speed_t.
162 baud_to_speed(int baud)
248 * Encode a special character into SSH line format.
251 special_char_encode(cc_t c)
253 #ifdef _POSIX_VDISABLE
254 if (c == _POSIX_VDISABLE)
256 #endif /* _POSIX_VDISABLE */
261 * Decode a special character from SSH line format.
264 special_char_decode(u_int c)
266 #ifdef _POSIX_VDISABLE
268 return _POSIX_VDISABLE;
269 #endif /* _POSIX_VDISABLE */
274 * Encodes terminal modes for the terminal referenced by fd
275 * or tiop in a portable manner, and appends the modes to a packet
279 tty_make_modes(int fd, struct termios *tiop)
289 debug("tty_make_modes: no fd or tio");
292 if (tcgetattr(fd, &tio) == -1) {
293 logit("tcgetattr: %.100s", strerror(errno));
299 /* Store input and output baud rates. */
300 baud = speed_to_baud(cfgetospeed(&tio));
301 buffer_put_char(&buf, TTY_OP_OSPEED);
302 buffer_put_int(&buf, baud);
303 baud = speed_to_baud(cfgetispeed(&tio));
304 buffer_put_char(&buf, TTY_OP_ISPEED);
305 buffer_put_int(&buf, baud);
307 /* Store values of mode flags. */
308 #define TTYCHAR(NAME, OP) \
309 buffer_put_char(&buf, OP); \
310 buffer_put_int(&buf, special_char_encode(tio.c_cc[NAME]));
312 #define SSH_TTYMODE_IUTF8 42 /* for SSH_BUG_UTF8TTYMODE */
314 #define TTYMODE(NAME, FIELD, OP) \
315 if (OP == SSH_TTYMODE_IUTF8 && (datafellows & SSH_BUG_UTF8TTYMODE)) { \
316 debug3("%s: SSH_BUG_UTF8TTYMODE", __func__); \
318 buffer_put_char(&buf, OP); \
319 buffer_put_int(&buf, ((tio.FIELD & NAME) != 0)); \
322 #include "ttymodes.h"
328 /* Mark end of mode data. */
329 buffer_put_char(&buf, TTY_OP_END);
330 packet_put_string(buffer_ptr(&buf), buffer_len(&buf));
335 * Decodes terminal modes for the terminal referenced by fd in a portable
336 * manner from a packet being read.
339 tty_parse_modes(int fd, int *n_bytes_ptr)
346 *n_bytes_ptr = packet_get_int();
347 if (*n_bytes_ptr == 0)
351 * Get old attributes for the terminal. We will modify these
352 * flags. I am hoping that if there are any machine-specific
353 * modes, they will initially have reasonable values.
355 if (tcgetattr(fd, &tio) == -1) {
356 logit("tcgetattr: %.100s", strerror(errno));
362 opcode = packet_get_char();
369 baud = packet_get_int();
371 cfsetispeed(&tio, baud_to_speed(baud)) == -1)
372 error("cfsetispeed failed for %d", baud);
377 baud = packet_get_int();
379 cfsetospeed(&tio, baud_to_speed(baud)) == -1)
380 error("cfsetospeed failed for %d", baud);
383 #define TTYCHAR(NAME, OP) \
386 tio.c_cc[NAME] = special_char_decode(packet_get_int()); \
388 #define TTYMODE(NAME, FIELD, OP) \
391 if (packet_get_int()) \
394 tio.FIELD &= ~NAME; \
397 #include "ttymodes.h"
403 debug("Ignoring unsupported tty mode opcode %d (0x%x)",
407 * Opcodes 1 to 159 are defined to have a uint32
409 * Opcodes 160 to 255 are undefined and cause parsing
412 if (opcode > 0 && opcode < 160) {
414 (void) packet_get_int();
417 logit("parse_tty_modes: unknown opcode %d",
425 if (*n_bytes_ptr != n_bytes) {
426 *n_bytes_ptr = n_bytes;
427 logit("parse_tty_modes: n_bytes_ptr != n_bytes: %d %d",
428 *n_bytes_ptr, n_bytes);
429 return; /* Don't process bytes passed */
432 return; /* Packet parsed ok but tcgetattr() failed */
434 /* Set the new modes for the terminal. */
435 if (tcsetattr(fd, TCSANOW, &tio) == -1)
436 logit("Setting tty modes failed: %.100s", strerror(errno));