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