2 * libwebsockets - small server side websockets and web server implementation
4 * Copyright (C) 2010-2016 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,
23 #include "private-libwebsockets.h"
26 lws_context_init_server(struct lws_context_creation_info *info,
27 struct lws_vhost *vhost)
30 int n, opt = 1, limit = 1;
32 lws_sockfd_type sockfd;
37 /* set up our external listening socket we serve on */
39 if (info->port == CONTEXT_PORT_NO_LISTEN)
42 vh = vhost->context->vhost_list;
44 if (vh->listen_port == info->port) {
45 if ((!info->iface && !vh->iface) ||
46 (info->iface && vh->iface &&
47 !strcmp(info->iface, vh->iface))) {
48 vhost->listen_port = info->port;
49 vhost->iface = info->iface;
50 lwsl_notice(" using listen skt from vhost %s\n",
59 #if defined(__linux__)
60 limit = vhost->context->count_threads;
63 for (m = 0; m < limit; m++) {
65 if (LWS_IPV6_ENABLED(context))
66 sockfd = socket(AF_INET6, SOCK_STREAM, 0);
69 sockfd = socket(AF_INET, SOCK_STREAM, 0);
73 sockfd = mbed3_create_tcp_stream_socket();
74 if (!lws_sockfd_valid(sockfd)) {
76 lwsl_err("ERROR opening socket\n");
82 * allow us to restart even if old sockets in TIME_WAIT
84 if (setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR,
85 (const void *)&opt, sizeof(opt)) < 0) {
86 compatible_close(sockfd);
89 #if defined(__linux__) && defined(SO_REUSEPORT) && LWS_MAX_SMP > 1
90 if (vhost->context->count_threads > 1)
91 if (setsockopt(sockfd, SOL_SOCKET, SO_REUSEPORT,
92 (const void *)&opt, sizeof(opt)) < 0) {
93 compatible_close(sockfd);
98 lws_plat_set_socket_options(vhost, sockfd);
101 n = lws_socket_bind(vhost->context, sockfd, info->port, info->iface);
106 vhost->listen_port = info->port;
107 vhost->iface = info->iface;
109 wsi = lws_zalloc(sizeof(struct lws));
111 lwsl_err("Out of mem\n");
114 wsi->context = vhost->context;
116 wsi->mode = LWSCM_SERVER_LISTENER;
117 wsi->protocol = vhost->protocols;
122 vhost->context->pt[m].wsi_listening = wsi;
123 if (insert_wsi_socket_into_fds(vhost->context, wsi))
126 vhost->context->count_wsi_allocated++;
127 vhost->lserv_wsi = wsi;
130 listen(wsi->sock, LWS_SOMAXCONN);
131 } /* for each thread able to independently lister */
133 mbed3_tcp_stream_bind(wsi->sock, info->port, wsi);
135 if (!lws_check_opt(info->options, LWS_SERVER_OPTION_EXPLICIT_VHOSTS))
136 lwsl_notice(" Listening on port %d\n", info->port);
141 compatible_close(sockfd);
147 _lws_server_listen_accept_flow_control(struct lws *twsi, int on)
149 struct lws_context_per_thread *pt = &twsi->context->pt[(int)twsi->tsi];
150 struct lws *wsi = pt->wsi_listening;
153 if (!wsi || twsi->context->being_destroyed)
156 lwsl_debug("%s: Thr %d: LISTEN wsi %p: state %d\n",
157 __func__, twsi->tsi, (void *)wsi, on);
160 n = lws_change_pollfd(wsi, 0, LWS_POLLIN);
162 n = lws_change_pollfd(wsi, LWS_POLLIN, 0);
168 lws_select_vhost(struct lws_context *context, int port, const char *servername)
170 struct lws_vhost *vhost = context->vhost_list;
173 if (port == vhost->listen_port &&
174 !strcmp(vhost->name, servername)) {
175 lwsl_info("SNI: Found: %s\n", servername);
178 vhost = vhost->vhost_next;
184 static const char * get_mimetype(const char *file)
186 int n = strlen(file);
191 if (!strcmp(&file[n - 4], ".ico"))
192 return "image/x-icon";
194 if (!strcmp(&file[n - 4], ".gif"))
197 if (!strcmp(&file[n - 3], ".js"))
198 return "text/javascript";
200 if (!strcmp(&file[n - 4], ".png"))
203 if (!strcmp(&file[n - 4], ".jpg"))
206 if (!strcmp(&file[n - 5], ".html"))
209 if (!strcmp(&file[n - 4], ".css"))
212 if (!strcmp(&file[n - 4], ".ttf"))
213 return "application/x-font-ttf";
218 int lws_http_serve(struct lws *wsi, char *uri, const char *origin)
220 const char *mimetype;
224 lwsl_notice("%s: %s %s\n", __func__, uri, origin);
225 snprintf(path, sizeof(path) - 1, "%s/%s", origin, uri);
227 mimetype = get_mimetype(path);
229 lwsl_err("unknown mimetype for %s", path);
230 lws_return_http_status(wsi, HTTP_STATUS_NOT_FOUND, NULL);
234 n = lws_serve_http_file(wsi, path, mimetype, NULL, 0);
236 if (n < 0 || ((n > 0) && lws_http_transaction_completed(wsi)))
237 return -1; /* error or can't reuse connection: close the socket */
243 lws_http_action(struct lws *wsi)
245 struct lws_context_per_thread *pt = &wsi->context->pt[(int)wsi->tsi];
246 enum http_connection_type connection_type;
247 enum http_version request_version;
248 char content_length_str[32];
249 struct lws_http_mount *hm, *hit = NULL;
250 unsigned int n, count = 0;
251 char http_version_str[10];
252 char http_conn_str[20];
253 int http_version_len;
254 char *uri_ptr = NULL;
255 int uri_len = 0, best = 0;
257 static const unsigned char methods[] = {
260 WSI_TOKEN_OPTIONS_URI,
263 WSI_TOKEN_DELETE_URI,
265 WSI_TOKEN_HTTP_COLON_PATH,
269 static const char * const method_names[] = {
270 "GET", "POST", "OPTIONS", "PUT", "PATCH", "DELETE",
277 /* it's not websocket.... shall we accept it as http? */
279 for (n = 0; n < ARRAY_SIZE(methods); n++)
280 if (lws_hdr_total_length(wsi, methods[n]))
283 lwsl_warn("Missing URI in HTTP request\n");
288 lwsl_warn("multiple methods?\n");
292 if (lws_ensure_user_space(wsi))
295 for (n = 0; n < ARRAY_SIZE(methods); n++)
296 if (lws_hdr_total_length(wsi, methods[n])) {
297 uri_ptr = lws_hdr_simple_ptr(wsi, methods[n]);
298 uri_len = lws_hdr_total_length(wsi, methods[n]);
299 lwsl_info("Method: %s request for '%s'\n",
300 method_names[n], uri_ptr);
304 /* we insist on absolute paths */
306 if (uri_ptr[0] != '/') {
307 lws_return_http_status(wsi, HTTP_STATUS_FORBIDDEN, NULL);
312 /* HTTP header had a content length? */
314 wsi->u.http.content_length = 0;
315 if (lws_hdr_total_length(wsi, WSI_TOKEN_POST_URI) ||
316 lws_hdr_total_length(wsi, WSI_TOKEN_PATCH_URI) ||
317 lws_hdr_total_length(wsi, WSI_TOKEN_PUT_URI))
318 wsi->u.http.content_length = 100 * 1024 * 1024;
320 if (lws_hdr_total_length(wsi, WSI_TOKEN_HTTP_CONTENT_LENGTH)) {
321 lws_hdr_copy(wsi, content_length_str,
322 sizeof(content_length_str) - 1,
323 WSI_TOKEN_HTTP_CONTENT_LENGTH);
324 wsi->u.http.content_length = atoi(content_length_str);
327 /* http_version? Default to 1.0, override with token: */
328 request_version = HTTP_VERSION_1_0;
330 /* Works for single digit HTTP versions. : */
331 http_version_len = lws_hdr_total_length(wsi, WSI_TOKEN_HTTP);
332 if (http_version_len > 7) {
333 lws_hdr_copy(wsi, http_version_str,
334 sizeof(http_version_str) - 1, WSI_TOKEN_HTTP);
335 if (http_version_str[5] == '1' && http_version_str[7] == '1')
336 request_version = HTTP_VERSION_1_1;
338 wsi->u.http.request_version = request_version;
340 /* HTTP/1.1 defaults to "keep-alive", 1.0 to "close" */
341 if (request_version == HTTP_VERSION_1_1)
342 connection_type = HTTP_CONNECTION_KEEP_ALIVE;
344 connection_type = HTTP_CONNECTION_CLOSE;
346 /* Override default if http "Connection:" header: */
347 if (lws_hdr_total_length(wsi, WSI_TOKEN_CONNECTION)) {
348 lws_hdr_copy(wsi, http_conn_str, sizeof(http_conn_str) - 1,
349 WSI_TOKEN_CONNECTION);
350 http_conn_str[sizeof(http_conn_str) - 1] = '\0';
351 if (!strcasecmp(http_conn_str, "keep-alive"))
352 connection_type = HTTP_CONNECTION_KEEP_ALIVE;
354 if (!strcasecmp(http_conn_str, "close"))
355 connection_type = HTTP_CONNECTION_CLOSE;
357 wsi->u.http.connection_type = connection_type;
359 n = wsi->protocol->callback(wsi, LWS_CALLBACK_FILTER_HTTP_CONNECTION,
360 wsi->user_space, uri_ptr, uri_len);
362 lwsl_info("LWS_CALLBACK_HTTP closing\n");
367 * if there is content supposed to be coming,
368 * put a timeout on it having arrived
370 lws_set_timeout(wsi, PENDING_TIMEOUT_HTTP_CONTENT,
371 wsi->context->timeout_secs);
372 #ifdef LWS_OPENSSL_SUPPORT
373 if (wsi->redirect_to_https) {
375 * we accepted http:// only so we could redirect to
376 * https://, so issue the redirect. Create the redirection
377 * URI from the host: header and ignore the path part
379 unsigned char *start = pt->serv_buf + LWS_PRE, *p = start,
382 if (!lws_hdr_total_length(wsi, WSI_TOKEN_HOST))
384 if (lws_add_http_header_status(wsi, 301, &p, end))
386 n = sprintf((char *)end, "https://%s/",
387 lws_hdr_simple_ptr(wsi, WSI_TOKEN_HOST));
388 if (lws_add_http_header_by_token(wsi, WSI_TOKEN_HTTP_LOCATION,
391 if (lws_finalize_http_header(wsi, &p, end))
393 n = lws_write(wsi, start, p - start, LWS_WRITE_HTTP_HEADERS);
397 return lws_http_transaction_completed(wsi);
401 /* can we serve it from the mount list? */
403 hm = wsi->vhost->mount_list;
405 if (uri_len >= hm->mountpoint_len &&
406 !strncmp(uri_ptr, hm->mountpoint, hm->mountpoint_len)) {
407 if (hm->mountpoint_len > best) {
408 best = hm->mountpoint_len;
415 char *s = uri_ptr + hit->mountpoint_len;
417 lwsl_err("*** hit %d %d %s\n", hit->mountpoint_len, hit->origin_protocol , hit->origin);
420 * if we have a mountpoint like https://xxx.com/yyy
421 * there is an implied / at the end for our purposes since
422 * we can only mount on a "directory".
424 * But if we just go with that, the browser cannot understand
425 * that he is actually looking down one "directory level", so
426 * even though we give him /yyy/abc.html he acts like the
427 * current directory level is /. So relative urls like "x.png"
428 * wrongly look outside the mountpoint.
430 * Therefore if we didn't come in on a url with an explicit
431 * / at the end, we must redirect to add it so the browser
432 * understands he is one "directory level" down.
434 if (hit->mountpoint_len > 1 || (hit->origin_protocol & 4))
435 if (*s != '/' || (hit->origin_protocol & 4)) {
436 unsigned char *start = pt->serv_buf + LWS_PRE,
437 *p = start, *end = p + 512;
438 static const char *oprot[] = {
439 "http://", "https://"
442 if (!lws_hdr_total_length(wsi, WSI_TOKEN_HOST))
444 if (lws_add_http_header_status(wsi, 301, &p, end))
447 lwsl_err("**** %s", hit->origin);
449 /* > at start indicates deal with by redirect */
450 if (hit->origin_protocol & 4)
451 n = snprintf((char *)end, 256, "%s%s",
452 oprot[hit->origin_protocol & 1],
455 n = snprintf((char *)end, 256,
457 lws_hdr_simple_ptr(wsi, WSI_TOKEN_HOST),
459 if (lws_add_http_header_by_token(wsi,
460 WSI_TOKEN_HTTP_LOCATION,
463 if (lws_finalize_http_header(wsi, &p, end))
465 n = lws_write(wsi, start, p - start,
466 LWS_WRITE_HTTP_HEADERS);
470 return lws_http_transaction_completed(wsi);
473 if (s[0] == '\0' || (s[0] == '/' && s[1] == '\0'))
474 s = (char *)hit->def;
478 n = lws_http_serve(wsi, s, hit->origin);
480 n = wsi->protocol->callback(wsi, LWS_CALLBACK_HTTP,
481 wsi->user_space, uri_ptr, uri_len);
484 lwsl_info("LWS_CALLBACK_HTTP closing\n");
490 * If we're not issuing a file, check for content_length or
491 * HTTP keep-alive. No keep-alive header allocation for
492 * ISSUING_FILE, as this uses HTTP/1.0.
494 * In any case, return 0 and let lws_read decide how to
495 * proceed based on state
497 if (wsi->state != LWSS_HTTP_ISSUING_FILE)
498 /* Prepare to read body if we have a content length: */
499 if (wsi->u.http.content_length > 0)
500 wsi->state = LWSS_HTTP_BODY;
505 /* we're closing, losing some rx is OK */
506 wsi->u.hdr.ah->rxpos = wsi->u.hdr.ah->rxlen;
507 lws_header_table_detach(wsi, 1);
514 lws_handshake_server(struct lws *wsi, unsigned char **buf, size_t len)
516 struct lws_context *context = lws_get_context(wsi);
517 struct lws_context_per_thread *pt = &context->pt[(int)wsi->tsi];
518 struct _lws_header_related hdr;
519 struct allocated_headers *ah;
520 int protocol_len, n, hit;
521 char protocol_list[128];
522 char protocol_name[32];
525 assert(len < 10000000);
526 assert(wsi->u.hdr.ah);
529 wsi->more_rx_waiting = !!len;
531 assert(wsi->mode == LWSCM_HTTP_SERVING);
533 if (lws_parse(wsi, *(*buf)++)) {
534 lwsl_info("lws_parse failed\n");
538 if (wsi->u.hdr.parser_state != WSI_PARSING_COMPLETE)
541 lwsl_parser("%s: lws_parse sees parsing complete\n", __func__);
542 lwsl_debug("%s: wsi->more_rx_waiting=%d\n", __func__,
543 wsi->more_rx_waiting);
545 wsi->mode = LWSCM_PRE_WS_SERVING_ACCEPT;
546 lws_set_timeout(wsi, NO_PENDING_TIMEOUT, 0);
548 /* is this websocket protocol or normal http 1.0? */
550 if (lws_hdr_total_length(wsi, WSI_TOKEN_UPGRADE)) {
551 if (!strcasecmp(lws_hdr_simple_ptr(wsi, WSI_TOKEN_UPGRADE),
553 lwsl_info("Upgrade to ws\n");
557 if (!strcasecmp(lws_hdr_simple_ptr(wsi, WSI_TOKEN_UPGRADE),
559 lwsl_info("Upgrade to h2c-14\n");
563 lwsl_err("Unknown upgrade\n");
564 /* dunno what he wanted to upgrade to */
568 /* no upgrade ack... he remained as HTTP */
570 lwsl_info("No upgrade\n");
575 if (lws_hdr_total_length(wsi, WSI_TOKEN_HOST)) {
576 struct lws_vhost *vhost = lws_select_vhost(
577 context, wsi->vhost->listen_port,
578 lws_hdr_simple_ptr(wsi, WSI_TOKEN_HOST));
584 lws_union_transition(wsi, LWSCM_HTTP_SERVING_ACCEPTED);
585 wsi->state = LWSS_HTTP;
586 wsi->u.http.fd = LWS_INVALID_FILE;
588 /* expose it at the same offset as u.hdr */
590 lwsl_debug("%s: wsi %p: ah %p\n", __func__, (void *)wsi,
591 (void *)wsi->u.hdr.ah);
593 n = lws_http_action(wsi);
599 if (!lws_hdr_total_length(wsi, WSI_TOKEN_HTTP2_SETTINGS)) {
600 lwsl_err("missing http2_settings\n");
604 lwsl_err("h2c upgrade...\n");
606 p = lws_hdr_simple_ptr(wsi, WSI_TOKEN_HTTP2_SETTINGS);
607 /* convert the peer's HTTP-Settings */
608 n = lws_b64_decode_string(p, protocol_list,
609 sizeof(protocol_list));
611 lwsl_parser("HTTP2_SETTINGS too long\n");
615 /* adopt the header info */
619 lws_union_transition(wsi, LWSCM_HTTP2_SERVING);
621 /* http2 union member has http union struct at start */
624 lws_http2_init(&wsi->u.http2.peer_settings);
625 lws_http2_init(&wsi->u.http2.my_settings);
629 lws_http2_interpret_settings_payload(&wsi->u.http2.peer_settings,
630 (unsigned char *)protocol_list, n);
632 strcpy(protocol_list,
633 "HTTP/1.1 101 Switching Protocols\x0d\x0a"
634 "Connection: Upgrade\x0d\x0a"
635 "Upgrade: h2c\x0d\x0a\x0d\x0a");
636 n = lws_issue_raw(wsi, (unsigned char *)protocol_list,
637 strlen(protocol_list));
638 if (n != strlen(protocol_list)) {
639 lwsl_debug("http2 switch: ERROR writing to socket\n");
643 wsi->state = LWSS_HTTP2_AWAIT_CLIENT_PREFACE;
650 lwsl_err("NULL protocol at lws_read\n");
655 * Select the first protocol we support from the list
656 * the client sent us.
658 * Copy it to remove header fragmentation
661 if (lws_hdr_copy(wsi, protocol_list, sizeof(protocol_list) - 1,
662 WSI_TOKEN_PROTOCOL) < 0) {
663 lwsl_err("protocol list too long");
667 protocol_len = lws_hdr_total_length(wsi, WSI_TOKEN_PROTOCOL);
668 protocol_list[protocol_len] = '\0';
674 while (n < sizeof(protocol_name) - 1 && *p && *p !=',')
675 protocol_name[n++] = *p++;
676 protocol_name[n] = '\0';
680 lwsl_info("checking %s\n", protocol_name);
683 while (wsi->vhost->protocols[n].callback) {
684 if (wsi->vhost->protocols[n].name &&
685 !strcmp(wsi->vhost->protocols[n].name,
687 lwsl_info("prot match %d\n", n);
688 wsi->protocol = &wsi->vhost->protocols[n];
697 /* we didn't find a protocol he wanted? */
700 if (lws_hdr_simple_ptr(wsi, WSI_TOKEN_PROTOCOL)) {
701 lwsl_err("No protocol from \"%s\" supported\n",
706 * some clients only have one protocol and
707 * do not sent the protocol list header...
708 * allow it and match to protocol 0
710 lwsl_info("defaulting to prot 0 handler\n");
711 wsi->protocol = &wsi->vhost->protocols[0];
714 /* allocate wsi->user storage */
715 if (lws_ensure_user_space(wsi))
719 * Give the user code a chance to study the request and
720 * have the opportunity to deny it
723 if ((wsi->protocol->callback)(wsi,
724 LWS_CALLBACK_FILTER_PROTOCOL_CONNECTION,
726 lws_hdr_simple_ptr(wsi, WSI_TOKEN_PROTOCOL), 0)) {
727 lwsl_warn("User code denied connection\n");
732 * Perform the handshake according to the protocol version the
736 switch (wsi->ietf_spec_revision) {
738 lwsl_parser("lws_parse calling handshake_04\n");
739 if (handshake_0405(context, wsi)) {
740 lwsl_info("hs0405 has failed the connection\n");
746 lwsl_warn("Unknown client spec version %d\n",
747 wsi->ietf_spec_revision);
751 /* we are upgrading to ws, so http/1.1 and keepalive +
752 * pipelined header considerations about keeping the ah around
753 * no longer apply. However it's common for the first ws
754 * protocol data to have been coalesced with the browser
755 * upgrade request and to already be in the ah rx buffer.
758 lwsl_info("%s: %p: inheriting ah in ws mode (rxpos:%d, rxlen:%d)\n",
759 __func__, wsi, wsi->u.hdr.ah->rxpos,
760 wsi->u.hdr.ah->rxlen);
764 lws_union_transition(wsi, LWSCM_WS_SERVING);
766 * first service is WS mode will notice this, use the RX and
767 * then detach the ah (caution: we are not in u.hdr union
768 * mode any more then... ah_temp member is at start the same
771 * Because rxpos/rxlen shows something in the ah, we will get
772 * service guaranteed next time around the event loop
774 * All union members begin with hdr, so we can use it even
775 * though we transitioned to ws union mode (the ah detach
776 * code uses it anyway).
782 * create the frame buffer for this connection according to the
783 * size mentioned in the protocol definition. If 0 there, use
784 * a big default for compatibility
787 n = wsi->protocol->rx_buffer_size;
789 n = LWS_MAX_SOCKET_IO_BUF;
791 wsi->u.ws.rx_ubuf = lws_malloc(n + 4 /* 0x0000ffff zlib */);
792 if (!wsi->u.ws.rx_ubuf) {
793 lwsl_err("Out of Mem allocating rx buffer %d\n", n);
796 wsi->u.ws.rx_ubuf_alloc = n;
797 lwsl_info("Allocating RX buffer %d\n", n);
799 if (setsockopt(wsi->sock, SOL_SOCKET, SO_SNDBUF,
800 (const char *)&n, sizeof n)) {
801 lwsl_warn("Failed to set SNDBUF to %d", n);
805 lwsl_parser("accepted v%02d connection\n",
806 wsi->ietf_spec_revision);
809 } /* while all chars are handled */
814 /* drop the header info */
815 /* we're closing, losing some rx is OK */
816 wsi->u.hdr.ah->rxpos = wsi->u.hdr.ah->rxlen;
817 lws_header_table_detach(wsi, 1);
823 lws_get_idlest_tsi(struct lws_context *context)
825 unsigned int lowest = ~0;
828 for (; n < context->count_threads; n++) {
829 if ((unsigned int)context->pt[n].fds_count !=
830 context->fd_limit_per_thread - 1 &&
831 (unsigned int)context->pt[n].fds_count < lowest) {
832 lowest = context->pt[n].fds_count;
841 lws_create_new_server_wsi(struct lws_vhost *vhost)
844 int n = lws_get_idlest_tsi(vhost->context);
847 lwsl_err("no space for new conn\n");
851 new_wsi = lws_zalloc(sizeof(struct lws));
852 if (new_wsi == NULL) {
853 lwsl_err("Out of memory for new connection\n");
858 lwsl_info("Accepted %p to tsi %d\n", new_wsi, new_wsi->tsi);
860 new_wsi->vhost = vhost;
861 new_wsi->context = vhost->context;
862 new_wsi->pending_timeout = NO_PENDING_TIMEOUT;
863 new_wsi->rxflow_change_to = LWS_RXFLOW_ALLOW;
865 /* intialize the instance struct */
867 new_wsi->state = LWSS_HTTP;
868 new_wsi->mode = LWSCM_HTTP_SERVING;
869 new_wsi->hdr_parsing_completed = 0;
871 #ifdef LWS_OPENSSL_SUPPORT
872 new_wsi->use_ssl = LWS_SSL_ENABLED(vhost);
876 * these can only be set once the protocol is known
877 * we set an unestablished connection's protocol pointer
878 * to the start of the supported list, so it can look
879 * for matching ones during the handshake
881 new_wsi->protocol = vhost->protocols;
882 new_wsi->user_space = NULL;
883 new_wsi->ietf_spec_revision = 0;
884 new_wsi->sock = LWS_SOCK_INVALID;
885 vhost->context->count_wsi_allocated++;
888 * outermost create notification for wsi
889 * no user_space because no protocol selection
891 vhost->protocols[0].callback(new_wsi, LWS_CALLBACK_WSI_CREATE,
898 * lws_http_transaction_completed() - wait for new http transaction or close
899 * @wsi: websocket connection
901 * Returns 1 if the HTTP connection must close now
902 * Returns 0 and resets connection to wait for new HTTP header /
903 * transaction if possible
906 LWS_VISIBLE int LWS_WARN_UNUSED_RESULT
907 lws_http_transaction_completed(struct lws *wsi)
909 lwsl_debug("%s: wsi %p\n", __func__, wsi);
910 /* if we can't go back to accept new headers, drop the connection */
911 if (wsi->u.http.connection_type != HTTP_CONNECTION_KEEP_ALIVE) {
912 lwsl_info("%s: %p: close connection\n", __func__, wsi);
916 /* otherwise set ourselves up ready to go again */
917 wsi->state = LWSS_HTTP;
918 wsi->mode = LWSCM_HTTP_SERVING;
919 wsi->u.http.content_length = 0;
920 wsi->hdr_parsing_completed = 0;
922 /* He asked for it to stay alive indefinitely */
923 lws_set_timeout(wsi, NO_PENDING_TIMEOUT, 0);
926 * We already know we are on http1.1 / keepalive and the next thing
927 * coming will be another header set.
929 * If there is no pending rx and we still have the ah, drop it and
930 * reacquire a new ah when the new headers start to arrive. (Otherwise
931 * we needlessly hog an ah indefinitely.)
933 * However if there is pending rx and we know from the keepalive state
934 * that is already at least the start of another header set, simply
935 * reset the existing header table and keep it.
938 lwsl_info("%s: wsi->more_rx_waiting=%d\n", __func__,
939 wsi->more_rx_waiting);
941 if (!wsi->more_rx_waiting) {
942 wsi->u.hdr.ah->rxpos = wsi->u.hdr.ah->rxlen;
943 lws_header_table_detach(wsi, 1);
945 lws_header_table_reset(wsi, 1);
948 /* If we're (re)starting on headers, need other implied init */
949 wsi->u.hdr.ues = URIES_IDLE;
951 lwsl_info("%s: %p: keep-alive await new transaction\n", __func__, wsi);
957 lws_adopt_socket_vhost(struct lws_vhost *vh, lws_sockfd_type accept_fd)
959 struct lws_context *context = vh->context;
960 struct lws *new_wsi = lws_create_new_server_wsi(vh);
963 compatible_close(accept_fd);
967 lwsl_info("%s: new wsi %p, sockfd %d\n", __func__, new_wsi, accept_fd);
969 new_wsi->sock = accept_fd;
971 /* the transport is accepted... give him time to negotiate */
972 lws_set_timeout(new_wsi, PENDING_TIMEOUT_ESTABLISH_WITH_SERVER,
973 context->timeout_secs);
976 mbed3_tcp_stream_accept(accept_fd, new_wsi);
980 * A new connection was accepted. Give the user a chance to
981 * set properties of the newly created wsi. There's no protocol
982 * selected yet so we issue this to protocols[0]
984 if ((context->vhost_list->protocols[0].callback)(new_wsi,
985 LWS_CALLBACK_SERVER_NEW_CLIENT_INSTANTIATED, NULL, NULL, 0)) {
986 compatible_close(new_wsi->sock);
991 lws_libev_accept(new_wsi, new_wsi->sock);
992 lws_libuv_accept(new_wsi, new_wsi->sock);
994 if (!LWS_SSL_ENABLED(new_wsi->vhost)) {
995 if (insert_wsi_socket_into_fds(context, new_wsi))
998 new_wsi->mode = LWSCM_SSL_INIT;
999 if (lws_server_socket_service_ssl(new_wsi, accept_fd))
1006 lwsl_err("%s: fail\n", __func__);
1007 lws_close_free_wsi(new_wsi, LWS_CLOSE_STATUS_NOSTATUS);
1013 * lws_adopt_socket() - adopt foreign socket as if listen socket accepted it
1014 * @context: lws context
1015 * @accept_fd: fd of already-accepted socket to adopt
1017 * Either returns new wsi bound to accept_fd, or closes accept_fd and
1018 * returns NULL, having cleaned up any new wsi pieces.
1020 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
1021 * to ws or just serve http.
1024 LWS_VISIBLE struct lws *
1025 lws_adopt_socket(struct lws_context *context, lws_sockfd_type accept_fd)
1027 return lws_adopt_socket_vhost(context->vhost_list, accept_fd);
1032 * lws_adopt_socket_readbuf() - adopt foreign socket and first rx as if listen socket accepted it
1033 * @context: lws context
1034 * @accept_fd: fd of already-accepted socket to adopt
1035 * @readbuf: NULL or pointer to data that must be drained before reading from
1037 * @len: The length of the data held at @readbuf
1039 * Either returns new wsi bound to accept_fd, or closes accept_fd and
1040 * returns NULL, having cleaned up any new wsi pieces.
1042 * LWS adopts the socket in http serving mode, it's ready to accept an upgrade
1043 * to ws or just serve http.
1045 * If your external code did not already read from the socket, you can use
1046 * lws_adopt_socket() instead.
1048 * This api is guaranteed to use the data at @readbuf first, before reading from
1051 * @readbuf is limited to the size of the ah rx buf, currently 2048 bytes.
1054 LWS_VISIBLE LWS_EXTERN struct lws *
1055 lws_adopt_socket_readbuf(struct lws_context *context, lws_sockfd_type accept_fd,
1056 const char *readbuf, size_t len)
1058 struct lws *wsi = lws_adopt_socket(context, accept_fd);
1059 struct lws_context_per_thread *pt;
1060 struct allocated_headers *ah;
1061 struct lws_pollfd *pfd;
1069 if (len > sizeof(ah->rx)) {
1070 lwsl_err("%s: rx in too big\n", __func__);
1074 * we can't process the initial read data until we can attach an ah.
1076 * if one is available, get it and place the data in his ah rxbuf...
1077 * wsi with ah that have pending rxbuf get auto-POLLIN service.
1079 * no autoservice because we didn't get a chance to attach the
1080 * readbuf data to wsi or ah yet, and we will do it next if we get
1083 if (!lws_header_table_attach(wsi, 0)) {
1085 memcpy(ah->rx, readbuf, len);
1089 lwsl_notice("%s: calling service on readbuf ah\n", __func__);
1090 pt = &context->pt[(int)wsi->tsi];
1092 /* unlike a normal connect, we have the headers already
1093 * (or the first part of them anyway).
1094 * libuv won't come back and service us without a network
1095 * event, so we need to do the header service right here.
1097 pfd = &pt->fds[wsi->position_in_fds_table];
1098 pfd->revents |= LWS_POLLIN;
1099 lwsl_err("%s: calling service\n", __func__);
1100 if (lws_service_fd_tsi(context, pfd, wsi->tsi))
1101 /* service closed us */
1106 lwsl_err("%s: deferring handling ah\n", __func__);
1108 * hum if no ah came, we are on the wait list and must defer
1109 * dealing with this until the ah arrives.
1111 * later successful lws_header_table_attach() will apply the
1112 * below to the rx buffer (via lws_header_table_reset()).
1114 wsi->u.hdr.preamble_rx = lws_malloc(len);
1115 memcpy(wsi->u.hdr.preamble_rx, readbuf, len);
1116 wsi->u.hdr.preamble_rx_len = len;
1121 lws_close_free_wsi(wsi, LWS_CLOSE_STATUS_NOSTATUS);
1127 lws_server_socket_service(struct lws_context *context, struct lws *wsi,
1128 struct lws_pollfd *pollfd)
1130 struct lws_context_per_thread *pt = &context->pt[(int)wsi->tsi];
1131 lws_sockfd_type accept_fd = LWS_SOCK_INVALID;
1132 struct allocated_headers *ah;
1134 struct sockaddr_in cli_addr;
1139 switch (wsi->mode) {
1141 case LWSCM_HTTP_SERVING:
1142 case LWSCM_HTTP_SERVING_ACCEPTED:
1143 case LWSCM_HTTP2_SERVING:
1145 /* handle http headers coming in */
1147 /* pending truncated sends have uber priority */
1149 if (wsi->trunc_len) {
1150 if (!(pollfd->revents & LWS_POLLOUT))
1153 if (lws_issue_raw(wsi, wsi->trunc_alloc +
1155 wsi->trunc_len) < 0)
1158 * we can't afford to allow input processing to send
1159 * something new, so spin around he event loop until
1160 * he doesn't have any partials
1165 /* any incoming data ready? */
1167 if (!(pollfd->revents & pollfd->events & LWS_POLLIN))
1170 /* these states imply we MUST have an ah attached */
1172 if (wsi->state == LWSS_HTTP ||
1173 wsi->state == LWSS_HTTP_ISSUING_FILE ||
1174 wsi->state == LWSS_HTTP_HEADERS) {
1176 /* no autoservice beacuse we will do it next */
1177 if (lws_header_table_attach(wsi, 0))
1182 lwsl_debug("%s: %p: rxpos:%d rxlen:%d\n", __func__, wsi,
1183 ah->rxpos, ah->rxlen);
1185 /* if nothing in ah rx buffer, get some fresh rx */
1186 if (ah->rxpos == ah->rxlen) {
1187 ah->rxlen = lws_ssl_capable_read(wsi, ah->rx,
1190 lwsl_debug("%s: wsi %p, ah->rxlen = %d\r\n",
1191 __func__, wsi, ah->rxlen);
1192 switch (ah->rxlen) {
1194 lwsl_info("%s: read 0 len\n", __func__);
1195 /* lwsl_info(" state=%d\n", wsi->state); */
1196 // if (!wsi->hdr_parsing_completed)
1197 // lws_header_table_detach(wsi);
1199 case LWS_SSL_CAPABLE_ERROR:
1201 case LWS_SSL_CAPABLE_MORE_SERVICE:
1202 ah->rxlen = ah->rxpos = 0;
1206 assert(ah->rxpos != ah->rxlen && ah->rxlen);
1207 /* just ignore incoming if waiting for close */
1208 if (wsi->state != LWSS_FLUSHING_STORED_SEND_BEFORE_CLOSE) {
1209 n = lws_read(wsi, ah->rx + ah->rxpos,
1210 ah->rxlen - ah->rxpos);
1211 if (n < 0) /* we closed wsi */
1213 if (wsi->u.hdr.ah) {
1214 if ( wsi->u.hdr.ah->rxlen)
1215 wsi->u.hdr.ah->rxpos += n;
1217 if (wsi->u.hdr.ah->rxpos == wsi->u.hdr.ah->rxlen &&
1218 (wsi->mode != LWSCM_HTTP_SERVING &&
1219 wsi->mode != LWSCM_HTTP_SERVING_ACCEPTED &&
1220 wsi->mode != LWSCM_HTTP2_SERVING))
1221 lws_header_table_detach(wsi, 1);
1229 len = lws_ssl_capable_read(wsi, pt->serv_buf,
1230 LWS_MAX_SOCKET_IO_BUF);
1231 lwsl_debug("%s: wsi %p read %d\r\n", __func__, wsi, len);
1234 lwsl_info("%s: read 0 len\n", __func__);
1235 /* lwsl_info(" state=%d\n", wsi->state); */
1236 // if (!wsi->hdr_parsing_completed)
1237 // lws_header_table_detach(wsi);
1239 case LWS_SSL_CAPABLE_ERROR:
1241 case LWS_SSL_CAPABLE_MORE_SERVICE:
1245 /* just ignore incoming if waiting for close */
1246 if (wsi->state != LWSS_FLUSHING_STORED_SEND_BEFORE_CLOSE) {
1248 * hm this may want to send
1249 * (via HTTP callback for example)
1251 n = lws_read(wsi, pt->serv_buf, len);
1252 if (n < 0) /* we closed wsi */
1254 /* hum he may have used up the
1255 * writability above */
1260 /* this handles POLLOUT for http serving fragments */
1262 if (!(pollfd->revents & LWS_POLLOUT))
1266 if (lws_change_pollfd(wsi, LWS_POLLOUT, 0)) {
1267 lwsl_notice("%s a\n", __func__);
1271 if (!wsi->hdr_parsing_completed)
1274 if (wsi->state != LWSS_HTTP_ISSUING_FILE) {
1275 n = user_callback_handle_rxflow(wsi->protocol->callback,
1276 wsi, LWS_CALLBACK_HTTP_WRITEABLE,
1277 wsi->user_space, NULL, 0);
1279 lwsl_info("writeable_fail\n");
1285 /* >0 == completion, <0 == error */
1286 n = lws_serve_http_file_fragment(wsi);
1287 if (n < 0 || (n > 0 && lws_http_transaction_completed(wsi))) {
1288 lwsl_info("completed\n");
1293 case LWSCM_SERVER_LISTENER:
1296 /* pollin means a client has connected to us then */
1299 if (!(pollfd->revents & LWS_POLLIN) || !(pollfd->events & LWS_POLLIN))
1302 /* listen socket got an unencrypted connection... */
1304 clilen = sizeof(cli_addr);
1305 lws_latency_pre(context, wsi);
1306 accept_fd = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
1308 lws_latency(context, wsi, "listener accept", accept_fd,
1310 if (accept_fd < 0) {
1311 if (LWS_ERRNO == LWS_EAGAIN ||
1312 LWS_ERRNO == LWS_EWOULDBLOCK) {
1313 lwsl_err("accept asks to try again\n");
1316 lwsl_err("ERROR on accept: %s\n", strerror(LWS_ERRNO));
1320 lws_plat_set_socket_options(wsi->vhost, accept_fd);
1322 lwsl_debug("accepted new conn port %u on fd=%d\n",
1323 ntohs(cli_addr.sin_port), accept_fd);
1326 /* not very beautiful... */
1327 accept_fd = (lws_sockfd_type)pollfd;
1330 * look at who we connected to and give user code a chance
1331 * to reject based on client IP. There's no protocol selected
1332 * yet so we issue this to protocols[0]
1334 if ((wsi->vhost->protocols[0].callback)(wsi,
1335 LWS_CALLBACK_FILTER_NETWORK_CONNECTION,
1336 NULL, (void *)(long)accept_fd, 0)) {
1337 lwsl_debug("Callback denied network connection\n");
1338 compatible_close(accept_fd);
1342 if (!lws_adopt_socket_vhost(wsi->vhost, accept_fd))
1343 /* already closed cleanly as necessary */
1347 } while (pt->fds_count < context->fd_limit_per_thread - 1 &&
1348 lws_poll_listen_fd(&pt->fds[wsi->position_in_fds_table]) > 0);
1356 if (!lws_server_socket_service_ssl(wsi, accept_fd))
1360 lws_close_free_wsi(wsi, LWS_CLOSE_STATUS_NOSTATUS);
1366 * lws_serve_http_file() - Send a file back to the client using http
1367 * @wsi: Websocket instance (available from user callback)
1368 * @file: The file to issue over http
1369 * @content_type: The http content type, eg, text/html
1370 * @other_headers: NULL or pointer to header string
1371 * @other_headers_len: length of the other headers if non-NULL
1373 * This function is intended to be called from the callback in response
1374 * to http requests from the client. It allows the callback to issue
1375 * local files down the http link in a single step.
1377 * Returning <0 indicates error and the wsi should be closed. Returning
1378 * >0 indicates the file was completely sent and
1379 * lws_http_transaction_completed() called on the wsi (and close if != 0)
1380 * ==0 indicates the file transfer is started and needs more service later,
1381 * the wsi should be left alone.
1385 lws_serve_http_file(struct lws *wsi, const char *file, const char *content_type,
1386 const char *other_headers, int other_headers_len)
1388 struct lws_context *context = lws_get_context(wsi);
1389 struct lws_context_per_thread *pt = &context->pt[(int)wsi->tsi];
1390 unsigned char *response = pt->serv_buf + LWS_PRE;
1391 unsigned char *p = response;
1392 unsigned char *end = p + LWS_MAX_SOCKET_IO_BUF - LWS_PRE;
1395 wsi->u.http.fd = lws_plat_file_open(wsi, file, &wsi->u.http.filelen,
1398 if (wsi->u.http.fd == LWS_INVALID_FILE) {
1399 lwsl_err("Unable to open '%s'\n", file);
1400 lws_return_http_status(wsi, HTTP_STATUS_NOT_FOUND, NULL);
1405 if (lws_add_http_header_status(wsi, 200, &p, end))
1407 if (lws_add_http_header_by_token(wsi, WSI_TOKEN_HTTP_SERVER,
1408 (unsigned char *)"libwebsockets", 13,
1411 if (lws_add_http_header_by_token(wsi, WSI_TOKEN_HTTP_CONTENT_TYPE,
1412 (unsigned char *)content_type,
1413 strlen(content_type), &p, end))
1415 if (lws_add_http_header_content_length(wsi, wsi->u.http.filelen, &p, end))
1418 if (other_headers) {
1419 if ((end - p) < other_headers_len)
1421 memcpy(p, other_headers, other_headers_len);
1422 p += other_headers_len;
1425 if (lws_finalize_http_header(wsi, &p, end))
1428 ret = lws_write(wsi, response, p - response, LWS_WRITE_HTTP_HEADERS);
1429 if (ret != (p - response)) {
1430 lwsl_err("_write returned %d from %d\n", ret, (p - response));
1434 wsi->u.http.filepos = 0;
1435 wsi->state = LWSS_HTTP_ISSUING_FILE;
1437 return lws_serve_http_file_fragment(wsi);
1441 lws_interpret_incoming_packet(struct lws *wsi, unsigned char **buf, size_t len)
1445 lwsl_parser("%s: received %d byte packet\n", __func__, (int)len);
1447 lwsl_hexdump(*buf, len);
1450 /* let the rx protocol state machine have as much as it needs */
1454 * we were accepting input but now we stopped doing so
1456 if (!(wsi->rxflow_change_to & LWS_RXFLOW_ALLOW)) {
1457 lws_rxflow_cache(wsi, *buf, 0, len);
1458 lwsl_parser("%s: cached %d\n", __func__, len);
1462 if (wsi->u.ws.rx_draining_ext) {
1463 m = lws_rx_sm(wsi, 0);
1469 /* account for what we're using in rxflow buffer */
1470 if (wsi->rxflow_buffer)
1473 /* consume payload bytes efficiently */
1474 if (wsi->lws_rx_parse_state ==
1475 LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED)
1476 lws_payload_until_length_exhausted(wsi, buf, &len);
1478 /* process the byte */
1479 m = lws_rx_sm(wsi, *(*buf)++);
1485 lwsl_parser("%s: exit with %d unused\n", __func__, (int)len);
1491 lws_server_get_canonical_hostname(struct lws_context *context,
1492 struct lws_context_creation_info *info)
1494 if (lws_check_opt(info->options, LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME))
1497 /* find canonical hostname */
1498 gethostname((char *)context->canonical_hostname,
1499 sizeof(context->canonical_hostname) - 1);
1501 lwsl_notice(" canonical_hostname = %s\n", context->canonical_hostname);