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         const struct lws_protocols *protocols;
 858         void **protocol_vh_privs;
 859         const struct lws_protocol_vhost_options *pvo;
 860         const struct lws_protocol_vhost_options *headers;
 861         struct lws **same_vh_protocol_list;
 862 #ifdef LWS_OPENSSL_SUPPORT
 863         SSL_CTX *ssl_ctx;
 864         SSL_CTX *ssl_client_ctx;
 865 #endif
 866 #ifndef LWS_NO_EXTENSIONS
 867         const struct lws_extension *extensions;
 868 #endif
 869
 870         int listen_port;
 871         unsigned int http_proxy_port;
 872 #if defined(LWS_WITH_SOCKS5)
 873         unsigned int socks_proxy_port;
 874 #endif
 875         unsigned int options;
 876         int count_protocols;
 877         int ka_time;
 878         int ka_probes;
 879         int ka_interval;
 880         int keepalive_timeout;
 881 #ifdef LWS_WITH_ACCESS_LOG
 882         int log_fd;
 883 #endif
 884
 885 #ifdef LWS_OPENSSL_SUPPORT
 886         int use_ssl;
 887         int allow_non_ssl_on_ssl_port;
 888         unsigned int user_supplied_ssl_ctx:1;
 889 #endif
 890
 891         unsigned int created_vhost_protocols:1;
 892
 893         unsigned char default_protocol_index;
 894         unsigned char raw_protocol_index;
 895 };
 896
 897 /*
 898  * the rest is managed per-context, that includes
 899  *
 900  *  - processwide single fd -> wsi lookup
 901  *  - contextwide headers pool
 902  */
 903
 904 struct lws_context {
 905         time_t last_timeout_check_s;
 906         time_t last_ws_ping_pong_check_s;
 907         time_t time_up;
 908         const struct lws_plat_file_ops *fops;
 909         struct lws_plat_file_ops fops_platform;
 910 #if defined(LWS_WITH_ZIP_FOPS)
 911         struct lws_plat_file_ops fops_zip;
 912 #endif
 913         struct lws_context_per_thread pt[LWS_MAX_SMP];
 914         struct lws_conn_stats conn_stats;
 915 #ifdef _WIN32
 916 /* different implementation between unix and windows */
 917         struct lws_fd_hashtable fd_hashtable[FD_HASHTABLE_MODULUS];
 918 #else
 919 #if defined(LWS_WITH_ESP8266)
 920         struct espconn **connpool; /* .reverse points to the wsi */
 921         void *rxd;
 922         int rxd_len;
 923         os_timer_t to_timer;
 924 #else
 925         struct lws **lws_lookup;  /* fd to wsi */
 926 #endif
 927 #endif
 928         struct lws_vhost *vhost_list;
 929         struct lws_plugin *plugin_list;
 930
 931         void *external_baggage_free_on_destroy;
 932         const struct lws_token_limits *token_limits;
 933         void *user_space;
 934         const char *server_string;
 935         const struct lws_protocol_vhost_options *reject_service_keywords;
 936         lws_reload_func deprecation_cb;
 937
 938 #if defined(LWS_USE_LIBEV)
 939         lws_ev_signal_cb_t * lws_ev_sigint_cb;
 940 #endif
 941 #if defined(LWS_USE_LIBUV)
 942         uv_signal_cb lws_uv_sigint_cb;
 943 #endif
 944 #if defined(LWS_USE_LIBEVENT)
 945         lws_event_signal_cb_t * lws_event_sigint_cb;
 946 #endif
 947         char canonical_hostname[128];
 948 #ifdef LWS_LATENCY
 949         unsigned long worst_latency;
 950         char worst_latency_info[256];
 951 #endif
 952
 953 #if defined(LWS_WITH_STATS)
 954         uint64_t lws_stats[LWSSTATS_SIZE];
 955         uint64_t last_dump;
 956         int updated;
 957 #endif
 958
 959         int max_fds;
 960 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
 961         int use_ev_sigint;
 962 #endif
 963         int started_with_parent;
 964         int uid, gid;
 965
 966         int fd_random;
 967 #ifdef LWS_OPENSSL_SUPPORT
 968 #define lws_ssl_anybody_has_buffered_read(w) \
 969                 (w->vhost->use_ssl && \
 970                  w->context->pt[(int)w->tsi].pending_read_list)
 971 #define lws_ssl_anybody_has_buffered_read_tsi(c, t) \
 972                 (/*c->use_ssl && */ \
 973                  c->pt[(int)t].pending_read_list)
 974 #else
 975 #define lws_ssl_anybody_has_buffered_read(ctx) (0)
 976 #define lws_ssl_anybody_has_buffered_read_tsi(ctx, t) (0)
 977 #endif
 978         int count_wsi_allocated;
 979         int count_cgi_spawned;
 980         unsigned int options;
 981         unsigned int fd_limit_per_thread;
 982         unsigned int timeout_secs;
 983         unsigned int pt_serv_buf_size;
 984         int max_http_header_data;
 985         int simultaneous_ssl_restriction;
 986         int simultaneous_ssl;
 987
 988         unsigned int deprecated:1;
 989         unsigned int being_destroyed:1;
 990         unsigned int being_destroyed1:1;
 991         unsigned int requested_kill:1;
 992         unsigned int protocol_init_done:1;
 993         unsigned int ssl_gate_accepts:1;
 994         /*
 995          * set to the Thread ID that's doing the service loop just before entry
 996          * to poll indicates service thread likely idling in poll()
 997          * volatile because other threads may check it as part of processing
 998          * for pollfd event change.
 999          */
1000         volatile int service_tid;
1001         int service_tid_detected;
1002
1003         short max_http_header_pool;
1004         short count_threads;
1005         short plugin_protocol_count;
1006         short plugin_extension_count;
1007         short server_string_len;
1008         unsigned short ws_ping_pong_interval;
1009         unsigned short deprecation_pending_listen_close_count;
1010         uint8_t max_fi;
1011 };
1012
1013 #define lws_get_context_protocol(ctx, x) ctx->vhost_list->protocols[x]
1014 #define lws_get_vh_protocol(vh, x) vh->protocols[x]
1015
1016 LWS_EXTERN void
1017 lws_close_free_wsi_final(struct lws *wsi);
1018 LWS_EXTERN void
1019 lws_libuv_closehandle(struct lws *wsi);
1020
1021 LWS_VISIBLE LWS_EXTERN int
1022 lws_plat_plugins_init(struct lws_context * context, const char * const *d);
1023
1024 LWS_VISIBLE LWS_EXTERN int
1025 lws_plat_plugins_destroy(struct lws_context * context);
1026
1027 LWS_EXTERN void
1028 lws_restart_ws_ping_pong_timer(struct lws *wsi);
1029
1030 struct lws *
1031 lws_adopt_socket_vhost(struct lws_vhost *vh, lws_sockfd_type accept_fd);
1032
1033
1034 enum {
1035         LWS_EV_READ = (1 << 0),
1036         LWS_EV_WRITE = (1 << 1),
1037         LWS_EV_START = (1 << 2),
1038         LWS_EV_STOP = (1 << 3),
1039
1040         LWS_EV_PREPARE_DELETION = (1 << 31),
1041 };
1042
1043 #if defined(LWS_USE_LIBEV)
1044 LWS_EXTERN void
1045 lws_libev_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
1046 LWS_EXTERN void
1047 lws_libev_io(struct lws *wsi, int flags);
1048 LWS_EXTERN int
1049 lws_libev_init_fd_table(struct lws_context *context);
1050 LWS_EXTERN void
1051 lws_libev_destroyloop(struct lws_context *context, int tsi);
1052 LWS_EXTERN void
1053 lws_libev_run(const struct lws_context *context, int tsi);
1054 #define LWS_LIBEV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBEV)
1055 LWS_EXTERN void lws_feature_status_libev(struct lws_context_creation_info *info);
1056 #else
1057 #define lws_libev_accept(_a, _b) ((void) 0)
1058 #define lws_libev_io(_a, _b) ((void) 0)
1059 #define lws_libev_init_fd_table(_a) (0)
1060 #define lws_libev_run(_a, _b) ((void) 0)
1061 #define lws_libev_destroyloop(_a, _b) ((void) 0)
1062 #define LWS_LIBEV_ENABLED(context) (0)
1063 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
1064 #define lws_feature_status_libev(_a) \
1065                         lwsl_notice("libev support not compiled in\n")
1066 #else
1067 #define lws_feature_status_libev(_a)
1068 #endif
1069 #endif
1070
1071 #if defined(LWS_USE_LIBUV)
1072 LWS_EXTERN void
1073 lws_libuv_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
1074 LWS_EXTERN void
1075 lws_libuv_io(struct lws *wsi, int flags);
1076 LWS_EXTERN int
1077 lws_libuv_init_fd_table(struct lws_context *context);
1078 LWS_EXTERN void
1079 lws_libuv_run(const struct lws_context *context, int tsi);
1080 LWS_EXTERN void
1081 lws_libuv_destroyloop(struct lws_context *context, int tsi);
1082 LWS_EXTERN int
1083 lws_uv_initvhost(struct lws_vhost* vh, struct lws*);
1084 #define LWS_LIBUV_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBUV)
1085 LWS_EXTERN void lws_feature_status_libuv(struct lws_context_creation_info *info);
1086 #else
1087 #define lws_libuv_accept(_a, _b) ((void) 0)
1088 #define lws_libuv_io(_a, _b) ((void) 0)
1089 #define lws_libuv_init_fd_table(_a) (0)
1090 #define lws_libuv_run(_a, _b) ((void) 0)
1091 #define lws_libuv_destroyloop(_a, _b) ((void) 0)
1092 #define LWS_LIBUV_ENABLED(context) (0)
1093 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
1094 #define lws_feature_status_libuv(_a) \
1095                         lwsl_notice("libuv support not compiled in\n")
1096 #else
1097 #define lws_feature_status_libuv(_a)
1098 #endif
1099 #endif
1100
1101 #if defined(LWS_USE_LIBEVENT)
1102 LWS_EXTERN void
1103 lws_libevent_accept(struct lws *new_wsi, lws_sock_file_fd_type desc);
1104 LWS_EXTERN void
1105 lws_libevent_io(struct lws *wsi, int flags);
1106 LWS_EXTERN int
1107 lws_libevent_init_fd_table(struct lws_context *context);
1108 LWS_EXTERN void
1109 lws_libevent_destroyloop(struct lws_context *context, int tsi);
1110 LWS_EXTERN void
1111 lws_libevent_run(const struct lws_context *context, int tsi);
1112 #define LWS_LIBEVENT_ENABLED(context) lws_check_opt(context->options, LWS_SERVER_OPTION_LIBEVENT)
1113 LWS_EXTERN void lws_feature_status_libevent(struct lws_context_creation_info *info);
1114 #else
1115 #define lws_libevent_accept(_a, _b) ((void) 0)
1116 #define lws_libevent_io(_a, _b) ((void) 0)
1117 #define lws_libevent_init_fd_table(_a) (0)
1118 #define lws_libevent_run(_a, _b) ((void) 0)
1119 #define lws_libevent_destroyloop(_a, _b) ((void) 0)
1120 #define LWS_LIBEVENT_ENABLED(context) (0)
1121 #if LWS_POSIX && !defined(LWS_WITH_ESP32)
1122 #define lws_feature_status_libevent(_a) \
1123                         lwsl_notice("libevent support not compiled in\n")
1124 #else
1125 #define lws_feature_status_libevent(_a)
1126 #endif
1127 #endif
1128
1129
1130 #ifdef LWS_USE_IPV6
1131 #define LWS_IPV6_ENABLED(vh) \
1132         (!lws_check_opt(vh->context->options, LWS_SERVER_OPTION_DISABLE_IPV6) && \
1133          !lws_check_opt(vh->options, LWS_SERVER_OPTION_DISABLE_IPV6))
1134 #else
1135 #define LWS_IPV6_ENABLED(context) (0)
1136 #endif
1137
1138 #ifdef LWS_USE_UNIX_SOCK
1139 #define LWS_UNIX_SOCK_ENABLED(vhost) \
1140         (vhost->options & LWS_SERVER_OPTION_UNIX_SOCK)
1141 #else
1142 #define LWS_UNIX_SOCK_ENABLED(vhost) (0)
1143 #endif
1144 enum uri_path_states {
1145         URIPS_IDLE,
1146         URIPS_SEEN_SLASH,
1147         URIPS_SEEN_SLASH_DOT,
1148         URIPS_SEEN_SLASH_DOT_DOT,
1149 };
1150
1151 enum uri_esc_states {
1152         URIES_IDLE,
1153         URIES_SEEN_PERCENT,
1154         URIES_SEEN_PERCENT_H1,
1155 };
1156
1157 /* notice that these union members:
1158  *
1159  *  hdr
1160  *  http
1161  *  http2
1162  *
1163  * all have a pointer to allocated_headers struct as their first member.
1164  *
1165  * It means for allocated_headers access, the three union paths can all be
1166  * used interchangeably to access the same data
1167  */
1168
1169
1170 #ifndef LWS_NO_CLIENT
1171 struct client_info_stash {
1172         char address[256];
1173         char path[4096];
1174         char host[256];
1175         char origin[256];
1176         char protocol[256];
1177         char method[16];
1178 };
1179 #endif
1180
1181 struct _lws_header_related {
1182         /* MUST be first in struct */
1183         struct allocated_headers *ah;
1184         struct lws *ah_wait_list;
1185         unsigned char *preamble_rx;
1186 #ifndef LWS_NO_CLIENT
1187         struct client_info_stash *stash;
1188 #endif
1189         unsigned int preamble_rx_len;
1190         enum uri_path_states ups;
1191         enum uri_esc_states ues;
1192         short lextable_pos;
1193         unsigned int current_token_limit;
1194
1195         char esc_stash;
1196         char post_literal_equal;
1197         unsigned char parser_state; /* enum lws_token_indexes */
1198 };
1199
1200 #if defined(LWS_WITH_RANGES)
1201 enum range_states {
1202         LWSRS_NO_ACTIVE_RANGE,
1203         LWSRS_BYTES_EQ,
1204         LWSRS_FIRST,
1205         LWSRS_STARTING,
1206         LWSRS_ENDING,
1207         LWSRS_COMPLETED,
1208         LWSRS_SYNTAX,
1209 };
1210
1211 struct lws_range_parsing {
1212         unsigned long long start, end, extent, agg, budget;
1213         const char buf[128];
1214         int pos;
1215         enum range_states state;
1216         char start_valid, end_valid, ctr, count_ranges, did_try, inside, send_ctr;
1217 };
1218
1219 int
1220 lws_ranges_init(struct lws *wsi, struct lws_range_parsing *rp, unsigned long long extent);
1221 int
1222 lws_ranges_next(struct lws_range_parsing *rp);
1223 void
1224 lws_ranges_reset(struct lws_range_parsing *rp);
1225 #endif
1226
1227 struct _lws_http_mode_related {
1228         /* MUST be first in struct */
1229         struct allocated_headers *ah; /* mirroring  _lws_header_related */
1230         struct lws *ah_wait_list;
1231         unsigned char *preamble_rx;
1232 #ifndef LWS_NO_CLIENT
1233         struct client_info_stash *stash;
1234 #endif
1235         unsigned int preamble_rx_len;
1236         struct lws *new_wsi_list;
1237         lws_filepos_t filepos;
1238         lws_filepos_t filelen;
1239         lws_fop_fd_t fop_fd;
1240
1241 #if defined(LWS_WITH_RANGES)
1242         struct lws_range_parsing range;
1243         char multipart_content_type[64];
1244 #endif
1245
1246         enum http_version request_version;
1247         enum http_connection_type connection_type;
1248         unsigned int content_length;
1249         unsigned int content_remain;
1250 };
1251
1252 #ifdef LWS_USE_HTTP2
1253
1254 enum lws_http2_settings {
1255         LWS_HTTP2_SETTINGS__HEADER_TABLE_SIZE = 1,
1256         LWS_HTTP2_SETTINGS__ENABLE_PUSH,
1257         LWS_HTTP2_SETTINGS__MAX_CONCURRENT_STREAMS,
1258         LWS_HTTP2_SETTINGS__INITIAL_WINDOW_SIZE,
1259         LWS_HTTP2_SETTINGS__MAX_FRAME_SIZE,
1260         LWS_HTTP2_SETTINGS__MAX_HEADER_LIST_SIZE,
1261
1262         LWS_HTTP2_SETTINGS__COUNT /* always last */
1263 };
1264
1265 enum lws_http2_wellknown_frame_types {
1266         LWS_HTTP2_FRAME_TYPE_DATA,
1267         LWS_HTTP2_FRAME_TYPE_HEADERS,
1268         LWS_HTTP2_FRAME_TYPE_PRIORITY,
1269         LWS_HTTP2_FRAME_TYPE_RST_STREAM,
1270         LWS_HTTP2_FRAME_TYPE_SETTINGS,
1271         LWS_HTTP2_FRAME_TYPE_PUSH_PROMISE,
1272         LWS_HTTP2_FRAME_TYPE_PING,
1273         LWS_HTTP2_FRAME_TYPE_GOAWAY,
1274         LWS_HTTP2_FRAME_TYPE_WINDOW_UPDATE,
1275         LWS_HTTP2_FRAME_TYPE_CONTINUATION,
1276
1277         LWS_HTTP2_FRAME_TYPE_COUNT /* always last */
1278 };
1279
1280 enum lws_http2_flags {
1281         LWS_HTTP2_FLAG_END_STREAM = 1,
1282         LWS_HTTP2_FLAG_END_HEADERS = 4,
1283         LWS_HTTP2_FLAG_PADDED = 8,
1284         LWS_HTTP2_FLAG_PRIORITY = 0x20,
1285
1286         LWS_HTTP2_FLAG_SETTINGS_ACK = 1,
1287 };
1288
1289 #define LWS_HTTP2_STREAM_ID_MASTER 0
1290 #define LWS_HTTP2_FRAME_HEADER_LENGTH 9
1291 #define LWS_HTTP2_SETTINGS_LENGTH 6
1292
1293 struct http2_settings {
1294         unsigned int setting[LWS_HTTP2_SETTINGS__COUNT];
1295 };
1296
1297 enum http2_hpack_state {
1298
1299         /* optional before first header block */
1300         HPKS_OPT_PADDING,
1301         HKPS_OPT_E_DEPENDENCY,
1302         HKPS_OPT_WEIGHT,
1303
1304         /* header block */
1305         HPKS_TYPE,
1306
1307         HPKS_IDX_EXT,
1308
1309         HPKS_HLEN,
1310         HPKS_HLEN_EXT,
1311
1312         HPKS_DATA,
1313
1314         /* optional after last header block */
1315         HKPS_OPT_DISCARD_PADDING,
1316 };
1317
1318 enum http2_hpack_type {
1319         HPKT_INDEXED_HDR_7,
1320         HPKT_INDEXED_HDR_6_VALUE_INCR,
1321         HPKT_LITERAL_HDR_VALUE_INCR,
1322         HPKT_INDEXED_HDR_4_VALUE,
1323         HPKT_LITERAL_HDR_VALUE,
1324         HPKT_SIZE_5
1325 };
1326
1327 struct hpack_dt_entry {
1328         int token; /* additions that don't map to a token are ignored */
1329         int arg_offset;
1330         int arg_len;
1331 };
1332
1333 struct hpack_dynamic_table {
1334         struct hpack_dt_entry *entries;
1335         char *args;
1336         int pos;
1337         int next;
1338         int num_entries;
1339         int args_length;
1340 };
1341
1342 struct _lws_http2_related {
1343         /*
1344          * having this first lets us also re-use all HTTP union code
1345          * and in turn, http_mode_related has allocated headers in right
1346          * place so we can use the header apis on the wsi directly still
1347          */
1348         struct _lws_http_mode_related http; /* MUST BE FIRST IN STRUCT */
1349
1350         struct http2_settings my_settings;
1351         struct http2_settings peer_settings;
1352
1353         struct lws *parent_wsi;
1354         struct lws *next_child_wsi;
1355
1356         struct hpack_dynamic_table *hpack_dyn_table;
1357         struct lws *stream_wsi;
1358         unsigned char ping_payload[8];
1359         unsigned char one_setting[LWS_HTTP2_SETTINGS_LENGTH];
1360
1361         unsigned int count;
1362         unsigned int length;
1363         unsigned int stream_id;
1364         enum http2_hpack_state hpack;
1365         enum http2_hpack_type hpack_type;
1366         unsigned int header_index;
1367         unsigned int hpack_len;
1368         unsigned int hpack_e_dep;
1369         int tx_credit;
1370         unsigned int my_stream_id;
1371         unsigned int child_count;
1372         int my_priority;
1373
1374         unsigned int END_STREAM:1;
1375         unsigned int END_HEADERS:1;
1376         unsigned int send_END_STREAM:1;
1377         unsigned int GOING_AWAY;
1378         unsigned int requested_POLLOUT:1;
1379         unsigned int waiting_tx_credit:1;
1380         unsigned int huff:1;
1381         unsigned int value:1;
1382
1383         unsigned short round_robin_POLLOUT;
1384         unsigned short count_POLLOUT_children;
1385         unsigned short hpack_pos;
1386
1387         unsigned char type;
1388         unsigned char flags;
1389         unsigned char frame_state;
1390         unsigned char padding;
1391         unsigned char hpack_m;
1392         unsigned char initialized;
1393 };
1394
1395 #define HTTP2_IS_TOPLEVEL_WSI(wsi) (!wsi->u.http2.parent_wsi)
1396
1397 #endif
1398
1399 struct _lws_websocket_related {
1400         /* cheapest way to deal with ah overlap with ws union transition */
1401         struct _lws_header_related hdr;
1402         char *rx_ubuf;
1403         unsigned int rx_ubuf_alloc;
1404         struct lws *rx_draining_ext_list;
1405         struct lws *tx_draining_ext_list;
1406         time_t time_next_ping_check;
1407         size_t rx_packet_length;
1408         unsigned int rx_ubuf_head;
1409         unsigned char mask[4];
1410         /* Also used for close content... control opcode == < 128 */
1411         unsigned char ping_payload_buf[128 - 3 + LWS_PRE];
1412
1413         unsigned char ping_payload_len;
1414         unsigned char mask_idx;
1415         unsigned char opcode;
1416         unsigned char rsv;
1417         unsigned char rsv_first_msg;
1418         /* zero if no info, or length including 2-byte close code */
1419         unsigned char close_in_ping_buffer_len;
1420         unsigned char utf8;
1421         unsigned char stashed_write_type;
1422         unsigned char tx_draining_stashed_wp;
1423
1424         unsigned int final:1;
1425         unsigned int frame_is_binary:1;
1426         unsigned int all_zero_nonce:1;
1427         unsigned int this_frame_masked:1;
1428         unsigned int inside_frame:1; /* next write will be more of frame */
1429         unsigned int clean_buffer:1; /* buffer not rewritten by extension */
1430         unsigned int payload_is_close:1; /* process as PONG, but it is close */
1431         unsigned int ping_pending_flag:1;
1432         unsigned int continuation_possible:1;
1433         unsigned int owed_a_fin:1;
1434         unsigned int check_utf8:1;
1435         unsigned int defeat_check_utf8:1;
1436         unsigned int pmce_compressed_message:1;
1437         unsigned int stashed_write_pending:1;
1438         unsigned int rx_draining_ext:1;
1439         unsigned int tx_draining_ext:1;
1440         unsigned int send_check_ping:1;
1441 };
1442
1443 #ifdef LWS_WITH_CGI
1444
1445 enum {
1446         SIGNIFICANT_HDR_CONTENT_LENGTH,
1447         SIGNIFICANT_HDR_LOCATION,
1448         SIGNIFICANT_HDR_STATUS,
1449         SIGNIFICANT_HDR_TRANSFER_ENCODING,
1450
1451         SIGNIFICANT_HDR_COUNT
1452 };
1453
1454 /* wsi who is master of the cgi points to an lws_cgi */
1455
1456 struct lws_cgi {
1457         struct lws_cgi *cgi_list;
1458         struct lws *stdwsi[3]; /* points to the associated stdin/out/err wsis */
1459         struct lws *wsi; /* owner */
1460         unsigned char *headers_buf;
1461         unsigned char *headers_pos;
1462         unsigned char *headers_dumped;
1463         unsigned char *headers_end;
1464         unsigned long content_length;
1465         unsigned long content_length_seen;
1466         int pipe_fds[3][2];
1467         int match[SIGNIFICANT_HDR_COUNT];
1468         int pid;
1469         int response_code;
1470         int lp;
1471         char l[12];
1472
1473         unsigned int being_closed:1;
1474         unsigned int explicitly_chunked:1;
1475
1476         unsigned char chunked_grace;
1477 };
1478 #endif
1479
1480 signed char char_to_hex(const char c);
1481
1482 #ifndef LWS_NO_CLIENT
1483 enum lws_chunk_parser {
1484         ELCP_HEX,
1485         ELCP_CR,
1486         ELCP_CONTENT,
1487         ELCP_POST_CR,
1488         ELCP_POST_LF,
1489 };
1490 #endif
1491
1492 struct lws_rewrite;
1493
1494 #ifdef LWS_WITH_ACCESS_LOG
1495 struct lws_access_log {
1496         char *header_log;
1497         char *user_agent;
1498         unsigned long sent;
1499         int response;
1500 };
1501 #endif
1502
1503 struct lws {
1504
1505         /* structs */
1506         /* members with mutually exclusive lifetimes are unionized */
1507
1508         union u {
1509                 struct _lws_http_mode_related http;
1510 #ifdef LWS_USE_HTTP2
1511                 struct _lws_http2_related http2;
1512 #endif
1513                 struct _lws_header_related hdr;
1514                 struct _lws_websocket_related ws;
1515         } u;
1516
1517         /* lifetime members */
1518
1519 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBUV) || defined(LWS_USE_LIBEVENT)
1520         struct lws_io_watcher w_read;
1521 #endif
1522 #if defined(LWS_USE_LIBEV) || defined(LWS_USE_LIBEVENT)
1523         struct lws_io_watcher w_write;
1524 #endif
1525         time_t pending_timeout_limit;
1526
1527         /* pointers */
1528
1529         struct lws_context *context;
1530         struct lws_vhost *vhost;
1531         struct lws *parent; /* points to parent, if any */
1532         struct lws *child_list; /* points to first child */
1533         struct lws *sibling_list; /* subsequent children at same level */
1534 #ifdef LWS_WITH_CGI
1535         struct lws_cgi *cgi; /* wsi being cgi master have one of these */
1536 #endif
1537         const struct lws_protocols *protocol;
1538         struct lws **same_vh_protocol_prev, *same_vh_protocol_next;
1539         struct lws *timeout_list;
1540         struct lws **timeout_list_prev;
1541 #ifdef LWS_WITH_ACCESS_LOG
1542         struct lws_access_log access_log;
1543 #endif
1544         void *user_space;
1545         /* rxflow handling */
1546         unsigned char *rxflow_buffer;
1547         /* truncated send handling */
1548         unsigned char *trunc_alloc; /* non-NULL means buffering in progress */
1549
1550 #if defined (LWS_WITH_ESP8266)
1551         void *premature_rx;
1552         unsigned short prem_rx_size, prem_rx_pos;
1553 #endif
1554
1555 #ifndef LWS_NO_EXTENSIONS
1556         const struct lws_extension *active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
1557         void *act_ext_user[LWS_MAX_EXTENSIONS_ACTIVE];
1558 #endif
1559 #ifdef LWS_OPENSSL_SUPPORT
1560         SSL *ssl;
1561         BIO *client_bio;
1562         struct lws *pending_read_list_prev, *pending_read_list_next;
1563 #if defined(LWS_WITH_STATS)
1564         uint64_t accept_start_us;
1565         char seen_rx;
1566 #endif
1567 #endif
1568 #ifdef LWS_WITH_HTTP_PROXY
1569         struct lws_rewrite *rw;
1570 #endif
1571 #ifdef LWS_LATENCY
1572         unsigned long action_start;
1573         unsigned long latency_start;
1574 #endif
1575         lws_sock_file_fd_type desc; /* .filefd / .sockfd */
1576 #if defined(LWS_WITH_STATS)
1577         uint64_t active_writable_req_us;
1578 #endif
1579         /* ints */
1580         int position_in_fds_table;
1581         int rxflow_len;
1582         int rxflow_pos;
1583         unsigned int trunc_alloc_len; /* size of malloc */
1584         unsigned int trunc_offset; /* where we are in terms of spilling */
1585         unsigned int trunc_len; /* how much is buffered */
1586 #ifndef LWS_NO_CLIENT
1587         int chunk_remaining;
1588 #endif
1589         unsigned int cache_secs;
1590
1591         unsigned int hdr_parsing_completed:1;
1592         unsigned int http2_substream:1;
1593         unsigned int listener:1;
1594         unsigned int user_space_externally_allocated:1;
1595         unsigned int socket_is_permanently_unusable:1;
1596         unsigned int rxflow_change_to:2;
1597         unsigned int more_rx_waiting:1; /* has to live here since ah may stick to end */
1598         unsigned int conn_stat_done:1;
1599         unsigned int cache_reuse:1;
1600         unsigned int cache_revalidate:1;
1601         unsigned int cache_intermediaries:1;
1602         unsigned int favoured_pollin:1;
1603         unsigned int sending_chunked:1;
1604         unsigned int already_did_cce:1;
1605         unsigned int told_user_closed:1;
1606
1607 #if defined(LWS_WITH_ESP8266)
1608         unsigned int pending_send_completion:3;
1609         unsigned int close_is_pending_send_completion:1;
1610 #endif
1611 #ifdef LWS_WITH_ACCESS_LOG
1612         unsigned int access_log_pending:1;
1613 #endif
1614 #ifndef LWS_NO_CLIENT
1615         unsigned int do_ws:1; /* whether we are doing http or ws flow */
1616         unsigned int chunked:1; /* if the clientside connection is chunked */
1617         unsigned int client_rx_avail:1;
1618         unsigned int client_http_body_pending:1;
1619 #endif
1620 #ifdef LWS_WITH_HTTP_PROXY
1621         unsigned int perform_rewrite:1;
1622 #endif
1623 #ifndef LWS_NO_EXTENSIONS
1624         unsigned int extension_data_pending:1;
1625 #endif
1626 #ifdef LWS_OPENSSL_SUPPORT
1627         unsigned int use_ssl:4;
1628 #endif
1629 #ifdef _WIN32
1630         unsigned int sock_send_blocking:1;
1631 #endif
1632 #ifdef LWS_OPENSSL_SUPPORT
1633         unsigned int redirect_to_https:1;
1634 #endif
1635
1636         /* volatile to make sure code is aware other thread can change */
1637         volatile unsigned int handling_pollout:1;
1638         volatile unsigned int leave_pollout_active:1;
1639
1640 #ifndef LWS_NO_CLIENT
1641         unsigned short c_port;
1642 #endif
1643
1644         /* chars */
1645 #ifndef LWS_NO_EXTENSIONS
1646         unsigned char count_act_ext;
1647 #endif
1648         unsigned char ietf_spec_revision;
1649         char mode; /* enum connection_mode */
1650         char state; /* enum lws_connection_states */
1651         char state_pre_close;
1652         char lws_rx_parse_state; /* enum lws_rx_parse_state */
1653         char rx_frame_type; /* enum lws_write_protocol */
1654         char pending_timeout; /* enum pending_timeout */
1655         char pps; /* enum lws_pending_protocol_send */
1656         char tsi; /* thread service index we belong to */
1657         char protocol_interpret_idx;
1658         char redirects;
1659 #ifdef LWS_WITH_CGI
1660         char cgi_channel; /* which of stdin/out/err */
1661         char hdr_state;
1662 #endif
1663 #ifndef LWS_NO_CLIENT
1664         char chunk_parser; /* enum lws_chunk_parser */
1665 #endif
1666 #if defined(LWS_WITH_CGI) || !defined(LWS_NO_CLIENT)
1667         char reason_bf; /* internal writeable callback reason bitfield */
1668 #endif
1669 };
1670
1671 LWS_EXTERN int log_level;
1672
1673 LWS_EXTERN int
1674 lws_socket_bind(struct lws_vhost *vhost, lws_sockfd_type sockfd, int port,
1675                 const char *iface);
1676
1677 #if defined(LWS_USE_IPV6)
1678 LWS_EXTERN unsigned long
1679 lws_get_addr_scope(const char *ipaddr);
1680 #endif
1681
1682 LWS_EXTERN void
1683 lws_close_free_wsi(struct lws *wsi, enum lws_close_status);
1684
1685 LWS_EXTERN int
1686 remove_wsi_socket_from_fds(struct lws *wsi);
1687 LWS_EXTERN int
1688 lws_rxflow_cache(struct lws *wsi, unsigned char *buf, int n, int len);
1689
1690 #ifndef LWS_LATENCY
1691 static inline void
1692 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1693             int ret, int completion) {
1694         do {
1695                 (void)context; (void)wsi; (void)action; (void)ret;
1696                 (void)completion;
1697         } while (0);
1698 }
1699 static inline void
1700 lws_latency_pre(struct lws_context *context, struct lws *wsi) {
1701         do { (void)context; (void)wsi; } while (0);
1702 }
1703 #else
1704 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
1705 extern void
1706 lws_latency(struct lws_context *context, struct lws *wsi, const char *action,
1707             int ret, int completion);
1708 #endif
1709
1710 LWS_EXTERN void
1711 lws_set_protocol_write_pending(struct lws *wsi,
1712                                enum lws_pending_protocol_send pend);
1713 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1714 lws_client_rx_sm(struct lws *wsi, unsigned char c);
1715
1716 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1717 lws_parse(struct lws *wsi, unsigned char c);
1718
1719 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1720 lws_http_action(struct lws *wsi);
1721
1722 LWS_EXTERN int
1723 lws_b64_selftest(void);
1724
1725 LWS_EXTERN int
1726 lws_service_flag_pending(struct lws_context *context, int tsi);
1727
1728 #if defined(_WIN32) || defined(LWS_WITH_ESP8266)
1729 LWS_EXTERN struct lws *
1730 wsi_from_fd(const struct lws_context *context, lws_sockfd_type fd);
1731
1732 LWS_EXTERN int
1733 insert_wsi(struct lws_context *context, struct lws *wsi);
1734
1735 LWS_EXTERN int
1736 delete_from_fd(struct lws_context *context, lws_sockfd_type fd);
1737 #else
1738 #define wsi_from_fd(A,B)  A->lws_lookup[B]
1739 #define insert_wsi(A,B)   assert(A->lws_lookup[B->desc.sockfd] == 0); A->lws_lookup[B->desc.sockfd]=B
1740 #define delete_from_fd(A,B) A->lws_lookup[B]=0
1741 #endif
1742
1743 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1744 insert_wsi_socket_into_fds(struct lws_context *context, struct lws *wsi);
1745
1746 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1747 lws_issue_raw(struct lws *wsi, unsigned char *buf, size_t len);
1748
1749
1750 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1751 lws_service_timeout_check(struct lws *wsi, unsigned int sec);
1752
1753 LWS_EXTERN void
1754 lws_remove_from_timeout_list(struct lws *wsi);
1755
1756 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1757 lws_client_connect_2(struct lws *wsi);
1758
1759 LWS_VISIBLE struct lws * LWS_WARN_UNUSED_RESULT
1760 lws_client_reset(struct lws **wsi, int ssl, const char *address, int port,
1761                  const char *path, const char *host);
1762
1763 LWS_EXTERN struct lws * LWS_WARN_UNUSED_RESULT
1764 lws_create_new_server_wsi(struct lws_vhost *vhost);
1765
1766 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1767 lws_generate_client_handshake(struct lws *wsi, char *pkt);
1768
1769 LWS_EXTERN int
1770 lws_handle_POLLOUT_event(struct lws *wsi, struct lws_pollfd *pollfd);
1771
1772 LWS_EXTERN struct lws *
1773 lws_client_connect_via_info2(struct lws *wsi);
1774
1775 /*
1776  * EXTENSIONS
1777  */
1778
1779 #ifndef LWS_NO_EXTENSIONS
1780 LWS_VISIBLE void
1781 lws_context_init_extensions(struct lws_context_creation_info *info,
1782                             struct lws_context *context);
1783 LWS_EXTERN int
1784 lws_any_extension_handled(struct lws *wsi, enum lws_extension_callback_reasons r,
1785                           void *v, size_t len);
1786
1787 LWS_EXTERN int
1788 lws_ext_cb_active(struct lws *wsi, int reason, void *buf, int len);
1789 LWS_EXTERN int
1790 lws_ext_cb_all_exts(struct lws_context *context, struct lws *wsi, int reason,
1791                     void *arg, int len);
1792
1793 #else
1794 #define lws_any_extension_handled(_a, _b, _c, _d) (0)
1795 #define lws_ext_cb_active(_a, _b, _c, _d) (0)
1796 #define lws_ext_cb_all_exts(_a, _b, _c, _d, _e) (0)
1797 #define lws_issue_raw_ext_access lws_issue_raw
1798 #define lws_context_init_extensions(_a, _b)
1799 #endif
1800
1801 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1802 lws_client_interpret_server_handshake(struct lws *wsi);
1803
1804 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1805 lws_rx_sm(struct lws *wsi, unsigned char c);
1806
1807 LWS_EXTERN int
1808 lws_payload_until_length_exhausted(struct lws *wsi, unsigned char **buf, size_t *len);
1809
1810 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1811 lws_issue_raw_ext_access(struct lws *wsi, unsigned char *buf, size_t len);
1812
1813 LWS_EXTERN void
1814 lws_union_transition(struct lws *wsi, enum connection_mode mode);
1815
1816 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1817 user_callback_handle_rxflow(lws_callback_function, struct lws *wsi,
1818                             enum lws_callback_reasons reason, void *user,
1819                             void *in, size_t len);
1820 #ifdef LWS_USE_HTTP2
1821 LWS_EXTERN struct lws *lws_http2_get_network_wsi(struct lws *wsi);
1822 struct lws * lws_http2_get_nth_child(struct lws *wsi, int n);
1823 LWS_EXTERN int
1824 lws_http2_interpret_settings_payload(struct http2_settings *settings,
1825                                      unsigned char *buf, int len);
1826 LWS_EXTERN void lws_http2_init(struct http2_settings *settings);
1827 LWS_EXTERN int
1828 lws_http2_parser(struct lws *wsi, unsigned char c);
1829 LWS_EXTERN int lws_http2_do_pps_send(struct lws_context *context,
1830                                      struct lws *wsi);
1831 LWS_EXTERN int lws_http2_frame_write(struct lws *wsi, int type, int flags,
1832                                      unsigned int sid, unsigned int len,
1833                                      unsigned char *buf);
1834 LWS_EXTERN struct lws *
1835 lws_http2_wsi_from_id(struct lws *wsi, unsigned int sid);
1836 LWS_EXTERN int lws_hpack_interpret(struct lws *wsi,
1837                                    unsigned char c);
1838 LWS_EXTERN int
1839 lws_add_http2_header_by_name(struct lws *wsi,
1840                              const unsigned char *name,
1841                              const unsigned char *value, int length,
1842                              unsigned char **p, unsigned char *end);
1843 LWS_EXTERN int
1844 lws_add_http2_header_by_token(struct lws *wsi,
1845                             enum lws_token_indexes token,
1846                             const unsigned char *value, int length,
1847                             unsigned char **p, unsigned char *end);
1848 LWS_EXTERN int
1849 lws_add_http2_header_status(struct lws *wsi,
1850                             unsigned int code, unsigned char **p,
1851                             unsigned char *end);
1852 LWS_EXTERN
1853 void lws_http2_configure_if_upgraded(struct lws *wsi);
1854 #else
1855 #define lws_http2_configure_if_upgraded(x)
1856 #endif
1857
1858 LWS_EXTERN int
1859 lws_plat_set_socket_options(struct lws_vhost *vhost, lws_sockfd_type fd);
1860
1861 LWS_EXTERN int
1862 lws_plat_check_connection_error(struct lws *wsi);
1863
1864 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1865 lws_header_table_attach(struct lws *wsi, int autoservice);
1866
1867 LWS_EXTERN int
1868 lws_header_table_detach(struct lws *wsi, int autoservice);
1869
1870 LWS_EXTERN void
1871 lws_header_table_reset(struct lws *wsi, int autoservice);
1872 void
1873 _lws_header_table_reset(struct allocated_headers *ah);
1874
1875 LWS_EXTERN char * LWS_WARN_UNUSED_RESULT
1876 lws_hdr_simple_ptr(struct lws *wsi, enum lws_token_indexes h);
1877
1878 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1879 lws_hdr_simple_create(struct lws *wsi, enum lws_token_indexes h, const char *s);
1880
1881 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1882 lws_ensure_user_space(struct lws *wsi);
1883
1884 LWS_EXTERN int
1885 lws_change_pollfd(struct lws *wsi, int _and, int _or);
1886
1887 #ifndef LWS_NO_SERVER
1888 int lws_context_init_server(struct lws_context_creation_info *info,
1889                             struct lws_vhost *vhost);
1890 LWS_EXTERN struct lws_vhost *
1891 lws_select_vhost(struct lws_context *context, int port, const char *servername);
1892 LWS_EXTERN int
1893 handshake_0405(struct lws_context *context, struct lws *wsi);
1894 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1895 lws_interpret_incoming_packet(struct lws *wsi, unsigned char **buf, size_t len);
1896 LWS_EXTERN void
1897 lws_server_get_canonical_hostname(struct lws_context *context,
1898                                   struct lws_context_creation_info *info);
1899 #else
1900 #define lws_context_init_server(_a, _b) (0)
1901 #define lws_interpret_incoming_packet(_a, _b, _c) (0)
1902 #define lws_server_get_canonical_hostname(_a, _b)
1903 #endif
1904
1905 #ifndef LWS_NO_DAEMONIZE
1906 LWS_EXTERN int get_daemonize_pid();
1907 #else
1908 #define get_daemonize_pid() (0)
1909 #endif
1910
1911 #if !defined(LWS_WITH_ESP8266)
1912 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1913 interface_to_sa(struct lws_vhost *vh, const char *ifname,
1914                 struct sockaddr_in *addr, size_t addrlen);
1915 #endif
1916 LWS_EXTERN void lwsl_emit_stderr(int level, const char *line);
1917
1918 enum lws_ssl_capable_status {
1919         LWS_SSL_CAPABLE_ERROR = -1,
1920         LWS_SSL_CAPABLE_MORE_SERVICE = -2,
1921 };
1922
1923 #ifndef LWS_OPENSSL_SUPPORT
1924 #define LWS_SSL_ENABLED(context) (0)
1925 #define lws_context_init_server_ssl(_a, _b) (0)
1926 #define lws_ssl_destroy(_a)
1927 #define lws_context_init_http2_ssl(_a)
1928 #define lws_ssl_capable_read lws_ssl_capable_read_no_ssl
1929 #define lws_ssl_capable_write lws_ssl_capable_write_no_ssl
1930 #define lws_ssl_pending lws_ssl_pending_no_ssl
1931 #define lws_server_socket_service_ssl(_b, _c) (0)
1932 #define lws_ssl_close(_a) (0)
1933 #define lws_ssl_context_destroy(_a)
1934 #define lws_ssl_SSL_CTX_destroy(_a)
1935 #define lws_ssl_remove_wsi_from_buffered_list(_a)
1936 #define lws_context_init_ssl_library(_a)
1937 #else
1938 #define LWS_SSL_ENABLED(context) (context->use_ssl)
1939 LWS_EXTERN int openssl_websocket_private_data_index;
1940 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1941 lws_ssl_capable_read(struct lws *wsi, unsigned char *buf, int len);
1942 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1943 lws_ssl_capable_write(struct lws *wsi, unsigned char *buf, int len);
1944 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1945 lws_ssl_pending(struct lws *wsi);
1946 LWS_EXTERN int
1947 lws_context_init_ssl_library(struct lws_context_creation_info *info);
1948 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
1949 lws_server_socket_service_ssl(struct lws *new_wsi, lws_sockfd_type accept_fd);
1950 LWS_EXTERN int
1951 lws_ssl_close(struct lws *wsi);
1952 LWS_EXTERN void
1953 lws_ssl_SSL_CTX_destroy(struct lws_vhost *vhost);
1954 LWS_EXTERN void
1955 lws_ssl_context_destroy(struct lws_context *context);
1956 LWS_VISIBLE void
1957 lws_ssl_remove_wsi_from_buffered_list(struct lws *wsi);
1958 LWS_EXTERN int
1959 lws_ssl_client_bio_create(struct lws *wsi);
1960 LWS_EXTERN int
1961 lws_ssl_client_connect1(struct lws *wsi);
1962 LWS_EXTERN int
1963 lws_ssl_client_connect2(struct lws *wsi);
1964 LWS_EXTERN void
1965 lws_ssl_elaborate_error(void);
1966 #ifndef LWS_NO_SERVER
1967 LWS_EXTERN int
1968 lws_context_init_server_ssl(struct lws_context_creation_info *info,
1969                             struct lws_vhost *vhost);
1970 #else
1971 #define lws_context_init_server_ssl(_a, _b) (0)
1972 #endif
1973 LWS_EXTERN void
1974 lws_ssl_destroy(struct lws_vhost *vhost);
1975 /* HTTP2-related */
1976
1977 #ifdef LWS_USE_HTTP2
1978 LWS_EXTERN void
1979 lws_context_init_http2_ssl(struct lws_vhost *vhost);
1980 #else
1981 #define lws_context_init_http2_ssl(_a)
1982 #endif
1983 #endif
1984
1985 #if LWS_MAX_SMP > 1
1986 static LWS_INLINE void
1987 lws_pt_mutex_init(struct lws_context_per_thread *pt)
1988 {
1989         pthread_mutex_init(&pt->lock, NULL);
1990 }
1991
1992 static LWS_INLINE void
1993 lws_pt_mutex_destroy(struct lws_context_per_thread *pt)
1994 {
1995         pthread_mutex_destroy(&pt->lock);
1996 }
1997
1998 static LWS_INLINE void
1999 lws_pt_lock(struct lws_context_per_thread *pt)
2000 {
2001         if (!pt->lock_depth++)
2002                 pthread_mutex_lock(&pt->lock);
2003 }
2004
2005 static LWS_INLINE void
2006 lws_pt_unlock(struct lws_context_per_thread *pt)
2007 {
2008         if (!(--pt->lock_depth))
2009                 pthread_mutex_unlock(&pt->lock);
2010 }
2011 #else
2012 #define lws_pt_mutex_init(_a) (void)(_a)
2013 #define lws_pt_mutex_destroy(_a) (void)(_a)
2014 #define lws_pt_lock(_a) (void)(_a)
2015 #define lws_pt_unlock(_a) (void)(_a)
2016 #endif
2017
2018 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2019 lws_ssl_capable_read_no_ssl(struct lws *wsi, unsigned char *buf, int len);
2020
2021 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2022 lws_ssl_capable_write_no_ssl(struct lws *wsi, unsigned char *buf, int len);
2023
2024 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2025 lws_ssl_pending_no_ssl(struct lws *wsi);
2026
2027 #ifdef LWS_WITH_HTTP_PROXY
2028 struct lws_rewrite {
2029         hubbub_parser *parser;
2030         hubbub_parser_optparams params;
2031         const char *from, *to;
2032         int from_len, to_len;
2033         unsigned char *p, *end;
2034         struct lws *wsi;
2035 };
2036 static LWS_INLINE int hstrcmp(hubbub_string *s, const char *p, int len)
2037 {
2038         if (s->len != len)
2039                 return 1;
2040
2041         return strncmp((const char *)s->ptr, p, len);
2042 }
2043 typedef hubbub_error (*hubbub_callback_t)(const hubbub_token *token, void *pw);
2044 LWS_EXTERN struct lws_rewrite *
2045 lws_rewrite_create(struct lws *wsi, hubbub_callback_t cb, const char *from, const char *to);
2046 LWS_EXTERN void
2047 lws_rewrite_destroy(struct lws_rewrite *r);
2048 LWS_EXTERN int
2049 lws_rewrite_parse(struct lws_rewrite *r, const unsigned char *in, int in_len);
2050 #endif
2051
2052 #ifndef LWS_NO_CLIENT
2053 LWS_EXTERN int lws_client_socket_service(struct lws_context *context,
2054                                          struct lws *wsi,
2055                                          struct lws_pollfd *pollfd);
2056 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2057 lws_http_transaction_completed_client(struct lws *wsi);
2058 #ifdef LWS_OPENSSL_SUPPORT
2059 LWS_EXTERN int
2060 lws_context_init_client_ssl(struct lws_context_creation_info *info,
2061                             struct lws_vhost *vhost);
2062 #else
2063         #define lws_context_init_client_ssl(_a, _b) (0)
2064 #endif
2065 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2066 lws_handshake_client(struct lws *wsi, unsigned char **buf, size_t len);
2067 LWS_EXTERN void
2068 lws_decode_ssl_error(void);
2069 #else
2070 #define lws_context_init_client_ssl(_a, _b) (0)
2071 #define lws_handshake_client(_a, _b, _c) (0)
2072 #endif
2073
2074 LWS_EXTERN int
2075 _lws_rx_flow_control(struct lws *wsi);
2076
2077 LWS_EXTERN int
2078 _lws_change_pollfd(struct lws *wsi, int _and, int _or, struct lws_pollargs *pa);
2079
2080 #ifndef LWS_NO_SERVER
2081 LWS_EXTERN int
2082 lws_server_socket_service(struct lws_context *context, struct lws *wsi,
2083                           struct lws_pollfd *pollfd);
2084 LWS_EXTERN int
2085 lws_handshake_server(struct lws *wsi, unsigned char **buf, size_t len);
2086 #else
2087 #define lws_server_socket_service(_a, _b, _c) (0)
2088 #define lws_handshake_server(_a, _b, _c) (0)
2089 #endif
2090
2091 #ifdef LWS_WITH_ACCESS_LOG
2092 LWS_EXTERN int
2093 lws_access_log(struct lws *wsi);
2094 #else
2095 #define lws_access_log(_a)
2096 #endif
2097
2098 LWS_EXTERN int
2099 lws_cgi_kill_terminated(struct lws_context_per_thread *pt);
2100
2101 int
2102 lws_protocol_init(struct lws_context *context);
2103
2104 int
2105 lws_bind_protocol(struct lws *wsi, const struct lws_protocols *p);
2106
2107 const struct lws_http_mount *
2108 lws_find_mount(struct lws *wsi, const char *uri_ptr, int uri_len);
2109
2110 /*
2111  * custom allocator
2112  */
2113 LWS_EXTERN void *
2114 lws_realloc(void *ptr, size_t size);
2115
2116 LWS_EXTERN void * LWS_WARN_UNUSED_RESULT
2117 lws_zalloc(size_t size);
2118
2119 #ifdef LWS_PLAT_OPTEE
2120 void *lws_malloc(size_t size);
2121 void lws_free(void *p);
2122 #define lws_free_set_NULL(P)    do { lws_free(P); (P) = NULL; } while(0)
2123 #else
2124 #define lws_malloc(S)   lws_realloc(NULL, S)
2125 #define lws_free(P)     lws_realloc(P, 0)
2126 #define lws_free_set_NULL(P)    do { lws_realloc(P, 0); (P) = NULL; } while(0)
2127 #endif
2128
2129 const struct lws_plat_file_ops *
2130 lws_vfs_select_fops(const struct lws_plat_file_ops *fops, const char *vfs_path,
2131                     const char **vpath);
2132
2133 /* lws_plat_ */
2134 LWS_EXTERN void
2135 lws_plat_delete_socket_from_fds(struct lws_context *context,
2136                                 struct lws *wsi, int m);
2137 LWS_EXTERN void
2138 lws_plat_insert_socket_into_fds(struct lws_context *context,
2139                                 struct lws *wsi);
2140 LWS_EXTERN void
2141 lws_plat_service_periodic(struct lws_context *context);
2142
2143 LWS_EXTERN int
2144 lws_plat_change_pollfd(struct lws_context *context, struct lws *wsi,
2145                        struct lws_pollfd *pfd);
2146 LWS_EXTERN void
2147 lws_add_wsi_to_draining_ext_list(struct lws *wsi);
2148 LWS_EXTERN void
2149 lws_remove_wsi_from_draining_ext_list(struct lws *wsi);
2150 LWS_EXTERN int
2151 lws_plat_context_early_init(void);
2152 LWS_EXTERN void
2153 lws_plat_context_early_destroy(struct lws_context *context);
2154 LWS_EXTERN void
2155 lws_plat_context_late_destroy(struct lws_context *context);
2156 LWS_EXTERN int
2157 lws_poll_listen_fd(struct lws_pollfd *fd);
2158 LWS_EXTERN int
2159 lws_plat_service(struct lws_context *context, int timeout_ms);
2160 LWS_EXTERN LWS_VISIBLE int
2161 _lws_plat_service_tsi(struct lws_context *context, int timeout_ms, int tsi);
2162 LWS_EXTERN int
2163 lws_plat_init(struct lws_context *context,
2164               struct lws_context_creation_info *info);
2165 LWS_EXTERN void
2166 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
2167 LWS_EXTERN unsigned long long
2168 time_in_microseconds(void);
2169 LWS_EXTERN const char * LWS_WARN_UNUSED_RESULT
2170 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);
2171 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2172 lws_plat_inet_pton(int af, const char *src, void *dst);
2173
2174 LWS_EXTERN int LWS_WARN_UNUSED_RESULT
2175 lws_check_utf8(unsigned char *state, unsigned char *buf, size_t len);
2176 LWS_EXTERN int alloc_file(struct lws_context *context, const char *filename, uint8_t **buf,
2177                                 lws_filepos_t *amount);
2178 LWS_EXTERN int alloc_pem_to_der_file(struct lws_context *context, const char *filename, uint8_t **buf,
2179                lws_filepos_t *amount);
2180
2181 LWS_EXTERN void
2182 lws_same_vh_protocol_remove(struct lws *wsi);
2183 LWS_EXTERN void
2184 lws_same_vh_protocol_insert(struct lws *wsi, int n);
2185
2186 #if defined(LWS_WITH_STATS)
2187 void
2188 lws_stats_atomic_bump(struct lws_context * context,
2189                 struct lws_context_per_thread *pt, int index, uint64_t bump);
2190 void
2191 lws_stats_atomic_max(struct lws_context * context,
2192                 struct lws_context_per_thread *pt, int index, uint64_t val);
2193 #else
2194 static inline uint64_t lws_stats_atomic_bump(struct lws_context * context,
2195                 struct lws_context_per_thread *pt, int index, uint64_t bump) {
2196         (void)context; (void)pt; (void)index; (void)bump; return 0; }
2197 static inline uint64_t lws_stats_atomic_max(struct lws_context * context,
2198                 struct lws_context_per_thread *pt, int index, uint64_t val) {
2199         (void)context; (void)pt; (void)index; (void)val; return 0; }
2200 #endif
2201
2202 /* socks */
2203 void socks_generate_msg(struct lws *wsi, enum socks_msg_type type,
2204                         size_t *msg_len);
2205
2206 #ifdef __cplusplus
2207 };
2208 #endif