networking/telnet.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * telnet implementation for busybox
   4  *
   5  * Author: Tomi Ollila <too@iki.fi>
   6  * Copyright (C) 1994-2000 by Tomi Ollila
   7  *
   8  * Created: Thu Apr  7 13:29:41 1994 too
   9  * Last modified: Fri Jun  9 14:34:24 2000 too
  10  *
  11  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  12  *
  13  * HISTORY
  14  * Revision 3.1  1994/04/17  11:31:54  too
  15  * initial revision
  16  * Modified 2000/06/13 for inclusion into BusyBox by Erik Andersen <andersen@codepoet.org>
  17  * Modified 2001/05/07 to add ability to pass TTYPE to remote host by Jim McQuillan
  18  * <jam@ltsp.org>
  19  * Modified 2004/02/11 to add ability to pass the USER variable to remote host
  20  * by Fernando Silveira <swrh@gmx.net>
  21  */
  22 //config:config TELNET
  23 //config:       bool "telnet (8.7 kb)"
  24 //config:       default y
  25 //config:       help
  26 //config:       Telnet is an interface to the TELNET protocol, but is also commonly
  27 //config:       used to test other simple protocols.
  28 //config:
  29 //config:config FEATURE_TELNET_TTYPE
  30 //config:       bool "Pass TERM type to remote host"
  31 //config:       default y
  32 //config:       depends on TELNET
  33 //config:       help
  34 //config:       Setting this option will forward the TERM environment variable to the
  35 //config:       remote host you are connecting to. This is useful to make sure that
  36 //config:       things like ANSI colors and other control sequences behave.
  37 //config:
  38 //config:config FEATURE_TELNET_AUTOLOGIN
  39 //config:       bool "Pass USER type to remote host"
  40 //config:       default y
  41 //config:       depends on TELNET
  42 //config:       help
  43 //config:       Setting this option will forward the USER environment variable to the
  44 //config:       remote host you are connecting to. This is useful when you need to
  45 //config:       log into a machine without telling the username (autologin). This
  46 //config:       option enables '-a' and '-l USER' options.
  47 //config:
  48 //config:config FEATURE_TELNET_WIDTH
  49 //config:       bool "Enable window size autodetection"
  50 //config:       default y
  51 //config:       depends on TELNET
  52
  53 //applet:IF_TELNET(APPLET(telnet, BB_DIR_USR_BIN, BB_SUID_DROP))
  54
  55 //kbuild:lib-$(CONFIG_TELNET) += telnet.o
  56
  57 //usage:#if ENABLE_FEATURE_TELNET_AUTOLOGIN
  58 //usage:#define telnet_trivial_usage
  59 //usage:       "[-a] [-l USER] HOST [PORT]"
  60 //usage:#define telnet_full_usage "\n\n"
  61 //usage:       "Connect to telnet server\n"
  62 //usage:     "\n        -a      Automatic login with $USER variable"
  63 //usage:     "\n        -l USER Automatic login as USER"
  64 //usage:
  65 //usage:#else
  66 //usage:#define telnet_trivial_usage
  67 //usage:       "HOST [PORT]"
  68 //usage:#define telnet_full_usage "\n\n"
  69 //usage:       "Connect to telnet server"
  70 //usage:#endif
  71
  72 #include <arpa/telnet.h>
  73 #include <netinet/in.h>
  74 #include "libbb.h"
  75 #include "common_bufsiz.h"
  76
  77 #ifdef __BIONIC__
  78 /* should be in arpa/telnet.h */
  79 # define IAC         255  /* interpret as command: */
  80 # define DONT        254  /* you are not to use option */
  81 # define DO          253  /* please, you use option */
  82 # define WONT        252  /* I won't use option */
  83 # define WILL        251  /* I will use option */
  84 # define SB          250  /* interpret as subnegotiation */
  85 # define SE          240  /* end sub negotiation */
  86 # define TELOPT_ECHO   1  /* echo */
  87 # define TELOPT_SGA    3  /* suppress go ahead */
  88 # define TELOPT_TTYPE 24  /* terminal type */
  89 # define TELOPT_NAWS  31  /* window size */
  90 #endif
  91
  92 enum {
  93         DATABUFSIZE = 128,
  94         IACBUFSIZE  = 128,
  95
  96         CHM_TRY = 0,
  97         CHM_ON = 1,
  98         CHM_OFF = 2,
  99
 100         UF_ECHO = 0x01,
 101         UF_SGA = 0x02,
 102
 103         TS_NORMAL = 0,
 104         TS_COPY = 1,
 105         TS_IAC = 2,
 106         TS_OPT = 3,
 107         TS_SUB1 = 4,
 108         TS_SUB2 = 5,
 109         TS_CR = 6,
 110 };
 111
 112 typedef unsigned char byte;
 113
 114 enum { netfd = 3 };
 115
 116 struct globals {
 117         int     iaclen; /* could even use byte, but it's a loss on x86 */
 118         byte    telstate; /* telnet negotiation state from network input */
 119         byte    telwish;  /* DO, DONT, WILL, WONT */
 120         byte    charmode;
 121         byte    telflags;
 122         byte    do_termios;
 123 #if ENABLE_FEATURE_TELNET_TTYPE
 124         char    *ttype;
 125 #endif
 126 #if ENABLE_FEATURE_TELNET_AUTOLOGIN
 127         const char *autologin;
 128 #endif
 129 #if ENABLE_FEATURE_TELNET_WIDTH
 130         unsigned win_width, win_height;
 131 #endif
 132         /* same buffer used both for network and console read/write */
 133         char    buf[DATABUFSIZE];
 134         /* buffer to handle telnet negotiations */
 135         char    iacbuf[IACBUFSIZE];
 136         struct termios termios_def;
 137         struct termios termios_raw;
 138 } FIX_ALIASING;
 139 #define G (*(struct globals*)bb_common_bufsiz1)
 140 #define INIT_G() do { \
 141         setup_common_bufsiz(); \
 142         BUILD_BUG_ON(sizeof(G) > COMMON_BUFSIZE); \
 143 } while (0)
 144
 145
 146 static void rawmode(void);
 147 static void cookmode(void);
 148 static void do_linemode(void);
 149 static void will_charmode(void);
 150 static void telopt(byte c);
 151 static void subneg(byte c);
 152
 153 static void iac_flush(void)
 154 {
 155         full_write(netfd, G.iacbuf, G.iaclen);
 156         G.iaclen = 0;
 157 }
 158
 159 static void doexit(int ev) NORETURN;
 160 static void doexit(int ev)
 161 {
 162         cookmode();
 163         exit(ev);
 164 }
 165
 166 static void con_escape(void)
 167 {
 168         char b;
 169
 170         if (bb_got_signal) /* came from line mode... go raw */
 171                 rawmode();
 172
 173         full_write1_str("\r\nConsole escape. Commands are:\r\n\n"
 174                         " l     go to line mode\r\n"
 175                         " c     go to character mode\r\n"
 176                         " z     suspend telnet\r\n"
 177                         " e     exit telnet\r\n");
 178
 179         if (read(STDIN_FILENO, &b, 1) <= 0)
 180                 doexit(EXIT_FAILURE);
 181
 182         switch (b) {
 183         case 'l':
 184                 if (!bb_got_signal) {
 185                         do_linemode();
 186                         goto ret;
 187                 }
 188                 break;
 189         case 'c':
 190                 if (bb_got_signal) {
 191                         will_charmode();
 192                         goto ret;
 193                 }
 194                 break;
 195         case 'z':
 196                 cookmode();
 197                 kill(0, SIGTSTP);
 198                 rawmode();
 199                 break;
 200         case 'e':
 201                 doexit(EXIT_SUCCESS);
 202         }
 203
 204         full_write1_str("continuing...\r\n");
 205
 206         if (bb_got_signal)
 207                 cookmode();
 208  ret:
 209         bb_got_signal = 0;
 210 }
 211
 212 static void handle_net_output(int len)
 213 {
 214         byte outbuf[2 * DATABUFSIZE];
 215         byte *dst = outbuf;
 216         byte *src = (byte*)G.buf;
 217         byte *end = src + len;
 218
 219         while (src < end) {
 220                 byte c = *src++;
 221                 if (c == 0x1d) {
 222                         con_escape();
 223                         return;
 224                 }
 225                 *dst = c;
 226                 if (c == IAC)
 227                         *++dst = c; /* IAC -> IAC IAC */
 228                 else
 229                 if (c == '\r' || c == '\n') {
 230                         /* Enter key sends '\r' in raw mode and '\n' in cooked one.
 231                          *
 232                          * See RFC 1123 3.3.1 Telnet End-of-Line Convention.
 233                          * Using CR LF instead of other allowed possibilities
 234                          * like CR NUL - easier to talk to HTTP/SMTP servers.
 235                          */
 236                         *dst = '\r'; /* Enter -> CR LF */
 237                         *++dst = '\n';
 238                 }
 239                 dst++;
 240         }
 241         if (dst - outbuf != 0)
 242                 full_write(netfd, outbuf, dst - outbuf);
 243 }
 244
 245 static void handle_net_input(int len)
 246 {
 247         int i;
 248         int cstart = 0;
 249
 250         for (i = 0; i < len; i++) {
 251                 byte c = G.buf[i];
 252
 253                 if (G.telstate == TS_NORMAL) { /* most typical state */
 254                         if (c == IAC) {
 255                                 cstart = i;
 256                                 G.telstate = TS_IAC;
 257                         }
 258                         else if (c == '\r') {
 259                                 cstart = i + 1;
 260                                 G.telstate = TS_CR;
 261                         }
 262                         /* No IACs were seen so far, no need to copy
 263                          * bytes within G.buf: */
 264                         continue;
 265                 }
 266
 267                 switch (G.telstate) {
 268                 case TS_CR:
 269                         /* Prev char was CR. If cur one is NUL, ignore it.
 270                          * See RFC 1123 section 3.3.1 for discussion of telnet EOL handling.
 271                          */
 272                         G.telstate = TS_COPY;
 273                         if (c == '\0')
 274                                 break;
 275                         /* else: fall through - need to handle CR IAC ... properly */
 276
 277                 case TS_COPY: /* Prev char was ordinary */
 278                         /* Similar to NORMAL, but in TS_COPY we need to copy bytes */
 279                         if (c == IAC)
 280                                 G.telstate = TS_IAC;
 281                         else
 282                                 G.buf[cstart++] = c;
 283                         if (c == '\r')
 284                                 G.telstate = TS_CR;
 285                         break;
 286
 287                 case TS_IAC: /* Prev char was IAC */
 288                         if (c == IAC) { /* IAC IAC -> one IAC */
 289                                 G.buf[cstart++] = c;
 290                                 G.telstate = TS_COPY;
 291                                 break;
 292                         }
 293                         /* else */
 294                         switch (c) {
 295                         case SB:
 296                                 G.telstate = TS_SUB1;
 297                                 break;
 298                         case DO:
 299                         case DONT:
 300                         case WILL:
 301                         case WONT:
 302                                 G.telwish = c;
 303                                 G.telstate = TS_OPT;
 304                                 break;
 305                         /* DATA MARK must be added later */
 306                         default:
 307                                 G.telstate = TS_COPY;
 308                         }
 309                         break;
 310
 311                 case TS_OPT: /* Prev chars were IAC WILL/WONT/DO/DONT */
 312                         telopt(c);
 313                         G.telstate = TS_COPY;
 314                         break;
 315
 316                 case TS_SUB1: /* Subnegotiation */
 317                 case TS_SUB2: /* Subnegotiation */
 318                         subneg(c); /* can change G.telstate */
 319                         break;
 320                 }
 321         }
 322
 323         if (G.telstate != TS_NORMAL) {
 324                 /* We had some IACs, or CR */
 325                 if (G.iaclen)
 326                         iac_flush();
 327                 if (G.telstate == TS_COPY) /* we aren't in the middle of IAC */
 328                         G.telstate = TS_NORMAL;
 329                 len = cstart;
 330         }
 331
 332         if (len)
 333                 full_write(STDOUT_FILENO, G.buf, len);
 334 }
 335
 336 static void put_iac(int c)
 337 {
 338         G.iacbuf[G.iaclen++] = c;
 339 }
 340
 341 static void put_iac2_merged(unsigned wwdd_and_c)
 342 {
 343         if (G.iaclen + 3 > IACBUFSIZE)
 344                 iac_flush();
 345
 346         put_iac(IAC);
 347         put_iac(wwdd_and_c >> 8);
 348         put_iac(wwdd_and_c & 0xff);
 349 }
 350 #define put_iac2(wwdd,c) put_iac2_merged(((wwdd)<<8) + (c))
 351
 352 #if ENABLE_FEATURE_TELNET_TTYPE
 353 static void put_iac_subopt(byte c, char *str)
 354 {
 355         int len = strlen(str) + 6;   // ( 2 + 1 + 1 + strlen + 2 )
 356
 357         if (G.iaclen + len > IACBUFSIZE)
 358                 iac_flush();
 359
 360         put_iac(IAC);
 361         put_iac(SB);
 362         put_iac(c);
 363         put_iac(0);
 364
 365         while (*str)
 366                 put_iac(*str++);
 367
 368         put_iac(IAC);
 369         put_iac(SE);
 370 }
 371 #endif
 372
 373 #if ENABLE_FEATURE_TELNET_AUTOLOGIN
 374 static void put_iac_subopt_autologin(void)
 375 {
 376         int len = strlen(G.autologin) + 6;      // (2 + 1 + 1 + strlen + 2)
 377         const char *p = "USER";
 378
 379         if (G.iaclen + len > IACBUFSIZE)
 380                 iac_flush();
 381
 382         put_iac(IAC);
 383         put_iac(SB);
 384         put_iac(TELOPT_NEW_ENVIRON);
 385         put_iac(TELQUAL_IS);
 386         put_iac(NEW_ENV_VAR);
 387
 388         while (*p)
 389                 put_iac(*p++);
 390
 391         put_iac(NEW_ENV_VALUE);
 392
 393         p = G.autologin;
 394         while (*p)
 395                 put_iac(*p++);
 396
 397         put_iac(IAC);
 398         put_iac(SE);
 399 }
 400 #endif
 401
 402 #if ENABLE_FEATURE_TELNET_WIDTH
 403 static void put_iac_naws(byte c, int x, int y)
 404 {
 405         if (G.iaclen + 9 > IACBUFSIZE)
 406                 iac_flush();
 407
 408         put_iac(IAC);
 409         put_iac(SB);
 410         put_iac(c);
 411
 412         /* "... & 0xff" implicitly done below */
 413         put_iac(x >> 8);
 414         put_iac(x);
 415         put_iac(y >> 8);
 416         put_iac(y);
 417
 418         put_iac(IAC);
 419         put_iac(SE);
 420 }
 421 #endif
 422
 423 static void setConMode(void)
 424 {
 425         if (G.telflags & UF_ECHO) {
 426                 if (G.charmode == CHM_TRY) {
 427                         G.charmode = CHM_ON;
 428                         printf("\r\nEntering %s mode"
 429                                 "\r\nEscape character is '^%c'.\r\n", "character", ']');
 430                         rawmode();
 431                 }
 432         } else {
 433                 if (G.charmode != CHM_OFF) {
 434                         G.charmode = CHM_OFF;
 435                         printf("\r\nEntering %s mode"
 436                                 "\r\nEscape character is '^%c'.\r\n", "line", 'C');
 437                         cookmode();
 438                 }
 439         }
 440 }
 441
 442 static void will_charmode(void)
 443 {
 444         G.charmode = CHM_TRY;
 445         G.telflags |= (UF_ECHO | UF_SGA);
 446         setConMode();
 447
 448         put_iac2(DO, TELOPT_ECHO);
 449         put_iac2(DO, TELOPT_SGA);
 450         iac_flush();
 451 }
 452
 453 static void do_linemode(void)
 454 {
 455         G.charmode = CHM_TRY;
 456         G.telflags &= ~(UF_ECHO | UF_SGA);
 457         setConMode();
 458
 459         put_iac2(DONT, TELOPT_ECHO);
 460         put_iac2(DONT, TELOPT_SGA);
 461         iac_flush();
 462 }
 463
 464 static void to_notsup(char c)
 465 {
 466         if (G.telwish == WILL)
 467                 put_iac2(DONT, c);
 468         else if (G.telwish == DO)
 469                 put_iac2(WONT, c);
 470 }
 471
 472 static void to_echo(void)
 473 {
 474         /* if server requests ECHO, don't agree */
 475         if (G.telwish == DO) {
 476                 put_iac2(WONT, TELOPT_ECHO);
 477                 return;
 478         }
 479         if (G.telwish == DONT)
 480                 return;
 481
 482         if (G.telflags & UF_ECHO) {
 483                 if (G.telwish == WILL)
 484                         return;
 485         } else if (G.telwish == WONT)
 486                 return;
 487
 488         if (G.charmode != CHM_OFF)
 489                 G.telflags ^= UF_ECHO;
 490
 491         if (G.telflags & UF_ECHO)
 492                 put_iac2(DO, TELOPT_ECHO);
 493         else
 494                 put_iac2(DONT, TELOPT_ECHO);
 495
 496         setConMode();
 497         full_write1_str("\r\n");  /* sudden modec */
 498 }
 499
 500 static void to_sga(void)
 501 {
 502         /* daemon always sends will/wont, client do/dont */
 503
 504         if (G.telflags & UF_SGA) {
 505                 if (G.telwish == WILL)
 506                         return;
 507         } else if (G.telwish == WONT)
 508                 return;
 509
 510         G.telflags ^= UF_SGA; /* toggle */
 511         if (G.telflags & UF_SGA)
 512                 put_iac2(DO, TELOPT_SGA);
 513         else
 514                 put_iac2(DONT, TELOPT_SGA);
 515 }
 516
 517 #if ENABLE_FEATURE_TELNET_TTYPE
 518 static void to_ttype(void)
 519 {
 520         /* Tell server we will (or won't) do TTYPE */
 521         if (G.ttype)
 522                 put_iac2(WILL, TELOPT_TTYPE);
 523         else
 524                 put_iac2(WONT, TELOPT_TTYPE);
 525 }
 526 #endif
 527
 528 #if ENABLE_FEATURE_TELNET_AUTOLOGIN
 529 static void to_new_environ(void)
 530 {
 531         /* Tell server we will (or will not) do AUTOLOGIN */
 532         if (G.autologin)
 533                 put_iac2(WILL, TELOPT_NEW_ENVIRON);
 534         else
 535                 put_iac2(WONT, TELOPT_NEW_ENVIRON);
 536 }
 537 #endif
 538
 539 #if ENABLE_FEATURE_TELNET_WIDTH
 540 static void to_naws(void)
 541 {
 542         /* Tell server we will do NAWS */
 543         put_iac2(WILL, TELOPT_NAWS);
 544 }
 545 #endif
 546
 547 static void telopt(byte c)
 548 {
 549         switch (c) {
 550         case TELOPT_ECHO:
 551                 to_echo(); break;
 552         case TELOPT_SGA:
 553                 to_sga(); break;
 554 #if ENABLE_FEATURE_TELNET_TTYPE
 555         case TELOPT_TTYPE:
 556                 to_ttype(); break;
 557 #endif
 558 #if ENABLE_FEATURE_TELNET_AUTOLOGIN
 559         case TELOPT_NEW_ENVIRON:
 560                 to_new_environ(); break;
 561 #endif
 562 #if ENABLE_FEATURE_TELNET_WIDTH
 563         case TELOPT_NAWS:
 564                 to_naws();
 565                 put_iac_naws(c, G.win_width, G.win_height);
 566                 break;
 567 #endif
 568         default:
 569                 to_notsup(c);
 570                 break;
 571         }
 572 }
 573
 574 /* subnegotiation -- ignore all (except TTYPE,NAWS) */
 575 static void subneg(byte c)
 576 {
 577         switch (G.telstate) {
 578         case TS_SUB1:
 579                 if (c == IAC)
 580                         G.telstate = TS_SUB2;
 581 #if ENABLE_FEATURE_TELNET_TTYPE
 582                 else
 583                 if (c == TELOPT_TTYPE && G.ttype)
 584                         put_iac_subopt(TELOPT_TTYPE, G.ttype);
 585 #endif
 586 #if ENABLE_FEATURE_TELNET_AUTOLOGIN
 587                 else
 588                 if (c == TELOPT_NEW_ENVIRON && G.autologin)
 589                         put_iac_subopt_autologin();
 590 #endif
 591                 break;
 592         case TS_SUB2:
 593                 if (c == SE) {
 594                         G.telstate = TS_COPY;
 595                         return;
 596                 }
 597                 G.telstate = TS_SUB1;
 598                 break;
 599         }
 600 }
 601
 602 static void rawmode(void)
 603 {
 604         if (G.do_termios)
 605                 tcsetattr(0, TCSADRAIN, &G.termios_raw);
 606 }
 607
 608 static void cookmode(void)
 609 {
 610         if (G.do_termios)
 611                 tcsetattr(0, TCSADRAIN, &G.termios_def);
 612 }
 613
 614 int telnet_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 615 int telnet_main(int argc UNUSED_PARAM, char **argv)
 616 {
 617         char *host;
 618         int port;
 619         int len;
 620         struct pollfd ufds[2];
 621
 622         INIT_G();
 623
 624 #if ENABLE_FEATURE_TELNET_TTYPE
 625         G.ttype = getenv("TERM");
 626 #endif
 627
 628         if (tcgetattr(0, &G.termios_def) >= 0) {
 629                 G.do_termios = 1;
 630                 G.termios_raw = G.termios_def;
 631                 cfmakeraw(&G.termios_raw);
 632         }
 633
 634 #if ENABLE_FEATURE_TELNET_AUTOLOGIN
 635         if (1 == getopt32(argv, "al:", &G.autologin)) {
 636                 /* Only -a without -l USER picks $USER from envvar */
 637                 G.autologin = getenv("USER");
 638         }
 639         argv += optind;
 640 #else
 641         argv++;
 642 #endif
 643         if (!*argv)
 644                 bb_show_usage();
 645         host = *argv++;
 646         port = bb_lookup_port(*argv ? *argv++ : "telnet", "tcp", 23);
 647         if (*argv) /* extra params?? */
 648                 bb_show_usage();
 649
 650         xmove_fd(create_and_connect_stream_or_die(host, port), netfd);
 651
 652         setsockopt_keepalive(netfd);
 653
 654 #if ENABLE_FEATURE_TELNET_WIDTH
 655         get_terminal_width_height(0, &G.win_width, &G.win_height);
 656 //TODO: support dynamic resize?
 657 #endif
 658
 659         signal(SIGINT, record_signo);
 660
 661         ufds[0].fd = STDIN_FILENO;
 662         ufds[0].events = POLLIN;
 663         ufds[1].fd = netfd;
 664         ufds[1].events = POLLIN;
 665
 666         while (1) {
 667                 if (poll(ufds, 2, -1) < 0) {
 668                         /* error, ignore and/or log something, bay go to loop */
 669                         if (bb_got_signal)
 670                                 con_escape();
 671                         else
 672                                 sleep(1);
 673                         continue;
 674                 }
 675
 676 // FIXME: reads can block. Need full bidirectional buffering.
 677
 678                 if (ufds[0].revents) {
 679                         len = safe_read(STDIN_FILENO, G.buf, DATABUFSIZE);
 680                         if (len <= 0)
 681                                 doexit(EXIT_SUCCESS);
 682                         handle_net_output(len);
 683                 }
 684
 685                 if (ufds[1].revents) {
 686                         len = safe_read(netfd, G.buf, DATABUFSIZE);
 687                         if (len <= 0) {
 688                                 full_write1_str("Connection closed by foreign host\r\n");
 689                                 doexit(EXIT_FAILURE);
 690                         }
 691                         handle_net_input(len);
 692                 }
 693         } /* while (1) */
 694 }