lib/ssl.c: fix libre- and boringssl
[platform/upstream/libwebsockets.git] / changelog
1 Changelog
2 ---------
3
4 Fixes
5 -----
6
7 1) OpenSSL version tests not needed on LibreSSL and BoringSSL
8
9
10 v2.0.0
11 ======
12
13 Summary
14 -------
15
16  - There are only api additions, the api is compatible with v1.7.x.  But
17    there is necessarily an soname bump to 8.
18  
19  - If you are using lws client, you mainly need to be aware the option
20    LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT is needed at context-creation time
21    if you will use SSL.
22    
23  - If you are using lws for serving, the above is also true but there are
24    many new features to simplify your code (and life).  There is a
25    summany online here
26    
27      https://libwebsockets.org/lws-2.0-new-features.html
28      
29    but basically the keywords are vhosts, mounts and plugins.  You can now
30    do the web serving part from lws without any user callback code at all.
31    See ./test-server/test-server-v2.0.c for an example, it has no user
32    code for ws either since it uses the protocol plugins... that one C file
33    is all that is needed to do the whole test server function.
34    
35    You now have the option to use a small generic ws-capable webserver
36    "lwsws" and write your ws part as a plugin.  That eliminates even
37    cut-and-pasting the test server code and offers more configurable
38    features like control over http cacheability in JSON.
39
40
41 Fixes
42 -----
43
44 These are already in 1.7.x series
45
46 1) MAJOR (Windows-only) fix assert firing
47
48 2) MAJOR http:/1.1 connections handled by  lws_return_http_status() did not
49 get sent a content-length resulting in the link hanging until the peer closed
50 it.  attack.sh updated to add a test for this.
51
52 3) MINOR An error about hdr struct in _lws_ws_related is corrected, it's not
53 known to affect anything until after it was fixed
54
55 4) MINOR During the close shutdown wait state introduced at v1.7, if something
56 requests callback on writeable for the socket it will busywait until the
57 socket closes
58
59 5) MAJOR Although the test server has done it for a few versions already, it
60 is now required for the user code to explicitly call
61
62         if (lws_http_transaction_completed(wsi))
63                 return -1;
64
65 when it finishes replying to a transaction in http.  Previously the library
66 did it for you, but that disallowed large, long transfers with multiple
67 trips around the event loop (and cgi...).
68
69 6) MAJOR connections on ah waiting list that closed did not get removed from
70 the waiting list...
71
72 7) MAJOR since we added the ability to hold an ah across http keepalive
73 transactions where more headers had already arrived, we broke the ability
74 to tell if more headers had arrived.  Result was if the browser didn't
75 close the keepalive, we retained ah for the lifetime of the keepalive,
76 using up the pool.
77
78 8) MAJOR windows-only-POLLHUP was not coming
79
80 9) Client should not send ext hdr if no exts
81
82 Changes
83 -------
84
85 1) MINOR test-server gained some new switches
86
87    -C <file>  use external SSL cert file
88    -K <file>  use external SSL key file
89    -A <file>  use external SSL CA cert file
90    
91    -u <uid>  set effective uid
92    -g <gid>  set effective gid
93
94 together you can use them like this to have the test-server work with the
95 usual purchased SSL certs from an official CA.
96
97    --ssl -C your.crt -K your.key -A your.cer -u 99 -g 99
98
99 2) MINOR the OpenSSL magic to setup ECDH cipher usage is implemented in the
100 library, and the ciphers restricted to use ECDH only.
101 Using this, the lws test server can score an A at SSLLABS test
102
103 3) MINOR STS (SSL always) header is added to the test server if you use --ssl.  With
104 that, we score A+ at SSLLABS test
105
106 4) MINOR daemonize function (disabled at cmake by default) is updated to work
107 with systemd
108
109 5) MINOR example systemd .service file now provided for test server
110 (not installed by default)
111
112 6) test server html is updated with tabs and a new live server monitoring
113 feature.  Input sanitization added to the js.
114
115 7) client connections attempted when no ah is free no longer fail, they are
116 just deferred until an ah becomes available.
117
118 8) The test client pays attention to if you give it an http:/ or https://
119 protocol string to its argument in URL format.  If so, it stays in http[s]
120 client mode and doesn't upgrade to ws[s], allowing you to do generic http client
121 operations.  Receiving transfer-encoding: chunked is supported.
122
123 9) If you enable -DLWS_WITH_HTTP_PROXY=1 at cmake, the test server has a
124 new URI path http://localhost:7681/proxytest If you visit here, a client
125 connection to http://example.com:80 is spawned, and the results piped on
126 to your original connection.
127
128 10) Also with LWS_WITH_HTTP_PROXY enabled at cmake, lws wants to link to an
129 additional library, "libhubbub".  This allows lws to do html rewriting on the
130 fly, adjusting proxied urls in a lightweight and fast way.
131
132 11) There's a new context creation flag LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT,
133 this is included automatically if you give any other SSL-related option flag.
134 If you give no SSL-related option flag, nor this one directly, then even
135 though SSL support may be compiled in, it is never initialized nor used for the
136 whole lifetime of the lws context.
137
138 Conversely in order to prepare the context to use SSL, even though, eg, you
139 are not listening on SSL but will use SSL client connections later, you must
140 give this flag explicitly to make sure SSL is initialized.
141
142
143 User API additions
144 ------------------
145
146 1) MINOR APIBREAK There's a new member in struct lws_context_creation_info, ecdh_curve,
147 which lets you set the name of the ECDH curve OpenSSL should use.  By
148 default (if you leave ecdh_curve NULL) it will use "prime256v1"
149
150 2) MINOR NEWAPI It was already possible to adopt a foreign socket that had not
151 been read from using lws_adopt_socket() since v1.7.  Now you can adopt a
152 partially-used socket if you don't need SSL, by passing it what you read
153 so it can drain that before reading from the socket.
154
155 LWS_VISIBLE LWS_EXTERN struct lws *
156 lws_adopt_socket_readbuf(struct lws_context *context, lws_sockfd_type accept_fd,
157                 const char *readbuf, size_t len);
158
159 3) MINOR NEWAPI CGI type "network io" subprocess execution is now possible from
160 a simple api.
161
162 LWS_VISIBLE LWS_EXTERN int
163 lws_cgi(struct lws *wsi, char * const *exec_array,  int script_uri_path_len,
164         int timeout_secs);
165
166 LWS_VISIBLE LWS_EXTERN int
167 lws_cgi_kill(struct lws *wsi);
168
169 To use it, you must first set the cmake option
170
171 $ cmake .. -DLWS_WITH_CGI=1
172
173 See test-server-http.c and  test server path
174
175 http://localhost:7681/cgitest
176
177 stdin gets http body, you can test it with wget
178
179 $ echo hello > hello.txt
180 $ wget http://localhost:7681/cgitest --post-file=hello.txt -O- --quiet
181 lwstest script
182 read="hello"
183
184 The test script returns text/html table showing /proc/meminfo.  But the cgi
185 support is complete enough to run cgit cgi.
186
187 4) There is a helper api for forming logging timestamps
188
189 LWS_VISIBLE int
190 lwsl_timestamp(int level, char *p, int len)
191
192 this generates this kind of timestamp for use as logging preamble
193
194 lwsts[13116]: [2016/01/25 14:52:52:8386] NOTICE: Initial logging level 7
195
196 5) struct lws_client_connect_info has a new member
197
198  const char *method
199  
200 If it's NULL, then everything happens as before, lws_client_connect_via_info()
201 makes a ws or wss connection to the address given.
202
203 If you set method to a valid http method like "GET", though, then this method
204 is used and the connection remains in http[s], it's not upgraded to ws[s].
205
206 So with this, you can perform http[s] client operations as well as ws[s] ones.
207
208 There are 4 new related callbacks
209
210         LWS_CALLBACK_ESTABLISHED_CLIENT_HTTP                    = 44,
211         LWS_CALLBACK_CLOSED_CLIENT_HTTP                         = 45,
212         LWS_CALLBACK_RECEIVE_CLIENT_HTTP                        = 46,
213         LWS_CALLBACK_COMPLETED_CLIENT_HTTP                      = 47,
214
215 6) struct lws_client_connect_info has a new member
216
217  const char *parent_wsi
218  
219 if non-NULL, the client wsi is set to be a child of parent_wsi.  This ensures
220 if parent_wsi closes, then the client child is closed just before.
221
222 7) If you're using SSL, there's a new context creation-time option flag
223 LWS_SERVER_OPTION_REDIRECT_HTTP_TO_HTTPS.  If you give this, non-ssl
224 connections to the server listen port are accepted and receive a 301
225 redirect to / on the same host and port using https://
226
227 8) User code may set per-connection extension options now, using a new api
228 "lws_set_extension_option()".
229
230 This should be called from the ESTABLISHED callback like this
231
232  lws_set_extension_option(wsi, "permessage-deflate",
233                           "rx_buf_size", "12"); /* 1 << 12 */
234
235 If the extension is not active (missing or not negotiated for the
236 connection, or extensions are disabled on the library) the call is
237 just returns -1.  Otherwise the connection's extension has its
238 named option changed.
239
240 The extension may decide to alter or disallow the change, in the
241 example above permessage-deflate restricts the size of his rx
242 output buffer also considering the protocol's rx_buf_size member.
243
244
245 New application lwsws
246 ---------------------
247
248 A libwebsockets-based general webserver is built by default now, lwsws.
249
250 It's configured by JSON, by default in
251
252   /etc/lwsws/conf
253
254 which contains global lws context settings like this
255
256 {
257   "global": {
258    "uid": "99",
259    "gid": "99",
260    "interface": "eth0",
261    "count-threads": "1"
262  }
263 }
264
265   /etc/lwsws/conf.d/*
266
267 which contains zero or more files describing vhosts, like this
268
269 {
270  "vhosts": [
271   { "name": "warmcat.com",
272     "port": "443",
273     "host-ssl-key": "/etc/pki/tls/private/warmcat.com.key",
274     "host-ssl-cert": "/etc/pki/tls/certs/warmcat.com.crt",
275     "host-ssl-ca": "/etc/pki/tls/certs/warmcat.com.cer",
276     "mounts": [
277       { "/": [
278        { "home": "file:///var/www/warmcat.com" },
279        { "default": "index.html" }
280       ]
281      }
282     ]
283    }
284  ]
285 }
286
287
288
289 v1.7.0
290 ======
291
292 Extension Changes
293 -----------------
294
295 1) There is now a "permessage-deflate" / RFC7692 implementation.  It's very
296 similar to "deflate-frame" we have offered for a long while; deflate-frame is
297 now provided as an alias of permessage-deflate.
298
299 The main differences are that the new permessage-deflate implementation:
300
301  - properly performs streaming respecting input and output buffer limits.  The
302    old deflate-frame implementation could only work on complete deflate input
303    and produce complete inflate output for each frame.  The new implementation
304    only mallocs buffers at initialization.
305
306  - goes around the event loop after each input package is processed allowing
307    interleaved output processing.  The RX flow control api can be used to
308    force compressed input processing to match the rate of compressed output
309    processing (test--echo shows an example of how to do this).
310
311  - when being "deflate-frame" for compatibility he uses the same default zlib
312    settings as the old "deflate-frame", but instead of exponentially increasing
313    malloc allocations until the whole output will fit, he observes the default
314    input and output chunking buffer sizes of "permessage-deflate", that's
315    1024 in and 1024 out at a time.
316
317 2) deflate-stream has been disabled for many versions (for over a year) and is
318 now removed.  Browsers are now standardizing on "permessage-deflate" / RFC7692
319
320 3) struct lws_extension is simplified, and lws extensions now have a public
321 api (their callback) for use in user code to compose extensions and options
322 the user code wants.  lws_get_internal_exts() is deprecated but kept around
323 as a NOP.  The changes allow one extension implementation to go by different
324 names and allows the user client code to control option offers per-ext.
325
326 The test client and server are updated to use the new way.  If you use
327 the old way it should still work, but extensions will be disabled until you
328 update your code.
329
330 Extensions are now responsible for allocating and per-instance private struct
331 at instance construction time and freeing it when the instance is destroyed.
332 Not needing to know the size means the extension's struct can be opaque
333 to user code.
334
335
336 User api additions
337 ------------------
338
339 1) The info struct gained three new members
340
341  - max_http_header_data: 0 for default (1024) or set the maximum amount of known
342     http header payload that lws can deal with.  Payload in unknown http
343     headers is dropped silently.  If for some reason you need to send huge
344     cookies or other HTTP-level headers, you can now increase this at context-
345     creation time.
346
347  - max_http_header_pool: 0 for default (16) or set the maximum amount of http
348      headers that can be tracked by lws in this context.  For the server, if
349      the header pool is completely in use then accepts on the listen socket
350      are disabled until one becomes free.  For the client, if you simultaneously
351      have pending connects for more than this number of client connections,
352      additional connects will fail until some of the pending connections timeout
353      or complete.
354
355  - timeout_secs: 0 for default (currently 20s), or set the library's
356      network activity timeout to the given number of seconds
357
358 HTTP header processing in lws only exists until just after the first main
359 callback after the HTTP handshake... for ws connections that is ESTABLISHED and
360 for HTTP connections the HTTP callback.
361
362 So these settings are not related to the maximum number of simultaneous
363 connections, but the number of HTTP handshakes that may be expected or ongoing,
364 or have just completed, at one time.  The reason it's useful is it changes the
365 memory allocation for header processing to be one-time at context creation
366 instead of every time there is a new connection, and gives you control over
367 the peak allocation.
368
369 Setting max_http_header_pool to 1 is fine it will just queue incoming
370 connections before the accept as necessary, you can still have as many
371 simultaneous post-header connections as you like.  Since the http header
372 processing is completed and the allocation released after ESTABLISHED or the
373 HTTP callback, even with a pool of 1 many connections can be handled rapidly.
374
375 2) There is a new callback that allows the user code to get acccess to the
376 optional close code + aux data that may have been sent by the peer.
377
378 LWS_CALLBACK_WS_PEER_INITIATED_CLOSE:
379              The peer has sent an unsolicited Close WS packet.  @in and
380              @len are the optional close code (first 2 bytes, network
381              order) and the optional additional information which is not
382              defined in the standard, and may be a string or non-human-
383              readble data.
384              If you return 0 lws will echo the close and then close the
385              connection.  If you return nonzero lws will just close the
386              connection.
387
388 As usual not handling it does the right thing, if you're not interested in it
389 just ignore it.
390
391 The test server has "open and close" testing buttons at the bottom, if you
392 open and close that connection, on close it will send a close code 3000 decimal
393 and the string "Bye!" as the aux data.
394
395 The test server dumb-increment callback handles this callback reason and prints
396
397 lwsts[15714]: LWS_CALLBACK_WS_PEER_INITIATED_CLOSE: len 6
398 lwsts[15714]:  0: 0x0B
399 lwsts[15714]:  1: 0xB8
400 lwsts[15714]:  2: 0x42
401 lwsts[15714]:  3: 0x79
402 lwsts[15714]:  4: 0x65
403 lwsts[15714]:  5: 0x21
404
405 3) There is a new API to allow the user code to control the content of the
406 close frame sent when about to return nonzero from the user callback to
407 indicate the connection should close.
408
409 /**
410  * lws_close_reason - Set reason and aux data to send with Close packet
411  *              If you are going to return nonzero from the callback
412  *              requesting the connection to close, you can optionally
413  *              call this to set the reason the peer will be told if
414  *              possible.
415  *
416  * @wsi:        The websocket connection to set the close reason on
417  * @status:     A valid close status from websocket standard
418  * @buf:        NULL or buffer containing up to 124 bytes of auxiliary data
419  * @len:        Length of data in @buf to send
420  */
421 LWS_VISIBLE LWS_EXTERN void
422 lws_close_reason(struct lws *wsi, enum lws_close_status status,
423                  unsigned char *buf, size_t len);
424
425 An extra button is added to the "open and close" test server page that requests
426 that the test server close the connection from his end.
427
428 The test server code will do so by
429
430                         lws_close_reason(wsi, LWS_CLOSE_STATUS_GOINGAWAY,
431                                          (unsigned char *)"seeya", 5);
432                         return -1;
433
434 The browser shows the close code and reason he received
435
436 websocket connection CLOSED, code: 1001, reason: seeya
437
438 4) There's a new context creation time option flag
439
440 LWS_SERVER_OPTION_VALIDATE_UTF8
441
442 if you set it in info->options, then TEXT and CLOSE frames will get checked to
443 confirm that they contain valid UTF-8.  If they don't, the connection will get
444 closed by lws.
445
446 5) ECDH Certs are now supported.  Enable the CMake option
447
448 cmake .. -DLWS_SSL_SERVER_WITH_ECDH_CERT=1 
449
450 **and** the info->options flag
451
452 LWS_SERVER_OPTION_SSL_ECDH
453
454 to build in support and select it at runtime.
455
456 6) There's a new api lws_parse_uri() that simplifies chopping up
457 https://xxx:yyy/zzz uris into parts nicely.  The test client now uses this
458 to allow proper uris as well as the old address style.
459
460 7) SMP support is integrated into LWS without any internal threading.  It's
461 very simple to use, libwebsockets-test-server-pthread shows how to do it,
462 use -j <n> argument there to control the number of service threads up to 32.
463
464 Two new members are added to the info struct
465
466         unsigned int count_threads;
467         unsigned int fd_limit_per_thread;
468         
469 leave them at the default 0 to get the normal singlethreaded service loop.
470
471 Set count_threads to n to tell lws you will have n simultaneous service threads
472 operating on the context.
473
474 There is still a single listen socket on one port, no matter how many
475 service threads.
476
477 When a connection is made, it is accepted by the service thread with the least
478 connections active to perform load balancing.
479
480 The user code is responsible for spawning n threads running the service loop
481 associated to a specific tsi (Thread Service Index, 0 .. n - 1).  See
482 the libwebsockets-test-server-pthread for how to do.
483
484 If you leave fd_limit_per_thread at 0, then the process limit of fds is shared
485 between the service threads; if you process was allowed 1024 fds overall then
486 each thread is limited to 1024 / n.
487
488 You can set fd_limit_per_thread to a nonzero number to control this manually, eg
489 the overall supported fd limit is less than the process allowance.
490
491 You can control the context basic data allocation for multithreading from Cmake
492 using -DLWS_MAX_SMP=, if not given it's set to 32.  The serv_buf allocation
493 for the threads (currently 4096) is made at runtime only for active threads.
494
495 Because lws will limit the requested number of actual threads supported
496 according to LWS_MAX_SMP, there is an api lws_get_count_threads(context) to
497 discover how many threads were actually allowed when the context was created.
498
499 It's required to implement locking in the user code in the same way that
500 libwebsockets-test-server-pthread does it, for the FD locking callbacks.
501
502 If LWS_MAX_SMP=1, then there is no code related to pthreads compiled in the
503 library.  If more than 1, a small amount of pthread mutex code is built into
504 the library.
505
506 8) New API
507
508 LWS_VISIBLE struct lws *
509 lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd)
510
511 allows foreign sockets accepted by non-lws code to be adopted by lws as if they
512 had just been accepted by lws' own listen socket.
513
514 9) X-Real-IP: header has been added as WSI_TOKEN_HTTP_X_REAL_IP
515
516 10) Libuv support is added, there are new related user apis
517
518 typedef void (lws_uv_signal_cb_t)(uv_loop_t *l, uv_signal_t *w, int revents);
519
520 LWS_VISIBLE LWS_EXTERN int
521 lws_uv_sigint_cfg(struct lws_context *context, int use_uv_sigint,
522                   lws_uv_signal_cb_t *cb);
523
524 LWS_VISIBLE LWS_EXTERN int
525 lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi);
526
527 LWS_VISIBLE void
528 lws_uv_sigint_cb(uv_loop_t *loop, uv_signal_t *watcher, int revents);
529
530 and CMAKE option
531
532 LWS_WITH_LIBUV
533
534
535 User api changes
536 ----------------
537
538 1) LWS_SEND_BUFFER_POST_PADDING is now 0 and deprecated.  You can remove it; if
539 you still use it, obviously it does nothing.  Old binary code with nonzero
540 LWS_SEND_BUFFER_POST_PADDING is perfectly compatible, the old code just
541 allocated a buffer bigger than the library is going to use.
542
543 The example apps no longer use LWS_SEND_BUFFER_POST_PADDING.
544
545 The only path who made use of it was sending with LWS_WRITE_CLOSE --->
546
547 2) Because of lws_close_reason() formalizing handling close frames,
548 LWS_WRITE_CLOSE is removed from libwebsockets.h.  It was only of use to send
549 close frames...close frame content should be managed using lws_close_reason()
550 now.
551
552 3) We check for invalid CLOSE codes and complain about protocol violation in
553 our close code.  But it changes little since we were in the middle of closing
554 anyway.
555
556 4) zero-length RX frames and zero length TX frames are now allowed.
557
558 5) Pings and close used to be limited to 124 bytes, the correct limit is 125
559 so that is now also allowed.
560
561 6) LWS_PRE is provided as a synonym for LWS_SEND_BUFFER_PRE_PADDING, either is
562 valid to use now.
563
564 7) There's generic support for RFC7462 style extension options built into the
565 library now.  As a consequence, a field "options" is added to lws_extension.
566 It can be NULL if there are no options on the extension.  Extension internal
567 info is part of the public abi because extensions may be implemented outside
568 the library.
569
570 8) WSI_TOKEN_PROXY enum was accidentally defined to collide with another token
571 of value 73.  That's now corrected and WSI_TOKEN_PROXY moved to his own place at
572 77.
573
574 9) With the addition of libuv support, libev is not the only event loop
575 library in town and his api names must be elaborated with _ev_
576
577   Callback typedef: lws_signal_cb ---> lws_ev_signal_cb_t
578   lws_sigint_cfg --> lws_ev_sigint_cfg
579   lws_initloop --> lws_ev_initloop
580   lws_sigint_cb --> lws_ev_sigint_cb
581
582 10) Libev support is made compatible with multithreaded service,
583 lws_ev_initloop (was lws_initloop) gets an extra argument for the
584 thread service index (use 0 if you will just have 1 service thread).
585
586 LWS_VISIBLE LWS_EXTERN int
587 lws_ev_initloop(struct lws_context *context, ev_loop_t *loop, int tsi);
588
589
590 v1.6.0-chrome48-firefox42
591 =======================
592
593 Major API improvements
594 ----------------------
595
596 v1.6.0 has many cleanups and improvements in the API.  Although at first it
597 looks pretty drastic, user code will only need four actions to update it.
598
599  - Do the three search/replaces in your user code, /libwebsocket_/lws_/,
600    /libwebsockets_/lws_/, and /struct\ libwebsocket/struct\ lws/
601
602  - Remove the context parameter from your user callbacks
603
604  - Remove context as the first parameter from the "Eleven APIS" listed in the
605    User Api Changes section
606
607  - Add lws_get_context(wsi) as the first parameter on the "Three APIS" listed
608    in the User Api Changes section, and anywhere else you still need context
609
610 That's it... generally only a handful of the 14 affected APIs are actually in
611 use in your user code and you can find them quickest by compiling and visiting
612 the errors each in turn.  And the end results are much cleaner, more
613 predictable and maintainable.
614
615
616 User api additions
617 ------------------
618
619 1) lws now exposes his internal platform file abstraction in a way that can be
620 both used by user code to make it platform-agnostic, and be overridden or
621 subclassed by user code.  This allows things like handling the URI "directory
622 space" as a virtual filesystem that may or may not be backed by a regular
623 filesystem.  One example use is serving files from inside large compressed
624 archive storage without having to unpack anything except the file being
625 requested.
626
627 The test server shows how to use it, basically the platform-specific part of
628 lws prepares a file operations structure that lives in the lws context.
629
630 Helpers are provided to also leverage these platform-independent file handling
631 apis
632
633 static inline lws_filefd_type
634 lws_plat_file_open(struct lws *wsi, const char *filename,
635                    unsigned long *filelen, int flags)
636 static inline int
637 lws_plat_file_close(struct lws *wsi, lws_filefd_type fd)
638
639 static inline unsigned long
640 lws_plat_file_seek_cur(struct lws *wsi, lws_filefd_type fd, long offset)
641
642 static inline int
643 lws_plat_file_read(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
644                    unsigned char *buf, unsigned long len)
645
646 static inline int
647 lws_plat_file_write(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
648                     unsigned char *buf, unsigned long len)
649                     
650 The user code can also override or subclass the file operations, to either
651 wrap or replace them.  An example is shown in test server.
652
653 A wsi can be associated with the file activity, allowing per-connection
654 authentication and state to be used when interpreting the file request.
655
656 2) A new API void * lws_wsi_user(struct lws *wsi) lets you get the pointer to
657 the user data associated with the wsi, just from the wsi.
658
659 3) URI argument handling.  Libwebsockets parses and protects URI arguments
660 like test.html?arg1=1&arg2=2, it decodes %xx uriencoding format and reduces
661 path attacks like ../.../../etc/passwd so they cannot go behind the web
662 server's /.  There is a list of confirmed attacks we're proof against in
663 ./test-server/attack.sh.
664
665 There is a new API lws_hdr_copy_fragment that should be used now to access
666 the URI arguments (it returns the fragments length)
667
668                while (lws_hdr_copy_fragment(wsi, buf, sizeof(buf),
669                                             WSI_TOKEN_HTTP_URI_ARGS, n) > 0) {
670                        lwsl_info("URI Arg %d: %s\n", ++n, buf);
671                }
672
673 For the example above, calling with n=0 will return "arg1=1" and n=1 "arg2=2".
674 All legal uriencodings will have been reduced in those strings.
675
676 lws_hdr_copy_fragment() returns the length of the x=y fragment, so it's also
677 possible to deal with arguments containing %00.  If you don't care about that,
678 the returned string has '\0' appended to simplify processing.
679
680
681 User api changes
682 ----------------
683
684 1) Three APIS
685
686  - lws_callback_on_writable_all_protocol(const struct lws_protocols *protocol)
687  - lws_callback_all_protocol(const struct lws_protocols *protocol)
688  - lws_rx_flow_allow_all_protocol(lws_rx_flow_allow_all_protocol)
689
690 Now take an additional pointer to the lws_context in their first argument.
691
692 The reason for this change is struct lws_protocols has been changed to remove
693 members that lws used for private storage: so the protocols struct in now
694 truly const and may be reused serially or simultaneously by different contexts.
695
696 2) Eleven APIs
697
698 LWS_VISIBLE LWS_EXTERN int
699 lws_add_http_header_by_name(struct lws_context *context,
700                 struct lws *wsi,
701                 const unsigned char *name,
702                 const unsigned char *value,
703                 int length,
704                 unsigned char **p,
705                 unsigned char *end);
706 LWS_VISIBLE LWS_EXTERN int
707 lws_finalize_http_header(struct lws_context *context,
708              struct lws *wsi,
709              unsigned char **p,
710              unsigned char *end);
711 LWS_VISIBLE LWS_EXTERN int
712 lws_add_http_header_by_token(struct lws_context *context,
713                  struct lws *wsi,
714                  enum lws_token_indexes token,
715                  const unsigned char *value,
716                  int length,
717                  unsigned char **p,
718                  unsigned char *end);
719 LWS_VISIBLE LWS_EXTERN int
720 lws_add_http_header_content_length(struct lws_context *context,
721                    struct lws *wsi,
722                    unsigned long content_length,
723                    unsigned char **p,
724                    unsigned char *end);
725 LWS_VISIBLE LWS_EXTERN int
726 lws_add_http_header_status(struct lws_context *context, struct lws *wsi,
727                unsigned int code, unsigned char **p,
728                unsigned char *end);
729
730 LWS_VISIBLE LWS_EXTERN int
731 lws_serve_http_file(struct lws_context *context, struct lws *wsi,
732             const char *file, const char *content_type,
733             const char *other_headers, int other_headers_len);
734 LWS_VISIBLE LWS_EXTERN int
735 lws_serve_http_file_fragment(struct lws_context *context, struct lws *wsi);
736
737 LWS_VISIBLE LWS_EXTERN int
738 lws_return_http_status(struct lws_context *context, struct lws *wsi,
739                unsigned int code, const char *html_body);
740
741 LWS_VISIBLE LWS_EXTERN int
742 lws_callback_on_writable(const struct lws_context *context, struct lws *wsi);
743
744 LWS_VISIBLE LWS_EXTERN void
745 lws_get_peer_addresses(struct lws_context *context, struct lws *wsi,
746                lws_sockfd_type fd, char *name, int name_len,
747                char *rip, int rip_len);
748
749 LWS_VISIBLE LWS_EXTERN int
750 lws_read(struct lws_context *context, struct lws *wsi,
751      unsigned char *buf, size_t len); 
752
753 no longer require their initial struct lws_context * parameter.
754
755 3) Several older apis start with libwebsocket_ or libwebsockets_ while newer ones
756 all begin lws_.  These apis have been changed to all begin with lws_.
757
758 To convert, search-replace
759
760  - libwebsockets_/lws_
761  - libwebsocket_/lws_
762  - struct\ libwebsocket/struct\ lws
763  
764 4) context parameter removed from user callback.
765
766 Since almost all apis no longer need the context as a parameter, it's no longer
767 provided at the user callback directly.
768
769 However if you need it, for ALL callbacks wsi is valid and has a valid context
770 pointer you can recover using lws_get_context(wsi).
771
772
773 v1.5-chrome47-firefox41
774 =======================
775
776 User api changes
777 ----------------
778
779 LWS_CALLBACK_CLIENT_CONNECTION_ERROR may provide an error string if in is
780 non-NULL.  If so, the string has length len.
781
782 LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED is available to relax the requirement
783 for peer certs if you are using the option to require client certs.
784
785 LWS_WITHOUT_BUILTIN_SHA1 cmake option forces lws to use SHA1() defined
786 externally, eg, byOpenSSL, and disables build of libwebsockets_SHA1()
787
788
789 v1.4-chrome43-firefox36
790 =======================
791
792 User api additions
793 ------------------
794
795 There's a new member in the info struct used to control context creation,
796 ssl_private_key_password, which allows passing into lws the passphrase on
797 an SSL cetificate
798
799 There's a new member in struct protocols, id, which is ignored by lws but can
800 be used by the user code to mark the selected protocol by user-defined version
801 or capabliity flag information, for the case multiple versions of a protocol are
802 supported.
803
804 int lws_is_ssl(wsi) added to allow user code to know if the connection was made
805 over ssl or not.  If LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT is used, both
806 ssl and non-ssl connections are possible and may need to be treated differently
807 in the user code.
808
809 int lws_partial_buffered(wsi) added... should be checked after any
810 libwebsocket_write that will be followed by another libwebsocket_write inside
811 the same writeable callback.  If set, you can't do any more writes until the
812 writeable callback is called again.  If you only do one write per writeable callback,
813 you can ignore this.
814
815 HTTP2-related: HTTP2 changes how headers are handled, lws now has new version-
816 agnositic header creation APIs.  These do the right thing depending on each
817 connection's HTTP version without the user code having to know or care, except
818 to make sure to use the new APIs for headers (test-server is updated to use
819 them already, so look there for examples)
820
821 The APIs "render" the headers into a user-provided buffer and bump *p as it
822 is used.  If *p reaches end, then the APIs return nonzero for error.
823
824 LWS_VISIBLE LWS_EXTERN int
825 lws_add_http_header_status(struct libwebsocket_context *context,
826                             struct libwebsocket *wsi,
827                             unsigned int code,
828                             unsigned char **p,
829                             unsigned char *end);
830
831 Start a response header reporting status like 200, 500, etc
832
833 LWS_VISIBLE LWS_EXTERN int
834 lws_add_http_header_by_name(struct libwebsocket_context *context,
835                             struct libwebsocket *wsi,
836                             const unsigned char *name,
837                             const unsigned char *value,
838                             int length,
839                             unsigned char **p,
840                             unsigned char *end);
841
842 Add a header like name: value in HTTP1.x
843
844 LWS_VISIBLE LWS_EXTERN int 
845 lws_finalize_http_header(struct libwebsocket_context *context,
846                             struct libwebsocket *wsi,
847                             unsigned char **p,
848                             unsigned char *end);
849
850 Finish off the headers, like add the extra \r\n in HTTP1.x
851
852 LWS_VISIBLE LWS_EXTERN int
853 lws_add_http_header_by_token(struct libwebsocket_context *context,
854                             struct libwebsocket *wsi,
855                             enum lws_token_indexes token,
856                             const unsigned char *value,
857                             int length,
858                             unsigned char **p,
859                             unsigned char *end);
860
861 Add a header by using a lws token as the name part.  In HTTP2, this can be
862 compressed to one or two bytes.
863
864
865 User api removal
866 ----------------
867
868 protocols struct member no_buffer_all_partial_tx is removed.  Under some
869 conditions like rewriting extension such as compression in use, the built-in
870 partial send buffering is the only way to deal with the problem, so turning
871 it off is deprecated.
872
873
874 User api changes
875 ----------------
876
877 HTTP2-related: API libwebsockets_serve_http_file() takes an extra parameter at
878 the end now
879
880 int other_headers_len)
881
882 If you are providing other headers, they must be generated using the new
883 HTTP-version-agnostic APIs, and you must provide the length of them using this
884 additional parameter.
885
886 struct lws_context_creation_info now has an additional member
887 SSL_CTX *provided_client_ssl_ctx you may set to an externally-initialized
888 SSL_CTX managed outside lws.  Defaulting to zero keeps the existing behaviour of
889 lws managing the context, if you memset the struct to 0 or have as a filescope
890 initialized struct in bss, no need to change anything.
891
892
893 v1.3-chrome37-firefox30
894 =======================
895
896  .gitignore                                               |    1 -
897  CMakeLists.txt                                           |  447 +++--
898  README.build                                             |   35 +-
899  README.coding                                            |   14 +
900  changelog                                                |   66 +
901  cmake/LibwebsocketsConfig.cmake.in                       |   17 +
902  cmake/LibwebsocketsConfigVersion.cmake.in                |   11 +
903  config.h.cmake                                           |   18 +
904  cross-ming.cmake                                         |   31 +
905  cross-openwrt-makefile                                   |   91 +
906  lib/client-handshake.c                                   |  205 ++-
907  lib/client-parser.c                                      |   58 +-
908  lib/client.c                                             |  158 +-
909  lib/context.c                                            |  341 ++++
910  lib/extension-deflate-frame.c                            |    2 +-
911  lib/extension.c                                          |  178 ++
912  lib/handshake.c                                          |  287 +---
913  lib/lextable.h                                           |  338 ++++
914  lib/libev.c                                              |  175 ++
915  lib/libwebsockets.c                                      | 2089 +++--------------------
916  lib/libwebsockets.h                                      |  253 ++-
917  lib/lws-plat-unix.c                                      |  404 +++++
918  lib/lws-plat-win.c                                       |  358 ++++
919  lib/minilex.c                                            |  530 +++---
920  lib/output.c                                             |  445 ++---
921  lib/parsers.c                                            |  682 ++++----
922  lib/pollfd.c                                             |  239 +++
923  lib/private-libwebsockets.h                              |  501 +++++-
924  lib/server-handshake.c                                   |  274 +--
925  lib/server.c                                             |  858 ++++++++--
926  lib/service.c                                            |  517 ++++++
927  lib/sha-1.c                                              |   38 +-
928  lib/ssl-http2.c                                          |   78 +
929  lib/ssl.c                                                |  571 +++++++
930  test-server/attack.sh                                    |  101 +-
931  test-server/test-client.c                                |    9 +-
932  test-server/test-echo.c                                  |   17 +-
933  test-server/test-fraggle.c                               |    7 -
934  test-server/test-ping.c                                  |   12 +-
935  test-server/test-server.c                                |  330 ++--
936  test-server/test.html                                    |    4 +-
937  win32port/client/client.vcxproj                          |  259 ---
938  win32port/client/client.vcxproj.filters                  |   39 -
939  .../libwebsocketswin32.vcxproj.filters                   |   93 -
940  win32port/server/server.vcxproj                          |  276 ---
941  win32port/server/server.vcxproj.filters                  |   51 -
942  win32port/win32helpers/gettimeofday.h                    |   59 +-
943  win32port/win32helpers/netdb.h                           |    1 -
944  win32port/win32helpers/strings.h                         |    0
945  win32port/win32helpers/sys/time.h                        |    1 -
946  win32port/win32helpers/unistd.h                          |    0
947  win32port/win32helpers/websock-w32.c                     |  104 --
948  win32port/win32helpers/websock-w32.h                     |   62 -
949  win32port/win32port.sln                                  |  100 --
950  win32port/zlib/gzio.c                                    |    3 +-
951  55 files changed, 6779 insertions(+), 5059 deletions(-)
952
953
954 User api additions
955 ------------------
956
957 POST method is supported
958
959 The protocol 0 / HTTP callback can now get two new kinds of callback,
960 LWS_CALLBACK_HTTP_BODY (in and len are a chunk of the body of the HTTP request)
961 and LWS_CALLBACK_HTTP_BODY_COMPLETION (the expected amount of body has arrived
962 and been passed to the user code already).  These callbacks are used with the
963 post method (see the test server for details).
964
965 The period between the HTTP header completion and the completion of the body
966 processing is protected by a 5s timeout.
967
968 The chunks are stored in a malloc'd buffer of size protocols[0].rx_buffer_size.
969
970
971 New server option you can enable from user code
972 LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT allows non-SSL connections to
973 also be accepted on an SSL listening port.  It's disabled unless you enable
974 it explicitly.
975
976
977 Two new callbacks are added in protocols[0] that are optional for allowing
978 limited thread access to libwebsockets, LWS_CALLBACK_LOCK_POLL and
979 LWS_CALLBACK_UNLOCK_POLL.
980
981 If you use them, they protect internal and external poll list changes, but if
982 you want to use external thread access to libwebsocket_callback_on_writable()
983 you have to implement your locking here even if you don't use external
984 poll support.
985
986 If you will use another thread for this, take a lot of care about managing
987 your list of live wsi by doing it from ESTABLISHED and CLOSED callbacks
988 (with your own locking).
989
990 If you configure cmake with -DLWS_WITH_LIBEV=1 then the code allowing the libev
991 eventloop instead of the default poll() one will also be compiled in.  But to
992 use it, you must also set the LWS_SERVER_OPTION_LIBEV flag on the context
993 creation info struct options member.
994
995 IPV6 is supported and enabled by default except for Windows, you can disable
996 the support at build-time by giving -DLWS_IPV6=, and disable use of it even if
997 compiled in by making sure the flag LWS_SERVER_OPTION_DISABLE_IPV6 is set on
998 the context creation info struct options member.
999
1000 You can give LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS option flag to
1001 guarantee the OS CAs will not be used, even if that support was selected at
1002 build-time.
1003
1004 Optional "token limits" may be enforced by setting the member "token_limits"
1005 in struct lws_context_creation_info to point to a struct lws_token_limits.
1006 NULL means no token limits used for compatibility.
1007
1008
1009 User api changes
1010 ----------------
1011
1012 Extra optional argument to libwebsockets_serve_http_file() allows injecion
1013 of HTTP headers into the canned response.  Eg, cookies may be added like
1014 that without getting involved in having to send the header by hand.
1015
1016 A new info member http_proxy_address may be used at context creation time to
1017 set the http proxy.  If non-NULL, it overrides http_proxy environment var.
1018
1019 Cmake supports LWS_SSL_CLIENT_USE_OS_CA_CERTS defaulting to on, which gets
1020 the client to use the OS CA Roots.  If you're worried somebody with the
1021 ability to forge for force creation of a client cert from the root CA in
1022 your OS, you should disable this since your selfsigned $0 cert is a lot safer
1023 then...
1024
1025
1026 v1.23-chrome32-firefox24
1027 ========================
1028
1029  Android.mk                            |   29 +
1030  CMakeLists.txt                        |  573 ++++++++----
1031  COPYING                               |  503 -----------
1032  INSTALL                               |  365 --------
1033  Makefile.am                           |   13 -
1034  README.build                          |  371 ++------
1035  README.coding                         |   63 ++
1036  autogen.sh                            | 1578 ---------------------------------
1037  changelog                             |   69 ++
1038  cmake/FindGit.cmake                   |  163 ++++
1039  cmake/FindOpenSSLbins.cmake           |   15 +-
1040  cmake/UseRPMTools.cmake               |  176 ++++
1041  config.h.cmake                        |   25 +-
1042  configure.ac                          |  226 -----
1043  cross-arm-linux-gnueabihf.cmake       |   28 +
1044  lib/Makefile.am                       |   89 --
1045  lib/base64-decode.c                   |   98 +-
1046  lib/client-handshake.c                |  123 ++-
1047  lib/client-parser.c                   |   19 +-
1048  lib/client.c                          |  145 ++-
1049  lib/daemonize.c                       |    4 +-
1050  lib/extension.c                       |    2 +-
1051  lib/getifaddrs.h                      |    4 +-
1052  lib/handshake.c                       |   76 +-
1053  lib/libwebsockets.c                   |  491 ++++++----
1054  lib/libwebsockets.h                   |  164 ++--
1055  lib/output.c                          |  214 ++++-
1056  lib/parsers.c                         |  102 +--
1057  lib/private-libwebsockets.h           |   66 +-
1058  lib/server-handshake.c                |    5 +-
1059  lib/server.c                          |   29 +-
1060  lib/sha-1.c                           |    2 +-
1061  libwebsockets-api-doc.html            |  249 +++---
1062  libwebsockets.pc.in                   |   11 -
1063  libwebsockets.spec                    |   14 +-
1064  m4/ignore-me                          |    2 -
1065  scripts/FindLibWebSockets.cmake       |   33 +
1066  scripts/kernel-doc                    |    1 +
1067  test-server/Makefile.am               |  131 ---
1068  test-server/leaf.jpg                  |  Bin 0 -> 2477518 bytes
1069  test-server/test-client.c             |   78 +-
1070  test-server/test-echo.c               |   33 +-
1071  test-server/test-fraggle.c            |   26 +-
1072  test-server/test-ping.c               |   15 +-
1073  test-server/test-server.c             |  197 +++-
1074  test-server/test.html                 |    5 +-
1075  win32port/win32helpers/gettimeofday.c |   74 +-
1076  win32port/win32helpers/websock-w32.h  |    6 +-
1077  48 files changed, 2493 insertions(+), 4212 deletions(-)
1078
1079
1080 User api additions
1081 ------------------
1082
1083  - You can now call libwebsocket_callback_on_writable() on http connectons,
1084         and get a LWS_CALLBACK_HTTP_WRITEABLE callback, the same way you can
1085         regulate writes with a websocket protocol connection.
1086
1087  - A new member in the context creation parameter struct "ssl_cipher_list" is
1088         added, replacing CIPHERS_LIST_STRING.  NULL means use the ssl library
1089         default list of ciphers.
1090
1091  - Not really an api addition, but libwebsocket_service_fd() will now zero
1092         the revents field of the pollfd it was called with if it handled the
1093         descriptor.  So you can tell if it is a non-lws fd by checking revents
1094         after the service call... if it's still nonzero, the descriptor
1095         belongs to you and you need to take care of it.
1096
1097  - libwebsocket_rx_flow_allow_all_protocol(protocol) will unthrottle all
1098         connections with the established protocol.  It's designed to be
1099         called from user server code when it sees it can accept more input
1100         and may have throttled connections using the server rx flow apis
1101         while it was unable to accept any other input  The user server code
1102         then does not have to try to track while connections it choked, this
1103         will free up all of them in one call.
1104
1105  - there's a new, optional callback LWS_CALLBACK_CLOSED_HTTP which gets
1106         called when an HTTP protocol socket closes
1107
1108  - for LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION callback, the user_space alloc
1109         has already been done before the callback happens.  That means we can
1110         use the user parameter to the callback to contain the user pointer, and
1111         move the protocol name to the "in" parameter.  The docs for this
1112         callback are also updated to reflect how to check headers in there.
1113
1114  - libwebsocket_client_connect() is now properly nonblocking and async.  See
1115         README.coding and test-client.c for information on the callbacks you
1116         can rely on controlling the async connection period with.
1117
1118  - if your OS does not support the http_proxy environment variable convention
1119         (eg, reportedly OSX), you can use a new api libwebsocket_set_proxy()
1120         to set the proxy details in between context creation and the connection
1121         action.  For OSes that support http_proxy, that's used automatically.
1122
1123 User api changes
1124 ----------------
1125
1126  - the external poll callbacks now get the socket descriptor coming from the
1127         "in" parameter.  The user parameter provides the user_space for the
1128         wsi as it normally does on the other callbacks.
1129         LWS_CALLBACK_FILTER_NETWORK_CONNECTION also has the socket descriptor
1130         delivered by @in now instead of @user.
1131
1132  - libwebsocket_write() now returns -1 for error, or the amount of data
1133         actually accepted for send.  Under load, the OS may signal it is
1134         ready to send new data on the socket, but have only a restricted
1135         amount of memory to buffer the packet compared to usual.
1136
1137
1138 User api removal
1139 ----------------
1140
1141  - libwebsocket_ensure_user_space() is removed from the public api, if you
1142         were using it to get user_space, you need to adapt your code to only
1143         use user_space inside the user callback.
1144
1145  - CIPHERS_LIST_STRING is removed
1146
1147  - autotools build has been removed.  See README.build for info on how to
1148         use CMake for your platform
1149
1150
1151 v1.21-chrome26-firefox18
1152 ========================
1153
1154  - Fixes buffer overflow bug in max frame size handling if you used the
1155         default protocol buffer size.  If you declared rx_buffer_size in your
1156         protocol, which is recommended anyway, your code was unaffected.
1157
1158 v1.2-chrome26-firefox18
1159 =======================
1160
1161 Diffstat
1162 --------
1163
1164  .gitignore                                                      |  16 +++
1165  CMakeLists.txt                                                  | 544 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1166  LICENSE                                                         | 526 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
1167  Makefile.am                                                     |   1 +
1168  README                                                          |  20 +++
1169  README.build                                                    | 258 ++++++++++++++++++++++++++++++++-----
1170  README.coding                                                   |  52 ++++++++
1171  changelog                                                       | 136 ++++++++++++++++++++
1172  cmake/FindOpenSSLbins.cmake                                     |  33 +++++
1173  config.h.cmake                                                  | 173 +++++++++++++++++++++++++
1174  configure.ac                                                    |  22 +++-
1175  lib/Makefile.am                                                 |  20 ++-
1176  lib/base64-decode.c                                             |   2 +-
1177  lib/client-handshake.c                                          | 190 +++++++++++-----------------
1178  lib/client-parser.c                                             |  88 +++++++------
1179  lib/client.c                                                    | 384 ++++++++++++++++++++++++++++++-------------------------
1180  lib/daemonize.c                                                 |  32 +++--
1181  lib/extension-deflate-frame.c                                   |  58 +++++----
1182  lib/extension-deflate-stream.c                                  |  19 ++-
1183  lib/extension-deflate-stream.h                                  |   4 +-
1184  lib/extension.c                                                 |  11 +-
1185  lib/getifaddrs.c                                                | 315 +++++++++++++++++++++++-----------------------
1186  lib/getifaddrs.h                                                |  30 ++---
1187  lib/handshake.c                                                 | 124 +++++++++++-------
1188  lib/libwebsockets.c                                             | 736 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------------------------
1189  lib/libwebsockets.h                                             | 237 ++++++++++++++++++++++------------
1190  lib/output.c                                                    | 192 +++++++++++-----------------
1191  lib/parsers.c                                                   | 966 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----------------------------------------------------------------
1192  lib/private-libwebsockets.h                                     | 225 +++++++++++++++++++++------------
1193  lib/server-handshake.c                                          |  82 ++++++------
1194  lib/server.c                                                    |  96 +++++++-------
1195  libwebsockets-api-doc.html                                      | 189 ++++++++++++++++++----------
1196  libwebsockets.spec                                              |  17 +--
1197  test-server/attack.sh                                           | 148 ++++++++++++++++++++++
1198  test-server/test-client.c                                       | 125 +++++++++---------
1199  test-server/test-echo.c                                         |  31 +++--
1200  test-server/test-fraggle.c                                      |  32 ++---
1201  test-server/test-ping.c                                         |  52 ++++----
1202  test-server/test-server.c                                       | 129 ++++++++++++-------
1203  win32port/libwebsocketswin32/libwebsocketswin32.vcxproj         | 279 ----------------------------------------
1204  win32port/libwebsocketswin32/libwebsocketswin32.vcxproj.filters |  23 +++-
1205  41 files changed, 4398 insertions(+), 2219 deletions(-)
1206
1207
1208 User api additions
1209 ------------------
1210
1211  - lws_get_library_version() returns a const char * with a string like
1212          "1.1 9e7f737", representing the library version from configure.ac
1213          and the git HEAD hash the library was built from
1214
1215  - TCP Keepalive can now optionally be applied to all lws sockets, on Linux
1216         also with controllable timeout, number of probes and probe interval.
1217         (On BSD type OS, you can only use system default settings for the
1218         timing and retries, although enabling it is supported by setting
1219         ka_time to nonzero, the exact value has no meaning.)
1220         This enables detection of idle connections which are logically okay,
1221         but are in fact dead, due to network connectivity issues at the server,
1222         client, or any intermediary.  By default it's not enabled, but you
1223         can enable it by setting a non-zero timeout (in seconds) at the new
1224         ka_time member at context creation time.
1225
1226  - Two new optional user callbacks added, LWS_CALLBACK_PROTOCOL_DESTROY which
1227         is called one-time per protocol as the context is being destroyed, and
1228         LWS_CALLBACK_PROTOCOL_INIT which is called when the context is created
1229         and the protocols are added, again it's a one-time affair.
1230         This lets you manage per-protocol allocations properly including
1231         cleaning up after yourself when the server goes down.
1232
1233 User api changes
1234 ----------------
1235
1236  - libwebsocket_create_context() has changed from taking a ton of parameters
1237         to just taking a pointer to a struct containing the parameters.  The
1238         struct lws_context_creation_info is in libwebsockets.h, the members
1239         are in the same order as when they were parameters to the call
1240         previously.  The test apps are all updated accordingly so you can
1241         see example code there.
1242
1243  - Header tokens are now deleted after the websocket connection is
1244         established.  Not just the header data is saved, but the pointer and
1245         length array is also removed from (union) scope saving several hundred
1246         bytes per connection once it is established
1247
1248  - struct libwebsocket_protocols has a new member rx_buffer_size, this
1249         controls rx buffer size per connection of that protocol now.  Sources
1250         for apps built against older versions of the library won't declare
1251         this in their protocols, defaulting it to 0.  Zero buffer is legal,
1252         it causes a default buffer to be allocated (currently 4096)
1253
1254         If you want to receive only atomic frames in your user callback, you
1255         should set this to greater than your largest frame size.  If a frame
1256         comes that exceeds that, no error occurs but the callback happens as
1257         soon as the buffer limit is reached, and again if it is reached again
1258         or the frame completes.  You can detect that has happened by seeing
1259         there is still frame content pending using
1260         libwebsockets_remaining_packet_payload()
1261
1262         By correctly setting this, you can save a lot of memory when your
1263         protocol has small frames (see the test server and client sources).
1264
1265  - LWS_MAX_HEADER_LEN now defaults to 1024 and is the total amount of known
1266         header payload lws can cope with, that includes the GET URL, origin
1267         etc.  Headers not understood by lws are ignored and their payload
1268         not included in this.
1269
1270
1271 User api removals
1272 -----------------
1273
1274  - The configuration-time option MAX_USER_RX_BUFFER has been replaced by a
1275         buffer size chosen per-protocol.  For compatibility, there's a default
1276         of 4096 rx buffer, but user code should set the appropriate size for
1277         the protocol frames.
1278
1279  - LWS_INITIAL_HDR_ALLOC and LWS_ADDITIONAL_HDR_ALLOC are no longer needed
1280         and have been removed.  There's a new header management scheme that
1281         handles them in a much more compact way.
1282
1283  - libwebsockets_hangup_on_client() is removed.  If you want to close the
1284         connection you must do so from the user callback and by returning
1285         -1 from there.
1286
1287  - libwebsocket_close_and_free_session() is now private to the library code
1288         only and not exposed for user code.  If you want to close the
1289         connection, you must do so from the user callback by returning -1
1290         from there.
1291
1292
1293 New features
1294 ------------
1295
1296  - Cmake project file added, aimed initially at Windows support: this replaces
1297         the visual studio project files that were in the tree until now.
1298
1299  - CyaSSL now supported in place of OpenSSL (--use-cyassl on configure)
1300
1301  - PATH_MAX or MAX_PATH no longer needed
1302
1303  - cutomizable frame rx buffer size by protocol
1304
1305  - optional TCP keepalive so dead peers can be detected, can be enabled at
1306         context-creation time
1307
1308  - valgrind-clean: no SSL or CyaSSL: completely clean.  With OpenSSL, 88 bytes
1309         lost at OpenSSL library init and symptomless reports of uninitialized
1310         memory usage... seems to be a known and ignored problem at OpenSSL
1311
1312  - By default debug is enabled and the library is built for -O0 -g to faclitate
1313         that.  Use --disable-debug configure option to build instead with -O4
1314         and no -g (debug info), obviously providing best performance and
1315         reduced binary size.
1316
1317  - 1.0 introduced some code to try to not deflate small frames, however this
1318         seems to break when confronted with a mixture of frames above and
1319         below the threshold, so it's removed.  Veto the compression extension
1320         in your user callback if you will typically have very small frames.
1321
1322  - There are many memory usage improvements, both a reduction in malloc/
1323         realloc and architectural changes.  A websocket connection now
1324         consumes only 296 bytes with SSL or 272 bytes without on x86_64,
1325         during header processing an additional 1262 bytes is allocated in a
1326         single malloc, but is freed when the websocket connection starts.
1327         The RX frame buffer defined by the protocol in user
1328         code is also allocated per connection, this represents the largest
1329         frame you can receive atomically in that protocol.
1330
1331  - On ARM9 build, just http+ws server no extensions or ssl, <12Kbytes .text
1332         and 112 bytes per connection (+1328 only during header processing)
1333
1334
1335 v1.1-chrome26-firefox18
1336 =======================
1337
1338 Diffstat
1339 --------
1340
1341  Makefile.am                            |    4 +
1342  README-test-server                     |  291 ---
1343  README.build                           |  239 ++
1344  README.coding                          |  138 ++
1345  README.rst                             |   72 -
1346  README.test-apps                       |  272 +++
1347  configure.ac                           |  116 +-
1348  lib/Makefile.am                        |   55 +-
1349  lib/base64-decode.c                    |    5 +-
1350  lib/client-handshake.c                 |  121 +-
1351  lib/client-parser.c                    |  394 ++++
1352  lib/client.c                           |  807 +++++++
1353  lib/daemonize.c                        |  212 ++
1354  lib/extension-deflate-frame.c          |  132 +-
1355  lib/extension-deflate-stream.c         |   12 +-
1356  lib/extension-x-google-mux.c           | 1223 ----------
1357  lib/extension-x-google-mux.h           |   96 -
1358  lib/extension.c                        |    8 -
1359  lib/getifaddrs.c                       |  271 +++
1360  lib/getifaddrs.h                       |   76 +
1361  lib/handshake.c                        |  582 +----
1362  lib/libwebsockets.c                    | 2493 ++++++---------------
1363  lib/libwebsockets.h                    |  115 +-
1364  lib/md5.c                              |  217 --
1365  lib/minilex.c                          |  440 ++++
1366  lib/output.c                           |  628 ++++++
1367  lib/parsers.c                          | 2016 +++++------------
1368  lib/private-libwebsockets.h            |  284 +--
1369  lib/server-handshake.c                 |  275 +++
1370  lib/server.c                           |  377 ++++
1371  libwebsockets-api-doc.html             |  300 +--
1372  m4/ignore-me                           |    2 +
1373  test-server/Makefile.am                |  111 +-
1374  test-server/libwebsockets.org-logo.png |  Bin 0 -> 7029 bytes
1375  test-server/test-client.c              |   45 +-
1376  test-server/test-echo.c                |  330 +++
1377  test-server/test-fraggle.c             |   20 +-
1378  test-server/test-ping.c                |   22 +-
1379  test-server/test-server-extpoll.c      |  554 -----
1380  test-server/test-server.c              |  349 ++-
1381  test-server/test.html                  |    3 +-
1382  win32port/zlib/ZLib.vcxproj            |  749 ++++---
1383  win32port/zlib/ZLib.vcxproj.filters    |  188 +-
1384  win32port/zlib/adler32.c               |  348 ++-
1385  win32port/zlib/compress.c              |  160 +-
1386  win32port/zlib/crc32.c                 |  867 ++++----
1387  win32port/zlib/crc32.h                 |  882 ++++----
1388  win32port/zlib/deflate.c               | 3799 +++++++++++++++-----------------
1389  win32port/zlib/deflate.h               |  688 +++---
1390  win32port/zlib/gzclose.c               |   50 +-
1391  win32port/zlib/gzguts.h                |  325 ++-
1392  win32port/zlib/gzlib.c                 | 1157 +++++-----
1393  win32port/zlib/gzread.c                | 1242 ++++++-----
1394  win32port/zlib/gzwrite.c               | 1096 +++++----
1395  win32port/zlib/infback.c               | 1272 ++++++-----
1396  win32port/zlib/inffast.c               |  680 +++---
1397  win32port/zlib/inffast.h               |   22 +-
1398  win32port/zlib/inffixed.h              |  188 +-
1399  win32port/zlib/inflate.c               | 2976 +++++++++++++------------
1400  win32port/zlib/inflate.h               |  244 +-
1401  win32port/zlib/inftrees.c              |  636 +++---
1402  win32port/zlib/inftrees.h              |  124 +-
1403  win32port/zlib/trees.c                 | 2468 +++++++++++----------
1404  win32port/zlib/trees.h                 |  256 +--
1405  win32port/zlib/uncompr.c               |  118 +-
1406  win32port/zlib/zconf.h                 |  934 ++++----
1407  win32port/zlib/zlib.h                  | 3357 ++++++++++++++--------------
1408  win32port/zlib/zutil.c                 |  642 +++---
1409  win32port/zlib/zutil.h                 |  526 ++---
1410  69 files changed, 19556 insertions(+), 20145 deletions(-)
1411
1412 user api changes
1413 ----------------
1414
1415  - libwebsockets_serve_http_file() now takes a context as first argument
1416
1417  - libwebsockets_get_peer_addresses() now takes a context and wsi as first
1418         two arguments
1419
1420
1421 user api additions
1422 ------------------
1423
1424  - lwsl_...() logging apis, default to stderr but retargetable by user code;
1425         may be used also by user code
1426
1427  - lws_set_log_level() set which logging apis are able to emit (defaults to
1428         notice, warn, err severities), optionally set the emit callback
1429
1430  - lwsl_emit_syslog() helper callback emits to syslog
1431
1432  - lws_daemonize() helper code that forks the app into a headless daemon
1433         properly, maintains a lock file with pid in suitable for sysvinit etc to
1434         control lifecycle
1435
1436  - LWS_CALLBACK_HTTP_FILE_COMPLETION callback added since http file
1437         transfer is now asynchronous (see test server code)
1438
1439  - lws_frame_is_binary() from a wsi pointer, let you know if the received
1440         data was sent in BINARY mode
1441
1442
1443 user api removals
1444 -----------------
1445
1446  - libwebsockets_fork_service_loop() - no longer supported (had intractable problems)
1447         arrange your code to act from the user callback instead from same
1448         process context as the service loop
1449
1450  - libwebsockets_broadcast() - use libwebsocket_callback_on_writable[_all_protocol]()
1451         instead from same process context as the service loop.  See the test apps
1452         for examples.
1453
1454  - x-google-mux() removed until someone wants it
1455
1456  - pre -v13 (ancient) protocol support removed
1457
1458
1459 New features
1460 ------------
1461
1462  - echo test server and client compatible with echo.websocket.org added
1463
1464  - many new configure options (see README.build) to reduce footprint of the
1465         library to what you actually need, eg, --without-client and
1466         --without-server
1467
1468  - http + websocket server can build to as little as 12K .text for ARM
1469
1470  - no more MAX_CLIENTS limitation; adapts to support the max number of fds
1471         allowed to the process by ulimit, defaults to 1024 on Fedora and
1472         Ubuntu.  Use ulimit to control this without needing to configure
1473         the library.  Code here is smaller and faster.
1474
1475  - adaptive ratio of listen socket to connection socket service allows
1476         good behaviour under Apache ab test load.  Tested with thousands
1477         of simultaneous connections
1478
1479  - reduction in per-connection memory footprint by moving to a union to hold
1480         mutually-exclusive state for the connection
1481
1482  - robustness: Out of Memory taken care of for all allocation code now
1483
1484  - internal getifaddrs option if your toolchain lacks it (some uclibc)
1485
1486  - configurable memory limit for deflate operations
1487
1488  - improvements in SSL code nonblocking operation, possible hang solved,
1489         some SSL operations broken down into pollable states so there is
1490         no library blocking, timeout coverage for SSL_connect
1491
1492  - extpoll test server merged into single test server source
1493
1494  - robustness: library should deal with all recoverable socket conditions
1495
1496  - rx flowcontrol for backpressure notification fixed and implmeneted
1497         correctly in the test server
1498
1499  - optimal lexical parser added for header processing; all headers in a
1500         single 276-byte state table
1501
1502  - latency tracking api added (configure --with-latency)
1503
1504  - Improved in-tree documentation, REAME.build, README.coding,
1505         README.test-apps, changelog
1506
1507  - Many small fixes
1508
1509
1510 v1.0-chrome25-firefox17 (6cd1ea9b005933f)