lib/private-libwebsockets.h

   1 /*
   2  * libwebsockets - small server side websockets and web server implementation
   3  *
   4  * Copyright (C) 2010 - 2013 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 /* System introspection configs */
  23 #ifdef CMAKE_BUILD
  24 #include "lws_config.h"
  25 #else
  26 #if defined(WIN32) || defined(_WIN32)
  27 #define inline __inline
  28 #else /* not WIN32 */
  29 #include "config.h"
  30
  31 #endif /* not WIN32 */
  32 #endif /* not CMAKE */
  33
  34 #ifdef HAVE_SYS_TYPES_H
  35 #include <sys/types.h>
  36 #endif
  37
  38 #include <stdio.h>
  39 #include <stdlib.h>
  40 #include <string.h>
  41 #include <time.h>
  42 #include <ctype.h>
  43 #include <limits.h>
  44 #include <stdarg.h>
  45
  46 #ifdef HAVE_SYS_STAT_H
  47 #include <sys/stat.h>
  48 #endif
  49
  50 #if defined(WIN32) || defined(_WIN32)
  51 #define LWS_NO_DAEMONIZE
  52 #define LWS_ERRNO WSAGetLastError()
  53 #define LWS_EAGAIN WSAEWOULDBLOCK
  54 #define LWS_EALREADY WSAEALREADY
  55 #define LWS_EINPROGRESS WSAEINPROGRESS
  56 #define LWS_EINTR WSAEINTR
  57 #define LWS_EISCONN WSAEISCONN
  58 #define LWS_EWOULDBLOCK WSAEWOULDBLOCK
  59 #define LWS_POLLHUP (FD_CLOSE)
  60 #define LWS_POLLIN (FD_READ | FD_ACCEPT)
  61 #define LWS_POLLOUT (FD_WRITE)
  62 #define MSG_NOSIGNAL 0
  63 #define SHUT_RDWR SD_BOTH
  64 #define SOL_TCP IPPROTO_TCP
  65
  66 #define compatible_close(fd) closesocket(fd)
  67 #define compatible_file_close(fd) CloseHandle(fd)
  68 #define compatible_file_seek_cur(fd, offset) SetFilePointer(fd, offset, NULL, FILE_CURRENT)
  69 #define compatible_file_read(amount, fd, buf, len) {\
  70         DWORD _amount; \
  71         if (!ReadFile(fd, buf, len, &_amount, NULL)) \
  72                 amount = -1; \
  73         else \
  74                 amount = _amount; \
  75         }
  76 #define lws_set_blocking_send(wsi) wsi->sock_send_blocking = TRUE
  77 #include <winsock2.h>
  78 #include <windows.h>
  79 #include <tchar.h>
  80 #ifdef HAVE_IN6ADDR_H
  81 #include <in6addr.h>
  82 #endif
  83 #include <mstcpip.h>
  84
  85 #ifndef __func__
  86 #define __func__ __FUNCTION__
  87 #endif
  88
  89 #ifdef _WIN32_WCE
  90 #define vsnprintf _vsnprintf
  91 #endif
  92
  93 #define LWS_INVALID_FILE INVALID_HANDLE_VALUE
  94 #else /* not windows --> */
  95 #include <errno.h>
  96 #include <fcntl.h>
  97 #include <netdb.h>
  98 #include <signal.h>
  99 #include <strings.h>
 100 #include <unistd.h>
 101 #include <sys/types.h>
 102 #include <sys/socket.h>
 103 #ifdef LWS_BUILTIN_GETIFADDRS
 104  #include <getifaddrs.h>
 105 #else
 106  #include <ifaddrs.h>
 107 #endif
 108 #if defined (__ANDROID__)
 109 #include <syslog.h>
 110 #else
 111 #include <sys/syslog.h>
 112 #endif
 113 #include <sys/un.h>
 114 #include <sys/socket.h>
 115 #include <netdb.h>
 116 #ifndef LWS_NO_FORK
 117 #ifdef HAVE_SYS_PRCTL_H
 118 #include <sys/prctl.h>
 119 #endif
 120 #endif
 121 #include <netinet/in.h>
 122 #include <netinet/tcp.h>
 123 #include <arpa/inet.h>
 124 #include <poll.h>
 125 #ifdef LWS_USE_LIBEV
 126 #include <ev.h>
 127 #endif /* LWS_USE_LIBEV */
 128
 129 #include <sys/mman.h>
 130 #include <sys/time.h>
 131
 132 #define LWS_ERRNO errno
 133 #define LWS_EAGAIN EAGAIN
 134 #define LWS_EALREADY EALREADY
 135 #define LWS_EINPROGRESS EINPROGRESS
 136 #define LWS_EINTR EINTR
 137 #define LWS_EISCONN EISCONN
 138 #define LWS_EWOULDBLOCK EWOULDBLOCK
 139 #define LWS_INVALID_FILE -1
 140 #define LWS_POLLHUP (POLLHUP|POLLERR)
 141 #define LWS_POLLIN (POLLIN)
 142 #define LWS_POLLOUT (POLLOUT)
 143 #define compatible_close(fd) close(fd)
 144 #define compatible_file_close(fd) close(fd)
 145 #define compatible_file_seek_cur(fd, offset) lseek(fd, offset, SEEK_CUR)
 146 #define compatible_file_read(amount, fd, buf, len) \
 147                 amount = read(fd, buf, len);
 148 #define lws_set_blocking_send(wsi)
 149 #endif
 150
 151 #ifndef HAVE_BZERO
 152 #define bzero(b, len) (memset((b), '\0', (len)), (void) 0)
 153 #endif
 154
 155 #ifndef HAVE_STRERROR
 156 #define strerror(x) ""
 157 #endif
 158
 159 #ifdef LWS_OPENSSL_SUPPORT
 160 #ifdef USE_CYASSL
 161 #include <cyassl/openssl/ssl.h>
 162 #include <cyassl/error-ssl.h>
 163 #else
 164 #include <openssl/ssl.h>
 165 #include <openssl/evp.h>
 166 #include <openssl/err.h>
 167 #include <openssl/md5.h>
 168 #include <openssl/sha.h>
 169 #endif /* not USE_CYASSL */
 170 #endif
 171
 172 #include "libwebsockets.h"
 173
 174 #if defined(WIN32) || defined(_WIN32)
 175
 176 #ifndef BIG_ENDIAN
 177 #define BIG_ENDIAN    4321  /* to show byte order (taken from gcc) */
 178 #endif
 179 #ifndef LITTLE_ENDIAN
 180 #define LITTLE_ENDIAN 1234
 181 #endif
 182 #ifndef BYTE_ORDER
 183 #define BYTE_ORDER LITTLE_ENDIAN
 184 #endif
 185 typedef unsigned __int64 u_int64_t;
 186
 187 #undef __P
 188 #ifndef __P
 189 #if __STDC__
 190 #define __P(protos) protos
 191 #else
 192 #define __P(protos) ()
 193 #endif
 194 #endif
 195
 196 #else
 197
 198 #include <sys/stat.h>
 199 #include <sys/cdefs.h>
 200 #include <sys/time.h>
 201
 202 #if defined(__APPLE__)
 203 #include <machine/endian.h>
 204 #elif defined(__FreeBSD__)
 205 #include <sys/endian.h>
 206 #elif defined(__linux__)
 207 #include <endian.h>
 208 #endif
 209
 210 #if defined(__QNX__)
 211         #include <gulliver.h>
 212         #if defined(__LITTLEENDIAN__)
 213                 #define BYTE_ORDER __LITTLEENDIAN__
 214                 #define LITTLE_ENDIAN __LITTLEENDIAN__
 215                 #define BIG_ENDIAN 4321  /* to show byte order (taken from gcc); for suppres warning that BIG_ENDIAN is not defined. */
 216         #endif
 217         #if defined(__BIGENDIAN__)
 218                 #define BYTE_ORDER __BIGENDIAN__
 219                 #define LITTLE_ENDIAN 1234  /* to show byte order (taken from gcc); for suppres warning that LITTLE_ENDIAN is not defined. */
 220                 #define BIG_ENDIAN __BIGENDIAN__
 221         #endif
 222 #endif
 223
 224 #if !defined(BYTE_ORDER)
 225 # define BYTE_ORDER __BYTE_ORDER
 226 #endif
 227 #if !defined(LITTLE_ENDIAN)
 228 # define LITTLE_ENDIAN __LITTLE_ENDIAN
 229 #endif
 230 #if !defined(BIG_ENDIAN)
 231 # define BIG_ENDIAN __BIG_ENDIAN
 232 #endif
 233
 234 #endif
 235
 236 /*
 237  * Mac OSX as well as iOS do not define the MSG_NOSIGNAL flag,
 238  * but happily have something equivalent in the SO_NOSIGPIPE flag.
 239  */
 240 #ifdef __APPLE__
 241 #define MSG_NOSIGNAL SO_NOSIGPIPE
 242 #endif
 243
 244 #ifndef LWS_MAX_HEADER_LEN
 245 #define LWS_MAX_HEADER_LEN 1024
 246 #endif
 247 #ifndef LWS_MAX_PROTOCOLS
 248 #define LWS_MAX_PROTOCOLS 5
 249 #endif
 250 #ifndef LWS_MAX_EXTENSIONS_ACTIVE
 251 #define LWS_MAX_EXTENSIONS_ACTIVE 3
 252 #endif
 253 #ifndef SPEC_LATEST_SUPPORTED
 254 #define SPEC_LATEST_SUPPORTED 13
 255 #endif
 256 #ifndef AWAITING_TIMEOUT
 257 #define AWAITING_TIMEOUT 5
 258 #endif
 259 #ifndef CIPHERS_LIST_STRING
 260 #define CIPHERS_LIST_STRING "DEFAULT"
 261 #endif
 262 #ifndef LWS_SOMAXCONN
 263 #define LWS_SOMAXCONN SOMAXCONN
 264 #endif
 265
 266 #define MAX_WEBSOCKET_04_KEY_LEN 128
 267 #define LWS_MAX_SOCKET_IO_BUF 4096
 268
 269 #ifndef SYSTEM_RANDOM_FILEPATH
 270 #define SYSTEM_RANDOM_FILEPATH "/dev/urandom"
 271 #endif
 272 #ifndef LWS_MAX_ZLIB_CONN_BUFFER
 273 #define LWS_MAX_ZLIB_CONN_BUFFER (64 * 1024)
 274 #endif
 275
 276 /*
 277  * if not in a connection storm, check for incoming
 278  * connections this many normal connection services
 279  */
 280 #define LWS_LISTEN_SERVICE_MODULO 10
 281
 282 enum lws_websocket_opcodes_07 {
 283         LWS_WS_OPCODE_07__CONTINUATION = 0,
 284         LWS_WS_OPCODE_07__TEXT_FRAME = 1,
 285         LWS_WS_OPCODE_07__BINARY_FRAME = 2,
 286
 287         LWS_WS_OPCODE_07__NOSPEC__MUX = 7,
 288
 289         /* control extensions 8+ */
 290
 291         LWS_WS_OPCODE_07__CLOSE = 8,
 292         LWS_WS_OPCODE_07__PING = 9,
 293         LWS_WS_OPCODE_07__PONG = 0xa,
 294 };
 295
 296
 297 enum lws_connection_states {
 298         WSI_STATE_HTTP,
 299         WSI_STATE_HTTP_ISSUING_FILE,
 300         WSI_STATE_HTTP_HEADERS,
 301         WSI_STATE_HTTP_BODY,
 302         WSI_STATE_DEAD_SOCKET,
 303         WSI_STATE_ESTABLISHED,
 304         WSI_STATE_CLIENT_UNCONNECTED,
 305         WSI_STATE_RETURNED_CLOSE_ALREADY,
 306         WSI_STATE_AWAITING_CLOSE_ACK,
 307         WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE,
 308
 309         WSI_STATE_HTTP2_AWAIT_CLIENT_PREFACE,
 310         WSI_STATE_HTTP2_ESTABLISHED_PRE_SETTINGS,
 311         WSI_STATE_HTTP2_ESTABLISHED,
 312 };
 313
 314 enum http_version {
 315         HTTP_VERSION_1_0,
 316         HTTP_VERSION_1_1,
 317 };
 318
 319 enum http_connection_type {
 320         HTTP_CONNECTION_CLOSE,
 321         HTTP_CONNECTION_KEEP_ALIVE
 322 };
 323
 324 enum lws_pending_protocol_send {
 325         LWS_PPS_NONE,
 326         LWS_PPS_HTTP2_MY_SETTINGS,
 327         LWS_PPS_HTTP2_ACK_SETTINGS,
 328 };
 329
 330 enum lws_rx_parse_state {
 331         LWS_RXPS_NEW,
 332
 333         LWS_RXPS_04_MASK_NONCE_1,
 334         LWS_RXPS_04_MASK_NONCE_2,
 335         LWS_RXPS_04_MASK_NONCE_3,
 336
 337         LWS_RXPS_04_FRAME_HDR_1,
 338         LWS_RXPS_04_FRAME_HDR_LEN,
 339         LWS_RXPS_04_FRAME_HDR_LEN16_2,
 340         LWS_RXPS_04_FRAME_HDR_LEN16_1,
 341         LWS_RXPS_04_FRAME_HDR_LEN64_8,
 342         LWS_RXPS_04_FRAME_HDR_LEN64_7,
 343         LWS_RXPS_04_FRAME_HDR_LEN64_6,
 344         LWS_RXPS_04_FRAME_HDR_LEN64_5,
 345         LWS_RXPS_04_FRAME_HDR_LEN64_4,
 346         LWS_RXPS_04_FRAME_HDR_LEN64_3,
 347         LWS_RXPS_04_FRAME_HDR_LEN64_2,
 348         LWS_RXPS_04_FRAME_HDR_LEN64_1,
 349
 350         LWS_RXPS_07_COLLECT_FRAME_KEY_1,
 351         LWS_RXPS_07_COLLECT_FRAME_KEY_2,
 352         LWS_RXPS_07_COLLECT_FRAME_KEY_3,
 353         LWS_RXPS_07_COLLECT_FRAME_KEY_4,
 354
 355         LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED
 356 };
 357
 358
 359 enum connection_mode {
 360         LWS_CONNMODE_HTTP_SERVING,
 361         LWS_CONNMODE_HTTP_SERVING_ACCEPTED, /* actual HTTP service going on */
 362         LWS_CONNMODE_PRE_WS_SERVING_ACCEPT,
 363
 364         LWS_CONNMODE_WS_SERVING,
 365         LWS_CONNMODE_WS_CLIENT,
 366
 367         LWS_CONNMODE_HTTP2_SERVING,
 368
 369         /* transient, ssl delay hiding */
 370         LWS_CONNMODE_SSL_ACK_PENDING,
 371
 372         /* transient modes */
 373         LWS_CONNMODE_WS_CLIENT_WAITING_CONNECT,
 374         LWS_CONNMODE_WS_CLIENT_WAITING_PROXY_REPLY,
 375         LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE,
 376         LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE2,
 377         LWS_CONNMODE_WS_CLIENT_WAITING_SSL,
 378         LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY,
 379         LWS_CONNMODE_WS_CLIENT_WAITING_EXTENSION_CONNECT,
 380         LWS_CONNMODE_WS_CLIENT_PENDING_CANDIDATE_CHILD,
 381
 382         /* special internal types */
 383         LWS_CONNMODE_SERVER_LISTENER,
 384 };
 385
 386 enum {
 387         LWS_RXFLOW_ALLOW = (1 << 0),
 388         LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
 389 };
 390
 391 struct libwebsocket_protocols;
 392 struct libwebsocket;
 393
 394 #ifdef LWS_USE_LIBEV
 395 struct lws_io_watcher {
 396         struct ev_io watcher;
 397         struct libwebsocket_context* context;
 398 };
 399
 400 struct lws_signal_watcher {
 401         struct ev_signal watcher;
 402         struct libwebsocket_context* context;
 403 };
 404 #endif /* LWS_USE_LIBEV */
 405
 406 struct libwebsocket_context {
 407 #ifdef _WIN32
 408         WSAEVENT *events;
 409 #endif
 410         struct libwebsocket_pollfd *fds;
 411         struct libwebsocket **lws_lookup; /* fd to wsi */
 412         int fds_count;
 413 #ifdef LWS_USE_LIBEV
 414         struct ev_loop* io_loop;
 415         struct lws_io_watcher w_accept;
 416         struct lws_signal_watcher w_sigint;
 417 #endif /* LWS_USE_LIBEV */
 418         int max_fds;
 419         int listen_port;
 420         const char *iface;
 421         char http_proxy_address[128];
 422         char canonical_hostname[128];
 423         unsigned int http_proxy_port;
 424         unsigned int options;
 425         time_t last_timeout_check_s;
 426
 427         /*
 428          * usable by anything in the service code, but only if the scope
 429          * does not last longer than the service action (since next service
 430          * of any socket can likewise use it and overwrite)
 431          */
 432         unsigned char service_buffer[LWS_MAX_SOCKET_IO_BUF];
 433
 434         int started_with_parent;
 435
 436         int fd_random;
 437         int listen_service_modulo;
 438         int listen_service_count;
 439         int listen_service_fd;
 440         int listen_service_extraseen;
 441
 442         /*
 443          * set to the Thread ID that's doing the service loop just before entry
 444          * to poll indicates service thread likely idling in poll()
 445          * volatile because other threads may check it as part of processing
 446          * for pollfd event change.
 447          */
 448         volatile int service_tid;
 449 #ifndef _WIN32
 450         int dummy_pipe_fds[2];
 451 #endif
 452
 453         int ka_time;
 454         int ka_probes;
 455         int ka_interval;
 456
 457 #ifdef LWS_LATENCY
 458         unsigned long worst_latency;
 459         char worst_latency_info[256];
 460 #endif
 461
 462 #ifdef LWS_OPENSSL_SUPPORT
 463         int use_ssl;
 464         int allow_non_ssl_on_ssl_port;
 465         SSL_CTX *ssl_ctx;
 466         SSL_CTX *ssl_client_ctx;
 467 #endif
 468         struct libwebsocket_protocols *protocols;
 469         int count_protocols;
 470 #ifndef LWS_NO_EXTENSIONS
 471         struct libwebsocket_extension *extensions;
 472 #endif
 473     struct lws_token_limits *token_limits;
 474         void *user_space;
 475 };
 476
 477 enum {
 478         LWS_EV_READ = (1 << 0),
 479         LWS_EV_WRITE = (1 << 1),
 480         LWS_EV_START = (1 << 2),
 481         LWS_EV_STOP = (1 << 3),
 482 };
 483
 484 #ifdef LWS_USE_LIBEV
 485 #define LWS_LIBEV_ENABLED(context) (context->options & LWS_SERVER_OPTION_LIBEV)
 486 LWS_EXTERN void lws_feature_status_libev(struct lws_context_creation_info *info);
 487 LWS_EXTERN void
 488 lws_libev_accept(struct libwebsocket_context *context,
 489                  struct libwebsocket *new_wsi, int accept_fd);
 490 LWS_EXTERN void
 491 lws_libev_io(struct libwebsocket_context *context,
 492                                 struct libwebsocket *wsi, int flags);
 493 LWS_EXTERN int
 494 lws_libev_init_fd_table(struct libwebsocket_context *context);
 495 LWS_EXTERN void
 496 lws_libev_run(struct libwebsocket_context *context);
 497 #else
 498 #define LWS_LIBEV_ENABLED(context) (0)
 499 #define lws_feature_status_libev(_a) \
 500                         lwsl_notice("libev support not compiled in\n")
 501 #define lws_libev_accept(_a, _b, _c) ((void) 0)
 502 #define lws_libev_io(_a, _b, _c) ((void) 0)
 503 #define lws_libev_init_fd_table(_a) (0)
 504 #define lws_libev_run(_a) ((void) 0)
 505 #endif
 506
 507 #ifdef LWS_USE_IPV6
 508 #define LWS_IPV6_ENABLED(context) (!(context->options & LWS_SERVER_OPTION_DISABLE_IPV6))
 509 #else
 510 #define LWS_IPV6_ENABLED(context) (0)
 511 #endif
 512
 513 enum uri_path_states {
 514         URIPS_IDLE,
 515         URIPS_SEEN_SLASH,
 516         URIPS_SEEN_SLASH_DOT,
 517         URIPS_SEEN_SLASH_DOT_DOT,
 518         URIPS_ARGUMENTS,
 519 };
 520
 521 enum uri_esc_states {
 522         URIES_IDLE,
 523         URIES_SEEN_PERCENT,
 524         URIES_SEEN_PERCENT_H1,
 525 };
 526
 527 /*
 528  * This is totally opaque to code using the library.  It's exported as a
 529  * forward-reference pointer-only declaration; the user can use the pointer with
 530  * other APIs to get information out of it.
 531  */
 532
 533 struct lws_fragments {
 534         unsigned short offset;
 535         unsigned short len;
 536         unsigned char next_frag_index;
 537 };
 538
 539 /* notice that these union members:
 540  *
 541  *  hdr
 542  *  http
 543  *  http2
 544  *
 545  * all have a pointer to allocated_headers struct as their first member.
 546  *
 547  * It means for allocated_headers access, the three union paths can all be
 548  * used interchangably to access the same data
 549  */
 550
 551 struct allocated_headers {
 552         unsigned short next_frag_index;
 553         unsigned short pos;
 554         unsigned char frag_index[WSI_TOKEN_COUNT];
 555         struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
 556         char data[LWS_MAX_HEADER_LEN];
 557 #ifndef LWS_NO_CLIENT
 558         char initial_handshake_hash_base64[30];
 559         unsigned short c_port;
 560 #endif
 561 };
 562
 563 struct _lws_http_mode_related {
 564         /* MUST be first in struct */
 565         struct allocated_headers *ah; /* mirroring  _lws_header_related */
 566 #if defined(WIN32) || defined(_WIN32)
 567         HANDLE fd;
 568 #else
 569         int fd;
 570 #endif
 571         unsigned long filepos;
 572         unsigned long filelen;
 573
 574         enum http_version request_version;
 575         enum http_connection_type connection_type;
 576         int content_length;
 577         int content_remain;
 578 };
 579
 580 #ifdef LWS_USE_HTTP2
 581
 582 enum lws_http2_settings {
 583         LWS_HTTP2_SETTINGS__HEADER_TABLE_SIZE = 1,
 584         LWS_HTTP2_SETTINGS__ENABLE_PUSH,
 585         LWS_HTTP2_SETTINGS__MAX_CONCURRENT_STREAMS,
 586         LWS_HTTP2_SETTINGS__INITIAL_WINDOW_SIZE,
 587         LWS_HTTP2_SETTINGS__MAX_FRAME_SIZE,
 588         LWS_HTTP2_SETTINGS__MAX_HEADER_LIST_SIZE,
 589
 590         LWS_HTTP2_SETTINGS__COUNT /* always last */
 591 };
 592
 593 enum lws_http2_wellknown_frame_types {
 594         LWS_HTTP2_FRAME_TYPE_DATA,
 595         LWS_HTTP2_FRAME_TYPE_HEADERS,
 596         LWS_HTTP2_FRAME_TYPE_PRIORITY,
 597         LWS_HTTP2_FRAME_TYPE_RST_STREAM,
 598         LWS_HTTP2_FRAME_TYPE_SETTINGS,
 599         LWS_HTTP2_FRAME_TYPE_PUSH_PROMISE,
 600         LWS_HTTP2_FRAME_TYPE_PING,
 601         LWS_HTTP2_FRAME_TYPE_GOAWAY,
 602         LWS_HTTP2_FRAME_TYPE_WINDOW_UPDATE,
 603         LWS_HTTP2_FRAME_TYPE_CONTINUATION,
 604
 605         LWS_HTTP2_FRAME_TYPE_COUNT /* always last */
 606 };
 607
 608 #define LWS_HTTP2_STREAM_ID_MASTER 0
 609 #define LWS_HTTP2_FRAME_HEADER_LENGTH 9
 610 #define LWS_HTTP2_SETTINGS_LENGTH 6
 611
 612 struct http2_settings {
 613         unsigned int setting[LWS_HTTP2_SETTINGS__COUNT];
 614 };
 615
 616 struct _lws_http2_related {
 617         /*
 618          * having this first lets us also re-use all HTTP union code
 619          * and in turn, http_mode_related has allocated headers in right
 620          * place so we can use the header apis on the wsi directly still
 621          */
 622         struct _lws_http_mode_related http; /* MUST BE FIRST IN STRUCT */
 623
 624         struct http2_settings my_settings;
 625         struct http2_settings peer_settings;
 626
 627         struct libwebsocket *parent_wsi;
 628         struct libwebsocket *next_child_wsi;
 629
 630         unsigned int count;
 631
 632         /* frame */
 633         unsigned int length;
 634         unsigned int stream_id;
 635         struct libwebsocket *stream_wsi;
 636         unsigned char type;
 637         unsigned char flags;
 638         unsigned char frame_state;
 639
 640         unsigned int tx_credit;
 641         unsigned int my_stream_id;
 642         unsigned int child_count;
 643         int my_priority;
 644         unsigned char initialized;
 645         unsigned char one_setting[LWS_HTTP2_SETTINGS_LENGTH];
 646 };
 647
 648 #define HTTP2_IS_TOPLEVEL_WSI(wsi) (!wsi->parent_wsi)
 649
 650 #endif
 651
 652 struct _lws_header_related {
 653         /* MUST be first in struct */
 654         struct allocated_headers *ah;
 655         short lextable_pos;
 656         unsigned short current_token_limit;
 657         unsigned char parser_state; /* enum lws_token_indexes */
 658         enum uri_path_states ups;
 659         enum uri_esc_states ues;
 660         char esc_stash;
 661 };
 662
 663 struct _lws_websocket_related {
 664         char *rx_user_buffer;
 665         int rx_user_buffer_head;
 666         unsigned char frame_masking_nonce_04[4];
 667         unsigned char frame_mask_index;
 668         size_t rx_packet_length;
 669         unsigned char opcode;
 670         unsigned int final:1;
 671         unsigned char rsv;
 672         unsigned int frame_is_binary:1;
 673         unsigned int all_zero_nonce:1;
 674         short close_reason; /* enum lws_close_status */
 675
 676         unsigned int this_frame_masked:1;
 677         unsigned int inside_frame:1; /* next write will be more of frame */
 678         unsigned int clean_buffer:1; /* buffer not rewritten by extension */
 679
 680         unsigned char *ping_payload_buf; /* non-NULL if malloc'd */
 681         unsigned int ping_payload_alloc; /* length malloc'd */
 682         unsigned int ping_payload_len; /* nonzero if PONG pending */
 683 };
 684
 685 struct libwebsocket {
 686
 687         /* lifetime members */
 688
 689 #ifdef LWS_USE_LIBEV
 690     struct lws_io_watcher w_read;
 691     struct lws_io_watcher w_write;
 692 #endif /* LWS_USE_LIBEV */
 693         const struct libwebsocket_protocols *protocol;
 694 #ifndef LWS_NO_EXTENSIONS
 695         struct libwebsocket_extension *
 696                                    active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
 697         void *active_extensions_user[LWS_MAX_EXTENSIONS_ACTIVE];
 698         unsigned char count_active_extensions;
 699         unsigned int extension_data_pending:1;
 700 #endif
 701         unsigned char ietf_spec_revision;
 702         enum lws_pending_protocol_send pps;
 703
 704         char mode; /* enum connection_mode */
 705         char state; /* enum lws_connection_states */
 706         char lws_rx_parse_state; /* enum lws_rx_parse_state */
 707         char rx_frame_type; /* enum libwebsocket_write_protocol */
 708
 709         unsigned int hdr_parsing_completed:1;
 710         unsigned int user_space_externally_allocated:1;
 711
 712         char pending_timeout; /* enum pending_timeout */
 713         time_t pending_timeout_limit;
 714
 715         int sock;
 716         int position_in_fds_table;
 717 #ifdef LWS_LATENCY
 718         unsigned long action_start;
 719         unsigned long latency_start;
 720 #endif
 721         /* rxflow handling */
 722         unsigned char *rxflow_buffer;
 723         int rxflow_len;
 724         int rxflow_pos;
 725         unsigned int rxflow_change_to:2;
 726
 727         /* truncated send handling */
 728         unsigned char *truncated_send_malloc; /* non-NULL means buffering in progress */
 729         unsigned int truncated_send_allocation; /* size of malloc */
 730         unsigned int truncated_send_offset; /* where we are in terms of spilling */
 731         unsigned int truncated_send_len; /* how much is buffered */
 732
 733         void *user_space;
 734
 735         /* members with mutually exclusive lifetimes are unionized */
 736
 737         union u {
 738                 struct _lws_http_mode_related http;
 739 #ifdef LWS_USE_HTTP2
 740                 struct _lws_http2_related http2;
 741 #endif
 742                 struct _lws_header_related hdr;
 743                 struct _lws_websocket_related ws;
 744         } u;
 745
 746 #ifdef LWS_OPENSSL_SUPPORT
 747         SSL *ssl;
 748         BIO *client_bio;
 749         unsigned int use_ssl:2;
 750 #endif
 751
 752 #ifdef _WIN32
 753         BOOL sock_send_blocking;
 754 #endif
 755 };
 756
 757 LWS_EXTERN int log_level;
 758
 759 LWS_EXTERN void
 760 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
 761                                struct libwebsocket *wsi, enum lws_close_status);
 762
 763 LWS_EXTERN int
 764 remove_wsi_socket_from_fds(struct libwebsocket_context *context,
 765                                                       struct libwebsocket *wsi);
 766 LWS_EXTERN int
 767 lws_rxflow_cache(struct libwebsocket *wsi, unsigned char *buf, int n, int len);
 768
 769 #ifndef LWS_LATENCY
 770 static inline void lws_latency(struct libwebsocket_context *context,
 771                 struct libwebsocket *wsi, const char *action,
 772                                          int ret, int completion) { while (0); }
 773 static inline void lws_latency_pre(struct libwebsocket_context *context,
 774                                         struct libwebsocket *wsi) { while (0); }
 775 #else
 776 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
 777 extern void
 778 lws_latency(struct libwebsocket_context *context,
 779                         struct libwebsocket *wsi, const char *action,
 780                                                        int ret, int completion);
 781 #endif
 782
 783 LWS_EXTERN void lws_set_protocol_write_pending(struct libwebsocket_context *context,
 784                                     struct libwebsocket *wsi,
 785                                     enum lws_pending_protocol_send pend);
 786 LWS_EXTERN int
 787 libwebsocket_client_rx_sm(struct libwebsocket *wsi, unsigned char c);
 788
 789 LWS_EXTERN int
 790 libwebsocket_parse(struct libwebsocket_context *context,
 791                 struct libwebsocket *wsi, unsigned char c);
 792
 793 LWS_EXTERN int
 794 lws_http_action(struct libwebsocket_context *context, struct libwebsocket *wsi);
 795
 796 LWS_EXTERN int
 797 lws_b64_selftest(void);
 798
 799 LWS_EXTERN struct libwebsocket *
 800 wsi_from_fd(struct libwebsocket_context *context, int fd);
 801
 802 LWS_EXTERN int
 803 insert_wsi_socket_into_fds(struct libwebsocket_context *context,
 804                                                       struct libwebsocket *wsi);
 805
 806 LWS_EXTERN int
 807 lws_issue_raw(struct libwebsocket *wsi, unsigned char *buf, size_t len);
 808
 809
 810 LWS_EXTERN int
 811 libwebsocket_service_timeout_check(struct libwebsocket_context *context,
 812                                     struct libwebsocket *wsi, unsigned int sec);
 813
 814 LWS_EXTERN struct libwebsocket *
 815 libwebsocket_client_connect_2(struct libwebsocket_context *context,
 816         struct libwebsocket *wsi);
 817
 818 LWS_EXTERN struct libwebsocket *
 819 libwebsocket_create_new_server_wsi(struct libwebsocket_context *context);
 820
 821 LWS_EXTERN char *
 822 libwebsockets_generate_client_handshake(struct libwebsocket_context *context,
 823                 struct libwebsocket *wsi, char *pkt);
 824
 825 LWS_EXTERN int
 826 lws_handle_POLLOUT_event(struct libwebsocket_context *context,
 827                               struct libwebsocket *wsi, struct libwebsocket_pollfd *pollfd);
 828 /*
 829  * EXTENSIONS
 830  */
 831
 832 #ifndef LWS_NO_EXTENSIONS
 833 LWS_VISIBLE void
 834 lws_context_init_extensions(struct lws_context_creation_info *info,
 835                                     struct libwebsocket_context *context);
 836 LWS_EXTERN int
 837 lws_any_extension_handled(struct libwebsocket_context *context,
 838                           struct libwebsocket *wsi,
 839                           enum libwebsocket_extension_callback_reasons r,
 840                           void *v, size_t len);
 841
 842 LWS_EXTERN int
 843 lws_ext_callback_for_each_active(struct libwebsocket *wsi, int reason,
 844                                                     void *buf, int len);
 845 LWS_EXTERN int
 846 lws_ext_callback_for_each_extension_type(
 847                 struct libwebsocket_context *context, struct libwebsocket *wsi,
 848                         int reason, void *arg, int len);
 849 #else
 850 #define lws_any_extension_handled(_a, _b, _c, _d, _e) (0)
 851 #define lws_ext_callback_for_each_active(_a, _b, _c, _d) (0)
 852 #define lws_ext_callback_for_each_extension_type(_a, _b, _c, _d, _e) (0)
 853 #define lws_issue_raw_ext_access lws_issue_raw
 854 #define lws_context_init_extensions(_a, _b)
 855 #endif
 856
 857 LWS_EXTERN int
 858 lws_client_interpret_server_handshake(struct libwebsocket_context *context,
 859                 struct libwebsocket *wsi);
 860
 861 LWS_EXTERN int
 862 libwebsocket_rx_sm(struct libwebsocket *wsi, unsigned char c);
 863
 864 LWS_EXTERN int
 865 lws_issue_raw_ext_access(struct libwebsocket *wsi,
 866                                                 unsigned char *buf, size_t len);
 867
 868 LWS_EXTERN int
 869 _libwebsocket_rx_flow_control(struct libwebsocket *wsi);
 870
 871 LWS_EXTERN int
 872 user_callback_handle_rxflow(callback_function,
 873                 struct libwebsocket_context *context,
 874                         struct libwebsocket *wsi,
 875                          enum libwebsocket_callback_reasons reason, void *user,
 876                                                           void *in, size_t len);
 877 #ifdef LWS_USE_HTTP2
 878 LWS_EXTERN int
 879 lws_http2_interpret_settings_payload(struct http2_settings *settings, unsigned char *buf, int len);
 880 LWS_EXTERN void lws_http2_init(struct http2_settings *settings);
 881 LWS_EXTERN int
 882 lws_http2_parser(struct libwebsocket_context *context,
 883                      struct libwebsocket *wsi, unsigned char c);
 884 LWS_EXTERN int lws_http2_do_pps_send(struct libwebsocket_context *context, struct libwebsocket *wsi);
 885 LWS_EXTERN int lws_http2_frame_write(struct libwebsocket *wsi, int type, int flags, unsigned int sid, unsigned int len, unsigned char *buf);
 886 LWS_EXTERN struct libwebsocket *
 887 lws_http2_wsi_from_id(struct libwebsocket *wsi, unsigned int sid);
 888 #endif
 889
 890 LWS_EXTERN int
 891 lws_plat_set_socket_options(struct libwebsocket_context *context, int fd);
 892
 893 LWS_EXTERN int
 894 lws_allocate_header_table(struct libwebsocket *wsi);
 895
 896 LWS_EXTERN char *
 897 lws_hdr_simple_ptr(struct libwebsocket *wsi, enum lws_token_indexes h);
 898
 899 LWS_EXTERN int
 900 lws_hdr_simple_create(struct libwebsocket *wsi,
 901                                 enum lws_token_indexes h, const char *s);
 902
 903 LWS_EXTERN int
 904 libwebsocket_ensure_user_space(struct libwebsocket *wsi);
 905
 906 LWS_EXTERN int
 907 lws_change_pollfd(struct libwebsocket *wsi, int _and, int _or);
 908
 909 #ifndef LWS_NO_SERVER
 910 int lws_context_init_server(struct lws_context_creation_info *info,
 911                             struct libwebsocket_context *context);
 912 LWS_EXTERN int handshake_0405(struct libwebsocket_context *context,
 913                                                       struct libwebsocket *wsi);
 914 LWS_EXTERN int
 915 libwebsocket_interpret_incoming_packet(struct libwebsocket *wsi,
 916                                                 unsigned char *buf, size_t len);
 917 LWS_EXTERN void
 918 lws_server_get_canonical_hostname(struct libwebsocket_context *context,
 919                                 struct lws_context_creation_info *info);
 920 #else
 921 #define lws_context_init_server(_a, _b) (0)
 922 #define libwebsocket_interpret_incoming_packet(_a, _b, _c) (0)
 923 #define lws_server_get_canonical_hostname(_a, _b)
 924 #endif
 925
 926 #ifndef LWS_NO_DAEMONIZE
 927 LWS_EXTERN int get_daemonize_pid();
 928 #else
 929 #define get_daemonize_pid() (0)
 930 #endif
 931
 932 LWS_EXTERN int interface_to_sa(struct libwebsocket_context *context,
 933                 const char *ifname, struct sockaddr_in *addr, size_t addrlen);
 934
 935 LWS_EXTERN void lwsl_emit_stderr(int level, const char *line);
 936
 937 #ifdef _WIN32
 938 LWS_EXTERN HANDLE lws_plat_open_file(const char* filename, unsigned long* filelen);
 939 #else
 940 LWS_EXTERN int lws_plat_open_file(const char* filename, unsigned long* filelen);
 941 #endif
 942
 943 enum lws_ssl_capable_status {
 944         LWS_SSL_CAPABLE_ERROR = -1,
 945         LWS_SSL_CAPABLE_MORE_SERVICE = -2,
 946 };
 947
 948 #ifndef LWS_OPENSSL_SUPPORT
 949 #define LWS_SSL_ENABLED(context) (0)
 950 #define lws_context_init_server_ssl(_a, _b) (0)
 951 #define lws_ssl_destroy(_a)
 952 #define lws_context_init_http2_ssl(_a)
 953 #define lws_ssl_pending(_a) (0)
 954 #define lws_ssl_capable_read lws_ssl_capable_read_no_ssl
 955 #define lws_ssl_capable_write lws_ssl_capable_write_no_ssl
 956 #define lws_server_socket_service_ssl(_a, _b, _c, _d, _e) (0)
 957 #define lws_ssl_close(_a) (0)
 958 #define lws_ssl_context_destroy(_a)
 959 #else
 960 #define LWS_SSL_ENABLED(context) (context->use_ssl)
 961 LWS_EXTERN int lws_ssl_pending(struct libwebsocket *wsi);
 962 LWS_EXTERN int openssl_websocket_private_data_index;
 963 LWS_EXTERN int
 964 lws_ssl_capable_read(struct libwebsocket *wsi, unsigned char *buf, int len);
 965
 966 LWS_EXTERN int
 967 lws_ssl_capable_write(struct libwebsocket *wsi, unsigned char *buf, int len);
 968 LWS_EXTERN int
 969 lws_server_socket_service_ssl(struct libwebsocket_context *context,
 970                 struct libwebsocket **wsi, struct libwebsocket *new_wsi,
 971                 int accept_fd, struct libwebsocket_pollfd *pollfd);
 972 LWS_EXTERN int
 973 lws_ssl_close(struct libwebsocket *wsi);
 974 LWS_EXTERN void
 975 lws_ssl_context_destroy(struct libwebsocket_context *context);
 976 #ifndef LWS_NO_SERVER
 977 LWS_EXTERN int
 978 lws_context_init_server_ssl(struct lws_context_creation_info *info,
 979                      struct libwebsocket_context *context);
 980 #else
 981 #define lws_context_init_server_ssl(_a, _b) (0)
 982 #endif
 983 LWS_EXTERN void
 984 lws_ssl_destroy(struct libwebsocket_context *context);
 985
 986 /* HTTP2-related */
 987
 988 #ifdef LWS_USE_HTTP2
 989 LWS_EXTERN void
 990 lws_context_init_http2_ssl(struct libwebsocket_context *context);
 991 #else
 992 #define lws_context_init_http2_ssl(_a)
 993 #endif
 994 #endif
 995
 996 LWS_EXTERN int
 997 lws_ssl_capable_read_no_ssl(struct libwebsocket *wsi, unsigned char *buf, int len);
 998
 999 LWS_EXTERN int
