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