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