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