blob: 9a804c166dc4abdbd0c832b4e287d043c61fb639 [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
30
Andy Green0c3cc2e2016-02-20 09:12:52 +080031Changes
32-------
33
341) MINOR test-server gained some new switches
35
36 -C <file> use external SSL cert file
37 -K <file> use external SSL key file
38 -A <file> use external SSL CA cert file
39
40 -u <uid> set effective uid
41 -g <gid> set effective gid
42
43together you can use them like this to have the test-server work with the
44usual purchased SSL certs from an official CA.
45
46 --ssl -C your.crt -K your.key -A your.cer -u 99 -g 99
47
482) MINOR the OpenSSL magic to setup ECDH cipher usage is implemented in the
49library, and the ciphers restricted to use ECDH only.
50Using this, the lws test server can score an A at SSLLABS test
51
523) MINOR STS (SSL always) header is added to the test server if you use --ssl. With
53that, we score A+ at SSLLABS test
54
554) MINOR daemonize function (disabled at cmake by default) is updated to work
56with systemd
57
585) MINOR example systemd .service file now provided for test server
59(not installed by default)
60
Andy Green0ad1a6e2016-02-20 14:05:55 +0800616) test server html is updated with tabs and a new live server monitoring
62feature. Input sanitization added to the js.
63
Andy Greend7fddad2016-02-18 20:36:55 +080064User API additions
65------------------
66
Andy Green0c3cc2e2016-02-20 09:12:52 +0800671) MINOR APIBREAK There's a new member in struct lws_context_creation_info, ecdh_curve,
Andy Greend7fddad2016-02-18 20:36:55 +080068which lets you set the name of the ECDH curve OpenSSL should use. By
69default (if you leave ecdh_curve NULL) it will use "prime256v1"
70
Andy Green51d9afa2016-02-24 11:05:56 +0800712) MINOR NEWAPI It was already possible to adopt a foreign socket that had not
72been read from using lws_adopt_socket() since v1.7. Now you can adopt a
73partially-used socket if you don't need SSL, by passing it what you read
74so it can drain that before reading from the socket.
75
76LWS_VISIBLE LWS_EXTERN struct lws *
77lws_adopt_socket_readbuf(struct lws_context *context, lws_sockfd_type accept_fd,
78 const char *readbuf, size_t len);
Andy Greend7fddad2016-02-18 20:36:55 +080079
Andy Green6a8099b2016-02-21 21:25:48 +0800803) MINOR NEWAPI CGI type "network io" subprocess execution is now possible from
81a simple api.
82
83LWS_VISIBLE LWS_EXTERN int
84lws_cgi(struct lws *wsi, char * const *exec_array, int timeout_secs);
85
86LWS_VISIBLE LWS_EXTERN int
87lws_cgi_kill(struct lws *wsi);
88
89To use it, you must first set the cmake option
90
91$ cmake .. -DLWS_WITH_CGI=1
92
93See test-server-http.c and test server path
94
95http://localhost:7681/cgitest
96
97stdin gets http body, you can test it with wget
98
99$ echo hello > hello.txt
100$ wget http://localhost:7681/cgitest --post-file=hello.txt -O- --quiet
101lwstest script
102read="hello"
103
104
Andy Green0c3cc2e2016-02-20 09:12:52 +0800105
Andy Green9c60ed92016-02-16 12:32:18 +0800106v1.7.0
107======
108
Andy Green67112662016-01-11 11:34:01 +0800109Extension Changes
110-----------------
111
1121) There is now a "permessage-deflate" / RFC7692 implementation. It's very
113similar to "deflate-frame" we have offered for a long while; deflate-frame is
114now provided as an alias of permessage-deflate.
115
116The main differences are that the new permessage-deflate implementation:
117
118 - properly performs streaming respecting input and output buffer limits. The
119 old deflate-frame implementation could only work on complete deflate input
120 and produce complete inflate output for each frame. The new implementation
121 only mallocs buffers at initialization.
122
123 - goes around the event loop after each input package is processed allowing
124 interleaved output processing. The RX flow control api can be used to
125 force compressed input processing to match the rate of compressed output
126 processing (test--echo shows an example of how to do this).
127
128 - when being "deflate-frame" for compatibility he uses the same default zlib
129 settings as the old "deflate-frame", but instead of exponentially increasing
130 malloc allocations until the whole output will fit, he observes the default
131 input and output chunking buffer sizes of "permessage-deflate", that's
132 1024 in and 1024 out at a time.
133
1342) deflate-stream has been disabled for many versions (for over a year) and is
135now removed. Browsers are now standardizing on "permessage-deflate" / RFC7692
136
1373) struct lws_extension is simplified, and lws extensions now have a public
138api (their callback) for use in user code to compose extensions and options
139the user code wants. lws_get_internal_exts() is deprecated but kept around
140as a NOP. The changes allow one extension implementation to go by different
141names and allows the user client code to control option offers per-ext.
142
143The test client and server are updated to use the new way. If you use
144the old way it should still work, but extensions will be disabled until you
145update your code.
146
147Extensions are now responsible for allocating and per-instance private struct
148at instance construction time and freeing it when the instance is destroyed.
149Not needing to know the size means the extension's struct can be opaque
150to user code.
151
152
Andy Green3df58002015-12-25 12:44:12 +0800153User api additions
154------------------
155
Andy Green200a6a22016-02-15 20:36:02 +08001561) The info struct gained three new members
Andy Green3df58002015-12-25 12:44:12 +0800157
158 - max_http_header_data: 0 for default (1024) or set the maximum amount of known
159 http header payload that lws can deal with. Payload in unknown http
160 headers is dropped silently. If for some reason you need to send huge
161 cookies or other HTTP-level headers, you can now increase this at context-
162 creation time.
163
164 - max_http_header_pool: 0 for default (16) or set the maximum amount of http
165 headers that can be tracked by lws in this context. For the server, if
166 the header pool is completely in use then accepts on the listen socket
167 are disabled until one becomes free. For the client, if you simultaneously
168 have pending connects for more than this number of client connections,
169 additional connects will fail until some of the pending connections timeout
170 or complete.
171
Andy Green200a6a22016-02-15 20:36:02 +0800172 - timeout_secs: 0 for default (currently 20s), or set the library's
173 network activity timeout to the given number of seconds
174
Andy Green3df58002015-12-25 12:44:12 +0800175HTTP header processing in lws only exists until just after the first main
176callback after the HTTP handshake... for ws connections that is ESTABLISHED and
177for HTTP connections the HTTP callback.
178
179So these settings are not related to the maximum number of simultaneous
Andy Green3246ebb2015-12-26 12:03:06 +0800180connections, but the number of HTTP handshakes that may be expected or ongoing,
Andy Green3df58002015-12-25 12:44:12 +0800181or have just completed, at one time. The reason it's useful is it changes the
182memory allocation for header processing to be one-time at context creation
183instead of every time there is a new connection, and gives you control over
184the peak allocation.
185
186Setting max_http_header_pool to 1 is fine it will just queue incoming
187connections before the accept as necessary, you can still have as many
Andy Green5b85e392015-12-26 13:23:11 +0800188simultaneous post-header connections as you like. Since the http header
189processing is completed and the allocation released after ESTABLISHED or the
190HTTP callback, even with a pool of 1 many connections can be handled rapidly.
191
Andy Green066a7a12015-12-26 15:47:06 +08001922) There is a new callback that allows the user code to get acccess to the
193optional close code + aux data that may have been sent by the peer.
194
195LWS_CALLBACK_WS_PEER_INITIATED_CLOSE:
196 The peer has sent an unsolicited Close WS packet. @in and
197 @len are the optional close code (first 2 bytes, network
198 order) and the optional additional information which is not
199 defined in the standard, and may be a string or non-human-
200 readble data.
201 If you return 0 lws will echo the close and then close the
Andy Green67112662016-01-11 11:34:01 +0800202 connection. If you return nonzero lws will just close the
203 connection.
Andy Green066a7a12015-12-26 15:47:06 +0800204
205As usual not handling it does the right thing, if you're not interested in it
206just ignore it.
207
208The test server has "open and close" testing buttons at the bottom, if you
209open and close that connection, on close it will send a close code 3000 decimal
210and the string "Bye!" as the aux data.
211
212The test server dumb-increment callback handles this callback reason and prints
213
214lwsts[15714]: LWS_CALLBACK_WS_PEER_INITIATED_CLOSE: len 6
215lwsts[15714]: 0: 0x0B
216lwsts[15714]: 1: 0xB8
217lwsts[15714]: 2: 0x42
218lwsts[15714]: 3: 0x79
219lwsts[15714]: 4: 0x65
220lwsts[15714]: 5: 0x21
221
Andy Green1fb95e82015-12-26 17:20:34 +08002223) There is a new API to allow the user code to control the content of the
223close frame sent when about to return nonzero from the user callback to
224indicate the connection should close.
225
226/**
227 * lws_close_reason - Set reason and aux data to send with Close packet
228 * If you are going to return nonzero from the callback
229 * requesting the connection to close, you can optionally
230 * call this to set the reason the peer will be told if
231 * possible.
232 *
233 * @wsi: The websocket connection to set the close reason on
234 * @status: A valid close status from websocket standard
235 * @buf: NULL or buffer containing up to 124 bytes of auxiliary data
236 * @len: Length of data in @buf to send
237 */
238LWS_VISIBLE LWS_EXTERN void
239lws_close_reason(struct lws *wsi, enum lws_close_status status,
240 unsigned char *buf, size_t len);
241
242An extra button is added to the "open and close" test server page that requests
243that the test server close the connection from his end.
244
245The test server code will do so by
246
247 lws_close_reason(wsi, LWS_CLOSE_STATUS_GOINGAWAY,
248 (unsigned char *)"seeya", 5);
249 return -1;
250
251The browser shows the close code and reason he received
252
253websocket connection CLOSED, code: 1001, reason: seeya
254
Vijay Khurdiyae73d4462016-01-15 16:21:51 +08002554) There's a new context creation time option flag
Andy Green44a7f652015-12-29 11:20:09 +0800256
257LWS_SERVER_OPTION_VALIDATE_UTF8
258
259if you set it in info->options, then TEXT and CLOSE frames will get checked to
260confirm that they contain valid UTF-8. If they don't, the connection will get
261closed by lws.
262
Vijay Khurdiyae73d4462016-01-15 16:21:51 +08002635) ECDH Certs are now supported. Enable the CMake option
264
265cmake .. -DLWS_SSL_SERVER_WITH_ECDH_CERT=1
266
267**and** the info->options flag
268
Andy Greenff696482016-02-17 07:46:27 +0800269LWS_SERVER_OPTION_SSL_ECDH
Vijay Khurdiyae73d4462016-01-15 16:21:51 +0800270
271to build in support and select it at runtime.
272
Andy Greenff696482016-02-17 07:46:27 +08002736) There's a new api lws_parse_uri() that simplifies chopping up
Andy Green809d69a2016-01-14 11:37:56 +0800274https://xxx:yyy/zzz uris into parts nicely. The test client now uses this
Andy Greend3a55052016-01-19 03:34:24 +0800275to allow proper uris as well as the old address style.
276
2777) SMP support is integrated into LWS without any internal threading. It's
278very simple to use, libwebsockets-test-server-pthread shows how to do it,
279use -j <n> argument there to control the number of service threads up to 32.
280
281Two new members are added to the info struct
282
283 unsigned int count_threads;
284 unsigned int fd_limit_per_thread;
285
286leave them at the default 0 to get the normal singlethreaded service loop.
287
288Set count_threads to n to tell lws you will have n simultaneous service threads
289operating on the context.
290
291There is still a single listen socket on one port, no matter how many
292service threads.
293
294When a connection is made, it is accepted by the service thread with the least
295connections active to perform load balancing.
296
297The user code is responsible for spawning n threads running the service loop
298associated to a specific tsi (Thread Service Index, 0 .. n - 1). See
299the libwebsockets-test-server-pthread for how to do.
300
301If you leave fd_limit_per_thread at 0, then the process limit of fds is shared
302between the service threads; if you process was allowed 1024 fds overall then
303each thread is limited to 1024 / n.
304
305You can set fd_limit_per_thread to a nonzero number to control this manually, eg
306the overall supported fd limit is less than the process allowance.
307
308You can control the context basic data allocation for multithreading from Cmake
309using -DLWS_MAX_SMP=, if not given it's set to 32. The serv_buf allocation
310for the threads (currently 4096) is made at runtime only for active threads.
311
312Because lws will limit the requested number of actual threads supported
313according to LWS_MAX_SMP, there is an api lws_get_count_threads(context) to
314discover how many threads were actually allowed when the context was created.
315
316It's required to implement locking in the user code in the same way that
317libwebsockets-test-server-pthread does it, for the FD locking callbacks.
318
Andy Greenba119e92016-01-26 21:40:32 +0800319If LWS_MAX_SMP=1, then there is no code related to pthreads compiled in the
320library. If more than 1, a small amount of pthread mutex code is built into
321the library.
Andy Green809d69a2016-01-14 11:37:56 +0800322
Andy Greenba119e92016-01-26 21:40:32 +08003238) New API
324
325LWS_VISIBLE struct lws *
326lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd)
327
328allows foreign sockets accepted by non-lws code to be adopted by lws as if they
329had just been accepted by lws' own listen socket.
Andy Green3df58002015-12-25 12:44:12 +0800330
Danomi Czaski4e9c7f32016-01-28 09:40:53 +08003319) X-Real-IP: header has been added as WSI_TOKEN_HTTP_X_REAL_IP
332
Andy Green86ed65f2016-02-14 09:27:41 +080033310) Libuv support is added, there are new related user apis
334
335typedef void (lws_uv_signal_cb_t)(uv_loop_t *l, uv_signal_t *w, int revents);
336
337LWS_VISIBLE LWS_EXTERN int
338lws_uv_sigint_cfg(struct lws_context *context, int use_uv_sigint,
339 lws_uv_signal_cb_t *cb);
340
341LWS_VISIBLE LWS_EXTERN int
342lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi);
343
344LWS_VISIBLE void
345lws_uv_sigint_cb(uv_loop_t *loop, uv_signal_t *watcher, int revents);
346
347and CMAKE option
348
349LWS_WITH_LIBUV
350
Danomi Czaski4e9c7f32016-01-28 09:40:53 +0800351
Andy Green3246ebb2015-12-26 12:03:06 +0800352User api changes
353----------------
354
3551) LWS_SEND_BUFFER_POST_PADDING is now 0 and deprecated. You can remove it; if
356you still use it, obviously it does nothing. Old binary code with nonzero
357LWS_SEND_BUFFER_POST_PADDING is perfectly compatible, the old code just
Andy Green5b85e392015-12-26 13:23:11 +0800358allocated a buffer bigger than the library is going to use.
Andy Green3246ebb2015-12-26 12:03:06 +0800359
Andy Green5b85e392015-12-26 13:23:11 +0800360The example apps no longer use LWS_SEND_BUFFER_POST_PADDING.
Andy Green3246ebb2015-12-26 12:03:06 +0800361
Andy Green4e2ac762015-12-26 20:26:11 +0800362The only path who made use of it was sending with LWS_WRITE_CLOSE --->
Andy Green3246ebb2015-12-26 12:03:06 +0800363
Andy Green1fb95e82015-12-26 17:20:34 +08003642) Because of lws_close_reason() formalizing handling close frames,
365LWS_WRITE_CLOSE is removed from libwebsockets.h. It was only of use to send
366close frames...close frame content should be managed using lws_close_reason()
367now.
368
Andy Green44a7f652015-12-29 11:20:09 +08003693) We check for invalid CLOSE codes and complain about protocol violation in
370our close code. But it changes little since we were in the middle of closing
371anyway.
372
3734) zero-length RX frames and zero length TX frames are now allowed.
374
3755) Pings and close used to be limited to 124 bytes, the correct limit is 125
376so that is now also allowed.
Andy Green3246ebb2015-12-26 12:03:06 +0800377
Steffen Vogelf9267172016-02-09 07:19:15 +01003786) LWS_PRE is provided as a synonym for LWS_SEND_BUFFER_PRE_PADDING, either is
Andy Green67112662016-01-11 11:34:01 +0800379valid to use now.
380
3817) There's generic support for RFC7462 style extension options built into the
382library now. As a consequence, a field "options" is added to lws_extension.
383It can be NULL if there are no options on the extension. Extension internal
384info is part of the public abi because extensions may be implemented outside
385the library.
386
Danomi Czaski4e9c7f32016-01-28 09:40:53 +08003878) WSI_TOKEN_PROXY enum was accidentally defined to collide with another token
388of value 73. That's now corrected and WSI_TOKEN_PROXY moved to his own place at
38977.
390
Andy Green86ed65f2016-02-14 09:27:41 +08003919) With the addition of libuv support, libev is not the only event loop
392library in town and his api names must be elaborated with _ev_
393
394 Callback typedef: lws_signal_cb ---> lws_ev_signal_cb_t
395 lws_sigint_cfg --> lws_ev_sigint_cfg
396 lws_initloop --> lws_ev_initloop
397 lws_sigint_cb --> lws_ev_sigint_cb
398
39910) Libev support is made compatible with multithreaded service,
400lws_ev_initloop (was lws_initloop) gets an extra argument for the
401thread service index (use 0 if you will just have 1 service thread).
402
403LWS_VISIBLE LWS_EXTERN int
Andy Greenff696482016-02-17 07:46:27 +0800404lws_ev_initloop(struct lws_context *context, ev_loop_t *loop, int tsi);
Andy Green86ed65f2016-02-14 09:27:41 +0800405
Andy Green3df58002015-12-25 12:44:12 +0800406
Andy Green9e8d1482015-12-18 11:01:03 +0800407v1.6.0-chrome48-firefox42
408=======================
409
410Major API improvements
411----------------------
412
413v1.6.0 has many cleanups and improvements in the API. Although at first it
414looks pretty drastic, user code will only need four actions to update it.
415
416 - Do the three search/replaces in your user code, /libwebsocket_/lws_/,
417 /libwebsockets_/lws_/, and /struct\ libwebsocket/struct\ lws/
418
419 - Remove the context parameter from your user callbacks
420
421 - Remove context as the first parameter from the "Eleven APIS" listed in the
422 User Api Changes section
423
424 - Add lws_get_context(wsi) as the first parameter on the "Three APIS" listed
425 in the User Api Changes section, and anywhere else you still need context
426
427That's it... generally only a handful of the 14 affected APIs are actually in
428use in your user code and you can find them quickest by compiling and visiting
429the errors each in turn. And the end results are much cleaner, more
430predictable and maintainable.
431
432
Andy Green4e442b72015-12-10 07:58:58 +0800433User api additions
434------------------
435
Andy Green3f628702015-12-14 07:16:32 +08004361) lws now exposes his internal platform file abstraction in a way that can be
Andy Green4e442b72015-12-10 07:58:58 +0800437both used by user code to make it platform-agnostic, and be overridden or
438subclassed by user code. This allows things like handling the URI "directory
439space" as a virtual filesystem that may or may not be backed by a regular
440filesystem. One example use is serving files from inside large compressed
441archive storage without having to unpack anything except the file being
442requested.
443
444The test server shows how to use it, basically the platform-specific part of
445lws prepares a file operations structure that lives in the lws context.
446
Andy Green3f599962015-12-14 07:21:42 +0800447Helpers are provided to also leverage these platform-independent file handling
448apis
Andy Green4e442b72015-12-10 07:58:58 +0800449
450static inline lws_filefd_type
Andy Green3f599962015-12-14 07:21:42 +0800451lws_plat_file_open(struct lws *wsi, const char *filename,
Andy Green4e442b72015-12-10 07:58:58 +0800452 unsigned long *filelen, int flags)
Andy Green4e442b72015-12-10 07:58:58 +0800453static inline int
Andy Green3f599962015-12-14 07:21:42 +0800454lws_plat_file_close(struct lws *wsi, lws_filefd_type fd)
Andy Green4e442b72015-12-10 07:58:58 +0800455
456static inline unsigned long
Andy Green3f599962015-12-14 07:21:42 +0800457lws_plat_file_seek_cur(struct lws *wsi, lws_filefd_type fd, long offset)
Andy Green4e442b72015-12-10 07:58:58 +0800458
459static inline int
Andy Green3f599962015-12-14 07:21:42 +0800460lws_plat_file_read(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
461 unsigned char *buf, unsigned long len)
Andy Green4e442b72015-12-10 07:58:58 +0800462
463static inline int
Andy Green3f599962015-12-14 07:21:42 +0800464lws_plat_file_write(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
465 unsigned char *buf, unsigned long len)
Andy Green4e442b72015-12-10 07:58:58 +0800466
467The user code can also override or subclass the file operations, to either
468wrap or replace them. An example is shown in test server.
469
Andy Green3f599962015-12-14 07:21:42 +0800470A wsi can be associated with the file activity, allowing per-connection
471authentication and state to be used when interpreting the file request.
472
Andy Green3f628702015-12-14 07:16:32 +08004732) A new API void * lws_wsi_user(struct lws *wsi) lets you get the pointer to
474the user data associated with the wsi, just from the wsi.
475
Andy Green9e8d1482015-12-18 11:01:03 +08004763) URI argument handling. Libwebsockets parses and protects URI arguments
477like test.html?arg1=1&arg2=2, it decodes %xx uriencoding format and reduces
478path attacks like ../.../../etc/passwd so they cannot go behind the web
479server's /. There is a list of confirmed attacks we're proof against in
480./test-server/attack.sh.
481
482There is a new API lws_hdr_copy_fragment that should be used now to access
483the URI arguments (it returns the fragments length)
484
485 while (lws_hdr_copy_fragment(wsi, buf, sizeof(buf),
486 WSI_TOKEN_HTTP_URI_ARGS, n) > 0) {
487 lwsl_info("URI Arg %d: %s\n", ++n, buf);
488 }
489
490For the example above, calling with n=0 will return "arg1=1" and n=1 "arg2=2".
491All legal uriencodings will have been reduced in those strings.
492
493lws_hdr_copy_fragment() returns the length of the x=y fragment, so it's also
494possible to deal with arguments containing %00. If you don't care about that,
495the returned string has '\0' appended to simplify processing.
496
Andy Green4e442b72015-12-10 07:58:58 +0800497
Andy Green6d417202015-12-04 10:39:23 +0800498User api changes
499----------------
500
Andy Green1a366bf2015-12-14 07:02:51 +08005011) Three APIS
502
503 - lws_callback_on_writable_all_protocol(const struct lws_protocols *protocol)
504 - lws_callback_all_protocol(const struct lws_protocols *protocol)
505 - lws_rx_flow_allow_all_protocol(lws_rx_flow_allow_all_protocol)
506
507Now take an additional pointer to the lws_context in their first argument.
508
509The reason for this change is struct lws_protocols has been changed to remove
510members that lws used for private storage: so the protocols struct in now
511truly const and may be reused serially or simultaneously by different contexts.
512
Andy Green11c05bf2015-12-16 18:19:08 +08005132) Eleven APIs
514
515LWS_VISIBLE LWS_EXTERN int
516lws_add_http_header_by_name(struct lws_context *context,
517 struct lws *wsi,
518 const unsigned char *name,
519 const unsigned char *value,
520 int length,
521 unsigned char **p,
522 unsigned char *end);
523LWS_VISIBLE LWS_EXTERN int
524lws_finalize_http_header(struct lws_context *context,
525 struct lws *wsi,
526 unsigned char **p,
527 unsigned char *end);
528LWS_VISIBLE LWS_EXTERN int
529lws_add_http_header_by_token(struct lws_context *context,
530 struct lws *wsi,
531 enum lws_token_indexes token,
532 const unsigned char *value,
533 int length,
534 unsigned char **p,
535 unsigned char *end);
536LWS_VISIBLE LWS_EXTERN int
537lws_add_http_header_content_length(struct lws_context *context,
538 struct lws *wsi,
539 unsigned long content_length,
540 unsigned char **p,
541 unsigned char *end);
542LWS_VISIBLE LWS_EXTERN int
543lws_add_http_header_status(struct lws_context *context, struct lws *wsi,
544 unsigned int code, unsigned char **p,
545 unsigned char *end);
546
547LWS_VISIBLE LWS_EXTERN int
548lws_serve_http_file(struct lws_context *context, struct lws *wsi,
549 const char *file, const char *content_type,
550 const char *other_headers, int other_headers_len);
551LWS_VISIBLE LWS_EXTERN int
552lws_serve_http_file_fragment(struct lws_context *context, struct lws *wsi);
553
554LWS_VISIBLE LWS_EXTERN int
555lws_return_http_status(struct lws_context *context, struct lws *wsi,
556 unsigned int code, const char *html_body);
557
558LWS_VISIBLE LWS_EXTERN int
559lws_callback_on_writable(const struct lws_context *context, struct lws *wsi);
560
561LWS_VISIBLE LWS_EXTERN void
562lws_get_peer_addresses(struct lws_context *context, struct lws *wsi,
563 lws_sockfd_type fd, char *name, int name_len,
564 char *rip, int rip_len);
565
566LWS_VISIBLE LWS_EXTERN int
567lws_read(struct lws_context *context, struct lws *wsi,
568 unsigned char *buf, size_t len);
569
570no longer require their initial struct lws_context * parameter.
571
5723) Several older apis start with libwebsocket_ or libwebsockets_ while newer ones
Andy Green6d417202015-12-04 10:39:23 +0800573all begin lws_. These apis have been changed to all begin with lws_.
574
Andy Green11c05bf2015-12-16 18:19:08 +0800575To convert, search-replace
Andy Green6d417202015-12-04 10:39:23 +0800576
Andy Green11c05bf2015-12-16 18:19:08 +0800577 - libwebsockets_/lws_
578 - libwebsocket_/lws_
579 - struct\ libwebsocket/struct\ lws
Andy Green00c6d152015-12-17 07:54:44 +0800580
5814) context parameter removed from user callback.
582
583Since almost all apis no longer need the context as a parameter, it's no longer
584provided at the user callback directly.
585
586However if you need it, for ALL callbacks wsi is valid and has a valid context
Andy Green6d645392015-12-17 18:25:25 +0800587pointer you can recover using lws_get_context(wsi).
Andy Green6d417202015-12-04 10:39:23 +0800588
589
Andy Greenab620ff2015-10-28 08:39:09 +0800590v1.5-chrome47-firefox41
591=======================
MGadkari020c53c2015-08-21 16:15:36 +0530592
593User api changes
594----------------
595
596LWS_CALLBACK_CLIENT_CONNECTION_ERROR may provide an error string if in is
597non-NULL. If so, the string has length len.
598
Andy Green6d59f592015-10-15 09:12:58 +0800599LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED is available to relax the requirement
600for peer certs if you are using the option to require client certs.
601
Andy Green4c79ee72015-10-15 11:20:40 +0800602LWS_WITHOUT_BUILTIN_SHA1 cmake option forces lws to use SHA1() defined
603externally, eg, byOpenSSL, and disables build of libwebsockets_SHA1()
604
605
Andy Green16fb0132015-03-28 11:35:40 +0800606v1.4-chrome43-firefox36
607=======================
Olehfaeac3c2014-07-29 23:18:41 +0800608
609User api additions
610------------------
611
612There's a new member in the info struct used to control context creation,
613ssl_private_key_password, which allows passing into lws the passphrase on
614an SSL cetificate
615
Andy Greeneabed8d2014-08-11 12:11:36 +0800616There's a new member in struct protocols, id, which is ignored by lws but can
617be used by the user code to mark the selected protocol by user-defined version
618or capabliity flag information, for the case multiple versions of a protocol are
619supported.
620
Andy Greenb128ccc2014-08-16 09:54:27 +0800621int lws_is_ssl(wsi) added to allow user code to know if the connection was made
622over ssl or not. If LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT is used, both
623ssl and non-ssl connections are possible and may need to be treated differently
624in the user code.
625
Andy Green14425ea2014-08-18 22:49:39 +0800626int lws_partial_buffered(wsi) added... should be checked after any
627libwebsocket_write that will be followed by another libwebsocket_write inside
628the same writeable callback. If set, you can't do any more writes until the
629writeable callback is called again. If you only do one write per writeable callback,
630you can ignore this.
631
Andy Green917f43a2014-10-12 14:31:47 +0800632HTTP2-related: HTTP2 changes how headers are handled, lws now has new version-
633agnositic header creation APIs. These do the right thing depending on each
634connection's HTTP version without the user code having to know or care, except
635to make sure to use the new APIs for headers (test-server is updated to use
636them already, so look there for examples)
637
638The APIs "render" the headers into a user-provided buffer and bump *p as it
639is used. If *p reaches end, then the APIs return nonzero for error.
640
641LWS_VISIBLE LWS_EXTERN int
642lws_add_http_header_status(struct libwebsocket_context *context,
643 struct libwebsocket *wsi,
644 unsigned int code,
645 unsigned char **p,
646 unsigned char *end);
647
648Start a response header reporting status like 200, 500, etc
649
650LWS_VISIBLE LWS_EXTERN int
651lws_add_http_header_by_name(struct libwebsocket_context *context,
652 struct libwebsocket *wsi,
653 const unsigned char *name,
654 const unsigned char *value,
655 int length,
656 unsigned char **p,
657 unsigned char *end);
658
659Add a header like name: value in HTTP1.x
660
661LWS_VISIBLE LWS_EXTERN int
662lws_finalize_http_header(struct libwebsocket_context *context,
663 struct libwebsocket *wsi,
664 unsigned char **p,
665 unsigned char *end);
666
667Finish off the headers, like add the extra \r\n in HTTP1.x
668
669LWS_VISIBLE LWS_EXTERN int
670lws_add_http_header_by_token(struct libwebsocket_context *context,
671 struct libwebsocket *wsi,
672 enum lws_token_indexes token,
673 const unsigned char *value,
674 int length,
675 unsigned char **p,
676 unsigned char *end);
677
678Add a header by using a lws token as the name part. In HTTP2, this can be
679compressed to one or two bytes.
680
Olehfaeac3c2014-07-29 23:18:41 +0800681
Andy Green822241c2014-08-18 22:21:51 +0800682User api removal
683----------------
684
685protocols struct member no_buffer_all_partial_tx is removed. Under some
Peter Pentchevbb085da2015-12-03 15:55:11 +0200686conditions like rewriting extension such as compression in use, the built-in
Andy Green822241c2014-08-18 22:21:51 +0800687partial send buffering is the only way to deal with the problem, so turning
688it off is deprecated.
689
690
Andy Green917f43a2014-10-12 14:31:47 +0800691User api changes
692----------------
693
694HTTP2-related: API libwebsockets_serve_http_file() takes an extra parameter at
695the end now
696
697int other_headers_len)
698
699If you are providing other headers, they must be generated using the new
700HTTP-version-agnostic APIs, and you must provide the length of them using this
701additional parameter.
702
joseph.urciuoli4d9c8fc2014-10-16 08:53:19 +0800703struct lws_context_creation_info now has an additional member
704SSL_CTX *provided_client_ssl_ctx you may set to an externally-initialized
705SSL_CTX managed outside lws. Defaulting to zero keeps the existing behaviour of
706lws managing the context, if you memset the struct to 0 or have as a filescope
707initialized struct in bss, no need to change anything.
708
Andy Green822241c2014-08-18 22:21:51 +0800709
Andy Greenc1fdd102014-07-06 09:56:11 +0800710v1.3-chrome37-firefox30
711=======================
712
713 .gitignore | 1 -
714 CMakeLists.txt | 447 +++--
715 README.build | 35 +-
716 README.coding | 14 +
717 changelog | 66 +
718 cmake/LibwebsocketsConfig.cmake.in | 17 +
719 cmake/LibwebsocketsConfigVersion.cmake.in | 11 +
720 config.h.cmake | 18 +
721 cross-ming.cmake | 31 +
722 cross-openwrt-makefile | 91 +
723 lib/client-handshake.c | 205 ++-
724 lib/client-parser.c | 58 +-
725 lib/client.c | 158 +-
726 lib/context.c | 341 ++++
727 lib/extension-deflate-frame.c | 2 +-
728 lib/extension.c | 178 ++
729 lib/handshake.c | 287 +---
730 lib/lextable.h | 338 ++++
731 lib/libev.c | 175 ++
732 lib/libwebsockets.c | 2089 +++--------------------
733 lib/libwebsockets.h | 253 ++-
734 lib/lws-plat-unix.c | 404 +++++
735 lib/lws-plat-win.c | 358 ++++
736 lib/minilex.c | 530 +++---
737 lib/output.c | 445 ++---
738 lib/parsers.c | 682 ++++----
739 lib/pollfd.c | 239 +++
740 lib/private-libwebsockets.h | 501 +++++-
741 lib/server-handshake.c | 274 +--
742 lib/server.c | 858 ++++++++--
743 lib/service.c | 517 ++++++
744 lib/sha-1.c | 38 +-
745 lib/ssl-http2.c | 78 +
746 lib/ssl.c | 571 +++++++
747 test-server/attack.sh | 101 +-
748 test-server/test-client.c | 9 +-
749 test-server/test-echo.c | 17 +-
750 test-server/test-fraggle.c | 7 -
751 test-server/test-ping.c | 12 +-
752 test-server/test-server.c | 330 ++--
753 test-server/test.html | 4 +-
754 win32port/client/client.vcxproj | 259 ---
755 win32port/client/client.vcxproj.filters | 39 -
756 .../libwebsocketswin32.vcxproj.filters | 93 -
757 win32port/server/server.vcxproj | 276 ---
758 win32port/server/server.vcxproj.filters | 51 -
759 win32port/win32helpers/gettimeofday.h | 59 +-
760 win32port/win32helpers/netdb.h | 1 -
761 win32port/win32helpers/strings.h | 0
762 win32port/win32helpers/sys/time.h | 1 -
763 win32port/win32helpers/unistd.h | 0
764 win32port/win32helpers/websock-w32.c | 104 --
765 win32port/win32helpers/websock-w32.h | 62 -
766 win32port/win32port.sln | 100 --
767 win32port/zlib/gzio.c | 3 +-
768 55 files changed, 6779 insertions(+), 5059 deletions(-)
769
Andy Green79002562013-11-09 11:04:35 +0800770
kapejodce64fb02013-11-19 13:38:16 +0100771User api additions
772------------------
773
774POST method is supported
775
776The protocol 0 / HTTP callback can now get two new kinds of callback,
777LWS_CALLBACK_HTTP_BODY (in and len are a chunk of the body of the HTTP request)
778and LWS_CALLBACK_HTTP_BODY_COMPLETION (the expected amount of body has arrived
779and been passed to the user code already). These callbacks are used with the
780post method (see the test server for details).
781
782The period between the HTTP header completion and the completion of the body
783processing is protected by a 5s timeout.
784
785The chunks are stored in a malloc'd buffer of size protocols[0].rx_buffer_size.
786
787
James Devine5b34c972013-12-14 11:41:29 +0800788New server option you can enable from user code
789LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT allows non-SSL connections to
790also be accepted on an SSL listening port. It's disabled unless you enable
791it explicitly.
792
793
Andy Green7a132792013-12-18 09:48:26 +0800794Two new callbacks are added in protocols[0] that are optional for allowing
795limited thread access to libwebsockets, LWS_CALLBACK_LOCK_POLL and
796LWS_CALLBACK_UNLOCK_POLL.
797
798If you use them, they protect internal and external poll list changes, but if
799you want to use external thread access to libwebsocket_callback_on_writable()
800you have to implement your locking here even if you don't use external
801poll support.
802
803If you will use another thread for this, take a lot of care about managing
804your list of live wsi by doing it from ESTABLISHED and CLOSED callbacks
805(with your own locking).
806
Andrew Canaday9769f4f2014-03-23 13:25:07 +0800807If you configure cmake with -DLWS_WITH_LIBEV=1 then the code allowing the libev
808eventloop instead of the default poll() one will also be compiled in. But to
809use it, you must also set the LWS_SERVER_OPTION_LIBEV flag on the context
810creation info struct options member.
Andy Green7a132792013-12-18 09:48:26 +0800811
Andy Greenc1fdd102014-07-06 09:56:11 +0800812IPV6 is supported and enabled by default except for Windows, you can disable
813the support at build-time by giving -DLWS_IPV6=, and disable use of it even if
James Devine3f13ea22014-03-24 16:09:25 +0800814compiled in by making sure the flag LWS_SERVER_OPTION_DISABLE_IPV6 is set on
815the context creation info struct options member.
816
Andy Greenc1fdd102014-07-06 09:56:11 +0800817You can give LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS option flag to
818guarantee the OS CAs will not be used, even if that support was selected at
819build-time.
820
821Optional "token limits" may be enforced by setting the member "token_limits"
822in struct lws_context_creation_info to point to a struct lws_token_limits.
823NULL means no token limits used for compatibility.
824
Andy Green7a132792013-12-18 09:48:26 +0800825
Andy Green79002562013-11-09 11:04:35 +0800826User api changes
827----------------
828
829Extra optional argument to libwebsockets_serve_http_file() allows injecion
830of HTTP headers into the canned response. Eg, cookies may be added like
831that without getting involved in having to send the header by hand.
832
Patrick Gansterer148b9452014-02-28 02:31:23 +0100833A new info member http_proxy_address may be used at context creation time to
834set the http proxy. If non-NULL, it overrides http_proxy environment var.
Andy Green79002562013-11-09 11:04:35 +0800835
Andy Greend2ec7ad2014-03-15 10:39:29 +0800836Cmake supports LWS_SSL_CLIENT_USE_OS_CA_CERTS defaulting to on, which gets
837the client to use the OS CA Roots. If you're worried somebody with the
838ability to forge for force creation of a client cert from the root CA in
839your OS, you should disable this since your selfsigned $0 cert is a lot safer
840then...
841
Andy Green79002562013-11-09 11:04:35 +0800842
Andy Green81877e62013-10-26 20:36:08 +0800843v1.23-chrome32-firefox24
844========================
845
846 Android.mk | 29 +
847 CMakeLists.txt | 573 ++++++++----
848 COPYING | 503 -----------
849 INSTALL | 365 --------
850 Makefile.am | 13 -
851 README.build | 371 ++------
852 README.coding | 63 ++
853 autogen.sh | 1578 ---------------------------------
854 changelog | 69 ++
855 cmake/FindGit.cmake | 163 ++++
856 cmake/FindOpenSSLbins.cmake | 15 +-
857 cmake/UseRPMTools.cmake | 176 ++++
858 config.h.cmake | 25 +-
859 configure.ac | 226 -----
860 cross-arm-linux-gnueabihf.cmake | 28 +
861 lib/Makefile.am | 89 --
862 lib/base64-decode.c | 98 +-
863 lib/client-handshake.c | 123 ++-
864 lib/client-parser.c | 19 +-
865 lib/client.c | 145 ++-
866 lib/daemonize.c | 4 +-
867 lib/extension.c | 2 +-
868 lib/getifaddrs.h | 4 +-
869 lib/handshake.c | 76 +-
870 lib/libwebsockets.c | 491 ++++++----
871 lib/libwebsockets.h | 164 ++--
872 lib/output.c | 214 ++++-
873 lib/parsers.c | 102 +--
874 lib/private-libwebsockets.h | 66 +-
875 lib/server-handshake.c | 5 +-
876 lib/server.c | 29 +-
877 lib/sha-1.c | 2 +-
878 libwebsockets-api-doc.html | 249 +++---
879 libwebsockets.pc.in | 11 -
880 libwebsockets.spec | 14 +-
881 m4/ignore-me | 2 -
882 scripts/FindLibWebSockets.cmake | 33 +
883 scripts/kernel-doc | 1 +
884 test-server/Makefile.am | 131 ---
885 test-server/leaf.jpg | Bin 0 -> 2477518 bytes
886 test-server/test-client.c | 78 +-
887 test-server/test-echo.c | 33 +-
888 test-server/test-fraggle.c | 26 +-
889 test-server/test-ping.c | 15 +-
890 test-server/test-server.c | 197 +++-
891 test-server/test.html | 5 +-
892 win32port/win32helpers/gettimeofday.c | 74 +-
893 win32port/win32helpers/websock-w32.h | 6 +-
894 48 files changed, 2493 insertions(+), 4212 deletions(-)
895
Andy Green54cb3462013-02-14 22:23:54 +0800896
897User api additions
898------------------
899
900 - You can now call libwebsocket_callback_on_writable() on http connectons,
901 and get a LWS_CALLBACK_HTTP_WRITEABLE callback, the same way you can
902 regulate writes with a websocket protocol connection.
903
Andy Green2672fb22013-02-22 09:54:35 +0800904 - A new member in the context creation parameter struct "ssl_cipher_list" is
905 added, replacing CIPHERS_LIST_STRING. NULL means use the ssl library
906 default list of ciphers.
907
Andy Green58f214e2013-03-09 13:03:53 +0800908 - Not really an api addition, but libwebsocket_service_fd() will now zero
909 the revents field of the pollfd it was called with if it handled the
910 descriptor. So you can tell if it is a non-lws fd by checking revents
911 after the service call... if it's still nonzero, the descriptor
912 belongs to you and you need to take care of it.
913
Andy Greenb55451c2013-03-16 12:32:27 +0800914 - libwebsocket_rx_flow_allow_all_protocol(protocol) will unthrottle all
915 connections with the established protocol. It's designed to be
916 called from user server code when it sees it can accept more input
917 and may have throttled connections using the server rx flow apis
918 while it was unable to accept any other input The user server code
919 then does not have to try to track while connections it choked, this
920 will free up all of them in one call.
921
Andy Green0c9563b2013-06-10 22:54:40 +0800922 - there's a new, optional callback LWS_CALLBACK_CLOSED_HTTP which gets
923 called when an HTTP protocol socket closes
924
Andy Green96d48fd2013-09-18 08:32:55 +0800925 - for LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION callback, the user_space alloc
926 has already been done before the callback happens. That means we can
927 use the user parameter to the callback to contain the user pointer, and
928 move the protocol name to the "in" parameter. The docs for this
929 callback are also updated to reflect how to check headers in there.
930
Andy Green5dc62ea2013-09-20 20:26:12 +0800931 - libwebsocket_client_connect() is now properly nonblocking and async. See
932 README.coding and test-client.c for information on the callbacks you
933 can rely on controlling the async connection period with.
934
Andy Green81877e62013-10-26 20:36:08 +0800935 - if your OS does not support the http_proxy environment variable convention
936 (eg, reportedly OSX), you can use a new api libwebsocket_set_proxy()
Peter Pentchevbb085da2015-12-03 15:55:11 +0200937 to set the proxy details in between context creation and the connection
Andy Green81877e62013-10-26 20:36:08 +0800938 action. For OSes that support http_proxy, that's used automatically.
Andy Greenb55451c2013-03-16 12:32:27 +0800939
Andy Green50097dd2013-02-15 22:36:30 +0800940User api changes
941----------------
942
943 - the external poll callbacks now get the socket descriptor coming from the
944 "in" parameter. The user parameter provides the user_space for the
945 wsi as it normally does on the other callbacks.
Edwin van den Oetelaar8c8a8e12013-02-20 20:56:59 +0800946 LWS_CALLBACK_FILTER_NETWORK_CONNECTION also has the socket descriptor
947 delivered by @in now instead of @user.
Andy Green50097dd2013-02-15 22:36:30 +0800948
Andy Greenfc7c5e42013-02-23 10:50:10 +0800949 - libwebsocket_write() now returns -1 for error, or the amount of data
950 actually accepted for send. Under load, the OS may signal it is
951 ready to send new data on the socket, but have only a restricted
952 amount of memory to buffer the packet compared to usual.
953
Andy Green50097dd2013-02-15 22:36:30 +0800954
Andy Greendc914cf2013-02-18 16:54:26 +0800955User api removal
956----------------
957
958 - libwebsocket_ensure_user_space() is removed from the public api, if you
959 were using it to get user_space, you need to adapt your code to only
960 use user_space inside the user callback.
961
Andy Green2672fb22013-02-22 09:54:35 +0800962 - CIPHERS_LIST_STRING is removed
963
Andy Green0097a992013-03-09 13:06:37 +0800964 - autotools build has been removed. See README.build for info on how to
965 use CMake for your platform
966
Andy Green54cb3462013-02-14 22:23:54 +0800967
Andy Green53a46782013-02-14 11:23:49 +0800968v1.21-chrome26-firefox18
969========================
970
971 - Fixes buffer overflow bug in max frame size handling if you used the
972 default protocol buffer size. If you declared rx_buffer_size in your
973 protocol, which is recommended anyway, your code was unaffected.
974
Andy Green182cb9a2013-02-13 11:54:08 +0800975v1.2-chrome26-firefox18
976=======================
977
978Diffstat
979--------
980
981 .gitignore | 16 +++
982 CMakeLists.txt | 544 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
983 LICENSE | 526 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
984 Makefile.am | 1 +
985 README | 20 +++
986 README.build | 258 ++++++++++++++++++++++++++++++++-----
987 README.coding | 52 ++++++++
988 changelog | 136 ++++++++++++++++++++
989 cmake/FindOpenSSLbins.cmake | 33 +++++
990 config.h.cmake | 173 +++++++++++++++++++++++++
991 configure.ac | 22 +++-
992 lib/Makefile.am | 20 ++-
993 lib/base64-decode.c | 2 +-
994 lib/client-handshake.c | 190 +++++++++++-----------------
995 lib/client-parser.c | 88 +++++++------
996 lib/client.c | 384 ++++++++++++++++++++++++++++++-------------------------
997 lib/daemonize.c | 32 +++--
998 lib/extension-deflate-frame.c | 58 +++++----
999 lib/extension-deflate-stream.c | 19 ++-
1000 lib/extension-deflate-stream.h | 4 +-
1001 lib/extension.c | 11 +-
1002 lib/getifaddrs.c | 315 +++++++++++++++++++++++-----------------------
1003 lib/getifaddrs.h | 30 ++---
1004 lib/handshake.c | 124 +++++++++++-------
1005 lib/libwebsockets.c | 736 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------------------------
1006 lib/libwebsockets.h | 237 ++++++++++++++++++++++------------
1007 lib/output.c | 192 +++++++++++-----------------
1008 lib/parsers.c | 966 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----------------------------------------------------------------
1009 lib/private-libwebsockets.h | 225 +++++++++++++++++++++------------
1010 lib/server-handshake.c | 82 ++++++------
1011 lib/server.c | 96 +++++++-------
1012 libwebsockets-api-doc.html | 189 ++++++++++++++++++----------
1013 libwebsockets.spec | 17 +--
1014 test-server/attack.sh | 148 ++++++++++++++++++++++
1015 test-server/test-client.c | 125 +++++++++---------
1016 test-server/test-echo.c | 31 +++--
1017 test-server/test-fraggle.c | 32 ++---
1018 test-server/test-ping.c | 52 ++++----
1019 test-server/test-server.c | 129 ++++++++++++-------
1020 win32port/libwebsocketswin32/libwebsocketswin32.vcxproj | 279 ----------------------------------------
1021 win32port/libwebsocketswin32/libwebsocketswin32.vcxproj.filters | 23 +++-
1022 41 files changed, 4398 insertions(+), 2219 deletions(-)
1023
Andy Green7b405452013-02-01 10:50:15 +08001024
1025User api additions
1026------------------
1027
1028 - lws_get_library_version() returns a const char * with a string like
1029 "1.1 9e7f737", representing the library version from configure.ac
1030 and the git HEAD hash the library was built from
1031
Andy Greena47865f2013-02-10 09:39:47 +08001032 - TCP Keepalive can now optionally be applied to all lws sockets, on Linux
1033 also with controllable timeout, number of probes and probe interval.
1034 (On BSD type OS, you can only use system default settings for the
1035 timing and retries, although enabling it is supported by setting
1036 ka_time to nonzero, the exact value has no meaning.)
1037 This enables detection of idle connections which are logically okay,
1038 but are in fact dead, due to network connectivity issues at the server,
Andy Greena690cd02013-02-09 12:25:31 +08001039 client, or any intermediary. By default it's not enabled, but you
1040 can enable it by setting a non-zero timeout (in seconds) at the new
1041 ka_time member at context creation time.
1042
Andy Greena7109e62013-02-11 12:05:54 +08001043 - Two new optional user callbacks added, LWS_CALLBACK_PROTOCOL_DESTROY which
1044 is called one-time per protocol as the context is being destroyed, and
1045 LWS_CALLBACK_PROTOCOL_INIT which is called when the context is created
1046 and the protocols are added, again it's a one-time affair.
1047 This lets you manage per-protocol allocations properly including
1048 cleaning up after yourself when the server goes down.
Andy Green7b405452013-02-01 10:50:15 +08001049
Andy Greened334462013-02-07 21:14:33 +08001050User api changes
1051----------------
1052
Andy Green1b265272013-02-09 14:01:09 +08001053 - libwebsocket_create_context() has changed from taking a ton of parameters
1054 to just taking a pointer to a struct containing the parameters. The
1055 struct lws_context_creation_info is in libwebsockets.h, the members
1056 are in the same order as when they were parameters to the call
1057 previously. The test apps are all updated accordingly so you can
1058 see example code there.
1059
Andy Greened334462013-02-07 21:14:33 +08001060 - Header tokens are now deleted after the websocket connection is
Andy Green54495112013-02-06 21:10:16 +09001061 established. Not just the header data is saved, but the pointer and
1062 length array is also removed from (union) scope saving several hundred
1063 bytes per connection once it is established
1064
1065 - struct libwebsocket_protocols has a new member rx_buffer_size, this
1066 controls rx buffer size per connection of that protocol now. Sources
1067 for apps built against older versions of the library won't declare
1068 this in their protocols, defaulting it to 0. Zero buffer is legal,
1069 it causes a default buffer to be allocated (currently 4096)
1070
1071 If you want to receive only atomic frames in your user callback, you
1072 should set this to greater than your largest frame size. If a frame
1073 comes that exceeds that, no error occurs but the callback happens as
1074 soon as the buffer limit is reached, and again if it is reached again
1075 or the frame completes. You can detect that has happened by seeing
1076 there is still frame content pending using
1077 libwebsockets_remaining_packet_payload()
1078
1079 By correctly setting this, you can save a lot of memory when your
1080 protocol has small frames (see the test server and client sources).
1081
Andy Green16ab3182013-02-10 18:02:31 +08001082 - LWS_MAX_HEADER_LEN now defaults to 1024 and is the total amount of known
1083 header payload lws can cope with, that includes the GET URL, origin
1084 etc. Headers not understood by lws are ignored and their payload
1085 not included in this.
1086
Andy Green54495112013-02-06 21:10:16 +09001087
1088User api removals
1089-----------------
1090
Andy Green16ab3182013-02-10 18:02:31 +08001091 - The configuration-time option MAX_USER_RX_BUFFER has been replaced by a
1092 buffer size chosen per-protocol. For compatibility, there's a default
1093 of 4096 rx buffer, but user code should set the appropriate size for
1094 the protocol frames.
1095
1096 - LWS_INITIAL_HDR_ALLOC and LWS_ADDITIONAL_HDR_ALLOC are no longer needed
1097 and have been removed. There's a new header management scheme that
1098 handles them in a much more compact way.
Andy Greened334462013-02-07 21:14:33 +08001099
Andy Green70edd6f2013-02-12 10:15:25 +08001100 - libwebsockets_hangup_on_client() is removed. If you want to close the
1101 connection you must do so from the user callback and by returning
1102 -1 from there.
1103
Andy Green508946c2013-02-12 10:19:08 +08001104 - libwebsocket_close_and_free_session() is now private to the library code
1105 only and not exposed for user code. If you want to close the
1106 connection, you must do so from the user callback by returning -1
1107 from there.
1108
Andy Greened334462013-02-07 21:14:33 +08001109
Andy Greendf60b0c2013-02-06 19:57:12 +09001110New features
1111------------
1112
Andy Green9b09dc02013-02-08 12:48:36 +08001113 - Cmake project file added, aimed initially at Windows support: this replaces
Andy Green16ab3182013-02-10 18:02:31 +08001114 the visual studio project files that were in the tree until now.
Andy Greendf60b0c2013-02-06 19:57:12 +09001115
Andy Greenc3ef0d62013-02-12 10:50:49 +08001116 - CyaSSL now supported in place of OpenSSL (--use-cyassl on configure)
1117
Andy Green9b09dc02013-02-08 12:48:36 +08001118 - PATH_MAX or MAX_PATH no longer needed
Andy Greendf60b0c2013-02-06 19:57:12 +09001119
Andy Green54495112013-02-06 21:10:16 +09001120 - cutomizable frame rx buffer size by protocol
1121
Andy Greenc3ef0d62013-02-12 10:50:49 +08001122 - optional TCP keepalive so dead peers can be detected, can be enabled at
1123 context-creation time
1124
1125 - valgrind-clean: no SSL or CyaSSL: completely clean. With OpenSSL, 88 bytes
1126 lost at OpenSSL library init and symptomless reports of uninitialized
1127 memory usage... seems to be a known and ignored problem at OpenSSL
1128
Andy Greena3957ef2013-02-11 09:31:43 +08001129 - By default debug is enabled and the library is built for -O0 -g to faclitate
1130 that. Use --disable-debug configure option to build instead with -O4
1131 and no -g (debug info), obviously providing best performance and
1132 reduced binary size.
Andy Green7b405452013-02-01 10:50:15 +08001133
Andy Green895d56d2013-02-11 09:32:53 +08001134 - 1.0 introduced some code to try to not deflate small frames, however this
1135 seems to break when confronted with a mixture of frames above and
1136 below the threshold, so it's removed. Veto the compression extension
1137 in your user callback if you will typically have very small frames.
1138
Andy Green16ab3182013-02-10 18:02:31 +08001139 - There are many memory usage improvements, both a reduction in malloc/
1140 realloc and architectural changes. A websocket connection now
1141 consumes only 296 bytes with SSL or 272 bytes without on x86_64,
1142 during header processing an additional 1262 bytes is allocated in a
1143 single malloc, but is freed when the websocket connection starts.
1144 The RX frame buffer defined by the protocol in user
1145 code is also allocated per connection, this represents the largest
1146 frame you can receive atomically in that protocol.
1147
Andy Greenc3ef0d62013-02-12 10:50:49 +08001148 - On ARM9 build, just http+ws server no extensions or ssl, <12Kbytes .text
1149 and 112 bytes per connection (+1328 only during header processing)
1150
Andy Green895d56d2013-02-11 09:32:53 +08001151
Andy Greenbd1132f2013-01-31 19:53:05 +08001152v1.1-chrome26-firefox18
Andy Greena35c86f2013-01-31 10:16:44 +08001153=======================
1154
1155Diffstat
1156--------
1157
1158 Makefile.am | 4 +
1159 README-test-server | 291 ---
1160 README.build | 239 ++
1161 README.coding | 138 ++
1162 README.rst | 72 -
1163 README.test-apps | 272 +++
1164 configure.ac | 116 +-
1165 lib/Makefile.am | 55 +-
1166 lib/base64-decode.c | 5 +-
1167 lib/client-handshake.c | 121 +-
1168 lib/client-parser.c | 394 ++++
1169 lib/client.c | 807 +++++++
1170 lib/daemonize.c | 212 ++
1171 lib/extension-deflate-frame.c | 132 +-
1172 lib/extension-deflate-stream.c | 12 +-
1173 lib/extension-x-google-mux.c | 1223 ----------
1174 lib/extension-x-google-mux.h | 96 -
1175 lib/extension.c | 8 -
1176 lib/getifaddrs.c | 271 +++
1177 lib/getifaddrs.h | 76 +
1178 lib/handshake.c | 582 +----
1179 lib/libwebsockets.c | 2493 ++++++---------------
1180 lib/libwebsockets.h | 115 +-
1181 lib/md5.c | 217 --
1182 lib/minilex.c | 440 ++++
1183 lib/output.c | 628 ++++++
1184 lib/parsers.c | 2016 +++++------------
1185 lib/private-libwebsockets.h | 284 +--
1186 lib/server-handshake.c | 275 +++
1187 lib/server.c | 377 ++++
1188 libwebsockets-api-doc.html | 300 +--
1189 m4/ignore-me | 2 +
1190 test-server/Makefile.am | 111 +-
1191 test-server/libwebsockets.org-logo.png | Bin 0 -> 7029 bytes
1192 test-server/test-client.c | 45 +-
1193 test-server/test-echo.c | 330 +++
1194 test-server/test-fraggle.c | 20 +-
1195 test-server/test-ping.c | 22 +-
1196 test-server/test-server-extpoll.c | 554 -----
1197 test-server/test-server.c | 349 ++-
1198 test-server/test.html | 3 +-
1199 win32port/zlib/ZLib.vcxproj | 749 ++++---
1200 win32port/zlib/ZLib.vcxproj.filters | 188 +-
1201 win32port/zlib/adler32.c | 348 ++-
1202 win32port/zlib/compress.c | 160 +-
1203 win32port/zlib/crc32.c | 867 ++++----
1204 win32port/zlib/crc32.h | 882 ++++----
1205 win32port/zlib/deflate.c | 3799 +++++++++++++++-----------------
1206 win32port/zlib/deflate.h | 688 +++---
1207 win32port/zlib/gzclose.c | 50 +-
1208 win32port/zlib/gzguts.h | 325 ++-
1209 win32port/zlib/gzlib.c | 1157 +++++-----
1210 win32port/zlib/gzread.c | 1242 ++++++-----
1211 win32port/zlib/gzwrite.c | 1096 +++++----
1212 win32port/zlib/infback.c | 1272 ++++++-----
1213 win32port/zlib/inffast.c | 680 +++---
1214 win32port/zlib/inffast.h | 22 +-
1215 win32port/zlib/inffixed.h | 188 +-
1216 win32port/zlib/inflate.c | 2976 +++++++++++++------------
1217 win32port/zlib/inflate.h | 244 +-
1218 win32port/zlib/inftrees.c | 636 +++---
1219 win32port/zlib/inftrees.h | 124 +-
1220 win32port/zlib/trees.c | 2468 +++++++++++----------
1221 win32port/zlib/trees.h | 256 +--
1222 win32port/zlib/uncompr.c | 118 +-
1223 win32port/zlib/zconf.h | 934 ++++----
1224 win32port/zlib/zlib.h | 3357 ++++++++++++++--------------
1225 win32port/zlib/zutil.c | 642 +++---
1226 win32port/zlib/zutil.h | 526 ++---
1227 69 files changed, 19556 insertions(+), 20145 deletions(-)
1228
1229user api changes
1230----------------
1231
1232 - libwebsockets_serve_http_file() now takes a context as first argument
1233
1234 - libwebsockets_get_peer_addresses() now takes a context and wsi as first
1235 two arguments
1236
1237
1238user api additions
1239------------------
1240
1241 - lwsl_...() logging apis, default to stderr but retargetable by user code;
1242 may be used also by user code
1243
1244 - lws_set_log_level() set which logging apis are able to emit (defaults to
1245 notice, warn, err severities), optionally set the emit callback
1246
1247 - lwsl_emit_syslog() helper callback emits to syslog
1248
1249 - lws_daemonize() helper code that forks the app into a headless daemon
1250 properly, maintains a lock file with pid in suitable for sysvinit etc to
1251 control lifecycle
1252
1253 - LWS_CALLBACK_HTTP_FILE_COMPLETION callback added since http file
1254 transfer is now asynchronous (see test server code)
1255
1256 - lws_frame_is_binary() from a wsi pointer, let you know if the received
1257 data was sent in BINARY mode
1258
1259
1260user api removals
1261-----------------
1262
1263 - libwebsockets_fork_service_loop() - no longer supported (had intractable problems)
1264 arrange your code to act from the user callback instead from same
1265 process context as the service loop
1266
1267 - libwebsockets_broadcast() - use libwebsocket_callback_on_writable[_all_protocol]()
1268 instead from same process context as the service loop. See the test apps
1269 for examples.
1270
1271 - x-google-mux() removed until someone wants it
1272
1273 - pre -v13 (ancient) protocol support removed
1274
1275
1276New features
1277------------
1278
1279 - echo test server and client compatible with echo.websocket.org added
1280
1281 - many new configure options (see README.build) to reduce footprint of the
1282 library to what you actually need, eg, --without-client and
1283 --without-server
1284
1285 - http + websocket server can build to as little as 12K .text for ARM
1286
1287 - no more MAX_CLIENTS limitation; adapts to support the max number of fds
1288 allowed to the process by ulimit, defaults to 1024 on Fedora and
1289 Ubuntu. Use ulimit to control this without needing to configure
1290 the library. Code here is smaller and faster.
1291
1292 - adaptive ratio of listen socket to connection socket service allows
1293 good behaviour under Apache ab test load. Tested with thousands
1294 of simultaneous connections
1295
1296 - reduction in per-connection memory footprint by moving to a union to hold
1297 mutually-exclusive state for the connection
1298
1299 - robustness: Out of Memory taken care of for all allocation code now
1300
1301 - internal getifaddrs option if your toolchain lacks it (some uclibc)
1302
1303 - configurable memory limit for deflate operations
1304
1305 - improvements in SSL code nonblocking operation, possible hang solved,
1306 some SSL operations broken down into pollable states so there is
1307 no library blocking, timeout coverage for SSL_connect
1308
1309 - extpoll test server merged into single test server source
1310
1311 - robustness: library should deal with all recoverable socket conditions
1312
1313 - rx flowcontrol for backpressure notification fixed and implmeneted
1314 correctly in the test server
1315
1316 - optimal lexical parser added for header processing; all headers in a
1317 single 276-byte state table
1318
1319 - latency tracking api added (configure --with-latency)
1320
1321 - Improved in-tree documentation, REAME.build, README.coding,
1322 README.test-apps, changelog
1323
1324 - Many small fixes
1325
1326
1327v1.0-chrome25-firefox17 (6cd1ea9b005933f)