]> andersk Git - openssh.git/blame - ttymodes.c
- stevesk@cvs.openbsd.org 2006/02/07 01:42:00
[openssh.git] / ttymodes.c
CommitLineData
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
bcbf86ec 5 *
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".
5260325f 11 */
8efc0c15 12
30dcc918 13/*
14 * SSH2 tty modes support by Kevin Steves.
15 * Copyright (c) 2001 Kevin Steves. All rights reserved.
16 *
17 * Redistribution and use in source and binary forms, with or without
18 * modification, are permitted provided that the following conditions
19 * are met:
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.
25 *
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.
36 */
37
38/*
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
42 * suitable code.
43 */
44
8efc0c15 45#include "includes.h"
1d3e026f 46RCSID("$OpenBSD: ttymodes.c,v 1.20 2006/02/07 01:42:00 stevesk Exp $");
47
48#include <termios.h>
8efc0c15 49
50#include "packet.h"
42f11eb2 51#include "log.h"
52#include "ssh1.h"
30dcc918 53#include "compat.h"
54#include "buffer.h"
55#include "bufaux.h"
8efc0c15 56
30dcc918 57#define TTY_OP_END 0
58/*
59 * uint32 (u_int) follows speed in SSH1 and SSH2
60 */
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
8efc0c15 65
5260325f 66/*
67 * Converts POSIX speed_t to a baud rate. The values of the
68 * constants for speed_t are not themselves portable.
69 */
6ae2364d 70static int
5260325f 71speed_to_baud(speed_t speed)
8efc0c15 72{
5260325f 73 switch (speed) {
74 case B0:
75 return 0;
76 case B50:
77 return 50;
78 case B75:
79 return 75;
80 case B110:
81 return 110;
82 case B134:
83 return 134;
84 case B150:
85 return 150;
86 case B200:
87 return 200;
88 case B300:
89 return 300;
90 case B600:
91 return 600;
92 case B1200:
93 return 1200;
94 case B1800:
95 return 1800;
96 case B2400:
97 return 2400;
98 case B4800:
99 return 4800;
100 case B9600:
101 return 9600;
8efc0c15 102
103#ifdef B19200
5260325f 104 case B19200:
105 return 19200;
8efc0c15 106#else /* B19200 */
107#ifdef EXTA
5260325f 108 case EXTA:
109 return 19200;
8efc0c15 110#endif /* EXTA */
111#endif /* B19200 */
112
113#ifdef B38400
5260325f 114 case B38400:
115 return 38400;
8efc0c15 116#else /* B38400 */
117#ifdef EXTB
5260325f 118 case EXTB:
119 return 38400;
8efc0c15 120#endif /* EXTB */
121#endif /* B38400 */
122
123#ifdef B7200
5260325f 124 case B7200:
125 return 7200;
8efc0c15 126#endif /* B7200 */
127#ifdef B14400
5260325f 128 case B14400:
129 return 14400;
8efc0c15 130#endif /* B14400 */
131#ifdef B28800
5260325f 132 case B28800:
133 return 28800;
8efc0c15 134#endif /* B28800 */
135#ifdef B57600
5260325f 136 case B57600:
137 return 57600;
8efc0c15 138#endif /* B57600 */
139#ifdef B76800
5260325f 140 case B76800:
141 return 76800;
8efc0c15 142#endif /* B76800 */
143#ifdef B115200
5260325f 144 case B115200:
145 return 115200;
8efc0c15 146#endif /* B115200 */
147#ifdef B230400
5260325f 148 case B230400:
149 return 230400;
8efc0c15 150#endif /* B230400 */
5260325f 151 default:
152 return 9600;
153 }
8efc0c15 154}
155
5260325f 156/*
157 * Converts a numeric baud rate to a POSIX speed_t.
158 */
6ae2364d 159static speed_t
5260325f 160baud_to_speed(int baud)
8efc0c15 161{
5260325f 162 switch (baud) {
30dcc918 163 case 0:
5260325f 164 return B0;
165 case 50:
166 return B50;
167 case 75:
168 return B75;
169 case 110:
170 return B110;
171 case 134:
172 return B134;
173 case 150:
174 return B150;
175 case 200:
176 return B200;
177 case 300:
178 return B300;
179 case 600:
180 return B600;
181 case 1200:
182 return B1200;
183 case 1800:
184 return B1800;
185 case 2400:
186 return B2400;
187 case 4800:
188 return B4800;
189 case 9600:
190 return B9600;
8efc0c15 191
192#ifdef B19200
5260325f 193 case 19200:
194 return B19200;
8efc0c15 195#else /* B19200 */
196#ifdef EXTA
5260325f 197 case 19200:
198 return EXTA;
8efc0c15 199#endif /* EXTA */
200#endif /* B19200 */
201
202#ifdef B38400
5260325f 203 case 38400:
204 return B38400;
8efc0c15 205#else /* B38400 */
206#ifdef EXTB
5260325f 207 case 38400:
208 return EXTB;
8efc0c15 209#endif /* EXTB */
210#endif /* B38400 */
211
212#ifdef B7200
5260325f 213 case 7200:
214 return B7200;
8efc0c15 215#endif /* B7200 */
216#ifdef B14400
5260325f 217 case 14400:
218 return B14400;
8efc0c15 219#endif /* B14400 */
220#ifdef B28800
5260325f 221 case 28800:
222 return B28800;
8efc0c15 223#endif /* B28800 */
224#ifdef B57600
5260325f 225 case 57600:
226 return B57600;
8efc0c15 227#endif /* B57600 */
228#ifdef B76800
5260325f 229 case 76800:
230 return B76800;
8efc0c15 231#endif /* B76800 */
232#ifdef B115200
5260325f 233 case 115200:
234 return B115200;
8efc0c15 235#endif /* B115200 */
236#ifdef B230400
5260325f 237 case 230400:
238 return B230400;
8efc0c15 239#endif /* B230400 */
5260325f 240 default:
241 return B9600;
242 }
8efc0c15 243}
244
879abf01 245/*
246 * Encode a special character into SSH line format.
247 */
248static u_int
249special_char_encode(cc_t c)
250{
251#ifdef _POSIX_VDISABLE
252 if (c == _POSIX_VDISABLE)
253 return 255;
254#endif /* _POSIX_VDISABLE */
255 return c;
256}
257
258/*
259 * Decode a special character from SSH line format.
260 */
261static cc_t
262special_char_decode(u_int c)
263{
264#ifdef _POSIX_VDISABLE
265 if (c == 255)
266 return _POSIX_VDISABLE;
267#endif /* _POSIX_VDISABLE */
268 return c;
269}
270
5260325f 271/*
272 * Encodes terminal modes for the terminal referenced by fd
30dcc918 273 * or tiop in a portable manner, and appends the modes to a packet
5260325f 274 * being constructed.
275 */
6ae2364d 276void
30dcc918 277tty_make_modes(int fd, struct termios *tiop)
8efc0c15 278{
5260325f 279 struct termios tio;
280 int baud;
30dcc918 281 Buffer buf;
282 int tty_op_ospeed, tty_op_ispeed;
283 void (*put_arg)(Buffer *, u_int);
5260325f 284
30dcc918 285 buffer_init(&buf);
286 if (compat20) {
287 tty_op_ospeed = TTY_OP_OSPEED_PROTO2;
288 tty_op_ispeed = TTY_OP_ISPEED_PROTO2;
289 put_arg = buffer_put_int;
290 } else {
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;
5260325f 294 }
30dcc918 295
296 if (tiop == NULL) {
297 if (tcgetattr(fd, &tio) == -1) {
bbe88b6d 298 logit("tcgetattr: %.100s", strerror(errno));
30dcc918 299 goto end;
300 }
301 } else
302 tio = *tiop;
303
5260325f 304 /* Store input and output baud rates. */
305 baud = speed_to_baud(cfgetospeed(&tio));
b4e7177c 306 debug3("tty_make_modes: ospeed %d", baud);
30dcc918 307 buffer_put_char(&buf, tty_op_ospeed);
308 buffer_put_int(&buf, baud);
5260325f 309 baud = speed_to_baud(cfgetispeed(&tio));
b4e7177c 310 debug3("tty_make_modes: ispeed %d", baud);
30dcc918 311 buffer_put_char(&buf, tty_op_ispeed);
312 buffer_put_int(&buf, baud);
5260325f 313
314 /* Store values of mode flags. */
8efc0c15 315#define TTYCHAR(NAME, OP) \
b4e7177c 316 debug3("tty_make_modes: %d %d", OP, tio.c_cc[NAME]); \
30dcc918 317 buffer_put_char(&buf, OP); \
879abf01 318 put_arg(&buf, special_char_encode(tio.c_cc[NAME]));
30dcc918 319
8efc0c15 320#define TTYMODE(NAME, FIELD, OP) \
b4e7177c 321 debug3("tty_make_modes: %d %d", OP, ((tio.FIELD & NAME) != 0)); \
30dcc918 322 buffer_put_char(&buf, OP); \
323 put_arg(&buf, ((tio.FIELD & NAME) != 0));
8efc0c15 324
325#include "ttymodes.h"
326
327#undef TTYCHAR
328#undef TTYMODE
8efc0c15 329
30dcc918 330end:
5260325f 331 /* Mark end of mode data. */
30dcc918 332 buffer_put_char(&buf, TTY_OP_END);
333 if (compat20)
334 packet_put_string(buffer_ptr(&buf), buffer_len(&buf));
335 else
336 packet_put_raw(buffer_ptr(&buf), buffer_len(&buf));
337 buffer_free(&buf);
8efc0c15 338}
339
5260325f 340/*
341 * Decodes terminal modes for the terminal referenced by fd in a portable
342 * manner from a packet being read.
343 */
6ae2364d 344void
5260325f 345tty_parse_modes(int fd, int *n_bytes_ptr)
8efc0c15 346{
5260325f 347 struct termios tio;
348 int opcode, baud;
349 int n_bytes = 0;
350 int failure = 0;
30dcc918 351 u_int (*get_arg)(void);
352 int arg, arg_size;
353
354 if (compat20) {
355 *n_bytes_ptr = packet_get_int();
b4e7177c 356 debug3("tty_parse_modes: SSH2 n_bytes %d", *n_bytes_ptr);
30dcc918 357 if (*n_bytes_ptr == 0)
358 return;
359 get_arg = packet_get_int;
360 arg_size = 4;
361 } else {
362 get_arg = packet_get_char;
363 arg_size = 1;
364 }
5260325f 365
366 /*
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.
370 */
30dcc918 371 if (tcgetattr(fd, &tio) == -1) {
bbe88b6d 372 logit("tcgetattr: %.100s", strerror(errno));
5260325f 373 failure = -1;
30dcc918 374 }
5260325f 375
376 for (;;) {
377 n_bytes += 1;
378 opcode = packet_get_char();
379 switch (opcode) {
380 case TTY_OP_END:
381 goto set;
382
30dcc918 383 /* XXX: future conflict possible */
384 case TTY_OP_ISPEED_PROTO1:
385 case TTY_OP_ISPEED_PROTO2:
5260325f 386 n_bytes += 4;
387 baud = packet_get_int();
b4e7177c 388 debug3("tty_parse_modes: ispeed %d", baud);
30dcc918 389 if (failure != -1 && cfsetispeed(&tio, baud_to_speed(baud)) == -1)
5260325f 390 error("cfsetispeed failed for %d", baud);
391 break;
392
30dcc918 393 /* XXX: future conflict possible */
394 case TTY_OP_OSPEED_PROTO1:
395 case TTY_OP_OSPEED_PROTO2:
5260325f 396 n_bytes += 4;
397 baud = packet_get_int();
b4e7177c 398 debug3("tty_parse_modes: ospeed %d", baud);
30dcc918 399 if (failure != -1 && cfsetospeed(&tio, baud_to_speed(baud)) == -1)
5260325f 400 error("cfsetospeed failed for %d", baud);
401 break;
8efc0c15 402
30dcc918 403#define TTYCHAR(NAME, OP) \
404 case OP: \
405 n_bytes += arg_size; \
879abf01 406 tio.c_cc[NAME] = special_char_decode(get_arg()); \
b4e7177c 407 debug3("tty_parse_modes: %d %d", OP, tio.c_cc[NAME]); \
8efc0c15 408 break;
30dcc918 409#define TTYMODE(NAME, FIELD, OP) \
410 case OP: \
411 n_bytes += arg_size; \
412 if ((arg = get_arg())) \
413 tio.FIELD |= NAME; \
414 else \
415 tio.FIELD &= ~NAME; \
b4e7177c 416 debug3("tty_parse_modes: %d %d", OP, arg); \
8efc0c15 417 break;
8efc0c15 418
419#include "ttymodes.h"
420
421#undef TTYCHAR
422#undef TTYMODE
8efc0c15 423
5260325f 424 default:
425 debug("Ignoring unsupported tty mode opcode %d (0x%x)",
184eed6a 426 opcode, opcode);
30dcc918 427 if (!compat20) {
428 /*
429 * SSH1:
430 * Opcodes 1 to 127 are defined to have
431 * a one-byte argument.
762715ce 432 * Opcodes 128 to 159 are defined to have
433 * an integer argument.
434 */
30dcc918 435 if (opcode > 0 && opcode < 128) {
436 n_bytes += 1;
437 (void) packet_get_char();
438 break;
439 } else if (opcode >= 128 && opcode < 160) {
762715ce 440 n_bytes += 4;
441 (void) packet_get_int();
442 break;
30dcc918 443 } else {
444 /*
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.
450 */
bbe88b6d 451 logit("parse_tty_modes: unknown opcode %d", opcode);
30dcc918 452 goto set;
762715ce 453 }
5260325f 454 } else {
455 /*
30dcc918 456 * SSH2:
e4664c3e 457 * Opcodes 1 to 159 are defined to have
30dcc918 458 * a uint32 argument.
459 * Opcodes 160 to 255 are undefined and
460 * cause parsing to stop.
5260325f 461 */
30dcc918 462 if (opcode > 0 && opcode < 160) {
5260325f 463 n_bytes += 4;
464 (void) packet_get_int();
465 break;
30dcc918 466 } else {
bbe88b6d 467 logit("parse_tty_modes: unknown opcode %d", opcode);
30dcc918 468 goto set;
5260325f 469 }
762715ce 470 }
8efc0c15 471 }
8efc0c15 472 }
8efc0c15 473
5260325f 474set:
475 if (*n_bytes_ptr != n_bytes) {
476 *n_bytes_ptr = n_bytes;
bbe88b6d 477 logit("parse_tty_modes: n_bytes_ptr != n_bytes: %d %d",
30dcc918 478 *n_bytes_ptr, n_bytes);
5260325f 479 return; /* Don't process bytes passed */
480 }
481 if (failure == -1)
e4664c3e 482 return; /* Packet parsed ok but tcgetattr() failed */
8efc0c15 483
5260325f 484 /* Set the new modes for the terminal. */
30dcc918 485 if (tcsetattr(fd, TCSANOW, &tio) == -1)
bbe88b6d 486 logit("Setting tty modes failed: %.100s", strerror(errno));
8efc0c15 487}
This page took 1.9747 seconds and 5 git commands to generate.