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