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