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