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