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