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