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
  29 #include "config.h"
  30 #endif
  31 #endif
  32
  33 #if _MSC_VER > 1000 || defined(_WIN32)
  34 #else
  35 #include <unistd.h>
  36 #include <strings.h>
  37 #endif
  38 #include <stdio.h>
  39 #include <stdlib.h>
  40 #include <string.h>
  41 #include <ctype.h>
  42 #include <errno.h>
  43 #include <fcntl.h>
  44 #include <signal.h>
  45 #include <limits.h>
  46 #ifdef __MINGW64__
  47 #else
  48 #ifdef __MINGW32__
  49 #elif _MSC_VER > 1000 || defined(_WIN32)
  50 #else
  51 #include <netdb.h>
  52 #endif
  53 #endif
  54 #include <stdarg.h>
  55
  56 #include <sys/stat.h>
  57
  58 #if defined(WIN32) || defined(_WIN32)
  59 #define LWS_NO_DAEMONIZE
  60 #ifndef EWOULDBLOCK
  61 #define EWOULDBLOCK EAGAIN
  62 #endif
  63 #ifndef EALREADY
  64 #define EALREADY WSAEALREADY
  65 #endif
  66 #ifndef EINPROGRESS
  67 #define EINPROGRESS WSAEINPROGRESS
  68 #endif
  69 #ifndef EISCONN
  70 #define EISCONN WSAEISCONN
  71 #endif
  72
  73 #define compatible_close(fd) closesocket(fd);
  74 #ifdef __MINGW64__
  75 #else
  76 #ifdef __MINGW32__
  77 #else
  78 #include <time.h >
  79 #endif
  80 #endif
  81 #include <winsock2.h>
  82 #include <ws2ipdef.h>
  83 #include <windows.h>
  84 #else
  85 #include <sys/types.h>
  86 #include <sys/socket.h>
  87 #ifndef LWS_NO_FORK
  88 #ifdef HAVE_SYS_PRCTL_H
  89 #include <sys/prctl.h>
  90 #endif
  91 #endif
  92 #include <netinet/in.h>
  93 #include <netinet/tcp.h>
  94 #include <arpa/inet.h>
  95
  96 #include <poll.h>
  97 #include <sys/mman.h>
  98 #include <sys/time.h>
  99
 100 #define compatible_close(fd) close(fd);
 101 #endif
 102
 103 #ifdef LWS_OPENSSL_SUPPORT
 104 #ifdef USE_CYASSL
 105 #include <cyassl/openssl/ssl.h>
 106 #include <cyassl/error.h>
 107 unsigned char *
 108 SHA1(const unsigned char *d, size_t n, unsigned char *md);
 109 #else
 110 #include <openssl/ssl.h>
 111 #include <openssl/evp.h>
 112 #include <openssl/err.h>
 113 #include <openssl/md5.h>
 114 #include <openssl/sha.h>
 115 #endif /* not USE_CYASSL */
 116 #endif
 117
 118 #include "libwebsockets.h"
 119
 120 /*
 121  * Mac OSX as well as iOS do not define the MSG_NOSIGNAL flag,
 122  * but happily have something equivalent in the SO_NOSIGPIPE flag.
 123  */
 124 #ifdef __APPLE__
 125 #define MSG_NOSIGNAL SO_NOSIGPIPE
 126 #endif
 127
 128 #ifndef LWS_MAX_HEADER_LEN
 129 #define LWS_MAX_HEADER_LEN 1024
 130 #endif
 131 #ifndef LWS_MAX_PROTOCOLS
 132 #define LWS_MAX_PROTOCOLS 5
 133 #endif
 134 #ifndef LWS_MAX_EXTENSIONS_ACTIVE
 135 #define LWS_MAX_EXTENSIONS_ACTIVE 3
 136 #endif
 137 #ifndef SPEC_LATEST_SUPPORTED
 138 #define SPEC_LATEST_SUPPORTED 13
 139 #endif
 140 #ifndef AWAITING_TIMEOUT
 141 #define AWAITING_TIMEOUT 5
 142 #endif
 143 #ifndef CIPHERS_LIST_STRING
 144 #define CIPHERS_LIST_STRING "DEFAULT"
 145 #endif
 146 #ifndef LWS_SOMAXCONN
 147 #define LWS_SOMAXCONN SOMAXCONN
 148 #endif
 149
 150 #define MAX_WEBSOCKET_04_KEY_LEN 128
 151 #define LWS_MAX_SOCKET_IO_BUF 4096
 152
 153 #ifndef SYSTEM_RANDOM_FILEPATH
 154 #define SYSTEM_RANDOM_FILEPATH "/dev/urandom"
 155 #endif
 156 #ifndef LWS_MAX_ZLIB_CONN_BUFFER
 157 #define LWS_MAX_ZLIB_CONN_BUFFER (64 * 1024)
 158 #endif
 159
 160 /*
 161  * if not in a connection storm, check for incoming
 162  * connections this many normal connection services
 163  */
 164 #define LWS_LISTEN_SERVICE_MODULO 10
 165
 166 enum lws_websocket_opcodes_07 {
 167         LWS_WS_OPCODE_07__CONTINUATION = 0,
 168         LWS_WS_OPCODE_07__TEXT_FRAME = 1,
 169         LWS_WS_OPCODE_07__BINARY_FRAME = 2,
 170
 171         LWS_WS_OPCODE_07__NOSPEC__MUX = 7,
 172
 173         /* control extensions 8+ */
 174
 175         LWS_WS_OPCODE_07__CLOSE = 8,
 176         LWS_WS_OPCODE_07__PING = 9,
 177         LWS_WS_OPCODE_07__PONG = 0xa,
 178 };
 179
 180
 181 enum lws_connection_states {
 182         WSI_STATE_HTTP,
 183         WSI_STATE_HTTP_ISSUING_FILE,
 184         WSI_STATE_HTTP_HEADERS,
 185         WSI_STATE_DEAD_SOCKET,
 186         WSI_STATE_ESTABLISHED,
 187         WSI_STATE_CLIENT_UNCONNECTED,
 188         WSI_STATE_RETURNED_CLOSE_ALREADY,
 189         WSI_STATE_AWAITING_CLOSE_ACK,
 190 };
 191
 192 enum lws_rx_parse_state {
 193         LWS_RXPS_NEW,
 194
 195         LWS_RXPS_04_MASK_NONCE_1,
 196         LWS_RXPS_04_MASK_NONCE_2,
 197         LWS_RXPS_04_MASK_NONCE_3,
 198
 199         LWS_RXPS_04_FRAME_HDR_1,
 200         LWS_RXPS_04_FRAME_HDR_LEN,
 201         LWS_RXPS_04_FRAME_HDR_LEN16_2,
 202         LWS_RXPS_04_FRAME_HDR_LEN16_1,
 203         LWS_RXPS_04_FRAME_HDR_LEN64_8,
 204         LWS_RXPS_04_FRAME_HDR_LEN64_7,
 205         LWS_RXPS_04_FRAME_HDR_LEN64_6,
 206         LWS_RXPS_04_FRAME_HDR_LEN64_5,
 207         LWS_RXPS_04_FRAME_HDR_LEN64_4,
 208         LWS_RXPS_04_FRAME_HDR_LEN64_3,
 209         LWS_RXPS_04_FRAME_HDR_LEN64_2,
 210         LWS_RXPS_04_FRAME_HDR_LEN64_1,
 211
 212         LWS_RXPS_07_COLLECT_FRAME_KEY_1,
 213         LWS_RXPS_07_COLLECT_FRAME_KEY_2,
 214         LWS_RXPS_07_COLLECT_FRAME_KEY_3,
 215         LWS_RXPS_07_COLLECT_FRAME_KEY_4,
 216
 217         LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED
 218 };
 219
 220
 221 enum connection_mode {
 222         LWS_CONNMODE_HTTP_SERVING,
 223         LWS_CONNMODE_HTTP_SERVING_ACCEPTED, /* actual HTTP service going on */
 224         LWS_CONNMODE_PRE_WS_SERVING_ACCEPT,
 225
 226         LWS_CONNMODE_WS_SERVING,
 227         LWS_CONNMODE_WS_CLIENT,
 228
 229         /* transient, ssl delay hiding */
 230         LWS_CONNMODE_SSL_ACK_PENDING,
 231
 232         /* transient modes */
 233         LWS_CONNMODE_WS_CLIENT_WAITING_CONNECT,
 234         LWS_CONNMODE_WS_CLIENT_WAITING_PROXY_REPLY,
 235         LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE,
 236         LWS_CONNMODE_WS_CLIENT_WAITING_SSL,
 237         LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY,
 238         LWS_CONNMODE_WS_CLIENT_WAITING_EXTENSION_CONNECT,
 239         LWS_CONNMODE_WS_CLIENT_PENDING_CANDIDATE_CHILD,
 240
 241         /* special internal types */
 242         LWS_CONNMODE_SERVER_LISTENER,
 243 };
 244
 245 enum {
 246         LWS_RXFLOW_ALLOW = (1 << 0),
 247         LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
 248 };
 249
 250 struct libwebsocket_protocols;
 251 struct libwebsocket;
 252
 253 struct libwebsocket_context {
 254         struct pollfd *fds;
 255         struct libwebsocket **lws_lookup; /* fd to wsi */
 256         int fds_count;
 257         int max_fds;
 258         int listen_port;
 259         char http_proxy_address[128];
 260         char canonical_hostname[128];
 261         unsigned int http_proxy_port;
 262         unsigned int options;
 263         unsigned long last_timeout_check_s;
 264
 265         /*
 266          * usable by anything in the service code, but only if the scope
 267          * does not last longer than the service action (since next service
 268          * of any socket can likewise use it and overwrite)
 269          */
 270         unsigned char service_buffer[LWS_MAX_SOCKET_IO_BUF];
 271
 272         int started_with_parent;
 273
 274         int fd_random;
 275         int listen_service_modulo;
 276         int listen_service_count;
 277         int listen_service_fd;
 278         int listen_service_extraseen;
 279
 280         int ka_time;
 281         int ka_probes;
 282         int ka_interval;
 283
 284 #ifdef LWS_LATENCY
 285         unsigned long worst_latency;
 286         char worst_latency_info[256];
 287 #endif
 288
 289 #ifdef LWS_OPENSSL_SUPPORT
 290         int use_ssl;
 291         SSL_CTX *ssl_ctx;
 292         SSL_CTX *ssl_client_ctx;
 293 #endif
 294         struct libwebsocket_protocols *protocols;
 295         int count_protocols;
 296 #ifndef LWS_NO_EXTENSIONS
 297         struct libwebsocket_extension *extensions;
 298 #endif
 299         void *user_space;
 300 };
 301
 302
 303 /*
 304  * This is totally opaque to code using the library.  It's exported as a
 305  * forward-reference pointer-only declaration; the user can use the pointer with
 306  * other APIs to get information out of it.
 307  */
 308
 309 struct lws_fragments {
 310         unsigned short offset;
 311         unsigned short len;
 312         unsigned char next_frag_index;
 313 };
 314
 315 struct allocated_headers {
 316         unsigned short next_frag_index;
 317         unsigned short pos;
 318         unsigned char frag_index[WSI_TOKEN_COUNT];
 319         struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
 320         char data[LWS_MAX_HEADER_LEN];
 321 #ifndef LWS_NO_CLIENT
 322         char initial_handshake_hash_base64[30];
 323         unsigned short c_port;
 324 #endif
 325 };
 326
 327 struct _lws_http_mode_related {
 328         struct allocated_headers *ah; /* mirroring  _lws_header_related */
 329         int fd;
 330         unsigned long filepos;
 331         unsigned long filelen;
 332 };
 333
 334 struct _lws_header_related {
 335         struct allocated_headers *ah;
 336         short lextable_pos;
 337         unsigned char parser_state; /* enum lws_token_indexes */
 338 };
 339
 340 struct _lws_websocket_related {
 341         char *rx_user_buffer;
 342         int rx_user_buffer_head;
 343         unsigned char frame_masking_nonce_04[4];
 344         unsigned char frame_mask_index;
 345         size_t rx_packet_length;
 346         unsigned char opcode;
 347         unsigned int final:1;
 348         unsigned char rsv;
 349         unsigned int frame_is_binary:1;
 350         unsigned int all_zero_nonce:1;
 351         short close_reason; /* enum lws_close_status */
 352         unsigned char *rxflow_buffer;
 353         int rxflow_len;
 354         int rxflow_pos;
 355         unsigned int rxflow_change_to:2;
 356         unsigned int this_frame_masked:1;
 357         unsigned int inside_frame:1; /* next write will be more of frame */
 358         unsigned int clean_buffer:1; /* buffer not rewritten by extension */
 359         /* truncated send handling */
 360         unsigned char *truncated_send_malloc; /* non-NULL means buffering in progress */
 361         unsigned int truncated_send_offset; /* where we are in terms of spilling */
 362         unsigned int truncated_send_len; /* how much is buffered */
 363 };
 364
 365 struct libwebsocket {
 366
 367         /* lifetime members */
 368
 369         const struct libwebsocket_protocols *protocol;
 370 #ifndef LWS_NO_EXTENSIONS
 371         struct libwebsocket_extension *
 372                                    active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
 373         void *active_extensions_user[LWS_MAX_EXTENSIONS_ACTIVE];
 374         unsigned char count_active_extensions;
 375         unsigned int extension_data_pending:1;
 376 #endif
 377         unsigned char ietf_spec_revision;
 378
 379         char mode; /* enum connection_mode */
 380         char state; /* enum lws_connection_states */
 381         char lws_rx_parse_state; /* enum lws_rx_parse_state */
 382         char rx_frame_type; /* enum libwebsocket_write_protocol */
 383
 384         unsigned int hdr_parsing_completed:1;
 385
 386         char pending_timeout; /* enum pending_timeout */
 387         unsigned long pending_timeout_limit;
 388
 389         int sock;
 390         int position_in_fds_table;
 391 #ifdef LWS_LATENCY
 392         unsigned long action_start;
 393         unsigned long latency_start;
 394 #endif
 395
 396         void *user_space;
 397
 398         /* members with mutually exclusive lifetimes are unionized */
 399
 400         union u {
 401                 struct _lws_http_mode_related http;
 402                 struct _lws_header_related hdr;
 403                 struct _lws_websocket_related ws;
 404         } u;
 405
 406 #ifdef LWS_OPENSSL_SUPPORT
 407         SSL *ssl;
 408         BIO *client_bio;
 409         unsigned int use_ssl:2;
 410 #endif
 411 };
 412
 413 LWS_EXTERN void
 414 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
 415                                struct libwebsocket *wsi, enum lws_close_status);
 416
 417 #ifndef LWS_LATENCY
 418 static inline void lws_latency(struct libwebsocket_context *context,
 419                 struct libwebsocket *wsi, const char *action,
 420                                          int ret, int completion) { while (0); }
 421 static inline void lws_latency_pre(struct libwebsocket_context *context,
 422                                         struct libwebsocket *wsi) { while (0); }
 423 #else
 424 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
 425 extern void
 426 lws_latency(struct libwebsocket_context *context,
 427                         struct libwebsocket *wsi, const char *action,
 428                                                        int ret, int completion);
 429 #endif
 430
 431 LWS_EXTERN int
 432 libwebsocket_client_rx_sm(struct libwebsocket *wsi, unsigned char c);
 433
 434 LWS_EXTERN int
 435 libwebsocket_parse(struct libwebsocket *wsi, unsigned char c);
 436
 437 LWS_EXTERN int
 438 libwebsocket_interpret_incoming_packet(struct libwebsocket *wsi,
 439                                                 unsigned char *buf, size_t len);
 440
 441 LWS_EXTERN int
 442 lws_b64_selftest(void);
 443
 444 LWS_EXTERN struct libwebsocket *
 445 wsi_from_fd(struct libwebsocket_context *context, int fd);
 446
 447 LWS_EXTERN int
 448 insert_wsi_socket_into_fds(struct libwebsocket_context *context,
 449                                                       struct libwebsocket *wsi);
 450
 451 LWS_EXTERN int
 452 lws_issue_raw(struct libwebsocket *wsi, unsigned char *buf, size_t len);
 453
 454
 455 LWS_EXTERN int
 456 libwebsocket_service_timeout_check(struct libwebsocket_context *context,
 457                                     struct libwebsocket *wsi, unsigned int sec);
 458
 459 LWS_EXTERN struct libwebsocket *
 460 libwebsocket_client_connect_2(struct libwebsocket_context *context,
 461         struct libwebsocket *wsi);
 462
 463 LWS_EXTERN struct libwebsocket *
 464 libwebsocket_create_new_server_wsi(struct libwebsocket_context *context);
 465
 466 LWS_EXTERN char *
 467 libwebsockets_generate_client_handshake(struct libwebsocket_context *context,
 468                 struct libwebsocket *wsi, char *pkt);
 469
 470 LWS_EXTERN int
 471 lws_handle_POLLOUT_event(struct libwebsocket_context *context,
 472                               struct libwebsocket *wsi, struct pollfd *pollfd);
 473 #ifndef LWS_NO_EXTENSIONS
 474 LWS_EXTERN int
 475 lws_any_extension_handled(struct libwebsocket_context *context,
 476                           struct libwebsocket *wsi,
 477                           enum libwebsocket_extension_callback_reasons r,
 478                           void *v, size_t len);
 479
 480 LWS_EXTERN void *
 481 lws_get_extension_user_matching_ext(struct libwebsocket *wsi,
 482                           struct libwebsocket_extension *ext);
 483 #endif
 484
 485 LWS_EXTERN int
 486 lws_client_interpret_server_handshake(struct libwebsocket_context *context,
 487                 struct libwebsocket *wsi);
 488
 489 LWS_EXTERN int
 490 libwebsocket_rx_sm(struct libwebsocket *wsi, unsigned char c);
 491
 492 LWS_EXTERN int
 493 lws_issue_raw_ext_access(struct libwebsocket *wsi,
 494                                                 unsigned char *buf, size_t len);
 495
 496 LWS_EXTERN int
 497 _libwebsocket_rx_flow_control(struct libwebsocket *wsi);
 498
 499 LWS_EXTERN int
 500 user_callback_handle_rxflow(callback_function,
 501                 struct libwebsocket_context *context,
 502                         struct libwebsocket *wsi,
 503                          enum libwebsocket_callback_reasons reason, void *user,
 504                                                           void *in, size_t len);
 505
 506 LWS_EXTERN int
 507 lws_set_socket_options(struct libwebsocket_context *context, int fd);
 508
 509 LWS_EXTERN int
 510 lws_allocate_header_table(struct libwebsocket *wsi);
 511
 512 LWS_EXTERN char *
 513 lws_hdr_simple_ptr(struct libwebsocket *wsi, enum lws_token_indexes h);
 514
 515 LWS_EXTERN int
 516 lws_hdr_simple_create(struct libwebsocket *wsi,
 517                                 enum lws_token_indexes h, const char *s);
 518
 519 LWS_EXTERN int
 520 libwebsocket_ensure_user_space(struct libwebsocket *wsi);
 521
 522 #ifndef LWS_NO_SERVER
 523 LWS_EXTERN int handshake_0405(struct libwebsocket_context *context,
 524                                                       struct libwebsocket *wsi);
 525 #endif
 526
 527 #ifndef LWS_NO_DAEMONIZE
 528 LWS_EXTERN int get_daemonize_pid();
 529 #endif
 530
 531 extern int interface_to_sa(const char *ifname,
 532                       struct sockaddr_in *addr, size_t addrlen);
 533
 534 #ifndef LWS_OPENSSL_SUPPORT
 535
 536 unsigned char *
 537 SHA1(const unsigned char *d, size_t n, unsigned char *md);
 538
 539 #else
 540
 541 LWS_EXTERN int openssl_websocket_private_data_index;
 542
 543 #endif