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 const 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     int session_started;
 201
 202     enum {
 203         TOP_LEVEL, SEENIAC, SEENWILL, SEENWONT, SEENDO, SEENDONT,
 204             SEENSB, SUBNEGOT, SUBNEG_IAC, SEENCR
 205     } state;
 206
 207     Conf *conf;
 208
 209     Pinger pinger;
 210 } *Telnet;
 211
 212 #define TELNET_MAX_BACKLOG 4096
 213
 214 #define SB_DELTA 1024
 215
 216 static void c_write(Telnet telnet, const char *buf, int len)
 217 {
 218     int backlog;
 219     backlog = from_backend(telnet->frontend, 0, buf, len);
 220     sk_set_frozen(telnet->s, backlog > TELNET_MAX_BACKLOG);
 221 }
 222
 223 static void log_option(Telnet telnet, const char *sender, int cmd, int option)
 224 {
 225     char *buf;
 226     /*
 227      * The strange-looking "<?""?>" below is there to avoid a
 228      * trigraph - a double question mark followed by > maps to a
 229      * closing brace character!
 230      */
 231     buf = dupprintf("%s:\t%s %s", sender,
 232                     (cmd == WILL ? "WILL" : cmd == WONT ? "WONT" :
 233                      cmd == DO ? "DO" : cmd == DONT ? "DONT" : "<?""?>"),
 234                     telopt(option));
 235     logevent(telnet->frontend, buf);
 236     sfree(buf);
 237 }
 238
 239 static void send_opt(Telnet telnet, int cmd, int option)
 240 {
 241     unsigned char b[3];
 242
 243     b[0] = IAC;
 244     b[1] = cmd;
 245     b[2] = option;
 246     telnet->bufsize = sk_write(telnet->s, (char *)b, 3);
 247     log_option(telnet, "client", cmd, option);
 248 }
 249
 250 static void deactivate_option(Telnet telnet, const struct Opt *o)
 251 {
 252     if (telnet->opt_states[o->index] == REQUESTED ||
 253         telnet->opt_states[o->index] == ACTIVE)
 254         send_opt(telnet, o->nsend, o->option);
 255     telnet->opt_states[o->index] = REALLY_INACTIVE;
 256 }
 257
 258 /*
 259  * Generate side effects of enabling or disabling an option.
 260  */
 261 static void option_side_effects(Telnet telnet, const struct Opt *o, int enabled)
 262 {
 263     if (o->option == TELOPT_ECHO && o->send == DO)
 264         telnet->echoing = !enabled;
 265     else if (o->option == TELOPT_SGA && o->send == DO)
 266         telnet->editing = !enabled;
 267     if (telnet->ldisc)                 /* cause ldisc to notice the change */
 268         ldisc_echoedit_update(telnet->ldisc);
 269
 270     /* Ensure we get the minimum options */
 271     if (!telnet->activated) {
 272         if (telnet->opt_states[o_echo.index] == INACTIVE) {
 273             telnet->opt_states[o_echo.index] = REQUESTED;
 274             send_opt(telnet, o_echo.send, o_echo.option);
 275         }
 276         if (telnet->opt_states[o_we_sga.index] == INACTIVE) {
 277             telnet->opt_states[o_we_sga.index] = REQUESTED;
 278             send_opt(telnet, o_we_sga.send, o_we_sga.option);
 279         }
 280         if (telnet->opt_states[o_they_sga.index] == INACTIVE) {
 281             telnet->opt_states[o_they_sga.index] = REQUESTED;
 282             send_opt(telnet, o_they_sga.send, o_they_sga.option);
 283         }
 284         telnet->activated = TRUE;
 285     }
 286 }
 287
 288 static void activate_option(Telnet telnet, const struct Opt *o)
 289 {
 290     if (o->send == WILL && o->option == TELOPT_NAWS)
 291         telnet_size(telnet, telnet->term_width, telnet->term_height);
 292     if (o->send == WILL &&
 293         (o->option == TELOPT_NEW_ENVIRON ||
 294          o->option == TELOPT_OLD_ENVIRON)) {
 295         /*
 296          * We may only have one kind of ENVIRON going at a time.
 297          * This is a hack, but who cares.
 298          */
 299         deactivate_option(telnet, o->option ==
 300                           TELOPT_NEW_ENVIRON ? &o_oenv : &o_nenv);
 301     }
 302     option_side_effects(telnet, o, 1);
 303 }
 304
 305 static void refused_option(Telnet telnet, const struct Opt *o)
 306 {
 307     if (o->send == WILL && o->option == TELOPT_NEW_ENVIRON &&
 308         telnet->opt_states[o_oenv.index] == INACTIVE) {
 309         send_opt(telnet, WILL, TELOPT_OLD_ENVIRON);
 310         telnet->opt_states[o_oenv.index] = REQUESTED;
 311     }
 312     option_side_effects(telnet, o, 0);
 313 }
 314
 315 static void proc_rec_opt(Telnet telnet, int cmd, int option)
 316 {
 317     const struct Opt *const *o;
 318
 319     log_option(telnet, "server", cmd, option);
 320     for (o = opts; *o; o++) {
 321         if ((*o)->option == option && (*o)->ack == cmd) {
 322             switch (telnet->opt_states[(*o)->index]) {
 323               case REQUESTED:
 324                 telnet->opt_states[(*o)->index] = ACTIVE;
 325                 activate_option(telnet, *o);
 326                 break;
 327               case ACTIVE:
 328                 break;
 329               case INACTIVE:
 330                 telnet->opt_states[(*o)->index] = ACTIVE;
 331                 send_opt(telnet, (*o)->send, option);
 332                 activate_option(telnet, *o);
 333                 break;
 334               case REALLY_INACTIVE:
 335                 send_opt(telnet, (*o)->nsend, option);
 336                 break;
 337             }
 338             return;
 339         } else if ((*o)->option == option && (*o)->nak == cmd) {
 340             switch (telnet->opt_states[(*o)->index]) {
 341               case REQUESTED:
 342                 telnet->opt_states[(*o)->index] = INACTIVE;
 343                 refused_option(telnet, *o);
 344                 break;
 345               case ACTIVE:
 346                 telnet->opt_states[(*o)->index] = INACTIVE;
 347                 send_opt(telnet, (*o)->nsend, option);
 348                 option_side_effects(telnet, *o, 0);
 349                 break;
 350               case INACTIVE:
 351               case REALLY_INACTIVE:
 352                 break;
 353             }
 354             return;
 355         }
 356     }
 357     /*
 358      * If we reach here, the option was one we weren't prepared to
 359      * cope with. If the request was positive (WILL or DO), we send
 360      * a negative ack to indicate refusal. If the request was
 361      * negative (WONT / DONT), we must do nothing.
 362      */
 363     if (cmd == WILL || cmd == DO)
 364         send_opt(telnet, (cmd == WILL ? DONT : WONT), option);
 365 }
 366
 367 static void process_subneg(Telnet telnet)
 368 {
 369     unsigned char *b, *p, *q;
 370     int var, value, n, bsize;
 371     char *e, *eval, *ekey, *user;
 372
 373     switch (telnet->sb_opt) {
 374       case TELOPT_TSPEED:
 375         if (telnet->sb_len == 1 && telnet->sb_buf[0] == TELQUAL_SEND) {
 376             char *logbuf;
 377             char *termspeed = conf_get_str(telnet->conf, CONF_termspeed);
 378             b = snewn(20 + strlen(termspeed), unsigned char);
 379             b[0] = IAC;
 380             b[1] = SB;
 381             b[2] = TELOPT_TSPEED;
 382             b[3] = TELQUAL_IS;
 383             strcpy((char *)(b + 4), termspeed);
 384             n = 4 + strlen(termspeed);
 385             b[n] = IAC;
 386             b[n + 1] = SE;
 387             telnet->bufsize = sk_write(telnet->s, (char *)b, n + 2);
 388             logevent(telnet->frontend, "server:\tSB TSPEED SEND");
 389             logbuf = dupprintf("client:\tSB TSPEED IS %s", termspeed);
 390             logevent(telnet->frontend, logbuf);
 391             sfree(logbuf);
 392             sfree(b);
 393         } else
 394             logevent(telnet->frontend, "server:\tSB TSPEED <something weird>");
 395         break;
 396       case TELOPT_TTYPE:
 397         if (telnet->sb_len == 1 && telnet->sb_buf[0] == TELQUAL_SEND) {
 398             char *logbuf;
 399             char *termtype = conf_get_str(telnet->conf, CONF_termtype);
 400             b = snewn(20 + strlen(termtype), unsigned char);
 401             b[0] = IAC;
 402             b[1] = SB;
 403             b[2] = TELOPT_TTYPE;
 404             b[3] = TELQUAL_IS;
 405             for (n = 0; termtype[n]; n++)
 406                 b[n + 4] = (termtype[n] >= 'a' && termtype[n] <= 'z' ?
 407                             termtype[n] + 'A' - 'a' :
 408                             termtype[n]);
 409             b[n + 4] = IAC;
 410             b[n + 5] = SE;
 411             telnet->bufsize = sk_write(telnet->s, (char *)b, n + 6);
 412             b[n + 4] = 0;
 413             logevent(telnet->frontend, "server:\tSB TTYPE SEND");
 414             logbuf = dupprintf("client:\tSB TTYPE IS %s", b + 4);
 415             logevent(telnet->frontend, logbuf);
 416             sfree(logbuf);
 417             sfree(b);
 418         } else
 419             logevent(telnet->frontend, "server:\tSB TTYPE <something weird>\r\n");
 420         break;
 421       case TELOPT_OLD_ENVIRON:
 422       case TELOPT_NEW_ENVIRON:
 423         p = telnet->sb_buf;
 424         q = p + telnet->sb_len;
 425         if (p < q && *p == TELQUAL_SEND) {
 426             char *logbuf;
 427             p++;
 428             logbuf = dupprintf("server:\tSB %s SEND", telopt(telnet->sb_opt));
 429             logevent(telnet->frontend, logbuf);
 430             sfree(logbuf);
 431             if (telnet->sb_opt == TELOPT_OLD_ENVIRON) {
 432                 if (conf_get_int(telnet->conf, CONF_rfc_environ)) {
 433                     value = RFC_VALUE;
 434                     var = RFC_VAR;
 435                 } else {
 436                     value = BSD_VALUE;
 437                     var = BSD_VAR;
 438                 }
 439                 /*
 440                  * Try to guess the sense of VAR and VALUE.
 441                  */
 442                 while (p < q) {
 443                     if (*p == RFC_VAR) {
 444                         value = RFC_VALUE;
 445                         var = RFC_VAR;
 446                     } else if (*p == BSD_VAR) {
 447                         value = BSD_VALUE;
 448                         var = BSD_VAR;
 449                     }
 450                     p++;
 451                 }
 452             } else {
 453                 /*
 454                  * With NEW_ENVIRON, the sense of VAR and VALUE
 455                  * isn't in doubt.
 456                  */
 457                 value = RFC_VALUE;
 458                 var = RFC_VAR;
 459             }
 460             bsize = 20;
 461             for (eval = conf_get_str_strs(telnet->conf, CONF_environmt,
 462                                          NULL, &ekey);
 463                  eval != NULL;
 464                  eval = conf_get_str_strs(telnet->conf, CONF_environmt,
 465                                          ekey, &ekey))
 466                  bsize += strlen(ekey) + strlen(eval) + 2;
 467             user = get_remote_username(telnet->conf);
 468             if (user)
 469                 bsize += 6 + strlen(user);
 470
 471             b = snewn(bsize, unsigned char);
 472             b[0] = IAC;
 473             b[1] = SB;
 474             b[2] = telnet->sb_opt;
 475             b[3] = TELQUAL_IS;
 476             n = 4;
 477             for (eval = conf_get_str_strs(telnet->conf, CONF_environmt,
 478                                          NULL, &ekey);
 479                  eval != NULL;
 480                  eval = conf_get_str_strs(telnet->conf, CONF_environmt,
 481                                          ekey, &ekey)) {
 482                 b[n++] = var;
 483                 for (e = ekey; *e; e++)
 484                     b[n++] = *e;
 485                 b[n++] = value;
 486                 for (e = eval; *e; e++)
 487                     b[n++] = *e;
 488             }
 489             if (user) {
 490                 b[n++] = var;
 491                 b[n++] = 'U';
 492                 b[n++] = 'S';
 493                 b[n++] = 'E';
 494                 b[n++] = 'R';
 495                 b[n++] = value;
 496                 for (e = user; *e; e++)
 497                     b[n++] = *e;
 498             }
 499             b[n++] = IAC;
 500             b[n++] = SE;
 501             telnet->bufsize = sk_write(telnet->s, (char *)b, n);
 502             if (n == 6) {
 503                 logbuf = dupprintf("client:\tSB %s IS <nothing>",
 504                                    telopt(telnet->sb_opt));
 505                 logevent(telnet->frontend, logbuf);
 506                 sfree(logbuf);
 507             } else {
 508                 logbuf = dupprintf("client:\tSB %s IS:",
 509                                    telopt(telnet->sb_opt));
 510                 logevent(telnet->frontend, logbuf);
 511                 sfree(logbuf);
 512                 for (eval = conf_get_str_strs(telnet->conf, CONF_environmt,
 513                                              NULL, &ekey);
 514                      eval != NULL;
 515                      eval = conf_get_str_strs(telnet->conf, CONF_environmt,
 516                                              ekey, &ekey)) {
 517                     logbuf = dupprintf("\t%s=%s", ekey, eval);
 518                     logevent(telnet->frontend, logbuf);
 519                     sfree(logbuf);
 520                 }
 521                 if (user) {
 522                     logbuf = dupprintf("\tUSER=%s", user);
 523                     logevent(telnet->frontend, logbuf);
 524                     sfree(logbuf);
 525                 }
 526             }
 527             sfree(b);
 528             sfree(user);
 529         }
 530         break;
 531     }
 532 }
 533
 534 static void do_telnet_read(Telnet telnet, char *buf, int len)
 535 {
 536     char *outbuf = NULL;
 537     int outbuflen = 0, outbufsize = 0;
 538
 539 #define ADDTOBUF(c) do { \
 540     if (outbuflen >= outbufsize) { \
 541         outbufsize = outbuflen + 256; \
 542         outbuf = sresize(outbuf, outbufsize, char); \
 543     } \
 544     outbuf[outbuflen++] = (c); \
 545 } while (0)
 546
 547     while (len--) {
 548         int c = (unsigned char) *buf++;
 549
 550         switch (telnet->state) {
 551           case TOP_LEVEL:
 552           case SEENCR:
 553             if (c == NUL && telnet->state == SEENCR)
 554                 telnet->state = TOP_LEVEL;
 555             else if (c == IAC)
 556                 telnet->state = SEENIAC;
 557             else {
 558                 if (!telnet->in_synch)
 559                     ADDTOBUF(c);
 560
 561 #if 1
 562                 /* I can't get the F***ing winsock to insert the urgent IAC
 563                  * into the right position! Even with SO_OOBINLINE it gives
 564                  * it to recv too soon. And of course the DM byte (that
 565                  * arrives in the same packet!) appears several K later!!
 566                  *
 567                  * Oh well, we do get the DM in the right place so I'll
 568                  * just stop hiding on the next 0xf2 and hope for the best.
 569                  */
 570                 else if (c == DM)
 571                     telnet->in_synch = 0;
 572 #endif
 573                 if (c == CR && telnet->opt_states[o_they_bin.index] != ACTIVE)
 574                     telnet->state = SEENCR;
 575                 else
 576                     telnet->state = TOP_LEVEL;
 577             }
 578             break;
 579           case SEENIAC:
 580             if (c == DO)
 581                 telnet->state = SEENDO;
 582             else if (c == DONT)
 583                 telnet->state = SEENDONT;
 584             else if (c == WILL)
 585                 telnet->state = SEENWILL;
 586             else if (c == WONT)
 587                 telnet->state = SEENWONT;
 588             else if (c == SB)
 589                 telnet->state = SEENSB;
 590             else if (c == DM) {
 591                 telnet->in_synch = 0;
 592                 telnet->state = TOP_LEVEL;
 593             } else {
 594                 /* ignore everything else; print it if it's IAC */
 595                 if (c == IAC) {
 596                     ADDTOBUF(c);
 597                 }
 598                 telnet->state = TOP_LEVEL;
 599             }
 600             break;
 601           case SEENWILL:
 602             proc_rec_opt(telnet, WILL, c);
 603             telnet->state = TOP_LEVEL;
 604             break;
 605           case SEENWONT:
 606             proc_rec_opt(telnet, WONT, c);
 607             telnet->state = TOP_LEVEL;
 608             break;
 609           case SEENDO:
 610             proc_rec_opt(telnet, DO, c);
 611             telnet->state = TOP_LEVEL;
 612             break;
 613           case SEENDONT:
 614             proc_rec_opt(telnet, DONT, c);
 615             telnet->state = TOP_LEVEL;
 616             break;
 617           case SEENSB:
 618             telnet->sb_opt = c;
 619             telnet->sb_len = 0;
 620             telnet->state = SUBNEGOT;
 621             break;
 622           case SUBNEGOT:
 623             if (c == IAC)
 624                 telnet->state = SUBNEG_IAC;
 625             else {
 626               subneg_addchar:
 627                 if (telnet->sb_len >= telnet->sb_size) {
 628                     telnet->sb_size += SB_DELTA;
 629                     telnet->sb_buf = sresize(telnet->sb_buf, telnet->sb_size,
 630                                              unsigned char);
 631                 }
 632                 telnet->sb_buf[telnet->sb_len++] = c;
 633                 telnet->state = SUBNEGOT;       /* in case we came here by goto */
 634             }
 635             break;
 636           case SUBNEG_IAC:
 637             if (c != SE)
 638                 goto subneg_addchar;   /* yes, it's a hack, I know, but... */
 639             else {
 640                 process_subneg(telnet);
 641                 telnet->state = TOP_LEVEL;
 642             }
 643             break;
 644         }
 645     }
 646
 647     if (outbuflen)
 648         c_write(telnet, outbuf, outbuflen);
 649     sfree(outbuf);
 650 }
 651
 652 static void telnet_log(Plug plug, int type, SockAddr addr, int port,
 653                        const char *error_msg, int error_code)
 654 {
 655     Telnet telnet = (Telnet) plug;
 656     backend_socket_log(telnet->frontend, type, addr, port,
 657                        error_msg, error_code, telnet->conf,
 658                        telnet->session_started);
 659 }
 660
 661 static int telnet_closing(Plug plug, const char *error_msg, int error_code,
 662                           int calling_back)
 663 {
 664     Telnet telnet = (Telnet) plug;
 665
 666     /*
 667      * We don't implement independent EOF in each direction for Telnet
 668      * connections; as soon as we get word that the remote side has
 669      * sent us EOF, we wind up the whole connection.
 670      */
 671
 672     if (telnet->s) {
 673         sk_close(telnet->s);
 674         telnet->s = NULL;
 675         if (error_msg)
 676             telnet->closed_on_socket_error = TRUE;
 677         notify_remote_exit(telnet->frontend);
 678     }
 679     if (error_msg) {
 680         logevent(telnet->frontend, error_msg);
 681         connection_fatal(telnet->frontend, "%s", error_msg);
 682     }
 683     /* Otherwise, the remote side closed the connection normally. */
 684     return 0;
 685 }
 686
 687 static int telnet_receive(Plug plug, int urgent, char *data, int len)
 688 {
 689     Telnet telnet = (Telnet) plug;
 690     if (urgent)
 691         telnet->in_synch = TRUE;
 692     telnet->session_started = TRUE;
 693     do_telnet_read(telnet, data, len);
 694     return 1;
 695 }
 696
 697 static void telnet_sent(Plug plug, int bufsize)
 698 {
 699     Telnet telnet = (Telnet) plug;
 700     telnet->bufsize = bufsize;
 701 }
 702
 703 /*
 704  * Called to set up the Telnet connection.
 705  *
 706  * Returns an error message, or NULL on success.
 707  *
 708  * Also places the canonical host name into `realhost'. It must be
 709  * freed by the caller.
 710  */
 711 static const char *telnet_init(void *frontend_handle, void **backend_handle,
 712                                Conf *conf, const char *host, int port,
 713                                char **realhost, int nodelay, int keepalive)
 714 {
 715     static const struct plug_function_table fn_table = {
 716         telnet_log,
 717         telnet_closing,
 718         telnet_receive,
 719         telnet_sent
 720     };
 721     SockAddr addr;
 722     const char *err;
 723     Telnet telnet;
 724     char *loghost;
 725     int addressfamily;
 726
 727     telnet = snew(struct telnet_tag);
 728     telnet->fn = &fn_table;
 729     telnet->conf = conf_copy(conf);
 730     telnet->s = NULL;
 731     telnet->closed_on_socket_error = FALSE;
 732     telnet->echoing = TRUE;
 733     telnet->editing = TRUE;
 734     telnet->activated = FALSE;
 735     telnet->sb_buf = NULL;
 736     telnet->sb_size = 0;
 737     telnet->frontend = frontend_handle;
 738     telnet->term_width = conf_get_int(telnet->conf, CONF_width);
 739     telnet->term_height = conf_get_int(telnet->conf, CONF_height);
 740     telnet->state = TOP_LEVEL;
 741     telnet->ldisc = NULL;
 742     telnet->pinger = NULL;
 743     telnet->session_started = TRUE;
 744     *backend_handle = telnet;
 745
 746     /*
 747      * Try to find host.
 748      */
 749     addressfamily = conf_get_int(telnet->conf, CONF_addressfamily);
 750     addr = name_lookup(host, port, realhost, telnet->conf, addressfamily,
 751                        telnet->frontend, "Telnet connection");
 752     if ((err = sk_addr_error(addr)) != NULL) {
 753         sk_addr_free(addr);
 754         return err;
 755     }
 756
 757     if (port < 0)
 758         port = 23;                     /* default telnet port */
 759
 760     /*
 761      * Open socket.
 762      */
 763     telnet->s = new_connection(addr, *realhost, port, 0, 1,
 764                                nodelay, keepalive, (Plug) telnet, telnet->conf);
 765     if ((err = sk_socket_error(telnet->s)) != NULL)
 766         return err;
 767
 768     telnet->pinger = pinger_new(telnet->conf, &telnet_backend, telnet);
 769
 770     /*
 771      * Initialise option states.
 772      */
 773     if (conf_get_int(telnet->conf, CONF_passive_telnet)) {
 774         const struct Opt *const *o;
 775
 776         for (o = opts; *o; o++)
 777             telnet->opt_states[(*o)->index] = INACTIVE;
 778     } else {
 779         const struct Opt *const *o;
 780
 781         for (o = opts; *o; o++) {
 782             telnet->opt_states[(*o)->index] = (*o)->initial_state;
 783             if (telnet->opt_states[(*o)->index] == REQUESTED)
 784                 send_opt(telnet, (*o)->send, (*o)->option);
 785         }
 786         telnet->activated = TRUE;
 787     }
 788
 789     /*
 790      * Set up SYNCH state.
 791      */
 792     telnet->in_synch = FALSE;
 793
 794     /*
 795      * We can send special commands from the start.
 796      */
 797     update_specials_menu(telnet->frontend);
 798
 799     /*
 800      * loghost overrides realhost, if specified.
 801      */
 802     loghost = conf_get_str(telnet->conf, CONF_loghost);
 803     if (*loghost) {
 804         char *colon;
 805
 806         sfree(*realhost);
 807         *realhost = dupstr(loghost);
 808
 809         colon = host_strrchr(*realhost, ':');
 810         if (colon)
 811             *colon++ = '\0';
 812     }
 813
 814     return NULL;
 815 }
 816
 817 static void telnet_free(void *handle)
 818 {
 819     Telnet telnet = (Telnet) handle;
 820
 821     sfree(telnet->sb_buf);
 822     if (telnet->s)
 823         sk_close(telnet->s);
 824     if (telnet->pinger)
 825         pinger_free(telnet->pinger);
 826     conf_free(telnet->conf);
 827     sfree(telnet);
 828 }
 829 /*
 830  * Reconfigure the Telnet backend. There's no immediate action
 831  * necessary, in this backend: we just save the fresh config for
 832  * any subsequent negotiations.
 833  */
 834 static void telnet_reconfig(void *handle, Conf *conf)
 835 {
 836     Telnet telnet = (Telnet) handle;
 837     pinger_reconfig(telnet->pinger, telnet->conf, conf);
 838     conf_free(telnet->conf);
 839     telnet->conf = conf_copy(conf);
 840 }
 841
 842 /*
 843  * Called to send data down the Telnet connection.
 844  */
 845 static int telnet_send(void *handle, const char *buf, int len)
 846 {
 847     Telnet telnet = (Telnet) handle;
 848     unsigned char *p, *end;
 849     static const unsigned char iac[2] = { IAC, IAC };
 850     static const unsigned char cr[2] = { CR, NUL };
 851 #if 0
 852     static const unsigned char nl[2] = { CR, LF };
 853 #endif
 854
 855     if (telnet->s == NULL)
 856         return 0;
 857
 858     p = (unsigned char *)buf;
 859     end = (unsigned char *)(buf + len);
 860     while (p < end) {
 861         unsigned char *q = p;
 862
 863         while (p < end && iswritable(*p))
 864             p++;
 865         telnet->bufsize = sk_write(telnet->s, (char *)q, p - q);
 866
 867         while (p < end && !iswritable(*p)) {
 868             telnet->bufsize =
 869                 sk_write(telnet->s, (char *)(*p == IAC ? iac : cr), 2);
 870             p++;
 871         }
 872     }
 873
 874     return telnet->bufsize;
 875 }
 876
 877 /*
 878  * Called to query the current socket sendability status.
 879  */
 880 static int telnet_sendbuffer(void *handle)
 881 {
 882     Telnet telnet = (Telnet) handle;
 883     return telnet->bufsize;
 884 }
 885
 886 /*
 887  * Called to set the size of the window from Telnet's POV.
 888  */
 889 static void telnet_size(void *handle, int width, int height)
 890 {
 891     Telnet telnet = (Telnet) handle;
 892     unsigned char b[24];
 893     int n;
 894     char *logbuf;
 895
 896     telnet->term_width = width;
 897     telnet->term_height = height;
 898
 899     if (telnet->s == NULL || telnet->opt_states[o_naws.index] != ACTIVE)
 900         return;
 901     n = 0;
 902     b[n++] = IAC;
 903     b[n++] = SB;
 904     b[n++] = TELOPT_NAWS;
 905     b[n++] = telnet->term_width >> 8;
 906     if (b[n-1] == IAC) b[n++] = IAC;   /* duplicate any IAC byte occurs */
 907     b[n++] = telnet->term_width & 0xFF;
 908     if (b[n-1] == IAC) b[n++] = IAC;   /* duplicate any IAC byte occurs */
 909     b[n++] = telnet->term_height >> 8;
 910     if (b[n-1] == IAC) b[n++] = IAC;   /* duplicate any IAC byte occurs */
 911     b[n++] = telnet->term_height & 0xFF;
 912     if (b[n-1] == IAC) b[n++] = IAC;   /* duplicate any IAC byte occurs */
 913     b[n++] = IAC;
 914     b[n++] = SE;
 915     telnet->bufsize = sk_write(telnet->s, (char *)b, n);
 916     logbuf = dupprintf("client:\tSB NAWS %d,%d",
 917                        telnet->term_width, telnet->term_height);
 918     logevent(telnet->frontend, logbuf);
 919     sfree(logbuf);
 920 }
 921
 922 /*
 923  * Send Telnet special codes.
 924  */
 925 static void telnet_special(void *handle, Telnet_Special code)
 926 {
 927     Telnet telnet = (Telnet) handle;
 928     unsigned char b[2];
 929
 930     if (telnet->s == NULL)
 931         return;
 932
 933     b[0] = IAC;
 934     switch (code) {
 935       case TS_AYT:
 936         b[1] = AYT;
 937         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 938         break;
 939       case TS_BRK:
 940         b[1] = BREAK;
 941         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 942         break;
 943       case TS_EC:
 944         b[1] = EC;
 945         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 946         break;
 947       case TS_EL:
 948         b[1] = EL;
 949         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 950         break;
 951       case TS_GA:
 952         b[1] = GA;
 953         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 954         break;
 955       case TS_NOP:
 956         b[1] = NOP;
 957         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 958         break;
 959       case TS_ABORT:
 960         b[1] = ABORT;
 961         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 962         break;
 963       case TS_AO:
 964         b[1] = AO;
 965         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 966         break;
 967       case TS_IP:
 968         b[1] = IP;
 969         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 970         break;
 971       case TS_SUSP:
 972         b[1] = SUSP;
 973         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 974         break;
 975       case TS_EOR:
 976         b[1] = EOR;
 977         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 978         break;
 979       case TS_EOF:
 980         b[1] = xEOF;
 981         telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
 982         break;
 983       case TS_EOL:
 984         /* In BINARY mode, CR-LF becomes just CR -
 985          * and without the NUL suffix too. */
 986         if (telnet->opt_states[o_we_bin.index] == ACTIVE)
 987             telnet->bufsize = sk_write(telnet->s, "\r", 1);
 988         else
 989             telnet->bufsize = sk_write(telnet->s, "\r\n", 2);
 990         break;
 991       case TS_SYNCH:
 992         b[1] = DM;
 993         telnet->bufsize = sk_write(telnet->s, (char *)b, 1);
 994         telnet->bufsize = sk_write_oob(telnet->s, (char *)(b + 1), 1);
 995         break;
 996       case TS_RECHO:
 997         if (telnet->opt_states[o_echo.index] == INACTIVE ||
 998             telnet->opt_states[o_echo.index] == REALLY_INACTIVE) {
 999             telnet->opt_states[o_echo.index] = REQUESTED;
1000             send_opt(telnet, o_echo.send, o_echo.option);
1001         }
1002         break;
1003       case TS_LECHO:
1004         if (telnet->opt_states[o_echo.index] == ACTIVE) {
1005             telnet->opt_states[o_echo.index] = REQUESTED;
1006             send_opt(telnet, o_echo.nsend, o_echo.option);
1007         }
1008         break;
1009       case TS_PING:
1010         if (telnet->opt_states[o_they_sga.index] == ACTIVE) {
1011             b[1] = NOP;
1012             telnet->bufsize = sk_write(telnet->s, (char *)b, 2);
1013         }
1014         break;
1015       default:
1016         break;  /* never heard of it */
1017     }
1018 }
1019
1020 static const struct telnet_special *telnet_get_specials(void *handle)
1021 {
1022     static const struct telnet_special specials[] = {
1023         {"Are You There", TS_AYT},
1024         {"Break", TS_BRK},
1025         {"Synch", TS_SYNCH},
1026         {"Erase Character", TS_EC},
1027         {"Erase Line", TS_EL},
1028         {"Go Ahead", TS_GA},
1029         {"No Operation", TS_NOP},
1030         {NULL, TS_SEP},
1031         {"Abort Process", TS_ABORT},
1032         {"Abort Output", TS_AO},
1033         {"Interrupt Process", TS_IP},
1034         {"Suspend Process", TS_SUSP},
1035         {NULL, TS_SEP},
1036         {"End Of Record", TS_EOR},
1037         {"End Of File", TS_EOF},
1038         {NULL, TS_EXITMENU}
1039     };
1040     return specials;
1041 }
1042
1043 static int telnet_connected(void *handle)
1044 {
1045     Telnet telnet = (Telnet) handle;
1046     return telnet->s != NULL;
1047 }
1048
1049 static int telnet_sendok(void *handle)
1050 {
1051     /* Telnet telnet = (Telnet) handle; */
1052     return 1;
1053 }
1054
1055 static void telnet_unthrottle(void *handle, int backlog)
1056 {
1057     Telnet telnet = (Telnet) handle;
1058     sk_set_frozen(telnet->s, backlog > TELNET_MAX_BACKLOG);
1059 }
1060
1061 static int telnet_ldisc(void *handle, int option)
1062 {
1063     Telnet telnet = (Telnet) handle;
1064     if (option == LD_ECHO)
1065         return telnet->echoing;
1066     if (option == LD_EDIT)
1067         return telnet->editing;
1068     return FALSE;
1069 }
1070
1071 static void telnet_provide_ldisc(void *handle, void *ldisc)
1072 {
1073     Telnet telnet = (Telnet) handle;
1074     telnet->ldisc = ldisc;
1075 }
1076
1077 static void telnet_provide_logctx(void *handle, void *logctx)
1078 {
1079     /* This is a stub. */
1080 }
1081
1082 static int telnet_exitcode(void *handle)
1083 {
1084     Telnet telnet = (Telnet) handle;
1085     if (telnet->s != NULL)
1086         return -1;                     /* still connected */
1087     else if (telnet->closed_on_socket_error)
1088         return INT_MAX;     /* a socket error counts as an unclean exit */
1089     else
1090         /* Telnet doesn't transmit exit codes back to the client */
1091         return 0;
1092 }
1093
1094 /*
1095  * cfg_info for Telnet does nothing at all.
1096  */
1097 static int telnet_cfg_info(void *handle)
1098 {
1099     return 0;
1100 }
1101
1102 Backend telnet_backend = {
1103     telnet_init,
1104     telnet_free,
1105     telnet_reconfig,
1106     telnet_send,
1107     telnet_sendbuffer,
1108     telnet_size,
1109     telnet_special,
1110     telnet_get_specials,
1111     telnet_connected,
1112     telnet_exitcode,
1113     telnet_sendok,
1114     telnet_ldisc,
1115     telnet_provide_ldisc,
1116     telnet_provide_logctx,
1117     telnet_unthrottle,
1118     telnet_cfg_info,
1119     NULL /* test_for_upstream */,
1120     "telnet",
1121     PROT_TELNET,
1122     23
1123 };