7 1) MAJOR connections on ah waiting list that closed did not get removed from
14 NB: No API change since v1.7.0
19 1) libuv one-per-session valgrind leak fixed
21 2) MINOR An error about hdr struct in _lws_ws_related is corrected, it's not
22 known to affect anything added until after it was fixed
24 3) MINOR During the close shutdown wait state introduced at v1.7, if something
25 requests callback on writeable for the socket it will busywait until the
28 4) MINOR update URLs in test html for libwebsockets.org https STS changes
33 1) test server html is updated with tabs and a new live server monitoring
34 feature. Input sanitization added to the js.
40 NB: No API change since v1.7.0
45 1) MAJOR (Windows-only) fix assert firing
47 2) MAJOR http:/1.1 connections handled by lws_return_http_status() did not
48 get sent a content-length resulting in the link hanging until the peer closed
49 it. attack.sh updated to add a test for this.
55 1) MINOR test-server gained some new switches
57 -C <file> use external SSL cert file
58 -K <file> use external SSL key file
59 -A <file> use external SSL CA cert file
61 -u <uid> set effective uid
62 -g <gid> set effective gid
64 together you can use them like this to have the test-server work with the
65 usual purchased SSL certs from an official CA.
67 --ssl -C your.crt -K your.key -A your.cer -u 99 -g 99
69 2) MINOR the OpenSSL magic to setup ECDH cipher usage is implemented in the
70 library, and the ciphers restricted to use ECDH only.
71 Using this, the lws test server can score an A at SSLLABS test
73 3) MINOR STS (SSL always) header is added to the test server if you use --ssl. With
74 that, we score A+ at SSLLABS test
76 4) MINOR daemonize function (disabled at cmake by default) is updated to work
79 5) MINOR example systemd .service file now provided for test server
80 (not installed by default)
89 1) There is now a "permessage-deflate" / RFC7692 implementation. It's very
90 similar to "deflate-frame" we have offered for a long while; deflate-frame is
91 now provided as an alias of permessage-deflate.
93 The main differences are that the new permessage-deflate implementation:
95 - properly performs streaming respecting input and output buffer limits. The
96 old deflate-frame implementation could only work on complete deflate input
97 and produce complete inflate output for each frame. The new implementation
98 only mallocs buffers at initialization.
100 - goes around the event loop after each input package is processed allowing
101 interleaved output processing. The RX flow control api can be used to
102 force compressed input processing to match the rate of compressed output
103 processing (test--echo shows an example of how to do this).
105 - when being "deflate-frame" for compatibility he uses the same default zlib
106 settings as the old "deflate-frame", but instead of exponentially increasing
107 malloc allocations until the whole output will fit, he observes the default
108 input and output chunking buffer sizes of "permessage-deflate", that's
109 1024 in and 1024 out at a time.
111 2) deflate-stream has been disabled for many versions (for over a year) and is
112 now removed. Browsers are now standardizing on "permessage-deflate" / RFC7692
114 3) struct lws_extension is simplified, and lws extensions now have a public
115 api (their callback) for use in user code to compose extensions and options
116 the user code wants. lws_get_internal_exts() is deprecated but kept around
117 as a NOP. The changes allow one extension implementation to go by different
118 names and allows the user client code to control option offers per-ext.
120 The test client and server are updated to use the new way. If you use
121 the old way it should still work, but extensions will be disabled until you
124 Extensions are now responsible for allocating and per-instance private struct
125 at instance construction time and freeing it when the instance is destroyed.
126 Not needing to know the size means the extension's struct can be opaque
133 1) The info struct gained three new members
135 - max_http_header_data: 0 for default (1024) or set the maximum amount of known
136 http header payload that lws can deal with. Payload in unknown http
137 headers is dropped silently. If for some reason you need to send huge
138 cookies or other HTTP-level headers, you can now increase this at context-
141 - max_http_header_pool: 0 for default (16) or set the maximum amount of http
142 headers that can be tracked by lws in this context. For the server, if
143 the header pool is completely in use then accepts on the listen socket
144 are disabled until one becomes free. For the client, if you simultaneously
145 have pending connects for more than this number of client connections,
146 additional connects will fail until some of the pending connections timeout
149 - timeout_secs: 0 for default (currently 20s), or set the library's
150 network activity timeout to the given number of seconds
152 HTTP header processing in lws only exists until just after the first main
153 callback after the HTTP handshake... for ws connections that is ESTABLISHED and
154 for HTTP connections the HTTP callback.
156 So these settings are not related to the maximum number of simultaneous
157 connections, but the number of HTTP handshakes that may be expected or ongoing,
158 or have just completed, at one time. The reason it's useful is it changes the
159 memory allocation for header processing to be one-time at context creation
160 instead of every time there is a new connection, and gives you control over
163 Setting max_http_header_pool to 1 is fine it will just queue incoming
164 connections before the accept as necessary, you can still have as many
165 simultaneous post-header connections as you like. Since the http header
166 processing is completed and the allocation released after ESTABLISHED or the
167 HTTP callback, even with a pool of 1 many connections can be handled rapidly.
169 2) There is a new callback that allows the user code to get acccess to the
170 optional close code + aux data that may have been sent by the peer.
172 LWS_CALLBACK_WS_PEER_INITIATED_CLOSE:
173 The peer has sent an unsolicited Close WS packet. @in and
174 @len are the optional close code (first 2 bytes, network
175 order) and the optional additional information which is not
176 defined in the standard, and may be a string or non-human-
178 If you return 0 lws will echo the close and then close the
179 connection. If you return nonzero lws will just close the
182 As usual not handling it does the right thing, if you're not interested in it
185 The test server has "open and close" testing buttons at the bottom, if you
186 open and close that connection, on close it will send a close code 3000 decimal
187 and the string "Bye!" as the aux data.
189 The test server dumb-increment callback handles this callback reason and prints
191 lwsts[15714]: LWS_CALLBACK_WS_PEER_INITIATED_CLOSE: len 6
192 lwsts[15714]: 0: 0x0B
193 lwsts[15714]: 1: 0xB8
194 lwsts[15714]: 2: 0x42
195 lwsts[15714]: 3: 0x79
196 lwsts[15714]: 4: 0x65
197 lwsts[15714]: 5: 0x21
199 3) There is a new API to allow the user code to control the content of the
200 close frame sent when about to return nonzero from the user callback to
201 indicate the connection should close.
204 * lws_close_reason - Set reason and aux data to send with Close packet
205 * If you are going to return nonzero from the callback
206 * requesting the connection to close, you can optionally
207 * call this to set the reason the peer will be told if
210 * @wsi: The websocket connection to set the close reason on
211 * @status: A valid close status from websocket standard
212 * @buf: NULL or buffer containing up to 124 bytes of auxiliary data
213 * @len: Length of data in @buf to send
215 LWS_VISIBLE LWS_EXTERN void
216 lws_close_reason(struct lws *wsi, enum lws_close_status status,
217 unsigned char *buf, size_t len);
219 An extra button is added to the "open and close" test server page that requests
220 that the test server close the connection from his end.
222 The test server code will do so by
224 lws_close_reason(wsi, LWS_CLOSE_STATUS_GOINGAWAY,
225 (unsigned char *)"seeya", 5);
228 The browser shows the close code and reason he received
230 websocket connection CLOSED, code: 1001, reason: seeya
232 4) There's a new context creation time option flag
234 LWS_SERVER_OPTION_VALIDATE_UTF8
236 if you set it in info->options, then TEXT and CLOSE frames will get checked to
237 confirm that they contain valid UTF-8. If they don't, the connection will get
240 5) ECDH Certs are now supported. Enable the CMake option
242 cmake .. -DLWS_SSL_SERVER_WITH_ECDH_CERT=1
244 **and** the info->options flag
246 LWS_SERVER_OPTION_SSL_ECDH
248 to build in support and select it at runtime.
250 6) There's a new api lws_parse_uri() that simplifies chopping up
251 https://xxx:yyy/zzz uris into parts nicely. The test client now uses this
252 to allow proper uris as well as the old address style.
254 7) SMP support is integrated into LWS without any internal threading. It's
255 very simple to use, libwebsockets-test-server-pthread shows how to do it,
256 use -j <n> argument there to control the number of service threads up to 32.
258 Two new members are added to the info struct
260 unsigned int count_threads;
261 unsigned int fd_limit_per_thread;
263 leave them at the default 0 to get the normal singlethreaded service loop.
265 Set count_threads to n to tell lws you will have n simultaneous service threads
266 operating on the context.
268 There is still a single listen socket on one port, no matter how many
271 When a connection is made, it is accepted by the service thread with the least
272 connections active to perform load balancing.
274 The user code is responsible for spawning n threads running the service loop
275 associated to a specific tsi (Thread Service Index, 0 .. n - 1). See
276 the libwebsockets-test-server-pthread for how to do.
278 If you leave fd_limit_per_thread at 0, then the process limit of fds is shared
279 between the service threads; if you process was allowed 1024 fds overall then
280 each thread is limited to 1024 / n.
282 You can set fd_limit_per_thread to a nonzero number to control this manually, eg
283 the overall supported fd limit is less than the process allowance.
285 You can control the context basic data allocation for multithreading from Cmake
286 using -DLWS_MAX_SMP=, if not given it's set to 32. The serv_buf allocation
287 for the threads (currently 4096) is made at runtime only for active threads.
289 Because lws will limit the requested number of actual threads supported
290 according to LWS_MAX_SMP, there is an api lws_get_count_threads(context) to
291 discover how many threads were actually allowed when the context was created.
293 It's required to implement locking in the user code in the same way that
294 libwebsockets-test-server-pthread does it, for the FD locking callbacks.
296 If LWS_MAX_SMP=1, then there is no code related to pthreads compiled in the
297 library. If more than 1, a small amount of pthread mutex code is built into
302 LWS_VISIBLE struct lws *
303 lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd)
305 allows foreign sockets accepted by non-lws code to be adopted by lws as if they
306 had just been accepted by lws' own listen socket.
308 9) X-Real-IP: header has been added as WSI_TOKEN_HTTP_X_REAL_IP
310 10) Libuv support is added, there are new related user apis
312 typedef void (lws_uv_signal_cb_t)(uv_loop_t *l, uv_signal_t *w, int revents);
314 LWS_VISIBLE LWS_EXTERN int
315 lws_uv_sigint_cfg(struct lws_context *context, int use_uv_sigint,
316 lws_uv_signal_cb_t *cb);
318 LWS_VISIBLE LWS_EXTERN int
319 lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi);
322 lws_uv_sigint_cb(uv_loop_t *loop, uv_signal_t *watcher, int revents);
332 1) LWS_SEND_BUFFER_POST_PADDING is now 0 and deprecated. You can remove it; if
333 you still use it, obviously it does nothing. Old binary code with nonzero
334 LWS_SEND_BUFFER_POST_PADDING is perfectly compatible, the old code just
335 allocated a buffer bigger than the library is going to use.
337 The example apps no longer use LWS_SEND_BUFFER_POST_PADDING.
339 The only path who made use of it was sending with LWS_WRITE_CLOSE --->
341 2) Because of lws_close_reason() formalizing handling close frames,
342 LWS_WRITE_CLOSE is removed from libwebsockets.h. It was only of use to send
343 close frames...close frame content should be managed using lws_close_reason()
346 3) We check for invalid CLOSE codes and complain about protocol violation in
347 our close code. But it changes little since we were in the middle of closing
350 4) zero-length RX frames and zero length TX frames are now allowed.
352 5) Pings and close used to be limited to 124 bytes, the correct limit is 125
353 so that is now also allowed.
355 6) LWS_PRE is provided as a synonym for LWS_SEND_BUFFER_PRE_PADDING, either is
358 7) There's generic support for RFC7462 style extension options built into the
359 library now. As a consequence, a field "options" is added to lws_extension.
360 It can be NULL if there are no options on the extension. Extension internal
361 info is part of the public abi because extensions may be implemented outside
364 8) WSI_TOKEN_PROXY enum was accidentally defined to collide with another token
365 of value 73. That's now corrected and WSI_TOKEN_PROXY moved to his own place at
368 9) With the addition of libuv support, libev is not the only event loop
369 library in town and his api names must be elaborated with _ev_
371 Callback typedef: lws_signal_cb ---> lws_ev_signal_cb_t
372 lws_sigint_cfg --> lws_ev_sigint_cfg
373 lws_initloop --> lws_ev_initloop
374 lws_sigint_cb --> lws_ev_sigint_cb
376 10) Libev support is made compatible with multithreaded service,
377 lws_ev_initloop (was lws_initloop) gets an extra argument for the
378 thread service index (use 0 if you will just have 1 service thread).
380 LWS_VISIBLE LWS_EXTERN int
381 lws_ev_initloop(struct lws_context *context, ev_loop_t *loop, int tsi);
384 v1.6.0-chrome48-firefox42
385 =======================
387 Major API improvements
388 ----------------------
390 v1.6.0 has many cleanups and improvements in the API. Although at first it
391 looks pretty drastic, user code will only need four actions to update it.
393 - Do the three search/replaces in your user code, /libwebsocket_/lws_/,
394 /libwebsockets_/lws_/, and /struct\ libwebsocket/struct\ lws/
396 - Remove the context parameter from your user callbacks
398 - Remove context as the first parameter from the "Eleven APIS" listed in the
399 User Api Changes section
401 - Add lws_get_context(wsi) as the first parameter on the "Three APIS" listed
402 in the User Api Changes section, and anywhere else you still need context
404 That's it... generally only a handful of the 14 affected APIs are actually in
405 use in your user code and you can find them quickest by compiling and visiting
406 the errors each in turn. And the end results are much cleaner, more
407 predictable and maintainable.
413 1) lws now exposes his internal platform file abstraction in a way that can be
414 both used by user code to make it platform-agnostic, and be overridden or
415 subclassed by user code. This allows things like handling the URI "directory
416 space" as a virtual filesystem that may or may not be backed by a regular
417 filesystem. One example use is serving files from inside large compressed
418 archive storage without having to unpack anything except the file being
421 The test server shows how to use it, basically the platform-specific part of
422 lws prepares a file operations structure that lives in the lws context.
424 Helpers are provided to also leverage these platform-independent file handling
427 static inline lws_filefd_type
428 lws_plat_file_open(struct lws *wsi, const char *filename,
429 unsigned long *filelen, int flags)
431 lws_plat_file_close(struct lws *wsi, lws_filefd_type fd)
433 static inline unsigned long
434 lws_plat_file_seek_cur(struct lws *wsi, lws_filefd_type fd, long offset)
437 lws_plat_file_read(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
438 unsigned char *buf, unsigned long len)
441 lws_plat_file_write(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
442 unsigned char *buf, unsigned long len)
444 The user code can also override or subclass the file operations, to either
445 wrap or replace them. An example is shown in test server.
447 A wsi can be associated with the file activity, allowing per-connection
448 authentication and state to be used when interpreting the file request.
450 2) A new API void * lws_wsi_user(struct lws *wsi) lets you get the pointer to
451 the user data associated with the wsi, just from the wsi.
453 3) URI argument handling. Libwebsockets parses and protects URI arguments
454 like test.html?arg1=1&arg2=2, it decodes %xx uriencoding format and reduces
455 path attacks like ../.../../etc/passwd so they cannot go behind the web
456 server's /. There is a list of confirmed attacks we're proof against in
457 ./test-server/attack.sh.
459 There is a new API lws_hdr_copy_fragment that should be used now to access
460 the URI arguments (it returns the fragments length)
462 while (lws_hdr_copy_fragment(wsi, buf, sizeof(buf),
463 WSI_TOKEN_HTTP_URI_ARGS, n) > 0) {
464 lwsl_info("URI Arg %d: %s\n", ++n, buf);
467 For the example above, calling with n=0 will return "arg1=1" and n=1 "arg2=2".
468 All legal uriencodings will have been reduced in those strings.
470 lws_hdr_copy_fragment() returns the length of the x=y fragment, so it's also
471 possible to deal with arguments containing %00. If you don't care about that,
472 the returned string has '\0' appended to simplify processing.
480 - lws_callback_on_writable_all_protocol(const struct lws_protocols *protocol)
481 - lws_callback_all_protocol(const struct lws_protocols *protocol)
482 - lws_rx_flow_allow_all_protocol(lws_rx_flow_allow_all_protocol)
484 Now take an additional pointer to the lws_context in their first argument.
486 The reason for this change is struct lws_protocols has been changed to remove
487 members that lws used for private storage: so the protocols struct in now
488 truly const and may be reused serially or simultaneously by different contexts.
492 LWS_VISIBLE LWS_EXTERN int
493 lws_add_http_header_by_name(struct lws_context *context,
495 const unsigned char *name,
496 const unsigned char *value,
500 LWS_VISIBLE LWS_EXTERN int
501 lws_finalize_http_header(struct lws_context *context,
505 LWS_VISIBLE LWS_EXTERN int
506 lws_add_http_header_by_token(struct lws_context *context,
508 enum lws_token_indexes token,
509 const unsigned char *value,
513 LWS_VISIBLE LWS_EXTERN int
514 lws_add_http_header_content_length(struct lws_context *context,
516 unsigned long content_length,
519 LWS_VISIBLE LWS_EXTERN int
520 lws_add_http_header_status(struct lws_context *context, struct lws *wsi,
521 unsigned int code, unsigned char **p,
524 LWS_VISIBLE LWS_EXTERN int
525 lws_serve_http_file(struct lws_context *context, struct lws *wsi,
526 const char *file, const char *content_type,
527 const char *other_headers, int other_headers_len);
528 LWS_VISIBLE LWS_EXTERN int
529 lws_serve_http_file_fragment(struct lws_context *context, struct lws *wsi);
531 LWS_VISIBLE LWS_EXTERN int
532 lws_return_http_status(struct lws_context *context, struct lws *wsi,
533 unsigned int code, const char *html_body);
535 LWS_VISIBLE LWS_EXTERN int
536 lws_callback_on_writable(const struct lws_context *context, struct lws *wsi);
538 LWS_VISIBLE LWS_EXTERN void
539 lws_get_peer_addresses(struct lws_context *context, struct lws *wsi,
540 lws_sockfd_type fd, char *name, int name_len,
541 char *rip, int rip_len);
543 LWS_VISIBLE LWS_EXTERN int
544 lws_read(struct lws_context *context, struct lws *wsi,
545 unsigned char *buf, size_t len);
547 no longer require their initial struct lws_context * parameter.
549 3) Several older apis start with libwebsocket_ or libwebsockets_ while newer ones
550 all begin lws_. These apis have been changed to all begin with lws_.
552 To convert, search-replace
554 - libwebsockets_/lws_
556 - struct\ libwebsocket/struct\ lws
558 4) context parameter removed from user callback.
560 Since almost all apis no longer need the context as a parameter, it's no longer
561 provided at the user callback directly.
563 However if you need it, for ALL callbacks wsi is valid and has a valid context
564 pointer you can recover using lws_get_context(wsi).
567 v1.5-chrome47-firefox41
568 =======================
573 LWS_CALLBACK_CLIENT_CONNECTION_ERROR may provide an error string if in is
574 non-NULL. If so, the string has length len.
576 LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED is available to relax the requirement
577 for peer certs if you are using the option to require client certs.
579 LWS_WITHOUT_BUILTIN_SHA1 cmake option forces lws to use SHA1() defined
580 externally, eg, byOpenSSL, and disables build of libwebsockets_SHA1()
583 v1.4-chrome43-firefox36
584 =======================
589 There's a new member in the info struct used to control context creation,
590 ssl_private_key_password, which allows passing into lws the passphrase on
593 There's a new member in struct protocols, id, which is ignored by lws but can
594 be used by the user code to mark the selected protocol by user-defined version
595 or capabliity flag information, for the case multiple versions of a protocol are
598 int lws_is_ssl(wsi) added to allow user code to know if the connection was made
599 over ssl or not. If LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT is used, both
600 ssl and non-ssl connections are possible and may need to be treated differently
603 int lws_partial_buffered(wsi) added... should be checked after any
604 libwebsocket_write that will be followed by another libwebsocket_write inside
605 the same writeable callback. If set, you can't do any more writes until the
606 writeable callback is called again. If you only do one write per writeable callback,
609 HTTP2-related: HTTP2 changes how headers are handled, lws now has new version-
610 agnositic header creation APIs. These do the right thing depending on each
611 connection's HTTP version without the user code having to know or care, except
612 to make sure to use the new APIs for headers (test-server is updated to use
613 them already, so look there for examples)
615 The APIs "render" the headers into a user-provided buffer and bump *p as it
616 is used. If *p reaches end, then the APIs return nonzero for error.
618 LWS_VISIBLE LWS_EXTERN int
619 lws_add_http_header_status(struct libwebsocket_context *context,
620 struct libwebsocket *wsi,
625 Start a response header reporting status like 200, 500, etc
627 LWS_VISIBLE LWS_EXTERN int
628 lws_add_http_header_by_name(struct libwebsocket_context *context,
629 struct libwebsocket *wsi,
630 const unsigned char *name,
631 const unsigned char *value,
636 Add a header like name: value in HTTP1.x
638 LWS_VISIBLE LWS_EXTERN int
639 lws_finalize_http_header(struct libwebsocket_context *context,
640 struct libwebsocket *wsi,
644 Finish off the headers, like add the extra \r\n in HTTP1.x
646 LWS_VISIBLE LWS_EXTERN int
647 lws_add_http_header_by_token(struct libwebsocket_context *context,
648 struct libwebsocket *wsi,
649 enum lws_token_indexes token,
650 const unsigned char *value,
655 Add a header by using a lws token as the name part. In HTTP2, this can be
656 compressed to one or two bytes.
662 protocols struct member no_buffer_all_partial_tx is removed. Under some
663 conditions like rewriting extension such as compression in use, the built-in
664 partial send buffering is the only way to deal with the problem, so turning
665 it off is deprecated.
671 HTTP2-related: API libwebsockets_serve_http_file() takes an extra parameter at
674 int other_headers_len)
676 If you are providing other headers, they must be generated using the new
677 HTTP-version-agnostic APIs, and you must provide the length of them using this
678 additional parameter.
680 struct lws_context_creation_info now has an additional member
681 SSL_CTX *provided_client_ssl_ctx you may set to an externally-initialized
682 SSL_CTX managed outside lws. Defaulting to zero keeps the existing behaviour of
683 lws managing the context, if you memset the struct to 0 or have as a filescope
684 initialized struct in bss, no need to change anything.
687 v1.3-chrome37-firefox30
688 =======================
691 CMakeLists.txt | 447 +++--
695 cmake/LibwebsocketsConfig.cmake.in | 17 +
696 cmake/LibwebsocketsConfigVersion.cmake.in | 11 +
697 config.h.cmake | 18 +
698 cross-ming.cmake | 31 +
699 cross-openwrt-makefile | 91 +
700 lib/client-handshake.c | 205 ++-
701 lib/client-parser.c | 58 +-
702 lib/client.c | 158 +-
703 lib/context.c | 341 ++++
704 lib/extension-deflate-frame.c | 2 +-
705 lib/extension.c | 178 ++
706 lib/handshake.c | 287 +---
707 lib/lextable.h | 338 ++++
709 lib/libwebsockets.c | 2089 +++--------------------
710 lib/libwebsockets.h | 253 ++-
711 lib/lws-plat-unix.c | 404 +++++
712 lib/lws-plat-win.c | 358 ++++
713 lib/minilex.c | 530 +++---
714 lib/output.c | 445 ++---
715 lib/parsers.c | 682 ++++----
716 lib/pollfd.c | 239 +++
717 lib/private-libwebsockets.h | 501 +++++-
718 lib/server-handshake.c | 274 +--
719 lib/server.c | 858 ++++++++--
720 lib/service.c | 517 ++++++
722 lib/ssl-http2.c | 78 +
723 lib/ssl.c | 571 +++++++
724 test-server/attack.sh | 101 +-
725 test-server/test-client.c | 9 +-
726 test-server/test-echo.c | 17 +-
727 test-server/test-fraggle.c | 7 -
728 test-server/test-ping.c | 12 +-
729 test-server/test-server.c | 330 ++--
730 test-server/test.html | 4 +-
731 win32port/client/client.vcxproj | 259 ---
732 win32port/client/client.vcxproj.filters | 39 -
733 .../libwebsocketswin32.vcxproj.filters | 93 -
734 win32port/server/server.vcxproj | 276 ---
735 win32port/server/server.vcxproj.filters | 51 -
736 win32port/win32helpers/gettimeofday.h | 59 +-
737 win32port/win32helpers/netdb.h | 1 -
738 win32port/win32helpers/strings.h | 0
739 win32port/win32helpers/sys/time.h | 1 -
740 win32port/win32helpers/unistd.h | 0
741 win32port/win32helpers/websock-w32.c | 104 --
742 win32port/win32helpers/websock-w32.h | 62 -
743 win32port/win32port.sln | 100 --
744 win32port/zlib/gzio.c | 3 +-
745 55 files changed, 6779 insertions(+), 5059 deletions(-)
751 POST method is supported
753 The protocol 0 / HTTP callback can now get two new kinds of callback,
754 LWS_CALLBACK_HTTP_BODY (in and len are a chunk of the body of the HTTP request)
755 and LWS_CALLBACK_HTTP_BODY_COMPLETION (the expected amount of body has arrived
756 and been passed to the user code already). These callbacks are used with the
757 post method (see the test server for details).
759 The period between the HTTP header completion and the completion of the body
760 processing is protected by a 5s timeout.
762 The chunks are stored in a malloc'd buffer of size protocols[0].rx_buffer_size.
765 New server option you can enable from user code
766 LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT allows non-SSL connections to
767 also be accepted on an SSL listening port. It's disabled unless you enable
771 Two new callbacks are added in protocols[0] that are optional for allowing
772 limited thread access to libwebsockets, LWS_CALLBACK_LOCK_POLL and
773 LWS_CALLBACK_UNLOCK_POLL.
775 If you use them, they protect internal and external poll list changes, but if
776 you want to use external thread access to libwebsocket_callback_on_writable()
777 you have to implement your locking here even if you don't use external
780 If you will use another thread for this, take a lot of care about managing
781 your list of live wsi by doing it from ESTABLISHED and CLOSED callbacks
782 (with your own locking).
784 If you configure cmake with -DLWS_WITH_LIBEV=1 then the code allowing the libev
785 eventloop instead of the default poll() one will also be compiled in. But to
786 use it, you must also set the LWS_SERVER_OPTION_LIBEV flag on the context
787 creation info struct options member.
789 IPV6 is supported and enabled by default except for Windows, you can disable
790 the support at build-time by giving -DLWS_IPV6=, and disable use of it even if
791 compiled in by making sure the flag LWS_SERVER_OPTION_DISABLE_IPV6 is set on
792 the context creation info struct options member.
794 You can give LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS option flag to
795 guarantee the OS CAs will not be used, even if that support was selected at
798 Optional "token limits" may be enforced by setting the member "token_limits"
799 in struct lws_context_creation_info to point to a struct lws_token_limits.
800 NULL means no token limits used for compatibility.
806 Extra optional argument to libwebsockets_serve_http_file() allows injecion
807 of HTTP headers into the canned response. Eg, cookies may be added like
808 that without getting involved in having to send the header by hand.
810 A new info member http_proxy_address may be used at context creation time to
811 set the http proxy. If non-NULL, it overrides http_proxy environment var.
813 Cmake supports LWS_SSL_CLIENT_USE_OS_CA_CERTS defaulting to on, which gets
814 the client to use the OS CA Roots. If you're worried somebody with the
815 ability to forge for force creation of a client cert from the root CA in
816 your OS, you should disable this since your selfsigned $0 cert is a lot safer
820 v1.23-chrome32-firefox24
821 ========================
824 CMakeLists.txt | 573 ++++++++----
825 COPYING | 503 -----------
826 INSTALL | 365 --------
828 README.build | 371 ++------
829 README.coding | 63 ++
830 autogen.sh | 1578 ---------------------------------
832 cmake/FindGit.cmake | 163 ++++
833 cmake/FindOpenSSLbins.cmake | 15 +-
834 cmake/UseRPMTools.cmake | 176 ++++
835 config.h.cmake | 25 +-
836 configure.ac | 226 -----
837 cross-arm-linux-gnueabihf.cmake | 28 +
838 lib/Makefile.am | 89 --
839 lib/base64-decode.c | 98 +-
840 lib/client-handshake.c | 123 ++-
841 lib/client-parser.c | 19 +-
842 lib/client.c | 145 ++-
843 lib/daemonize.c | 4 +-
844 lib/extension.c | 2 +-
845 lib/getifaddrs.h | 4 +-
846 lib/handshake.c | 76 +-
847 lib/libwebsockets.c | 491 ++++++----
848 lib/libwebsockets.h | 164 ++--
849 lib/output.c | 214 ++++-
850 lib/parsers.c | 102 +--
851 lib/private-libwebsockets.h | 66 +-
852 lib/server-handshake.c | 5 +-
855 libwebsockets-api-doc.html | 249 +++---
856 libwebsockets.pc.in | 11 -
857 libwebsockets.spec | 14 +-
859 scripts/FindLibWebSockets.cmake | 33 +
860 scripts/kernel-doc | 1 +
861 test-server/Makefile.am | 131 ---
862 test-server/leaf.jpg | Bin 0 -> 2477518 bytes
863 test-server/test-client.c | 78 +-
864 test-server/test-echo.c | 33 +-
865 test-server/test-fraggle.c | 26 +-
866 test-server/test-ping.c | 15 +-
867 test-server/test-server.c | 197 +++-
868 test-server/test.html | 5 +-
869 win32port/win32helpers/gettimeofday.c | 74 +-
870 win32port/win32helpers/websock-w32.h | 6 +-
871 48 files changed, 2493 insertions(+), 4212 deletions(-)
877 - You can now call libwebsocket_callback_on_writable() on http connectons,
878 and get a LWS_CALLBACK_HTTP_WRITEABLE callback, the same way you can
879 regulate writes with a websocket protocol connection.
881 - A new member in the context creation parameter struct "ssl_cipher_list" is
882 added, replacing CIPHERS_LIST_STRING. NULL means use the ssl library
883 default list of ciphers.
885 - Not really an api addition, but libwebsocket_service_fd() will now zero
886 the revents field of the pollfd it was called with if it handled the
887 descriptor. So you can tell if it is a non-lws fd by checking revents
888 after the service call... if it's still nonzero, the descriptor
889 belongs to you and you need to take care of it.
891 - libwebsocket_rx_flow_allow_all_protocol(protocol) will unthrottle all
892 connections with the established protocol. It's designed to be
893 called from user server code when it sees it can accept more input
894 and may have throttled connections using the server rx flow apis
895 while it was unable to accept any other input The user server code
896 then does not have to try to track while connections it choked, this
897 will free up all of them in one call.
899 - there's a new, optional callback LWS_CALLBACK_CLOSED_HTTP which gets
900 called when an HTTP protocol socket closes
902 - for LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION callback, the user_space alloc
903 has already been done before the callback happens. That means we can
904 use the user parameter to the callback to contain the user pointer, and
905 move the protocol name to the "in" parameter. The docs for this
906 callback are also updated to reflect how to check headers in there.
908 - libwebsocket_client_connect() is now properly nonblocking and async. See
909 README.coding and test-client.c for information on the callbacks you
910 can rely on controlling the async connection period with.
912 - if your OS does not support the http_proxy environment variable convention
913 (eg, reportedly OSX), you can use a new api libwebsocket_set_proxy()
914 to set the proxy details in between context creation and the connection
915 action. For OSes that support http_proxy, that's used automatically.
920 - the external poll callbacks now get the socket descriptor coming from the
921 "in" parameter. The user parameter provides the user_space for the
922 wsi as it normally does on the other callbacks.
923 LWS_CALLBACK_FILTER_NETWORK_CONNECTION also has the socket descriptor
924 delivered by @in now instead of @user.
926 - libwebsocket_write() now returns -1 for error, or the amount of data
927 actually accepted for send. Under load, the OS may signal it is
928 ready to send new data on the socket, but have only a restricted
929 amount of memory to buffer the packet compared to usual.
935 - libwebsocket_ensure_user_space() is removed from the public api, if you
936 were using it to get user_space, you need to adapt your code to only
937 use user_space inside the user callback.
939 - CIPHERS_LIST_STRING is removed
941 - autotools build has been removed. See README.build for info on how to
942 use CMake for your platform
945 v1.21-chrome26-firefox18
946 ========================
948 - Fixes buffer overflow bug in max frame size handling if you used the
949 default protocol buffer size. If you declared rx_buffer_size in your
950 protocol, which is recommended anyway, your code was unaffected.
952 v1.2-chrome26-firefox18
953 =======================
959 CMakeLists.txt | 544 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
960 LICENSE | 526 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
963 README.build | 258 ++++++++++++++++++++++++++++++++-----
964 README.coding | 52 ++++++++
965 changelog | 136 ++++++++++++++++++++
966 cmake/FindOpenSSLbins.cmake | 33 +++++
967 config.h.cmake | 173 +++++++++++++++++++++++++
968 configure.ac | 22 +++-
969 lib/Makefile.am | 20 ++-
970 lib/base64-decode.c | 2 +-
971 lib/client-handshake.c | 190 +++++++++++-----------------
972 lib/client-parser.c | 88 +++++++------
973 lib/client.c | 384 ++++++++++++++++++++++++++++++-------------------------
974 lib/daemonize.c | 32 +++--
975 lib/extension-deflate-frame.c | 58 +++++----
976 lib/extension-deflate-stream.c | 19 ++-
977 lib/extension-deflate-stream.h | 4 +-
978 lib/extension.c | 11 +-
979 lib/getifaddrs.c | 315 +++++++++++++++++++++++-----------------------
980 lib/getifaddrs.h | 30 ++---
981 lib/handshake.c | 124 +++++++++++-------
982 lib/libwebsockets.c | 736 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------------------------
983 lib/libwebsockets.h | 237 ++++++++++++++++++++++------------
984 lib/output.c | 192 +++++++++++-----------------
985 lib/parsers.c | 966 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----------------------------------------------------------------
986 lib/private-libwebsockets.h | 225 +++++++++++++++++++++------------
987 lib/server-handshake.c | 82 ++++++------
988 lib/server.c | 96 +++++++-------
989 libwebsockets-api-doc.html | 189 ++++++++++++++++++----------
990 libwebsockets.spec | 17 +--
991 test-server/attack.sh | 148 ++++++++++++++++++++++
992 test-server/test-client.c | 125 +++++++++---------
993 test-server/test-echo.c | 31 +++--
994 test-server/test-fraggle.c | 32 ++---
995 test-server/test-ping.c | 52 ++++----
996 test-server/test-server.c | 129 ++++++++++++-------
997 win32port/libwebsocketswin32/libwebsocketswin32.vcxproj | 279 ----------------------------------------
998 win32port/libwebsocketswin32/libwebsocketswin32.vcxproj.filters | 23 +++-
999 41 files changed, 4398 insertions(+), 2219 deletions(-)
1005 - lws_get_library_version() returns a const char * with a string like
1006 "1.1 9e7f737", representing the library version from configure.ac
1007 and the git HEAD hash the library was built from
1009 - TCP Keepalive can now optionally be applied to all lws sockets, on Linux
1010 also with controllable timeout, number of probes and probe interval.
1011 (On BSD type OS, you can only use system default settings for the
1012 timing and retries, although enabling it is supported by setting
1013 ka_time to nonzero, the exact value has no meaning.)
1014 This enables detection of idle connections which are logically okay,
1015 but are in fact dead, due to network connectivity issues at the server,
1016 client, or any intermediary. By default it's not enabled, but you
1017 can enable it by setting a non-zero timeout (in seconds) at the new
1018 ka_time member at context creation time.
1020 - Two new optional user callbacks added, LWS_CALLBACK_PROTOCOL_DESTROY which
1021 is called one-time per protocol as the context is being destroyed, and
1022 LWS_CALLBACK_PROTOCOL_INIT which is called when the context is created
1023 and the protocols are added, again it's a one-time affair.
1024 This lets you manage per-protocol allocations properly including
1025 cleaning up after yourself when the server goes down.
1030 - libwebsocket_create_context() has changed from taking a ton of parameters
1031 to just taking a pointer to a struct containing the parameters. The
1032 struct lws_context_creation_info is in libwebsockets.h, the members
1033 are in the same order as when they were parameters to the call
1034 previously. The test apps are all updated accordingly so you can
1035 see example code there.
1037 - Header tokens are now deleted after the websocket connection is
1038 established. Not just the header data is saved, but the pointer and
1039 length array is also removed from (union) scope saving several hundred
1040 bytes per connection once it is established
1042 - struct libwebsocket_protocols has a new member rx_buffer_size, this
1043 controls rx buffer size per connection of that protocol now. Sources
1044 for apps built against older versions of the library won't declare
1045 this in their protocols, defaulting it to 0. Zero buffer is legal,
1046 it causes a default buffer to be allocated (currently 4096)
1048 If you want to receive only atomic frames in your user callback, you
1049 should set this to greater than your largest frame size. If a frame
1050 comes that exceeds that, no error occurs but the callback happens as
1051 soon as the buffer limit is reached, and again if it is reached again
1052 or the frame completes. You can detect that has happened by seeing
1053 there is still frame content pending using
1054 libwebsockets_remaining_packet_payload()
1056 By correctly setting this, you can save a lot of memory when your
1057 protocol has small frames (see the test server and client sources).
1059 - LWS_MAX_HEADER_LEN now defaults to 1024 and is the total amount of known
1060 header payload lws can cope with, that includes the GET URL, origin
1061 etc. Headers not understood by lws are ignored and their payload
1062 not included in this.
1068 - The configuration-time option MAX_USER_RX_BUFFER has been replaced by a
1069 buffer size chosen per-protocol. For compatibility, there's a default
1070 of 4096 rx buffer, but user code should set the appropriate size for
1071 the protocol frames.
1073 - LWS_INITIAL_HDR_ALLOC and LWS_ADDITIONAL_HDR_ALLOC are no longer needed
1074 and have been removed. There's a new header management scheme that
1075 handles them in a much more compact way.
1077 - libwebsockets_hangup_on_client() is removed. If you want to close the
1078 connection you must do so from the user callback and by returning
1081 - libwebsocket_close_and_free_session() is now private to the library code
1082 only and not exposed for user code. If you want to close the
1083 connection, you must do so from the user callback by returning -1
1090 - Cmake project file added, aimed initially at Windows support: this replaces
1091 the visual studio project files that were in the tree until now.
1093 - CyaSSL now supported in place of OpenSSL (--use-cyassl on configure)
1095 - PATH_MAX or MAX_PATH no longer needed
1097 - cutomizable frame rx buffer size by protocol
1099 - optional TCP keepalive so dead peers can be detected, can be enabled at
1100 context-creation time
1102 - valgrind-clean: no SSL or CyaSSL: completely clean. With OpenSSL, 88 bytes
1103 lost at OpenSSL library init and symptomless reports of uninitialized
1104 memory usage... seems to be a known and ignored problem at OpenSSL
1106 - By default debug is enabled and the library is built for -O0 -g to faclitate
1107 that. Use --disable-debug configure option to build instead with -O4
1108 and no -g (debug info), obviously providing best performance and
1109 reduced binary size.
1111 - 1.0 introduced some code to try to not deflate small frames, however this
1112 seems to break when confronted with a mixture of frames above and
1113 below the threshold, so it's removed. Veto the compression extension
1114 in your user callback if you will typically have very small frames.
1116 - There are many memory usage improvements, both a reduction in malloc/
1117 realloc and architectural changes. A websocket connection now
1118 consumes only 296 bytes with SSL or 272 bytes without on x86_64,
1119 during header processing an additional 1262 bytes is allocated in a
1120 single malloc, but is freed when the websocket connection starts.
1121 The RX frame buffer defined by the protocol in user
1122 code is also allocated per connection, this represents the largest
1123 frame you can receive atomically in that protocol.
1125 - On ARM9 build, just http+ws server no extensions or ssl, <12Kbytes .text
1126 and 112 bytes per connection (+1328 only during header processing)
1129 v1.1-chrome26-firefox18
1130 =======================
1136 README-test-server | 291 ---
1137 README.build | 239 ++
1138 README.coding | 138 ++
1140 README.test-apps | 272 +++
1141 configure.ac | 116 +-
1142 lib/Makefile.am | 55 +-
1143 lib/base64-decode.c | 5 +-
1144 lib/client-handshake.c | 121 +-
1145 lib/client-parser.c | 394 ++++
1146 lib/client.c | 807 +++++++
1147 lib/daemonize.c | 212 ++
1148 lib/extension-deflate-frame.c | 132 +-
1149 lib/extension-deflate-stream.c | 12 +-
1150 lib/extension-x-google-mux.c | 1223 ----------
1151 lib/extension-x-google-mux.h | 96 -
1152 lib/extension.c | 8 -
1153 lib/getifaddrs.c | 271 +++
1154 lib/getifaddrs.h | 76 +
1155 lib/handshake.c | 582 +----
1156 lib/libwebsockets.c | 2493 ++++++---------------
1157 lib/libwebsockets.h | 115 +-
1159 lib/minilex.c | 440 ++++
1160 lib/output.c | 628 ++++++
1161 lib/parsers.c | 2016 +++++------------
1162 lib/private-libwebsockets.h | 284 +--
1163 lib/server-handshake.c | 275 +++
1164 lib/server.c | 377 ++++
1165 libwebsockets-api-doc.html | 300 +--
1167 test-server/Makefile.am | 111 +-
1168 test-server/libwebsockets.org-logo.png | Bin 0 -> 7029 bytes
1169 test-server/test-client.c | 45 +-
1170 test-server/test-echo.c | 330 +++
1171 test-server/test-fraggle.c | 20 +-
1172 test-server/test-ping.c | 22 +-
1173 test-server/test-server-extpoll.c | 554 -----
1174 test-server/test-server.c | 349 ++-
1175 test-server/test.html | 3 +-
1176 win32port/zlib/ZLib.vcxproj | 749 ++++---
1177 win32port/zlib/ZLib.vcxproj.filters | 188 +-
1178 win32port/zlib/adler32.c | 348 ++-
1179 win32port/zlib/compress.c | 160 +-
1180 win32port/zlib/crc32.c | 867 ++++----
1181 win32port/zlib/crc32.h | 882 ++++----
1182 win32port/zlib/deflate.c | 3799 +++++++++++++++-----------------
1183 win32port/zlib/deflate.h | 688 +++---
1184 win32port/zlib/gzclose.c | 50 +-
1185 win32port/zlib/gzguts.h | 325 ++-
1186 win32port/zlib/gzlib.c | 1157 +++++-----
1187 win32port/zlib/gzread.c | 1242 ++++++-----
1188 win32port/zlib/gzwrite.c | 1096 +++++----
1189 win32port/zlib/infback.c | 1272 ++++++-----
1190 win32port/zlib/inffast.c | 680 +++---
1191 win32port/zlib/inffast.h | 22 +-
1192 win32port/zlib/inffixed.h | 188 +-
1193 win32port/zlib/inflate.c | 2976 +++++++++++++------------
1194 win32port/zlib/inflate.h | 244 +-
1195 win32port/zlib/inftrees.c | 636 +++---
1196 win32port/zlib/inftrees.h | 124 +-
1197 win32port/zlib/trees.c | 2468 +++++++++++----------
1198 win32port/zlib/trees.h | 256 +--
1199 win32port/zlib/uncompr.c | 118 +-
1200 win32port/zlib/zconf.h | 934 ++++----
1201 win32port/zlib/zlib.h | 3357 ++++++++++++++--------------
1202 win32port/zlib/zutil.c | 642 +++---
1203 win32port/zlib/zutil.h | 526 ++---
1204 69 files changed, 19556 insertions(+), 20145 deletions(-)
1209 - libwebsockets_serve_http_file() now takes a context as first argument
1211 - libwebsockets_get_peer_addresses() now takes a context and wsi as first
1218 - lwsl_...() logging apis, default to stderr but retargetable by user code;
1219 may be used also by user code
1221 - lws_set_log_level() set which logging apis are able to emit (defaults to
1222 notice, warn, err severities), optionally set the emit callback
1224 - lwsl_emit_syslog() helper callback emits to syslog
1226 - lws_daemonize() helper code that forks the app into a headless daemon
1227 properly, maintains a lock file with pid in suitable for sysvinit etc to
1230 - LWS_CALLBACK_HTTP_FILE_COMPLETION callback added since http file
1231 transfer is now asynchronous (see test server code)
1233 - lws_frame_is_binary() from a wsi pointer, let you know if the received
1234 data was sent in BINARY mode
1240 - libwebsockets_fork_service_loop() - no longer supported (had intractable problems)
1241 arrange your code to act from the user callback instead from same
1242 process context as the service loop
1244 - libwebsockets_broadcast() - use libwebsocket_callback_on_writable[_all_protocol]()
1245 instead from same process context as the service loop. See the test apps
1248 - x-google-mux() removed until someone wants it
1250 - pre -v13 (ancient) protocol support removed
1256 - echo test server and client compatible with echo.websocket.org added
1258 - many new configure options (see README.build) to reduce footprint of the
1259 library to what you actually need, eg, --without-client and
1262 - http + websocket server can build to as little as 12K .text for ARM
1264 - no more MAX_CLIENTS limitation; adapts to support the max number of fds
1265 allowed to the process by ulimit, defaults to 1024 on Fedora and
1266 Ubuntu. Use ulimit to control this without needing to configure
1267 the library. Code here is smaller and faster.
1269 - adaptive ratio of listen socket to connection socket service allows
1270 good behaviour under Apache ab test load. Tested with thousands
1271 of simultaneous connections
1273 - reduction in per-connection memory footprint by moving to a union to hold
1274 mutually-exclusive state for the connection
1276 - robustness: Out of Memory taken care of for all allocation code now
1278 - internal getifaddrs option if your toolchain lacks it (some uclibc)
1280 - configurable memory limit for deflate operations
1282 - improvements in SSL code nonblocking operation, possible hang solved,
1283 some SSL operations broken down into pollable states so there is
1284 no library blocking, timeout coverage for SSL_connect
1286 - extpoll test server merged into single test server source
1288 - robustness: library should deal with all recoverable socket conditions
1290 - rx flowcontrol for backpressure notification fixed and implmeneted
1291 correctly in the test server
1293 - optimal lexical parser added for header processing; all headers in a
1294 single 276-byte state table
1296 - latency tracking api added (configure --with-latency)
1298 - Improved in-tree documentation, REAME.build, README.coding,
1299 README.test-apps, changelog
1304 v1.0-chrome25-firefox17 (6cd1ea9b005933f)