[BACK]Return to ttymodes.c CVS log [TXT][DIR] Up to [local] / src / usr.bin / ssh

Annotation of src/usr.bin/ssh/ttymodes.c, Revision 1.33

1.33    ! dtucker     1: /* $OpenBSD: ttymodes.c,v 1.32 2017/04/30 23:26:54 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.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.33    ! dtucker    57: #include "compat.h"
1.1       deraadt    58:
1.12      stevesk    59: #define TTY_OP_END             0
                     60: /*
1.32      djm        61:  * uint32 (u_int) follows speed.
1.12      stevesk    62:  */
1.32      djm        63: #define TTY_OP_ISPEED  128
                     64: #define TTY_OP_OSPEED  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:
                    257:        buffer_init(&buf);
                    258:
                    259:        if (tiop == NULL) {
1.27      djm       260:                if (fd == -1) {
                    261:                        debug("tty_make_modes: no fd or tio");
                    262:                        goto end;
                    263:                }
1.12      stevesk   264:                if (tcgetattr(fd, &tio) == -1) {
1.19      itojun    265:                        logit("tcgetattr: %.100s", strerror(errno));
1.12      stevesk   266:                        goto end;
                    267:                }
                    268:        } else
                    269:                tio = *tiop;
1.1       deraadt   270:
1.3       markus    271:        /* Store input and output baud rates. */
                    272:        baud = speed_to_baud(cfgetospeed(&tio));
1.32      djm       273:        buffer_put_char(&buf, TTY_OP_OSPEED);
1.12      stevesk   274:        buffer_put_int(&buf, baud);
1.3       markus    275:        baud = speed_to_baud(cfgetispeed(&tio));
1.32      djm       276:        buffer_put_char(&buf, TTY_OP_ISPEED);
1.12      stevesk   277:        buffer_put_int(&buf, baud);
1.1       deraadt   278:
1.3       markus    279:        /* Store values of mode flags. */
1.1       deraadt   280: #define TTYCHAR(NAME, OP) \
1.12      stevesk   281:        buffer_put_char(&buf, OP); \
1.31      djm       282:        buffer_put_int(&buf, tio.c_cc[NAME]);
1.12      stevesk   283:
1.33    ! dtucker   284: #define SSH_TTYMODE_IUTF8 42  /* for SSH_BUG_UTF8TTYMODE */
        !           285:
1.1       deraadt   286: #define TTYMODE(NAME, FIELD, OP) \
1.33    ! dtucker   287:        if (OP == SSH_TTYMODE_IUTF8 && (datafellows & SSH_BUG_UTF8TTYMODE)) { \
        !           288:                debug3("%s: SSH_BUG_UTF8TTYMODE", __func__); \
        !           289:        } else { \
        !           290:                buffer_put_char(&buf, OP); \
        !           291:                buffer_put_int(&buf, ((tio.FIELD & NAME) != 0)); \
        !           292:        }
1.1       deraadt   293:
                    294: #include "ttymodes.h"
                    295:
                    296: #undef TTYCHAR
                    297: #undef TTYMODE
                    298:
1.12      stevesk   299: end:
1.3       markus    300:        /* Mark end of mode data. */
1.12      stevesk   301:        buffer_put_char(&buf, TTY_OP_END);
1.31      djm       302:        packet_put_string(buffer_ptr(&buf), buffer_len(&buf));
1.12      stevesk   303:        buffer_free(&buf);
1.1       deraadt   304: }
                    305:
1.4       deraadt   306: /*
                    307:  * Decodes terminal modes for the terminal referenced by fd in a portable
                    308:  * manner from a packet being read.
                    309:  */
