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