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