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