blob: 3142d559be8c4a01875e7cf896377765d34aa081 [file] [log] [blame]
Andy Greena35c86f2013-01-31 10:16:44 +08001Changelog
2---------
3
Andy Green0c3cc2e2016-02-20 09:12:52 +08004Fixes
5-----
6
71) MAJOR (Windows-only) fix assert firing
8
92) MAJOR http:/1.1 connections handled by lws_return_http_status() did not
10get sent a content-length resulting in the link hanging until the peer closed
11it. attack.sh updated to add a test for this.
12
Andy Green26d42492016-02-24 12:40:21 +0800133) MINOR An error about hdr struct in _lws_ws_related is corrected, it's not
14known to affect anything until after it was fixed
15
Andy Green5c0bcf42016-02-24 21:27:46 +0800164) MINOR During the close shutdown wait state introduced at v1.7, if something
17requests callback on writeable for the socket it will busywait until the
18socket closes
19
Andy Greendbfbbb42016-02-24 20:58:19 +0800205) MAJOR Although the test server has done it for a few versions already, it
21is now required for the user code to explicitly call
22
23 if (lws_http_transaction_completed(wsi))
24 return -1;
25
26when it finishes replying to a transaction in http. Previously the library
27did it for you, but that disallowed large, long transfers with multiple
28trips around the event loop (and cgi...).
29
Andy Green4ba798d2016-02-25 21:50:49 +0800306) MAJOR connections on ah waiting list that closed did not get removed from
31the waiting list...
32
Andy Green83af28a2016-02-28 10:55:31 +0800337) MAJOR since we added the ability to hold an ah across http keepalive
34transactions where more headers had already arrived, we broke the ability
35to tell if more headers had arrived. Result was if the browser didn't
36close the keepalive, we retained ah for the lifetime of the keepalive,
37using up the pool.
38
Andy Green442e1c82016-02-29 10:10:42 +0800398) MAJOR windows-only-POLLHUP was not coming
40
Andy Green4f5ebec2016-03-09 23:13:31 +0800419) Client should not send ext hdr if no exts
Andy Greendbfbbb42016-02-24 20:58:19 +080042
Andy Green0c3cc2e2016-02-20 09:12:52 +080043Changes
44-------
45
461) 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
55together you can use them like this to have the test-server work with the
56usual purchased SSL certs from an official CA.
57
58 --ssl -C your.crt -K your.key -A your.cer -u 99 -g 99
59
602) MINOR the OpenSSL magic to setup ECDH cipher usage is implemented in the
61library, and the ciphers restricted to use ECDH only.
62Using this, the lws test server can score an A at SSLLABS test
63
643) MINOR STS (SSL always) header is added to the test server if you use --ssl. With
65that, we score A+ at SSLLABS test
66
674) MINOR daemonize function (disabled at cmake by default) is updated to work
68with systemd
69
705) MINOR example systemd .service file now provided for test server
71(not installed by default)
72
Andy Green0ad1a6e2016-02-20 14:05:55 +0800736) test server html is updated with tabs and a new live server monitoring
74feature. Input sanitization added to the js.
75
Andy Green2d8d35a2016-02-29 14:19:16 +0800767) client connections attempted when no ah is free no longer fail, they are
77just deferred until an ah becomes available.
78
Andy Greena661ee52016-02-29 13:18:30 +0800798) The test client pays attention to if you give it an http:/ or https://
80protocol string to its argument in URL format. If so, it stays in http[s]
81client mode and doesn't upgrade to ws[s], allowing you to do generic http client
Andy Green5c8906e2016-03-13 16:44:19 +080082operations. Receiving transfer-encoding: chunked is supported.
Andy Greena661ee52016-02-29 13:18:30 +080083
Andy Green1e5a9ad2016-03-20 11:59:53 +0800849) If you enable -DLWS_WITH_HTTP_PROXY=1 at cmake, the test server has a
85new URI path http://localhost:7681/proxytest If you visit here, a client
86connection to http://example.com:80 is spawned, and the results piped on
87to your original connection.
88
8910) Also with LWS_WITH_HTTP_PROXY enabled at cmake, lws wants to link to an
90additional library, "libhubbub". This allows lws to do html rewriting on the
91fly, adjusting proxied urls in a lightweight and fast way.
Andy Greenfb5f33b2016-03-01 07:19:01 +080092
Andy Greenc6fd3602016-03-23 09:22:11 +08009311) There's a new context creation flag LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT,
94this is included automatically if you give any other SSL-related option flag.
95If you give no SSL-related option flag, nor this one directly, then even
96though SSL support may be compiled in, it is never initialized nor used for the
97whole lifetime of the lws context.
98
99Conversely in order to prepare the context to use SSL, even though, eg, you
100are not listening on SSL but will use SSL client connections later, you must
101give this flag explicitly to make sure SSL is initialized.
102
Andy Green2d8d35a2016-02-29 14:19:16 +0800103
Andy Greend7fddad2016-02-18 20:36:55 +0800104User API additions
105------------------
106
Andy Green0c3cc2e2016-02-20 09:12:52 +08001071) MINOR APIBREAK There's a new member in struct lws_context_creation_info, ecdh_curve,
Andy Greend7fddad2016-02-18 20:36:55 +0800108which lets you set the name of the ECDH curve OpenSSL should use. By
109default (if you leave ecdh_curve NULL) it will use "prime256v1"
110
Andy Green51d9afa2016-02-24 11:05:56 +08001112) MINOR NEWAPI It was already possible to adopt a foreign socket that had not
112been read from using lws_adopt_socket() since v1.7. Now you can adopt a
113partially-used socket if you don't need SSL, by passing it what you read
114so it can drain that before reading from the socket.
115
116LWS_VISIBLE LWS_EXTERN struct lws *
117lws_adopt_socket_readbuf(struct lws_context *context, lws_sockfd_type accept_fd,
118 const char *readbuf, size_t len);
Andy Greend7fddad2016-02-18 20:36:55 +0800119
Andy Green6a8099b2016-02-21 21:25:48 +08001203) MINOR NEWAPI CGI type "network io" subprocess execution is now possible from
121a simple api.
122
123LWS_VISIBLE LWS_EXTERN int
Andy Green1a138852016-03-20 11:55:25 +0800124lws_cgi(struct lws *wsi, char * const *exec_array, int script_uri_path_len,
125 int timeout_secs);
Andy Green6a8099b2016-02-21 21:25:48 +0800126
127LWS_VISIBLE LWS_EXTERN int
128lws_cgi_kill(struct lws *wsi);
129
130To use it, you must first set the cmake option
131
132$ cmake .. -DLWS_WITH_CGI=1
133
134See test-server-http.c and test server path
135
136http://localhost:7681/cgitest
137
138stdin 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
142lwstest script
143read="hello"
144
Andy Green1a138852016-03-20 11:55:25 +0800145The test script returns text/html table showing /proc/meminfo. But the cgi
146support is complete enough to run cgit cgi.
147
Andy Greend61bed32016-02-25 15:01:55 +08001484) There is a helper api for forming logging timestamps
149
150LWS_VISIBLE int
151lwsl_timestamp(int level, char *p, int len)
152
153this generates this kind of timestamp for use as logging preamble
154
155lwsts[13116]: [2016/01/25 14:52:52:8386] NOTICE: Initial logging level 7
156
Andy Greena661ee52016-02-29 13:18:30 +08001575) struct lws_client_connect_info has a new member
158
159 const char *method
160
161If it's NULL, then everything happens as before, lws_client_connect_via_info()
162makes a ws or wss connection to the address given.
163
164If you set method to a valid http method like "GET", though, then this method
165is used and the connection remains in http[s], it's not upgraded to ws[s].
166
167So with this, you can perform http[s] client operations as well as ws[s] ones.
168
169There 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,
Andy Green6a8099b2016-02-21 21:25:48 +0800175
Andy Green494418a2016-03-02 09:17:22 +08001766) struct lws_client_connect_info has a new member
177
178 const char *parent_wsi
179
180if non-NULL, the client wsi is set to be a child of parent_wsi. This ensures
181if parent_wsi closes, then the client child is closed just before.
182
Andy Green0f9904f2016-03-17 15:26:49 +08001837) If you're using SSL, there's a new context creation-time option flag
184LWS_SERVER_OPTION_REDIRECT_HTTP_TO_HTTPS. If you give this, non-ssl
185connections to the server listen port are accepted and receive a 301
186redirect to / on the same host and port using https://
187
Andy Greencd0c6962016-03-28 10:12:37 +0800188New application lwsws
189---------------------
190
191A libwebsockets-based general webserver is built by default now, lwsws.
192
193It's configured by JSON, by default in
194
195 /etc/lwsws/conf
196
197which 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
210which 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
Andy Green0c3cc2e2016-02-20 09:12:52 +0800231
Andy Green9c60ed92016-02-16 12:32:18 +0800232v1.7.0
233======
234
Andy Green67112662016-01-11 11:34:01 +0800235Extension Changes
236-----------------
237
2381) There is now a "permessage-deflate" / RFC7692 implementation. It's very
239similar to "deflate-frame" we have offered for a long while; deflate-frame is
240now provided as an alias of permessage-deflate.
241
242The 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
2602) deflate-stream has been disabled for many versions (for over a year) and is
261now removed. Browsers are now standardizing on "permessage-deflate" / RFC7692
262
2633) struct lws_extension is simplified, and lws extensions now have a public
264api (their callback) for use in user code to compose extensions and options
265the user code wants. lws_get_internal_exts() is deprecated but kept around
266as a NOP. The changes allow one extension implementation to go by different
267names and allows the user client code to control option offers per-ext.
268
269The test client and server are updated to use the new way. If you use
270the old way it should still work, but extensions will be disabled until you
271update your code.
272
273Extensions are now responsible for allocating and per-instance private struct
274at instance construction time and freeing it when the instance is destroyed.
275Not needing to know the size means the extension's struct can be opaque
276to user code.
277
278
Andy Green3df58002015-12-25 12:44:12 +0800279User api additions
280------------------
281
Andy Green200a6a22016-02-15 20:36:02 +08002821) The info struct gained three new members
Andy Green3df58002015-12-25 12:44:12 +0800283
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
Andy Green200a6a22016-02-15 20:36:02 +0800298 - timeout_secs: 0 for default (currently 20s), or set the library's
299 network activity timeout to the given number of seconds
300
Andy Green3df58002015-12-25 12:44:12 +0800301HTTP header processing in lws only exists until just after the first main
302callback after the HTTP handshake... for ws connections that is ESTABLISHED and
303for HTTP connections the HTTP callback.
304
305So these settings are not related to the maximum number of simultaneous
Andy Green3246ebb2015-12-26 12:03:06 +0800306connections, but the number of HTTP handshakes that may be expected or ongoing,
Andy Green3df58002015-12-25 12:44:12 +0800307or have just completed, at one time. The reason it's useful is it changes the
308memory allocation for header processing to be one-time at context creation
309instead of every time there is a new connection, and gives you control over
310the peak allocation.
311
312Setting max_http_header_pool to 1 is fine it will just queue incoming
313connections before the accept as necessary, you can still have as many
Andy Green5b85e392015-12-26 13:23:11 +0800314simultaneous post-header connections as you like. Since the http header
315processing is completed and the allocation released after ESTABLISHED or the
316HTTP callback, even with a pool of 1 many connections can be handled rapidly.
317
Andy Green066a7a12015-12-26 15:47:06 +08003182) There is a new callback that allows the user code to get acccess to the
319optional close code + aux data that may have been sent by the peer.
320
321LWS_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
Andy Green67112662016-01-11 11:34:01 +0800328 connection. If you return nonzero lws will just close the
329 connection.
Andy Green066a7a12015-12-26 15:47:06 +0800330
331As usual not handling it does the right thing, if you're not interested in it
332just ignore it.
333
334The test server has "open and close" testing buttons at the bottom, if you
335open and close that connection, on close it will send a close code 3000 decimal
336and the string "Bye!" as the aux data.
337
338The test server dumb-increment callback handles this callback reason and prints
339
340lwsts[15714]: LWS_CALLBACK_WS_PEER_INITIATED_CLOSE: len 6
341lwsts[15714]: 0: 0x0B
342lwsts[15714]: 1: 0xB8
343lwsts[15714]: 2: 0x42
344lwsts[15714]: 3: 0x79
345lwsts[15714]: 4: 0x65
346lwsts[15714]: 5: 0x21
347
Andy Green1fb95e82015-12-26 17:20:34 +08003483) There is a new API to allow the user code to control the content of the
349close frame sent when about to return nonzero from the user callback to
350indicate 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 */
364LWS_VISIBLE LWS_EXTERN void
365lws_close_reason(struct lws *wsi, enum lws_close_status status,
366 unsigned char *buf, size_t len);
367
368An extra button is added to the "open and close" test server page that requests
369that the test server close the connection from his end.
370
371The 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
377The browser shows the close code and reason he received
378
379websocket connection CLOSED, code: 1001, reason: seeya
380
Vijay Khurdiyae73d4462016-01-15 16:21:51 +08003814) There's a new context creation time option flag
Andy Green44a7f652015-12-29 11:20:09 +0800382
383LWS_SERVER_OPTION_VALIDATE_UTF8
384
385if you set it in info->options, then TEXT and CLOSE frames will get checked to
386confirm that they contain valid UTF-8. If they don't, the connection will get
387closed by lws.
388
Vijay Khurdiyae73d4462016-01-15 16:21:51 +08003895) ECDH Certs are now supported. Enable the CMake option
390
391cmake .. -DLWS_SSL_SERVER_WITH_ECDH_CERT=1
392
393**and** the info->options flag
394
Andy Greenff696482016-02-17 07:46:27 +0800395LWS_SERVER_OPTION_SSL_ECDH
Vijay Khurdiyae73d4462016-01-15 16:21:51 +0800396
397to build in support and select it at runtime.
398
Andy Greenff696482016-02-17 07:46:27 +08003996) There's a new api lws_parse_uri() that simplifies chopping up
Andy Green809d69a2016-01-14 11:37:56 +0800400https://xxx:yyy/zzz uris into parts nicely. The test client now uses this
Andy Greend3a55052016-01-19 03:34:24 +0800401to allow proper uris as well as the old address style.
402
4037) SMP support is integrated into LWS without any internal threading. It's
404very simple to use, libwebsockets-test-server-pthread shows how to do it,
405use -j <n> argument there to control the number of service threads up to 32.
406
407Two new members are added to the info struct
408
409 unsigned int count_threads;
410 unsigned int fd_limit_per_thread;
411
412leave them at the default 0 to get the normal singlethreaded service loop.
413
414Set count_threads to n to tell lws you will have n simultaneous service threads
415operating on the context.
416
417There is still a single listen socket on one port, no matter how many
418service threads.
419
420When a connection is made, it is accepted by the service thread with the least
421connections active to perform load balancing.
422
423The user code is responsible for spawning n threads running the service loop
424associated to a specific tsi (Thread Service Index, 0 .. n - 1). See
425the libwebsockets-test-server-pthread for how to do.
426
427If you leave fd_limit_per_thread at 0, then the process limit of fds is shared
428between the service threads; if you process was allowed 1024 fds overall then
429each thread is limited to 1024 / n.
430
431You can set fd_limit_per_thread to a nonzero number to control this manually, eg
432the overall supported fd limit is less than the process allowance.
433
434You can control the context basic data allocation for multithreading from Cmake
435using -DLWS_MAX_SMP=, if not given it's set to 32. The serv_buf allocation
436for the threads (currently 4096) is made at runtime only for active threads.
437
438Because lws will limit the requested number of actual threads supported
439according to LWS_MAX_SMP, there is an api lws_get_count_threads(context) to
440discover how many threads were actually allowed when the context was created.
441
442It's required to implement locking in the user code in the same way that
443libwebsockets-test-server-pthread does it, for the FD locking callbacks.
444
Andy Greenba119e92016-01-26 21:40:32 +0800445If LWS_MAX_SMP=1, then there is no code related to pthreads compiled in the
446library. If more than 1, a small amount of pthread mutex code is built into
447the library.
Andy Green809d69a2016-01-14 11:37:56 +0800448
Andy Greenba119e92016-01-26 21:40:32 +08004498) New API
450
451LWS_VISIBLE struct lws *
452lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd)
453
454allows foreign sockets accepted by non-lws code to be adopted by lws as if they
455had just been accepted by lws' own listen socket.
Andy Green3df58002015-12-25 12:44:12 +0800456
Danomi Czaski4e9c7f32016-01-28 09:40:53 +08004579) X-Real-IP: header has been added as WSI_TOKEN_HTTP_X_REAL_IP
458
Andy Green86ed65f2016-02-14 09:27:41 +080045910) Libuv support is added, there are new related user apis
460
461typedef void (lws_uv_signal_cb_t)(uv_loop_t *l, uv_signal_t *w, int revents);
462
463LWS_VISIBLE LWS_EXTERN int
464lws_uv_sigint_cfg(struct lws_context *context, int use_uv_sigint,
465 lws_uv_signal_cb_t *cb);
466
467LWS_VISIBLE LWS_EXTERN int
468lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi);
469
470LWS_VISIBLE void
471lws_uv_sigint_cb(uv_loop_t *loop, uv_signal_t *watcher, int revents);
472
473and CMAKE option
474
475LWS_WITH_LIBUV
476
Danomi Czaski4e9c7f32016-01-28 09:40:53 +0800477
Andy Green3246ebb2015-12-26 12:03:06 +0800478User api changes
479----------------
480
4811) LWS_SEND_BUFFER_POST_PADDING is now 0 and deprecated. You can remove it; if
482you still use it, obviously it does nothing. Old binary code with nonzero
483LWS_SEND_BUFFER_POST_PADDING is perfectly compatible, the old code just
Andy Green5b85e392015-12-26 13:23:11 +0800484allocated a buffer bigger than the library is going to use.
Andy Green3246ebb2015-12-26 12:03:06 +0800485
Andy Green5b85e392015-12-26 13:23:11 +0800486The example apps no longer use LWS_SEND_BUFFER_POST_PADDING.
Andy Green3246ebb2015-12-26 12:03:06 +0800487
Andy Green4e2ac762015-12-26 20:26:11 +0800488The only path who made use of it was sending with LWS_WRITE_CLOSE --->
Andy Green3246ebb2015-12-26 12:03:06 +0800489
Andy Green1fb95e82015-12-26 17:20:34 +08004902) Because of lws_close_reason() formalizing handling close frames,
491LWS_WRITE_CLOSE is removed from libwebsockets.h. It was only of use to send
492close frames...close frame content should be managed using lws_close_reason()
493now.
494
Andy Green44a7f652015-12-29 11:20:09 +08004953) We check for invalid CLOSE codes and complain about protocol violation in
496our close code. But it changes little since we were in the middle of closing
497anyway.
498
4994) zero-length RX frames and zero length TX frames are now allowed.
500
5015) Pings and close used to be limited to 124 bytes, the correct limit is 125
502so that is now also allowed.
Andy Green3246ebb2015-12-26 12:03:06 +0800503
Steffen Vogelf9267172016-02-09 07:19:15 +01005046) LWS_PRE is provided as a synonym for LWS_SEND_BUFFER_PRE_PADDING, either is
Andy Green67112662016-01-11 11:34:01 +0800505valid to use now.
506
5077) There's generic support for RFC7462 style extension options built into the
508library now. As a consequence, a field "options" is added to lws_extension.
509It can be NULL if there are no options on the extension. Extension internal
510info is part of the public abi because extensions may be implemented outside
511the library.
512
Danomi Czaski4e9c7f32016-01-28 09:40:53 +08005138) WSI_TOKEN_PROXY enum was accidentally defined to collide with another token
514of value 73. That's now corrected and WSI_TOKEN_PROXY moved to his own place at
51577.
516
Andy Green86ed65f2016-02-14 09:27:41 +08005179) With the addition of libuv support, libev is not the only event loop
518library 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
52510) Libev support is made compatible with multithreaded service,
526lws_ev_initloop (was lws_initloop) gets an extra argument for the
527thread service index (use 0 if you will just have 1 service thread).
528
529LWS_VISIBLE LWS_EXTERN int
Andy Greenff696482016-02-17 07:46:27 +0800530lws_ev_initloop(struct lws_context *context, ev_loop_t *loop, int tsi);
Andy Green86ed65f2016-02-14 09:27:41 +0800531
Andy Green3df58002015-12-25 12:44:12 +0800532
Andy Green9e8d1482015-12-18 11:01:03 +0800533v1.6.0-chrome48-firefox42
534=======================
535
536Major API improvements
537----------------------
538
539v1.6.0 has many cleanups and improvements in the API. Although at first it
540looks 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
553That's it... generally only a handful of the 14 affected APIs are actually in
554use in your user code and you can find them quickest by compiling and visiting
555the errors each in turn. And the end results are much cleaner, more
556predictable and maintainable.
557
558
Andy Green4e442b72015-12-10 07:58:58 +0800559User api additions
560------------------
561
Andy Green3f628702015-12-14 07:16:32 +08005621) lws now exposes his internal platform file abstraction in a way that can be
Andy Green4e442b72015-12-10 07:58:58 +0800563both used by user code to make it platform-agnostic, and be overridden or
564subclassed by user code. This allows things like handling the URI "directory
565space" as a virtual filesystem that may or may not be backed by a regular
566filesystem. One example use is serving files from inside large compressed
567archive storage without having to unpack anything except the file being
568requested.
569
570The test server shows how to use it, basically the platform-specific part of
571lws prepares a file operations structure that lives in the lws context.
572
Andy Green3f599962015-12-14 07:21:42 +0800573Helpers are provided to also leverage these platform-independent file handling
574apis
Andy Green4e442b72015-12-10 07:58:58 +0800575
576static inline lws_filefd_type
Andy Green3f599962015-12-14 07:21:42 +0800577lws_plat_file_open(struct lws *wsi, const char *filename,
Andy Green4e442b72015-12-10 07:58:58 +0800578 unsigned long *filelen, int flags)
Andy Green4e442b72015-12-10 07:58:58 +0800579static inline int
Andy Green3f599962015-12-14 07:21:42 +0800580lws_plat_file_close(struct lws *wsi, lws_filefd_type fd)
Andy Green4e442b72015-12-10 07:58:58 +0800581
582static inline unsigned long
Andy Green3f599962015-12-14 07:21:42 +0800583lws_plat_file_seek_cur(struct lws *wsi, lws_filefd_type fd, long offset)
Andy Green4e442b72015-12-10 07:58:58 +0800584
585static inline int
Andy Green3f599962015-12-14 07:21:42 +0800586lws_plat_file_read(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
587 unsigned char *buf, unsigned long len)
Andy Green4e442b72015-12-10 07:58:58 +0800588
589static inline int
Andy Green3f599962015-12-14 07:21:42 +0800590lws_plat_file_write(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
591 unsigned char *buf, unsigned long len)
Andy Green4e442b72015-12-10 07:58:58 +0800592
593The user code can also override or subclass the file operations, to either
594wrap or replace them. An example is shown in test server.
595
Andy Green3f599962015-12-14 07:21:42 +0800596A wsi can be associated with the file activity, allowing per-connection
597authentication and state to be used when interpreting the file request.
598
Andy Green3f628702015-12-14 07:16:32 +08005992) A new API void * lws_wsi_user(struct lws *wsi) lets you get the pointer to
600the user data associated with the wsi, just from the wsi.
601
Andy Green9e8d1482015-12-18 11:01:03 +08006023) URI argument handling. Libwebsockets parses and protects URI arguments
603like test.html?arg1=1&arg2=2, it decodes %xx uriencoding format and reduces
604path attacks like ../.../../etc/passwd so they cannot go behind the web
605server's /. There is a list of confirmed attacks we're proof against in
606./test-server/attack.sh.
607
608There is a new API lws_hdr_copy_fragment that should be used now to access
609the 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
616For the example above, calling with n=0 will return "arg1=1" and n=1 "arg2=2".
617All legal uriencodings will have been reduced in those strings.
618
619lws_hdr_copy_fragment() returns the length of the x=y fragment, so it's also
620possible to deal with arguments containing %00. If you don't care about that,
621the returned string has '\0' appended to simplify processing.
622
Andy Green4e442b72015-12-10 07:58:58 +0800623
Andy Green6d417202015-12-04 10:39:23 +0800624User api changes
625----------------
626
Andy Green1a366bf2015-12-14 07:02:51 +08006271) 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
633Now take an additional pointer to the lws_context in their first argument.
634
635The reason for this change is struct lws_protocols has been changed to remove
636members that lws used for private storage: so the protocols struct in now
637truly const and may be reused serially or simultaneously by different contexts.
638
Andy Green11c05bf2015-12-16 18:19:08 +08006392) Eleven APIs
640
641LWS_VISIBLE LWS_EXTERN int
642lws_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);
649LWS_VISIBLE LWS_EXTERN int
650lws_finalize_http_header(struct lws_context *context,
651 struct lws *wsi,
652 unsigned char **p,
653 unsigned char *end);
654LWS_VISIBLE LWS_EXTERN int
655lws_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);
662LWS_VISIBLE LWS_EXTERN int
663lws_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);
668LWS_VISIBLE LWS_EXTERN int
669lws_add_http_header_status(struct lws_context *context, struct lws *wsi,
670 unsigned int code, unsigned char **p,
671 unsigned char *end);
672
673LWS_VISIBLE LWS_EXTERN int
674lws_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);
677LWS_VISIBLE LWS_EXTERN int
678lws_serve_http_file_fragment(struct lws_context *context, struct lws *wsi);
679
680LWS_VISIBLE LWS_EXTERN int
681lws_return_http_status(struct lws_context *context, struct lws *wsi,
682 unsigned int code, const char *html_body);
683
684LWS_VISIBLE LWS_EXTERN int
685lws_callback_on_writable(const struct lws_context *context, struct lws *wsi);
686
687LWS_VISIBLE LWS_EXTERN void
688lws_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
692LWS_VISIBLE LWS_EXTERN int
693lws_read(struct lws_context *context, struct lws *wsi,
694 unsigned char *buf, size_t len);
695
696no longer require their initial struct lws_context * parameter.
697
6983) Several older apis start with libwebsocket_ or libwebsockets_ while newer ones
Andy Green6d417202015-12-04 10:39:23 +0800699all begin lws_. These apis have been changed to all begin with lws_.
700
Andy Green11c05bf2015-12-16 18:19:08 +0800701To convert, search-replace
Andy Green6d417202015-12-04 10:39:23 +0800702
Andy Green11c05bf2015-12-16 18:19:08 +0800703 - libwebsockets_/lws_
704 - libwebsocket_/lws_
705 - struct\ libwebsocket/struct\ lws
Andy Green00c6d152015-12-17 07:54:44 +0800706
7074) context parameter removed from user callback.
708
709Since almost all apis no longer need the context as a parameter, it's no longer
710provided at the user callback directly.
711
712However if you need it, for ALL callbacks wsi is valid and has a valid context
Andy Green6d645392015-12-17 18:25:25 +0800713pointer you can recover using lws_get_context(wsi).
Andy Green6d417202015-12-04 10:39:23 +0800714
715
Andy Greenab620ff2015-10-28 08:39:09 +0800716v1.5-chrome47-firefox41
717=======================
MGadkari020c53c2015-08-21 16:15:36 +0530718
719User api changes
720----------------
721
722LWS_CALLBACK_CLIENT_CONNECTION_ERROR may provide an error string if in is
723non-NULL. If so, the string has length len.
724
Andy Green6d59f592015-10-15 09:12:58 +0800725LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED is available to relax the requirement
726for peer certs if you are using the option to require client certs.
727
Andy Green4c79ee72015-10-15 11:20:40 +0800728LWS_WITHOUT_BUILTIN_SHA1 cmake option forces lws to use SHA1() defined
729externally, eg, byOpenSSL, and disables build of libwebsockets_SHA1()
730
731
Andy Green16fb0132015-03-28 11:35:40 +0800732v1.4-chrome43-firefox36
733=======================
Olehfaeac3c2014-07-29 23:18:41 +0800734
735User api additions
736------------------
737
738There's a new member in the info struct used to control context creation,
739ssl_private_key_password, which allows passing into lws the passphrase on
740an SSL cetificate
741
Andy Greeneabed8d2014-08-11 12:11:36 +0800742There's a new member in struct protocols, id, which is ignored by lws but can
743be used by the user code to mark the selected protocol by user-defined version
744or capabliity flag information, for the case multiple versions of a protocol are
745supported.
746
Andy Greenb128ccc2014-08-16 09:54:27 +0800747int lws_is_ssl(wsi) added to allow user code to know if the connection was made
748over ssl or not. If LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT is used, both
749ssl and non-ssl connections are possible and may need to be treated differently
750in the user code.
751
Andy Green14425ea2014-08-18 22:49:39 +0800752int lws_partial_buffered(wsi) added... should be checked after any
753libwebsocket_write that will be followed by another libwebsocket_write inside
754the same writeable callback. If set, you can't do any more writes until the
755writeable callback is called again. If you only do one write per writeable callback,
756you can ignore this.
757
Andy Green917f43a2014-10-12 14:31:47 +0800758HTTP2-related: HTTP2 changes how headers are handled, lws now has new version-
759agnositic header creation APIs. These do the right thing depending on each
760connection's HTTP version without the user code having to know or care, except
761to make sure to use the new APIs for headers (test-server is updated to use
762them already, so look there for examples)
763
764The APIs "render" the headers into a user-provided buffer and bump *p as it
765is used. If *p reaches end, then the APIs return nonzero for error.
766
767LWS_VISIBLE LWS_EXTERN int
768lws_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
774Start a response header reporting status like 200, 500, etc
775
776LWS_VISIBLE LWS_EXTERN int
777lws_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
785Add a header like name: value in HTTP1.x
786
787LWS_VISIBLE LWS_EXTERN int
788lws_finalize_http_header(struct libwebsocket_context *context,
789 struct libwebsocket *wsi,
790 unsigned char **p,
791 unsigned char *end);
792
793Finish off the headers, like add the extra \r\n in HTTP1.x
794
795LWS_VISIBLE LWS_EXTERN int
796lws_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
804Add a header by using a lws token as the name part. In HTTP2, this can be
805compressed to one or two bytes.
806
Olehfaeac3c2014-07-29 23:18:41 +0800807
Andy Green822241c2014-08-18 22:21:51 +0800808User api removal
809----------------
810
811protocols struct member no_buffer_all_partial_tx is removed. Under some
Peter Pentchevbb085da2015-12-03 15:55:11 +0200812conditions like rewriting extension such as compression in use, the built-in
Andy Green822241c2014-08-18 22:21:51 +0800813partial send buffering is the only way to deal with the problem, so turning
814it off is deprecated.
815
816
Andy Green917f43a2014-10-12 14:31:47 +0800817User api changes
818----------------
819
820HTTP2-related: API libwebsockets_serve_http_file() takes an extra parameter at
821the end now
822
823int other_headers_len)
824
825If you are providing other headers, they must be generated using the new
826HTTP-version-agnostic APIs, and you must provide the length of them using this
827additional parameter.
828
joseph.urciuoli4d9c8fc2014-10-16 08:53:19 +0800829struct lws_context_creation_info now has an additional member
830SSL_CTX *provided_client_ssl_ctx you may set to an externally-initialized
831SSL_CTX managed outside lws. Defaulting to zero keeps the existing behaviour of
832lws managing the context, if you memset the struct to 0 or have as a filescope
833initialized struct in bss, no need to change anything.
834
Andy Green822241c2014-08-18 22:21:51 +0800835
Andy Greenc1fdd102014-07-06 09:56:11 +0800836v1.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
Andy Green79002562013-11-09 11:04:35 +0800896
kapejodce64fb02013-11-19 13:38:16 +0100897User api additions
898------------------
899
900POST method is supported
901
902The protocol 0 / HTTP callback can now get two new kinds of callback,
903LWS_CALLBACK_HTTP_BODY (in and len are a chunk of the body of the HTTP request)
904and LWS_CALLBACK_HTTP_BODY_COMPLETION (the expected amount of body has arrived
905and been passed to the user code already). These callbacks are used with the
906post method (see the test server for details).
907
908The period between the HTTP header completion and the completion of the body
909processing is protected by a 5s timeout.
910
911The chunks are stored in a malloc'd buffer of size protocols[0].rx_buffer_size.
912
913
James Devine5b34c972013-12-14 11:41:29 +0800914New server option you can enable from user code
915LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT allows non-SSL connections to
916also be accepted on an SSL listening port. It's disabled unless you enable
917it explicitly.
918
919
Andy Green7a132792013-12-18 09:48:26 +0800920Two new callbacks are added in protocols[0] that are optional for allowing
921limited thread access to libwebsockets, LWS_CALLBACK_LOCK_POLL and
922LWS_CALLBACK_UNLOCK_POLL.
923
924If you use them, they protect internal and external poll list changes, but if
925you want to use external thread access to libwebsocket_callback_on_writable()
926you have to implement your locking here even if you don't use external
927poll support.
928
929If you will use another thread for this, take a lot of care about managing
930your list of live wsi by doing it from ESTABLISHED and CLOSED callbacks
931(with your own locking).
932
Andrew Canaday9769f4f2014-03-23 13:25:07 +0800933If you configure cmake with -DLWS_WITH_LIBEV=1 then the code allowing the libev
934eventloop instead of the default poll() one will also be compiled in. But to
935use it, you must also set the LWS_SERVER_OPTION_LIBEV flag on the context
936creation info struct options member.
Andy Green7a132792013-12-18 09:48:26 +0800937
Andy Greenc1fdd102014-07-06 09:56:11 +0800938IPV6 is supported and enabled by default except for Windows, you can disable
939the support at build-time by giving -DLWS_IPV6=, and disable use of it even if
James Devine3f13ea22014-03-24 16:09:25 +0800940compiled in by making sure the flag LWS_SERVER_OPTION_DISABLE_IPV6 is set on
941the context creation info struct options member.
942
Andy Greenc1fdd102014-07-06 09:56:11 +0800943You can give LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS option flag to
944guarantee the OS CAs will not be used, even if that support was selected at
945build-time.
946
947Optional "token limits" may be enforced by setting the member "token_limits"
948in struct lws_context_creation_info to point to a struct lws_token_limits.
949NULL means no token limits used for compatibility.
950
Andy Green7a132792013-12-18 09:48:26 +0800951
Andy Green79002562013-11-09 11:04:35 +0800952User api changes
953----------------
954
955Extra optional argument to libwebsockets_serve_http_file() allows injecion
956of HTTP headers into the canned response. Eg, cookies may be added like
957that without getting involved in having to send the header by hand.
958
Patrick Gansterer148b9452014-02-28 02:31:23 +0100959A new info member http_proxy_address may be used at context creation time to
960set the http proxy. If non-NULL, it overrides http_proxy environment var.
Andy Green79002562013-11-09 11:04:35 +0800961
Andy Greend2ec7ad2014-03-15 10:39:29 +0800962Cmake supports LWS_SSL_CLIENT_USE_OS_CA_CERTS defaulting to on, which gets
963the client to use the OS CA Roots. If you're worried somebody with the
964ability to forge for force creation of a client cert from the root CA in
965your OS, you should disable this since your selfsigned $0 cert is a lot safer
966then...
967
Andy Green79002562013-11-09 11:04:35 +0800968
Andy Green81877e62013-10-26 20:36:08 +0800969v1.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
Andy Green54cb3462013-02-14 22:23:54 +08001022
1023User 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
Andy Green2672fb22013-02-22 09:54:35 +08001030 - 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
Andy Green58f214e2013-03-09 13:03:53 +08001034 - 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
Andy Greenb55451c2013-03-16 12:32:27 +08001040 - 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
Andy Green0c9563b2013-06-10 22:54:40 +08001048 - there's a new, optional callback LWS_CALLBACK_CLOSED_HTTP which gets
1049 called when an HTTP protocol socket closes
1050
Andy Green96d48fd2013-09-18 08:32:55 +08001051 - 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
Andy Green5dc62ea2013-09-20 20:26:12 +08001057 - 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
Andy Green81877e62013-10-26 20:36:08 +08001061 - 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()
Peter Pentchevbb085da2015-12-03 15:55:11 +02001063 to set the proxy details in between context creation and the connection
Andy Green81877e62013-10-26 20:36:08 +08001064 action. For OSes that support http_proxy, that's used automatically.
Andy Greenb55451c2013-03-16 12:32:27 +08001065
Andy Green50097dd2013-02-15 22:36:30 +08001066User 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.
Edwin van den Oetelaar8c8a8e12013-02-20 20:56:59 +08001072 LWS_CALLBACK_FILTER_NETWORK_CONNECTION also has the socket descriptor
1073 delivered by @in now instead of @user.
Andy Green50097dd2013-02-15 22:36:30 +08001074
Andy Greenfc7c5e42013-02-23 10:50:10 +08001075 - 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
Andy Green50097dd2013-02-15 22:36:30 +08001080
Andy Greendc914cf2013-02-18 16:54:26 +08001081User 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
Andy Green2672fb22013-02-22 09:54:35 +08001088 - CIPHERS_LIST_STRING is removed
1089
Andy Green0097a992013-03-09 13:06:37 +08001090 - autotools build has been removed. See README.build for info on how to
1091 use CMake for your platform
1092
Andy Green54cb3462013-02-14 22:23:54 +08001093
Andy Green53a46782013-02-14 11:23:49 +08001094v1.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
Andy Green182cb9a2013-02-13 11:54:08 +08001101v1.2-chrome26-firefox18
1102=======================
1103
1104Diffstat
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
Andy Green7b405452013-02-01 10:50:15 +08001150
1151User 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
Andy Greena47865f2013-02-10 09:39:47 +08001158 - 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,
Andy Greena690cd02013-02-09 12:25:31 +08001165 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
Andy Greena7109e62013-02-11 12:05:54 +08001169 - 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.
Andy Green7b405452013-02-01 10:50:15 +08001175
Andy Greened334462013-02-07 21:14:33 +08001176User api changes
1177----------------
1178
Andy Green1b265272013-02-09 14:01:09 +08001179 - 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
Andy Greened334462013-02-07 21:14:33 +08001186 - Header tokens are now deleted after the websocket connection is
Andy Green54495112013-02-06 21:10:16 +09001187 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
Andy Green16ab3182013-02-10 18:02:31 +08001208 - 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
Andy Green54495112013-02-06 21:10:16 +09001213
1214User api removals
1215-----------------
1216
Andy Green16ab3182013-02-10 18:02:31 +08001217 - 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.
Andy Greened334462013-02-07 21:14:33 +08001225
Andy Green70edd6f2013-02-12 10:15:25 +08001226 - 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
Andy Green508946c2013-02-12 10:19:08 +08001230 - 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
Andy Greened334462013-02-07 21:14:33 +08001235
Andy Greendf60b0c2013-02-06 19:57:12 +09001236New features
1237------------
1238
Andy Green9b09dc02013-02-08 12:48:36 +08001239 - Cmake project file added, aimed initially at Windows support: this replaces
Andy Green16ab3182013-02-10 18:02:31 +08001240 the visual studio project files that were in the tree until now.
Andy Greendf60b0c2013-02-06 19:57:12 +09001241
Andy Greenc3ef0d62013-02-12 10:50:49 +08001242 - CyaSSL now supported in place of OpenSSL (--use-cyassl on configure)
1243
Andy Green9b09dc02013-02-08 12:48:36 +08001244 - PATH_MAX or MAX_PATH no longer needed
Andy Greendf60b0c2013-02-06 19:57:12 +09001245
Andy Green54495112013-02-06 21:10:16 +09001246 - cutomizable frame rx buffer size by protocol
1247
Andy Greenc3ef0d62013-02-12 10:50:49 +08001248 - 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
Andy Greena3957ef2013-02-11 09:31:43 +08001255 - 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.
Andy Green7b405452013-02-01 10:50:15 +08001259
Andy Green895d56d2013-02-11 09:32:53 +08001260 - 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
Andy Green16ab3182013-02-10 18:02:31 +08001265 - 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
Andy Greenc3ef0d62013-02-12 10:50:49 +08001274 - 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
Andy Green895d56d2013-02-11 09:32:53 +08001277
Andy Greenbd1132f2013-01-31 19:53:05 +08001278v1.1-chrome26-firefox18
Andy Greena35c86f2013-01-31 10:16:44 +08001279=======================
1280
1281Diffstat
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
1355user 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
1364user 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
1386user 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
1402New 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
1453v1.0-chrome25-firefox17 (6cd1ea9b005933f)