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 #ifndef EWOULDBLOCK
  61 #define EWOULDBLOCK EAGAIN
  62 #endif
  63
  64 #define compatible_close(fd) closesocket(fd);
  65 #ifdef __MINGW64__
  66 #else
  67 #ifdef __MINGW32__
  68 #else
  69 #include <time.h >
  70 #endif
  71 #endif
  72 #include <winsock2.h>
  73 #include <ws2ipdef.h>
  74 #include <windows.h>
  75 #else
  76 #include <sys/types.h>
  77 #include <sys/socket.h>
  78 #ifndef LWS_NO_FORK
  79 #ifdef HAVE_SYS_PRCTL_H
  80 #include <sys/prctl.h>
  81 #endif
  82 #endif
  83 #include <netinet/in.h>
  84 #include <netinet/tcp.h>
  85 #include <arpa/inet.h>
  86
  87 #include <poll.h>
  88 #include <sys/mman.h>
  89 #include <sys/time.h>
  90
  91 #define compatible_close(fd) close(fd);
  92 #endif
  93
  94 #ifdef LWS_OPENSSL_SUPPORT
  95 #ifdef USE_CYASSL
  96 #include <cyassl/openssl/ssl.h>
  97 #include <cyassl/error.h>
  98 unsigned char *
  99 SHA1(const unsigned char *d, size_t n, unsigned char *md);
 100 #else
 101 #include <openssl/ssl.h>
 102 #include <openssl/evp.h>
 103 #include <openssl/err.h>
 104 #include <openssl/md5.h>
 105 #include <openssl/sha.h>
 106 #endif /* not USE_CYASSL */
 107 #endif
 108
 109 #include "libwebsockets.h"
 110
 111 /*
 112  * Mac OSX as well as iOS do not define the MSG_NOSIGNAL flag,
 113  * but happily have something equivalent in the SO_NOSIGPIPE flag.
 114  */
 115 #ifdef __APPLE__
 116 #define MSG_NOSIGNAL SO_NOSIGPIPE
 117 #endif
 118
 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         LWS_CONNMODE_HTTP_SERVING_ACCEPTED, /* actual HTTP service going on */
 215         LWS_CONNMODE_PRE_WS_SERVING_ACCEPT,
 216
 217         LWS_CONNMODE_WS_SERVING,
 218         LWS_CONNMODE_WS_CLIENT,
 219
 220         /* transient, ssl delay hiding */
 221         LWS_CONNMODE_SSL_ACK_PENDING,
 222
 223         /* transient modes */
 224         LWS_CONNMODE_WS_CLIENT_WAITING_CONNECT,
 225         LWS_CONNMODE_WS_CLIENT_WAITING_PROXY_REPLY,
 226         LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE,
 227         LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY,
 228         LWS_CONNMODE_WS_CLIENT_WAITING_EXTENSION_CONNECT,
 229         LWS_CONNMODE_WS_CLIENT_PENDING_CANDIDATE_CHILD,
 230
 231         /* special internal types */
 232         LWS_CONNMODE_SERVER_LISTENER,
 233 };
 234
 235 enum {
 236         LWS_RXFLOW_ALLOW = (1 << 0),
 237         LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
 238 };
 239
 240 struct libwebsocket_protocols;
 241 struct libwebsocket;
 242
 243 struct libwebsocket_context {
 244         struct pollfd *fds;
 245         struct libwebsocket **lws_lookup; /* fd to wsi */
 246         int fds_count;
 247         int max_fds;
 248         int listen_port;
 249         char http_proxy_address[128];
 250         char canonical_hostname[128];
 251         unsigned int http_proxy_port;
 252         unsigned int options;
 253         unsigned long last_timeout_check_s;
 254
 255         /*
 256          * usable by anything in the service code, but only if the scope
 257          * does not last longer than the service action (since next service
 258          * of any socket can likewise use it and overwrite)
 259          */
 260         unsigned char service_buffer[LWS_MAX_SOCKET_IO_BUF];
 261
 262         int started_with_parent;
 263
 264         int fd_random;
 265         int listen_service_modulo;
 266         int listen_service_count;
 267         int listen_service_fd;
 268         int listen_service_extraseen;
 269
 270         int ka_time;
 271         int ka_probes;
 272         int ka_interval;
 273
 274 #ifdef LWS_LATENCY
 275         unsigned long worst_latency;
 276         char worst_latency_info[256];
 277 #endif
 278
 279 #ifdef LWS_OPENSSL_SUPPORT
 280         int use_ssl;
 281         SSL_CTX *ssl_ctx;
 282         SSL_CTX *ssl_client_ctx;
 283 #endif
 284         struct libwebsocket_protocols *protocols;
 285         int count_protocols;
 286 #ifndef LWS_NO_EXTENSIONS
 287         struct libwebsocket_extension *extensions;
 288 #endif
 289         void *user_space;
 290 };
 291
 292
 293 /*
 294  * This is totally opaque to code using the library.  It's exported as a
 295  * forward-reference pointer-only declaration; the user can use the pointer with
 296  * other APIs to get information out of it.
 297  */
 298
 299 struct _lws_http_mode_related {
 300         int fd;
 301         unsigned long filepos;
 302         unsigned long filelen;
 303 };
 304
 305 struct lws_fragments {
 306         unsigned short offset;
 307         unsigned short len;
 308         unsigned char next_frag_index;
 309 };
 310
 311 struct allocated_headers {
 312         unsigned short next_frag_index;
 313         unsigned short pos;
 314         unsigned char frag_index[WSI_TOKEN_COUNT];
 315         struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
 316         char data[LWS_MAX_HEADER_LEN];
 317 #ifndef LWS_NO_CLIENT
 318         char initial_handshake_hash_base64[30];
 319         unsigned short c_port;
 320 #endif
 321 };
 322
 323 struct _lws_header_related {
 324         struct allocated_headers *ah;
 325         short lextable_pos;
 326         unsigned char parser_state; /* enum lws_token_indexes */
 327 };
 328
 329 struct _lws_websocket_related {
 330         char *rx_user_buffer;
 331         int rx_user_buffer_head;
 332         unsigned char frame_masking_nonce_04[4];
 333         unsigned char frame_mask_index;
 334         size_t rx_packet_length;
 335         unsigned char opcode;
 336         unsigned int final:1;
 337         unsigned char rsv;
 338         unsigned int frame_is_binary:1;
 339         unsigned int all_zero_nonce:1;
 340         short close_reason; /* enum lws_close_status */
 341         unsigned char *rxflow_buffer;
 342         int rxflow_len;
 343         int rxflow_pos;
 344         unsigned int rxflow_change_to:2;
 345         unsigned int this_frame_masked:1;
 346 };
 347
 348 struct libwebsocket {
 349
 350         /* lifetime members */
 351
 352         const struct libwebsocket_protocols *protocol;
 353 #ifndef LWS_NO_EXTENSIONS
 354         struct libwebsocket_extension *
 355                                    active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
 356         void *active_extensions_user[LWS_MAX_EXTENSIONS_ACTIVE];
 357         unsigned char count_active_extensions;
 358         unsigned int extension_data_pending:1;
 359 #endif
 360         unsigned char ietf_spec_revision;
 361
 362         char mode; /* enum connection_mode */
 363         char state; /* enum lws_connection_states */
 364         char lws_rx_parse_state; /* enum lws_rx_parse_state */
 365         char rx_frame_type; /* enum libwebsocket_write_protocol */
 366
 367         unsigned int hdr_parsing_completed:1;
 368
 369         char pending_timeout; /* enum pending_timeout */
 370         unsigned long pending_timeout_limit;
 371
 372         int sock;
 373         int position_in_fds_table;
 374 #ifdef LWS_LATENCY
 375         unsigned long action_start;
 376         unsigned long latency_start;
 377 #endif
 378
 379         void *user_space;
 380
 381         /* members with mutually exclusive lifetimes are unionized */
 382
 383         union u {
 384                 struct _lws_http_mode_related http;
 385                 struct _lws_header_related hdr;
 386                 struct _lws_websocket_related ws;
 387         } u;
 388
 389 #ifdef LWS_OPENSSL_SUPPORT
 390         SSL *ssl;
 391         BIO *client_bio;
 392         unsigned int use_ssl:2;
 393 #endif
 394 };
 395
 396 LWS_EXTERN void
 397 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
 398                                struct libwebsocket *wsi, enum lws_close_status);
 399
 400 #ifndef LWS_LATENCY
 401 static inline void lws_latency(struct libwebsocket_context *context,
 402                 struct libwebsocket *wsi, const char *action,
 403                                          int ret, int completion) { while (0); }
 404 static inline void lws_latency_pre(struct libwebsocket_context *context,
 405                                         struct libwebsocket *wsi) { while (0); }
 406 #else
 407 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
 408 extern void
 409 lws_latency(struct libwebsocket_context *context,
 410                         struct libwebsocket *wsi, const char *action,
 411                                                        int ret, int completion);
 412 #endif
 413
 414 LWS_EXTERN int
 415 libwebsocket_client_rx_sm(struct libwebsocket *wsi, unsigned char c);
 416
 417 LWS_EXTERN int
 418 libwebsocket_parse(struct libwebsocket *wsi, unsigned char c);
 419
 420 LWS_EXTERN int
 421 libwebsocket_interpret_incoming_packet(struct libwebsocket *wsi,
 422                                                 unsigned char *buf, size_t len);
 423
 424 LWS_EXTERN int
 425 lws_b64_selftest(void);
 426
 427 LWS_EXTERN struct libwebsocket *
 428 wsi_from_fd(struct libwebsocket_context *context, int fd);
 429
 430 LWS_EXTERN int
 431 insert_wsi_socket_into_fds(struct libwebsocket_context *context,
 432                                                       struct libwebsocket *wsi);
 433
 434 LWS_EXTERN int
 435 lws_issue_raw(struct libwebsocket *wsi, unsigned char *buf, size_t len);
 436
 437
 438 LWS_EXTERN int
 439 libwebsocket_service_timeout_check(struct libwebsocket_context *context,
 440                                     struct libwebsocket *wsi, unsigned int sec);
 441
 442 LWS_EXTERN struct libwebsocket *
 443 __libwebsocket_client_connect_2(struct libwebsocket_context *context,
 444         struct libwebsocket *wsi);
 445
 446 LWS_EXTERN struct libwebsocket *
 447 libwebsocket_create_new_server_wsi(struct libwebsocket_context *context);
 448
 449 LWS_EXTERN char *
 450 libwebsockets_generate_client_handshake(struct libwebsocket_context *context,
 451                 struct libwebsocket *wsi, char *pkt);
 452
 453 LWS_EXTERN int
 454 lws_handle_POLLOUT_event(struct libwebsocket_context *context,
 455                               struct libwebsocket *wsi, struct pollfd *pollfd);
 456 #ifndef LWS_NO_EXTENSIONS
 457 LWS_EXTERN int
 458 lws_any_extension_handled(struct libwebsocket_context *context,
 459                           struct libwebsocket *wsi,
 460                           enum libwebsocket_extension_callback_reasons r,
 461                           void *v, size_t len);
 462
 463 LWS_EXTERN void *
 464 lws_get_extension_user_matching_ext(struct libwebsocket *wsi,
 465                           struct libwebsocket_extension *ext);
 466 #endif
 467
 468 LWS_EXTERN int
 469 lws_client_interpret_server_handshake(struct libwebsocket_context *context,
 470                 struct libwebsocket *wsi);
 471
 472 LWS_EXTERN int
 473 libwebsocket_rx_sm(struct libwebsocket *wsi, unsigned char c);
 474
 475 LWS_EXTERN int
 476 lws_issue_raw_ext_access(struct libwebsocket *wsi,
 477                                                 unsigned char *buf, size_t len);
 478
 479 LWS_EXTERN int
 480 _libwebsocket_rx_flow_control(struct libwebsocket *wsi);
 481
 482 LWS_EXTERN int
 483 user_callback_handle_rxflow(callback_function,
 484                 struct libwebsocket_context *context,
 485                         struct libwebsocket *wsi,
 486                          enum libwebsocket_callback_reasons reason, void *user,
 487                                                           void *in, size_t len);
 488
 489 LWS_EXTERN int
 490 lws_set_socket_options(struct libwebsocket_context *context, int fd);
 491
 492 LWS_EXTERN int
 493 lws_allocate_header_table(struct libwebsocket *wsi);
 494
 495 LWS_EXTERN char *
 496 lws_hdr_simple_ptr(struct libwebsocket *wsi, enum lws_token_indexes h);
 497
 498 LWS_EXTERN int
 499 lws_hdr_simple_create(struct libwebsocket *wsi,
 500                                 enum lws_token_indexes h, const char *s);
 501
 502 LWS_EXTERN int
 503 libwebsocket_ensure_user_space(struct libwebsocket *wsi);
 504
 505 #ifndef LWS_NO_SERVER
 506 LWS_EXTERN int handshake_0405(struct libwebsocket_context *context,
 507                                                       struct libwebsocket *wsi);
 508 #endif
 509
 510 #ifndef LWS_NO_DAEMONIZE
 511 LWS_EXTERN int get_daemonize_pid();
 512 #endif
 513
 514 extern int interface_to_sa(const char *ifname,
 515                       struct sockaddr_in *addr, size_t addrlen);
 516
 517 #ifndef LWS_OPENSSL_SUPPORT
 518
 519 unsigned char *
 520 SHA1(const unsigned char *d, size_t n, unsigned char *md);
 521
 522 #else
 523
 524 LWS_EXTERN int openssl_websocket_private_data_index;
 525
 526 #endif