Annotation of src/usr.bin/ssh/ttymodes.c, Revision 1.20
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: RCSID("$OpenBSD: ttymodes.c,v 1.19 2003/04/08 20:21:29 itojun Exp $");
! 47:
! 48: #include <termios.h>
1.1 deraadt 49:
50: #include "packet.h"
1.10 markus 51: #include "log.h"
1.9 markus 52: #include "ssh1.h"
1.12 stevesk 53: #include "compat.h"
54: #include "buffer.h"
55: #include "bufaux.h"
1.1 deraadt 56:
1.12 stevesk 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
1.1 deraadt 65:
1.4 deraadt 66: /*
67: * Converts POSIX speed_t to a baud rate. The values of the
68: * constants for speed_t are not themselves portable.
69: */
1.6 markus 70: static int
1.3 markus 71: speed_to_baud(speed_t speed)
1.1 deraadt 72: {
1.3 markus 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;
1.1 deraadt 102:
103: #ifdef B19200
1.3 markus 104: case B19200:
105: return 19200;
1.1 deraadt 106: #else /* B19200 */
107: #ifdef EXTA
1.3 markus 108: case EXTA:
109: return 19200;
1.1 deraadt 110: #endif /* EXTA */
111: #endif /* B19200 */
112:
113: #ifdef B38400
1.3 markus 114: case B38400:
115: return 38400;
1.1 deraadt 116: #else /* B38400 */
117: #ifdef EXTB
1.3 markus 118: case EXTB:
119: return 38400;
1.1 deraadt 120: #endif /* EXTB */
121: #endif /* B38400 */
122:
123: #ifdef B7200
1.3 markus 124: case B7200:
125: return 7200;
1.1 deraadt 126: #endif /* B7200 */
127: #ifdef B14400
1.3 markus 128: case B14400:
129: return 14400;
1.1 deraadt 130: #endif /* B14400 */
131: #ifdef B28800
1.3 markus 132: case B28800:
133: return 28800;
1.1 deraadt 134: #endif /* B28800 */
135: #ifdef B57600
1.3 markus 136: case B57600:
137: return 57600;
1.1 deraadt 138: #endif /* B57600 */
139: #ifdef B76800
1.3 markus 140: case B76800:
141: return 76800;
1.1 deraadt 142: #endif /* B76800 */
143: #ifdef B115200
1.3 markus 144: case B115200:
145: return 115200;
1.1 deraadt 146: #endif /* B115200 */
147: #ifdef B230400
1.3 markus 148: case B230400:
149: return 230400;
1.1 deraadt 150: #endif /* B230400 */
1.3 markus 151: default:
152: return 9600;
153: }
1.1 deraadt 154: }
155:
1.4 deraadt 156: /*
157: * Converts a numeric baud rate to a POSIX speed_t.
158: */
1.6 markus 159: static speed_t
1.3 markus 160: baud_to_speed(int baud)
1.1 deraadt 161: {
1.3 markus 162: switch (baud) {
1.12 stevesk 163: case 0:
1.3 markus 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;
1.1 deraadt 191:
192: #ifdef B19200
1.3 markus 193: case 19200:
194: return B19200;
1.1 deraadt 195: #else /* B19200 */
196: #ifdef EXTA
1.3 markus 197: case 19200:
198: return EXTA;
1.1 deraadt 199: #endif /* EXTA */
200: #endif /* B19200 */
201:
202: #ifdef B38400
1.3 markus 203: case 38400:
204: return B38400;
1.1 deraadt 205: #else /* B38400 */
206: #ifdef EXTB
1.3 markus 207: case 38400:
208: return EXTB;
1.1 deraadt 209: #endif /* EXTB */
210: #endif /* B38400 */
211:
212: #ifdef B7200
1.3 markus 213: case 7200:
214: return B7200;
1.1 deraadt 215: #endif /* B7200 */
216: #ifdef B14400
1.3 markus 217: case 14400:
218: return B14400;
1.1 deraadt 219: #endif /* B14400 */
220: #ifdef B28800
1.3 markus 221: case 28800:
222: return B28800;
1.1 deraadt 223: #endif /* B28800 */
224: #ifdef B57600
1.3 markus 225: case 57600:
226: return B57600;
1.1 deraadt 227: #endif /* B57600 */
228: #ifdef B76800
1.3 markus 229: case 76800:
230: return B76800;
1.1 deraadt 231: #endif /* B76800 */
232: #ifdef B115200
1.3 markus 233: case 115200:
234: return B115200;
1.1 deraadt 235: #endif /* B115200 */
236: #ifdef B230400
1.3 markus 237: case 230400:
238: return B230400;
1.1 deraadt 239: #endif /* B230400 */
1.3 markus 240: default:
241: return B9600;
242: }
1.1 deraadt 243: }
244:
1.4 deraadt 245: /*
246: * Encodes terminal modes for the terminal referenced by fd
1.12 stevesk 247: * or tiop in a portable manner, and appends the modes to a packet
1.4 deraadt 248: * being constructed.
249: */
1.6 markus 250: void
1.12 stevesk 251: tty_make_modes(int fd, struct termios *tiop)
1.1 deraadt 252: {
1.3 markus 253: struct termios tio;
254: int baud;
1.12 stevesk 255: Buffer buf;
256: int tty_op_ospeed, tty_op_ispeed;
257: void (*put_arg)(Buffer *, u_int);
258:
259: buffer_init(&buf);
260: if (compat20) {
261: tty_op_ospeed = TTY_OP_OSPEED_PROTO2;
262: tty_op_ispeed = TTY_OP_ISPEED_PROTO2;
263: put_arg = buffer_put_int;
264: } else {
265: tty_op_ospeed = TTY_OP_OSPEED_PROTO1;
266: tty_op_ispeed = TTY_OP_ISPEED_PROTO1;
267: put_arg = (void (*)(Buffer *, u_int)) buffer_put_char;
268: }
269:
270: if (tiop == NULL) {
271: if (tcgetattr(fd, &tio) == -1) {
1.19 itojun 272: logit("tcgetattr: %.100s", strerror(errno));
1.12 stevesk 273: goto end;
274: }
275: } else
276: tio = *tiop;
1.1 deraadt 277:
1.3 markus 278: /* Store input and output baud rates. */
279: baud = speed_to_baud(cfgetospeed(&tio));
1.14 markus 280: debug3("tty_make_modes: ospeed %d", baud);
1.12 stevesk 281: buffer_put_char(&buf, tty_op_ospeed);
282: buffer_put_int(&buf, baud);
1.3 markus 283: baud = speed_to_baud(cfgetispeed(&tio));
1.14 markus 284: debug3("tty_make_modes: ispeed %d", baud);
1.12 stevesk 285: buffer_put_char(&buf, tty_op_ispeed);
286: buffer_put_int(&buf, baud);
1.1 deraadt 287:
1.3 markus 288: /* Store values of mode flags. */
1.1 deraadt 289: #define TTYCHAR(NAME, OP) \
1.14 markus 290: debug3("tty_make_modes: %d %d", OP, tio.c_cc[NAME]); \
1.12 stevesk 291: buffer_put_char(&buf, OP); \
292: put_arg(&buf, tio.c_cc[NAME]);
293:
1.1 deraadt 294: #define TTYMODE(NAME, FIELD, OP) \
1.14 markus 295: debug3("tty_make_modes: %d %d", OP, ((tio.FIELD & NAME) != 0)); \
1.12 stevesk 296: buffer_put_char(&buf, OP); \
297: put_arg(&buf, ((tio.FIELD & NAME) != 0));
1.1 deraadt 298:
299: #include "ttymodes.h"
300:
301: #undef TTYCHAR
302: #undef TTYMODE
303:
1.12 stevesk 304: end:
1.3 markus 305: /* Mark end of mode data. */
1.12 stevesk 306: buffer_put_char(&buf, TTY_OP_END);
307: if (compat20)
308: packet_put_string(buffer_ptr(&buf), buffer_len(&buf));
309: else
310: packet_put_raw(buffer_ptr(&buf), buffer_len(&buf));
311: buffer_free(&buf);
1.1 deraadt 312: }
313:
1.4 deraadt 314: /*
315: * Decodes terminal modes for the terminal referenced by fd in a portable
316: * manner from a packet being read.
317: */
1.6 markus 318: void
1.3 markus 319: tty_parse_modes(int fd, int *n_bytes_ptr)
1.1 deraadt 320: {
1.3 markus 321: struct termios tio;
322: int opcode, baud;
323: int n_bytes = 0;
324: int failure = 0;
1.12 stevesk 325: u_int (*get_arg)(void);
326: int arg, arg_size;
327:
328: if (compat20) {
329: *n_bytes_ptr = packet_get_int();
1.14 markus 330: debug3("tty_parse_modes: SSH2 n_bytes %d", *n_bytes_ptr);
1.12 stevesk 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.14 markus 362: debug3("tty_parse_modes: ispeed %d", baud);
1.12 stevesk 363: if (failure != -1 && 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.14 markus 372: debug3("tty_parse_modes: ospeed %d", baud);
1.12 stevesk 373: if (failure != -1 && 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.14 markus 381: debug3("tty_parse_modes: %d %d", OP, tio.c_cc[NAME]); \
1.1 deraadt 382: break;
1.12 stevesk 383: #define TTYMODE(NAME, FIELD, OP) \
384: case OP: \
385: n_bytes += arg_size; \
386: if ((arg = get_arg())) \
387: tio.FIELD |= NAME; \
388: else \
389: tio.FIELD &= ~NAME; \
1.14 markus 390: debug3("tty_parse_modes: %d %d", OP, arg); \
1.1 deraadt 391: break;
392:
393: #include "ttymodes.h"
394:
395: #undef TTYCHAR
396: #undef TTYMODE
397:
1.3 markus 398: default:
399: debug("Ignoring unsupported tty mode opcode %d (0x%x)",
1.15 deraadt 400: opcode, opcode);
1.12 stevesk 401: if (!compat20) {
402: /*
403: * SSH1:
404: * Opcodes 1 to 127 are defined to have
405: * a one-byte argument.
1.17 markus 406: * Opcodes 128 to 159 are defined to have
407: * an integer argument.
408: */
1.12 stevesk 409: if (opcode > 0 && opcode < 128) {
410: n_bytes += 1;
411: (void) packet_get_char();
412: break;
413: } else if (opcode >= 128 && opcode < 160) {
1.17 markus 414: n_bytes += 4;
415: (void) packet_get_int();
416: break;
1.12 stevesk 417: } else {
418: /*
419: * It is a truly undefined opcode (160 to 255).
420: * We have no idea about its arguments. So we
421: * must stop parsing. Note that some data may be
422: * left in the packet; hopefully there is nothing
423: * more coming after the mode data.
424: */
1.19 itojun 425: logit("parse_tty_modes: unknown opcode %d", opcode);
1.12 stevesk 426: goto set;
1.17 markus 427: }
1.3 markus 428: } else {
1.4 deraadt 429: /*
1.12 stevesk 430: * SSH2:
1.13 stevesk 431: * Opcodes 1 to 159 are defined to have
1.12 stevesk 432: * a uint32 argument.
433: * Opcodes 160 to 255 are undefined and
434: * cause parsing to stop.
1.4 deraadt 435: */
1.12 stevesk 436: if (opcode > 0 && opcode < 160) {
1.3 markus 437: n_bytes += 4;
438: (void) packet_get_int();
439: break;
1.12 stevesk 440: } else {
1.19 itojun 441: logit("parse_tty_modes: unknown opcode %d", 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