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