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