telnet.c

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