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 #ifdef DOTRACE
  93 # define TRACE(x, y) do { if (x) printf y; } while (0)
  94 #else
  95 # define TRACE(x, y)
  96 #endif
  97
  98 enum {
  99         DATABUFSIZE = 128,
 100         IACBUFSIZE  = 128,
 101
 102         CHM_TRY = 0,
 103         CHM_ON = 1,
 104         CHM_OFF = 2,
 105
 106         UF_ECHO = 0x01,
 107         UF_SGA = 0x02,
 108
 109         TS_NORMAL = 0,
 110         TS_COPY = 1,
 111         TS_IAC = 2,
 112         TS_OPT = 3,
 113         TS_SUB1 = 4,
 114         TS_SUB2 = 5,
 115         TS_CR = 6,
 116 };
 117
 118 typedef unsigned char byte;
 119
 120 enum { netfd = 3 };
 121
 122 struct globals {
 123         int     iaclen; /* could even use byte, but it's a loss on x86 */
 124         byte    telstate; /* telnet negotiation state from network input */
 125         byte    telwish;  /* DO, DONT, WILL, WONT */
 126         byte    charmode;
 127         byte    telflags;
 128         byte    do_termios;
 129 #if ENABLE_FEATURE_TELNET_TTYPE
 130         char    *ttype;
 131 #endif
 132 #if ENABLE_FEATURE_TELNET_AUTOLOGIN
 133         const char *autologin;
 134 #endif
 135 #if ENABLE_FEATURE_TELNET_WIDTH
 136         unsigned win_width, win_height;
 137 #endif
 138         /* same buffer used both for network and console read/write */
 139         char    buf[DATABUFSIZE];
 140         /* buffer to handle telnet negotiations */
 141         char    iacbuf[IACBUFSIZE];
 142         struct termios termios_def;
 143         struct termios termios_raw;
 144 } FIX_ALIASING;
 145 #define G (*(struct globals*)bb_common_bufsiz1)
 146 #define INIT_G() do { \
 147         setup_common_bufsiz(); \
 148         BUILD_BUG_ON(sizeof(G) > COMMON_BUFSIZE); \
 149 } while (0)
 150
 151
 152 static void rawmode(void);
 153 static void cookmode(void);
 154 static void do_linemode(void);
 155 static void will_charmode(void);
 156 static void telopt(byte c);
 157 static void subneg(byte c);
 158
 159 static void iac_flush(void)
 160 {
 161         full_write(netfd, G.iacbuf, G.iaclen);
 162         G.iaclen = 0;
 163 }
 164
 165 static void doexit(int ev) NORETURN;
 166 static void doexit(int ev)
 167 {
 168         cookmode();
 169         exit(ev);
 170 }
 171
 172 static void con_escape(void)
 173 {
 174         char b;
 175
 176         if (bb_got_signal) /* came from line mode... go raw */
 177                 rawmode();
 178
 179         full_write1_str("\r\nConsole escape. Commands are:\r\n\n"
 180                         " l     go to line mode\r\n"
 181                         " c     go to character mode\r\n"
 182                         " z     suspend telnet\r\n"
 183                         " e     exit telnet\r\n");
 184
 185         if (read(STDIN_FILENO, &b, 1) <= 0)
 186                 doexit(EXIT_FAILURE);
 187
 188         switch (b) {
 189         case 'l':
 190                 if (!bb_got_signal) {
 191                         do_linemode();
 192                         goto ret;
 193                 }
 194                 break;
 195         case 'c':
 196                 if (bb_got_signal) {
 197                         will_charmode();
 198                         goto ret;
 199                 }
 200                 break;
 201         case 'z':
 202                 cookmode();
 203                 kill(0, SIGTSTP);
 204                 rawmode();
 205                 break;
 206         case 'e':
 207                 doexit(EXIT_SUCCESS);
 208         }
 209
 210         full_write1_str("continuing...\r\n");
 211
 212         if (bb_got_signal)
 213                 cookmode();
 214  ret:
 215         bb_got_signal = 0;
 216 }
 217
 218 static void handle_net_output(int len)
 219 {
 220         byte outbuf[2 * DATABUFSIZE];
 221         byte *dst = outbuf;
 222         byte *src = (byte*)G.buf;
 223         byte *end = src + len;
 224
 225         while (src < end) {
 226                 byte c = *src++;
 227                 if (c == 0x1d) {
 228                         con_escape();
 229                         return;
 230                 }
 231                 *dst = c;
 232                 if (c == IAC)
 233                         *++dst = c; /* IAC -> IAC IAC */
 234                 else
 235                 if (c == '\r' || c == '\n') {
 236                         /* Enter key sends '\r' in raw mode and '\n' in cooked one.
 237                          *
 238                          * See RFC 1123 3.3.1 Telnet End-of-Line Convention.
 239                          * Using CR LF instead of other allowed possibilities
 240                          * like CR NUL - easier to talk to HTTP/SMTP servers.
 241                          */
 242                         *dst = '\r'; /* Enter -> CR LF */
 243                         *++dst = '\n';
 244                 }
 245                 dst++;
 246         }
 247         if (dst - outbuf != 0)
 248                 full_write(netfd, outbuf, dst - outbuf);
 249 }
 250
 251 static void handle_net_input(int len)
 252 {
 253         int i;
 254         int cstart = 0;
 255
 256         for (i = 0; i < len; i++) {
 257                 byte c = G.buf[i];
 258
 259                 if (G.telstate == TS_NORMAL) { /* most typical state */
 260                         if (c == IAC) {
 261                                 cstart = i;
 262                                 G.telstate = TS_IAC;
 263                         }
 264                         else if (c == '\r') {
 265                                 cstart = i + 1;
 266                                 G.telstate = TS_CR;
 267                         }
 268                         /* No IACs were seen so far, no need to copy
 269                          * bytes within G.buf: */
 270                         continue;
 271                 }
 272
 273                 switch (G.telstate) {
 274                 case TS_CR:
 275                         /* Prev char was CR. If cur one is NUL, ignore it.
 276                          * See RFC 1123 section 3.3.1 for discussion of telnet EOL handling.
 277                          */
 278                         G.telstate = TS_COPY;
 279                         if (c == '\0')
 280                                 break;
 281                         /* else: fall through - need to handle CR IAC ... properly */
 282
 283                 case TS_COPY: /* Prev char was ordinary */
 284                         /* Similar to NORMAL, but in TS_COPY we need to copy bytes */
 285                         if (c == IAC)
 286                                 G.telstate = TS_IAC;
 287                         else
 288                                 G.buf[cstart++] = c;
 289                         if (c == '\r')
 290                                 G.telstate = TS_CR;
 291                         break;
 292
 293                 case TS_IAC: /* Prev char was IAC */
 294                         if (c == IAC) { /* IAC IAC -> one IAC */
 295                                 G.buf[cstart++] = c;
 296                                 G.telstate = TS_COPY;
 297                                 break;
 298                         }
 299                         /* else */
 300                         switch (c) {
 301                         case SB:
 302                                 G.telstate = TS_SUB1;
 303                                 break;
 304                         case DO:
 305                         case DONT:
 306                         case WILL:
 307                         case WONT:
 308                                 G.telwish = c;
 309                                 G.telstate = TS_OPT;
 310                                 break;
 311                         /* DATA MARK must be added later */
 312                         default:
 313                                 G.telstate = TS_COPY;
 314                         }
 315                         break;
 316
 317                 case TS_OPT: /* Prev chars were IAC WILL/WONT/DO/DONT */
 318                         telopt(c);
 319                         G.telstate = TS_COPY;
 320                         break;
 321
 322                 case TS_SUB1: /* Subnegotiation */
 323                 case TS_SUB2: /* Subnegotiation */
 324                         subneg(c); /* can change G.telstate */
 325                         break;
 326                 }
 327         }
 328
 329         if (G.telstate != TS_NORMAL) {
 330                 /* We had some IACs, or CR */
 331                 if (G.iaclen)
 332                         iac_flush();
 333                 if (G.telstate == TS_COPY) /* we aren't in the middle of IAC */
 334                         G.telstate = TS_NORMAL;
 335                 len = cstart;
 336         }
 337
 338         if (len)
 339                 full_write(STDOUT_FILENO, G.buf, len);
 340 }
 341
 342 static void put_iac(int c)
 343 {
 344         G.iacbuf[G.iaclen++] = c;
 345 }
 346
 347 static void put_iac2_merged(unsigned wwdd_and_c)
 348 {
 349         if (G.iaclen + 3 > IACBUFSIZE)
 350                 iac_flush();
 351
 352         put_iac(IAC);
 353         put_iac(wwdd_and_c >> 8);
 354         put_iac(wwdd_and_c & 0xff);
 355 }
 356 #define put_iac2(wwdd,c) put_iac2_merged(((wwdd)<<8) + (c))
 357
 358 #if ENABLE_FEATURE_TELNET_TTYPE
 359 static void put_iac_subopt(byte c, char *str)
 360 {
 361         int len = strlen(str) + 6;   // ( 2 + 1 + 1 + strlen + 2 )
 362
 363         if (G.iaclen + len > IACBUFSIZE)
 364                 iac_flush();
 365
 366         put_iac(IAC);
 367         put_iac(SB);
 368         put_iac(c);
 369         put_iac(0);
 370
 371         while (*str)
 372                 put_iac(*str++);
 373
 374         put_iac(IAC);
 375         put_iac(SE);
 376 }
 377 #endif
 378
 379 #if ENABLE_FEATURE_TELNET_AUTOLOGIN
 380 static void put_iac_subopt_autologin(void)
 381 {
 382         int len = strlen(G.autologin) + 6;      // (2 + 1 + 1 + strlen + 2)
 383         const char *p = "USER";
 384
 385         if (G.iaclen + len > IACBUFSIZE)
 386                 iac_flush();
 387
 388         put_iac(IAC);
 389         put_iac(SB);
 390         put_iac(TELOPT_NEW_ENVIRON);
 391         put_iac(TELQUAL_IS);
 392         put_iac(NEW_ENV_VAR);
 393
 394         while (*p)
 395                 put_iac(*p++);
 396
 397         put_iac(NEW_ENV_VALUE);
 398
 399         p = G.autologin;
 400         while (*p)
 401                 put_iac(*p++);
 402
 403         put_iac(IAC);
 404         put_iac(SE);
 405 }
 406 #endif
 407
 408 #if ENABLE_FEATURE_TELNET_WIDTH
 409 static void put_iac_naws(byte c, int x, int y)
 410 {
 411         if (G.iaclen + 9 > IACBUFSIZE)
 412                 iac_flush();
 413
 414         put_iac(IAC);
 415         put_iac(SB);
 416         put_iac(c);
 417
 418         /* "... & 0xff" implicitly done below */
 419         put_iac(x >> 8);
 420         put_iac(x);
 421         put_iac(y >> 8);
 422         put_iac(y);
 423
 424         put_iac(IAC);
 425         put_iac(SE);
 426 }
 427 #endif
 428
 429 static void setConMode(void)
 430 {
 431         if (G.telflags & UF_ECHO) {
 432                 if (G.charmode == CHM_TRY) {
 433                         G.charmode = CHM_ON;
 434                         printf("\r\nEntering %s mode"
 435                                 "\r\nEscape character is '^%c'.\r\n", "character", ']');
 436                         rawmode();
 437                 }
 438         } else {
 439                 if (G.charmode != CHM_OFF) {
 440                         G.charmode = CHM_OFF;
 441                         printf("\r\nEntering %s mode"
 442                                 "\r\nEscape character is '^%c'.\r\n", "line", 'C');
 443                         cookmode();
 444                 }
 445         }
 446 }
 447
 448 static void will_charmode(void)
 449 {
 450         G.charmode = CHM_TRY;
 451         G.telflags |= (UF_ECHO | UF_SGA);
 452         setConMode();
 453
 454         put_iac2(DO, TELOPT_ECHO);
 455         put_iac2(DO, TELOPT_SGA);
 456         iac_flush();
 457 }
 458
 459 static void do_linemode(void)
 460 {
 461         G.charmode = CHM_TRY;
 462         G.telflags &= ~(UF_ECHO | UF_SGA);
 463         setConMode();
 464
 465         put_iac2(DONT, TELOPT_ECHO);
 466         put_iac2(DONT, TELOPT_SGA);
 467         iac_flush();
 468 }
 469
 470 static void to_notsup(char c)
 471 {
 472         if (G.telwish == WILL)
 473                 put_iac2(DONT, c);
 474         else if (G.telwish == DO)
 475                 put_iac2(WONT, c);
 476 }
 477
 478 static void to_echo(void)
 479 {
 480         /* if server requests ECHO, don't agree */
 481         if (G.telwish == DO) {
 482                 put_iac2(WONT, TELOPT_ECHO);
 483                 return;
 484         }
 485         if (G.telwish == DONT)
 486                 return;
 487
 488         if (G.telflags & UF_ECHO) {
 489                 if (G.telwish == WILL)
 490                         return;
 491         } else if (G.telwish == WONT)
 492                 return;
 493
 494         if (G.charmode != CHM_OFF)
 495                 G.telflags ^= UF_ECHO;
 496
 497         if (G.telflags & UF_ECHO)
 498                 put_iac2(DO, TELOPT_ECHO);
 499         else
 500                 put_iac2(DONT, TELOPT_ECHO);
 501
 502         setConMode();
 503         full_write1_str("\r\n");  /* sudden modec */
 504 }
 505
 506 static void to_sga(void)
 507 {
 508         /* daemon always sends will/wont, client do/dont */
 509
 510         if (G.telflags & UF_SGA) {
 511                 if (G.telwish == WILL)
 512                         return;
 513         } else if (G.telwish == WONT)
 514                 return;
 515
 516         G.telflags ^= UF_SGA; /* toggle */
 517         if (G.telflags & UF_SGA)
 518                 put_iac2(DO, TELOPT_SGA);
 519         else
 520                 put_iac2(DONT, TELOPT_SGA);
 521 }
 522
 523 #if ENABLE_FEATURE_TELNET_TTYPE
 524 static void to_ttype(void)
 525 {
 526         /* Tell server we will (or won't) do TTYPE */
 527         if (G.ttype)
 528                 put_iac2(WILL, TELOPT_TTYPE);
 529         else
 530                 put_iac2(WONT, TELOPT_TTYPE);
 531 }
 532 #endif
 533
 534 #if ENABLE_FEATURE_TELNET_AUTOLOGIN
 535 static void to_new_environ(void)
 536 {
 537         /* Tell server we will (or will not) do AUTOLOGIN */
 538         if (G.autologin)
 539                 put_iac2(WILL, TELOPT_NEW_ENVIRON);
 540         else
 541                 put_iac2(WONT, TELOPT_NEW_ENVIRON);
 542 }
 543 #endif
 544
 545 #if ENABLE_FEATURE_TELNET_WIDTH
 546 static void to_naws(void)
 547 {
 548         /* Tell server we will do NAWS */
 549         put_iac2(WILL, TELOPT_NAWS);
 550 }
 551 #endif
 552
 553 static void telopt(byte c)
 554 {
 555         switch (c) {
 556         case TELOPT_ECHO:
 557                 to_echo(); break;
 558         case TELOPT_SGA:
 559                 to_sga(); break;
 560 #if ENABLE_FEATURE_TELNET_TTYPE
 561         case TELOPT_TTYPE:
 562                 to_ttype(); break;
 563 #endif
 564 #if ENABLE_FEATURE_TELNET_AUTOLOGIN
 565         case TELOPT_NEW_ENVIRON:
 566                 to_new_environ(); break;
 567 #endif
 568 #if ENABLE_FEATURE_TELNET_WIDTH
 569         case TELOPT_NAWS:
 570                 to_naws();
 571                 put_iac_naws(c, G.win_width, G.win_height);
 572                 break;
 573 #endif
 574         default:
 575                 to_notsup(c);
 576                 break;
 577         }
 578 }
 579
 580 /* subnegotiation -- ignore all (except TTYPE,NAWS) */
 581 static void subneg(byte c)
 582 {
 583         switch (G.telstate) {
 584         case TS_SUB1:
 585                 if (c == IAC)
 586                         G.telstate = TS_SUB2;
 587 #if ENABLE_FEATURE_TELNET_TTYPE
 588                 else
 589                 if (c == TELOPT_TTYPE && G.ttype)
 590                         put_iac_subopt(TELOPT_TTYPE, G.ttype);
 591 #endif
 592 #if ENABLE_FEATURE_TELNET_AUTOLOGIN
 593                 else
 594                 if (c == TELOPT_NEW_ENVIRON && G.autologin)
 595                         put_iac_subopt_autologin();
 596 #endif
 597                 break;
 598         case TS_SUB2:
 599                 if (c == SE) {
 600                         G.telstate = TS_COPY;
 601                         return;
 602                 }
 603                 G.telstate = TS_SUB1;
 604                 break;
 605         }
 606 }
 607
 608 static void rawmode(void)
 609 {
 610         if (G.do_termios)
 611                 tcsetattr(0, TCSADRAIN, &G.termios_raw);
 612 }
 613
 614 static void cookmode(void)
 615 {
 616         if (G.do_termios)
 617                 tcsetattr(0, TCSADRAIN, &G.termios_def);
 618 }
 619
 620 int telnet_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 621 int telnet_main(int argc UNUSED_PARAM, char **argv)
 622 {
 623         char *host;
 624         int port;
 625         int len;
 626         struct pollfd ufds[2];
 627
 628         INIT_G();
 629
 630 #if ENABLE_FEATURE_TELNET_WIDTH
 631         get_terminal_width_height(0, &G.win_width, &G.win_height);
 632 #endif
 633
 634 #if ENABLE_FEATURE_TELNET_TTYPE
 635         G.ttype = getenv("TERM");
 636 #endif
 637
 638         if (tcgetattr(0, &G.termios_def) >= 0) {
 639                 G.do_termios = 1;
 640                 G.termios_raw = G.termios_def;
 641                 cfmakeraw(&G.termios_raw);
 642         }
 643
 644 #if ENABLE_FEATURE_TELNET_AUTOLOGIN
 645         if (1 == getopt32(argv, "al:", &G.autologin)) {
 646                 /* Only -a without -l USER picks $USER from envvar */
 647                 G.autologin = getenv("USER");
 648         }
 649         argv += optind;
 650 #else
 651         argv++;
 652 #endif
 653         if (!*argv)
 654                 bb_show_usage();
 655         host = *argv++;
 656         port = bb_lookup_port(*argv ? *argv++ : "telnet", "tcp", 23);
 657         if (*argv) /* extra params?? */
 658                 bb_show_usage();
 659
 660         xmove_fd(create_and_connect_stream_or_die(host, port), netfd);
 661
 662         setsockopt_keepalive(netfd);
 663
 664         signal(SIGINT, record_signo);
 665
 666         ufds[0].fd = STDIN_FILENO;
 667         ufds[0].events = POLLIN;
 668         ufds[1].fd = netfd;
 669         ufds[1].events = POLLIN;
 670
 671         while (1) {
 672                 if (poll(ufds, 2, -1) < 0) {
 673                         /* error, ignore and/or log something, bay go to loop */
 674                         if (bb_got_signal)
 675                                 con_escape();
 676                         else
 677                                 sleep(1);
 678                         continue;
 679                 }
 680
 681 // FIXME: reads can block. Need full bidirectional buffering.
 682
 683                 if (ufds[0].revents) {
 684                         len = safe_read(STDIN_FILENO, G.buf, DATABUFSIZE);
 685                         if (len <= 0)
 686                                 doexit(EXIT_SUCCESS);
 687                         TRACE(0, ("Read con: %d\n", len));
 688                         handle_net_output(len);
 689                 }
 690
 691                 if (ufds[1].revents) {
 692                         len = safe_read(netfd, G.buf, DATABUFSIZE);
 693                         if (len <= 0) {
 694                                 full_write1_str("Connection closed by foreign host\r\n");
 695                                 doexit(EXIT_FAILURE);
 696                         }
 697                         TRACE(0, ("Read netfd (%d): %d\n", netfd, len));
 698                         handle_net_input(len);
 699                 }
 700         } /* while (1) */
 701 }