blob: db8fce7040d7257c79e06f026a0ae2cdce947af3 [file] [log] [blame]
Andy Greena35c86f2013-01-31 10:16:44 +08001Changelog
2---------
3
Andy Greend7fddad2016-02-18 20:36:55 +08004User API additions
5------------------
6
71) There's a new member in struct lws_context_creation_info, ecdh_curve,
8which lets you set the name of the ECDH curve OpenSSL should use. By
9default (if you leave ecdh_curve NULL) it will use "prime256v1"
10
11
Andy Green9c60ed92016-02-16 12:32:18 +080012v1.7.0
13======
14
Andy Green67112662016-01-11 11:34:01 +080015Extension Changes
16-----------------
17
181) There is now a "permessage-deflate" / RFC7692 implementation. It's very
19similar to "deflate-frame" we have offered for a long while; deflate-frame is
20now provided as an alias of permessage-deflate.
21
22The main differences are that the new permessage-deflate implementation:
23
24 - properly performs streaming respecting input and output buffer limits. The
25 old deflate-frame implementation could only work on complete deflate input
26 and produce complete inflate output for each frame. The new implementation
27 only mallocs buffers at initialization.
28
29 - goes around the event loop after each input package is processed allowing
30 interleaved output processing. The RX flow control api can be used to
31 force compressed input processing to match the rate of compressed output
32 processing (test--echo shows an example of how to do this).
33
34 - when being "deflate-frame" for compatibility he uses the same default zlib
35 settings as the old "deflate-frame", but instead of exponentially increasing
36 malloc allocations until the whole output will fit, he observes the default
37 input and output chunking buffer sizes of "permessage-deflate", that's
38 1024 in and 1024 out at a time.
39
402) deflate-stream has been disabled for many versions (for over a year) and is
41now removed. Browsers are now standardizing on "permessage-deflate" / RFC7692
42
433) struct lws_extension is simplified, and lws extensions now have a public
44api (their callback) for use in user code to compose extensions and options
45the user code wants. lws_get_internal_exts() is deprecated but kept around
46as a NOP. The changes allow one extension implementation to go by different
47names and allows the user client code to control option offers per-ext.
48
49The test client and server are updated to use the new way. If you use
50the old way it should still work, but extensions will be disabled until you
51update your code.
52
53Extensions are now responsible for allocating and per-instance private struct
54at instance construction time and freeing it when the instance is destroyed.
55Not needing to know the size means the extension's struct can be opaque
56to user code.
57
58
Andy Green3df58002015-12-25 12:44:12 +080059User api additions
60------------------
61
Andy Green200a6a22016-02-15 20:36:02 +0800621) The info struct gained three new members
Andy Green3df58002015-12-25 12:44:12 +080063
64 - max_http_header_data: 0 for default (1024) or set the maximum amount of known
65 http header payload that lws can deal with. Payload in unknown http
66 headers is dropped silently. If for some reason you need to send huge
67 cookies or other HTTP-level headers, you can now increase this at context-
68 creation time.
69
70 - max_http_header_pool: 0 for default (16) or set the maximum amount of http
71 headers that can be tracked by lws in this context. For the server, if
72 the header pool is completely in use then accepts on the listen socket
73 are disabled until one becomes free. For the client, if you simultaneously
74 have pending connects for more than this number of client connections,
75 additional connects will fail until some of the pending connections timeout
76 or complete.
77
Andy Green200a6a22016-02-15 20:36:02 +080078 - timeout_secs: 0 for default (currently 20s), or set the library's
79 network activity timeout to the given number of seconds
80
Andy Green3df58002015-12-25 12:44:12 +080081HTTP header processing in lws only exists until just after the first main
82callback after the HTTP handshake... for ws connections that is ESTABLISHED and
83for HTTP connections the HTTP callback.
84
85So these settings are not related to the maximum number of simultaneous
Andy Green3246ebb2015-12-26 12:03:06 +080086connections, but the number of HTTP handshakes that may be expected or ongoing,
Andy Green3df58002015-12-25 12:44:12 +080087or have just completed, at one time. The reason it's useful is it changes the
88memory allocation for header processing to be one-time at context creation
89instead of every time there is a new connection, and gives you control over
90the peak allocation.
91
92Setting max_http_header_pool to 1 is fine it will just queue incoming
93connections before the accept as necessary, you can still have as many
Andy Green5b85e392015-12-26 13:23:11 +080094simultaneous post-header connections as you like. Since the http header
95processing is completed and the allocation released after ESTABLISHED or the
96HTTP callback, even with a pool of 1 many connections can be handled rapidly.
97
Andy Green066a7a12015-12-26 15:47:06 +0800982) There is a new callback that allows the user code to get acccess to the
99optional close code + aux data that may have been sent by the peer.
100
101LWS_CALLBACK_WS_PEER_INITIATED_CLOSE:
102 The peer has sent an unsolicited Close WS packet. @in and
103 @len are the optional close code (first 2 bytes, network
104 order) and the optional additional information which is not
105 defined in the standard, and may be a string or non-human-
106 readble data.
107 If you return 0 lws will echo the close and then close the
Andy Green67112662016-01-11 11:34:01 +0800108 connection. If you return nonzero lws will just close the
109 connection.
Andy Green066a7a12015-12-26 15:47:06 +0800110
111As usual not handling it does the right thing, if you're not interested in it
112just ignore it.
113
114The test server has "open and close" testing buttons at the bottom, if you
115open and close that connection, on close it will send a close code 3000 decimal
116and the string "Bye!" as the aux data.
117
118The test server dumb-increment callback handles this callback reason and prints
119
120lwsts[15714]: LWS_CALLBACK_WS_PEER_INITIATED_CLOSE: len 6
121lwsts[15714]: 0: 0x0B
122lwsts[15714]: 1: 0xB8
123lwsts[15714]: 2: 0x42
124lwsts[15714]: 3: 0x79
125lwsts[15714]: 4: 0x65
126lwsts[15714]: 5: 0x21
127
Andy Green1fb95e82015-12-26 17:20:34 +08001283) There is a new API to allow the user code to control the content of the
129close frame sent when about to return nonzero from the user callback to
130indicate the connection should close.
131
132/**
133 * lws_close_reason - Set reason and aux data to send with Close packet
134 * If you are going to return nonzero from the callback
135 * requesting the connection to close, you can optionally
136 * call this to set the reason the peer will be told if
137 * possible.
138 *
139 * @wsi: The websocket connection to set the close reason on
140 * @status: A valid close status from websocket standard
141 * @buf: NULL or buffer containing up to 124 bytes of auxiliary data
142 * @len: Length of data in @buf to send
143 */
144LWS_VISIBLE LWS_EXTERN void
145lws_close_reason(struct lws *wsi, enum lws_close_status status,
146 unsigned char *buf, size_t len);
147
148An extra button is added to the "open and close" test server page that requests
149that the test server close the connection from his end.
150
151The test server code will do so by
152
153 lws_close_reason(wsi, LWS_CLOSE_STATUS_GOINGAWAY,
154 (unsigned char *)"seeya", 5);
155 return -1;
156
157The browser shows the close code and reason he received
158
159websocket connection CLOSED, code: 1001, reason: seeya
160
Vijay Khurdiyae73d4462016-01-15 16:21:51 +08001614) There's a new context creation time option flag
Andy Green44a7f652015-12-29 11:20:09 +0800162
163LWS_SERVER_OPTION_VALIDATE_UTF8
164
165if you set it in info->options, then TEXT and CLOSE frames will get checked to
166confirm that they contain valid UTF-8. If they don't, the connection will get
167closed by lws.
168
Vijay Khurdiyae73d4462016-01-15 16:21:51 +08001695) ECDH Certs are now supported. Enable the CMake option
170
171cmake .. -DLWS_SSL_SERVER_WITH_ECDH_CERT=1
172
173**and** the info->options flag
174
Andy Greenff696482016-02-17 07:46:27 +0800175LWS_SERVER_OPTION_SSL_ECDH
Vijay Khurdiyae73d4462016-01-15 16:21:51 +0800176
177to build in support and select it at runtime.
178
Andy Greenff696482016-02-17 07:46:27 +08001796) There's a new api lws_parse_uri() that simplifies chopping up
Andy Green809d69a2016-01-14 11:37:56 +0800180https://xxx:yyy/zzz uris into parts nicely. The test client now uses this
Andy Greend3a55052016-01-19 03:34:24 +0800181to allow proper uris as well as the old address style.
182
1837) SMP support is integrated into LWS without any internal threading. It's
184very simple to use, libwebsockets-test-server-pthread shows how to do it,
185use -j <n> argument there to control the number of service threads up to 32.
186
187Two new members are added to the info struct
188
189 unsigned int count_threads;
190 unsigned int fd_limit_per_thread;
191
192leave them at the default 0 to get the normal singlethreaded service loop.
193
194Set count_threads to n to tell lws you will have n simultaneous service threads
195operating on the context.
196
197There is still a single listen socket on one port, no matter how many
198service threads.
199
200When a connection is made, it is accepted by the service thread with the least
201connections active to perform load balancing.
202
203The user code is responsible for spawning n threads running the service loop
204associated to a specific tsi (Thread Service Index, 0 .. n - 1). See
205the libwebsockets-test-server-pthread for how to do.
206
207If you leave fd_limit_per_thread at 0, then the process limit of fds is shared
208between the service threads; if you process was allowed 1024 fds overall then
209each thread is limited to 1024 / n.
210
211You can set fd_limit_per_thread to a nonzero number to control this manually, eg
212the overall supported fd limit is less than the process allowance.
213
214You can control the context basic data allocation for multithreading from Cmake
215using -DLWS_MAX_SMP=, if not given it's set to 32. The serv_buf allocation
216for the threads (currently 4096) is made at runtime only for active threads.
217
218Because lws will limit the requested number of actual threads supported
219according to LWS_MAX_SMP, there is an api lws_get_count_threads(context) to
220discover how many threads were actually allowed when the context was created.
221
222It's required to implement locking in the user code in the same way that
223libwebsockets-test-server-pthread does it, for the FD locking callbacks.
224
Andy Greenba119e92016-01-26 21:40:32 +0800225If LWS_MAX_SMP=1, then there is no code related to pthreads compiled in the
226library. If more than 1, a small amount of pthread mutex code is built into
227the library.
Andy Green809d69a2016-01-14 11:37:56 +0800228
Andy Greenba119e92016-01-26 21:40:32 +08002298) New API
230
231LWS_VISIBLE struct lws *
232lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd)
233
234allows foreign sockets accepted by non-lws code to be adopted by lws as if they
235had just been accepted by lws' own listen socket.
Andy Green3df58002015-12-25 12:44:12 +0800236
Danomi Czaski4e9c7f32016-01-28 09:40:53 +08002379) X-Real-IP: header has been added as WSI_TOKEN_HTTP_X_REAL_IP
238
Andy Green86ed65f2016-02-14 09:27:41 +080023910) Libuv support is added, there are new related user apis
240
241typedef void (lws_uv_signal_cb_t)(uv_loop_t *l, uv_signal_t *w, int revents);
242
243LWS_VISIBLE LWS_EXTERN int
244lws_uv_sigint_cfg(struct lws_context *context, int use_uv_sigint,
245 lws_uv_signal_cb_t *cb);
246
247LWS_VISIBLE LWS_EXTERN int
248lws_uv_initloop(struct lws_context *context, uv_loop_t *loop, int tsi);
249
250LWS_VISIBLE void
251lws_uv_sigint_cb(uv_loop_t *loop, uv_signal_t *watcher, int revents);
252
253and CMAKE option
254
255LWS_WITH_LIBUV
256
Danomi Czaski4e9c7f32016-01-28 09:40:53 +0800257
Andy Green3246ebb2015-12-26 12:03:06 +0800258User api changes
259----------------
260
2611) LWS_SEND_BUFFER_POST_PADDING is now 0 and deprecated. You can remove it; if
262you still use it, obviously it does nothing. Old binary code with nonzero
263LWS_SEND_BUFFER_POST_PADDING is perfectly compatible, the old code just
Andy Green5b85e392015-12-26 13:23:11 +0800264allocated a buffer bigger than the library is going to use.
Andy Green3246ebb2015-12-26 12:03:06 +0800265
Andy Green5b85e392015-12-26 13:23:11 +0800266The example apps no longer use LWS_SEND_BUFFER_POST_PADDING.
Andy Green3246ebb2015-12-26 12:03:06 +0800267
Andy Green4e2ac762015-12-26 20:26:11 +0800268The only path who made use of it was sending with LWS_WRITE_CLOSE --->
Andy Green3246ebb2015-12-26 12:03:06 +0800269
Andy Green1fb95e82015-12-26 17:20:34 +08002702) Because of lws_close_reason() formalizing handling close frames,
271LWS_WRITE_CLOSE is removed from libwebsockets.h. It was only of use to send
272close frames...close frame content should be managed using lws_close_reason()
273now.
274
Andy Green44a7f652015-12-29 11:20:09 +08002753) We check for invalid CLOSE codes and complain about protocol violation in
276our close code. But it changes little since we were in the middle of closing
277anyway.
278
2794) zero-length RX frames and zero length TX frames are now allowed.
280
2815) Pings and close used to be limited to 124 bytes, the correct limit is 125
282so that is now also allowed.
Andy Green3246ebb2015-12-26 12:03:06 +0800283
Steffen Vogelf9267172016-02-09 07:19:15 +01002846) LWS_PRE is provided as a synonym for LWS_SEND_BUFFER_PRE_PADDING, either is
Andy Green67112662016-01-11 11:34:01 +0800285valid to use now.
286
2877) There's generic support for RFC7462 style extension options built into the
288library now. As a consequence, a field "options" is added to lws_extension.
289It can be NULL if there are no options on the extension. Extension internal
290info is part of the public abi because extensions may be implemented outside
291the library.
292
Danomi Czaski4e9c7f32016-01-28 09:40:53 +08002938) WSI_TOKEN_PROXY enum was accidentally defined to collide with another token
294of value 73. That's now corrected and WSI_TOKEN_PROXY moved to his own place at
29577.
296
Andy Green86ed65f2016-02-14 09:27:41 +08002979) With the addition of libuv support, libev is not the only event loop
298library in town and his api names must be elaborated with _ev_
299
300 Callback typedef: lws_signal_cb ---> lws_ev_signal_cb_t
301 lws_sigint_cfg --> lws_ev_sigint_cfg
302 lws_initloop --> lws_ev_initloop
303 lws_sigint_cb --> lws_ev_sigint_cb
304
30510) Libev support is made compatible with multithreaded service,
306lws_ev_initloop (was lws_initloop) gets an extra argument for the
307thread service index (use 0 if you will just have 1 service thread).
308
309LWS_VISIBLE LWS_EXTERN int
Andy Greenff696482016-02-17 07:46:27 +0800310lws_ev_initloop(struct lws_context *context, ev_loop_t *loop, int tsi);
Andy Green86ed65f2016-02-14 09:27:41 +0800311
Andy Green3df58002015-12-25 12:44:12 +0800312
Andy Green9e8d1482015-12-18 11:01:03 +0800313v1.6.0-chrome48-firefox42
314=======================
315
316Major API improvements
317----------------------
318
319v1.6.0 has many cleanups and improvements in the API. Although at first it
320looks pretty drastic, user code will only need four actions to update it.
321
322 - Do the three search/replaces in your user code, /libwebsocket_/lws_/,
323 /libwebsockets_/lws_/, and /struct\ libwebsocket/struct\ lws/
324
325 - Remove the context parameter from your user callbacks
326
327 - Remove context as the first parameter from the "Eleven APIS" listed in the
328 User Api Changes section
329
330 - Add lws_get_context(wsi) as the first parameter on the "Three APIS" listed
331 in the User Api Changes section, and anywhere else you still need context
332
333That's it... generally only a handful of the 14 affected APIs are actually in
334use in your user code and you can find them quickest by compiling and visiting
335the errors each in turn. And the end results are much cleaner, more
336predictable and maintainable.
337
338
Andy Green4e442b72015-12-10 07:58:58 +0800339User api additions
340------------------
341
Andy Green3f628702015-12-14 07:16:32 +08003421) lws now exposes his internal platform file abstraction in a way that can be
Andy Green4e442b72015-12-10 07:58:58 +0800343both used by user code to make it platform-agnostic, and be overridden or
344subclassed by user code. This allows things like handling the URI "directory
345space" as a virtual filesystem that may or may not be backed by a regular
346filesystem. One example use is serving files from inside large compressed
347archive storage without having to unpack anything except the file being
348requested.
349
350The test server shows how to use it, basically the platform-specific part of
351lws prepares a file operations structure that lives in the lws context.
352
Andy Green3f599962015-12-14 07:21:42 +0800353Helpers are provided to also leverage these platform-independent file handling
354apis
Andy Green4e442b72015-12-10 07:58:58 +0800355
356static inline lws_filefd_type
Andy Green3f599962015-12-14 07:21:42 +0800357lws_plat_file_open(struct lws *wsi, const char *filename,
Andy Green4e442b72015-12-10 07:58:58 +0800358 unsigned long *filelen, int flags)
Andy Green4e442b72015-12-10 07:58:58 +0800359static inline int
Andy Green3f599962015-12-14 07:21:42 +0800360lws_plat_file_close(struct lws *wsi, lws_filefd_type fd)
Andy Green4e442b72015-12-10 07:58:58 +0800361
362static inline unsigned long
Andy Green3f599962015-12-14 07:21:42 +0800363lws_plat_file_seek_cur(struct lws *wsi, lws_filefd_type fd, long offset)
Andy Green4e442b72015-12-10 07:58:58 +0800364
365static inline int
Andy Green3f599962015-12-14 07:21:42 +0800366lws_plat_file_read(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
367 unsigned char *buf, unsigned long len)
Andy Green4e442b72015-12-10 07:58:58 +0800368
369static inline int
Andy Green3f599962015-12-14 07:21:42 +0800370lws_plat_file_write(struct lws *wsi, lws_filefd_type fd, unsigned long *amount,
371 unsigned char *buf, unsigned long len)
Andy Green4e442b72015-12-10 07:58:58 +0800372
373The user code can also override or subclass the file operations, to either
374wrap or replace them. An example is shown in test server.
375
Andy Green3f599962015-12-14 07:21:42 +0800376A wsi can be associated with the file activity, allowing per-connection
377authentication and state to be used when interpreting the file request.
378
Andy Green3f628702015-12-14 07:16:32 +08003792) A new API void * lws_wsi_user(struct lws *wsi) lets you get the pointer to
380the user data associated with the wsi, just from the wsi.
381
Andy Green9e8d1482015-12-18 11:01:03 +08003823) URI argument handling. Libwebsockets parses and protects URI arguments
383like test.html?arg1=1&arg2=2, it decodes %xx uriencoding format and reduces
384path attacks like ../.../../etc/passwd so they cannot go behind the web
385server's /. There is a list of confirmed attacks we're proof against in
386./test-server/attack.sh.
387
388There is a new API lws_hdr_copy_fragment that should be used now to access
389the URI arguments (it returns the fragments length)
390
391 while (lws_hdr_copy_fragment(wsi, buf, sizeof(buf),
392 WSI_TOKEN_HTTP_URI_ARGS, n) > 0) {
393 lwsl_info("URI Arg %d: %s\n", ++n, buf);
394 }
395
396For the example above, calling with n=0 will return "arg1=1" and n=1 "arg2=2".
397All legal uriencodings will have been reduced in those strings.
398
399lws_hdr_copy_fragment() returns the length of the x=y fragment, so it's also
400possible to deal with arguments containing %00. If you don't care about that,
401the returned string has '\0' appended to simplify processing.
402
Andy Green4e442b72015-12-10 07:58:58 +0800403
Andy Green6d417202015-12-04 10:39:23 +0800404User api changes
405----------------
406
Andy Green1a366bf2015-12-14 07:02:51 +08004071) Three APIS
408
409 - lws_callback_on_writable_all_protocol(const struct lws_protocols *protocol)
410 - lws_callback_all_protocol(const struct lws_protocols *protocol)
411 - lws_rx_flow_allow_all_protocol(lws_rx_flow_allow_all_protocol)
412
413Now take an additional pointer to the lws_context in their first argument.
414
415The reason for this change is struct lws_protocols has been changed to remove
416members that lws used for private storage: so the protocols struct in now
417truly const and may be reused serially or simultaneously by different contexts.
418
Andy Green11c05bf2015-12-16 18:19:08 +08004192) Eleven APIs
420
421LWS_VISIBLE LWS_EXTERN int
422lws_add_http_header_by_name(struct lws_context *context,
423 struct lws *wsi,
424 const unsigned char *name,
425 const unsigned char *value,
426 int length,
427 unsigned char **p,
428 unsigned char *end);
429LWS_VISIBLE LWS_EXTERN int
430lws_finalize_http_header(struct lws_context *context,
431 struct lws *wsi,
432 unsigned char **p,
433 unsigned char *end);
434LWS_VISIBLE LWS_EXTERN int
435lws_add_http_header_by_token(struct lws_context *context,
436 struct lws *wsi,
437 enum lws_token_indexes token,
438 const unsigned char *value,
439 int length,
440 unsigned char **p,
441 unsigned char *end);
442LWS_VISIBLE LWS_EXTERN int
443lws_add_http_header_content_length(struct lws_context *context,
444 struct lws *wsi,
445 unsigned long content_length,
446 unsigned char **p,
447 unsigned char *end);
448LWS_VISIBLE LWS_EXTERN int
449lws_add_http_header_status(struct lws_context *context, struct lws *wsi,
450 unsigned int code, unsigned char **p,
451 unsigned char *end);
452
453LWS_VISIBLE LWS_EXTERN int
454lws_serve_http_file(struct lws_context *context, struct lws *wsi,
455 const char *file, const char *content_type,
456 const char *other_headers, int other_headers_len);
457LWS_VISIBLE LWS_EXTERN int
458lws_serve_http_file_fragment(struct lws_context *context, struct lws *wsi);
459
460LWS_VISIBLE LWS_EXTERN int
461lws_return_http_status(struct lws_context *context, struct lws *wsi,
462 unsigned int code, const char *html_body);
463
464LWS_VISIBLE LWS_EXTERN int
465lws_callback_on_writable(const struct lws_context *context, struct lws *wsi);
466
467LWS_VISIBLE LWS_EXTERN void
468lws_get_peer_addresses(struct lws_context *context, struct lws *wsi,
469 lws_sockfd_type fd, char *name, int name_len,
470 char *rip, int rip_len);
471
472LWS_VISIBLE LWS_EXTERN int
473lws_read(struct lws_context *context, struct lws *wsi,
474 unsigned char *buf, size_t len);
475
476no longer require their initial struct lws_context * parameter.
477
4783) Several older apis start with libwebsocket_ or libwebsockets_ while newer ones
Andy Green6d417202015-12-04 10:39:23 +0800479all begin lws_. These apis have been changed to all begin with lws_.
480
Andy Green11c05bf2015-12-16 18:19:08 +0800481To convert, search-replace
Andy Green6d417202015-12-04 10:39:23 +0800482
Andy Green11c05bf2015-12-16 18:19:08 +0800483 - libwebsockets_/lws_
484 - libwebsocket_/lws_
485 - struct\ libwebsocket/struct\ lws
Andy Green00c6d152015-12-17 07:54:44 +0800486
4874) context parameter removed from user callback.
488
489Since almost all apis no longer need the context as a parameter, it's no longer
490provided at the user callback directly.
491
492However if you need it, for ALL callbacks wsi is valid and has a valid context
Andy Green6d645392015-12-17 18:25:25 +0800493pointer you can recover using lws_get_context(wsi).
Andy Green6d417202015-12-04 10:39:23 +0800494
495
Andy Greenab620ff2015-10-28 08:39:09 +0800496v1.5-chrome47-firefox41
497=======================
MGadkari020c53c2015-08-21 16:15:36 +0530498
499User api changes
500----------------
501
502LWS_CALLBACK_CLIENT_CONNECTION_ERROR may provide an error string if in is
503non-NULL. If so, the string has length len.
504
Andy Green6d59f592015-10-15 09:12:58 +0800505LWS_SERVER_OPTION_PEER_CERT_NOT_REQUIRED is available to relax the requirement
506for peer certs if you are using the option to require client certs.
507
Andy Green4c79ee72015-10-15 11:20:40 +0800508LWS_WITHOUT_BUILTIN_SHA1 cmake option forces lws to use SHA1() defined
509externally, eg, byOpenSSL, and disables build of libwebsockets_SHA1()
510
511
Andy Green16fb0132015-03-28 11:35:40 +0800512v1.4-chrome43-firefox36
513=======================
Olehfaeac3c2014-07-29 23:18:41 +0800514
515User api additions
516------------------
517
518There's a new member in the info struct used to control context creation,
519ssl_private_key_password, which allows passing into lws the passphrase on
520an SSL cetificate
521
Andy Greeneabed8d2014-08-11 12:11:36 +0800522There's a new member in struct protocols, id, which is ignored by lws but can
523be used by the user code to mark the selected protocol by user-defined version
524or capabliity flag information, for the case multiple versions of a protocol are
525supported.
526
Andy Greenb128ccc2014-08-16 09:54:27 +0800527int lws_is_ssl(wsi) added to allow user code to know if the connection was made
528over ssl or not. If LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT is used, both
529ssl and non-ssl connections are possible and may need to be treated differently
530in the user code.
531
Andy Green14425ea2014-08-18 22:49:39 +0800532int lws_partial_buffered(wsi) added... should be checked after any
533libwebsocket_write that will be followed by another libwebsocket_write inside
534the same writeable callback. If set, you can't do any more writes until the
535writeable callback is called again. If you only do one write per writeable callback,
536you can ignore this.
537
Andy Green917f43a2014-10-12 14:31:47 +0800538HTTP2-related: HTTP2 changes how headers are handled, lws now has new version-
539agnositic header creation APIs. These do the right thing depending on each
540connection's HTTP version without the user code having to know or care, except
541to make sure to use the new APIs for headers (test-server is updated to use
542them already, so look there for examples)
543
544The APIs "render" the headers into a user-provided buffer and bump *p as it
545is used. If *p reaches end, then the APIs return nonzero for error.
546
547LWS_VISIBLE LWS_EXTERN int
548lws_add_http_header_status(struct libwebsocket_context *context,
549 struct libwebsocket *wsi,
550 unsigned int code,
551 unsigned char **p,
552 unsigned char *end);
553
554Start a response header reporting status like 200, 500, etc
555
556LWS_VISIBLE LWS_EXTERN int
557lws_add_http_header_by_name(struct libwebsocket_context *context,
558 struct libwebsocket *wsi,
559 const unsigned char *name,
560 const unsigned char *value,
561 int length,
562 unsigned char **p,
563 unsigned char *end);
564
565Add a header like name: value in HTTP1.x
566
567LWS_VISIBLE LWS_EXTERN int
568lws_finalize_http_header(struct libwebsocket_context *context,
569 struct libwebsocket *wsi,
570 unsigned char **p,
571 unsigned char *end);
572
573Finish off the headers, like add the extra \r\n in HTTP1.x
574
575LWS_VISIBLE LWS_EXTERN int
576lws_add_http_header_by_token(struct libwebsocket_context *context,
577 struct libwebsocket *wsi,
578 enum lws_token_indexes token,
579 const unsigned char *value,
580 int length,
581 unsigned char **p,
582 unsigned char *end);
583
584Add a header by using a lws token as the name part. In HTTP2, this can be
585compressed to one or two bytes.
586
Olehfaeac3c2014-07-29 23:18:41 +0800587
Andy Green822241c2014-08-18 22:21:51 +0800588User api removal
589----------------
590
591protocols struct member no_buffer_all_partial_tx is removed. Under some
Peter Pentchevbb085da2015-12-03 15:55:11 +0200592conditions like rewriting extension such as compression in use, the built-in
Andy Green822241c2014-08-18 22:21:51 +0800593partial send buffering is the only way to deal with the problem, so turning
594it off is deprecated.
595
596
Andy Green917f43a2014-10-12 14:31:47 +0800597User api changes
598----------------
599
600HTTP2-related: API libwebsockets_serve_http_file() takes an extra parameter at
601the end now
602
603int other_headers_len)
604
605If you are providing other headers, they must be generated using the new
606HTTP-version-agnostic APIs, and you must provide the length of them using this
607additional parameter.
608
joseph.urciuoli4d9c8fc2014-10-16 08:53:19 +0800609struct lws_context_creation_info now has an additional member
610SSL_CTX *provided_client_ssl_ctx you may set to an externally-initialized
611SSL_CTX managed outside lws. Defaulting to zero keeps the existing behaviour of
612lws managing the context, if you memset the struct to 0 or have as a filescope
613initialized struct in bss, no need to change anything.
614
Andy Green822241c2014-08-18 22:21:51 +0800615
Andy Greenc1fdd102014-07-06 09:56:11 +0800616v1.3-chrome37-firefox30
617=======================
618
619 .gitignore | 1 -
620 CMakeLists.txt | 447 +++--
621 README.build | 35 +-
622 README.coding | 14 +
623 changelog | 66 +
624 cmake/LibwebsocketsConfig.cmake.in | 17 +
625 cmake/LibwebsocketsConfigVersion.cmake.in | 11 +
626 config.h.cmake | 18 +
627 cross-ming.cmake | 31 +
628 cross-openwrt-makefile | 91 +
629 lib/client-handshake.c | 205 ++-
630 lib/client-parser.c | 58 +-
631 lib/client.c | 158 +-
632 lib/context.c | 341 ++++
633 lib/extension-deflate-frame.c | 2 +-
634 lib/extension.c | 178 ++
635 lib/handshake.c | 287 +---
636 lib/lextable.h | 338 ++++
637 lib/libev.c | 175 ++
638 lib/libwebsockets.c | 2089 +++--------------------
639 lib/libwebsockets.h | 253 ++-
640 lib/lws-plat-unix.c | 404 +++++
641 lib/lws-plat-win.c | 358 ++++
642 lib/minilex.c | 530 +++---
643 lib/output.c | 445 ++---
644 lib/parsers.c | 682 ++++----
645 lib/pollfd.c | 239 +++
646 lib/private-libwebsockets.h | 501 +++++-
647 lib/server-handshake.c | 274 +--
648 lib/server.c | 858 ++++++++--
649 lib/service.c | 517 ++++++
650 lib/sha-1.c | 38 +-
651 lib/ssl-http2.c | 78 +
652 lib/ssl.c | 571 +++++++
653 test-server/attack.sh | 101 +-
654 test-server/test-client.c | 9 +-
655 test-server/test-echo.c | 17 +-
656 test-server/test-fraggle.c | 7 -
657 test-server/test-ping.c | 12 +-
658 test-server/test-server.c | 330 ++--
659 test-server/test.html | 4 +-
660 win32port/client/client.vcxproj | 259 ---
661 win32port/client/client.vcxproj.filters | 39 -
662 .../libwebsocketswin32.vcxproj.filters | 93 -
663 win32port/server/server.vcxproj | 276 ---
664 win32port/server/server.vcxproj.filters | 51 -
665 win32port/win32helpers/gettimeofday.h | 59 +-
666 win32port/win32helpers/netdb.h | 1 -
667 win32port/win32helpers/strings.h | 0
668 win32port/win32helpers/sys/time.h | 1 -
669 win32port/win32helpers/unistd.h | 0
670 win32port/win32helpers/websock-w32.c | 104 --
671 win32port/win32helpers/websock-w32.h | 62 -
672 win32port/win32port.sln | 100 --
673 win32port/zlib/gzio.c | 3 +-
674 55 files changed, 6779 insertions(+), 5059 deletions(-)
675
Andy Green79002562013-11-09 11:04:35 +0800676
kapejodce64fb02013-11-19 13:38:16 +0100677User api additions
678------------------
679
680POST method is supported
681
682The protocol 0 / HTTP callback can now get two new kinds of callback,
683LWS_CALLBACK_HTTP_BODY (in and len are a chunk of the body of the HTTP request)
684and LWS_CALLBACK_HTTP_BODY_COMPLETION (the expected amount of body has arrived
685and been passed to the user code already). These callbacks are used with the
686post method (see the test server for details).
687
688The period between the HTTP header completion and the completion of the body
689processing is protected by a 5s timeout.
690
691The chunks are stored in a malloc'd buffer of size protocols[0].rx_buffer_size.
692
693
James Devine5b34c972013-12-14 11:41:29 +0800694New server option you can enable from user code
695LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT allows non-SSL connections to
696also be accepted on an SSL listening port. It's disabled unless you enable
697it explicitly.
698
699
Andy Green7a132792013-12-18 09:48:26 +0800700Two new callbacks are added in protocols[0] that are optional for allowing
701limited thread access to libwebsockets, LWS_CALLBACK_LOCK_POLL and
702LWS_CALLBACK_UNLOCK_POLL.
703
704If you use them, they protect internal and external poll list changes, but if
705you want to use external thread access to libwebsocket_callback_on_writable()
706you have to implement your locking here even if you don't use external
707poll support.
708
709If you will use another thread for this, take a lot of care about managing
710your list of live wsi by doing it from ESTABLISHED and CLOSED callbacks
711(with your own locking).
712
Andrew Canaday9769f4f2014-03-23 13:25:07 +0800713If you configure cmake with -DLWS_WITH_LIBEV=1 then the code allowing the libev
714eventloop instead of the default poll() one will also be compiled in. But to
715use it, you must also set the LWS_SERVER_OPTION_LIBEV flag on the context
716creation info struct options member.
Andy Green7a132792013-12-18 09:48:26 +0800717
Andy Greenc1fdd102014-07-06 09:56:11 +0800718IPV6 is supported and enabled by default except for Windows, you can disable
719the support at build-time by giving -DLWS_IPV6=, and disable use of it even if
James Devine3f13ea22014-03-24 16:09:25 +0800720compiled in by making sure the flag LWS_SERVER_OPTION_DISABLE_IPV6 is set on
721the context creation info struct options member.
722
Andy Greenc1fdd102014-07-06 09:56:11 +0800723You can give LWS_SERVER_OPTION_DISABLE_OS_CA_CERTS option flag to
724guarantee the OS CAs will not be used, even if that support was selected at
725build-time.
726
727Optional "token limits" may be enforced by setting the member "token_limits"
728in struct lws_context_creation_info to point to a struct lws_token_limits.
729NULL means no token limits used for compatibility.
730
Andy Green7a132792013-12-18 09:48:26 +0800731
Andy Green79002562013-11-09 11:04:35 +0800732User api changes
733----------------
734
735Extra optional argument to libwebsockets_serve_http_file() allows injecion
736of HTTP headers into the canned response. Eg, cookies may be added like
737that without getting involved in having to send the header by hand.
738
Patrick Gansterer148b9452014-02-28 02:31:23 +0100739A new info member http_proxy_address may be used at context creation time to
740set the http proxy. If non-NULL, it overrides http_proxy environment var.
Andy Green79002562013-11-09 11:04:35 +0800741
Andy Greend2ec7ad2014-03-15 10:39:29 +0800742Cmake supports LWS_SSL_CLIENT_USE_OS_CA_CERTS defaulting to on, which gets
743the client to use the OS CA Roots. If you're worried somebody with the
744ability to forge for force creation of a client cert from the root CA in
745your OS, you should disable this since your selfsigned $0 cert is a lot safer
746then...
747
Andy Green79002562013-11-09 11:04:35 +0800748
Andy Green81877e62013-10-26 20:36:08 +0800749v1.23-chrome32-firefox24
750========================
751
752 Android.mk | 29 +
753 CMakeLists.txt | 573 ++++++++----
754 COPYING | 503 -----------
755 INSTALL | 365 --------
756 Makefile.am | 13 -
757 README.build | 371 ++------
758 README.coding | 63 ++
759 autogen.sh | 1578 ---------------------------------
760 changelog | 69 ++
761 cmake/FindGit.cmake | 163 ++++
762 cmake/FindOpenSSLbins.cmake | 15 +-
763 cmake/UseRPMTools.cmake | 176 ++++
764 config.h.cmake | 25 +-
765 configure.ac | 226 -----
766 cross-arm-linux-gnueabihf.cmake | 28 +
767 lib/Makefile.am | 89 --
768 lib/base64-decode.c | 98 +-
769 lib/client-handshake.c | 123 ++-
770 lib/client-parser.c | 19 +-
771 lib/client.c | 145 ++-
772 lib/daemonize.c | 4 +-
773 lib/extension.c | 2 +-
774 lib/getifaddrs.h | 4 +-
775 lib/handshake.c | 76 +-
776 lib/libwebsockets.c | 491 ++++++----
777 lib/libwebsockets.h | 164 ++--
778 lib/output.c | 214 ++++-
779 lib/parsers.c | 102 +--
780 lib/private-libwebsockets.h | 66 +-
781 lib/server-handshake.c | 5 +-
782 lib/server.c | 29 +-
783 lib/sha-1.c | 2 +-
784 libwebsockets-api-doc.html | 249 +++---
785 libwebsockets.pc.in | 11 -
786 libwebsockets.spec | 14 +-
787 m4/ignore-me | 2 -
788 scripts/FindLibWebSockets.cmake | 33 +
789 scripts/kernel-doc | 1 +
790 test-server/Makefile.am | 131 ---
791 test-server/leaf.jpg | Bin 0 -> 2477518 bytes
792 test-server/test-client.c | 78 +-
793 test-server/test-echo.c | 33 +-
794 test-server/test-fraggle.c | 26 +-
795 test-server/test-ping.c | 15 +-
796 test-server/test-server.c | 197 +++-
797 test-server/test.html | 5 +-
798 win32port/win32helpers/gettimeofday.c | 74 +-
799 win32port/win32helpers/websock-w32.h | 6 +-
800 48 files changed, 2493 insertions(+), 4212 deletions(-)
801
Andy Green54cb3462013-02-14 22:23:54 +0800802
803User api additions
804------------------
805
806 - You can now call libwebsocket_callback_on_writable() on http connectons,
807 and get a LWS_CALLBACK_HTTP_WRITEABLE callback, the same way you can
808 regulate writes with a websocket protocol connection.
809
Andy Green2672fb22013-02-22 09:54:35 +0800810 - A new member in the context creation parameter struct "ssl_cipher_list" is
811 added, replacing CIPHERS_LIST_STRING. NULL means use the ssl library
812 default list of ciphers.
813
Andy Green58f214e2013-03-09 13:03:53 +0800814 - Not really an api addition, but libwebsocket_service_fd() will now zero
815 the revents field of the pollfd it was called with if it handled the
816 descriptor. So you can tell if it is a non-lws fd by checking revents
817 after the service call... if it's still nonzero, the descriptor
818 belongs to you and you need to take care of it.
819
Andy Greenb55451c2013-03-16 12:32:27 +0800820 - libwebsocket_rx_flow_allow_all_protocol(protocol) will unthrottle all
821 connections with the established protocol. It's designed to be
822 called from user server code when it sees it can accept more input
823 and may have throttled connections using the server rx flow apis
824 while it was unable to accept any other input The user server code
825 then does not have to try to track while connections it choked, this
826 will free up all of them in one call.
827
Andy Green0c9563b2013-06-10 22:54:40 +0800828 - there's a new, optional callback LWS_CALLBACK_CLOSED_HTTP which gets
829 called when an HTTP protocol socket closes
830
Andy Green96d48fd2013-09-18 08:32:55 +0800831 - for LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION callback, the user_space alloc
832 has already been done before the callback happens. That means we can
833 use the user parameter to the callback to contain the user pointer, and
834 move the protocol name to the "in" parameter. The docs for this
835 callback are also updated to reflect how to check headers in there.
836
Andy Green5dc62ea2013-09-20 20:26:12 +0800837 - libwebsocket_client_connect() is now properly nonblocking and async. See
838 README.coding and test-client.c for information on the callbacks you
839 can rely on controlling the async connection period with.
840
Andy Green81877e62013-10-26 20:36:08 +0800841 - if your OS does not support the http_proxy environment variable convention
842 (eg, reportedly OSX), you can use a new api libwebsocket_set_proxy()
Peter Pentchevbb085da2015-12-03 15:55:11 +0200843 to set the proxy details in between context creation and the connection
Andy Green81877e62013-10-26 20:36:08 +0800844 action. For OSes that support http_proxy, that's used automatically.
Andy Greenb55451c2013-03-16 12:32:27 +0800845
Andy Green50097dd2013-02-15 22:36:30 +0800846User api changes
847----------------
848
849 - the external poll callbacks now get the socket descriptor coming from the
850 "in" parameter. The user parameter provides the user_space for the
851 wsi as it normally does on the other callbacks.
Edwin van den Oetelaar8c8a8e12013-02-20 20:56:59 +0800852 LWS_CALLBACK_FILTER_NETWORK_CONNECTION also has the socket descriptor
853 delivered by @in now instead of @user.
Andy Green50097dd2013-02-15 22:36:30 +0800854
Andy Greenfc7c5e42013-02-23 10:50:10 +0800855 - libwebsocket_write() now returns -1 for error, or the amount of data
856 actually accepted for send. Under load, the OS may signal it is
857 ready to send new data on the socket, but have only a restricted
858 amount of memory to buffer the packet compared to usual.
859
Andy Green50097dd2013-02-15 22:36:30 +0800860
Andy Greendc914cf2013-02-18 16:54:26 +0800861User api removal
862----------------
863
864 - libwebsocket_ensure_user_space() is removed from the public api, if you
865 were using it to get user_space, you need to adapt your code to only
866 use user_space inside the user callback.
867
Andy Green2672fb22013-02-22 09:54:35 +0800868 - CIPHERS_LIST_STRING is removed
869
Andy Green0097a992013-03-09 13:06:37 +0800870 - autotools build has been removed. See README.build for info on how to
871 use CMake for your platform
872
Andy Green54cb3462013-02-14 22:23:54 +0800873
Andy Green53a46782013-02-14 11:23:49 +0800874v1.21-chrome26-firefox18
875========================
876
877 - Fixes buffer overflow bug in max frame size handling if you used the
878 default protocol buffer size. If you declared rx_buffer_size in your
879 protocol, which is recommended anyway, your code was unaffected.
880
Andy Green182cb9a2013-02-13 11:54:08 +0800881v1.2-chrome26-firefox18
882=======================
883
884Diffstat
885--------
886
887 .gitignore | 16 +++
888 CMakeLists.txt | 544 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
889 LICENSE | 526 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
890 Makefile.am | 1 +
891 README | 20 +++
892 README.build | 258 ++++++++++++++++++++++++++++++++-----
893 README.coding | 52 ++++++++
894 changelog | 136 ++++++++++++++++++++
895 cmake/FindOpenSSLbins.cmake | 33 +++++
896 config.h.cmake | 173 +++++++++++++++++++++++++
897 configure.ac | 22 +++-
898 lib/Makefile.am | 20 ++-
899 lib/base64-decode.c | 2 +-
900 lib/client-handshake.c | 190 +++++++++++-----------------
901 lib/client-parser.c | 88 +++++++------
902 lib/client.c | 384 ++++++++++++++++++++++++++++++-------------------------
903 lib/daemonize.c | 32 +++--
904 lib/extension-deflate-frame.c | 58 +++++----
905 lib/extension-deflate-stream.c | 19 ++-
906 lib/extension-deflate-stream.h | 4 +-
907 lib/extension.c | 11 +-
908 lib/getifaddrs.c | 315 +++++++++++++++++++++++-----------------------
909 lib/getifaddrs.h | 30 ++---
910 lib/handshake.c | 124 +++++++++++-------
911 lib/libwebsockets.c | 736 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++--------------------------------------
912 lib/libwebsockets.h | 237 ++++++++++++++++++++++------------
913 lib/output.c | 192 +++++++++++-----------------
914 lib/parsers.c | 966 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++----------------------------------------------------------------
915 lib/private-libwebsockets.h | 225 +++++++++++++++++++++------------
916 lib/server-handshake.c | 82 ++++++------
917 lib/server.c | 96 +++++++-------
918 libwebsockets-api-doc.html | 189 ++++++++++++++++++----------
919 libwebsockets.spec | 17 +--
920 test-server/attack.sh | 148 ++++++++++++++++++++++
921 test-server/test-client.c | 125 +++++++++---------
922 test-server/test-echo.c | 31 +++--
923 test-server/test-fraggle.c | 32 ++---
924 test-server/test-ping.c | 52 ++++----
925 test-server/test-server.c | 129 ++++++++++++-------
926 win32port/libwebsocketswin32/libwebsocketswin32.vcxproj | 279 ----------------------------------------
927 win32port/libwebsocketswin32/libwebsocketswin32.vcxproj.filters | 23 +++-
928 41 files changed, 4398 insertions(+), 2219 deletions(-)
929
Andy Green7b405452013-02-01 10:50:15 +0800930
931User api additions
932------------------
933
934 - lws_get_library_version() returns a const char * with a string like
935 "1.1 9e7f737", representing the library version from configure.ac
936 and the git HEAD hash the library was built from
937
Andy Greena47865f2013-02-10 09:39:47 +0800938 - TCP Keepalive can now optionally be applied to all lws sockets, on Linux
939 also with controllable timeout, number of probes and probe interval.
940 (On BSD type OS, you can only use system default settings for the
941 timing and retries, although enabling it is supported by setting
942 ka_time to nonzero, the exact value has no meaning.)
943 This enables detection of idle connections which are logically okay,
944 but are in fact dead, due to network connectivity issues at the server,
Andy Greena690cd02013-02-09 12:25:31 +0800945 client, or any intermediary. By default it's not enabled, but you
946 can enable it by setting a non-zero timeout (in seconds) at the new
947 ka_time member at context creation time.
948
Andy Greena7109e62013-02-11 12:05:54 +0800949 - Two new optional user callbacks added, LWS_CALLBACK_PROTOCOL_DESTROY which
950 is called one-time per protocol as the context is being destroyed, and
951 LWS_CALLBACK_PROTOCOL_INIT which is called when the context is created
952 and the protocols are added, again it's a one-time affair.
953 This lets you manage per-protocol allocations properly including
954 cleaning up after yourself when the server goes down.
Andy Green7b405452013-02-01 10:50:15 +0800955
Andy Greened334462013-02-07 21:14:33 +0800956User api changes
957----------------
958
Andy Green1b265272013-02-09 14:01:09 +0800959 - libwebsocket_create_context() has changed from taking a ton of parameters
960 to just taking a pointer to a struct containing the parameters. The
961 struct lws_context_creation_info is in libwebsockets.h, the members
962 are in the same order as when they were parameters to the call
963 previously. The test apps are all updated accordingly so you can
964 see example code there.
965
Andy Greened334462013-02-07 21:14:33 +0800966 - Header tokens are now deleted after the websocket connection is
Andy Green54495112013-02-06 21:10:16 +0900967 established. Not just the header data is saved, but the pointer and
968 length array is also removed from (union) scope saving several hundred
969 bytes per connection once it is established
970
971 - struct libwebsocket_protocols has a new member rx_buffer_size, this
972 controls rx buffer size per connection of that protocol now. Sources
973 for apps built against older versions of the library won't declare
974 this in their protocols, defaulting it to 0. Zero buffer is legal,
975 it causes a default buffer to be allocated (currently 4096)
976
977 If you want to receive only atomic frames in your user callback, you
978 should set this to greater than your largest frame size. If a frame
979 comes that exceeds that, no error occurs but the callback happens as
980 soon as the buffer limit is reached, and again if it is reached again
981 or the frame completes. You can detect that has happened by seeing
982 there is still frame content pending using
983 libwebsockets_remaining_packet_payload()
984
985 By correctly setting this, you can save a lot of memory when your
986 protocol has small frames (see the test server and client sources).
987
Andy Green16ab3182013-02-10 18:02:31 +0800988 - LWS_MAX_HEADER_LEN now defaults to 1024 and is the total amount of known
989 header payload lws can cope with, that includes the GET URL, origin
990 etc. Headers not understood by lws are ignored and their payload
991 not included in this.
992
Andy Green54495112013-02-06 21:10:16 +0900993
994User api removals
995-----------------
996
Andy Green16ab3182013-02-10 18:02:31 +0800997 - The configuration-time option MAX_USER_RX_BUFFER has been replaced by a
998 buffer size chosen per-protocol. For compatibility, there's a default
999 of 4096 rx buffer, but user code should set the appropriate size for
1000 the protocol frames.
1001
1002 - LWS_INITIAL_HDR_ALLOC and LWS_ADDITIONAL_HDR_ALLOC are no longer needed
1003 and have been removed. There's a new header management scheme that
1004 handles them in a much more compact way.
Andy Greened334462013-02-07 21:14:33 +08001005
Andy Green70edd6f2013-02-12 10:15:25 +08001006 - libwebsockets_hangup_on_client() is removed. If you want to close the
1007 connection you must do so from the user callback and by returning
1008 -1 from there.
1009
Andy Green508946c2013-02-12 10:19:08 +08001010 - libwebsocket_close_and_free_session() is now private to the library code
1011 only and not exposed for user code. If you want to close the
1012 connection, you must do so from the user callback by returning -1
1013 from there.
1014
Andy Greened334462013-02-07 21:14:33 +08001015
Andy Greendf60b0c2013-02-06 19:57:12 +09001016New features
1017------------
1018
Andy Green9b09dc02013-02-08 12:48:36 +08001019 - Cmake project file added, aimed initially at Windows support: this replaces
Andy Green16ab3182013-02-10 18:02:31 +08001020 the visual studio project files that were in the tree until now.
Andy Greendf60b0c2013-02-06 19:57:12 +09001021
Andy Greenc3ef0d62013-02-12 10:50:49 +08001022 - CyaSSL now supported in place of OpenSSL (--use-cyassl on configure)
1023
Andy Green9b09dc02013-02-08 12:48:36 +08001024 - PATH_MAX or MAX_PATH no longer needed
Andy Greendf60b0c2013-02-06 19:57:12 +09001025
Andy Green54495112013-02-06 21:10:16 +09001026 - cutomizable frame rx buffer size by protocol
1027
Andy Greenc3ef0d62013-02-12 10:50:49 +08001028 - optional TCP keepalive so dead peers can be detected, can be enabled at
1029 context-creation time
1030
1031 - valgrind-clean: no SSL or CyaSSL: completely clean. With OpenSSL, 88 bytes
1032 lost at OpenSSL library init and symptomless reports of uninitialized
1033 memory usage... seems to be a known and ignored problem at OpenSSL
1034
Andy Greena3957ef2013-02-11 09:31:43 +08001035 - By default debug is enabled and the library is built for -O0 -g to faclitate
1036 that. Use --disable-debug configure option to build instead with -O4
1037 and no -g (debug info), obviously providing best performance and
1038 reduced binary size.
Andy Green7b405452013-02-01 10:50:15 +08001039
Andy Green895d56d2013-02-11 09:32:53 +08001040 - 1.0 introduced some code to try to not deflate small frames, however this
1041 seems to break when confronted with a mixture of frames above and
1042 below the threshold, so it's removed. Veto the compression extension
1043 in your user callback if you will typically have very small frames.
1044
Andy Green16ab3182013-02-10 18:02:31 +08001045 - There are many memory usage improvements, both a reduction in malloc/
1046 realloc and architectural changes. A websocket connection now
1047 consumes only 296 bytes with SSL or 272 bytes without on x86_64,
1048 during header processing an additional 1262 bytes is allocated in a
1049 single malloc, but is freed when the websocket connection starts.
1050 The RX frame buffer defined by the protocol in user
1051 code is also allocated per connection, this represents the largest
1052 frame you can receive atomically in that protocol.
1053
Andy Greenc3ef0d62013-02-12 10:50:49 +08001054 - On ARM9 build, just http+ws server no extensions or ssl, <12Kbytes .text
1055 and 112 bytes per connection (+1328 only during header processing)
1056
Andy Green895d56d2013-02-11 09:32:53 +08001057
Andy Greenbd1132f2013-01-31 19:53:05 +08001058v1.1-chrome26-firefox18
Andy Greena35c86f2013-01-31 10:16:44 +08001059=======================
1060
1061Diffstat
1062--------
1063
1064 Makefile.am | 4 +
1065 README-test-server | 291 ---
1066 README.build | 239 ++
1067 README.coding | 138 ++
1068 README.rst | 72 -
1069 README.test-apps | 272 +++
1070 configure.ac | 116 +-
1071 lib/Makefile.am | 55 +-
1072 lib/base64-decode.c | 5 +-
1073 lib/client-handshake.c | 121 +-
1074 lib/client-parser.c | 394 ++++
1075 lib/client.c | 807 +++++++
1076 lib/daemonize.c | 212 ++
1077 lib/extension-deflate-frame.c | 132 +-
1078 lib/extension-deflate-stream.c | 12 +-
1079 lib/extension-x-google-mux.c | 1223 ----------
1080 lib/extension-x-google-mux.h | 96 -
1081 lib/extension.c | 8 -
1082 lib/getifaddrs.c | 271 +++
1083 lib/getifaddrs.h | 76 +
1084 lib/handshake.c | 582 +----
1085 lib/libwebsockets.c | 2493 ++++++---------------
1086 lib/libwebsockets.h | 115 +-
1087 lib/md5.c | 217 --
1088 lib/minilex.c | 440 ++++
1089 lib/output.c | 628 ++++++
1090 lib/parsers.c | 2016 +++++------------
1091 lib/private-libwebsockets.h | 284 +--
1092 lib/server-handshake.c | 275 +++
1093 lib/server.c | 377 ++++
1094 libwebsockets-api-doc.html | 300 +--
1095 m4/ignore-me | 2 +
1096 test-server/Makefile.am | 111 +-
1097 test-server/libwebsockets.org-logo.png | Bin 0 -> 7029 bytes
1098 test-server/test-client.c | 45 +-
1099 test-server/test-echo.c | 330 +++
1100 test-server/test-fraggle.c | 20 +-
1101 test-server/test-ping.c | 22 +-
1102 test-server/test-server-extpoll.c | 554 -----
1103 test-server/test-server.c | 349 ++-
1104 test-server/test.html | 3 +-
1105 win32port/zlib/ZLib.vcxproj | 749 ++++---
1106 win32port/zlib/ZLib.vcxproj.filters | 188 +-
1107 win32port/zlib/adler32.c | 348 ++-
1108 win32port/zlib/compress.c | 160 +-
1109 win32port/zlib/crc32.c | 867 ++++----
1110 win32port/zlib/crc32.h | 882 ++++----
1111 win32port/zlib/deflate.c | 3799 +++++++++++++++-----------------
1112 win32port/zlib/deflate.h | 688 +++---
1113 win32port/zlib/gzclose.c | 50 +-
1114 win32port/zlib/gzguts.h | 325 ++-
1115 win32port/zlib/gzlib.c | 1157 +++++-----
1116 win32port/zlib/gzread.c | 1242 ++++++-----
1117 win32port/zlib/gzwrite.c | 1096 +++++----
1118 win32port/zlib/infback.c | 1272 ++++++-----
1119 win32port/zlib/inffast.c | 680 +++---
1120 win32port/zlib/inffast.h | 22 +-
1121 win32port/zlib/inffixed.h | 188 +-
1122 win32port/zlib/inflate.c | 2976 +++++++++++++------------
1123 win32port/zlib/inflate.h | 244 +-
1124 win32port/zlib/inftrees.c | 636 +++---
1125 win32port/zlib/inftrees.h | 124 +-
1126 win32port/zlib/trees.c | 2468 +++++++++++----------
1127 win32port/zlib/trees.h | 256 +--
1128 win32port/zlib/uncompr.c | 118 +-
1129 win32port/zlib/zconf.h | 934 ++++----
1130 win32port/zlib/zlib.h | 3357 ++++++++++++++--------------
1131 win32port/zlib/zutil.c | 642 +++---
1132 win32port/zlib/zutil.h | 526 ++---
1133 69 files changed, 19556 insertions(+), 20145 deletions(-)
1134
1135user api changes
1136----------------
1137
1138 - libwebsockets_serve_http_file() now takes a context as first argument
1139
1140 - libwebsockets_get_peer_addresses() now takes a context and wsi as first
1141 two arguments
1142
1143
1144user api additions
1145------------------
1146
1147 - lwsl_...() logging apis, default to stderr but retargetable by user code;
1148 may be used also by user code
1149
1150 - lws_set_log_level() set which logging apis are able to emit (defaults to
1151 notice, warn, err severities), optionally set the emit callback
1152
1153 - lwsl_emit_syslog() helper callback emits to syslog
1154
1155 - lws_daemonize() helper code that forks the app into a headless daemon
1156 properly, maintains a lock file with pid in suitable for sysvinit etc to
1157 control lifecycle
1158
1159 - LWS_CALLBACK_HTTP_FILE_COMPLETION callback added since http file
1160 transfer is now asynchronous (see test server code)
1161
1162 - lws_frame_is_binary() from a wsi pointer, let you know if the received
1163 data was sent in BINARY mode
1164
1165
1166user api removals
1167-----------------
1168
1169 - libwebsockets_fork_service_loop() - no longer supported (had intractable problems)
1170 arrange your code to act from the user callback instead from same
1171 process context as the service loop
1172
1173 - libwebsockets_broadcast() - use libwebsocket_callback_on_writable[_all_protocol]()
1174 instead from same process context as the service loop. See the test apps
1175 for examples.
1176
1177 - x-google-mux() removed until someone wants it
1178
1179 - pre -v13 (ancient) protocol support removed
1180
1181
1182New features
1183------------
1184
1185 - echo test server and client compatible with echo.websocket.org added
1186
1187 - many new configure options (see README.build) to reduce footprint of the
1188 library to what you actually need, eg, --without-client and
1189 --without-server
1190
1191 - http + websocket server can build to as little as 12K .text for ARM
1192
1193 - no more MAX_CLIENTS limitation; adapts to support the max number of fds
1194 allowed to the process by ulimit, defaults to 1024 on Fedora and
1195 Ubuntu. Use ulimit to control this without needing to configure
1196 the library. Code here is smaller and faster.
1197
1198 - adaptive ratio of listen socket to connection socket service allows
1199 good behaviour under Apache ab test load. Tested with thousands
1200 of simultaneous connections
1201
1202 - reduction in per-connection memory footprint by moving to a union to hold
1203 mutually-exclusive state for the connection
1204
1205 - robustness: Out of Memory taken care of for all allocation code now
1206
1207 - internal getifaddrs option if your toolchain lacks it (some uclibc)
1208
1209 - configurable memory limit for deflate operations
1210
1211 - improvements in SSL code nonblocking operation, possible hang solved,
1212 some SSL operations broken down into pollable states so there is
1213 no library blocking, timeout coverage for SSL_connect
1214
1215 - extpoll test server merged into single test server source
1216
1217 - robustness: library should deal with all recoverable socket conditions
1218
1219 - rx flowcontrol for backpressure notification fixed and implmeneted
1220 correctly in the test server
1221
1222 - optimal lexical parser added for header processing; all headers in a
1223 single 276-byte state table
1224
1225 - latency tracking api added (configure --with-latency)
1226
1227 - Improved in-tree documentation, REAME.build, README.coding,
1228 README.test-apps, changelog
1229
1230 - Many small fixes
1231
1232
1233v1.0-chrome25-firefox17 (6cd1ea9b005933f)