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
  42 #if defined(LWS_WITH_ESP32)
  43 #define MSG_NOSIGNAL 0
  44 #define SOMAXCONN 3
  45 #endif
  46
  47 #if defined(LWS_WITH_ESP8266)
  48 #include <user_interface.h>
  49 #define assert(n)
  50
  51 /* rom-provided stdc functions for free, ensure use these instead of libc ones */
  52
  53 int ets_vsprintf(char *str, const char *format, va_list argptr);
  54 int ets_vsnprintf(char *buffer, size_t sizeOfBuffer,  const char *format, va_list argptr);
  55 int ets_snprintf(char *str, size_t size, const char *format, ...);
  56 int ets_sprintf(char *str, const char *format, ...);
  57 int os_printf_plus(const char *format, ...);
  58 #undef malloc
  59 #undef realloc
  60 #undef free
  61 void *pvPortMalloc(size_t s, const char *f, int line);
  62 #define malloc(s) pvPortMalloc(s, "", 0)
  63 void *pvPortRealloc(void *p, size_t s, const char *f, int line);
  64 #define realloc(p, s) pvPortRealloc(p, s, "", 0)
  65 void vPortFree(void *p, const char *f, int line);
  66 #define free(p) vPortFree(p, "", 0)
  67 #undef memcpy
  68 void *ets_memcpy(void *dest, const void *src, size_t n);
  69 #define memcpy ets_memcpy
  70 void *ets_memset(void *dest, int v, size_t n);
  71 #define memset ets_memset
  72 char *ets_strcpy(char *dest, const char *src);
  73 #define strcpy ets_strcpy
  74 char *ets_strncpy(char *dest, const char *src, size_t n);
  75 #define strncpy ets_strncpy
  76 char *ets_strstr(const char *haystack, const char *needle);
  77 #define strstr ets_strstr
  78 int ets_strcmp(const char *s1, const char *s2);
  79 int ets_strncmp(const char *s1, const char *s2, size_t n);
  80 #define strcmp ets_strcmp
  81 #define strncmp ets_strncmp
  82 size_t ets_strlen(const char *s);
  83 #define strlen ets_strlen
  84 void *ets_memmove(void *dest, const void *src, size_t n);
  85 #define memmove ets_memmove
  86 char *ets_strchr(const char *s, int c);
  87 #define strchr_ets_strchr
  88 #undef _DEBUG
  89 #include <osapi.h>
  90
  91 #else
  92 #define STORE_IN_ROM
  93 #include <assert.h>
  94 #endif
  95 #if LWS_MAX_SMP > 1
  96 #include <pthread.h>
  97 #endif
  98
  99 #ifdef LWS_HAVE_SYS_STAT_H
 100 #include <sys/stat.h>
 101 #endif
 102
 103 #if defined(WIN32) || defined(_WIN32)
 104 #if (WINVER < 0x0501)
 105 #undef WINVER
 106 #undef _WIN32_WINNT
 107 #define WINVER 0x0501
 108 #define _WIN32_WINNT WINVER
 109 #endif
 110 #define LWS_NO_DAEMONIZE
 111 #define LWS_ERRNO WSAGetLastError()
 112 #define LWS_EAGAIN WSAEWOULDBLOCK
 113 #define LWS_EALREADY WSAEALREADY
 114 #define LWS_EINPROGRESS WSAEINPROGRESS
 115 #define LWS_EINTR WSAEINTR
 116 #define LWS_EISCONN WSAEISCONN
 117 #define LWS_EWOULDBLOCK WSAEWOULDBLOCK
 118 #define MSG_NOSIGNAL 0
 119 #define SHUT_RDWR SD_BOTH
 120 #define SOL_TCP IPPROTO_TCP
 121 #define SHUT_WR SD_SEND
 122
 123 #define compatible_close(fd) closesocket(fd)
 124 #define lws_set_blocking_send(wsi) wsi->sock_send_blocking = 1
 125 #define lws_socket_is_valid(x) (!!x)
 126 #define LWS_SOCK_INVALID 0
 127 #include <winsock2.h>
 128 #include <ws2tcpip.h>
 129 #include <windows.h>
 130 #include <tchar.h>
 131 #ifdef LWS_HAVE_IN6ADDR_H
 132 #include <in6addr.h>
 133 #endif
 134 #include <mstcpip.h>
 135 #include <io.h>
 136
 137 #if !defined(LWS_HAVE_ATOLL)
 138 #if defined(LWS_HAVE__ATOI64)
 139 #define atoll _atoi64
 140 #else
 141 #warning No atoll or _atoi64 available, using atoi
 142 #define atoll atoi
 143 #endif
 144 #endif
 145
 146 #ifndef __func__
 147 #define __func__ __FUNCTION__
 148 #endif
 149
 150 #ifdef LWS_HAVE__VSNPRINTF
 151 #define vsnprintf _vsnprintf
 152 #endif
 153
 154 /* we don't have an implementation for this on windows... */
 155 int kill(int pid, int sig);
 156 int fork(void);
 157 #ifndef SIGINT
 158 #define SIGINT 2
 159 #endif
 160
 161 #else /* not windows --> */
 162
 163 #include <fcntl.h>
 164 #include <strings.h>
 165 #include <unistd.h>
 166 #include <sys/types.h>
 167
 168 #ifndef __cplusplus
 169 #include <errno.h>
 170 #endif
 171 #include <netdb.h>
 172 #include <signal.h>
 173 #ifdef LWS_WITH_ESP8266
 174 #include <sockets.h>
 175 #define vsnprintf ets_vsnprintf
 176 #define snprintf ets_snprintf
 177 #define sprintf ets_sprintf
 178
 179 int kill(int pid, int sig);
 180
 181 #else
 182 #include <sys/socket.h>
 183 #endif
 184 #ifdef LWS_WITH_HTTP_PROXY
 185 #include <hubbub/hubbub.h>
 186 #include <hubbub/parser.h>
 187 #endif
 188 #if defined(LWS_BUILTIN_GETIFADDRS)
 189  #include <getifaddrs.h>
 190 #else
 191  #if !defined(LWS_WITH_ESP8266) && !defined(LWS_WITH_ESP32)
 192  #include <ifaddrs.h>
 193  #endif
 194 #endif
 195 #if defined (__ANDROID__)
 196 #include <syslog.h>
 197 #include <sys/resource.h>
 198 #elif defined (__sun)
 199 #include <syslog.h>
 200 #else
 201 #if !defined(LWS_WITH_ESP8266)  && !defined(LWS_WITH_ESP32)
 202 #include <sys/syslog.h>
 203 #endif
 204 #endif
 205 #include <netdb.h>
 206 #if !defined(LWS_WITH_ESP8266) && !defined(LWS_WITH_ESP32)
 207 #include <sys/mman.h>
 208 #include <sys/un.h>
 209 #include <netinet/in.h>
 210 #include <netinet/tcp.h>
 211 #include <arpa/inet.h>
 212 #include <poll.h>
 213 #endif
 214 #ifdef LWS_USE_LIBEV
 215 #include <ev.h>
 216 #endif
 217 #ifdef LWS_USE_LIBUV
 218 #include <uv.h>
 219 #endif
 220 #ifdef LWS_USE_LIBEVENT
 221 #include <event2/event.h>
 222 #endif
 223
 224 #ifndef LWS_NO_FORK
 225 #ifdef LWS_HAVE_SYS_PRCTL_H
 226 #include <sys/prctl.h>
 227 #endif
 228 #endif
 229
 230 #include <sys/time.h>
 231
 232 #define LWS_ERRNO errno
 233 #define LWS_EAGAIN EAGAIN
 234 #define LWS_EALREADY EALREADY
 235 #define LWS_EINPROGRESS EINPROGRESS
 236 #define LWS_EINTR EINTR
 237 #define LWS_EISCONN EISCONN
 238 #define LWS_EWOULDBLOCK EWOULDBLOCK
 239
 240 #define lws_set_blocking_send(wsi)
 241
 242 #if defined(LWS_WITH_ESP8266)
 243 #define lws_socket_is_valid(x) ((x) != NULL)
 244 #define LWS_SOCK_INVALID (NULL)
 245 struct lws;
 246 const char *
 247 lws_plat_get_peer_simple(struct lws *wsi, char *name, int namelen);
 248 #else
 249 #define lws_socket_is_valid(x) (x >= 0)
 250 #define LWS_SOCK_INVALID (-1)
 251 #endif
 252 #endif
 253
 254 #ifndef LWS_HAVE_BZERO
 255 #ifndef bzero
 256 #define bzero(b, len) (memset((b), '\0', (len)), (void) 0)
 257 #endif
 258 #endif
 259
 260 #ifndef LWS_HAVE_STRERROR
 261 #define strerror(x) ""
 262 #endif
 263
 264 #ifdef LWS_OPENSSL_SUPPORT
 265
 266 #ifdef USE_WOLFSSL
 267 #ifdef USE_OLD_CYASSL
 268 #include <cyassl/openssl/ssl.h>
 269 #include <cyassl/error-ssl.h>
 270 #else
 271 #include <wolfssl/openssl/ssl.h>
 272 #include <wolfssl/error-ssl.h>
 273 #define OPENSSL_NO_TLSEXT
 274 #endif /* not USE_OLD_CYASSL */
 275 #else
 276 #include <openssl/ssl.h>
 277 #if !defined(LWS_WITH_ESP32)
 278 #include <openssl/evp.h>
 279 #include <openssl/err.h>
 280 #include <openssl/md5.h>
 281 #include <openssl/sha.h>
 282 #ifdef LWS_HAVE_OPENSSL_ECDH_H
 283 #include <openssl/ecdh.h>
 284 #endif
 285 #include <openssl/x509v3.h>
 286 #endif
 287 #if (OPENSSL_VERSION_NUMBER < 0x0009080afL)
 288 /* later openssl defines this to negate the presence of tlsext... but it was only
 289  * introduced at 0.9.8j.  Earlier versions don't know it exists so don't
 290  * define it... making it look like the feature exists...
 291  */
 292 #define OPENSSL_NO_TLSEXT
 293 #endif
 294 #endif /* not USE_WOLFSSL */
 295 #endif
 296
 297 #include "libwebsockets.h"
 298 #if defined(WIN32) || defined(_WIN32)
 299 #else
 300 static inline int compatible_close(int fd) { return close(fd); }
 301 #endif
 302
 303 #if defined(WIN32) || defined(_WIN32)
 304 #include <gettimeofday.h>
 305 #endif
 306
 307 #if defined(LWS_WITH_ESP8266)
 308 #undef compatible_close
 309 #define compatible_close(fd) { fd->state=ESPCONN_CLOSE; espconn_delete(fd); }
 310 lws_sockfd_type
 311 esp8266_create_tcp_stream_socket(void);
 312 void
 313 esp8266_tcp_stream_bind(lws_sockfd_type fd, int port, struct lws *wsi);
 314 #ifndef BIG_ENDIAN
 315 #define BIG_ENDIAN    4321  /* to show byte order (taken from gcc) */
 316 #endif
 317 #ifndef LITTLE_ENDIAN
 318 #define LITTLE_ENDIAN 1234
 319 #endif
 320 #ifndef BYTE_ORDER
 321 #define BYTE_ORDER LITTLE_ENDIAN
 322 #endif
 323 #endif
 324
 325
 326 #if defined(WIN32) || defined(_WIN32)
 327
 328 #ifndef BIG_ENDIAN
 329 #define BIG_ENDIAN    4321  /* to show byte order (taken from gcc) */
 330 #endif
 331 #ifndef LITTLE_ENDIAN
 332 #define LITTLE_ENDIAN 1234
 333 #endif
 334 #ifndef BYTE_ORDER
 335 #define BYTE_ORDER LITTLE_ENDIAN
 336 #endif
 337 #ifndef u_int64_t
 338 typedef unsigned __int64 u_int64_t;
 339 #endif
 340
 341 #undef __P
 342 #ifndef __P
 343 #if __STDC__
 344 #define __P(protos) protos
 345 #else
 346 #define __P(protos) ()
 347 #endif
 348 #endif
 349
 350 #else
 351
 352 #include <sys/stat.h>
 353 #include <sys/time.h>
 354
 355 #if defined(__APPLE__)
 356 #include <machine/endian.h>
 357 #elif defined(__FreeBSD__)
 358 #include <sys/endian.h>
 359 #elif defined(__linux__)
 360 #include <endian.h>
 361 #endif
 362
 363 #ifdef __cplusplus
 364 extern "C" {
 365 #endif
 366
 367 #if defined(__QNX__)
 368         #include <gulliver.h>
 369         #if defined(__LITTLEENDIAN__)
 370                 #define BYTE_ORDER __LITTLEENDIAN__
 371                 #define LITTLE_ENDIAN __LITTLEENDIAN__
 372                 #define BIG_ENDIAN 4321  /* to show byte order (taken from gcc); for suppres warning that BIG_ENDIAN is not defined. */
 373         #endif
 374         #if defined(__BIGENDIAN__)
 375                 #define BYTE_ORDER __BIGENDIAN__
 376                 #define LITTLE_ENDIAN 1234  /* to show byte order (taken from gcc); for suppres warning that LITTLE_ENDIAN is not defined. */
 377                 #define BIG_ENDIAN __BIGENDIAN__
 378         #endif
 379 #endif
 380
 381 #if defined(__sun) && defined(__GNUC__)
 382
 383 #include <arpa/nameser_compat.h>
 384
 385 #if !defined (BYTE_ORDER)
 386 # define BYTE_ORDER __BYTE_ORDER__
 387 #endif
 388
 389 #if !defined(LITTLE_ENDIAN)
 390 # define LITTLE_ENDIAN __ORDER_LITTLE_ENDIAN__
 391 #endif
 392
 393 #if !defined(BIG_ENDIAN)
 394 # define BIG_ENDIAN __ORDER_BIG_ENDIAN__
 395 #endif
 396
 397 #endif /* sun + GNUC */
 398
 399 #if !defined(BYTE_ORDER)
 400 # define BYTE_ORDER __BYTE_ORDER
 401 #endif
 402 #if !defined(LITTLE_ENDIAN)
 403 # define LITTLE_ENDIAN __LITTLE_ENDIAN
 404 #endif
 405 #if !defined(BIG_ENDIAN)
 406 # define BIG_ENDIAN __BIG_ENDIAN
 407 #endif
 408
 409 #endif
 410
 411 /*
 412  * Mac OSX as well as iOS do not define the MSG_NOSIGNAL flag,
 413  * but happily have something equivalent in the SO_NOSIGPIPE flag.
 414  */
 415 #ifdef __APPLE__
 416 #define MSG_NOSIGNAL SO_NOSIGPIPE
 417 #endif
 418
 419 /*
 420  * Solaris 11.X only supports POSIX 2001, MSG_NOSIGNAL appears in
 421  * POSIX 2008.
 422  */
 423 #ifdef __sun
 424 #define MSG_NOSIGNAL 0
 425 #endif
 426
 427 #ifdef _WIN32
 428 #ifndef FD_HASHTABLE_MODULUS
 429 #define FD_HASHTABLE_MODULUS 32
 430 #endif
 431 #endif
 432
 433 #ifndef LWS_DEF_HEADER_LEN
 434 #define LWS_DEF_HEADER_LEN 4096
 435 #endif
 436 #ifndef LWS_DEF_HEADER_POOL
 437 #define LWS_DEF_HEADER_POOL 4
 438 #endif
 439 #ifndef LWS_MAX_PROTOCOLS
 440 #define LWS_MAX_PROTOCOLS 5
 441 #endif
 442 #ifndef LWS_MAX_EXTENSIONS_ACTIVE
 443 #define LWS_MAX_EXTENSIONS_ACTIVE 2
 444 #endif
 445 #ifndef LWS_MAX_EXT_OFFERS
 446 #define LWS_MAX_EXT_OFFERS 8
 447 #endif
 448 #ifndef SPEC_LATEST_SUPPORTED
 449 #define SPEC_LATEST_SUPPORTED 13
 450 #endif
 451 #ifndef AWAITING_TIMEOUT
 452 #define AWAITING_TIMEOUT 20
 453 #endif
 454 #ifndef CIPHERS_LIST_STRING
 455 #define CIPHERS_LIST_STRING "DEFAULT"
 456 #endif
 457 #ifndef LWS_SOMAXCONN
 458 #define LWS_SOMAXCONN SOMAXCONN
 459 #endif
 460
 461 #define MAX_WEBSOCKET_04_KEY_LEN 128
 462
 463 #ifndef SYSTEM_RANDOM_FILEPATH
 464 #define SYSTEM_RANDOM_FILEPATH "/dev/urandom"
 465 #endif
 466
 467 enum lws_websocket_opcodes_07 {
 468         LWSWSOPC_CONTINUATION = 0,
 469         LWSWSOPC_TEXT_FRAME = 1,
 470         LWSWSOPC_BINARY_FRAME = 2,
 471
 472         LWSWSOPC_NOSPEC__MUX = 7,
 473
 474         /* control extensions 8+ */
 475
 476         LWSWSOPC_CLOSE = 8,
 477         LWSWSOPC_PING = 9,
 478         LWSWSOPC_PONG = 0xa,
 479 };
 480
 481
 482 enum lws_connection_states {
 483         LWSS_HTTP,
 484         LWSS_HTTP_ISSUING_FILE,
 485         LWSS_HTTP_HEADERS,
 486         LWSS_HTTP_BODY,
 487         LWSS_DEAD_SOCKET,
 488         LWSS_ESTABLISHED,
 489         LWSS_CLIENT_HTTP_ESTABLISHED,
 490         LWSS_CLIENT_UNCONNECTED,
 491         LWSS_WAITING_TO_SEND_CLOSE_NOTIFICATION,
 492         LWSS_RETURNED_CLOSE_ALREADY,
 493         LWSS_AWAITING_CLOSE_ACK,
 494         LWSS_FLUSHING_STORED_SEND_BEFORE_CLOSE,
 495         LWSS_SHUTDOWN,
 496
 497         LWSS_HTTP2_AWAIT_CLIENT_PREFACE,
 498         LWSS_HTTP2_ESTABLISHED_PRE_SETTINGS,
 499         LWSS_HTTP2_ESTABLISHED,
 500
 501         LWSS_CGI,
 502 };
 503
 504 enum http_version {
 505         HTTP_VERSION_1_0,
 506         HTTP_VERSION_1_1,
 507         HTTP_VERSION_2
 508 };
 509
 510 enum http_connection_type {
 511         HTTP_CONNECTION_CLOSE,
 512         HTTP_CONNECTION_KEEP_ALIVE
 513 };
 514
 515 enum lws_pending_protocol_send {
 516         LWS_PPS_NONE,
 517         LWS_PPS_HTTP2_MY_SETTINGS,
 518         LWS_PPS_HTTP2_ACK_SETTINGS,
 519         LWS_PPS_HTTP2_PONG,
 520 };
 521
 522 enum lws_rx_parse_state {
 523         LWS_RXPS_NEW,
 524
 525         LWS_RXPS_04_mask_1,
 526         LWS_RXPS_04_mask_2,
 527         LWS_RXPS_04_mask_3,
 528
 529         LWS_RXPS_04_FRAME_HDR_1,
 530         LWS_RXPS_04_FRAME_HDR_LEN,
 531         LWS_RXPS_04_FRAME_HDR_LEN16_2,
 532         LWS_RXPS_04_FRAME_HDR_LEN16_1,
 533         LWS_RXPS_04_FRAME_HDR_LEN64_8,
 534         LWS_RXPS_04_FRAME_HDR_LEN64_7,
 535         LWS_RXPS_04_FRAME_HDR_LEN64_6,
 536         LWS_RXPS_04_FRAME_HDR_LEN64_5,
 537         LWS_RXPS_04_FRAME_HDR_LEN64_4,
 538         LWS_RXPS_04_FRAME_HDR_LEN64_3,
 539         LWS_RXPS_04_FRAME_HDR_LEN64_2,
 540         LWS_RXPS_04_FRAME_HDR_LEN64_1,
 541
 542         LWS_RXPS_07_COLLECT_FRAME_KEY_1,
 543         LWS_RXPS_07_COLLECT_FRAME_KEY_2,
 544         LWS_RXPS_07_COLLECT_FRAME_KEY_3,
 545         LWS_RXPS_07_COLLECT_FRAME_KEY_4,
 546
 547         LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED
 548 };
 549
 550 #define LWSCM_FLAG_IMPLIES_CALLBACK_CLOSED_CLIENT_HTTP 32
 551
 552 enum connection_mode {
 553         LWSCM_HTTP_SERVING,
 554         LWSCM_HTTP_SERVING_ACCEPTED, /* actual HTTP service going on */
 555         LWSCM_PRE_WS_SERVING_ACCEPT,
 556
 557         LWSCM_WS_SERVING,
 558         LWSCM_WS_CLIENT,
 559
 560         LWSCM_HTTP2_SERVING,
 561
 562         /* transient, ssl delay hiding */
 563         LWSCM_SSL_ACK_PENDING,
 564         LWSCM_SSL_INIT,
 565         /* as above, but complete into LWSCM_RAW */
 566         LWSCM_SSL_ACK_PENDING_RAW,
 567         LWSCM_SSL_INIT_RAW,
 568
 569         /* special internal types */
 570         LWSCM_SERVER_LISTENER,
 571         LWSCM_CGI, /* stdin, stdout, stderr for another cgi master wsi */
 572         LWSCM_RAW, /* raw with bulk handling */
 573         LWSCM_RAW_FILEDESC, /* raw without bulk handling */
 574
 575         /* HTTP Client related */
 576         LWSCM_HTTP_CLIENT = LWSCM_FLAG_IMPLIES_CALLBACK_CLOSED_CLIENT_HTTP,
 577         LWSCM_HTTP_CLIENT_ACCEPTED, /* actual HTTP service going on */
 578         LWSCM_WSCL_WAITING_CONNECT,
 579         LWSCM_WSCL_WAITING_PROXY_REPLY,
 580         LWSCM_WSCL_ISSUE_HANDSHAKE,
 581         LWSCM_WSCL_ISSUE_HANDSHAKE2,
 582         LWSCM_WSCL_ISSUE_HTTP_BODY,
 583         LWSCM_WSCL_WAITING_SSL,
 584         LWSCM_WSCL_WAITING_SERVER_REPLY,
 585         LWSCM_WSCL_WAITING_EXTENSION_CONNECT,
 586         LWSCM_WSCL_PENDING_CANDIDATE_CHILD,
 587         LWSCM_WSCL_WAITING_SOCKS_GREETING_REPLY,
 588         LWSCM_WSCL_WAITING_SOCKS_CONNECT_REPLY,
 589         LWSCM_WSCL_WAITING_SOCKS_AUTH_REPLY,
 590
 591         /****** add new things just above ---^ ******/
 592
 593
 594 };
 595
 596 /* enums of socks version */
 597 enum socks_version {
 598         SOCKS_VERSION_4 = 4,
 599         SOCKS_VERSION_5 = 5
 600 };
 601
 602 /* enums of subnegotiation version */
 603 enum socks_subnegotiation_version {
 604         SOCKS_SUBNEGOTIATION_VERSION_1 = 1,
 605 };
 606
 607 /* enums of socks commands */
 608 enum socks_command {
 609         SOCKS_COMMAND_CONNECT = 1,
 610         SOCKS_COMMAND_BIND = 2,
 611         SOCKS_COMMAND_UDP_ASSOCIATE = 3
 612 };
 613
 614 /* enums of socks address type */
 615 enum socks_atyp {
 616         SOCKS_ATYP_IPV4 = 1,
 617         SOCKS_ATYP_DOMAINNAME = 3,
 618         SOCKS_ATYP_IPV6 = 4
 619 };
 620
 621 /* enums of socks authentication methods */
 622 enum socks_auth_method {
 623         SOCKS_AUTH_NO_AUTH = 0,
 624         SOCKS_AUTH_GSSAPI = 1,
 625         SOCKS_AUTH_USERNAME_PASSWORD = 2
 626 };
 627
 628 /* enums of subnegotiation status */
 629 enum socks_subnegotiation_status {
 630         SOCKS_SUBNEGOTIATION_STATUS_SUCCESS = 0,
 631 };
 632
 633 /* enums of socks request reply */
 634 enum socks_request_reply {
 635         SOCKS_REQUEST_REPLY_SUCCESS = 0,
 636         SOCKS_REQUEST_REPLY_FAILURE_GENERAL = 1,
 637         SOCKS_REQUEST_REPLY_CONNECTION_NOT_ALLOWED = 2,
 638         SOCKS_REQUEST_REPLY_NETWORK_UNREACHABLE = 3,
 639         SOCKS_REQUEST_REPLY_HOST_UNREACHABLE = 4,
 640         SOCKS_REQUEST_REPLY_CONNECTION_REFUSED = 5,
 641         SOCKS_REQUEST_REPLY_TTL_EXPIRED = 6,
 642         SOCKS_REQUEST_REPLY_COMMAND_NOT_SUPPORTED = 7,
 643         SOCKS_REQUEST_REPLY_ATYP_NOT_SUPPORTED = 8
 644 };
 645
 646 /* enums used to generate socks messages */
 647 enum socks_msg_type {
 648         /* greeting */
 649         SOCKS_MSG_GREETING,
 650         /* credential, user name and password */
 651         SOCKS_MSG_USERNAME_PASSWORD,
 652         /* connect command */
 653         SOCKS_MSG_CONNECT
 654 };
 655
 656 enum {
 657         LWS_RXFLOW_ALLOW = (1 << 0),
 658         LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
 659 };
 660
 661 /* this is not usable directly by user code any more, lws_close_reason() */
 662 #define LWS_WRITE_CLOSE 4
 663
 664 struct lws_protocols;
 665 struct lws;
 666
 667 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
 668
 669 struct lws_io_watcher {
 670 #ifdef LWS_USE_LIBEV
 671         ev_io ev_watcher;
 672 #endif
 673 #ifdef LWS_USE_LIBUV
 674         uv_poll_t uv_watcher;
 675 #endif
 676 #ifdef LWS_USE_LIBEVENT
 677         struct event *event_watcher;
 678 #endif
 679         struct lws_context *context;
 680 };
 681
 682 struct lws_signal_watcher {
 683 #ifdef LWS_USE_LIBEV
 684         ev_signal ev_watcher;
 685 #endif
 686 #ifdef LWS_USE_LIBUV
 687         uv_signal_t uv_watcher;
 688 #endif
 689 #ifdef LWS_USE_LIBEVENT
 690         struct event *event_watcher;
 691 #endif
 692         struct lws_context *context;
 693 };
 694 #endif
 695
 696 #ifdef _WIN32
 697 #define LWS_FD_HASH(fd) ((fd ^ (fd >> 8) ^ (fd >> 16)) % FD_HASHTABLE_MODULUS)
 698 struct lws_fd_hashtable {
 699         struct lws **wsi;
 700         int length;
 701 };
 702 #endif
 703
 704 /*
 705  * This is totally opaque to code using the library.  It's exported as a
 706  * forward-reference pointer-only declaration; the user can use the pointer with
 707  * other APIs to get information out of it.
 708  */
 709
 710 struct lws_fragments {
 711         unsigned int offset;
 712         unsigned short len;
 713         unsigned char nfrag; /* which ah->frag[] continues this content, or 0 */
 714 };
 715
 716 /*
 717  * these are assigned from a pool held in the context.
 718  * Both client and server mode uses them for http header analysis
 719  */
 720
 721 struct allocated_headers {
 722         struct lws *wsi; /* owner */
 723         char *data; /* prepared by context init to point to dedicated storage */
 724         /*
 725          * the randomly ordered fragments, indexed by frag_index and
 726          * lws_fragments->nfrag for continuation.
 727          */
 728         struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
 729         time_t assigned;
 730         /*
 731          * for each recognized token, frag_index says which frag[] his data
 732          * starts in (0 means the token did not appear)
 733          * the actual header data gets dumped as it comes in, into data[]
 734          */
 735         unsigned char frag_index[WSI_TOKEN_COUNT];
 736         unsigned char rx[2048];
 737
 738         unsigned int rxpos;
 739         unsigned int rxlen;
 740         unsigned int pos;
 741
 742         unsigned int http_response;
 743
 744 #ifndef LWS_NO_CLIENT
 745         char initial_handshake_hash_base64[30];
 746 #endif
 747
 748         unsigned char in_use;
 749         unsigned char nfrag;
 750 };
 751
 752 /*
 753  * so we can have n connections being serviced simultaneously,
 754  * these things need to be isolated per-thread.
 755  */
 756
 757 struct lws_context_per_thread {
 758 #if LWS_MAX_SMP > 1
 759         pthread_mutex_t lock;
 760 #endif
 761         struct lws_pollfd *fds;
 762 #if defined(LWS_WITH_ESP8266)
 763         struct lws **lws_vs_fds_index;
 764 #endif
 765         struct lws *rx_draining_ext_list;
 766         struct lws *tx_draining_ext_list;
 767         struct lws *timeout_list;
 768 #if defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
 769         struct lws_context *context;
 770 #endif
 771 #ifdef LWS_WITH_CGI
 772         struct lws_cgi *cgi_list;
 773 #endif
 774         void *http_header_data;
 775         struct allocated_headers *ah_pool;
 776         struct lws *ah_wait_list;
 777         int ah_wait_list_length;
 778 #ifdef LWS_OPENSSL_SUPPORT
 779         struct lws *pending_read_list; /* linked list */
 780 #endif
 781 #if defined(LWS_USE_LIBEV)
 782         struct ev_loop *io_loop_ev;
 783 #endif
 784 #if defined(LWS_USE_LIBUV)
 785         uv_loop_t *io_loop_uv;
 786         uv_signal_t signals[8];
 787         uv_timer_t uv_timeout_watcher;
 788         uv_idle_t uv_idle;
 789 #endif
 790 #if defined(LWS_USE_LIBEVENT)
 791         struct event_base *io_loop_event_base;
 792 #endif
 793 #if defined(LWS_USE_LIBEV)
 794         struct lws_io_watcher w_accept;
 795 #endif
 796 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
 797         struct lws_signal_watcher w_sigint;
 798         unsigned char ev_loop_foreign:1;
 799 #endif
 800
 801         unsigned long count_conns;
 802         /*
 803          * usable by anything in the service code, but only if the scope
 804          * does not last longer than the service action (since next service
 805          * of any socket can likewise use it and overwrite)
 806          */
 807         unsigned char *serv_buf;
 808 #ifdef _WIN32
 809         WSAEVENT *events;
 810 #else
 811         lws_sockfd_type dummy_pipe_fds[2];
 812 #endif
 813         unsigned int fds_count;
 814
 815         short ah_count_in_use;
 816         unsigned char tid;
 817         unsigned char lock_depth;
 818 };
 819
 820 struct lws_conn_stats {
 821         unsigned long long rx, tx;
 822         unsigned long conn, trans, ws_upg, http2_upg, rejected;
 823 };
 824
 825 void
 826 lws_sum_stats(const struct lws_context *ctx, struct lws_conn_stats *cs);
 827
 828 /*
 829  * virtual host -related context information
 830  *   vhostwide SSL context
 831  *   vhostwide proxy
 832  *
 833  * hierarchy:
 834  *
 835  * context -> vhost -> wsi
 836  *
 837  * incoming connection non-SSL vhost binding:
 838  *
 839  *    listen socket -> wsi -> select vhost after first headers
 840  *
 841  * incoming connection SSL vhost binding:
 842  *
 843  *    SSL SNI -> wsi -> bind after SSL negotiation
 844  */
 845
 846 struct lws_vhost {
 847 #if !defined(LWS_WITH_ESP8266)
 848         char http_proxy_address[128];
 849         char proxy_basic_auth_token[128];
 850 #if defined(LWS_WITH_SOCKS5)
 851         char socks_proxy_address[128];
 852         char socks_user[96];
 853         char socks_password[96];
 854 #endif
 855 #endif
 856 #if defined(LWS_WITH_ESP8266)
 857         /* listen sockets need a place to hang their hat */
 858         esp_tcp tcp;
 859 #endif
 860         struct lws_conn_stats conn_stats;
 861         struct lws_context *context;
 862         struct lws_vhost *vhost_next;
 863         const struct lws_http_mount *mount_list;
 864         struct lws *lserv_wsi;
 865         const char *name;
 866         const char *iface;
 867 #if !defined(LWS_WITH_ESP8266) && !defined(LWS_WITH_ESP32) && !defined(OPTEE_TA) && !defined(WIN32)
 868         int bind_iface;
 869 #endif
 870         const struct lws_protocols *protocols;
 871         void **protocol_vh_privs;
 872         const struct lws_protocol_vhost_options *pvo;
 873         const struct lws_protocol_vhost_options *headers;
 874         struct lws **same_vh_protocol_list;
 875 #ifdef LWS_OPENSSL_SUPPORT
 876         SSL_CTX *ssl_ctx;
 877         SSL_CTX *ssl_client_ctx;
 878 #endif
 879 #ifndef LWS_NO_EXTENSIONS
 880         const struct lws_extension *extensions;
 881 #endif
 882
 883         int listen_port;
 884         unsigned int http_proxy_port;
 885 #if defined(LWS_WITH_SOCKS5)
 886         unsigned int socks_proxy_port;
 887 #endif
 888         unsigned int options;
 889         int count_protocols;
 890         int ka_time;
 891         int ka_probes;
 892         int ka_interval;
 893         int keepalive_timeout;
 894         int ssl_info_event_mask;
 895 #ifdef LWS_WITH_ACCESS_LOG
 896         int log_fd;
 897 #endif
 898
 899 #ifdef LWS_OPENSSL_SUPPORT
 900         int use_ssl;
 901         int allow_non_ssl_on_ssl_port;
 902         unsigned int user_supplied_ssl_ctx:1;
 903 #endif
 904
 905         unsigned int created_vhost_protocols:1;
 906         unsigned int being_destroyed:1;
 907
 908         unsigned char default_protocol_index;
 909         unsigned char raw_protocol_index;
 910 };
 911
 912 struct lws_deferred_free
 913 {
 914         struct lws_deferred_free *next;
 915         time_t deadline;
 916         void *payload;
 917 };
 918
 919 /*
 920  * the rest is managed per-context, that includes
 921  *
 922  *  - processwide single fd -> wsi lookup
 923  *  - contextwide headers pool
 924  */
 925
 926 struct lws_context {
 927         time_t last_timeout_check_s;
 928         time_t last_ws_ping_pong_check_s;
 929         time_t time_up;
 930         const struct lws_plat_file_ops *fops;
 931         struct lws_plat_file_ops fops_platform;
 932 #if defined(LWS_WITH_ZIP_FOPS)
 933         struct lws_plat_file_ops fops_zip;
 934 #endif
 935         struct lws_context_per_thread pt[LWS_MAX_SMP];
 936         struct lws_conn_stats conn_stats;
 937 #ifdef _WIN32
 938 /* different implementation between unix and windows */
 939         struct lws_fd_hashtable fd_hashtable[FD_HASHTABLE_MODULUS];
 940 #else
 941 #if defined(LWS_WITH_ESP8266)
 942         struct espconn **connpool; /* .reverse points to the wsi */
 943         void *rxd;
 944         int rxd_len;
 945         os_timer_t to_timer;
 946 #else
 947         struct lws **lws_lookup;  /* fd to wsi */
 948 #endif
 949 #endif
 950         struct lws_vhost *vhost_list;
 951         struct lws_vhost *vhost_pending_destruction_list;
 952         struct lws_plugin *plugin_list;
 953         struct lws_deferred_free *deferred_free_list;
 954
 955         void *external_baggage_free_on_destroy;
 956         const struct lws_token_limits *token_limits;
 957         void *user_space;
 958         const char *server_string;
 959         const struct lws_protocol_vhost_options *reject_service_keywords;
 960         lws_reload_func deprecation_cb;
 961
 962 #if defined(LWS_HAVE_SYS_CAPABILITY_H) && defined(LWS_HAVE_LIBCAP)
 963         cap_value_t caps[4];
 964         char count_caps;
 965 #endif
 966
 967 #if defined(LWS_USE_LIBEV)
 968         lws_ev_signal_cb_t * lws_ev_sigint_cb;
 969 #endif
 970 #if defined(LWS_USE_LIBUV)
 971         uv_signal_cb lws_uv_sigint_cb;
 972         uv_loop_t pu_loop;
 973 #endif
 974 #if defined(LWS_USE_LIBEVENT)
 975         lws_event_signal_cb_t * lws_event_sigint_cb;
 976 #endif
 977         char canonical_hostname[128];
 978 #ifdef LWS_LATENCY
 979         unsigned long worst_latency;
 980         char worst_latency_info[256];
 981 #endif
 982
 983 #if defined(LWS_WITH_STATS)
 984         uint64_t lws_stats[LWSSTATS_SIZE];
 985         uint64_t last_dump;
 986         int updated;
 987 #endif
 988
 989         int max_fds;
 990 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
 991         int use_ev_sigint;
 992 #endif
 993         int started_with_parent;
 994         int uid, gid;
 995
 996         int fd_random;
 997 #ifdef LWS_OPENSSL_SUPPORT
 998 #define lws_ssl_anybody_has_buffered_read(w) \
 999                 (w->vhost->use_ssl && \
1000                  w->context->pt[(int)w->tsi].pending_read_list)
1001 #define lws_ssl_anybody_has_buffered_read_tsi(c, t) \
1002                 (/*c->use_ssl && */ \
1003                  c->pt[(int)t].pending_read_list)
1004 #else
1005 #define lws_ssl_anybody_has_buffered_read(ctx) (0)
1006 #define lws_ssl_anybody_has_buffered_read_tsi(ctx, t) (0)
1007 #endif
1008         int count_wsi_allocated;
1009         int count_cgi_spawned;
1010         unsigned int options;
1011         unsigned int fd_limit_per_thread;
1012         unsigned int timeout_secs;
1013         unsigned int pt_serv_buf_size;
1014         int max_http_header_data;
1015         int simultaneous_ssl_restriction;
1016         int simultaneous_ssl;
1017
1018         unsigned int deprecated:1;
1019         unsigned int being_destroyed:1;
1020         unsigned int being_destroyed1:1;
1021         unsigned int requested_kill:1;
1022         unsigned int protocol_init_done:1;
1023         unsigned int ssl_gate_accepts:1;
1024         /*
1025          * set to the Thread ID that's doing the service loop just before entry
1026          * to poll indicates service thread likely idling in poll()
1027          * volatile because other threads may check it as part of processing
1028          * for pollfd event change.
1029          */
1030         volatile int service_tid;
1031         int service_tid_detected;
1032
1033         short max_http_header_pool;
1034         short count_threads;
1035         short plugin_protocol_count;
1036         short plugin_extension_count;
1037         short server_string_len;
1038         unsigned short ws_ping_pong_interval;
1039         unsigned short deprecation_pending_listen_close_count;
1040         uint8_t max_fi;
1041 };
1042
1043 int
1044 lws_check_deferred_free(struct lws_context *context, int force);
1045
1046 #define lws_get_context_protocol(ctx, x) ctx->vhost_list->protocols[x]
1047 #define lws_get_vh_protocol(vh, x) vh->protocols[x]
1048
1049 LWS_EXTERN void
1050 lws_close_free_wsi_final(struct lws *wsi);
1051 LWS_EXTERN void
1052 lws_libuv_closehandle(struct lws *wsi);
1053 LWS_EXTERN void
1054 lws_libuv_closehandle_manually(struct lws *wsi);
1055 LWS_EXTERN int
1056 lws_libuv_check_watcher_active(struct lws *wsi);
1057
1058 LWS_VISIBLE LWS_EXTERN int
1059 lws_plat_plugins_init(struct lws_context * context, const char * const *d);
1060
1061 LWS_VISIBLE LWS_EXTERN int
1062 lws_plat_plugins_destroy(struct lws_context * context);
1063
1064 LWS_EXTERN void
1065 lws_restart_ws_ping_pong_timer(struct lws *wsi);
1066
1067 struct lws *
1068 lws_adopt_socket_vhost(struct lws_vhost *vh, lws_sockfd_type accept_fd);
1069
1070
1071 enum {
1072         LWS_EV_READ = (1 << 0),
1073         LWS_EV_WRITE = (1 << 1),
1074         LWS_EV_START = (1 << 2),
1075         LWS_EV_STOP = (1 << 3),
1076
1077         LWS_EV_PREPARE_DELETION = (1 << 31),
1078 };
1079
1080 #if defined(LWS_USE_LIBEV)
1081 LWS_EXTERN void
1082 lws_libev_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
1083 LWS_EXTERN void
1084 lws_libev_io(struct lws *wsi, int flags);
1085 LWS_EXTERN int
1086 lws_libev_init_fd_table(struct lws_context *context);
1087 LWS_EXTERN void
1088 lws_libev_destroyloop(struct lws_context *context, int tsi);
1089 LWS_EXTERN void
1090 lws_libev_run(const struct lws_context *context, int tsi);
1091 #define LWS_LIBEV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBEV)
1092 LWS_EXTERN void lws_feature_status_libev(struct lws_context_creation_info *info);
1093 #else
1094 #define lws_libev_accept(_a, _b) ((void) 0)
1095 #define lws_libev_io(_a, _b) ((void) 0)
1096 #define lws_libev_init_fd_table(_a) (0)
1097 #define lws_libev_run(_a, _b) ((void) 0)
1098 #define lws_libev_destroyloop(_a, _b) ((void) 0)
1099 #define LWS_LIBEV_ENABLED(context) (0)
1100 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
1101 #define lws_feature_status_libev(_a) \
1102                         lwsl_notice("libev support not compiled in\n")
1103 #else
1104 #define lws_feature_status_libev(_a)
1105 #endif
1106 #endif
1107
1108 #if defined(LWS_USE_LIBUV)
1109 LWS_EXTERN void
1110 lws_libuv_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
1111 LWS_EXTERN void
1112 lws_libuv_io(struct lws *wsi, int flags);
1113 LWS_EXTERN int
1114 lws_libuv_init_fd_table(struct lws_context *context);
1115 LWS_EXTERN void
1116 lws_libuv_run(const struct lws_context *context, int tsi);
1117 LWS_EXTERN void
1118 lws_libuv_destroyloop(struct lws_context *context, int tsi);
1119 LWS_EXTERN int
1120 lws_uv_initvhost(struct lws_vhost* vh, struct lws*);
1121 #define LWS_LIBUV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBUV)
1122 LWS_EXTERN void lws_feature_status_libuv(struct lws_context_creation_info *info);
1123 #else
1124 #define lws_libuv_accept(_a, _b) ((void) 0)
1125 #define lws_libuv_io(_a, _b) ((void) 0)
1126 #define lws_libuv_init_fd_table(_a) (0)
1127 #define lws_libuv_run(_a, _b) ((void) 0)
1128 #define lws_libuv_destroyloop(_a, _b) ((void) 0)
1129 #define LWS_LIBUV_ENABLED(context) (0)
1130 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
1131 #define lws_feature_status_libuv(_a) \
1132                         lwsl_notice("libuv support not compiled in\n")
1133 #else
1134 #define lws_feature_status_libuv(_a)
1135 #endif
1136 #endif
1137
1138 #if defined(LWS_USE_LIBEVENT)
1139 LWS_EXTERN void
1140 lws_libevent_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
1141 LWS_EXTERN void
1142 lws_libevent_io(struct lws *wsi, int flags);
1143 LWS_EXTERN int
1144 lws_libevent_init_fd_table(struct lws_context *context);
1145 LWS_EXTERN void
1146 lws_libevent_destroyloop(struct lws_context *context, int tsi);
1147 LWS_EXTERN void
1148 lws_libevent_run(const struct lws_context *context, int tsi);
1149 #define LWS_LIBEVENT_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBEVENT)
1150 LWS_EXTERN void lws_feature_status_libevent(struct lws_context_creation_info *info);
1151 #else
1152 #define lws_libevent_accept(_a, _b) ((void) 0)
1153 #define lws_libevent_io(_a, _b) ((void) 0)
1154 #define lws_libevent_init_fd_table(_a) (0)
1155 #define lws_libevent_run(_a, _b) ((void) 0)
1156 #define lws_libevent_destroyloop(_a, _b) ((void) 0)
1157 #define LWS_LIBEVENT_ENABLED(context) (0)
1158 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
1159 #define lws_feature_status_libevent(_a) \
1160                         lwsl_notice("libevent support not compiled in\n")
1161 #else
1162 #define lws_feature_status_libevent(_a)
1163 #endif
1164 #endif
1165
1166
1167 #ifdef LWS_USE_IPV6
1168 #define LWS_IPV6_ENABLED(vh) \
1169         (!lws_check_opt(vh->context->options, LWS_SERVER_OPTION_DISABLE_IPV6) && \
1170          !lws_check_opt(vh->options, LWS_SERVER_OPTION_DISABLE_IPV6))
1171 #else
1172 #define LWS_IPV6_ENABLED(context) (0)
1173 #endif
1174
1175 #ifdef LWS_USE_UNIX_SOCK
1176 #define LWS_UNIX_SOCK_ENABLED(vhost) \
1177         (vhost->options & LWS_SERVER_OPTION_UNIX_SOCK)
1178 #else
1179 #define LWS_UNIX_SOCK_ENABLED(vhost) (0)
1180 #endif
1181
1182 typedef union {
1183 #ifdef LWS_USE_IPV6
1184         struct sockaddr_in6 sa6;
1185 #endif
1186         struct sockaddr_in sa4;
1187 } sockaddr46;
1188
1189 enum uri_path_states {
1190         URIPS_IDLE,
1191         URIPS_SEEN_SLASH,
1192         URIPS_SEEN_SLASH_DOT,
1193         URIPS_SEEN_SLASH_DOT_DOT,
1194 };
1195
1196 enum uri_esc_states {
1197         URIES_IDLE,
1198         URIES_SEEN_PERCENT,
1199         URIES_SEEN_PERCENT_H1,
1200 };
1201
1202 /* notice that these union members:
1203  *
1204  *  hdr
1205  *  http
1206  *  http2
1207  *
1208  * all have a pointer to allocated_headers struct as their first member.
1209  *
1210  * It means for allocated_headers access, the three union paths can all be
1211  * used interchangeably to access the same data
1212  */
1213
1214
1215 #ifndef LWS_NO_CLIENT
1216 struct client_info_stash {
1217         char address[256];
1218         char path[4096];
1219         char host[256];
1220         char origin[256];
1221         char protocol[256];
1222         char method[16];
1223         char iface[16];
1224 };
1225 #endif
1226
1227 struct _lws_header_related {
1228         /* MUST be first in struct */
1229         struct allocated_headers *ah;
1230         struct lws *ah_wait_list;
1231         unsigned char *preamble_rx;
1232 #ifndef LWS_NO_CLIENT
1233         struct client_info_stash *stash;
1234 #endif
1235         unsigned int preamble_rx_len;
1236         enum uri_path_states ups;
1237         enum uri_esc_states ues;
1238         short lextable_pos;
1239         unsigned int current_token_limit;
1240
1241         char esc_stash;
1242         char post_literal_equal;
1243         unsigned char parser_state; /* enum lws_token_indexes */
1244 };
1245
1246 #if defined(LWS_WITH_RANGES)
1247 enum range_states {
1248         LWSRS_NO_ACTIVE_RANGE,
1249         LWSRS_BYTES_EQ,
1250         LWSRS_FIRST,
1251         LWSRS_STARTING,
1252         LWSRS_ENDING,
1253         LWSRS_COMPLETED,
1254         LWSRS_SYNTAX,
1255 };
1256
1257 struct lws_range_parsing {
1258         unsigned long long start, end, extent, agg, budget;
1259         const char buf[128];
1260         int pos;
1261         enum range_states state;
1262         char start_valid, end_valid, ctr, count_ranges, did_try, inside, send_ctr;
1263 };
1264
1265 int
1266 lws_ranges_init(struct lws *wsi, struct lws_range_parsing *rp, unsigned long long extent);
1267 int
1268 lws_ranges_next(struct lws_range_parsing *rp);
1269 void
1270 lws_ranges_reset(struct lws_range_parsing *rp);
1271 #endif
1272
1273 struct _lws_http_mode_related {
1274         /* MUST be first in struct */
1275         struct allocated_headers *ah; /* mirroring  _lws_header_related */
1276         struct lws *ah_wait_list;
1277         unsigned char *preamble_rx;
1278 #ifndef LWS_NO_CLIENT
1279         struct client_info_stash *stash;
1280 #endif
1281         unsigned int preamble_rx_len;
1282         struct lws *new_wsi_list;
1283         lws_filepos_t filepos;
1284         lws_filepos_t filelen;
1285         lws_fop_fd_t fop_fd;
1286
1287 #if defined(LWS_WITH_RANGES)
1288         struct lws_range_parsing range;
1289         char multipart_content_type[64];
1290 #endif
1291
1292         enum http_version request_version;
1293         enum http_connection_type connection_type;
1294         lws_filepos_t content_length;
1295         lws_filepos_t content_remain;
1296 };
1297
1298 #ifdef LWS_USE_HTTP2
1299
1300 enum lws_http2_settings {
1301         LWS_HTTP2_SETTINGS__HEADER_TABLE_SIZE = 1,
1302         LWS_HTTP2_SETTINGS__ENABLE_PUSH,
1303         LWS_HTTP2_SETTINGS__MAX_CONCURRENT_STREAMS,
1304         LWS_HTTP2_SETTINGS__INITIAL_WINDOW_SIZE,
1305         LWS_HTTP2_SETTINGS__MAX_FRAME_SIZE,
1306         LWS_HTTP2_SETTINGS__MAX_HEADER_LIST_SIZE,
1307
1308         LWS_HTTP2_SETTINGS__COUNT /* always last */
1309 };
1310
1311 enum lws_http2_wellknown_frame_types {
1312         LWS_HTTP2_FRAME_TYPE_DATA,
1313         LWS_HTTP2_FRAME_TYPE_HEADERS,
1314         LWS_HTTP2_FRAME_TYPE_PRIORITY,
1315         LWS_HTTP2_FRAME_TYPE_RST_STREAM,
1316         LWS_HTTP2_FRAME_TYPE_SETTINGS,
1317         LWS_HTTP2_FRAME_TYPE_PUSH_PROMISE,
1318         LWS_HTTP2_FRAME_TYPE_PING,
1319         LWS_HTTP2_FRAME_TYPE_GOAWAY,
1320         LWS_HTTP2_FRAME_TYPE_WINDOW_UPDATE,
1321         LWS_HTTP2_FRAME_TYPE_CONTINUATION,
1322
1323         LWS_HTTP2_FRAME_TYPE_COUNT /* always last */
1324 };
1325
1326 enum lws_http2_flags {
1327         LWS_HTTP2_FLAG_END_STREAM = 1,
1328         LWS_HTTP2_FLAG_END_HEADERS = 4,
1329         LWS_HTTP2_FLAG_PADDED = 8,
1330         LWS_HTTP2_FLAG_PRIORITY = 0x20,
1331
1332         LWS_HTTP2_FLAG_SETTINGS_ACK = 1,
1333 };
1334
1335 #define LWS_HTTP2_STREAM_ID_MASTER 0
1336 #define LWS_HTTP2_FRAME_HEADER_LENGTH 9
1337 #define LWS_HTTP2_SETTINGS_LENGTH 6
1338
1339 struct http2_settings {
1340         unsigned int setting[LWS_HTTP2_SETTINGS__COUNT];
1341 };
1342
1343 enum http2_hpack_state {
1344
1345         /* optional before first header block */
1346         HPKS_OPT_PADDING,
1347         HKPS_OPT_E_DEPENDENCY,
1348         HKPS_OPT_WEIGHT,
1349
1350         /* header block */
1351         HPKS_TYPE,
1352
1353         HPKS_IDX_EXT,
1354
1355         HPKS_HLEN,
1356         HPKS_HLEN_EXT,
1357
1358         HPKS_DATA,
1359
1360         /* optional after last header block */
1361         HKPS_OPT_DISCARD_PADDING,
1362 };
1363
1364 enum http2_hpack_type {
1365         HPKT_INDEXED_HDR_7,
1366         HPKT_INDEXED_HDR_6_VALUE_INCR,
1367         HPKT_LITERAL_HDR_VALUE_INCR,
1368         HPKT_INDEXED_HDR_4_VALUE,
1369         HPKT_LITERAL_HDR_VALUE,
1370         HPKT_SIZE_5
1371 };
1372
1373 struct hpack_dt_entry {
1374         int token; /* additions that don't map to a token are ignored */
1375         int arg_offset;
1376         int arg_len;
1377 };
1378
1379 struct hpack_dynamic_table {
1380         struct hpack_dt_entry *entries;
1381         char *args;
1382         int pos;
1383         int next;
1384         int num_entries;
1385         int args_length;
1386 };
1387
1388 struct _lws_http2_related {
1389         /*
1390          * having this first lets us also re-use all HTTP union code
1391          * and in turn, http_mode_related has allocated headers in right
1392          * place so we can use the header apis on the wsi directly still
1393          */
1394         struct _lws_http_mode_related http; /* MUST BE FIRST IN STRUCT */
1395
1396         struct http2_settings my_settings;
1397         struct http2_settings peer_settings;
1398
1399         struct lws *parent_wsi;
1400         struct lws *next_child_wsi;
1401
1402         struct hpack_dynamic_table *hpack_dyn_table;
1403         struct lws *stream_wsi;
1404         unsigned char ping_payload[8];
1405         unsigned char one_setting[LWS_HTTP2_SETTINGS_LENGTH];
1406
1407         unsigned int count;
1408         unsigned int length;
1409         unsigned int stream_id;
1410         enum http2_hpack_state hpack;
1411         enum http2_hpack_type hpack_type;
1412         unsigned int header_index;
1413         unsigned int hpack_len;
1414         unsigned int hpack_e_dep;
1415         int tx_credit;
1416         unsigned int my_stream_id;
1417         unsigned int child_count;
1418         int my_priority;
1419
1420         unsigned int END_STREAM:1;
1421         unsigned int END_HEADERS:1;
1422         unsigned int send_END_STREAM:1;
1423         unsigned int GOING_AWAY;
1424         unsigned int requested_POLLOUT:1;
1425         unsigned int waiting_tx_credit:1;
1426         unsigned int huff:1;
1427         unsigned int value:1;
1428
1429         unsigned short round_robin_POLLOUT;
1430         unsigned short count_POLLOUT_children;
1431         unsigned short hpack_pos;
1432
1433         unsigned char type;
1434         unsigned char flags;
1435         unsigned char frame_state;
1436         unsigned char padding;
1437         unsigned char hpack_m;
1438         unsigned char initialized;
1439 };
1440
1441 #define HTTP2_IS_TOPLEVEL_WSI(wsi) (!wsi->u.http2.parent_wsi)
1442
1443 #endif
1444
1445 struct _lws_websocket_related {
1446         /* cheapest way to deal with ah overlap with ws union transition */
1447         struct _lws_header_related hdr;
1448         char *rx_ubuf;
1449         unsigned int rx_ubuf_alloc;
1450         struct lws *rx_draining_ext_list;
1451         struct lws *tx_draining_ext_list;
1452         time_t time_next_ping_check;
1453         size_t rx_packet_length;
1454         unsigned int rx_ubuf_head;
1455         unsigned char mask[4];
1456         /* Also used for close content... control opcode == < 128 */
1457         unsigned char ping_payload_buf[128 - 3 + LWS_PRE];
1458
1459         unsigned char ping_payload_len;
1460         unsigned char mask_idx;
1461         unsigned char opcode;
1462         unsigned char rsv;
1463         unsigned char rsv_first_msg;
1464         /* zero if no info, or length including 2-byte close code */
1465         unsigned char close_in_ping_buffer_len;
1466         unsigned char utf8;
1467         unsigned char stashed_write_type;
1468         unsigned char tx_draining_stashed_wp;
1469
1470         unsigned int final:1;
1471         unsigned int frame_is_binary:1;
1472         unsigned int all_zero_nonce:1;
1473         unsigned int this_frame_masked:1;
1474         unsigned int inside_frame:1; /* next write will be more of frame */
1475         unsigned int clean_buffer:1; /* buffer not rewritten by extension */
1476         unsigned int payload_is_close:1; /* process as PONG, but it is close */
1477         unsigned int ping_pending_flag:1;
1478         unsigned int continuation_possible:1;
1479         unsigned int owed_a_fin:1;
1480         unsigned int check_utf8:1;
1481         unsigned int defeat_check_utf8:1;
1482         unsigned int pmce_compressed_message:1;
1483         unsigned int stashed_write_pending:1;
1484         unsigned int rx_draining_ext:1;
1485         unsigned int tx_draining_ext:1;
1486         unsigned int send_check_ping:1;
1487         unsigned int first_fragment:1;
1488 };
1489
1490 #ifdef LWS_WITH_CGI
1491
1492 enum {
1493         SIGNIFICANT_HDR_CONTENT_LENGTH,
1494         SIGNIFICANT_HDR_LOCATION,
1495         SIGNIFICANT_HDR_STATUS,
1496         SIGNIFICANT_HDR_TRANSFER_ENCODING,
1497
1498         SIGNIFICANT_HDR_COUNT
1499 };
1500
1501 /* wsi who is master of the cgi points to an lws_cgi */
1502
1503 struct lws_cgi {
1504         struct lws_cgi *cgi_list;
1505         struct lws *stdwsi[3]; /* points to the associated stdin/out/err wsis */
1506         struct lws *wsi; /* owner */
1507         unsigned char *headers_buf;
1508         unsigned char *headers_pos;
1509         unsigned char *headers_dumped;
1510         unsigned char *headers_end;
1511         lws_filepos_t content_length;
1512         lws_filepos_t content_length_seen;
1513         int pipe_fds[3][2];
1514         int match[SIGNIFICANT_HDR_COUNT];
1515         int pid;
1516         int response_code;
1517         int lp;
1518         char l[12];
1519
1520         unsigned int being_closed:1;
1521         unsigned int explicitly_chunked:1;
1522
1523         unsigned char chunked_grace;
1524 };
1525 #endif
1526
1527 signed char char_to_hex(const char c);
1528
1529 #ifndef LWS_NO_CLIENT
1530 enum lws_chunk_parser {
1531         ELCP_HEX,
1532         ELCP_CR,
1533         ELCP_CONTENT,
1534         ELCP_POST_CR,
1535         ELCP_POST_LF,
1536 };
1537 #endif
1538
1539 struct lws_rewrite;
1540
1541 #ifdef LWS_WITH_ACCESS_LOG
1542 struct lws_access_log {
1543         char *header_log;
1544         char *user_agent;
1545         unsigned long sent;
1546         int response;
1547 };
1548 #endif
1549
1550 struct lws {
1551
1552         /* structs */
1553         /* members with mutually exclusive lifetimes are unionized */
1554
1555         union u {
1556                 struct _lws_http_mode_related http;
1557 #ifdef LWS_USE_HTTP2
1558                 struct _lws_http2_related http2;
1559 #endif
1560                 struct _lws_header_related hdr;
1561                 struct _lws_websocket_related ws;
1562         } u;
1563
1564         /* lifetime members */
1565
1566 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
1567         struct lws_io_watcher w_read;
1568 #endif
1569 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBEVENT)
1570         struct lws_io_watcher w_write;
1571 #endif
1572         time_t pending_timeout_limit;
1573
1574         /* pointers */
1575
1576         struct lws_context *context;
1577         struct lws_vhost *vhost;
1578         struct lws *parent; /* points to parent, if any */
1579         struct lws *child_list; /* points to first child */
1580         struct lws *sibling_list; /* subsequent children at same level */
1581 #ifdef LWS_WITH_CGI
1582         struct lws_cgi *cgi; /* wsi being cgi master have one of these */
1583 #endif
1584         const struct lws_protocols *protocol;
1585         struct lws **same_vh_protocol_prev, *same_vh_protocol_next;
1586         struct lws *timeout_list;
1587         struct lws **timeout_list_prev;
1588 #ifdef LWS_WITH_ACCESS_LOG
1589         struct lws_access_log access_log;
1590 #endif
1591         void *user_space;
1592         void *opaque_parent_data;
1593         /* rxflow handling */
1594         unsigned char *rxflow_buffer;
1595         /* truncated send handling */
1596         unsigned char *trunc_alloc; /* non-NULL means buffering in progress */
1597
1598 #if defined (LWS_WITH_ESP8266)
1599         void *premature_rx;
1600         unsigned short prem_rx_size, prem_rx_pos;
1601 #endif
1602
1603 #ifndef LWS_NO_EXTENSIONS
1604         const struct lws_extension *active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
1605         void *act_ext_user[LWS_MAX_EXTENSIONS_ACTIVE];
1606 #endif
1607 #ifdef LWS_OPENSSL_SUPPORT
1608         SSL *ssl;
1609         BIO *client_bio;
1610         struct lws *pending_read_list_prev, *pending_read_list_next;
1611 #if defined(LWS_WITH_STATS)
1612         uint64_t accept_start_us;
1613         char seen_rx;
1614 #endif
1615 #endif
1616 #ifdef LWS_WITH_HTTP_PROXY
1617         struct lws_rewrite *rw;
1618 #endif
1619 #ifdef LWS_LATENCY
1620         unsigned long action_start;
1621         unsigned long latency_start;
1622 #endif
1623         lws_sock_file_fd_type desc; /* .filefd / .sockfd */
1624 #if defined(LWS_WITH_STATS)
1625         uint64_t active_writable_req_us;
1626 #endif
1627         /* ints */
1628         int position_in_fds_table;
1629         int rxflow_len;
1630         int rxflow_pos;
1631         unsigned int trunc_alloc_len; /* size of malloc */
1632         unsigned int trunc_offset; /* where we are in terms of spilling */
1633         unsigned int trunc_len; /* how much is buffered */
1634 #ifndef LWS_NO_CLIENT
1635         int chunk_remaining;
1636 #endif
1637         unsigned int cache_secs;
1638
1639         unsigned int hdr_parsing_completed:1;
1640         unsigned int http2_substream:1;
1641         unsigned int listener:1;
1642         unsigned int user_space_externally_allocated:1;
1643         unsigned int socket_is_permanently_unusable:1;
1644         unsigned int rxflow_change_to:2;
1645         unsigned int more_rx_waiting:1; /* has to live here since ah may stick to end */
1646         unsigned int conn_stat_done:1;
1647         unsigned int cache_reuse:1;
1648         unsigned int cache_revalidate:1;
1649         unsigned int cache_intermediaries:1;
1650         unsigned int favoured_pollin:1;
1651         unsigned int sending_chunked:1;
1652         unsigned int already_did_cce:1;
1653         unsigned int told_user_closed:1;
1654         unsigned int waiting_to_send_close_frame:1;
1655         unsigned int ipv6:1;
1656         unsigned int parent_carries_io:1;
1657         unsigned int parent_pending_cb_on_writable:1;
1658
1659 #if defined(LWS_WITH_ESP8266)
1660         unsigned int pending_send_completion:3;
1661         unsigned int close_is_pending_send_completion:1;
1662 #endif
1663 #ifdef LWS_WITH_ACCESS_LOG
1664         unsigned int access_log_pending:1;
1665 #endif
1666 #ifndef LWS_NO_CLIENT
1667         unsigned int do_ws:1; /* whether we are doing http or ws flow */
1668         unsigned int chunked:1; /* if the clientside connection is chunked */
1669         unsigned int client_rx_avail:1;
1670         unsigned int client_http_body_pending:1;
1671 #endif
1672 #ifdef LWS_WITH_HTTP_PROXY
1673         unsigned int perform_rewrite:1;
1674 #endif
1675 #ifndef LWS_NO_EXTENSIONS
1676         unsigned int extension_data_pending:1;
1677 #endif
1678 #ifdef LWS_OPENSSL_SUPPORT
1679         unsigned int use_ssl:4;
1680 #endif
1681 #ifdef _WIN32
1682         unsigned int sock_send_blocking:1;
1683 #endif
1684 #ifdef LWS_OPENSSL_SUPPORT
1685         unsigned int redirect_to_https:1;
1686 #endif
1687
1688         /* volatile to make sure code is aware other thread can change */
1689         volatile unsigned int handling_pollout:1;
1690         volatile unsigned int leave_pollout_active:1;
1691
1692 #ifndef LWS_NO_CLIENT
1693         unsigned short c_port;
1694 #endif
1695
1696         /* chars */
1697 #ifndef LWS_NO_EXTENSIONS
1698         unsigned char count_act_ext;
1699 #endif
1700         unsigned char ietf_spec_revision;
1701         char mode; /* enum connection_mode */
1702         char state; /* enum lws_connection_states */
1703         char state_pre_close;
1704         char lws_rx_parse_state; /* enum lws_rx_parse_state */
1705         char rx_frame_type; /* enum lws_write_protocol */
1706         char pending_timeout; /* enum pending_timeout */
1707         char pps; /* enum lws_pending_protocol_send */
1708         char tsi; /* thread service index we belong to */
1709         char protocol_interpret_idx;
1710         char redirects;
1711 #ifdef LWS_WITH_CGI
1712         char cgi_channel; /* which of stdin/out/err */
1713         char hdr_state;
1714 #endif
1715 #ifndef LWS_NO_CLIENT
1716         char chunk_parser; /* enum lws_chunk_parser */
1717 #endif
1718 #if defined(LWS_WITH_CGI) || !defined(LWS_NO_CLIENT)
1719         char reason_bf; /* internal writeable callback reason bitfield */
1720 #endif
1721 };
1722
1723 LWS_EXTERN int log_level;
1724
1725 LWS_EXTERN int
1726 lws_socket_bind(struct lws_vhost *vhost, lws_sockfd_type sockfd, int port,
1727                 const char *iface);
1728
1729 #if defined(LWS_USE_IPV6)
1730 LWS_EXTERN unsigned long
1731 lws_get_addr_scope(const char *ipaddr);
1732 #endif
1733
1734 LWS_EXTERN void
1735 lws_close_free_wsi(struct lws *wsi, enum lws_close_status);
1736
1737 LWS_EXTERN int
1738 remove_wsi_socket_from_fds(struct lws *wsi);
1739 LWS_EXTERN int
1740 lws_rxflow_cache(struct lws *wsi, unsigned char *buf, int n, int len);
1741
1742 #ifndef LWS_LATENCY
1743 static inline void
1744 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1745             int ret, int completion) {
1746         do {
1747                 (void)context; (void)wsi; (void)action; (void)ret;
1748                 (void)completion;
1749         } while (0);
1750 }
1751 static inline void
1752 lws_latency_pre(struct lws_context *context, struct lws *wsi) {
1753         do { (void)context; (void)wsi; } while (0);
1754 }
1755 #else
1756 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
1757 extern void
1758 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1759             int ret, int completion);
1760 #endif
1761
1762 LWS_EXTERN void
1763 lws_set_protocol_write_pending(struct lws *wsi,
1764                                enum lws_pending_protocol_send pend);
1765 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1766 lws_client_rx_sm(struct lws *wsi, unsigned char c);
1767
1768 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1769 lws_parse(struct lws *wsi, unsigned char c);
1770
1771 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1772 lws_http_action(struct lws *wsi);
1773
1774 LWS_EXTERN int
1775 lws_b64_selftest(void);
1776
1777 LWS_EXTERN int
1778 lws_service_flag_pending(struct lws_context *context, int tsi);
1779
1780 #if defined(_WIN32) || defined(LWS_WITH_ESP8266)
1781 LWS_EXTERN struct lws *
1782 wsi_from_fd(const struct lws_context *context, lws_sockfd_type fd);
1783
1784 LWS_EXTERN int
1785 insert_wsi(struct lws_context *context, struct lws *wsi);
1786
1787 LWS_EXTERN int
1788 delete_from_fd(struct lws_context *context, lws_sockfd_type fd);
1789 #else
1790 #define wsi_from_fd(A,B)  A->lws_lookup[B]
1791 #define insert_wsi(A,B)   assert(A->lws_lookup[B->desc.sockfd] == 0); A->lws_lookup[B->desc.sockfd]=B
1792 #define delete_from_fd(A,B) A->lws_lookup[B]=0
1793 #endif
1794
1795 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1796 insert_wsi_socket_into_fds(struct lws_context *context, struct lws *wsi);
1797
1798 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1799 lws_issue_raw(struct lws *wsi, unsigned char *buf, size_t len);
1800
1801
1802 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1803 lws_service_timeout_check(struct lws *wsi, unsigned int sec);
1804
1805 LWS_EXTERN void
1806 lws_remove_from_timeout_list(struct lws *wsi);
1807
1808 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1809 lws_client_connect_2(struct lws *wsi);
1810
1811 LWS_VISIBLE struct lws * LWS_WARN_UNUSED_RESULT
1812 lws_client_reset(struct lws **wsi, int ssl, const char *address, int port,
1813                  const char *path, const char *host);
1814
1815 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1816 lws_create_new_server_wsi(struct lws_vhost *vhost);
1817
1818 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1819 lws_generate_client_handshake(struct lws *wsi, char *pkt);
1820
1821 LWS_EXTERN int
1822 lws_handle_POLLOUT_event(struct lws *wsi, struct lws_pollfd *pollfd);
1823
1824 LWS_EXTERN struct lws *
1825 lws_client_connect_via_info2(struct lws *wsi);
1826
1827 /*
1828  * EXTENSIONS
1829  */
1830
1831 #ifndef LWS_NO_EXTENSIONS
1832 LWS_VISIBLE void
1833 lws_context_init_extensions(struct lws_context_creation_info *info,
1834                             struct lws_context *context);
1835 LWS_EXTERN int
1836 lws_any_extension_handled(struct lws *wsi, enum lws_extension_callback_reasons r,
1837                           void *v, size_t len);
1838
1839 LWS_EXTERN int
1840 lws_ext_cb_active(struct lws *wsi, int reason, void *buf, int len);
1841 LWS_EXTERN int
1842 lws_ext_cb_all_exts(struct lws_context *context, struct lws *wsi, int reason,
1843                     void *arg, int len);
1844
1845 #else
1846 #define lws_any_extension_handled(_a, _b, _c, _d) (0)
1847 #define lws_ext_cb_active(_a, _b, _c, _d) (0)
1848 #define lws_ext_cb_all_exts(_a, _b, _c, _d, _e) (0)
1849 #define lws_issue_raw_ext_access lws_issue_raw
1850 #define lws_context_init_extensions(_a, _b)
1851 #endif
1852
1853 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1854 lws_client_interpret_server_handshake(struct lws *wsi);
1855
1856 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1857 lws_rx_sm(struct lws *wsi, unsigned char c);
1858
1859 LWS_EXTERN int
1860 lws_payload_until_length_exhausted(struct lws *wsi, unsigned char **buf, size_t *len);
1861
1862 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1863 lws_issue_raw_ext_access(struct lws *wsi, unsigned char *buf, size_t len);
1864
1865 LWS_EXTERN void
1866 lws_union_transition(struct lws *wsi, enum connection_mode mode);
1867
1868 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1869 user_callback_handle_rxflow(lws_callback_function, struct lws *wsi,
1870                             enum lws_callback_reasons reason, void *user,
1871                             void *in, size_t len);
1872 #ifdef LWS_USE_HTTP2
1873 LWS_EXTERN struct lws *lws_http2_get_network_wsi(struct lws *wsi);
1874 struct lws * lws_http2_get_nth_child(struct lws *wsi, int n);
1875 LWS_EXTERN int
1876 lws_http2_interpret_settings_payload(struct http2_settings *settings,
1877                                      unsigned char *buf, int len);
1878 LWS_EXTERN void lws_http2_init(struct http2_settings *settings);
1879 LWS_EXTERN int
1880 lws_http2_parser(struct lws *wsi, unsigned char c);
1881 LWS_EXTERN int lws_http2_do_pps_send(struct lws_context *context,
1882                                      struct lws *wsi);
1883 LWS_EXTERN int lws_http2_frame_write(struct lws *wsi, int type, int flags,
1884                                      unsigned int sid, unsigned int len,
1885                                      unsigned char *buf);
1886 LWS_EXTERN struct lws *
1887 lws_http2_wsi_from_id(struct lws *wsi, unsigned int sid);
1888 LWS_EXTERN int lws_hpack_interpret(struct lws *wsi,
1889                                    unsigned char c);
1890 LWS_EXTERN int
1891 lws_add_http2_header_by_name(struct lws *wsi,
1892                              const unsigned char *name,
1893                              const unsigned char *value, int length,
1894                              unsigned char **p, unsigned char *end);
1895 LWS_EXTERN int
1896 lws_add_http2_header_by_token(struct lws *wsi,
1897                             enum lws_token_indexes token,
1898                             const unsigned char *value, int length,
1899                             unsigned char **p, unsigned char *end);
1900 LWS_EXTERN int
1901 lws_add_http2_header_status(struct lws *wsi,
1902                             unsigned int code, unsigned char **p,
1903                             unsigned char *end);
1904 LWS_EXTERN
1905 void lws_http2_configure_if_upgraded(struct lws *wsi);
1906 #else
1907 #define lws_http2_configure_if_upgraded(x)
1908 #endif
1909
1910 LWS_EXTERN int
1911 lws_plat_set_socket_options(struct lws_vhost *vhost, lws_sockfd_type fd);
1912
1913 LWS_EXTERN int
1914 lws_plat_check_connection_error(struct lws *wsi);
1915
1916 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1917 lws_header_table_attach(struct lws *wsi, int autoservice);
1918
1919 LWS_EXTERN int
1920 lws_header_table_detach(struct lws *wsi, int autoservice);
1921
1922 LWS_EXTERN void
1923 lws_header_table_reset(struct lws *wsi, int autoservice);
1924 void
1925 _lws_header_table_reset(struct allocated_headers *ah);
1926
1927 void
1928 lws_header_table_force_to_detachable_state(struct lws *wsi);
1929 int
1930 lws_header_table_is_in_detachable_state(struct lws *wsi);
1931
1932 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1933 lws_hdr_simple_ptr(struct lws *wsi, enum lws_token_indexes h);
1934
1935 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1936 lws_hdr_simple_create(struct lws *wsi, enum lws_token_indexes h, const char *s);
1937
1938 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1939 lws_ensure_user_space(struct lws *wsi);
1940
1941 LWS_EXTERN int
1942 lws_change_pollfd(struct lws *wsi, int _and, int _or);
1943
1944 #ifndef LWS_NO_SERVER
1945 int lws_context_init_server(struct lws_context_creation_info *info,
1946                             struct lws_vhost *vhost);
1947 LWS_EXTERN struct lws_vhost *
1948 lws_select_vhost(struct lws_context *context, int port, const char *servername);
1949 LWS_EXTERN int
1950 handshake_0405(struct lws_context *context, struct lws *wsi);
1951 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1952 lws_interpret_incoming_packet(struct lws *wsi, unsigned char **buf, size_t len);
1953 LWS_EXTERN void
1954 lws_server_get_canonical_hostname(struct lws_context *context,
1955                                   struct lws_context_creation_info *info);
1956 #else
1957 #define lws_context_init_server(_a, _b) (0)
1958 #define lws_interpret_incoming_packet(_a, _b, _c) (0)
1959 #define lws_server_get_canonical_hostname(_a, _b)
1960 #endif
1961
1962 #ifndef LWS_NO_DAEMONIZE
1963 LWS_EXTERN int get_daemonize_pid();
1964 #else
1965 #define get_daemonize_pid() (0)
1966 #endif
1967
1968 #if !defined(LWS_WITH_ESP8266)
1969 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1970 interface_to_sa(struct lws_vhost *vh, const char *ifname,
1971                 struct sockaddr_in *addr, size_t addrlen);
1972 #endif
1973 LWS_EXTERN void lwsl_emit_stderr(int level, const char *line);
1974
1975 enum lws_ssl_capable_status {
1976         LWS_SSL_CAPABLE_ERROR = -1,
1977         LWS_SSL_CAPABLE_MORE_SERVICE = -2,
1978 };
1979
1980 #ifndef LWS_OPENSSL_SUPPORT
1981 #define LWS_SSL_ENABLED(context) (0)
1982 #define lws_context_init_server_ssl(_a, _b) (0)
1983 #define lws_ssl_destroy(_a)
1984 #define lws_context_init_http2_ssl(_a)
1985 #define lws_ssl_capable_read lws_ssl_capable_read_no_ssl
1986 #define lws_ssl_capable_write lws_ssl_capable_write_no_ssl
1987 #define lws_ssl_pending lws_ssl_pending_no_ssl
1988 #define lws_server_socket_service_ssl(_b, _c) (0)
1989 #define lws_ssl_close(_a) (0)
1990 #define lws_ssl_context_destroy(_a)
1991 #define lws_ssl_SSL_CTX_destroy(_a)
1992 #define lws_ssl_remove_wsi_from_buffered_list(_a)
1993 #define lws_context_init_ssl_library(_a)
1994 #else
1995 #define LWS_SSL_ENABLED(context) (context->use_ssl)
1996 LWS_EXTERN int openssl_websocket_private_data_index;
1997 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1998 lws_ssl_capable_read(struct lws *wsi, unsigned char *buf, int len);
1999 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2000 lws_ssl_capable_write(struct lws *wsi, unsigned char *buf, int len);
2001 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2002 lws_ssl_pending(struct lws *wsi);
2003 LWS_EXTERN int
2004 lws_context_init_ssl_library(struct lws_context_creation_info *info);
2005 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2006 lws_server_socket_service_ssl(struct lws *new_wsi, lws_sockfd_type accept_fd);
2007 LWS_EXTERN int
2008 lws_ssl_close(struct lws *wsi);
2009 LWS_EXTERN void
2010 lws_ssl_SSL_CTX_destroy(struct lws_vhost *vhost);
2011 LWS_EXTERN void
2012 lws_ssl_context_destroy(struct lws_context *context);
2013 LWS_VISIBLE void
2014 lws_ssl_remove_wsi_from_buffered_list(struct lws *wsi);
2015 LWS_EXTERN int
2016 lws_ssl_client_bio_create(struct lws *wsi);
2017 LWS_EXTERN int
2018 lws_ssl_client_connect1(struct lws *wsi);
2019 LWS_EXTERN int
2020 lws_ssl_client_connect2(struct lws *wsi);
2021 LWS_EXTERN void
2022 lws_ssl_elaborate_error(void);
2023 #ifndef LWS_NO_SERVER
2024 LWS_EXTERN int
2025 lws_context_init_server_ssl(struct lws_context_creation_info *info,
2026                             struct lws_vhost *vhost);
2027 #else
2028 #define lws_context_init_server_ssl(_a, _b) (0)
2029 #endif
2030 LWS_EXTERN void
2031 lws_ssl_destroy(struct lws_vhost *vhost);
2032 /* HTTP2-related */
2033
2034 #ifdef LWS_USE_HTTP2
2035 LWS_EXTERN void
2036 lws_context_init_http2_ssl(struct lws_vhost *vhost);
2037 #else
2038 #define lws_context_init_http2_ssl(_a)
2039 #endif
2040 #endif
2041
2042 #if LWS_MAX_SMP > 1
2043 static LWS_INLINE void
2044 lws_pt_mutex_init(struct lws_context_per_thread *pt)
2045 {
2046         pthread_mutex_init(&pt->lock, NULL);
2047 }
2048
2049 static LWS_INLINE void
2050 lws_pt_mutex_destroy(struct lws_context_per_thread *pt)
2051 {
2052         pthread_mutex_destroy(&pt->lock);
2053 }
2054
2055 static LWS_INLINE void
2056 lws_pt_lock(struct lws_context_per_thread *pt)
2057 {
2058         if (!pt->lock_depth++)
2059                 pthread_mutex_lock(&pt->lock);
2060 }
2061
2062 static LWS_INLINE void
2063 lws_pt_unlock(struct lws_context_per_thread *pt)
2064 {
2065         if (!(--pt->lock_depth))
2066                 pthread_mutex_unlock(&pt->lock);
2067 }
2068 #else
2069 #define lws_pt_mutex_init(_a) (void)(_a)
2070 #define lws_pt_mutex_destroy(_a) (void)(_a)
2071 #define lws_pt_lock(_a) (void)(_a)
2072 #define lws_pt_unlock(_a) (void)(_a)
2073 #endif
2074
2075 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2076 lws_ssl_capable_read_no_ssl(struct lws *wsi, unsigned char *buf, int len);
2077
2078 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2079 lws_ssl_capable_write_no_ssl(struct lws *wsi, unsigned char *buf, int len);
2080
2081 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2082 lws_ssl_pending_no_ssl(struct lws *wsi);
2083
2084 #ifdef LWS_WITH_HTTP_PROXY
2085 struct lws_rewrite {
2086         hubbub_parser *parser;
2087         hubbub_parser_optparams params;
2088         const char *from, *to;
2089         int from_len, to_len;
2090         unsigned char *p, *end;
2091         struct lws *wsi;
2092 };
2093 static LWS_INLINE int hstrcmp(hubbub_string *s, const char *p, int len)
2094 {
2095         if (s->len != len)
2096                 return 1;
2097
2098         return strncmp((const char *)s->ptr, p, len);
2099 }
2100 typedef hubbub_error (*hubbub_callback_t)(const hubbub_token *token, void *pw);
2101 LWS_EXTERN struct lws_rewrite *
2102 lws_rewrite_create(struct lws *wsi, hubbub_callback_t cb, const char *from, const char *to);
2103 LWS_EXTERN void
2104 lws_rewrite_destroy(struct lws_rewrite *r);
2105 LWS_EXTERN int
2106 lws_rewrite_parse(struct lws_rewrite *r, const unsigned char *in, int in_len);
2107 #endif
2108
2109 #ifndef LWS_NO_CLIENT
2110 LWS_EXTERN int lws_client_socket_service(struct lws_context *context,
2111                                          struct lws *wsi,
2112                                          struct lws_pollfd *pollfd);
2113 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2114 lws_http_transaction_completed_client(struct lws *wsi);
2115 #ifdef LWS_OPENSSL_SUPPORT
2116 LWS_EXTERN int
2117 lws_context_init_client_ssl(struct lws_context_creation_info *info,
2118                             struct lws_vhost *vhost);
2119
2120 LWS_EXTERN void
2121 lws_ssl_info_callback(const SSL *ssl, int where, int ret);
2122
2123 #else
2124         #define lws_context_init_client_ssl(_a, _b) (0)
2125 #endif
2126 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2127 lws_handshake_client(struct lws *wsi, unsigned char **buf, size_t len);
2128 LWS_EXTERN void
2129 lws_decode_ssl_error(void);
2130 #else
2131 #define lws_context_init_client_ssl(_a, _b) (0)
2132 #define lws_handshake_client(_a, _b, _c) (0)
2133 #endif
2134
2135 LWS_EXTERN int
2136 _lws_rx_flow_control(struct lws *wsi);
2137
2138 LWS_EXTERN int
2139 _lws_change_pollfd(struct lws *wsi, int _and, int _or, struct lws_pollargs *pa);
2140
2141 #ifndef LWS_NO_SERVER
2142 LWS_EXTERN int
2143 lws_server_socket_service(struct lws_context *context, struct lws *wsi,
2144                           struct lws_pollfd *pollfd);
2145 LWS_EXTERN int
2146 lws_handshake_server(struct lws *wsi, unsigned char **buf, size_t len);
2147 #else
2148 #define lws_server_socket_service(_a, _b, _c) (0)
2149 #define lws_handshake_server(_a, _b, _c) (0)
2150 #endif
2151
2152 #ifdef LWS_WITH_ACCESS_LOG
2153 LWS_EXTERN int
2154 lws_access_log(struct lws *wsi);
2155 #else
2156 #define lws_access_log(_a)
2157 #endif
2158
2159 LWS_EXTERN int
2160 lws_cgi_kill_terminated(struct lws_context_per_thread *pt);
2161
2162 int
2163 lws_protocol_init(struct lws_context *context);
2164
2165 int
2166 lws_bind_protocol(struct lws *wsi, const struct lws_protocols *p);
2167
2168 const struct lws_http_mount *
2169 lws_find_mount(struct lws *wsi, const char *uri_ptr, int uri_len);
2170
2171 /*
2172  * custom allocator
2173  */
2174 LWS_EXTERN void *
2175 lws_realloc(void *ptr, size_t size);
2176
2177 LWS_EXTERN void * LWS_WARN_UNUSED_RESULT
2178 lws_zalloc(size_t size);
2179
2180 #ifdef LWS_PLAT_OPTEE
2181 void *lws_malloc(size_t size);
2182 void lws_free(void *p);
2183 #define lws_free_set_NULL(P)    do { lws_free(P); (P) = NULL; } while(0)
2184 #else
2185 #define lws_malloc(S)   lws_realloc(NULL, S)
2186 #define lws_free(P)     lws_realloc(P, 0)
2187 #define lws_free_set_NULL(P)    do { lws_realloc(P, 0); (P) = NULL; } while(0)
2188 #endif
2189
2190 const struct lws_plat_file_ops *
2191 lws_vfs_select_fops(const struct lws_plat_file_ops *fops, const char *vfs_path,
2192                     const char **vpath);
2193
2194 /* lws_plat_ */
2195 LWS_EXTERN void
2196 lws_plat_delete_socket_from_fds(struct lws_context *context,
2197                                 struct lws *wsi, int m);
2198 LWS_EXTERN void
2199 lws_plat_insert_socket_into_fds(struct lws_context *context,
2200                                 struct lws *wsi);
2201 LWS_EXTERN void
2202 lws_plat_service_periodic(struct lws_context *context);
2203
2204 LWS_EXTERN int
2205 lws_plat_change_pollfd(struct lws_context *context, struct lws *wsi,
2206                        struct lws_pollfd *pfd);
2207 LWS_EXTERN void
2208 lws_add_wsi_to_draining_ext_list(struct lws *wsi);
2209 LWS_EXTERN void
2210 lws_remove_wsi_from_draining_ext_list(struct lws *wsi);
2211 LWS_EXTERN int
2212 lws_plat_context_early_init(void);
2213 LWS_EXTERN void
2214 lws_plat_context_early_destroy(struct lws_context *context);
2215 LWS_EXTERN void
2216 lws_plat_context_late_destroy(struct lws_context *context);
2217 LWS_EXTERN int
2218 lws_poll_listen_fd(struct lws_pollfd *fd);
2219 LWS_EXTERN int
2220 lws_plat_service(struct lws_context *context, int timeout_ms);
2221 LWS_EXTERN LWS_VISIBLE int
2222 _lws_plat_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
2223 LWS_EXTERN int
2224 lws_plat_init(struct lws_context *context,
2225               struct lws_context_creation_info *info);
2226 LWS_EXTERN void
2227 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
2228 LWS_EXTERN unsigned long long
2229 time_in_microseconds(void);
2230 LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
2231 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);
2232 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2233 lws_plat_inet_pton(int af, const char *src, void *dst);
2234
2235 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2236 lws_check_utf8(unsigned char *state, unsigned char *buf, size_t len);
2237 LWS_EXTERN int alloc_file(struct lws_context *context, const char *filename, uint8_t **buf,
2238                                 lws_filepos_t *amount);
2239 LWS_EXTERN int alloc_pem_to_der_file(struct lws_context *context, const char *filename, uint8_t **buf,
2240                lws_filepos_t *amount);
2241
2242 LWS_EXTERN void
2243 lws_same_vh_protocol_remove(struct lws *wsi);
2244 LWS_EXTERN void
2245 lws_same_vh_protocol_insert(struct lws *wsi, int n);
2246
2247 #if defined(LWS_WITH_STATS)
2248 void
2249 lws_stats_atomic_bump(struct lws_context * context,
2250                 struct lws_context_per_thread *pt, int index, uint64_t bump);
2251 void
2252 lws_stats_atomic_max(struct lws_context * context,
2253                 struct lws_context_per_thread *pt, int index, uint64_t val);
2254 #else
2255 static inline uint64_t lws_stats_atomic_bump(struct lws_context * context,
2256                 struct lws_context_per_thread *pt, int index, uint64_t bump) {
2257         (void)context; (void)pt; (void)index; (void)bump; return 0; }
2258 static inline uint64_t lws_stats_atomic_max(struct lws_context * context,
2259                 struct lws_context_per_thread *pt, int index, uint64_t val) {
2260         (void)context; (void)pt; (void)index; (void)val; return 0; }
2261 #endif
2262
2263 /* socks */
2264 void socks_generate_msg(struct lws *wsi, enum socks_msg_type type,
2265                         size_t *msg_len);
2266
2267 #ifdef __cplusplus
2268 };
2269 #endif