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
229 1) LWS_SEND_BUFFER_POST_PADDING is now 0 and deprecated. You can remove it; if
230 you still use it, obviously it does nothing. Old binary code with nonzero
231 LWS_SEND_BUFFER_POST_PADDING is perfectly compatible, the old code just
232 allocated a buffer bigger than the library is going to use.
234 The example apps no longer use LWS_SEND_BUFFER_POST_PADDING.
236 The only path who made use of it was sending with LWS_WRITE_CLOSE --->
238 2) Because of lws_close_reason() formalizing handling close frames,
239 LWS_WRITE_CLOSE is removed from libwebsockets.h. It was only of use to send
240 close frames...close frame content should be managed using lws_close_reason()
243 3) We check for invalid CLOSE codes and complain about protocol violation in
244 our close code. But it changes little since we were in the middle of closing
247 4) zero-length RX frames and zero length TX frames are now allowed.
249 5) Pings and close used to be limited to 124 bytes, the correct limit is 125
250 so that is now also allowed.
252 6) LWS_PRE is provided as a synonym for LWS_SEND_BUFFER_POST_PADDING, either is
255 7) There's generic support for RFC7462 style extension options built into the
256 library now. As a consequence, a field "options" is added to lws_extension.
257 It can be NULL if there are no options on the extension. Extension internal
258 info is part of the public abi because extensions may be implemented outside
261 8) WSI_TOKEN_PROXY enum was accidentally defined to collide with another token
262 of value 73. That's now corrected and WSI_TOKEN_PROXY moved to his own place at
266 v1.6.0-chrome48-firefox42
267 =======================
269 Major API improvements
270 ----------------------
272 v1.6.0 has many cleanups and improvements in the API. Although at first it
273 looks pretty drastic, user code will only need four actions to update it.
275 - Do the three search/replaces in your user code, /libwebsocket_/lws_/,
276 /libwebsockets_/lws_/, and /struct\ libwebsocket/struct\ lws/
278 - Remove the context parameter from your user callbacks
280 - Remove context as the first parameter from the "Eleven APIS" listed in the
281 User Api Changes section
283 - Add lws_get_context(wsi) as the first parameter on the "Three APIS" listed
284 in the User Api Changes section, and anywhere else you still need context
286 That's it... generally only a handful of the 14 affected APIs are actually in
287 use in your user code and you can find them quickest by compiling and visiting
288 the errors each in turn. And the end results are much cleaner, more
289 predictable and maintainable.
295 1) lws now exposes his internal platform file abstraction in a way that can be
296 both used by user code to make it platform-agnostic, and be overridden or
297 subclassed by user code. This allows things like handling the URI "directory
298 space" as a virtual filesystem that may or may not be backed by a regular
299 filesystem. One example use is serving files from inside large compressed
300 archive storage without having to unpack anything except the file being
303 The test server shows how to use it, basically the platform-specific part of
304 lws prepares a file operations structure that lives in the lws context.
306 Helpers are provided to also leverage these platform-independent file handling
309 static inline lws_filefd_type
310 lws_plat_file_open(struct lws *wsi, const char *filename,
311 unsigned long *filelen, int flags)
313 lws_plat_file_close(struct lws *wsi, lws_filefd_type fd)
315 static inline unsigned long
316 lws_plat_file_seek_cur(struct lws *wsi, lws_filefd_type fd, long offset)
319 lws_plat_file_read(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
320 unsigned char *buf, unsigned long len)
323 lws_plat_file_write(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
324 unsigned char *buf, unsigned long len)
326 The user code can also override or subclass the file operations, to either
327 wrap or replace them. An example is shown in test server.
329 A wsi can be associated with the file activity, allowing per-connection
330 authentication and state to be used when interpreting the file request.
332 2) A new API void * lws_wsi_user(struct lws *wsi) lets you get the pointer to
333 the user data associated with the wsi, just from the wsi.
335 3) URI argument handling. Libwebsockets parses and protects URI arguments
336 like test.html?arg1=1&arg2=2, it decodes %xx uriencoding format and reduces
337 path attacks like ../.../../etc/passwd so they cannot go behind the web
338 server's /. There is a list of confirmed attacks we're proof against in
339 ./test-server/attack.sh.
341 There is a new API lws_hdr_copy_fragment that should be used now to access
342 the URI arguments (it returns the fragments length)
344 while (lws_hdr_copy_fragment(wsi, buf, sizeof(buf),
345 WSI_TOKEN_HTTP_URI_ARGS, n) > 0) {
346 lwsl_info("URI Arg %d: %s\n", ++n, buf);
349 For the example above, calling with n=0 will return "arg1=1" and n=1 "arg2=2".
350 All legal uriencodings will have been reduced in those strings.
352 lws_hdr_copy_fragment() returns the length of the x=y fragment, so it's also
353 possible to deal with arguments containing %00. If you don't care about that,
354 the returned string has '\0' appended to simplify processing.
362 - lws_callback_on_writable_all_protocol(const struct lws_protocols *protocol)
363 - lws_callback_all_protocol(const struct lws_protocols *protocol)
364 - lws_rx_flow_allow_all_protocol(lws_rx_flow_allow_all_protocol)
366 Now take an additional pointer to the lws_context in their first argument.
368 The reason for this change is struct lws_protocols has been changed to remove
369 members that lws used for private storage: so the protocols struct in now
370 truly const and may be reused serially or simultaneously by different contexts.
374 LWS_VISIBLE LWS_EXTERN int
375 lws_add_http_header_by_name(struct lws_context *context,
377 const unsigned char *name,
378 const unsigned char *value,
382 LWS_VISIBLE LWS_EXTERN int
383 lws_finalize_http_header(struct lws_context *context,
387 LWS_VISIBLE LWS_EXTERN int
388 lws_add_http_header_by_token(struct lws_context *context,
390 enum lws_token_indexes token,
391 const unsigned char *value,
395 LWS_VISIBLE LWS_EXTERN int
396 lws_add_http_header_content_length(struct lws_context *context,
398 unsigned long content_length,
401 LWS_VISIBLE LWS_EXTERN int
402 lws_add_http_header_status(struct lws_context *context, struct lws *wsi,
403 unsigned int code, unsigned char **p,
406 LWS_VISIBLE LWS_EXTERN int
407 lws_serve_http_file(struct lws_context *context, struct lws *wsi,
408 const char *file, const char *content_type,
409 const char *other_headers, int other_headers_len);
410 LWS_VISIBLE LWS_EXTERN int
411 lws_serve_http_file_fragment(struct lws_context *context, struct lws *wsi);
413 LWS_VISIBLE LWS_EXTERN int
414 lws_return_http_status(struct lws_context *context, struct lws *wsi,
415 unsigned int code, const char *html_body);
417 LWS_VISIBLE LWS_EXTERN int
418 lws_callback_on_writable(const struct lws_context *context, struct lws *wsi);
420 LWS_VISIBLE LWS_EXTERN void
421 lws_get_peer_addresses(struct lws_context *context, struct lws *wsi,
422 lws_sockfd_type fd, char *name, int name_len,
423 char *rip, int rip_len);
425 LWS_VISIBLE LWS_EXTERN int
426 lws_read(struct lws_context *context, struct lws *wsi,
427 unsigned char *buf, size_t len);
429 no longer require their initial struct lws_context * parameter.
431 3) Several older apis start with libwebsocket_ or libwebsockets_ while newer ones
432 all begin lws_. These apis have been changed to all begin with lws_.
434 To convert, search-replace
436 - libwebsockets_/lws_
438 - struct\ libwebsocket/struct\ lws
440 4) context parameter removed from user callback.
442 Since almost all apis no longer need the context as a parameter, it's no longer
443 provided at the user callback directly.
445 However if you need it, for ALL callbacks wsi is valid and has a valid context
446 pointer you can recover using lws_get_context(wsi).
449 v1.5-chrome47-firefox41
450 =======================
455 LWS_CALLBACK_CLIENT_CONNECTION_ERROR may provide an error string if in is
456 non-NULL. If so, the string has length len.
458 LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED is available to relax the requirement
459 for peer certs if you are using the option to require client certs.
461 LWS_WITHOUT_BUILTIN_SHA1 cmake option forces lws to use SHA1() defined
462 externally, eg, byOpenSSL, and disables build of libwebsockets_SHA1()
465 v1.4-chrome43-firefox36
466 =======================
471 There's a new member in the info struct used to control context creation,
472 ssl_private_key_password, which allows passing into lws the passphrase on
475 There's a new member in struct protocols, id, which is ignored by lws but can
476 be used by the user code to mark the selected protocol by user-defined version
477 or capabliity flag information, for the case multiple versions of a protocol are
480 int lws_is_ssl(wsi) added to allow user code to know if the connection was made
481 over ssl or not. If LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT is used, both
482 ssl and non-ssl connections are possible and may need to be treated differently
485 int lws_partial_buffered(wsi) added... should be checked after any
486 libwebsocket_write that will be followed by another libwebsocket_write inside
487 the same writeable callback. If set, you can't do any more writes until the
488 writeable callback is called again. If you only do one write per writeable callback,
491 HTTP2-related: HTTP2 changes how headers are handled, lws now has new version-
492 agnositic header creation APIs. These do the right thing depending on each
493 connection's HTTP version without the user code having to know or care, except
494 to make sure to use the new APIs for headers (test-server is updated to use
495 them already, so look there for examples)
497 The APIs "render" the headers into a user-provided buffer and bump *p as it
498 is used. If *p reaches end, then the APIs return nonzero for error.
500 LWS_VISIBLE LWS_EXTERN int
501 lws_add_http_header_status(struct libwebsocket_context *context,
502 struct libwebsocket *wsi,
507 Start a response header reporting status like 200, 500, etc
509 LWS_VISIBLE LWS_EXTERN int
510 lws_add_http_header_by_name(struct libwebsocket_context *context,
511 struct libwebsocket *wsi,
512 const unsigned char *name,
513 const unsigned char *value,
518 Add a header like name: value in HTTP1.x
520 LWS_VISIBLE LWS_EXTERN int
521 lws_finalize_http_header(struct libwebsocket_context *context,
522 struct libwebsocket *wsi,
526 Finish off the headers, like add the extra \r\n in HTTP1.x
528 LWS_VISIBLE LWS_EXTERN int
529 lws_add_http_header_by_token(struct libwebsocket_context *context,
530 struct libwebsocket *wsi,
531 enum lws_token_indexes token,
532 const unsigned char *value,
537 Add a header by using a lws token as the name part. In HTTP2, this can be
538 compressed to one or two bytes.
544 protocols struct member no_buffer_all_partial_tx is removed. Under some
545 conditions like rewriting extension such as compression in use, the built-in
546 partial send buffering is the only way to deal with the problem, so turning
547 it off is deprecated.
553 HTTP2-related: API libwebsockets_serve_http_file() takes an extra parameter at
556 int other_headers_len)
558 If you are providing other headers, they must be generated using the new
559 HTTP-version-agnostic APIs, and you must provide the length of them using this
560 additional parameter.
562 struct lws_context_creation_info now has an additional member
563 SSL_CTX *provided_client_ssl_ctx you may set to an externally-initialized
564 SSL_CTX managed outside lws. Defaulting to zero keeps the existing behaviour of
565 lws managing the context, if you memset the struct to 0 or have as a filescope
566 initialized struct in bss, no need to change anything.
569 v1.3-chrome37-firefox30
570 =======================
573 CMakeLists.txt | 447 +++--
577 cmake/LibwebsocketsConfig.cmake.in | 17 +
578 cmake/LibwebsocketsConfigVersion.cmake.in | 11 +
579 config.h.cmake | 18 +
580 cross-ming.cmake | 31 +
581 cross-openwrt-makefile | 91 +
582 lib/client-handshake.c | 205 ++-
583 lib/client-parser.c | 58 +-
584 lib/client.c | 158 +-
585 lib/context.c | 341 ++++
586 lib/extension-deflate-frame.c | 2 +-
587 lib/extension.c | 178 ++
588 lib/handshake.c | 287 +---
589 lib/lextable.h | 338 ++++
591 lib/libwebsockets.c | 2089 +++--------------------
592 lib/libwebsockets.h | 253 ++-
593 lib/lws-plat-unix.c | 404 +++++
594 lib/lws-plat-win.c | 358 ++++
595 lib/minilex.c | 530 +++---
596 lib/output.c | 445 ++---
597 lib/parsers.c | 682 ++++----
598 lib/pollfd.c | 239 +++
599 lib/private-libwebsockets.h | 501 +++++-
600 lib/server-handshake.c | 274 +--
601 lib/server.c | 858 ++++++++--
602 lib/service.c | 517 ++++++
604 lib/ssl-http2.c | 78 +
605 lib/ssl.c | 571 +++++++
606 test-server/attack.sh | 101 +-
607 test-server/test-client.c | 9 +-
608 test-server/test-echo.c | 17 +-
609 test-server/test-fraggle.c | 7 -
610 test-server/test-ping.c | 12 +-
611 test-server/test-server.c | 330 ++--
612 test-server/test.html | 4 +-
613 win32port/client/client.vcxproj | 259 ---
614 win32port/client/client.vcxproj.filters | 39 -
615 .../libwebsocketswin32.vcxproj.filters | 93 -
616 win32port/server/server.vcxproj | 276 ---
617 win32port/server/server.vcxproj.filters | 51 -
618 win32port/win32helpers/gettimeofday.h | 59 +-
619 win32port/win32helpers/netdb.h | 1 -
620 win32port/win32helpers/strings.h | 0
621 win32port/win32helpers/sys/time.h | 1 -
622 win32port/win32helpers/unistd.h | 0
623 win32port/win32helpers/websock-w32.c | 104 --
624 win32port/win32helpers/websock-w32.h | 62 -
625 win32port/win32port.sln | 100 --
626 win32port/zlib/gzio.c | 3 +-
627 55 files changed, 6779 insertions(+), 5059 deletions(-)
633 POST method is supported
635 The protocol 0 / HTTP callback can now get two new kinds of callback,
636 LWS_CALLBACK_HTTP_BODY (in and len are a chunk of the body of the HTTP request)
637 and LWS_CALLBACK_HTTP_BODY_COMPLETION (the expected amount of body has arrived
638 and been passed to the user code already). These callbacks are used with the
639 post method (see the test server for details).
641 The period between the HTTP header completion and the completion of the body
642 processing is protected by a 5s timeout.
644 The chunks are stored in a malloc'd buffer of size protocols[0].rx_buffer_size.
647 New server option you can enable from user code
648 LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT allows non-SSL connections to
649 also be accepted on an SSL listening port. It's disabled unless you enable
653 Two new callbacks are added in protocols[0] that are optional for allowing
654 limited thread access to libwebsockets, LWS_CALLBACK_LOCK_POLL and
655 LWS_CALLBACK_UNLOCK_POLL.
657 If you use them, they protect internal and external poll list changes, but if
658 you want to use external thread access to libwebsocket_callback_on_writable()
659 you have to implement your locking here even if you don't use external
662 If you will use another thread for this, take a lot of care about managing
663 your list of live wsi by doing it from ESTABLISHED and CLOSED callbacks
664 (with your own locking).
666 If you configure cmake with -DLWS_WITH_LIBEV=1 then the code allowing the libev
667 eventloop instead of the default poll() one will also be compiled in. But to
668 use it, you must also set the LWS_SERVER_OPTION_LIBEV flag on the context
669 creation info struct options member.
671 IPV6 is supported and enabled by default except for Windows, you can disable
672 the support at build-time by giving -DLWS_IPV6=, and disable use of it even if
673 compiled in by making sure the flag LWS_SERVER_OPTION_DISABLE_IPV6 is set on
674 the context creation info struct options member.
676 You can give LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS option flag to
677 guarantee the OS CAs will not be used, even if that support was selected at
680 Optional "token limits" may be enforced by setting the member "token_limits"
681 in struct lws_context_creation_info to point to a struct lws_token_limits.
682 NULL means no token limits used for compatibility.
688 Extra optional argument to libwebsockets_serve_http_file() allows injecion
689 of HTTP headers into the canned response. Eg, cookies may be added like
690 that without getting involved in having to send the header by hand.
692 A new info member http_proxy_address may be used at context creation time to
693 set the http proxy. If non-NULL, it overrides http_proxy environment var.
695 Cmake supports LWS_SSL_CLIENT_USE_OS_CA_CERTS defaulting to on, which gets
696 the client to use the OS CA Roots. If you're worried somebody with the
697 ability to forge for force creation of a client cert from the root CA in
698 your OS, you should disable this since your selfsigned $0 cert is a lot safer
702 v1.23-chrome32-firefox24
703 ========================
706 CMakeLists.txt | 573 ++++++++----
707 COPYING | 503 -----------
708 INSTALL | 365 --------
710 README.build | 371 ++------
711 README.coding | 63 ++
712 autogen.sh | 1578 ---------------------------------
714 cmake/FindGit.cmake | 163 ++++
715 cmake/FindOpenSSLbins.cmake | 15 +-
716 cmake/UseRPMTools.cmake | 176 ++++
717 config.h.cmake | 25 +-
718 configure.ac | 226 -----
719 cross-arm-linux-gnueabihf.cmake | 28 +
720 lib/Makefile.am | 89 --
721 lib/base64-decode.c | 98 +-
722 lib/client-handshake.c | 123 ++-
723 lib/client-parser.c | 19 +-
724 lib/client.c | 145 ++-
725 lib/daemonize.c | 4 +-
726 lib/extension.c | 2 +-
727 lib/getifaddrs.h | 4 +-
728 lib/handshake.c | 76 +-
729 lib/libwebsockets.c | 491 ++++++----
730 lib/libwebsockets.h | 164 ++--
731 lib/output.c | 214 ++++-
732 lib/parsers.c | 102 +--
733 lib/private-libwebsockets.h | 66 +-
734 lib/server-handshake.c | 5 +-
737 libwebsockets-api-doc.html | 249 +++---
738 libwebsockets.pc.in | 11 -
739 libwebsockets.spec | 14 +-
741 scripts/FindLibWebSockets.cmake | 33 +
742 scripts/kernel-doc | 1 +
743 test-server/Makefile.am | 131 ---
744 test-server/leaf.jpg | Bin 0 -> 2477518 bytes
745 test-server/test-client.c | 78 +-
746 test-server/test-echo.c | 33 +-
747 test-server/test-fraggle.c | 26 +-
748 test-server/test-ping.c | 15 +-
749 test-server/test-server.c | 197 +++-
750 test-server/test.html | 5 +-
751 win32port/win32helpers/gettimeofday.c | 74 +-
752 win32port/win32helpers/websock-w32.h | 6 +-
753 48 files changed, 2493 insertions(+), 4212 deletions(-)
759 - You can now call libwebsocket_callback_on_writable() on http connectons,
760 and get a LWS_CALLBACK_HTTP_WRITEABLE callback, the same way you can
761 regulate writes with a websocket protocol connection.
763 - A new member in the context creation parameter struct "ssl_cipher_list" is
764 added, replacing CIPHERS_LIST_STRING. NULL means use the ssl library
765 default list of ciphers.
767 - Not really an api addition, but libwebsocket_service_fd() will now zero
768 the revents field of the pollfd it was called with if it handled the
769 descriptor. So you can tell if it is a non-lws fd by checking revents
770 after the service call... if it's still nonzero, the descriptor
771 belongs to you and you need to take care of it.
773 - libwebsocket_rx_flow_allow_all_protocol(protocol) will unthrottle all
774 connections with the established protocol. It's designed to be
775 called from user server code when it sees it can accept more input
776 and may have throttled connections using the server rx flow apis
777 while it was unable to accept any other input The user server code
778 then does not have to try to track while connections it choked, this
779 will free up all of them in one call.
781 - there's a new, optional callback LWS_CALLBACK_CLOSED_HTTP which gets
782 called when an HTTP protocol socket closes
784 - for LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION callback, the user_space alloc
785 has already been done before the callback happens. That means we can
786 use the user parameter to the callback to contain the user pointer, and
787 move the protocol name to the "in" parameter. The docs for this
788 callback are also updated to reflect how to check headers in there.
790 - libwebsocket_client_connect() is now properly nonblocking and async. See
791 README.coding and test-client.c for information on the callbacks you
792 can rely on controlling the async connection period with.
794 - if your OS does not support the http_proxy environment variable convention
795 (eg, reportedly OSX), you can use a new api libwebsocket_set_proxy()
796 to set the proxy details in between context creation and the connection
797 action. For OSes that support http_proxy, that's used automatically.
802 - the external poll callbacks now get the socket descriptor coming from the
803 "in" parameter. The user parameter provides the user_space for the
804 wsi as it normally does on the other callbacks.
805 LWS_CALLBACK_FILTER_NETWORK_CONNECTION also has the socket descriptor
806 delivered by @in now instead of @user.
808 - libwebsocket_write() now returns -1 for error, or the amount of data
809 actually accepted for send. Under load, the OS may signal it is
810 ready to send new data on the socket, but have only a restricted
811 amount of memory to buffer the packet compared to usual.
817 - libwebsocket_ensure_user_space() is removed from the public api, if you
818 were using it to get user_space, you need to adapt your code to only
819 use user_space inside the user callback.
821 - CIPHERS_LIST_STRING is removed
823 - autotools build has been removed. See README.build for info on how to
824 use CMake for your platform
827 v1.21-chrome26-firefox18
828 ========================
830 - Fixes buffer overflow bug in max frame size handling if you used the
831 default protocol buffer size. If you declared rx_buffer_size in your
832 protocol, which is recommended anyway, your code was unaffected.
834 v1.2-chrome26-firefox18
835 =======================
841 CMakeLists.txt | 544 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
842 LICENSE | 526 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
845 README.build | 258 ++++++++++++++++++++++++++++++++-----
846 README.coding | 52 ++++++++
847 changelog | 136 ++++++++++++++++++++
848 cmake/FindOpenSSLbins.cmake | 33 +++++
849 config.h.cmake | 173 +++++++++++++++++++++++++
850 configure.ac | 22 +++-
851 lib/Makefile.am | 20 ++-
852 lib/base64-decode.c | 2 +-
853 lib/client-handshake.c | 190 +++++++++++-----------------
854 lib/client-parser.c | 88 +++++++------
855 lib/client.c | 384 ++++++++++++++++++++++++++++++-------------------------
856 lib/daemonize.c | 32 +++--
857 lib/extension-deflate-frame.c | 58 +++++----
858 lib/extension-deflate-stream.c | 19 ++-
859 lib/extension-deflate-stream.h | 4 +-
860 lib/extension.c | 11 +-
861 lib/getifaddrs.c | 315 +++++++++++++++++++++++-----------------------
862 lib/getifaddrs.h | 30 ++---
863 lib/handshake.c | 124 +++++++++++-------
864 lib/libwebsockets.c | 736 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------------------------
865 lib/libwebsockets.h | 237 ++++++++++++++++++++++------------
866 lib/output.c | 192 +++++++++++-----------------
867 lib/parsers.c | 966 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----------------------------------------------------------------
868 lib/private-libwebsockets.h | 225 +++++++++++++++++++++------------
869 lib/server-handshake.c | 82 ++++++------
870 lib/server.c | 96 +++++++-------
871 libwebsockets-api-doc.html | 189 ++++++++++++++++++----------
872 libwebsockets.spec | 17 +--
873 test-server/attack.sh | 148 ++++++++++++++++++++++
874 test-server/test-client.c | 125 +++++++++---------
875 test-server/test-echo.c | 31 +++--
876 test-server/test-fraggle.c | 32 ++---
877 test-server/test-ping.c | 52 ++++----
878 test-server/test-server.c | 129 ++++++++++++-------
879 win32port/libwebsocketswin32/libwebsocketswin32.vcxproj | 279 ----------------------------------------
880 win32port/libwebsocketswin32/libwebsocketswin32.vcxproj.filters | 23 +++-
881 41 files changed, 4398 insertions(+), 2219 deletions(-)
887 - lws_get_library_version() returns a const char * with a string like
888 "1.1 9e7f737", representing the library version from configure.ac
889 and the git HEAD hash the library was built from
891 - TCP Keepalive can now optionally be applied to all lws sockets, on Linux
892 also with controllable timeout, number of probes and probe interval.
893 (On BSD type OS, you can only use system default settings for the
894 timing and retries, although enabling it is supported by setting
895 ka_time to nonzero, the exact value has no meaning.)
896 This enables detection of idle connections which are logically okay,
897 but are in fact dead, due to network connectivity issues at the server,
898 client, or any intermediary. By default it's not enabled, but you
899 can enable it by setting a non-zero timeout (in seconds) at the new
900 ka_time member at context creation time.
902 - Two new optional user callbacks added, LWS_CALLBACK_PROTOCOL_DESTROY which
903 is called one-time per protocol as the context is being destroyed, and
904 LWS_CALLBACK_PROTOCOL_INIT which is called when the context is created
905 and the protocols are added, again it's a one-time affair.
906 This lets you manage per-protocol allocations properly including
907 cleaning up after yourself when the server goes down.
912 - libwebsocket_create_context() has changed from taking a ton of parameters
913 to just taking a pointer to a struct containing the parameters. The
914 struct lws_context_creation_info is in libwebsockets.h, the members
915 are in the same order as when they were parameters to the call
916 previously. The test apps are all updated accordingly so you can
917 see example code there.
919 - Header tokens are now deleted after the websocket connection is
920 established. Not just the header data is saved, but the pointer and
921 length array is also removed from (union) scope saving several hundred
922 bytes per connection once it is established
924 - struct libwebsocket_protocols has a new member rx_buffer_size, this
925 controls rx buffer size per connection of that protocol now. Sources
926 for apps built against older versions of the library won't declare
927 this in their protocols, defaulting it to 0. Zero buffer is legal,
928 it causes a default buffer to be allocated (currently 4096)
930 If you want to receive only atomic frames in your user callback, you
931 should set this to greater than your largest frame size. If a frame
932 comes that exceeds that, no error occurs but the callback happens as
933 soon as the buffer limit is reached, and again if it is reached again
934 or the frame completes. You can detect that has happened by seeing
935 there is still frame content pending using
936 libwebsockets_remaining_packet_payload()
938 By correctly setting this, you can save a lot of memory when your
939 protocol has small frames (see the test server and client sources).
941 - LWS_MAX_HEADER_LEN now defaults to 1024 and is the total amount of known
942 header payload lws can cope with, that includes the GET URL, origin
943 etc. Headers not understood by lws are ignored and their payload
944 not included in this.
950 - The configuration-time option MAX_USER_RX_BUFFER has been replaced by a
951 buffer size chosen per-protocol. For compatibility, there's a default
952 of 4096 rx buffer, but user code should set the appropriate size for
955 - LWS_INITIAL_HDR_ALLOC and LWS_ADDITIONAL_HDR_ALLOC are no longer needed
956 and have been removed. There's a new header management scheme that
957 handles them in a much more compact way.
959 - libwebsockets_hangup_on_client() is removed. If you want to close the
960 connection you must do so from the user callback and by returning
963 - libwebsocket_close_and_free_session() is now private to the library code
964 only and not exposed for user code. If you want to close the
965 connection, you must do so from the user callback by returning -1
972 - Cmake project file added, aimed initially at Windows support: this replaces
973 the visual studio project files that were in the tree until now.
975 - CyaSSL now supported in place of OpenSSL (--use-cyassl on configure)
977 - PATH_MAX or MAX_PATH no longer needed
979 - cutomizable frame rx buffer size by protocol
981 - optional TCP keepalive so dead peers can be detected, can be enabled at
982 context-creation time
984 - valgrind-clean: no SSL or CyaSSL: completely clean. With OpenSSL, 88 bytes
985 lost at OpenSSL library init and symptomless reports of uninitialized
986 memory usage... seems to be a known and ignored problem at OpenSSL
988 - By default debug is enabled and the library is built for -O0 -g to faclitate
989 that. Use --disable-debug configure option to build instead with -O4
990 and no -g (debug info), obviously providing best performance and
993 - 1.0 introduced some code to try to not deflate small frames, however this
994 seems to break when confronted with a mixture of frames above and
995 below the threshold, so it's removed. Veto the compression extension
996 in your user callback if you will typically have very small frames.
998 - There are many memory usage improvements, both a reduction in malloc/
999 realloc and architectural changes. A websocket connection now
1000 consumes only 296 bytes with SSL or 272 bytes without on x86_64,
1001 during header processing an additional 1262 bytes is allocated in a
1002 single malloc, but is freed when the websocket connection starts.
1003 The RX frame buffer defined by the protocol in user
1004 code is also allocated per connection, this represents the largest
1005 frame you can receive atomically in that protocol.
1007 - On ARM9 build, just http+ws server no extensions or ssl, <12Kbytes .text
1008 and 112 bytes per connection (+1328 only during header processing)
1011 v1.1-chrome26-firefox18
1012 =======================
1018 README-test-server | 291 ---
1019 README.build | 239 ++
1020 README.coding | 138 ++
1022 README.test-apps | 272 +++
1023 configure.ac | 116 +-
1024 lib/Makefile.am | 55 +-
1025 lib/base64-decode.c | 5 +-
1026 lib/client-handshake.c | 121 +-
1027 lib/client-parser.c | 394 ++++
1028 lib/client.c | 807 +++++++
1029 lib/daemonize.c | 212 ++
1030 lib/extension-deflate-frame.c | 132 +-
1031 lib/extension-deflate-stream.c | 12 +-
1032 lib/extension-x-google-mux.c | 1223 ----------
1033 lib/extension-x-google-mux.h | 96 -
1034 lib/extension.c | 8 -
1035 lib/getifaddrs.c | 271 +++
1036 lib/getifaddrs.h | 76 +
1037 lib/handshake.c | 582 +----
1038 lib/libwebsockets.c | 2493 ++++++---------------
1039 lib/libwebsockets.h | 115 +-
1041 lib/minilex.c | 440 ++++
1042 lib/output.c | 628 ++++++
1043 lib/parsers.c | 2016 +++++------------
1044 lib/private-libwebsockets.h | 284 +--
1045 lib/server-handshake.c | 275 +++
1046 lib/server.c | 377 ++++
1047 libwebsockets-api-doc.html | 300 +--
1049 test-server/Makefile.am | 111 +-
1050 test-server/libwebsockets.org-logo.png | Bin 0 -> 7029 bytes
1051 test-server/test-client.c | 45 +-
1052 test-server/test-echo.c | 330 +++
1053 test-server/test-fraggle.c | 20 +-
1054 test-server/test-ping.c | 22 +-
1055 test-server/test-server-extpoll.c | 554 -----
1056 test-server/test-server.c | 349 ++-
1057 test-server/test.html | 3 +-
1058 win32port/zlib/ZLib.vcxproj | 749 ++++---
1059 win32port/zlib/ZLib.vcxproj.filters | 188 +-
1060 win32port/zlib/adler32.c | 348 ++-
1061 win32port/zlib/compress.c | 160 +-
1062 win32port/zlib/crc32.c | 867 ++++----
1063 win32port/zlib/crc32.h | 882 ++++----
1064 win32port/zlib/deflate.c | 3799 +++++++++++++++-----------------
1065 win32port/zlib/deflate.h | 688 +++---
1066 win32port/zlib/gzclose.c | 50 +-
1067 win32port/zlib/gzguts.h | 325 ++-
1068 win32port/zlib/gzlib.c | 1157 +++++-----
1069 win32port/zlib/gzread.c | 1242 ++++++-----
1070 win32port/zlib/gzwrite.c | 1096 +++++----
1071 win32port/zlib/infback.c | 1272 ++++++-----
1072 win32port/zlib/inffast.c | 680 +++---
1073 win32port/zlib/inffast.h | 22 +-
1074 win32port/zlib/inffixed.h | 188 +-
1075 win32port/zlib/inflate.c | 2976 +++++++++++++------------
1076 win32port/zlib/inflate.h | 244 +-
1077 win32port/zlib/inftrees.c | 636 +++---
1078 win32port/zlib/inftrees.h | 124 +-
1079 win32port/zlib/trees.c | 2468 +++++++++++----------
1080 win32port/zlib/trees.h | 256 +--
1081 win32port/zlib/uncompr.c | 118 +-
1082 win32port/zlib/zconf.h | 934 ++++----
1083 win32port/zlib/zlib.h | 3357 ++++++++++++++--------------
1084 win32port/zlib/zutil.c | 642 +++---
1085 win32port/zlib/zutil.h | 526 ++---
1086 69 files changed, 19556 insertions(+), 20145 deletions(-)
1091 - libwebsockets_serve_http_file() now takes a context as first argument
1093 - libwebsockets_get_peer_addresses() now takes a context and wsi as first
1100 - lwsl_...() logging apis, default to stderr but retargetable by user code;
1101 may be used also by user code
1103 - lws_set_log_level() set which logging apis are able to emit (defaults to
1104 notice, warn, err severities), optionally set the emit callback
1106 - lwsl_emit_syslog() helper callback emits to syslog
1108 - lws_daemonize() helper code that forks the app into a headless daemon
1109 properly, maintains a lock file with pid in suitable for sysvinit etc to
1112 - LWS_CALLBACK_HTTP_FILE_COMPLETION callback added since http file
1113 transfer is now asynchronous (see test server code)
1115 - lws_frame_is_binary() from a wsi pointer, let you know if the received
1116 data was sent in BINARY mode
1122 - libwebsockets_fork_service_loop() - no longer supported (had intractable problems)
1123 arrange your code to act from the user callback instead from same
1124 process context as the service loop
1126 - libwebsockets_broadcast() - use libwebsocket_callback_on_writable[_all_protocol]()
1127 instead from same process context as the service loop. See the test apps
1130 - x-google-mux() removed until someone wants it
1132 - pre -v13 (ancient) protocol support removed
1138 - echo test server and client compatible with echo.websocket.org added
1140 - many new configure options (see README.build) to reduce footprint of the
1141 library to what you actually need, eg, --without-client and
1144 - http + websocket server can build to as little as 12K .text for ARM
1146 - no more MAX_CLIENTS limitation; adapts to support the max number of fds
1147 allowed to the process by ulimit, defaults to 1024 on Fedora and
1148 Ubuntu. Use ulimit to control this without needing to configure
1149 the library. Code here is smaller and faster.
1151 - adaptive ratio of listen socket to connection socket service allows
1152 good behaviour under Apache ab test load. Tested with thousands
1153 of simultaneous connections
1155 - reduction in per-connection memory footprint by moving to a union to hold
1156 mutually-exclusive state for the connection
1158 - robustness: Out of Memory taken care of for all allocation code now
1160 - internal getifaddrs option if your toolchain lacks it (some uclibc)
1162 - configurable memory limit for deflate operations
1164 - improvements in SSL code nonblocking operation, possible hang solved,
1165 some SSL operations broken down into pollable states so there is
1166 no library blocking, timeout coverage for SSL_connect
1168 - extpoll test server merged into single test server source
1170 - robustness: library should deal with all recoverable socket conditions
1172 - rx flowcontrol for backpressure notification fixed and implmeneted
1173 correctly in the test server
1175 - optimal lexical parser added for header processing; all headers in a
1176 single 276-byte state table
1178 - latency tracking api added (configure --with-latency)
1180 - Improved in-tree documentation, REAME.build, README.coding,
1181 README.test-apps, changelog
1186 v1.0-chrome25-firefox17 (6cd1ea9b005933f)