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_RETURNED_CLOSE_ALREADY,
 492         LWSS_AWAITING_CLOSE_ACK,
 493         LWSS_FLUSHING_STORED_SEND_BEFORE_CLOSE,
 494         LWSS_SHUTDOWN,
 495
 496         LWSS_HTTP2_AWAIT_CLIENT_PREFACE,
 497         LWSS_HTTP2_ESTABLISHED_PRE_SETTINGS,
 498         LWSS_HTTP2_ESTABLISHED,
 499
 500         LWSS_CGI,
 501 };
 502
 503 enum http_version {
 504         HTTP_VERSION_1_0,
 505         HTTP_VERSION_1_1,
 506         HTTP_VERSION_2
 507 };
 508
 509 enum http_connection_type {
 510         HTTP_CONNECTION_CLOSE,
 511         HTTP_CONNECTION_KEEP_ALIVE
 512 };
 513
 514 enum lws_pending_protocol_send {
 515         LWS_PPS_NONE,
 516         LWS_PPS_HTTP2_MY_SETTINGS,
 517         LWS_PPS_HTTP2_ACK_SETTINGS,
 518         LWS_PPS_HTTP2_PONG,
 519 };
 520
 521 enum lws_rx_parse_state {
 522         LWS_RXPS_NEW,
 523
 524         LWS_RXPS_04_mask_1,
 525         LWS_RXPS_04_mask_2,
 526         LWS_RXPS_04_mask_3,
 527
 528         LWS_RXPS_04_FRAME_HDR_1,
 529         LWS_RXPS_04_FRAME_HDR_LEN,
 530         LWS_RXPS_04_FRAME_HDR_LEN16_2,
 531         LWS_RXPS_04_FRAME_HDR_LEN16_1,
 532         LWS_RXPS_04_FRAME_HDR_LEN64_8,
 533         LWS_RXPS_04_FRAME_HDR_LEN64_7,
 534         LWS_RXPS_04_FRAME_HDR_LEN64_6,
 535         LWS_RXPS_04_FRAME_HDR_LEN64_5,
 536         LWS_RXPS_04_FRAME_HDR_LEN64_4,
 537         LWS_RXPS_04_FRAME_HDR_LEN64_3,
 538         LWS_RXPS_04_FRAME_HDR_LEN64_2,
 539         LWS_RXPS_04_FRAME_HDR_LEN64_1,
 540
 541         LWS_RXPS_07_COLLECT_FRAME_KEY_1,
 542         LWS_RXPS_07_COLLECT_FRAME_KEY_2,
 543         LWS_RXPS_07_COLLECT_FRAME_KEY_3,
 544         LWS_RXPS_07_COLLECT_FRAME_KEY_4,
 545
 546         LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED
 547 };
 548
 549 #define LWSCM_FLAG_IMPLIES_CALLBACK_CLOSED_CLIENT_HTTP 32
 550
 551 enum connection_mode {
 552         LWSCM_HTTP_SERVING,
 553         LWSCM_HTTP_SERVING_ACCEPTED, /* actual HTTP service going on */
 554         LWSCM_PRE_WS_SERVING_ACCEPT,
 555
 556         LWSCM_WS_SERVING,
 557         LWSCM_WS_CLIENT,
 558
 559         LWSCM_HTTP2_SERVING,
 560
 561         /* transient, ssl delay hiding */
 562         LWSCM_SSL_ACK_PENDING,
 563         LWSCM_SSL_INIT,
 564         /* as above, but complete into LWSCM_RAW */
 565         LWSCM_SSL_ACK_PENDING_RAW,
 566         LWSCM_SSL_INIT_RAW,
 567
 568         /* special internal types */
 569         LWSCM_SERVER_LISTENER,
 570         LWSCM_CGI, /* stdin, stdout, stderr for another cgi master wsi */
 571         LWSCM_RAW, /* raw with bulk handling */
 572         LWSCM_RAW_FILEDESC, /* raw without bulk handling */
 573
 574         /* HTTP Client related */
 575         LWSCM_HTTP_CLIENT = LWSCM_FLAG_IMPLIES_CALLBACK_CLOSED_CLIENT_HTTP,
 576         LWSCM_HTTP_CLIENT_ACCEPTED, /* actual HTTP service going on */
 577         LWSCM_WSCL_WAITING_CONNECT,
 578         LWSCM_WSCL_WAITING_PROXY_REPLY,
 579         LWSCM_WSCL_ISSUE_HANDSHAKE,
 580         LWSCM_WSCL_ISSUE_HANDSHAKE2,
 581         LWSCM_WSCL_ISSUE_HTTP_BODY,
 582         LWSCM_WSCL_WAITING_SSL,
 583         LWSCM_WSCL_WAITING_SERVER_REPLY,
 584         LWSCM_WSCL_WAITING_EXTENSION_CONNECT,
 585         LWSCM_WSCL_PENDING_CANDIDATE_CHILD,
 586         LWSCM_WSCL_WAITING_SOCKS_GREETING_REPLY,
 587         LWSCM_WSCL_WAITING_SOCKS_CONNECT_REPLY,
 588         LWSCM_WSCL_WAITING_SOCKS_AUTH_REPLY,
 589
 590         /****** add new things just above ---^ ******/
 591
 592
 593 };
 594
 595 /* enums of socks version */
 596 enum socks_version {
 597         SOCKS_VERSION_4 = 4,
 598         SOCKS_VERSION_5 = 5
 599 };
 600
 601 /* enums of subnegotiation version */
 602 enum socks_subnegotiation_version {
 603         SOCKS_SUBNEGOTIATION_VERSION_1 = 1,
 604 };
 605
 606 /* enums of socks commands */
 607 enum socks_command {
 608         SOCKS_COMMAND_CONNECT = 1,
 609         SOCKS_COMMAND_BIND = 2,
 610         SOCKS_COMMAND_UDP_ASSOCIATE = 3
 611 };
 612
 613 /* enums of socks address type */
 614 enum socks_atyp {
 615         SOCKS_ATYP_IPV4 = 1,
 616         SOCKS_ATYP_DOMAINNAME = 3,
 617         SOCKS_ATYP_IPV6 = 4
 618 };
 619
 620 /* enums of socks authentication methods */
 621 enum socks_auth_method {
 622         SOCKS_AUTH_NO_AUTH = 0,
 623         SOCKS_AUTH_GSSAPI = 1,
 624         SOCKS_AUTH_USERNAME_PASSWORD = 2
 625 };
 626
 627 /* enums of subnegotiation status */
 628 enum socks_subnegotiation_status {
 629         SOCKS_SUBNEGOTIATION_STATUS_SUCCESS = 0,
 630 };
 631
 632 /* enums of socks request reply */
 633 enum socks_request_reply {
 634         SOCKS_REQUEST_REPLY_SUCCESS = 0,
 635         SOCKS_REQUEST_REPLY_FAILURE_GENERAL = 1,
 636         SOCKS_REQUEST_REPLY_CONNECTION_NOT_ALLOWED = 2,
 637         SOCKS_REQUEST_REPLY_NETWORK_UNREACHABLE = 3,
 638         SOCKS_REQUEST_REPLY_HOST_UNREACHABLE = 4,
 639         SOCKS_REQUEST_REPLY_CONNECTION_REFUSED = 5,
 640         SOCKS_REQUEST_REPLY_TTL_EXPIRED = 6,
 641         SOCKS_REQUEST_REPLY_COMMAND_NOT_SUPPORTED = 7,
 642         SOCKS_REQUEST_REPLY_ATYP_NOT_SUPPORTED = 8
 643 };
 644
 645 /* enums used to generate socks messages */
 646 enum socks_msg_type {
 647         /* greeting */
 648         SOCKS_MSG_GREETING,
 649         /* credential, user name and password */
 650         SOCKS_MSG_USERNAME_PASSWORD,
 651         /* connect command */
 652         SOCKS_MSG_CONNECT
 653 };
 654
 655 enum {
 656         LWS_RXFLOW_ALLOW = (1 << 0),
 657         LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
 658 };
 659
 660 /* this is not usable directly by user code any more, lws_close_reason() */
 661 #define LWS_WRITE_CLOSE 4
 662
 663 struct lws_protocols;
 664 struct lws;
 665
 666 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
 667
 668 struct lws_io_watcher {
 669 #ifdef LWS_USE_LIBEV
 670         ev_io ev_watcher;
 671 #endif
 672 #ifdef LWS_USE_LIBUV
 673         uv_poll_t uv_watcher;
 674 #endif
 675 #ifdef LWS_USE_LIBEVENT
 676         struct event *event_watcher;
 677 #endif
 678         struct lws_context *context;
 679 };
 680
 681 struct lws_signal_watcher {
 682 #ifdef LWS_USE_LIBEV
 683         ev_signal ev_watcher;
 684 #endif
 685 #ifdef LWS_USE_LIBUV
 686         uv_signal_t uv_watcher;
 687 #endif
 688 #ifdef LWS_USE_LIBEVENT
 689         struct event *event_watcher;
 690 #endif
 691         struct lws_context *context;
 692 };
 693 #endif
 694
 695 #ifdef _WIN32
 696 #define LWS_FD_HASH(fd) ((fd ^ (fd >> 8) ^ (fd >> 16)) % FD_HASHTABLE_MODULUS)
 697 struct lws_fd_hashtable {
 698         struct lws **wsi;
 699         int length;
 700 };
 701 #endif
 702
 703 /*
 704  * This is totally opaque to code using the library.  It's exported as a
 705  * forward-reference pointer-only declaration; the user can use the pointer with
 706  * other APIs to get information out of it.
 707  */
 708
 709 struct lws_fragments {
 710         unsigned int offset;
 711         unsigned short len;
 712         unsigned char nfrag; /* which ah->frag[] continues this content, or 0 */
 713 };
 714
 715 /*
 716  * these are assigned from a pool held in the context.
 717  * Both client and server mode uses them for http header analysis
 718  */
 719
 720 struct allocated_headers {
 721         struct lws *wsi; /* owner */
 722         char *data; /* prepared by context init to point to dedicated storage */
 723         /*
 724          * the randomly ordered fragments, indexed by frag_index and
 725          * lws_fragments->nfrag for continuation.
 726          */
 727         struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
 728         time_t assigned;
 729         /*
 730          * for each recognized token, frag_index says which frag[] his data
 731          * starts in (0 means the token did not appear)
 732          * the actual header data gets dumped as it comes in, into data[]
 733          */
 734         unsigned char frag_index[WSI_TOKEN_COUNT];
 735         unsigned char rx[2048];
 736
 737         unsigned int rxpos;
 738         unsigned int rxlen;
 739         unsigned int pos;
 740
 741         unsigned int http_response;
 742
 743 #ifndef LWS_NO_CLIENT
 744         char initial_handshake_hash_base64[30];
 745 #endif
 746
 747         unsigned char in_use;
 748         unsigned char nfrag;
 749 };
 750
 751 /*
 752  * so we can have n connections being serviced simultaneously,
 753  * these things need to be isolated per-thread.
 754  */
 755
 756 struct lws_context_per_thread {
 757 #if LWS_MAX_SMP > 1
 758         pthread_mutex_t lock;
 759 #endif
 760         struct lws_pollfd *fds;
 761 #if defined(LWS_WITH_ESP8266)
 762         struct lws **lws_vs_fds_index;
 763 #endif
 764         struct lws *rx_draining_ext_list;
 765         struct lws *tx_draining_ext_list;
 766         struct lws *timeout_list;
 767 #if defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
 768         struct lws_context *context;
 769 #endif
 770 #ifdef LWS_WITH_CGI
 771         struct lws_cgi *cgi_list;
 772 #endif
 773         void *http_header_data;
 774         struct allocated_headers *ah_pool;
 775         struct lws *ah_wait_list;
 776         int ah_wait_list_length;
 777 #ifdef LWS_OPENSSL_SUPPORT
 778         struct lws *pending_read_list; /* linked list */
 779 #endif
 780 #if defined(LWS_USE_LIBEV)
 781         struct ev_loop *io_loop_ev;
 782 #endif
 783 #if defined(LWS_USE_LIBUV)
 784         uv_loop_t *io_loop_uv;
 785         uv_signal_t signals[8];
 786         uv_timer_t uv_timeout_watcher;
 787         uv_idle_t uv_idle;
 788 #endif
 789 #if defined(LWS_USE_LIBEVENT)
 790         struct event_base *io_loop_event_base;
 791 #endif
 792 #if defined(LWS_USE_LIBEV)
 793         struct lws_io_watcher w_accept;
 794 #endif
 795 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
 796         struct lws_signal_watcher w_sigint;
 797         unsigned char ev_loop_foreign:1;
 798 #endif
 799
 800         unsigned long count_conns;
 801         /*
 802          * usable by anything in the service code, but only if the scope
 803          * does not last longer than the service action (since next service
 804          * of any socket can likewise use it and overwrite)
 805          */
 806         unsigned char *serv_buf;
 807 #ifdef _WIN32
 808         WSAEVENT *events;
 809 #else
 810         lws_sockfd_type dummy_pipe_fds[2];
 811 #endif
 812         unsigned int fds_count;
 813
 814         short ah_count_in_use;
 815         unsigned char tid;
 816         unsigned char lock_depth;
 817 };
 818
 819 struct lws_conn_stats {
 820         unsigned long long rx, tx;
 821         unsigned long conn, trans, ws_upg, http2_upg, rejected;
 822 };
 823
 824 void
 825 lws_sum_stats(const struct lws_context *ctx, struct lws_conn_stats *cs);
 826
 827 /*
 828  * virtual host -related context information
 829  *   vhostwide SSL context
 830  *   vhostwide proxy
 831  *
 832  * hierarchy:
 833  *
 834  * context -> vhost -> wsi
 835  *
 836  * incoming connection non-SSL vhost binding:
 837  *
 838  *    listen socket -> wsi -> select vhost after first headers
 839  *
 840  * incoming connection SSL vhost binding:
 841  *
 842  *    SSL SNI -> wsi -> bind after SSL negotiation
 843  */
 844
 845 struct lws_vhost {
 846 #if !defined(LWS_WITH_ESP8266)
 847         char http_proxy_address[128];
 848         char proxy_basic_auth_token[128];
 849 #if defined(LWS_WITH_SOCKS5)
 850         char socks_proxy_address[128];
 851         char socks_user[96];
 852         char socks_password[96];
 853 #endif
 854 #endif
 855 #if defined(LWS_WITH_ESP8266)
 856         /* listen sockets need a place to hang their hat */
 857         esp_tcp tcp;
 858 #endif
 859         struct lws_conn_stats conn_stats;
 860         struct lws_context *context;
 861         struct lws_vhost *vhost_next;
 862         const struct lws_http_mount *mount_list;
 863         struct lws *lserv_wsi;
 864         const char *name;
 865         const char *iface;
 866 #if !defined(LWS_WITH_ESP8266) && !defined(LWS_WITH_ESP32) && !defined(OPTEE_TA) && !defined(WIN32)
 867         int bind_iface;
 868 #endif
 869         const struct lws_protocols *protocols;
 870         void **protocol_vh_privs;
 871         const struct lws_protocol_vhost_options *pvo;
 872         const struct lws_protocol_vhost_options *headers;
 873         struct lws **same_vh_protocol_list;
 874 #ifdef LWS_OPENSSL_SUPPORT
 875         SSL_CTX *ssl_ctx;
 876         SSL_CTX *ssl_client_ctx;
 877 #endif
 878 #ifndef LWS_NO_EXTENSIONS
 879         const struct lws_extension *extensions;
 880 #endif
 881
 882         int listen_port;
 883         unsigned int http_proxy_port;
 884 #if defined(LWS_WITH_SOCKS5)
 885         unsigned int socks_proxy_port;
 886 #endif
 887         unsigned int options;
 888         int count_protocols;
 889         int ka_time;
 890         int ka_probes;
 891         int ka_interval;
 892         int keepalive_timeout;
 893 #ifdef LWS_WITH_ACCESS_LOG
 894         int log_fd;
 895 #endif
 896
 897 #ifdef LWS_OPENSSL_SUPPORT
 898         int use_ssl;
 899         int allow_non_ssl_on_ssl_port;
 900         unsigned int user_supplied_ssl_ctx:1;
 901 #endif
 902
 903         unsigned int created_vhost_protocols:1;
 904
 905         unsigned char default_protocol_index;
 906         unsigned char raw_protocol_index;
 907 };
 908
 909 /*
 910  * the rest is managed per-context, that includes
 911  *
 912  *  - processwide single fd -> wsi lookup
 913  *  - contextwide headers pool
 914  */
 915
 916 struct lws_context {
 917         time_t last_timeout_check_s;
 918         time_t last_ws_ping_pong_check_s;
 919         time_t time_up;
 920         const struct lws_plat_file_ops *fops;
 921         struct lws_plat_file_ops fops_platform;
 922 #if defined(LWS_WITH_ZIP_FOPS)
 923         struct lws_plat_file_ops fops_zip;
 924 #endif
 925         struct lws_context_per_thread pt[LWS_MAX_SMP];
 926         struct lws_conn_stats conn_stats;
 927 #ifdef _WIN32
 928 /* different implementation between unix and windows */
 929         struct lws_fd_hashtable fd_hashtable[FD_HASHTABLE_MODULUS];
 930 #else
 931 #if defined(LWS_WITH_ESP8266)
 932         struct espconn **connpool; /* .reverse points to the wsi */
 933         void *rxd;
 934         int rxd_len;
 935         os_timer_t to_timer;
 936 #else
 937         struct lws **lws_lookup;  /* fd to wsi */
 938 #endif
 939 #endif
 940         struct lws_vhost *vhost_list;
 941         struct lws_plugin *plugin_list;
 942
 943         void *external_baggage_free_on_destroy;
 944         const struct lws_token_limits *token_limits;
 945         void *user_space;
 946         const char *server_string;
 947         const struct lws_protocol_vhost_options *reject_service_keywords;
 948         lws_reload_func deprecation_cb;
 949
 950 #if defined(LWS_HAVE_SYS_CAPABILITY_H) && defined(LWS_HAVE_LIBCAP)
 951         cap_value_t caps[4];
 952         char count_caps;
 953 #endif
 954
 955 #if defined(LWS_USE_LIBEV)
 956         lws_ev_signal_cb_t * lws_ev_sigint_cb;
 957 #endif
 958 #if defined(LWS_USE_LIBUV)
 959         uv_signal_cb lws_uv_sigint_cb;
 960 #endif
 961 #if defined(LWS_USE_LIBEVENT)
 962         lws_event_signal_cb_t * lws_event_sigint_cb;
 963 #endif
 964         char canonical_hostname[128];
 965 #ifdef LWS_LATENCY
 966         unsigned long worst_latency;
 967         char worst_latency_info[256];
 968 #endif
 969
 970 #if defined(LWS_WITH_STATS)
 971         uint64_t lws_stats[LWSSTATS_SIZE];
 972         uint64_t last_dump;
 973         int updated;
 974 #endif
 975
 976         int max_fds;
 977 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
 978         int use_ev_sigint;
 979 #endif
 980         int started_with_parent;
 981         int uid, gid;
 982
 983         int fd_random;
 984 #ifdef LWS_OPENSSL_SUPPORT
 985 #define lws_ssl_anybody_has_buffered_read(w) \
 986                 (w->vhost->use_ssl && \
 987                  w->context->pt[(int)w->tsi].pending_read_list)
 988 #define lws_ssl_anybody_has_buffered_read_tsi(c, t) \
 989                 (/*c->use_ssl && */ \
 990                  c->pt[(int)t].pending_read_list)
 991 #else
 992 #define lws_ssl_anybody_has_buffered_read(ctx) (0)
 993 #define lws_ssl_anybody_has_buffered_read_tsi(ctx, t) (0)
 994 #endif
 995         int count_wsi_allocated;
 996         int count_cgi_spawned;
 997         unsigned int options;
 998         unsigned int fd_limit_per_thread;
 999         unsigned int timeout_secs;
1000         unsigned int pt_serv_buf_size;
1001         int max_http_header_data;
1002         int simultaneous_ssl_restriction;
1003         int simultaneous_ssl;
1004
1005         unsigned int deprecated:1;
1006         unsigned int being_destroyed:1;
1007         unsigned int being_destroyed1:1;
1008         unsigned int requested_kill:1;
1009         unsigned int protocol_init_done:1;
1010         unsigned int ssl_gate_accepts:1;
1011         /*
1012          * set to the Thread ID that's doing the service loop just before entry
1013          * to poll indicates service thread likely idling in poll()
1014          * volatile because other threads may check it as part of processing
1015          * for pollfd event change.
1016          */
1017         volatile int service_tid;
1018         int service_tid_detected;
1019
1020         short max_http_header_pool;
1021         short count_threads;
1022         short plugin_protocol_count;
1023         short plugin_extension_count;
1024         short server_string_len;
1025         unsigned short ws_ping_pong_interval;
1026         unsigned short deprecation_pending_listen_close_count;
1027         uint8_t max_fi;
1028 };
1029
1030 #define lws_get_context_protocol(ctx, x) ctx->vhost_list->protocols[x]
1031 #define lws_get_vh_protocol(vh, x) vh->protocols[x]
1032
1033 LWS_EXTERN void
1034 lws_close_free_wsi_final(struct lws *wsi);
1035 LWS_EXTERN void
1036 lws_libuv_closehandle(struct lws *wsi);
1037
1038 LWS_VISIBLE LWS_EXTERN int
1039 lws_plat_plugins_init(struct lws_context * context, const char * const *d);
1040
1041 LWS_VISIBLE LWS_EXTERN int
1042 lws_plat_plugins_destroy(struct lws_context * context);
1043
1044 LWS_EXTERN void
1045 lws_restart_ws_ping_pong_timer(struct lws *wsi);
1046
1047 struct lws *
1048 lws_adopt_socket_vhost(struct lws_vhost *vh, lws_sockfd_type accept_fd);
1049
1050
1051 enum {
1052         LWS_EV_READ = (1 << 0),
1053         LWS_EV_WRITE = (1 << 1),
1054         LWS_EV_START = (1 << 2),
1055         LWS_EV_STOP = (1 << 3),
1056
1057         LWS_EV_PREPARE_DELETION = (1 << 31),
1058 };
1059
1060 #if defined(LWS_USE_LIBEV)
1061 LWS_EXTERN void
1062 lws_libev_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
1063 LWS_EXTERN void
1064 lws_libev_io(struct lws *wsi, int flags);
1065 LWS_EXTERN int
1066 lws_libev_init_fd_table(struct lws_context *context);
1067 LWS_EXTERN void
1068 lws_libev_destroyloop(struct lws_context *context, int tsi);
1069 LWS_EXTERN void
1070 lws_libev_run(const struct lws_context *context, int tsi);
1071 #define LWS_LIBEV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBEV)
1072 LWS_EXTERN void lws_feature_status_libev(struct lws_context_creation_info *info);
1073 #else
1074 #define lws_libev_accept(_a, _b) ((void) 0)
1075 #define lws_libev_io(_a, _b) ((void) 0)
1076 #define lws_libev_init_fd_table(_a) (0)
1077 #define lws_libev_run(_a, _b) ((void) 0)
1078 #define lws_libev_destroyloop(_a, _b) ((void) 0)
1079 #define LWS_LIBEV_ENABLED(context) (0)
1080 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
1081 #define lws_feature_status_libev(_a) \
1082                         lwsl_notice("libev support not compiled in\n")
1083 #else
1084 #define lws_feature_status_libev(_a)
1085 #endif
1086 #endif
1087
1088 #if defined(LWS_USE_LIBUV)
1089 LWS_EXTERN void
1090 lws_libuv_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
1091 LWS_EXTERN void
1092 lws_libuv_io(struct lws *wsi, int flags);
1093 LWS_EXTERN int
1094 lws_libuv_init_fd_table(struct lws_context *context);
1095 LWS_EXTERN void
1096 lws_libuv_run(const struct lws_context *context, int tsi);
1097 LWS_EXTERN void
1098 lws_libuv_destroyloop(struct lws_context *context, int tsi);
1099 LWS_EXTERN int
1100 lws_uv_initvhost(struct lws_vhost* vh, struct lws*);
1101 #define LWS_LIBUV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBUV)
1102 LWS_EXTERN void lws_feature_status_libuv(struct lws_context_creation_info *info);
1103 #else
1104 #define lws_libuv_accept(_a, _b) ((void) 0)
1105 #define lws_libuv_io(_a, _b) ((void) 0)
1106 #define lws_libuv_init_fd_table(_a) (0)
1107 #define lws_libuv_run(_a, _b) ((void) 0)
1108 #define lws_libuv_destroyloop(_a, _b) ((void) 0)
1109 #define LWS_LIBUV_ENABLED(context) (0)
1110 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
1111 #define lws_feature_status_libuv(_a) \
1112                         lwsl_notice("libuv support not compiled in\n")
1113 #else
1114 #define lws_feature_status_libuv(_a)
1115 #endif
1116 #endif
1117
1118 #if defined(LWS_USE_LIBEVENT)
1119 LWS_EXTERN void
1120 lws_libevent_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
1121 LWS_EXTERN void
1122 lws_libevent_io(struct lws *wsi, int flags);
1123 LWS_EXTERN int
1124 lws_libevent_init_fd_table(struct lws_context *context);
1125 LWS_EXTERN void
1126 lws_libevent_destroyloop(struct lws_context *context, int tsi);
1127 LWS_EXTERN void
1128 lws_libevent_run(const struct lws_context *context, int tsi);
1129 #define LWS_LIBEVENT_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBEVENT)
1130 LWS_EXTERN void lws_feature_status_libevent(struct lws_context_creation_info *info);
1131 #else
1132 #define lws_libevent_accept(_a, _b) ((void) 0)
1133 #define lws_libevent_io(_a, _b) ((void) 0)
1134 #define lws_libevent_init_fd_table(_a) (0)
1135 #define lws_libevent_run(_a, _b) ((void) 0)
1136 #define lws_libevent_destroyloop(_a, _b) ((void) 0)
1137 #define LWS_LIBEVENT_ENABLED(context) (0)
1138 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
1139 #define lws_feature_status_libevent(_a) \
1140                         lwsl_notice("libevent support not compiled in\n")
1141 #else
1142 #define lws_feature_status_libevent(_a)
1143 #endif
1144 #endif
1145
1146
1147 #ifdef LWS_USE_IPV6
1148 #define LWS_IPV6_ENABLED(vh) \
1149         (!lws_check_opt(vh->context->options, LWS_SERVER_OPTION_DISABLE_IPV6) && \
1150          !lws_check_opt(vh->options, LWS_SERVER_OPTION_DISABLE_IPV6))
1151 #else
1152 #define LWS_IPV6_ENABLED(context) (0)
1153 #endif
1154
1155 #ifdef LWS_USE_UNIX_SOCK
1156 #define LWS_UNIX_SOCK_ENABLED(vhost) \
1157         (vhost->options & LWS_SERVER_OPTION_UNIX_SOCK)
1158 #else
1159 #define LWS_UNIX_SOCK_ENABLED(vhost) (0)
1160 #endif
1161 enum uri_path_states {
1162         URIPS_IDLE,
1163         URIPS_SEEN_SLASH,
1164         URIPS_SEEN_SLASH_DOT,
1165         URIPS_SEEN_SLASH_DOT_DOT,
1166 };
1167
1168 enum uri_esc_states {
1169         URIES_IDLE,
1170         URIES_SEEN_PERCENT,
1171         URIES_SEEN_PERCENT_H1,
1172 };
1173
1174 /* notice that these union members:
1175  *
1176  *  hdr
1177  *  http
1178  *  http2
1179  *
1180  * all have a pointer to allocated_headers struct as their first member.
1181  *
1182  * It means for allocated_headers access, the three union paths can all be
1183  * used interchangeably to access the same data
1184  */
1185
1186
1187 #ifndef LWS_NO_CLIENT
1188 struct client_info_stash {
1189         char address[256];
1190         char path[4096];
1191         char host[256];
1192         char origin[256];
1193         char protocol[256];
1194         char method[16];
1195 };
1196 #endif
1197
1198 struct _lws_header_related {
1199         /* MUST be first in struct */
1200         struct allocated_headers *ah;
1201         struct lws *ah_wait_list;
1202         unsigned char *preamble_rx;
1203 #ifndef LWS_NO_CLIENT
1204         struct client_info_stash *stash;
1205 #endif
1206         unsigned int preamble_rx_len;
1207         enum uri_path_states ups;
1208         enum uri_esc_states ues;
1209         short lextable_pos;
1210         unsigned int current_token_limit;
1211
1212         char esc_stash;
1213         char post_literal_equal;
1214         unsigned char parser_state; /* enum lws_token_indexes */
1215 };
1216
1217 #if defined(LWS_WITH_RANGES)
1218 enum range_states {
1219         LWSRS_NO_ACTIVE_RANGE,
1220         LWSRS_BYTES_EQ,
1221         LWSRS_FIRST,
1222         LWSRS_STARTING,
1223         LWSRS_ENDING,
1224         LWSRS_COMPLETED,
1225         LWSRS_SYNTAX,
1226 };
1227
1228 struct lws_range_parsing {
1229         unsigned long long start, end, extent, agg, budget;
1230         const char buf[128];
1231         int pos;
1232         enum range_states state;
1233         char start_valid, end_valid, ctr, count_ranges, did_try, inside, send_ctr;
1234 };
1235
1236 int
1237 lws_ranges_init(struct lws *wsi, struct lws_range_parsing *rp, unsigned long long extent);
1238 int
1239 lws_ranges_next(struct lws_range_parsing *rp);
1240 void
1241 lws_ranges_reset(struct lws_range_parsing *rp);
1242 #endif
1243
1244 struct _lws_http_mode_related {
1245         /* MUST be first in struct */
1246         struct allocated_headers *ah; /* mirroring  _lws_header_related */
1247         struct lws *ah_wait_list;
1248         unsigned char *preamble_rx;
1249 #ifndef LWS_NO_CLIENT
1250         struct client_info_stash *stash;
1251 #endif
1252         unsigned int preamble_rx_len;
1253         struct lws *new_wsi_list;
1254         lws_filepos_t filepos;
1255         lws_filepos_t filelen;
1256         lws_fop_fd_t fop_fd;
1257
1258 #if defined(LWS_WITH_RANGES)
1259         struct lws_range_parsing range;
1260         char multipart_content_type[64];
1261 #endif
1262
1263         enum http_version request_version;
1264         enum http_connection_type connection_type;
1265         lws_filepos_t content_length;
1266         lws_filepos_t content_remain;
1267 };
1268
1269 #ifdef LWS_USE_HTTP2
1270
1271 enum lws_http2_settings {
1272         LWS_HTTP2_SETTINGS__HEADER_TABLE_SIZE = 1,
1273         LWS_HTTP2_SETTINGS__ENABLE_PUSH,
1274         LWS_HTTP2_SETTINGS__MAX_CONCURRENT_STREAMS,
1275         LWS_HTTP2_SETTINGS__INITIAL_WINDOW_SIZE,
1276         LWS_HTTP2_SETTINGS__MAX_FRAME_SIZE,
1277         LWS_HTTP2_SETTINGS__MAX_HEADER_LIST_SIZE,
1278
1279         LWS_HTTP2_SETTINGS__COUNT /* always last */
1280 };
1281
1282 enum lws_http2_wellknown_frame_types {
1283         LWS_HTTP2_FRAME_TYPE_DATA,
1284         LWS_HTTP2_FRAME_TYPE_HEADERS,
1285         LWS_HTTP2_FRAME_TYPE_PRIORITY,
1286         LWS_HTTP2_FRAME_TYPE_RST_STREAM,
1287         LWS_HTTP2_FRAME_TYPE_SETTINGS,
1288         LWS_HTTP2_FRAME_TYPE_PUSH_PROMISE,
1289         LWS_HTTP2_FRAME_TYPE_PING,
1290         LWS_HTTP2_FRAME_TYPE_GOAWAY,
1291         LWS_HTTP2_FRAME_TYPE_WINDOW_UPDATE,
1292         LWS_HTTP2_FRAME_TYPE_CONTINUATION,
1293
1294         LWS_HTTP2_FRAME_TYPE_COUNT /* always last */
1295 };
1296
1297 enum lws_http2_flags {
1298         LWS_HTTP2_FLAG_END_STREAM = 1,
1299         LWS_HTTP2_FLAG_END_HEADERS = 4,
1300         LWS_HTTP2_FLAG_PADDED = 8,
1301         LWS_HTTP2_FLAG_PRIORITY = 0x20,
1302
1303         LWS_HTTP2_FLAG_SETTINGS_ACK = 1,
1304 };
1305
1306 #define LWS_HTTP2_STREAM_ID_MASTER 0
1307 #define LWS_HTTP2_FRAME_HEADER_LENGTH 9
1308 #define LWS_HTTP2_SETTINGS_LENGTH 6
1309
1310 struct http2_settings {
1311         unsigned int setting[LWS_HTTP2_SETTINGS__COUNT];
1312 };
1313
1314 enum http2_hpack_state {
1315
1316         /* optional before first header block */
1317         HPKS_OPT_PADDING,
1318         HKPS_OPT_E_DEPENDENCY,
1319         HKPS_OPT_WEIGHT,
1320
1321         /* header block */
1322         HPKS_TYPE,
1323
1324         HPKS_IDX_EXT,
1325
1326         HPKS_HLEN,
1327         HPKS_HLEN_EXT,
1328
1329         HPKS_DATA,
1330
1331         /* optional after last header block */
1332         HKPS_OPT_DISCARD_PADDING,
1333 };
1334
1335 enum http2_hpack_type {
1336         HPKT_INDEXED_HDR_7,
1337         HPKT_INDEXED_HDR_6_VALUE_INCR,
1338         HPKT_LITERAL_HDR_VALUE_INCR,
1339         HPKT_INDEXED_HDR_4_VALUE,
1340         HPKT_LITERAL_HDR_VALUE,
1341         HPKT_SIZE_5
1342 };
1343
1344 struct hpack_dt_entry {
1345         int token; /* additions that don't map to a token are ignored */
1346         int arg_offset;
1347         int arg_len;
1348 };
1349
1350 struct hpack_dynamic_table {
1351         struct hpack_dt_entry *entries;
1352         char *args;
1353         int pos;
1354         int next;
1355         int num_entries;
1356         int args_length;
1357 };
1358
1359 struct _lws_http2_related {
1360         /*
1361          * having this first lets us also re-use all HTTP union code
1362          * and in turn, http_mode_related has allocated headers in right
1363          * place so we can use the header apis on the wsi directly still
1364          */
1365         struct _lws_http_mode_related http; /* MUST BE FIRST IN STRUCT */
1366
1367         struct http2_settings my_settings;
1368         struct http2_settings peer_settings;
1369
1370         struct lws *parent_wsi;
1371         struct lws *next_child_wsi;
1372
1373         struct hpack_dynamic_table *hpack_dyn_table;
1374         struct lws *stream_wsi;
1375         unsigned char ping_payload[8];
1376         unsigned char one_setting[LWS_HTTP2_SETTINGS_LENGTH];
1377
1378         unsigned int count;
1379         unsigned int length;
1380         unsigned int stream_id;
1381         enum http2_hpack_state hpack;
1382         enum http2_hpack_type hpack_type;
1383         unsigned int header_index;
1384         unsigned int hpack_len;
1385         unsigned int hpack_e_dep;
1386         int tx_credit;
1387         unsigned int my_stream_id;
1388         unsigned int child_count;
1389         int my_priority;
1390
1391         unsigned int END_STREAM:1;
1392         unsigned int END_HEADERS:1;
1393         unsigned int send_END_STREAM:1;
1394         unsigned int GOING_AWAY;
1395         unsigned int requested_POLLOUT:1;
1396         unsigned int waiting_tx_credit:1;
1397         unsigned int huff:1;
1398         unsigned int value:1;
1399
1400         unsigned short round_robin_POLLOUT;
1401         unsigned short count_POLLOUT_children;
1402         unsigned short hpack_pos;
1403
1404         unsigned char type;
1405         unsigned char flags;
1406         unsigned char frame_state;
1407         unsigned char padding;
1408         unsigned char hpack_m;
1409         unsigned char initialized;
1410 };
1411
1412 #define HTTP2_IS_TOPLEVEL_WSI(wsi) (!wsi->u.http2.parent_wsi)
1413
1414 #endif
1415
1416 struct _lws_websocket_related {
1417         /* cheapest way to deal with ah overlap with ws union transition */
1418         struct _lws_header_related hdr;
1419         char *rx_ubuf;
1420         unsigned int rx_ubuf_alloc;
1421         struct lws *rx_draining_ext_list;
1422         struct lws *tx_draining_ext_list;
1423         time_t time_next_ping_check;
1424         size_t rx_packet_length;
1425         unsigned int rx_ubuf_head;
1426         unsigned char mask[4];
1427         /* Also used for close content... control opcode == < 128 */
1428         unsigned char ping_payload_buf[128 - 3 + LWS_PRE];
1429
1430         unsigned char ping_payload_len;
1431         unsigned char mask_idx;
1432         unsigned char opcode;
1433         unsigned char rsv;
1434         unsigned char rsv_first_msg;
1435         /* zero if no info, or length including 2-byte close code */
1436         unsigned char close_in_ping_buffer_len;
1437         unsigned char utf8;
1438         unsigned char stashed_write_type;
1439         unsigned char tx_draining_stashed_wp;
1440
1441         unsigned int final:1;
1442         unsigned int frame_is_binary:1;
1443         unsigned int all_zero_nonce:1;
1444         unsigned int this_frame_masked:1;
1445         unsigned int inside_frame:1; /* next write will be more of frame */
1446         unsigned int clean_buffer:1; /* buffer not rewritten by extension */
1447         unsigned int payload_is_close:1; /* process as PONG, but it is close */
1448         unsigned int ping_pending_flag:1;
1449         unsigned int continuation_possible:1;
1450         unsigned int owed_a_fin:1;
1451         unsigned int check_utf8:1;
1452         unsigned int defeat_check_utf8:1;
1453         unsigned int pmce_compressed_message:1;
1454         unsigned int stashed_write_pending:1;
1455         unsigned int rx_draining_ext:1;
1456         unsigned int tx_draining_ext:1;
1457         unsigned int send_check_ping:1;
1458 };
1459
1460 #ifdef LWS_WITH_CGI
1461
1462 enum {
1463         SIGNIFICANT_HDR_CONTENT_LENGTH,
1464         SIGNIFICANT_HDR_LOCATION,
1465         SIGNIFICANT_HDR_STATUS,
1466         SIGNIFICANT_HDR_TRANSFER_ENCODING,
1467
1468         SIGNIFICANT_HDR_COUNT
1469 };
1470
1471 /* wsi who is master of the cgi points to an lws_cgi */
1472
1473 struct lws_cgi {
1474         struct lws_cgi *cgi_list;
1475         struct lws *stdwsi[3]; /* points to the associated stdin/out/err wsis */
1476         struct lws *wsi; /* owner */
1477         unsigned char *headers_buf;
1478         unsigned char *headers_pos;
1479         unsigned char *headers_dumped;
1480         unsigned char *headers_end;
1481         lws_filepos_t content_length;
1482         lws_filepos_t content_length_seen;
1483         int pipe_fds[3][2];
1484         int match[SIGNIFICANT_HDR_COUNT];
1485         int pid;
1486         int response_code;
1487         int lp;
1488         char l[12];
1489
1490         unsigned int being_closed:1;
1491         unsigned int explicitly_chunked:1;
1492
1493         unsigned char chunked_grace;
1494 };
1495 #endif
1496
1497 signed char char_to_hex(const char c);
1498
1499 #ifndef LWS_NO_CLIENT
1500 enum lws_chunk_parser {
1501         ELCP_HEX,
1502         ELCP_CR,
1503         ELCP_CONTENT,
1504         ELCP_POST_CR,
1505         ELCP_POST_LF,
1506 };
1507 #endif
1508
1509 struct lws_rewrite;
1510
1511 #ifdef LWS_WITH_ACCESS_LOG
1512 struct lws_access_log {
1513         char *header_log;
1514         char *user_agent;
1515         unsigned long sent;
1516         int response;
1517 };
1518 #endif
1519
1520 struct lws {
1521
1522         /* structs */
1523         /* members with mutually exclusive lifetimes are unionized */
1524
1525         union u {
1526                 struct _lws_http_mode_related http;
1527 #ifdef LWS_USE_HTTP2
1528                 struct _lws_http2_related http2;
1529 #endif
1530                 struct _lws_header_related hdr;
1531                 struct _lws_websocket_related ws;
1532         } u;
1533
1534         /* lifetime members */
1535
1536 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
1537         struct lws_io_watcher w_read;
1538 #endif
1539 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBEVENT)
1540         struct lws_io_watcher w_write;
1541 #endif
1542         time_t pending_timeout_limit;
1543
1544         /* pointers */
1545
1546         struct lws_context *context;
1547         struct lws_vhost *vhost;
1548         struct lws *parent; /* points to parent, if any */
1549         struct lws *child_list; /* points to first child */
1550         struct lws *sibling_list; /* subsequent children at same level */
1551 #ifdef LWS_WITH_CGI
1552         struct lws_cgi *cgi; /* wsi being cgi master have one of these */
1553 #endif
1554         const struct lws_protocols *protocol;
1555         struct lws **same_vh_protocol_prev, *same_vh_protocol_next;
1556         struct lws *timeout_list;
1557         struct lws **timeout_list_prev;
1558 #ifdef LWS_WITH_ACCESS_LOG
1559         struct lws_access_log access_log;
1560 #endif
1561         void *user_space;
1562         /* rxflow handling */
1563         unsigned char *rxflow_buffer;
1564         /* truncated send handling */
1565         unsigned char *trunc_alloc; /* non-NULL means buffering in progress */
1566
1567 #if defined (LWS_WITH_ESP8266)
1568         void *premature_rx;
1569         unsigned short prem_rx_size, prem_rx_pos;
1570 #endif
1571
1572 #ifndef LWS_NO_EXTENSIONS
1573         const struct lws_extension *active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
1574         void *act_ext_user[LWS_MAX_EXTENSIONS_ACTIVE];
1575 #endif
1576 #ifdef LWS_OPENSSL_SUPPORT
1577         SSL *ssl;
1578         BIO *client_bio;
1579         struct lws *pending_read_list_prev, *pending_read_list_next;
1580 #if defined(LWS_WITH_STATS)
1581         uint64_t accept_start_us;
1582         char seen_rx;
1583 #endif
1584 #endif
1585 #ifdef LWS_WITH_HTTP_PROXY
1586         struct lws_rewrite *rw;
1587 #endif
1588 #ifdef LWS_LATENCY
1589         unsigned long action_start;
1590         unsigned long latency_start;
1591 #endif
1592         lws_sock_file_fd_type desc; /* .filefd / .sockfd */
1593 #if defined(LWS_WITH_STATS)
1594         uint64_t active_writable_req_us;
1595 #endif
1596         /* ints */
1597         int position_in_fds_table;
1598         int rxflow_len;
1599         int rxflow_pos;
1600         unsigned int trunc_alloc_len; /* size of malloc */
1601         unsigned int trunc_offset; /* where we are in terms of spilling */
1602         unsigned int trunc_len; /* how much is buffered */
1603 #ifndef LWS_NO_CLIENT
1604         int chunk_remaining;
1605 #endif
1606         unsigned int cache_secs;
1607
1608         unsigned int hdr_parsing_completed:1;
1609         unsigned int http2_substream:1;
1610         unsigned int listener:1;
1611         unsigned int user_space_externally_allocated:1;
1612         unsigned int socket_is_permanently_unusable:1;
1613         unsigned int rxflow_change_to:2;
1614         unsigned int more_rx_waiting:1; /* has to live here since ah may stick to end */
1615         unsigned int conn_stat_done:1;
1616         unsigned int cache_reuse:1;
1617         unsigned int cache_revalidate:1;
1618         unsigned int cache_intermediaries:1;
1619         unsigned int favoured_pollin:1;
1620         unsigned int sending_chunked:1;
1621         unsigned int already_did_cce:1;
1622         unsigned int told_user_closed:1;
1623
1624 #if defined(LWS_WITH_ESP8266)
1625         unsigned int pending_send_completion:3;
1626         unsigned int close_is_pending_send_completion:1;
1627 #endif
1628 #ifdef LWS_WITH_ACCESS_LOG
1629         unsigned int access_log_pending:1;
1630 #endif
1631 #ifndef LWS_NO_CLIENT
1632         unsigned int do_ws:1; /* whether we are doing http or ws flow */
1633         unsigned int chunked:1; /* if the clientside connection is chunked */
1634         unsigned int client_rx_avail:1;
1635         unsigned int client_http_body_pending:1;
1636 #endif
1637 #ifdef LWS_WITH_HTTP_PROXY
1638         unsigned int perform_rewrite:1;
1639 #endif
1640 #ifndef LWS_NO_EXTENSIONS
1641         unsigned int extension_data_pending:1;
1642 #endif
1643 #ifdef LWS_OPENSSL_SUPPORT
1644         unsigned int use_ssl:4;
1645 #endif
1646 #ifdef _WIN32
1647         unsigned int sock_send_blocking:1;
1648 #endif
1649 #ifdef LWS_OPENSSL_SUPPORT
1650         unsigned int redirect_to_https:1;
1651 #endif
1652
1653         /* volatile to make sure code is aware other thread can change */
1654         volatile unsigned int handling_pollout:1;
1655         volatile unsigned int leave_pollout_active:1;
1656
1657 #ifndef LWS_NO_CLIENT
1658         unsigned short c_port;
1659 #endif
1660
1661         /* chars */
1662 #ifndef LWS_NO_EXTENSIONS
1663         unsigned char count_act_ext;
1664 #endif
1665         unsigned char ietf_spec_revision;
1666         char mode; /* enum connection_mode */
1667         char state; /* enum lws_connection_states */
1668         char state_pre_close;
1669         char lws_rx_parse_state; /* enum lws_rx_parse_state */
1670         char rx_frame_type; /* enum lws_write_protocol */
1671         char pending_timeout; /* enum pending_timeout */
1672         char pps; /* enum lws_pending_protocol_send */
1673         char tsi; /* thread service index we belong to */
1674         char protocol_interpret_idx;
1675         char redirects;
1676 #ifdef LWS_WITH_CGI
1677         char cgi_channel; /* which of stdin/out/err */
1678         char hdr_state;
1679 #endif
1680 #ifndef LWS_NO_CLIENT
1681         char chunk_parser; /* enum lws_chunk_parser */
1682 #endif
1683 #if defined(LWS_WITH_CGI) || !defined(LWS_NO_CLIENT)
1684         char reason_bf; /* internal writeable callback reason bitfield */
1685 #endif
1686 };
1687
1688 LWS_EXTERN int log_level;
1689
1690 LWS_EXTERN int
1691 lws_socket_bind(struct lws_vhost *vhost, lws_sockfd_type sockfd, int port,
1692                 const char *iface);
1693
1694 #if defined(LWS_USE_IPV6)
1695 LWS_EXTERN unsigned long
1696 lws_get_addr_scope(const char *ipaddr);
1697 #endif
1698
1699 LWS_EXTERN void
1700 lws_close_free_wsi(struct lws *wsi, enum lws_close_status);
1701
1702 LWS_EXTERN int
1703 remove_wsi_socket_from_fds(struct lws *wsi);
1704 LWS_EXTERN int
1705 lws_rxflow_cache(struct lws *wsi, unsigned char *buf, int n, int len);
1706
1707 #ifndef LWS_LATENCY
1708 static inline void
1709 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1710             int ret, int completion) {
1711         do {
1712                 (void)context; (void)wsi; (void)action; (void)ret;
1713                 (void)completion;
1714         } while (0);
1715 }
1716 static inline void
1717 lws_latency_pre(struct lws_context *context, struct lws *wsi) {
1718         do { (void)context; (void)wsi; } while (0);
1719 }
1720 #else
1721 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
1722 extern void
1723 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1724             int ret, int completion);
1725 #endif
1726
1727 LWS_EXTERN void
1728 lws_set_protocol_write_pending(struct lws *wsi,
1729                                enum lws_pending_protocol_send pend);
1730 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1731 lws_client_rx_sm(struct lws *wsi, unsigned char c);
1732
1733 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1734 lws_parse(struct lws *wsi, unsigned char c);
1735
1736 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1737 lws_http_action(struct lws *wsi);
1738
1739 LWS_EXTERN int
1740 lws_b64_selftest(void);
1741
1742 LWS_EXTERN int
1743 lws_service_flag_pending(struct lws_context *context, int tsi);
1744
1745 #if defined(_WIN32) || defined(LWS_WITH_ESP8266)
1746 LWS_EXTERN struct lws *
1747 wsi_from_fd(const struct lws_context *context, lws_sockfd_type fd);
1748
1749 LWS_EXTERN int
1750 insert_wsi(struct lws_context *context, struct lws *wsi);
1751
1752 LWS_EXTERN int
1753 delete_from_fd(struct lws_context *context, lws_sockfd_type fd);
1754 #else
1755 #define wsi_from_fd(A,B)  A->lws_lookup[B]
1756 #define insert_wsi(A,B)   assert(A->lws_lookup[B->desc.sockfd] == 0); A->lws_lookup[B->desc.sockfd]=B
1757 #define delete_from_fd(A,B) A->lws_lookup[B]=0
1758 #endif
1759
1760 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1761 insert_wsi_socket_into_fds(struct lws_context *context, struct lws *wsi);
1762
1763 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1764 lws_issue_raw(struct lws *wsi, unsigned char *buf, size_t len);
1765
1766
1767 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1768 lws_service_timeout_check(struct lws *wsi, unsigned int sec);
1769
1770 LWS_EXTERN void
1771 lws_remove_from_timeout_list(struct lws *wsi);
1772
1773 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1774 lws_client_connect_2(struct lws *wsi);
1775
1776 LWS_VISIBLE struct lws * LWS_WARN_UNUSED_RESULT
1777 lws_client_reset(struct lws **wsi, int ssl, const char *address, int port,
1778                  const char *path, const char *host);
1779
1780 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1781 lws_create_new_server_wsi(struct lws_vhost *vhost);
1782
1783 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1784 lws_generate_client_handshake(struct lws *wsi, char *pkt);
1785
1786 LWS_EXTERN int
1787 lws_handle_POLLOUT_event(struct lws *wsi, struct lws_pollfd *pollfd);
1788
1789 LWS_EXTERN struct lws *
1790 lws_client_connect_via_info2(struct lws *wsi);
1791
1792 /*
1793  * EXTENSIONS
1794  */
1795
1796 #ifndef LWS_NO_EXTENSIONS
1797 LWS_VISIBLE void
1798 lws_context_init_extensions(struct lws_context_creation_info *info,
1799                             struct lws_context *context);
1800 LWS_EXTERN int
1801 lws_any_extension_handled(struct lws *wsi, enum lws_extension_callback_reasons r,
1802                           void *v, size_t len);
1803
1804 LWS_EXTERN int
1805 lws_ext_cb_active(struct lws *wsi, int reason, void *buf, int len);
1806 LWS_EXTERN int
1807 lws_ext_cb_all_exts(struct lws_context *context, struct lws *wsi, int reason,
1808                     void *arg, int len);
1809
1810 #else
1811 #define lws_any_extension_handled(_a, _b, _c, _d) (0)
1812 #define lws_ext_cb_active(_a, _b, _c, _d) (0)
1813 #define lws_ext_cb_all_exts(_a, _b, _c, _d, _e) (0)
1814 #define lws_issue_raw_ext_access lws_issue_raw
1815 #define lws_context_init_extensions(_a, _b)
1816 #endif
1817
1818 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1819 lws_client_interpret_server_handshake(struct lws *wsi);
1820
1821 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1822 lws_rx_sm(struct lws *wsi, unsigned char c);
1823
1824 LWS_EXTERN int
1825 lws_payload_until_length_exhausted(struct lws *wsi, unsigned char **buf, size_t *len);
1826
1827 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1828 lws_issue_raw_ext_access(struct lws *wsi, unsigned char *buf, size_t len);
1829
1830 LWS_EXTERN void
1831 lws_union_transition(struct lws *wsi, enum connection_mode mode);
1832
1833 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1834 user_callback_handle_rxflow(lws_callback_function, struct lws *wsi,
1835                             enum lws_callback_reasons reason, void *user,
1836                             void *in, size_t len);
1837 #ifdef LWS_USE_HTTP2
1838 LWS_EXTERN struct lws *lws_http2_get_network_wsi(struct lws *wsi);
1839 struct lws * lws_http2_get_nth_child(struct lws *wsi, int n);
1840 LWS_EXTERN int
1841 lws_http2_interpret_settings_payload(struct http2_settings *settings,
1842                                      unsigned char *buf, int len);
1843 LWS_EXTERN void lws_http2_init(struct http2_settings *settings);
1844 LWS_EXTERN int
1845 lws_http2_parser(struct lws *wsi, unsigned char c);
1846 LWS_EXTERN int lws_http2_do_pps_send(struct lws_context *context,
1847                                      struct lws *wsi);
1848 LWS_EXTERN int lws_http2_frame_write(struct lws *wsi, int type, int flags,
1849                                      unsigned int sid, unsigned int len,
1850                                      unsigned char *buf);
1851 LWS_EXTERN struct lws *
1852 lws_http2_wsi_from_id(struct lws *wsi, unsigned int sid);
1853 LWS_EXTERN int lws_hpack_interpret(struct lws *wsi,
1854                                    unsigned char c);
1855 LWS_EXTERN int
1856 lws_add_http2_header_by_name(struct lws *wsi,
1857                              const unsigned char *name,
1858                              const unsigned char *value, int length,
1859                              unsigned char **p, unsigned char *end);
1860 LWS_EXTERN int
1861 lws_add_http2_header_by_token(struct lws *wsi,
1862                             enum lws_token_indexes token,
1863                             const unsigned char *value, int length,
1864                             unsigned char **p, unsigned char *end);
1865 LWS_EXTERN int
1866 lws_add_http2_header_status(struct lws *wsi,
1867                             unsigned int code, unsigned char **p,
1868                             unsigned char *end);
1869 LWS_EXTERN
1870 void lws_http2_configure_if_upgraded(struct lws *wsi);
1871 #else
1872 #define lws_http2_configure_if_upgraded(x)
1873 #endif
1874
1875 LWS_EXTERN int
1876 lws_plat_set_socket_options(struct lws_vhost *vhost, lws_sockfd_type fd);
1877
1878 LWS_EXTERN int
1879 lws_plat_check_connection_error(struct lws *wsi);
1880
1881 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1882 lws_header_table_attach(struct lws *wsi, int autoservice);
1883
1884 LWS_EXTERN int
1885 lws_header_table_detach(struct lws *wsi, int autoservice);
1886
1887 LWS_EXTERN void
1888 lws_header_table_reset(struct lws *wsi, int autoservice);
1889 void
1890 _lws_header_table_reset(struct allocated_headers *ah);
1891
1892 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1893 lws_hdr_simple_ptr(struct lws *wsi, enum lws_token_indexes h);
1894
1895 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1896 lws_hdr_simple_create(struct lws *wsi, enum lws_token_indexes h, const char *s);
1897
1898 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1899 lws_ensure_user_space(struct lws *wsi);
1900
1901 LWS_EXTERN int
1902 lws_change_pollfd(struct lws *wsi, int _and, int _or);
1903
1904 #ifndef LWS_NO_SERVER
1905 int lws_context_init_server(struct lws_context_creation_info *info,
1906                             struct lws_vhost *vhost);
1907 LWS_EXTERN struct lws_vhost *
1908 lws_select_vhost(struct lws_context *context, int port, const char *servername);
1909 LWS_EXTERN int
1910 handshake_0405(struct lws_context *context, struct lws *wsi);
1911 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1912 lws_interpret_incoming_packet(struct lws *wsi, unsigned char **buf, size_t len);
1913 LWS_EXTERN void
1914 lws_server_get_canonical_hostname(struct lws_context *context,
1915                                   struct lws_context_creation_info *info);
1916 #else
1917 #define lws_context_init_server(_a, _b) (0)
1918 #define lws_interpret_incoming_packet(_a, _b, _c) (0)
1919 #define lws_server_get_canonical_hostname(_a, _b)
1920 #endif
1921
1922 #ifndef LWS_NO_DAEMONIZE
1923 LWS_EXTERN int get_daemonize_pid();
1924 #else
1925 #define get_daemonize_pid() (0)
1926 #endif
1927
1928 #if !defined(LWS_WITH_ESP8266)
1929 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1930 interface_to_sa(struct lws_vhost *vh, const char *ifname,
1931                 struct sockaddr_in *addr, size_t addrlen);
1932 #endif
1933 LWS_EXTERN void lwsl_emit_stderr(int level, const char *line);
1934
1935 enum lws_ssl_capable_status {
1936         LWS_SSL_CAPABLE_ERROR = -1,
1937         LWS_SSL_CAPABLE_MORE_SERVICE = -2,
1938 };
1939
1940 #ifndef LWS_OPENSSL_SUPPORT
1941 #define LWS_SSL_ENABLED(context) (0)
1942 #define lws_context_init_server_ssl(_a, _b) (0)
1943 #define lws_ssl_destroy(_a)
1944 #define lws_context_init_http2_ssl(_a)
1945 #define lws_ssl_capable_read lws_ssl_capable_read_no_ssl
1946 #define lws_ssl_capable_write lws_ssl_capable_write_no_ssl
1947 #define lws_ssl_pending lws_ssl_pending_no_ssl
1948 #define lws_server_socket_service_ssl(_b, _c) (0)
1949 #define lws_ssl_close(_a) (0)
1950 #define lws_ssl_context_destroy(_a)
1951 #define lws_ssl_SSL_CTX_destroy(_a)
1952 #define lws_ssl_remove_wsi_from_buffered_list(_a)
1953 #define lws_context_init_ssl_library(_a)
1954 #else
1955 #define LWS_SSL_ENABLED(context) (context->use_ssl)
1956 LWS_EXTERN int openssl_websocket_private_data_index;
1957 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1958 lws_ssl_capable_read(struct lws *wsi, unsigned char *buf, int len);
1959 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1960 lws_ssl_capable_write(struct lws *wsi, unsigned char *buf, int len);
1961 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1962 lws_ssl_pending(struct lws *wsi);
1963 LWS_EXTERN int
1964 lws_context_init_ssl_library(struct lws_context_creation_info *info);
1965 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1966 lws_server_socket_service_ssl(struct lws *new_wsi, lws_sockfd_type accept_fd);
1967 LWS_EXTERN int
1968 lws_ssl_close(struct lws *wsi);
1969 LWS_EXTERN void
1970 lws_ssl_SSL_CTX_destroy(struct lws_vhost *vhost);
1971 LWS_EXTERN void
1972 lws_ssl_context_destroy(struct lws_context *context);
1973 LWS_VISIBLE void
1974 lws_ssl_remove_wsi_from_buffered_list(struct lws *wsi);
1975 LWS_EXTERN int
1976 lws_ssl_client_bio_create(struct lws *wsi);
1977 LWS_EXTERN int
1978 lws_ssl_client_connect1(struct lws *wsi);
1979 LWS_EXTERN int
1980 lws_ssl_client_connect2(struct lws *wsi);
1981 LWS_EXTERN void
1982 lws_ssl_elaborate_error(void);
1983 #ifndef LWS_NO_SERVER
1984 LWS_EXTERN int
1985 lws_context_init_server_ssl(struct lws_context_creation_info *info,
1986                             struct lws_vhost *vhost);
1987 #else
1988 #define lws_context_init_server_ssl(_a, _b) (0)
1989 #endif
1990 LWS_EXTERN void
1991 lws_ssl_destroy(struct lws_vhost *vhost);
1992 /* HTTP2-related */
1993
1994 #ifdef LWS_USE_HTTP2
1995 LWS_EXTERN void
1996 lws_context_init_http2_ssl(struct lws_vhost *vhost);
1997 #else
1998 #define lws_context_init_http2_ssl(_a)
1999 #endif
2000 #endif
2001
2002 #if LWS_MAX_SMP > 1
2003 static LWS_INLINE void
2004 lws_pt_mutex_init(struct lws_context_per_thread *pt)
2005 {
2006         pthread_mutex_init(&pt->lock, NULL);
2007 }
2008
2009 static LWS_INLINE void
2010 lws_pt_mutex_destroy(struct lws_context_per_thread *pt)
2011 {
2012         pthread_mutex_destroy(&pt->lock);
2013 }
2014
2015 static LWS_INLINE void
2016 lws_pt_lock(struct lws_context_per_thread *pt)
2017 {
2018         if (!pt->lock_depth++)
2019                 pthread_mutex_lock(&pt->lock);
2020 }
2021
2022 static LWS_INLINE void
2023 lws_pt_unlock(struct lws_context_per_thread *pt)
2024 {
2025         if (!(--pt->lock_depth))
2026                 pthread_mutex_unlock(&pt->lock);
2027 }
2028 #else
2029 #define lws_pt_mutex_init(_a) (void)(_a)
2030 #define lws_pt_mutex_destroy(_a) (void)(_a)
2031 #define lws_pt_lock(_a) (void)(_a)
2032 #define lws_pt_unlock(_a) (void)(_a)
2033 #endif
2034
2035 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2036 lws_ssl_capable_read_no_ssl(struct lws *wsi, unsigned char *buf, int len);
2037
2038 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2039 lws_ssl_capable_write_no_ssl(struct lws *wsi, unsigned char *buf, int len);
2040
2041 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2042 lws_ssl_pending_no_ssl(struct lws *wsi);
2043
2044 #ifdef LWS_WITH_HTTP_PROXY
2045 struct lws_rewrite {
2046         hubbub_parser *parser;
2047         hubbub_parser_optparams params;
2048         const char *from, *to;
2049         int from_len, to_len;
2050         unsigned char *p, *end;
2051         struct lws *wsi;
2052 };
2053 static LWS_INLINE int hstrcmp(hubbub_string *s, const char *p, int len)
2054 {
2055         if (s->len != len)
2056                 return 1;
2057
2058         return strncmp((const char *)s->ptr, p, len);
2059 }
2060 typedef hubbub_error (*hubbub_callback_t)(const hubbub_token *token, void *pw);
2061 LWS_EXTERN struct lws_rewrite *
2062 lws_rewrite_create(struct lws *wsi, hubbub_callback_t cb, const char *from, const char *to);
2063 LWS_EXTERN void
2064 lws_rewrite_destroy(struct lws_rewrite *r);
2065 LWS_EXTERN int
2066 lws_rewrite_parse(struct lws_rewrite *r, const unsigned char *in, int in_len);
2067 #endif
2068
2069 #ifndef LWS_NO_CLIENT
2070 LWS_EXTERN int lws_client_socket_service(struct lws_context *context,
2071                                          struct lws *wsi,
2072                                          struct lws_pollfd *pollfd);
2073 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2074 lws_http_transaction_completed_client(struct lws *wsi);
2075 #ifdef LWS_OPENSSL_SUPPORT
2076 LWS_EXTERN int
2077 lws_context_init_client_ssl(struct lws_context_creation_info *info,
2078                             struct lws_vhost *vhost);
2079 #else
2080         #define lws_context_init_client_ssl(_a, _b) (0)
2081 #endif
2082 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2083 lws_handshake_client(struct lws *wsi, unsigned char **buf, size_t len);
2084 LWS_EXTERN void
2085 lws_decode_ssl_error(void);
2086 #else
2087 #define lws_context_init_client_ssl(_a, _b) (0)
2088 #define lws_handshake_client(_a, _b, _c) (0)
2089 #endif
2090
2091 LWS_EXTERN int
2092 _lws_rx_flow_control(struct lws *wsi);
2093
2094 LWS_EXTERN int
2095 _lws_change_pollfd(struct lws *wsi, int _and, int _or, struct lws_pollargs *pa);
2096
2097 #ifndef LWS_NO_SERVER
2098 LWS_EXTERN int
2099 lws_server_socket_service(struct lws_context *context, struct lws *wsi,
2100                           struct lws_pollfd *pollfd);
2101 LWS_EXTERN int
2102 lws_handshake_server(struct lws *wsi, unsigned char **buf, size_t len);
2103 #else
2104 #define lws_server_socket_service(_a, _b, _c) (0)
2105 #define lws_handshake_server(_a, _b, _c) (0)
2106 #endif
2107
2108 #ifdef LWS_WITH_ACCESS_LOG
2109 LWS_EXTERN int
2110 lws_access_log(struct lws *wsi);
2111 #else
2112 #define lws_access_log(_a)
2113 #endif
2114
2115 LWS_EXTERN int
2116 lws_cgi_kill_terminated(struct lws_context_per_thread *pt);
2117
2118 int
2119 lws_protocol_init(struct lws_context *context);
2120
2121 int
2122 lws_bind_protocol(struct lws *wsi, const struct lws_protocols *p);
2123
2124 const struct lws_http_mount *
2125 lws_find_mount(struct lws *wsi, const char *uri_ptr, int uri_len);
2126
2127 /*
2128  * custom allocator
2129  */
2130 LWS_EXTERN void *
2131 lws_realloc(void *ptr, size_t size);
2132
2133 LWS_EXTERN void * LWS_WARN_UNUSED_RESULT
2134 lws_zalloc(size_t size);
2135
2136 #ifdef LWS_PLAT_OPTEE
2137 void *lws_malloc(size_t size);
2138 void lws_free(void *p);
2139 #define lws_free_set_NULL(P)    do { lws_free(P); (P) = NULL; } while(0)
2140 #else
2141 #define lws_malloc(S)   lws_realloc(NULL, S)
2142 #define lws_free(P)     lws_realloc(P, 0)
2143 #define lws_free_set_NULL(P)    do { lws_realloc(P, 0); (P) = NULL; } while(0)
2144 #endif
2145
2146 const struct lws_plat_file_ops *
2147 lws_vfs_select_fops(const struct lws_plat_file_ops *fops, const char *vfs_path,
2148                     const char **vpath);
2149
2150 /* lws_plat_ */
2151 LWS_EXTERN void
2152 lws_plat_delete_socket_from_fds(struct lws_context *context,
2153                                 struct lws *wsi, int m);
2154 LWS_EXTERN void
2155 lws_plat_insert_socket_into_fds(struct lws_context *context,
2156                                 struct lws *wsi);
2157 LWS_EXTERN void
2158 lws_plat_service_periodic(struct lws_context *context);
2159
2160 LWS_EXTERN int
2161 lws_plat_change_pollfd(struct lws_context *context, struct lws *wsi,
2162                        struct lws_pollfd *pfd);
2163 LWS_EXTERN void
2164 lws_add_wsi_to_draining_ext_list(struct lws *wsi);
2165 LWS_EXTERN void
2166 lws_remove_wsi_from_draining_ext_list(struct lws *wsi);
2167 LWS_EXTERN int
2168 lws_plat_context_early_init(void);
2169 LWS_EXTERN void
2170 lws_plat_context_early_destroy(struct lws_context *context);
2171 LWS_EXTERN void
2172 lws_plat_context_late_destroy(struct lws_context *context);
2173 LWS_EXTERN int
2174 lws_poll_listen_fd(struct lws_pollfd *fd);
2175 LWS_EXTERN int
2176 lws_plat_service(struct lws_context *context, int timeout_ms);
2177 LWS_EXTERN LWS_VISIBLE int
2178 _lws_plat_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
2179 LWS_EXTERN int
2180 lws_plat_init(struct lws_context *context,
2181               struct lws_context_creation_info *info);
2182 LWS_EXTERN void
2183 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
2184 LWS_EXTERN unsigned long long
2185 time_in_microseconds(void);
2186 LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
2187 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);
2188 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2189 lws_plat_inet_pton(int af, const char *src, void *dst);
2190
2191 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2192 lws_check_utf8(unsigned char *state, unsigned char *buf, size_t len);
2193 LWS_EXTERN int alloc_file(struct lws_context *context, const char *filename, uint8_t **buf,
2194                                 lws_filepos_t *amount);
2195 LWS_EXTERN int alloc_pem_to_der_file(struct lws_context *context, const char *filename, uint8_t **buf,
2196                lws_filepos_t *amount);
2197
2198 LWS_EXTERN void
2199 lws_same_vh_protocol_remove(struct lws *wsi);
2200 LWS_EXTERN void
2201 lws_same_vh_protocol_insert(struct lws *wsi, int n);
2202
2203 #if defined(LWS_WITH_STATS)
2204 void
2205 lws_stats_atomic_bump(struct lws_context * context,
2206                 struct lws_context_per_thread *pt, int index, uint64_t bump);
2207 void
2208 lws_stats_atomic_max(struct lws_context * context,
2209                 struct lws_context_per_thread *pt, int index, uint64_t val);
2210 #else
2211 static inline uint64_t lws_stats_atomic_bump(struct lws_context * context,
2212                 struct lws_context_per_thread *pt, int index, uint64_t bump) {
2213         (void)context; (void)pt; (void)index; (void)bump; return 0; }
2214 static inline uint64_t lws_stats_atomic_max(struct lws_context * context,
2215                 struct lws_context_per_thread *pt, int index, uint64_t val) {
2216         (void)context; (void)pt; (void)index; (void)val; return 0; }
2217 #endif
2218
2219 /* socks */
2220 void socks_generate_msg(struct lws *wsi, enum socks_msg_type type,
2221                         size_t *msg_len);
2222
2223 #ifdef __cplusplus
2224 };
2225 #endif