blob: 6cf7d191c6896de487262c34ffe57c13bf0df16b [file] [log] [blame]
Andy Greena35c86f2013-01-31 10:16:44 +08001Changelog
2---------
3
Andy Green4e442b72015-12-10 07:58:58 +08004User api additions
5------------------
6
Andy Green3f628702015-12-14 07:16:32 +080071) lws now exposes his internal platform file abstraction in a way that can be
Andy Green4e442b72015-12-10 07:58:58 +08008both used by user code to make it platform-agnostic, and be overridden or
9subclassed by user code. This allows things like handling the URI "directory
10space" as a virtual filesystem that may or may not be backed by a regular
11filesystem. One example use is serving files from inside large compressed
12archive storage without having to unpack anything except the file being
13requested.
14
15The test server shows how to use it, basically the platform-specific part of
16lws prepares a file operations structure that lives in the lws context.
17
Andy Green3f599962015-12-14 07:21:42 +080018Helpers are provided to also leverage these platform-independent file handling
19apis
Andy Green4e442b72015-12-10 07:58:58 +080020
21static inline lws_filefd_type
Andy Green3f599962015-12-14 07:21:42 +080022lws_plat_file_open(struct lws *wsi, const char *filename,
Andy Green4e442b72015-12-10 07:58:58 +080023 unsigned long *filelen, int flags)
Andy Green4e442b72015-12-10 07:58:58 +080024static inline int
Andy Green3f599962015-12-14 07:21:42 +080025lws_plat_file_close(struct lws *wsi, lws_filefd_type fd)
Andy Green4e442b72015-12-10 07:58:58 +080026
27static inline unsigned long
Andy Green3f599962015-12-14 07:21:42 +080028lws_plat_file_seek_cur(struct lws *wsi, lws_filefd_type fd, long offset)
Andy Green4e442b72015-12-10 07:58:58 +080029
30static inline int
Andy Green3f599962015-12-14 07:21:42 +080031lws_plat_file_read(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
32 unsigned char *buf, unsigned long len)
Andy Green4e442b72015-12-10 07:58:58 +080033
34static inline int
Andy Green3f599962015-12-14 07:21:42 +080035lws_plat_file_write(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
36 unsigned char *buf, unsigned long len)
Andy Green4e442b72015-12-10 07:58:58 +080037
38The user code can also override or subclass the file operations, to either
39wrap or replace them. An example is shown in test server.
40
Andy Green3f599962015-12-14 07:21:42 +080041A wsi can be associated with the file activity, allowing per-connection
42authentication and state to be used when interpreting the file request.
43
Andy Green3f628702015-12-14 07:16:32 +0800442) A new API void * lws_wsi_user(struct lws *wsi) lets you get the pointer to
45the user data associated with the wsi, just from the wsi.
46
Andy Green4e442b72015-12-10 07:58:58 +080047
Andy Green6d417202015-12-04 10:39:23 +080048User api changes
49----------------
50
Andy Green1a366bf2015-12-14 07:02:51 +0800511) Three APIS
52
53 - lws_callback_on_writable_all_protocol(const struct lws_protocols *protocol)
54 - lws_callback_all_protocol(const struct lws_protocols *protocol)
55 - lws_rx_flow_allow_all_protocol(lws_rx_flow_allow_all_protocol)
56
57Now take an additional pointer to the lws_context in their first argument.
58
59The reason for this change is struct lws_protocols has been changed to remove
60members that lws used for private storage: so the protocols struct in now
61truly const and may be reused serially or simultaneously by different contexts.
62
632) Several older apis start with libwebsocket_ or libwebsockets_ while newer ones
Andy Green6d417202015-12-04 10:39:23 +080064all begin lws_. These apis have been changed to all begin with lws_.
65
Andy Green1a366bf2015-12-14 07:02:51 +080066However except for the three APIs mentioned above in 1), compatibility defines
67have been added in libwebsockets.h, so it is largely build-compatible with
68older sources using the old api names.
Andy Green6d417202015-12-04 10:39:23 +080069
70If you are using lws with a distro, or otherwise can't rebuild the user code,
71you should add
72
73 -DLWS_WITH_OLD_API_WRAPPERS=1
74
75to your cmake args. This builds lws with all the old apis as wrappers around
76the new apis, so the library still exports the old apis.
77
78In this way you can have lws export both the new and old apis simultaneously
79for compatibility.
80
81
Andy Greenab620ff2015-10-28 08:39:09 +080082v1.5-chrome47-firefox41
83=======================
MGadkari020c53c2015-08-21 16:15:36 +053084
85User api changes
86----------------
87
88LWS_CALLBACK_CLIENT_CONNECTION_ERROR may provide an error string if in is
89non-NULL. If so, the string has length len.
90
Andy Green6d59f592015-10-15 09:12:58 +080091LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED is available to relax the requirement
92for peer certs if you are using the option to require client certs.
93
Andy Green4c79ee72015-10-15 11:20:40 +080094LWS_WITHOUT_BUILTIN_SHA1 cmake option forces lws to use SHA1() defined
95externally, eg, byOpenSSL, and disables build of libwebsockets_SHA1()
96
97
Andy Green16fb0132015-03-28 11:35:40 +080098v1.4-chrome43-firefox36
99=======================
Olehfaeac3c2014-07-29 23:18:41 +0800100
101User api additions
102------------------
103
104There's a new member in the info struct used to control context creation,
105ssl_private_key_password, which allows passing into lws the passphrase on
106an SSL cetificate
107
Andy Greeneabed8d2014-08-11 12:11:36 +0800108There's a new member in struct protocols, id, which is ignored by lws but can
109be used by the user code to mark the selected protocol by user-defined version
110or capabliity flag information, for the case multiple versions of a protocol are
111supported.
112
Andy Greenb128ccc2014-08-16 09:54:27 +0800113int lws_is_ssl(wsi) added to allow user code to know if the connection was made
114over ssl or not. If LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT is used, both
115ssl and non-ssl connections are possible and may need to be treated differently
116in the user code.
117
Andy Green14425ea2014-08-18 22:49:39 +0800118int lws_partial_buffered(wsi) added... should be checked after any
119libwebsocket_write that will be followed by another libwebsocket_write inside
120the same writeable callback. If set, you can't do any more writes until the
121writeable callback is called again. If you only do one write per writeable callback,
122you can ignore this.
123
Andy Green917f43a2014-10-12 14:31:47 +0800124HTTP2-related: HTTP2 changes how headers are handled, lws now has new version-
125agnositic header creation APIs. These do the right thing depending on each
126connection's HTTP version without the user code having to know or care, except
127to make sure to use the new APIs for headers (test-server is updated to use
128them already, so look there for examples)
129
130The APIs "render" the headers into a user-provided buffer and bump *p as it
131is used. If *p reaches end, then the APIs return nonzero for error.
132
133LWS_VISIBLE LWS_EXTERN int
134lws_add_http_header_status(struct libwebsocket_context *context,
135 struct libwebsocket *wsi,
136 unsigned int code,
137 unsigned char **p,
138 unsigned char *end);
139
140Start a response header reporting status like 200, 500, etc
141
142LWS_VISIBLE LWS_EXTERN int
143lws_add_http_header_by_name(struct libwebsocket_context *context,
144 struct libwebsocket *wsi,
145 const unsigned char *name,
146 const unsigned char *value,
147 int length,
148 unsigned char **p,
149 unsigned char *end);
150
151Add a header like name: value in HTTP1.x
152
153LWS_VISIBLE LWS_EXTERN int
154lws_finalize_http_header(struct libwebsocket_context *context,
155 struct libwebsocket *wsi,
156 unsigned char **p,
157 unsigned char *end);
158
159Finish off the headers, like add the extra \r\n in HTTP1.x
160
161LWS_VISIBLE LWS_EXTERN int
162lws_add_http_header_by_token(struct libwebsocket_context *context,
163 struct libwebsocket *wsi,
164 enum lws_token_indexes token,
165 const unsigned char *value,
166 int length,
167 unsigned char **p,
168 unsigned char *end);
169
170Add a header by using a lws token as the name part. In HTTP2, this can be
171compressed to one or two bytes.
172
Olehfaeac3c2014-07-29 23:18:41 +0800173
Andy Green822241c2014-08-18 22:21:51 +0800174User api removal
175----------------
176
177protocols struct member no_buffer_all_partial_tx is removed. Under some
Peter Pentchevbb085da2015-12-03 15:55:11 +0200178conditions like rewriting extension such as compression in use, the built-in
Andy Green822241c2014-08-18 22:21:51 +0800179partial send buffering is the only way to deal with the problem, so turning
180it off is deprecated.
181
182
Andy Green917f43a2014-10-12 14:31:47 +0800183User api changes
184----------------
185
186HTTP2-related: API libwebsockets_serve_http_file() takes an extra parameter at
187the end now
188
189int other_headers_len)
190
191If you are providing other headers, they must be generated using the new
192HTTP-version-agnostic APIs, and you must provide the length of them using this
193additional parameter.
194
joseph.urciuoli4d9c8fc2014-10-16 08:53:19 +0800195struct lws_context_creation_info now has an additional member
196SSL_CTX *provided_client_ssl_ctx you may set to an externally-initialized
197SSL_CTX managed outside lws. Defaulting to zero keeps the existing behaviour of
198lws managing the context, if you memset the struct to 0 or have as a filescope
199initialized struct in bss, no need to change anything.
200
Andy Green822241c2014-08-18 22:21:51 +0800201
Andy Greenc1fdd102014-07-06 09:56:11 +0800202v1.3-chrome37-firefox30
203=======================
204
205 .gitignore | 1 -
206 CMakeLists.txt | 447 +++--
207 README.build | 35 +-
208 README.coding | 14 +
209 changelog | 66 +
210 cmake/LibwebsocketsConfig.cmake.in | 17 +
211 cmake/LibwebsocketsConfigVersion.cmake.in | 11 +
212 config.h.cmake | 18 +
213 cross-ming.cmake | 31 +
214 cross-openwrt-makefile | 91 +
215 lib/client-handshake.c | 205 ++-
216 lib/client-parser.c | 58 +-
217 lib/client.c | 158 +-
218 lib/context.c | 341 ++++
219 lib/extension-deflate-frame.c | 2 +-
220 lib/extension.c | 178 ++
221 lib/handshake.c | 287 +---
222 lib/lextable.h | 338 ++++
223 lib/libev.c | 175 ++
224 lib/libwebsockets.c | 2089 +++--------------------
225 lib/libwebsockets.h | 253 ++-
226 lib/lws-plat-unix.c | 404 +++++
227 lib/lws-plat-win.c | 358 ++++
228 lib/minilex.c | 530 +++---
229 lib/output.c | 445 ++---
230 lib/parsers.c | 682 ++++----
231 lib/pollfd.c | 239 +++
232 lib/private-libwebsockets.h | 501 +++++-
233 lib/server-handshake.c | 274 +--
234 lib/server.c | 858 ++++++++--
235 lib/service.c | 517 ++++++
236 lib/sha-1.c | 38 +-
237 lib/ssl-http2.c | 78 +
238 lib/ssl.c | 571 +++++++
239 test-server/attack.sh | 101 +-
240 test-server/test-client.c | 9 +-
241 test-server/test-echo.c | 17 +-
242 test-server/test-fraggle.c | 7 -
243 test-server/test-ping.c | 12 +-
244 test-server/test-server.c | 330 ++--
245 test-server/test.html | 4 +-
246 win32port/client/client.vcxproj | 259 ---
247 win32port/client/client.vcxproj.filters | 39 -
248 .../libwebsocketswin32.vcxproj.filters | 93 -
249 win32port/server/server.vcxproj | 276 ---
250 win32port/server/server.vcxproj.filters | 51 -
251 win32port/win32helpers/gettimeofday.h | 59 +-
252 win32port/win32helpers/netdb.h | 1 -
253 win32port/win32helpers/strings.h | 0
254 win32port/win32helpers/sys/time.h | 1 -
255 win32port/win32helpers/unistd.h | 0
256 win32port/win32helpers/websock-w32.c | 104 --
257 win32port/win32helpers/websock-w32.h | 62 -
258 win32port/win32port.sln | 100 --
259 win32port/zlib/gzio.c | 3 +-
260 55 files changed, 6779 insertions(+), 5059 deletions(-)
261
Andy Green79002562013-11-09 11:04:35 +0800262
kapejodce64fb02013-11-19 13:38:16 +0100263User api additions
264------------------
265
266POST method is supported
267
268The protocol 0 / HTTP callback can now get two new kinds of callback,
269LWS_CALLBACK_HTTP_BODY (in and len are a chunk of the body of the HTTP request)
270and LWS_CALLBACK_HTTP_BODY_COMPLETION (the expected amount of body has arrived
271and been passed to the user code already). These callbacks are used with the
272post method (see the test server for details).
273
274The period between the HTTP header completion and the completion of the body
275processing is protected by a 5s timeout.
276
277The chunks are stored in a malloc'd buffer of size protocols[0].rx_buffer_size.
278
279
James Devine5b34c972013-12-14 11:41:29 +0800280New server option you can enable from user code
281LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT allows non-SSL connections to
282also be accepted on an SSL listening port. It's disabled unless you enable
283it explicitly.
284
285
Andy Green7a132792013-12-18 09:48:26 +0800286Two new callbacks are added in protocols[0] that are optional for allowing
287limited thread access to libwebsockets, LWS_CALLBACK_LOCK_POLL and
288LWS_CALLBACK_UNLOCK_POLL.
289
290If you use them, they protect internal and external poll list changes, but if
291you want to use external thread access to libwebsocket_callback_on_writable()
292you have to implement your locking here even if you don't use external
293poll support.
294
295If you will use another thread for this, take a lot of care about managing
296your list of live wsi by doing it from ESTABLISHED and CLOSED callbacks
297(with your own locking).
298
Andrew Canaday9769f4f2014-03-23 13:25:07 +0800299If you configure cmake with -DLWS_WITH_LIBEV=1 then the code allowing the libev
300eventloop instead of the default poll() one will also be compiled in. But to
301use it, you must also set the LWS_SERVER_OPTION_LIBEV flag on the context
302creation info struct options member.
Andy Green7a132792013-12-18 09:48:26 +0800303
Andy Greenc1fdd102014-07-06 09:56:11 +0800304IPV6 is supported and enabled by default except for Windows, you can disable
305the support at build-time by giving -DLWS_IPV6=, and disable use of it even if
James Devine3f13ea22014-03-24 16:09:25 +0800306compiled in by making sure the flag LWS_SERVER_OPTION_DISABLE_IPV6 is set on
307the context creation info struct options member.
308
Andy Greenc1fdd102014-07-06 09:56:11 +0800309You can give LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS option flag to
310guarantee the OS CAs will not be used, even if that support was selected at
311build-time.
312
313Optional "token limits" may be enforced by setting the member "token_limits"
314in struct lws_context_creation_info to point to a struct lws_token_limits.
315NULL means no token limits used for compatibility.
316
Andy Green7a132792013-12-18 09:48:26 +0800317
Andy Green79002562013-11-09 11:04:35 +0800318User api changes
319----------------
320
321Extra optional argument to libwebsockets_serve_http_file() allows injecion
322of HTTP headers into the canned response. Eg, cookies may be added like
323that without getting involved in having to send the header by hand.
324
Patrick Gansterer148b9452014-02-28 02:31:23 +0100325A new info member http_proxy_address may be used at context creation time to
326set the http proxy. If non-NULL, it overrides http_proxy environment var.
Andy Green79002562013-11-09 11:04:35 +0800327
Andy Greend2ec7ad2014-03-15 10:39:29 +0800328Cmake supports LWS_SSL_CLIENT_USE_OS_CA_CERTS defaulting to on, which gets
329the client to use the OS CA Roots. If you're worried somebody with the
330ability to forge for force creation of a client cert from the root CA in
331your OS, you should disable this since your selfsigned $0 cert is a lot safer
332then...
333
Andy Green79002562013-11-09 11:04:35 +0800334
Andy Green81877e62013-10-26 20:36:08 +0800335v1.23-chrome32-firefox24
336========================
337
338 Android.mk | 29 +
339 CMakeLists.txt | 573 ++++++++----
340 COPYING | 503 -----------
341 INSTALL | 365 --------
342 Makefile.am | 13 -
343 README.build | 371 ++------
344 README.coding | 63 ++
345 autogen.sh | 1578 ---------------------------------
346 changelog | 69 ++
347 cmake/FindGit.cmake | 163 ++++
348 cmake/FindOpenSSLbins.cmake | 15 +-
349 cmake/UseRPMTools.cmake | 176 ++++
350 config.h.cmake | 25 +-
351 configure.ac | 226 -----
352 cross-arm-linux-gnueabihf.cmake | 28 +
353 lib/Makefile.am | 89 --
354 lib/base64-decode.c | 98 +-
355 lib/client-handshake.c | 123 ++-
356 lib/client-parser.c | 19 +-
357 lib/client.c | 145 ++-
358 lib/daemonize.c | 4 +-
359 lib/extension.c | 2 +-
360 lib/getifaddrs.h | 4 +-
361 lib/handshake.c | 76 +-
362 lib/libwebsockets.c | 491 ++++++----
363 lib/libwebsockets.h | 164 ++--
364 lib/output.c | 214 ++++-
365 lib/parsers.c | 102 +--
366 lib/private-libwebsockets.h | 66 +-
367 lib/server-handshake.c | 5 +-
368 lib/server.c | 29 +-
369 lib/sha-1.c | 2 +-
370 libwebsockets-api-doc.html | 249 +++---
371 libwebsockets.pc.in | 11 -
372 libwebsockets.spec | 14 +-
373 m4/ignore-me | 2 -
374 scripts/FindLibWebSockets.cmake | 33 +
375 scripts/kernel-doc | 1 +
376 test-server/Makefile.am | 131 ---
377 test-server/leaf.jpg | Bin 0 -> 2477518 bytes
378 test-server/test-client.c | 78 +-
379 test-server/test-echo.c | 33 +-
380 test-server/test-fraggle.c | 26 +-
381 test-server/test-ping.c | 15 +-
382 test-server/test-server.c | 197 +++-
383 test-server/test.html | 5 +-
384 win32port/win32helpers/gettimeofday.c | 74 +-
385 win32port/win32helpers/websock-w32.h | 6 +-
386 48 files changed, 2493 insertions(+), 4212 deletions(-)
387
Andy Green54cb3462013-02-14 22:23:54 +0800388
389User api additions
390------------------
391
392 - You can now call libwebsocket_callback_on_writable() on http connectons,
393 and get a LWS_CALLBACK_HTTP_WRITEABLE callback, the same way you can
394 regulate writes with a websocket protocol connection.
395
Andy Green2672fb22013-02-22 09:54:35 +0800396 - A new member in the context creation parameter struct "ssl_cipher_list" is
397 added, replacing CIPHERS_LIST_STRING. NULL means use the ssl library
398 default list of ciphers.
399
Andy Green58f214e2013-03-09 13:03:53 +0800400 - Not really an api addition, but libwebsocket_service_fd() will now zero
401 the revents field of the pollfd it was called with if it handled the
402 descriptor. So you can tell if it is a non-lws fd by checking revents
403 after the service call... if it's still nonzero, the descriptor
404 belongs to you and you need to take care of it.
405
Andy Greenb55451c2013-03-16 12:32:27 +0800406 - libwebsocket_rx_flow_allow_all_protocol(protocol) will unthrottle all
407 connections with the established protocol. It's designed to be
408 called from user server code when it sees it can accept more input
409 and may have throttled connections using the server rx flow apis
410 while it was unable to accept any other input The user server code
411 then does not have to try to track while connections it choked, this
412 will free up all of them in one call.
413
Andy Green0c9563b2013-06-10 22:54:40 +0800414 - there's a new, optional callback LWS_CALLBACK_CLOSED_HTTP which gets
415 called when an HTTP protocol socket closes
416
Andy Green96d48fd2013-09-18 08:32:55 +0800417 - for LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION callback, the user_space alloc
418 has already been done before the callback happens. That means we can
419 use the user parameter to the callback to contain the user pointer, and
420 move the protocol name to the "in" parameter. The docs for this
421 callback are also updated to reflect how to check headers in there.
422
Andy Green5dc62ea2013-09-20 20:26:12 +0800423 - libwebsocket_client_connect() is now properly nonblocking and async. See
424 README.coding and test-client.c for information on the callbacks you
425 can rely on controlling the async connection period with.
426
Andy Green81877e62013-10-26 20:36:08 +0800427 - if your OS does not support the http_proxy environment variable convention
428 (eg, reportedly OSX), you can use a new api libwebsocket_set_proxy()
Peter Pentchevbb085da2015-12-03 15:55:11 +0200429 to set the proxy details in between context creation and the connection
Andy Green81877e62013-10-26 20:36:08 +0800430 action. For OSes that support http_proxy, that's used automatically.
Andy Greenb55451c2013-03-16 12:32:27 +0800431
Andy Green50097dd2013-02-15 22:36:30 +0800432User api changes
433----------------
434
435 - the external poll callbacks now get the socket descriptor coming from the
436 "in" parameter. The user parameter provides the user_space for the
437 wsi as it normally does on the other callbacks.
Edwin van den Oetelaar8c8a8e12013-02-20 20:56:59 +0800438 LWS_CALLBACK_FILTER_NETWORK_CONNECTION also has the socket descriptor
439 delivered by @in now instead of @user.
Andy Green50097dd2013-02-15 22:36:30 +0800440
Andy Greenfc7c5e42013-02-23 10:50:10 +0800441 - libwebsocket_write() now returns -1 for error, or the amount of data
442 actually accepted for send. Under load, the OS may signal it is
443 ready to send new data on the socket, but have only a restricted
444 amount of memory to buffer the packet compared to usual.
445
Andy Green50097dd2013-02-15 22:36:30 +0800446
Andy Greendc914cf2013-02-18 16:54:26 +0800447User api removal
448----------------
449
450 - libwebsocket_ensure_user_space() is removed from the public api, if you
451 were using it to get user_space, you need to adapt your code to only
452 use user_space inside the user callback.
453
Andy Green2672fb22013-02-22 09:54:35 +0800454 - CIPHERS_LIST_STRING is removed
455
Andy Green0097a992013-03-09 13:06:37 +0800456 - autotools build has been removed. See README.build for info on how to
457 use CMake for your platform
458
Andy Green54cb3462013-02-14 22:23:54 +0800459
Andy Green53a46782013-02-14 11:23:49 +0800460v1.21-chrome26-firefox18
461========================
462
463 - Fixes buffer overflow bug in max frame size handling if you used the
464 default protocol buffer size. If you declared rx_buffer_size in your
465 protocol, which is recommended anyway, your code was unaffected.
466
Andy Green182cb9a2013-02-13 11:54:08 +0800467v1.2-chrome26-firefox18
468=======================
469
470Diffstat
471--------
472
473 .gitignore | 16 +++
474 CMakeLists.txt | 544 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
475 LICENSE | 526 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
476 Makefile.am | 1 +
477 README | 20 +++
478 README.build | 258 ++++++++++++++++++++++++++++++++-----
479 README.coding | 52 ++++++++
480 changelog | 136 ++++++++++++++++++++
481 cmake/FindOpenSSLbins.cmake | 33 +++++
482 config.h.cmake | 173 +++++++++++++++++++++++++
483 configure.ac | 22 +++-
484 lib/Makefile.am | 20 ++-
485 lib/base64-decode.c | 2 +-
486 lib/client-handshake.c | 190 +++++++++++-----------------
487 lib/client-parser.c | 88 +++++++------
488 lib/client.c | 384 ++++++++++++++++++++++++++++++-------------------------
489 lib/daemonize.c | 32 +++--
490 lib/extension-deflate-frame.c | 58 +++++----
491 lib/extension-deflate-stream.c | 19 ++-
492 lib/extension-deflate-stream.h | 4 +-
493 lib/extension.c | 11 +-
494 lib/getifaddrs.c | 315 +++++++++++++++++++++++-----------------------
495 lib/getifaddrs.h | 30 ++---
496 lib/handshake.c | 124 +++++++++++-------
497 lib/libwebsockets.c | 736 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------------------------
498 lib/libwebsockets.h | 237 ++++++++++++++++++++++------------
499 lib/output.c | 192 +++++++++++-----------------
500 lib/parsers.c | 966 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----------------------------------------------------------------
501 lib/private-libwebsockets.h | 225 +++++++++++++++++++++------------
502 lib/server-handshake.c | 82 ++++++------
503 lib/server.c | 96 +++++++-------
504 libwebsockets-api-doc.html | 189 ++++++++++++++++++----------
505 libwebsockets.spec | 17 +--
506 test-server/attack.sh | 148 ++++++++++++++++++++++
507 test-server/test-client.c | 125 +++++++++---------
508 test-server/test-echo.c | 31 +++--
509 test-server/test-fraggle.c | 32 ++---
510 test-server/test-ping.c | 52 ++++----
511 test-server/test-server.c | 129 ++++++++++++-------
512 win32port/libwebsocketswin32/libwebsocketswin32.vcxproj | 279 ----------------------------------------
513 win32port/libwebsocketswin32/libwebsocketswin32.vcxproj.filters | 23 +++-
514 41 files changed, 4398 insertions(+), 2219 deletions(-)
515
Andy Green7b405452013-02-01 10:50:15 +0800516
517User api additions
518------------------
519
520 - lws_get_library_version() returns a const char * with a string like
521 "1.1 9e7f737", representing the library version from configure.ac
522 and the git HEAD hash the library was built from
523
Andy Greena47865f2013-02-10 09:39:47 +0800524 - TCP Keepalive can now optionally be applied to all lws sockets, on Linux
525 also with controllable timeout, number of probes and probe interval.
526 (On BSD type OS, you can only use system default settings for the
527 timing and retries, although enabling it is supported by setting
528 ka_time to nonzero, the exact value has no meaning.)
529 This enables detection of idle connections which are logically okay,
530 but are in fact dead, due to network connectivity issues at the server,
Andy Greena690cd02013-02-09 12:25:31 +0800531 client, or any intermediary. By default it's not enabled, but you
532 can enable it by setting a non-zero timeout (in seconds) at the new
533 ka_time member at context creation time.
534
Andy Greena7109e62013-02-11 12:05:54 +0800535 - Two new optional user callbacks added, LWS_CALLBACK_PROTOCOL_DESTROY which
536 is called one-time per protocol as the context is being destroyed, and
537 LWS_CALLBACK_PROTOCOL_INIT which is called when the context is created
538 and the protocols are added, again it's a one-time affair.
539 This lets you manage per-protocol allocations properly including
540 cleaning up after yourself when the server goes down.
Andy Green7b405452013-02-01 10:50:15 +0800541
Andy Greened334462013-02-07 21:14:33 +0800542User api changes
543----------------
544
Andy Green1b265272013-02-09 14:01:09 +0800545 - libwebsocket_create_context() has changed from taking a ton of parameters
546 to just taking a pointer to a struct containing the parameters. The
547 struct lws_context_creation_info is in libwebsockets.h, the members
548 are in the same order as when they were parameters to the call
549 previously. The test apps are all updated accordingly so you can
550 see example code there.
551
Andy Greened334462013-02-07 21:14:33 +0800552 - Header tokens are now deleted after the websocket connection is
Andy Green54495112013-02-06 21:10:16 +0900553 established. Not just the header data is saved, but the pointer and
554 length array is also removed from (union) scope saving several hundred
555 bytes per connection once it is established
556
557 - struct libwebsocket_protocols has a new member rx_buffer_size, this
558 controls rx buffer size per connection of that protocol now. Sources
559 for apps built against older versions of the library won't declare
560 this in their protocols, defaulting it to 0. Zero buffer is legal,
561 it causes a default buffer to be allocated (currently 4096)
562
563 If you want to receive only atomic frames in your user callback, you
564 should set this to greater than your largest frame size. If a frame
565 comes that exceeds that, no error occurs but the callback happens as
566 soon as the buffer limit is reached, and again if it is reached again
567 or the frame completes. You can detect that has happened by seeing
568 there is still frame content pending using
569 libwebsockets_remaining_packet_payload()
570
571 By correctly setting this, you can save a lot of memory when your
572 protocol has small frames (see the test server and client sources).
573
Andy Green16ab3182013-02-10 18:02:31 +0800574 - LWS_MAX_HEADER_LEN now defaults to 1024 and is the total amount of known
575 header payload lws can cope with, that includes the GET URL, origin
576 etc. Headers not understood by lws are ignored and their payload
577 not included in this.
578
Andy Green54495112013-02-06 21:10:16 +0900579
580User api removals
581-----------------
582
Andy Green16ab3182013-02-10 18:02:31 +0800583 - The configuration-time option MAX_USER_RX_BUFFER has been replaced by a
584 buffer size chosen per-protocol. For compatibility, there's a default
585 of 4096 rx buffer, but user code should set the appropriate size for
586 the protocol frames.
587
588 - LWS_INITIAL_HDR_ALLOC and LWS_ADDITIONAL_HDR_ALLOC are no longer needed
589 and have been removed. There's a new header management scheme that
590 handles them in a much more compact way.
Andy Greened334462013-02-07 21:14:33 +0800591
Andy Green70edd6f2013-02-12 10:15:25 +0800592 - libwebsockets_hangup_on_client() is removed. If you want to close the
593 connection you must do so from the user callback and by returning
594 -1 from there.
595
Andy Green508946c2013-02-12 10:19:08 +0800596 - libwebsocket_close_and_free_session() is now private to the library code
597 only and not exposed for user code. If you want to close the
598 connection, you must do so from the user callback by returning -1
599 from there.
600
Andy Greened334462013-02-07 21:14:33 +0800601
Andy Greendf60b0c2013-02-06 19:57:12 +0900602New features
603------------
604
Andy Green9b09dc02013-02-08 12:48:36 +0800605 - Cmake project file added, aimed initially at Windows support: this replaces
Andy Green16ab3182013-02-10 18:02:31 +0800606 the visual studio project files that were in the tree until now.
Andy Greendf60b0c2013-02-06 19:57:12 +0900607
Andy Greenc3ef0d62013-02-12 10:50:49 +0800608 - CyaSSL now supported in place of OpenSSL (--use-cyassl on configure)
609
Andy Green9b09dc02013-02-08 12:48:36 +0800610 - PATH_MAX or MAX_PATH no longer needed
Andy Greendf60b0c2013-02-06 19:57:12 +0900611
Andy Green54495112013-02-06 21:10:16 +0900612 - cutomizable frame rx buffer size by protocol
613
Andy Greenc3ef0d62013-02-12 10:50:49 +0800614 - optional TCP keepalive so dead peers can be detected, can be enabled at
615 context-creation time
616
617 - valgrind-clean: no SSL or CyaSSL: completely clean. With OpenSSL, 88 bytes
618 lost at OpenSSL library init and symptomless reports of uninitialized
619 memory usage... seems to be a known and ignored problem at OpenSSL
620
Andy Greena3957ef2013-02-11 09:31:43 +0800621 - By default debug is enabled and the library is built for -O0 -g to faclitate
622 that. Use --disable-debug configure option to build instead with -O4
623 and no -g (debug info), obviously providing best performance and
624 reduced binary size.
Andy Green7b405452013-02-01 10:50:15 +0800625
Andy Green895d56d2013-02-11 09:32:53 +0800626 - 1.0 introduced some code to try to not deflate small frames, however this
627 seems to break when confronted with a mixture of frames above and
628 below the threshold, so it's removed. Veto the compression extension
629 in your user callback if you will typically have very small frames.
630
Andy Green16ab3182013-02-10 18:02:31 +0800631 - There are many memory usage improvements, both a reduction in malloc/
632 realloc and architectural changes. A websocket connection now
633 consumes only 296 bytes with SSL or 272 bytes without on x86_64,
634 during header processing an additional 1262 bytes is allocated in a
635 single malloc, but is freed when the websocket connection starts.
636 The RX frame buffer defined by the protocol in user
637 code is also allocated per connection, this represents the largest
638 frame you can receive atomically in that protocol.
639
Andy Greenc3ef0d62013-02-12 10:50:49 +0800640 - On ARM9 build, just http+ws server no extensions or ssl, <12Kbytes .text
641 and 112 bytes per connection (+1328 only during header processing)
642
Andy Green895d56d2013-02-11 09:32:53 +0800643
Andy Greenbd1132f2013-01-31 19:53:05 +0800644v1.1-chrome26-firefox18
Andy Greena35c86f2013-01-31 10:16:44 +0800645=======================
646
647Diffstat
648--------
649
650 Makefile.am | 4 +
651 README-test-server | 291 ---
652 README.build | 239 ++
653 README.coding | 138 ++
654 README.rst | 72 -
655 README.test-apps | 272 +++
656 configure.ac | 116 +-
657 lib/Makefile.am | 55 +-
658 lib/base64-decode.c | 5 +-
659 lib/client-handshake.c | 121 +-
660 lib/client-parser.c | 394 ++++
661 lib/client.c | 807 +++++++
662 lib/daemonize.c | 212 ++
663 lib/extension-deflate-frame.c | 132 +-
664 lib/extension-deflate-stream.c | 12 +-
665 lib/extension-x-google-mux.c | 1223 ----------
666 lib/extension-x-google-mux.h | 96 -
667 lib/extension.c | 8 -
668 lib/getifaddrs.c | 271 +++
669 lib/getifaddrs.h | 76 +
670 lib/handshake.c | 582 +----
671 lib/libwebsockets.c | 2493 ++++++---------------
672 lib/libwebsockets.h | 115 +-
673 lib/md5.c | 217 --
674 lib/minilex.c | 440 ++++
675 lib/output.c | 628 ++++++
676 lib/parsers.c | 2016 +++++------------
677 lib/private-libwebsockets.h | 284 +--
678 lib/server-handshake.c | 275 +++
679 lib/server.c | 377 ++++
680 libwebsockets-api-doc.html | 300 +--
681 m4/ignore-me | 2 +
682 test-server/Makefile.am | 111 +-
683 test-server/libwebsockets.org-logo.png | Bin 0 -> 7029 bytes
684 test-server/test-client.c | 45 +-
685 test-server/test-echo.c | 330 +++
686 test-server/test-fraggle.c | 20 +-
687 test-server/test-ping.c | 22 +-
688 test-server/test-server-extpoll.c | 554 -----
689 test-server/test-server.c | 349 ++-
690 test-server/test.html | 3 +-
691 win32port/zlib/ZLib.vcxproj | 749 ++++---
692 win32port/zlib/ZLib.vcxproj.filters | 188 +-
693 win32port/zlib/adler32.c | 348 ++-
694 win32port/zlib/compress.c | 160 +-
695 win32port/zlib/crc32.c | 867 ++++----
696 win32port/zlib/crc32.h | 882 ++++----
697 win32port/zlib/deflate.c | 3799 +++++++++++++++-----------------
698 win32port/zlib/deflate.h | 688 +++---
699 win32port/zlib/gzclose.c | 50 +-
700 win32port/zlib/gzguts.h | 325 ++-
701 win32port/zlib/gzlib.c | 1157 +++++-----
702 win32port/zlib/gzread.c | 1242 ++++++-----
703 win32port/zlib/gzwrite.c | 1096 +++++----
704 win32port/zlib/infback.c | 1272 ++++++-----
705 win32port/zlib/inffast.c | 680 +++---
706 win32port/zlib/inffast.h | 22 +-
707 win32port/zlib/inffixed.h | 188 +-
708 win32port/zlib/inflate.c | 2976 +++++++++++++------------
709 win32port/zlib/inflate.h | 244 +-
710 win32port/zlib/inftrees.c | 636 +++---
711 win32port/zlib/inftrees.h | 124 +-
712 win32port/zlib/trees.c | 2468 +++++++++++----------
713 win32port/zlib/trees.h | 256 +--
714 win32port/zlib/uncompr.c | 118 +-
715 win32port/zlib/zconf.h | 934 ++++----
716 win32port/zlib/zlib.h | 3357 ++++++++++++++--------------
717 win32port/zlib/zutil.c | 642 +++---
718 win32port/zlib/zutil.h | 526 ++---
719 69 files changed, 19556 insertions(+), 20145 deletions(-)
720
721user api changes
722----------------
723
724 - libwebsockets_serve_http_file() now takes a context as first argument
725
726 - libwebsockets_get_peer_addresses() now takes a context and wsi as first
727 two arguments
728
729
730user api additions
731------------------
732
733 - lwsl_...() logging apis, default to stderr but retargetable by user code;
734 may be used also by user code
735
736 - lws_set_log_level() set which logging apis are able to emit (defaults to
737 notice, warn, err severities), optionally set the emit callback
738
739 - lwsl_emit_syslog() helper callback emits to syslog
740
741 - lws_daemonize() helper code that forks the app into a headless daemon
742 properly, maintains a lock file with pid in suitable for sysvinit etc to
743 control lifecycle
744
745 - LWS_CALLBACK_HTTP_FILE_COMPLETION callback added since http file
746 transfer is now asynchronous (see test server code)
747
748 - lws_frame_is_binary() from a wsi pointer, let you know if the received
749 data was sent in BINARY mode
750
751
752user api removals
753-----------------
754
755 - libwebsockets_fork_service_loop() - no longer supported (had intractable problems)
756 arrange your code to act from the user callback instead from same
757 process context as the service loop
758
759 - libwebsockets_broadcast() - use libwebsocket_callback_on_writable[_all_protocol]()
760 instead from same process context as the service loop. See the test apps
761 for examples.
762
763 - x-google-mux() removed until someone wants it
764
765 - pre -v13 (ancient) protocol support removed
766
767
768New features
769------------
770
771 - echo test server and client compatible with echo.websocket.org added
772
773 - many new configure options (see README.build) to reduce footprint of the
774 library to what you actually need, eg, --without-client and
775 --without-server
776
777 - http + websocket server can build to as little as 12K .text for ARM
778
779 - no more MAX_CLIENTS limitation; adapts to support the max number of fds
780 allowed to the process by ulimit, defaults to 1024 on Fedora and
781 Ubuntu. Use ulimit to control this without needing to configure
782 the library. Code here is smaller and faster.
783
784 - adaptive ratio of listen socket to connection socket service allows
785 good behaviour under Apache ab test load. Tested with thousands
786 of simultaneous connections
787
788 - reduction in per-connection memory footprint by moving to a union to hold
789 mutually-exclusive state for the connection
790
791 - robustness: Out of Memory taken care of for all allocation code now
792
793 - internal getifaddrs option if your toolchain lacks it (some uclibc)
794
795 - configurable memory limit for deflate operations
796
797 - improvements in SSL code nonblocking operation, possible hang solved,
798 some SSL operations broken down into pollable states so there is
799 no library blocking, timeout coverage for SSL_connect
800
801 - extpoll test server merged into single test server source
802
803 - robustness: library should deal with all recoverable socket conditions
804
805 - rx flowcontrol for backpressure notification fixed and implmeneted
806 correctly in the test server
807
808 - optimal lexical parser added for header processing; all headers in a
809 single 276-byte state table
810
811 - latency tracking api added (configure --with-latency)
812
813 - Improved in-tree documentation, REAME.build, README.coding,
814 README.test-apps, changelog
815
816 - Many small fixes
817
818
819v1.0-chrome25-firefox17 (6cd1ea9b005933f)