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