telnet.c

   1 /*
   2  * Telnet backend.
   3  */
   4
   5 #include <stdio.h>
   6 #include <stdlib.h>
   7 #include <limits.h>
   8
   9 #include "putty.h"
  10
  11 #ifndef FALSE
  12 #define FALSE 0
  13 #endif
  14 #ifndef TRUE
  15 #define TRUE 1
  16 #endif
  17
  18 #define IAC     255                    /* interpret as command: */
  19 #define DONT    254                    /* you are not to use option */
  20 #define DO      253                    /* please, you use option */
  21 #define WONT    252                    /* I won't use option */
  22 #define WILL    251                    /* I will use option */
  23 #define SB      250                    /* interpret as subnegotiation */
  24 #define SE      240                    /* end sub negotiation */
  25
  26 #define GA      249                    /* you may reverse the line */
  27 #define EL      248                    /* erase the current line */
  28 #define EC      247                    /* erase the current character */
  29 #define AYT     246                    /* are you there */
  30 #define AO      245                    /* abort output--but let prog finish */
  31 #define IP      244                    /* interrupt process--permanently */
  32 #define BREAK   243                    /* break */
  33 #define DM      242                    /* data mark--for connect. cleaning */
  34 #define NOP     241                    /* nop */
  35 #define EOR     239                    /* end of record (transparent mode) */
  36 #define ABORT   238                    /* Abort process */
  37 #define SUSP    237                    /* Suspend process */
  38 #define xEOF    236                    /* End of file: EOF is already used... */
  39
  40 #define TELOPTS(X) \
  41     X(BINARY, 0)                       /* 8-bit data path */ \
  42     X(ECHO, 1)                         /* echo */ \
  43     X(RCP, 2)                          /* prepare to reconnect */ \
  44     X(SGA, 3)                          /* suppress go ahead */ \
  45     X(NAMS, 4)                         /* approximate message size */ \
  46     X(STATUS, 5)                       /* give status */ \
  47     X(TM, 6)                           /* timing mark */ \
  48     X(RCTE, 7)                         /* remote controlled transmission and echo */ \
  49     X(NAOL, 8)                         /* negotiate about output line width */ \
  50     X(NAOP, 9)                         /* negotiate about output page size */ \
  51     X(NAOCRD, 10)                      /* negotiate about CR disposition */ \
  52     X(NAOHTS, 11)                      /* negotiate about horizontal tabstops */ \
  53     X(NAOHTD, 12)                      /* negotiate about horizontal tab disposition */ \
  54     X(NAOFFD, 13)                      /* negotiate about formfeed disposition */ \
  55     X(NAOVTS, 14)                      /* negotiate about vertical tab stops */ \
  56     X(NAOVTD, 15)                      /* negotiate about vertical tab disposition */ \
  57     X(NAOLFD, 16)                      /* negotiate about output LF disposition */ \
  58     X(XASCII, 17)                      /* extended ascic character set */ \
  59     X(LOGOUT, 18)                      /* force logout */ \
  60     X(BM, 19)                          /* byte macro */ \
  61     X(DET, 20)                         /* data entry terminal */ \
  62     X(SUPDUP, 21)                      /* supdup protocol */ \
  63     X(SUPDUPOUTPUT, 22)                /* supdup output */ \
  64     X(SNDLOC, 23)                      /* send location */ \
  65     X(TTYPE, 24)                       /* terminal type */ \
  66     X(EOR, 25)                         /* end or record */ \
  67     X(TUID, 26)                        /* TACACS user identification */ \
  68     X(OUTMRK, 27)                      /* output marking */ \
  69     X(TTYLOC, 28)                      /* terminal location number */ \
  70     X(3270REGIME, 29)                  /* 3270 regime */ \
  71     X(X3PAD, 30)                       /* X.3 PAD */ \
  72     X(NAWS, 31)                        /* window size */ \
  73     X(TSPEED, 32)                      /* terminal speed */ \
  74     X(LFLOW, 33)                       /* remote flow control */ \
  75     X(LINEMODE, 34)                    /* Linemode option */ \
  76     X(XDISPLOC, 35)                    /* X Display Location */ \
  77     X(OLD_ENVIRON, 36)                 /* Old - Environment variables */ \
  78     X(AUTHENTICATION, 37)              /* Authenticate */ \
  79     X(ENCRYPT, 38)                     /* Encryption option */ \
  80     X(NEW_ENVIRON, 39)                 /* New - Environment variables */ \
  81     X(TN3270E, 40)                     /* TN3270 enhancements */ \
  82     X(XAUTH, 41)                       \
  83     X(CHARSET, 42)                     /* Character set */ \
  84     X(RSP, 43)                         /* Remote serial port */ \
  85     X(COM_PORT_OPTION, 44)             /* Com port control */ \
  86     X(SLE, 45)                         /* Suppress local echo */ \
  87     X(STARTTLS, 46)                    /* Start TLS */ \
  88     X(KERMIT, 47)                      /* Automatic Kermit file transfer */ \
  89     X(SEND_URL, 48)                    \
  90     X(FORWARD_X, 49)                   \
  91     X(PRAGMA_LOGON, 138)               \
  92     X(SSPI_LOGON, 139)                 \
  93     X(PRAGMA_HEARTBEAT, 140)           \
  94     X(EXOPL, 255)                      /* extended-options-list */
  95
  96 #define telnet_enum(x,y) TELOPT_##x = y,
  97 enum { TELOPTS(telnet_enum) dummy=0 };
  98 #undef telnet_enum
  99
 100 #define TELQUAL_IS      0              /* option is... */
 101 #define TELQUAL_SEND    1              /* send option */
 102 #define TELQUAL_INFO    2              /* ENVIRON: informational version of IS */
 103 #define BSD_VAR 1
 104 #define BSD_VALUE 0
 105 #define RFC_VAR 0
 106 #define RFC_VALUE 1
 107
 108 #define CR 13
 109 #define LF 10
 110 #define NUL 0
 111
 112 #define iswritable(x) \
 113         ( (x) != IAC && \
 114               (telnet->opt_states[o_we_bin.index] == ACTIVE || (x) != CR))
 115
 116 static char *telopt(int opt)
 117 {
 118 #define telnet_str(x,y) case TELOPT_##x: return #x;
 119     switch (opt) {
 120         TELOPTS(telnet_str)
 121       default:
 122         return "<unknown>";
 123     }
 124 #undef telnet_str
 125 }
 126
 127 static void telnet_size(void *handle, int width, int height);
 128
 129 struct Opt {
 130     int send;                          /* what we initially send */
 131     int nsend;                         /* -ve send if requested to stop it */
 132     int ack, nak;                      /* +ve and -ve acknowledgements */
 133     int option;                        /* the option code */
 134     int index;                         /* index into telnet->opt_states[] */
 135     enum {
 136         REQUESTED, ACTIVE, INACTIVE, REALLY_INACTIVE
 137     } initial_state;
 138 };
 139
 140 enum {
 141     OPTINDEX_NAWS,
 142     OPTINDEX_TSPEED,
 143     OPTINDEX_TTYPE,
 144     OPTINDEX_OENV,
 145     OPTINDEX_NENV,
 146     OPTINDEX_ECHO,
 147     OPTINDEX_WE_SGA,
 148     OPTINDEX_THEY_SGA,
 149     OPTINDEX_WE_BIN,
 150     OPTINDEX_THEY_BIN,
 151     NUM_OPTS
 152 };
 153
 154 static const struct Opt o_naws =
 155     { WILL, WONT, DO, DONT, TELOPT_NAWS, OPTINDEX_NAWS, REQUESTED };
 156 static const struct Opt o_tspeed =
 157     { WILL, WONT, DO, DONT, TELOPT_TSPEED, OPTINDEX_TSPEED, REQUESTED };
 158 static const struct Opt o_ttype =
 159     { WILL, WONT, DO, DONT, TELOPT_TTYPE, OPTINDEX_TTYPE, REQUESTED };
 160 static const struct Opt o_oenv =
 161     { WILL, WONT, DO, DONT, TELOPT_OLD_ENVIRON, OPTINDEX_OENV, INACTIVE };
 162 static const struct Opt o_nenv =
 163     { WILL, WONT, DO, DONT, TELOPT_NEW_ENVIRON, OPTINDEX_NENV, REQUESTED };
 164 static const struct Opt o_echo =
 165     { DO, DONT, WILL, WONT, TELOPT_ECHO, OPTINDEX_ECHO, REQUESTED };
 166 static const struct Opt o_we_sga =
 167     { WILL, WONT, DO, DONT, TELOPT_SGA, OPTINDEX_WE_SGA, REQUESTED };
 168 static const struct Opt o_they_sga =
 169     { DO, DONT, WILL, WONT, TELOPT_SGA, OPTINDEX_THEY_SGA, REQUESTED };
 170 static const struct Opt o_we_bin =
 171     { WILL, WONT, DO, DONT, TELOPT_BINARY, OPTINDEX_WE_BIN, INACTIVE };
 172 static const struct Opt o_they_bin =
 173     { DO, DONT, WILL, WONT, TELOPT_BINARY, OPTINDEX_THEY_BIN, INACTIVE };
 174
 175 static const struct Opt *const opts[] = {
 176     &o_naws, &o_tspeed, &o_ttype, &o_oenv, &o_nenv, &o_echo,
 177     &o_we_sga, &o_they_sga, &o_we_bin, &o_they_bin, NULL
 178 };
 179
 180 typedef struct telnet_tag {
 181     const struct plug_function_table *fn;
 182     /* the above field _must_ be first in the structure */
 183
 184     Socket s;
 185     int closed_on_socket_error;
 186
 187     void *frontend;
 188     void *ldisc;
 189     int term_width, term_height;
 190
 191     int opt_states[NUM_OPTS];
 192
 193     int echoing, editing;
 194     int activated;
 195     int bufsize;
 196     int in_synch;
 197     int sb_opt, sb_len;
 198     unsigned char *sb_buf;
 199     int sb_size;
 200
 201     enum {
 202         TOP_LEVEL, SEENIAC, SEENWILL, SEENWONT, SEENDO, SEENDONT,
 203             SEENSB, SUBNEGOT, SUBNEG_IAC, SEENCR
 204     } state;
 205
 206     Conf *conf;
 207
 208     Pinger pinger;
 209 } *Telnet;
 210
 211 #define TELNET_MAX_BACKLOG 4096
 212
 213 #define SB_DELTA 1024
 214
 215 static void c_write(Telnet telnet, char *buf, int len)
 216 {
 217     int backlog;
 218     backlog = from_backend(telnet->frontend, 0, buf, len);
 219     sk_set_frozen(telnet->s, backlog > TELNET_MAX_BACKLOG);
 220 }
 221
 222 static void log_option(Telnet telnet, char *sender, int cmd, int option)
 223 {
 224     char *buf;
 225     /*
 226      * The strange-looking "<?""?>" below is there to avoid a
 227      * trigraph - a double question mark followed by > maps to a
 228      * closing brace character!
 229      */
 230     buf = dupprintf("%s:\t%s %s", sender,
 231                     (cmd == WILL ? "WILL" : cmd == WONT ? "WONT" :
 232                      cmd == DO ? "DO" : cmd == DONT ? "DONT" : "<?""?>"),
 233                     telopt(option));
 234     logevent(telnet->frontend, buf);
 235     sfree(buf);
 236 }
 237
 238 static void send_opt(Telnet telnet, int cmd, int option)
 239 {
 240     unsigned char b[3];
 241
 242     b[0] = IAC;
 243     b[1] = cmd;
 244     b[2] = option;
 245     telnet->bufsize = sk_write(telnet->s, (char *)b, 3);
 246     log_option(telnet, "client", cmd, option);
 247 }
 248
 249 static void deactivate_option(Telnet telnet, const struct Opt *o)
 250 {
 251     if (telnet->opt_states[o->index] == REQUESTED ||
 252         telnet->opt_states[o->index] == ACTIVE)
 253         send_opt(telnet, o->nsend, o->option);
 254     telnet->opt_states[o->index] = REALLY_INACTIVE;
 255 }
 256
 257 /*
 258  * Generate side effects of enabling or disabling an option.
 259  */
 260 static void option_side_effects(Telnet telnet, const struct Opt *o, int enabled)
 261 {
 262     if (o->option == TELOPT_ECHO && o->send == DO)
 263         telnet->echoing = !enabled;
 264     else if (o->option == TELOPT_SGA && o->send == DO)
 265         telnet->editing = !enabled;
 266     if (telnet->ldisc)                 /* cause ldisc to notice the change */
 267         ldisc_send(telnet->ldisc, NULL, 0, 0);
 268
 269     /* Ensure we get the minimum options */
 270     if (!telnet->activated) {
 271         if (telnet->opt_states[o_echo.index] == INACTIVE) {
 272             telnet->opt_states[o_echo.index] = REQUESTED;
 273             send_opt(telnet, o_echo.send, o_echo.option);
 274         }
 275         if (telnet->opt_states[o_we_sga.index] == INACTIVE) {
 276             telnet->opt_states[o_we_sga.index] = REQUESTED;
 277             send_opt(telnet, o_we_sga.send, o_we_sga.option);
 278         }
 279         if (telnet->opt_states[o_they_sga.index] == INACTIVE) {
 280             telnet->opt_states[o_they_sga.index] = REQUESTED;
 281             send_opt(telnet, o_they_sga.send, o_they_sga.option);
 282         }
 283         telnet->activated = TRUE;
 284     }
 285 }
 286
 287 static void activate_option(Telnet telnet, const struct Opt *o)
 288 {
 289     if (o->send == WILL && o->option == TELOPT_NAWS)
 290         telnet_size(telnet, telnet->term_width, telnet->term_height);
 291     if (o->send == WILL &&
 292         (o->option == TELOPT_NEW_ENVIRON ||
 293          o->option == TELOPT_OLD_ENVIRON)) {
 294         /*
 295          * We may only have one kind of ENVIRON going at a time.
 296          * This is a hack, but who cares.
 297          */
 298         deactivate_option(telnet, o->option ==
 299                           TELOPT_NEW_ENVIRON ? &o_oenv : &o_nenv);
 300     }
 301     option_side_effects(telnet, o, 1);
 302 }
 303
 304 static void refused_option(Telnet telnet, const struct Opt *o)
 305 {
 306     if (o->send == WILL && o->option == TELOPT_NEW_ENVIRON &&
 307         telnet->opt_states[o_oenv.index] == INACTIVE) {
 308         send_opt(telnet, WILL, TELOPT_OLD_ENVIRON);
 309         telnet->opt_states[o_oenv.index] = REQUESTED;
 310     }
 311     option_side_effects(telnet, o, 0);
 312 }
 313
 314 static void proc_rec_opt(Telnet telnet, int cmd, int option)
 315 {
 316     const struct Opt *const *o;
 317
 318     log_option(telnet, "server", cmd, option);
 319     for (o = opts; *o; o++) {
 320         if ((*o)->option == option && (*o)->ack == cmd) {
 321             switch (telnet->opt_states[(*o)->index]) {
 322               case REQUESTED:
 323                 telnet->opt_states[(*o)->index] = ACTIVE;
 324                 activate_option(telnet, *o);
 325                 break;
 326               case ACTIVE:
 327                 break;
 328               case INACTIVE:
 329                 telnet->opt_states[(*o)->index] = ACTIVE;
 330                 send_opt(telnet, (*o)->send, option);
 331                 activate_option(telnet, *o);
 332                 break;
 333               case REALLY_INACTIVE:
 334                 send_opt(telnet, (*o)->nsend, option);
 335                 break;
 336             }
 337             return;
 338         } else if ((*o)->option == option && (*o)->nak == cmd) {
 339             switch (telnet->opt_states[(*o)->index]) {
 340               case REQUESTED:
 341                 telnet->opt_states[(*o)->index] = INACTIVE;
 342                 refused_option(telnet, *o);
 343                 break;
 344               case ACTIVE:
 345                 telnet->opt_states[(*o)->index] = INACTIVE;
 346                 send_opt(telnet, (*o)->nsend, option);
 347                 option_side_effects(telnet, *o, 0);
 348                 break;
 349               case INACTIVE:
 350               case REALLY_INACTIVE:
 351                 break;
 352             }
 353             return;
 354         }
 355     }
 356     /*
 357      * If we reach here, the option was one we weren't prepared to
 358      * cope with. If the request was positive (WILL or DO), we send
 359      * a negative ack to indicate refusal. If the request was
 360      * negative (WONT / DONT), we must do nothing.
 361      */
 362     if (cmd == WILL || cmd == DO)
 363         send_opt(telnet, (cmd == WILL ? DONT : WONT), option);
 364 }
 365
 366 static void process_subneg(Telnet telnet)
 367 {
 368     unsigned char *b, *p, *q;
 369     int var, value, n, bsize;
 370     char *e, *eval, *ekey, *user;
 371
 372     switch (telnet->sb_opt) {
 373       case TELOPT_TSPEED:
 374         if (telnet->sb_len == 1 && telnet->sb_buf[0] == TELQUAL_SEND) {
 375             char *logbuf;
 376             char *termspeed = conf_get_str(telnet->conf, CONF_termspeed);
 377             b = snewn(20 + strlen(termspeed), unsigned char);
 378             b[0] = IAC;
 379             b[1] = SB;
 380             b[2] = TELOPT_TSPEED;
 381             b[3] = TELQUAL_IS;
 382             strcpy((char *)(b + 4), termspeed);
 383             n = 4 + strlen(termspeed);
 384             b[n] = IAC;
 385             b[n + 1] = SE;
 386             telnet->bufsize = sk_write(telnet->s, (char *)b, n + 2);
 387             logevent(telnet->frontend, "server:\tSB TSPEED SEND");
 388             logbuf = dupprintf("client:\tSB TSPEED IS %s", termspeed);
 389             logevent(telnet->frontend, logbuf);
 390             sfree(logbuf);
 391             sfree(b);
 392         } else
 393             logevent(telnet->frontend, "server:\tSB TSPEED <something weird>");
 394         break;
 395       case TELOPT_TTYPE:
 396         if (telnet->sb_len == 1 && telnet->sb_buf[0] == TELQUAL_SEND) {
 397             char *logbuf;
 398             char *termtype = conf_get_str(telnet->conf, CONF_termtype);
 399             b = snewn(20 + strlen(termtype), unsigned char);
 400             b[0] = IAC;
 401             b[1] = SB;
 402             b[2] = TELOPT_TTYPE;
 403             b[3] = TELQUAL_IS;
 404             for (n = 0; termtype[n]; n++)
 405                 b[n + 4] = (termtype[n] >= 'a' && termtype[n] <= 'z' ?
 406                             termtype[n] + 'A' - 'a' :
 407                             termtype[n]);
 408             b[n + 4] = IAC;
 409             b[n + 5] = SE;
 410             telnet->bufsize = sk_write(telnet->s, (char *)b, n + 6);
 411             b[n + 4] = 0;
 412             logevent(telnet->frontend, "server:\tSB TTYPE SEND");
 413             logbuf = dupprintf("client:\tSB TTYPE IS %s", b + 4);
 414             logevent(telnet->frontend, logbuf);
 415             sfree(logbuf);
 416             sfree(b);
 417         } else
 418             logevent(telnet->frontend, "server:\tSB TTYPE <something weird>\r\n");
 419         break;
 420       case TELOPT_OLD_ENVIRON:
 421       case TELOPT_NEW_ENVIRON:
 422         p = telnet->sb_buf;
 423         q = p + telnet->sb_len;
 424         if (p < q && *p == TELQUAL_SEND) {
 425             char *logbuf;
 426             p++;
 427             logbuf = dupprintf("server:\tSB %s SEND", telopt(telnet->sb_opt));
 428             logevent(telnet->frontend, logbuf);
 429             sfree(logbuf);
 430             if (telnet->sb_opt == TELOPT_OLD_ENVIRON) {
 431                 if (conf_get_int(telnet->conf, CONF_rfc_environ)) {
 432                     value = RFC_VALUE;
 433                     var = RFC_VAR;
 434                 } else {
 435                     value = BSD_VALUE;
 436                     var = BSD_VAR;
 437                 }
 438                 /*
 439                  * Try to guess the sense of VAR and VALUE.
 440                  */
 441                 while (p < q) {
 442                     if (*p == RFC_VAR) {
 443                         value = RFC_VALUE;
 444                         var = RFC_VAR;
 445                     } else if (*p == BSD_VAR) {
 446                         value = BSD_VALUE;
 447                         var = BSD_VAR;
 448                     }
 449                     p++;
 450                 }
 451             } else {
 452                 /*
 453                  * With NEW_ENVIRON, the sense of VAR and VALUE
 454                  * isn't in doubt.
 455                  */
 456                 value = RFC_VALUE;
 457                 var = RFC_VAR;
 458             }
 459             bsize = 20;
 460             for (eval = conf_get_str_strs(telnet->conf, CONF_environmt,
 461                                          NULL, &ekey);
 462                  eval != NULL;
 463                  eval = conf_get_str_strs(telnet->conf, CONF_environmt,
 464                                          ekey, &ekey))
 465                  bsize += strlen(ekey) + strlen(eval) + 2;
 466             user = get_remote_username(telnet->conf);
 467             if (user)
 468                 bsize += 6 + strlen(user);
 469
 470             b = snewn(bsize, unsigned char);
 471             b[0] = IAC;
 472             b[1] = SB;
 473             b[2] = telnet->sb_opt;
 474             b[3] = TELQUAL_IS;
 475             n = 4;
 476             for (eval = conf_get_str_strs(telnet->conf, CONF_environmt,
 477                                          NULL, &ekey);
 478                  eval != NULL;
 479                  eval = conf_get_str_strs(telnet->conf, CONF_environmt,
 480                                          ekey, &ekey)) {
 481                 b[n++] = var;
 482                 for (e = ekey; *e; e++)
 483                     b[n++] = *e;
 484                 b[n++] = value;
 485                 for (e = eval; *e; e++)
 486                     b[n++] = *e;
 487             }
 488             if (user) {
 489                 b[n++] = var;
 490                 b[n++] = 'U';
 491                 b[n++] = 'S';
 492                 b[n++] = 'E';
 493                 b[n++] = 'R';
 494                 b[n++] = value;
 495                 for (e = user; *e; e++)
 496                     b[n++] = *e;
 497             }
 498             b[n++] = IAC;
 499             b[n++] = SE;
 500             telnet->bufsize = sk_write(telnet->s, (char *)b, n);
 501             if (n == 6) {
 502                 logbuf = dupprintf("client:\tSB %s IS <nothing>",
 503                                    telopt(telnet->sb_opt));
 504                 logevent(telnet->frontend, logbuf);
 505                 sfree(logbuf);
 506             } else {
 507                 logbuf = dupprintf("client:\tSB %s IS:",
 508                                    telopt(telnet->sb_opt));
 509                 logevent(telnet->frontend, logbuf);
 510                 sfree(logbuf);
 511                 for (eval = conf_get_str_strs(telnet->conf, CONF_environmt,
 512                                              NULL, &ekey);
 513                      eval != NULL;
 514                      eval = conf_get_str_strs(telnet->conf, CONF_environmt,
 515                                              ekey, &ekey)) {
 516                     logbuf = dupprintf("\t%s=%s", ekey, eval);
 517                     logevent(telnet->frontend, logbuf);
 518                     sfree(logbuf);
 519                 }
 520                 if (user) {
 521                     logbuf = dupprintf("\tUSER=%s", user);
 522                     logevent(telnet->frontend, logbuf);
 523                     sfree(logbuf);
 524                 }
 525             }
 526             sfree(b);
 527             sfree(user);
 528         }
 529         break;
 530     }
 531 }
 532
 533 static void do_telnet_read(Telnet telnet, char *buf, int len)
 534 {
 535     char *outbuf = NULL;
 536     int outbuflen = 0, outbufsize = 0;
 537
 538 #define ADDTOBUF(c) do { \
 539     if (outbuflen >= outbufsize) { \
 540         outbufsize = outbuflen + 256; \
 541         outbuf = sresize(outbuf, outbufsize, char); \
 542     } \
 543     outbuf[outbuflen++] = (c); \
 544 } while (0)
 545
 546     while (len--) {
 547         int c = (unsigned char) *buf++;
 548
 549         switch (telnet->state) {
 550           case TOP_LEVEL:
 551           case SEENCR:
 552             if (c == NUL && telnet->state == SEENCR)
 553                 telnet->state = TOP_LEVEL;
 554             else if (c == IAC)
 555                 telnet->state = SEENIAC;
 556             else {
 557                 if (!telnet->in_synch)
 558                     ADDTOBUF(c);
 559
 560 #if 1
 561                 /* I can't get the F***ing winsock to insert the urgent IAC
 562                  * into the right position! Even with SO_OOBINLINE it gives
 563                  * it to recv too soon. And of course the DM byte (that
 564                  * arrives in the same packet!) appears several K later!!
 565                  *
 566                  * Oh well, we do get the DM in the right place so I'll
 567                  * just stop hiding on the next 0xf2 and hope for the best.
 568                  */
 569                 else if (c == DM)
 570                     telnet->in_synch = 0;
 571 #endif
 572                 if (c == CR && telnet->opt_states[o_they_bin.index] != ACTIVE)
 573                     telnet->state = SEENCR;
 574                 else
 575                     telnet->state = TOP_LEVEL;
 576             }
 577             break;
 578           case SEENIAC:
 579             if (c == DO)
 580                 telnet->state = SEENDO;
 581             else if (c == DONT)
 582                 telnet->state = SEENDONT;
 583             else if (c == WILL)
 584                 telnet->state = SEENWILL;
 585             else if (c == WONT)
 586                 telnet->state = SEENWONT;
 587             else if (c == SB)
 588                 telnet->state = SEENSB;
 589             else if (c == DM) {
 590                 telnet->in_synch = 0;
 591                 telnet->state = TOP_LEVEL;
 592             } else {
 593                 /* ignore everything else; print it if it's IAC */
 594                 if (c == IAC) {
 595                     ADDTOBUF(c);
 596                 }
 597                 telnet->state = TOP_LEVEL;
 598             }
 599             break;
 600           case SEENWILL:
 601             proc_rec_opt(telnet, WILL, c);
 602             telnet->state = TOP_LEVEL;
 603             break;
 604           case SEENWONT:
 605             proc_rec_opt(telnet, WONT, c);
 606             telnet->state = TOP_LEVEL;
 607             break;
 608           case SEENDO:
 609             proc_rec_opt(telnet, DO, c);
 610             telnet->state = TOP_LEVEL;
 611             break;
 612           case SEENDONT:
 613             proc_rec_opt(telnet, DONT, c);
 614             telnet->state = TOP_LEVEL;
 615             break;
 616           case SEENSB:
 617             telnet->sb_opt = c;
 618             telnet->sb_len = 0;
 619             telnet->state = SUBNEGOT;
 620             break;
 621           case SUBNEGOT:
 622             if (c == IAC)
 623                 telnet->state = SUBNEG_IAC;
 624             else {
 625               subneg_addchar:
 626                 if (telnet->sb_len >= telnet->sb_size) {
 627                     telnet->sb_size += SB_DELTA;
 628                     telnet->sb_buf = sresize(telnet->sb_buf, telnet->sb_size,
 629                                              unsigned char);
 630                 }
 631                 telnet->sb_buf[telnet->sb_len++] = c;
 632                 telnet->state = SUBNEGOT;       /* in case we came here by goto */
 633             }
 634             break;
 635           case SUBNEG_IAC:
 636             if (c != SE)
 637                 goto subneg_addchar;   /* yes, it's a hack, I know, but... */
 638             else {
 639                 process_subneg(telnet);
 640                 telnet->state = TOP_LEVEL;
 641             }
 642             break;
 643         }
 644     }
 645
 646     if (outbuflen)
 647         c_write(telnet, outbuf, outbuflen);
 648     sfree(outbuf);
 649 }
 650
 651 static void telnet_log(Plug plug, int type, SockAddr addr, int port,
 652                        const char *error_msg, int error_code)
 653 {
 654     Telnet telnet = (Telnet) plug;
 655     char addrbuf[256], *msg;
 656
 657     sk_getaddr(addr, addrbuf, lenof(addrbuf));
 658
 659     if (type == 0)
 660         msg = dupprintf("Connecting to %s port %d", addrbuf, port);
 661     else
 662         msg = dupprintf("Failed to connect to %s: %s", addrbuf, error_msg);
 663
 664     logevent(telnet->frontend, msg);
 665 }
 666
 667 static int telnet_closing(Plug plug, const char *error_msg, int error_code,
 668                           int calling_back)
 669 {
 670     Telnet telnet = (Telnet) plug;
 671
 672     /*
 673      * We don't implement independent EOF in each direction for Telnet
 674      * connections; as soon as we get word that the remote side has
 675      * sent us EOF, we wind up the whole connection.
 676      */
 677
 678     if (telnet->s) {
 679         sk_close(telnet->s);
 680         telnet->s = NULL;
 681         if (error_msg)
 682             telnet->closed_on_socket_error = TRUE;
 683         notify_remote_exit(telnet->frontend);
 684     }
 685     if (error_msg) {
 686         logevent(telnet->frontend, error_msg);
 687         connection_fatal(telnet->frontend, "%s", error_msg);
 688     }
 689     /* Otherwise, the remote side closed the connection normally. */
 690     return 0;
 691 }
 692
 693 static int telnet_receive(Plug plug, int urgent, char *data, int len)
 694 {
 695     Telnet telnet = (Telnet) plug;
 696     if (urgent)
 697         telnet->in_synch = TRUE;
 698     do_telnet_read(telnet, data, len);
 699     return 1;
 700 }
 701
 702 static void telnet_sent(Plug plug, int bufsize)
 703 {
 704     Telnet telnet = (Telnet) plug;
 705     telnet->bufsize = bufsize;
 706 }
 707
 708 /*
 709  * Called to set up the Telnet connection.
 710  *
 711  * Returns an error message, or NULL on success.
 712  *
 713  * Also places the canonical host name into `realhost'. It must be
 714  * freed by the caller.
 715  */
 716 static const char *telnet_init(void *frontend_handle, void **backend_handle,
 717                                Conf *conf, char *host, int port,
 718                                char **realhost, int nodelay, int keepalive)
 719 {
 720     static const struct plug_function_table fn_table = {
 721         telnet_log,
 722         telnet_closing,
 723         telnet_receive,
 724         telnet_sent
 725     };
 726     SockAddr addr;
 727     const char *err;
 728     Telnet telnet;
 729     char *loghost;
 730     int addressfamily;
 731
 732     telnet = snew(struct telnet_tag);
 733     telnet->fn = &fn_table;
 734     telnet->conf = conf_copy(conf);
 735     telnet->s = NULL;
 736     telnet->closed_on_socket_error = FALSE;
 737     telnet->echoing = TRUE;
 738     telnet->editing = TRUE;
 739     telnet->activated = FALSE;
 740     telnet->sb_buf = NULL;
 741     telnet->sb_size = 0;
 742     telnet->frontend = frontend_handle;
 743     telnet->term_width = conf_get_int(telnet->conf, CONF_width);
 744     telnet->term_height = conf_get_int(telnet->conf, CONF_height);
 745     telnet->state = TOP_LEVEL;
 746     telnet->ldisc = NULL;
 747     telnet->pinger = NULL;
 748     *backend_handle = telnet;
 749
 750     /*
 751      * Try to find host.
 752      */
 753     {
 754         char *buf;
 755         addressfamily = conf_get_int(telnet->conf, CONF_addressfamily);
 756         buf = dupprintf("Looking up host \"%s\"%s", host,
 757                         (addressfamily == ADDRTYPE_IPV4 ? " (IPv4)" :
 758                          (addressfamily == ADDRTYPE_IPV6 ? " (IPv6)" :
 759                           "")));
 760         logevent(telnet->frontend, buf);
 761         sfree(buf);
 762     }
 763     addr = name_lookup(host, port, realhost, telnet->conf, addressfamily);
 764     if ((err = sk_addr_error(addr)) != NULL) {
 765         sk_addr_free(addr);
 766         return err;
 767     }
 768
 769     if (port < 0)
 770         port = 23;                     /* default telnet port */
 771
 772     /*
 773      * Open socket.
 774      */
 775     telnet->s = new_connection(addr, *realhost, port, 0, 1,
 776                                nodelay, keepalive, (Plug) telnet, telnet->conf);
 777     if ((err = sk_socket_error(telnet->s)) != NULL)
 778         return err;
 779
 780     telnet->pinger = pinger_new(telnet->conf, &telnet_backend, telnet);
 781
 782     /*
 783      * Initialise option states.
 784      */
 785     if (conf_get_int(telnet->conf, CONF_passive_telnet)) {
 786         const struct Opt *const *o;
 787
 788         for (o = opts; *o; o++)
 789             telnet->opt_states[(*o)->index] = INACTIVE;
 790     } else {
 791         const struct Opt *const *o;
 792
 793         for (o = opts; *o; o++) {
 794             telnet->opt_states[(*o)->index] = (*o)->initial_state;
 795             if (telnet->opt_states[(*o)->index] == REQUESTED)
 796                 send_opt(telnet, (*o)->send, (*o)->option);
 797         }
 798         telnet->activated = TRUE;
 799     }
 800
 801     /*
 802      * Set up SYNCH state.
 803      */
 804     telnet->in_synch = FALSE;
 805
 806     /*
 807      * We can send special commands from the start.
 808      */
 809     update_specials_menu(telnet->frontend);
 810
 811     /*
 812      * loghost overrides realhost, if specified.
 813      */
 814     loghost = conf_get_str(telnet->conf, CONF_loghost);
 815     if (*loghost) {
 816         char *colon;
 817
 818         sfree(*realhost);
 819         *realhost = dupstr(loghost);
 820         colon = strrchr(*realhost, ':');
 821         if (colon) {
 822             /*
 823              * FIXME: if we ever update this aspect of ssh.c for
 824              * IPv6 literal management, this should change in line
 825              * with it.
 826              */
 827             *colon++ = '\0';
 828         }
 829     }
 830
 831     return NULL;
 832 }
 833
 834 static void telnet_free(void *handle)
 835 {
 836     Telnet telnet = (Telnet) handle;
 837
 838     sfree(telnet->sb_buf);
 839     if (telnet->s)
 840         sk_close(telnet->s);
 841     if (telnet->pinger)
 842         pinger_free(telnet->pinger);
 843     conf_free(telnet->conf);
 844     sfree(telnet);
 845 }
 846 /*
 847  * Reconfigure the Telnet backend. There's no immediate action
 848  * necessary, in this backend: we just save the fresh config for
 849  * any subsequent negotiations.
 850  */
 851 static void telnet_reconfig(void *handle, Conf *conf)
 852 {
 853     Telnet telnet = (Telnet) handle;
 854     pinger_reconfig(telnet->pinger, telnet->conf, conf);
 855     conf_free(telnet->conf);
 856     telnet->conf = conf_copy(conf);
 857 }
 858
 859 /*
 860  * Called to send data down the Telnet connection.
 861  */
 862 static int telnet_send(void *handle, char *buf, int len)
 863 {
 864     Telnet telnet = (Telnet) handle;
 865     unsigned char *p, *end;
 866     static const unsigned char iac[2] = { IAC, IAC };
 867     static const unsigned char cr[2] = { CR, NUL };
 868 #if 0
 869     static const unsigned char nl[2] = { CR, LF };
 870 #endif
 871
 872     if (telnet->s == NULL)
 873         return 0;
 874
 875     p = (unsigned char *)buf;
 876     end = (unsigned char *)(buf + len);
 877     while (p < end) {
 878         unsigned char *q = p;
 879
 880         while (p < end && iswritable(*p))
 881             p++;
 882         telnet->bufsize = sk_write(telnet->s, (char *)q, p - q);
 883
 884         while (p < end && !iswritable(*p)) {
 885             telnet->bufsize =
 886                 sk_write(telnet->s, (char *)(*p == IAC ? iac : cr), 2);
 887             p++;
 888         }
 889     }
 890
 891     return telnet->bufsize;
 892 }
 893
 894 /*
 895  * Called to query the current socket sendability status.
 896  */
 897 static int telnet_sendbuffer(void *handle)
 898 {
 899     Telnet telnet = (Telnet) handle;
 900     return telnet->bufsize;
 901 }
 902
 903 /*
 904  * Called to set the size of the window from Telnet's POV.
 905  */
 906 static void telnet_size(void *handle, int width, int height)
 907 {
 908     Telnet telnet = (Telnet) handle;
 909     unsigned char b[24];
 910     int n;
 911     char *logbuf;
 912
 913     telnet->term_width = width;
 914     telnet->term_height = height;
 915
 916     if (telnet->s == NULL || telnet->opt_states[o_naws.index] != ACTIVE)
 917         return;
 918     n = 0;
 919     b[n++] = IAC;
 920     b[n++] = SB;
 921     b[n++] = TELOPT_NAWS;
 922     b[n++] = telnet->term_width >> 8;
 923     if (b[n-1] == IAC) b[n++] = IAC;   /* duplicate any IAC byte occurs */
 924     b[n++] = telnet->term_width & 0xFF;
 925     if (b[n-1] == IAC) b[n++] = IAC;   /* duplicate any IAC byte occurs */
 926     b[n++] = telnet->term_height >> 8;
 927     if (b[n-1] == IAC) b[n++] = IAC;   /* duplicate any IAC byte occurs */
 928     b[n++] = telnet->term_height & 0xFF;
 929     if (b[n-1] == IAC) b[n++] = IAC;   /* duplicate any IAC byte occurs */
 930     b[n++] = IAC;
 931     b[n++] = SE;
 932     telnet->bufsize = sk_write(telnet->s, (char *)b, n);
 933     logbuf = dupprintf("client:\tSB NAWS %d,%d",
 934                        telnet->term_width, telnet->term_height);
 935     logevent(telnet->frontend, logbuf);
 936     sfree(logbuf);
 937 }
 938
 939 /*
 940  * Send Telnet special codes.
 941  */
 942 static void telnet_special(void *handle, Telnet_Special code)
 943 {
 944     Telnet telnet = (Telnet) handle;
 945     unsigned char b[2];
 946
 947     if (telnet->s == NULL)
 948         return;
 949
 950     b[0] = IAC;
 951     switch (code) {
 952       case TS_AYT:
 953         b[1] = AYT;
 954         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 955         break;
 956       case TS_BRK:
 957         b[1] = BREAK;
 958         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 959         break;
 960       case TS_EC:
 961         b[1] = EC;
 962         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 963         break;
 964       case TS_EL:
 965         b[1] = EL;
 966         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 967         break;
 968       case TS_GA:
 969         b[1] = GA;
 970         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 971         break;
 972       case TS_NOP:
 973         b[1] = NOP;
 974         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 975         break;
 976       case TS_ABORT:
 977         b[1] = ABORT;
 978         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 979         break;
 980       case TS_AO:
 981         b[1] = AO;
 982         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 983         break;
 984       case TS_IP:
 985         b[1] = IP;
 986         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 987         break;
 988       case TS_SUSP:
 989         b[1] = SUSP;
 990         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 991         break;
 992       case TS_EOR:
 993         b[1] = EOR;
 994         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 995         break;
 996       case TS_EOF:
 997         b[1] = xEOF;
 998         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 999         break;
1000       case TS_EOL:
1001         /* In BINARY mode, CR-LF becomes just CR -
1002          * and without the NUL suffix too. */
1003         if (telnet->opt_states[o_we_bin.index] == ACTIVE)
1004             telnet->bufsize = sk_write(telnet->s, "\r", 1);
1005         else
1006             telnet->bufsize = sk_write(telnet->s, "\r\n", 2);
1007         break;
1008       case TS_SYNCH:
1009         b[1] = DM;
1010         telnet->bufsize = sk_write(telnet->s, (char *)b, 1);
1011         telnet->bufsize = sk_write_oob(telnet->s, (char *)(b + 1), 1);
1012         break;
1013       case TS_RECHO:
1014         if (telnet->opt_states[o_echo.index] == INACTIVE ||
1015             telnet->opt_states[o_echo.index] == REALLY_INACTIVE) {
1016             telnet->opt_states[o_echo.index] = REQUESTED;
1017             send_opt(telnet, o_echo.send, o_echo.option);
1018         }
1019         break;
1020       case TS_LECHO:
1021         if (telnet->opt_states[o_echo.index] == ACTIVE) {
1022             telnet->opt_states[o_echo.index] = REQUESTED;
1023             send_opt(telnet, o_echo.nsend, o_echo.option);
1024         }
1025         break;
1026       case TS_PING:
1027         if (telnet->opt_states[o_they_sga.index] == ACTIVE) {
1028             b[1] = NOP;
1029             telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
1030         }
1031         break;
1032       default:
1033         break;  /* never heard of it */
1034     }
1035 }
1036
1037 static const struct telnet_special *telnet_get_specials(void *handle)
1038 {
1039     static const struct telnet_special specials[] = {
1040         {"Are You There", TS_AYT},
1041         {"Break", TS_BRK},
1042         {"Synch", TS_SYNCH},
1043         {"Erase Character", TS_EC},
1044         {"Erase Line", TS_EL},
1045         {"Go Ahead", TS_GA},
1046         {"No Operation", TS_NOP},
1047         {NULL, TS_SEP},
1048         {"Abort Process", TS_ABORT},
1049         {"Abort Output", TS_AO},
1050         {"Interrupt Process", TS_IP},
1051         {"Suspend Process", TS_SUSP},
1052         {NULL, TS_SEP},
1053         {"End Of Record", TS_EOR},
1054         {"End Of File", TS_EOF},
1055         {NULL, TS_EXITMENU}
1056     };
1057     return specials;
1058 }
1059
1060 static int telnet_connected(void *handle)
1061 {
1062     Telnet telnet = (Telnet) handle;
1063     return telnet->s != NULL;
1064 }
1065
1066 static int telnet_sendok(void *handle)
1067 {
1068     /* Telnet telnet = (Telnet) handle; */
1069     return 1;
1070 }
1071
1072 static void telnet_unthrottle(void *handle, int backlog)
1073 {
1074     Telnet telnet = (Telnet) handle;
1075     sk_set_frozen(telnet->s, backlog > TELNET_MAX_BACKLOG);
1076 }
1077
1078 static int telnet_ldisc(void *handle, int option)
1079 {
1080     Telnet telnet = (Telnet) handle;
1081     if (option == LD_ECHO)
1082         return telnet->echoing;
1083     if (option == LD_EDIT)
1084         return telnet->editing;
1085     return FALSE;
1086 }
1087
1088 static void telnet_provide_ldisc(void *handle, void *ldisc)
1089 {
1090     Telnet telnet = (Telnet) handle;
1091     telnet->ldisc = ldisc;
1092 }
1093
1094 static void telnet_provide_logctx(void *handle, void *logctx)
1095 {
1096     /* This is a stub. */
1097 }
1098
1099 static int telnet_exitcode(void *handle)
1100 {
1101     Telnet telnet = (Telnet) handle;
1102     if (telnet->s != NULL)
1103         return -1;                     /* still connected */
1104     else if (telnet->closed_on_socket_error)
1105         return INT_MAX;     /* a socket error counts as an unclean exit */
1106     else
1107         /* Telnet doesn't transmit exit codes back to the client */
1108         return 0;
1109 }
1110
1111 /*
1112  * cfg_info for Telnet does nothing at all.
1113  */
1114 static int telnet_cfg_info(void *handle)
1115 {
1116     return 0;
1117 }
1118
1119 Backend telnet_backend = {
1120     telnet_init,
1121     telnet_free,
1122     telnet_reconfig,
1123     telnet_send,
1124     telnet_sendbuffer,
1125     telnet_size,
1126     telnet_special,
1127     telnet_get_specials,
1128     telnet_connected,
1129     telnet_exitcode,
1130     telnet_sendok,
1131     telnet_ldisc,
1132     telnet_provide_ldisc,
1133     telnet_provide_logctx,
1134     telnet_unthrottle,
1135     telnet_cfg_info,
1136     "telnet",
1137     PROT_TELNET,
1138     23
1139 };