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