Annotation of src/usr.bin/ssh/ttymodes.c, Revision 1.30
1.30 ! markus 1: /* $OpenBSD: ttymodes.c,v 1.29 2008/11/02 00:16:16 stevesk 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.26 deraadt 46: #include <sys/types.h>
1.20 stevesk 47:
1.24 stevesk 48: #include <errno.h>
1.25 stevesk 49: #include <string.h>
1.20 stevesk 50: #include <termios.h>
1.26 deraadt 51: #include <stdarg.h>
1.1 deraadt 52:
53: #include "packet.h"
1.10 markus 54: #include "log.h"
1.12 stevesk 55: #include "compat.h"
56: #include "buffer.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) {
1.27 djm 272: if (fd == -1) {
273: debug("tty_make_modes: no fd or tio");
274: goto end;
275: }
1.12 stevesk 276: if (tcgetattr(fd, &tio) == -1) {
1.19 itojun 277: logit("tcgetattr: %.100s", strerror(errno));
1.12 stevesk 278: goto end;
279: }
280: } else
281: tio = *tiop;
1.1 deraadt 282:
1.3 markus 283: /* Store input and output baud rates. */
284: baud = speed_to_baud(cfgetospeed(&tio));
1.12 stevesk 285: buffer_put_char(&buf, tty_op_ospeed);
286: buffer_put_int(&buf, baud);
1.3 markus 287: baud = speed_to_baud(cfgetispeed(&tio));
1.12 stevesk 288: buffer_put_char(&buf, tty_op_ispeed);
289: buffer_put_int(&buf, baud);
1.1 deraadt 290:
1.3 markus 291: /* Store values of mode flags. */
1.1 deraadt 292: #define TTYCHAR(NAME, OP) \
1.12 stevesk 293: buffer_put_char(&buf, OP); \
294: put_arg(&buf, tio.c_cc[NAME]);
295:
1.1 deraadt 296: #define TTYMODE(NAME, FIELD, OP) \
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);
1.28 stevesk 327: int arg_size;
1.12 stevesk 328:
329: if (compat20) {
330: *n_bytes_ptr = packet_get_int();
331: if (*n_bytes_ptr == 0)
332: return;
333: get_arg = packet_get_int;
334: arg_size = 4;
335: } else {
336: get_arg = packet_get_char;
337: arg_size = 1;
338: }
1.3 markus 339:
1.4 deraadt 340: /*
341: * Get old attributes for the terminal. We will modify these
342: * flags. I am hoping that if there are any machine-specific
343: * modes, they will initially have reasonable values.
344: */
1.12 stevesk 345: if (tcgetattr(fd, &tio) == -1) {
1.19 itojun 346: logit("tcgetattr: %.100s", strerror(errno));
1.3 markus 347: failure = -1;
1.12 stevesk 348: }
1.3 markus 349:
350: for (;;) {
351: n_bytes += 1;
352: opcode = packet_get_char();
353: switch (opcode) {
354: case TTY_OP_END:
355: goto set;
356:
1.12 stevesk 357: /* XXX: future conflict possible */
358: case TTY_OP_ISPEED_PROTO1:
359: case TTY_OP_ISPEED_PROTO2:
1.3 markus 360: n_bytes += 4;
361: baud = packet_get_int();
1.22 deraadt 362: if (failure != -1 &&
363: cfsetispeed(&tio, baud_to_speed(baud)) == -1)
1.3 markus 364: error("cfsetispeed failed for %d", baud);
365: break;
366:
1.12 stevesk 367: /* XXX: future conflict possible */
368: case TTY_OP_OSPEED_PROTO1:
369: case TTY_OP_OSPEED_PROTO2:
1.3 markus 370: n_bytes += 4;
371: baud = packet_get_int();
1.22 deraadt 372: if (failure != -1 &&
373: cfsetospeed(&tio, baud_to_speed(baud)) == -1)
1.3 markus 374: error("cfsetospeed failed for %d", baud);
375: break;
1.1 deraadt 376:
1.12 stevesk 377: #define TTYCHAR(NAME, OP) \
378: case OP: \
379: n_bytes += arg_size; \
380: tio.c_cc[NAME] = get_arg(); \
1.1 deraadt 381: break;
1.12 stevesk 382: #define TTYMODE(NAME, FIELD, OP) \
383: case OP: \
384: n_bytes += arg_size; \
1.28 stevesk 385: if (get_arg()) \
1.12 stevesk 386: tio.FIELD |= NAME; \
387: else \
388: tio.FIELD &= ~NAME; \
1.1 deraadt 389: break;
390:
391: #include "ttymodes.h"
392:
393: #undef TTYCHAR
394: #undef TTYMODE
395:
1.3 markus 396: default:
397: debug("Ignoring unsupported tty mode opcode %d (0x%x)",
1.15 deraadt 398: opcode, opcode);
1.12 stevesk 399: if (!compat20) {
400: /*
401: * SSH1:
402: * Opcodes 1 to 127 are defined to have
403: * a one-byte argument.
1.17 markus 404: * Opcodes 128 to 159 are defined to have
405: * an integer argument.
406: */
1.12 stevesk 407: if (opcode > 0 && opcode < 128) {
408: n_bytes += 1;
409: (void) packet_get_char();
410: break;
411: } else if (opcode >= 128 && opcode < 160) {
1.17 markus 412: n_bytes += 4;
413: (void) packet_get_int();
414: break;
1.12 stevesk 415: } else {
416: /*
417: * It is a truly undefined opcode (160 to 255).
418: * We have no idea about its arguments. So we
1.22 deraadt 419: * must stop parsing. Note that some data
420: * may be left in the packet; hopefully there
421: * is nothing more coming after the mode data.
1.12 stevesk 422: */
1.22 deraadt 423: logit("parse_tty_modes: unknown opcode %d",
424: 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.22 deraadt 440: logit("parse_tty_modes: unknown opcode %d",
441: opcode);
1.12 stevesk 442: goto set;
1.3 markus 443: }
1.17 markus 444: }
1.1 deraadt 445: }
446: }
447:
1.3 markus 448: set:
449: if (*n_bytes_ptr != n_bytes) {
450: *n_bytes_ptr = n_bytes;
1.19 itojun 451: logit("parse_tty_modes: n_bytes_ptr != n_bytes: %d %d",
1.12 stevesk 452: *n_bytes_ptr, n_bytes);
1.3 markus 453: return; /* Don't process bytes passed */
454: }
455: if (failure == -1)
1.13 stevesk 456: return; /* Packet parsed ok but tcgetattr() failed */
1.3 markus 457:
458: /* Set the new modes for the terminal. */
1.12 stevesk 459: if (tcsetattr(fd, TCSANOW, &tio) == -1)
1.19 itojun 460: logit("Setting tty modes failed: %.100s", strerror(errno));
1.1 deraadt 461: }
![[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