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