1.6       markus    310: void
1.3       markus    311: tty_parse_modes(int fd, int *n_bytes_ptr)
1.1       deraadt   312: {
1.3       markus    313:        struct termios tio;
                    314:        int opcode, baud;
                    315:        int n_bytes = 0;
                    316:        int failure = 0;
1.12      stevesk   317:
1.31      djm       318:        *n_bytes_ptr = packet_get_int();
                    319:        if (*n_bytes_ptr == 0)
                    320:                return;
1.3       markus    321:
1.4       deraadt   322:        /*
                    323:         * Get old attributes for the terminal.  We will modify these
                    324:         * flags. I am hoping that if there are any machine-specific
                    325:         * modes, they will initially have reasonable values.
                    326:         */
1.12      stevesk   327:        if (tcgetattr(fd, &tio) == -1) {
1.19      itojun    328:                logit("tcgetattr: %.100s", strerror(errno));
1.3       markus    329:                failure = -1;
1.12      stevesk   330:        }
1.3       markus    331:
                    332:        for (;;) {
                    333:                n_bytes += 1;
                    334:                opcode = packet_get_char();
                    335:                switch (opcode) {
                    336:                case TTY_OP_END:
                    337:                        goto set;
                    338:
1.32      djm       339:                case TTY_OP_ISPEED:
1.3       markus    340:                        n_bytes += 4;
                    341:                        baud = packet_get_int();
1.22      deraadt   342:                        if (failure != -1 &&
                    343:                            cfsetispeed(&tio, baud_to_speed(baud)) == -1)
1.3       markus    344:                                error("cfsetispeed failed for %d", baud);
                    345:                        break;
                    346:
1.32      djm       347:                case TTY_OP_OSPEED:
1.3       markus    348:                        n_bytes += 4;
                    349:                        baud = packet_get_int();
1.22      deraadt   350:                        if (failure != -1 &&
                    351:                            cfsetospeed(&tio, baud_to_speed(baud)) == -1)
1.3       markus    352:                                error("cfsetospeed failed for %d", baud);
                    353:                        break;
1.1       deraadt   354:
1.12      stevesk   355: #define TTYCHAR(NAME, OP) \
                    356:        case OP: \
1.31      djm       357:          n_bytes += 4; \
                    358:          tio.c_cc[NAME] = packet_get_int(); \
1.1       deraadt   359:          break;
1.12      stevesk   360: #define TTYMODE(NAME, FIELD, OP) \
                    361:        case OP: \
1.31      djm       362:          n_bytes += 4; \
                    363:          if (packet_get_int()) \
1.12      stevesk   364:            tio.FIELD |= NAME; \
                    365:          else \
                    366:            tio.FIELD &= ~NAME; \
1.1       deraadt   367:          break;
                    368:
                    369: #include "ttymodes.h"
                    370:
                    371: #undef TTYCHAR
                    372: #undef TTYMODE
                    373:
1.3       markus    374:                default:
                    375:                        debug("Ignoring unsupported tty mode opcode %d (0x%x)",
1.15      deraadt   376:                            opcode, opcode);
1.31      djm       377:                        /*
                    378:                         * SSH2:
                    379:                         * Opcodes 1 to 159 are defined to have a uint32
                    380:                         * argument.
                    381:                         * Opcodes 160 to 255 are undefined and cause parsing
                    382:                         * to stop.
                    383:                         */
                    384:                        if (opcode > 0 && opcode < 160) {
                    385:                                n_bytes += 4;
                    386:                                (void) packet_get_int();
                    387:                                break;
1.3       markus    388:                        } else {
1.31      djm       389:                                logit("parse_tty_modes: unknown opcode %d",
                    390:                                    opcode);
                    391:                                goto set;
1.17      markus    392:                        }
1.1       deraadt   393:                }
                    394:        }
                    395:
1.3       markus    396: set:
                    397:        if (*n_bytes_ptr != n_bytes) {
                    398:                *n_bytes_ptr = n_bytes;
1.19      itojun    399:                logit("parse_tty_modes: n_bytes_ptr != n_bytes: %d %d",
1.12      stevesk   400:                    *n_bytes_ptr, n_bytes);
1.3       markus    401:                return;         /* Don't process bytes passed */
                    402:        }
                    403:        if (failure == -1)
1.13      stevesk   404:                return;         /* Packet parsed ok but tcgetattr() failed */
1.3       markus    405:
                    406:        /* Set the new modes for the terminal. */
1.12      stevesk   407:        if (tcsetattr(fd, TCSANOW, &tio) == -1)
1.19      itojun    408:                logit("Setting tty modes failed: %.100s", strerror(errno));
1.1       deraadt   409: }