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