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