Adding header table free function to make sure we free cleanly everywhere.
[platform/upstream/libwebsockets.git] / 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 #if defined(WIN32) || defined(_WIN32)
27 #define inline __inline
28 #else /* not WIN32 */
29 #include "config.h"
30
31 #endif /* not WIN32 */
32 #endif /* not CMAKE */
33
34 #ifdef HAVE_SYS_TYPES_H
35 #include <sys/types.h>
36 #endif
37
38 #include <stdio.h>
39 #include <stdlib.h>
40 #include <string.h>
41 #include <time.h>
42 #include <ctype.h>
43 #include <limits.h>
44 #include <stdarg.h>
45
46 #ifdef HAVE_SYS_STAT_H
47 #include <sys/stat.h>
48 #endif
49
50 #if defined(WIN32) || defined(_WIN32)
51 #define LWS_NO_DAEMONIZE
52 #define LWS_ERRNO WSAGetLastError()
53 #define LWS_EAGAIN WSAEWOULDBLOCK
54 #define LWS_EALREADY WSAEALREADY
55 #define LWS_EINPROGRESS WSAEINPROGRESS
56 #define LWS_EINTR WSAEINTR
57 #define LWS_EISCONN WSAEISCONN
58 #define LWS_EWOULDBLOCK WSAEWOULDBLOCK
59 #define LWS_POLLHUP (FD_CLOSE)
60 #define LWS_POLLIN (FD_READ | FD_ACCEPT)
61 #define LWS_POLLOUT (FD_WRITE)
62 #define MSG_NOSIGNAL 0
63 #define SHUT_RDWR SD_BOTH
64 #define SOL_TCP IPPROTO_TCP
65
66 #define compatible_close(fd) closesocket(fd)
67 #define compatible_file_close(fd) CloseHandle(fd)
68 #define compatible_file_seek_cur(fd, offset) SetFilePointer(fd, offset, NULL, FILE_CURRENT)
69 #define compatible_file_read(amount, fd, buf, len) {\
70         DWORD _amount; \
71         if (!ReadFile(fd, buf, len, &_amount, NULL)) \
72                 amount = -1; \
73         else \
74                 amount = _amount; \
75         }
76 #define lws_set_blocking_send(wsi) wsi->sock_send_blocking = TRUE
77 #include <winsock2.h>
78 #include <windows.h>
79 #include <tchar.h>
80 #ifdef HAVE_IN6ADDR_H
81 #include <in6addr.h>
82 #endif
83 #include <mstcpip.h>
84
85 #ifndef __func__
86 #define __func__ __FUNCTION__
87 #endif
88
89 #ifdef _WIN32_WCE
90 #define vsnprintf _vsnprintf
91 #endif
92
93 #define LWS_INVALID_FILE INVALID_HANDLE_VALUE
94 #else /* not windows --> */
95 #include <errno.h>
96 #include <fcntl.h>
97 #include <netdb.h>
98 #include <signal.h>
99 #include <strings.h>
100 #include <unistd.h>
101 #include <sys/types.h>
102 #include <sys/socket.h>
103 #ifdef LWS_BUILTIN_GETIFADDRS
104  #include <getifaddrs.h>
105 #else
106  #include <ifaddrs.h>
107 #endif
108 #if defined (__ANDROID__)
109 #include <syslog.h>
110 #else
111 #include <sys/syslog.h>
112 #endif
113 #include <sys/un.h>
114 #include <sys/socket.h>
115 #include <netdb.h>
116 #ifndef LWS_NO_FORK
117 #ifdef HAVE_SYS_PRCTL_H
118 #include <sys/prctl.h>
119 #endif
120 #endif
121 #include <netinet/in.h>
122 #include <netinet/tcp.h>
123 #include <arpa/inet.h>
124 #include <poll.h>
125 #ifdef LWS_USE_LIBEV
126 #include <ev.h>
127 #endif /* LWS_USE_LIBEV */
128
129 #include <sys/mman.h>
130 #include <sys/time.h>
131
132 #define LWS_ERRNO errno
133 #define LWS_EAGAIN EAGAIN
134 #define LWS_EALREADY EALREADY
135 #define LWS_EINPROGRESS EINPROGRESS
136 #define LWS_EINTR EINTR
137 #define LWS_EISCONN EISCONN
138 #define LWS_EWOULDBLOCK EWOULDBLOCK
139 #define LWS_INVALID_FILE -1
140 #define LWS_POLLHUP (POLLHUP|POLLERR)
141 #define LWS_POLLIN (POLLIN)
142 #define LWS_POLLOUT (POLLOUT)
143 #define compatible_close(fd) close(fd)
144 #define compatible_file_close(fd) close(fd)
145 #define compatible_file_seek_cur(fd, offset) lseek(fd, offset, SEEK_CUR)
146 #define compatible_file_read(amount, fd, buf, len) \
147                 amount = read(fd, buf, len);
148 #define lws_set_blocking_send(wsi)
149 #endif
150
151 #ifndef HAVE_BZERO
152 #define bzero(b, len) (memset((b), '\0', (len)), (void) 0)
153 #endif
154
155 #ifndef HAVE_STRERROR
156 #define strerror(x) ""
157 #endif
158
159 #ifdef LWS_OPENSSL_SUPPORT
160 #ifdef USE_CYASSL
161 #include <cyassl/openssl/ssl.h>
162 #include <cyassl/error-ssl.h>
163 #else
164 #include <openssl/ssl.h>
165 #include <openssl/evp.h>
166 #include <openssl/err.h>
167 #include <openssl/md5.h>
168 #include <openssl/sha.h>
169 #endif /* not USE_CYASSL */
170 #endif
171
172 #include "libwebsockets.h"
173
174 #if defined(WIN32) || defined(_WIN32)
175
176 #ifndef BIG_ENDIAN
177 #define BIG_ENDIAN    4321  /* to show byte order (taken from gcc) */
178 #endif
179 #ifndef LITTLE_ENDIAN
180 #define LITTLE_ENDIAN 1234
181 #endif
182 #ifndef BYTE_ORDER
183 #define BYTE_ORDER LITTLE_ENDIAN
184 #endif
185 typedef unsigned __int64 u_int64_t;
186
187 #undef __P
188 #ifndef __P
189 #if __STDC__
190 #define __P(protos) protos
191 #else
192 #define __P(protos) ()
193 #endif
194 #endif
195
196 #else
197
198 #include <sys/stat.h>
199 #include <sys/cdefs.h>
200 #include <sys/time.h>
201
202 #if defined(__APPLE__)
203 #include <machine/endian.h>
204 #elif defined(__FreeBSD__)
205 #include <sys/endian.h>
206 #elif defined(__linux__)
207 #include <endian.h>
208 #endif
209
210 #if defined(__QNX__)
211         #include <gulliver.h>
212         #if defined(__LITTLEENDIAN__)
213                 #define BYTE_ORDER __LITTLEENDIAN__
214                 #define LITTLE_ENDIAN __LITTLEENDIAN__
215                 #define BIG_ENDIAN 4321  /* to show byte order (taken from gcc); for suppres warning that BIG_ENDIAN is not defined. */
216         #endif
217         #if defined(__BIGENDIAN__)
218                 #define BYTE_ORDER __BIGENDIAN__
219                 #define LITTLE_ENDIAN 1234  /* to show byte order (taken from gcc); for suppres warning that LITTLE_ENDIAN is not defined. */
220                 #define BIG_ENDIAN __BIGENDIAN__
221         #endif
222 #endif
223
224 #if !defined(BYTE_ORDER)
225 # define BYTE_ORDER __BYTE_ORDER
226 #endif
227 #if !defined(LITTLE_ENDIAN)
228 # define LITTLE_ENDIAN __LITTLE_ENDIAN
229 #endif
230 #if !defined(BIG_ENDIAN)
231 # define BIG_ENDIAN __BIG_ENDIAN
232 #endif
233
234 #endif
235
236 /*
237  * Mac OSX as well as iOS do not define the MSG_NOSIGNAL flag,
238  * but happily have something equivalent in the SO_NOSIGPIPE flag.
239  */
240 #ifdef __APPLE__
241 #define MSG_NOSIGNAL SO_NOSIGPIPE
242 #endif
243
244 #ifndef LWS_MAX_HEADER_LEN
245 #define LWS_MAX_HEADER_LEN 1024
246 #endif
247 #ifndef LWS_MAX_PROTOCOLS
248 #define LWS_MAX_PROTOCOLS 5
249 #endif
250 #ifndef LWS_MAX_EXTENSIONS_ACTIVE
251 #define LWS_MAX_EXTENSIONS_ACTIVE 3
252 #endif
253 #ifndef SPEC_LATEST_SUPPORTED
254 #define SPEC_LATEST_SUPPORTED 13
255 #endif
256 #ifndef AWAITING_TIMEOUT
257 #define AWAITING_TIMEOUT 5
258 #endif
259 #ifndef CIPHERS_LIST_STRING
260 #define CIPHERS_LIST_STRING "DEFAULT"
261 #endif
262 #ifndef LWS_SOMAXCONN
263 #define LWS_SOMAXCONN SOMAXCONN
264 #endif
265
266 #define MAX_WEBSOCKET_04_KEY_LEN 128
267 #define LWS_MAX_SOCKET_IO_BUF 4096
268
269 #ifndef SYSTEM_RANDOM_FILEPATH
270 #define SYSTEM_RANDOM_FILEPATH "/dev/urandom"
271 #endif
272 #ifndef LWS_MAX_ZLIB_CONN_BUFFER
273 #define LWS_MAX_ZLIB_CONN_BUFFER (64 * 1024)
274 #endif
275
276 /*
277  * if not in a connection storm, check for incoming
278  * connections this many normal connection services
279  */
280 #define LWS_LISTEN_SERVICE_MODULO 10
281
282 enum lws_websocket_opcodes_07 {
283         LWS_WS_OPCODE_07__CONTINUATION = 0,
284         LWS_WS_OPCODE_07__TEXT_FRAME = 1,
285         LWS_WS_OPCODE_07__BINARY_FRAME = 2,
286
287         LWS_WS_OPCODE_07__NOSPEC__MUX = 7,
288
289         /* control extensions 8+ */
290
291         LWS_WS_OPCODE_07__CLOSE = 8,
292         LWS_WS_OPCODE_07__PING = 9,
293         LWS_WS_OPCODE_07__PONG = 0xa,
294 };
295
296
297 enum lws_connection_states {
298         WSI_STATE_HTTP,
299         WSI_STATE_HTTP_ISSUING_FILE,
300         WSI_STATE_HTTP_HEADERS,
301         WSI_STATE_HTTP_BODY,
302         WSI_STATE_DEAD_SOCKET,
303         WSI_STATE_ESTABLISHED,
304         WSI_STATE_CLIENT_UNCONNECTED,
305         WSI_STATE_RETURNED_CLOSE_ALREADY,
306         WSI_STATE_AWAITING_CLOSE_ACK,
307         WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE,
308         
309         WSI_STATE_HTTP2_AWAIT_CLIENT_PREFACE,
310         WSI_STATE_HTTP2_ESTABLISHED_PRE_SETTINGS,
311         WSI_STATE_HTTP2_ESTABLISHED,
312 };
313
314 enum http_version {
315         HTTP_VERSION_1_0,
316         HTTP_VERSION_1_1,
317 };
318
319 enum http_connection_type {
320         HTTP_CONNECTION_CLOSE,
321         HTTP_CONNECTION_KEEP_ALIVE
322 };
323
324 enum lws_pending_protocol_send {
325         LWS_PPS_NONE,
326         LWS_PPS_HTTP2_MY_SETTINGS,
327         LWS_PPS_HTTP2_ACK_SETTINGS,
328         LWS_PPS_HTTP2_PONG,
329 };
330
331 enum lws_rx_parse_state {
332         LWS_RXPS_NEW,
333
334         LWS_RXPS_04_MASK_NONCE_1,
335         LWS_RXPS_04_MASK_NONCE_2,
336         LWS_RXPS_04_MASK_NONCE_3,
337
338         LWS_RXPS_04_FRAME_HDR_1,
339         LWS_RXPS_04_FRAME_HDR_LEN,
340         LWS_RXPS_04_FRAME_HDR_LEN16_2,
341         LWS_RXPS_04_FRAME_HDR_LEN16_1,
342         LWS_RXPS_04_FRAME_HDR_LEN64_8,
343         LWS_RXPS_04_FRAME_HDR_LEN64_7,
344         LWS_RXPS_04_FRAME_HDR_LEN64_6,
345         LWS_RXPS_04_FRAME_HDR_LEN64_5,
346         LWS_RXPS_04_FRAME_HDR_LEN64_4,
347         LWS_RXPS_04_FRAME_HDR_LEN64_3,
348         LWS_RXPS_04_FRAME_HDR_LEN64_2,
349         LWS_RXPS_04_FRAME_HDR_LEN64_1,
350
351         LWS_RXPS_07_COLLECT_FRAME_KEY_1,
352         LWS_RXPS_07_COLLECT_FRAME_KEY_2,
353         LWS_RXPS_07_COLLECT_FRAME_KEY_3,
354         LWS_RXPS_07_COLLECT_FRAME_KEY_4,
355
356         LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED
357 };
358
359
360 enum connection_mode {
361         LWS_CONNMODE_HTTP_SERVING,
362         LWS_CONNMODE_HTTP_SERVING_ACCEPTED, /* actual HTTP service going on */
363         LWS_CONNMODE_PRE_WS_SERVING_ACCEPT,
364
365         LWS_CONNMODE_WS_SERVING,
366         LWS_CONNMODE_WS_CLIENT,
367         
368         LWS_CONNMODE_HTTP2_SERVING,
369
370         /* transient, ssl delay hiding */
371         LWS_CONNMODE_SSL_ACK_PENDING,
372
373         /* transient modes */
374         LWS_CONNMODE_WS_CLIENT_WAITING_CONNECT,
375         LWS_CONNMODE_WS_CLIENT_WAITING_PROXY_REPLY,
376         LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE,
377         LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE2,
378         LWS_CONNMODE_WS_CLIENT_WAITING_SSL,
379         LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY,
380         LWS_CONNMODE_WS_CLIENT_WAITING_EXTENSION_CONNECT,
381         LWS_CONNMODE_WS_CLIENT_PENDING_CANDIDATE_CHILD,
382
383         /* special internal types */
384         LWS_CONNMODE_SERVER_LISTENER,
385 };
386
387 enum {
388         LWS_RXFLOW_ALLOW = (1 << 0),
389         LWS_RXFLOW_PENDING_CHANGE = (1 << 1),
390 };
391
392 struct libwebsocket_protocols;
393 struct libwebsocket;
394
395 #ifdef LWS_USE_LIBEV
396 struct lws_io_watcher {
397         struct ev_io watcher;
398         struct libwebsocket_context* context;
399 };
400
401 struct lws_signal_watcher {
402         struct ev_signal watcher;
403         struct libwebsocket_context* context;
404 };
405 #endif /* LWS_USE_LIBEV */
406
407 struct libwebsocket_context {
408 #ifdef _WIN32
409         WSAEVENT *events;
410 #endif
411         struct libwebsocket_pollfd *fds;
412         struct libwebsocket **lws_lookup; /* fd to wsi */
413         int fds_count;
414 #ifdef LWS_USE_LIBEV
415         struct ev_loop* io_loop;
416         struct lws_io_watcher w_accept;
417         struct lws_signal_watcher w_sigint;
418 #endif /* LWS_USE_LIBEV */
419         int max_fds;
420         int listen_port;
421         const char *iface;
422         char http_proxy_address[128];
423         char canonical_hostname[128];
424         unsigned int http_proxy_port;
425         unsigned int options;
426         time_t last_timeout_check_s;
427
428         /*
429          * usable by anything in the service code, but only if the scope
430          * does not last longer than the service action (since next service
431          * of any socket can likewise use it and overwrite)
432          */
433         unsigned char service_buffer[LWS_MAX_SOCKET_IO_BUF];
434
435         int started_with_parent;
436
437         int fd_random;
438         int listen_service_modulo;
439         int listen_service_count;
440         int listen_service_fd;
441         int listen_service_extraseen;
442
443         /*
444          * set to the Thread ID that's doing the service loop just before entry
445          * to poll indicates service thread likely idling in poll()
446          * volatile because other threads may check it as part of processing
447          * for pollfd event change.
448          */
449         volatile int service_tid;
450 #ifndef _WIN32
451         int dummy_pipe_fds[2];
452 #endif
453
454         int ka_time;
455         int ka_probes;
456         int ka_interval;
457
458 #ifdef LWS_LATENCY
459         unsigned long worst_latency;
460         char worst_latency_info[256];
461 #endif
462
463 #ifdef LWS_OPENSSL_SUPPORT
464         int use_ssl;
465         int allow_non_ssl_on_ssl_port;
466         unsigned int user_supplied_ssl_ctx:1;
467         SSL_CTX *ssl_ctx;
468         SSL_CTX *ssl_client_ctx;
469         unsigned int ssl_flag_buffered_reads:1;
470 #endif
471         struct libwebsocket_protocols *protocols;
472         int count_protocols;
473 #ifndef LWS_NO_EXTENSIONS
474         struct libwebsocket_extension *extensions;
475 #endif
476     struct lws_token_limits *token_limits;
477         void *user_space;
478 };
479
480 enum {
481         LWS_EV_READ = (1 << 0),
482         LWS_EV_WRITE = (1 << 1),
483         LWS_EV_START = (1 << 2),
484         LWS_EV_STOP = (1 << 3),
485 };
486
487 #ifdef LWS_USE_LIBEV
488 #define LWS_LIBEV_ENABLED(context) (context->options & LWS_SERVER_OPTION_LIBEV)
489 LWS_EXTERN void lws_feature_status_libev(struct lws_context_creation_info *info);
490 LWS_EXTERN void
491 lws_libev_accept(struct libwebsocket_context *context,
492                  struct libwebsocket *new_wsi, int accept_fd);
493 LWS_EXTERN void
494 lws_libev_io(struct libwebsocket_context *context,
495                                 struct libwebsocket *wsi, int flags);
496 LWS_EXTERN int
497 lws_libev_init_fd_table(struct libwebsocket_context *context);
498 LWS_EXTERN void
499 lws_libev_run(struct libwebsocket_context *context);
500 #else
501 #define LWS_LIBEV_ENABLED(context) (0)
502 #define lws_feature_status_libev(_a) \
503                         lwsl_notice("libev support not compiled in\n")
504 #define lws_libev_accept(_a, _b, _c) ((void) 0)
505 #define lws_libev_io(_a, _b, _c) ((void) 0)
506 #define lws_libev_init_fd_table(_a) (0)
507 #define lws_libev_run(_a) ((void) 0)
508 #endif
509
510 #ifdef LWS_USE_IPV6
511 #define LWS_IPV6_ENABLED(context) (!(context->options & LWS_SERVER_OPTION_DISABLE_IPV6))
512 #else
513 #define LWS_IPV6_ENABLED(context) (0)
514 #endif
515
516 enum uri_path_states {
517         URIPS_IDLE,
518         URIPS_SEEN_SLASH,
519         URIPS_SEEN_SLASH_DOT,
520         URIPS_SEEN_SLASH_DOT_DOT,
521         URIPS_ARGUMENTS,
522 };
523
524 enum uri_esc_states {
525         URIES_IDLE,
526         URIES_SEEN_PERCENT,
527         URIES_SEEN_PERCENT_H1,
528 };
529
530 /*
531  * This is totally opaque to code using the library.  It's exported as a
532  * forward-reference pointer-only declaration; the user can use the pointer with
533  * other APIs to get information out of it.
534  */
535
536 struct lws_fragments {
537         unsigned short offset;
538         unsigned short len;
539         unsigned char next_frag_index;
540 };
541
542 /* notice that these union members:
543  * 
544  *  hdr
545  *  http
546  *  http2
547  * 
548  * all have a pointer to allocated_headers struct as their first member.
549  * 
550  * It means for allocated_headers access, the three union paths can all be
551  * used interchangably to access the same data
552  */
553
554 struct allocated_headers {
555         unsigned short next_frag_index;
556         unsigned short pos;
557         unsigned char frag_index[WSI_TOKEN_COUNT];
558         struct lws_fragments frags[WSI_TOKEN_COUNT * 2];
559         char data[LWS_MAX_HEADER_LEN];
560 #ifndef LWS_NO_CLIENT
561         char initial_handshake_hash_base64[30];
562         unsigned short c_port;
563 #endif
564 };
565
566 struct _lws_http_mode_related {
567         /* MUST be first in struct */
568         struct allocated_headers *ah; /* mirroring  _lws_header_related */
569 #if defined(WIN32) || defined(_WIN32)
570         HANDLE fd;
571 #else
572         int fd;
573 #endif
574         unsigned long filepos;
575         unsigned long filelen;
576
577         enum http_version request_version;
578         enum http_connection_type connection_type;
579         int content_length;
580         int content_remain;
581 };
582
583
584 #ifdef LWS_USE_HTTP2
585
586 enum lws_http2_settings {
587         LWS_HTTP2_SETTINGS__HEADER_TABLE_SIZE = 1,
588         LWS_HTTP2_SETTINGS__ENABLE_PUSH,
589         LWS_HTTP2_SETTINGS__MAX_CONCURRENT_STREAMS,
590         LWS_HTTP2_SETTINGS__INITIAL_WINDOW_SIZE,
591         LWS_HTTP2_SETTINGS__MAX_FRAME_SIZE,
592         LWS_HTTP2_SETTINGS__MAX_HEADER_LIST_SIZE,
593         
594         LWS_HTTP2_SETTINGS__COUNT /* always last */
595 };
596
597 enum lws_http2_wellknown_frame_types {
598         LWS_HTTP2_FRAME_TYPE_DATA,
599         LWS_HTTP2_FRAME_TYPE_HEADERS,
600         LWS_HTTP2_FRAME_TYPE_PRIORITY,
601         LWS_HTTP2_FRAME_TYPE_RST_STREAM,
602         LWS_HTTP2_FRAME_TYPE_SETTINGS,
603         LWS_HTTP2_FRAME_TYPE_PUSH_PROMISE,
604         LWS_HTTP2_FRAME_TYPE_PING,
605         LWS_HTTP2_FRAME_TYPE_GOAWAY,
606         LWS_HTTP2_FRAME_TYPE_WINDOW_UPDATE,
607         LWS_HTTP2_FRAME_TYPE_CONTINUATION,
608         
609         LWS_HTTP2_FRAME_TYPE_COUNT /* always last */
610 };
611
612 enum lws_http2_flags {
613         LWS_HTTP2_FLAG_END_STREAM = 1,
614         LWS_HTTP2_FLAG_END_HEADERS = 4,
615         LWS_HTTP2_FLAG_PADDED = 8,
616         LWS_HTTP2_FLAG_PRIORITY = 0x20,
617
618         LWS_HTTP2_FLAG_SETTINGS_ACK = 1,
619 };
620
621 #define LWS_HTTP2_STREAM_ID_MASTER 0
622 #define LWS_HTTP2_FRAME_HEADER_LENGTH 9
623 #define LWS_HTTP2_SETTINGS_LENGTH 6
624
625 struct http2_settings {
626         unsigned int setting[LWS_HTTP2_SETTINGS__COUNT];
627 };
628
629 enum http2_hpack_state {
630         
631         /* optional before first header block */
632         HPKS_OPT_PADDING,
633         HKPS_OPT_E_DEPENDENCY,
634         HKPS_OPT_WEIGHT,
635         
636         /* header block */
637         HPKS_TYPE,
638         
639         HPKS_IDX_EXT,
640         
641         HPKS_HLEN,
642         HPKS_HLEN_EXT,
643
644         HPKS_DATA,
645         
646         /* optional after last header block */
647         HKPS_OPT_DISCARD_PADDING,
648 };
649
650 enum http2_hpack_type {
651         HPKT_INDEXED_HDR_7,
652         HPKT_INDEXED_HDR_6_VALUE_INCR,
653         HPKT_LITERAL_HDR_VALUE_INCR,
654         HPKT_INDEXED_HDR_4_VALUE,
655         HPKT_LITERAL_HDR_VALUE,
656         HPKT_SIZE_5
657 };
658
659 struct hpack_dt_entry {
660         int token; /* additions that don't map to a token are ignored */
661         int arg_offset;
662         int arg_len;
663 };
664
665 struct hpack_dynamic_table {
666         struct hpack_dt_entry *entries;
667         char *args;
668         int pos;
669         int next;
670         int num_entries;
671         int args_length;
672 };
673
674 struct _lws_http2_related {
675         /* 
676          * having this first lets us also re-use all HTTP union code
677          * and in turn, http_mode_related has allocated headers in right
678          * place so we can use the header apis on the wsi directly still
679          */
680         struct _lws_http_mode_related http; /* MUST BE FIRST IN STRUCT */
681
682         struct http2_settings my_settings;
683         struct http2_settings peer_settings;
684         
685         struct libwebsocket *parent_wsi;
686         struct libwebsocket *next_child_wsi;
687
688         struct hpack_dynamic_table *hpack_dyn_table;
689         
690         unsigned int count;
691         
692         /* frame */
693         unsigned int length;
694         unsigned int stream_id;
695         struct libwebsocket *stream_wsi;
696         unsigned char type;
697         unsigned char flags;
698         unsigned char frame_state;
699         unsigned char padding;
700
701         unsigned char ping_payload[8];
702         
703         unsigned short round_robin_POLLOUT;
704         unsigned short count_POLLOUT_children;
705
706         unsigned int END_STREAM:1;
707         unsigned int END_HEADERS:1;
708         unsigned int send_END_STREAM:1;
709         unsigned int GOING_AWAY;
710         unsigned int requested_POLLOUT:1;
711         unsigned int waiting_tx_credit:1;
712
713         /* hpack */
714         enum http2_hpack_state hpack;
715         enum http2_hpack_type hpack_type;
716         unsigned int header_index;
717         unsigned int hpack_len;
718         unsigned short hpack_pos;
719         unsigned char hpack_m;
720         unsigned int hpack_e_dep;
721         unsigned int huff:1;
722         unsigned int value:1;
723         
724         /* negative credit is mandated by the spec */
725         int tx_credit;
726         unsigned int my_stream_id;
727         unsigned int child_count;
728         int my_priority;
729         unsigned char initialized;
730         unsigned char one_setting[LWS_HTTP2_SETTINGS_LENGTH];
731 };
732
733 #define HTTP2_IS_TOPLEVEL_WSI(wsi) (!wsi->u.http2.parent_wsi)
734
735 #endif
736
737 struct _lws_header_related {
738         /* MUST be first in struct */
739         struct allocated_headers *ah;
740         short lextable_pos;
741         unsigned short current_token_limit;
742         unsigned char parser_state; /* enum lws_token_indexes */
743         enum uri_path_states ups;
744         enum uri_esc_states ues;
745         char esc_stash;
746 };
747
748 struct _lws_websocket_related {
749         char *rx_user_buffer;
750         int rx_user_buffer_head;
751         unsigned char frame_masking_nonce_04[4];
752         unsigned char frame_mask_index;
753         size_t rx_packet_length;
754         unsigned char opcode;
755         unsigned int final:1;
756         unsigned char rsv;
757         unsigned int frame_is_binary:1;
758         unsigned int all_zero_nonce:1;
759         short close_reason; /* enum lws_close_status */
760
761         unsigned int this_frame_masked:1;
762         unsigned int inside_frame:1; /* next write will be more of frame */
763         unsigned int clean_buffer:1; /* buffer not rewritten by extension */
764
765         unsigned char *ping_payload_buf; /* non-NULL if malloc'd */
766         unsigned int ping_payload_alloc; /* length malloc'd */
767         unsigned int ping_payload_len; /* nonzero if PONG pending */
768 };
769
770 struct libwebsocket {
771
772         /* lifetime members */
773
774 #ifdef LWS_USE_LIBEV
775     struct lws_io_watcher w_read;
776     struct lws_io_watcher w_write;
777 #endif /* LWS_USE_LIBEV */
778         const struct libwebsocket_protocols *protocol;
779 #ifndef LWS_NO_EXTENSIONS
780         struct libwebsocket_extension *
781                                    active_extensions[LWS_MAX_EXTENSIONS_ACTIVE];
782         void *active_extensions_user[LWS_MAX_EXTENSIONS_ACTIVE];
783         unsigned char count_active_extensions;
784         unsigned int extension_data_pending:1;
785 #endif
786         unsigned char ietf_spec_revision;
787         enum lws_pending_protocol_send pps;
788
789         char mode; /* enum connection_mode */
790         char state; /* enum lws_connection_states */
791         char lws_rx_parse_state; /* enum lws_rx_parse_state */
792         char rx_frame_type; /* enum libwebsocket_write_protocol */
793
794         unsigned int hdr_parsing_completed:1;
795         unsigned int user_space_externally_allocated:1;
796         unsigned int socket_is_permanently_unusable:1;
797
798         char pending_timeout; /* enum pending_timeout */
799         time_t pending_timeout_limit;
800
801         int sock;
802         int position_in_fds_table;
803 #ifdef LWS_LATENCY
804         unsigned long action_start;
805         unsigned long latency_start;
806 #endif
807         /* rxflow handling */
808         unsigned char *rxflow_buffer;
809         int rxflow_len;
810         int rxflow_pos;
811         unsigned int rxflow_change_to:2;
812
813         /* truncated send handling */
814         unsigned char *truncated_send_malloc; /* non-NULL means buffering in progress */
815         unsigned int truncated_send_allocation; /* size of malloc */
816         unsigned int truncated_send_offset; /* where we are in terms of spilling */
817         unsigned int truncated_send_len; /* how much is buffered */
818
819         void *user_space;
820
821         /* members with mutually exclusive lifetimes are unionized */
822
823         union u {
824                 struct _lws_http_mode_related http;
825 #ifdef LWS_USE_HTTP2
826                 struct _lws_http2_related http2;
827 #endif
828                 struct _lws_header_related hdr;
829                 struct _lws_websocket_related ws;
830         } u;
831
832 #ifdef LWS_OPENSSL_SUPPORT
833         SSL *ssl;
834         BIO *client_bio;
835         unsigned int use_ssl:2;
836         unsigned int buffered_reads_pending:1;
837         unsigned int upgraded:1;
838 #endif
839
840 #ifdef _WIN32
841         BOOL sock_send_blocking;
842 #endif
843 };
844
845 LWS_EXTERN int log_level;
846
847 LWS_EXTERN void
848 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
849                                struct libwebsocket *wsi, enum lws_close_status);
850
851 LWS_EXTERN int
852 remove_wsi_socket_from_fds(struct libwebsocket_context *context,
853                                                       struct libwebsocket *wsi);
854 LWS_EXTERN int
855 lws_rxflow_cache(struct libwebsocket *wsi, unsigned char *buf, int n, int len);
856
857 #ifndef LWS_LATENCY
858 static inline void lws_latency(struct libwebsocket_context *context,
859                 struct libwebsocket *wsi, const char *action,
860                                          int ret, int completion) { while (0); }
861 static inline void lws_latency_pre(struct libwebsocket_context *context,
862                                         struct libwebsocket *wsi) { while (0); }
863 #else
864 #define lws_latency_pre(_context, _wsi) lws_latency(_context, _wsi, NULL, 0, 0)
865 extern void
866 lws_latency(struct libwebsocket_context *context,
867                         struct libwebsocket *wsi, const char *action,
868                                                        int ret, int completion);
869 #endif
870
871 LWS_EXTERN void lws_set_protocol_write_pending(struct libwebsocket_context *context,
872                                     struct libwebsocket *wsi,
873                                     enum lws_pending_protocol_send pend);
874 LWS_EXTERN int
875 libwebsocket_client_rx_sm(struct libwebsocket *wsi, unsigned char c);
876
877 LWS_EXTERN int
878 libwebsocket_parse(struct libwebsocket_context *context,
879                 struct libwebsocket *wsi, unsigned char c);
880
881 LWS_EXTERN int
882 lws_http_action(struct libwebsocket_context *context, struct libwebsocket *wsi);
883
884 LWS_EXTERN int
885 lws_b64_selftest(void);
886
887 LWS_EXTERN struct libwebsocket *
888 wsi_from_fd(struct libwebsocket_context *context, int fd);
889
890 LWS_EXTERN int
891 insert_wsi_socket_into_fds(struct libwebsocket_context *context,
892                                                       struct libwebsocket *wsi);
893
894 LWS_EXTERN int
895 lws_issue_raw(struct libwebsocket *wsi, unsigned char *buf, size_t len);
896
897
898 LWS_EXTERN int
899 libwebsocket_service_timeout_check(struct libwebsocket_context *context,
900                                     struct libwebsocket *wsi, unsigned int sec);
901
902 LWS_EXTERN struct libwebsocket *
903 libwebsocket_client_connect_2(struct libwebsocket_context *context,
904         struct libwebsocket *wsi);
905
906 LWS_EXTERN struct libwebsocket *
907 libwebsocket_create_new_server_wsi(struct libwebsocket_context *context);
908
909 LWS_EXTERN char *
910 libwebsockets_generate_client_handshake(struct libwebsocket_context *context,
911                 struct libwebsocket *wsi, char *pkt);
912
913 LWS_EXTERN int
914 lws_handle_POLLOUT_event(struct libwebsocket_context *context,
915                               struct libwebsocket *wsi, struct libwebsocket_pollfd *pollfd);
916
917 /*
918  * EXTENSIONS
919  */
920
921 #ifndef LWS_NO_EXTENSIONS
922 LWS_VISIBLE void
923 lws_context_init_extensions(struct lws_context_creation_info *info,
924                                     struct libwebsocket_context *context);
925 LWS_EXTERN int
926 lws_any_extension_handled(struct libwebsocket_context *context,
927                           struct libwebsocket *wsi,
928                           enum libwebsocket_extension_callback_reasons r,
929                           void *v, size_t len);
930
931 LWS_EXTERN int
932 lws_ext_callback_for_each_active(struct libwebsocket *wsi, int reason,
933                                                     void *buf, int len);
934 LWS_EXTERN int
935 lws_ext_callback_for_each_extension_type(
936                 struct libwebsocket_context *context, struct libwebsocket *wsi,
937                         int reason, void *arg, int len);
938 #else
939 #define lws_any_extension_handled(_a, _b, _c, _d, _e) (0)
940 #define lws_ext_callback_for_each_active(_a, _b, _c, _d) (0)
941 #define lws_ext_callback_for_each_extension_type(_a, _b, _c, _d, _e) (0)
942 #define lws_issue_raw_ext_access lws_issue_raw
943 #define lws_context_init_extensions(_a, _b)
944 #endif
945
946 LWS_EXTERN int
947 lws_client_interpret_server_handshake(struct libwebsocket_context *context,
948                 struct libwebsocket *wsi);
949
950 LWS_EXTERN int
951 libwebsocket_rx_sm(struct libwebsocket *wsi, unsigned char c);
952
953 LWS_EXTERN int
954 lws_issue_raw_ext_access(struct libwebsocket *wsi,
955                                                 unsigned char *buf, size_t len);
956
957 LWS_EXTERN int
958 _libwebsocket_rx_flow_control(struct libwebsocket *wsi);
959
960 LWS_EXTERN int
961 user_callback_handle_rxflow(callback_function,
962                 struct libwebsocket_context *context,
963                         struct libwebsocket *wsi,
964                          enum libwebsocket_callback_reasons reason, void *user,
965                                                           void *in, size_t len);
966 #ifdef LWS_USE_HTTP2
967 LWS_EXTERN struct libwebsocket *lws_http2_get_network_wsi(struct libwebsocket *wsi);
968 struct libwebsocket * lws_http2_get_nth_child(struct libwebsocket *wsi, int n);
969 LWS_EXTERN int
970 lws_http2_interpret_settings_payload(struct http2_settings *settings, unsigned char *buf, int len);
971 LWS_EXTERN void lws_http2_init(struct http2_settings *settings);
972 LWS_EXTERN int
973 lws_http2_parser(struct libwebsocket_context *context,
974                      struct libwebsocket *wsi, unsigned char c);
975 LWS_EXTERN int lws_http2_do_pps_send(struct libwebsocket_context *context, struct libwebsocket *wsi);
976 LWS_EXTERN int lws_http2_frame_write(struct libwebsocket *wsi, int type, int flags, unsigned int sid, unsigned int len, unsigned char *buf);
977 LWS_EXTERN struct libwebsocket *
978 lws_http2_wsi_from_id(struct libwebsocket *wsi, unsigned int sid);
979 LWS_EXTERN int lws_hpack_interpret(struct libwebsocket_context *context,
980                                    struct libwebsocket *wsi,
981                                    unsigned char c);
982 LWS_EXTERN int
983 lws_add_http2_header_by_name(struct libwebsocket_context *context,
984                             struct libwebsocket *wsi,
985                             const unsigned char *name,
986                             const unsigned char *value,
987                             int length,
988                             unsigned char **p,
989                             unsigned char *end);
990 LWS_EXTERN int
991 lws_add_http2_header_by_token(struct libwebsocket_context *context,
992                             struct libwebsocket *wsi,
993                             enum lws_token_indexes token,
994                             const unsigned char *value,
995                             int length,
996                             unsigned char **p,
997                             unsigned char *end);
998 LWS_EXTERN int
999 lws_add_http2_header_status(struct libwebsocket_context *context,
1000                             struct libwebsocket *wsi,
1001                             unsigned int code,
1002                             unsigned char **p,
1003                             unsigned char *end);
1004 LWS_EXTERN
1005 void lws_http2_configure_if_upgraded(struct libwebsocket *wsi);
1006 #else
1007 #define lws_http2_configure_if_upgraded(x)
1008 #endif
1009
1010 LWS_EXTERN int
1011 lws_plat_set_socket_options(struct libwebsocket_context *context, int fd);
1012
1013 LWS_EXTERN int
1014 lws_allocate_header_table(struct libwebsocket *wsi);
1015
1016 LWS_EXTERN int
1017 lws_free_header_table(struct libwebsocket *wsi);
1018
1019 LWS_EXTERN char *
1020 lws_hdr_simple_ptr(struct libwebsocket *wsi, enum lws_token_indexes h);
1021
1022 LWS_EXTERN int
1023 lws_hdr_simple_create(struct libwebsocket *wsi,
1024                                 enum lws_token_indexes h, const char *s);
1025
1026 LWS_EXTERN int
1027 libwebsocket_ensure_user_space(struct libwebsocket *wsi);
1028
1029 LWS_EXTERN int
1030 lws_change_pollfd(struct libwebsocket *wsi, int _and, int _or);
1031
1032 #ifndef LWS_NO_SERVER
1033 int lws_context_init_server(struct lws_context_creation_info *info,
1034                             struct libwebsocket_context *context);
1035 LWS_EXTERN int handshake_0405(struct libwebsocket_context *context,
1036                                                       struct libwebsocket *wsi);
1037 LWS_EXTERN int
1038 libwebsocket_interpret_incoming_packet(struct libwebsocket *wsi,
1039                                                 unsigned char *buf, size_t len);
1040 LWS_EXTERN void
1041 lws_server_get_canonical_hostname(struct libwebsocket_context *context,
1042                                 struct lws_context_creation_info *info);
1043 #else
1044 #define lws_context_init_server(_a, _b) (0)
1045 #define libwebsocket_interpret_incoming_packet(_a, _b, _c) (0)
1046 #define lws_server_get_canonical_hostname(_a, _b)
1047 #endif
1048
1049 #ifndef LWS_NO_DAEMONIZE
1050 LWS_EXTERN int get_daemonize_pid();
1051 #else
1052 #define get_daemonize_pid() (0)
1053 #endif
1054
1055 LWS_EXTERN int interface_to_sa(struct libwebsocket_context *context,
1056                 const char *ifname, struct sockaddr_in *addr, size_t addrlen);
1057
1058 LWS_EXTERN void lwsl_emit_stderr(int level, const char *line);
1059
1060 #ifdef _WIN32
1061 LWS_EXTERN HANDLE lws_plat_open_file(const char* filename, unsigned long* filelen);
1062 #else
1063 LWS_EXTERN int lws_plat_open_file(const char* filename, unsigned long* filelen);
1064 #endif
1065
1066 enum lws_ssl_capable_status {
1067         LWS_SSL_CAPABLE_ERROR = -1,
1068         LWS_SSL_CAPABLE_MORE_SERVICE = -2,
1069 };
1070
1071 #ifndef LWS_OPENSSL_SUPPORT
1072 #define LWS_SSL_ENABLED(context) (0)
1073 #define lws_context_init_server_ssl(_a, _b) (0)
1074 #define lws_ssl_destroy(_a)
1075 #define lws_context_init_http2_ssl(_a)
1076 #define lws_ssl_capable_read lws_ssl_capable_read_no_ssl
1077 #define lws_ssl_capable_write lws_ssl_capable_write_no_ssl
1078 #define lws_server_socket_service_ssl(_a, _b, _c, _d, _e) (0)
1079 #define lws_ssl_close(_a) (0)
1080 #define lws_ssl_context_destroy(_a)
1081 #else
1082 #define LWS_SSL_ENABLED(context) (context->use_ssl)
1083 LWS_EXTERN int openssl_websocket_private_data_index;
1084 LWS_EXTERN int
1085 lws_ssl_capable_read(struct libwebsocket_context *context,
1086                      struct libwebsocket *wsi, unsigned char *buf, int len);
1087
1088 LWS_EXTERN int
1089 lws_ssl_capable_write(struct libwebsocket *wsi, unsigned char *buf, int len);
1090 LWS_EXTERN int
1091 lws_server_socket_service_ssl(struct libwebsocket_context *context,
1092                 struct libwebsocket **wsi, struct libwebsocket *new_wsi,
1093                 int accept_fd, struct libwebsocket_pollfd *pollfd);
1094 LWS_EXTERN int
1095 lws_ssl_close(struct libwebsocket *wsi);
1096 LWS_EXTERN void
1097 lws_ssl_context_destroy(struct libwebsocket_context *context);
1098 #ifndef LWS_NO_SERVER
1099 LWS_EXTERN int
1100 lws_context_init_server_ssl(struct lws_context_creation_info *info,
1101                      struct libwebsocket_context *context);
1102 #else
1103 #define lws_context_init_server_ssl(_a, _b) (0)
1104 #endif
1105 LWS_EXTERN void
1106 lws_ssl_destroy(struct libwebsocket_context *context);
1107
1108 /* HTTP2-related */
1109
1110 #ifdef LWS_USE_HTTP2
1111 LWS_EXTERN void
1112 lws_context_init_http2_ssl(struct libwebsocket_context *context);
1113 #else
1114 #define lws_context_init_http2_ssl(_a)
1115 #endif
1116 #endif
1117
1118 LWS_EXTERN int
1119 lws_ssl_capable_read_no_ssl(struct libwebsocket_context *context,
1120                             struct libwebsocket *wsi, unsigned char *buf, int len);
1121
1122 LWS_EXTERN int
1123 lws_ssl_capable_write_no_ssl(struct libwebsocket *wsi, unsigned char *buf, int len);
1124
1125 #ifndef LWS_NO_CLIENT
1126         LWS_EXTERN int lws_client_socket_service(
1127                 struct libwebsocket_context *context,
1128                 struct libwebsocket *wsi, struct libwebsocket_pollfd *pollfd);
1129 #ifdef LWS_OPENSSL_SUPPORT
1130         LWS_EXTERN int lws_context_init_client_ssl(struct lws_context_creation_info *info,
1131                             struct libwebsocket_context *context);
1132 #else
1133         #define lws_context_init_client_ssl(_a, _b) (0)
1134 #endif
1135         LWS_EXTERN int lws_handshake_client(struct libwebsocket *wsi, unsigned char **buf, size_t len);
1136         LWS_EXTERN void
1137         libwebsockets_decode_ssl_error(void);
1138 #else
1139 #define lws_context_init_client_ssl(_a, _b) (0)
1140 #define lws_handshake_client(_a, _b, _c) (0)
1141 #endif
1142 #ifndef LWS_NO_SERVER
1143         LWS_EXTERN int lws_server_socket_service(
1144                 struct libwebsocket_context *context,
1145                 struct libwebsocket *wsi, struct libwebsocket_pollfd *pollfd);
1146         LWS_EXTERN int _libwebsocket_rx_flow_control(struct libwebsocket *wsi);
1147         LWS_EXTERN int lws_handshake_server(struct libwebsocket_context *context,
1148                      struct libwebsocket *wsi, unsigned char **buf, size_t len);
1149 #else
1150 #define lws_server_socket_service(_a, _b, _c) (0)
1151 #define _libwebsocket_rx_flow_control(_a) (0)
1152 #define lws_handshake_server(_a, _b, _c, _d) (0)
1153 #endif
1154
1155 /*
1156  * lws_plat_
1157  */
1158 LWS_EXTERN void
1159 lws_plat_delete_socket_from_fds(struct libwebsocket_context *context,
1160                                                struct libwebsocket *wsi, int m);
1161 LWS_EXTERN void
1162 lws_plat_insert_socket_into_fds(struct libwebsocket_context *context,
1163                                                       struct libwebsocket *wsi);
1164 LWS_EXTERN void
1165 lws_plat_service_periodic(struct libwebsocket_context *context);
1166
1167 LWS_EXTERN int
1168 lws_plat_change_pollfd(struct libwebsocket_context *context,
1169                      struct libwebsocket *wsi, struct libwebsocket_pollfd *pfd);
1170 LWS_EXTERN int
1171 lws_plat_context_early_init(void);
1172 LWS_EXTERN void
1173 lws_plat_context_early_destroy(struct libwebsocket_context *context);
1174 LWS_EXTERN void
1175 lws_plat_context_late_destroy(struct libwebsocket_context *context);
1176 LWS_EXTERN int
1177 lws_poll_listen_fd(struct libwebsocket_pollfd *fd);
1178 LWS_EXTERN int
1179 lws_plat_service(struct libwebsocket_context *context, int timeout_ms);
1180 LWS_EXTERN int
1181 lws_plat_init_fd_tables(struct libwebsocket_context *context);
1182 LWS_EXTERN void
1183 lws_plat_drop_app_privileges(struct lws_context_creation_info *info);
1184 LWS_EXTERN unsigned long long
1185 time_in_microseconds(void);
1186 LWS_EXTERN const char *
1187 lws_plat_inet_ntop(int af, const void *src, char *dst, int cnt);