portfwd.c

   1 /*
   2  * SSH port forwarding.
   3  */
   4
   5 #include <stdio.h>
   6 #include <stdlib.h>
   7
   8 #include "putty.h"
   9 #include "ssh.h"
  10
  11 #ifndef FALSE
  12 #define FALSE 0
  13 #endif
  14 #ifndef TRUE
  15 #define TRUE 1
  16 #endif
  17
  18 struct PFwdPrivate {
  19     const struct plug_function_table *fn;
  20     /* the above variable absolutely *must* be the first in this structure */
  21     void *c;                           /* (channel) data used by ssh.c */
  22     void *backhandle;                  /* instance of SSH backend itself */
  23     /* Note that backhandle need not be filled in if c is non-NULL */
  24     Socket s;
  25     int throttled, throttle_override;
  26     int ready;
  27     /*
  28      * `dynamic' does double duty. It's set to 0 for an ordinary
  29      * forwarded port, and nonzero for SOCKS-style dynamic port
  30      * forwarding; but it also represents the state of the SOCKS
  31      * exchange.
  32      */
  33     int dynamic;
  34     /*
  35      * `hostname' and `port' are the real hostname and port, once
  36      * we know what we're connecting to; they're unused for this
  37      * purpose while conducting a local SOCKS exchange, which means
  38      * we can also use them as a buffer and pointer for reading
  39      * data from the SOCKS client.
  40      */
  41     char hostname[256+8];
  42     int port;
  43     /*
  44      * When doing dynamic port forwarding, we can receive
  45      * connection data before we are actually able to send it; so
  46      * we may have to temporarily hold some in a dynamically
  47      * allocated buffer here.
  48      */
  49     void *buffer;
  50     int buflen;
  51 };
  52
  53 static void pfd_log(Plug plug, int type, SockAddr addr, int port,
  54                     const char *error_msg, int error_code)
  55 {
  56     /* we have to dump these since we have no interface to logging.c */
  57 }
  58
  59 static int pfd_closing(Plug plug, const char *error_msg, int error_code,
  60                        int calling_back)
  61 {
  62     struct PFwdPrivate *pr = (struct PFwdPrivate *) plug;
  63
  64     /*
  65      * We have no way to communicate down the forwarded connection,
  66      * so if an error occurred on the socket, we just ignore it
  67      * and treat it like a proper close.
  68      */
  69     if (pr->c)
  70         sshfwd_close(pr->c);
  71     pfd_close(pr->s);
  72     return 1;
  73 }
  74
  75 static int pfd_receive(Plug plug, int urgent, char *data, int len)
  76 {
  77     struct PFwdPrivate *pr = (struct PFwdPrivate *) plug;
  78     if (pr->dynamic) {
  79         while (len--) {
  80             /*
  81              * Throughout SOCKS negotiation, "hostname" is re-used as a
  82              * random protocol buffer with "port" storing the length.
  83              */
  84             if (pr->port >= lenof(pr->hostname)) {
  85                 /* Request too long. */
  86                 if ((pr->dynamic >> 12) == 4) {
  87                     /* Send back a SOCKS 4 error before closing. */
  88                     char data[8];
  89                     memset(data, 0, sizeof(data));
  90                     data[1] = 91;      /* generic `request rejected' */
  91                     sk_write(pr->s, data, 8);
  92                 }
  93                 pfd_close(pr->s);
  94                 return 1;
  95             }
  96             pr->hostname[pr->port++] = *data++;
  97
  98             /*
  99              * Now check what's in the buffer to see if it's a
 100              * valid and complete message in the SOCKS exchange.
 101              */
 102             if ((pr->dynamic == 1 || (pr->dynamic >> 12) == 4) &&
 103                 pr->hostname[0] == 4) {
 104                 /*
 105                  * SOCKS 4.
 106                  */
 107                 if (pr->dynamic == 1)
 108                     pr->dynamic = 0x4000;
 109                 if (pr->port < 2) continue;/* don't have command code yet */
 110                 if (pr->hostname[1] != 1) {
 111                     /* Not CONNECT. */
 112                     /* Send back a SOCKS 4 error before closing. */
 113                     char data[8];
 114                     memset(data, 0, sizeof(data));
 115                     data[1] = 91;      /* generic `request rejected' */
 116                     sk_write(pr->s, data, 8);
 117                     pfd_close(pr->s);
 118                     return 1;
 119                 }
 120                 if (pr->port <= 8) continue; /* haven't started user/hostname */
 121                 if (pr->hostname[pr->port-1] != 0)
 122                     continue;          /* haven't _finished_ user/hostname */
 123                 /*
 124                  * Now we have a full SOCKS 4 request. Check it to
 125                  * see if it's a SOCKS 4A request.
 126                  */
 127                 if (pr->hostname[4] == 0 && pr->hostname[5] == 0 &&
 128                     pr->hostname[6] == 0 && pr->hostname[7] != 0) {
 129                     /*
 130                      * It's SOCKS 4A. So if we haven't yet
 131                      * collected the host name, we should continue
 132                      * waiting for data in order to do so; if we
 133                      * have, we can go ahead.
 134                      */
 135                     int len;
 136                     if (pr->dynamic == 0x4000) {
 137                         pr->dynamic = 0x4001;
 138                         pr->port = 8;      /* reset buffer to overwrite name */
 139                         continue;
 140                     }
 141                     pr->hostname[0] = 0;   /* reply version code */
 142                     pr->hostname[1] = 90;   /* request granted */
 143                     sk_write(pr->s, pr->hostname, 8);
 144                     len= pr->port - 8;
 145                     pr->port = GET_16BIT_MSB_FIRST(pr->hostname+2);
 146                     memmove(pr->hostname, pr->hostname + 8, len);
 147                     goto connect;
 148                 } else {
 149                     /*
 150                      * It's SOCKS 4, which means we should format
 151                      * the IP address into the hostname string and
 152                      * then just go.
 153                      */
 154                     pr->hostname[0] = 0;   /* reply version code */
 155                     pr->hostname[1] = 90;   /* request granted */
 156                     sk_write(pr->s, pr->hostname, 8);
 157                     pr->port = GET_16BIT_MSB_FIRST(pr->hostname+2);
 158                     sprintf(pr->hostname, "%d.%d.%d.%d",
 159                             (unsigned char)pr->hostname[4],
 160                             (unsigned char)pr->hostname[5],
 161                             (unsigned char)pr->hostname[6],
 162                             (unsigned char)pr->hostname[7]);
 163                     goto connect;
 164                 }
 165             }
 166
 167             if ((pr->dynamic == 1 || (pr->dynamic >> 12) == 5) &&
 168                 pr->hostname[0] == 5) {
 169                 /*
 170                  * SOCKS 5.
 171                  */
 172                 if (pr->dynamic == 1)
 173                     pr->dynamic = 0x5000;
 174
 175                 if (pr->dynamic == 0x5000) {
 176                     int i, method;
 177                     char data[2];
 178                     /*
 179                      * We're receiving a set of method identifiers.
 180                      */
 181                     if (pr->port < 2) continue;/* no method count yet */
 182                     if (pr->port < 2 + (unsigned char)pr->hostname[1])
 183                         continue;      /* no methods yet */
 184                     method = 0xFF;     /* invalid */
 185                     for (i = 0; i < (unsigned char)pr->hostname[1]; i++)
 186                         if (pr->hostname[2+i] == 0) {
 187                             method = 0;/* no auth */
 188                             break;
 189                         }
 190                     data[0] = 5;
 191                     data[1] = method;
 192                     sk_write(pr->s, data, 2);
 193                     pr->dynamic = 0x5001;
 194                     pr->port = 0;      /* re-empty the buffer */
 195                     continue;
 196                 }
 197
 198                 if (pr->dynamic == 0x5001) {
 199                     /*
 200                      * We're receiving a SOCKS request.
 201                      */
 202                     unsigned char reply[10]; /* SOCKS5 atyp=1 reply */
 203                     int atype, alen = 0;
 204
 205                     /*
 206                      * Pre-fill reply packet.
 207                      * In all cases, we set BND.{HOST,ADDR} to 0.0.0.0:0
 208                      * (atyp=1) in the reply; if we succeed, we don't know
 209                      * the right answers, and if we fail, they should be
 210                      * ignored.
 211                      */
 212                     memset(reply, 0, lenof(reply));
 213                     reply[0] = 5; /* VER */
 214                     reply[3] = 1; /* ATYP = 1 (IPv4, 0.0.0.0:0) */
 215
 216                     if (pr->port < 6) continue;
 217                     atype = (unsigned char)pr->hostname[3];
 218                     if (atype == 1)    /* IPv4 address */
 219                         alen = 4;
 220                     if (atype == 4)    /* IPv6 address */
 221                         alen = 16;
 222                     if (atype == 3)    /* domain name has leading length */
 223                         alen = 1 + (unsigned char)pr->hostname[4];
 224                     if (pr->port < 6 + alen) continue;
 225                     if (pr->hostname[1] != 1 || pr->hostname[2] != 0) {
 226                         /* Not CONNECT or reserved field nonzero - error */
 227                         reply[1] = 1;   /* generic failure */
 228                         sk_write(pr->s, (char *) reply, lenof(reply));
 229                         pfd_close(pr->s);
 230                         return 1;
 231                     }
 232                     /*
 233                      * Now we have a viable connect request. Switch
 234                      * on atype.
 235                      */
 236                     pr->port = GET_16BIT_MSB_FIRST(pr->hostname+4+alen);
 237                     if (atype == 1) {
 238                         /* REP=0 (success) already */
 239                         sk_write(pr->s, (char *) reply, lenof(reply));
 240                         sprintf(pr->hostname, "%d.%d.%d.%d",
 241                                 (unsigned char)pr->hostname[4],
 242                                 (unsigned char)pr->hostname[5],
 243                                 (unsigned char)pr->hostname[6],
 244                                 (unsigned char)pr->hostname[7]);
 245                         goto connect;
 246                     } else if (atype == 3) {
 247                         /* REP=0 (success) already */
 248                         sk_write(pr->s, (char *) reply, lenof(reply));
 249                         memmove(pr->hostname, pr->hostname + 5, alen-1);
 250                         pr->hostname[alen-1] = '\0';
 251                         goto connect;
 252                     } else {
 253                         /*
 254                          * Unknown address type. (FIXME: support IPv6!)
 255                          */
 256                         reply[1] = 8;   /* atype not supported */
 257                         sk_write(pr->s, (char *) reply, lenof(reply));
 258                         pfd_close(pr->s);
 259                         return 1;
 260                     }
 261                 }
 262             }
 263
 264             /*
 265              * If we get here without either having done `continue'
 266              * or `goto connect', it must be because there is no
 267              * sensible interpretation of what's in our buffer. So
 268              * close the connection rudely.
 269              */
 270             pfd_close(pr->s);
 271             return 1;
 272         }
 273         return 1;
 274
 275         /*
 276          * We come here when we're ready to make an actual
 277          * connection.
 278          */
 279         connect:
 280
 281         pr->c = new_sock_channel(pr->backhandle, pr->s);
 282         if (pr->c == NULL) {
 283             pfd_close(pr->s);
 284             return 1;
 285         } else {
 286             /* asks to forward to the specified host/port for this */
 287             ssh_send_port_open(pr->c, pr->hostname, pr->port, "forwarding");
 288         }
 289         pr->dynamic = 0;
 290
 291         /*
 292          * Now freeze the socket until the SSH server confirms the
 293          * connection.
 294          */
 295         sk_set_frozen(pr->s, 1);
 296         /*
 297          * If there's any data remaining in our current buffer,
 298          * save it to be sent on pfd_confirm().
 299          */
 300         if (len > 0) {
 301             pr->buffer = snewn(len, char);
 302             memcpy(pr->buffer, data, len);
 303             pr->buflen = len;
 304         }
 305     }
 306     if (pr->ready) {
 307         if (sshfwd_write(pr->c, data, len) > 0) {
 308             pr->throttled = 1;
 309             sk_set_frozen(pr->s, 1);
 310         }
 311     }
 312     return 1;
 313 }
 314
 315 static void pfd_sent(Plug plug, int bufsize)
 316 {
 317     struct PFwdPrivate *pr = (struct PFwdPrivate *) plug;
 318
 319     if (pr->c)
 320         sshfwd_unthrottle(pr->c, bufsize);
 321 }
 322
 323 /*
 324  * Called when receiving a PORT OPEN from the server
 325  */
 326 const char *pfd_newconnect(Socket *s, char *hostname, int port,
 327                            void *c, const Config *cfg, int addressfamily)
 328 {
 329     static const struct plug_function_table fn_table = {
 330         pfd_log,
 331         pfd_closing,
 332         pfd_receive,
 333         pfd_sent,
 334         NULL
 335     };
 336
 337     SockAddr addr;
 338     const char *err;
 339     char *dummy_realhost;
 340     struct PFwdPrivate *pr;
 341
 342     /*
 343      * Try to find host.
 344      */
 345     addr = name_lookup(hostname, port, &dummy_realhost, cfg, addressfamily);
 346     if ((err = sk_addr_error(addr)) != NULL) {
 347         sk_addr_free(addr);
 348         return err;
 349     }
 350
 351     /*
 352      * Open socket.
 353      */
 354     pr = snew(struct PFwdPrivate);
 355     pr->buffer = NULL;
 356     pr->fn = &fn_table;
 357     pr->throttled = pr->throttle_override = 0;
 358     pr->ready = 1;
 359     pr->c = c;
 360     pr->backhandle = NULL;             /* we shouldn't need this */
 361     pr->dynamic = 0;
 362
 363     pr->s = *s = new_connection(addr, dummy_realhost, port,
 364                                 0, 1, 0, 0, (Plug) pr, cfg);
 365     if ((err = sk_socket_error(*s)) != NULL) {
 366         sfree(pr);
 367         return err;
 368     }
 369
 370     sk_set_private_ptr(*s, pr);
 371     return NULL;
 372 }
 373
 374 /*
 375  called when someone connects to the local port
 376  */
 377
 378 static int pfd_accepting(Plug p, OSSocket sock)
 379 {
 380     static const struct plug_function_table fn_table = {
 381         pfd_log,
 382         pfd_closing,
 383         pfd_receive,
 384         pfd_sent,
 385         NULL
 386     };
 387     struct PFwdPrivate *pr, *org;
 388     Socket s;
 389     const char *err;
 390
 391     org = (struct PFwdPrivate *)p;
 392     pr = snew(struct PFwdPrivate);
 393     pr->buffer = NULL;
 394     pr->fn = &fn_table;
 395
 396     pr->c = NULL;
 397     pr->backhandle = org->backhandle;
 398
 399     pr->s = s = sk_register(sock, (Plug) pr);
 400     if ((err = sk_socket_error(s)) != NULL) {
 401         sfree(pr);
 402         return err != NULL;
 403     }
 404
 405     sk_set_private_ptr(s, pr);
 406
 407     pr->throttled = pr->throttle_override = 0;
 408     pr->ready = 0;
 409
 410     if (org->dynamic) {
 411         pr->dynamic = 1;
 412         pr->port = 0;                  /* "hostname" buffer is so far empty */
 413         sk_set_frozen(s, 0);           /* we want to receive SOCKS _now_! */
 414     } else {
 415         pr->dynamic = 0;
 416         strcpy(pr->hostname, org->hostname);
 417         pr->port = org->port;
 418         pr->c = new_sock_channel(org->backhandle, s);
 419
 420         if (pr->c == NULL) {
 421             sfree(pr);
 422             return 1;
 423         } else {
 424             /* asks to forward to the specified host/port for this */
 425             ssh_send_port_open(pr->c, pr->hostname, pr->port, "forwarding");
 426         }
 427     }
 428
 429     return 0;
 430 }
 431
 432
 433 /* Add a new forwarding from port -> desthost:destport
 434  sets up a listener on the local machine on (srcaddr:)port
 435  */
 436 const char *pfd_addforward(char *desthost, int destport, char *srcaddr,
 437                            int port, void *backhandle, const Config *cfg,
 438                            void **sockdata, int address_family)
 439 {
 440     static const struct plug_function_table fn_table = {
 441         pfd_log,
 442         pfd_closing,
 443         pfd_receive,                   /* should not happen... */
 444         pfd_sent,                      /* also should not happen */
 445         pfd_accepting
 446     };
 447
 448     const char *err;
 449     struct PFwdPrivate *pr;
 450     Socket s;
 451
 452     /*
 453      * Open socket.
 454      */
 455     pr = snew(struct PFwdPrivate);
 456     pr->buffer = NULL;
 457     pr->fn = &fn_table;
 458     pr->c = NULL;
 459     if (desthost) {
 460         strcpy(pr->hostname, desthost);
 461         pr->port = destport;
 462         pr->dynamic = 0;
 463     } else
 464         pr->dynamic = 1;
 465     pr->throttled = pr->throttle_override = 0;
 466     pr->ready = 0;
 467     pr->backhandle = backhandle;
 468
 469     pr->s = s = new_listener(srcaddr, port, (Plug) pr,
 470                              !cfg->lport_acceptall, cfg, address_family);
 471     if ((err = sk_socket_error(s)) != NULL) {
 472         sfree(pr);
 473         return err;
 474     }
 475
 476     sk_set_private_ptr(s, pr);
 477
 478     *sockdata = (void *)s;
 479
 480     return NULL;
 481 }
 482
 483 void pfd_close(Socket s)
 484 {
 485     struct PFwdPrivate *pr;
 486
 487     if (!s)
 488         return;
 489
 490     pr = (struct PFwdPrivate *) sk_get_private_ptr(s);
 491
 492     sfree(pr->buffer);
 493     sfree(pr);
 494
 495     sk_close(s);
 496 }
 497
 498 /*
 499  * Terminate a listener.
 500  */
 501 void pfd_terminate(void *sv)
 502 {
 503     pfd_close((Socket)sv);
 504 }
 505
 506 void pfd_unthrottle(Socket s)
 507 {
 508     struct PFwdPrivate *pr;
 509     if (!s)
 510         return;
 511     pr = (struct PFwdPrivate *) sk_get_private_ptr(s);
 512
 513     pr->throttled = 0;
 514     sk_set_frozen(s, pr->throttled || pr->throttle_override);
 515 }
 516
 517 void pfd_override_throttle(Socket s, int enable)
 518 {
 519     struct PFwdPrivate *pr;
 520     if (!s)
 521         return;
 522     pr = (struct PFwdPrivate *) sk_get_private_ptr(s);
 523
 524     pr->throttle_override = enable;
 525     sk_set_frozen(s, pr->throttled || pr->throttle_override);
 526 }
 527
 528 /*
 529  * Called to send data down the raw connection.
 530  */
 531 int pfd_send(Socket s, char *data, int len)
 532 {
 533     if (s == NULL)
 534         return 0;
 535     return sk_write(s, data, len);
 536 }
 537
 538
 539 void pfd_confirm(Socket s)
 540 {
 541     struct PFwdPrivate *pr;
 542
 543     if (s == NULL)
 544         return;
 545
 546     pr = (struct PFwdPrivate *) sk_get_private_ptr(s);
 547     pr->ready = 1;
 548     sk_set_frozen(s, 0);
 549     sk_write(s, NULL, 0);
 550     if (pr->buffer) {
 551         sshfwd_write(pr->c, pr->buffer, pr->buflen);
 552         sfree(pr->buffer);
 553         pr->buffer = NULL;
 554     }
 555 }