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