lib/private-libwebsockets.h

   1 /*
   2  * libwebsockets - small server side websockets and web server implementation
   3  *
   4  * Copyright (C) 2010 - 2016 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 "lws_config.h"
  23 #include "lws_config_private.h"
  24
  25
  26 #if defined(LWS_WITH_CGI) && defined(LWS_HAVE_VFORK)
  27 #define  _GNU_SOURCE
  28 #endif
  29
  30 #ifdef LWS_HAVE_SYS_TYPES_H
  31 #include <sys/types.h>
  32 #endif
  33
  34 #include <stdio.h>
  35 #include <stdlib.h>
  36 #include <string.h>
  37 #include <time.h>
  38 #include <ctype.h>
  39 #include <limits.h>
  40 #include <stdarg.h>
  41 #include <assert.h>
  42 #if LWS_MAX_SMP > 1
  43 #include <pthread.h>
  44 #endif
  45
  46 #ifdef LWS_HAVE_SYS_STAT_H
  47 #include <sys/stat.h>
  48 #endif
  49
  50 #if defined(WIN32) || defined(_WIN32)
  51 #if (WINVER < 0x0501)
  52 #undef WINVER
  53 #undef _WIN32_WINNT
  54 #define WINVER 0x0501
  55 #define _WIN32_WINNT WINVER
  56 #endif
  57 #define LWS_NO_DAEMONIZE
  58 #define LWS_ERRNO WSAGetLastError()
  59 #define LWS_EAGAIN WSAEWOULDBLOCK
  60 #define LWS_EALREADY WSAEALREADY
  61 #define LWS_EINPROGRESS WSAEINPROGRESS
  62 #define LWS_EINTR WSAEINTR
  63 #define LWS_EISCONN WSAEISCONN
  64 #define LWS_EWOULDBLOCK WSAEWOULDBLOCK
  65 #define LWS_POLLHUP (FD_CLOSE)
  66 #define LWS_POLLIN (FD_READ | FD_ACCEPT)
  67 #define LWS_POLLOUT (FD_WRITE)
  68 #define MSG_NOSIGNAL 0
  69 #define SHUT_RDWR SD_BOTH
  70 #define SOL_TCP IPPROTO_TCP
  71 #define SHUT_WR SD_SEND
  72
  73 #define compatible_close(fd) closesocket(fd)
  74 #define lws_set_blocking_send(wsi) wsi->sock_send_blocking = 1
  75 #define lws_socket_is_valid(x) (!!x)
  76 #define LWS_SOCK_INVALID 0
  77 #include <winsock2.h>
  78 #include <ws2tcpip.h>
  79 #include <windows.h>
  80 #include <tchar.h>
  81 #ifdef LWS_HAVE_IN6ADDR_H
  82 #include <in6addr.h>
  83 #endif
  84 #include <mstcpip.h>
  85
  86 #ifndef __func__
  87 #define __func__ __FUNCTION__
  88 #endif
  89
  90 #ifdef _WIN32_WCE
  91 #define vsnprintf _vsnprintf
  92 #else
  93 #ifdef LWS_HAVE__VSNPRINTF
  94 #define vsnprintf _vsnprintf
  95 #endif
  96 #endif
  97
  98 #ifdef LWS_HAVE__SNPRINTF
  99 #define snprintf _snprintf
 100 #endif
 101
 102 #else /* not windows --> */
 103
 104 #include <fcntl.h>
 105 #include <strings.h>
 106 #include <unistd.h>
 107 #include <sys/types.h>
 108 #ifndef MBED_OPERATORS
 109 #ifndef __cplusplus
 110 #include <errno.h>
 111 #endif
 112 #include <netdb.h>
 113 #include <signal.h>
 114 #include <sys/socket.h>
 115 #ifdef LWS_WITH_HTTP_PROXY
 116 #include <hubbub/hubbub.h>
 117 #include <hubbub/parser.h>
 118 #endif
 119 #ifdef LWS_BUILTIN_GETIFADDRS
 120  #include <getifaddrs.h>
 121 #else
 122  #include <ifaddrs.h>
 123 #endif
 124 #if defined (__ANDROID__)
 125 #include <syslog.h>
 126 #else
 127 #include <sys/syslog.h>
 128 #endif
 129 #include <sys/un.h>
 130 #include <sys/socket.h>
 131 #include <netdb.h>
 132 #include <netinet/in.h>
 133 #include <netinet/tcp.h>
 134 #include <arpa/inet.h>
 135 #include <poll.h>
 136 #ifdef LWS_USE_LIBEV
 137 #include <ev.h>
 138 #endif
 139 #ifdef LWS_USE_LIBUV
 140 #include <uv.h>
 141 #endif
 142 #include <sys/mman.h>
 143
 144 #endif /* MBED */
 145
 146 #ifndef LWS_NO_FORK
 147 #ifdef LWS_HAVE_SYS_PRCTL_H
 148 #include <sys/prctl.h>
 149 #endif
 150 #endif
 151
 152 #include <sys/time.h>
 153
 154 #define LWS_ERRNO errno
 155 #define LWS_EAGAIN EAGAIN
 156 #define LWS_EALREADY EALREADY
 157 #define LWS_EINPROGRESS EINPROGRESS
 158 #define LWS_EINTR EINTR
 159 #define LWS_EISCONN EISCONN
 160 #define LWS_EWOULDBLOCK EWOULDBLOCK
 161 #define LWS_POLLHUP (POLLHUP|POLLERR)
 162 #define LWS_POLLIN (POLLIN)
 163 #define LWS_POLLOUT (POLLOUT)
 164 static inline int compatible_close(int fd) { return close(fd); }
 165 #define lws_set_blocking_send(wsi)
 166
 167 #ifdef MBED_OPERATORS
 168 #define lws_socket_is_valid(x) ((x) != NULL)
 169 #define LWS_SOCK_INVALID (NULL)
 170 #else
 171 #define lws_socket_is_valid(x) (x >= 0)
 172 #define LWS_SOCK_INVALID (-1)
 173 #endif
 174 #endif
 175
 176 #ifndef LWS_HAVE_BZERO
 177 #ifndef bzero
 178 #define bzero(b, len) (memset((b), '\0', (len)), (void) 0)
 179 #endif
 180 #endif
 181
 182 #ifndef LWS_HAVE_STRERROR
 183 #define strerror(x) ""
 184 #endif
 185
 186 #ifdef LWS_OPENSSL_SUPPORT
 187
 188 #ifdef USE_WOLFSSL
 189 #ifdef USE_OLD_CYASSL
 190 #include <cyassl/openssl/ssl.h>
 191 #include <cyassl/error-ssl.h>
 192 #else
 193 #include <wolfssl/openssl/ssl.h>
 194 #include <wolfssl/error-ssl.h>
 195 #endif /* not USE_OLD_CYASSL */
 196 #else
 197 #if defined(LWS_USE_POLARSSL)
 198 #include <polarssl/ssl.h>
 199 #include <polarssl/error.h>
 200 #include <polarssl/md5.h>
 201 #include <polarssl/sha1.h>
 202 #include <polarssl/ecdh.h>
 203 #else
 204 #if defined(LWS_USE_MBEDTLS)
 205 #include <mbedtls/ssl.h>
 206 #include <mbedtls/error.h>
 207 #include <mbedtls/md5.h>
 208 #include <mbedtls/sha1.h>
 209 #include <mbedtls/ecdh.h>
 210 #else
 211 #include <openssl/ssl.h>
 212 #include <openssl/evp.h>
 213 #include <openssl/err.h>
 214 #include <openssl/md5.h>
 215 #include <openssl/sha.h>
 216 #ifdef LWS_HAVE_OPENSSL_ECDH_H
 217 #include <openssl/ecdh.h>
 218 #endif
 219 #endif /* not USE_MBEDTLS */
 220 #endif /* not USE_POLARSSL */
 221 #endif /* not USE_WOLFSSL */
 222 #endif
 223
 224 #include "libwebsockets.h"
 225
 226 #if defined(MBED_OPERATORS)
 227 #undef compatible_close
 228 #define compatible_close(fd) mbed3_delete_tcp_stream_socket(fd)
 229 #ifndef BIG_ENDIAN
 230 #define BIG_ENDIAN    4321  /* to show byte order (taken from gcc) */
 231 #endif
 232 #ifndef LITTLE_ENDIAN
 233 #define LITTLE_ENDIAN 1234
 234 #endif
 235 #ifndef BYTE_ORDER
 236 #define BYTE_ORDER LITTLE_ENDIAN
 237 #endif
 238 #endif
 239
 240 #if defined(WIN32) || defined(_WIN32)
 241
 242 #ifndef BIG_ENDIAN
 243 #define BIG_ENDIAN    4321  /* to show byte order (taken from gcc) */
 244 #endif
 245 #ifndef LITTLE_ENDIAN
 246 #define LITTLE_ENDIAN 1234
 247 #endif
 248 #ifndef BYTE_ORDER
 249 #define BYTE_ORDER LITTLE_ENDIAN
 250 #endif
 251 #ifndef u_int64_t
 252 typedef unsigned __int64 u_int64_t;
 253 #endif
 254
 255 #undef __P
 256 #ifndef __P
 257 #if __STDC__
 258 #define __P(protos) protos
 259 #else
 260 #define __P(protos) ()
 261 #endif
 262 #endif
 263
 264 #else
 265
 266 #include <sys/stat.h>
 267 #include <sys/time.h>
 268
 269 #if defined(__APPLE__)
 270 #include <machine/endian.h>
 271 #elif defined(__FreeBSD__)
 272 #include <sys/endian.h>
 273 #elif defined(__linux__)
 274 #include <endian.h>
 275 #endif
 276
 277 #ifdef __cplusplus
 278 extern "C" {
 279 #endif
 280
 281 #if defined(__QNX__)
 282         #include <gulliver.h>
 283         #if defined(__LITTLEENDIAN__)
 284                 #define BYTE_ORDER __LITTLEENDIAN__
 285                 #define LITTLE_ENDIAN __LITTLEENDIAN__
 286                 #define BIG_ENDIAN 4321  /* to show byte order (taken from gcc); for suppres warning that BIG_ENDIAN is not defined. */
 287         #endif
 288         #if defined(__BIGENDIAN__)
 289                 #define BYTE_ORDER __BIGENDIAN__
 290                 #define LITTLE_ENDIAN 1234  /* to show byte order (taken from gcc); for suppres warning that LITTLE_ENDIAN is not defined. */
 291                 #define BIG_ENDIAN __BIGENDIAN__
 292         #endif
 293 #endif
 294
 295 #if !defined(BYTE_ORDER)
 296 # define BYTE_ORDER __BYTE_ORDER
 297 #endif
 298 #if !defined(LITTLE_ENDIAN)
 299 # define LITTLE_ENDIAN __LITTLE_ENDIAN
 300 #endif
 301 #if !defined(BIG_ENDIAN)
 302 # define BIG_ENDIAN __BIG_ENDIAN
 303 #endif
 304
 305 #endif
 306
 307 /*
 308  * Mac OSX as well as iOS do not define the MSG_NOSIGNAL flag,
 309  * but happily have something equivalent in the SO_NOSIGPIPE flag.
 310  */
 311 #ifdef __APPLE__
 312 #define MSG_NOSIGNAL SO_NOSIGPIPE
 313 #endif
 314
 315 #ifdef _WIN32
 316 #ifndef FD_HASHTABLE_MODULUS
 317 #define FD_HASHTABLE_MODULUS 32
 318 #endif
 319 #endif
 320
 321 #ifndef LWS_DEF_HEADER_LEN
 322 #define LWS_DEF_HEADER_LEN 1024
 323 #endif
 324 #ifndef LWS_DEF_HEADER_POOL
 325 #define LWS_DEF_HEADER_POOL 16
 326 #endif
 327 #ifndef LWS_MAX_PROTOCOLS
 328 #define LWS_MAX_PROTOCOLS 5
 329 #endif
 330 #ifndef LWS_MAX_EXTENSIONS_ACTIVE
 331 #define LWS_MAX_EXTENSIONS_ACTIVE 2
 332 #endif
 333 #ifndef LWS_MAX_EXT_OFFERS
 334 #define LWS_MAX_EXT_OFFERS 8
 335 #endif
 336 #ifndef SPEC_LATEST_SUPPORTED
 337 #define SPEC_LATEST_SUPPORTED 13
 338 #endif
 339 #ifndef AWAITING_TIMEOUT
 340 #define AWAITING_TIMEOUT 20
 341 #endif
 342 #ifndef CIPHERS_LIST_STRING
 343 #define CIPHERS_LIST_STRING "DEFAULT"
 344 #endif
 345 #ifndef LWS_SOMAXCONN
 346 #define LWS_SOMAXCONN SOMAXCONN
 347 #endif
 348
 349 #define MAX_WEBSOCKET_04_KEY_LEN 128
 350 #define LWS_MAX_SOCKET_IO_BUF 4096
 351
 352 #ifndef SYSTEM_RANDOM_FILEPATH
 353 #define SYSTEM_RANDOM_FILEPATH "/dev/urandom"
 354 #endif
 355
 356 enum lws_websocket_opcodes_07 {
 357         LWSWSOPC_CONTINUATION = 0,
 358         LWSWSOPC_TEXT_FRAME = 1,
 359         LWSWSOPC_BINARY_FRAME = 2,
 360
 361         LWSWSOPC_NOSPEC__MUX = 7,
 362
 363         /* control extensions 8+ */
 364
 365         LWSWSOPC_CLOSE = 8,
 366         LWSWSOPC_PING = 9,
 367         LWSWSOPC_PONG = 0xa,
 368 };
 369
 370
 371 enum lws_connection_states {
 372         LWSS_HTTP,
 373         LWSS_HTTP_ISSUING_FILE,
 374         LWSS_HTTP_HEADERS,
 375         LWSS_HTTP_BODY,
 376         LWSS_DEAD_SOCKET,
 377         LWSS_ESTABLISHED,
 378         LWSS_CLIENT_HTTP_ESTABLISHED,
 379         LWSS_CLIENT_UNCONNECTED,
 380         LWSS_RETURNED_CLOSE_ALREADY,
 381         LWSS_AWAITING_CLOSE_ACK,
 382         LWSS_FLUSHING_STORED_SEND_BEFORE_CLOSE,
 383         LWSS_SHUTDOWN,
 384
 385         LWSS_HTTP2_AWAIT_CLIENT_PREFACE,
 386         LWSS_HTTP2_ESTABLISHED_PRE_SETTINGS,
 387         LWSS_HTTP2_ESTABLISHED,
 388
 389         LWSS_CGI,
 390 };
 391
 392 enum http_version {
 393         HTTP_VERSION_1_0,
 394         HTTP_VERSION_1_1,
 395 };
 396
 397 enum http_connection_type {
 398         HTTP_CONNECTION_CLOSE,
 399         HTTP_CONNECTION_KEEP_ALIVE
 400 };
 401
 402 enum lws_pending_protocol_send {
 403         LWS_PPS_NONE,
 404         LWS_PPS_HTTP2_MY_SETTINGS,
 405         LWS_PPS_HTTP2_ACK_SETTINGS,
 406         LWS_PPS_HTTP2_PONG,
 407 };
 408
 409 enum lws_rx_parse_state {
 410         LWS_RXPS_NEW,
 411
 412         LWS_RXPS_04_mask_1,
 413         LWS_RXPS_04_mask_2,
 414         LWS_RXPS_04_mask_3,
 415
 416         LWS_RXPS_04_FRAME_HDR_1,
 417         LWS_RXPS_04_FRAME_HDR_LEN,
 418         LWS_RXPS_04_FRAME_HDR_LEN16_2,
 419         LWS_RXPS_04_FRAME_HDR_LEN16_1,
 420         LWS_RXPS_04_FRAME_HDR_LEN64_8,
 421         LWS_RXPS_04_FRAME_HDR_LEN64_7,
 422         LWS_RXPS_04_FRAME_HDR_LEN64_6,
 423         LWS_RXPS_04_FRAME_HDR_LEN64_5,
 424         LWS_RXPS_04_FRAME_HDR_LEN64_4,
 425         LWS_RXPS_04_FRAME_HDR_LEN64_3,
 426         LWS_RXPS_04_FRAME_HDR_LEN64_2,
 427         LWS_RXPS_04_FRAME_HDR_LEN64_1,
 428
 429         LWS_RXPS_07_COLLECT_FRAME_KEY_1,
 430         LWS_RXPS_07_COLLECT_FRAME_KEY_2,
 431         LWS_RXPS_07_COLLECT_FRAME_KEY_3,
 432         LWS_RXPS_07_COLLECT_FRAME_KEY_4,
 433
 434         LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED
 435 };
 436
 437
 438 enum connection_mode {
 439         LWSCM_HTTP_SERVING,
 440         LWSCM_HTTP_CLIENT, /* we are client to someone else's server */
 441         LWSCM_HTTP_SERVING_ACCEPTED, /* actual HTTP service going on */
 442         LWSCM_HTTP_CLIENT_ACCEPTED, /* actual HTTP service going on */
 443         LWSCM_PRE_WS_SERVING_ACCEPT,
 444
 445         LWSCM_WS_SERVING,
 446         LWSCM_WS_CLIENT,
 447
 448         LWSCM_HTTP2_SERVING,
 449
 450         /* transient, ssl delay hiding */
 451         LWSCM_SSL_ACK_PENDING,
 452         LWSCM_SSL_INIT,
 453
 454         /* transient modes */
 455         LWSCM_WSCL_WAITING_CONNECT,
 456         LWSCM_WSCL_WAITING_PROXY_REPLY,
 457         LWSCM_WSCL_ISSUE_HANDSHAKE,
 458         LWSCM_WSCL_ISSUE_HANDSHAKE2,
 459         LWSCM_WSCL_WAITING_SSL,
 460         LWSCM_WSCL_WAITING_SERVER_REPLY,
 461         LWSCM_WSCL_WAITING_EXTENSION_CONNECT,
 462         LWSCM_WSCL_PENDING_CANDIDATE_CHILD,
 463
 464         /* special internal types */
 465         LWSCM_SERVER_LISTENER,
 466         LWSCM_CGI, /* stdin, stdout, stderr for another cgi master wsi */
 467 };
 468
 469 enum {
 470         LWS_RXFLOW_ALLOW = (1 << 0),
 471         LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
 472 };
 473
 474 /* this is not usable directly by user code any more, lws_close_reason() */
 475 #define LWS_WRITE_CLOSE 4
 476
 477 struct lws_protocols;
 478 struct lws;
 479
 480 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
 481
 482 struct lws_io_watcher {
 483 #ifdef LWS_USE_LIBEV
 484         ev_io ev_watcher;
 485 #endif
 486 #ifdef LWS_USE_LIBUV
 487         uv_poll_t uv_watcher;
 488 #endif
 489         struct lws_context *context;
 490 };
 491
 492 struct lws_signal_watcher {
 493 #ifdef LWS_USE_LIBEV
 494         ev_signal ev_watcher;
 495 #endif
 496 #ifdef LWS_USE_LIBUV
 497         uv_signal_t uv_watcher;
 498 #endif
 499         struct lws_context *context;
 500 };
 501 #endif
 502
 503 #ifdef _WIN32
 504 #define LWS_FD_HASH(fd) ((fd ^ (fd >> 8) ^ (fd >> 16)) % FD_HASHTABLE_MODULUS)
 505 struct lws_fd_hashtable {
 506         struct lws **wsi;
 507         int length;
 508 };
 509 #endif
 510
 511 /*
 512  * This is totally opaque to code using the library.  It's exported as a
 513  * forward-reference pointer-only declaration; the user can use the pointer with
 514  * other APIs to get information out of it.
 515  */
 516
 517 struct lws_fragments {
 518         unsigned short offset;
 519         unsigned short len;
 520         unsigned char nfrag; /* which ah->frag[] continues this content, or 0 */
 521 };
 522
 523 /*
 524  * these are assigned from a pool held in the context.
 525  * Both client and server mode uses them for http header analysis
 526  */
 527
 528 struct allocated_headers {
 529         struct lws *wsi; /* owner */
 530         char *data; /* prepared by context init to point to dedicated storage */
 531         /*
 532          * the randomly ordered fragments, indexed by frag_index and
 533          * lws_fragments->nfrag for continuation.
 534          */
 535         struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
 536         time_t assigned;
 537         /*
 538          * for each recognized token, frag_index says which frag[] his data
 539          * starts in (0 means the token did not appear)
 540          * the actual header data gets dumped as it comes in, into data[]
 541          */
 542         unsigned char frag_index[WSI_TOKEN_COUNT];
 543         unsigned char rx[2048];
 544         unsigned int rxpos;
 545         unsigned int rxlen;
 546
 547 #ifndef LWS_NO_CLIENT
 548         char initial_handshake_hash_base64[30];
 549 #endif
 550
 551         unsigned short pos;
 552         unsigned char in_use;
 553         unsigned char nfrag;
 554 };
 555
 556 /*
 557  * so we can have n connections being serviced simultaneously,
 558  * these things need to be isolated per-thread.
 559  */
 560
 561 struct lws_context_per_thread {
 562 #if LWS_MAX_SMP > 1
 563         pthread_mutex_t lock;
 564 #endif
 565         struct lws_pollfd *fds;
 566         struct lws *rx_draining_ext_list;
 567         struct lws *tx_draining_ext_list;
 568         struct lws *timeout_list;
 569         struct lws_context *context;
 570 #ifdef LWS_WITH_CGI
 571         struct lws_cgi *cgi_list;
 572 #endif
 573         void *http_header_data;
 574         struct allocated_headers *ah_pool;
 575         struct lws *ah_wait_list;
 576         int ah_wait_list_length;
 577 #ifdef LWS_OPENSSL_SUPPORT
 578         struct lws *pending_read_list; /* linked list */
 579 #endif
 580 #ifndef LWS_NO_SERVER
 581         struct lws *wsi_listening;
 582 #endif
 583 #if defined(LWS_USE_LIBEV)
 584         struct ev_loop *io_loop_ev;
 585 #endif
 586 #if defined(LWS_USE_LIBUV)
 587         uv_loop_t *io_loop_uv;
 588         uv_signal_t signals[8];
 589         uv_timer_t uv_timeout_watcher;
 590         uv_idle_t uv_idle;
 591 #endif
 592 #if defined(LWS_USE_LIBEV)
 593         struct lws_io_watcher w_accept;
 594 #endif
 595 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
 596         struct lws_signal_watcher w_sigint;
 597         unsigned char ev_loop_foreign:1;
 598 #endif
 599
 600         unsigned long count_conns;
 601         /*
 602          * usable by anything in the service code, but only if the scope
 603          * does not last longer than the service action (since next service
 604          * of any socket can likewise use it and overwrite)
 605          */
 606         unsigned char *serv_buf;
 607 #ifdef _WIN32
 608         WSAEVENT *events;
 609 #else
 610         int dummy_pipe_fds[2];
 611 #endif
 612         unsigned int fds_count;
 613
 614         short ah_count_in_use;
 615         unsigned char tid;
 616 };
 617
 618 struct lws_http_mount {
 619         struct lws_http_mount *mount_next;
 620         const char *mountpoint; /* mountpoint in http pathspace, eg, "/" */
 621         const char *origin; /* path to be mounted, eg, "/var/www/warmcat.com" */
 622         const char *def; /* default target, eg, "index.html" */
 623
 624         unsigned char origin_protocol;
 625         unsigned char mountpoint_len;
 626 };
 627
 628 /*
 629  * virtual host -related context information
 630  *   vhostwide SSL context
 631  *   vhostwide proxy
 632  *
 633  * heirarchy:
 634  *
 635  * context -> vhost -> wsi
 636  *
 637  * incoming connection non-SSL vhost binding:
 638  *
 639  *    listen socket -> wsi -> select vhost after first headers
 640  *
 641  * incoming connection SSL vhost binding:
 642  *
 643  *    SSL SNI -> wsi -> bind after SSL negotiation
 644  */
 645
 646 struct lws_vhost {
 647         char http_proxy_address[128];
 648         char proxy_basic_auth_token[128];
 649         struct lws_context *context;
 650         struct lws_vhost *vhost_next;
 651         struct lws_http_mount *mount_list;
 652         struct lws *lserv_wsi;
 653         const char *name;
 654         const char *iface;
 655         const struct lws_protocols *protocols;
 656         void **protocol_vh_privs;
 657         struct lws_protocol_vhost_options *pvo;
 658 #ifdef LWS_OPENSSL_SUPPORT
 659         SSL_CTX *ssl_ctx;
 660         SSL_CTX *ssl_client_ctx;
 661 #endif
 662 #ifndef LWS_NO_EXTENSIONS
 663         const struct lws_extension *extensions;
 664 #endif
 665
 666         int listen_port;
 667         unsigned int http_proxy_port;
 668         int count_protocols;
 669         int ka_time;
 670         int ka_probes;
 671         int ka_interval;
 672
 673 #ifdef LWS_OPENSSL_SUPPORT
 674         int use_ssl;
 675         int allow_non_ssl_on_ssl_port;
 676         unsigned int user_supplied_ssl_ctx:1;
 677 #endif
 678 };
 679
 680 /*
 681  * the rest is managed per-context, that includes
 682  *
 683  *  - processwide single fd -> wsi lookup
 684  *  - contextwide headers pool
 685  */
 686
 687 struct lws_context {
 688         time_t last_timeout_check_s;
 689         struct lws_plat_file_ops fops;
 690         struct lws_context_per_thread pt[LWS_MAX_SMP];
 691 #ifdef _WIN32
 692 /* different implementation between unix and windows */
 693         struct lws_fd_hashtable fd_hashtable[FD_HASHTABLE_MODULUS];
 694 #else
 695         struct lws **lws_lookup;  /* fd to wsi */
 696 #endif
 697         struct lws_vhost *vhost_list;
 698         struct lws_plugin *plugin_list;
 699         const struct lws_token_limits *token_limits;
 700         void *user_space;
 701
 702 #if defined(LWS_USE_LIBEV)
 703         lws_ev_signal_cb_t * lws_ev_sigint_cb;
 704 #endif
 705 #if defined(LWS_USE_LIBUV)
 706         uv_signal_cb lws_uv_sigint_cb;
 707 #endif
 708         char canonical_hostname[128];
 709 #ifdef LWS_LATENCY
 710         unsigned long worst_latency;
 711         char worst_latency_info[256];
 712 #endif
 713
 714         int max_fds;
 715 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
 716         int use_ev_sigint;
 717 #endif
 718         int started_with_parent;
 719         int uid, gid;
 720
 721         int fd_random;
 722 #ifdef LWS_OPENSSL_SUPPORT
 723 #define lws_ssl_anybody_has_buffered_read(w) \
 724                 (w->vhost->use_ssl && \
 725                  w->context->pt[(int)w->tsi].pending_read_list)
 726 #define lws_ssl_anybody_has_buffered_read_tsi(c, t) \
 727                 (/*c->use_ssl && */ \
 728                  c->pt[(int)t].pending_read_list)
 729 #else
 730 #define lws_ssl_anybody_has_buffered_read(ctx) (0)
 731 #define lws_ssl_anybody_has_buffered_read_tsi(ctx, t) (0)
 732 #endif
 733         int count_wsi_allocated;
 734         unsigned int options;
 735         unsigned int fd_limit_per_thread;
 736         unsigned int timeout_secs;
 737
 738         /*
 739          * set to the Thread ID that's doing the service loop just before entry
 740          * to poll indicates service thread likely idling in poll()
 741          * volatile because other threads may check it as part of processing
 742          * for pollfd event change.
 743          */
 744         volatile int service_tid;
 745         int service_tid_detected;
 746
 747         short max_http_header_data;
 748         short max_http_header_pool;
 749         short count_threads;
 750         short plugin_protocol_count;
 751         short plugin_extension_count;
 752
 753         unsigned int being_destroyed:1;
 754         unsigned int requested_kill:1;
 755         unsigned int protocol_init_done:1;
 756 };
 757
 758 #define lws_get_context_protocol(ctx, x) ctx->vhost_list->protocols[x]
 759 #define lws_get_vh_protocol(vh, x) vh->protocols[x]
 760
 761 LWS_EXTERN void
 762 lws_close_free_wsi_final(struct lws *wsi);
 763 LWS_EXTERN void
 764 lws_libuv_closehandle(struct lws *wsi);
 765
 766 LWS_VISIBLE LWS_EXTERN int
 767 lws_plat_plugins_init(struct lws_context * context, const char *d);
 768
 769 LWS_VISIBLE LWS_EXTERN int
 770 lws_plat_plugins_destroy(struct lws_context * context);
 771
 772 enum {
 773         LWS_EV_READ = (1 << 0),
 774         LWS_EV_WRITE = (1 << 1),
 775         LWS_EV_START = (1 << 2),
 776         LWS_EV_STOP = (1 << 3),
 777
 778         LWS_EV_PREPARE_DELETION = (1 << 31),
 779 };
 780
 781 #if defined(LWS_USE_LIBEV)
 782 LWS_EXTERN void
 783 lws_libev_accept(struct lws *new_wsi, lws_sockfd_type accept_fd);
 784 LWS_EXTERN void
 785 lws_libev_io(struct lws *wsi, int flags);
 786 LWS_EXTERN int
 787 lws_libev_init_fd_table(struct lws_context *context);
 788 LWS_EXTERN void
 789 lws_libev_destroyloop(struct lws_context *context, int tsi);
 790 LWS_EXTERN void
 791 lws_libev_run(const struct lws_context *context, int tsi);
 792 #define LWS_LIBEV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBEV)
 793 LWS_EXTERN void lws_feature_status_libev(struct lws_context_creation_info *info);
 794 #else
 795 #define lws_libev_accept(_a, _b) ((void) 0)
 796 #define lws_libev_io(_a, _b) ((void) 0)
 797 #define lws_libev_init_fd_table(_a) (0)
 798 #define lws_libev_run(_a, _b) ((void) 0)
 799 #define lws_libev_destroyloop(_a, _b) ((void) 0)
 800 #define LWS_LIBEV_ENABLED(context) (0)
 801 #if LWS_POSIX
 802 #define lws_feature_status_libev(_a) \
 803                         lwsl_notice("libev support not compiled in\n")
 804 #else
 805 #define lws_feature_status_libev(_a)
 806 #endif
 807 #endif
 808
 809 #if defined(LWS_USE_LIBUV)
 810 LWS_EXTERN void
 811 lws_libuv_accept(struct lws *new_wsi, lws_sockfd_type accept_fd);
 812 LWS_EXTERN void
 813 lws_libuv_io(struct lws *wsi, int flags);
 814 LWS_EXTERN int
 815 lws_libuv_init_fd_table(struct lws_context *context);
 816 LWS_EXTERN void
 817 lws_libuv_run(const struct lws_context *context, int tsi);
 818 LWS_EXTERN void
 819 lws_libuv_destroyloop(struct lws_context *context, int tsi);
 820 #define LWS_LIBUV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBUV)
 821 LWS_EXTERN void lws_feature_status_libuv(struct lws_context_creation_info *info);
 822 #else
 823 #define lws_libuv_accept(_a, _b) ((void) 0)
 824 #define lws_libuv_io(_a, _b) ((void) 0)
 825 #define lws_libuv_init_fd_table(_a) (0)
 826 #define lws_libuv_run(_a, _b) ((void) 0)
 827 #define lws_libuv_destroyloop(_a, _b) ((void) 0)
 828 #define LWS_LIBUV_ENABLED(context) (0)
 829 #if LWS_POSIX
 830 #define lws_feature_status_libuv(_a) \
 831                         lwsl_notice("libuv support not compiled in\n")
 832 #else
 833 #define lws_feature_status_libuv(_a)
 834 #endif
 835 #endif
 836
 837
 838 #ifdef LWS_USE_IPV6
 839 #define LWS_IPV6_ENABLED(context) \
 840         (!lws_check_opt(context->options, LWS_SERVER_OPTION_DISABLE_IPV6))
 841 #else
 842 #define LWS_IPV6_ENABLED(context) (0)
 843 #endif
 844
 845 enum uri_path_states {
 846         URIPS_IDLE,
 847         URIPS_SEEN_SLASH,
 848         URIPS_SEEN_SLASH_DOT,
 849         URIPS_SEEN_SLASH_DOT_DOT,
 850 };
 851
 852 enum uri_esc_states {
 853         URIES_IDLE,
 854         URIES_SEEN_PERCENT,
 855         URIES_SEEN_PERCENT_H1,
 856 };
 857
 858 /* notice that these union members:
 859  *
 860  *  hdr
 861  *  http
 862  *  http2
 863  *
 864  * all have a pointer to allocated_headers struct as their first member.
 865  *
 866  * It means for allocated_headers access, the three union paths can all be
 867  * used interchangeably to access the same data
 868  */
 869
 870
 871 #ifndef LWS_NO_CLIENT
 872 struct client_info_stash {
 873         char address[256];
 874         char path[1024];
 875         char host[256];
 876         char origin[256];
 877         char protocol[256];
 878         char method[16];
 879 };
 880 #endif
 881
 882 struct _lws_header_related {
 883         /* MUST be first in struct */
 884         struct allocated_headers *ah;
 885         struct lws *ah_wait_list;
 886         unsigned char *preamble_rx;
 887 #ifndef LWS_NO_CLIENT
 888         struct client_info_stash *stash;
 889 #endif
 890         unsigned int preamble_rx_len;
 891         enum uri_path_states ups;
 892         enum uri_esc_states ues;
 893         short lextable_pos;
 894         unsigned short current_token_limit;
 895 #ifndef LWS_NO_CLIENT
 896         unsigned short c_port;
 897 #endif
 898         char esc_stash;
 899         char post_literal_equal;
 900         unsigned char parser_state; /* enum lws_token_indexes */
 901         char redirects;
 902 };
 903
 904 struct _lws_http_mode_related {
 905         /* MUST be first in struct */
 906         struct allocated_headers *ah; /* mirroring  _lws_header_related */
 907         struct lws *ah_wait_list;
 908         unsigned char *preamble_rx;
 909 #ifndef LWS_NO_CLIENT
 910         struct client_info_stash *stash;
 911 #endif
 912         unsigned int preamble_rx_len;
 913         struct lws *new_wsi_list;
 914         unsigned long filepos;
 915         unsigned long filelen;
 916         lws_filefd_type fd;
 917
 918         enum http_version request_version;
 919         enum http_connection_type connection_type;
 920         unsigned int content_length;
 921         unsigned int content_remain;
 922 };
 923
 924 #ifdef LWS_USE_HTTP2
 925
 926 enum lws_http2_settings {
 927         LWS_HTTP2_SETTINGS__HEADER_TABLE_SIZE = 1,
 928         LWS_HTTP2_SETTINGS__ENABLE_PUSH,
 929         LWS_HTTP2_SETTINGS__MAX_CONCURRENT_STREAMS,
 930         LWS_HTTP2_SETTINGS__INITIAL_WINDOW_SIZE,
 931         LWS_HTTP2_SETTINGS__MAX_FRAME_SIZE,
 932         LWS_HTTP2_SETTINGS__MAX_HEADER_LIST_SIZE,
 933
 934         LWS_HTTP2_SETTINGS__COUNT /* always last */
 935 };
 936
 937 enum lws_http2_wellknown_frame_types {
 938         LWS_HTTP2_FRAME_TYPE_DATA,
 939         LWS_HTTP2_FRAME_TYPE_HEADERS,
 940         LWS_HTTP2_FRAME_TYPE_PRIORITY,
 941         LWS_HTTP2_FRAME_TYPE_RST_STREAM,
 942         LWS_HTTP2_FRAME_TYPE_SETTINGS,
 943         LWS_HTTP2_FRAME_TYPE_PUSH_PROMISE,
 944         LWS_HTTP2_FRAME_TYPE_PING,
 945         LWS_HTTP2_FRAME_TYPE_GOAWAY,
 946         LWS_HTTP2_FRAME_TYPE_WINDOW_UPDATE,
 947         LWS_HTTP2_FRAME_TYPE_CONTINUATION,
 948
 949         LWS_HTTP2_FRAME_TYPE_COUNT /* always last */
 950 };
 951
 952 enum lws_http2_flags {
 953         LWS_HTTP2_FLAG_END_STREAM = 1,
 954         LWS_HTTP2_FLAG_END_HEADERS = 4,
 955         LWS_HTTP2_FLAG_PADDED = 8,
 956         LWS_HTTP2_FLAG_PRIORITY = 0x20,
 957
 958         LWS_HTTP2_FLAG_SETTINGS_ACK = 1,
 959 };
 960
 961 #define LWS_HTTP2_STREAM_ID_MASTER 0
 962 #define LWS_HTTP2_FRAME_HEADER_LENGTH 9
 963 #define LWS_HTTP2_SETTINGS_LENGTH 6
 964
 965 struct http2_settings {
 966         unsigned int setting[LWS_HTTP2_SETTINGS__COUNT];
 967 };
 968
 969 enum http2_hpack_state {
 970
 971         /* optional before first header block */
 972         HPKS_OPT_PADDING,
 973         HKPS_OPT_E_DEPENDENCY,
 974         HKPS_OPT_WEIGHT,
 975
 976         /* header block */
 977         HPKS_TYPE,
 978
 979         HPKS_IDX_EXT,
 980
 981         HPKS_HLEN,
 982         HPKS_HLEN_EXT,
 983
 984         HPKS_DATA,
 985
 986         /* optional after last header block */
 987         HKPS_OPT_DISCARD_PADDING,
 988 };
 989
 990 enum http2_hpack_type {
 991         HPKT_INDEXED_HDR_7,
 992         HPKT_INDEXED_HDR_6_VALUE_INCR,
 993         HPKT_LITERAL_HDR_VALUE_INCR,
 994         HPKT_INDEXED_HDR_4_VALUE,
 995         HPKT_LITERAL_HDR_VALUE,
 996         HPKT_SIZE_5
 997 };
 998
 999 struct hpack_dt_entry {
1000         int token; /* additions that don't map to a token are ignored */
1001         int arg_offset;
1002         int arg_len;
1003 };
1004
1005 struct hpack_dynamic_table {
1006         struct hpack_dt_entry *entries;
1007         char *args;
1008         int pos;
1009         int next;
1010         int num_entries;
1011         int args_length;
1012 };
1013
1014 struct _lws_http2_related {
1015         /*
1016          * having this first lets us also re-use all HTTP union code
1017          * and in turn, http_mode_related has allocated headers in right
1018          * place so we can use the header apis on the wsi directly still
1019          */
1020         struct _lws_http_mode_related http; /* MUST BE FIRST IN STRUCT */
1021
1022         struct http2_settings my_settings;
1023         struct http2_settings peer_settings;
1024
1025         struct lws *parent_wsi;
1026         struct lws *next_child_wsi;
1027
1028         struct hpack_dynamic_table *hpack_dyn_table;
1029         struct lws *stream_wsi;
1030         unsigned char ping_payload[8];
1031         unsigned char one_setting[LWS_HTTP2_SETTINGS_LENGTH];
1032
1033         unsigned int count;
1034         unsigned int length;
1035         unsigned int stream_id;
1036         enum http2_hpack_state hpack;
1037         enum http2_hpack_type hpack_type;
1038         unsigned int header_index;
1039         unsigned int hpack_len;
1040         unsigned int hpack_e_dep;
1041         int tx_credit;
1042         unsigned int my_stream_id;
1043         unsigned int child_count;
1044         int my_priority;
1045
1046         unsigned int END_STREAM:1;
1047         unsigned int END_HEADERS:1;
1048         unsigned int send_END_STREAM:1;
1049         unsigned int GOING_AWAY;
1050         unsigned int requested_POLLOUT:1;
1051         unsigned int waiting_tx_credit:1;
1052         unsigned int huff:1;
1053         unsigned int value:1;
1054
1055         unsigned short round_robin_POLLOUT;
1056         unsigned short count_POLLOUT_children;
1057         unsigned short hpack_pos;
1058
1059         unsigned char type;
1060         unsigned char flags;
1061         unsigned char frame_state;
1062         unsigned char padding;
1063         unsigned char hpack_m;
1064         unsigned char initialized;
1065 };
1066
1067 #define HTTP2_IS_TOPLEVEL_WSI(wsi) (!wsi->u.http2.parent_wsi)
1068
1069 #endif
1070
1071 struct _lws_websocket_related {
1072         /* cheapest way to deal with ah overlap with ws union transition */
1073         struct _lws_header_related hdr;
1074         char *rx_ubuf;
1075         unsigned int rx_ubuf_alloc;
1076         struct lws *rx_draining_ext_list;
1077         struct lws *tx_draining_ext_list;
1078         size_t rx_packet_length;
1079         unsigned int rx_ubuf_head;
1080         unsigned char mask[4];
1081         /* Also used for close content... control opcode == < 128 */
1082         unsigned char ping_payload_buf[128 - 3 + LWS_PRE];
1083
1084         unsigned char ping_payload_len;
1085         unsigned char mask_idx;
1086         unsigned char opcode;
1087         unsigned char rsv;
1088         unsigned char rsv_first_msg;
1089         /* zero if no info, or length including 2-byte close code */
1090         unsigned char close_in_ping_buffer_len;
1091         unsigned char utf8;
1092         unsigned char stashed_write_type;
1093         unsigned char tx_draining_stashed_wp;
1094
1095         unsigned int final:1;
1096         unsigned int frame_is_binary:1;
1097         unsigned int all_zero_nonce:1;
1098         unsigned int this_frame_masked:1;
1099         unsigned int inside_frame:1; /* next write will be more of frame */
1100         unsigned int clean_buffer:1; /* buffer not rewritten by extension */
1101         unsigned int payload_is_close:1; /* process as PONG, but it is close */
1102         unsigned int ping_pending_flag:1;
1103         unsigned int continuation_possible:1;
1104         unsigned int owed_a_fin:1;
1105         unsigned int check_utf8:1;
1106         unsigned int defeat_check_utf8:1;
1107         unsigned int pmce_compressed_message:1;
1108         unsigned int stashed_write_pending:1;
1109         unsigned int rx_draining_ext:1;
1110         unsigned int tx_draining_ext:1;
1111 };
1112
1113 #ifdef LWS_WITH_CGI
1114
1115 /* wsi who is master of the cgi points to an lws_cgi */
1116
1117 struct lws_cgi {
1118         struct lws_cgi *cgi_list;
1119         struct lws *stdwsi[3]; /* points to the associated stdin/out/err wsis */
1120         struct lws *wsi; /* owner */
1121         int pipe_fds[3][2];
1122         int pid;
1123
1124         unsigned int being_closed:1;
1125 };
1126 #endif
1127
1128 signed char char_to_hex(const char c);
1129
1130 #ifndef LWS_NO_CLIENT
1131 enum lws_chunk_parser {
1132         ELCP_HEX,
1133         ELCP_CR,
1134         ELCP_CONTENT,
1135         ELCP_POST_CR,
1136         ELCP_POST_LF,
1137 };
1138 #endif
1139
1140 struct lws_rewrite;
1141
1142 struct lws {
1143
1144         /* structs */
1145         /* members with mutually exclusive lifetimes are unionized */
1146
1147         union u {
1148                 struct _lws_http_mode_related http;
1149 #ifdef LWS_USE_HTTP2
1150                 struct _lws_http2_related http2;
1151 #endif
1152                 struct _lws_header_related hdr;
1153                 struct _lws_websocket_related ws;
1154         } u;
1155
1156         /* lifetime members */
1157
1158 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
1159         struct lws_io_watcher w_read;
1160 #endif
1161 #if defined(LWS_USE_LIBEV)
1162         struct lws_io_watcher w_write;
1163 #endif
1164         time_t pending_timeout_limit;
1165
1166         /* pointers */
1167
1168         struct lws_context *context;
1169         struct lws_vhost *vhost;
1170         struct lws *parent; /* points to parent, if any */
1171         struct lws *child_list; /* points to first child */
1172         struct lws *sibling_list; /* subsequent children at same level */
1173 #ifdef LWS_WITH_CGI
1174         struct lws_cgi *cgi; /* wsi being cgi master have one of these */
1175 #endif
1176         const struct lws_protocols *protocol;
1177         struct lws *timeout_list;
1178         struct lws **timeout_list_prev;
1179         void *user_space;
1180         /* rxflow handling */
1181         unsigned char *rxflow_buffer;
1182         /* truncated send handling */
1183         unsigned char *trunc_alloc; /* non-NULL means buffering in progress */
1184 #ifndef LWS_NO_EXTENSIONS
1185         const struct lws_extension *active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
1186         void *act_ext_user[LWS_MAX_EXTENSIONS_ACTIVE];
1187 #endif
1188 #ifdef LWS_OPENSSL_SUPPORT
1189         SSL *ssl;
1190 #if !defined(LWS_USE_POLARSSL) && !defined(LWS_USE_MBEDTLS)
1191         BIO *client_bio;
1192 #endif
1193         struct lws *pending_read_list_prev, *pending_read_list_next;
1194 #endif
1195 #ifdef LWS_WITH_HTTP_PROXY
1196         struct lws_rewrite *rw;
1197 #endif
1198 #ifdef LWS_LATENCY
1199         unsigned long action_start;
1200         unsigned long latency_start;
1201 #endif
1202         /* pointer / int */
1203         lws_sockfd_type sock;
1204
1205         /* ints */
1206         int position_in_fds_table;
1207         int rxflow_len;
1208         int rxflow_pos;
1209         unsigned int trunc_alloc_len; /* size of malloc */
1210         unsigned int trunc_offset; /* where we are in terms of spilling */
1211         unsigned int trunc_len; /* how much is buffered */
1212 #ifndef LWS_NO_CLIENT
1213         int chunk_remaining;
1214 #endif
1215
1216         unsigned int hdr_parsing_completed:1;
1217         unsigned int listener:1;
1218         unsigned int user_space_externally_allocated:1;
1219         unsigned int socket_is_permanently_unusable:1;
1220         unsigned int rxflow_change_to:2;
1221         unsigned int more_rx_waiting:1; /* has to live here since ah may stick to end */
1222 #ifndef LWS_NO_CLIENT
1223         unsigned int do_ws:1; /* whether we are doing http or ws flow */
1224         unsigned int chunked:1; /* if the clientside connection is chunked */
1225         unsigned int client_rx_avail:1;
1226 #endif
1227 #ifdef LWS_WITH_HTTP_PROXY
1228         unsigned int perform_rewrite:1;
1229 #endif
1230 #ifndef LWS_NO_EXTENSIONS
1231         unsigned int extension_data_pending:1;
1232 #endif
1233 #ifdef LWS_OPENSSL_SUPPORT
1234         unsigned int use_ssl:2;
1235         unsigned int upgraded:1;
1236 #endif
1237 #ifdef _WIN32
1238         unsigned int sock_send_blocking:1;
1239 #endif
1240 #ifdef LWS_OPENSSL_SUPPORT
1241         unsigned int redirect_to_https:1;
1242 #endif
1243
1244         /* chars */
1245 #ifndef LWS_NO_EXTENSIONS
1246         unsigned char count_act_ext;
1247 #endif
1248         unsigned char ietf_spec_revision;
1249         char mode; /* enum connection_mode */
1250         char state; /* enum lws_connection_states */
1251         char state_pre_close;
1252         char lws_rx_parse_state; /* enum lws_rx_parse_state */
1253         char rx_frame_type; /* enum lws_write_protocol */
1254         char pending_timeout; /* enum pending_timeout */
1255         char pps; /* enum lws_pending_protocol_send */
1256         char tsi; /* thread service index we belong to */
1257 #ifdef LWS_WITH_CGI
1258         char cgi_channel; /* which of stdin/out/err */
1259         char hdr_state;
1260 #endif
1261 #ifndef LWS_NO_CLIENT
1262         char chunk_parser; /* enum lws_chunk_parser */
1263 #endif
1264 };
1265
1266 LWS_EXTERN int log_level;
1267
1268 LWS_EXTERN int
1269 lws_socket_bind(struct lws_context *context, int sockfd, int port,
1270                 const char *iface);
1271
1272 LWS_EXTERN void
1273 lws_close_free_wsi(struct lws *wsi, enum lws_close_status);
1274
1275 LWS_EXTERN int
1276 remove_wsi_socket_from_fds(struct lws *wsi);
1277 LWS_EXTERN int
1278 lws_rxflow_cache(struct lws *wsi, unsigned char *buf, int n, int len);
1279
1280 #ifndef LWS_LATENCY
1281 static inline void
1282 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1283             int ret, int completion) {
1284         do {
1285                 (void)context; (void)wsi; (void)action; (void)ret;
1286                 (void)completion;
1287         } while (0);
1288 }
1289 static inline void
1290 lws_latency_pre(struct lws_context *context, struct lws *wsi) {
1291         do { (void)context; (void)wsi; } while (0);
1292 }
1293 #else
1294 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
1295 extern void
1296 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1297             int ret, int completion);
1298 #endif
1299
1300 LWS_EXTERN void
1301 lws_set_protocol_write_pending(struct lws *wsi,
1302                                enum lws_pending_protocol_send pend);
1303 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1304 lws_client_rx_sm(struct lws *wsi, unsigned char c);
1305
1306 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1307 lws_parse(struct lws *wsi, unsigned char c);
1308
1309 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1310 lws_http_action(struct lws *wsi);
1311
1312 LWS_EXTERN int
1313 lws_b64_selftest(void);
1314
1315 LWS_EXTERN int
1316 lws_service_adjust_timeout(struct lws_context *context, int timeout_ms, int tsi);
1317
1318 LWS_EXTERN int
1319 lws_service_flag_pending(struct lws_context *context, int tsi);
1320
1321 #if defined(_WIN32) || defined(MBED_OPERATORS)
1322 LWS_EXTERN struct lws *
1323 wsi_from_fd(const struct lws_context *context, lws_sockfd_type fd);
1324
1325 LWS_EXTERN int
1326 insert_wsi(struct lws_context *context, struct lws *wsi);
1327
1328 LWS_EXTERN int
1329 delete_from_fd(struct lws_context *context, lws_sockfd_type fd);
1330 #else
1331 #define wsi_from_fd(A,B)  A->lws_lookup[B]
1332 #define insert_wsi(A,B)   assert(A->lws_lookup[B->sock] == 0); A->lws_lookup[B->sock]=B
1333 #define delete_from_fd(A,B) A->lws_lookup[B]=0
1334 #endif
1335
1336 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1337 insert_wsi_socket_into_fds(struct lws_context *context, struct lws *wsi);
1338
1339 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1340 lws_issue_raw(struct lws *wsi, unsigned char *buf, size_t len);
1341
1342
1343 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1344 lws_service_timeout_check(struct lws *wsi, unsigned int sec);
1345
1346 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1347 lws_client_connect_2(struct lws *wsi);
1348
1349 LWS_VISIBLE struct lws * LWS_WARN_UNUSED_RESULT
1350 lws_client_reset(struct lws *wsi, int ssl, const char *address, int port,
1351                  const char *path, const char *host);
1352
1353 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1354 lws_create_new_server_wsi(struct lws_vhost *vhost);
1355
1356 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1357 lws_generate_client_handshake(struct lws *wsi, char *pkt);
1358
1359 LWS_EXTERN int
1360 lws_handle_POLLOUT_event(struct lws *wsi, struct lws_pollfd *pollfd);
1361
1362 LWS_EXTERN struct lws *
1363 lws_client_connect_via_info2(struct lws *wsi);
1364
1365 /*
1366  * EXTENSIONS
1367  */
1368
1369 #ifndef LWS_NO_EXTENSIONS
1370 LWS_VISIBLE void
1371 lws_context_init_extensions(struct lws_context_creation_info *info,
1372                             struct lws_context *context);
1373 LWS_EXTERN int
1374 lws_any_extension_handled(struct lws *wsi, enum lws_extension_callback_reasons r,
1375                           void *v, size_t len);
1376
1377 LWS_EXTERN int
1378 lws_ext_cb_active(struct lws *wsi, int reason, void *buf, int len);
1379 LWS_EXTERN int
1380 lws_ext_cb_all_exts(struct lws_context *context, struct lws *wsi, int reason,
1381                     void *arg, int len);
1382
1383 #else
1384 #define lws_any_extension_handled(_a, _b, _c, _d) (0)
1385 #define lws_ext_cb_active(_a, _b, _c, _d) (0)
1386 #define lws_ext_cb_all_exts(_a, _b, _c, _d, _e) (0)
1387 #define lws_issue_raw_ext_access lws_issue_raw
1388 #define lws_context_init_extensions(_a, _b)
1389 #endif
1390
1391 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1392 lws_client_interpret_server_handshake(struct lws *wsi);
1393
1394 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1395 lws_rx_sm(struct lws *wsi, unsigned char c);
1396
1397 LWS_EXTERN void
1398 lws_payload_until_length_exhausted(struct lws *wsi, unsigned char **buf, size_t *len);
1399
1400 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1401 lws_issue_raw_ext_access(struct lws *wsi, unsigned char *buf, size_t len);
1402
1403 LWS_EXTERN void
1404 lws_union_transition(struct lws *wsi, enum connection_mode mode);
1405
1406 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1407 user_callback_handle_rxflow(lws_callback_function, struct lws *wsi,
1408                             enum lws_callback_reasons reason, void *user,
1409                             void *in, size_t len);
1410 #ifdef LWS_USE_HTTP2
1411 LWS_EXTERN struct lws *lws_http2_get_network_wsi(struct lws *wsi);
1412 struct lws * lws_http2_get_nth_child(struct lws *wsi, int n);
1413 LWS_EXTERN int
1414 lws_http2_interpret_settings_payload(struct http2_settings *settings,
1415                                      unsigned char *buf, int len);
1416 LWS_EXTERN void lws_http2_init(struct http2_settings *settings);
1417 LWS_EXTERN int
1418 lws_http2_parser(struct lws *wsi, unsigned char c);
1419 LWS_EXTERN int lws_http2_do_pps_send(struct lws_context *context,
1420                                      struct lws *wsi);
1421 LWS_EXTERN int lws_http2_frame_write(struct lws *wsi, int type, int flags,
1422                                      unsigned int sid, unsigned int len,
1423                                      unsigned char *buf);
1424 LWS_EXTERN struct lws *
1425 lws_http2_wsi_from_id(struct lws *wsi, unsigned int sid);
1426 LWS_EXTERN int lws_hpack_interpret(struct lws *wsi,
1427                                    unsigned char c);
1428 LWS_EXTERN int
1429 lws_add_http2_header_by_name(struct lws *wsi,
1430                              const unsigned char *name,
1431                              const unsigned char *value, int length,
1432                              unsigned char **p, unsigned char *end);
1433 LWS_EXTERN int
1434 lws_add_http2_header_by_token(struct lws *wsi,
1435                             enum lws_token_indexes token,
1436                             const unsigned char *value, int length,
1437                             unsigned char **p, unsigned char *end);
1438 LWS_EXTERN int
1439 lws_add_http2_header_status(struct lws *wsi,
1440                             unsigned int code, unsigned char **p,
1441                             unsigned char *end);
1442 LWS_EXTERN
1443 void lws_http2_configure_if_upgraded(struct lws *wsi);
1444 #else
1445 #define lws_http2_configure_if_upgraded(x)
1446 #endif
1447
1448 LWS_EXTERN int
1449 lws_plat_set_socket_options(struct lws_vhost *vhost, lws_sockfd_type fd);
1450
1451 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1452 lws_header_table_attach(struct lws *wsi, int autoservice);
1453
1454 LWS_EXTERN int
1455 lws_header_table_detach(struct lws *wsi, int autoservice);
1456
1457 LWS_EXTERN void
1458 lws_header_table_reset(struct lws *wsi, int autoservice);
1459
1460 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1461 lws_hdr_simple_ptr(struct lws *wsi, enum lws_token_indexes h);
1462
1463 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1464 lws_hdr_simple_create(struct lws *wsi, enum lws_token_indexes h, const char *s);
1465
1466 LWS_EXTERN int
1467 lws_ensure_user_space(struct lws *wsi);
1468
1469 LWS_EXTERN int
1470 lws_change_pollfd(struct lws *wsi, int _and, int _or);
1471
1472 #ifndef LWS_NO_SERVER
1473 int lws_context_init_server(struct lws_context_creation_info *info,
1474                             struct lws_vhost *vhost);
1475 LWS_EXTERN struct lws_vhost *
1476 lws_select_vhost(struct lws_context *context, int port, const char *servername);
1477 LWS_EXTERN int
1478 handshake_0405(struct lws_context *context, struct lws *wsi);
1479 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1480 lws_interpret_incoming_packet(struct lws *wsi, unsigned char **buf, size_t len);
1481 LWS_EXTERN void
1482 lws_server_get_canonical_hostname(struct lws_context *context,
1483                                   struct lws_context_creation_info *info);
1484 #else
1485 #define lws_context_init_server(_a, _b) (0)
1486 #define lws_interpret_incoming_packet(_a, _b, _c) (0)
1487 #define lws_server_get_canonical_hostname(_a, _b)
1488 #endif
1489
1490 #ifndef LWS_NO_DAEMONIZE
1491 LWS_EXTERN int get_daemonize_pid();
1492 #else
1493 #define get_daemonize_pid() (0)
1494 #endif
1495
1496 #if !defined(MBED_OPERATORS)
1497 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1498 interface_to_sa(struct lws_context *context, const char *ifname,
1499                 struct sockaddr_in *addr, size_t addrlen);
1500 #endif
1501 LWS_EXTERN void lwsl_emit_stderr(int level, const char *line);
1502
1503 enum lws_ssl_capable_status {
1504         LWS_SSL_CAPABLE_ERROR = -1,
1505         LWS_SSL_CAPABLE_MORE_SERVICE = -2,
1506 };
1507
1508 #ifndef LWS_OPENSSL_SUPPORT
1509 #define LWS_SSL_ENABLED(context) (0)
1510 #define lws_context_init_server_ssl(_a, _b) (0)
1511 #define lws_ssl_destroy(_a)
1512 #define lws_context_init_http2_ssl(_a)
1513 #define lws_ssl_capable_read lws_ssl_capable_read_no_ssl
1514 #define lws_ssl_capable_write lws_ssl_capable_write_no_ssl
1515 #define lws_ssl_pending lws_ssl_pending_no_ssl
1516 #define lws_server_socket_service_ssl(_b, _c) (0)
1517 #define lws_ssl_close(_a) (0)
1518 #define lws_ssl_context_destroy(_a)
1519 #define lws_ssl_SSL_CTX_destroy(_a)
1520 #define lws_ssl_remove_wsi_from_buffered_list(_a)
1521 #define lws_context_init_ssl_library(_a)
1522 #else
1523 #define LWS_SSL_ENABLED(context) (context->use_ssl)
1524 LWS_EXTERN int openssl_websocket_private_data_index;
1525 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1526 lws_ssl_capable_read(struct lws *wsi, unsigned char *buf, int len);
1527 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1528 lws_ssl_capable_write(struct lws *wsi, unsigned char *buf, int len);
1529 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1530 lws_ssl_pending(struct lws *wsi);
1531 LWS_EXTERN int
1532 lws_context_init_ssl_library(struct lws_context_creation_info *info);
1533 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1534 lws_server_socket_service_ssl(struct lws *new_wsi, lws_sockfd_type accept_fd);
1535 LWS_EXTERN int
1536 lws_ssl_close(struct lws *wsi);
1537 LWS_EXTERN void
1538 lws_ssl_SSL_CTX_destroy(struct lws_vhost *vhost);
1539 LWS_EXTERN void
1540 lws_ssl_context_destroy(struct lws_context *context);
1541 LWS_VISIBLE void
1542 lws_ssl_remove_wsi_from_buffered_list(struct lws *wsi);
1543 LWS_EXTERN int
1544 lws_ssl_client_bio_create(struct lws *wsi);
1545 LWS_EXTERN int
1546 lws_ssl_client_connect1(struct lws *wsi);
1547 LWS_EXTERN int
1548 lws_ssl_client_connect2(struct lws *wsi);
1549 #ifndef LWS_NO_SERVER
1550 LWS_EXTERN int
1551 lws_context_init_server_ssl(struct lws_context_creation_info *info,
1552                             struct lws_vhost *vhost);
1553 #else
1554 #define lws_context_init_server_ssl(_a, _b) (0)
1555 #endif
1556 LWS_EXTERN void
1557 lws_ssl_destroy(struct lws_vhost *vhost);
1558
1559 /* HTTP2-related */
1560
1561 #ifdef LWS_USE_HTTP2
1562 LWS_EXTERN void
1563 lws_context_init_http2_ssl(struct lws_context *context);
1564 #else
1565 #define lws_context_init_http2_ssl(_a)
1566 #endif
1567 #endif
1568
1569 #if LWS_MAX_SMP > 1
1570 static LWS_INLINE void
1571 lws_pt_mutex_init(struct lws_context_per_thread *pt)
1572 {
1573         pthread_mutex_init(&pt->lock, NULL);
1574 }
1575 static LWS_INLINE void
1576 lws_pt_lock(struct lws_context_per_thread *pt)
1577 {
1578         pthread_mutex_lock(&pt->lock);
1579 }
1580
1581 static LWS_INLINE void
1582 lws_pt_unlock(struct lws_context_per_thread *pt)
1583 {
1584         pthread_mutex_unlock(&pt->lock);
1585 }
1586 #else
1587 #define lws_pt_mutex_init(_a) (void)(_a)
1588 #define lws_pt_lock(_a) (void)(_a)
1589 #define lws_pt_unlock(_a) (void)(_a)
1590 #endif
1591
1592 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1593 lws_ssl_capable_read_no_ssl(struct lws *wsi, unsigned char *buf, int len);
1594
1595 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1596 lws_ssl_capable_write_no_ssl(struct lws *wsi, unsigned char *buf, int len);
1597
1598 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1599 lws_ssl_pending_no_ssl(struct lws *wsi);
1600
1601 #ifdef LWS_WITH_HTTP_PROXY
1602 struct lws_rewrite {
1603         hubbub_parser *parser;
1604         hubbub_parser_optparams params;
1605         const char *from, *to;
1606         int from_len, to_len;
1607         unsigned char *p, *end;
1608         struct lws *wsi;
1609 };
1610 static LWS_INLINE int hstrcmp(hubbub_string *s, const char *p, int len)
1611 {
1612         if (s->len != len)
1613                 return 1;
1614
1615         return strncmp((const char *)s->ptr, p, len);
1616 }
1617 typedef hubbub_error (*hubbub_callback_t)(const hubbub_token *token, void *pw);
1618 LWS_EXTERN struct lws_rewrite *
1619 lws_rewrite_create(struct lws *wsi, hubbub_callback_t cb, const char *from, const char *to);
1620 LWS_EXTERN void
1621 lws_rewrite_destroy(struct lws_rewrite *r);
1622 LWS_EXTERN int
1623 lws_rewrite_parse(struct lws_rewrite *r, const unsigned char *in, int in_len);
1624 #endif
1625
1626 #ifndef LWS_NO_CLIENT
1627 LWS_EXTERN int lws_client_socket_service(struct lws_context *context,
1628                                          struct lws *wsi,
1629                                          struct lws_pollfd *pollfd);
1630 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1631 lws_http_transaction_completed_client(struct lws *wsi);
1632 #ifdef LWS_OPENSSL_SUPPORT
1633 LWS_EXTERN int
1634 lws_context_init_client_ssl(struct lws_context_creation_info *info,
1635                             struct lws_vhost *vhost);
1636 #else
1637         #define lws_context_init_client_ssl(_a, _b) (0)
1638 #endif
1639 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1640 lws_handshake_client(struct lws *wsi, unsigned char **buf, size_t len);
1641 LWS_EXTERN void
1642 lws_decode_ssl_error(void);
1643 #else
1644 #define lws_context_init_client_ssl(_a, _b) (0)
1645 #define lws_handshake_client(_a, _b, _c) (0)
1646 #endif
1647
1648 LWS_EXTERN int
1649 _lws_rx_flow_control(struct lws *wsi);
1650
1651 LWS_EXTERN int
1652 _lws_change_pollfd(struct lws *wsi, int _and, int _or, struct lws_pollargs *pa);
1653
1654 #ifndef LWS_NO_SERVER
1655 LWS_EXTERN int
1656 lws_server_socket_service(struct lws_context *context, struct lws *wsi,
1657                           struct lws_pollfd *pollfd);
1658 LWS_EXTERN int
1659 lws_handshake_server(struct lws *wsi, unsigned char **buf, size_t len);
1660 LWS_EXTERN int
1661 _lws_server_listen_accept_flow_control(struct lws *twsi, int on);
1662 #else
1663 #define lws_server_socket_service(_a, _b, _c) (0)
1664 #define lws_handshake_server(_a, _b, _c) (0)
1665 #define _lws_server_listen_accept_flow_control(a, b) (0)
1666 #endif
1667
1668 LWS_EXTERN int
1669 lws_get_addresses(struct lws_context *context, void *ads, char *name,
1670                   int name_len, char *rip, int rip_len);
1671
1672 LWS_EXTERN int
1673 lws_cgi_kill_terminated(struct lws_context_per_thread *pt);
1674
1675 int
1676 lws_protocol_init(struct lws_context *context);
1677
1678 /*
1679  * custom allocator
1680  */
1681 LWS_EXTERN void *
1682 lws_realloc(void *ptr, size_t size);
1683
1684 LWS_EXTERN void * LWS_WARN_UNUSED_RESULT
1685 lws_zalloc(size_t size);
1686
1687 #define lws_malloc(S)   lws_realloc(NULL, S)
1688 #define lws_free(P)     lws_realloc(P, 0)
1689 #define lws_free_set_NULL(P)    do { lws_realloc(P, 0); (P) = NULL; } while(0)
1690
1691 /* lws_plat_ */
1692 LWS_EXTERN void
1693 lws_plat_delete_socket_from_fds(struct lws_context *context,
1694                                 struct lws *wsi, int m);
1695 LWS_EXTERN void
1696 lws_plat_insert_socket_into_fds(struct lws_context *context,
1697                                 struct lws *wsi);
1698 LWS_EXTERN void
1699 lws_plat_service_periodic(struct lws_context *context);
1700
1701 LWS_EXTERN int
1702 lws_plat_change_pollfd(struct lws_context *context, struct lws *wsi,
1703                        struct lws_pollfd *pfd);
1704 LWS_EXTERN int
1705 lws_plat_context_early_init(void);
1706 LWS_EXTERN void
1707 lws_plat_context_early_destroy(struct lws_context *context);
1708 LWS_EXTERN void
1709 lws_plat_context_late_destroy(struct lws_context *context);
1710 LWS_EXTERN int
1711 lws_poll_listen_fd(struct lws_pollfd *fd);
1712 LWS_EXTERN int
1713 lws_plat_service(struct lws_context *context, int timeout_ms);
1714 LWS_EXTERN LWS_VISIBLE int
1715 lws_plat_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
1716 LWS_EXTERN int
1717 lws_plat_init(struct lws_context *context,
1718               struct lws_context_creation_info *info);
1719 LWS_EXTERN void
1720 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
1721 LWS_EXTERN unsigned long long
1722 time_in_microseconds(void);
1723 LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
1724 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);
1725
1726 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1727 lws_check_utf8(unsigned char *state, unsigned char *buf, size_t len);
1728
1729 #ifdef __cplusplus
1730 };
1731 #endif