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