f9ceaa2319cac747a810888514458d1bd16937f8
[platform/upstream/libwebsockets.git] / changelog
1 Changelog
2 ---------
3
4 (since v1.23)
5
6 User api additions
7 ------------------
8
9 POST method is supported
10
11 The protocol 0 / HTTP callback can now get two new kinds of callback,
12 LWS_CALLBACK_HTTP_BODY (in and len are a chunk of the body of the HTTP request)
13 and LWS_CALLBACK_HTTP_BODY_COMPLETION (the expected amount of body has arrived
14 and been passed to the user code already).  These callbacks are used with the
15 post method (see the test server for details).
16
17 The period between the HTTP header completion and the completion of the body
18 processing is protected by a 5s timeout.
19
20 The chunks are stored in a malloc'd buffer of size protocols[0].rx_buffer_size.
21
22
23 New server option you can enable from user code
24 LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT allows non-SSL connections to
25 also be accepted on an SSL listening port.  It's disabled unless you enable
26 it explicitly.
27
28
29 Two new callbacks are added in protocols[0] that are optional for allowing
30 limited thread access to libwebsockets, LWS_CALLBACK_LOCK_POLL and
31 LWS_CALLBACK_UNLOCK_POLL.
32
33 If you use them, they protect internal and external poll list changes, but if
34 you want to use external thread access to libwebsocket_callback_on_writable()
35 you have to implement your locking here even if you don't use external
36 poll support.
37
38 If you will use another thread for this, take a lot of care about managing
39 your list of live wsi by doing it from ESTABLISHED and CLOSED callbacks
40 (with your own locking).
41
42
43
44 User api changes
45 ----------------
46
47 Extra optional argument to libwebsockets_serve_http_file() allows injecion
48 of HTTP headers into the canned response.  Eg, cookies may be added like
49 that without getting involved in having to send the header by hand.
50
51 A new info member http_proxy_address may be used at context creation time to
52 set the http proxy.  If non-NULL, it overrides http_proxy environment var.
53
54 Cmake supports LWS_SSL_CLIENT_USE_OS_CA_CERTS defaulting to on, which gets
55 the client to use the OS CA Roots.  If you're worried somebody with the
56 ability to forge for force creation of a client cert from the root CA in
57 your OS, you should disable this since your selfsigned $0 cert is a lot safer
58 then...
59
60
61 v1.23-chrome32-firefox24
62 ========================
63
64  Android.mk                            |   29 +
65  CMakeLists.txt                        |  573 ++++++++----
66  COPYING                               |  503 -----------
67  INSTALL                               |  365 --------
68  Makefile.am                           |   13 -
69  README.build                          |  371 ++------
70  README.coding                         |   63 ++
71  autogen.sh                            | 1578 ---------------------------------
72  changelog                             |   69 ++
73  cmake/FindGit.cmake                   |  163 ++++
74  cmake/FindOpenSSLbins.cmake           |   15 +-
75  cmake/UseRPMTools.cmake               |  176 ++++
76  config.h.cmake                        |   25 +-
77  configure.ac                          |  226 -----
78  cross-arm-linux-gnueabihf.cmake       |   28 +
79  lib/Makefile.am                       |   89 --
80  lib/base64-decode.c                   |   98 +-
81  lib/client-handshake.c                |  123 ++-
82  lib/client-parser.c                   |   19 +-
83  lib/client.c                          |  145 ++-
84  lib/daemonize.c                       |    4 +-
85  lib/extension.c                       |    2 +-
86  lib/getifaddrs.h                      |    4 +-
87  lib/handshake.c                       |   76 +-
88  lib/libwebsockets.c                   |  491 ++++++----
89  lib/libwebsockets.h                   |  164 ++--
90  lib/output.c                          |  214 ++++-
91  lib/parsers.c                         |  102 +--
92  lib/private-libwebsockets.h           |   66 +-
93  lib/server-handshake.c                |    5 +-
94  lib/server.c                          |   29 +-
95  lib/sha-1.c                           |    2 +-
96  libwebsockets-api-doc.html            |  249 +++---
97  libwebsockets.pc.in                   |   11 -
98  libwebsockets.spec                    |   14 +-
99  m4/ignore-me                          |    2 -
100  scripts/FindLibWebSockets.cmake       |   33 +
101  scripts/kernel-doc                    |    1 +
102  test-server/Makefile.am               |  131 ---
103  test-server/leaf.jpg                  |  Bin 0 -> 2477518 bytes
104  test-server/test-client.c             |   78 +-
105  test-server/test-echo.c               |   33 +-
106  test-server/test-fraggle.c            |   26 +-
107  test-server/test-ping.c               |   15 +-
108  test-server/test-server.c             |  197 +++-
109  test-server/test.html                 |    5 +-
110  win32port/win32helpers/gettimeofday.c |   74 +-
111  win32port/win32helpers/websock-w32.h  |    6 +-
112  48 files changed, 2493 insertions(+), 4212 deletions(-)
113
114
115 User api additions
116 ------------------
117
118  - You can now call libwebsocket_callback_on_writable() on http connectons,
119         and get a LWS_CALLBACK_HTTP_WRITEABLE callback, the same way you can
120         regulate writes with a websocket protocol connection.
121
122  - A new member in the context creation parameter struct "ssl_cipher_list" is
123         added, replacing CIPHERS_LIST_STRING.  NULL means use the ssl library
124         default list of ciphers.
125
126  - Not really an api addition, but libwebsocket_service_fd() will now zero
127         the revents field of the pollfd it was called with if it handled the
128         descriptor.  So you can tell if it is a non-lws fd by checking revents
129         after the service call... if it's still nonzero, the descriptor
130         belongs to you and you need to take care of it.
131
132  - libwebsocket_rx_flow_allow_all_protocol(protocol) will unthrottle all
133         connections with the established protocol.  It's designed to be
134         called from user server code when it sees it can accept more input
135         and may have throttled connections using the server rx flow apis
136         while it was unable to accept any other input  The user server code
137         then does not have to try to track while connections it choked, this
138         will free up all of them in one call.
139
140  - there's a new, optional callback LWS_CALLBACK_CLOSED_HTTP which gets
141         called when an HTTP protocol socket closes
142
143  - for LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION callback, the user_space alloc
144         has already been done before the callback happens.  That means we can
145         use the user parameter to the callback to contain the user pointer, and
146         move the protocol name to the "in" parameter.  The docs for this
147         callback are also updated to reflect how to check headers in there.
148
149  - libwebsocket_client_connect() is now properly nonblocking and async.  See
150         README.coding and test-client.c for information on the callbacks you
151         can rely on controlling the async connection period with.
152
153  - if your OS does not support the http_proxy environment variable convention
154         (eg, reportedly OSX), you can use a new api libwebsocket_set_proxy()
155         to set the proxy details inbetween context creation and the connection
156         action.  For OSes that support http_proxy, that's used automatically.
157
158 User api changes
159 ----------------
160
161  - the external poll callbacks now get the socket descriptor coming from the
162         "in" parameter.  The user parameter provides the user_space for the
163         wsi as it normally does on the other callbacks.
164         LWS_CALLBACK_FILTER_NETWORK_CONNECTION also has the socket descriptor
165         delivered by @in now instead of @user.
166
167  - libwebsocket_write() now returns -1 for error, or the amount of data
168         actually accepted for send.  Under load, the OS may signal it is
169         ready to send new data on the socket, but have only a restricted
170         amount of memory to buffer the packet compared to usual.
171
172
173 User api removal
174 ----------------
175
176  - libwebsocket_ensure_user_space() is removed from the public api, if you
177         were using it to get user_space, you need to adapt your code to only
178         use user_space inside the user callback.
179
180  - CIPHERS_LIST_STRING is removed
181
182  - autotools build has been removed.  See README.build for info on how to
183         use CMake for your platform
184
185
186 v1.21-chrome26-firefox18
187 ========================
188
189  - Fixes buffer overflow bug in max frame size handling if you used the
190         default protocol buffer size.  If you declared rx_buffer_size in your
191         protocol, which is recommended anyway, your code was unaffected.
192
193 v1.2-chrome26-firefox18
194 =======================
195
196 Diffstat
197 --------
198
199  .gitignore                                                      |  16 +++
200  CMakeLists.txt                                                  | 544 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
201  LICENSE                                                         | 526 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
202  Makefile.am                                                     |   1 +
203  README                                                          |  20 +++
204  README.build                                                    | 258 ++++++++++++++++++++++++++++++++-----
205  README.coding                                                   |  52 ++++++++
206  changelog                                                       | 136 ++++++++++++++++++++
207  cmake/FindOpenSSLbins.cmake                                     |  33 +++++
208  config.h.cmake                                                  | 173 +++++++++++++++++++++++++
209  configure.ac                                                    |  22 +++-
210  lib/Makefile.am                                                 |  20 ++-
211  lib/base64-decode.c                                             |   2 +-
212  lib/client-handshake.c                                          | 190 +++++++++++-----------------
213  lib/client-parser.c                                             |  88 +++++++------
214  lib/client.c                                                    | 384 ++++++++++++++++++++++++++++++-------------------------
215  lib/daemonize.c                                                 |  32 +++--
216  lib/extension-deflate-frame.c                                   |  58 +++++----
217  lib/extension-deflate-stream.c                                  |  19 ++-
218  lib/extension-deflate-stream.h                                  |   4 +-
219  lib/extension.c                                                 |  11 +-
220  lib/getifaddrs.c                                                | 315 +++++++++++++++++++++++-----------------------
221  lib/getifaddrs.h                                                |  30 ++---
222  lib/handshake.c                                                 | 124 +++++++++++-------
223  lib/libwebsockets.c                                             | 736 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------------------------
224  lib/libwebsockets.h                                             | 237 ++++++++++++++++++++++------------
225  lib/output.c                                                    | 192 +++++++++++-----------------
226  lib/parsers.c                                                   | 966 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----------------------------------------------------------------
227  lib/private-libwebsockets.h                                     | 225 +++++++++++++++++++++------------
228  lib/server-handshake.c                                          |  82 ++++++------
229  lib/server.c                                                    |  96 +++++++-------
230  libwebsockets-api-doc.html                                      | 189 ++++++++++++++++++----------
231  libwebsockets.spec                                              |  17 +--
232  test-server/attack.sh                                           | 148 ++++++++++++++++++++++
233  test-server/test-client.c                                       | 125 +++++++++---------
234  test-server/test-echo.c                                         |  31 +++--
235  test-server/test-fraggle.c                                      |  32 ++---
236  test-server/test-ping.c                                         |  52 ++++----
237  test-server/test-server.c                                       | 129 ++++++++++++-------
238  win32port/libwebsocketswin32/libwebsocketswin32.vcxproj         | 279 ----------------------------------------
239  win32port/libwebsocketswin32/libwebsocketswin32.vcxproj.filters |  23 +++-
240  41 files changed, 4398 insertions(+), 2219 deletions(-)
241
242
243 User api additions
244 ------------------
245
246  - lws_get_library_version() returns a const char * with a string like
247          "1.1 9e7f737", representing the library version from configure.ac
248          and the git HEAD hash the library was built from
249
250  - TCP Keepalive can now optionally be applied to all lws sockets, on Linux
251         also with controllable timeout, number of probes and probe interval.
252         (On BSD type OS, you can only use system default settings for the
253         timing and retries, although enabling it is supported by setting
254         ka_time to nonzero, the exact value has no meaning.)
255         This enables detection of idle connections which are logically okay,
256         but are in fact dead, due to network connectivity issues at the server,
257         client, or any intermediary.  By default it's not enabled, but you
258         can enable it by setting a non-zero timeout (in seconds) at the new
259         ka_time member at context creation time.
260
261  - Two new optional user callbacks added, LWS_CALLBACK_PROTOCOL_DESTROY which
262         is called one-time per protocol as the context is being destroyed, and
263         LWS_CALLBACK_PROTOCOL_INIT which is called when the context is created
264         and the protocols are added, again it's a one-time affair.
265         This lets you manage per-protocol allocations properly including
266         cleaning up after yourself when the server goes down.
267
268 User api changes
269 ----------------
270
271  - libwebsocket_create_context() has changed from taking a ton of parameters
272         to just taking a pointer to a struct containing the parameters.  The
273         struct lws_context_creation_info is in libwebsockets.h, the members
274         are in the same order as when they were parameters to the call
275         previously.  The test apps are all updated accordingly so you can
276         see example code there.
277
278  - Header tokens are now deleted after the websocket connection is
279         established.  Not just the header data is saved, but the pointer and
280         length array is also removed from (union) scope saving several hundred
281         bytes per connection once it is established
282
283  - struct libwebsocket_protocols has a new member rx_buffer_size, this
284         controls rx buffer size per connection of that protocol now.  Sources
285         for apps built against older versions of the library won't declare
286         this in their protocols, defaulting it to 0.  Zero buffer is legal,
287         it causes a default buffer to be allocated (currently 4096)
288
289         If you want to receive only atomic frames in your user callback, you
290         should set this to greater than your largest frame size.  If a frame
291         comes that exceeds that, no error occurs but the callback happens as
292         soon as the buffer limit is reached, and again if it is reached again
293         or the frame completes.  You can detect that has happened by seeing
294         there is still frame content pending using
295         libwebsockets_remaining_packet_payload()
296
297         By correctly setting this, you can save a lot of memory when your
298         protocol has small frames (see the test server and client sources).
299
300  - LWS_MAX_HEADER_LEN now defaults to 1024 and is the total amount of known
301         header payload lws can cope with, that includes the GET URL, origin
302         etc.  Headers not understood by lws are ignored and their payload
303         not included in this.
304
305
306 User api removals
307 -----------------
308
309  - The configuration-time option MAX_USER_RX_BUFFER has been replaced by a
310         buffer size chosen per-protocol.  For compatibility, there's a default
311         of 4096 rx buffer, but user code should set the appropriate size for
312         the protocol frames.
313
314  - LWS_INITIAL_HDR_ALLOC and LWS_ADDITIONAL_HDR_ALLOC are no longer needed
315         and have been removed.  There's a new header management scheme that
316         handles them in a much more compact way.
317
318  - libwebsockets_hangup_on_client() is removed.  If you want to close the
319         connection you must do so from the user callback and by returning
320         -1 from there.
321
322  - libwebsocket_close_and_free_session() is now private to the library code
323         only and not exposed for user code.  If you want to close the
324         connection, you must do so from the user callback by returning -1
325         from there.
326
327
328 New features
329 ------------
330
331  - Cmake project file added, aimed initially at Windows support: this replaces
332         the visual studio project files that were in the tree until now.
333
334  - CyaSSL now supported in place of OpenSSL (--use-cyassl on configure)
335
336  - PATH_MAX or MAX_PATH no longer needed
337
338  - cutomizable frame rx buffer size by protocol
339
340  - optional TCP keepalive so dead peers can be detected, can be enabled at
341         context-creation time
342
343  - valgrind-clean: no SSL or CyaSSL: completely clean.  With OpenSSL, 88 bytes
344         lost at OpenSSL library init and symptomless reports of uninitialized
345         memory usage... seems to be a known and ignored problem at OpenSSL
346
347  - By default debug is enabled and the library is built for -O0 -g to faclitate
348         that.  Use --disable-debug configure option to build instead with -O4
349         and no -g (debug info), obviously providing best performance and
350         reduced binary size.
351
352  - 1.0 introduced some code to try to not deflate small frames, however this
353         seems to break when confronted with a mixture of frames above and
354         below the threshold, so it's removed.  Veto the compression extension
355         in your user callback if you will typically have very small frames.
356
357  - There are many memory usage improvements, both a reduction in malloc/
358         realloc and architectural changes.  A websocket connection now
359         consumes only 296 bytes with SSL or 272 bytes without on x86_64,
360         during header processing an additional 1262 bytes is allocated in a
361         single malloc, but is freed when the websocket connection starts.
362         The RX frame buffer defined by the protocol in user
363         code is also allocated per connection, this represents the largest
364         frame you can receive atomically in that protocol.
365
366  - On ARM9 build, just http+ws server no extensions or ssl, <12Kbytes .text
367         and 112 bytes per connection (+1328 only during header processing)
368
369
370 v1.1-chrome26-firefox18
371 =======================
372
373 Diffstat
374 --------
375
376  Makefile.am                            |    4 +
377  README-test-server                     |  291 ---
378  README.build                           |  239 ++
379  README.coding                          |  138 ++
380  README.rst                             |   72 -
381  README.test-apps                       |  272 +++
382  configure.ac                           |  116 +-
383  lib/Makefile.am                        |   55 +-
384  lib/base64-decode.c                    |    5 +-
385  lib/client-handshake.c                 |  121 +-
386  lib/client-parser.c                    |  394 ++++
387  lib/client.c                           |  807 +++++++
388  lib/daemonize.c                        |  212 ++
389  lib/extension-deflate-frame.c          |  132 +-
390  lib/extension-deflate-stream.c         |   12 +-
391  lib/extension-x-google-mux.c           | 1223 ----------
392  lib/extension-x-google-mux.h           |   96 -
393  lib/extension.c                        |    8 -
394  lib/getifaddrs.c                       |  271 +++
395  lib/getifaddrs.h                       |   76 +
396  lib/handshake.c                        |  582 +----
397  lib/libwebsockets.c                    | 2493 ++++++---------------
398  lib/libwebsockets.h                    |  115 +-
399  lib/md5.c                              |  217 --
400  lib/minilex.c                          |  440 ++++
401  lib/output.c                           |  628 ++++++
402  lib/parsers.c                          | 2016 +++++------------
403  lib/private-libwebsockets.h            |  284 +--
404  lib/server-handshake.c                 |  275 +++
405  lib/server.c                           |  377 ++++
406  libwebsockets-api-doc.html             |  300 +--
407  m4/ignore-me                           |    2 +
408  test-server/Makefile.am                |  111 +-
409  test-server/libwebsockets.org-logo.png |  Bin 0 -> 7029 bytes
410  test-server/test-client.c              |   45 +-
411  test-server/test-echo.c                |  330 +++
412  test-server/test-fraggle.c             |   20 +-
413  test-server/test-ping.c                |   22 +-
414  test-server/test-server-extpoll.c      |  554 -----
415  test-server/test-server.c              |  349 ++-
416  test-server/test.html                  |    3 +-
417  win32port/zlib/ZLib.vcxproj            |  749 ++++---
418  win32port/zlib/ZLib.vcxproj.filters    |  188 +-
419  win32port/zlib/adler32.c               |  348 ++-
420  win32port/zlib/compress.c              |  160 +-
421  win32port/zlib/crc32.c                 |  867 ++++----
422  win32port/zlib/crc32.h                 |  882 ++++----
423  win32port/zlib/deflate.c               | 3799 +++++++++++++++-----------------
424  win32port/zlib/deflate.h               |  688 +++---
425  win32port/zlib/gzclose.c               |   50 +-
426  win32port/zlib/gzguts.h                |  325 ++-
427  win32port/zlib/gzlib.c                 | 1157 +++++-----
428  win32port/zlib/gzread.c                | 1242 ++++++-----
429  win32port/zlib/gzwrite.c               | 1096 +++++----
430  win32port/zlib/infback.c               | 1272 ++++++-----
431  win32port/zlib/inffast.c               |  680 +++---
432  win32port/zlib/inffast.h               |   22 +-
433  win32port/zlib/inffixed.h              |  188 +-
434  win32port/zlib/inflate.c               | 2976 +++++++++++++------------
435  win32port/zlib/inflate.h               |  244 +-
436  win32port/zlib/inftrees.c              |  636 +++---
437  win32port/zlib/inftrees.h              |  124 +-
438  win32port/zlib/trees.c                 | 2468 +++++++++++----------
439  win32port/zlib/trees.h                 |  256 +--
440  win32port/zlib/uncompr.c               |  118 +-
441  win32port/zlib/zconf.h                 |  934 ++++----
442  win32port/zlib/zlib.h                  | 3357 ++++++++++++++--------------
443  win32port/zlib/zutil.c                 |  642 +++---
444  win32port/zlib/zutil.h                 |  526 ++---
445  69 files changed, 19556 insertions(+), 20145 deletions(-)
446
447 user api changes
448 ----------------
449
450  - libwebsockets_serve_http_file() now takes a context as first argument
451
452  - libwebsockets_get_peer_addresses() now takes a context and wsi as first
453         two arguments
454
455
456 user api additions
457 ------------------
458
459  - lwsl_...() logging apis, default to stderr but retargetable by user code;
460         may be used also by user code
461
462  - lws_set_log_level() set which logging apis are able to emit (defaults to
463         notice, warn, err severities), optionally set the emit callback
464
465  - lwsl_emit_syslog() helper callback emits to syslog
466
467  - lws_daemonize() helper code that forks the app into a headless daemon
468         properly, maintains a lock file with pid in suitable for sysvinit etc to
469         control lifecycle
470
471  - LWS_CALLBACK_HTTP_FILE_COMPLETION callback added since http file
472         transfer is now asynchronous (see test server code)
473
474  - lws_frame_is_binary() from a wsi pointer, let you know if the received
475         data was sent in BINARY mode
476
477
478 user api removals
479 -----------------
480
481  - libwebsockets_fork_service_loop() - no longer supported (had intractable problems)
482         arrange your code to act from the user callback instead from same
483         process context as the service loop
484
485  - libwebsockets_broadcast() - use libwebsocket_callback_on_writable[_all_protocol]()
486         instead from same process context as the service loop.  See the test apps
487         for examples.
488
489  - x-google-mux() removed until someone wants it
490
491  - pre -v13 (ancient) protocol support removed
492
493
494 New features
495 ------------
496
497  - echo test server and client compatible with echo.websocket.org added
498
499  - many new configure options (see README.build) to reduce footprint of the
500         library to what you actually need, eg, --without-client and
501         --without-server
502
503  - http + websocket server can build to as little as 12K .text for ARM
504
505  - no more MAX_CLIENTS limitation; adapts to support the max number of fds
506         allowed to the process by ulimit, defaults to 1024 on Fedora and
507         Ubuntu.  Use ulimit to control this without needing to configure
508         the library.  Code here is smaller and faster.
509
510  - adaptive ratio of listen socket to connection socket service allows
511         good behaviour under Apache ab test load.  Tested with thousands
512         of simultaneous connections
513
514  - reduction in per-connection memory footprint by moving to a union to hold
515         mutually-exclusive state for the connection
516
517  - robustness: Out of Memory taken care of for all allocation code now
518
519  - internal getifaddrs option if your toolchain lacks it (some uclibc)
520
521  - configurable memory limit for deflate operations
522
523  - improvements in SSL code nonblocking operation, possible hang solved,
524         some SSL operations broken down into pollable states so there is
525         no library blocking, timeout coverage for SSL_connect
526
527  - extpoll test server merged into single test server source
528
529  - robustness: library should deal with all recoverable socket conditions
530
531  - rx flowcontrol for backpressure notification fixed and implmeneted
532         correctly in the test server
533
534  - optimal lexical parser added for header processing; all headers in a
535         single 276-byte state table
536
537  - latency tracking api added (configure --with-latency)
538
539  - Improved in-tree documentation, REAME.build, README.coding,
540         README.test-apps, changelog
541
542  - Many small fixes
543
544
545 v1.0-chrome25-firefox17 (6cd1ea9b005933f)