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         char iface[16];
1196 };
1197 #endif
1198
1199 struct _lws_header_related {
1200         /* MUST be first in struct */
1201         struct allocated_headers *ah;
1202         struct lws *ah_wait_list;
1203         unsigned char *preamble_rx;
1204 #ifndef LWS_NO_CLIENT
1205         struct client_info_stash *stash;
1206 #endif
1207         unsigned int preamble_rx_len;
1208         enum uri_path_states ups;
1209         enum uri_esc_states ues;
1210         short lextable_pos;
1211         unsigned int current_token_limit;
1212
1213         char esc_stash;
1214         char post_literal_equal;
1215         unsigned char parser_state; /* enum lws_token_indexes */
1216 };
1217
1218 #if defined(LWS_WITH_RANGES)
1219 enum range_states {
1220         LWSRS_NO_ACTIVE_RANGE,
1221         LWSRS_BYTES_EQ,
1222         LWSRS_FIRST,
1223         LWSRS_STARTING,
1224         LWSRS_ENDING,
1225         LWSRS_COMPLETED,
1226         LWSRS_SYNTAX,
1227 };
1228
1229 struct lws_range_parsing {
1230         unsigned long long start, end, extent, agg, budget;
1231         const char buf[128];
1232         int pos;
1233         enum range_states state;
1234         char start_valid, end_valid, ctr, count_ranges, did_try, inside, send_ctr;
1235 };
1236
1237 int
1238 lws_ranges_init(struct lws *wsi, struct lws_range_parsing *rp, unsigned long long extent);
1239 int
1240 lws_ranges_next(struct lws_range_parsing *rp);
1241 void
1242 lws_ranges_reset(struct lws_range_parsing *rp);
1243 #endif
1244
1245 struct _lws_http_mode_related {
1246         /* MUST be first in struct */
1247         struct allocated_headers *ah; /* mirroring  _lws_header_related */
1248         struct lws *ah_wait_list;
1249         unsigned char *preamble_rx;
1250 #ifndef LWS_NO_CLIENT
1251         struct client_info_stash *stash;
1252 #endif
1253         unsigned int preamble_rx_len;
1254         struct lws *new_wsi_list;
1255         lws_filepos_t filepos;
1256         lws_filepos_t filelen;
1257         lws_fop_fd_t fop_fd;
1258
1259 #if defined(LWS_WITH_RANGES)
1260         struct lws_range_parsing range;
1261         char multipart_content_type[64];
1262 #endif
1263
1264         enum http_version request_version;
1265         enum http_connection_type connection_type;
1266         lws_filepos_t content_length;
1267         lws_filepos_t content_remain;
1268 };
1269
1270 #ifdef LWS_USE_HTTP2
1271
1272 enum lws_http2_settings {
1273         LWS_HTTP2_SETTINGS__HEADER_TABLE_SIZE = 1,
1274         LWS_HTTP2_SETTINGS__ENABLE_PUSH,
1275         LWS_HTTP2_SETTINGS__MAX_CONCURRENT_STREAMS,
1276         LWS_HTTP2_SETTINGS__INITIAL_WINDOW_SIZE,
1277         LWS_HTTP2_SETTINGS__MAX_FRAME_SIZE,
1278         LWS_HTTP2_SETTINGS__MAX_HEADER_LIST_SIZE,
1279
1280         LWS_HTTP2_SETTINGS__COUNT /* always last */
1281 };
1282
1283 enum lws_http2_wellknown_frame_types {
1284         LWS_HTTP2_FRAME_TYPE_DATA,
1285         LWS_HTTP2_FRAME_TYPE_HEADERS,
1286         LWS_HTTP2_FRAME_TYPE_PRIORITY,
1287         LWS_HTTP2_FRAME_TYPE_RST_STREAM,
1288         LWS_HTTP2_FRAME_TYPE_SETTINGS,
1289         LWS_HTTP2_FRAME_TYPE_PUSH_PROMISE,
1290         LWS_HTTP2_FRAME_TYPE_PING,
1291         LWS_HTTP2_FRAME_TYPE_GOAWAY,
1292         LWS_HTTP2_FRAME_TYPE_WINDOW_UPDATE,
1293         LWS_HTTP2_FRAME_TYPE_CONTINUATION,
1294
1295         LWS_HTTP2_FRAME_TYPE_COUNT /* always last */
1296 };
1297
1298 enum lws_http2_flags {
1299         LWS_HTTP2_FLAG_END_STREAM = 1,
1300         LWS_HTTP2_FLAG_END_HEADERS = 4,
1301         LWS_HTTP2_FLAG_PADDED = 8,
1302         LWS_HTTP2_FLAG_PRIORITY = 0x20,
1303
1304         LWS_HTTP2_FLAG_SETTINGS_ACK = 1,
1305 };
1306
1307 #define LWS_HTTP2_STREAM_ID_MASTER 0
1308 #define LWS_HTTP2_FRAME_HEADER_LENGTH 9
1309 #define LWS_HTTP2_SETTINGS_LENGTH 6
1310
1311 struct http2_settings {
1312         unsigned int setting[LWS_HTTP2_SETTINGS__COUNT];
1313 };
1314
1315 enum http2_hpack_state {
1316
1317         /* optional before first header block */
1318         HPKS_OPT_PADDING,
1319         HKPS_OPT_E_DEPENDENCY,
1320         HKPS_OPT_WEIGHT,
1321
1322         /* header block */
1323         HPKS_TYPE,
1324
1325         HPKS_IDX_EXT,
1326
1327         HPKS_HLEN,
1328         HPKS_HLEN_EXT,
1329
1330         HPKS_DATA,
1331
1332         /* optional after last header block */
1333         HKPS_OPT_DISCARD_PADDING,
1334 };
1335
1336 enum http2_hpack_type {
1337         HPKT_INDEXED_HDR_7,
1338         HPKT_INDEXED_HDR_6_VALUE_INCR,
1339         HPKT_LITERAL_HDR_VALUE_INCR,
1340         HPKT_INDEXED_HDR_4_VALUE,
1341         HPKT_LITERAL_HDR_VALUE,
1342         HPKT_SIZE_5
1343 };
1344
1345 struct hpack_dt_entry {
1346         int token; /* additions that don't map to a token are ignored */
1347         int arg_offset;
1348         int arg_len;
1349 };
1350
1351 struct hpack_dynamic_table {
1352         struct hpack_dt_entry *entries;
1353         char *args;
1354         int pos;
1355         int next;
1356         int num_entries;
1357         int args_length;
1358 };
1359
1360 struct _lws_http2_related {
1361         /*
1362          * having this first lets us also re-use all HTTP union code
1363          * and in turn, http_mode_related has allocated headers in right
1364          * place so we can use the header apis on the wsi directly still
1365          */
1366         struct _lws_http_mode_related http; /* MUST BE FIRST IN STRUCT */
1367
1368         struct http2_settings my_settings;
1369         struct http2_settings peer_settings;
1370
1371         struct lws *parent_wsi;
1372         struct lws *next_child_wsi;
1373
1374         struct hpack_dynamic_table *hpack_dyn_table;
1375         struct lws *stream_wsi;
1376         unsigned char ping_payload[8];
1377         unsigned char one_setting[LWS_HTTP2_SETTINGS_LENGTH];
1378
1379         unsigned int count;
1380         unsigned int length;
1381         unsigned int stream_id;
1382         enum http2_hpack_state hpack;
1383         enum http2_hpack_type hpack_type;
1384         unsigned int header_index;
1385         unsigned int hpack_len;
1386         unsigned int hpack_e_dep;
1387         int tx_credit;
1388         unsigned int my_stream_id;
1389         unsigned int child_count;
1390         int my_priority;
1391
1392         unsigned int END_STREAM:1;
1393         unsigned int END_HEADERS:1;
1394         unsigned int send_END_STREAM:1;
1395         unsigned int GOING_AWAY;
1396         unsigned int requested_POLLOUT:1;
1397         unsigned int waiting_tx_credit:1;
1398         unsigned int huff:1;
1399         unsigned int value:1;
1400
1401         unsigned short round_robin_POLLOUT;
1402         unsigned short count_POLLOUT_children;
1403         unsigned short hpack_pos;
1404
1405         unsigned char type;
1406         unsigned char flags;
1407         unsigned char frame_state;
1408         unsigned char padding;
1409         unsigned char hpack_m;
1410         unsigned char initialized;
1411 };
1412
1413 #define HTTP2_IS_TOPLEVEL_WSI(wsi) (!wsi->u.http2.parent_wsi)
1414
1415 #endif
1416
1417 struct _lws_websocket_related {
1418         /* cheapest way to deal with ah overlap with ws union transition */
1419         struct _lws_header_related hdr;
1420         char *rx_ubuf;
1421         unsigned int rx_ubuf_alloc;
1422         struct lws *rx_draining_ext_list;
1423         struct lws *tx_draining_ext_list;
1424         time_t time_next_ping_check;
1425         size_t rx_packet_length;
1426         unsigned int rx_ubuf_head;
1427         unsigned char mask[4];
1428         /* Also used for close content... control opcode == < 128 */
1429         unsigned char ping_payload_buf[128 - 3 + LWS_PRE];
1430
1431         unsigned char ping_payload_len;
1432         unsigned char mask_idx;
1433         unsigned char opcode;
1434         unsigned char rsv;
1435         unsigned char rsv_first_msg;
1436         /* zero if no info, or length including 2-byte close code */
1437         unsigned char close_in_ping_buffer_len;
1438         unsigned char utf8;
1439         unsigned char stashed_write_type;
1440         unsigned char tx_draining_stashed_wp;
1441
1442         unsigned int final:1;
1443         unsigned int frame_is_binary:1;
1444         unsigned int all_zero_nonce:1;
1445         unsigned int this_frame_masked:1;
1446         unsigned int inside_frame:1; /* next write will be more of frame */
1447         unsigned int clean_buffer:1; /* buffer not rewritten by extension */
1448         unsigned int payload_is_close:1; /* process as PONG, but it is close */
1449         unsigned int ping_pending_flag:1;
1450         unsigned int continuation_possible:1;
1451         unsigned int owed_a_fin:1;
1452         unsigned int check_utf8:1;
1453         unsigned int defeat_check_utf8:1;
1454         unsigned int pmce_compressed_message:1;
1455         unsigned int stashed_write_pending:1;
1456         unsigned int rx_draining_ext:1;
1457         unsigned int tx_draining_ext:1;
1458         unsigned int send_check_ping:1;
1459 };
1460
1461 #ifdef LWS_WITH_CGI
1462
1463 enum {
1464         SIGNIFICANT_HDR_CONTENT_LENGTH,
1465         SIGNIFICANT_HDR_LOCATION,
1466         SIGNIFICANT_HDR_STATUS,
1467         SIGNIFICANT_HDR_TRANSFER_ENCODING,
1468
1469         SIGNIFICANT_HDR_COUNT
1470 };
1471
1472 /* wsi who is master of the cgi points to an lws_cgi */
1473
1474 struct lws_cgi {
1475         struct lws_cgi *cgi_list;
1476         struct lws *stdwsi[3]; /* points to the associated stdin/out/err wsis */
1477         struct lws *wsi; /* owner */
1478         unsigned char *headers_buf;
1479         unsigned char *headers_pos;
1480         unsigned char *headers_dumped;
1481         unsigned char *headers_end;
1482         lws_filepos_t content_length;
1483         lws_filepos_t content_length_seen;
1484         int pipe_fds[3][2];
1485         int match[SIGNIFICANT_HDR_COUNT];
1486         int pid;
1487         int response_code;
1488         int lp;
1489         char l[12];
1490
1491         unsigned int being_closed:1;
1492         unsigned int explicitly_chunked:1;
1493
1494         unsigned char chunked_grace;
1495 };
1496 #endif
1497
1498 signed char char_to_hex(const char c);
1499
1500 #ifndef LWS_NO_CLIENT
1501 enum lws_chunk_parser {
1502         ELCP_HEX,
1503         ELCP_CR,
1504         ELCP_CONTENT,
1505         ELCP_POST_CR,
1506         ELCP_POST_LF,
1507 };
1508 #endif
1509
1510 struct lws_rewrite;
1511
1512 #ifdef LWS_WITH_ACCESS_LOG
1513 struct lws_access_log {
1514         char *header_log;
1515         char *user_agent;
1516         unsigned long sent;
1517         int response;
1518 };
1519 #endif
1520
1521 struct lws {
1522
1523         /* structs */
1524         /* members with mutually exclusive lifetimes are unionized */
1525
1526         union u {
1527                 struct _lws_http_mode_related http;
1528 #ifdef LWS_USE_HTTP2
1529                 struct _lws_http2_related http2;
1530 #endif
1531                 struct _lws_header_related hdr;
1532                 struct _lws_websocket_related ws;
1533         } u;
1534
1535         /* lifetime members */
1536
1537 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
1538         struct lws_io_watcher w_read;
1539 #endif
1540 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBEVENT)
1541         struct lws_io_watcher w_write;
1542 #endif
1543         time_t pending_timeout_limit;
1544
1545         /* pointers */
1546
1547         struct lws_context *context;
1548         struct lws_vhost *vhost;
1549         struct lws *parent; /* points to parent, if any */
1550         struct lws *child_list; /* points to first child */
1551         struct lws *sibling_list; /* subsequent children at same level */
1552 #ifdef LWS_WITH_CGI
1553         struct lws_cgi *cgi; /* wsi being cgi master have one of these */
1554 #endif
1555         const struct lws_protocols *protocol;
1556         struct lws **same_vh_protocol_prev, *same_vh_protocol_next;
1557         struct lws *timeout_list;
1558         struct lws **timeout_list_prev;
1559 #ifdef LWS_WITH_ACCESS_LOG
1560         struct lws_access_log access_log;
1561 #endif
1562         void *user_space;
1563         /* rxflow handling */
1564         unsigned char *rxflow_buffer;
1565         /* truncated send handling */
1566         unsigned char *trunc_alloc; /* non-NULL means buffering in progress */
1567
1568 #if defined (LWS_WITH_ESP8266)
1569         void *premature_rx;
1570         unsigned short prem_rx_size, prem_rx_pos;
1571 #endif
1572
1573 #ifndef LWS_NO_EXTENSIONS
1574         const struct lws_extension *active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
1575         void *act_ext_user[LWS_MAX_EXTENSIONS_ACTIVE];
1576 #endif
1577 #ifdef LWS_OPENSSL_SUPPORT
1578         SSL *ssl;
1579         BIO *client_bio;
1580         struct lws *pending_read_list_prev, *pending_read_list_next;
1581 #if defined(LWS_WITH_STATS)
1582         uint64_t accept_start_us;
1583         char seen_rx;
1584 #endif
1585 #endif
1586 #ifdef LWS_WITH_HTTP_PROXY
1587         struct lws_rewrite *rw;
1588 #endif
1589 #ifdef LWS_LATENCY
1590         unsigned long action_start;
1591         unsigned long latency_start;
1592 #endif
1593         lws_sock_file_fd_type desc; /* .filefd / .sockfd */
1594 #if defined(LWS_WITH_STATS)
1595         uint64_t active_writable_req_us;
1596 #endif
1597         /* ints */
1598         int position_in_fds_table;
1599         int rxflow_len;
1600         int rxflow_pos;
1601         unsigned int trunc_alloc_len; /* size of malloc */
1602         unsigned int trunc_offset; /* where we are in terms of spilling */
1603         unsigned int trunc_len; /* how much is buffered */
1604 #ifndef LWS_NO_CLIENT
1605         int chunk_remaining;
1606 #endif
1607         unsigned int cache_secs;
1608
1609         unsigned int hdr_parsing_completed:1;
1610         unsigned int http2_substream:1;
1611         unsigned int listener:1;
1612         unsigned int user_space_externally_allocated:1;
1613         unsigned int socket_is_permanently_unusable:1;
1614         unsigned int rxflow_change_to:2;
1615         unsigned int more_rx_waiting:1; /* has to live here since ah may stick to end */
1616         unsigned int conn_stat_done:1;
1617         unsigned int cache_reuse:1;
1618         unsigned int cache_revalidate:1;
1619         unsigned int cache_intermediaries:1;
1620         unsigned int favoured_pollin:1;
1621         unsigned int sending_chunked:1;
1622         unsigned int already_did_cce:1;
1623         unsigned int told_user_closed:1;
1624
1625 #if defined(LWS_WITH_ESP8266)
1626         unsigned int pending_send_completion:3;
1627         unsigned int close_is_pending_send_completion:1;
1628 #endif
1629 #ifdef LWS_WITH_ACCESS_LOG
1630         unsigned int access_log_pending:1;
1631 #endif
1632 #ifndef LWS_NO_CLIENT
1633         unsigned int do_ws:1; /* whether we are doing http or ws flow */
1634         unsigned int chunked:1; /* if the clientside connection is chunked */
1635         unsigned int client_rx_avail:1;
1636         unsigned int client_http_body_pending:1;
1637 #endif
1638 #ifdef LWS_WITH_HTTP_PROXY
1639         unsigned int perform_rewrite:1;
1640 #endif
1641 #ifndef LWS_NO_EXTENSIONS
1642         unsigned int extension_data_pending:1;
1643 #endif
1644 #ifdef LWS_OPENSSL_SUPPORT
1645         unsigned int use_ssl:4;
1646 #endif
1647 #ifdef _WIN32
1648         unsigned int sock_send_blocking:1;
1649 #endif
1650 #ifdef LWS_OPENSSL_SUPPORT
1651         unsigned int redirect_to_https:1;
1652 #endif
1653
1654         /* volatile to make sure code is aware other thread can change */
1655         volatile unsigned int handling_pollout:1;
1656         volatile unsigned int leave_pollout_active:1;
1657
1658 #ifndef LWS_NO_CLIENT
1659         unsigned short c_port;
1660 #endif
1661
1662         /* chars */
1663 #ifndef LWS_NO_EXTENSIONS
1664         unsigned char count_act_ext;
1665 #endif
1666         unsigned char ietf_spec_revision;
1667         char mode; /* enum connection_mode */
1668         char state; /* enum lws_connection_states */
1669         char state_pre_close;
1670         char lws_rx_parse_state; /* enum lws_rx_parse_state */
1671         char rx_frame_type; /* enum lws_write_protocol */
1672         char pending_timeout; /* enum pending_timeout */
1673         char pps; /* enum lws_pending_protocol_send */
1674         char tsi; /* thread service index we belong to */
1675         char protocol_interpret_idx;
1676         char redirects;
1677 #ifdef LWS_WITH_CGI
1678         char cgi_channel; /* which of stdin/out/err */
1679         char hdr_state;
1680 #endif
1681 #ifndef LWS_NO_CLIENT
1682         char chunk_parser; /* enum lws_chunk_parser */
1683 #endif
1684 #if defined(LWS_WITH_CGI) || !defined(LWS_NO_CLIENT)
1685         char reason_bf; /* internal writeable callback reason bitfield */
1686 #endif
1687 };
1688
1689 LWS_EXTERN int log_level;
1690
1691 LWS_EXTERN int
1692 lws_socket_bind(struct lws_vhost *vhost, lws_sockfd_type sockfd, int port,
1693                 const char *iface);
1694
1695 #if defined(LWS_USE_IPV6)
1696 LWS_EXTERN unsigned long
1697 lws_get_addr_scope(const char *ipaddr);
1698 #endif
1699
1700 LWS_EXTERN void
1701 lws_close_free_wsi(struct lws *wsi, enum lws_close_status);
1702
1703 LWS_EXTERN int
1704 remove_wsi_socket_from_fds(struct lws *wsi);
1705 LWS_EXTERN int
1706 lws_rxflow_cache(struct lws *wsi, unsigned char *buf, int n, int len);
1707
1708 #ifndef LWS_LATENCY
1709 static inline void
1710 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1711             int ret, int completion) {
1712         do {
1713                 (void)context; (void)wsi; (void)action; (void)ret;
1714                 (void)completion;
1715         } while (0);
1716 }
1717 static inline void
1718 lws_latency_pre(struct lws_context *context, struct lws *wsi) {
1719         do { (void)context; (void)wsi; } while (0);
1720 }
1721 #else
1722 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
1723 extern void
1724 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1725             int ret, int completion);
1726 #endif
1727
1728 LWS_EXTERN void
1729 lws_set_protocol_write_pending(struct lws *wsi,
1730                                enum lws_pending_protocol_send pend);
1731 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1732 lws_client_rx_sm(struct lws *wsi, unsigned char c);
1733
1734 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1735 lws_parse(struct lws *wsi, unsigned char c);
1736
1737 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1738 lws_http_action(struct lws *wsi);
1739
1740 LWS_EXTERN int
1741 lws_b64_selftest(void);
1742
1743 LWS_EXTERN int
1744 lws_service_flag_pending(struct lws_context *context, int tsi);
1745
1746 #if defined(_WIN32) || defined(LWS_WITH_ESP8266)
1747 LWS_EXTERN struct lws *
1748 wsi_from_fd(const struct lws_context *context, lws_sockfd_type fd);
1749
1750 LWS_EXTERN int
1751 insert_wsi(struct lws_context *context, struct lws *wsi);
1752
1753 LWS_EXTERN int
1754 delete_from_fd(struct lws_context *context, lws_sockfd_type fd);
1755 #else
1756 #define wsi_from_fd(A,B)  A->lws_lookup[B]
1757 #define insert_wsi(A,B)   assert(A->lws_lookup[B->desc.sockfd] == 0); A->lws_lookup[B->desc.sockfd]=B
1758 #define delete_from_fd(A,B) A->lws_lookup[B]=0
1759 #endif
1760
1761 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1762 insert_wsi_socket_into_fds(struct lws_context *context, struct lws *wsi);
1763
1764 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1765 lws_issue_raw(struct lws *wsi, unsigned char *buf, size_t len);
1766
1767
1768 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1769 lws_service_timeout_check(struct lws *wsi, unsigned int sec);
1770
1771 LWS_EXTERN void
1772 lws_remove_from_timeout_list(struct lws *wsi);
1773
1774 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1775 lws_client_connect_2(struct lws *wsi);
1776
1777 LWS_VISIBLE struct lws * LWS_WARN_UNUSED_RESULT
1778 lws_client_reset(struct lws **wsi, int ssl, const char *address, int port,
1779                  const char *path, const char *host);
1780
1781 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1782 lws_create_new_server_wsi(struct lws_vhost *vhost);
1783
1784 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1785 lws_generate_client_handshake(struct lws *wsi, char *pkt);
1786
1787 LWS_EXTERN int
1788 lws_handle_POLLOUT_event(struct lws *wsi, struct lws_pollfd *pollfd);
1789
1790 LWS_EXTERN struct lws *
1791 lws_client_connect_via_info2(struct lws *wsi);
1792
1793 /*
1794  * EXTENSIONS
1795  */
1796
1797 #ifndef LWS_NO_EXTENSIONS
1798 LWS_VISIBLE void
1799 lws_context_init_extensions(struct lws_context_creation_info *info,
1800                             struct lws_context *context);
1801 LWS_EXTERN int
1802 lws_any_extension_handled(struct lws *wsi, enum lws_extension_callback_reasons r,
1803                           void *v, size_t len);
1804
1805 LWS_EXTERN int
1806 lws_ext_cb_active(struct lws *wsi, int reason, void *buf, int len);
1807 LWS_EXTERN int
1808 lws_ext_cb_all_exts(struct lws_context *context, struct lws *wsi, int reason,
1809                     void *arg, int len);
1810
1811 #else
1812 #define lws_any_extension_handled(_a, _b, _c, _d) (0)
1813 #define lws_ext_cb_active(_a, _b, _c, _d) (0)
1814 #define lws_ext_cb_all_exts(_a, _b, _c, _d, _e) (0)
1815 #define lws_issue_raw_ext_access lws_issue_raw
1816 #define lws_context_init_extensions(_a, _b)
1817 #endif
1818
1819 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1820 lws_client_interpret_server_handshake(struct lws *wsi);
1821
1822 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1823 lws_rx_sm(struct lws *wsi, unsigned char c);
1824
1825 LWS_EXTERN int
1826 lws_payload_until_length_exhausted(struct lws *wsi, unsigned char **buf, size_t *len);
1827
1828 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1829 lws_issue_raw_ext_access(struct lws *wsi, unsigned char *buf, size_t len);
1830
1831 LWS_EXTERN void
1832 lws_union_transition(struct lws *wsi, enum connection_mode mode);
1833
1834 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1835 user_callback_handle_rxflow(lws_callback_function, struct lws *wsi,
1836                             enum lws_callback_reasons reason, void *user,
1837                             void *in, size_t len);
1838 #ifdef LWS_USE_HTTP2
1839 LWS_EXTERN struct lws *lws_http2_get_network_wsi(struct lws *wsi);
1840 struct lws * lws_http2_get_nth_child(struct lws *wsi, int n);
1841 LWS_EXTERN int
1842 lws_http2_interpret_settings_payload(struct http2_settings *settings,
1843                                      unsigned char *buf, int len);
1844 LWS_EXTERN void lws_http2_init(struct http2_settings *settings);
1845 LWS_EXTERN int
1846 lws_http2_parser(struct lws *wsi, unsigned char c);
1847 LWS_EXTERN int lws_http2_do_pps_send(struct lws_context *context,
1848                                      struct lws *wsi);
1849 LWS_EXTERN int lws_http2_frame_write(struct lws *wsi, int type, int flags,
1850                                      unsigned int sid, unsigned int len,
1851                                      unsigned char *buf);
1852 LWS_EXTERN struct lws *
1853 lws_http2_wsi_from_id(struct lws *wsi, unsigned int sid);
1854 LWS_EXTERN int lws_hpack_interpret(struct lws *wsi,
1855                                    unsigned char c);
1856 LWS_EXTERN int
1857 lws_add_http2_header_by_name(struct lws *wsi,
1858                              const unsigned char *name,
1859                              const unsigned char *value, int length,
1860                              unsigned char **p, unsigned char *end);
1861 LWS_EXTERN int
1862 lws_add_http2_header_by_token(struct lws *wsi,
1863                             enum lws_token_indexes token,
1864                             const unsigned char *value, int length,
1865                             unsigned char **p, unsigned char *end);
1866 LWS_EXTERN int
1867 lws_add_http2_header_status(struct lws *wsi,
1868                             unsigned int code, unsigned char **p,
1869                             unsigned char *end);
1870 LWS_EXTERN
1871 void lws_http2_configure_if_upgraded(struct lws *wsi);
1872 #else
1873 #define lws_http2_configure_if_upgraded(x)
1874 #endif
1875
1876 LWS_EXTERN int
1877 lws_plat_set_socket_options(struct lws_vhost *vhost, lws_sockfd_type fd);
1878
1879 LWS_EXTERN int
1880 lws_plat_check_connection_error(struct lws *wsi);
1881
1882 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1883 lws_header_table_attach(struct lws *wsi, int autoservice);
1884
1885 LWS_EXTERN int
1886 lws_header_table_detach(struct lws *wsi, int autoservice);
1887
1888 LWS_EXTERN void
1889 lws_header_table_reset(struct lws *wsi, int autoservice);
1890 void
1891 _lws_header_table_reset(struct allocated_headers *ah);
1892
1893 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1894 lws_hdr_simple_ptr(struct lws *wsi, enum lws_token_indexes h);
1895
1896 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1897 lws_hdr_simple_create(struct lws *wsi, enum lws_token_indexes h, const char *s);
1898
1899 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1900 lws_ensure_user_space(struct lws *wsi);
1901
1902 LWS_EXTERN int
1903 lws_change_pollfd(struct lws *wsi, int _and, int _or);
1904
1905 #ifndef LWS_NO_SERVER
1906 int lws_context_init_server(struct lws_context_creation_info *info,
1907                             struct lws_vhost *vhost);
1908 LWS_EXTERN struct lws_vhost *
1909 lws_select_vhost(struct lws_context *context, int port, const char *servername);
1910 LWS_EXTERN int
1911 handshake_0405(struct lws_context *context, struct lws *wsi);
1912 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1913 lws_interpret_incoming_packet(struct lws *wsi, unsigned char **buf, size_t len);
1914 LWS_EXTERN void
1915 lws_server_get_canonical_hostname(struct lws_context *context,
1916                                   struct lws_context_creation_info *info);
1917 #else
1918 #define lws_context_init_server(_a, _b) (0)
1919 #define lws_interpret_incoming_packet(_a, _b, _c) (0)
1920 #define lws_server_get_canonical_hostname(_a, _b)
1921 #endif
1922
1923 #ifndef LWS_NO_DAEMONIZE
1924 LWS_EXTERN int get_daemonize_pid();
1925 #else
1926 #define get_daemonize_pid() (0)
1927 #endif
1928
1929 #if !defined(LWS_WITH_ESP8266)
1930 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1931 interface_to_sa(struct lws_vhost *vh, const char *ifname,
1932                 struct sockaddr_in *addr, size_t addrlen);
1933 #endif
1934 LWS_EXTERN void lwsl_emit_stderr(int level, const char *line);
1935
1936 enum lws_ssl_capable_status {
1937         LWS_SSL_CAPABLE_ERROR = -1,
1938         LWS_SSL_CAPABLE_MORE_SERVICE = -2,
1939 };
1940
1941 #ifndef LWS_OPENSSL_SUPPORT
1942 #define LWS_SSL_ENABLED(context) (0)
1943 #define lws_context_init_server_ssl(_a, _b) (0)
1944 #define lws_ssl_destroy(_a)
1945 #define lws_context_init_http2_ssl(_a)
1946 #define lws_ssl_capable_read lws_ssl_capable_read_no_ssl
1947 #define lws_ssl_capable_write lws_ssl_capable_write_no_ssl
1948 #define lws_ssl_pending lws_ssl_pending_no_ssl
1949 #define lws_server_socket_service_ssl(_b, _c) (0)
1950 #define lws_ssl_close(_a) (0)
1951 #define lws_ssl_context_destroy(_a)
1952 #define lws_ssl_SSL_CTX_destroy(_a)
1953 #define lws_ssl_remove_wsi_from_buffered_list(_a)
1954 #define lws_context_init_ssl_library(_a)
1955 #else
1956 #define LWS_SSL_ENABLED(context) (context->use_ssl)
1957 LWS_EXTERN int openssl_websocket_private_data_index;
1958 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1959 lws_ssl_capable_read(struct lws *wsi, unsigned char *buf, int len);
1960 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1961 lws_ssl_capable_write(struct lws *wsi, unsigned char *buf, int len);
1962 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1963 lws_ssl_pending(struct lws *wsi);
1964 LWS_EXTERN int
1965 lws_context_init_ssl_library(struct lws_context_creation_info *info);
1966 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1967 lws_server_socket_service_ssl(struct lws *new_wsi, lws_sockfd_type accept_fd);
1968 LWS_EXTERN int
1969 lws_ssl_close(struct lws *wsi);
1970 LWS_EXTERN void
1971 lws_ssl_SSL_CTX_destroy(struct lws_vhost *vhost);
1972 LWS_EXTERN void
1973 lws_ssl_context_destroy(struct lws_context *context);
1974 LWS_VISIBLE void
1975 lws_ssl_remove_wsi_from_buffered_list(struct lws *wsi);
1976 LWS_EXTERN int
1977 lws_ssl_client_bio_create(struct lws *wsi);
1978 LWS_EXTERN int
1979 lws_ssl_client_connect1(struct lws *wsi);
1980 LWS_EXTERN int
1981 lws_ssl_client_connect2(struct lws *wsi);
1982 LWS_EXTERN void
1983 lws_ssl_elaborate_error(void);
1984 #ifndef LWS_NO_SERVER
1985 LWS_EXTERN int
1986 lws_context_init_server_ssl(struct lws_context_creation_info *info,
1987                             struct lws_vhost *vhost);
1988 #else
1989 #define lws_context_init_server_ssl(_a, _b) (0)
1990 #endif
1991 LWS_EXTERN void
1992 lws_ssl_destroy(struct lws_vhost *vhost);
1993 /* HTTP2-related */
1994
1995 #ifdef LWS_USE_HTTP2
1996 LWS_EXTERN void
1997 lws_context_init_http2_ssl(struct lws_vhost *vhost);
1998 #else
1999 #define lws_context_init_http2_ssl(_a)
2000 #endif
2001 #endif
2002
2003 #if LWS_MAX_SMP > 1
2004 static LWS_INLINE void
2005 lws_pt_mutex_init(struct lws_context_per_thread *pt)
2006 {
2007         pthread_mutex_init(&pt->lock, NULL);
2008 }
2009
2010 static LWS_INLINE void
2011 lws_pt_mutex_destroy(struct lws_context_per_thread *pt)
2012 {
2013         pthread_mutex_destroy(&pt->lock);
2014 }
2015
2016 static LWS_INLINE void
2017 lws_pt_lock(struct lws_context_per_thread *pt)
2018 {
2019         if (!pt->lock_depth++)
2020                 pthread_mutex_lock(&pt->lock);
2021 }
2022
2023 static LWS_INLINE void
2024 lws_pt_unlock(struct lws_context_per_thread *pt)
2025 {
2026         if (!(--pt->lock_depth))
2027                 pthread_mutex_unlock(&pt->lock);
2028 }
2029 #else
2030 #define lws_pt_mutex_init(_a) (void)(_a)
2031 #define lws_pt_mutex_destroy(_a) (void)(_a)
2032 #define lws_pt_lock(_a) (void)(_a)
2033 #define lws_pt_unlock(_a) (void)(_a)
2034 #endif
2035
2036 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2037 lws_ssl_capable_read_no_ssl(struct lws *wsi, unsigned char *buf, int len);
2038
2039 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2040 lws_ssl_capable_write_no_ssl(struct lws *wsi, unsigned char *buf, int len);
2041
2042 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2043 lws_ssl_pending_no_ssl(struct lws *wsi);
2044
2045 #ifdef LWS_WITH_HTTP_PROXY
2046 struct lws_rewrite {
2047         hubbub_parser *parser;
2048         hubbub_parser_optparams params;
2049         const char *from, *to;
2050         int from_len, to_len;
2051         unsigned char *p, *end;
2052         struct lws *wsi;
2053 };
2054 static LWS_INLINE int hstrcmp(hubbub_string *s, const char *p, int len)
2055 {
2056         if (s->len != len)
2057                 return 1;
2058
2059         return strncmp((const char *)s->ptr, p, len);
2060 }
2061 typedef hubbub_error (*hubbub_callback_t)(const hubbub_token *token, void *pw);
2062 LWS_EXTERN struct lws_rewrite *
2063 lws_rewrite_create(struct lws *wsi, hubbub_callback_t cb, const char *from, const char *to);
2064 LWS_EXTERN void
2065 lws_rewrite_destroy(struct lws_rewrite *r);
2066 LWS_EXTERN int
2067 lws_rewrite_parse(struct lws_rewrite *r, const unsigned char *in, int in_len);
2068 #endif
2069
2070 #ifndef LWS_NO_CLIENT
2071 LWS_EXTERN int lws_client_socket_service(struct lws_context *context,
2072                                          struct lws *wsi,
2073                                          struct lws_pollfd *pollfd);
2074 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2075 lws_http_transaction_completed_client(struct lws *wsi);
2076 #ifdef LWS_OPENSSL_SUPPORT
2077 LWS_EXTERN int
2078 lws_context_init_client_ssl(struct lws_context_creation_info *info,
2079                             struct lws_vhost *vhost);
2080 #else
2081         #define lws_context_init_client_ssl(_a, _b) (0)
2082 #endif
2083 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2084 lws_handshake_client(struct lws *wsi, unsigned char **buf, size_t len);
2085 LWS_EXTERN void
2086 lws_decode_ssl_error(void);
2087 #else
2088 #define lws_context_init_client_ssl(_a, _b) (0)
2089 #define lws_handshake_client(_a, _b, _c) (0)
2090 #endif
2091
2092 LWS_EXTERN int
2093 _lws_rx_flow_control(struct lws *wsi);
2094
2095 LWS_EXTERN int
2096 _lws_change_pollfd(struct lws *wsi, int _and, int _or, struct lws_pollargs *pa);
2097
2098 #ifndef LWS_NO_SERVER
2099 LWS_EXTERN int
2100 lws_server_socket_service(struct lws_context *context, struct lws *wsi,
2101                           struct lws_pollfd *pollfd);
2102 LWS_EXTERN int
2103 lws_handshake_server(struct lws *wsi, unsigned char **buf, size_t len);
2104 #else
2105 #define lws_server_socket_service(_a, _b, _c) (0)
2106 #define lws_handshake_server(_a, _b, _c) (0)
2107 #endif
2108
2109 #ifdef LWS_WITH_ACCESS_LOG
2110 LWS_EXTERN int
2111 lws_access_log(struct lws *wsi);
2112 #else
2113 #define lws_access_log(_a)
2114 #endif
2115
2116 LWS_EXTERN int
2117 lws_cgi_kill_terminated(struct lws_context_per_thread *pt);
2118
2119 int
2120 lws_protocol_init(struct lws_context *context);
2121
2122 int
2123 lws_bind_protocol(struct lws *wsi, const struct lws_protocols *p);
2124
2125 const struct lws_http_mount *
2126 lws_find_mount(struct lws *wsi, const char *uri_ptr, int uri_len);
2127
2128 /*
2129  * custom allocator
2130  */
2131 LWS_EXTERN void *
2132 lws_realloc(void *ptr, size_t size);
2133
2134 LWS_EXTERN void * LWS_WARN_UNUSED_RESULT
2135 lws_zalloc(size_t size);
2136
2137 #ifdef LWS_PLAT_OPTEE
2138 void *lws_malloc(size_t size);
2139 void lws_free(void *p);
2140 #define lws_free_set_NULL(P)    do { lws_free(P); (P) = NULL; } while(0)
2141 #else
2142 #define lws_malloc(S)   lws_realloc(NULL, S)
2143 #define lws_free(P)     lws_realloc(P, 0)
2144 #define lws_free_set_NULL(P)    do { lws_realloc(P, 0); (P) = NULL; } while(0)
2145 #endif
2146
2147 const struct lws_plat_file_ops *
2148 lws_vfs_select_fops(const struct lws_plat_file_ops *fops, const char *vfs_path,
2149                     const char **vpath);
2150
2151 /* lws_plat_ */
2152 LWS_EXTERN void
2153 lws_plat_delete_socket_from_fds(struct lws_context *context,
2154                                 struct lws *wsi, int m);
2155 LWS_EXTERN void
2156 lws_plat_insert_socket_into_fds(struct lws_context *context,
2157                                 struct lws *wsi);
2158 LWS_EXTERN void
2159 lws_plat_service_periodic(struct lws_context *context);
2160
2161 LWS_EXTERN int
2162 lws_plat_change_pollfd(struct lws_context *context, struct lws *wsi,
2163                        struct lws_pollfd *pfd);
2164 LWS_EXTERN void
2165 lws_add_wsi_to_draining_ext_list(struct lws *wsi);
2166 LWS_EXTERN void
2167 lws_remove_wsi_from_draining_ext_list(struct lws *wsi);
2168 LWS_EXTERN int
2169 lws_plat_context_early_init(void);
2170 LWS_EXTERN void
2171 lws_plat_context_early_destroy(struct lws_context *context);
2172 LWS_EXTERN void
2173 lws_plat_context_late_destroy(struct lws_context *context);
2174 LWS_EXTERN int
2175 lws_poll_listen_fd(struct lws_pollfd *fd);
2176 LWS_EXTERN int
2177 lws_plat_service(struct lws_context *context, int timeout_ms);
2178 LWS_EXTERN LWS_VISIBLE int
2179 _lws_plat_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
2180 LWS_EXTERN int
2181 lws_plat_init(struct lws_context *context,
2182               struct lws_context_creation_info *info);
2183 LWS_EXTERN void
2184 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
2185 LWS_EXTERN unsigned long long
2186 time_in_microseconds(void);
2187 LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
2188 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);
2189 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2190 lws_plat_inet_pton(int af, const char *src, void *dst);
2191
2192 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2193 lws_check_utf8(unsigned char *state, unsigned char *buf, size_t len);
2194 LWS_EXTERN int alloc_file(struct lws_context *context, const char *filename, uint8_t **buf,
2195                                 lws_filepos_t *amount);
2196 LWS_EXTERN int alloc_pem_to_der_file(struct lws_context *context, const char *filename, uint8_t **buf,
2197                lws_filepos_t *amount);
2198
2199 LWS_EXTERN void
2200 lws_same_vh_protocol_remove(struct lws *wsi);
2201 LWS_EXTERN void
2202 lws_same_vh_protocol_insert(struct lws *wsi, int n);
2203
2204 #if defined(LWS_WITH_STATS)
2205 void
2206 lws_stats_atomic_bump(struct lws_context * context,
2207                 struct lws_context_per_thread *pt, int index, uint64_t bump);
2208 void
2209 lws_stats_atomic_max(struct lws_context * context,
2210                 struct lws_context_per_thread *pt, int index, uint64_t val);
2211 #else
2212 static inline uint64_t lws_stats_atomic_bump(struct lws_context * context,
2213                 struct lws_context_per_thread *pt, int index, uint64_t bump) {
2214         (void)context; (void)pt; (void)index; (void)bump; return 0; }
2215 static inline uint64_t lws_stats_atomic_max(struct lws_context * context,
2216                 struct lws_context_per_thread *pt, int index, uint64_t val) {
2217         (void)context; (void)pt; (void)index; (void)val; return 0; }
2218 #endif
2219
2220 /* socks */
2221 void socks_generate_msg(struct lws *wsi, enum socks_msg_type type,
2222                         size_t *msg_len);
2223
2224 #ifdef __cplusplus
2225 };
2226 #endif