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