changelog

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