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