Annotation of src/usr.bin/ssh/ttymodes.c, Revision 1.29
1.29 ! stevesk 1: /* $OpenBSD: ttymodes.c,v 1.28 2008/07/07 00:31:41 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.9 markus 55: #include "ssh1.h"
1.12 stevesk 56: #include "compat.h"
57: #include "buffer.h"
1.1 deraadt 58:
1.12 stevesk 59: #define TTY_OP_END 0
60: /*
61: * uint32 (u_int) follows speed in SSH1 and SSH2
62: */
63: #define TTY_OP_ISPEED_PROTO1 192
64: #define TTY_OP_OSPEED_PROTO1 193
65: #define TTY_OP_ISPEED_PROTO2 128
66: #define TTY_OP_OSPEED_PROTO2 129
1.1 deraadt 67:
1.4 deraadt 68: /*
69: * Converts POSIX speed_t to a baud rate. The values of the
70: * constants for speed_t are not themselves portable.
71: */
1.6 markus 72: static int
1.3 markus 73: speed_to_baud(speed_t speed)
1.1 deraadt 74: {
1.3 markus 75: switch (speed) {
76: case B0:
77: return 0;
78: case B50:
79: return 50;
80: case B75:
81: return 75;
82: case B110:
83: return 110;
84: case B134:
85: return 134;
86: case B150:
87: return 150;
88: case B200:
89: return 200;
90: case B300:
91: return 300;
92: case B600:
93: return 600;
94: case B1200:
95: return 1200;
96: case B1800:
97: return 1800;
98: case B2400:
99: return 2400;
100: case B4800:
101: return 4800;
102: case B9600:
103: return 9600;
1.1 deraadt 104:
105: #ifdef B19200
1.3 markus 106: case B19200:
107: return 19200;
1.1 deraadt 108: #else /* B19200 */
109: #ifdef EXTA
1.3 markus 110: case EXTA:
111: return 19200;
1.1 deraadt 112: #endif /* EXTA */
113: #endif /* B19200 */
114:
115: #ifdef B38400
1.3 markus 116: case B38400:
117: return 38400;
1.1 deraadt 118: #else /* B38400 */
119: #ifdef EXTB
1.3 markus 120: case EXTB:
121: return 38400;
1.1 deraadt 122: #endif /* EXTB */
123: #endif /* B38400 */
124:
125: #ifdef B7200
1.3 markus 126: case B7200:
127: return 7200;
1.1 deraadt 128: #endif /* B7200 */
129: #ifdef B14400
1.3 markus 130: case B14400:
131: return 14400;
1.1 deraadt 132: #endif /* B14400 */
133: #ifdef B28800
1.3 markus 134: case B28800:
135: return 28800;
1.1 deraadt 136: #endif /* B28800 */
137: #ifdef B57600
1.3 markus 138: case B57600:
139: return 57600;
1.1 deraadt 140: #endif /* B57600 */
141: #ifdef B76800
1.3 markus 142: case B76800:
143: return 76800;
1.1 deraadt 144: #endif /* B76800 */
145: #ifdef B115200
1.3 markus 146: case B115200:
147: return 115200;
1.1 deraadt 148: #endif /* B115200 */
149: #ifdef B230400
1.3 markus 150: case B230400:
151: return 230400;
1.1 deraadt 152: #endif /* B230400 */
1.3 markus 153: default:
154: return 9600;
155: }
1.1 deraadt 156: }
157:
1.4 deraadt 158: /*
159: * Converts a numeric baud rate to a POSIX speed_t.
160: */
1.6 markus 161: static speed_t
1.3 markus 162: baud_to_speed(int baud)
1.1 deraadt 163: {
1.3 markus 164: switch (baud) {
1.12 stevesk 165: case 0:
1.3 markus 166: return B0;
167: case 50:
168: return B50;
169: case 75:
170: return B75;
171: case 110:
172: return B110;
173: case 134:
174: return B134;
175: case 150:
176: return B150;
177: case 200:
178: return B200;
179: case 300:
180: return B300;
181: case 600:
182: return B600;
183: case 1200:
184: return B1200;
185: case 1800:
186: return B1800;
187: case 2400:
188: return B2400;
189: case 4800:
190: return B4800;
191: case 9600:
192: return B9600;
1.1 deraadt 193:
194: #ifdef B19200
1.3 markus 195: case 19200:
196: return B19200;
1.1 deraadt 197: #else /* B19200 */
198: #ifdef EXTA
1.3 markus 199: case 19200:
200: return EXTA;
1.1 deraadt 201: #endif /* EXTA */
202: #endif /* B19200 */
203:
204: #ifdef B38400
1.3 markus 205: case 38400:
206: return B38400;
1.1 deraadt 207: #else /* B38400 */
208: #ifdef EXTB
1.3 markus 209: case 38400:
210: return EXTB;
1.1 deraadt 211: #endif /* EXTB */
212: #endif /* B38400 */
213:
214: #ifdef B7200
1.3 markus 215: case 7200:
216: return B7200;
1.1 deraadt 217: #endif /* B7200 */
218: #ifdef B14400
1.3 markus 219: case 14400:
220: return B14400;
1.1 deraadt 221: #endif /* B14400 */
222: #ifdef B28800
1.3 markus 223: case 28800:
224: return B28800;
1.1 deraadt 225: #endif /* B28800 */
226: #ifdef B57600
1.3 markus 227: case 57600:
228: return B57600;
1.1 deraadt 229: #endif /* B57600 */
230: #ifdef B76800
1.3 markus 231: case 76800:
232: return B76800;
1.1 deraadt 233: #endif /* B76800 */
234: #ifdef B115200
1.3 markus 235: case 115200:
236: return B115200;
1.1 deraadt 237: #endif /* B115200 */
238: #ifdef B230400
1.3 markus 239: case 230400:
240: return B230400;
1.1 deraadt 241: #endif /* B230400 */
1.3 markus 242: default:
243: return B9600;
244: }
1.1 deraadt 245: }
246:
1.4 deraadt 247: /*
248: * Encodes terminal modes for the terminal referenced by fd
1.12 stevesk 249: * or tiop in a portable manner, and appends the modes to a packet
1.4 deraadt 250: * being constructed.
251: */
1.6 markus 252: void
1.12 stevesk 253: tty_make_modes(int fd, struct termios *tiop)
1.1 deraadt 254: {
1.3 markus 255: struct termios tio;
256: int baud;
1.12 stevesk 257: Buffer buf;
258: int tty_op_ospeed, tty_op_ispeed;
259: void (*put_arg)(Buffer *, u_int);
260:
261: buffer_init(&buf);
262: if (compat20) {
263: tty_op_ospeed = TTY_OP_OSPEED_PROTO2;
264: tty_op_ispeed = TTY_OP_ISPEED_PROTO2;
265: put_arg = buffer_put_int;
266: } else {
267: tty_op_ospeed = TTY_OP_OSPEED_PROTO1;
268: tty_op_ispeed = TTY_OP_ISPEED_PROTO1;
269: put_arg = (void (*)(Buffer *, u_int)) buffer_put_char;
270: }
271:
272: if (tiop == NULL) {
1.27 djm 273: if (fd == -1) {
274: debug("tty_make_modes: no fd or tio");
275: goto end;
276: }
1.12 stevesk 277: if (tcgetattr(fd, &tio) == -1) {
1.19 itojun 278: logit("tcgetattr: %.100s", strerror(errno));
1.12 stevesk 279: goto end;
280: }
281: } else
282: tio = *tiop;
1.1 deraadt 283:
1.3 markus 284: /* Store input and output baud rates. */
285: baud = speed_to_baud(cfgetospeed(&tio));
1.12 stevesk 286: buffer_put_char(&buf, tty_op_ospeed);
287: buffer_put_int(&buf, baud);
1.3 markus 288: baud = speed_to_baud(cfgetispeed(&tio));
1.12 stevesk 289: buffer_put_char(&buf, tty_op_ispeed);
290: buffer_put_int(&buf, baud);
1.1 deraadt 291:
1.3 markus 292: /* Store values of mode flags. */
1.1 deraadt 293: #define TTYCHAR(NAME, OP) \
1.12 stevesk 294: buffer_put_char(&buf, OP); \
295: put_arg(&buf, tio.c_cc[NAME]);
296:
1.1 deraadt 297: #define TTYMODE(NAME, FIELD, OP) \
1.12 stevesk 298: buffer_put_char(&buf, OP); \
299: put_arg(&buf, ((tio.FIELD & NAME) != 0));
1.1 deraadt 300:
301: #include "ttymodes.h"
302:
303: #undef TTYCHAR
304: #undef TTYMODE
305:
1.12 stevesk 306: end:
1.3 markus 307: /* Mark end of mode data. */
1.12 stevesk 308: buffer_put_char(&buf, TTY_OP_END);
309: if (compat20)
310: packet_put_string(buffer_ptr(&buf), buffer_len(&buf));
311: else
312: packet_put_raw(buffer_ptr(&buf), buffer_len(&buf));
313: buffer_free(&buf);
1.1 deraadt 314: }
315:
1.4 deraadt 316: /*
317: * Decodes terminal modes for the terminal referenced by fd in a portable
318: * manner from a packet being read.
319: */
1.6 markus 320: void
1.3 markus 321: tty_parse_modes(int fd, int *n_bytes_ptr)
1.1 deraadt 322: {
1.3 markus 323: struct termios tio;
324: int opcode, baud;
325: int n_bytes = 0;
326: int failure = 0;
1.12 stevesk 327: u_int (*get_arg)(void);
1.28 stevesk 328: int arg_size;
1.12 stevesk 329:
330: if (compat20) {
331: *n_bytes_ptr = packet_get_int();
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.22 deraadt 363: if (failure != -1 &&
364: cfsetispeed(&tio, baud_to_speed(baud)) == -1)
1.3 markus 365: error("cfsetispeed failed for %d", baud);
366: break;
367:
1.12 stevesk 368: /* XXX: future conflict possible */
369: case TTY_OP_OSPEED_PROTO1:
370: case TTY_OP_OSPEED_PROTO2:
1.3 markus 371: n_bytes += 4;
372: baud = packet_get_int();
1.22 deraadt 373: if (failure != -1 &&
374: cfsetospeed(&tio, baud_to_speed(baud)) == -1)
1.3 markus 375: error("cfsetospeed failed for %d", baud);
376: break;
1.1 deraadt 377:
1.12 stevesk 378: #define TTYCHAR(NAME, OP) \
379: case OP: \
380: n_bytes += arg_size; \
381: tio.c_cc[NAME] = get_arg(); \
1.1 deraadt 382: break;
1.12 stevesk 383: #define TTYMODE(NAME, FIELD, OP) \
384: case OP: \
385: n_bytes += arg_size; \
1.28 stevesk 386: if (get_arg()) \
1.12 stevesk 387: tio.FIELD |= NAME; \
388: else \
389: tio.FIELD &= ~NAME; \
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
1.22 deraadt 420: * must stop parsing. Note that some data
421: * may be left in the packet; hopefully there
422: * is nothing more coming after the mode data.
1.12 stevesk 423: */
1.22 deraadt 424: logit("parse_tty_modes: unknown opcode %d",
425: 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.22 deraadt 441: logit("parse_tty_modes: unknown opcode %d",
442: opcode);
1.12 stevesk 443: goto set;
1.3 markus 444: }
1.17 markus 445: }
1.1 deraadt 446: }
447: }
448:
1.3 markus 449: set:
450: if (*n_bytes_ptr != n_bytes) {
451: *n_bytes_ptr = n_bytes;
1.19 itojun 452: logit("parse_tty_modes: n_bytes_ptr != n_bytes: %d %d",
1.12 stevesk 453: *n_bytes_ptr, n_bytes);
1.3 markus 454: return; /* Don't process bytes passed */
455: }
456: if (failure == -1)
1.13 stevesk 457: return; /* Packet parsed ok but tcgetattr() failed */
1.3 markus 458:
459: /* Set the new modes for the terminal. */
1.12 stevesk 460: if (tcsetattr(fd, TCSANOW, &tio) == -1)
1.19 itojun 461: logit("Setting tty modes failed: %.100s", strerror(errno));
1.1 deraadt 462: }
![[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