lib/private-libwebsockets.h

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