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