7 1) There is now a "permessage-deflate" / RFC7692 implementation. It's very
8 similar to "deflate-frame" we have offered for a long while; deflate-frame is
9 now provided as an alias of permessage-deflate.
11 The main differences are that the new permessage-deflate implementation:
13 - properly performs streaming respecting input and output buffer limits. The
14 old deflate-frame implementation could only work on complete deflate input
15 and produce complete inflate output for each frame. The new implementation
16 only mallocs buffers at initialization.
18 - goes around the event loop after each input package is processed allowing
19 interleaved output processing. The RX flow control api can be used to
20 force compressed input processing to match the rate of compressed output
21 processing (test--echo shows an example of how to do this).
23 - when being "deflate-frame" for compatibility he uses the same default zlib
24 settings as the old "deflate-frame", but instead of exponentially increasing
25 malloc allocations until the whole output will fit, he observes the default
26 input and output chunking buffer sizes of "permessage-deflate", that's
27 1024 in and 1024 out at a time.
29 2) deflate-stream has been disabled for many versions (for over a year) and is
30 now removed. Browsers are now standardizing on "permessage-deflate" / RFC7692
32 3) struct lws_extension is simplified, and lws extensions now have a public
33 api (their callback) for use in user code to compose extensions and options
34 the user code wants. lws_get_internal_exts() is deprecated but kept around
35 as a NOP. The changes allow one extension implementation to go by different
36 names and allows the user client code to control option offers per-ext.
38 The test client and server are updated to use the new way. If you use
39 the old way it should still work, but extensions will be disabled until you
42 Extensions are now responsible for allocating and per-instance private struct
43 at instance construction time and freeing it when the instance is destroyed.
44 Not needing to know the size means the extension's struct can be opaque
51 1) The info struct gained three new members
53 - max_http_header_data: 0 for default (1024) or set the maximum amount of known
54 http header payload that lws can deal with. Payload in unknown http
55 headers is dropped silently. If for some reason you need to send huge
56 cookies or other HTTP-level headers, you can now increase this at context-
59 - max_http_header_pool: 0 for default (16) or set the maximum amount of http
60 headers that can be tracked by lws in this context. For the server, if
61 the header pool is completely in use then accepts on the listen socket
62 are disabled until one becomes free. For the client, if you simultaneously
63 have pending connects for more than this number of client connections,
64 additional connects will fail until some of the pending connections timeout
67 - timeout_secs: 0 for default (currently 20s), or set the library's
68 network activity timeout to the given number of seconds
70 HTTP header processing in lws only exists until just after the first main
71 callback after the HTTP handshake... for ws connections that is ESTABLISHED and
72 for HTTP connections the HTTP callback.
74 So these settings are not related to the maximum number of simultaneous
75 connections, but the number of HTTP handshakes that may be expected or ongoing,
76 or have just completed, at one time. The reason it's useful is it changes the
77 memory allocation for header processing to be one-time at context creation
78 instead of every time there is a new connection, and gives you control over
81 Setting max_http_header_pool to 1 is fine it will just queue incoming
82 connections before the accept as necessary, you can still have as many
83 simultaneous post-header connections as you like. Since the http header
84 processing is completed and the allocation released after ESTABLISHED or the
85 HTTP callback, even with a pool of 1 many connections can be handled rapidly.
87 2) There is a new callback that allows the user code to get acccess to the
88 optional close code + aux data that may have been sent by the peer.
90 LWS_CALLBACK_WS_PEER_INITIATED_CLOSE:
91 The peer has sent an unsolicited Close WS packet. @in and
92 @len are the optional close code (first 2 bytes, network
93 order) and the optional additional information which is not
94 defined in the standard, and may be a string or non-human-
96 If you return 0 lws will echo the close and then close the
97 connection. If you return nonzero lws will just close the
100 As usual not handling it does the right thing, if you're not interested in it
103 The test server has "open and close" testing buttons at the bottom, if you
104 open and close that connection, on close it will send a close code 3000 decimal
105 and the string "Bye!" as the aux data.
107 The test server dumb-increment callback handles this callback reason and prints
109 lwsts[15714]: LWS_CALLBACK_WS_PEER_INITIATED_CLOSE: len 6
110 lwsts[15714]: 0: 0x0B
111 lwsts[15714]: 1: 0xB8
112 lwsts[15714]: 2: 0x42
113 lwsts[15714]: 3: 0x79
114 lwsts[15714]: 4: 0x65
115 lwsts[15714]: 5: 0x21
117 3) There is a new API to allow the user code to control the content of the
118 close frame sent when about to return nonzero from the user callback to
119 indicate the connection should close.
122 * lws_close_reason - Set reason and aux data to send with Close packet
123 * If you are going to return nonzero from the callback
124 * requesting the connection to close, you can optionally
125 * call this to set the reason the peer will be told if
128 * @wsi: The websocket connection to set the close reason on
129 * @status: A valid close status from websocket standard
130 * @buf: NULL or buffer containing up to 124 bytes of auxiliary data
131 * @len: Length of data in @buf to send
133 LWS_VISIBLE LWS_EXTERN void
134 lws_close_reason(struct lws *wsi, enum lws_close_status status,
135 unsigned char *buf, size_t len);
137 An extra button is added to the "open and close" test server page that requests
138 that the test server close the connection from his end.
140 The test server code will do so by
142 lws_close_reason(wsi, LWS_CLOSE_STATUS_GOINGAWAY,
143 (unsigned char *)"seeya", 5);
146 The browser shows the close code and reason he received
148 websocket connection CLOSED, code: 1001, reason: seeya
150 4) There's a new context creation time option flag
152 LWS_SERVER_OPTION_VALIDATE_UTF8
154 if you set it in info->options, then TEXT and CLOSE frames will get checked to
155 confirm that they contain valid UTF-8. If they don't, the connection will get
158 5) ECDH Certs are now supported. Enable the CMake option
160 cmake .. -DLWS_SSL_SERVER_WITH_ECDH_CERT=1
162 **and** the info->options flag
164 LWS_SERVER_OPTION_SSL_ECD
166 to build in support and select it at runtime.
168 6) There's a new api lws_parse_uri() that simplies chopping up
169 https://xxx:yyy/zzz uris into parts nicely. The test client now uses this
170 to allow proper uris as well as the old address style.
172 7) SMP support is integrated into LWS without any internal threading. It's
173 very simple to use, libwebsockets-test-server-pthread shows how to do it,
174 use -j <n> argument there to control the number of service threads up to 32.
176 Two new members are added to the info struct
178 unsigned int count_threads;
179 unsigned int fd_limit_per_thread;
181 leave them at the default 0 to get the normal singlethreaded service loop.
183 Set count_threads to n to tell lws you will have n simultaneous service threads
184 operating on the context.
186 There is still a single listen socket on one port, no matter how many
189 When a connection is made, it is accepted by the service thread with the least
190 connections active to perform load balancing.
192 The user code is responsible for spawning n threads running the service loop
193 associated to a specific tsi (Thread Service Index, 0 .. n - 1). See
194 the libwebsockets-test-server-pthread for how to do.
196 If you leave fd_limit_per_thread at 0, then the process limit of fds is shared
197 between the service threads; if you process was allowed 1024 fds overall then
198 each thread is limited to 1024 / n.
200 You can set fd_limit_per_thread to a nonzero number to control this manually, eg
201 the overall supported fd limit is less than the process allowance.
203 You can control the context basic data allocation for multithreading from Cmake
204 using -DLWS_MAX_SMP=, if not given it's set to 32. The serv_buf allocation
205 for the threads (currently 4096) is made at runtime only for active threads.
207 Because lws will limit the requested number of actual threads supported
208 according to LWS_MAX_SMP, there is an api lws_get_count_threads(context) to
209 discover how many threads were actually allowed when the context was created.
211 It's required to implement locking in the user code in the same way that
212 libwebsockets-test-server-pthread does it, for the FD locking callbacks.
214 If LWS_MAX_SMP=1, then there is no code related to pthreads compiled in the
215 library. If more than 1, a small amount of pthread mutex code is built into
220 LWS_VISIBLE struct lws *
221 lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd)
223 allows foreign sockets accepted by non-lws code to be adopted by lws as if they
224 had just been accepted by lws' own listen socket.
226 9) X-Real-IP: header has been added as WSI_TOKEN_HTTP_X_REAL_IP
228 10) Libuv support is added, there are new related user apis
230 typedef void (lws_uv_signal_cb_t)(uv_loop_t *l, uv_signal_t *w, int revents);
232 LWS_VISIBLE LWS_EXTERN int
233 lws_uv_sigint_cfg(struct lws_context *context, int use_uv_sigint,
234 lws_uv_signal_cb_t *cb);
236 LWS_VISIBLE LWS_EXTERN int
237 lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi);
240 lws_uv_sigint_cb(uv_loop_t *loop, uv_signal_t *watcher, int revents);
250 1) LWS_SEND_BUFFER_POST_PADDING is now 0 and deprecated. You can remove it; if
251 you still use it, obviously it does nothing. Old binary code with nonzero
252 LWS_SEND_BUFFER_POST_PADDING is perfectly compatible, the old code just
253 allocated a buffer bigger than the library is going to use.
255 The example apps no longer use LWS_SEND_BUFFER_POST_PADDING.
257 The only path who made use of it was sending with LWS_WRITE_CLOSE --->
259 2) Because of lws_close_reason() formalizing handling close frames,
260 LWS_WRITE_CLOSE is removed from libwebsockets.h. It was only of use to send
261 close frames...close frame content should be managed using lws_close_reason()
264 3) We check for invalid CLOSE codes and complain about protocol violation in
265 our close code. But it changes little since we were in the middle of closing
268 4) zero-length RX frames and zero length TX frames are now allowed.
270 5) Pings and close used to be limited to 124 bytes, the correct limit is 125
271 so that is now also allowed.
273 6) LWS_PRE is provided as a synonym for LWS_SEND_BUFFER_PRE_PADDING, either is
276 7) There's generic support for RFC7462 style extension options built into the
277 library now. As a consequence, a field "options" is added to lws_extension.
278 It can be NULL if there are no options on the extension. Extension internal
279 info is part of the public abi because extensions may be implemented outside
282 8) WSI_TOKEN_PROXY enum was accidentally defined to collide with another token
283 of value 73. That's now corrected and WSI_TOKEN_PROXY moved to his own place at
286 9) With the addition of libuv support, libev is not the only event loop
287 library in town and his api names must be elaborated with _ev_
289 Callback typedef: lws_signal_cb ---> lws_ev_signal_cb_t
290 lws_sigint_cfg --> lws_ev_sigint_cfg
291 lws_initloop --> lws_ev_initloop
292 lws_sigint_cb --> lws_ev_sigint_cb
294 10) Libev support is made compatible with multithreaded service,
295 lws_ev_initloop (was lws_initloop) gets an extra argument for the
296 thread service index (use 0 if you will just have 1 service thread).
298 LWS_VISIBLE LWS_EXTERN int
299 lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi);
302 v1.6.0-chrome48-firefox42
303 =======================
305 Major API improvements
306 ----------------------
308 v1.6.0 has many cleanups and improvements in the API. Although at first it
309 looks pretty drastic, user code will only need four actions to update it.
311 - Do the three search/replaces in your user code, /libwebsocket_/lws_/,
312 /libwebsockets_/lws_/, and /struct\ libwebsocket/struct\ lws/
314 - Remove the context parameter from your user callbacks
316 - Remove context as the first parameter from the "Eleven APIS" listed in the
317 User Api Changes section
319 - Add lws_get_context(wsi) as the first parameter on the "Three APIS" listed
320 in the User Api Changes section, and anywhere else you still need context
322 That's it... generally only a handful of the 14 affected APIs are actually in
323 use in your user code and you can find them quickest by compiling and visiting
324 the errors each in turn. And the end results are much cleaner, more
325 predictable and maintainable.
331 1) lws now exposes his internal platform file abstraction in a way that can be
332 both used by user code to make it platform-agnostic, and be overridden or
333 subclassed by user code. This allows things like handling the URI "directory
334 space" as a virtual filesystem that may or may not be backed by a regular
335 filesystem. One example use is serving files from inside large compressed
336 archive storage without having to unpack anything except the file being
339 The test server shows how to use it, basically the platform-specific part of
340 lws prepares a file operations structure that lives in the lws context.
342 Helpers are provided to also leverage these platform-independent file handling
345 static inline lws_filefd_type
346 lws_plat_file_open(struct lws *wsi, const char *filename,
347 unsigned long *filelen, int flags)
349 lws_plat_file_close(struct lws *wsi, lws_filefd_type fd)
351 static inline unsigned long
352 lws_plat_file_seek_cur(struct lws *wsi, lws_filefd_type fd, long offset)
355 lws_plat_file_read(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
356 unsigned char *buf, unsigned long len)
359 lws_plat_file_write(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
360 unsigned char *buf, unsigned long len)
362 The user code can also override or subclass the file operations, to either
363 wrap or replace them. An example is shown in test server.
365 A wsi can be associated with the file activity, allowing per-connection
366 authentication and state to be used when interpreting the file request.
368 2) A new API void * lws_wsi_user(struct lws *wsi) lets you get the pointer to
369 the user data associated with the wsi, just from the wsi.
371 3) URI argument handling. Libwebsockets parses and protects URI arguments
372 like test.html?arg1=1&arg2=2, it decodes %xx uriencoding format and reduces
373 path attacks like ../.../../etc/passwd so they cannot go behind the web
374 server's /. There is a list of confirmed attacks we're proof against in
375 ./test-server/attack.sh.
377 There is a new API lws_hdr_copy_fragment that should be used now to access
378 the URI arguments (it returns the fragments length)
380 while (lws_hdr_copy_fragment(wsi, buf, sizeof(buf),
381 WSI_TOKEN_HTTP_URI_ARGS, n) > 0) {
382 lwsl_info("URI Arg %d: %s\n", ++n, buf);
385 For the example above, calling with n=0 will return "arg1=1" and n=1 "arg2=2".
386 All legal uriencodings will have been reduced in those strings.
388 lws_hdr_copy_fragment() returns the length of the x=y fragment, so it's also
389 possible to deal with arguments containing %00. If you don't care about that,
390 the returned string has '\0' appended to simplify processing.
398 - lws_callback_on_writable_all_protocol(const struct lws_protocols *protocol)
399 - lws_callback_all_protocol(const struct lws_protocols *protocol)
400 - lws_rx_flow_allow_all_protocol(lws_rx_flow_allow_all_protocol)
402 Now take an additional pointer to the lws_context in their first argument.
404 The reason for this change is struct lws_protocols has been changed to remove
405 members that lws used for private storage: so the protocols struct in now
406 truly const and may be reused serially or simultaneously by different contexts.
410 LWS_VISIBLE LWS_EXTERN int
411 lws_add_http_header_by_name(struct lws_context *context,
413 const unsigned char *name,
414 const unsigned char *value,
418 LWS_VISIBLE LWS_EXTERN int
419 lws_finalize_http_header(struct lws_context *context,
423 LWS_VISIBLE LWS_EXTERN int
424 lws_add_http_header_by_token(struct lws_context *context,
426 enum lws_token_indexes token,
427 const unsigned char *value,
431 LWS_VISIBLE LWS_EXTERN int
432 lws_add_http_header_content_length(struct lws_context *context,
434 unsigned long content_length,
437 LWS_VISIBLE LWS_EXTERN int
438 lws_add_http_header_status(struct lws_context *context, struct lws *wsi,
439 unsigned int code, unsigned char **p,
442 LWS_VISIBLE LWS_EXTERN int
443 lws_serve_http_file(struct lws_context *context, struct lws *wsi,
444 const char *file, const char *content_type,
445 const char *other_headers, int other_headers_len);
446 LWS_VISIBLE LWS_EXTERN int
447 lws_serve_http_file_fragment(struct lws_context *context, struct lws *wsi);
449 LWS_VISIBLE LWS_EXTERN int
450 lws_return_http_status(struct lws_context *context, struct lws *wsi,
451 unsigned int code, const char *html_body);
453 LWS_VISIBLE LWS_EXTERN int
454 lws_callback_on_writable(const struct lws_context *context, struct lws *wsi);
456 LWS_VISIBLE LWS_EXTERN void
457 lws_get_peer_addresses(struct lws_context *context, struct lws *wsi,
458 lws_sockfd_type fd, char *name, int name_len,
459 char *rip, int rip_len);
461 LWS_VISIBLE LWS_EXTERN int
462 lws_read(struct lws_context *context, struct lws *wsi,
463 unsigned char *buf, size_t len);
465 no longer require their initial struct lws_context * parameter.
467 3) Several older apis start with libwebsocket_ or libwebsockets_ while newer ones
468 all begin lws_. These apis have been changed to all begin with lws_.
470 To convert, search-replace
472 - libwebsockets_/lws_
474 - struct\ libwebsocket/struct\ lws
476 4) context parameter removed from user callback.
478 Since almost all apis no longer need the context as a parameter, it's no longer
479 provided at the user callback directly.
481 However if you need it, for ALL callbacks wsi is valid and has a valid context
482 pointer you can recover using lws_get_context(wsi).
485 v1.5-chrome47-firefox41
486 =======================
491 LWS_CALLBACK_CLIENT_CONNECTION_ERROR may provide an error string if in is
492 non-NULL. If so, the string has length len.
494 LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED is available to relax the requirement
495 for peer certs if you are using the option to require client certs.
497 LWS_WITHOUT_BUILTIN_SHA1 cmake option forces lws to use SHA1() defined
498 externally, eg, byOpenSSL, and disables build of libwebsockets_SHA1()
501 v1.4-chrome43-firefox36
502 =======================
507 There's a new member in the info struct used to control context creation,
508 ssl_private_key_password, which allows passing into lws the passphrase on
511 There's a new member in struct protocols, id, which is ignored by lws but can
512 be used by the user code to mark the selected protocol by user-defined version
513 or capabliity flag information, for the case multiple versions of a protocol are
516 int lws_is_ssl(wsi) added to allow user code to know if the connection was made
517 over ssl or not. If LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT is used, both
518 ssl and non-ssl connections are possible and may need to be treated differently
521 int lws_partial_buffered(wsi) added... should be checked after any
522 libwebsocket_write that will be followed by another libwebsocket_write inside
523 the same writeable callback. If set, you can't do any more writes until the
524 writeable callback is called again. If you only do one write per writeable callback,
527 HTTP2-related: HTTP2 changes how headers are handled, lws now has new version-
528 agnositic header creation APIs. These do the right thing depending on each
529 connection's HTTP version without the user code having to know or care, except
530 to make sure to use the new APIs for headers (test-server is updated to use
531 them already, so look there for examples)
533 The APIs "render" the headers into a user-provided buffer and bump *p as it
534 is used. If *p reaches end, then the APIs return nonzero for error.
536 LWS_VISIBLE LWS_EXTERN int
537 lws_add_http_header_status(struct libwebsocket_context *context,
538 struct libwebsocket *wsi,
543 Start a response header reporting status like 200, 500, etc
545 LWS_VISIBLE LWS_EXTERN int
546 lws_add_http_header_by_name(struct libwebsocket_context *context,
547 struct libwebsocket *wsi,
548 const unsigned char *name,
549 const unsigned char *value,
554 Add a header like name: value in HTTP1.x
556 LWS_VISIBLE LWS_EXTERN int
557 lws_finalize_http_header(struct libwebsocket_context *context,
558 struct libwebsocket *wsi,
562 Finish off the headers, like add the extra \r\n in HTTP1.x
564 LWS_VISIBLE LWS_EXTERN int
565 lws_add_http_header_by_token(struct libwebsocket_context *context,
566 struct libwebsocket *wsi,
567 enum lws_token_indexes token,
568 const unsigned char *value,
573 Add a header by using a lws token as the name part. In HTTP2, this can be
574 compressed to one or two bytes.
580 protocols struct member no_buffer_all_partial_tx is removed. Under some
581 conditions like rewriting extension such as compression in use, the built-in
582 partial send buffering is the only way to deal with the problem, so turning
583 it off is deprecated.
589 HTTP2-related: API libwebsockets_serve_http_file() takes an extra parameter at
592 int other_headers_len)
594 If you are providing other headers, they must be generated using the new
595 HTTP-version-agnostic APIs, and you must provide the length of them using this
596 additional parameter.
598 struct lws_context_creation_info now has an additional member
599 SSL_CTX *provided_client_ssl_ctx you may set to an externally-initialized
600 SSL_CTX managed outside lws. Defaulting to zero keeps the existing behaviour of
601 lws managing the context, if you memset the struct to 0 or have as a filescope
602 initialized struct in bss, no need to change anything.
605 v1.3-chrome37-firefox30
606 =======================
609 CMakeLists.txt | 447 +++--
613 cmake/LibwebsocketsConfig.cmake.in | 17 +
614 cmake/LibwebsocketsConfigVersion.cmake.in | 11 +
615 config.h.cmake | 18 +
616 cross-ming.cmake | 31 +
617 cross-openwrt-makefile | 91 +
618 lib/client-handshake.c | 205 ++-
619 lib/client-parser.c | 58 +-
620 lib/client.c | 158 +-
621 lib/context.c | 341 ++++
622 lib/extension-deflate-frame.c | 2 +-
623 lib/extension.c | 178 ++
624 lib/handshake.c | 287 +---
625 lib/lextable.h | 338 ++++
627 lib/libwebsockets.c | 2089 +++--------------------
628 lib/libwebsockets.h | 253 ++-
629 lib/lws-plat-unix.c | 404 +++++
630 lib/lws-plat-win.c | 358 ++++
631 lib/minilex.c | 530 +++---
632 lib/output.c | 445 ++---
633 lib/parsers.c | 682 ++++----
634 lib/pollfd.c | 239 +++
635 lib/private-libwebsockets.h | 501 +++++-
636 lib/server-handshake.c | 274 +--
637 lib/server.c | 858 ++++++++--
638 lib/service.c | 517 ++++++
640 lib/ssl-http2.c | 78 +
641 lib/ssl.c | 571 +++++++
642 test-server/attack.sh | 101 +-
643 test-server/test-client.c | 9 +-
644 test-server/test-echo.c | 17 +-
645 test-server/test-fraggle.c | 7 -
646 test-server/test-ping.c | 12 +-
647 test-server/test-server.c | 330 ++--
648 test-server/test.html | 4 +-
649 win32port/client/client.vcxproj | 259 ---
650 win32port/client/client.vcxproj.filters | 39 -
651 .../libwebsocketswin32.vcxproj.filters | 93 -
652 win32port/server/server.vcxproj | 276 ---
653 win32port/server/server.vcxproj.filters | 51 -
654 win32port/win32helpers/gettimeofday.h | 59 +-
655 win32port/win32helpers/netdb.h | 1 -
656 win32port/win32helpers/strings.h | 0
657 win32port/win32helpers/sys/time.h | 1 -
658 win32port/win32helpers/unistd.h | 0
659 win32port/win32helpers/websock-w32.c | 104 --
660 win32port/win32helpers/websock-w32.h | 62 -
661 win32port/win32port.sln | 100 --
662 win32port/zlib/gzio.c | 3 +-
663 55 files changed, 6779 insertions(+), 5059 deletions(-)
669 POST method is supported
671 The protocol 0 / HTTP callback can now get two new kinds of callback,
672 LWS_CALLBACK_HTTP_BODY (in and len are a chunk of the body of the HTTP request)
673 and LWS_CALLBACK_HTTP_BODY_COMPLETION (the expected amount of body has arrived
674 and been passed to the user code already). These callbacks are used with the
675 post method (see the test server for details).
677 The period between the HTTP header completion and the completion of the body
678 processing is protected by a 5s timeout.
680 The chunks are stored in a malloc'd buffer of size protocols[0].rx_buffer_size.
683 New server option you can enable from user code
684 LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT allows non-SSL connections to
685 also be accepted on an SSL listening port. It's disabled unless you enable
689 Two new callbacks are added in protocols[0] that are optional for allowing
690 limited thread access to libwebsockets, LWS_CALLBACK_LOCK_POLL and
691 LWS_CALLBACK_UNLOCK_POLL.
693 If you use them, they protect internal and external poll list changes, but if
694 you want to use external thread access to libwebsocket_callback_on_writable()
695 you have to implement your locking here even if you don't use external
698 If you will use another thread for this, take a lot of care about managing
699 your list of live wsi by doing it from ESTABLISHED and CLOSED callbacks
700 (with your own locking).
702 If you configure cmake with -DLWS_WITH_LIBEV=1 then the code allowing the libev
703 eventloop instead of the default poll() one will also be compiled in. But to
704 use it, you must also set the LWS_SERVER_OPTION_LIBEV flag on the context
705 creation info struct options member.
707 IPV6 is supported and enabled by default except for Windows, you can disable
708 the support at build-time by giving -DLWS_IPV6=, and disable use of it even if
709 compiled in by making sure the flag LWS_SERVER_OPTION_DISABLE_IPV6 is set on
710 the context creation info struct options member.
712 You can give LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS option flag to
713 guarantee the OS CAs will not be used, even if that support was selected at
716 Optional "token limits" may be enforced by setting the member "token_limits"
717 in struct lws_context_creation_info to point to a struct lws_token_limits.
718 NULL means no token limits used for compatibility.
724 Extra optional argument to libwebsockets_serve_http_file() allows injecion
725 of HTTP headers into the canned response. Eg, cookies may be added like
726 that without getting involved in having to send the header by hand.
728 A new info member http_proxy_address may be used at context creation time to
729 set the http proxy. If non-NULL, it overrides http_proxy environment var.
731 Cmake supports LWS_SSL_CLIENT_USE_OS_CA_CERTS defaulting to on, which gets
732 the client to use the OS CA Roots. If you're worried somebody with the
733 ability to forge for force creation of a client cert from the root CA in
734 your OS, you should disable this since your selfsigned $0 cert is a lot safer
738 v1.23-chrome32-firefox24
739 ========================
742 CMakeLists.txt | 573 ++++++++----
743 COPYING | 503 -----------
744 INSTALL | 365 --------
746 README.build | 371 ++------
747 README.coding | 63 ++
748 autogen.sh | 1578 ---------------------------------
750 cmake/FindGit.cmake | 163 ++++
751 cmake/FindOpenSSLbins.cmake | 15 +-
752 cmake/UseRPMTools.cmake | 176 ++++
753 config.h.cmake | 25 +-
754 configure.ac | 226 -----
755 cross-arm-linux-gnueabihf.cmake | 28 +
756 lib/Makefile.am | 89 --
757 lib/base64-decode.c | 98 +-
758 lib/client-handshake.c | 123 ++-
759 lib/client-parser.c | 19 +-
760 lib/client.c | 145 ++-
761 lib/daemonize.c | 4 +-
762 lib/extension.c | 2 +-
763 lib/getifaddrs.h | 4 +-
764 lib/handshake.c | 76 +-
765 lib/libwebsockets.c | 491 ++++++----
766 lib/libwebsockets.h | 164 ++--
767 lib/output.c | 214 ++++-
768 lib/parsers.c | 102 +--
769 lib/private-libwebsockets.h | 66 +-
770 lib/server-handshake.c | 5 +-
773 libwebsockets-api-doc.html | 249 +++---
774 libwebsockets.pc.in | 11 -
775 libwebsockets.spec | 14 +-
777 scripts/FindLibWebSockets.cmake | 33 +
778 scripts/kernel-doc | 1 +
779 test-server/Makefile.am | 131 ---
780 test-server/leaf.jpg | Bin 0 -> 2477518 bytes
781 test-server/test-client.c | 78 +-
782 test-server/test-echo.c | 33 +-
783 test-server/test-fraggle.c | 26 +-
784 test-server/test-ping.c | 15 +-
785 test-server/test-server.c | 197 +++-
786 test-server/test.html | 5 +-
787 win32port/win32helpers/gettimeofday.c | 74 +-
788 win32port/win32helpers/websock-w32.h | 6 +-
789 48 files changed, 2493 insertions(+), 4212 deletions(-)
795 - You can now call libwebsocket_callback_on_writable() on http connectons,
796 and get a LWS_CALLBACK_HTTP_WRITEABLE callback, the same way you can
797 regulate writes with a websocket protocol connection.
799 - A new member in the context creation parameter struct "ssl_cipher_list" is
800 added, replacing CIPHERS_LIST_STRING. NULL means use the ssl library
801 default list of ciphers.
803 - Not really an api addition, but libwebsocket_service_fd() will now zero
804 the revents field of the pollfd it was called with if it handled the
805 descriptor. So you can tell if it is a non-lws fd by checking revents
806 after the service call... if it's still nonzero, the descriptor
807 belongs to you and you need to take care of it.
809 - libwebsocket_rx_flow_allow_all_protocol(protocol) will unthrottle all
810 connections with the established protocol. It's designed to be
811 called from user server code when it sees it can accept more input
812 and may have throttled connections using the server rx flow apis
813 while it was unable to accept any other input The user server code
814 then does not have to try to track while connections it choked, this
815 will free up all of them in one call.
817 - there's a new, optional callback LWS_CALLBACK_CLOSED_HTTP which gets
818 called when an HTTP protocol socket closes
820 - for LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION callback, the user_space alloc
821 has already been done before the callback happens. That means we can
822 use the user parameter to the callback to contain the user pointer, and
823 move the protocol name to the "in" parameter. The docs for this
824 callback are also updated to reflect how to check headers in there.
826 - libwebsocket_client_connect() is now properly nonblocking and async. See
827 README.coding and test-client.c for information on the callbacks you
828 can rely on controlling the async connection period with.
830 - if your OS does not support the http_proxy environment variable convention
831 (eg, reportedly OSX), you can use a new api libwebsocket_set_proxy()
832 to set the proxy details in between context creation and the connection
833 action. For OSes that support http_proxy, that's used automatically.
838 - the external poll callbacks now get the socket descriptor coming from the
839 "in" parameter. The user parameter provides the user_space for the
840 wsi as it normally does on the other callbacks.
841 LWS_CALLBACK_FILTER_NETWORK_CONNECTION also has the socket descriptor
842 delivered by @in now instead of @user.
844 - libwebsocket_write() now returns -1 for error, or the amount of data
845 actually accepted for send. Under load, the OS may signal it is
846 ready to send new data on the socket, but have only a restricted
847 amount of memory to buffer the packet compared to usual.
853 - libwebsocket_ensure_user_space() is removed from the public api, if you
854 were using it to get user_space, you need to adapt your code to only
855 use user_space inside the user callback.
857 - CIPHERS_LIST_STRING is removed
859 - autotools build has been removed. See README.build for info on how to
860 use CMake for your platform
863 v1.21-chrome26-firefox18
864 ========================
866 - Fixes buffer overflow bug in max frame size handling if you used the
867 default protocol buffer size. If you declared rx_buffer_size in your
868 protocol, which is recommended anyway, your code was unaffected.
870 v1.2-chrome26-firefox18
871 =======================
877 CMakeLists.txt | 544 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
878 LICENSE | 526 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
881 README.build | 258 ++++++++++++++++++++++++++++++++-----
882 README.coding | 52 ++++++++
883 changelog | 136 ++++++++++++++++++++
884 cmake/FindOpenSSLbins.cmake | 33 +++++
885 config.h.cmake | 173 +++++++++++++++++++++++++
886 configure.ac | 22 +++-
887 lib/Makefile.am | 20 ++-
888 lib/base64-decode.c | 2 +-
889 lib/client-handshake.c | 190 +++++++++++-----------------
890 lib/client-parser.c | 88 +++++++------
891 lib/client.c | 384 ++++++++++++++++++++++++++++++-------------------------
892 lib/daemonize.c | 32 +++--
893 lib/extension-deflate-frame.c | 58 +++++----
894 lib/extension-deflate-stream.c | 19 ++-
895 lib/extension-deflate-stream.h | 4 +-
896 lib/extension.c | 11 +-
897 lib/getifaddrs.c | 315 +++++++++++++++++++++++-----------------------
898 lib/getifaddrs.h | 30 ++---
899 lib/handshake.c | 124 +++++++++++-------
900 lib/libwebsockets.c | 736 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------------------------
901 lib/libwebsockets.h | 237 ++++++++++++++++++++++------------
902 lib/output.c | 192 +++++++++++-----------------
903 lib/parsers.c | 966 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----------------------------------------------------------------
904 lib/private-libwebsockets.h | 225 +++++++++++++++++++++------------
905 lib/server-handshake.c | 82 ++++++------
906 lib/server.c | 96 +++++++-------
907 libwebsockets-api-doc.html | 189 ++++++++++++++++++----------
908 libwebsockets.spec | 17 +--
909 test-server/attack.sh | 148 ++++++++++++++++++++++
910 test-server/test-client.c | 125 +++++++++---------
911 test-server/test-echo.c | 31 +++--
912 test-server/test-fraggle.c | 32 ++---
913 test-server/test-ping.c | 52 ++++----
914 test-server/test-server.c | 129 ++++++++++++-------
915 win32port/libwebsocketswin32/libwebsocketswin32.vcxproj | 279 ----------------------------------------
916 win32port/libwebsocketswin32/libwebsocketswin32.vcxproj.filters | 23 +++-
917 41 files changed, 4398 insertions(+), 2219 deletions(-)
923 - lws_get_library_version() returns a const char * with a string like
924 "1.1 9e7f737", representing the library version from configure.ac
925 and the git HEAD hash the library was built from
927 - TCP Keepalive can now optionally be applied to all lws sockets, on Linux
928 also with controllable timeout, number of probes and probe interval.
929 (On BSD type OS, you can only use system default settings for the
930 timing and retries, although enabling it is supported by setting
931 ka_time to nonzero, the exact value has no meaning.)
932 This enables detection of idle connections which are logically okay,
933 but are in fact dead, due to network connectivity issues at the server,
934 client, or any intermediary. By default it's not enabled, but you
935 can enable it by setting a non-zero timeout (in seconds) at the new
936 ka_time member at context creation time.
938 - Two new optional user callbacks added, LWS_CALLBACK_PROTOCOL_DESTROY which
939 is called one-time per protocol as the context is being destroyed, and
940 LWS_CALLBACK_PROTOCOL_INIT which is called when the context is created
941 and the protocols are added, again it's a one-time affair.
942 This lets you manage per-protocol allocations properly including
943 cleaning up after yourself when the server goes down.
948 - libwebsocket_create_context() has changed from taking a ton of parameters
949 to just taking a pointer to a struct containing the parameters. The
950 struct lws_context_creation_info is in libwebsockets.h, the members
951 are in the same order as when they were parameters to the call
952 previously. The test apps are all updated accordingly so you can
953 see example code there.
955 - Header tokens are now deleted after the websocket connection is
956 established. Not just the header data is saved, but the pointer and
957 length array is also removed from (union) scope saving several hundred
958 bytes per connection once it is established
960 - struct libwebsocket_protocols has a new member rx_buffer_size, this
961 controls rx buffer size per connection of that protocol now. Sources
962 for apps built against older versions of the library won't declare
963 this in their protocols, defaulting it to 0. Zero buffer is legal,
964 it causes a default buffer to be allocated (currently 4096)
966 If you want to receive only atomic frames in your user callback, you
967 should set this to greater than your largest frame size. If a frame
968 comes that exceeds that, no error occurs but the callback happens as
969 soon as the buffer limit is reached, and again if it is reached again
970 or the frame completes. You can detect that has happened by seeing
971 there is still frame content pending using
972 libwebsockets_remaining_packet_payload()
974 By correctly setting this, you can save a lot of memory when your
975 protocol has small frames (see the test server and client sources).
977 - LWS_MAX_HEADER_LEN now defaults to 1024 and is the total amount of known
978 header payload lws can cope with, that includes the GET URL, origin
979 etc. Headers not understood by lws are ignored and their payload
980 not included in this.
986 - The configuration-time option MAX_USER_RX_BUFFER has been replaced by a
987 buffer size chosen per-protocol. For compatibility, there's a default
988 of 4096 rx buffer, but user code should set the appropriate size for
991 - LWS_INITIAL_HDR_ALLOC and LWS_ADDITIONAL_HDR_ALLOC are no longer needed
992 and have been removed. There's a new header management scheme that
993 handles them in a much more compact way.
995 - libwebsockets_hangup_on_client() is removed. If you want to close the
996 connection you must do so from the user callback and by returning
999 - libwebsocket_close_and_free_session() is now private to the library code
1000 only and not exposed for user code. If you want to close the
1001 connection, you must do so from the user callback by returning -1
1008 - Cmake project file added, aimed initially at Windows support: this replaces
1009 the visual studio project files that were in the tree until now.
1011 - CyaSSL now supported in place of OpenSSL (--use-cyassl on configure)
1013 - PATH_MAX or MAX_PATH no longer needed
1015 - cutomizable frame rx buffer size by protocol
1017 - optional TCP keepalive so dead peers can be detected, can be enabled at
1018 context-creation time
1020 - valgrind-clean: no SSL or CyaSSL: completely clean. With OpenSSL, 88 bytes
1021 lost at OpenSSL library init and symptomless reports of uninitialized
1022 memory usage... seems to be a known and ignored problem at OpenSSL
1024 - By default debug is enabled and the library is built for -O0 -g to faclitate
1025 that. Use --disable-debug configure option to build instead with -O4
1026 and no -g (debug info), obviously providing best performance and
1027 reduced binary size.
1029 - 1.0 introduced some code to try to not deflate small frames, however this
1030 seems to break when confronted with a mixture of frames above and
1031 below the threshold, so it's removed. Veto the compression extension
1032 in your user callback if you will typically have very small frames.
1034 - There are many memory usage improvements, both a reduction in malloc/
1035 realloc and architectural changes. A websocket connection now
1036 consumes only 296 bytes with SSL or 272 bytes without on x86_64,
1037 during header processing an additional 1262 bytes is allocated in a
1038 single malloc, but is freed when the websocket connection starts.
1039 The RX frame buffer defined by the protocol in user
1040 code is also allocated per connection, this represents the largest
1041 frame you can receive atomically in that protocol.
1043 - On ARM9 build, just http+ws server no extensions or ssl, <12Kbytes .text
1044 and 112 bytes per connection (+1328 only during header processing)
1047 v1.1-chrome26-firefox18
1048 =======================
1054 README-test-server | 291 ---
1055 README.build | 239 ++
1056 README.coding | 138 ++
1058 README.test-apps | 272 +++
1059 configure.ac | 116 +-
1060 lib/Makefile.am | 55 +-
1061 lib/base64-decode.c | 5 +-
1062 lib/client-handshake.c | 121 +-
1063 lib/client-parser.c | 394 ++++
1064 lib/client.c | 807 +++++++
1065 lib/daemonize.c | 212 ++
1066 lib/extension-deflate-frame.c | 132 +-
1067 lib/extension-deflate-stream.c | 12 +-
1068 lib/extension-x-google-mux.c | 1223 ----------
1069 lib/extension-x-google-mux.h | 96 -
1070 lib/extension.c | 8 -
1071 lib/getifaddrs.c | 271 +++
1072 lib/getifaddrs.h | 76 +
1073 lib/handshake.c | 582 +----
1074 lib/libwebsockets.c | 2493 ++++++---------------
1075 lib/libwebsockets.h | 115 +-
1077 lib/minilex.c | 440 ++++
1078 lib/output.c | 628 ++++++
1079 lib/parsers.c | 2016 +++++------------
1080 lib/private-libwebsockets.h | 284 +--
1081 lib/server-handshake.c | 275 +++
1082 lib/server.c | 377 ++++
1083 libwebsockets-api-doc.html | 300 +--
1085 test-server/Makefile.am | 111 +-
1086 test-server/libwebsockets.org-logo.png | Bin 0 -> 7029 bytes
1087 test-server/test-client.c | 45 +-
1088 test-server/test-echo.c | 330 +++
1089 test-server/test-fraggle.c | 20 +-
1090 test-server/test-ping.c | 22 +-
1091 test-server/test-server-extpoll.c | 554 -----
1092 test-server/test-server.c | 349 ++-
1093 test-server/test.html | 3 +-
1094 win32port/zlib/ZLib.vcxproj | 749 ++++---
1095 win32port/zlib/ZLib.vcxproj.filters | 188 +-
1096 win32port/zlib/adler32.c | 348 ++-
1097 win32port/zlib/compress.c | 160 +-
1098 win32port/zlib/crc32.c | 867 ++++----
1099 win32port/zlib/crc32.h | 882 ++++----
1100 win32port/zlib/deflate.c | 3799 +++++++++++++++-----------------
1101 win32port/zlib/deflate.h | 688 +++---
1102 win32port/zlib/gzclose.c | 50 +-
1103 win32port/zlib/gzguts.h | 325 ++-
1104 win32port/zlib/gzlib.c | 1157 +++++-----
1105 win32port/zlib/gzread.c | 1242 ++++++-----
1106 win32port/zlib/gzwrite.c | 1096 +++++----
1107 win32port/zlib/infback.c | 1272 ++++++-----
1108 win32port/zlib/inffast.c | 680 +++---
1109 win32port/zlib/inffast.h | 22 +-
1110 win32port/zlib/inffixed.h | 188 +-
1111 win32port/zlib/inflate.c | 2976 +++++++++++++------------
1112 win32port/zlib/inflate.h | 244 +-
1113 win32port/zlib/inftrees.c | 636 +++---
1114 win32port/zlib/inftrees.h | 124 +-
1115 win32port/zlib/trees.c | 2468 +++++++++++----------
1116 win32port/zlib/trees.h | 256 +--
1117 win32port/zlib/uncompr.c | 118 +-
1118 win32port/zlib/zconf.h | 934 ++++----
1119 win32port/zlib/zlib.h | 3357 ++++++++++++++--------------
1120 win32port/zlib/zutil.c | 642 +++---
1121 win32port/zlib/zutil.h | 526 ++---
1122 69 files changed, 19556 insertions(+), 20145 deletions(-)
1127 - libwebsockets_serve_http_file() now takes a context as first argument
1129 - libwebsockets_get_peer_addresses() now takes a context and wsi as first
1136 - lwsl_...() logging apis, default to stderr but retargetable by user code;
1137 may be used also by user code
1139 - lws_set_log_level() set which logging apis are able to emit (defaults to
1140 notice, warn, err severities), optionally set the emit callback
1142 - lwsl_emit_syslog() helper callback emits to syslog
1144 - lws_daemonize() helper code that forks the app into a headless daemon
1145 properly, maintains a lock file with pid in suitable for sysvinit etc to
1148 - LWS_CALLBACK_HTTP_FILE_COMPLETION callback added since http file
1149 transfer is now asynchronous (see test server code)
1151 - lws_frame_is_binary() from a wsi pointer, let you know if the received
1152 data was sent in BINARY mode
1158 - libwebsockets_fork_service_loop() - no longer supported (had intractable problems)
1159 arrange your code to act from the user callback instead from same
1160 process context as the service loop
1162 - libwebsockets_broadcast() - use libwebsocket_callback_on_writable[_all_protocol]()
1163 instead from same process context as the service loop. See the test apps
1166 - x-google-mux() removed until someone wants it
1168 - pre -v13 (ancient) protocol support removed
1174 - echo test server and client compatible with echo.websocket.org added
1176 - many new configure options (see README.build) to reduce footprint of the
1177 library to what you actually need, eg, --without-client and
1180 - http + websocket server can build to as little as 12K .text for ARM
1182 - no more MAX_CLIENTS limitation; adapts to support the max number of fds
1183 allowed to the process by ulimit, defaults to 1024 on Fedora and
1184 Ubuntu. Use ulimit to control this without needing to configure
1185 the library. Code here is smaller and faster.
1187 - adaptive ratio of listen socket to connection socket service allows
1188 good behaviour under Apache ab test load. Tested with thousands
1189 of simultaneous connections
1191 - reduction in per-connection memory footprint by moving to a union to hold
1192 mutually-exclusive state for the connection
1194 - robustness: Out of Memory taken care of for all allocation code now
1196 - internal getifaddrs option if your toolchain lacks it (some uclibc)
1198 - configurable memory limit for deflate operations
1200 - improvements in SSL code nonblocking operation, possible hang solved,
1201 some SSL operations broken down into pollable states so there is
1202 no library blocking, timeout coverage for SSL_connect
1204 - extpoll test server merged into single test server source
1206 - robustness: library should deal with all recoverable socket conditions
1208 - rx flowcontrol for backpressure notification fixed and implmeneted
1209 correctly in the test server
1211 - optimal lexical parser added for header processing; all headers in a
1212 single 276-byte state table
1214 - latency tracking api added (configure --with-latency)
1216 - Improved in-tree documentation, REAME.build, README.coding,
1217 README.test-apps, changelog
1222 v1.0-chrome25-firefox17 (6cd1ea9b005933f)