7 1) MAJOR (Windows-only) fix assert firing
9 2) MAJOR http:/1.1 connections handled by lws_return_http_status() did not
10 get sent a content-length resulting in the link hanging until the peer closed
11 it. attack.sh updated to add a test for this.
16 1) MINOR test-server gained some new switches
18 -C <file> use external SSL cert file
19 -K <file> use external SSL key file
20 -A <file> use external SSL CA cert file
22 -u <uid> set effective uid
23 -g <gid> set effective gid
25 together you can use them like this to have the test-server work with the
26 usual purchased SSL certs from an official CA.
28 --ssl -C your.crt -K your.key -A your.cer -u 99 -g 99
30 2) MINOR the OpenSSL magic to setup ECDH cipher usage is implemented in the
31 library, and the ciphers restricted to use ECDH only.
32 Using this, the lws test server can score an A at SSLLABS test
34 3) MINOR STS (SSL always) header is added to the test server if you use --ssl. With
35 that, we score A+ at SSLLABS test
37 4) MINOR daemonize function (disabled at cmake by default) is updated to work
40 5) MINOR example systemd .service file now provided for test server
41 (not installed by default)
46 1) MINOR APIBREAK There's a new member in struct lws_context_creation_info, ecdh_curve,
47 which lets you set the name of the ECDH curve OpenSSL should use. By
48 default (if you leave ecdh_curve NULL) it will use "prime256v1"
58 1) There is now a "permessage-deflate" / RFC7692 implementation. It's very
59 similar to "deflate-frame" we have offered for a long while; deflate-frame is
60 now provided as an alias of permessage-deflate.
62 The main differences are that the new permessage-deflate implementation:
64 - properly performs streaming respecting input and output buffer limits. The
65 old deflate-frame implementation could only work on complete deflate input
66 and produce complete inflate output for each frame. The new implementation
67 only mallocs buffers at initialization.
69 - goes around the event loop after each input package is processed allowing
70 interleaved output processing. The RX flow control api can be used to
71 force compressed input processing to match the rate of compressed output
72 processing (test--echo shows an example of how to do this).
74 - when being "deflate-frame" for compatibility he uses the same default zlib
75 settings as the old "deflate-frame", but instead of exponentially increasing
76 malloc allocations until the whole output will fit, he observes the default
77 input and output chunking buffer sizes of "permessage-deflate", that's
78 1024 in and 1024 out at a time.
80 2) deflate-stream has been disabled for many versions (for over a year) and is
81 now removed. Browsers are now standardizing on "permessage-deflate" / RFC7692
83 3) struct lws_extension is simplified, and lws extensions now have a public
84 api (their callback) for use in user code to compose extensions and options
85 the user code wants. lws_get_internal_exts() is deprecated but kept around
86 as a NOP. The changes allow one extension implementation to go by different
87 names and allows the user client code to control option offers per-ext.
89 The test client and server are updated to use the new way. If you use
90 the old way it should still work, but extensions will be disabled until you
93 Extensions are now responsible for allocating and per-instance private struct
94 at instance construction time and freeing it when the instance is destroyed.
95 Not needing to know the size means the extension's struct can be opaque
102 1) The info struct gained three new members
104 - max_http_header_data: 0 for default (1024) or set the maximum amount of known
105 http header payload that lws can deal with. Payload in unknown http
106 headers is dropped silently. If for some reason you need to send huge
107 cookies or other HTTP-level headers, you can now increase this at context-
110 - max_http_header_pool: 0 for default (16) or set the maximum amount of http
111 headers that can be tracked by lws in this context. For the server, if
112 the header pool is completely in use then accepts on the listen socket
113 are disabled until one becomes free. For the client, if you simultaneously
114 have pending connects for more than this number of client connections,
115 additional connects will fail until some of the pending connections timeout
118 - timeout_secs: 0 for default (currently 20s), or set the library's
119 network activity timeout to the given number of seconds
121 HTTP header processing in lws only exists until just after the first main
122 callback after the HTTP handshake... for ws connections that is ESTABLISHED and
123 for HTTP connections the HTTP callback.
125 So these settings are not related to the maximum number of simultaneous
126 connections, but the number of HTTP handshakes that may be expected or ongoing,
127 or have just completed, at one time. The reason it's useful is it changes the
128 memory allocation for header processing to be one-time at context creation
129 instead of every time there is a new connection, and gives you control over
132 Setting max_http_header_pool to 1 is fine it will just queue incoming
133 connections before the accept as necessary, you can still have as many
134 simultaneous post-header connections as you like. Since the http header
135 processing is completed and the allocation released after ESTABLISHED or the
136 HTTP callback, even with a pool of 1 many connections can be handled rapidly.
138 2) There is a new callback that allows the user code to get acccess to the
139 optional close code + aux data that may have been sent by the peer.
141 LWS_CALLBACK_WS_PEER_INITIATED_CLOSE:
142 The peer has sent an unsolicited Close WS packet. @in and
143 @len are the optional close code (first 2 bytes, network
144 order) and the optional additional information which is not
145 defined in the standard, and may be a string or non-human-
147 If you return 0 lws will echo the close and then close the
148 connection. If you return nonzero lws will just close the
151 As usual not handling it does the right thing, if you're not interested in it
154 The test server has "open and close" testing buttons at the bottom, if you
155 open and close that connection, on close it will send a close code 3000 decimal
156 and the string "Bye!" as the aux data.
158 The test server dumb-increment callback handles this callback reason and prints
160 lwsts[15714]: LWS_CALLBACK_WS_PEER_INITIATED_CLOSE: len 6
161 lwsts[15714]: 0: 0x0B
162 lwsts[15714]: 1: 0xB8
163 lwsts[15714]: 2: 0x42
164 lwsts[15714]: 3: 0x79
165 lwsts[15714]: 4: 0x65
166 lwsts[15714]: 5: 0x21
168 3) There is a new API to allow the user code to control the content of the
169 close frame sent when about to return nonzero from the user callback to
170 indicate the connection should close.
173 * lws_close_reason - Set reason and aux data to send with Close packet
174 * If you are going to return nonzero from the callback
175 * requesting the connection to close, you can optionally
176 * call this to set the reason the peer will be told if
179 * @wsi: The websocket connection to set the close reason on
180 * @status: A valid close status from websocket standard
181 * @buf: NULL or buffer containing up to 124 bytes of auxiliary data
182 * @len: Length of data in @buf to send
184 LWS_VISIBLE LWS_EXTERN void
185 lws_close_reason(struct lws *wsi, enum lws_close_status status,
186 unsigned char *buf, size_t len);
188 An extra button is added to the "open and close" test server page that requests
189 that the test server close the connection from his end.
191 The test server code will do so by
193 lws_close_reason(wsi, LWS_CLOSE_STATUS_GOINGAWAY,
194 (unsigned char *)"seeya", 5);
197 The browser shows the close code and reason he received
199 websocket connection CLOSED, code: 1001, reason: seeya
201 4) There's a new context creation time option flag
203 LWS_SERVER_OPTION_VALIDATE_UTF8
205 if you set it in info->options, then TEXT and CLOSE frames will get checked to
206 confirm that they contain valid UTF-8. If they don't, the connection will get
209 5) ECDH Certs are now supported. Enable the CMake option
211 cmake .. -DLWS_SSL_SERVER_WITH_ECDH_CERT=1
213 **and** the info->options flag
215 LWS_SERVER_OPTION_SSL_ECDH
217 to build in support and select it at runtime.
219 6) There's a new api lws_parse_uri() that simplifies chopping up
220 https://xxx:yyy/zzz uris into parts nicely. The test client now uses this
221 to allow proper uris as well as the old address style.
223 7) SMP support is integrated into LWS without any internal threading. It's
224 very simple to use, libwebsockets-test-server-pthread shows how to do it,
225 use -j <n> argument there to control the number of service threads up to 32.
227 Two new members are added to the info struct
229 unsigned int count_threads;
230 unsigned int fd_limit_per_thread;
232 leave them at the default 0 to get the normal singlethreaded service loop.
234 Set count_threads to n to tell lws you will have n simultaneous service threads
235 operating on the context.
237 There is still a single listen socket on one port, no matter how many
240 When a connection is made, it is accepted by the service thread with the least
241 connections active to perform load balancing.
243 The user code is responsible for spawning n threads running the service loop
244 associated to a specific tsi (Thread Service Index, 0 .. n - 1). See
245 the libwebsockets-test-server-pthread for how to do.
247 If you leave fd_limit_per_thread at 0, then the process limit of fds is shared
248 between the service threads; if you process was allowed 1024 fds overall then
249 each thread is limited to 1024 / n.
251 You can set fd_limit_per_thread to a nonzero number to control this manually, eg
252 the overall supported fd limit is less than the process allowance.
254 You can control the context basic data allocation for multithreading from Cmake
255 using -DLWS_MAX_SMP=, if not given it's set to 32. The serv_buf allocation
256 for the threads (currently 4096) is made at runtime only for active threads.
258 Because lws will limit the requested number of actual threads supported
259 according to LWS_MAX_SMP, there is an api lws_get_count_threads(context) to
260 discover how many threads were actually allowed when the context was created.
262 It's required to implement locking in the user code in the same way that
263 libwebsockets-test-server-pthread does it, for the FD locking callbacks.
265 If LWS_MAX_SMP=1, then there is no code related to pthreads compiled in the
266 library. If more than 1, a small amount of pthread mutex code is built into
271 LWS_VISIBLE struct lws *
272 lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd)
274 allows foreign sockets accepted by non-lws code to be adopted by lws as if they
275 had just been accepted by lws' own listen socket.
277 9) X-Real-IP: header has been added as WSI_TOKEN_HTTP_X_REAL_IP
279 10) Libuv support is added, there are new related user apis
281 typedef void (lws_uv_signal_cb_t)(uv_loop_t *l, uv_signal_t *w, int revents);
283 LWS_VISIBLE LWS_EXTERN int
284 lws_uv_sigint_cfg(struct lws_context *context, int use_uv_sigint,
285 lws_uv_signal_cb_t *cb);
287 LWS_VISIBLE LWS_EXTERN int
288 lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi);
291 lws_uv_sigint_cb(uv_loop_t *loop, uv_signal_t *watcher, int revents);
301 1) LWS_SEND_BUFFER_POST_PADDING is now 0 and deprecated. You can remove it; if
302 you still use it, obviously it does nothing. Old binary code with nonzero
303 LWS_SEND_BUFFER_POST_PADDING is perfectly compatible, the old code just
304 allocated a buffer bigger than the library is going to use.
306 The example apps no longer use LWS_SEND_BUFFER_POST_PADDING.
308 The only path who made use of it was sending with LWS_WRITE_CLOSE --->
310 2) Because of lws_close_reason() formalizing handling close frames,
311 LWS_WRITE_CLOSE is removed from libwebsockets.h. It was only of use to send
312 close frames...close frame content should be managed using lws_close_reason()
315 3) We check for invalid CLOSE codes and complain about protocol violation in
316 our close code. But it changes little since we were in the middle of closing
319 4) zero-length RX frames and zero length TX frames are now allowed.
321 5) Pings and close used to be limited to 124 bytes, the correct limit is 125
322 so that is now also allowed.
324 6) LWS_PRE is provided as a synonym for LWS_SEND_BUFFER_PRE_PADDING, either is
327 7) There's generic support for RFC7462 style extension options built into the
328 library now. As a consequence, a field "options" is added to lws_extension.
329 It can be NULL if there are no options on the extension. Extension internal
330 info is part of the public abi because extensions may be implemented outside
333 8) WSI_TOKEN_PROXY enum was accidentally defined to collide with another token
334 of value 73. That's now corrected and WSI_TOKEN_PROXY moved to his own place at
337 9) With the addition of libuv support, libev is not the only event loop
338 library in town and his api names must be elaborated with _ev_
340 Callback typedef: lws_signal_cb ---> lws_ev_signal_cb_t
341 lws_sigint_cfg --> lws_ev_sigint_cfg
342 lws_initloop --> lws_ev_initloop
343 lws_sigint_cb --> lws_ev_sigint_cb
345 10) Libev support is made compatible with multithreaded service,
346 lws_ev_initloop (was lws_initloop) gets an extra argument for the
347 thread service index (use 0 if you will just have 1 service thread).
349 LWS_VISIBLE LWS_EXTERN int
350 lws_ev_initloop(struct lws_context *context, ev_loop_t *loop, int tsi);
353 v1.6.0-chrome48-firefox42
354 =======================
356 Major API improvements
357 ----------------------
359 v1.6.0 has many cleanups and improvements in the API. Although at first it
360 looks pretty drastic, user code will only need four actions to update it.
362 - Do the three search/replaces in your user code, /libwebsocket_/lws_/,
363 /libwebsockets_/lws_/, and /struct\ libwebsocket/struct\ lws/
365 - Remove the context parameter from your user callbacks
367 - Remove context as the first parameter from the "Eleven APIS" listed in the
368 User Api Changes section
370 - Add lws_get_context(wsi) as the first parameter on the "Three APIS" listed
371 in the User Api Changes section, and anywhere else you still need context
373 That's it... generally only a handful of the 14 affected APIs are actually in
374 use in your user code and you can find them quickest by compiling and visiting
375 the errors each in turn. And the end results are much cleaner, more
376 predictable and maintainable.
382 1) lws now exposes his internal platform file abstraction in a way that can be
383 both used by user code to make it platform-agnostic, and be overridden or
384 subclassed by user code. This allows things like handling the URI "directory
385 space" as a virtual filesystem that may or may not be backed by a regular
386 filesystem. One example use is serving files from inside large compressed
387 archive storage without having to unpack anything except the file being
390 The test server shows how to use it, basically the platform-specific part of
391 lws prepares a file operations structure that lives in the lws context.
393 Helpers are provided to also leverage these platform-independent file handling
396 static inline lws_filefd_type
397 lws_plat_file_open(struct lws *wsi, const char *filename,
398 unsigned long *filelen, int flags)
400 lws_plat_file_close(struct lws *wsi, lws_filefd_type fd)
402 static inline unsigned long
403 lws_plat_file_seek_cur(struct lws *wsi, lws_filefd_type fd, long offset)
406 lws_plat_file_read(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
407 unsigned char *buf, unsigned long len)
410 lws_plat_file_write(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
411 unsigned char *buf, unsigned long len)
413 The user code can also override or subclass the file operations, to either
414 wrap or replace them. An example is shown in test server.
416 A wsi can be associated with the file activity, allowing per-connection
417 authentication and state to be used when interpreting the file request.
419 2) A new API void * lws_wsi_user(struct lws *wsi) lets you get the pointer to
420 the user data associated with the wsi, just from the wsi.
422 3) URI argument handling. Libwebsockets parses and protects URI arguments
423 like test.html?arg1=1&arg2=2, it decodes %xx uriencoding format and reduces
424 path attacks like ../.../../etc/passwd so they cannot go behind the web
425 server's /. There is a list of confirmed attacks we're proof against in
426 ./test-server/attack.sh.
428 There is a new API lws_hdr_copy_fragment that should be used now to access
429 the URI arguments (it returns the fragments length)
431 while (lws_hdr_copy_fragment(wsi, buf, sizeof(buf),
432 WSI_TOKEN_HTTP_URI_ARGS, n) > 0) {
433 lwsl_info("URI Arg %d: %s\n", ++n, buf);
436 For the example above, calling with n=0 will return "arg1=1" and n=1 "arg2=2".
437 All legal uriencodings will have been reduced in those strings.
439 lws_hdr_copy_fragment() returns the length of the x=y fragment, so it's also
440 possible to deal with arguments containing %00. If you don't care about that,
441 the returned string has '\0' appended to simplify processing.
449 - lws_callback_on_writable_all_protocol(const struct lws_protocols *protocol)
450 - lws_callback_all_protocol(const struct lws_protocols *protocol)
451 - lws_rx_flow_allow_all_protocol(lws_rx_flow_allow_all_protocol)
453 Now take an additional pointer to the lws_context in their first argument.
455 The reason for this change is struct lws_protocols has been changed to remove
456 members that lws used for private storage: so the protocols struct in now
457 truly const and may be reused serially or simultaneously by different contexts.
461 LWS_VISIBLE LWS_EXTERN int
462 lws_add_http_header_by_name(struct lws_context *context,
464 const unsigned char *name,
465 const unsigned char *value,
469 LWS_VISIBLE LWS_EXTERN int
470 lws_finalize_http_header(struct lws_context *context,
474 LWS_VISIBLE LWS_EXTERN int
475 lws_add_http_header_by_token(struct lws_context *context,
477 enum lws_token_indexes token,
478 const unsigned char *value,
482 LWS_VISIBLE LWS_EXTERN int
483 lws_add_http_header_content_length(struct lws_context *context,
485 unsigned long content_length,
488 LWS_VISIBLE LWS_EXTERN int
489 lws_add_http_header_status(struct lws_context *context, struct lws *wsi,
490 unsigned int code, unsigned char **p,
493 LWS_VISIBLE LWS_EXTERN int
494 lws_serve_http_file(struct lws_context *context, struct lws *wsi,
495 const char *file, const char *content_type,
496 const char *other_headers, int other_headers_len);
497 LWS_VISIBLE LWS_EXTERN int
498 lws_serve_http_file_fragment(struct lws_context *context, struct lws *wsi);
500 LWS_VISIBLE LWS_EXTERN int
501 lws_return_http_status(struct lws_context *context, struct lws *wsi,
502 unsigned int code, const char *html_body);
504 LWS_VISIBLE LWS_EXTERN int
505 lws_callback_on_writable(const struct lws_context *context, struct lws *wsi);
507 LWS_VISIBLE LWS_EXTERN void
508 lws_get_peer_addresses(struct lws_context *context, struct lws *wsi,
509 lws_sockfd_type fd, char *name, int name_len,
510 char *rip, int rip_len);
512 LWS_VISIBLE LWS_EXTERN int
513 lws_read(struct lws_context *context, struct lws *wsi,
514 unsigned char *buf, size_t len);
516 no longer require their initial struct lws_context * parameter.
518 3) Several older apis start with libwebsocket_ or libwebsockets_ while newer ones
519 all begin lws_. These apis have been changed to all begin with lws_.
521 To convert, search-replace
523 - libwebsockets_/lws_
525 - struct\ libwebsocket/struct\ lws
527 4) context parameter removed from user callback.
529 Since almost all apis no longer need the context as a parameter, it's no longer
530 provided at the user callback directly.
532 However if you need it, for ALL callbacks wsi is valid and has a valid context
533 pointer you can recover using lws_get_context(wsi).
536 v1.5-chrome47-firefox41
537 =======================
542 LWS_CALLBACK_CLIENT_CONNECTION_ERROR may provide an error string if in is
543 non-NULL. If so, the string has length len.
545 LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED is available to relax the requirement
546 for peer certs if you are using the option to require client certs.
548 LWS_WITHOUT_BUILTIN_SHA1 cmake option forces lws to use SHA1() defined
549 externally, eg, byOpenSSL, and disables build of libwebsockets_SHA1()
552 v1.4-chrome43-firefox36
553 =======================
558 There's a new member in the info struct used to control context creation,
559 ssl_private_key_password, which allows passing into lws the passphrase on
562 There's a new member in struct protocols, id, which is ignored by lws but can
563 be used by the user code to mark the selected protocol by user-defined version
564 or capabliity flag information, for the case multiple versions of a protocol are
567 int lws_is_ssl(wsi) added to allow user code to know if the connection was made
568 over ssl or not. If LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT is used, both
569 ssl and non-ssl connections are possible and may need to be treated differently
572 int lws_partial_buffered(wsi) added... should be checked after any
573 libwebsocket_write that will be followed by another libwebsocket_write inside
574 the same writeable callback. If set, you can't do any more writes until the
575 writeable callback is called again. If you only do one write per writeable callback,
578 HTTP2-related: HTTP2 changes how headers are handled, lws now has new version-
579 agnositic header creation APIs. These do the right thing depending on each
580 connection's HTTP version without the user code having to know or care, except
581 to make sure to use the new APIs for headers (test-server is updated to use
582 them already, so look there for examples)
584 The APIs "render" the headers into a user-provided buffer and bump *p as it
585 is used. If *p reaches end, then the APIs return nonzero for error.
587 LWS_VISIBLE LWS_EXTERN int
588 lws_add_http_header_status(struct libwebsocket_context *context,
589 struct libwebsocket *wsi,
594 Start a response header reporting status like 200, 500, etc
596 LWS_VISIBLE LWS_EXTERN int
597 lws_add_http_header_by_name(struct libwebsocket_context *context,
598 struct libwebsocket *wsi,
599 const unsigned char *name,
600 const unsigned char *value,
605 Add a header like name: value in HTTP1.x
607 LWS_VISIBLE LWS_EXTERN int
608 lws_finalize_http_header(struct libwebsocket_context *context,
609 struct libwebsocket *wsi,
613 Finish off the headers, like add the extra \r\n in HTTP1.x
615 LWS_VISIBLE LWS_EXTERN int
616 lws_add_http_header_by_token(struct libwebsocket_context *context,
617 struct libwebsocket *wsi,
618 enum lws_token_indexes token,
619 const unsigned char *value,
624 Add a header by using a lws token as the name part. In HTTP2, this can be
625 compressed to one or two bytes.
631 protocols struct member no_buffer_all_partial_tx is removed. Under some
632 conditions like rewriting extension such as compression in use, the built-in
633 partial send buffering is the only way to deal with the problem, so turning
634 it off is deprecated.
640 HTTP2-related: API libwebsockets_serve_http_file() takes an extra parameter at
643 int other_headers_len)
645 If you are providing other headers, they must be generated using the new
646 HTTP-version-agnostic APIs, and you must provide the length of them using this
647 additional parameter.
649 struct lws_context_creation_info now has an additional member
650 SSL_CTX *provided_client_ssl_ctx you may set to an externally-initialized
651 SSL_CTX managed outside lws. Defaulting to zero keeps the existing behaviour of
652 lws managing the context, if you memset the struct to 0 or have as a filescope
653 initialized struct in bss, no need to change anything.
656 v1.3-chrome37-firefox30
657 =======================
660 CMakeLists.txt | 447 +++--
664 cmake/LibwebsocketsConfig.cmake.in | 17 +
665 cmake/LibwebsocketsConfigVersion.cmake.in | 11 +
666 config.h.cmake | 18 +
667 cross-ming.cmake | 31 +
668 cross-openwrt-makefile | 91 +
669 lib/client-handshake.c | 205 ++-
670 lib/client-parser.c | 58 +-
671 lib/client.c | 158 +-
672 lib/context.c | 341 ++++
673 lib/extension-deflate-frame.c | 2 +-
674 lib/extension.c | 178 ++
675 lib/handshake.c | 287 +---
676 lib/lextable.h | 338 ++++
678 lib/libwebsockets.c | 2089 +++--------------------
679 lib/libwebsockets.h | 253 ++-
680 lib/lws-plat-unix.c | 404 +++++
681 lib/lws-plat-win.c | 358 ++++
682 lib/minilex.c | 530 +++---
683 lib/output.c | 445 ++---
684 lib/parsers.c | 682 ++++----
685 lib/pollfd.c | 239 +++
686 lib/private-libwebsockets.h | 501 +++++-
687 lib/server-handshake.c | 274 +--
688 lib/server.c | 858 ++++++++--
689 lib/service.c | 517 ++++++
691 lib/ssl-http2.c | 78 +
692 lib/ssl.c | 571 +++++++
693 test-server/attack.sh | 101 +-
694 test-server/test-client.c | 9 +-
695 test-server/test-echo.c | 17 +-
696 test-server/test-fraggle.c | 7 -
697 test-server/test-ping.c | 12 +-
698 test-server/test-server.c | 330 ++--
699 test-server/test.html | 4 +-
700 win32port/client/client.vcxproj | 259 ---
701 win32port/client/client.vcxproj.filters | 39 -
702 .../libwebsocketswin32.vcxproj.filters | 93 -
703 win32port/server/server.vcxproj | 276 ---
704 win32port/server/server.vcxproj.filters | 51 -
705 win32port/win32helpers/gettimeofday.h | 59 +-
706 win32port/win32helpers/netdb.h | 1 -
707 win32port/win32helpers/strings.h | 0
708 win32port/win32helpers/sys/time.h | 1 -
709 win32port/win32helpers/unistd.h | 0
710 win32port/win32helpers/websock-w32.c | 104 --
711 win32port/win32helpers/websock-w32.h | 62 -
712 win32port/win32port.sln | 100 --
713 win32port/zlib/gzio.c | 3 +-
714 55 files changed, 6779 insertions(+), 5059 deletions(-)
720 POST method is supported
722 The protocol 0 / HTTP callback can now get two new kinds of callback,
723 LWS_CALLBACK_HTTP_BODY (in and len are a chunk of the body of the HTTP request)
724 and LWS_CALLBACK_HTTP_BODY_COMPLETION (the expected amount of body has arrived
725 and been passed to the user code already). These callbacks are used with the
726 post method (see the test server for details).
728 The period between the HTTP header completion and the completion of the body
729 processing is protected by a 5s timeout.
731 The chunks are stored in a malloc'd buffer of size protocols[0].rx_buffer_size.
734 New server option you can enable from user code
735 LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT allows non-SSL connections to
736 also be accepted on an SSL listening port. It's disabled unless you enable
740 Two new callbacks are added in protocols[0] that are optional for allowing
741 limited thread access to libwebsockets, LWS_CALLBACK_LOCK_POLL and
742 LWS_CALLBACK_UNLOCK_POLL.
744 If you use them, they protect internal and external poll list changes, but if
745 you want to use external thread access to libwebsocket_callback_on_writable()
746 you have to implement your locking here even if you don't use external
749 If you will use another thread for this, take a lot of care about managing
750 your list of live wsi by doing it from ESTABLISHED and CLOSED callbacks
751 (with your own locking).
753 If you configure cmake with -DLWS_WITH_LIBEV=1 then the code allowing the libev
754 eventloop instead of the default poll() one will also be compiled in. But to
755 use it, you must also set the LWS_SERVER_OPTION_LIBEV flag on the context
756 creation info struct options member.
758 IPV6 is supported and enabled by default except for Windows, you can disable
759 the support at build-time by giving -DLWS_IPV6=, and disable use of it even if
760 compiled in by making sure the flag LWS_SERVER_OPTION_DISABLE_IPV6 is set on
761 the context creation info struct options member.
763 You can give LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS option flag to
764 guarantee the OS CAs will not be used, even if that support was selected at
767 Optional "token limits" may be enforced by setting the member "token_limits"
768 in struct lws_context_creation_info to point to a struct lws_token_limits.
769 NULL means no token limits used for compatibility.
775 Extra optional argument to libwebsockets_serve_http_file() allows injecion
776 of HTTP headers into the canned response. Eg, cookies may be added like
777 that without getting involved in having to send the header by hand.
779 A new info member http_proxy_address may be used at context creation time to
780 set the http proxy. If non-NULL, it overrides http_proxy environment var.
782 Cmake supports LWS_SSL_CLIENT_USE_OS_CA_CERTS defaulting to on, which gets
783 the client to use the OS CA Roots. If you're worried somebody with the
784 ability to forge for force creation of a client cert from the root CA in
785 your OS, you should disable this since your selfsigned $0 cert is a lot safer
789 v1.23-chrome32-firefox24
790 ========================
793 CMakeLists.txt | 573 ++++++++----
794 COPYING | 503 -----------
795 INSTALL | 365 --------
797 README.build | 371 ++------
798 README.coding | 63 ++
799 autogen.sh | 1578 ---------------------------------
801 cmake/FindGit.cmake | 163 ++++
802 cmake/FindOpenSSLbins.cmake | 15 +-
803 cmake/UseRPMTools.cmake | 176 ++++
804 config.h.cmake | 25 +-
805 configure.ac | 226 -----
806 cross-arm-linux-gnueabihf.cmake | 28 +
807 lib/Makefile.am | 89 --
808 lib/base64-decode.c | 98 +-
809 lib/client-handshake.c | 123 ++-
810 lib/client-parser.c | 19 +-
811 lib/client.c | 145 ++-
812 lib/daemonize.c | 4 +-
813 lib/extension.c | 2 +-
814 lib/getifaddrs.h | 4 +-
815 lib/handshake.c | 76 +-
816 lib/libwebsockets.c | 491 ++++++----
817 lib/libwebsockets.h | 164 ++--
818 lib/output.c | 214 ++++-
819 lib/parsers.c | 102 +--
820 lib/private-libwebsockets.h | 66 +-
821 lib/server-handshake.c | 5 +-
824 libwebsockets-api-doc.html | 249 +++---
825 libwebsockets.pc.in | 11 -
826 libwebsockets.spec | 14 +-
828 scripts/FindLibWebSockets.cmake | 33 +
829 scripts/kernel-doc | 1 +
830 test-server/Makefile.am | 131 ---
831 test-server/leaf.jpg | Bin 0 -> 2477518 bytes
832 test-server/test-client.c | 78 +-
833 test-server/test-echo.c | 33 +-
834 test-server/test-fraggle.c | 26 +-
835 test-server/test-ping.c | 15 +-
836 test-server/test-server.c | 197 +++-
837 test-server/test.html | 5 +-
838 win32port/win32helpers/gettimeofday.c | 74 +-
839 win32port/win32helpers/websock-w32.h | 6 +-
840 48 files changed, 2493 insertions(+), 4212 deletions(-)
846 - You can now call libwebsocket_callback_on_writable() on http connectons,
847 and get a LWS_CALLBACK_HTTP_WRITEABLE callback, the same way you can
848 regulate writes with a websocket protocol connection.
850 - A new member in the context creation parameter struct "ssl_cipher_list" is
851 added, replacing CIPHERS_LIST_STRING. NULL means use the ssl library
852 default list of ciphers.
854 - Not really an api addition, but libwebsocket_service_fd() will now zero
855 the revents field of the pollfd it was called with if it handled the
856 descriptor. So you can tell if it is a non-lws fd by checking revents
857 after the service call... if it's still nonzero, the descriptor
858 belongs to you and you need to take care of it.
860 - libwebsocket_rx_flow_allow_all_protocol(protocol) will unthrottle all
861 connections with the established protocol. It's designed to be
862 called from user server code when it sees it can accept more input
863 and may have throttled connections using the server rx flow apis
864 while it was unable to accept any other input The user server code
865 then does not have to try to track while connections it choked, this
866 will free up all of them in one call.
868 - there's a new, optional callback LWS_CALLBACK_CLOSED_HTTP which gets
869 called when an HTTP protocol socket closes
871 - for LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION callback, the user_space alloc
872 has already been done before the callback happens. That means we can
873 use the user parameter to the callback to contain the user pointer, and
874 move the protocol name to the "in" parameter. The docs for this
875 callback are also updated to reflect how to check headers in there.
877 - libwebsocket_client_connect() is now properly nonblocking and async. See
878 README.coding and test-client.c for information on the callbacks you
879 can rely on controlling the async connection period with.
881 - if your OS does not support the http_proxy environment variable convention
882 (eg, reportedly OSX), you can use a new api libwebsocket_set_proxy()
883 to set the proxy details in between context creation and the connection
884 action. For OSes that support http_proxy, that's used automatically.
889 - the external poll callbacks now get the socket descriptor coming from the
890 "in" parameter. The user parameter provides the user_space for the
891 wsi as it normally does on the other callbacks.
892 LWS_CALLBACK_FILTER_NETWORK_CONNECTION also has the socket descriptor
893 delivered by @in now instead of @user.
895 - libwebsocket_write() now returns -1 for error, or the amount of data
896 actually accepted for send. Under load, the OS may signal it is
897 ready to send new data on the socket, but have only a restricted
898 amount of memory to buffer the packet compared to usual.
904 - libwebsocket_ensure_user_space() is removed from the public api, if you
905 were using it to get user_space, you need to adapt your code to only
906 use user_space inside the user callback.
908 - CIPHERS_LIST_STRING is removed
910 - autotools build has been removed. See README.build for info on how to
911 use CMake for your platform
914 v1.21-chrome26-firefox18
915 ========================
917 - Fixes buffer overflow bug in max frame size handling if you used the
918 default protocol buffer size. If you declared rx_buffer_size in your
919 protocol, which is recommended anyway, your code was unaffected.
921 v1.2-chrome26-firefox18
922 =======================
928 CMakeLists.txt | 544 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
929 LICENSE | 526 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
932 README.build | 258 ++++++++++++++++++++++++++++++++-----
933 README.coding | 52 ++++++++
934 changelog | 136 ++++++++++++++++++++
935 cmake/FindOpenSSLbins.cmake | 33 +++++
936 config.h.cmake | 173 +++++++++++++++++++++++++
937 configure.ac | 22 +++-
938 lib/Makefile.am | 20 ++-
939 lib/base64-decode.c | 2 +-
940 lib/client-handshake.c | 190 +++++++++++-----------------
941 lib/client-parser.c | 88 +++++++------
942 lib/client.c | 384 ++++++++++++++++++++++++++++++-------------------------
943 lib/daemonize.c | 32 +++--
944 lib/extension-deflate-frame.c | 58 +++++----
945 lib/extension-deflate-stream.c | 19 ++-
946 lib/extension-deflate-stream.h | 4 +-
947 lib/extension.c | 11 +-
948 lib/getifaddrs.c | 315 +++++++++++++++++++++++-----------------------
949 lib/getifaddrs.h | 30 ++---
950 lib/handshake.c | 124 +++++++++++-------
951 lib/libwebsockets.c | 736 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------------------------
952 lib/libwebsockets.h | 237 ++++++++++++++++++++++------------
953 lib/output.c | 192 +++++++++++-----------------
954 lib/parsers.c | 966 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----------------------------------------------------------------
955 lib/private-libwebsockets.h | 225 +++++++++++++++++++++------------
956 lib/server-handshake.c | 82 ++++++------
957 lib/server.c | 96 +++++++-------
958 libwebsockets-api-doc.html | 189 ++++++++++++++++++----------
959 libwebsockets.spec | 17 +--
960 test-server/attack.sh | 148 ++++++++++++++++++++++
961 test-server/test-client.c | 125 +++++++++---------
962 test-server/test-echo.c | 31 +++--
963 test-server/test-fraggle.c | 32 ++---
964 test-server/test-ping.c | 52 ++++----
965 test-server/test-server.c | 129 ++++++++++++-------
966 win32port/libwebsocketswin32/libwebsocketswin32.vcxproj | 279 ----------------------------------------
967 win32port/libwebsocketswin32/libwebsocketswin32.vcxproj.filters | 23 +++-
968 41 files changed, 4398 insertions(+), 2219 deletions(-)
974 - lws_get_library_version() returns a const char * with a string like
975 "1.1 9e7f737", representing the library version from configure.ac
976 and the git HEAD hash the library was built from
978 - TCP Keepalive can now optionally be applied to all lws sockets, on Linux
979 also with controllable timeout, number of probes and probe interval.
980 (On BSD type OS, you can only use system default settings for the
981 timing and retries, although enabling it is supported by setting
982 ka_time to nonzero, the exact value has no meaning.)
983 This enables detection of idle connections which are logically okay,
984 but are in fact dead, due to network connectivity issues at the server,
985 client, or any intermediary. By default it's not enabled, but you
986 can enable it by setting a non-zero timeout (in seconds) at the new
987 ka_time member at context creation time.
989 - Two new optional user callbacks added, LWS_CALLBACK_PROTOCOL_DESTROY which
990 is called one-time per protocol as the context is being destroyed, and
991 LWS_CALLBACK_PROTOCOL_INIT which is called when the context is created
992 and the protocols are added, again it's a one-time affair.
993 This lets you manage per-protocol allocations properly including
994 cleaning up after yourself when the server goes down.
999 - libwebsocket_create_context() has changed from taking a ton of parameters
1000 to just taking a pointer to a struct containing the parameters. The
1001 struct lws_context_creation_info is in libwebsockets.h, the members
1002 are in the same order as when they were parameters to the call
1003 previously. The test apps are all updated accordingly so you can
1004 see example code there.
1006 - Header tokens are now deleted after the websocket connection is
1007 established. Not just the header data is saved, but the pointer and
1008 length array is also removed from (union) scope saving several hundred
1009 bytes per connection once it is established
1011 - struct libwebsocket_protocols has a new member rx_buffer_size, this
1012 controls rx buffer size per connection of that protocol now. Sources
1013 for apps built against older versions of the library won't declare
1014 this in their protocols, defaulting it to 0. Zero buffer is legal,
1015 it causes a default buffer to be allocated (currently 4096)
1017 If you want to receive only atomic frames in your user callback, you
1018 should set this to greater than your largest frame size. If a frame
1019 comes that exceeds that, no error occurs but the callback happens as
1020 soon as the buffer limit is reached, and again if it is reached again
1021 or the frame completes. You can detect that has happened by seeing
1022 there is still frame content pending using
1023 libwebsockets_remaining_packet_payload()
1025 By correctly setting this, you can save a lot of memory when your
1026 protocol has small frames (see the test server and client sources).
1028 - LWS_MAX_HEADER_LEN now defaults to 1024 and is the total amount of known
1029 header payload lws can cope with, that includes the GET URL, origin
1030 etc. Headers not understood by lws are ignored and their payload
1031 not included in this.
1037 - The configuration-time option MAX_USER_RX_BUFFER has been replaced by a
1038 buffer size chosen per-protocol. For compatibility, there's a default
1039 of 4096 rx buffer, but user code should set the appropriate size for
1040 the protocol frames.
1042 - LWS_INITIAL_HDR_ALLOC and LWS_ADDITIONAL_HDR_ALLOC are no longer needed
1043 and have been removed. There's a new header management scheme that
1044 handles them in a much more compact way.
1046 - libwebsockets_hangup_on_client() is removed. If you want to close the
1047 connection you must do so from the user callback and by returning
1050 - libwebsocket_close_and_free_session() is now private to the library code
1051 only and not exposed for user code. If you want to close the
1052 connection, you must do so from the user callback by returning -1
1059 - Cmake project file added, aimed initially at Windows support: this replaces
1060 the visual studio project files that were in the tree until now.
1062 - CyaSSL now supported in place of OpenSSL (--use-cyassl on configure)
1064 - PATH_MAX or MAX_PATH no longer needed
1066 - cutomizable frame rx buffer size by protocol
1068 - optional TCP keepalive so dead peers can be detected, can be enabled at
1069 context-creation time
1071 - valgrind-clean: no SSL or CyaSSL: completely clean. With OpenSSL, 88 bytes
1072 lost at OpenSSL library init and symptomless reports of uninitialized
1073 memory usage... seems to be a known and ignored problem at OpenSSL
1075 - By default debug is enabled and the library is built for -O0 -g to faclitate
1076 that. Use --disable-debug configure option to build instead with -O4
1077 and no -g (debug info), obviously providing best performance and
1078 reduced binary size.
1080 - 1.0 introduced some code to try to not deflate small frames, however this
1081 seems to break when confronted with a mixture of frames above and
1082 below the threshold, so it's removed. Veto the compression extension
1083 in your user callback if you will typically have very small frames.
1085 - There are many memory usage improvements, both a reduction in malloc/
1086 realloc and architectural changes. A websocket connection now
1087 consumes only 296 bytes with SSL or 272 bytes without on x86_64,
1088 during header processing an additional 1262 bytes is allocated in a
1089 single malloc, but is freed when the websocket connection starts.
1090 The RX frame buffer defined by the protocol in user
1091 code is also allocated per connection, this represents the largest
1092 frame you can receive atomically in that protocol.
1094 - On ARM9 build, just http+ws server no extensions or ssl, <12Kbytes .text
1095 and 112 bytes per connection (+1328 only during header processing)
1098 v1.1-chrome26-firefox18
1099 =======================
1105 README-test-server | 291 ---
1106 README.build | 239 ++
1107 README.coding | 138 ++
1109 README.test-apps | 272 +++
1110 configure.ac | 116 +-
1111 lib/Makefile.am | 55 +-
1112 lib/base64-decode.c | 5 +-
1113 lib/client-handshake.c | 121 +-
1114 lib/client-parser.c | 394 ++++
1115 lib/client.c | 807 +++++++
1116 lib/daemonize.c | 212 ++
1117 lib/extension-deflate-frame.c | 132 +-
1118 lib/extension-deflate-stream.c | 12 +-
1119 lib/extension-x-google-mux.c | 1223 ----------
1120 lib/extension-x-google-mux.h | 96 -
1121 lib/extension.c | 8 -
1122 lib/getifaddrs.c | 271 +++
1123 lib/getifaddrs.h | 76 +
1124 lib/handshake.c | 582 +----
1125 lib/libwebsockets.c | 2493 ++++++---------------
1126 lib/libwebsockets.h | 115 +-
1128 lib/minilex.c | 440 ++++
1129 lib/output.c | 628 ++++++
1130 lib/parsers.c | 2016 +++++------------
1131 lib/private-libwebsockets.h | 284 +--
1132 lib/server-handshake.c | 275 +++
1133 lib/server.c | 377 ++++
1134 libwebsockets-api-doc.html | 300 +--
1136 test-server/Makefile.am | 111 +-
1137 test-server/libwebsockets.org-logo.png | Bin 0 -> 7029 bytes
1138 test-server/test-client.c | 45 +-
1139 test-server/test-echo.c | 330 +++
1140 test-server/test-fraggle.c | 20 +-
1141 test-server/test-ping.c | 22 +-
1142 test-server/test-server-extpoll.c | 554 -----
1143 test-server/test-server.c | 349 ++-
1144 test-server/test.html | 3 +-
1145 win32port/zlib/ZLib.vcxproj | 749 ++++---
1146 win32port/zlib/ZLib.vcxproj.filters | 188 +-
1147 win32port/zlib/adler32.c | 348 ++-
1148 win32port/zlib/compress.c | 160 +-
1149 win32port/zlib/crc32.c | 867 ++++----
1150 win32port/zlib/crc32.h | 882 ++++----
1151 win32port/zlib/deflate.c | 3799 +++++++++++++++-----------------
1152 win32port/zlib/deflate.h | 688 +++---
1153 win32port/zlib/gzclose.c | 50 +-
1154 win32port/zlib/gzguts.h | 325 ++-
1155 win32port/zlib/gzlib.c | 1157 +++++-----
1156 win32port/zlib/gzread.c | 1242 ++++++-----
1157 win32port/zlib/gzwrite.c | 1096 +++++----
1158 win32port/zlib/infback.c | 1272 ++++++-----
1159 win32port/zlib/inffast.c | 680 +++---
1160 win32port/zlib/inffast.h | 22 +-
1161 win32port/zlib/inffixed.h | 188 +-
1162 win32port/zlib/inflate.c | 2976 +++++++++++++------------
1163 win32port/zlib/inflate.h | 244 +-
1164 win32port/zlib/inftrees.c | 636 +++---
1165 win32port/zlib/inftrees.h | 124 +-
1166 win32port/zlib/trees.c | 2468 +++++++++++----------
1167 win32port/zlib/trees.h | 256 +--
1168 win32port/zlib/uncompr.c | 118 +-
1169 win32port/zlib/zconf.h | 934 ++++----
1170 win32port/zlib/zlib.h | 3357 ++++++++++++++--------------
1171 win32port/zlib/zutil.c | 642 +++---
1172 win32port/zlib/zutil.h | 526 ++---
1173 69 files changed, 19556 insertions(+), 20145 deletions(-)
1178 - libwebsockets_serve_http_file() now takes a context as first argument
1180 - libwebsockets_get_peer_addresses() now takes a context and wsi as first
1187 - lwsl_...() logging apis, default to stderr but retargetable by user code;
1188 may be used also by user code
1190 - lws_set_log_level() set which logging apis are able to emit (defaults to
1191 notice, warn, err severities), optionally set the emit callback
1193 - lwsl_emit_syslog() helper callback emits to syslog
1195 - lws_daemonize() helper code that forks the app into a headless daemon
1196 properly, maintains a lock file with pid in suitable for sysvinit etc to
1199 - LWS_CALLBACK_HTTP_FILE_COMPLETION callback added since http file
1200 transfer is now asynchronous (see test server code)
1202 - lws_frame_is_binary() from a wsi pointer, let you know if the received
1203 data was sent in BINARY mode
1209 - libwebsockets_fork_service_loop() - no longer supported (had intractable problems)
1210 arrange your code to act from the user callback instead from same
1211 process context as the service loop
1213 - libwebsockets_broadcast() - use libwebsocket_callback_on_writable[_all_protocol]()
1214 instead from same process context as the service loop. See the test apps
1217 - x-google-mux() removed until someone wants it
1219 - pre -v13 (ancient) protocol support removed
1225 - echo test server and client compatible with echo.websocket.org added
1227 - many new configure options (see README.build) to reduce footprint of the
1228 library to what you actually need, eg, --without-client and
1231 - http + websocket server can build to as little as 12K .text for ARM
1233 - no more MAX_CLIENTS limitation; adapts to support the max number of fds
1234 allowed to the process by ulimit, defaults to 1024 on Fedora and
1235 Ubuntu. Use ulimit to control this without needing to configure
1236 the library. Code here is smaller and faster.
1238 - adaptive ratio of listen socket to connection socket service allows
1239 good behaviour under Apache ab test load. Tested with thousands
1240 of simultaneous connections
1242 - reduction in per-connection memory footprint by moving to a union to hold
1243 mutually-exclusive state for the connection
1245 - robustness: Out of Memory taken care of for all allocation code now
1247 - internal getifaddrs option if your toolchain lacks it (some uclibc)
1249 - configurable memory limit for deflate operations
1251 - improvements in SSL code nonblocking operation, possible hang solved,
1252 some SSL operations broken down into pollable states so there is
1253 no library blocking, timeout coverage for SSL_connect
1255 - extpoll test server merged into single test server source
1257 - robustness: library should deal with all recoverable socket conditions
1259 - rx flowcontrol for backpressure notification fixed and implmeneted
1260 correctly in the test server
1262 - optimal lexical parser added for header processing; all headers in a
1263 single 276-byte state table
1265 - latency tracking api added (configure --with-latency)
1267 - Improved in-tree documentation, REAME.build, README.coding,
1268 README.test-apps, changelog
1273 v1.0-chrome25-firefox17 (6cd1ea9b005933f)