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