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 #if (defined(_MSC_VER) && _MSC_VER < 1900) || defined(_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 #include <sys/resource.h>
 127 #else
 128 #include <sys/syslog.h>
 129 #endif
 130 #include <sys/un.h>
 131 #include <sys/socket.h>
 132 #include <netdb.h>
 133 #include <netinet/in.h>
 134 #include <netinet/tcp.h>
 135 #include <arpa/inet.h>
 136 #include <poll.h>
 137 #ifdef LWS_USE_LIBEV
 138 #include <ev.h>
 139 #endif
 140 #ifdef LWS_USE_LIBUV
 141 #include <uv.h>
 142 #endif
 143 #include <sys/mman.h>
 144
 145 #endif /* MBED */
 146
 147 #ifndef LWS_NO_FORK
 148 #ifdef LWS_HAVE_SYS_PRCTL_H
 149 #include <sys/prctl.h>
 150 #endif
 151 #endif
 152
 153 #include <sys/time.h>
 154
 155 #define LWS_ERRNO errno
 156 #define LWS_EAGAIN EAGAIN
 157 #define LWS_EALREADY EALREADY
 158 #define LWS_EINPROGRESS EINPROGRESS
 159 #define LWS_EINTR EINTR
 160 #define LWS_EISCONN EISCONN
 161 #define LWS_EWOULDBLOCK EWOULDBLOCK
 162 #define LWS_POLLHUP (POLLHUP|POLLERR)
 163 #define LWS_POLLIN (POLLIN)
 164 #define LWS_POLLOUT (POLLOUT)
 165 static inline int compatible_close(int fd) { return close(fd); }
 166 #define lws_set_blocking_send(wsi)
 167
 168 #ifdef MBED_OPERATORS
 169 #define lws_socket_is_valid(x) ((x) != NULL)
 170 #define LWS_SOCK_INVALID (NULL)
 171 #else
 172 #define lws_socket_is_valid(x) (x >= 0)
 173 #define LWS_SOCK_INVALID (-1)
 174 #endif
 175 #endif
 176
 177 #ifndef LWS_HAVE_BZERO
 178 #ifndef bzero
 179 #define bzero(b, len) (memset((b), '\0', (len)), (void) 0)
 180 #endif
 181 #endif
 182
 183 #ifndef LWS_HAVE_STRERROR
 184 #define strerror(x) ""
 185 #endif
 186
 187 #ifdef LWS_OPENSSL_SUPPORT
 188
 189 #ifdef USE_WOLFSSL
 190 #ifdef USE_OLD_CYASSL
 191 #include <cyassl/openssl/ssl.h>
 192 #include <cyassl/error-ssl.h>
 193 #else
 194 #include <wolfssl/openssl/ssl.h>
 195 #include <wolfssl/error-ssl.h>
 196 #endif /* not USE_OLD_CYASSL */
 197 #else
 198 #if defined(LWS_USE_POLARSSL)
 199 #include <polarssl/ssl.h>
 200 #include <polarssl/error.h>
 201 #include <polarssl/md5.h>
 202 #include <polarssl/sha1.h>
 203 #include <polarssl/ecdh.h>
 204 #define SSL_ERROR_WANT_READ POLARSSL_ERR_NET_WANT_READ
 205 #define SSL_ERROR_WANT_WRITE POLARSSL_ERR_NET_WANT_WRITE
 206 #define OPENSSL_VERSION_NUMBER  0x10002000L
 207 #else
 208 #if defined(LWS_USE_MBEDTLS)
 209 #include <mbedtls/ssl.h>
 210 #include <mbedtls/error.h>
 211 #include <mbedtls/md5.h>
 212 #include <mbedtls/sha1.h>
 213 #include <mbedtls/ecdh.h>
 214 #else
 215 #include <openssl/ssl.h>
 216 #include <openssl/evp.h>
 217 #include <openssl/err.h>
 218 #include <openssl/md5.h>
 219 #include <openssl/sha.h>
 220 #ifdef LWS_HAVE_OPENSSL_ECDH_H
 221 #include <openssl/ecdh.h>
 222 #endif
 223 #endif /* not USE_MBEDTLS */
 224 #endif /* not USE_POLARSSL */
 225 #endif /* not USE_WOLFSSL */
 226 #endif
 227
 228 #include "libwebsockets.h"
 229
 230 #if defined(MBED_OPERATORS)
 231 #undef compatible_close
 232 #define compatible_close(fd) mbed3_delete_tcp_stream_socket(fd)
 233 #ifndef BIG_ENDIAN
 234 #define BIG_ENDIAN    4321  /* to show byte order (taken from gcc) */
 235 #endif
 236 #ifndef LITTLE_ENDIAN
 237 #define LITTLE_ENDIAN 1234
 238 #endif
 239 #ifndef BYTE_ORDER
 240 #define BYTE_ORDER LITTLE_ENDIAN
 241 #endif
 242 #endif
 243
 244 #if defined(WIN32) || defined(_WIN32)
 245
 246 #ifndef BIG_ENDIAN
 247 #define BIG_ENDIAN    4321  /* to show byte order (taken from gcc) */
 248 #endif
 249 #ifndef LITTLE_ENDIAN
 250 #define LITTLE_ENDIAN 1234
 251 #endif
 252 #ifndef BYTE_ORDER
 253 #define BYTE_ORDER LITTLE_ENDIAN
 254 #endif
 255 #ifndef u_int64_t
 256 typedef unsigned __int64 u_int64_t;
 257 #endif
 258
 259 #undef __P
 260 #ifndef __P
 261 #if __STDC__
 262 #define __P(protos) protos
 263 #else
 264 #define __P(protos) ()
 265 #endif
 266 #endif
 267
 268 #else
 269
 270 #include <sys/stat.h>
 271 #include <sys/time.h>
 272
 273 #if defined(__APPLE__)
 274 #include <machine/endian.h>
 275 #elif defined(__FreeBSD__)
 276 #include <sys/endian.h>
 277 #elif defined(__linux__)
 278 #include <endian.h>
 279 #endif
 280
 281 #ifdef __cplusplus
 282 extern "C" {
 283 #endif
 284
 285 #if defined(__QNX__)
 286         #include <gulliver.h>
 287         #if defined(__LITTLEENDIAN__)
 288                 #define BYTE_ORDER __LITTLEENDIAN__
 289                 #define LITTLE_ENDIAN __LITTLEENDIAN__
 290                 #define BIG_ENDIAN 4321  /* to show byte order (taken from gcc); for suppres warning that BIG_ENDIAN is not defined. */
 291         #endif
 292         #if defined(__BIGENDIAN__)
 293                 #define BYTE_ORDER __BIGENDIAN__
 294                 #define LITTLE_ENDIAN 1234  /* to show byte order (taken from gcc); for suppres warning that LITTLE_ENDIAN is not defined. */
 295                 #define BIG_ENDIAN __BIGENDIAN__
 296         #endif
 297 #endif
 298
 299 #if !defined(BYTE_ORDER)
 300 # define BYTE_ORDER __BYTE_ORDER
 301 #endif
 302 #if !defined(LITTLE_ENDIAN)
 303 # define LITTLE_ENDIAN __LITTLE_ENDIAN
 304 #endif
 305 #if !defined(BIG_ENDIAN)
 306 # define BIG_ENDIAN __BIG_ENDIAN
 307 #endif
 308
 309 #endif
 310
 311 /*
 312  * Mac OSX as well as iOS do not define the MSG_NOSIGNAL flag,
 313  * but happily have something equivalent in the SO_NOSIGPIPE flag.
 314  */
 315 #ifdef __APPLE__
 316 #define MSG_NOSIGNAL SO_NOSIGPIPE
 317 #endif
 318
 319 #ifdef _WIN32
 320 #ifndef FD_HASHTABLE_MODULUS
 321 #define FD_HASHTABLE_MODULUS 32
 322 #endif
 323 #endif
 324
 325 #ifndef LWS_DEF_HEADER_LEN
 326 #define LWS_DEF_HEADER_LEN 1024
 327 #endif
 328 #ifndef LWS_DEF_HEADER_POOL
 329 #define LWS_DEF_HEADER_POOL 16
 330 #endif
 331 #ifndef LWS_MAX_PROTOCOLS
 332 #define LWS_MAX_PROTOCOLS 5
 333 #endif
 334 #ifndef LWS_MAX_EXTENSIONS_ACTIVE
 335 #define LWS_MAX_EXTENSIONS_ACTIVE 2
 336 #endif
 337 #ifndef LWS_MAX_EXT_OFFERS
 338 #define LWS_MAX_EXT_OFFERS 8
 339 #endif
 340 #ifndef SPEC_LATEST_SUPPORTED
 341 #define SPEC_LATEST_SUPPORTED 13
 342 #endif
 343 #ifndef AWAITING_TIMEOUT
 344 #define AWAITING_TIMEOUT 20
 345 #endif
 346 #ifndef CIPHERS_LIST_STRING
 347 #define CIPHERS_LIST_STRING "DEFAULT"
 348 #endif
 349 #ifndef LWS_SOMAXCONN
 350 #define LWS_SOMAXCONN SOMAXCONN
 351 #endif
 352
 353 #define MAX_WEBSOCKET_04_KEY_LEN 128
 354 #define LWS_MAX_SOCKET_IO_BUF 4096
 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 short 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
 552 #ifndef LWS_NO_CLIENT
 553         char initial_handshake_hash_base64[30];
 554 #endif
 555
 556         unsigned short pos;
 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 };
 682
 683 /*
 684  * the rest is managed per-context, that includes
 685  *
 686  *  - processwide single fd -> wsi lookup
 687  *  - contextwide headers pool
 688  */
 689
 690 struct lws_context {
 691         time_t last_timeout_check_s;
 692         time_t time_up;
 693         struct lws_plat_file_ops fops;
 694         struct lws_context_per_thread pt[LWS_MAX_SMP];
 695 #ifdef _WIN32
 696 /* different implementation between unix and windows */
 697         struct lws_fd_hashtable fd_hashtable[FD_HASHTABLE_MODULUS];
 698 #else
 699         struct lws **lws_lookup;  /* fd to wsi */
 700 #endif
 701         struct lws_vhost *vhost_list;
 702         struct lws_plugin *plugin_list;
 703         const struct lws_token_limits *token_limits;
 704         void *user_space;
 705         const char *server_string;
 706
 707 #if defined(LWS_USE_LIBEV)
 708         lws_ev_signal_cb_t * lws_ev_sigint_cb;
 709 #endif
 710 #if defined(LWS_USE_LIBUV)
 711         uv_signal_cb lws_uv_sigint_cb;
 712 #endif
 713         char canonical_hostname[128];
 714 #ifdef LWS_LATENCY
 715         unsigned long worst_latency;
 716         char worst_latency_info[256];
 717 #endif
 718
 719         int max_fds;
 720 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
 721         int use_ev_sigint;
 722 #endif
 723         int started_with_parent;
 724         int uid, gid;
 725
 726         int fd_random;
 727 #ifdef LWS_OPENSSL_SUPPORT
 728 #define lws_ssl_anybody_has_buffered_read(w) \
 729                 (w->vhost->use_ssl && \
 730                  w->context->pt[(int)w->tsi].pending_read_list)
 731 #define lws_ssl_anybody_has_buffered_read_tsi(c, t) \
 732                 (/*c->use_ssl && */ \
 733                  c->pt[(int)t].pending_read_list)
 734 #else
 735 #define lws_ssl_anybody_has_buffered_read(ctx) (0)
 736 #define lws_ssl_anybody_has_buffered_read_tsi(ctx, t) (0)
 737 #endif
 738         int count_wsi_allocated;
 739         int count_cgi_spawned;
 740         unsigned int options;
 741         unsigned int fd_limit_per_thread;
 742         unsigned int timeout_secs;
 743
 744         /*
 745          * set to the Thread ID that's doing the service loop just before entry
 746          * to poll indicates service thread likely idling in poll()
 747          * volatile because other threads may check it as part of processing
 748          * for pollfd event change.
 749          */
 750         volatile int service_tid;
 751         int service_tid_detected;
 752
 753         short max_http_header_data;
 754         short max_http_header_pool;
 755         short count_threads;
 756         short plugin_protocol_count;
 757         short plugin_extension_count;
 758         short server_string_len;
 759
 760         unsigned int being_destroyed:1;
 761         unsigned int requested_kill:1;
 762         unsigned int protocol_init_done:1;
 763 };
 764
 765 #define lws_get_context_protocol(ctx, x) ctx->vhost_list->protocols[x]
 766 #define lws_get_vh_protocol(vh, x) vh->protocols[x]
 767
 768 LWS_EXTERN void
 769 lws_close_free_wsi_final(struct lws *wsi);
 770 LWS_EXTERN void
 771 lws_libuv_closehandle(struct lws *wsi);
 772
 773 LWS_VISIBLE LWS_EXTERN int
 774 lws_plat_plugins_init(struct lws_context * context, const char * const *d);
 775
 776 LWS_VISIBLE LWS_EXTERN int
 777 lws_plat_plugins_destroy(struct lws_context * context);
 778
 779 enum {
 780         LWS_EV_READ = (1 << 0),
 781         LWS_EV_WRITE = (1 << 1),
 782         LWS_EV_START = (1 << 2),
 783         LWS_EV_STOP = (1 << 3),
 784
 785         LWS_EV_PREPARE_DELETION = (1 << 31),
 786 };
 787
 788 #if defined(LWS_USE_LIBEV)
 789 LWS_EXTERN void
 790 lws_libev_accept(struct lws *new_wsi, lws_sockfd_type accept_fd);
 791 LWS_EXTERN void
 792 lws_libev_io(struct lws *wsi, int flags);
 793 LWS_EXTERN int
 794 lws_libev_init_fd_table(struct lws_context *context);
 795 LWS_EXTERN void
 796 lws_libev_destroyloop(struct lws_context *context, int tsi);
 797 LWS_EXTERN void
 798 lws_libev_run(const struct lws_context *context, int tsi);
 799 #define LWS_LIBEV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBEV)
 800 LWS_EXTERN void lws_feature_status_libev(struct lws_context_creation_info *info);
 801 #else
 802 #define lws_libev_accept(_a, _b) ((void) 0)
 803 #define lws_libev_io(_a, _b) ((void) 0)
 804 #define lws_libev_init_fd_table(_a) (0)
 805 #define lws_libev_run(_a, _b) ((void) 0)
 806 #define lws_libev_destroyloop(_a, _b) ((void) 0)
 807 #define LWS_LIBEV_ENABLED(context) (0)
 808 #if LWS_POSIX
 809 #define lws_feature_status_libev(_a) \
 810                         lwsl_notice("libev support not compiled in\n")
 811 #else
 812 #define lws_feature_status_libev(_a)
 813 #endif
 814 #endif
 815
 816 #if defined(LWS_USE_LIBUV)
 817 LWS_EXTERN void
 818 lws_libuv_accept(struct lws *new_wsi, lws_sockfd_type accept_fd);
 819 LWS_EXTERN void
 820 lws_libuv_io(struct lws *wsi, int flags);
 821 LWS_EXTERN int
 822 lws_libuv_init_fd_table(struct lws_context *context);
 823 LWS_EXTERN void
 824 lws_libuv_run(const struct lws_context *context, int tsi);
 825 LWS_EXTERN void
 826 lws_libuv_destroyloop(struct lws_context *context, int tsi);
 827 #define LWS_LIBUV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBUV)
 828 LWS_EXTERN void lws_feature_status_libuv(struct lws_context_creation_info *info);
 829 #else
 830 #define lws_libuv_accept(_a, _b) ((void) 0)
 831 #define lws_libuv_io(_a, _b) ((void) 0)
 832 #define lws_libuv_init_fd_table(_a) (0)
 833 #define lws_libuv_run(_a, _b) ((void) 0)
 834 #define lws_libuv_destroyloop(_a, _b) ((void) 0)
 835 #define LWS_LIBUV_ENABLED(context) (0)
 836 #if LWS_POSIX
 837 #define lws_feature_status_libuv(_a) \
 838                         lwsl_notice("libuv support not compiled in\n")
 839 #else
 840 #define lws_feature_status_libuv(_a)
 841 #endif
 842 #endif
 843
 844
 845 #ifdef LWS_USE_IPV6
 846 #define LWS_IPV6_ENABLED(context) \
 847         (!lws_check_opt(context->options, LWS_SERVER_OPTION_DISABLE_IPV6))
 848 #else
 849 #define LWS_IPV6_ENABLED(context) (0)
 850 #endif
 851
 852 #ifdef LWS_USE_UNIX_SOCK
 853 #define LWS_UNIX_SOCK_ENABLED(vhost) \
 854         (vhost->options & LWS_SERVER_OPTION_UNIX_SOCK)
 855 #else
 856 #define LWS_UNIX_SOCK_ENABLED(vhost) (0)
 857 #endif
 858 enum uri_path_states {
 859         URIPS_IDLE,
 860         URIPS_SEEN_SLASH,
 861         URIPS_SEEN_SLASH_DOT,
 862         URIPS_SEEN_SLASH_DOT_DOT,
 863 };
 864
 865 enum uri_esc_states {
 866         URIES_IDLE,
 867         URIES_SEEN_PERCENT,
 868         URIES_SEEN_PERCENT_H1,
 869 };
 870
 871 /* notice that these union members:
 872  *
 873  *  hdr
 874  *  http
 875  *  http2
 876  *
 877  * all have a pointer to allocated_headers struct as their first member.
 878  *
 879  * It means for allocated_headers access, the three union paths can all be
 880  * used interchangeably to access the same data
 881  */
 882
 883
 884 #ifndef LWS_NO_CLIENT
 885 struct client_info_stash {
 886         char address[256];
 887         char path[1024];
 888         char host[256];
 889         char origin[256];
 890         char protocol[256];
 891         char method[16];
 892 };
 893 #endif
 894
 895 struct _lws_header_related {
 896         /* MUST be first in struct */
 897         struct allocated_headers *ah;
 898         struct lws *ah_wait_list;
 899         unsigned char *preamble_rx;
 900 #ifndef LWS_NO_CLIENT
 901         struct client_info_stash *stash;
 902 #endif
 903         unsigned int preamble_rx_len;
 904         enum uri_path_states ups;
 905         enum uri_esc_states ues;
 906         short lextable_pos;
 907         unsigned short current_token_limit;
 908 #ifndef LWS_NO_CLIENT
 909         unsigned short c_port;
 910 #endif
 911         char esc_stash;
 912         char post_literal_equal;
 913         unsigned char parser_state; /* enum lws_token_indexes */
 914         char redirects;
 915 };
 916
 917 struct _lws_http_mode_related {
 918         /* MUST be first in struct */
 919         struct allocated_headers *ah; /* mirroring  _lws_header_related */
 920         struct lws *ah_wait_list;
 921         unsigned char *preamble_rx;
 922 #ifndef LWS_NO_CLIENT
 923         struct client_info_stash *stash;
 924 #endif
 925         unsigned int preamble_rx_len;
 926         struct lws *new_wsi_list;
 927         unsigned long filepos;
 928         unsigned long filelen;
 929         lws_filefd_type fd;
 930
 931         enum http_version request_version;
 932         enum http_connection_type connection_type;
 933         unsigned int content_length;
 934         unsigned int content_remain;
 935 };
 936
 937 #ifdef LWS_USE_HTTP2
 938
 939 enum lws_http2_settings {
 940         LWS_HTTP2_SETTINGS__HEADER_TABLE_SIZE = 1,
 941         LWS_HTTP2_SETTINGS__ENABLE_PUSH,
 942         LWS_HTTP2_SETTINGS__MAX_CONCURRENT_STREAMS,
 943         LWS_HTTP2_SETTINGS__INITIAL_WINDOW_SIZE,
 944         LWS_HTTP2_SETTINGS__MAX_FRAME_SIZE,
 945         LWS_HTTP2_SETTINGS__MAX_HEADER_LIST_SIZE,
 946
 947         LWS_HTTP2_SETTINGS__COUNT /* always last */
 948 };
 949
 950 enum lws_http2_wellknown_frame_types {
 951         LWS_HTTP2_FRAME_TYPE_DATA,
 952         LWS_HTTP2_FRAME_TYPE_HEADERS,
 953         LWS_HTTP2_FRAME_TYPE_PRIORITY,
 954         LWS_HTTP2_FRAME_TYPE_RST_STREAM,
 955         LWS_HTTP2_FRAME_TYPE_SETTINGS,
 956         LWS_HTTP2_FRAME_TYPE_PUSH_PROMISE,
 957         LWS_HTTP2_FRAME_TYPE_PING,
 958         LWS_HTTP2_FRAME_TYPE_GOAWAY,
 959         LWS_HTTP2_FRAME_TYPE_WINDOW_UPDATE,
 960         LWS_HTTP2_FRAME_TYPE_CONTINUATION,
 961
 962         LWS_HTTP2_FRAME_TYPE_COUNT /* always last */
 963 };
 964
 965 enum lws_http2_flags {
 966         LWS_HTTP2_FLAG_END_STREAM = 1,
 967         LWS_HTTP2_FLAG_END_HEADERS = 4,
 968         LWS_HTTP2_FLAG_PADDED = 8,
 969         LWS_HTTP2_FLAG_PRIORITY = 0x20,
 970
 971         LWS_HTTP2_FLAG_SETTINGS_ACK = 1,
 972 };
 973
 974 #define LWS_HTTP2_STREAM_ID_MASTER 0
 975 #define LWS_HTTP2_FRAME_HEADER_LENGTH 9
 976 #define LWS_HTTP2_SETTINGS_LENGTH 6
 977
 978 struct http2_settings {
 979         unsigned int setting[LWS_HTTP2_SETTINGS__COUNT];
 980 };
 981
 982 enum http2_hpack_state {
 983
 984         /* optional before first header block */
 985         HPKS_OPT_PADDING,
 986         HKPS_OPT_E_DEPENDENCY,
 987         HKPS_OPT_WEIGHT,
 988
 989         /* header block */
 990         HPKS_TYPE,
 991
 992         HPKS_IDX_EXT,
 993
 994         HPKS_HLEN,
 995         HPKS_HLEN_EXT,
 996
 997         HPKS_DATA,
 998
 999         /* optional after last header block */
1000         HKPS_OPT_DISCARD_PADDING,
1001 };
1002
1003 enum http2_hpack_type {
1004         HPKT_INDEXED_HDR_7,
1005         HPKT_INDEXED_HDR_6_VALUE_INCR,
1006         HPKT_LITERAL_HDR_VALUE_INCR,
1007         HPKT_INDEXED_HDR_4_VALUE,
1008         HPKT_LITERAL_HDR_VALUE,
1009         HPKT_SIZE_5
1010 };
1011
1012 struct hpack_dt_entry {
1013         int token; /* additions that don't map to a token are ignored */
1014         int arg_offset;
1015         int arg_len;
1016 };
1017
1018 struct hpack_dynamic_table {
1019         struct hpack_dt_entry *entries;
1020         char *args;
1021         int pos;
1022         int next;
1023         int num_entries;
1024         int args_length;
1025 };
1026
1027 struct _lws_http2_related {
1028         /*
1029          * having this first lets us also re-use all HTTP union code
1030          * and in turn, http_mode_related has allocated headers in right
1031          * place so we can use the header apis on the wsi directly still
1032          */
1033         struct _lws_http_mode_related http; /* MUST BE FIRST IN STRUCT */
1034
1035         struct http2_settings my_settings;
1036         struct http2_settings peer_settings;
1037
1038         struct lws *parent_wsi;
1039         struct lws *next_child_wsi;
1040
1041         struct hpack_dynamic_table *hpack_dyn_table;
1042         struct lws *stream_wsi;
1043         unsigned char ping_payload[8];
1044         unsigned char one_setting[LWS_HTTP2_SETTINGS_LENGTH];
1045
1046         unsigned int count;
1047         unsigned int length;
1048         unsigned int stream_id;
1049         enum http2_hpack_state hpack;
1050         enum http2_hpack_type hpack_type;
1051         unsigned int header_index;
1052         unsigned int hpack_len;
1053         unsigned int hpack_e_dep;
1054         int tx_credit;
1055         unsigned int my_stream_id;
1056         unsigned int child_count;
1057         int my_priority;
1058
1059         unsigned int END_STREAM:1;
1060         unsigned int END_HEADERS:1;
1061         unsigned int send_END_STREAM:1;
1062         unsigned int GOING_AWAY;
1063         unsigned int requested_POLLOUT:1;
1064         unsigned int waiting_tx_credit:1;
1065         unsigned int huff:1;
1066         unsigned int value:1;
1067
1068         unsigned short round_robin_POLLOUT;
1069         unsigned short count_POLLOUT_children;
1070         unsigned short hpack_pos;
1071
1072         unsigned char type;
1073         unsigned char flags;
1074         unsigned char frame_state;
1075         unsigned char padding;
1076         unsigned char hpack_m;
1077         unsigned char initialized;
1078 };
1079
1080 #define HTTP2_IS_TOPLEVEL_WSI(wsi) (!wsi->u.http2.parent_wsi)
1081
1082 #endif
1083
1084 struct _lws_websocket_related {
1085         /* cheapest way to deal with ah overlap with ws union transition */
1086         struct _lws_header_related hdr;
1087         char *rx_ubuf;
1088         unsigned int rx_ubuf_alloc;
1089         struct lws *rx_draining_ext_list;
1090         struct lws *tx_draining_ext_list;
1091         size_t rx_packet_length;
1092         unsigned int rx_ubuf_head;
1093         unsigned char mask[4];
1094         /* Also used for close content... control opcode == < 128 */
1095         unsigned char ping_payload_buf[128 - 3 + LWS_PRE];
1096
1097         unsigned char ping_payload_len;
1098         unsigned char mask_idx;
1099         unsigned char opcode;
1100         unsigned char rsv;
1101         unsigned char rsv_first_msg;
1102         /* zero if no info, or length including 2-byte close code */
1103         unsigned char close_in_ping_buffer_len;
1104         unsigned char utf8;
1105         unsigned char stashed_write_type;
1106         unsigned char tx_draining_stashed_wp;
1107
1108         unsigned int final:1;
1109         unsigned int frame_is_binary:1;
1110         unsigned int all_zero_nonce:1;
1111         unsigned int this_frame_masked:1;
1112         unsigned int inside_frame:1; /* next write will be more of frame */
1113         unsigned int clean_buffer:1; /* buffer not rewritten by extension */
1114         unsigned int payload_is_close:1; /* process as PONG, but it is close */
1115         unsigned int ping_pending_flag:1;
1116         unsigned int continuation_possible:1;
1117         unsigned int owed_a_fin:1;
1118         unsigned int check_utf8:1;
1119         unsigned int defeat_check_utf8:1;
1120         unsigned int pmce_compressed_message:1;
1121         unsigned int stashed_write_pending:1;
1122         unsigned int rx_draining_ext:1;
1123         unsigned int tx_draining_ext:1;
1124 };
1125
1126 #ifdef LWS_WITH_CGI
1127
1128 /* wsi who is master of the cgi points to an lws_cgi */
1129
1130 struct lws_cgi {
1131         struct lws_cgi *cgi_list;
1132         struct lws *stdwsi[3]; /* points to the associated stdin/out/err wsis */
1133         struct lws *wsi; /* owner */
1134         unsigned long content_length;
1135         unsigned long content_length_seen;
1136         int pipe_fds[3][2];
1137         int pid;
1138
1139         unsigned int being_closed:1;
1140 };
1141 #endif
1142
1143 signed char char_to_hex(const char c);
1144
1145 #ifndef LWS_NO_CLIENT
1146 enum lws_chunk_parser {
1147         ELCP_HEX,
1148         ELCP_CR,
1149         ELCP_CONTENT,
1150         ELCP_POST_CR,
1151         ELCP_POST_LF,
1152 };
1153 #endif
1154
1155 struct lws_rewrite;
1156
1157 #ifdef LWS_WITH_ACCESS_LOG
1158 struct lws_access_log {
1159         char *header_log;
1160         char *user_agent;
1161         unsigned long sent;
1162         int response;
1163 };
1164 #endif
1165
1166 struct lws {
1167
1168         /* structs */
1169         /* members with mutually exclusive lifetimes are unionized */
1170
1171         union u {
1172                 struct _lws_http_mode_related http;
1173 #ifdef LWS_USE_HTTP2
1174                 struct _lws_http2_related http2;
1175 #endif
1176                 struct _lws_header_related hdr;
1177                 struct _lws_websocket_related ws;
1178         } u;
1179
1180         /* lifetime members */
1181
1182 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV)
1183         struct lws_io_watcher w_read;
1184 #endif
1185 #if defined(LWS_USE_LIBEV)
1186         struct lws_io_watcher w_write;
1187 #endif
1188         time_t pending_timeout_limit;
1189
1190         /* pointers */
1191
1192         struct lws_context *context;
1193         struct lws_vhost *vhost;
1194         struct lws *parent; /* points to parent, if any */
1195         struct lws *child_list; /* points to first child */
1196         struct lws *sibling_list; /* subsequent children at same level */
1197 #ifdef LWS_WITH_CGI
1198         struct lws_cgi *cgi; /* wsi being cgi master have one of these */
1199 #endif
1200         const struct lws_protocols *protocol;
1201         struct lws **same_vh_protocol_prev, *same_vh_protocol_next;
1202         struct lws *timeout_list;
1203         struct lws **timeout_list_prev;
1204 #ifdef LWS_WITH_ACCESS_LOG
1205         struct lws_access_log access_log;
1206 #endif
1207         void *user_space;
1208         /* rxflow handling */
1209         unsigned char *rxflow_buffer;
1210         /* truncated send handling */
1211         unsigned char *trunc_alloc; /* non-NULL means buffering in progress */
1212 #ifndef LWS_NO_EXTENSIONS
1213         const struct lws_extension *active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
1214         void *act_ext_user[LWS_MAX_EXTENSIONS_ACTIVE];
1215 #endif
1216 #ifdef LWS_OPENSSL_SUPPORT
1217         SSL *ssl;
1218 #if !defined(LWS_USE_POLARSSL) && !defined(LWS_USE_MBEDTLS)
1219         BIO *client_bio;
1220 #endif
1221         struct lws *pending_read_list_prev, *pending_read_list_next;
1222 #endif
1223 #ifdef LWS_WITH_HTTP_PROXY
1224         struct lws_rewrite *rw;
1225 #endif
1226 #ifdef LWS_LATENCY
1227         unsigned long action_start;
1228         unsigned long latency_start;
1229 #endif
1230         /* pointer / int */
1231         lws_sockfd_type sock;
1232
1233         /* ints */
1234         int position_in_fds_table;
1235         int rxflow_len;
1236         int rxflow_pos;
1237         unsigned int trunc_alloc_len; /* size of malloc */
1238         unsigned int trunc_offset; /* where we are in terms of spilling */
1239         unsigned int trunc_len; /* how much is buffered */
1240 #ifndef LWS_NO_CLIENT
1241         int chunk_remaining;
1242 #endif
1243         unsigned int cache_secs;
1244
1245         unsigned int hdr_parsing_completed:1;
1246         unsigned int http2_substream:1;
1247         unsigned int listener:1;
1248         unsigned int user_space_externally_allocated:1;
1249         unsigned int socket_is_permanently_unusable:1;
1250         unsigned int rxflow_change_to:2;
1251         unsigned int more_rx_waiting:1; /* has to live here since ah may stick to end */
1252         unsigned int conn_stat_done:1;
1253         unsigned int cache_reuse:1;
1254         unsigned int cache_revalidate:1;
1255         unsigned int cache_intermediaries:1;
1256         unsigned int favoured_pollin:1;
1257 #ifdef LWS_WITH_ACCESS_LOG
1258         unsigned int access_log_pending:1;
1259 #endif
1260 #ifndef LWS_NO_CLIENT
1261         unsigned int do_ws:1; /* whether we are doing http or ws flow */
1262         unsigned int chunked:1; /* if the clientside connection is chunked */
1263         unsigned int client_rx_avail:1;
1264 #endif
1265 #ifdef LWS_WITH_HTTP_PROXY
1266         unsigned int perform_rewrite:1;
1267 #endif
1268 #ifndef LWS_NO_EXTENSIONS
1269         unsigned int extension_data_pending:1;
1270 #endif
1271 #ifdef LWS_OPENSSL_SUPPORT
1272         unsigned int use_ssl:2;
1273         unsigned int upgraded:1;
1274 #endif
1275 #ifdef _WIN32
1276         unsigned int sock_send_blocking:1;
1277 #endif
1278 #ifdef LWS_OPENSSL_SUPPORT
1279         unsigned int redirect_to_https:1;
1280 #endif
1281
1282         /* chars */
1283 #ifndef LWS_NO_EXTENSIONS
1284         unsigned char count_act_ext;
1285 #endif
1286         unsigned char ietf_spec_revision;
1287         char mode; /* enum connection_mode */
1288         char state; /* enum lws_connection_states */
1289         char state_pre_close;
1290         char lws_rx_parse_state; /* enum lws_rx_parse_state */
1291         char rx_frame_type; /* enum lws_write_protocol */
1292         char pending_timeout; /* enum pending_timeout */
1293         char pps; /* enum lws_pending_protocol_send */
1294         char tsi; /* thread service index we belong to */
1295 #ifdef LWS_WITH_CGI
1296         char cgi_channel; /* which of stdin/out/err */
1297         char hdr_state;
1298 #endif
1299 #ifndef LWS_NO_CLIENT
1300         char chunk_parser; /* enum lws_chunk_parser */
1301 #endif
1302 };
1303
1304 LWS_EXTERN int log_level;
1305
1306 LWS_EXTERN int
1307 lws_socket_bind(struct lws_vhost *vhost, int sockfd, int port,
1308                 const char *iface);
1309
1310 LWS_EXTERN void
1311 lws_close_free_wsi(struct lws *wsi, enum lws_close_status);
1312
1313 LWS_EXTERN int
1314 remove_wsi_socket_from_fds(struct lws *wsi);
1315 LWS_EXTERN int
1316 lws_rxflow_cache(struct lws *wsi, unsigned char *buf, int n, int len);
1317
1318 #ifndef LWS_LATENCY
1319 static inline void
1320 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1321             int ret, int completion) {
1322         do {
1323                 (void)context; (void)wsi; (void)action; (void)ret;
1324                 (void)completion;
1325         } while (0);
1326 }
1327 static inline void
1328 lws_latency_pre(struct lws_context *context, struct lws *wsi) {
1329         do { (void)context; (void)wsi; } while (0);
1330 }
1331 #else
1332 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
1333 extern void
1334 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1335             int ret, int completion);
1336 #endif
1337
1338 LWS_EXTERN void
1339 lws_set_protocol_write_pending(struct lws *wsi,
1340                                enum lws_pending_protocol_send pend);
1341 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1342 lws_client_rx_sm(struct lws *wsi, unsigned char c);
1343
1344 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1345 lws_parse(struct lws *wsi, unsigned char c);
1346
1347 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1348 lws_http_action(struct lws *wsi);
1349
1350 LWS_EXTERN int
1351 lws_b64_selftest(void);
1352
1353 LWS_EXTERN int
1354 lws_service_adjust_timeout(struct lws_context *context, int timeout_ms, int tsi);
1355
1356 LWS_EXTERN int
1357 lws_service_flag_pending(struct lws_context *context, int tsi);
1358
1359 #if defined(_WIN32) || defined(MBED_OPERATORS)
1360 LWS_EXTERN struct lws *
1361 wsi_from_fd(const struct lws_context *context, lws_sockfd_type fd);
1362
1363 LWS_EXTERN int
1364 insert_wsi(struct lws_context *context, struct lws *wsi);
1365
1366 LWS_EXTERN int
1367 delete_from_fd(struct lws_context *context, lws_sockfd_type fd);
1368 #else
1369 #define wsi_from_fd(A,B)  A->lws_lookup[B]
1370 #define insert_wsi(A,B)   assert(A->lws_lookup[B->sock] == 0); A->lws_lookup[B->sock]=B
1371 #define delete_from_fd(A,B) A->lws_lookup[B]=0
1372 #endif
1373
1374 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1375 insert_wsi_socket_into_fds(struct lws_context *context, struct lws *wsi);
1376
1377 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1378 lws_issue_raw(struct lws *wsi, unsigned char *buf, size_t len);
1379
1380
1381 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1382 lws_service_timeout_check(struct lws *wsi, unsigned int sec);
1383
1384 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1385 lws_client_connect_2(struct lws *wsi);
1386
1387 LWS_VISIBLE struct lws * LWS_WARN_UNUSED_RESULT
1388 lws_client_reset(struct lws *wsi, int ssl, const char *address, int port,
1389                  const char *path, const char *host);
1390
1391 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1392 lws_create_new_server_wsi(struct lws_vhost *vhost);
1393
1394 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1395 lws_generate_client_handshake(struct lws *wsi, char *pkt);
1396
1397 LWS_EXTERN int
1398 lws_handle_POLLOUT_event(struct lws *wsi, struct lws_pollfd *pollfd);
1399
1400 LWS_EXTERN struct lws *
1401 lws_client_connect_via_info2(struct lws *wsi);
1402
1403 /*
1404  * EXTENSIONS
1405  */
1406
1407 #ifndef LWS_NO_EXTENSIONS
1408 LWS_VISIBLE void
1409 lws_context_init_extensions(struct lws_context_creation_info *info,
1410                             struct lws_context *context);
1411 LWS_EXTERN int
1412 lws_any_extension_handled(struct lws *wsi, enum lws_extension_callback_reasons r,
1413                           void *v, size_t len);
1414
1415 LWS_EXTERN int
1416 lws_ext_cb_active(struct lws *wsi, int reason, void *buf, int len);
1417 LWS_EXTERN int
1418 lws_ext_cb_all_exts(struct lws_context *context, struct lws *wsi, int reason,
1419                     void *arg, int len);
1420
1421 #else
1422 #define lws_any_extension_handled(_a, _b, _c, _d) (0)
1423 #define lws_ext_cb_active(_a, _b, _c, _d) (0)
1424 #define lws_ext_cb_all_exts(_a, _b, _c, _d, _e) (0)
1425 #define lws_issue_raw_ext_access lws_issue_raw
1426 #define lws_context_init_extensions(_a, _b)
1427 #endif
1428
1429 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1430 lws_client_interpret_server_handshake(struct lws *wsi);
1431
1432 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1433 lws_rx_sm(struct lws *wsi, unsigned char c);
1434
1435 LWS_EXTERN void
1436 lws_payload_until_length_exhausted(struct lws *wsi, unsigned char **buf, size_t *len);
1437
1438 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1439 lws_issue_raw_ext_access(struct lws *wsi, unsigned char *buf, size_t len);
1440
1441 LWS_EXTERN void
1442 lws_union_transition(struct lws *wsi, enum connection_mode mode);
1443
1444 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1445 user_callback_handle_rxflow(lws_callback_function, struct lws *wsi,
1446                             enum lws_callback_reasons reason, void *user,
1447                             void *in, size_t len);
1448 #ifdef LWS_USE_HTTP2
1449 LWS_EXTERN struct lws *lws_http2_get_network_wsi(struct lws *wsi);
1450 struct lws * lws_http2_get_nth_child(struct lws *wsi, int n);
1451 LWS_EXTERN int
1452 lws_http2_interpret_settings_payload(struct http2_settings *settings,
1453                                      unsigned char *buf, int len);
1454 LWS_EXTERN void lws_http2_init(struct http2_settings *settings);
1455 LWS_EXTERN int
1456 lws_http2_parser(struct lws *wsi, unsigned char c);
1457 LWS_EXTERN int lws_http2_do_pps_send(struct lws_context *context,
1458                                      struct lws *wsi);
1459 LWS_EXTERN int lws_http2_frame_write(struct lws *wsi, int type, int flags,
1460                                      unsigned int sid, unsigned int len,
1461                                      unsigned char *buf);
1462 LWS_EXTERN struct lws *
1463 lws_http2_wsi_from_id(struct lws *wsi, unsigned int sid);
1464 LWS_EXTERN int lws_hpack_interpret(struct lws *wsi,
1465                                    unsigned char c);
1466 LWS_EXTERN int
1467 lws_add_http2_header_by_name(struct lws *wsi,
1468                              const unsigned char *name,
1469                              const unsigned char *value, int length,
1470                              unsigned char **p, unsigned char *end);
1471 LWS_EXTERN int
1472 lws_add_http2_header_by_token(struct lws *wsi,
1473                             enum lws_token_indexes token,
1474                             const unsigned char *value, int length,
1475                             unsigned char **p, unsigned char *end);
1476 LWS_EXTERN int
1477 lws_add_http2_header_status(struct lws *wsi,
1478                             unsigned int code, unsigned char **p,
1479                             unsigned char *end);
1480 LWS_EXTERN
1481 void lws_http2_configure_if_upgraded(struct lws *wsi);
1482 #else
1483 #define lws_http2_configure_if_upgraded(x)
1484 #endif
1485
1486 LWS_EXTERN int
1487 lws_plat_set_socket_options(struct lws_vhost *vhost, lws_sockfd_type fd);
1488
1489 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1490 lws_header_table_attach(struct lws *wsi, int autoservice);
1491
1492 LWS_EXTERN int
1493 lws_header_table_detach(struct lws *wsi, int autoservice);
1494
1495 LWS_EXTERN void
1496 lws_header_table_reset(struct lws *wsi, int autoservice);
1497
1498 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1499 lws_hdr_simple_ptr(struct lws *wsi, enum lws_token_indexes h);
1500
1501 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1502 lws_hdr_simple_create(struct lws *wsi, enum lws_token_indexes h, const char *s);
1503
1504 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1505 lws_ensure_user_space(struct lws *wsi);
1506
1507 LWS_EXTERN int
1508 lws_change_pollfd(struct lws *wsi, int _and, int _or);
1509
1510 #ifndef LWS_NO_SERVER
1511 int lws_context_init_server(struct lws_context_creation_info *info,
1512                             struct lws_vhost *vhost);
1513 LWS_EXTERN struct lws_vhost *
1514 lws_select_vhost(struct lws_context *context, int port, const char *servername);
1515 LWS_EXTERN int
1516 handshake_0405(struct lws_context *context, struct lws *wsi);
1517 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1518 lws_interpret_incoming_packet(struct lws *wsi, unsigned char **buf, size_t len);
1519 LWS_EXTERN void
1520 lws_server_get_canonical_hostname(struct lws_context *context,
1521                                   struct lws_context_creation_info *info);
1522 #else
1523 #define lws_context_init_server(_a, _b) (0)
1524 #define lws_interpret_incoming_packet(_a, _b, _c) (0)
1525 #define lws_server_get_canonical_hostname(_a, _b)
1526 #endif
1527
1528 #ifndef LWS_NO_DAEMONIZE
1529 LWS_EXTERN int get_daemonize_pid();
1530 #else
1531 #define get_daemonize_pid() (0)
1532 #endif
1533
1534 #if !defined(MBED_OPERATORS)
1535 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1536 interface_to_sa(struct lws_context *context, const char *ifname,
1537                 struct sockaddr_in *addr, size_t addrlen);
1538 #endif
1539 LWS_EXTERN void lwsl_emit_stderr(int level, const char *line);
1540
1541 enum lws_ssl_capable_status {
1542         LWS_SSL_CAPABLE_ERROR = -1,
1543         LWS_SSL_CAPABLE_MORE_SERVICE = -2,
1544 };
1545
1546 #ifndef LWS_OPENSSL_SUPPORT
1547 #define LWS_SSL_ENABLED(context) (0)
1548 #define lws_context_init_server_ssl(_a, _b) (0)
1549 #define lws_ssl_destroy(_a)
1550 #define lws_context_init_http2_ssl(_a)
1551 #define lws_ssl_capable_read lws_ssl_capable_read_no_ssl
1552 #define lws_ssl_capable_write lws_ssl_capable_write_no_ssl
1553 #define lws_ssl_pending lws_ssl_pending_no_ssl
1554 #define lws_server_socket_service_ssl(_b, _c) (0)
1555 #define lws_ssl_close(_a) (0)
1556 #define lws_ssl_context_destroy(_a)
1557 #define lws_ssl_SSL_CTX_destroy(_a)
1558 #define lws_ssl_remove_wsi_from_buffered_list(_a)
1559 #define lws_context_init_ssl_library(_a)
1560 #else
1561 #define LWS_SSL_ENABLED(context) (context->use_ssl)
1562 LWS_EXTERN int openssl_websocket_private_data_index;
1563 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1564 lws_ssl_capable_read(struct lws *wsi, unsigned char *buf, int len);
1565 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1566 lws_ssl_capable_write(struct lws *wsi, unsigned char *buf, int len);
1567 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1568 lws_ssl_pending(struct lws *wsi);
1569 LWS_EXTERN int
1570 lws_context_init_ssl_library(struct lws_context_creation_info *info);
1571 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1572 lws_server_socket_service_ssl(struct lws *new_wsi, lws_sockfd_type accept_fd);
1573 LWS_EXTERN int
1574 lws_ssl_close(struct lws *wsi);
1575 LWS_EXTERN void
1576 lws_ssl_SSL_CTX_destroy(struct lws_vhost *vhost);
1577 LWS_EXTERN void
1578 lws_ssl_context_destroy(struct lws_context *context);
1579 LWS_VISIBLE void
1580 lws_ssl_remove_wsi_from_buffered_list(struct lws *wsi);
1581 LWS_EXTERN int
1582 lws_ssl_client_bio_create(struct lws *wsi);
1583 LWS_EXTERN int
1584 lws_ssl_client_connect1(struct lws *wsi);
1585 LWS_EXTERN int
1586 lws_ssl_client_connect2(struct lws *wsi);
1587 LWS_EXTERN void
1588 lws_ssl_elaborate_error(void);
1589 #ifndef LWS_NO_SERVER
1590 LWS_EXTERN int
1591 lws_context_init_server_ssl(struct lws_context_creation_info *info,
1592                             struct lws_vhost *vhost);
1593 #else
1594 #define lws_context_init_server_ssl(_a, _b) (0)
1595 #endif
1596 LWS_EXTERN void
1597 lws_ssl_destroy(struct lws_vhost *vhost);
1598
1599 /* HTTP2-related */
1600
1601 #ifdef LWS_USE_HTTP2
1602 LWS_EXTERN void
1603 lws_context_init_http2_ssl(struct lws_vhost *vhost);
1604 #else
1605 #define lws_context_init_http2_ssl(_a)
1606 #endif
1607 #endif
1608
1609 #if LWS_MAX_SMP > 1
1610 static LWS_INLINE void
1611 lws_pt_mutex_init(struct lws_context_per_thread *pt)
1612 {
1613         pthread_mutex_init(&pt->lock, NULL);
1614 }
1615 static LWS_INLINE void
1616 lws_pt_lock(struct lws_context_per_thread *pt)
1617 {
1618         pthread_mutex_lock(&pt->lock);
1619 }
1620
1621 static LWS_INLINE void
1622 lws_pt_unlock(struct lws_context_per_thread *pt)
1623 {
1624         pthread_mutex_unlock(&pt->lock);
1625 }
1626 #else
1627 #define lws_pt_mutex_init(_a) (void)(_a)
1628 #define lws_pt_lock(_a) (void)(_a)
1629 #define lws_pt_unlock(_a) (void)(_a)
1630 #endif
1631
1632 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1633 lws_ssl_capable_read_no_ssl(struct lws *wsi, unsigned char *buf, int len);
1634
1635 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1636 lws_ssl_capable_write_no_ssl(struct lws *wsi, unsigned char *buf, int len);
1637
1638 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1639 lws_ssl_pending_no_ssl(struct lws *wsi);
1640
1641 #ifdef LWS_WITH_HTTP_PROXY
1642 struct lws_rewrite {
1643         hubbub_parser *parser;
1644         hubbub_parser_optparams params;
1645         const char *from, *to;
1646         int from_len, to_len;
1647         unsigned char *p, *end;
1648         struct lws *wsi;
1649 };
1650 static LWS_INLINE int hstrcmp(hubbub_string *s, const char *p, int len)
1651 {
1652         if (s->len != len)
1653                 return 1;
1654
1655         return strncmp((const char *)s->ptr, p, len);
1656 }
1657 typedef hubbub_error (*hubbub_callback_t)(const hubbub_token *token, void *pw);
1658 LWS_EXTERN struct lws_rewrite *
1659 lws_rewrite_create(struct lws *wsi, hubbub_callback_t cb, const char *from, const char *to);
1660 LWS_EXTERN void
1661 lws_rewrite_destroy(struct lws_rewrite *r);
1662 LWS_EXTERN int
1663 lws_rewrite_parse(struct lws_rewrite *r, const unsigned char *in, int in_len);
1664 #endif
1665
1666 #ifndef LWS_NO_CLIENT
1667 LWS_EXTERN int lws_client_socket_service(struct lws_context *context,
1668                                          struct lws *wsi,
1669                                          struct lws_pollfd *pollfd);
1670 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1671 lws_http_transaction_completed_client(struct lws *wsi);
1672 #ifdef LWS_OPENSSL_SUPPORT
1673 LWS_EXTERN int
1674 lws_context_init_client_ssl(struct lws_context_creation_info *info,
1675                             struct lws_vhost *vhost);
1676 #else
1677         #define lws_context_init_client_ssl(_a, _b) (0)
1678 #endif
1679 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1680 lws_handshake_client(struct lws *wsi, unsigned char **buf, size_t len);
1681 LWS_EXTERN void
1682 lws_decode_ssl_error(void);
1683 #else
1684 #define lws_context_init_client_ssl(_a, _b) (0)
1685 #define lws_handshake_client(_a, _b, _c) (0)
1686 #endif
1687
1688 LWS_EXTERN int
1689 _lws_rx_flow_control(struct lws *wsi);
1690
1691 LWS_EXTERN int
1692 _lws_change_pollfd(struct lws *wsi, int _and, int _or, struct lws_pollargs *pa);
1693
1694 #ifndef LWS_NO_SERVER
1695 LWS_EXTERN int
1696 lws_server_socket_service(struct lws_context *context, struct lws *wsi,
1697                           struct lws_pollfd *pollfd);
1698 LWS_EXTERN int
1699 lws_handshake_server(struct lws *wsi, unsigned char **buf, size_t len);
1700 LWS_EXTERN int
1701 _lws_server_listen_accept_flow_control(struct lws *twsi, int on);
1702 #else
1703 #define lws_server_socket_service(_a, _b, _c) (0)
1704 #define lws_handshake_server(_a, _b, _c) (0)
1705 #define _lws_server_listen_accept_flow_control(a, b) (0)
1706 #endif
1707
1708 LWS_EXTERN int
1709 lws_get_addresses(struct lws_context *context, void *ads, char *name,
1710                   int name_len, char *rip, int rip_len);
1711
1712 LWS_EXTERN const char *
1713 lws_get_peer_simple(struct lws *wsi, char *name, int namelen);
1714
1715 #ifdef LWS_WITH_ACCESS_LOG
1716 LWS_EXTERN int
1717 lws_access_log(struct lws *wsi);
1718 #else
1719 #define lws_access_log(_a)
1720 #endif
1721
1722 LWS_EXTERN int
1723 lws_cgi_kill_terminated(struct lws_context_per_thread *pt);
1724
1725 int
1726 lws_protocol_init(struct lws_context *context);
1727
1728 /*
1729  * custom allocator
1730  */
1731 LWS_EXTERN void *
1732 lws_realloc(void *ptr, size_t size);
1733
1734 LWS_EXTERN void * LWS_WARN_UNUSED_RESULT
1735 lws_zalloc(size_t size);
1736
1737 #define lws_malloc(S)   lws_realloc(NULL, S)
1738 #define lws_free(P)     lws_realloc(P, 0)
1739 #define lws_free_set_NULL(P)    do { lws_realloc(P, 0); (P) = NULL; } while(0)
1740
1741 /* lws_plat_ */
1742 LWS_EXTERN void
1743 lws_plat_delete_socket_from_fds(struct lws_context *context,
1744                                 struct lws *wsi, int m);
1745 LWS_EXTERN void
1746 lws_plat_insert_socket_into_fds(struct lws_context *context,
1747                                 struct lws *wsi);
1748 LWS_EXTERN void
1749 lws_plat_service_periodic(struct lws_context *context);
1750
1751 LWS_EXTERN int
1752 lws_plat_change_pollfd(struct lws_context *context, struct lws *wsi,
1753                        struct lws_pollfd *pfd);
1754 LWS_EXTERN int
1755 lws_plat_context_early_init(void);
1756 LWS_EXTERN void
1757 lws_plat_context_early_destroy(struct lws_context *context);
1758 LWS_EXTERN void
1759 lws_plat_context_late_destroy(struct lws_context *context);
1760 LWS_EXTERN int
1761 lws_poll_listen_fd(struct lws_pollfd *fd);
1762 LWS_EXTERN int
1763 lws_plat_service(struct lws_context *context, int timeout_ms);
1764 LWS_EXTERN LWS_VISIBLE int
1765 lws_plat_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
1766 LWS_EXTERN int
1767 lws_plat_init(struct lws_context *context,
1768               struct lws_context_creation_info *info);
1769 LWS_EXTERN void
1770 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
1771 LWS_EXTERN unsigned long long
1772 time_in_microseconds(void);
1773 LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
1774 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);
1775
1776 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1777 lws_check_utf8(unsigned char *state, unsigned char *buf, size_t len);
1778
1779 #ifdef __cplusplus
1780 };
1781 #endif