2 * libwebsockets - small server side websockets and web server implementation
4 * Copyright (C) 2010 - 2013 Andy Green <andy@warmcat.com>
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.
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.
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,
22 /* System introspection configs */
24 #include "lws_config.h"
26 #if defined(WIN32) || defined(_WIN32)
27 #define inline __inline
31 #define vsnprintf _vsnprintf
37 #endif /* not WIN32 */
38 #endif /* not CMAKE */
40 #ifdef HAVE_SYS_TYPES_H
41 #include <sys/types.h>
52 #ifdef HAVE_SYS_STAT_H
56 #if defined(WIN32) || defined(_WIN32)
57 #define LWS_NO_DAEMONIZE
58 #define LWS_ERRNO WSAGetLastError()
59 #define LWS_EAGAIN WSAEWOULDBLOCK
60 #define LWS_EALREADY WSAEALREADY
61 #define LWS_EINPROGRESS WSAEINPROGRESS
62 #define LWS_EINTR WSAEINTR
63 #define LWS_EISCONN WSAEISCONN
64 #define LWS_EWOULDBLOCK WSAEWOULDBLOCK
65 #define LWS_POLLHUP (FD_CLOSE)
66 #define LWS_POLLIN (FD_READ | FD_ACCEPT)
67 #define LWS_POLLOUT (FD_WRITE)
68 #define MSG_NOSIGNAL 0
69 #define SHUT_RDWR SD_BOTH
70 #define SOL_TCP IPPROTO_TCP
72 #define compatible_close(fd) closesocket(fd)
73 #define compatible_file_close(fd) CloseHandle(fd)
74 #define compatible_file_seek_cur(fd, offset) SetFilePointer(fd, offset, FILE_CURRENT)
75 #define compatible_file_read(amount, fd, buf, len) {\
77 if (!ReadFile(fd, buf, len, &amount, NULL)) \
82 #define lws_set_blocking_send(wsi) wsi->sock_send_blocking = TRUE
85 #define LWS_INVALID_FILE INVALID_HANDLE_VALUE
86 const char *inet_ntop(int af, const void *src, char *dst, int cnt);
87 #else /* not windows --> */
94 #include <sys/types.h>
95 #include <sys/socket.h>
96 #ifdef LWS_BUILTIN_GETIFADDRS
97 #include <getifaddrs.h>
101 #include <sys/syslog.h>
103 #include <sys/socket.h>
106 #ifdef HAVE_SYS_PRCTL_H
107 #include <sys/prctl.h>
110 #include <netinet/in.h>
111 #include <netinet/tcp.h>
112 #include <arpa/inet.h>
116 #endif /* LWS_USE_LIBEV */
118 #include <sys/mman.h>
119 #include <sys/time.h>
121 #define LWS_ERRNO errno
122 #define LWS_EAGAIN EAGAIN
123 #define LWS_EALREADY EALREADY
124 #define LWS_EINPROGRESS EINPROGRESS
125 #define LWS_EINTR EINTR
126 #define LWS_EISCONN EISCONN
127 #define LWS_EWOULDBLOCK EWOULDBLOCK
128 #define LWS_INVALID_FILE -1
129 #define LWS_POLLHUP (POLLHUP|POLLERR)
130 #define LWS_POLLIN (POLLIN)
131 #define LWS_POLLOUT (POLLOUT)
132 #define compatible_close(fd) close(fd)
133 #define compatible_file_close(fd) close(fd)
134 #define compatible_file_seek_cur(fd, offset) lseek(fd, offset, SEEK_CUR)
135 #define compatible_file_read(amount, fd, buf, len) \
136 amount = read(fd, buf, len);
137 #define lws_set_blocking_send(wsi)
141 #define bzero(b, len) (memset((b), '\0', (len)), (void) 0)
144 #ifndef HAVE_STRERROR
145 #define strerror(x) ""
148 #ifdef LWS_OPENSSL_SUPPORT
150 #include <cyassl/openssl/ssl.h>
151 #include <cyassl/error.h>
153 SHA1(const unsigned char *d, size_t n, unsigned char *md);
155 #include <openssl/ssl.h>
156 #include <openssl/evp.h>
157 #include <openssl/err.h>
158 #include <openssl/md5.h>
159 #include <openssl/sha.h>
160 #endif /* not USE_CYASSL */
163 #include "libwebsockets.h"
165 #if defined(WIN32) || defined(_WIN32)
168 #define BIG_ENDIAN 4321 /* to show byte order (taken from gcc) */
170 #ifndef LITTLE_ENDIAN
171 #define LITTLE_ENDIAN 1234
174 #define BYTE_ORDER LITTLE_ENDIAN
176 typedef unsigned __int64 u_int64_t;
181 #define __P(protos) protos
183 #define __P(protos) ()
189 #include <sys/stat.h>
190 #include <sys/cdefs.h>
191 #include <sys/time.h>
193 #if defined(__APPLE__)
194 #include <machine/endian.h>
195 #elif defined(__FreeBSD__)
196 #include <sys/endian.h>
197 #elif defined(__linux__)
201 #if !defined(BYTE_ORDER)
202 # define BYTE_ORDER __BYTE_ORDER
204 #if !defined(LITTLE_ENDIAN)
205 # define LITTLE_ENDIAN __LITTLE_ENDIAN
207 #if !defined(BIG_ENDIAN)
208 # define BIG_ENDIAN __BIG_ENDIAN
214 * Mac OSX as well as iOS do not define the MSG_NOSIGNAL flag,
215 * but happily have something equivalent in the SO_NOSIGPIPE flag.
218 #define MSG_NOSIGNAL SO_NOSIGPIPE
221 #ifndef LWS_MAX_HEADER_LEN
222 #define LWS_MAX_HEADER_LEN 1024
224 #ifndef LWS_MAX_PROTOCOLS
225 #define LWS_MAX_PROTOCOLS 5
227 #ifndef LWS_MAX_EXTENSIONS_ACTIVE
228 #define LWS_MAX_EXTENSIONS_ACTIVE 3
230 #ifndef SPEC_LATEST_SUPPORTED
231 #define SPEC_LATEST_SUPPORTED 13
233 #ifndef AWAITING_TIMEOUT
234 #define AWAITING_TIMEOUT 5
236 #ifndef CIPHERS_LIST_STRING
237 #define CIPHERS_LIST_STRING "DEFAULT"
239 #ifndef LWS_SOMAXCONN
240 #define LWS_SOMAXCONN SOMAXCONN
243 #define MAX_WEBSOCKET_04_KEY_LEN 128
244 #define LWS_MAX_SOCKET_IO_BUF 4096
246 #ifndef SYSTEM_RANDOM_FILEPATH
247 #define SYSTEM_RANDOM_FILEPATH "/dev/urandom"
249 #ifndef LWS_MAX_ZLIB_CONN_BUFFER
250 #define LWS_MAX_ZLIB_CONN_BUFFER (64 * 1024)
254 * if not in a connection storm, check for incoming
255 * connections this many normal connection services
257 #define LWS_LISTEN_SERVICE_MODULO 10
259 enum lws_websocket_opcodes_07 {
260 LWS_WS_OPCODE_07__CONTINUATION = 0,
261 LWS_WS_OPCODE_07__TEXT_FRAME = 1,
262 LWS_WS_OPCODE_07__BINARY_FRAME = 2,
264 LWS_WS_OPCODE_07__NOSPEC__MUX = 7,
266 /* control extensions 8+ */
268 LWS_WS_OPCODE_07__CLOSE = 8,
269 LWS_WS_OPCODE_07__PING = 9,
270 LWS_WS_OPCODE_07__PONG = 0xa,
274 enum lws_connection_states {
276 WSI_STATE_HTTP_ISSUING_FILE,
277 WSI_STATE_HTTP_HEADERS,
279 WSI_STATE_DEAD_SOCKET,
280 WSI_STATE_ESTABLISHED,
281 WSI_STATE_CLIENT_UNCONNECTED,
282 WSI_STATE_RETURNED_CLOSE_ALREADY,
283 WSI_STATE_AWAITING_CLOSE_ACK,
286 enum lws_rx_parse_state {
289 LWS_RXPS_04_MASK_NONCE_1,
290 LWS_RXPS_04_MASK_NONCE_2,
291 LWS_RXPS_04_MASK_NONCE_3,
293 LWS_RXPS_04_FRAME_HDR_1,
294 LWS_RXPS_04_FRAME_HDR_LEN,
295 LWS_RXPS_04_FRAME_HDR_LEN16_2,
296 LWS_RXPS_04_FRAME_HDR_LEN16_1,
297 LWS_RXPS_04_FRAME_HDR_LEN64_8,
298 LWS_RXPS_04_FRAME_HDR_LEN64_7,
299 LWS_RXPS_04_FRAME_HDR_LEN64_6,
300 LWS_RXPS_04_FRAME_HDR_LEN64_5,
301 LWS_RXPS_04_FRAME_HDR_LEN64_4,
302 LWS_RXPS_04_FRAME_HDR_LEN64_3,
303 LWS_RXPS_04_FRAME_HDR_LEN64_2,
304 LWS_RXPS_04_FRAME_HDR_LEN64_1,
306 LWS_RXPS_07_COLLECT_FRAME_KEY_1,
307 LWS_RXPS_07_COLLECT_FRAME_KEY_2,
308 LWS_RXPS_07_COLLECT_FRAME_KEY_3,
309 LWS_RXPS_07_COLLECT_FRAME_KEY_4,
311 LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED
315 enum connection_mode {
316 LWS_CONNMODE_HTTP_SERVING,
317 LWS_CONNMODE_HTTP_SERVING_ACCEPTED, /* actual HTTP service going on */
318 LWS_CONNMODE_PRE_WS_SERVING_ACCEPT,
320 LWS_CONNMODE_WS_SERVING,
321 LWS_CONNMODE_WS_CLIENT,
323 /* transient, ssl delay hiding */
324 LWS_CONNMODE_SSL_ACK_PENDING,
326 /* transient modes */
327 LWS_CONNMODE_WS_CLIENT_WAITING_CONNECT,
328 LWS_CONNMODE_WS_CLIENT_WAITING_PROXY_REPLY,
329 LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE,
330 LWS_CONNMODE_WS_CLIENT_WAITING_SSL,
331 LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY,
332 LWS_CONNMODE_WS_CLIENT_WAITING_EXTENSION_CONNECT,
333 LWS_CONNMODE_WS_CLIENT_PENDING_CANDIDATE_CHILD,
335 /* special internal types */
336 LWS_CONNMODE_SERVER_LISTENER,
340 LWS_RXFLOW_ALLOW = (1 << 0),
341 LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
344 struct libwebsocket_protocols;
348 struct lws_io_watcher {
349 struct ev_io watcher;
350 struct libwebsocket_context* context;
353 struct lws_signal_watcher {
354 struct ev_signal watcher;
355 struct libwebsocket_context* context;
357 #endif /* LWS_USE_LIBEV */
359 struct libwebsocket_context {
363 struct libwebsocket_pollfd *fds;
364 struct libwebsocket **lws_lookup; /* fd to wsi */
367 struct ev_loop* io_loop;
368 struct lws_io_watcher w_accept;
369 struct lws_signal_watcher w_sigint;
370 #endif /* LWS_USE_LIBEV */
374 char http_proxy_address[128];
375 char canonical_hostname[128];
376 unsigned int http_proxy_port;
377 unsigned int options;
378 time_t last_timeout_check_s;
381 * usable by anything in the service code, but only if the scope
382 * does not last longer than the service action (since next service
383 * of any socket can likewise use it and overwrite)
385 unsigned char service_buffer[LWS_MAX_SOCKET_IO_BUF];
387 int started_with_parent;
390 int listen_service_modulo;
391 int listen_service_count;
392 int listen_service_fd;
393 int listen_service_extraseen;
396 * set to the Thread ID that's doing the service loop just before entry
397 * to poll indicates service thread likely idling in poll()
398 * volatile because other threads may check it as part of processing
399 * for pollfd event change.
401 volatile int service_tid;
403 int dummy_pipe_fds[2];
411 unsigned long worst_latency;
412 char worst_latency_info[256];
415 #ifdef LWS_OPENSSL_SUPPORT
417 int allow_non_ssl_on_ssl_port;
419 SSL_CTX *ssl_client_ctx;
421 struct libwebsocket_protocols *protocols;
423 #ifndef LWS_NO_EXTENSIONS
424 struct libwebsocket_extension *extensions;
430 #define LWS_LIBEV_ENABLED(context) (context->options & LWS_SERVER_OPTION_LIBEV)
432 #define LWS_LIBEV_ENABLED(context) (0)
436 #define LWS_IPV6_ENABLED(context) (!(context->options & LWS_SERVER_OPTION_DISABLE_IPV6))
438 #define LWS_IPV6_ENABLED(context) (0)
441 enum uri_path_states {
444 URIPS_SEEN_SLASH_DOT,
445 URIPS_SEEN_SLASH_DOT_DOT,
449 enum uri_esc_states {
452 URIES_SEEN_PERCENT_H1,
456 * This is totally opaque to code using the library. It's exported as a
457 * forward-reference pointer-only declaration; the user can use the pointer with
458 * other APIs to get information out of it.
461 struct lws_fragments {
462 unsigned short offset;
464 unsigned char next_frag_index;
467 struct allocated_headers {
468 unsigned short next_frag_index;
470 unsigned char frag_index[WSI_TOKEN_COUNT];
471 struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
472 char data[LWS_MAX_HEADER_LEN];
473 #ifndef LWS_NO_CLIENT
474 char initial_handshake_hash_base64[30];
475 unsigned short c_port;
479 struct _lws_http_mode_related {
480 struct allocated_headers *ah; /* mirroring _lws_header_related */
481 #if defined(WIN32) || defined(_WIN32)
486 unsigned long filepos;
487 unsigned long filelen;
490 int content_length_seen;
492 unsigned char *post_buffer;
495 struct _lws_header_related {
496 struct allocated_headers *ah;
498 unsigned char parser_state; /* enum lws_token_indexes */
499 enum uri_path_states ups;
500 enum uri_esc_states ues;
504 struct _lws_websocket_related {
505 char *rx_user_buffer;
506 int rx_user_buffer_head;
507 unsigned char frame_masking_nonce_04[4];
508 unsigned char frame_mask_index;
509 size_t rx_packet_length;
510 unsigned char opcode;
511 unsigned int final:1;
513 unsigned int frame_is_binary:1;
514 unsigned int all_zero_nonce:1;
515 short close_reason; /* enum lws_close_status */
516 unsigned char *rxflow_buffer;
519 unsigned int rxflow_change_to:2;
520 unsigned int this_frame_masked:1;
521 unsigned int inside_frame:1; /* next write will be more of frame */
522 unsigned int clean_buffer:1; /* buffer not rewritten by extension */
525 struct libwebsocket {
527 /* lifetime members */
530 struct lws_io_watcher w_read;
531 struct lws_io_watcher w_write;
532 #endif /* LWS_USE_LIBEV */
533 const struct libwebsocket_protocols *protocol;
534 #ifndef LWS_NO_EXTENSIONS
535 struct libwebsocket_extension *
536 active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
537 void *active_extensions_user[LWS_MAX_EXTENSIONS_ACTIVE];
538 unsigned char count_active_extensions;
539 unsigned int extension_data_pending:1;
541 unsigned char ietf_spec_revision;
543 char mode; /* enum connection_mode */
544 char state; /* enum lws_connection_states */
545 char lws_rx_parse_state; /* enum lws_rx_parse_state */
546 char rx_frame_type; /* enum libwebsocket_write_protocol */
548 unsigned int hdr_parsing_completed:1;
550 char pending_timeout; /* enum pending_timeout */
551 time_t pending_timeout_limit;
554 int position_in_fds_table;
556 unsigned long action_start;
557 unsigned long latency_start;
560 /* truncated send handling */
561 unsigned char *truncated_send_malloc; /* non-NULL means buffering in progress */
562 unsigned int truncated_send_allocation; /* size of malloc */
563 unsigned int truncated_send_offset; /* where we are in terms of spilling */
564 unsigned int truncated_send_len; /* how much is buffered */
568 /* members with mutually exclusive lifetimes are unionized */
571 struct _lws_http_mode_related http;
572 struct _lws_header_related hdr;
573 struct _lws_websocket_related ws;
576 #ifdef LWS_OPENSSL_SUPPORT
579 unsigned int use_ssl:2;
583 BOOL sock_send_blocking;
587 LWS_EXTERN int log_level;
590 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
591 struct libwebsocket *wsi, enum lws_close_status);
594 remove_wsi_socket_from_fds(struct libwebsocket_context *context,
595 struct libwebsocket *wsi);
598 static inline void lws_latency(struct libwebsocket_context *context,
599 struct libwebsocket *wsi, const char *action,
600 int ret, int completion) { while (0); }
601 static inline void lws_latency_pre(struct libwebsocket_context *context,
602 struct libwebsocket *wsi) { while (0); }
604 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
606 lws_latency(struct libwebsocket_context *context,
607 struct libwebsocket *wsi, const char *action,
608 int ret, int completion);
612 libwebsocket_client_rx_sm(struct libwebsocket *wsi, unsigned char c);
615 libwebsocket_parse(struct libwebsocket *wsi, unsigned char c);
618 libwebsocket_interpret_incoming_packet(struct libwebsocket *wsi,
619 unsigned char *buf, size_t len);
622 lws_b64_selftest(void);
624 LWS_EXTERN struct libwebsocket *
625 wsi_from_fd(struct libwebsocket_context *context, int fd);
628 insert_wsi_socket_into_fds(struct libwebsocket_context *context,
629 struct libwebsocket *wsi);
632 lws_issue_raw(struct libwebsocket *wsi, unsigned char *buf, size_t len);
636 libwebsocket_service_timeout_check(struct libwebsocket_context *context,
637 struct libwebsocket *wsi, unsigned int sec);
639 LWS_EXTERN struct libwebsocket *
640 libwebsocket_client_connect_2(struct libwebsocket_context *context,
641 struct libwebsocket *wsi);
643 LWS_EXTERN struct libwebsocket *
644 libwebsocket_create_new_server_wsi(struct libwebsocket_context *context);
647 libwebsockets_generate_client_handshake(struct libwebsocket_context *context,
648 struct libwebsocket *wsi, char *pkt);
651 lws_handle_POLLOUT_event(struct libwebsocket_context *context,
652 struct libwebsocket *wsi, struct libwebsocket_pollfd *pollfd);
653 #ifndef LWS_NO_EXTENSIONS
655 lws_any_extension_handled(struct libwebsocket_context *context,
656 struct libwebsocket *wsi,
657 enum libwebsocket_extension_callback_reasons r,
658 void *v, size_t len);
661 lws_ext_callback_for_each_active(struct libwebsocket *wsi, int reason,
664 lws_ext_callback_for_each_extension_type(
665 struct libwebsocket_context *context, struct libwebsocket *wsi,
666 int reason, void *arg, int len);
668 #define lws_any_extension_handled(_a, _b, _c, _d, _e) (0)
669 #define lws_ext_callback_for_each_active(_a, _b, _c, _d) (0)
670 #define lws_ext_callback_for_each_extension_type(_a, _b, _c, _d, _e) (0)
674 lws_client_interpret_server_handshake(struct libwebsocket_context *context,
675 struct libwebsocket *wsi);
678 libwebsocket_rx_sm(struct libwebsocket *wsi, unsigned char c);
681 lws_issue_raw_ext_access(struct libwebsocket *wsi,
682 unsigned char *buf, size_t len);
685 _libwebsocket_rx_flow_control(struct libwebsocket *wsi);
688 user_callback_handle_rxflow(callback_function,
689 struct libwebsocket_context *context,
690 struct libwebsocket *wsi,
691 enum libwebsocket_callback_reasons reason, void *user,
692 void *in, size_t len);
695 lws_plat_set_socket_options(struct libwebsocket_context *context, int fd);
698 lws_allocate_header_table(struct libwebsocket *wsi);
701 lws_hdr_simple_ptr(struct libwebsocket *wsi, enum lws_token_indexes h);
704 lws_hdr_simple_create(struct libwebsocket *wsi,
705 enum lws_token_indexes h, const char *s);
708 libwebsocket_ensure_user_space(struct libwebsocket *wsi);
711 lws_change_pollfd(struct libwebsocket *wsi, int _and, int _or);
713 #ifndef LWS_NO_SERVER
714 int lws_context_init_server(struct lws_context_creation_info *info,
715 struct libwebsocket_context *context);
716 LWS_EXTERN int handshake_0405(struct libwebsocket_context *context,
717 struct libwebsocket *wsi);
719 #define lws_context_init_server(_a, _b) (0)
722 #ifndef LWS_NO_DAEMONIZE
723 LWS_EXTERN int get_daemonize_pid();
726 LWS_EXTERN int interface_to_sa(struct libwebsocket_context *context,
727 const char *ifname, struct sockaddr_in *addr, size_t addrlen);
730 LWS_EXTERN HANDLE lws_plat_open_file(const char* filename, unsigned long* filelen);
732 LWS_EXTERN int lws_plat_open_file(const char* filename, unsigned long* filelen);
735 #ifndef LWS_OPENSSL_SUPPORT
738 SHA1(const unsigned char *d, size_t n, unsigned char *md);
742 LWS_EXTERN int openssl_websocket_private_data_index;
746 #ifndef LWS_NO_CLIENT
747 LWS_EXTERN int lws_client_socket_service(
748 struct libwebsocket_context *context,
749 struct libwebsocket *wsi, struct libwebsocket_pollfd *pollfd);
750 LWS_EXTERN int lws_context_init_client(struct lws_context_creation_info *info,
751 struct libwebsocket_context *context);
753 #define lws_context_init_client(_a, _b) (0)
755 #ifndef LWS_NO_SERVER
756 LWS_EXTERN int lws_server_socket_service(
757 struct libwebsocket_context *context,
758 struct libwebsocket *wsi, struct libwebsocket_pollfd *pollfd);
759 LWS_EXTERN int _libwebsocket_rx_flow_control(struct libwebsocket *wsi);
761 #define _libwebsocket_rx_flow_control(_a) (0)
768 lws_plat_delete_socket_from_fds(struct libwebsocket_context *context,
769 struct libwebsocket *wsi, int m);
771 lws_plat_insert_socket_into_fds(struct libwebsocket_context *context,
772 struct libwebsocket *wsi);
774 lws_plat_service_periodic(struct libwebsocket_context *context);
777 lws_plat_change_pollfd(struct libwebsocket_context *context,
778 struct libwebsocket *wsi, struct libwebsocket_pollfd *pfd);
780 lws_plat_context_early_init(void);
782 lws_plat_context_early_destroy(struct libwebsocket_context *context);
784 lws_plat_context_late_destroy(struct libwebsocket_context *context);
786 lws_poll_listen_fd(struct libwebsocket_pollfd *fd);
788 lws_plat_service(struct libwebsocket_context *context, int timeout_ms);
790 lws_plat_init_fd_tables(struct libwebsocket_context *context);
792 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
793 LWS_EXTERN unsigned long long
794 time_in_microseconds(void);
795 LWS_EXTERN const char *
796 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);