2 * libwebsockets - small server side websockets and web server implementation
4 * Copyright (C) 2010-2015 Andy Green <andy@warmcat.com>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation:
9 * version 2.1 of the License.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
22 #include "private-libwebsockets.h"
25 lws_0405_frame_mask_generate(struct lws *wsi)
28 wsi->u.ws.mask[0] = 0;
29 wsi->u.ws.mask[1] = 0;
30 wsi->u.ws.mask[2] = 0;
31 wsi->u.ws.mask[3] = 0;
34 /* fetch the per-frame nonce */
36 n = lws_get_random(lws_get_context(wsi), wsi->u.ws.mask, 4);
38 lwsl_parser("Unable to read from random device %s %d\n",
39 SYSTEM_RANDOM_FILEPATH, n);
43 /* start masking from first byte of masking key buffer */
44 wsi->u.ws.mask_idx = 0;
51 LWS_VISIBLE void lwsl_hexdump(void *vbuf, size_t len)
53 unsigned char *buf = (unsigned char *)vbuf;
54 unsigned int n, m, start;
60 for (n = 0; n < len;) {
64 p += sprintf(p, "%04X: ", start);
66 for (m = 0; m < 16 && n < len; m++)
67 p += sprintf(p, "%02X ", buf[n++]);
73 for (m = 0; m < 16 && (start + m) < len; m++) {
74 if (buf[start + m] >= ' ' && buf[start + m] < 127)
75 *p++ = buf[start + m];
84 lwsl_debug("%s", line);
92 * notice this returns number of bytes consumed, or -1
95 int lws_issue_raw(struct lws *wsi, unsigned char *buf, size_t len)
97 struct lws_context *context = lws_get_context(wsi);
98 size_t real_len = len;
104 /* just ignore sends after we cleared the truncation buffer */
105 if (wsi->state == LWSS_FLUSHING_STORED_SEND_BEFORE_CLOSE &&
109 if (wsi->trunc_len && (buf < wsi->trunc_alloc ||
110 buf > (wsi->trunc_alloc + wsi->trunc_len + wsi->trunc_offset))) {
112 strncpy(dump, (char *)buf, sizeof(dump) - 1);
113 dump[sizeof(dump) - 1] = '\0';
114 #if defined(LWS_WITH_ESP8266)
115 lwsl_err("****** %p: Sending new %d (%s), pending truncated ...\n",
118 lwsl_err("****** %p: Sending new %d (%s), pending truncated ...\n"
119 " It's illegal to do an lws_write outside of\n"
120 " the writable callback: fix your code",
128 m = lws_ext_cb_active(wsi, LWS_EXT_CB_PACKET_TX_DO_SEND, &buf, len);
131 if (m) /* handled */ {
133 goto handle_truncated_send;
136 if (!lws_socket_is_valid(wsi->sock))
137 lwsl_warn("** error invalid sock but expected to send\n");
140 n = wsi->protocol->rx_buffer_size;
142 n = context->pt_serv_buf_size;
146 #if defined(LWS_WITH_ESP8266)
147 if (wsi->pending_send_completion) {
149 goto handle_truncated_send;
153 /* nope, send it on the socket directly */
154 lws_latency_pre(context, wsi);
155 n = lws_ssl_capable_write(wsi, buf, n);
156 lws_latency(context, wsi, "send lws_issue_raw", n, n == len);
159 case LWS_SSL_CAPABLE_ERROR:
160 /* we're going to close, let close know sends aren't possible */
161 wsi->socket_is_permanently_unusable = 1;
163 case LWS_SSL_CAPABLE_MORE_SERVICE:
164 /* nothing got sent, not fatal, retry the whole thing later */
169 handle_truncated_send:
171 * we were already handling a truncated send?
173 if (wsi->trunc_len) {
174 lwsl_info("%p partial adv %d (vs %d)\n", wsi, n, real_len);
175 wsi->trunc_offset += n;
178 if (!wsi->trunc_len) {
179 lwsl_info("***** %x partial send completed\n", wsi);
180 /* done with it, but don't free it */
182 if (wsi->state == LWSS_FLUSHING_STORED_SEND_BEFORE_CLOSE) {
183 lwsl_info("***** %x signalling to close now\n", wsi);
184 return -1; /* retry closing now */
187 /* always callback on writeable */
188 lws_callback_on_writable(wsi);
193 if ((unsigned int)n == real_len)
194 /* what we just sent went out cleanly */
198 * Newly truncated send. Buffer the remainder (it will get
199 * first priority next time the socket is writable)
201 lwsl_notice("%p new partial sent %d from %d total\n", wsi, n, real_len);
204 * - if we still have a suitable malloc lying around, use it
205 * - or, if too small, reallocate it
206 * - or, if no buffer, create it
208 if (!wsi->trunc_alloc || real_len - n > wsi->trunc_alloc_len) {
209 lws_free(wsi->trunc_alloc);
211 wsi->trunc_alloc_len = real_len - n;
212 wsi->trunc_alloc = lws_malloc(real_len - n);
213 if (!wsi->trunc_alloc) {
214 lwsl_err("truncated send: unable to malloc %d\n",
219 wsi->trunc_offset = 0;
220 wsi->trunc_len = real_len - n;
221 memcpy(wsi->trunc_alloc, buf + n, real_len - n);
223 /* since something buffered, force it to get another chance to send */
224 lws_callback_on_writable(wsi);
229 LWS_VISIBLE int lws_write(struct lws *wsi, unsigned char *buf, size_t len,
230 enum lws_write_protocol wp)
232 struct lws_context_per_thread *pt = &wsi->context->pt[(int)wsi->tsi];
233 int masked7 = (wsi->mode == LWSCM_WS_CLIENT);
234 unsigned char is_masked_bit = 0;
235 unsigned char *dropmask = NULL;
236 struct lws_tokens eff_buf;
238 size_t orig_len = len;
240 #ifdef LWS_WITH_ACCESS_LOG
241 wsi->access_log.sent += len;
244 wsi->vhost->tx += len;
246 if (wsi->state == LWSS_ESTABLISHED && wsi->u.ws.tx_draining_ext) {
247 /* remove us from the list */
248 struct lws **w = &pt->tx_draining_ext_list;
249 lwsl_debug("%s: TX EXT DRAINING: Remove from list\n", __func__);
250 wsi->u.ws.tx_draining_ext = 0;
251 /* remove us from context draining ext list */
254 *w = wsi->u.ws.tx_draining_ext_list;
257 w = &((*w)->u.ws.tx_draining_ext_list);
259 wsi->u.ws.tx_draining_ext_list = NULL;
260 wp = (wsi->u.ws.tx_draining_stashed_wp & 0xc0) |
261 LWS_WRITE_CONTINUATION;
263 lwsl_ext("FORCED draining wp to 0x%02X\n", wp);
266 lws_restart_ws_ping_pong_timer(wsi);
268 if (wp == LWS_WRITE_HTTP ||
269 wp == LWS_WRITE_HTTP_FINAL ||
270 wp == LWS_WRITE_HTTP_HEADERS)
273 /* if not in a state to send stuff, then just send nothing */
275 if (wsi->state != LWSS_ESTABLISHED &&
276 ((wsi->state != LWSS_RETURNED_CLOSE_ALREADY &&
277 wsi->state != LWSS_AWAITING_CLOSE_ACK) ||
278 wp != LWS_WRITE_CLOSE))
281 /* if we are continuing a frame that already had its header done */
283 if (wsi->u.ws.inside_frame) {
284 lwsl_debug("INSIDE FRAME\n");
285 goto do_more_inside_frame;
288 wsi->u.ws.clean_buffer = 1;
291 * give a chance to the extensions to modify payload
292 * the extension may decide to produce unlimited payload erratically
293 * (eg, compression extension), so we require only that if he produces
294 * something, it will be a complete fragment of the length known at
295 * the time (just the fragment length known), and if he has
296 * more we will come back next time he is writeable and allow him to
297 * produce more fragments until he's drained.
299 * This allows what is sent each time it is writeable to be limited to
300 * a size that can be sent without partial sends or blocking, allows
301 * interleaving of control frames and other connection service.
303 eff_buf.token = (char *)buf;
304 eff_buf.token_len = len;
309 case LWS_WRITE_CLOSE:
312 n = lws_ext_cb_active(wsi, LWS_EXT_CB_PAYLOAD_TX, &eff_buf, wp);
316 if (n && eff_buf.token_len) {
317 /* extension requires further draining */
318 wsi->u.ws.tx_draining_ext = 1;
319 wsi->u.ws.tx_draining_ext_list = pt->tx_draining_ext_list;
320 pt->tx_draining_ext_list = wsi;
321 /* we must come back to do more */
322 lws_callback_on_writable(wsi);
324 * keep a copy of the write type for the overall
325 * action that has provoked generation of these
326 * fragments, so the last guy can use its FIN state.
328 wsi->u.ws.tx_draining_stashed_wp = wp;
329 /* this is definitely not actually the last fragment
330 * because the extension asserted he has more coming
331 * So make sure this intermediate one doesn't go out
334 wp |= LWS_WRITE_NO_FIN;
337 if (eff_buf.token_len && wsi->u.ws.stashed_write_pending) {
338 wsi->u.ws.stashed_write_pending = 0;
339 wp = (wp &0xc0) | (int)wsi->u.ws.stashed_write_type;
344 * an extension did something we need to keep... for example, if
345 * compression extension, it has already updated its state according
346 * to this being issued
348 if ((char *)buf != eff_buf.token) {
350 * ext might eat it, but no have anything to issue yet
351 * in that case we have to follow his lead, but stash and
352 * replace the write type that was lost here the first time.
354 if (len && !eff_buf.token_len) {
355 if (!wsi->u.ws.stashed_write_pending)
356 wsi->u.ws.stashed_write_type = (char)wp & 0x3f;
357 wsi->u.ws.stashed_write_pending = 1;
361 * extension recreated it:
362 * need to buffer this if not all sent
364 wsi->u.ws.clean_buffer = 0;
367 buf = (unsigned char *)eff_buf.token;
368 len = eff_buf.token_len;
370 switch (wsi->ietf_spec_revision) {
374 dropmask = &buf[0 - pre];
375 is_masked_bit = 0x80;
380 n = LWSWSOPC_TEXT_FRAME;
382 case LWS_WRITE_BINARY:
383 n = LWSWSOPC_BINARY_FRAME;
385 case LWS_WRITE_CONTINUATION:
386 n = LWSWSOPC_CONTINUATION;
389 case LWS_WRITE_CLOSE:
399 lwsl_warn("lws_write: unknown write opc / wp\n");
403 if (!(wp & LWS_WRITE_NO_FIN))
409 buf[-pre + 1] = (unsigned char)(len | is_masked_bit);
414 buf[-pre + 1] = 126 | is_masked_bit;
415 buf[-pre + 2] = (unsigned char)(len >> 8);
416 buf[-pre + 3] = (unsigned char)len;
420 buf[-pre + 1] = 127 | is_masked_bit;
422 buf[-pre + 2] = (len >> 56) & 0x7f;
423 buf[-pre + 3] = len >> 48;
424 buf[-pre + 4] = len >> 40;
425 buf[-pre + 5] = len >> 32;
432 buf[-pre + 6] = (unsigned char)(len >> 24);
433 buf[-pre + 7] = (unsigned char)(len >> 16);
434 buf[-pre + 8] = (unsigned char)(len >> 8);
435 buf[-pre + 9] = (unsigned char)len;
441 do_more_inside_frame:
444 * Deal with masking if we are in client -> server direction and
449 if (!wsi->u.ws.inside_frame)
450 if (lws_0405_frame_mask_generate(wsi)) {
451 lwsl_err("frame mask generation failed\n");
456 * in v7, just mask the payload
458 if (dropmask) { /* never set if already inside frame */
459 for (n = 4; n < (int)len + 4; n++)
460 dropmask[n] = dropmask[n] ^ wsi->u.ws.mask[
461 (wsi->u.ws.mask_idx++) & 3];
463 /* copy the frame nonce into place */
464 memcpy(dropmask, wsi->u.ws.mask, 4);
470 case LWS_WRITE_CLOSE:
471 /* lwsl_hexdump(&buf[-pre], len); */
473 case LWS_WRITE_HTTP_FINAL:
474 case LWS_WRITE_HTTP_HEADERS:
478 if (wsi->mode == LWSCM_HTTP2_SERVING) {
479 unsigned char flags = 0;
481 n = LWS_HTTP2_FRAME_TYPE_DATA;
482 if (wp == LWS_WRITE_HTTP_HEADERS) {
483 n = LWS_HTTP2_FRAME_TYPE_HEADERS;
484 flags = LWS_HTTP2_FLAG_END_HEADERS;
485 if (wsi->u.http2.send_END_STREAM)
486 flags |= LWS_HTTP2_FLAG_END_STREAM;
489 if ((wp == LWS_WRITE_HTTP ||
490 wp == LWS_WRITE_HTTP_FINAL) &&
491 wsi->u.http.content_length) {
492 wsi->u.http.content_remain -= len;
493 lwsl_info("%s: content_remain = %lu\n", __func__,
494 wsi->u.http.content_remain);
495 if (!wsi->u.http.content_remain) {
496 lwsl_info("%s: selecting final write mode\n", __func__);
497 wp = LWS_WRITE_HTTP_FINAL;
501 if (wp == LWS_WRITE_HTTP_FINAL && wsi->u.http2.END_STREAM) {
502 lwsl_info("%s: setting END_STREAM\n", __func__);
503 flags |= LWS_HTTP2_FLAG_END_STREAM;
506 return lws_http2_frame_write(wsi, n, flags,
507 wsi->u.http2.my_stream_id, len, buf);
510 return lws_issue_raw(wsi, (unsigned char *)buf - pre, len + pre);
516 * give any active extensions a chance to munge the buffer
517 * before send. We pass in a pointer to an lws_tokens struct
518 * prepared with the default buffer and content length that's in
519 * there. Rather than rewrite the default buffer, extensions
520 * that expect to grow the buffer can adapt .token to
521 * point to their own per-connection buffer in the extension
522 * user allocation. By default with no extensions or no
523 * extension callback handling, just the normal input buffer is
524 * used then so it is efficient.
526 * callback returns 1 in case it wants to spill more buffers
528 * This takes care of holding the buffer if send is incomplete, ie,
529 * if wsi->u.ws.clean_buffer is 0 (meaning an extension meddled with
530 * the buffer). If wsi->u.ws.clean_buffer is 1, it will instead
531 * return to the user code how much OF THE USER BUFFER was consumed.
534 n = lws_issue_raw_ext_access(wsi, buf - pre, len + pre);
535 wsi->u.ws.inside_frame = 1;
539 if (n == (int)len + pre) {
540 /* everything in the buffer was handled (or rebuffered...) */
541 wsi->u.ws.inside_frame = 0;
546 * it is how many bytes of user buffer got sent... may be < orig_len
547 * in which case callback when writable has already been arranged
548 * and user code can call lws_write() again with the rest
555 LWS_VISIBLE int lws_serve_http_file_fragment(struct lws *wsi)
557 struct lws_context *context = wsi->context;
558 struct lws_context_per_thread *pt = &context->pt[(int)wsi->tsi];
559 struct lws_process_html_args args;
560 unsigned long amount, poss;
561 unsigned char *p = pt->serv_buf;
564 // lwsl_notice("%s (trunc len %d)\n", __func__, wsi->trunc_len);
566 while (wsi->http2_substream || !lws_send_pipe_choked(wsi)) {
567 if (wsi->trunc_len) {
568 if (lws_issue_raw(wsi, wsi->trunc_alloc +
570 wsi->trunc_len) < 0) {
571 lwsl_info("%s: closing\n", __func__);
577 if (wsi->u.http.filepos == wsi->u.http.filelen)
580 poss = context->pt_serv_buf_size;
582 if (wsi->sending_chunked) {
583 /* we need to drop the chunk size in here */
585 /* allow for the chunk to grow by 128 in translation */
589 if (lws_plat_file_read(wsi, wsi->u.http.fd, &amount, p, poss) < 0)
590 return -1; /* caller will close */
592 //lwsl_notice("amount %ld\n", amount);
596 lws_set_timeout(wsi, PENDING_TIMEOUT_HTTP_CONTENT,
597 context->timeout_secs);
599 if (wsi->sending_chunked) {
602 args.max_len = poss + 128;
603 args.final = wsi->u.http.filepos + n ==
605 if (user_callback_handle_rxflow(
606 wsi->vhost->protocols[(int)wsi->protocol_interpret_idx].callback, wsi,
607 LWS_CALLBACK_PROCESS_HTML,
608 wsi->user_space, &args, 0) < 0)
611 p = (unsigned char *)args.p;
614 m = lws_write(wsi, p, n,
615 wsi->u.http.filepos == wsi->u.http.filelen ?
616 LWS_WRITE_HTTP_FINAL :
622 wsi->u.http.filepos += amount;
624 /* adjust for what was not sent */
625 if (lws_plat_file_seek_cur(wsi, wsi->u.http.fd,
632 if (!wsi->trunc_len &&
633 wsi->u.http.filepos == wsi->u.http.filelen) {
634 wsi->state = LWSS_HTTP;
635 /* we might be in keepalive, so close it off here */
636 lws_plat_file_close(wsi, wsi->u.http.fd);
637 wsi->u.http.fd = LWS_INVALID_FILE;
639 lwsl_notice("file completed\n");
641 if (wsi->protocol->callback)
642 /* ignore callback returned value */
643 if (user_callback_handle_rxflow(
644 wsi->protocol->callback, wsi,
645 LWS_CALLBACK_HTTP_FILE_COMPLETION,
646 wsi->user_space, NULL, 0) < 0)
649 return 1; /* >0 indicates completed */
653 lws_callback_on_writable(wsi);
655 return 0; /* indicates further processing must be done */
660 lws_ssl_capable_read_no_ssl(struct lws *wsi, unsigned char *buf, int len)
664 n = recv(wsi->sock, (char *)buf, len, 0);
668 lws_restart_ws_ping_pong_timer(wsi);
672 if (LWS_ERRNO == LWS_EAGAIN ||
673 LWS_ERRNO == LWS_EWOULDBLOCK ||
674 LWS_ERRNO == LWS_EINTR)
675 return LWS_SSL_CAPABLE_MORE_SERVICE;
677 lwsl_notice("error on reading from skt : %d\n", LWS_ERRNO);
678 return LWS_SSL_CAPABLE_ERROR;
682 lws_ssl_capable_write_no_ssl(struct lws *wsi, unsigned char *buf, int len)
687 n = send(wsi->sock, (char *)buf, len, MSG_NOSIGNAL);
688 // lwsl_info("%s: sent len %d result %d", __func__, len, n);
692 if (LWS_ERRNO == LWS_EAGAIN ||
693 LWS_ERRNO == LWS_EWOULDBLOCK ||
694 LWS_ERRNO == LWS_EINTR) {
695 if (LWS_ERRNO == LWS_EWOULDBLOCK)
696 lws_set_blocking_send(wsi);
698 return LWS_SSL_CAPABLE_MORE_SERVICE;
708 lwsl_debug("ERROR writing len %d to skt fd %d err %d / errno %d\n", len, wsi->sock, n, LWS_ERRNO);
709 return LWS_SSL_CAPABLE_ERROR;
713 lws_ssl_pending_no_ssl(struct lws *wsi)