lib/private-libwebsockets.h

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