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