1000 lws_ssl_capable_write_no_ssl(struct libwebsocket *wsi, unsigned char *buf, int len);
1001
1002 #ifndef LWS_NO_CLIENT
1003         LWS_EXTERN int lws_client_socket_service(
1004                 struct libwebsocket_context *context,
1005                 struct libwebsocket *wsi, struct libwebsocket_pollfd *pollfd);
1006 #ifdef LWS_OPENSSL_SUPPORT
1007         LWS_EXTERN int lws_context_init_client_ssl(struct lws_context_creation_info *info,
1008                             struct libwebsocket_context *context);
1009 #else
1010         #define lws_context_init_client_ssl(_a, _b) (0)
1011 #endif
1012         LWS_EXTERN int lws_handshake_client(struct libwebsocket *wsi, unsigned char **buf, size_t len);
1013         LWS_EXTERN void
1014         libwebsockets_decode_ssl_error(void);
1015 #else
1016 #define lws_context_init_client_ssl(_a, _b) (0)
1017 #define lws_handshake_client(_a, _b, _c) (0)
1018 #endif
1019 #ifndef LWS_NO_SERVER
1020         LWS_EXTERN int lws_server_socket_service(
1021                 struct libwebsocket_context *context,
1022                 struct libwebsocket *wsi, struct libwebsocket_pollfd *pollfd);
1023         LWS_EXTERN int _libwebsocket_rx_flow_control(struct libwebsocket *wsi);
1024         LWS_EXTERN int lws_handshake_server(struct libwebsocket_context *context,
1025                      struct libwebsocket *wsi, unsigned char **buf, size_t len);
1026 #else
1027 #define lws_server_socket_service(_a, _b, _c) (0)
1028 #define _libwebsocket_rx_flow_control(_a) (0)
1029 #define lws_handshake_server(_a, _b, _c, _d) (0)
1030 #endif
1031
1032 /*
1033  * lws_plat_
1034  */
1035 LWS_EXTERN void
1036 lws_plat_delete_socket_from_fds(struct libwebsocket_context *context,
1037                                                struct libwebsocket *wsi, int m);
1038 LWS_EXTERN void
1039 lws_plat_insert_socket_into_fds(struct libwebsocket_context *context,
1040                                                       struct libwebsocket *wsi);
1041 LWS_EXTERN void
1042 lws_plat_service_periodic(struct libwebsocket_context *context);
1043
1044 LWS_EXTERN int
1045 lws_plat_change_pollfd(struct libwebsocket_context *context,
1046                      struct libwebsocket *wsi, struct libwebsocket_pollfd *pfd);
1047 LWS_EXTERN int
1048 lws_plat_context_early_init(void);
1049 LWS_EXTERN void
1050 lws_plat_context_early_destroy(struct libwebsocket_context *context);
1051 LWS_EXTERN void
1052 lws_plat_context_late_destroy(struct libwebsocket_context *context);
1053 LWS_EXTERN int
1054 lws_poll_listen_fd(struct libwebsocket_pollfd *fd);
1055 LWS_EXTERN int
1056 lws_plat_service(struct libwebsocket_context *context, int timeout_ms);
1057 LWS_EXTERN int
1058 lws_plat_init_fd_tables(struct libwebsocket_context *context);
1059 LWS_EXTERN void
1060 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
1061 LWS_EXTERN unsigned long long
1062 time_in_microseconds(void);
1063 LWS_EXTERN const char *
1064 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);