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