lib/libwebsockets.c

   1 /*
   2  * libwebsockets - small server side websockets and web server implementation
   3  *
   4  * Copyright (C) 2010 Andy Green <andy@warmcat.com>
   5  *
   6  *  This library is free software; you can redistribute it and/or
   7  *  modify it under the terms of the GNU Lesser General Public
   8  *  License as published by the Free Software Foundation:
   9  *  version 2.1 of the License.
  10  *
  11  *  This library is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  *  Lesser General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU Lesser General Public
  17  *  License along with this library; if not, write to the Free Software
  18  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  19  *  MA  02110-1301  USA
  20  */
  21
  22 #include "private-libwebsockets.h"
  23
  24 #ifdef WIN32
  25 #include <tchar.h>
  26 #include <io.h>
  27 #else
  28 #include <ifaddrs.h>
  29 #include <sys/un.h>
  30 #include <sys/socket.h>
  31 #include <netdb.h>
  32 #endif
  33
  34 #ifdef LWS_OPENSSL_SUPPORT
  35 int openssl_websocket_private_data_index;
  36 #endif
  37
  38 #ifdef __MINGW32__
  39 #include "../win32port/win32helpers/websock-w32.c"
  40 #else
  41 #ifdef __MINGW64__
  42 #include "../win32port/win32helpers/websock-w32.c"
  43 #endif
  44 #endif
  45
  46 /*
  47  * In-place str to lower case
  48  */
  49
  50 static void
  51 strtolower(char *s)
  52 {
  53         while (*s) {
  54                 *s = tolower(*s);
  55                 s++;
  56         }
  57 }
  58
  59 /* file descriptor hash management */
  60
  61 struct libwebsocket *
  62 wsi_from_fd(struct libwebsocket_context *context, int fd)
  63 {
  64         int h = LWS_FD_HASH(fd);
  65         int n = 0;
  66
  67         for (n = 0; n < context->fd_hashtable[h].length; n++)
  68                 if (context->fd_hashtable[h].wsi[n]->sock == fd)
  69                         return context->fd_hashtable[h].wsi[n];
  70
  71         return NULL;
  72 }
  73
  74 int
  75 insert_wsi(struct libwebsocket_context *context, struct libwebsocket *wsi)
  76 {
  77         int h = LWS_FD_HASH(wsi->sock);
  78
  79         if (context->fd_hashtable[h].length == MAX_CLIENTS - 1) {
  80                 fprintf(stderr, "hash table overflow\n");
  81                 return 1;
  82         }
  83
  84         context->fd_hashtable[h].wsi[context->fd_hashtable[h].length++] = wsi;
  85
  86         return 0;
  87 }
  88
  89 int
  90 delete_from_fd(struct libwebsocket_context *context, int fd)
  91 {
  92         int h = LWS_FD_HASH(fd);
  93         int n = 0;
  94
  95         for (n = 0; n < context->fd_hashtable[h].length; n++)
  96                 if (context->fd_hashtable[h].wsi[n]->sock == fd) {
  97                         while (n < context->fd_hashtable[h].length) {
  98                                 context->fd_hashtable[h].wsi[n] =
  99                                             context->fd_hashtable[h].wsi[n + 1];
 100                                 n++;
 101                         }
 102                         context->fd_hashtable[h].length--;
 103
 104                         return 0;
 105                 }
 106
 107         fprintf(stderr, "Failed to find fd %d requested for "
 108                                                    "delete in hashtable\n", fd);
 109         return 1;
 110 }
 111
 112 #ifdef LWS_OPENSSL_SUPPORT
 113 static void
 114 libwebsockets_decode_ssl_error(void)
 115 {
 116         char buf[256];
 117         u_long err;
 118
 119         while ((err = ERR_get_error()) != 0) {
 120                 ERR_error_string_n(err, buf, sizeof(buf));
 121                 fprintf(stderr, "*** %s\n", buf);
 122         }
 123 }
 124 #endif
 125
 126
 127 static int
 128 interface_to_sa(const char *ifname, struct sockaddr_in *addr, size_t addrlen)
 129 {
 130         int rc = -1;
 131 #ifdef WIN32
 132         /* TODO */
 133 #else
 134         struct ifaddrs *ifr;
 135         struct ifaddrs *ifc;
 136         struct sockaddr_in *sin;
 137
 138         getifaddrs(&ifr);
 139         for (ifc = ifr; ifc != NULL; ifc = ifc->ifa_next) {
 140                 if (strcmp(ifc->ifa_name, ifname))
 141                         continue;
 142                 if (ifc->ifa_addr == NULL)
 143                         continue;
 144                 sin = (struct sockaddr_in *)ifc->ifa_addr;
 145                 if (sin->sin_family != AF_INET)
 146                         continue;
 147                 memcpy(addr, sin, addrlen);
 148                 rc = 0;
 149         }
 150
 151         freeifaddrs(ifr);
 152 #endif
 153         return rc;
 154 }
 155
 156 void
 157 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
 158                          struct libwebsocket *wsi, enum lws_close_status reason)
 159 {
 160         int n;
 161         int old_state;
 162         unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 2 +
 163                                                   LWS_SEND_BUFFER_POST_PADDING];
 164         int ret;
 165         int m;
 166         struct lws_tokens eff_buf;
 167         struct libwebsocket_extension *ext;
 168
 169         if (!wsi)
 170                 return;
 171
 172         old_state = wsi->state;
 173
 174         if (old_state == WSI_STATE_DEAD_SOCKET)
 175                 return;
 176
 177         wsi->close_reason = reason;
 178
 179         /*
 180          * are his extensions okay with him closing?  Eg he might be a mux
 181          * parent and just his ch1 aspect is closing?
 182          */
 183
 184
 185         for (n = 0; n < wsi->count_active_extensions; n++) {
 186                 if (!wsi->active_extensions[n]->callback)
 187                         continue;
 188
 189                 m = wsi->active_extensions[n]->callback(context,
 190                         wsi->active_extensions[n], wsi,
 191                         LWS_EXT_CALLBACK_CHECK_OK_TO_REALLY_CLOSE,
 192                                        wsi->active_extensions_user[n], NULL, 0);
 193
 194                 /*
 195                  * if somebody vetoed actually closing him at this time....
 196                  * up to the extension to track the attempted close, let's
 197                  * just bail
 198                  */
 199
 200                 if (m) {
 201                         debug("extension vetoed close\n");
 202                         return;
 203                 }
 204         }
 205
 206
 207
 208         /*
 209          * flush any tx pending from extensions, since we may send close packet
 210          * if there are problems with send, just nuke the connection
 211          */
 212
 213         ret = 1;
 214         while (ret == 1) {
 215
 216                 /* default to nobody has more to spill */
 217
 218                 ret = 0;
 219                 eff_buf.token = NULL;
 220                 eff_buf.token_len = 0;
 221
 222                 /* show every extension the new incoming data */
 223
 224                 for (n = 0; n < wsi->count_active_extensions; n++) {
 225                         m = wsi->active_extensions[n]->callback(
 226                                         wsi->protocol->owning_server,
 227                                         wsi->active_extensions[n], wsi,
 228                                         LWS_EXT_CALLBACK_FLUSH_PENDING_TX,
 229                                    wsi->active_extensions_user[n], &eff_buf, 0);
 230                         if (m < 0) {
 231                                 fprintf(stderr, "Extension reports "
 232                                                                "fatal error\n");
 233                                 goto just_kill_connection;
 234                         }
 235                         if (m)
 236                                 /*
 237                                  * at least one extension told us he has more
 238                                  * to spill, so we will go around again after
 239                                  */
 240                                 ret = 1;
 241                 }
 242
 243                 /* assuming they left us something to send, send it */
 244
 245                 if (eff_buf.token_len)
 246                         if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
 247                                                              eff_buf.token_len))
 248                                 goto just_kill_connection;
 249         }
 250
 251         /*
 252          * signal we are closing, libsocket_write will
 253          * add any necessary version-specific stuff.  If the write fails,
 254          * no worries we are closing anyway.  If we didn't initiate this
 255          * close, then our state has been changed to
 256          * WSI_STATE_RETURNED_CLOSE_ALREADY and we will skip this.
 257          *
 258          * Likewise if it's a second call to close this connection after we
 259          * sent the close indication to the peer already, we are in state
 260          * WSI_STATE_AWAITING_CLOSE_ACK and will skip doing this a second time.
 261          */
 262
 263         if (old_state == WSI_STATE_ESTABLISHED &&
 264                                           reason != LWS_CLOSE_STATUS_NOSTATUS) {
 265
 266                 debug("sending close indication...\n");
 267
 268                 n = libwebsocket_write(wsi, &buf[LWS_SEND_BUFFER_PRE_PADDING],
 269                                                             0, LWS_WRITE_CLOSE);
 270                 if (!n) {
 271                         /*
 272                          * we have sent a nice protocol level indication we
 273                          * now wish to close, we should not send anything more
 274                          */
 275
 276                         wsi->state = WSI_STATE_AWAITING_CLOSE_ACK;
 277
 278                         /* and we should wait for a reply for a bit */
 279
 280                         libwebsocket_set_timeout(wsi,
 281                                                   PENDING_TIMEOUT_CLOSE_ACK, AWAITING_TIMEOUT);
 282
 283                         debug("sent close indication, awaiting ack\n");
 284
 285                         return;
 286                 }
 287
 288                 /* else, the send failed and we should just hang up */
 289         }
 290
 291 just_kill_connection:
 292
 293         debug("libwebsocket_close_and_free_session: just_kill_connection\n");
 294
 295         /*
 296          * we won't be servicing or receiving anything further from this guy
 297          * remove this fd from wsi mapping hashtable
 298          */
 299
 300         if (wsi->sock)
 301                 delete_from_fd(context, wsi->sock);
 302
 303         /* delete it from the internal poll list if still present */
 304
 305         for (n = 0; n < context->fds_count; n++) {
 306                 if (context->fds[n].fd != wsi->sock)
 307                         continue;
 308                 while (n < context->fds_count - 1) {
 309                         context->fds[n] = context->fds[n + 1];
 310                         n++;
 311                 }
 312                 context->fds_count--;
 313                 /* we only have to deal with one */
 314                 n = context->fds_count;
 315         }
 316
 317         /* remove also from external POLL support via protocol 0 */
 318         if (wsi->sock)
 319                 context->protocols[0].callback(context, wsi,
 320                     LWS_CALLBACK_DEL_POLL_FD, (void *)(long)wsi->sock, NULL, 0);
 321
 322         wsi->state = WSI_STATE_DEAD_SOCKET;
 323
 324         /* tell the user it's all over for this guy */
 325
 326         if (wsi->protocol && wsi->protocol->callback &&
 327                         ((old_state == WSI_STATE_ESTABLISHED) ||
 328                          (old_state == WSI_STATE_RETURNED_CLOSE_ALREADY) ||
 329                          (old_state == WSI_STATE_AWAITING_CLOSE_ACK))) {
 330                 debug("calling back CLOSED\n");
 331                 wsi->protocol->callback(context, wsi, LWS_CALLBACK_CLOSED,
 332                                                       wsi->user_space, NULL, 0);
 333         } else
 334                 debug("not calling back closed, old_state=%d\n", old_state);
 335
 336         /* deallocate any active extension contexts */
 337
 338         for (n = 0; n < wsi->count_active_extensions; n++) {
 339                 if (!wsi->active_extensions[n]->callback)
 340                         continue;
 341
 342                 wsi->active_extensions[n]->callback(context,
 343                         wsi->active_extensions[n], wsi,
 344                                 LWS_EXT_CALLBACK_DESTROY,
 345                                        wsi->active_extensions_user[n], NULL, 0);
 346
 347                 free(wsi->active_extensions_user[n]);
 348         }
 349
 350         /*
 351          * inform all extensions in case they tracked this guy out of band
 352          * even though not active on him specifically
 353          */
 354
 355         ext = context->extensions;
 356         while (ext && ext->callback) {
 357                 ext->callback(context, ext, wsi,
 358                                 LWS_EXT_CALLBACK_DESTROY_ANY_WSI_CLOSING,
 359                                        NULL, NULL, 0);
 360                 ext++;
 361         }
 362
 363         /* free up his parsing allocations */
 364
 365         for (n = 0; n < WSI_TOKEN_COUNT; n++)
 366                 if (wsi->utf8_token[n].token)
 367                         free(wsi->utf8_token[n].token);
 368
 369         if (wsi->c_address)
 370                 free(wsi->c_address);
 371
 372 /*      fprintf(stderr, "closing fd=%d\n", wsi->sock); */
 373
 374 #ifdef LWS_OPENSSL_SUPPORT
 375         if (wsi->ssl) {
 376                 n = SSL_get_fd(wsi->ssl);
 377                 SSL_shutdown(wsi->ssl);
 378 #ifdef WIN32
 379                 closesocket(n);
 380 #else
 381                 close(n);
 382 #endif
 383                 SSL_free(wsi->ssl);
 384         } else {
 385 #endif
 386                 shutdown(wsi->sock, SHUT_RDWR);
 387 #ifdef WIN32
 388                 if (wsi->sock)
 389                         closesocket(wsi->sock);
 390 #else
 391                 if (wsi->sock)
 392                         close(wsi->sock);
 393 #endif
 394 #ifdef LWS_OPENSSL_SUPPORT
 395         }
 396 #endif
 397         if (wsi->protocol && wsi->protocol->per_session_data_size && wsi->user_space) /* user code may own */
 398                 free(wsi->user_space);
 399
 400         free(wsi);
 401 }
 402
 403 /**
 404  * libwebsockets_hangup_on_client() - Server calls to terminate client
 405  *                                      connection
 406  * @context:    libwebsockets context
 407  * @fd:         Connection socket descriptor
 408  */
 409
 410 void
 411 libwebsockets_hangup_on_client(struct libwebsocket_context *context, int fd)
 412 {
 413         struct libwebsocket *wsi = wsi_from_fd(context, fd);
 414
 415         if (wsi == NULL)
 416                 return;
 417
 418         libwebsocket_close_and_free_session(context, wsi,
 419                                                      LWS_CLOSE_STATUS_NOSTATUS);
 420 }
 421
 422
 423 /**
 424  * libwebsockets_get_peer_addresses() - Get client address information
 425  * @fd:         Connection socket descriptor
 426  * @name:       Buffer to take client address name
 427  * @name_len:   Length of client address name buffer
 428  * @rip:        Buffer to take client address IP qotted quad
 429  * @rip_len:    Length of client address IP buffer
 430  *
 431  *      This function fills in @name and @rip with the name and IP of
 432  *      the client connected with socket descriptor @fd.  Names may be
 433  *      truncated if there is not enough room.  If either cannot be
 434  *      determined, they will be returned as valid zero-length strings.
 435  */
 436
 437 void
 438 libwebsockets_get_peer_addresses(int fd, char *name, int name_len,
 439                                         char *rip, int rip_len)
 440 {
 441         unsigned int len;
 442         struct sockaddr_in sin;
 443         struct hostent *host;
 444         struct hostent *host1;
 445         char ip[128];
 446         unsigned char *p;
 447         int n;
 448 #ifdef AF_LOCAL
 449     struct sockaddr_un *un;
 450 #endif
 451
 452         rip[0] = '\0';
 453         name[0] = '\0';
 454
 455         len = sizeof sin;
 456         if (getpeername(fd, (struct sockaddr *) &sin, &len) < 0) {
 457                 perror("getpeername");
 458                 return;
 459         }
 460
 461         host = gethostbyaddr((char *) &sin.sin_addr, sizeof sin.sin_addr,
 462                                                                        AF_INET);
 463         if (host == NULL) {
 464                 perror("gethostbyaddr");
 465                 return;
 466         }
 467
 468         strncpy(name, host->h_name, name_len);
 469         name[name_len - 1] = '\0';
 470
 471         host1 = gethostbyname(host->h_name);
 472         if (host1 == NULL)
 473                 return;
 474         p = (unsigned char *)host1;
 475         n = 0;
 476         while (p != NULL) {
 477                 p = (unsigned char *)host1->h_addr_list[n++];
 478                 if (p == NULL)
 479                         continue;
 480                 if ((host1->h_addrtype != AF_INET)
 481 #ifdef AF_LOCAL
 482                         && (host1->h_addrtype != AF_LOCAL)
 483 #endif
 484                         )
 485                         continue;
 486
 487                 if (host1->h_addrtype == AF_INET)
 488                         sprintf(ip, "%u.%u.%u.%u", p[0], p[1], p[2], p[3]);
 489 #ifdef AF_LOCAL
 490                 else {
 491                         un = (struct sockaddr_un *)p;
 492                         strncpy(ip, un->sun_path, sizeof(ip) - 1);
 493                         ip[sizeof(ip) - 1] = '\0';
 494                 }
 495 #endif
 496                 p = NULL;
 497                 strncpy(rip, ip, rip_len);
 498                 rip[rip_len - 1] = '\0';
 499         }
 500 }
 501
 502 int libwebsockets_get_random(struct libwebsocket_context *context,
 503                                                              void *buf, int len)
 504 {
 505         int n;
 506         char *p = buf;
 507
 508 #ifdef WIN32
 509         for (n = 0; n < len; n++)
 510                 p[n] = (unsigned char)rand();
 511 #else
 512         n = read(context->fd_random, p, len);
 513 #endif
 514
 515         return n;
 516 }
 517
 518 unsigned char *
 519 libwebsockets_SHA1(const unsigned char *d, size_t n, unsigned char *md)
 520 {
 521         return SHA1(d, n, md);
 522 }
 523
 524 void libwebsockets_00_spaceout(char *key, int spaces, int seed)
 525 {
 526         char *p;
 527
 528         key++;
 529         while (spaces--) {
 530                 if (*key && (seed & 1))
 531                         key++;
 532                 seed >>= 1;
 533
 534                 p = key + strlen(key);
 535                 while (p >= key) {
 536                         p[1] = p[0];
 537                         p--;
 538                 }
 539                 *key++ = ' ';
 540         }
 541 }
 542
 543 void libwebsockets_00_spam(char *key, int count, int seed)
 544 {
 545         char *p;
 546
 547         key++;
 548         while (count--) {
 549
 550                 if (*key && (seed & 1))
 551                         key++;
 552                 seed >>= 1;
 553
 554                 p = key + strlen(key);
 555                 while (p >= key) {
 556                         p[1] = p[0];
 557                         p--;
 558                 }
 559                 *key++ = 0x21 + ((seed & 0xffff) % 15);
 560                 /* 4 would use it up too fast.. not like it matters */
 561                 seed >>= 1;
 562         }
 563 }
 564
 565 int lws_send_pipe_choked(struct libwebsocket *wsi)
 566 {
 567         struct pollfd fds;
 568
 569         fds.fd = wsi->sock;
 570         fds.events = POLLOUT;
 571         fds.revents = 0;
 572
 573         if (poll(&fds, 1, 0) != 1)
 574                 return 1;
 575
 576         if ((fds.revents & POLLOUT) == 0)
 577                 return 1;
 578
 579         /* okay to send another packet without blocking */
 580
 581         return 0;
 582 }
 583
 584 int
 585 lws_handle_POLLOUT_event(struct libwebsocket_context *context,
 586                                 struct libwebsocket *wsi, struct pollfd *pollfd)
 587 {
 588         struct lws_tokens eff_buf;
 589         int n;
 590         int ret;
 591         int m;
 592         int handled = 0;
 593
 594         for (n = 0; n < wsi->count_active_extensions; n++) {
 595                 if (!wsi->active_extensions[n]->callback)
 596                         continue;
 597
 598                 m = wsi->active_extensions[n]->callback(context,
 599                         wsi->active_extensions[n], wsi,
 600                         LWS_EXT_CALLBACK_IS_WRITEABLE,
 601                                        wsi->active_extensions_user[n], NULL, 0);
 602                 if (m > handled)
 603                         handled = m;
 604         }
 605
 606         if (handled == 1)
 607                 goto notify_action;
 608
 609         if (!wsi->extension_data_pending || handled == 2)
 610                 goto user_service;
 611
 612         /*
 613          * check in on the active extensions, see if they
 614          * had pending stuff to spill... they need to get the
 615          * first look-in otherwise sequence will be disordered
 616          *
 617          * NULL, zero-length eff_buf means just spill pending
 618          */
 619
 620         ret = 1;
 621         while (ret == 1) {
 622
 623                 /* default to nobody has more to spill */
 624
 625                 ret = 0;
 626                 eff_buf.token = NULL;
 627                 eff_buf.token_len = 0;
 628
 629                 /* give every extension a chance to spill */
 630
 631                 for (n = 0; n < wsi->count_active_extensions; n++) {
 632                         m = wsi->active_extensions[n]->callback(
 633                                 wsi->protocol->owning_server,
 634                                 wsi->active_extensions[n], wsi,
 635                                         LWS_EXT_CALLBACK_PACKET_TX_PRESEND,
 636                                    wsi->active_extensions_user[n], &eff_buf, 0);
 637                         if (m < 0) {
 638                                 fprintf(stderr, "ext reports fatal error\n");
 639                                 return -1;
 640                         }
 641                         if (m)
 642                                 /*
 643                                  * at least one extension told us he has more
 644                                  * to spill, so we will go around again after
 645                                  */
 646                                 ret = 1;
 647                 }
 648
 649                 /* assuming they gave us something to send, send it */
 650
 651                 if (eff_buf.token_len) {
 652                         if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
 653                                                              eff_buf.token_len))
 654                                 return -1;
 655                 } else
 656                         continue;
 657
 658                 /* no extension has more to spill */
 659
 660                 if (!ret)
 661                         continue;
 662
 663                 /*
 664                  * There's more to spill from an extension, but we just sent
 665                  * something... did that leave the pipe choked?
 666                  */
 667
 668                 if (!lws_send_pipe_choked(wsi))
 669                         /* no we could add more */
 670                         continue;
 671
 672                 debug("choked in POLLOUT service\n");
 673
 674                 /*
 675                  * Yes, he's choked.  Leave the POLLOUT masked on so we will
 676                  * come back here when he is unchoked.  Don't call the user
 677                  * callback to enforce ordering of spilling, he'll get called
 678                  * when we come back here and there's nothing more to spill.
 679                  */
 680
 681                 return 0;
 682         }
 683
 684         wsi->extension_data_pending = 0;
 685
 686 user_service:
 687         /* one shot */
 688
 689         if (pollfd) {
 690                 pollfd->events &= ~POLLOUT;
 691
 692                 /* external POLL support via protocol 0 */
 693                 context->protocols[0].callback(context, wsi,
 694                         LWS_CALLBACK_CLEAR_MODE_POLL_FD,
 695                         (void *)(long)wsi->sock, NULL, POLLOUT);
 696         }
 697
 698 notify_action:
 699
 700         if (wsi->mode == LWS_CONNMODE_WS_CLIENT)
 701                 n = LWS_CALLBACK_CLIENT_WRITEABLE;
 702         else
 703                 n = LWS_CALLBACK_SERVER_WRITEABLE;
 704
 705         wsi->protocol->callback(context, wsi, n, wsi->user_space, NULL, 0);
 706
 707         return 0;
 708 }
 709
 710
 711
 712 void
 713 libwebsocket_service_timeout_check(struct libwebsocket_context *context,
 714                                      struct libwebsocket *wsi, unsigned int sec)
 715 {
 716         int n;
 717
 718         /*
 719          * if extensions want in on it (eg, we are a mux parent)
 720          * give them a chance to service child timeouts
 721          */
 722
 723         for (n = 0; n < wsi->count_active_extensions; n++)
 724                 wsi->active_extensions[n]->callback(
 725                                     context, wsi->active_extensions[n],
 726                                     wsi, LWS_EXT_CALLBACK_1HZ,
 727                                     wsi->active_extensions_user[n], NULL, sec);
 728
 729         if (!wsi->pending_timeout)
 730                 return;
 731
 732         /*
 733          * if we went beyond the allowed time, kill the
 734          * connection
 735          */
 736
 737         if (sec > wsi->pending_timeout_limit) {
 738                 debug("TIMEDOUT WAITING\n");
 739                 libwebsocket_close_and_free_session(context,
 740                                 wsi, LWS_CLOSE_STATUS_NOSTATUS);
 741         }
 742 }
 743
 744 struct libwebsocket *
 745 libwebsocket_create_new_server_wsi(struct libwebsocket_context *context)
 746 {
 747         struct libwebsocket *new_wsi;
 748         int n;
 749
 750         new_wsi = malloc(sizeof(struct libwebsocket));
 751         if (new_wsi == NULL) {
 752                 fprintf(stderr, "Out of memory for new connection\n");
 753                 return NULL;
 754         }
 755
 756         memset(new_wsi, 0, sizeof(struct libwebsocket));
 757         new_wsi->count_active_extensions = 0;
 758         new_wsi->pending_timeout = NO_PENDING_TIMEOUT;
 759
 760         /* intialize the instance struct */
 761
 762         new_wsi->state = WSI_STATE_HTTP;
 763         new_wsi->name_buffer_pos = 0;
 764         new_wsi->mode = LWS_CONNMODE_WS_SERVING;
 765
 766         for (n = 0; n < WSI_TOKEN_COUNT; n++) {
 767                 new_wsi->utf8_token[n].token = NULL;
 768                 new_wsi->utf8_token[n].token_len = 0;
 769         }
 770
 771         /*
 772          * these can only be set once the protocol is known
 773          * we set an unestablished connection's protocol pointer
 774          * to the start of the supported list, so it can look
 775          * for matching ones during the handshake
 776          */
 777         new_wsi->protocol = context->protocols;
 778         new_wsi->user_space = NULL;
 779
 780         /*
 781          * Default protocol is 76 / 00
 782          * After 76, there's a header specified to inform which
 783          * draft the client wants, when that's seen we modify
 784          * the individual connection's spec revision accordingly
 785          */
 786         new_wsi->ietf_spec_revision = 0;
 787
 788         return new_wsi;
 789 }
 790
 791 char *
 792 libwebsockets_generate_client_handshake(struct libwebsocket_context *context,
 793                 struct libwebsocket *wsi, char *pkt)
 794 {
 795         char hash[20];
 796         char *p = pkt;
 797         int n;
 798         struct libwebsocket_extension *ext;
 799         struct libwebsocket_extension *ext1;
 800         int ext_count = 0;
 801         unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 1 +
 802                          MAX_BROADCAST_PAYLOAD + LWS_SEND_BUFFER_POST_PADDING];
 803         static const char magic_websocket_guid[] =
 804                                          "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
 805
 806         /*
 807          * create the random key
 808          */
 809
 810         n = libwebsockets_get_random(context, hash, 16);
 811         if (n != 16) {
 812                 fprintf(stderr, "Unable to read from random dev %s\n",
 813                                                 SYSTEM_RANDOM_FILEPATH);
 814                 free(wsi->c_path);
 815                 free(wsi->c_host);
 816                 if (wsi->c_origin)
 817                         free(wsi->c_origin);
 818                 if (wsi->c_protocol)
 819                         free(wsi->c_protocol);
 820                 libwebsocket_close_and_free_session(context, wsi,
 821                                              LWS_CLOSE_STATUS_NOSTATUS);
 822                 return NULL;
 823         }
 824
 825         lws_b64_encode_string(hash, 16, wsi->key_b64,
 826                                                    sizeof wsi->key_b64);
 827
 828         /*
 829          * 00 example client handshake
 830          *
 831          * GET /socket.io/websocket HTTP/1.1
 832          * Upgrade: WebSocket
 833          * Connection: Upgrade
 834          * Host: 127.0.0.1:9999
 835          * Origin: http://127.0.0.1
 836          * Sec-WebSocket-Key1: 1 0 2#0W 9 89 7  92 ^
 837          * Sec-WebSocket-Key2: 7 7Y 4328 B2v[8(z1
 838          * Cookie: socketio=websocket
 839          *
 840          * (Á®Ä0¶†≥
 841          *
 842          * 04 example client handshake
 843          *
 844          * GET /chat HTTP/1.1
 845          * Host: server.example.com
 846          * Upgrade: websocket
 847          * Connection: Upgrade
 848          * Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
 849          * Sec-WebSocket-Origin: http://example.com
 850          * Sec-WebSocket-Protocol: chat, superchat
 851          * Sec-WebSocket-Version: 4
 852          */
 853
 854         p += sprintf(p, "GET %s HTTP/1.1\x0d\x0a", wsi->c_path);
 855
 856         if (wsi->ietf_spec_revision == 0) {
 857                 unsigned char spaces_1, spaces_2;
 858                 unsigned int max_1, max_2;
 859                 unsigned int num_1, num_2;
 860                 unsigned long product_1, product_2;
 861                 char key_1[40];
 862                 char key_2[40];
 863                 unsigned int seed;
 864                 unsigned int count;
 865                 char challenge[16];
 866
 867                 libwebsockets_get_random(context, &spaces_1, sizeof(char));
 868                 libwebsockets_get_random(context, &spaces_2, sizeof(char));
 869
 870                 spaces_1 = (spaces_1 % 12) + 1;
 871                 spaces_2 = (spaces_2 % 12) + 1;
 872
 873                 max_1 = 4294967295 / spaces_1;
 874                 max_2 = 4294967295 / spaces_2;
 875
 876                 libwebsockets_get_random(context, &num_1, sizeof(int));
 877                 libwebsockets_get_random(context, &num_2, sizeof(int));
 878
 879                 num_1 = (num_1 % max_1);
 880                 num_2 = (num_2 % max_2);
 881
 882                 challenge[0] = num_1 >> 24;
 883                 challenge[1] = num_1 >> 16;
 884                 challenge[2] = num_1 >> 8;
 885                 challenge[3] = num_1;
 886                 challenge[4] = num_2 >> 24;
 887                 challenge[5] = num_2 >> 16;
 888                 challenge[6] = num_2 >> 8;
 889                 challenge[7] = num_2;
 890
 891                 product_1 = num_1 * spaces_1;
 892                 product_2 = num_2 * spaces_2;
 893
 894                 sprintf(key_1, "%lu", product_1);
 895                 sprintf(key_2, "%lu", product_2);
 896
 897                 libwebsockets_get_random(context, &seed, sizeof(int));
 898                 libwebsockets_get_random(context, &count, sizeof(int));
 899
 900                 libwebsockets_00_spam(key_1, (count % 12) + 1, seed);
 901
 902                 libwebsockets_get_random(context, &seed, sizeof(int));
 903                 libwebsockets_get_random(context, &count, sizeof(int));
 904
 905                 libwebsockets_00_spam(key_2, (count % 12) + 1, seed);
 906
 907                 libwebsockets_get_random(context, &seed, sizeof(int));
 908
 909                 libwebsockets_00_spaceout(key_1, spaces_1, seed);
 910                 libwebsockets_00_spaceout(key_2, spaces_2, seed >> 16);
 911
 912                 p += sprintf(p, "Upgrade: WebSocket\x0d\x0a"
 913                         "Connection: Upgrade\x0d\x0aHost: %s\x0d\x0a",
 914                         wsi->c_host);
 915                 if (wsi->c_origin)
 916                         p += sprintf(p, "Origin: %s\x0d\x0a", wsi->c_origin);
 917
 918                 if (wsi->c_protocol)
 919                         p += sprintf(p, "Sec-WebSocket-Protocol: %s"
 920                                          "\x0d\x0a", wsi->c_protocol);
 921
 922                 p += sprintf(p, "Sec-WebSocket-Key1: %s\x0d\x0a", key_1);
 923                 p += sprintf(p, "Sec-WebSocket-Key2: %s\x0d\x0a", key_2);
 924
 925                 /* give userland a chance to append, eg, cookies */
 926
 927                 context->protocols[0].callback(context, wsi,
 928                         LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER,
 929                                 NULL, &p, (pkt + sizeof(pkt)) - p - 12);
 930
 931                 p += sprintf(p, "\x0d\x0a");
 932
 933                 if (libwebsockets_get_random(context, p, 8) != 8)
 934                         return NULL;
 935                 memcpy(&challenge[8], p, 8);
 936                 p += 8;
 937
 938                 /* precompute what we want to see from the server */
 939
 940                 MD5((unsigned char *)challenge, 16,
 941                    (unsigned char *)wsi->initial_handshake_hash_base64);
 942
 943                 goto issue_hdr;
 944         }
 945
 946         p += sprintf(p, "Host: %s\x0d\x0a", wsi->c_host);
 947         p += sprintf(p, "Upgrade: websocket\x0d\x0a");
 948         p += sprintf(p, "Connection: Upgrade\x0d\x0a"
 949                                 "Sec-WebSocket-Key: ");
 950         strcpy(p, wsi->key_b64);
 951         p += strlen(wsi->key_b64);
 952         p += sprintf(p, "\x0d\x0a");
 953         if (wsi->c_origin) {
 954         if (wsi->ietf_spec_revision == 13) {
 955             p += sprintf(p, "Origin: %s\x0d\x0a",
 956                                                          wsi->c_origin);
 957         }
 958         else {
 959                     p += sprintf(p, "Sec-WebSocket-Origin: %s\x0d\x0a",
 960                                                          wsi->c_origin);
 961         }
 962     }
 963         if (wsi->c_protocol)
 964                 p += sprintf(p, "Sec-WebSocket-Protocol: %s\x0d\x0a",
 965                                                        wsi->c_protocol);
 966
 967         /* tell the server what extensions we could support */
 968
 969         p += sprintf(p, "Sec-WebSocket-Extensions: ");
 970
 971         ext = context->extensions;
 972         while (ext && ext->callback) {
 973
 974                 n = 0;
 975                 ext1 = context->extensions;
 976
 977                 while (ext1 && ext1->callback) {
 978                         n |= ext1->callback(context, ext1, wsi,
 979                                 LWS_EXT_CALLBACK_CHECK_OK_TO_PROPOSE_EXTENSION,
 980                                         NULL, (char *)ext->name, 0);
 981
 982                         ext1++;
 983                 }
 984
 985                 if (n) { /* an extension vetos us */
 986                         debug("ext %s vetoed\n", (char *)ext->name);
 987                         ext++;
 988                         continue;
 989                 }
 990
 991                 n = context->protocols[0].callback(context, wsi,
 992                         LWS_CALLBACK_CLIENT_CONFIRM_EXTENSION_SUPPORTED,
 993                                 wsi->user_space, (char *)ext->name, 0);
 994
 995                 /*
 996                  * zero return from callback means
 997                  * go ahead and allow the extension,
 998                  * it's what we get if the callback is
 999                  * unhandled
1000                  */
1001
1002                 if (n) {
1003                         ext++;
1004                         continue;
1005                 }
1006
1007                 /* apply it */
1008
1009                 if (ext_count)
1010                         *p++ = ',';
1011                 p += sprintf(p, "%s", ext->name);
1012                 ext_count++;
1013
1014                 ext++;
1015         }
1016
1017         p += sprintf(p, "\x0d\x0a");
1018
1019         if (wsi->ietf_spec_revision)
1020                 p += sprintf(p, "Sec-WebSocket-Version: %d\x0d\x0a",
1021                                                wsi->ietf_spec_revision);
1022
1023         /* give userland a chance to append, eg, cookies */
1024
1025         context->protocols[0].callback(context, wsi,
1026                 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER,
1027                 NULL, &p, (pkt + sizeof(pkt)) - p - 12);
1028
1029         p += sprintf(p, "\x0d\x0a");
1030
1031         /* prepare the expected server accept response */
1032
1033         strcpy((char *)buf, wsi->key_b64);
1034         strcpy((char *)&buf[strlen((char *)buf)], magic_websocket_guid);
1035
1036         SHA1(buf, strlen((char *)buf), (unsigned char *)hash);
1037
1038         lws_b64_encode_string(hash, 20,
1039                         wsi->initial_handshake_hash_base64,
1040                              sizeof wsi->initial_handshake_hash_base64);
1041
1042 issue_hdr:
1043
1044 #if 0
1045         puts(pkt);
1046 #endif
1047
1048         /* done with these now */
1049
1050         free(wsi->c_path);
1051         free(wsi->c_host);
1052         if (wsi->c_origin)
1053                 free(wsi->c_origin);
1054
1055         return p;
1056 }
1057
1058 int
1059 lws_client_interpret_server_handshake(struct libwebsocket_context *context,
1060                 struct libwebsocket *wsi)
1061 {
1062         unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 1 +
1063                         MAX_BROADCAST_PAYLOAD + LWS_SEND_BUFFER_POST_PADDING];
1064         char pkt[1024];
1065         char *p = &pkt[0];
1066         const char *pc;
1067         const char *c;
1068         int more = 1;
1069         int okay = 0;
1070         char ext_name[128];
1071         struct libwebsocket_extension *ext;
1072         void *v;
1073         int len = 0;
1074         int n;
1075         static const char magic_websocket_04_masking_guid[] =
1076                                          "61AC5F19-FBBA-4540-B96F-6561F1AB40A8";
1077
1078         /*
1079          * 00 / 76 -->
1080          *
1081          * HTTP/1.1 101 WebSocket Protocol Handshake
1082          * Upgrade: WebSocket
1083          * Connection: Upgrade
1084          * Sec-WebSocket-Origin: http://127.0.0.1
1085          * Sec-WebSocket-Location: ws://127.0.0.1:9999/socket.io/websocket
1086          *
1087          * xxxxxxxxxxxxxxxx
1088          */
1089
1090         if (wsi->ietf_spec_revision == 0) {
1091                 if (!wsi->utf8_token[WSI_TOKEN_HTTP].token_len ||
1092                         !wsi->utf8_token[WSI_TOKEN_UPGRADE].token_len ||
1093                         !wsi->utf8_token[WSI_TOKEN_CHALLENGE].token_len ||
1094                         !wsi->utf8_token[WSI_TOKEN_CONNECTION].token_len ||
1095                         (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len &&
1096                         wsi->c_protocol != NULL)) {
1097                         debug("libwebsocket_client_handshake "
1098                                         "missing required header(s)\n");
1099                         pkt[len] = '\0';
1100                         debug("%s", pkt);
1101                         goto bail3;
1102                 }
1103
1104                 strtolower(wsi->utf8_token[WSI_TOKEN_HTTP].token);
1105                 if (strncmp(wsi->utf8_token[WSI_TOKEN_HTTP].token, "101", 3)) {
1106                         fprintf(stderr, "libwebsocket_client_handshake "
1107                                 "server sent bad HTTP response '%s'\n",
1108                                 wsi->utf8_token[WSI_TOKEN_HTTP].token);
1109                         goto bail3;
1110                 }
1111
1112                 if (wsi->utf8_token[WSI_TOKEN_CHALLENGE].token_len < 16) {
1113                         fprintf(stderr, "libwebsocket_client_handshake "
1114                                 "challenge reply too short %d\n",
1115                                 wsi->utf8_token[
1116                                         WSI_TOKEN_CHALLENGE].token_len);
1117                         pkt[len] = '\0';
1118                         debug("%s", pkt);
1119                         goto bail3;
1120
1121                 }
1122
1123                 goto select_protocol;
1124         }
1125
1126         /*
1127          * well, what the server sent looked reasonable for syntax.
1128          * Now let's confirm it sent all the necessary headers
1129          */
1130 #if 0
1131         fprintf(stderr, "WSI_TOKEN_HTTP: %d\n",
1132                                     wsi->utf8_token[WSI_TOKEN_HTTP].token_len);
1133         fprintf(stderr, "WSI_TOKEN_UPGRADE: %d\n",
1134                                  wsi->utf8_token[WSI_TOKEN_UPGRADE].token_len);
1135         fprintf(stderr, "WSI_TOKEN_CONNECTION: %d\n",
1136                               wsi->utf8_token[WSI_TOKEN_CONNECTION].token_len);
1137         fprintf(stderr, "WSI_TOKEN_ACCEPT: %d\n",
1138                                   wsi->utf8_token[WSI_TOKEN_ACCEPT].token_len);
1139         fprintf(stderr, "WSI_TOKEN_NONCE: %d\n",
1140                                    wsi->utf8_token[WSI_TOKEN_NONCE].token_len);
1141         fprintf(stderr, "WSI_TOKEN_PROTOCOL: %d\n",
1142                                 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len);
1143 #endif
1144         if (!wsi->utf8_token[WSI_TOKEN_HTTP].token_len ||
1145             !wsi->utf8_token[WSI_TOKEN_UPGRADE].token_len ||
1146             !wsi->utf8_token[WSI_TOKEN_CONNECTION].token_len ||
1147             !wsi->utf8_token[WSI_TOKEN_ACCEPT].token_len ||
1148             (!wsi->utf8_token[WSI_TOKEN_NONCE].token_len &&
1149                                    wsi->ietf_spec_revision == 4) ||
1150             (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len &&
1151                                                     wsi->c_protocol != NULL)) {
1152                 debug("libwebsocket_client_handshake "
1153                                         "missing required header(s)\n");
1154                 pkt[len] = '\0';
1155                 debug("%s", pkt);
1156                 goto bail3;
1157         }
1158
1159         /*
1160          * Everything seems to be there, now take a closer look at what
1161          * is in each header
1162          */
1163
1164         strtolower(wsi->utf8_token[WSI_TOKEN_HTTP].token);
1165         if (strncmp(wsi->utf8_token[WSI_TOKEN_HTTP].token, "101", 3)) {
1166                 fprintf(stderr, "libwebsocket_client_handshake "
1167                                 "server sent bad HTTP response '%s'\n",
1168                                  wsi->utf8_token[WSI_TOKEN_HTTP].token);
1169                 goto bail3;
1170         }
1171
1172         strtolower(wsi->utf8_token[WSI_TOKEN_UPGRADE].token);
1173         if (strcmp(wsi->utf8_token[WSI_TOKEN_UPGRADE].token,
1174                                                          "websocket")) {
1175                 fprintf(stderr, "libwebsocket_client_handshake server "
1176                                 "sent bad Upgrade header '%s'\n",
1177                                   wsi->utf8_token[WSI_TOKEN_UPGRADE].token);
1178                 goto bail3;
1179         }
1180
1181         strtolower(wsi->utf8_token[WSI_TOKEN_CONNECTION].token);
1182         if (strcmp(wsi->utf8_token[WSI_TOKEN_CONNECTION].token,
1183                                                            "upgrade")) {
1184                 fprintf(stderr, "libwebsocket_client_handshake server "
1185                                 "sent bad Connection hdr '%s'\n",
1186                            wsi->utf8_token[WSI_TOKEN_CONNECTION].token);
1187                 goto bail3;
1188         }
1189
1190 select_protocol:
1191         pc = wsi->c_protocol;
1192         if (pc == NULL)
1193                 fprintf(stderr, "lws_client_interpret_server_handshake: "
1194                                                           "NULL c_protocol\n");
1195         else
1196                 debug("lws_client_interpret_server_handshake: "
1197                                                       "cPprotocol='%s'\n", pc);
1198
1199         /*
1200          * confirm the protocol the server wants to talk was in the list
1201          * of protocols we offered
1202          */
1203
1204         if (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len) {
1205
1206                 fprintf(stderr, "lws_client_interpret_server_handshake "
1207                                                "WSI_TOKEN_PROTOCOL is null\n");
1208                 /*
1209                  * no protocol name to work from,
1210                  * default to first protocol
1211                  */
1212                 wsi->protocol = &context->protocols[0];
1213                 wsi->c_callback = wsi->protocol->callback;
1214                 free(wsi->c_protocol);
1215
1216                 goto check_extensions;
1217         }
1218
1219         while (*pc && !okay) {
1220                 if ((!strncmp(pc, wsi->utf8_token[WSI_TOKEN_PROTOCOL].token,
1221                  wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len)) &&
1222                  (pc[wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len] == ',' ||
1223                   pc[wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len] == '\0')) {
1224                         okay = 1;
1225                         continue;
1226                 }
1227                 while (*pc && *pc != ',')
1228                         pc++;
1229                 while (*pc && *pc != ' ')
1230                         pc++;
1231         }
1232
1233         /* done with him now */
1234
1235         if (wsi->c_protocol)
1236                 free(wsi->c_protocol);
1237
1238         if (!okay) {
1239                 fprintf(stderr, "libwebsocket_client_handshake server "
1240                                         "sent bad protocol '%s'\n",
1241                                  wsi->utf8_token[WSI_TOKEN_PROTOCOL].token);
1242                 goto bail2;
1243         }
1244
1245         /*
1246          * identify the selected protocol struct and set it
1247          */
1248         n = 0;
1249         wsi->protocol = NULL;
1250         while (context->protocols[n].callback && !wsi->protocol) {  /* Stop after finding first one?? */
1251                 if (strcmp(wsi->utf8_token[WSI_TOKEN_PROTOCOL].token,
1252                                            context->protocols[n].name) == 0) {
1253                         wsi->protocol = &context->protocols[n];
1254                         wsi->c_callback = wsi->protocol->callback;
1255                 }
1256                 n++;
1257         }
1258
1259         if (wsi->protocol == NULL) {
1260                 fprintf(stderr, "libwebsocket_client_handshake server "
1261                                 "requested protocol '%s', which we "
1262                                 "said we supported but we don't!\n",
1263                                  wsi->utf8_token[WSI_TOKEN_PROTOCOL].token);
1264                 goto bail2;
1265         }
1266
1267
1268 check_extensions:
1269
1270         /* instantiate the accepted extensions */
1271
1272         if (!wsi->utf8_token[WSI_TOKEN_EXTENSIONS].token_len) {
1273                 debug("no client extenstions allowed by server\n");
1274                 goto check_accept;
1275         }
1276
1277         /*
1278          * break down the list of server accepted extensions
1279          * and go through matching them or identifying bogons
1280          */
1281
1282         c = wsi->utf8_token[WSI_TOKEN_EXTENSIONS].token;
1283         n = 0;
1284         while (more) {
1285
1286                 if (*c && (*c != ',' && *c != ' ' && *c != '\t')) {
1287                         ext_name[n] = *c++;
1288                         if (n < sizeof(ext_name) - 1)
1289                                 n++;
1290                         continue;
1291                 }
1292                 ext_name[n] = '\0';
1293                 if (!*c)
1294                         more = 0;
1295                 else {
1296                         c++;
1297                         if (!n)
1298                                 continue;
1299                 }
1300
1301                 /* check we actually support it */
1302
1303                 debug("checking client ext %s\n", ext_name);
1304
1305                 n = 0;
1306                 ext = wsi->protocol->owning_server->extensions;
1307                 while (ext && ext->callback) {
1308
1309                         if (strcmp(ext_name, ext->name)) {
1310                                 ext++;
1311                                 continue;
1312                         }
1313
1314                         n = 1;
1315
1316                         debug("instantiating client ext %s\n", ext_name);
1317
1318                         /* instantiate the extension on this conn */
1319
1320                         wsi->active_extensions_user[
1321                                 wsi->count_active_extensions] =
1322                                          malloc(ext->per_session_data_size);
1323                         memset(wsi->active_extensions_user[
1324                                 wsi->count_active_extensions], 0,
1325                                                     ext->per_session_data_size);
1326                         wsi->active_extensions[
1327                                   wsi->count_active_extensions] = ext;
1328
1329                         /* allow him to construct his context */
1330
1331                         ext->callback(wsi->protocol->owning_server,
1332                                 ext, wsi,
1333                                    LWS_EXT_CALLBACK_CLIENT_CONSTRUCT,
1334                                         wsi->active_extensions_user[
1335                                          wsi->count_active_extensions],
1336                                                                    NULL, 0);
1337
1338                         wsi->count_active_extensions++;
1339
1340                         ext++;
1341                 }
1342
1343                 if (n == 0) {
1344                         fprintf(stderr, "Server said we should use"
1345                                   "an unknown extension '%s'!\n", ext_name);
1346                         goto bail2;
1347                 }
1348
1349                 n = 0;
1350         }
1351
1352
1353 check_accept:
1354
1355         if (wsi->ietf_spec_revision == 0) {
1356
1357                 if (memcmp(wsi->initial_handshake_hash_base64,
1358                           wsi->utf8_token[WSI_TOKEN_CHALLENGE].token, 16)) {
1359                         fprintf(stderr, "libwebsocket_client_handshake "
1360                                            "failed 00 challenge compare\n");
1361                                 pkt[len] = '\0';
1362                                 fprintf(stderr, "%s", pkt);
1363                                 goto bail2;
1364                 }
1365
1366                 goto accept_ok;
1367         }
1368
1369         /*
1370          * Confirm his accept token is the one we precomputed
1371          */
1372
1373         if (strcmp(wsi->utf8_token[WSI_TOKEN_ACCEPT].token,
1374                                   wsi->initial_handshake_hash_base64)) {
1375                 fprintf(stderr, "libwebsocket_client_handshake server "
1376                         "sent bad ACCEPT '%s' vs computed '%s'\n",
1377                         wsi->utf8_token[WSI_TOKEN_ACCEPT].token,
1378                                         wsi->initial_handshake_hash_base64);
1379                 goto bail2;
1380         }
1381
1382         if (wsi->ietf_spec_revision == 4) {
1383                 /*
1384                  * Calculate the 04 masking key to use when
1385                  * sending data to server
1386                  */
1387
1388                 strcpy((char *)buf, wsi->key_b64);
1389                 p = (char *)buf + strlen(wsi->key_b64);
1390                 strcpy(p, wsi->utf8_token[WSI_TOKEN_NONCE].token);
1391                 p += wsi->utf8_token[WSI_TOKEN_NONCE].token_len;
1392                 strcpy(p, magic_websocket_04_masking_guid);
1393                 SHA1(buf, strlen((char *)buf), wsi->masking_key_04);
1394         }
1395 accept_ok:
1396
1397         /* allocate the per-connection user memory (if any) */
1398         if (wsi->protocol->per_session_data_size &&
1399                                           !libwebsocket_ensure_user_space(wsi))
1400                 goto bail2;
1401
1402         /* clear his proxy connection timeout */
1403
1404         libwebsocket_set_timeout(wsi, NO_PENDING_TIMEOUT, 0);
1405
1406         /* mark him as being alive */
1407
1408         wsi->state = WSI_STATE_ESTABLISHED;
1409         wsi->mode = LWS_CONNMODE_WS_CLIENT;
1410
1411         debug("handshake OK for protocol %s\n", wsi->protocol->name);
1412
1413         /* call him back to inform him he is up */
1414
1415         wsi->protocol->callback(context, wsi,
1416                                 LWS_CALLBACK_CLIENT_ESTABLISHED,
1417                                                      wsi->user_space, NULL, 0);
1418
1419         /*
1420          * inform all extensions, not just active ones since they
1421          * already know
1422          */
1423
1424         ext = context->extensions;
1425
1426         while (ext && ext->callback) {
1427                 v = NULL;
1428                 for (n = 0; n < wsi->count_active_extensions; n++)
1429                         if (wsi->active_extensions[n] == ext)
1430                                 v = wsi->active_extensions_user[n];
1431
1432                 ext->callback(context, ext, wsi,
1433                           LWS_EXT_CALLBACK_ANY_WSI_ESTABLISHED, v, NULL, 0);
1434                 ext++;
1435         }
1436
1437         return 0;
1438
1439 bail3:
1440         if (wsi->c_protocol)
1441                 free(wsi->c_protocol);
1442
1443 bail2:
1444         if (wsi->c_callback) wsi->c_callback(context, wsi,
1445        LWS_CALLBACK_CLIENT_CONNECTION_ERROR,
1446                          wsi->user_space,
1447                          NULL, 0);
1448         libwebsocket_close_and_free_session(context, wsi,
1449                                                  LWS_CLOSE_STATUS_NOSTATUS);  // But this should be LWS_CLOSE_STATUS_PROTOCOL_ERR
1450
1451         return 1;
1452 }
1453
1454
1455
1456 /**
1457  * libwebsocket_service_fd() - Service polled socket with something waiting
1458  * @context:    Websocket context
1459  * @pollfd:     The pollfd entry describing the socket fd and which events
1460  *              happened.
1461  *
1462  *      This function closes any active connections and then frees the
1463  *      context.  After calling this, any further use of the context is
1464  *      undefined.
1465  */
1466
1467 int
1468 libwebsocket_service_fd(struct libwebsocket_context *context,
1469                                                           struct pollfd *pollfd)
1470 {
1471         unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 1 +
1472                          MAX_BROADCAST_PAYLOAD + LWS_SEND_BUFFER_POST_PADDING];
1473         struct libwebsocket *wsi;
1474         struct libwebsocket *new_wsi;
1475         int n;
1476         int m;
1477         ssize_t len;
1478         int accept_fd;
1479         unsigned int clilen;
1480         struct sockaddr_in cli_addr;
1481         struct timeval tv;
1482         char pkt[1024];
1483         char *p = &pkt[0];
1484         int more = 1;
1485         struct lws_tokens eff_buf;
1486         int opt = 1;
1487         char c;
1488
1489 #ifdef LWS_OPENSSL_SUPPORT
1490         char ssl_err_buf[512];
1491 #endif
1492         /*
1493          * you can call us with pollfd = NULL to just allow the once-per-second
1494          * global timeout checks; if less than a second since the last check
1495          * it returns immediately then.
1496          */
1497
1498         gettimeofday(&tv, NULL);
1499
1500         if (context->last_timeout_check_s != tv.tv_sec) {
1501                 context->last_timeout_check_s = tv.tv_sec;
1502
1503                 /* global timeout check once per second */
1504
1505                 for (n = 0; n < context->fds_count; n++) {
1506                         wsi = wsi_from_fd(context, context->fds[n].fd);
1507
1508                         libwebsocket_service_timeout_check(context, wsi,
1509                                                                      tv.tv_sec);
1510                 }
1511         }
1512
1513         /* just here for timeout management? */
1514
1515         if (pollfd == NULL)
1516                 return 0;
1517
1518         /* no, here to service a socket descriptor */
1519
1520         wsi = wsi_from_fd(context, pollfd->fd);
1521
1522         if (wsi == NULL)
1523                 return 0;
1524
1525         switch (wsi->mode) {
1526         case LWS_CONNMODE_SERVER_LISTENER:
1527
1528                 /* pollin means a client has connected to us then */
1529
1530                 if (!(pollfd->revents & POLLIN))
1531                         break;
1532
1533                 if (context->fds_count >= MAX_CLIENTS) {
1534                         fprintf(stderr, "too busy to accept new client\n");
1535                         break;
1536                 }
1537
1538                 /* listen socket got an unencrypted connection... */
1539
1540                 clilen = sizeof(cli_addr);
1541                 accept_fd  = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
1542                                                                        &clilen);
1543                 if (accept_fd < 0) {
1544                         debug("ERROR on accept\n");
1545                         return -1;
1546                 }
1547
1548                 /* Disable Nagle */
1549                 opt = 1;
1550                 setsockopt(accept_fd, IPPROTO_TCP, TCP_NODELAY,
1551                                               (const void *)&opt, sizeof(opt));
1552
1553                 /*
1554                  * look at who we connected to and give user code a chance
1555                  * to reject based on client IP.  There's no protocol selected
1556                  * yet so we issue this to protocols[0]
1557                  */
1558
1559                 if ((context->protocols[0].callback)(context, wsi,
1560                                 LWS_CALLBACK_FILTER_NETWORK_CONNECTION,
1561                                            (void *)(long)accept_fd, NULL, 0)) {
1562                         debug("Callback denied network connection\n");
1563 #ifdef WIN32
1564                         closesocket(accept_fd);
1565 #else
1566                         close(accept_fd);
1567 #endif
1568                         break;
1569                 }
1570
1571                 /* accepting connection to main listener */
1572
1573                 new_wsi = libwebsocket_create_new_server_wsi(context);
1574                 if (new_wsi == NULL)
1575                         break;
1576
1577                 new_wsi->sock = accept_fd;
1578
1579
1580 #ifdef LWS_OPENSSL_SUPPORT
1581                 new_wsi->ssl = NULL;
1582
1583                 if (context->use_ssl) {
1584
1585                         new_wsi->ssl = SSL_new(context->ssl_ctx);
1586                         if (new_wsi->ssl == NULL) {
1587                                 fprintf(stderr, "SSL_new failed: %s\n",
1588                                     ERR_error_string(SSL_get_error(
1589                                     new_wsi->ssl, 0), NULL));
1590                                     libwebsockets_decode_ssl_error();
1591                                 free(new_wsi);
1592                                 break;
1593                         }
1594
1595                         SSL_set_fd(new_wsi->ssl, accept_fd);
1596
1597                         n = SSL_accept(new_wsi->ssl);
1598                         if (n != 1) {
1599                                 /*
1600                                  * browsers seem to probe with various
1601                                  * ssl params which fail then retry
1602                                  * and succeed
1603                                  */
1604                                 debug("SSL_accept failed skt %u: %s\n",
1605                                       pollfd->fd,
1606                                       ERR_error_string(SSL_get_error(
1607                                       new_wsi->ssl, n), NULL));
1608                                 SSL_free(
1609                                        new_wsi->ssl);
1610                                 free(new_wsi);
1611                                 break;
1612                         }
1613
1614                         debug("accepted new SSL conn  "
1615                               "port %u on fd=%d SSL ver %s\n",
1616                                 ntohs(cli_addr.sin_port), accept_fd,
1617                                   SSL_get_version(new_wsi->ssl));
1618
1619                 } else
1620 #endif
1621                         debug("accepted new conn  port %u on fd=%d\n",
1622                                           ntohs(cli_addr.sin_port), accept_fd);
1623
1624                 insert_wsi(context, new_wsi);
1625
1626                 /*
1627                  * make sure NO events are seen yet on this new socket
1628                  * (otherwise we inherit old fds[client].revents from
1629                  * previous socket there and die mysteriously! )
1630                  */
1631                 context->fds[context->fds_count].revents = 0;
1632
1633                 context->fds[context->fds_count].events = POLLIN;
1634                 context->fds[context->fds_count++].fd = accept_fd;
1635
1636                 /* external POLL support via protocol 0 */
1637                 context->protocols[0].callback(context, new_wsi,
1638                         LWS_CALLBACK_ADD_POLL_FD,
1639                         (void *)(long)accept_fd, NULL, POLLIN);
1640
1641                 break;
1642
1643         case LWS_CONNMODE_BROADCAST_PROXY_LISTENER:
1644
1645                 /* as we are listening, POLLIN means accept() is needed */
1646
1647                 if (!(pollfd->revents & POLLIN))
1648                         break;
1649
1650                 /* listen socket got an unencrypted connection... */
1651
1652                 clilen = sizeof(cli_addr);
1653                 accept_fd  = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
1654                                                                        &clilen);
1655                 if (accept_fd < 0) {
1656                         debug("ERROR on accept\n");
1657                         return -1;
1658                 }
1659
1660                 if (context->fds_count >= MAX_CLIENTS) {
1661                         fprintf(stderr, "too busy to accept new broadcast "
1662                                                               "proxy client\n");
1663 #ifdef WIN32
1664                         closesocket(accept_fd);
1665 #else
1666                         close(accept_fd);
1667 #endif
1668                         break;
1669                 }
1670
1671                 /* create a dummy wsi for the connection and add it */
1672
1673                 new_wsi = malloc(sizeof(struct libwebsocket));
1674                 memset(new_wsi, 0, sizeof(struct libwebsocket));
1675                 new_wsi->sock = accept_fd;
1676                 new_wsi->mode = LWS_CONNMODE_BROADCAST_PROXY;
1677                 new_wsi->state = WSI_STATE_ESTABLISHED;
1678                 new_wsi->count_active_extensions = 0;
1679                 /* note which protocol we are proxying */
1680                 new_wsi->protocol_index_for_broadcast_proxy =
1681                                         wsi->protocol_index_for_broadcast_proxy;
1682                 insert_wsi(context, new_wsi);
1683
1684                 /* add connected socket to internal poll array */
1685
1686                 context->fds[context->fds_count].revents = 0;
1687                 context->fds[context->fds_count].events = POLLIN;
1688                 context->fds[context->fds_count++].fd = accept_fd;
1689
1690                 /* external POLL support via protocol 0 */
1691                 context->protocols[0].callback(context, new_wsi,
1692                         LWS_CALLBACK_ADD_POLL_FD,
1693                         (void *)(long)accept_fd, NULL, POLLIN);
1694
1695                 break;
1696
1697         case LWS_CONNMODE_BROADCAST_PROXY:
1698
1699                 /* handle session socket closed */
1700
1701                 if (pollfd->revents & (POLLERR | POLLHUP)) {
1702
1703                         debug("Session Socket %p (fd=%d) dead\n",
1704                                 (void *)wsi, pollfd->fd);
1705
1706                         libwebsocket_close_and_free_session(context, wsi,
1707                                                        LWS_CLOSE_STATUS_NORMAL);
1708                         return 1;
1709                 }
1710
1711                 /*
1712                  * either extension code with stuff to spill, or the user code,
1713                  * requested a callback when it was OK to write
1714                  */
1715
1716                 if (pollfd->revents & POLLOUT)
1717                         if (lws_handle_POLLOUT_event(context, wsi,
1718                                                                  pollfd) < 0) {
1719                                 libwebsocket_close_and_free_session(
1720                                         context, wsi, LWS_CLOSE_STATUS_NORMAL);
1721                                 return 1;
1722                         }
1723
1724                 /* any incoming data ready? */
1725
1726                 if (!(pollfd->revents & POLLIN))
1727                         break;
1728
1729                 /* get the issued broadcast payload from the socket */
1730
1731                 len = read(pollfd->fd, buf + LWS_SEND_BUFFER_PRE_PADDING,
1732                                                          MAX_BROADCAST_PAYLOAD);
1733                 if (len < 0) {
1734                         fprintf(stderr, "Error reading broadcast payload\n");
1735                         break;
1736                 }
1737
1738                 /* broadcast it to all guys with this protocol index */
1739
1740                 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
1741
1742                         for (m = 0; m < context->fd_hashtable[n].length; m++) {
1743
1744                                 new_wsi = context->fd_hashtable[n].wsi[m];
1745
1746                                 /* only to clients we are serving to */
1747
1748                                 if (new_wsi->mode != LWS_CONNMODE_WS_SERVING)
1749                                         continue;
1750
1751                                 /*
1752                                  * never broadcast to non-established
1753                                  * connection
1754                                  */
1755
1756                                 if (new_wsi->state != WSI_STATE_ESTABLISHED)
1757                                         continue;
1758
1759                                 /*
1760                                  * only broadcast to connections using
1761                                  * the requested protocol
1762                                  */
1763
1764                                 if (new_wsi->protocol->protocol_index !=
1765                                         wsi->protocol_index_for_broadcast_proxy)
1766                                         continue;
1767
1768                                 /* broadcast it to this connection */
1769
1770                                 new_wsi->protocol->callback(context, new_wsi,
1771                                         LWS_CALLBACK_BROADCAST,
1772                                         new_wsi->user_space,
1773                                         buf + LWS_SEND_BUFFER_PRE_PADDING, len);
1774                         }
1775                 }
1776                 break;
1777
1778         case LWS_CONNMODE_WS_CLIENT_WAITING_PROXY_REPLY:
1779
1780                 /* handle proxy hung up on us */
1781
1782                 if (pollfd->revents & (POLLERR | POLLHUP)) {
1783
1784                         fprintf(stderr, "Proxy connection %p (fd=%d) dead\n",
1785                                 (void *)wsi, pollfd->fd);
1786
1787                         libwebsocket_close_and_free_session(context, wsi,
1788                                                      LWS_CLOSE_STATUS_NOSTATUS);
1789                         return 1;
1790                 }
1791
1792                 n = recv(wsi->sock, pkt, sizeof pkt, 0);
1793                 if (n < 0) {
1794                         libwebsocket_close_and_free_session(context, wsi,
1795                                                      LWS_CLOSE_STATUS_NOSTATUS);
1796                         fprintf(stderr, "ERROR reading from proxy socket\n");
1797                         return 1;
1798                 }
1799
1800                 pkt[13] = '\0';
1801                 if (strcmp(pkt, "HTTP/1.0 200 ") != 0) {
1802                         libwebsocket_close_and_free_session(context, wsi,
1803                                                      LWS_CLOSE_STATUS_NOSTATUS);
1804                         fprintf(stderr, "ERROR from proxy: %s\n", pkt);
1805                         return 1;
1806                 }
1807
1808                 /* clear his proxy connection timeout */
1809
1810                 libwebsocket_set_timeout(wsi, NO_PENDING_TIMEOUT, 0);
1811
1812                 /* fallthru */
1813
1814         case LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE:
1815
1816         #ifdef LWS_OPENSSL_SUPPORT
1817                 if (wsi->use_ssl && !wsi->ssl) {
1818
1819                         wsi->ssl = SSL_new(context->ssl_client_ctx);
1820                         wsi->client_bio = BIO_new_socket(wsi->sock,
1821                                                                    BIO_NOCLOSE);
1822                         SSL_set_bio(wsi->ssl, wsi->client_bio, wsi->client_bio);
1823
1824                         SSL_set_ex_data(wsi->ssl,
1825                                         openssl_websocket_private_data_index,
1826                                                                        context);
1827                 }
1828
1829                 if (wsi->use_ssl) {
1830                         if (SSL_connect(wsi->ssl) <= 0) {
1831
1832                                 /*
1833                                  * retry if new data comes until we
1834                                  * run into the connection timeout or win
1835                                  */
1836
1837                                 fprintf(stderr, "SSL connect error %s\n",
1838                                         ERR_error_string(ERR_get_error(),
1839                                                                   ssl_err_buf));
1840                                 return 0;
1841                         }
1842
1843                         n = SSL_get_verify_result(wsi->ssl);
1844                         if ((n != X509_V_OK) && (
1845                                 n != X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT ||
1846                                                            wsi->use_ssl != 2)) {
1847
1848                                 fprintf(stderr, "server's cert didn't "
1849                                                            "look good %d\n", n);
1850                                 libwebsocket_close_and_free_session(context,
1851                                                 wsi, LWS_CLOSE_STATUS_NOSTATUS);
1852                                 return 1;
1853                         }
1854                 } else
1855                         wsi->ssl = NULL;
1856         #endif
1857
1858                 p = libwebsockets_generate_client_handshake(context, wsi, p);
1859                 if (p == NULL)
1860                         return 1;
1861
1862                 /* send our request to the server */
1863
1864         #ifdef LWS_OPENSSL_SUPPORT
1865                 if (wsi->use_ssl)
1866                         n = SSL_write(wsi->ssl, pkt, p - pkt);
1867                 else
1868         #endif
1869                         n = send(wsi->sock, pkt, p - pkt, 0);
1870
1871                 if (n < 0) {
1872                         fprintf(stderr, "ERROR writing to client socket\n");
1873                         libwebsocket_close_and_free_session(context, wsi,
1874                                                      LWS_CLOSE_STATUS_NOSTATUS);
1875                         return 1;
1876                 }
1877
1878                 wsi->parser_state = WSI_TOKEN_NAME_PART;
1879                 wsi->mode = LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY;
1880                 libwebsocket_set_timeout(wsi,
1881                                 PENDING_TIMEOUT_AWAITING_SERVER_RESPONSE, AWAITING_TIMEOUT);
1882
1883                 break;
1884
1885         case LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY:
1886
1887                 /* handle server hung up on us */
1888
1889                 if (pollfd->revents & (POLLERR | POLLHUP)) {
1890
1891                         fprintf(stderr, "Server connection %p (fd=%d) dead\n",
1892                                 (void *)wsi, pollfd->fd);
1893
1894                         goto bail3;
1895                 }
1896
1897
1898                 /* interpret the server response */
1899
1900                 /*
1901                  *  HTTP/1.1 101 Switching Protocols
1902                  *  Upgrade: websocket
1903                  *  Connection: Upgrade
1904                  *  Sec-WebSocket-Accept: me89jWimTRKTWwrS3aRrL53YZSo=
1905                  *  Sec-WebSocket-Nonce: AQIDBAUGBwgJCgsMDQ4PEC==
1906                  *  Sec-WebSocket-Protocol: chat
1907                  */
1908
1909                 /*
1910                  * we have to take some care here to only take from the
1911                  * socket bytewise.  The browser may (and has been seen to
1912                  * in the case that onopen() performs websocket traffic)
1913                  * coalesce both handshake response and websocket traffic
1914                  * in one packet, since at that point the connection is
1915                  * definitively ready from browser pov.
1916                  */
1917
1918                 len = 1;
1919                 while (wsi->parser_state != WSI_PARSING_COMPLETE && len > 0) {
1920 #ifdef LWS_OPENSSL_SUPPORT
1921                         if (wsi->use_ssl)
1922                                 len = SSL_read(wsi->ssl, &c, 1);
1923                          else
1924 #endif
1925                                 len = recv(wsi->sock, &c, 1, 0);
1926
1927                         libwebsocket_parse(wsi, c);
1928                 }
1929
1930                 /*
1931                  * hs may also be coming in multiple packets, there is a 5-sec
1932                  * libwebsocket timeout still active here too, so if parsing did
1933                  * not complete just wait for next packet coming in this state
1934                  */
1935
1936                 if (wsi->parser_state != WSI_PARSING_COMPLETE)
1937                         break;
1938
1939                 /*
1940                  * otherwise deal with the handshake.  If there's any
1941                  * packet traffic already arrived we'll trigger poll() again
1942                  * right away and deal with it that way
1943                  */
1944
1945                 return lws_client_interpret_server_handshake(context, wsi);
1946
1947 bail3:
1948                 if (wsi->c_protocol)
1949                         free(wsi->c_protocol);
1950                 libwebsocket_close_and_free_session(context, wsi,
1951                                                     LWS_CLOSE_STATUS_NOSTATUS);
1952                 return 1;
1953
1954         case LWS_CONNMODE_WS_CLIENT_WAITING_EXTENSION_CONNECT:
1955                 fprintf(stderr,
1956                          "LWS_CONNMODE_WS_CLIENT_WAITING_EXTENSION_CONNECT\n");
1957                 break;
1958
1959         case LWS_CONNMODE_WS_CLIENT_PENDING_CANDIDATE_CHILD:
1960                 fprintf(stderr,
1961                            "LWS_CONNMODE_WS_CLIENT_PENDING_CANDIDATE_CHILD\n");
1962                 break;
1963
1964
1965         case LWS_CONNMODE_WS_SERVING:
1966         case LWS_CONNMODE_WS_CLIENT:
1967
1968                 /* handle session socket closed */
1969
1970                 if (pollfd->revents & (POLLERR | POLLHUP)) {
1971
1972                         fprintf(stderr, "Session Socket %p (fd=%d) dead\n",
1973                                 (void *)wsi, pollfd->fd);
1974
1975                         libwebsocket_close_and_free_session(context, wsi,
1976                                                      LWS_CLOSE_STATUS_NOSTATUS);
1977                         return 1;
1978                 }
1979
1980                 /* the guy requested a callback when it was OK to write */
1981
1982                 if ((pollfd->revents & POLLOUT) &&
1983                                             wsi->state == WSI_STATE_ESTABLISHED)
1984                         if (lws_handle_POLLOUT_event(context, wsi,
1985                                                                   pollfd) < 0) {
1986                                 libwebsocket_close_and_free_session(
1987                                          context, wsi, LWS_CLOSE_STATUS_NORMAL);
1988                                 return 1;
1989                         }
1990
1991
1992                 /* any incoming data ready? */
1993
1994                 if (!(pollfd->revents & POLLIN))
1995                         break;
1996
1997 #ifdef LWS_OPENSSL_SUPPORT
1998                 if (wsi->ssl)
1999                         eff_buf.token_len = SSL_read(wsi->ssl, buf, sizeof buf);
2000                 else
2001 #endif
2002                         eff_buf.token_len =
2003                                            recv(pollfd->fd, buf, sizeof buf, 0);
2004
2005                 if (eff_buf.token_len < 0) {
2006                         fprintf(stderr, "Socket read returned %d\n",
2007                                                             eff_buf.token_len);
2008                         if (errno != EINTR && errno != EAGAIN)
2009                                 libwebsocket_close_and_free_session(context,
2010                                                wsi, LWS_CLOSE_STATUS_NOSTATUS);
2011                         return 1;
2012                 }
2013                 if (!eff_buf.token_len) {
2014                         libwebsocket_close_and_free_session(context, wsi,
2015                                                     LWS_CLOSE_STATUS_NOSTATUS);
2016                         return 0;
2017                 }
2018
2019                 /*
2020                  * give any active extensions a chance to munge the buffer
2021                  * before parse.  We pass in a pointer to an lws_tokens struct
2022                  * prepared with the default buffer and content length that's in
2023                  * there.  Rather than rewrite the default buffer, extensions
2024                  * that expect to grow the buffer can adapt .token to
2025                  * point to their own per-connection buffer in the extension
2026                  * user allocation.  By default with no extensions or no
2027                  * extension callback handling, just the normal input buffer is
2028                  * used then so it is efficient.
2029                  */
2030
2031                 eff_buf.token = (char *)buf;
2032
2033                 more = 1;
2034                 while (more) {
2035
2036                         more = 0;
2037
2038                         for (n = 0; n < wsi->count_active_extensions; n++) {
2039                                 m = wsi->active_extensions[n]->callback(context,
2040                                         wsi->active_extensions[n], wsi,
2041                                         LWS_EXT_CALLBACK_PACKET_RX_PREPARSE,
2042                                         wsi->active_extensions_user[n],
2043                                                                    &eff_buf, 0);
2044                                 if (m < 0) {
2045                                         fprintf(stderr,
2046                                             "Extension reports fatal error\n");
2047                                         libwebsocket_close_and_free_session(
2048                                                 context, wsi,
2049                                                     LWS_CLOSE_STATUS_NOSTATUS);
2050                                         return 1;
2051                                 }
2052                                 if (m)
2053                                         more = 1;
2054                         }
2055
2056                         /* service incoming data */
2057
2058                         if (eff_buf.token_len) {
2059                                 n = libwebsocket_read(context, wsi,
2060                                         (unsigned char *)eff_buf.token,
2061                                                             eff_buf.token_len);
2062                                 if (n < 0)
2063                                         /* we closed wsi */
2064                                         return 1;
2065                         }
2066
2067                         eff_buf.token = NULL;
2068                         eff_buf.token_len = 0;
2069                 }
2070                 break;
2071         }
2072
2073         return 0;
2074 }
2075
2076
2077 /**
2078  * libwebsocket_context_destroy() - Destroy the websocket context
2079  * @context:    Websocket context
2080  *
2081  *      This function closes any active connections and then frees the
2082  *      context.  After calling this, any further use of the context is
2083  *      undefined.
2084  */
2085 void
2086 libwebsocket_context_destroy(struct libwebsocket_context *context)
2087 {
2088         int n;
2089         int m;
2090         struct libwebsocket *wsi;
2091         struct libwebsocket_extension *ext;
2092
2093         for (n = 0; n < FD_HASHTABLE_MODULUS; n++)
2094                 for (m = 0; m < context->fd_hashtable[n].length; m++) {
2095                         wsi = context->fd_hashtable[n].wsi[m];
2096                         libwebsocket_close_and_free_session(context, wsi,
2097                                                     LWS_CLOSE_STATUS_GOINGAWAY);
2098                 }
2099
2100         /*
2101          * give all extensions a chance to clean up any per-context
2102          * allocations they might have made
2103          */
2104
2105         ext = context->extensions;
2106         m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_DESTRUCT;
2107         if (context->listen_port)
2108                 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_DESTRUCT;
2109         while (ext && ext->callback) {
2110                 ext->callback(context, ext, NULL, m, NULL, NULL, 0);
2111                 ext++;
2112         }
2113
2114 #ifdef WIN32
2115 #else
2116         close(context->fd_random);
2117 #endif
2118
2119 #ifdef LWS_OPENSSL_SUPPORT
2120         if (context->ssl_ctx)
2121                 SSL_CTX_free(context->ssl_ctx);
2122         if (context->ssl_client_ctx)
2123                 SSL_CTX_free(context->ssl_client_ctx);
2124 #endif
2125
2126         free(context);
2127
2128 #ifdef WIN32
2129         WSACleanup();
2130 #endif
2131 }
2132
2133 LWS_EXTERN void *
2134 libwebsocket_context_user(struct libwebsocket_context *context)
2135 {
2136     return context->user_space;
2137 }
2138
2139 /**
2140  * libwebsocket_service() - Service any pending websocket activity
2141  * @context:    Websocket context
2142  * @timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
2143  *              service otherwise block and service immediately, returning
2144  *              after the timeout if nothing needed service.
2145  *
2146  *      This function deals with any pending websocket traffic, for three
2147  *      kinds of event.  It handles these events on both server and client
2148  *      types of connection the same.
2149  *
2150  *      1) Accept new connections to our context's server
2151  *
2152  *      2) Perform pending broadcast writes initiated from other forked
2153  *         processes (effectively serializing asynchronous broadcasts)
2154  *
2155  *      3) Call the receive callback for incoming frame data received by
2156  *          server or client connections.
2157  *
2158  *      You need to call this service function periodically to all the above
2159  *      functions to happen; if your application is single-threaded you can
2160  *      just call it in your main event loop.
2161  *
2162  *      Alternatively you can fork a new process that asynchronously handles
2163  *      calling this service in a loop.  In that case you are happy if this
2164  *      call blocks your thread until it needs to take care of something and
2165  *      would call it with a large nonzero timeout.  Your loop then takes no
2166  *      CPU while there is nothing happening.
2167  *
2168  *      If you are calling it in a single-threaded app, you don't want it to
2169  *      wait around blocking other things in your loop from happening, so you
2170  *      would call it with a timeout_ms of 0, so it returns immediately if
2171  *      nothing is pending, or as soon as it services whatever was pending.
2172  */
2173
2174
2175 int
2176 libwebsocket_service(struct libwebsocket_context *context, int timeout_ms)
2177 {
2178         int n;
2179
2180         /* stay dead once we are dead */
2181
2182         if (context == NULL)
2183                 return 1;
2184
2185         /* wait for something to need service */
2186
2187         n = poll(context->fds, context->fds_count, timeout_ms);
2188         if (n == 0) /* poll timeout */
2189                 return 0;
2190
2191         if (n < 0) {
2192                 /*
2193                 fprintf(stderr, "Listen Socket dead\n");
2194                 */
2195                 return -1;
2196         }
2197
2198         /* handle accept on listening socket? */
2199
2200         for (n = 0; n < context->fds_count; n++)
2201                 if (context->fds[n].revents)
2202                         if (libwebsocket_service_fd(context,
2203                                                         &context->fds[n]) < 0)
2204                                 return -1;
2205         return 0;
2206 }
2207
2208 int
2209 lws_any_extension_handled(struct libwebsocket_context *context,
2210                           struct libwebsocket *wsi,
2211                           enum libwebsocket_extension_callback_reasons r,
2212                                                        void *v, size_t len)
2213 {
2214         int n;
2215         int handled = 0;
2216
2217         /* maybe an extension will take care of it for us */
2218
2219         for (n = 0; n < wsi->count_active_extensions && !handled; n++) {
2220                 if (!wsi->active_extensions[n]->callback)
2221                         continue;
2222
2223                 handled |= wsi->active_extensions[n]->callback(context,
2224                         wsi->active_extensions[n], wsi,
2225                         r, wsi->active_extensions_user[n], v, len);
2226         }
2227
2228         return handled;
2229 }
2230
2231
2232 void *
2233 lws_get_extension_user_matching_ext(struct libwebsocket *wsi,
2234                                            struct libwebsocket_extension *ext)
2235 {
2236         int n = 0;
2237
2238         if (wsi == NULL)
2239                 return NULL;
2240
2241         while (n < wsi->count_active_extensions) {
2242                 if (wsi->active_extensions[n] != ext) {
2243                         n++;
2244                         continue;
2245                 }
2246                 return wsi->active_extensions_user[n];
2247         }
2248
2249         return NULL;
2250 }
2251
2252 /**
2253  * libwebsocket_callback_on_writable() - Request a callback when this socket
2254  *                                       becomes able to be written to without
2255  *                                       blocking
2256  *
2257  * @context:    libwebsockets context
2258  * @wsi:        Websocket connection instance to get callback for
2259  */
2260
2261 int
2262 libwebsocket_callback_on_writable(struct libwebsocket_context *context,
2263                                                       struct libwebsocket *wsi)
2264 {
2265         int n;
2266         int handled = 0;
2267
2268         /* maybe an extension will take care of it for us */
2269
2270         for (n = 0; n < wsi->count_active_extensions; n++) {
2271                 if (!wsi->active_extensions[n]->callback)
2272                         continue;
2273
2274                 handled |= wsi->active_extensions[n]->callback(context,
2275                         wsi->active_extensions[n], wsi,
2276                         LWS_EXT_CALLBACK_REQUEST_ON_WRITEABLE,
2277                                        wsi->active_extensions_user[n], NULL, 0);
2278         }
2279
2280         if (handled)
2281                 return 1;
2282
2283         for (n = 0; n < context->fds_count; n++)
2284                 if (context->fds[n].fd == wsi->sock) {
2285                         context->fds[n].events |= POLLOUT;
2286                         n = context->fds_count + 1;
2287                 }
2288
2289         if (n == context->fds_count)
2290                 fprintf(stderr, "libwebsocket_callback_on_writable: "
2291                                       "failed to find socket %d\n", wsi->sock);
2292
2293         /* external POLL support via protocol 0 */
2294         context->protocols[0].callback(context, wsi,
2295                 LWS_CALLBACK_SET_MODE_POLL_FD,
2296                 (void *)(long)wsi->sock, NULL, POLLOUT);
2297
2298         return 1;
2299 }
2300
2301 /**
2302  * libwebsocket_callback_on_writable_all_protocol() - Request a callback for
2303  *                      all connections using the given protocol when it
2304  *                      becomes possible to write to each socket without
2305  *                      blocking in turn.
2306  *
2307  * @protocol:   Protocol whose connections will get callbacks
2308  */
2309
2310 int
2311 libwebsocket_callback_on_writable_all_protocol(
2312                                   const struct libwebsocket_protocols *protocol)
2313 {
2314         struct libwebsocket_context *context = protocol->owning_server;
2315         int n;
2316         int m;
2317         struct libwebsocket *wsi;
2318
2319         for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
2320
2321                 for (m = 0; m < context->fd_hashtable[n].length; m++) {
2322
2323                         wsi = context->fd_hashtable[n].wsi[m];
2324
2325                         if (wsi->protocol == protocol)
2326                                 libwebsocket_callback_on_writable(context, wsi);
2327                 }
2328         }
2329
2330         return 0;
2331 }
2332
2333 /**
2334  * libwebsocket_set_timeout() - marks the wsi as subject to a timeout
2335  *
2336  * You will not need this unless you are doing something special
2337  *
2338  * @wsi:        Websocket connection instance
2339  * @reason:     timeout reason
2340  * @secs:       how many seconds
2341  */
2342
2343 void
2344 libwebsocket_set_timeout(struct libwebsocket *wsi,
2345                                           enum pending_timeout reason, int secs)
2346 {
2347         struct timeval tv;
2348
2349         gettimeofday(&tv, NULL);
2350
2351         wsi->pending_timeout_limit = tv.tv_sec + secs;
2352         wsi->pending_timeout = reason;
2353 }
2354
2355
2356 /**
2357  * libwebsocket_get_socket_fd() - returns the socket file descriptor
2358  *
2359  * You will not need this unless you are doing something special
2360  *
2361  * @wsi:        Websocket connection instance
2362  */
2363
2364 int
2365 libwebsocket_get_socket_fd(struct libwebsocket *wsi)
2366 {
2367         return wsi->sock;
2368 }
2369
2370 /**
2371  * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
2372  *                              receieved packets.
2373  *
2374  * If the output side of a server process becomes choked, this allows flow
2375  * control for the input side.
2376  *
2377  * @wsi:        Websocket connection instance to get callback for
2378  * @enable:     0 = disable read servicing for this connection, 1 = enable
2379  */
2380
2381 int
2382 libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
2383 {
2384         struct libwebsocket_context *context = wsi->protocol->owning_server;
2385         int n;
2386
2387         for (n = 0; n < context->fds_count; n++)
2388                 if (context->fds[n].fd == wsi->sock) {
2389                         if (enable)
2390                                 context->fds[n].events |= POLLIN;
2391                         else
2392                                 context->fds[n].events &= ~POLLIN;
2393
2394                         return 0;
2395                 }
2396
2397         if (enable)
2398                 /* external POLL support via protocol 0 */
2399                 context->protocols[0].callback(context, wsi,
2400                         LWS_CALLBACK_SET_MODE_POLL_FD,
2401                         (void *)(long)wsi->sock, NULL, POLLIN);
2402         else
2403                 /* external POLL support via protocol 0 */
2404                 context->protocols[0].callback(context, wsi,
2405                         LWS_CALLBACK_CLEAR_MODE_POLL_FD,
2406                         (void *)(long)wsi->sock, NULL, POLLIN);
2407
2408 #if 0
2409         fprintf(stderr, "libwebsocket_rx_flow_control "
2410                                                      "unable to find socket\n");
2411 #endif
2412         return 1;
2413 }
2414
2415 /**
2416  * libwebsocket_canonical_hostname() - returns this host's hostname
2417  *
2418  * This is typically used by client code to fill in the host parameter
2419  * when making a client connection.  You can only call it after the context
2420  * has been created.
2421  *
2422  * @context:    Websocket context
2423  */
2424
2425
2426 extern const char *
2427 libwebsocket_canonical_hostname(struct libwebsocket_context *context)
2428 {
2429         return (const char *)context->canonical_hostname;
2430 }
2431
2432
2433 static void sigpipe_handler(int x)
2434 {
2435 }
2436
2437 #ifdef LWS_OPENSSL_SUPPORT
2438 static int
2439 OpenSSL_verify_callback(int preverify_ok, X509_STORE_CTX *x509_ctx)
2440 {
2441
2442         SSL *ssl;
2443         int n;
2444         struct libwebsocket_context *context;
2445
2446         ssl = X509_STORE_CTX_get_ex_data(x509_ctx,
2447                 SSL_get_ex_data_X509_STORE_CTX_idx());
2448
2449         /*
2450          * !!! nasty openssl requires the index to come as a library-scope
2451          * static
2452          */
2453         context = SSL_get_ex_data(ssl, openssl_websocket_private_data_index);
2454
2455         n = context->protocols[0].callback(NULL, NULL,
2456                 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION,
2457                                                    x509_ctx, ssl, preverify_ok);
2458
2459         /* convert return code from 0 = OK to 1 = OK */
2460
2461         if (!n)
2462                 n = 1;
2463         else
2464                 n = 0;
2465
2466         return n;
2467 }
2468 #endif
2469
2470
2471 /**
2472  * libwebsocket_create_context() - Create the websocket handler
2473  * @port:       Port to listen on... you can use 0 to suppress listening on
2474  *              any port, that's what you want if you are not running a
2475  *              websocket server at all but just using it as a client
2476  * @interf:  NULL to bind the listen socket to all interfaces, or the
2477  *              interface name, eg, "eth2"
2478  * @protocols:  Array of structures listing supported protocols and a protocol-
2479  *              specific callback for each one.  The list is ended with an
2480  *              entry that has a NULL callback pointer.
2481  *              It's not const because we write the owning_server member
2482  * @extensions: NULL or array of libwebsocket_extension structs listing the
2483  *              extensions this context supports
2484  * @ssl_cert_filepath:  If libwebsockets was compiled to use ssl, and you want
2485  *                      to listen using SSL, set to the filepath to fetch the
2486  *                      server cert from, otherwise NULL for unencrypted
2487  * @ssl_private_key_filepath: filepath to private key if wanting SSL mode,
2488  *                      else ignored
2489  * @ssl_ca_filepath: CA certificate filepath or NULL
2490  * @gid:        group id to change to after setting listen socket, or -1.
2491  * @uid:        user id to change to after setting listen socket, or -1.
2492  * @options:    0, or LWS_SERVER_OPTION_DEFEAT_CLIENT_MASK
2493  * @user:       optional user pointer that can be recovered via the context
2494  *              pointer using libwebsocket_context_user
2495  *
2496  *      This function creates the listening socket and takes care
2497  *      of all initialization in one step.
2498  *
2499  *      After initialization, it returns a struct libwebsocket_context * that
2500  *      represents this server.  After calling, user code needs to take care
2501  *      of calling libwebsocket_service() with the context pointer to get the
2502  *      server's sockets serviced.  This can be done in the same process context
2503  *      or a forked process, or another thread,
2504  *
2505  *      The protocol callback functions are called for a handful of events
2506  *      including http requests coming in, websocket connections becoming
2507  *      established, and data arriving; it's also called periodically to allow
2508  *      async transmission.
2509  *
2510  *      HTTP requests are sent always to the FIRST protocol in @protocol, since
2511  *      at that time websocket protocol has not been negotiated.  Other
2512  *      protocols after the first one never see any HTTP callack activity.
2513  *
2514  *      The server created is a simple http server by default; part of the
2515  *      websocket standard is upgrading this http connection to a websocket one.
2516  *
2517  *      This allows the same server to provide files like scripts and favicon /
2518  *      images or whatever over http and dynamic data over websockets all in
2519  *      one place; they're all handled in the user callback.
2520  */
2521
2522 struct libwebsocket_context *
2523 libwebsocket_create_context(int port, const char *interf,
2524                                struct libwebsocket_protocols *protocols,
2525                                struct libwebsocket_extension *extensions,
2526                                const char *ssl_cert_filepath,
2527                                const char *ssl_private_key_filepath,
2528                                const char *ssl_ca_filepath,
2529                                int gid, int uid, unsigned int options,
2530                                void *user)
2531 {
2532         int n;
2533         int m;
2534         int sockfd = 0;
2535         int fd;
2536         struct sockaddr_in serv_addr, cli_addr;
2537         int opt = 1;
2538         struct libwebsocket_context *context = NULL;
2539         unsigned int slen;
2540         char *p;
2541         char hostname[1024] = "";
2542 //      struct hostent *he;
2543         struct libwebsocket *wsi;
2544         struct sockaddr sa;
2545
2546 #ifdef LWS_OPENSSL_SUPPORT
2547         SSL_METHOD *method;
2548         char ssl_err_buf[512];
2549 #endif
2550
2551 #ifdef _WIN32
2552         {
2553                 WORD wVersionRequested;
2554                 WSADATA wsaData;
2555                 int err;
2556                 HMODULE wsdll;
2557
2558                 /* Use the MAKEWORD(lowbyte, highbyte) macro from Windef.h */
2559                 wVersionRequested = MAKEWORD(2, 2);
2560
2561                 err = WSAStartup(wVersionRequested, &wsaData);
2562                 if (err != 0) {
2563                         /* Tell the user that we could not find a usable */
2564                         /* Winsock DLL.                                  */
2565                         fprintf(stderr, "WSAStartup failed with error: %d\n",
2566                                                                            err);
2567                         return NULL;
2568                 }
2569
2570                 /* default to a poll() made out of select() */
2571                 poll = emulated_poll;
2572
2573                 /* if windows socket lib available, use his WSAPoll */
2574                 wsdll = GetModuleHandle(_T("Ws2_32.dll"));
2575                 if (wsdll)
2576                         poll = (PFNWSAPOLL)GetProcAddress(wsdll, "WSAPoll");
2577         }
2578 #endif
2579
2580
2581         context = malloc(sizeof(struct libwebsocket_context));
2582         if (!context) {
2583                 fprintf(stderr, "No memory for websocket context\n");
2584                 return NULL;
2585         }
2586         context->protocols = protocols;
2587         context->listen_port = port;
2588         context->http_proxy_port = 0;
2589         context->http_proxy_address[0] = '\0';
2590         context->options = options;
2591         context->fds_count = 0;
2592         context->extensions = extensions;
2593         context->last_timeout_check_s = 0;
2594     context->user_space = user;
2595
2596 #ifdef WIN32
2597         context->fd_random = 0;
2598 #else
2599         context->fd_random = open(SYSTEM_RANDOM_FILEPATH, O_RDONLY);
2600         if (context->fd_random < 0) {
2601                 fprintf(stderr, "Unable to open random device %s %d\n",
2602                                     SYSTEM_RANDOM_FILEPATH, context->fd_random);
2603                 return NULL;
2604         }
2605 #endif
2606
2607 #ifdef LWS_OPENSSL_SUPPORT
2608         context->use_ssl = 0;
2609         context->ssl_ctx = NULL;
2610         context->ssl_client_ctx = NULL;
2611         openssl_websocket_private_data_index = 0;
2612 #endif
2613
2614         if (options & LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME) {
2615
2616                 strcpy(context->canonical_hostname, "unknown");
2617
2618         } else {
2619
2620                 /* find canonical hostname */
2621
2622                 hostname[(sizeof hostname) - 1] = '\0';
2623                 memset(&sa, 0, sizeof(sa));
2624                 sa.sa_family = AF_INET;
2625                 sa.sa_data[(sizeof sa.sa_data) - 1] = '\0';
2626                 gethostname(hostname, (sizeof hostname) - 1);
2627
2628                 n = 0;
2629
2630                 if (strlen(hostname) < sizeof(sa.sa_data) - 1) {
2631                         strcpy(sa.sa_data, hostname);
2632         //              fprintf(stderr, "my host name is %s\n", sa.sa_data);
2633                         n = getnameinfo(&sa, sizeof(sa), hostname,
2634                                 (sizeof hostname) - 1, NULL, 0, 0);
2635                 }
2636
2637                 if (!n) {
2638                         strncpy(context->canonical_hostname, hostname,
2639                                                 sizeof context->canonical_hostname - 1);
2640                         context->canonical_hostname[
2641                                         sizeof context->canonical_hostname - 1] = '\0';
2642                 } else
2643                         strncpy(context->canonical_hostname, hostname,
2644                                                 sizeof context->canonical_hostname - 1);
2645
2646         //      fprintf(stderr, "context->canonical_hostname = %s\n",
2647         //                                              context->canonical_hostname);
2648         }
2649
2650         /* split the proxy ads:port if given */
2651
2652         p = getenv("http_proxy");
2653         if (p) {
2654                 strncpy(context->http_proxy_address, p,
2655                                        sizeof context->http_proxy_address - 1);
2656                 context->http_proxy_address[
2657                                  sizeof context->http_proxy_address - 1] = '\0';
2658
2659                 p = strchr(context->http_proxy_address, ':');
2660                 if (p == NULL) {
2661                         fprintf(stderr, "http_proxy needs to be ads:port\n");
2662                         return NULL;
2663                 }
2664                 *p = '\0';
2665                 context->http_proxy_port = atoi(p + 1);
2666
2667                 fprintf(stderr, "Using proxy %s:%u\n",
2668                                 context->http_proxy_address,
2669                                                       context->http_proxy_port);
2670         }
2671
2672         if (port) {
2673
2674 #ifdef LWS_OPENSSL_SUPPORT
2675                 context->use_ssl = ssl_cert_filepath != NULL &&
2676                                                ssl_private_key_filepath != NULL;
2677                 if (context->use_ssl)
2678                         fprintf(stderr, " Compiled with SSL support, "
2679                                                                   "using it\n");
2680                 else
2681                         fprintf(stderr, " Compiled with SSL support, "
2682                                                               "not using it\n");
2683
2684 #else
2685                 if (ssl_cert_filepath != NULL &&
2686                                              ssl_private_key_filepath != NULL) {
2687                         fprintf(stderr, " Not compiled for OpenSSl support!\n");
2688                         return NULL;
2689                 }
2690                 fprintf(stderr, " Compiled without SSL support, "
2691                                                        "serving unencrypted\n");
2692 #endif
2693         }
2694
2695         /* ignore SIGPIPE */
2696 #ifdef WIN32
2697 #else
2698         signal(SIGPIPE, sigpipe_handler);
2699 #endif
2700
2701
2702 #ifdef LWS_OPENSSL_SUPPORT
2703
2704         /* basic openssl init */
2705
2706         SSL_library_init();
2707
2708         OpenSSL_add_all_algorithms();
2709         SSL_load_error_strings();
2710
2711         openssl_websocket_private_data_index =
2712                 SSL_get_ex_new_index(0, "libwebsockets", NULL, NULL, NULL);
2713
2714         /*
2715          * Firefox insists on SSLv23 not SSLv3
2716          * Konq disables SSLv2 by default now, SSLv23 works
2717          */
2718
2719         method = (SSL_METHOD *)SSLv23_server_method();
2720         if (!method) {
2721                 fprintf(stderr, "problem creating ssl method: %s\n",
2722                         ERR_error_string(ERR_get_error(), ssl_err_buf));
2723                 return NULL;
2724         }
2725         context->ssl_ctx = SSL_CTX_new(method); /* create context */
2726         if (!context->ssl_ctx) {
2727                 fprintf(stderr, "problem creating ssl context: %s\n",
2728                         ERR_error_string(ERR_get_error(), ssl_err_buf));
2729                 return NULL;
2730         }
2731
2732         /* client context */
2733
2734         if (port == CONTEXT_PORT_NO_LISTEN) {
2735                 method = (SSL_METHOD *)SSLv23_client_method();
2736                 if (!method) {
2737                         fprintf(stderr, "problem creating ssl method: %s\n",
2738                                 ERR_error_string(ERR_get_error(), ssl_err_buf));
2739                         return NULL;
2740                 }
2741                 /* create context */
2742                 context->ssl_client_ctx = SSL_CTX_new(method);
2743                 if (!context->ssl_client_ctx) {
2744                         fprintf(stderr, "problem creating ssl context: %s\n",
2745                                 ERR_error_string(ERR_get_error(), ssl_err_buf));
2746                         return NULL;
2747                 }
2748
2749                 /* openssl init for cert verification (for client sockets) */
2750                 if (!ssl_ca_filepath) {
2751                         if (!SSL_CTX_load_verify_locations(
2752                                 context->ssl_client_ctx, NULL,
2753                                                      LWS_OPENSSL_CLIENT_CERTS))
2754                                 fprintf(stderr,
2755                                         "Unable to load SSL Client certs from %s "
2756                                         "(set by --with-client-cert-dir= in configure) -- "
2757                                         " client ssl isn't going to work",
2758                                                      LWS_OPENSSL_CLIENT_CERTS);
2759                 } else
2760                         if (!SSL_CTX_load_verify_locations(
2761                                 context->ssl_client_ctx, ssl_ca_filepath,
2762                                                                   NULL))
2763                                 fprintf(stderr,
2764                                         "Unable to load SSL Client certs "
2765                                         "file from %s -- client ssl isn't "
2766                                         "going to work", ssl_ca_filepath);
2767
2768                 /*
2769                  * callback allowing user code to load extra verification certs
2770                  * helping the client to verify server identity
2771                  */
2772
2773                 context->protocols[0].callback(context, NULL,
2774                         LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS,
2775                         context->ssl_client_ctx, NULL, 0);
2776         }
2777
2778         /* as a server, are we requiring clients to identify themselves? */
2779
2780         if (options & LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT) {
2781
2782                 /* absolutely require the client cert */
2783
2784                 SSL_CTX_set_verify(context->ssl_ctx,
2785                        SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
2786                                                        OpenSSL_verify_callback);
2787
2788                 /*
2789                  * give user code a chance to load certs into the server
2790                  * allowing it to verify incoming client certs
2791                  */
2792
2793                 context->protocols[0].callback(context, NULL,
2794                         LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS,
2795                                                      context->ssl_ctx, NULL, 0);
2796         }
2797
2798         if (context->use_ssl) {
2799
2800                 /* openssl init for server sockets */
2801
2802                 /* set the local certificate from CertFile */
2803                 n = SSL_CTX_use_certificate_file(context->ssl_ctx,
2804                                         ssl_cert_filepath, SSL_FILETYPE_PEM);
2805                 if (n != 1) {
2806                         fprintf(stderr, "problem getting cert '%s': %s\n",
2807                                 ssl_cert_filepath,
2808                                 ERR_error_string(ERR_get_error(), ssl_err_buf));
2809                         return NULL;
2810                 }
2811                 /* set the private key from KeyFile */
2812                 if (SSL_CTX_use_PrivateKey_file(context->ssl_ctx,
2813                              ssl_private_key_filepath, SSL_FILETYPE_PEM) != 1) {
2814                         fprintf(stderr, "ssl problem getting key '%s': %s\n",
2815                                                 ssl_private_key_filepath,
2816                                 ERR_error_string(ERR_get_error(), ssl_err_buf));
2817                         return NULL;
2818                 }
2819                 /* verify private key */
2820                 if (!SSL_CTX_check_private_key(context->ssl_ctx)) {
2821                         fprintf(stderr, "Private SSL key doesn't match cert\n");
2822                         return NULL;
2823                 }
2824
2825                 /* SSL is happy and has a cert it's content with */
2826         }
2827 #endif
2828
2829         /* selftest */
2830
2831         if (lws_b64_selftest())
2832                 return NULL;
2833
2834         /* fd hashtable init */
2835
2836         for (n = 0; n < FD_HASHTABLE_MODULUS; n++)
2837                 context->fd_hashtable[n].length = 0;
2838
2839         /* set up our external listening socket we serve on */
2840
2841         if (port) {
2842
2843                 sockfd = socket(AF_INET, SOCK_STREAM, 0);
2844                 if (sockfd < 0) {
2845                         fprintf(stderr, "ERROR opening socket");
2846                         return NULL;
2847                 }
2848
2849                 /* allow us to restart even if old sockets in TIME_WAIT */
2850                 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR,
2851                                               (const void *)&opt, sizeof(opt));
2852
2853                 /* Disable Nagle */
2854                 opt = 1;
2855                 setsockopt(sockfd, IPPROTO_TCP, TCP_NODELAY,
2856                                               (const void *)&opt, sizeof(opt));
2857
2858                 bzero((char *) &serv_addr, sizeof(serv_addr));
2859                 serv_addr.sin_family = AF_INET;
2860                 if (interf == NULL)
2861                         serv_addr.sin_addr.s_addr = INADDR_ANY;
2862                 else
2863                         interface_to_sa(interf, &serv_addr,
2864                                                 sizeof(serv_addr));
2865                 serv_addr.sin_port = htons(port);
2866
2867                 n = bind(sockfd, (struct sockaddr *) &serv_addr,
2868                                                              sizeof(serv_addr));
2869                 if (n < 0) {
2870                         fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
2871                                                                 port, n, errno);
2872                         return NULL;
2873                 }
2874
2875                 wsi = malloc(sizeof(struct libwebsocket));
2876                 memset(wsi, 0, sizeof(struct libwebsocket));
2877                 wsi->sock = sockfd;
2878                 wsi->count_active_extensions = 0;
2879                 wsi->mode = LWS_CONNMODE_SERVER_LISTENER;
2880                 insert_wsi(context, wsi);
2881
2882                 listen(sockfd, SOMAXCONN);
2883                 fprintf(stderr, " Listening on port %d\n", port);
2884
2885                 /* list in the internal poll array */
2886
2887                 context->fds[context->fds_count].fd = sockfd;
2888                 context->fds[context->fds_count++].events = POLLIN;
2889
2890                 /* external POLL support via protocol 0 */
2891                 context->protocols[0].callback(context, wsi,
2892                         LWS_CALLBACK_ADD_POLL_FD,
2893                         (void *)(long)sockfd, NULL, POLLIN);
2894
2895         }
2896
2897         /*
2898          * drop any root privs for this process
2899          * to listen on port < 1023 we would have needed root, but now we are
2900          * listening, we don't want the power for anything else
2901          */
2902 #ifdef WIN32
2903 #else
2904         if (gid != -1)
2905                 if (setgid(gid))
2906                         fprintf(stderr, "setgid: %s\n", strerror(errno));
2907         if (uid != -1)
2908                 if (setuid(uid))
2909                         fprintf(stderr, "setuid: %s\n", strerror(errno));
2910 #endif
2911
2912         /* set up our internal broadcast trigger sockets per-protocol */
2913
2914         for (context->count_protocols = 0;
2915                         protocols[context->count_protocols].callback;
2916                                                    context->count_protocols++) {
2917
2918                 debug("  Protocol: %s\n", protocols[context->count_protocols].name);
2919
2920                 protocols[context->count_protocols].owning_server = context;
2921                 protocols[context->count_protocols].protocol_index =
2922                                                        context->count_protocols;
2923
2924                 fd = socket(AF_INET, SOCK_STREAM, 0);
2925                 if (fd < 0) {
2926                         fprintf(stderr, "ERROR opening socket");
2927                         return NULL;
2928                 }
2929
2930                 /* allow us to restart even if old sockets in TIME_WAIT */
2931                 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (const void *)&opt,
2932                                                                   sizeof(opt));
2933
2934                 bzero((char *) &serv_addr, sizeof(serv_addr));
2935                 serv_addr.sin_family = AF_INET;
2936                 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
2937                 serv_addr.sin_port = 0; /* pick the port for us */
2938
2939                 n = bind(fd, (struct sockaddr *) &serv_addr, sizeof(serv_addr));
2940                 if (n < 0) {
2941                         fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
2942                                                                 port, n, errno);
2943                         return NULL;
2944                 }
2945
2946                 slen = sizeof cli_addr;
2947                 n = getsockname(fd, (struct sockaddr *)&cli_addr, &slen);
2948                 if (n < 0) {
2949                         fprintf(stderr, "getsockname failed\n");
2950                         return NULL;
2951                 }
2952                 protocols[context->count_protocols].broadcast_socket_port =
2953                                                        ntohs(cli_addr.sin_port);
2954                 listen(fd, 5);
2955
2956                 debug("  Protocol %s broadcast socket %d\n",
2957                                 protocols[context->count_protocols].name,
2958                                                       ntohs(cli_addr.sin_port));
2959
2960                 /* dummy wsi per broadcast proxy socket */
2961
2962                 wsi = malloc(sizeof(struct libwebsocket));
2963                 memset(wsi, 0, sizeof(struct libwebsocket));
2964                 wsi->sock = fd;
2965                 wsi->mode = LWS_CONNMODE_BROADCAST_PROXY_LISTENER;
2966                 wsi->count_active_extensions = 0;
2967                 /* note which protocol we are proxying */
2968                 wsi->protocol_index_for_broadcast_proxy =
2969                                                        context->count_protocols;
2970                 insert_wsi(context, wsi);
2971
2972                 /* list in internal poll array */
2973
2974                 context->fds[context->fds_count].fd = fd;
2975                 context->fds[context->fds_count].events = POLLIN;
2976                 context->fds[context->fds_count].revents = 0;
2977                 context->fds_count++;
2978
2979                 /* external POLL support via protocol 0 */
2980                 context->protocols[0].callback(context, wsi,
2981                         LWS_CALLBACK_ADD_POLL_FD,
2982                         (void *)(long)fd, NULL, POLLIN);
2983         }
2984
2985         /*
2986          * give all extensions a chance to create any per-context
2987          * allocations they need
2988          */
2989
2990         m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_CONSTRUCT;
2991         if (port)
2992                 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_CONSTRUCT;
2993
2994         if (extensions) {
2995             while (extensions->callback) {
2996                     debug("  Extension: %s\n", extensions->name);
2997                     extensions->callback(context, extensions,
2998                                                 NULL, m, NULL, NULL, 0);
2999                     extensions++;
3000             }
3001         }
3002
3003         return context;
3004 }
3005
3006
3007 #ifndef LWS_NO_FORK
3008
3009 /**
3010  * libwebsockets_fork_service_loop() - Optional helper function forks off
3011  *                                a process for the websocket server loop.
3012  *                              You don't have to use this but if not, you
3013  *                              have to make sure you are calling
3014  *                              libwebsocket_service periodically to service
3015  *                              the websocket traffic
3016  * @context:    server context returned by creation function
3017  */
3018
3019 int
3020 libwebsockets_fork_service_loop(struct libwebsocket_context *context)
3021 {
3022         int fd;
3023         struct sockaddr_in cli_addr;
3024         int n;
3025         int p;
3026
3027         n = fork();
3028         if (n < 0)
3029                 return n;
3030
3031         if (!n) {
3032
3033                 /* main process context */
3034
3035                 /*
3036                  * set up the proxy sockets to allow broadcast from
3037                  * service process context
3038                  */
3039
3040                 for (p = 0; p < context->count_protocols; p++) {
3041                         fd = socket(AF_INET, SOCK_STREAM, 0);
3042                         if (fd < 0) {
3043                                 fprintf(stderr, "Unable to create socket\n");
3044                                 return -1;
3045                         }
3046                         cli_addr.sin_family = AF_INET;
3047                         cli_addr.sin_port = htons(
3048                              context->protocols[p].broadcast_socket_port);
3049                         cli_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
3050                         n = connect(fd, (struct sockaddr *)&cli_addr,
3051                                                                sizeof cli_addr);
3052                         if (n < 0) {
3053                                 fprintf(stderr, "Unable to connect to "
3054                                                 "broadcast socket %d, %s\n",
3055                                                 n, strerror(errno));
3056                                 return -1;
3057                         }
3058
3059                         context->protocols[p].broadcast_socket_user_fd = fd;
3060                 }
3061
3062                 return 0;
3063         }
3064
3065 #ifdef HAVE_SYS_PRCTL_H
3066         /* we want a SIGHUP when our parent goes down */
3067         prctl(PR_SET_PDEATHSIG, SIGHUP);
3068 #endif
3069
3070         /* in this forked process, sit and service websocket connections */
3071
3072         while (1) {
3073                 if (libwebsocket_service(context, 1000))
3074                         break;
3075 //#ifndef HAVE_SYS_PRCTL_H
3076 /*
3077  * on systems without prctl() (i.e. anything but linux) we can notice that our
3078  * parent is dead if getppid() returns 1. FIXME apparently this is not true for
3079  * solaris, could remember ppid right after fork and wait for it to change.
3080  */
3081
3082         if (getppid() == 1)
3083             break;
3084 //#endif
3085     }
3086
3087
3088         return 1;
3089 }
3090
3091 #endif
3092
3093 /**
3094  * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
3095  *                                connection.
3096  * @wsi:        pointer to struct websocket you want to know the protocol of
3097  *
3098  *
3099  *      This is useful to get the protocol to broadcast back to from inside
3100  * the callback.
3101  */
3102
3103 const struct libwebsocket_protocols *
3104 libwebsockets_get_protocol(struct libwebsocket *wsi)
3105 {
3106         return wsi->protocol;
3107 }
3108
3109 /**
3110  * libwebsockets_broadcast() - Sends a buffer to the callback for all active
3111  *                                connections of the given protocol.
3112  * @protocol:   pointer to the protocol you will broadcast to all members of
3113  * @buf:  buffer containing the data to be broadcase.  NOTE: this has to be
3114  *              allocated with LWS_SEND_BUFFER_PRE_PADDING valid bytes before
3115  *              the pointer and LWS_SEND_BUFFER_POST_PADDING afterwards in the
3116  *              case you are calling this function from callback context.
3117  * @len:        length of payload data in buf, starting from buf.
3118  *
3119  *      This function allows bulk sending of a packet to every connection using
3120  * the given protocol.  It does not send the data directly; instead it calls
3121  * the callback with a reason type of LWS_CALLBACK_BROADCAST.  If the callback
3122  * wants to actually send the data for that connection, the callback itself
3123  * should call libwebsocket_write().
3124  *
3125  * libwebsockets_broadcast() can be called from another fork context without
3126  * having to take any care about data visibility between the processes, it'll
3127  * "just work".
3128  */
3129
3130
3131 int
3132 libwebsockets_broadcast(const struct libwebsocket_protocols *protocol,
3133                                                  unsigned char *buf, size_t len)
3134 {
3135         struct libwebsocket_context *context = protocol->owning_server;
3136         int n;
3137         int m;
3138         struct libwebsocket *wsi;
3139
3140         if (!protocol->broadcast_socket_user_fd) {
3141                 /*
3142                  * We are either running unforked / flat, or we are being
3143                  * called from poll thread context
3144                  * eg, from a callback.  In that case don't use sockets for
3145                  * broadcast IPC (since we can't open a socket connection to
3146                  * a socket listening on our own thread) but directly do the
3147                  * send action.
3148                  *
3149                  * Locking is not needed because we are by definition being
3150                  * called in the poll thread context and are serialized.
3151                  */
3152
3153                 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
3154
3155                         for (m = 0; m < context->fd_hashtable[n].length; m++) {
3156
3157                                 wsi = context->fd_hashtable[n].wsi[m];
3158
3159                                 if (wsi->mode != LWS_CONNMODE_WS_SERVING)
3160                                         continue;
3161
3162                                 /*
3163                                  * never broadcast to
3164                                  * non-established connections
3165                                  */
3166                                 if (wsi->state != WSI_STATE_ESTABLISHED)
3167                                         continue;
3168
3169                                 /* only broadcast to guys using
3170                                  * requested protocol
3171                                  */
3172                                 if (wsi->protocol != protocol)
3173                                         continue;
3174
3175                                 wsi->protocol->callback(context, wsi,
3176                                          LWS_CALLBACK_BROADCAST,
3177                                          wsi->user_space,
3178                                          buf, len);
3179                         }
3180                 }
3181
3182                 return 0;
3183         }
3184
3185         /*
3186          * We're being called from a different process context than the server
3187          * loop.  Instead of broadcasting directly, we send our
3188          * payload on a socket to do the IPC; the server process will serialize
3189          * the broadcast action in its main poll() loop.
3190          *
3191          * There's one broadcast socket listening for each protocol supported
3192          * set up when the websocket server initializes
3193          */
3194
3195         n = send(protocol->broadcast_socket_user_fd, buf, len, MSG_NOSIGNAL);
3196
3197         return n;
3198 }
3199
3200 int
3201 libwebsocket_is_final_fragment(struct libwebsocket *wsi)
3202 {
3203         return wsi->final;
3204 }
3205
3206 unsigned char
3207 libwebsocket_get_reserved_bits(struct libwebsocket *wsi)
3208 {
3209         return wsi->rsv;
3210 }
3211
3212 void *
3213 libwebsocket_ensure_user_space(struct libwebsocket *wsi)
3214 {
3215         /* allocate the per-connection user memory (if any) */
3216
3217         if (wsi->protocol->per_session_data_size && !wsi->user_space) {
3218                 wsi->user_space = malloc(
3219                                   wsi->protocol->per_session_data_size);
3220                 if (wsi->user_space  == NULL) {
3221                         fprintf(stderr, "Out of memory for "
3222                                                    "conn user space\n");
3223                         return NULL;
3224                 }
3225                 memset(wsi->user_space, 0,
3226                                          wsi->protocol->per_session_data_size);
3227         }
3228         return wsi->user_space;
3229 }