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 #include <syslog.h>
  24
  25 #ifdef WIN32
  26 #include <tchar.h>
  27 #include <io.h>
  28 #else
  29 #ifdef LWS_BUILTIN_GETIFADDRS
  30 #include <getifaddrs.h>
  31 #else
  32 #include <ifaddrs.h>
  33 #endif
  34 #include <sys/un.h>
  35 #include <sys/socket.h>
  36 #include <netdb.h>
  37 #endif
  38
  39 #ifdef LWS_OPENSSL_SUPPORT
  40 int openssl_websocket_private_data_index;
  41 #endif
  42
  43 #ifdef __MINGW32__
  44 #include "../win32port/win32helpers/websock-w32.c"
  45 #else
  46 #ifdef __MINGW64__
  47 #include "../win32port/win32helpers/websock-w32.c"
  48 #endif
  49 #endif
  50
  51 static int log_level = LLL_ERR | LLL_WARN | LLL_NOTICE;
  52 static void lwsl_emit_stderr(int level, const char *line);
  53 static void (*lwsl_emit)(int level, const char *line) = lwsl_emit_stderr;
  54
  55 static const char *log_level_names[] = {
  56         "ERR",
  57         "WARN",
  58         "NOTICE",
  59         "INFO",
  60         "DEBUG",
  61         "PARSER",
  62         "HEADER",
  63         "EXTENSION",
  64         "CLIENT",
  65 };
  66
  67 int
  68 insert_wsi_socket_into_fds(struct libwebsocket_context *context, struct libwebsocket *wsi)
  69 {
  70         if (context->fds_count >= context->max_fds) {
  71                 lwsl_err("Reached limit of fds tracking (%d)\n", context->max_fds);
  72                 return 1;
  73         }
  74
  75         if (wsi->sock > context->max_fds) {
  76                 lwsl_err("Socket fd %d is beyond what we can index (%d)\n", wsi->sock, context->max_fds);
  77                 return 1;
  78         }
  79
  80         assert(wsi);
  81         assert(wsi->sock);
  82
  83         lwsl_info("insert_wsi_socket_into_fds: wsi=%p, sock=%d, fds pos=%d\n", wsi, wsi->sock, context->fds_count);
  84
  85         context->lws_lookup[wsi->sock] = wsi;
  86         wsi->position_in_fds_table = context->fds_count;
  87         context->fds[context->fds_count].fd = wsi->sock;
  88         context->fds[context->fds_count].events = POLLIN;
  89         context->fds[context->fds_count++].revents = 0;
  90
  91         /* external POLL support via protocol 0 */
  92         context->protocols[0].callback(context, wsi,
  93                 LWS_CALLBACK_ADD_POLL_FD,
  94                 (void *)(long)wsi->sock, NULL, POLLIN);
  95
  96         return 0;
  97 }
  98
  99 static int
 100 remove_wsi_socket_from_fds(struct libwebsocket_context *context, struct libwebsocket *wsi)
 101 {
 102         int m;
 103
 104         if (!--context->fds_count)
 105                 goto do_ext;
 106
 107         if (wsi->sock > context->max_fds) {
 108                 lwsl_err("Socket fd %d is beyond what we can index (%d)\n", wsi->sock, context->max_fds);
 109                 return 1;
 110         }
 111
 112         lwsl_info("remove_wsi_socket_from_fds: wsi=%p, sock=%d, fds pos=%d\n", wsi, wsi->sock, wsi->position_in_fds_table);
 113
 114         m = wsi->position_in_fds_table; /* replace the contents for this */
 115
 116         /* have the last guy take up the vacant slot */
 117         context->fds[m] = context->fds[context->fds_count]; /* vacant fds slot filled with end one */
 118         /* end guy's fds_lookup entry remains unchanged (still same fd pointing to same wsi) */
 119         /* end guy's "position in fds table" changed */
 120         context->lws_lookup[context->fds[context->fds_count].fd]->position_in_fds_table = m;
 121         /* deletion guy's lws_lookup entry needs nuking */
 122         context->lws_lookup[wsi->sock] = NULL; /* no WSI for the socket of the wsi being removed*/
 123         wsi->position_in_fds_table = -1; /* removed wsi has no position any more */
 124
 125 do_ext:
 126         /* remove also from external POLL support via protocol 0 */
 127         if (wsi->sock)
 128                 context->protocols[0].callback(context, wsi,
 129                     LWS_CALLBACK_DEL_POLL_FD, (void *)(long)wsi->sock, NULL, 0);
 130
 131         return 0;
 132 }
 133
 134
 135 void
 136 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
 137                          struct libwebsocket *wsi, enum lws_close_status reason)
 138 {
 139         int n;
 140         int old_state;
 141         unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 2 +
 142                                                   LWS_SEND_BUFFER_POST_PADDING];
 143         int ret;
 144         int m;
 145         struct lws_tokens eff_buf;
 146         struct libwebsocket_extension *ext;
 147
 148         if (!wsi)
 149                 return;
 150
 151         old_state = wsi->state;
 152
 153         if (old_state == WSI_STATE_DEAD_SOCKET)
 154                 return;
 155
 156         wsi->close_reason = reason;
 157
 158         /*
 159          * are his extensions okay with him closing?  Eg he might be a mux
 160          * parent and just his ch1 aspect is closing?
 161          */
 162
 163
 164         for (n = 0; n < wsi->count_active_extensions; n++) {
 165                 if (!wsi->active_extensions[n]->callback)
 166                         continue;
 167
 168                 m = wsi->active_extensions[n]->callback(context,
 169                         wsi->active_extensions[n], wsi,
 170                         LWS_EXT_CALLBACK_CHECK_OK_TO_REALLY_CLOSE,
 171                                        wsi->active_extensions_user[n], NULL, 0);
 172
 173                 /*
 174                  * if somebody vetoed actually closing him at this time....
 175                  * up to the extension to track the attempted close, let's
 176                  * just bail
 177                  */
 178
 179                 if (m) {
 180                         lwsl_ext("extension vetoed close\n");
 181                         return;
 182                 }
 183         }
 184
 185
 186
 187         /*
 188          * flush any tx pending from extensions, since we may send close packet
 189          * if there are problems with send, just nuke the connection
 190          */
 191
 192         ret = 1;
 193         while (ret == 1) {
 194
 195                 /* default to nobody has more to spill */
 196
 197                 ret = 0;
 198                 eff_buf.token = NULL;
 199                 eff_buf.token_len = 0;
 200
 201                 /* show every extension the new incoming data */
 202
 203                 for (n = 0; n < wsi->count_active_extensions; n++) {
 204                         m = wsi->active_extensions[n]->callback(
 205                                         wsi->protocol->owning_server,
 206                                         wsi->active_extensions[n], wsi,
 207                                         LWS_EXT_CALLBACK_FLUSH_PENDING_TX,
 208                                    wsi->active_extensions_user[n], &eff_buf, 0);
 209                         if (m < 0) {
 210                                 lwsl_ext("Extension reports fatal error\n");
 211                                 goto just_kill_connection;
 212                         }
 213                         if (m)
 214                                 /*
 215                                  * at least one extension told us he has more
 216                                  * to spill, so we will go around again after
 217                                  */
 218                                 ret = 1;
 219                 }
 220
 221                 /* assuming they left us something to send, send it */
 222
 223                 if (eff_buf.token_len)
 224                         if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
 225                                                              eff_buf.token_len)) {
 226                                 lwsl_debug("close: sending final extension spill had problems\n");
 227                                 goto just_kill_connection;
 228                         }
 229         }
 230
 231         /*
 232          * signal we are closing, libsocket_write will
 233          * add any necessary version-specific stuff.  If the write fails,
 234          * no worries we are closing anyway.  If we didn't initiate this
 235          * close, then our state has been changed to
 236          * WSI_STATE_RETURNED_CLOSE_ALREADY and we will skip this.
 237          *
 238          * Likewise if it's a second call to close this connection after we
 239          * sent the close indication to the peer already, we are in state
 240          * WSI_STATE_AWAITING_CLOSE_ACK and will skip doing this a second time.
 241          */
 242
 243         if (old_state == WSI_STATE_ESTABLISHED &&
 244                                           reason != LWS_CLOSE_STATUS_NOSTATUS) {
 245
 246                 lwsl_debug("sending close indication...\n");
 247
 248                 n = libwebsocket_write(wsi, &buf[LWS_SEND_BUFFER_PRE_PADDING],
 249                                                             0, LWS_WRITE_CLOSE);
 250                 if (!n) {
 251                         /*
 252                          * we have sent a nice protocol level indication we
 253                          * now wish to close, we should not send anything more
 254                          */
 255
 256                         wsi->state = WSI_STATE_AWAITING_CLOSE_ACK;
 257
 258                         /* and we should wait for a reply for a bit out of politeness */
 259
 260                         libwebsocket_set_timeout(wsi,
 261                                                   PENDING_TIMEOUT_CLOSE_ACK, 1);
 262
 263                         lwsl_debug("sent close indication, awaiting ack\n");
 264
 265                         return;
 266                 }
 267
 268                 lwsl_info("close: sending the close packet failed, hanging up\n");
 269
 270                 /* else, the send failed and we should just hang up */
 271         }
 272
 273 just_kill_connection:
 274
 275         lwsl_debug("libwebsocket_close_and_free_session: just_kill_connection\n");
 276
 277         /*
 278          * we won't be servicing or receiving anything further from this guy
 279          * delete socket from the internal poll list if still present
 280          */
 281
 282         remove_wsi_socket_from_fds(context, wsi);
 283
 284         wsi->state = WSI_STATE_DEAD_SOCKET;
 285
 286         /* tell the user it's all over for this guy */
 287
 288         if (wsi->protocol && wsi->protocol->callback &&
 289                         ((old_state == WSI_STATE_ESTABLISHED) ||
 290                          (old_state == WSI_STATE_RETURNED_CLOSE_ALREADY) ||
 291                          (old_state == WSI_STATE_AWAITING_CLOSE_ACK))) {
 292                 lwsl_debug("calling back CLOSED\n");
 293                 wsi->protocol->callback(context, wsi, LWS_CALLBACK_CLOSED,
 294                                                       wsi->user_space, NULL, 0);
 295         } else
 296                 lwsl_debug("not calling back closed, old_state=%d\n", old_state);
 297
 298         /* deallocate any active extension contexts */
 299
 300         for (n = 0; n < wsi->count_active_extensions; n++) {
 301                 if (!wsi->active_extensions[n]->callback)
 302                         continue;
 303
 304                 wsi->active_extensions[n]->callback(context,
 305                         wsi->active_extensions[n], wsi,
 306                                 LWS_EXT_CALLBACK_DESTROY,
 307                                        wsi->active_extensions_user[n], NULL, 0);
 308
 309                 free(wsi->active_extensions_user[n]);
 310         }
 311
 312         /*
 313          * inform all extensions in case they tracked this guy out of band
 314          * even though not active on him specifically
 315          */
 316
 317         ext = context->extensions;
 318         while (ext && ext->callback) {
 319                 ext->callback(context, ext, wsi,
 320                                 LWS_EXT_CALLBACK_DESTROY_ANY_WSI_CLOSING,
 321                                        NULL, NULL, 0);
 322                 ext++;
 323         }
 324
 325         /* free up his parsing allocations */
 326
 327         for (n = 0; n < WSI_TOKEN_COUNT; n++)
 328                 if (wsi->utf8_token[n].token)
 329                         free(wsi->utf8_token[n].token);
 330 #ifndef LWS_NO_CLIENT
 331         if (wsi->c_address)
 332                 free(wsi->c_address);
 333 #endif
 334         if (wsi->rxflow_buffer)
 335                 free(wsi->rxflow_buffer);
 336
 337 /*      lwsl_info("closing fd=%d\n", wsi->sock); */
 338
 339 #ifdef LWS_OPENSSL_SUPPORT
 340         if (wsi->ssl) {
 341                 n = SSL_get_fd(wsi->ssl);
 342                 SSL_shutdown(wsi->ssl);
 343                 compatible_close(n);
 344                 SSL_free(wsi->ssl);
 345         } else {
 346 #endif
 347                 if (wsi->sock) {
 348                         n = shutdown(wsi->sock, SHUT_RDWR);
 349                         if (n)
 350                                 lwsl_debug("closing: shutdown returned %d\n", errno);
 351
 352                         n = compatible_close(wsi->sock);
 353                         if (n)
 354                                 lwsl_debug("closing: close returned %d\n", errno);
 355                 }
 356 #ifdef LWS_OPENSSL_SUPPORT
 357         }
 358 #endif
 359         if (wsi->protocol && wsi->protocol->per_session_data_size && wsi->user_space) /* user code may own */
 360                 free(wsi->user_space);
 361
 362         free(wsi);
 363 }
 364
 365 /**
 366  * libwebsockets_hangup_on_client() - Server calls to terminate client
 367  *                                      connection
 368  * @context:    libwebsockets context
 369  * @fd:         Connection socket descriptor
 370  */
 371
 372 void
 373 libwebsockets_hangup_on_client(struct libwebsocket_context *context, int fd)
 374 {
 375         struct libwebsocket *wsi = context->lws_lookup[fd];
 376
 377         if (wsi) {
 378                 libwebsocket_close_and_free_session(context,
 379                         wsi, LWS_CLOSE_STATUS_NOSTATUS);
 380         } else
 381                 close(fd);
 382 }
 383
 384
 385 /**
 386  * libwebsockets_get_peer_addresses() - Get client address information
 387  * @fd:         Connection socket descriptor
 388  * @name:       Buffer to take client address name
 389  * @name_len:   Length of client address name buffer
 390  * @rip:        Buffer to take client address IP qotted quad
 391  * @rip_len:    Length of client address IP buffer
 392  *
 393  *      This function fills in @name and @rip with the name and IP of
 394  *      the client connected with socket descriptor @fd.  Names may be
 395  *      truncated if there is not enough room.  If either cannot be
 396  *      determined, they will be returned as valid zero-length strings.
 397  */
 398
 399 void
 400 libwebsockets_get_peer_addresses(int fd, char *name, int name_len,
 401                                         char *rip, int rip_len)
 402 {
 403         unsigned int len;
 404         struct sockaddr_in sin;
 405         struct hostent *host;
 406         struct hostent *host1;
 407         char ip[128];
 408         unsigned char *p;
 409         int n;
 410 #ifdef AF_LOCAL
 411     struct sockaddr_un *un;
 412 #endif
 413
 414         rip[0] = '\0';
 415         name[0] = '\0';
 416
 417         len = sizeof sin;
 418         if (getpeername(fd, (struct sockaddr *) &sin, &len) < 0) {
 419                 perror("getpeername");
 420                 return;
 421         }
 422
 423         host = gethostbyaddr((char *) &sin.sin_addr, sizeof sin.sin_addr,
 424                                                                        AF_INET);
 425         if (host == NULL) {
 426                 perror("gethostbyaddr");
 427                 return;
 428         }
 429
 430         strncpy(name, host->h_name, name_len);
 431         name[name_len - 1] = '\0';
 432
 433         host1 = gethostbyname(host->h_name);
 434         if (host1 == NULL)
 435                 return;
 436         p = (unsigned char *)host1;
 437         n = 0;
 438         while (p != NULL) {
 439                 p = (unsigned char *)host1->h_addr_list[n++];
 440                 if (p == NULL)
 441                         continue;
 442                 if ((host1->h_addrtype != AF_INET)
 443 #ifdef AF_LOCAL
 444                         && (host1->h_addrtype != AF_LOCAL)
 445 #endif
 446                         )
 447                         continue;
 448
 449                 if (host1->h_addrtype == AF_INET)
 450                         sprintf(ip, "%u.%u.%u.%u", p[0], p[1], p[2], p[3]);
 451 #ifdef AF_LOCAL
 452                 else {
 453                         un = (struct sockaddr_un *)p;
 454                         strncpy(ip, un->sun_path, sizeof(ip) - 1);
 455                         ip[sizeof(ip) - 1] = '\0';
 456                 }
 457 #endif
 458                 p = NULL;
 459                 strncpy(rip, ip, rip_len);
 460                 rip[rip_len - 1] = '\0';
 461         }
 462 }
 463
 464 int libwebsockets_get_random(struct libwebsocket_context *context,
 465                                                              void *buf, int len)
 466 {
 467         int n;
 468         char *p = (char *)buf;
 469
 470 #ifdef WIN32
 471         for (n = 0; n < len; n++)
 472                 p[n] = (unsigned char)rand();
 473 #else
 474         n = read(context->fd_random, p, len);
 475 #endif
 476
 477         return n;
 478 }
 479
 480 unsigned char *
 481 libwebsockets_SHA1(const unsigned char *d, size_t n, unsigned char *md)
 482 {
 483         return SHA1(d, n, md);
 484 }
 485
 486 int lws_send_pipe_choked(struct libwebsocket *wsi)
 487 {
 488         struct pollfd fds;
 489
 490         fds.fd = wsi->sock;
 491         fds.events = POLLOUT;
 492         fds.revents = 0;
 493
 494         if (poll(&fds, 1, 0) != 1)
 495                 return 1;
 496
 497         if ((fds.revents & POLLOUT) == 0)
 498                 return 1;
 499
 500         /* okay to send another packet without blocking */
 501
 502         return 0;
 503 }
 504
 505 int
 506 lws_handle_POLLOUT_event(struct libwebsocket_context *context,
 507                                 struct libwebsocket *wsi, struct pollfd *pollfd)
 508 {
 509         struct lws_tokens eff_buf;
 510         int n;
 511         int ret;
 512         int m;
 513         int handled = 0;
 514
 515         for (n = 0; n < wsi->count_active_extensions; n++) {
 516                 if (!wsi->active_extensions[n]->callback)
 517                         continue;
 518
 519                 m = wsi->active_extensions[n]->callback(context,
 520                         wsi->active_extensions[n], wsi,
 521                         LWS_EXT_CALLBACK_IS_WRITEABLE,
 522                                        wsi->active_extensions_user[n], NULL, 0);
 523                 if (m > handled)
 524                         handled = m;
 525         }
 526
 527         if (handled == 1)
 528                 goto notify_action;
 529
 530         if (!wsi->extension_data_pending || handled == 2)
 531                 goto user_service;
 532
 533         /*
 534          * check in on the active extensions, see if they
 535          * had pending stuff to spill... they need to get the
 536          * first look-in otherwise sequence will be disordered
 537          *
 538          * NULL, zero-length eff_buf means just spill pending
 539          */
 540
 541         ret = 1;
 542         while (ret == 1) {
 543
 544                 /* default to nobody has more to spill */
 545
 546                 ret = 0;
 547                 eff_buf.token = NULL;
 548                 eff_buf.token_len = 0;
 549
 550                 /* give every extension a chance to spill */
 551
 552                 for (n = 0; n < wsi->count_active_extensions; n++) {
 553                         m = wsi->active_extensions[n]->callback(
 554                                 wsi->protocol->owning_server,
 555                                 wsi->active_extensions[n], wsi,
 556                                         LWS_EXT_CALLBACK_PACKET_TX_PRESEND,
 557                                    wsi->active_extensions_user[n], &eff_buf, 0);
 558                         if (m < 0) {
 559                                 lwsl_err("ext reports fatal error\n");
 560                                 return -1;
 561                         }
 562                         if (m)
 563                                 /*
 564                                  * at least one extension told us he has more
 565                                  * to spill, so we will go around again after
 566                                  */
 567                                 ret = 1;
 568                 }
 569
 570                 /* assuming they gave us something to send, send it */
 571
 572                 if (eff_buf.token_len) {
 573                         if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
 574                                                              eff_buf.token_len))
 575                                 return -1;
 576                 } else
 577                         continue;
 578
 579                 /* no extension has more to spill */
 580
 581                 if (!ret)
 582                         continue;
 583
 584                 /*
 585                  * There's more to spill from an extension, but we just sent
 586                  * something... did that leave the pipe choked?
 587                  */
 588
 589                 if (!lws_send_pipe_choked(wsi))
 590                         /* no we could add more */
 591                         continue;
 592
 593                 lwsl_info("choked in POLLOUT service\n");
 594
 595                 /*
 596                  * Yes, he's choked.  Leave the POLLOUT masked on so we will
 597                  * come back here when he is unchoked.  Don't call the user
 598                  * callback to enforce ordering of spilling, he'll get called
 599                  * when we come back here and there's nothing more to spill.
 600                  */
 601
 602                 return 0;
 603         }
 604
 605         wsi->extension_data_pending = 0;
 606
 607 user_service:
 608         /* one shot */
 609
 610         if (pollfd) {
 611                 pollfd->events &= ~POLLOUT;
 612
 613                 /* external POLL support via protocol 0 */
 614                 context->protocols[0].callback(context, wsi,
 615                         LWS_CALLBACK_CLEAR_MODE_POLL_FD,
 616                         (void *)(long)wsi->sock, NULL, POLLOUT);
 617         }
 618
 619 notify_action:
 620
 621         if (wsi->mode == LWS_CONNMODE_WS_CLIENT)
 622                 n = LWS_CALLBACK_CLIENT_WRITEABLE;
 623         else
 624                 n = LWS_CALLBACK_SERVER_WRITEABLE;
 625
 626         user_callback_handle_rxflow(wsi->protocol->callback, context,
 627                 wsi, (enum libwebsocket_callback_reasons) n, wsi->user_space, NULL, 0);
 628
 629         return 0;
 630 }
 631
 632
 633
 634 void
 635 libwebsocket_service_timeout_check(struct libwebsocket_context *context,
 636                                      struct libwebsocket *wsi, unsigned int sec)
 637 {
 638         int n;
 639
 640         /*
 641          * if extensions want in on it (eg, we are a mux parent)
 642          * give them a chance to service child timeouts
 643          */
 644
 645         for (n = 0; n < wsi->count_active_extensions; n++)
 646                 wsi->active_extensions[n]->callback(
 647                                     context, wsi->active_extensions[n],
 648                                     wsi, LWS_EXT_CALLBACK_1HZ,
 649                                     wsi->active_extensions_user[n], NULL, sec);
 650
 651         if (!wsi->pending_timeout)
 652                 return;
 653
 654         /*
 655          * if we went beyond the allowed time, kill the
 656          * connection
 657          */
 658
 659         if (sec > wsi->pending_timeout_limit) {
 660                 lwsl_info("TIMEDOUT WAITING\n");
 661                 libwebsocket_close_and_free_session(context,
 662                                 wsi, LWS_CLOSE_STATUS_NOSTATUS);
 663         }
 664 }
 665
 666 /**
 667  * libwebsocket_service_fd() - Service polled socket with something waiting
 668  * @context:    Websocket context
 669  * @pollfd:     The pollfd entry describing the socket fd and which events
 670  *              happened.
 671  *
 672  *      This function closes any active connections and then frees the
 673  *      context.  After calling this, any further use of the context is
 674  *      undefined.
 675  */
 676
 677 int
 678 libwebsocket_service_fd(struct libwebsocket_context *context,
 679                                                           struct pollfd *pollfd)
 680 {
 681         struct libwebsocket *wsi;
 682         unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 1 +
 683                          MAX_BROADCAST_PAYLOAD + LWS_SEND_BUFFER_POST_PADDING];
 684         int n;
 685         int m;
 686         struct timeval tv;
 687         int more = 1;
 688         struct lws_tokens eff_buf;
 689 #ifndef LWS_NO_CLIENT
 690         extern int lws_client_socket_service(struct libwebsocket_context *context, struct libwebsocket *wsi, struct pollfd *pollfd);
 691 #endif
 692 #ifndef LWS_NO_SERVER
 693         extern int lws_server_socket_service(struct libwebsocket_context *context, struct libwebsocket *wsi, struct pollfd *pollfd);
 694 #endif
 695         /*
 696          * you can call us with pollfd = NULL to just allow the once-per-second
 697          * global timeout checks; if less than a second since the last check
 698          * it returns immediately then.
 699          */
 700
 701         gettimeofday(&tv, NULL);
 702
 703         if (context->last_timeout_check_s != tv.tv_sec) {
 704                 context->last_timeout_check_s = tv.tv_sec;
 705
 706                 /* global timeout check once per second */
 707
 708                 for (n = 0; n < context->fds_count; n++) {
 709                         struct libwebsocket *new_wsi = context->lws_lookup[context->fds[n].fd];
 710                         if (!new_wsi)
 711                                 continue;
 712                         libwebsocket_service_timeout_check(context,
 713                                 new_wsi, tv.tv_sec);
 714                 }
 715         }
 716
 717         /* just here for timeout management? */
 718
 719         if (pollfd == NULL)
 720                 return 0;
 721
 722         /* no, here to service a socket descriptor */
 723
 724         /*
 725          * deal with listen service piggybacking
 726          * every listen_service_modulo services of other fds, we
 727          * sneak one in to service the listen socket if there's anything waiting
 728          *
 729          * To handle connection storms, as found in ab, if we previously saw a
 730          * pending connection here, it causes us to check again next time.
 731          */
 732
 733         if (context->listen_service_fd && pollfd->fd != context->listen_service_fd) {
 734                 context->listen_service_count++;
 735                 if (context->listen_service_extraseen ||
 736                                 context->listen_service_count == context->listen_service_modulo) {
 737                         context->listen_service_count = 0;
 738                         m = 1;
 739                         if (context->listen_service_extraseen > 5)
 740                                 m = 2;
 741                         while (m--) {
 742                                 /* even with extpoll, we prepared this internal fds for listen */
 743                                 n = poll(&context->fds[0], 1, 0);
 744                                 if (n > 0) { /* there's a connection waiting for us */
 745                                         libwebsocket_service_fd(context, &context->fds[0]);
 746                                         context->listen_service_extraseen++;
 747                                 } else {
 748                                         if (context->listen_service_extraseen)
 749                                                 context->listen_service_extraseen--;
 750                                         break;
 751                                 }
 752                         }
 753                 }
 754
 755         }
 756
 757         /* okay, what we came here to do... */
 758
 759         wsi = context->lws_lookup[pollfd->fd];
 760         if (wsi == NULL) {
 761                 if (pollfd->fd > 11)
 762                         lwsl_err("unexpected NULL wsi fd=%d fds_count=%d\n", pollfd->fd, context->fds_count);
 763                 return 0;
 764         }
 765
 766         switch (wsi->mode) {
 767
 768 #ifndef LWS_NO_SERVER
 769         case LWS_CONNMODE_HTTP_SERVING:
 770         case LWS_CONNMODE_SERVER_LISTENER:
 771         case LWS_CONNMODE_BROADCAST_PROXY_LISTENER:
 772         case LWS_CONNMODE_BROADCAST_PROXY:
 773                 return lws_server_socket_service(context, wsi, pollfd);
 774 #endif
 775
 776         case LWS_CONNMODE_WS_SERVING:
 777         case LWS_CONNMODE_WS_CLIENT:
 778
 779                 /* handle session socket closed */
 780
 781                 if (pollfd->revents & (POLLERR | POLLHUP)) {
 782
 783                         lwsl_debug("Session Socket %p (fd=%d) dead\n",
 784                                 (void *)wsi, pollfd->fd);
 785
 786                         libwebsocket_close_and_free_session(context, wsi,
 787                                                      LWS_CLOSE_STATUS_NOSTATUS);
 788                         return 0;
 789                 }
 790
 791                 /* the guy requested a callback when it was OK to write */
 792
 793                 if ((pollfd->revents & POLLOUT) &&
 794                                             wsi->state == WSI_STATE_ESTABLISHED)
 795                         if (lws_handle_POLLOUT_event(context, wsi,
 796                                                                   pollfd) < 0) {
 797                                 libwebsocket_close_and_free_session(
 798                                          context, wsi, LWS_CLOSE_STATUS_NORMAL);
 799                                 return 0;
 800                         }
 801
 802
 803                 /* any incoming data ready? */
 804
 805                 if (!(pollfd->revents & POLLIN))
 806                         break;
 807
 808 #ifdef LWS_OPENSSL_SUPPORT
 809 read_pending:
 810                 if (wsi->ssl)
 811                         eff_buf.token_len = SSL_read(wsi->ssl, buf, sizeof buf);
 812                 else
 813 #endif
 814                         eff_buf.token_len =
 815                                            recv(pollfd->fd, buf, sizeof buf, 0);
 816
 817                 if (eff_buf.token_len < 0) {
 818                         lwsl_debug("Socket read returned %d\n",
 819                                                             eff_buf.token_len);
 820                         if (errno != EINTR && errno != EAGAIN)
 821                                 libwebsocket_close_and_free_session(context,
 822                                                wsi, LWS_CLOSE_STATUS_NOSTATUS);
 823                         return 0;
 824                 }
 825                 if (!eff_buf.token_len) {
 826                         libwebsocket_close_and_free_session(context, wsi,
 827                                                     LWS_CLOSE_STATUS_NOSTATUS);
 828                         return 0;
 829                 }
 830
 831                 /*
 832                  * give any active extensions a chance to munge the buffer
 833                  * before parse.  We pass in a pointer to an lws_tokens struct
 834                  * prepared with the default buffer and content length that's in
 835                  * there.  Rather than rewrite the default buffer, extensions
 836                  * that expect to grow the buffer can adapt .token to
 837                  * point to their own per-connection buffer in the extension
 838                  * user allocation.  By default with no extensions or no
 839                  * extension callback handling, just the normal input buffer is
 840                  * used then so it is efficient.
 841                  */
 842
 843                 eff_buf.token = (char *)buf;
 844
 845                 more = 1;
 846                 while (more) {
 847
 848                         more = 0;
 849
 850                         for (n = 0; n < wsi->count_active_extensions; n++) {
 851                                 m = wsi->active_extensions[n]->callback(context,
 852                                         wsi->active_extensions[n], wsi,
 853                                         LWS_EXT_CALLBACK_PACKET_RX_PREPARSE,
 854                                         wsi->active_extensions_user[n],
 855                                                                    &eff_buf, 0);
 856                                 if (m < 0) {
 857                                         lwsl_ext(
 858                                             "Extension reports fatal error\n");
 859                                         libwebsocket_close_and_free_session(
 860                                                 context, wsi,
 861                                                     LWS_CLOSE_STATUS_NOSTATUS);
 862                                         return 0;
 863                                 }
 864                                 if (m)
 865                                         more = 1;
 866                         }
 867
 868                         /* service incoming data */
 869
 870                         if (eff_buf.token_len) {
 871                                 n = libwebsocket_read(context, wsi,
 872                                         (unsigned char *)eff_buf.token,
 873                                                             eff_buf.token_len);
 874                                 if (n < 0)
 875                                         /* we closed wsi */
 876                                         return 0;
 877                         }
 878
 879                         eff_buf.token = NULL;
 880                         eff_buf.token_len = 0;
 881                 }
 882
 883 #ifdef LWS_OPENSSL_SUPPORT
 884                 if (wsi->ssl && SSL_pending(wsi->ssl))
 885                         goto read_pending;
 886 #endif
 887                 break;
 888
 889         default:
 890 #ifdef LWS_NO_CLIENT
 891                 break;
 892 #else
 893                 return  lws_client_socket_service(context, wsi, pollfd);
 894 #endif
 895         }
 896
 897         return 0;
 898 }
 899
 900
 901 /**
 902  * libwebsocket_context_destroy() - Destroy the websocket context
 903  * @context:    Websocket context
 904  *
 905  *      This function closes any active connections and then frees the
 906  *      context.  After calling this, any further use of the context is
 907  *      undefined.
 908  */
 909 void
 910 libwebsocket_context_destroy(struct libwebsocket_context *context)
 911 {
 912         int n;
 913         int m;
 914         struct libwebsocket_extension *ext;
 915
 916         for (n = 0; n < context->fds_count; n++) {
 917                 struct libwebsocket *wsi = context->lws_lookup[context->fds[n].fd];
 918                 libwebsocket_close_and_free_session(context,
 919                         wsi, LWS_CLOSE_STATUS_GOINGAWAY);
 920         }
 921
 922         /*
 923          * give all extensions a chance to clean up any per-context
 924          * allocations they might have made
 925          */
 926
 927         ext = context->extensions;
 928         m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_DESTRUCT;
 929         if (context->listen_port)
 930                 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_DESTRUCT;
 931         while (ext && ext->callback) {
 932                 ext->callback(context, ext, NULL, (enum libwebsocket_extension_callback_reasons)m, NULL, NULL, 0);
 933                 ext++;
 934         }
 935
 936 #ifdef WIN32
 937 #else
 938         close(context->fd_random);
 939 #endif
 940
 941 #ifdef LWS_OPENSSL_SUPPORT
 942         if (context->ssl_ctx)
 943                 SSL_CTX_free(context->ssl_ctx);
 944         if (context->ssl_client_ctx)
 945                 SSL_CTX_free(context->ssl_client_ctx);
 946 #endif
 947
 948         free(context);
 949
 950 #ifdef WIN32
 951         WSACleanup();
 952 #endif
 953 }
 954
 955 LWS_EXTERN void *
 956 libwebsocket_context_user(struct libwebsocket_context *context)
 957 {
 958     return context->user_space;
 959 }
 960
 961 /**
 962  * libwebsocket_service() - Service any pending websocket activity
 963  * @context:    Websocket context
 964  * @timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
 965  *              service otherwise block and service immediately, returning
 966  *              after the timeout if nothing needed service.
 967  *
 968  *      This function deals with any pending websocket traffic, for three
 969  *      kinds of event.  It handles these events on both server and client
 970  *      types of connection the same.
 971  *
 972  *      1) Accept new connections to our context's server
 973  *
 974  *      2) Perform pending broadcast writes initiated from other forked
 975  *         processes (effectively serializing asynchronous broadcasts)
 976  *
 977  *      3) Call the receive callback for incoming frame data received by
 978  *          server or client connections.
 979  *
 980  *      You need to call this service function periodically to all the above
 981  *      functions to happen; if your application is single-threaded you can
 982  *      just call it in your main event loop.
 983  *
 984  *      Alternatively you can fork a new process that asynchronously handles
 985  *      calling this service in a loop.  In that case you are happy if this
 986  *      call blocks your thread until it needs to take care of something and
 987  *      would call it with a large nonzero timeout.  Your loop then takes no
 988  *      CPU while there is nothing happening.
 989  *
 990  *      If you are calling it in a single-threaded app, you don't want it to
 991  *      wait around blocking other things in your loop from happening, so you
 992  *      would call it with a timeout_ms of 0, so it returns immediately if
 993  *      nothing is pending, or as soon as it services whatever was pending.
 994  */
 995
 996
 997 int
 998 libwebsocket_service(struct libwebsocket_context *context, int timeout_ms)
 999 {
1000         int n;
1001
1002         /* stay dead once we are dead */
1003
1004         if (context == NULL)
1005                 return 1;
1006
1007         /* wait for something to need service */
1008
1009         n = poll(context->fds, context->fds_count, timeout_ms);
1010         if (n == 0) /* poll timeout */
1011                 return 0;
1012
1013         if (n < 0)
1014                 return -1;
1015
1016         /* any socket with events to service? */
1017
1018         for (n = 0; n < context->fds_count; n++)
1019                 if (context->fds[n].revents)
1020                         if (libwebsocket_service_fd(context,
1021                                                         &context->fds[n]) < 0)
1022                                 return -1;
1023         return 0;
1024 }
1025
1026 int
1027 lws_any_extension_handled(struct libwebsocket_context *context,
1028                           struct libwebsocket *wsi,
1029                           enum libwebsocket_extension_callback_reasons r,
1030                                                        void *v, size_t len)
1031 {
1032         int n;
1033         int handled = 0;
1034
1035         /* maybe an extension will take care of it for us */
1036
1037         for (n = 0; n < wsi->count_active_extensions && !handled; n++) {
1038                 if (!wsi->active_extensions[n]->callback)
1039                         continue;
1040
1041                 handled |= wsi->active_extensions[n]->callback(context,
1042                         wsi->active_extensions[n], wsi,
1043                         r, wsi->active_extensions_user[n], v, len);
1044         }
1045
1046         return handled;
1047 }
1048
1049
1050 void *
1051 lws_get_extension_user_matching_ext(struct libwebsocket *wsi,
1052                                            struct libwebsocket_extension *ext)
1053 {
1054         int n = 0;
1055
1056         if (wsi == NULL)
1057                 return NULL;
1058
1059         while (n < wsi->count_active_extensions) {
1060                 if (wsi->active_extensions[n] != ext) {
1061                         n++;
1062                         continue;
1063                 }
1064                 return wsi->active_extensions_user[n];
1065         }
1066
1067         return NULL;
1068 }
1069
1070 /**
1071  * libwebsocket_callback_on_writable() - Request a callback when this socket
1072  *                                       becomes able to be written to without
1073  *                                       blocking
1074  *
1075  * @context:    libwebsockets context
1076  * @wsi:        Websocket connection instance to get callback for
1077  */
1078
1079 int
1080 libwebsocket_callback_on_writable(struct libwebsocket_context *context,
1081                                                       struct libwebsocket *wsi)
1082 {
1083         int n;
1084         int handled = 0;
1085
1086         /* maybe an extension will take care of it for us */
1087
1088         for (n = 0; n < wsi->count_active_extensions; n++) {
1089                 if (!wsi->active_extensions[n]->callback)
1090                         continue;
1091
1092                 handled |= wsi->active_extensions[n]->callback(context,
1093                         wsi->active_extensions[n], wsi,
1094                         LWS_EXT_CALLBACK_REQUEST_ON_WRITEABLE,
1095                                        wsi->active_extensions_user[n], NULL, 0);
1096         }
1097
1098         if (handled)
1099                 return 1;
1100
1101         if (wsi->position_in_fds_table < 0) {
1102                 lwsl_err("libwebsocket_callback_on_writable: "
1103                                       "failed to find socket %d\n", wsi->sock);
1104                 return -1;
1105         }
1106
1107         context->fds[wsi->position_in_fds_table].events |= POLLOUT;
1108
1109         /* external POLL support via protocol 0 */
1110         context->protocols[0].callback(context, wsi,
1111                 LWS_CALLBACK_SET_MODE_POLL_FD,
1112                 (void *)(long)wsi->sock, NULL, POLLOUT);
1113
1114         return 1;
1115 }
1116
1117 /**
1118  * libwebsocket_callback_on_writable_all_protocol() - Request a callback for
1119  *                      all connections using the given protocol when it
1120  *                      becomes possible to write to each socket without
1121  *                      blocking in turn.
1122  *
1123  * @protocol:   Protocol whose connections will get callbacks
1124  */
1125
1126 int
1127 libwebsocket_callback_on_writable_all_protocol(
1128                                   const struct libwebsocket_protocols *protocol)
1129 {
1130         struct libwebsocket_context *context = protocol->owning_server;
1131         int n;
1132         struct libwebsocket *wsi;
1133
1134         for (n = 0; n < context->fds_count; n++) {
1135                 wsi = context->lws_lookup[context->fds[n].fd];
1136                 if (!wsi)
1137                         continue;
1138                 if (wsi->protocol == protocol)
1139                         libwebsocket_callback_on_writable(context, wsi);
1140         }
1141
1142         return 0;
1143 }
1144
1145 /**
1146  * libwebsocket_set_timeout() - marks the wsi as subject to a timeout
1147  *
1148  * You will not need this unless you are doing something special
1149  *
1150  * @wsi:        Websocket connection instance
1151  * @reason:     timeout reason
1152  * @secs:       how many seconds
1153  */
1154
1155 void
1156 libwebsocket_set_timeout(struct libwebsocket *wsi,
1157                                           enum pending_timeout reason, int secs)
1158 {
1159         struct timeval tv;
1160
1161         gettimeofday(&tv, NULL);
1162
1163         wsi->pending_timeout_limit = tv.tv_sec + secs;
1164         wsi->pending_timeout = reason;
1165 }
1166
1167
1168 /**
1169  * libwebsocket_get_socket_fd() - returns the socket file descriptor
1170  *
1171  * You will not need this unless you are doing something special
1172  *
1173  * @wsi:        Websocket connection instance
1174  */
1175
1176 int
1177 libwebsocket_get_socket_fd(struct libwebsocket *wsi)
1178 {
1179         return wsi->sock;
1180 }
1181
1182 #ifdef LWS_NO_SERVER
1183 int
1184 _libwebsocket_rx_flow_control(struct libwebsocket *wsi)
1185 {
1186         return 0;
1187 }
1188 #else
1189 int
1190 _libwebsocket_rx_flow_control(struct libwebsocket *wsi)
1191 {
1192         struct libwebsocket_context *context = wsi->protocol->owning_server;
1193         int n;
1194
1195         if (!(wsi->rxflow_change_to & 2))
1196                 return 0;
1197
1198         wsi->rxflow_change_to &= ~2;
1199
1200         lwsl_info("rxflow: wsi %p change_to %d\n", wsi, wsi->rxflow_change_to);
1201
1202         /* if we're letting it come again, did we interrupt anything? */
1203         if ((wsi->rxflow_change_to & 1) && wsi->rxflow_buffer) {
1204                 n = libwebsocket_interpret_incoming_packet(wsi, NULL, 0);
1205                 if (n < 0) {
1206                         libwebsocket_close_and_free_session(context, wsi, LWS_CLOSE_STATUS_NOSTATUS);
1207                         return -1;
1208                 }
1209                 if (n)
1210                         /* oh he stuck again, do nothing */
1211                         return 0;
1212         }
1213
1214         if (wsi->rxflow_change_to & 1)
1215                 context->fds[wsi->position_in_fds_table].events |= POLLIN;
1216         else
1217                 context->fds[wsi->position_in_fds_table].events &= ~POLLIN;
1218
1219         if (wsi->rxflow_change_to & 1)
1220                 /* external POLL support via protocol 0 */
1221                 context->protocols[0].callback(context, wsi,
1222                         LWS_CALLBACK_SET_MODE_POLL_FD,
1223                         (void *)(long)wsi->sock, NULL, POLLIN);
1224         else
1225                 /* external POLL support via protocol 0 */
1226                 context->protocols[0].callback(context, wsi,
1227                         LWS_CALLBACK_CLEAR_MODE_POLL_FD,
1228                         (void *)(long)wsi->sock, NULL, POLLIN);
1229
1230         return 1;
1231 }
1232 #endif
1233
1234 /**
1235  * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
1236  *                              receieved packets.
1237  *
1238  * If the output side of a server process becomes choked, this allows flow
1239  * control for the input side.
1240  *
1241  * @wsi:        Websocket connection instance to get callback for
1242  * @enable:     0 = disable read servicing for this connection, 1 = enable
1243  */
1244
1245 int
1246 libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
1247 {
1248         wsi->rxflow_change_to = 2 | !!enable;
1249
1250         return 0;
1251 }
1252
1253
1254 /**
1255  * libwebsocket_canonical_hostname() - returns this host's hostname
1256  *
1257  * This is typically used by client code to fill in the host parameter
1258  * when making a client connection.  You can only call it after the context
1259  * has been created.
1260  *
1261  * @context:    Websocket context
1262  */
1263
1264
1265 extern const char *
1266 libwebsocket_canonical_hostname(struct libwebsocket_context *context)
1267 {
1268         return (const char *)context->canonical_hostname;
1269 }
1270
1271
1272 static void sigpipe_handler(int x)
1273 {
1274 }
1275
1276 #ifdef LWS_OPENSSL_SUPPORT
1277 static int
1278 OpenSSL_verify_callback(int preverify_ok, X509_STORE_CTX *x509_ctx)
1279 {
1280
1281         SSL *ssl;
1282         int n;
1283         struct libwebsocket_context *context;
1284
1285         ssl = X509_STORE_CTX_get_ex_data(x509_ctx,
1286                 SSL_get_ex_data_X509_STORE_CTX_idx());
1287
1288         /*
1289          * !!! nasty openssl requires the index to come as a library-scope
1290          * static
1291          */
1292         context = SSL_get_ex_data(ssl, openssl_websocket_private_data_index);
1293
1294         n = context->protocols[0].callback(NULL, NULL,
1295                 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION,
1296                                                    x509_ctx, ssl, preverify_ok);
1297
1298         /* convert return code from 0 = OK to 1 = OK */
1299
1300         if (!n)
1301                 n = 1;
1302         else
1303                 n = 0;
1304
1305         return n;
1306 }
1307 #endif
1308
1309 int user_callback_handle_rxflow(callback_function callback_function,
1310                 struct libwebsocket_context * context,
1311                         struct libwebsocket *wsi,
1312                          enum libwebsocket_callback_reasons reason, void *user,
1313                                                           void *in, size_t len)
1314 {
1315         int n;
1316
1317         n = callback_function(context, wsi, reason, user, in, len);
1318         if (n < 0)
1319                 return n;
1320
1321         _libwebsocket_rx_flow_control(wsi);
1322
1323         return 0;
1324 }
1325
1326
1327 /**
1328  * libwebsocket_create_context() - Create the websocket handler
1329  * @port:       Port to listen on... you can use 0 to suppress listening on
1330  *              any port, that's what you want if you are not running a
1331  *              websocket server at all but just using it as a client
1332  * @interf:  NULL to bind the listen socket to all interfaces, or the
1333  *              interface name, eg, "eth2"
1334  * @protocols:  Array of structures listing supported protocols and a protocol-
1335  *              specific callback for each one.  The list is ended with an
1336  *              entry that has a NULL callback pointer.
1337  *              It's not const because we write the owning_server member
1338  * @extensions: NULL or array of libwebsocket_extension structs listing the
1339  *              extensions this context supports
1340  * @ssl_cert_filepath:  If libwebsockets was compiled to use ssl, and you want
1341  *                      to listen using SSL, set to the filepath to fetch the
1342  *                      server cert from, otherwise NULL for unencrypted
1343  * @ssl_private_key_filepath: filepath to private key if wanting SSL mode,
1344  *                      else ignored
1345  * @ssl_ca_filepath: CA certificate filepath or NULL
1346  * @gid:        group id to change to after setting listen socket, or -1.
1347  * @uid:        user id to change to after setting listen socket, or -1.
1348  * @options:    0, or LWS_SERVER_OPTION_DEFEAT_CLIENT_MASK
1349  * @user:       optional user pointer that can be recovered via the context
1350  *              pointer using libwebsocket_context_user
1351  *
1352  *      This function creates the listening socket and takes care
1353  *      of all initialization in one step.
1354  *
1355  *      After initialization, it returns a struct libwebsocket_context * that
1356  *      represents this server.  After calling, user code needs to take care
1357  *      of calling libwebsocket_service() with the context pointer to get the
1358  *      server's sockets serviced.  This can be done in the same process context
1359  *      or a forked process, or another thread,
1360  *
1361  *      The protocol callback functions are called for a handful of events
1362  *      including http requests coming in, websocket connections becoming
1363  *      established, and data arriving; it's also called periodically to allow
1364  *      async transmission.
1365  *
1366  *      HTTP requests are sent always to the FIRST protocol in @protocol, since
1367  *      at that time websocket protocol has not been negotiated.  Other
1368  *      protocols after the first one never see any HTTP callack activity.
1369  *
1370  *      The server created is a simple http server by default; part of the
1371  *      websocket standard is upgrading this http connection to a websocket one.
1372  *
1373  *      This allows the same server to provide files like scripts and favicon /
1374  *      images or whatever over http and dynamic data over websockets all in
1375  *      one place; they're all handled in the user callback.
1376  */
1377
1378 struct libwebsocket_context *
1379 libwebsocket_create_context(int port, const char *interf,
1380                                struct libwebsocket_protocols *protocols,
1381                                struct libwebsocket_extension *extensions,
1382                                const char *ssl_cert_filepath,
1383                                const char *ssl_private_key_filepath,
1384                                const char *ssl_ca_filepath,
1385                                int gid, int uid, unsigned int options,
1386                                void *user)
1387 {
1388         int n;
1389         int m;
1390         int fd;
1391         struct sockaddr_in serv_addr, cli_addr;
1392         int opt = 1;
1393         struct libwebsocket_context *context = NULL;
1394         unsigned int slen;
1395         char *p;
1396         struct libwebsocket *wsi;
1397
1398 #ifdef LWS_OPENSSL_SUPPORT
1399         SSL_METHOD *method;
1400         char ssl_err_buf[512];
1401 #endif
1402
1403         lwsl_notice("Initial logging level %d\n", log_level);
1404         lwsl_info(" LWS_MAX_HEADER_NAME_LENGTH: %u\n", LWS_MAX_HEADER_NAME_LENGTH);
1405         lwsl_info(" LWS_MAX_HEADER_LEN: %u\n", LWS_MAX_HEADER_LEN);
1406         lwsl_info(" LWS_INITIAL_HDR_ALLOC: %u\n", LWS_INITIAL_HDR_ALLOC);
1407         lwsl_info(" LWS_ADDITIONAL_HDR_ALLOC: %u\n", LWS_ADDITIONAL_HDR_ALLOC);
1408         lwsl_info(" MAX_USER_RX_BUFFER: %u\n", MAX_USER_RX_BUFFER);
1409         lwsl_info(" MAX_BROADCAST_PAYLOAD: %u\n", MAX_BROADCAST_PAYLOAD);
1410         lwsl_info(" LWS_MAX_PROTOCOLS: %u\n", LWS_MAX_PROTOCOLS);
1411         lwsl_info(" LWS_MAX_EXTENSIONS_ACTIVE: %u\n", LWS_MAX_EXTENSIONS_ACTIVE);
1412         lwsl_info(" SPEC_LATEST_SUPPORTED: %u\n", SPEC_LATEST_SUPPORTED);
1413         lwsl_info(" AWAITING_TIMEOUT: %u\n", AWAITING_TIMEOUT);
1414         lwsl_info(" CIPHERS_LIST_STRING: '%s'\n", CIPHERS_LIST_STRING);
1415         lwsl_info(" SYSTEM_RANDOM_FILEPATH: '%s'\n", SYSTEM_RANDOM_FILEPATH);
1416         lwsl_info(" LWS_MAX_ZLIB_CONN_BUFFER: %u\n", LWS_MAX_ZLIB_CONN_BUFFER);
1417
1418 #ifdef _WIN32
1419         {
1420                 WORD wVersionRequested;
1421                 WSADATA wsaData;
1422                 int err;
1423                 HMODULE wsdll;
1424
1425                 /* Use the MAKEWORD(lowbyte, highbyte) macro from Windef.h */
1426                 wVersionRequested = MAKEWORD(2, 2);
1427
1428                 err = WSAStartup(wVersionRequested, &wsaData);
1429                 if (err != 0) {
1430                         /* Tell the user that we could not find a usable */
1431                         /* Winsock DLL.                                  */
1432                         lwsl_err("WSAStartup failed with error: %d\n", err);
1433                         return NULL;
1434                 }
1435
1436                 /* default to a poll() made out of select() */
1437                 poll = emulated_poll;
1438
1439                 /* if windows socket lib available, use his WSAPoll */
1440                 wsdll = GetModuleHandle(_T("Ws2_32.dll"));
1441                 if (wsdll)
1442                         poll = (PFNWSAPOLL)GetProcAddress(wsdll, "WSAPoll");
1443         }
1444 #endif
1445
1446
1447         context = (struct libwebsocket_context *) malloc(sizeof(struct libwebsocket_context));
1448         if (!context) {
1449                 lwsl_err("No memory for websocket context\n");
1450                 return NULL;
1451         }
1452         context->protocols = protocols;
1453         context->listen_port = port;
1454         context->http_proxy_port = 0;
1455         context->http_proxy_address[0] = '\0';
1456         context->options = options;
1457         /* to reduce this allocation, */
1458         context->max_fds = getdtablesize();
1459         lwsl_notice(" max fd tracked: %u\n", context->max_fds);
1460
1461         context->fds = (struct pollfd *)malloc(sizeof(struct pollfd) * context->max_fds);
1462         if (context->fds == NULL) {
1463                 lwsl_err("Unable to allocate fds array for %d connections\n", context->max_fds);
1464                 free(context);
1465                 return NULL;
1466         }
1467         context->lws_lookup = (struct libwebsocket **)malloc(sizeof(struct libwebsocke *) * context->max_fds);
1468         if (context->lws_lookup == NULL) {
1469                 lwsl_err("Unable to allocate lws_lookup array for %d connections\n", context->max_fds);
1470                 free(context->fds);
1471                 free(context);
1472                 return NULL;
1473         }
1474         context->fds_count = 0;
1475         context->extensions = extensions;
1476         context->last_timeout_check_s = 0;
1477         context->user_space = user;
1478
1479 #ifdef WIN32
1480         context->fd_random = 0;
1481 #else
1482         context->fd_random = open(SYSTEM_RANDOM_FILEPATH, O_RDONLY);
1483         if (context->fd_random < 0) {
1484                 free(context);
1485                 lwsl_err("Unable to open random device %s %d\n",
1486                                     SYSTEM_RANDOM_FILEPATH, context->fd_random);
1487                 return NULL;
1488         }
1489 #endif
1490
1491 #ifdef LWS_OPENSSL_SUPPORT
1492         context->use_ssl = 0;
1493         context->ssl_ctx = NULL;
1494         context->ssl_client_ctx = NULL;
1495         openssl_websocket_private_data_index = 0;
1496 #endif
1497
1498         strcpy(context->canonical_hostname, "unknown");
1499
1500 #ifndef LWS_NO_SERVER
1501         if (!(options & LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME)) {
1502                 struct sockaddr sa;
1503                 char hostname[1024] = "";
1504
1505                 /* find canonical hostname */
1506
1507                 hostname[(sizeof hostname) - 1] = '\0';
1508                 memset(&sa, 0, sizeof(sa));
1509                 sa.sa_family = AF_INET;
1510                 sa.sa_data[(sizeof sa.sa_data) - 1] = '\0';
1511                 gethostname(hostname, (sizeof hostname) - 1);
1512
1513                 n = 0;
1514
1515                 if (strlen(hostname) < sizeof(sa.sa_data) - 1) {
1516                         strcpy(sa.sa_data, hostname);
1517         //              lwsl_debug("my host name is %s\n", sa.sa_data);
1518                         n = getnameinfo(&sa, sizeof(sa), hostname,
1519                                 (sizeof hostname) - 1, NULL, 0, 0);
1520                 }
1521
1522                 if (!n) {
1523                         strncpy(context->canonical_hostname, hostname,
1524                                                 sizeof context->canonical_hostname - 1);
1525                         context->canonical_hostname[
1526                                         sizeof context->canonical_hostname - 1] = '\0';
1527                 } else
1528                         strncpy(context->canonical_hostname, hostname,
1529                                                 sizeof context->canonical_hostname - 1);
1530
1531                 lwsl_notice(" canonical_hostname = %s\n", context->canonical_hostname);
1532         }
1533 #endif
1534
1535         /* split the proxy ads:port if given */
1536
1537         p = getenv("http_proxy");
1538         if (p) {
1539                 strncpy(context->http_proxy_address, p,
1540                                        sizeof context->http_proxy_address - 1);
1541                 context->http_proxy_address[
1542                                  sizeof context->http_proxy_address - 1] = '\0';
1543
1544                 p = strchr(context->http_proxy_address, ':');
1545                 if (p == NULL) {
1546                         lwsl_err("http_proxy needs to be ads:port\n");
1547                         return NULL;
1548                 }
1549                 *p = '\0';
1550                 context->http_proxy_port = atoi(p + 1);
1551
1552                 lwsl_notice(" Proxy %s:%u\n",
1553                                 context->http_proxy_address,
1554                                                       context->http_proxy_port);
1555         }
1556
1557 #ifndef LWS_NO_SERVER
1558         if (port) {
1559
1560 #ifdef LWS_OPENSSL_SUPPORT
1561                 context->use_ssl = ssl_cert_filepath != NULL &&
1562                                                ssl_private_key_filepath != NULL;
1563                 if (context->use_ssl)
1564                         lwsl_notice(" Compiled with SSL support, using it\n");
1565                 else
1566                         lwsl_notice(" Compiled with SSL support, not using it\n");
1567
1568 #else
1569                 if (ssl_cert_filepath != NULL &&
1570                                              ssl_private_key_filepath != NULL) {
1571                         lwsl_notice(" Not compiled for OpenSSl support!\n");
1572                         return NULL;
1573                 }
1574                 lwsl_notice(" Compiled without SSL support, "
1575                                                        "serving unencrypted\n");
1576 #endif
1577         }
1578 #endif
1579
1580         /* ignore SIGPIPE */
1581 #ifdef WIN32
1582 #else
1583         signal(SIGPIPE, sigpipe_handler);
1584 #endif
1585
1586
1587 #ifdef LWS_OPENSSL_SUPPORT
1588
1589         /* basic openssl init */
1590
1591         SSL_library_init();
1592
1593         OpenSSL_add_all_algorithms();
1594         SSL_load_error_strings();
1595
1596         openssl_websocket_private_data_index =
1597                 SSL_get_ex_new_index(0, "libwebsockets", NULL, NULL, NULL);
1598
1599         /*
1600          * Firefox insists on SSLv23 not SSLv3
1601          * Konq disables SSLv2 by default now, SSLv23 works
1602          */
1603
1604         method = (SSL_METHOD *)SSLv23_server_method();
1605         if (!method) {
1606                 lwsl_err("problem creating ssl method: %s\n",
1607                         ERR_error_string(ERR_get_error(), ssl_err_buf));
1608                 return NULL;
1609         }
1610         context->ssl_ctx = SSL_CTX_new(method); /* create context */
1611         if (!context->ssl_ctx) {
1612                 lwsl_err("problem creating ssl context: %s\n",
1613                         ERR_error_string(ERR_get_error(), ssl_err_buf));
1614                 return NULL;
1615         }
1616
1617 #ifdef SSL_OP_NO_COMPRESSION
1618         SSL_CTX_set_options(context->ssl_ctx, SSL_OP_NO_COMPRESSION);
1619 #endif
1620         SSL_CTX_set_options(context->ssl_ctx, SSL_OP_CIPHER_SERVER_PREFERENCE);
1621         SSL_CTX_set_cipher_list(context->ssl_ctx, CIPHERS_LIST_STRING);
1622
1623 #ifndef LWS_NO_CLIENT
1624
1625         /* client context */
1626
1627         if (port == CONTEXT_PORT_NO_LISTEN) {
1628                 method = (SSL_METHOD *)SSLv23_client_method();
1629                 if (!method) {
1630                         lwsl_err("problem creating ssl method: %s\n",
1631                                 ERR_error_string(ERR_get_error(), ssl_err_buf));
1632                         return NULL;
1633                 }
1634                 /* create context */
1635                 context->ssl_client_ctx = SSL_CTX_new(method);
1636                 if (!context->ssl_client_ctx) {
1637                         lwsl_err("problem creating ssl context: %s\n",
1638                                 ERR_error_string(ERR_get_error(), ssl_err_buf));
1639                         return NULL;
1640                 }
1641
1642 #ifdef SSL_OP_NO_COMPRESSION
1643                 SSL_CTX_set_options(context->ssl_client_ctx, SSL_OP_NO_COMPRESSION);
1644 #endif
1645                 SSL_CTX_set_options(context->ssl_client_ctx, SSL_OP_CIPHER_SERVER_PREFERENCE);
1646                 SSL_CTX_set_cipher_list(context->ssl_client_ctx, CIPHERS_LIST_STRING);
1647
1648                 /* openssl init for cert verification (for client sockets) */
1649                 if (!ssl_ca_filepath) {
1650                         if (!SSL_CTX_load_verify_locations(
1651                                 context->ssl_client_ctx, NULL,
1652                                                      LWS_OPENSSL_CLIENT_CERTS))
1653                                 lwsl_err(
1654                                         "Unable to load SSL Client certs from %s "
1655                                         "(set by --with-client-cert-dir= in configure) -- "
1656                                         " client ssl isn't going to work",
1657                                                      LWS_OPENSSL_CLIENT_CERTS);
1658                 } else
1659                         if (!SSL_CTX_load_verify_locations(
1660                                 context->ssl_client_ctx, ssl_ca_filepath,
1661                                                                   NULL))
1662                                 lwsl_err(
1663                                         "Unable to load SSL Client certs "
1664                                         "file from %s -- client ssl isn't "
1665                                         "going to work", ssl_ca_filepath);
1666
1667                 /*
1668                  * callback allowing user code to load extra verification certs
1669                  * helping the client to verify server identity
1670                  */
1671
1672                 context->protocols[0].callback(context, NULL,
1673                         LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS,
1674                         context->ssl_client_ctx, NULL, 0);
1675         }
1676 #endif
1677
1678         /* as a server, are we requiring clients to identify themselves? */
1679
1680         if (options & LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT) {
1681
1682                 /* absolutely require the client cert */
1683
1684                 SSL_CTX_set_verify(context->ssl_ctx,
1685                        SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
1686                                                        OpenSSL_verify_callback);
1687
1688                 /*
1689                  * give user code a chance to load certs into the server
1690                  * allowing it to verify incoming client certs
1691                  */
1692
1693                 context->protocols[0].callback(context, NULL,
1694                         LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS,
1695                                                      context->ssl_ctx, NULL, 0);
1696         }
1697
1698         if (context->use_ssl) {
1699
1700                 /* openssl init for server sockets */
1701
1702                 /* set the local certificate from CertFile */
1703                 n = SSL_CTX_use_certificate_chain_file(context->ssl_ctx,
1704                                         ssl_cert_filepath);
1705                 if (n != 1) {
1706                         lwsl_err("problem getting cert '%s': %s\n",
1707                                 ssl_cert_filepath,
1708                                 ERR_error_string(ERR_get_error(), ssl_err_buf));
1709                         return NULL;
1710                 }
1711                 /* set the private key from KeyFile */
1712                 if (SSL_CTX_use_PrivateKey_file(context->ssl_ctx,
1713                              ssl_private_key_filepath, SSL_FILETYPE_PEM) != 1) {
1714                         lwsl_err("ssl problem getting key '%s': %s\n",
1715                                                 ssl_private_key_filepath,
1716                                 ERR_error_string(ERR_get_error(), ssl_err_buf));
1717                         return NULL;
1718                 }
1719                 /* verify private key */
1720                 if (!SSL_CTX_check_private_key(context->ssl_ctx)) {
1721                         lwsl_err("Private SSL key doesn't match cert\n");
1722                         return NULL;
1723                 }
1724
1725                 /* SSL is happy and has a cert it's content with */
1726         }
1727 #endif
1728
1729         /* selftest */
1730
1731         if (lws_b64_selftest())
1732                 return NULL;
1733
1734 #ifndef LWS_NO_SERVER
1735         /* set up our external listening socket we serve on */
1736
1737         if (port) {
1738                 extern int interface_to_sa(const char *ifname, struct sockaddr_in *addr, size_t addrlen);
1739                 int sockfd;
1740
1741                 sockfd = socket(AF_INET, SOCK_STREAM, 0);
1742                 if (sockfd < 0) {
1743                         lwsl_err("ERROR opening socket\n");
1744                         return NULL;
1745                 }
1746
1747                 /* allow us to restart even if old sockets in TIME_WAIT */
1748                 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR,
1749                                               (const void *)&opt, sizeof(opt));
1750
1751                 /* Disable Nagle */
1752                 opt = 1;
1753                 setsockopt(sockfd, IPPROTO_TCP, TCP_NODELAY,
1754                                               (const void *)&opt, sizeof(opt));
1755
1756                 bzero((char *) &serv_addr, sizeof(serv_addr));
1757                 serv_addr.sin_family = AF_INET;
1758                 if (interf == NULL)
1759                         serv_addr.sin_addr.s_addr = INADDR_ANY;
1760                 else
1761                         interface_to_sa(interf, &serv_addr,
1762                                                 sizeof(serv_addr));
1763                 serv_addr.sin_port = htons(port);
1764
1765                 n = bind(sockfd, (struct sockaddr *) &serv_addr,
1766                                                              sizeof(serv_addr));
1767                 if (n < 0) {
1768                         lwsl_err("ERROR on binding to port %d (%d %d)\n",
1769                                                                 port, n, errno);
1770                         close(sockfd);
1771                         return NULL;
1772                 }
1773
1774                 wsi = (struct libwebsocket *)malloc(sizeof(struct libwebsocket));
1775                 if (wsi == NULL) {
1776                         lwsl_err("Out of mem\n");
1777                         close(sockfd);
1778                         return NULL;
1779                 }
1780                 memset(wsi, 0, sizeof (struct libwebsocket));
1781                 wsi->sock = sockfd;
1782                 wsi->count_active_extensions = 0;
1783                 wsi->mode = LWS_CONNMODE_SERVER_LISTENER;
1784
1785                 insert_wsi_socket_into_fds(context, wsi);
1786
1787                 context->listen_service_modulo = LWS_LISTEN_SERVICE_MODULO;
1788                 context->listen_service_count = 0;
1789                 context->listen_service_fd = sockfd;
1790
1791                 listen(sockfd, LWS_SOMAXCONN);
1792                 lwsl_notice(" Listening on port %d\n", port);
1793         }
1794 #endif
1795
1796         /*
1797          * drop any root privs for this process
1798          * to listen on port < 1023 we would have needed root, but now we are
1799          * listening, we don't want the power for anything else
1800          */
1801 #ifdef WIN32
1802 #else
1803         if (gid != -1)
1804                 if (setgid(gid))
1805                         lwsl_warn("setgid: %s\n", strerror(errno));
1806         if (uid != -1)
1807                 if (setuid(uid))
1808                         lwsl_warn("setuid: %s\n", strerror(errno));
1809 #endif
1810
1811         /* set up our internal broadcast trigger sockets per-protocol */
1812
1813         for (context->count_protocols = 0;
1814                         protocols[context->count_protocols].callback;
1815                                                    context->count_protocols++) {
1816
1817                 lwsl_parser("  Protocol: %s\n",
1818                                 protocols[context->count_protocols].name);
1819
1820                 protocols[context->count_protocols].owning_server = context;
1821                 protocols[context->count_protocols].protocol_index =
1822                                                        context->count_protocols;
1823
1824                 fd = socket(AF_INET, SOCK_STREAM, 0);
1825                 if (fd < 0) {
1826                         lwsl_err("ERROR opening socket\n");
1827                         return NULL;
1828                 }
1829
1830                 /* allow us to restart even if old sockets in TIME_WAIT */
1831                 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (const void *)&opt,
1832                                                                   sizeof(opt));
1833
1834                 bzero((char *) &serv_addr, sizeof(serv_addr));
1835                 serv_addr.sin_family = AF_INET;
1836                 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
1837                 serv_addr.sin_port = 0; /* pick the port for us */
1838
1839                 n = bind(fd, (struct sockaddr *) &serv_addr, sizeof(serv_addr));
1840                 if (n < 0) {
1841                         lwsl_err("ERROR on binding to port %d (%d %d)\n",
1842                                                                 port, n, errno);
1843                         return NULL;
1844                 }
1845
1846                 slen = sizeof cli_addr;
1847                 n = getsockname(fd, (struct sockaddr *)&cli_addr, &slen);
1848                 if (n < 0) {
1849                         lwsl_err("getsockname failed\n");
1850                         return NULL;
1851                 }
1852                 protocols[context->count_protocols].broadcast_socket_port =
1853                                                        ntohs(cli_addr.sin_port);
1854                 listen(fd, 5);
1855
1856                 lwsl_debug("  Protocol %s broadcast socket %d\n",
1857                                 protocols[context->count_protocols].name,
1858                                                       ntohs(cli_addr.sin_port));
1859
1860                 /* dummy wsi per broadcast proxy socket */
1861
1862                 wsi = (struct libwebsocket *)malloc(sizeof(struct libwebsocket));
1863                 if (wsi == NULL) {
1864                         lwsl_err("Out of mem\n");
1865                         close(fd);
1866                         return NULL;
1867                 }
1868                 memset(wsi, 0, sizeof (struct libwebsocket));
1869                 wsi->sock = fd;
1870                 wsi->mode = LWS_CONNMODE_BROADCAST_PROXY_LISTENER;
1871                 wsi->count_active_extensions = 0;
1872                 /* note which protocol we are proxying */
1873                 wsi->protocol_index_for_broadcast_proxy =
1874                                                        context->count_protocols;
1875
1876                 insert_wsi_socket_into_fds(context, wsi);
1877         }
1878
1879         /*
1880          * give all extensions a chance to create any per-context
1881          * allocations they need
1882          */
1883
1884         m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_CONSTRUCT;
1885         if (port)
1886                 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_CONSTRUCT;
1887
1888         if (extensions) {
1889             while (extensions->callback) {
1890                     lwsl_ext("  Extension: %s\n", extensions->name);
1891                     extensions->callback(context, extensions, NULL,
1892                         (enum libwebsocket_extension_callback_reasons)m,
1893                                                                 NULL, NULL, 0);
1894                     extensions++;
1895             }
1896         }
1897
1898         return context;
1899 }
1900
1901
1902 #ifndef LWS_NO_FORK
1903
1904 /**
1905  * libwebsockets_fork_service_loop() - Optional helper function forks off
1906  *                                a process for the websocket server loop.
1907  *                              You don't have to use this but if not, you
1908  *                              have to make sure you are calling
1909  *                              libwebsocket_service periodically to service
1910  *                              the websocket traffic
1911  * @context:    server context returned by creation function
1912  */
1913
1914 int
1915 libwebsockets_fork_service_loop(struct libwebsocket_context *context)
1916 {
1917         int fd;
1918         struct sockaddr_in cli_addr;
1919         int n;
1920         int p;
1921
1922         n = fork();
1923         if (n < 0)
1924                 return n;
1925
1926         if (n) {
1927
1928                 /* main process context */
1929
1930                 /*
1931                  * set up the proxy sockets to allow broadcast from
1932                  * service process context
1933                  */
1934
1935                 for (p = 0; p < context->count_protocols; p++) {
1936                         fd = socket(AF_INET, SOCK_STREAM, 0);
1937                         if (fd < 0) {
1938                                 lwsl_err("Unable to create socket\n");
1939                                 return -1;
1940                         }
1941                         cli_addr.sin_family = AF_INET;
1942                         cli_addr.sin_port = htons(
1943                              context->protocols[p].broadcast_socket_port);
1944                         cli_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
1945                         n = connect(fd, (struct sockaddr *)&cli_addr,
1946                                                                sizeof cli_addr);
1947                         if (n < 0) {
1948                                 lwsl_err("Unable to connect to "
1949                                                 "broadcast socket %d, %s\n",
1950                                                 n, strerror(errno));
1951                                 return -1;
1952                         }
1953
1954                         context->protocols[p].broadcast_socket_user_fd = fd;
1955                 }
1956
1957                 return 0;
1958         }
1959
1960 #ifdef HAVE_SYS_PRCTL_H
1961         /* we want a SIGHUP when our parent goes down */
1962         signal(SIGHUP, SIG_DFL);
1963         prctl(PR_SET_PDEATHSIG, SIGHUP);
1964 #endif
1965
1966         /* in this forked process, sit and service websocket connections */
1967
1968         while (1) {
1969                 if (libwebsocket_service(context, 1000))
1970                         break;
1971 //#ifndef HAVE_SYS_PRCTL_H
1972 /*
1973  * on systems without prctl() (i.e. anything but linux) we can notice that our
1974  * parent is dead if getppid() returns 1. FIXME apparently this is not true for
1975  * solaris, could remember ppid right after fork and wait for it to change.
1976  */
1977
1978         if (getppid() == 1)
1979             break;
1980 //#endif
1981     }
1982
1983
1984         return 1;
1985 }
1986
1987 #endif
1988
1989 /**
1990  * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
1991  *                                connection.
1992  * @wsi:        pointer to struct websocket you want to know the protocol of
1993  *
1994  *
1995  *      This is useful to get the protocol to broadcast back to from inside
1996  * the callback.
1997  */
1998
1999 const struct libwebsocket_protocols *
2000 libwebsockets_get_protocol(struct libwebsocket *wsi)
2001 {
2002         return wsi->protocol;
2003 }
2004
2005 /**
2006  * libwebsockets_broadcast() - Sends a buffer to the callback for all active
2007  *                                connections of the given protocol.
2008  * @protocol:   pointer to the protocol you will broadcast to all members of
2009  * @buf:  buffer containing the data to be broadcase.  NOTE: this has to be
2010  *              allocated with LWS_SEND_BUFFER_PRE_PADDING valid bytes before
2011  *              the pointer and LWS_SEND_BUFFER_POST_PADDING afterwards in the
2012  *              case you are calling this function from callback context.
2013  * @len:        length of payload data in buf, starting from buf.
2014  *
2015  *      This function allows bulk sending of a packet to every connection using
2016  * the given protocol.  It does not send the data directly; instead it calls
2017  * the callback with a reason type of LWS_CALLBACK_BROADCAST.  If the callback
2018  * wants to actually send the data for that connection, the callback itself
2019  * should call libwebsocket_write().
2020  *
2021  * libwebsockets_broadcast() can be called from another fork context without
2022  * having to take any care about data visibility between the processes, it'll
2023  * "just work".
2024  */
2025
2026
2027 int
2028 libwebsockets_broadcast(const struct libwebsocket_protocols *protocol,
2029                                                  unsigned char *buf, size_t len)
2030 {
2031         struct libwebsocket_context *context = protocol->owning_server;
2032         int n;
2033         struct libwebsocket *wsi;
2034
2035         if (!protocol->broadcast_socket_user_fd) {
2036                 /*
2037                  * We are either running unforked / flat, or we are being
2038                  * called from poll thread context
2039                  * eg, from a callback.  In that case don't use sockets for
2040                  * broadcast IPC (since we can't open a socket connection to
2041                  * a socket listening on our own thread) but directly do the
2042                  * send action.
2043                  *
2044                  * Locking is not needed because we are by definition being
2045                  * called in the poll thread context and are serialized.
2046                  */
2047
2048                 for (n = 0; n < context->fds_count; n++) {
2049
2050                         wsi = context->lws_lookup[context->fds[n].fd];
2051                         if (!wsi)
2052                                 continue;
2053
2054                         if (wsi->mode != LWS_CONNMODE_WS_SERVING)
2055                                 continue;
2056
2057                         /*
2058                          * never broadcast to non-established connections
2059                          */
2060                         if (wsi->state != WSI_STATE_ESTABLISHED)
2061                                 continue;
2062
2063                         /* only broadcast to guys using
2064                          * requested protocol
2065                          */
2066                         if (wsi->protocol != protocol)
2067                                 continue;
2068
2069                         user_callback_handle_rxflow(wsi->protocol->callback,
2070                                  context, wsi,
2071                                  LWS_CALLBACK_BROADCAST,
2072                                  wsi->user_space,
2073                                  buf, len);
2074                 }
2075
2076                 return 0;
2077         }
2078
2079         /*
2080          * We're being called from a different process context than the server
2081          * loop.  Instead of broadcasting directly, we send our
2082          * payload on a socket to do the IPC; the server process will serialize
2083          * the broadcast action in its main poll() loop.
2084          *
2085          * There's one broadcast socket listening for each protocol supported
2086          * set up when the websocket server initializes
2087          */
2088
2089         n = send(protocol->broadcast_socket_user_fd, buf, len, MSG_NOSIGNAL);
2090
2091         return n;
2092 }
2093
2094 int
2095 libwebsocket_is_final_fragment(struct libwebsocket *wsi)
2096 {
2097         return wsi->final;
2098 }
2099
2100 unsigned char
2101 libwebsocket_get_reserved_bits(struct libwebsocket *wsi)
2102 {
2103         return wsi->rsv;
2104 }
2105
2106 void *
2107 libwebsocket_ensure_user_space(struct libwebsocket *wsi)
2108 {
2109         /* allocate the per-connection user memory (if any) */
2110
2111         if (wsi->protocol->per_session_data_size && !wsi->user_space) {
2112                 wsi->user_space = malloc(
2113                                   wsi->protocol->per_session_data_size);
2114                 if (wsi->user_space  == NULL) {
2115                         lwsl_err("Out of memory for conn user space\n");
2116                         return NULL;
2117                 }
2118                 memset(wsi->user_space, 0,
2119                                          wsi->protocol->per_session_data_size);
2120         }
2121         return wsi->user_space;
2122 }
2123
2124 /**
2125  * lws_confirm_legit_wsi: returns nonzero if the wsi looks bad
2126  *
2127  * @wsi: struct libwebsocket to assess
2128  *
2129  * Performs consistecy checks on what the wsi claims and what the
2130  * polling arrays hold.  This'll catch a closed wsi still in use.
2131  * Don't try to use on the listen (nonconnection) wsi as it will
2132  * fail it.  Otherwise 0 return == wsi seems consistent.
2133  */
2134
2135 int lws_confirm_legit_wsi(struct libwebsocket *wsi)
2136 {
2137         struct libwebsocket_context *context;
2138
2139         if (!(wsi && wsi->protocol && wsi->protocol->owning_server))
2140                 return 1;
2141
2142         context = wsi->protocol->owning_server;
2143
2144         if (!context)
2145                 return 2;
2146
2147         if (!wsi->position_in_fds_table)
2148                 return 3; /* position in fds table looks bad */
2149         if (context->fds[wsi->position_in_fds_table].fd != wsi->sock)
2150                 return 4; /* pollfd entry does not wait on our socket descriptor */
2151         if (context->lws_lookup[wsi->sock] != wsi)
2152                 return 5; /* lookup table does not agree with wsi */
2153
2154         return 0;
2155 }
2156
2157 static void lwsl_emit_stderr(int level, const char *line)
2158 {
2159         char buf[300];
2160         struct timeval tv;
2161         int n;
2162
2163         gettimeofday(&tv, NULL);
2164
2165         buf[0] = '\0';
2166         for (n = 0; n < LLL_COUNT; n++)
2167                 if (level == (1 << n)) {
2168                         sprintf(buf, "[%ld:%04d] %s: ", tv.tv_sec,
2169                                         (int)(tv.tv_usec / 100), log_level_names[n]);
2170                         break;
2171                 }
2172
2173         fprintf(stderr, "%s%s", buf, line);
2174 }
2175
2176 void lwsl_emit_syslog(int level, const char *line)
2177 {
2178         int syslog_level = LOG_DEBUG;
2179
2180         switch (level) {
2181         case LLL_ERR:
2182                 syslog_level = LOG_ERR;
2183                 break;
2184         case LLL_WARN:
2185                 syslog_level = LOG_WARNING;
2186                 break;
2187         case LLL_NOTICE:
2188                 syslog_level = LOG_NOTICE;
2189                 break;
2190         case LLL_INFO:
2191                 syslog_level = LOG_INFO;
2192                 break;
2193         }
2194         syslog(syslog_level, line);
2195 }
2196
2197 void _lws_log(int filter, const char *format, ...)
2198 {
2199         char buf[256];
2200         va_list ap;
2201
2202         if (!(log_level & filter))
2203                 return;
2204
2205         va_start(ap, format);
2206         vsnprintf(buf, (sizeof buf), format, ap);
2207         buf[(sizeof buf) - 1] = '\0';
2208         va_end(ap);
2209
2210         lwsl_emit(filter, buf);
2211 }
2212
2213 /**
2214  * lws_set_log_level() - Set the logging bitfield
2215  * @level:      OR together the LLL_ debug contexts you want output from
2216  * @log_emit_function:  NULL to leave it as it is, or a user-supplied
2217  *                      function to perform log string emission instead of
2218  *                      the default stderr one.
2219  *
2220  *      log level defaults to "err" and "warn" contexts enabled only and
2221  *      emission on stderr.
2222  */
2223
2224 void lws_set_log_level(int level, void (*log_emit_function)(int level, const char *line))
2225 {
2226         log_level = level;
2227         if (log_emit_function)
2228                 lwsl_emit = log_emit_function;
2229 }