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