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"
27 #define inline __inline
33 #if _MSC_VER > 1000 || defined(_WIN32)
49 #elif _MSC_VER > 1000 || defined(_WIN32)
59 #define LWS_NO_DAEMONIZE
61 #define EWOULDBLOCK EAGAIN
64 #define compatible_close(fd) closesocket(fd);
76 #include <sys/types.h>
77 #include <sys/socket.h>
79 #ifdef HAVE_SYS_PRCTL_H
80 #include <sys/prctl.h>
83 #include <netinet/in.h>
84 #include <netinet/tcp.h>
85 #include <arpa/inet.h>
91 #define compatible_close(fd) close(fd);
94 #ifdef LWS_OPENSSL_SUPPORT
96 #include <cyassl/openssl/ssl.h>
97 #include <cyassl/error.h>
99 SHA1(const unsigned char *d, size_t n, unsigned char *md);
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 */
109 #include "libwebsockets.h"
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.
116 #define MSG_NOSIGNAL SO_NOSIGPIPE
119 #ifndef LWS_MAX_HEADER_LEN
120 #define LWS_MAX_HEADER_LEN 1024
122 #ifndef LWS_MAX_PROTOCOLS
123 #define LWS_MAX_PROTOCOLS 5
125 #ifndef LWS_MAX_EXTENSIONS_ACTIVE
126 #define LWS_MAX_EXTENSIONS_ACTIVE 3
128 #ifndef SPEC_LATEST_SUPPORTED
129 #define SPEC_LATEST_SUPPORTED 13
131 #ifndef AWAITING_TIMEOUT
132 #define AWAITING_TIMEOUT 5
134 #ifndef CIPHERS_LIST_STRING
135 #define CIPHERS_LIST_STRING "DEFAULT"
137 #ifndef LWS_SOMAXCONN
138 #define LWS_SOMAXCONN SOMAXCONN
141 #define MAX_WEBSOCKET_04_KEY_LEN 128
142 #define LWS_MAX_SOCKET_IO_BUF 4096
144 #ifndef SYSTEM_RANDOM_FILEPATH
145 #define SYSTEM_RANDOM_FILEPATH "/dev/urandom"
147 #ifndef LWS_MAX_ZLIB_CONN_BUFFER
148 #define LWS_MAX_ZLIB_CONN_BUFFER (64 * 1024)
152 * if not in a connection storm, check for incoming
153 * connections this many normal connection services
155 #define LWS_LISTEN_SERVICE_MODULO 10
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,
162 LWS_WS_OPCODE_07__NOSPEC__MUX = 7,
164 /* control extensions 8+ */
166 LWS_WS_OPCODE_07__CLOSE = 8,
167 LWS_WS_OPCODE_07__PING = 9,
168 LWS_WS_OPCODE_07__PONG = 0xa,
172 enum lws_connection_states {
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,
183 enum lws_rx_parse_state {
186 LWS_RXPS_04_MASK_NONCE_1,
187 LWS_RXPS_04_MASK_NONCE_2,
188 LWS_RXPS_04_MASK_NONCE_3,
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,
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,
208 LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED
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,
217 LWS_CONNMODE_WS_SERVING,
218 LWS_CONNMODE_WS_CLIENT,
220 /* transient, ssl delay hiding */
221 LWS_CONNMODE_SSL_ACK_PENDING,
223 /* transient modes */
224 LWS_CONNMODE_WS_CLIENT_WAITING_PROXY_REPLY,
225 LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE,
226 LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY,
227 LWS_CONNMODE_WS_CLIENT_WAITING_EXTENSION_CONNECT,
228 LWS_CONNMODE_WS_CLIENT_PENDING_CANDIDATE_CHILD,
230 /* special internal types */
231 LWS_CONNMODE_SERVER_LISTENER,
235 LWS_RXFLOW_ALLOW = (1 << 0),
236 LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
239 struct libwebsocket_protocols;
242 struct libwebsocket_context {
244 struct libwebsocket **lws_lookup; /* fd to wsi */
248 char http_proxy_address[128];
249 char canonical_hostname[128];
250 unsigned int http_proxy_port;
251 unsigned int options;
252 unsigned long last_timeout_check_s;
255 * usable by anything in the service code, but only if the scope
256 * does not last longer than the service action (since next service
257 * of any socket can likewise use it and overwrite)
259 unsigned char service_buffer[LWS_MAX_SOCKET_IO_BUF];
261 int started_with_parent;
264 int listen_service_modulo;
265 int listen_service_count;
266 int listen_service_fd;
267 int listen_service_extraseen;
274 unsigned long worst_latency;
275 char worst_latency_info[256];
278 #ifdef LWS_OPENSSL_SUPPORT
281 SSL_CTX *ssl_client_ctx;
283 struct libwebsocket_protocols *protocols;
285 #ifndef LWS_NO_EXTENSIONS
286 struct libwebsocket_extension *extensions;
293 * This is totally opaque to code using the library. It's exported as a
294 * forward-reference pointer-only declaration; the user can use the pointer with
295 * other APIs to get information out of it.
298 struct _lws_http_mode_related {
300 unsigned long filepos;
301 unsigned long filelen;
304 struct lws_fragments {
305 unsigned short offset;
307 unsigned char next_frag_index;
310 struct allocated_headers {
311 unsigned short next_frag_index;
313 unsigned char frag_index[WSI_TOKEN_COUNT];
314 struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
315 char data[LWS_MAX_HEADER_LEN];
316 #ifndef LWS_NO_CLIENT
317 char initial_handshake_hash_base64[30];
318 unsigned short c_port;
322 struct _lws_header_related {
323 struct allocated_headers *ah;
325 unsigned char parser_state; /* enum lws_token_indexes */
328 struct _lws_websocket_related {
329 char *rx_user_buffer;
330 int rx_user_buffer_head;
331 unsigned char frame_masking_nonce_04[4];
332 unsigned char frame_mask_index;
333 size_t rx_packet_length;
334 unsigned char opcode;
335 unsigned int final:1;
337 unsigned int frame_is_binary:1;
338 unsigned int all_zero_nonce:1;
339 short close_reason; /* enum lws_close_status */
340 unsigned char *rxflow_buffer;
343 unsigned int rxflow_change_to:2;
344 unsigned int this_frame_masked:1;
347 struct libwebsocket {
349 /* lifetime members */
351 const struct libwebsocket_protocols *protocol;
352 #ifndef LWS_NO_EXTENSIONS
353 struct libwebsocket_extension *
354 active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
355 void *active_extensions_user[LWS_MAX_EXTENSIONS_ACTIVE];
356 unsigned char count_active_extensions;
357 unsigned int extension_data_pending:1;
359 unsigned char ietf_spec_revision;
361 char mode; /* enum connection_mode */
362 char state; /* enum lws_connection_states */
363 char lws_rx_parse_state; /* enum lws_rx_parse_state */
364 char rx_frame_type; /* enum libwebsocket_write_protocol */
366 unsigned int hdr_parsing_completed:1;
368 char pending_timeout; /* enum pending_timeout */
369 unsigned long pending_timeout_limit;
372 int position_in_fds_table;
374 unsigned long action_start;
375 unsigned long latency_start;
380 /* members with mutually exclusive lifetimes are unionized */
383 struct _lws_http_mode_related http;
384 struct _lws_header_related hdr;
385 struct _lws_websocket_related ws;
388 #ifdef LWS_OPENSSL_SUPPORT
391 unsigned int use_ssl:2;
396 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
397 struct libwebsocket *wsi, enum lws_close_status);
400 static inline void lws_latency(struct libwebsocket_context *context,
401 struct libwebsocket *wsi, const char *action,
402 int ret, int completion) { while (0); }
403 static inline void lws_latency_pre(struct libwebsocket_context *context,
404 struct libwebsocket *wsi) { while (0); }
406 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
408 lws_latency(struct libwebsocket_context *context,
409 struct libwebsocket *wsi, const char *action,
410 int ret, int completion);
414 libwebsocket_client_rx_sm(struct libwebsocket *wsi, unsigned char c);
417 libwebsocket_parse(struct libwebsocket *wsi, unsigned char c);
420 libwebsocket_interpret_incoming_packet(struct libwebsocket *wsi,
421 unsigned char *buf, size_t len);
424 lws_b64_selftest(void);
426 LWS_EXTERN struct libwebsocket *
427 wsi_from_fd(struct libwebsocket_context *context, int fd);
430 insert_wsi_socket_into_fds(struct libwebsocket_context *context,
431 struct libwebsocket *wsi);
434 lws_issue_raw(struct libwebsocket *wsi, unsigned char *buf, size_t len);
438 libwebsocket_service_timeout_check(struct libwebsocket_context *context,
439 struct libwebsocket *wsi, unsigned int sec);
441 LWS_EXTERN struct libwebsocket *
442 __libwebsocket_client_connect_2(struct libwebsocket_context *context,
443 struct libwebsocket *wsi);
445 LWS_EXTERN struct libwebsocket *
446 libwebsocket_create_new_server_wsi(struct libwebsocket_context *context);
449 libwebsockets_generate_client_handshake(struct libwebsocket_context *context,
450 struct libwebsocket *wsi, char *pkt);
453 lws_handle_POLLOUT_event(struct libwebsocket_context *context,
454 struct libwebsocket *wsi, struct pollfd *pollfd);
455 #ifndef LWS_NO_EXTENSIONS
457 lws_any_extension_handled(struct libwebsocket_context *context,
458 struct libwebsocket *wsi,
459 enum libwebsocket_extension_callback_reasons r,
460 void *v, size_t len);
463 lws_get_extension_user_matching_ext(struct libwebsocket *wsi,
464 struct libwebsocket_extension *ext);
468 lws_client_interpret_server_handshake(struct libwebsocket_context *context,
469 struct libwebsocket *wsi);
472 libwebsocket_rx_sm(struct libwebsocket *wsi, unsigned char c);
475 lws_issue_raw_ext_access(struct libwebsocket *wsi,
476 unsigned char *buf, size_t len);
479 _libwebsocket_rx_flow_control(struct libwebsocket *wsi);
482 user_callback_handle_rxflow(callback_function,
483 struct libwebsocket_context *context,
484 struct libwebsocket *wsi,
485 enum libwebsocket_callback_reasons reason, void *user,
486 void *in, size_t len);
489 lws_set_socket_options(struct libwebsocket_context *context, int fd);
492 lws_allocate_header_table(struct libwebsocket *wsi);
495 lws_hdr_simple_ptr(struct libwebsocket *wsi, enum lws_token_indexes h);
498 lws_hdr_simple_create(struct libwebsocket *wsi,
499 enum lws_token_indexes h, const char *s);
502 libwebsocket_ensure_user_space(struct libwebsocket *wsi);
504 #ifndef LWS_NO_SERVER
505 LWS_EXTERN int handshake_0405(struct libwebsocket_context *context,
506 struct libwebsocket *wsi);
509 #ifndef LWS_NO_DAEMONIZE
510 LWS_EXTERN int get_daemonize_pid();
513 extern int interface_to_sa(const char *ifname,
514 struct sockaddr_in *addr, size_t addrlen);
516 #ifndef LWS_OPENSSL_SUPPORT
519 SHA1(const unsigned char *d, size_t n, unsigned char *md);
523 LWS_EXTERN int openssl_websocket_private_data_index;