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