2 * libwebsockets - small server side websockets and web server implementation
4 * Copyright (C) 2010-2014 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"
24 int log_level = LLL_ERR | LLL_WARN | LLL_NOTICE;
25 static void (*lwsl_emit)(int level, const char *line) = lwsl_emit_stderr;
27 static const char * const log_level_names[] = {
41 lws_free_wsi(struct libwebsocket *wsi)
46 /* Protocol user data may be allocated either internally by lws
47 * or by specified the user. Important we don't free external user data */
48 if (wsi->protocol && wsi->protocol->per_session_data_size
49 && wsi->user_space && !wsi->user_space_externally_allocated) {
50 lws_free(wsi->user_space);
53 lws_free2(wsi->rxflow_buffer);
54 lws_free2(wsi->truncated_send_malloc);
56 // TODO: Probably should handle the union structs in wsi->u here depending
57 // on connection mode as well. Too spaghetti for me to follow however...
59 lws_free_header_table(wsi);
64 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
65 struct libwebsocket *wsi, enum lws_close_status reason)
69 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 2 +
70 LWS_SEND_BUFFER_POST_PADDING];
71 struct lws_tokens eff_buf;
76 old_state = wsi->state;
78 if (wsi->socket_is_permanently_unusable ||
79 reason == LWS_CLOSE_STATUS_NOSTATUS_CONTEXT_DESTROY)
80 goto just_kill_connection;
83 case WSI_STATE_DEAD_SOCKET:
86 /* we tried the polite way... */
87 case WSI_STATE_AWAITING_CLOSE_ACK:
88 goto just_kill_connection;
90 case WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE:
91 if (wsi->truncated_send_len) {
92 libwebsocket_callback_on_writable(context, wsi);
95 lwsl_info("wsi %p completed WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE\n", wsi);
96 goto just_kill_connection;
98 if (wsi->truncated_send_len) {
99 lwsl_info("wsi %p entering WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE\n", wsi);
100 wsi->state = WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE;
101 libwebsocket_set_timeout(wsi, PENDING_FLUSH_STORED_SEND_BEFORE_CLOSE, 5);
107 wsi->u.ws.close_reason = reason;
109 if (wsi->mode == LWS_CONNMODE_WS_CLIENT_WAITING_CONNECT ||
110 wsi->mode == LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE) {
112 context->protocols[0].callback(context, wsi,
113 LWS_CALLBACK_CLIENT_CONNECTION_ERROR, wsi->user_space, NULL, 0);
115 goto just_kill_connection;
118 if (wsi->mode == LWS_CONNMODE_HTTP_SERVING)
119 context->protocols[0].callback(context, wsi,
120 LWS_CALLBACK_CLOSED_HTTP, wsi->user_space, NULL, 0);
122 if (wsi->mode == LWS_CONNMODE_HTTP_SERVING_ACCEPTED) {
123 if (wsi->u.http.fd != LWS_INVALID_FILE) {
124 // TODO: If we're just closing with LWS_CLOSE_STATUS_NOSTATUS_CONTEXT_DESTROY this file descriptor might leak?
125 lwsl_debug("closing http file\n");
126 compatible_file_close(wsi->u.http.fd);
127 wsi->u.http.fd = LWS_INVALID_FILE;
128 context->protocols[0].callback(context, wsi,
129 LWS_CALLBACK_CLOSED_HTTP, wsi->user_space, NULL, 0);
134 * are his extensions okay with him closing? Eg he might be a mux
135 * parent and just his ch1 aspect is closing?
138 if (lws_ext_callback_for_each_active(wsi,
139 LWS_EXT_CALLBACK_CHECK_OK_TO_REALLY_CLOSE, NULL, 0) > 0) {
140 lwsl_ext("extension vetoed close\n");
145 * flush any tx pending from extensions, since we may send close packet
146 * if there are problems with send, just nuke the connection
151 eff_buf.token = NULL;
152 eff_buf.token_len = 0;
154 /* show every extension the new incoming data */
156 m = lws_ext_callback_for_each_active(wsi,
157 LWS_EXT_CALLBACK_FLUSH_PENDING_TX, &eff_buf, 0);
159 lwsl_ext("Extension reports fatal error\n");
160 goto just_kill_connection;
164 * at least one extension told us he has more
165 * to spill, so we will go around again after
169 /* assuming they left us something to send, send it */
171 if (eff_buf.token_len)
172 if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
173 eff_buf.token_len) != eff_buf.token_len) {
174 lwsl_debug("close: ext spill failed\n");
175 goto just_kill_connection;
180 * signal we are closing, libwebsocket_write will
181 * add any necessary version-specific stuff. If the write fails,
182 * no worries we are closing anyway. If we didn't initiate this
183 * close, then our state has been changed to
184 * WSI_STATE_RETURNED_CLOSE_ALREADY and we will skip this.
186 * Likewise if it's a second call to close this connection after we
187 * sent the close indication to the peer already, we are in state
188 * WSI_STATE_AWAITING_CLOSE_ACK and will skip doing this a second time.
191 if (old_state == WSI_STATE_ESTABLISHED &&
192 reason != LWS_CLOSE_STATUS_NOSTATUS &&
193 reason != LWS_CLOSE_STATUS_NOSTATUS_CONTEXT_DESTROY) {
195 lwsl_debug("sending close indication...\n");
197 /* make valgrind happy */
198 memset(buf, 0, sizeof(buf));
199 n = libwebsocket_write(wsi,
200 &buf[LWS_SEND_BUFFER_PRE_PADDING + 2],
204 * we have sent a nice protocol level indication we
205 * now wish to close, we should not send anything more
208 wsi->state = WSI_STATE_AWAITING_CLOSE_ACK;
211 * ...and we should wait for a reply for a bit
215 libwebsocket_set_timeout(wsi,
216 PENDING_TIMEOUT_CLOSE_ACK, 1);
218 lwsl_debug("sent close indication, awaiting ack\n");
223 lwsl_info("close: sending close packet failed, hanging up\n");
225 /* else, the send failed and we should just hang up */
228 just_kill_connection:
230 lwsl_debug("close: just_kill_connection\n");
233 * we won't be servicing or receiving anything further from this guy
234 * delete socket from the internal poll list if still present
237 lws_ssl_remove_wsi_from_buffered_list(context, wsi);
239 // checking return redundant since we anyway close
240 remove_wsi_socket_from_fds(context, wsi);
242 wsi->state = WSI_STATE_DEAD_SOCKET;
244 lws_free2(wsi->rxflow_buffer);
245 lws_free_header_table(wsi);
247 if ((old_state == WSI_STATE_ESTABLISHED ||
248 wsi->mode == LWS_CONNMODE_WS_SERVING ||
249 wsi->mode == LWS_CONNMODE_WS_CLIENT)) {
251 lws_free2(wsi->u.ws.rx_user_buffer);
253 if (wsi->truncated_send_malloc) {
254 /* not going to be completed... nuke it */
255 lws_free2(wsi->truncated_send_malloc);
256 wsi->truncated_send_len = 0;
258 if (wsi->u.ws.ping_payload_buf) {
259 lws_free2(wsi->u.ws.ping_payload_buf);
260 wsi->u.ws.ping_payload_alloc = 0;
261 wsi->u.ws.ping_payload_len = 0;
262 wsi->u.ws.ping_pending_flag = 0;
266 /* tell the user it's all over for this guy */
268 if (wsi->protocol && wsi->protocol->callback &&
269 ((old_state == WSI_STATE_ESTABLISHED) ||
270 (old_state == WSI_STATE_RETURNED_CLOSE_ALREADY) ||
271 (old_state == WSI_STATE_AWAITING_CLOSE_ACK) ||
272 (old_state == WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE))) {
273 lwsl_debug("calling back CLOSED\n");
274 wsi->protocol->callback(context, wsi, LWS_CALLBACK_CLOSED,
275 wsi->user_space, NULL, 0);
276 } else if (wsi->mode == LWS_CONNMODE_HTTP_SERVING_ACCEPTED) {
277 lwsl_debug("calling back CLOSED_HTTP\n");
278 context->protocols[0].callback(context, wsi,
279 LWS_CALLBACK_CLOSED_HTTP, wsi->user_space, NULL, 0 );
280 } else if (wsi->mode == LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY ||
281 wsi->mode == LWS_CONNMODE_WS_CLIENT_WAITING_CONNECT) {
282 lwsl_debug("Connection closed before server reply\n");
283 context->protocols[0].callback(context, wsi,
284 LWS_CALLBACK_CLIENT_CONNECTION_ERROR,
285 wsi->user_space, NULL, 0 );
287 lwsl_debug("not calling back closed mode=%d state=%d\n",
288 wsi->mode, old_state);
290 /* deallocate any active extension contexts */
292 if (lws_ext_callback_for_each_active(wsi, LWS_EXT_CALLBACK_DESTROY, NULL, 0) < 0)
293 lwsl_warn("extension destruction failed\n");
294 #ifndef LWS_NO_EXTENSIONS
295 for (n = 0; n < wsi->count_active_extensions; n++)
296 lws_free(wsi->active_extensions_user[n]);
299 * inform all extensions in case they tracked this guy out of band
300 * even though not active on him specifically
302 if (lws_ext_callback_for_each_extension_type(context, wsi,
303 LWS_EXT_CALLBACK_DESTROY_ANY_WSI_CLOSING, NULL, 0) < 0)
304 lwsl_warn("ext destroy wsi failed\n");
306 /* lwsl_info("closing fd=%d\n", wsi->sock); */
308 if (!lws_ssl_close(wsi) && wsi->sock >= 0) {
309 n = shutdown(wsi->sock, SHUT_RDWR);
311 lwsl_debug("closing: shutdown ret %d\n", LWS_ERRNO);
313 n = compatible_close(wsi->sock);
315 lwsl_debug("closing: close ret %d\n", LWS_ERRNO);
318 /* outermost destroy notification for wsi (user_space still intact) */
319 context->protocols[0].callback(context, wsi,
320 LWS_CALLBACK_WSI_DESTROY, wsi->user_space, NULL, 0);
326 libwebsockets_get_addresses(struct libwebsocket_context *context,
327 void *ads, char *name, int name_len,
328 char *rip, int rip_len)
330 struct addrinfo ai, *res;
337 if (LWS_IPV6_ENABLED(context)) {
338 if (!lws_plat_inet_ntop(AF_INET6, &((struct sockaddr_in6 *)ads)->sin6_addr, rip, rip_len)) {
339 lwsl_err("inet_ntop", strerror(LWS_ERRNO));
343 // Strip off the IPv4 to IPv6 header if one exists
344 if (strncmp(rip, "::ffff:", 7) == 0)
345 memmove(rip, rip + 7, strlen(rip) - 6);
347 getnameinfo((struct sockaddr *)ads,
348 sizeof(struct sockaddr_in6), name,
349 name_len, NULL, 0, 0);
355 memset(&ai, 0, sizeof ai);
356 ai.ai_family = PF_UNSPEC;
357 ai.ai_socktype = SOCK_STREAM;
358 ai.ai_flags = AI_CANONNAME;
360 if (getnameinfo((struct sockaddr *)ads,
361 sizeof(struct sockaddr_in),
362 name, name_len, NULL, 0, 0))
368 if (getaddrinfo(name, NULL, &ai, &res))
372 switch (res->ai_family) {
374 p = &((struct sockaddr_in *)res->ai_addr)->sin_addr;
385 lws_plat_inet_ntop(AF_INET, p, rip, rip_len);
391 * libwebsockets_get_peer_addresses() - Get client address information
392 * @context: Libwebsockets context
393 * @wsi: Local struct libwebsocket associated with
394 * @fd: Connection socket descriptor
395 * @name: Buffer to take client address name
396 * @name_len: Length of client address name buffer
397 * @rip: Buffer to take client address IP dotted quad
398 * @rip_len: Length of client address IP buffer
400 * This function fills in @name and @rip with the name and IP of
401 * the client connected with socket descriptor @fd. Names may be
402 * truncated if there is not enough room. If either cannot be
403 * determined, they will be returned as valid zero-length strings.
407 libwebsockets_get_peer_addresses(struct libwebsocket_context *context,
408 struct libwebsocket *wsi, int fd, char *name, int name_len,
409 char *rip, int rip_len)
413 struct sockaddr_in6 sin6;
415 struct sockaddr_in sin4;
422 lws_latency_pre(context, wsi);
425 if (LWS_IPV6_ENABLED(context)) {
435 if (getpeername(fd, p, &len) < 0) {
436 lwsl_warn("getpeername: %s\n", strerror(LWS_ERRNO));
440 ret = libwebsockets_get_addresses(context, p, name, name_len, rip, rip_len);
443 lws_latency(context, wsi, "libwebsockets_get_peer_addresses", ret, 1);
447 * libwebsocket_context_user() - get the user data associated with the context
448 * @context: Websocket context
450 * This returns the optional user allocation that can be attached to
451 * the context the sockets live in at context_create time. It's a way
452 * to let all sockets serviced in the same context share data without
453 * using globals statics in the user code.
456 libwebsocket_context_user(struct libwebsocket_context *context)
458 return context->user_space;
463 * libwebsocket_callback_all_protocol() - Callback all connections using
464 * the given protocol with the given reason
466 * @protocol: Protocol whose connections will get callbacks
467 * @reason: Callback reason index
471 libwebsocket_callback_all_protocol(
472 const struct libwebsocket_protocols *protocol, int reason)
474 struct libwebsocket_context *context = protocol->owning_server;
476 struct libwebsocket *wsi;
478 for (n = 0; n < context->fds_count; n++) {
479 wsi = wsi_from_fd(context, context->fds[n].fd);
482 if (wsi->protocol == protocol)
483 protocol->callback(context, wsi,
484 reason, wsi->user_space, NULL, 0);
491 * libwebsocket_set_timeout() - marks the wsi as subject to a timeout
493 * You will not need this unless you are doing something special
495 * @wsi: Websocket connection instance
496 * @reason: timeout reason
497 * @secs: how many seconds
501 libwebsocket_set_timeout(struct libwebsocket *wsi,
502 enum pending_timeout reason, int secs)
508 wsi->pending_timeout_limit = now + secs;
509 wsi->pending_timeout = reason;
514 * libwebsocket_get_socket_fd() - returns the socket file descriptor
516 * You will not need this unless you are doing something special
518 * @wsi: Websocket connection instance
522 libwebsocket_get_socket_fd(struct libwebsocket *wsi)
529 lws_latency(struct libwebsocket_context *context, struct libwebsocket *wsi,
530 const char *action, int ret, int completed)
532 unsigned long long u;
535 u = time_in_microseconds();
538 wsi->latency_start = u;
539 if (!wsi->action_start)
540 wsi->action_start = u;
544 if (wsi->action_start == wsi->latency_start)
546 "Completion first try lat %lluus: %p: ret %d: %s\n",
547 u - wsi->latency_start,
548 (void *)wsi, ret, action);
551 "Completion %lluus: lat %lluus: %p: ret %d: %s\n",
552 u - wsi->action_start,
553 u - wsi->latency_start,
554 (void *)wsi, ret, action);
555 wsi->action_start = 0;
557 sprintf(buf, "lat %lluus: %p: ret %d: %s\n",
558 u - wsi->latency_start, (void *)wsi, ret, action);
560 if (u - wsi->latency_start > context->worst_latency) {
561 context->worst_latency = u - wsi->latency_start;
562 strcpy(context->worst_latency_info, buf);
564 lwsl_latency("%s", buf);
571 * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
574 * If the output side of a server process becomes choked, this allows flow
575 * control for the input side.
577 * @wsi: Websocket connection instance to get callback for
578 * @enable: 0 = disable read servicing for this connection, 1 = enable
582 libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
584 if (enable == (wsi->rxflow_change_to & LWS_RXFLOW_ALLOW))
587 lwsl_info("libwebsocket_rx_flow_control(0x%p, %d)\n", wsi, enable);
588 wsi->rxflow_change_to = LWS_RXFLOW_PENDING_CHANGE | !!enable;
594 * libwebsocket_rx_flow_allow_all_protocol() - Allow all connections with this protocol to receive
596 * When the user server code realizes it can accept more input, it can
597 * call this to have the RX flow restriction removed from all connections using
598 * the given protocol.
600 * @protocol: all connections using this protocol will be allowed to receive
604 libwebsocket_rx_flow_allow_all_protocol(
605 const struct libwebsocket_protocols *protocol)
607 struct libwebsocket_context *context = protocol->owning_server;
609 struct libwebsocket *wsi;
611 for (n = 0; n < context->fds_count; n++) {
612 wsi = wsi_from_fd(context, context->fds[n].fd);
615 if (wsi->protocol == protocol)
616 libwebsocket_rx_flow_control(wsi, LWS_RXFLOW_ALLOW);
622 * libwebsocket_canonical_hostname() - returns this host's hostname
624 * This is typically used by client code to fill in the host parameter
625 * when making a client connection. You can only call it after the context
628 * @context: Websocket context
630 LWS_VISIBLE extern const char *
631 libwebsocket_canonical_hostname(struct libwebsocket_context *context)
633 return (const char *)context->canonical_hostname;
636 int user_callback_handle_rxflow(callback_function callback_function,
637 struct libwebsocket_context *context,
638 struct libwebsocket *wsi,
639 enum libwebsocket_callback_reasons reason, void *user,
640 void *in, size_t len)
644 n = callback_function(context, wsi, reason, user, in, len);
646 n = _libwebsocket_rx_flow_control(wsi);
653 * libwebsocket_set_proxy() - Setups proxy to libwebsocket_context.
654 * @context: pointer to struct libwebsocket_context you want set proxy to
655 * @proxy: pointer to c string containing proxy in format address:port
657 * Returns 0 if proxy string was parsed and proxy was setup.
658 * Returns -1 if @proxy is NULL or has incorrect format.
660 * This is only required if your OS does not provide the http_proxy
661 * environment variable (eg, OSX)
663 * IMPORTANT! You should call this function right after creation of the
664 * libwebsocket_context and before call to connect. If you call this
665 * function after connect behavior is undefined.
666 * This function will override proxy settings made on libwebsocket_context
667 * creation with genenv() call.
671 libwebsocket_set_proxy(struct libwebsocket_context *context, const char *proxy)
678 strncpy(context->http_proxy_address, proxy,
679 sizeof(context->http_proxy_address) - 1);
680 context->http_proxy_address[
681 sizeof(context->http_proxy_address) - 1] = '\0';
683 p = strchr(context->http_proxy_address, ':');
685 lwsl_err("http_proxy needs to be ads:port\n");
690 context->http_proxy_port = atoi(p + 1);
692 lwsl_notice(" Proxy %s:%u\n", context->http_proxy_address,
693 context->http_proxy_port);
699 * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
701 * @wsi: pointer to struct websocket you want to know the protocol of
704 * Some apis can act on all live connections of a given protocol,
705 * this is how you can get a pointer to the active protocol if needed.
708 LWS_VISIBLE const struct libwebsocket_protocols *
709 libwebsockets_get_protocol(struct libwebsocket *wsi)
711 return wsi->protocol;
715 libwebsocket_is_final_fragment(struct libwebsocket *wsi)
717 return wsi->u.ws.final;
720 LWS_VISIBLE unsigned char
721 libwebsocket_get_reserved_bits(struct libwebsocket *wsi)
723 return wsi->u.ws.rsv;
727 libwebsocket_ensure_user_space(struct libwebsocket *wsi)
729 lwsl_info("%s: %p protocol %p\n", __func__, wsi, wsi->protocol);
733 /* allocate the per-connection user memory (if any) */
735 if (wsi->protocol->per_session_data_size && !wsi->user_space) {
736 wsi->user_space = lws_zalloc(wsi->protocol->per_session_data_size);
737 if (wsi->user_space == NULL) {
738 lwsl_err("Out of memory for conn user space\n");
742 lwsl_info("%s: %p protocol pss %u, user_space=%d\n", __func__, wsi, wsi->protocol->per_session_data_size, wsi->user_space);
746 LWS_VISIBLE void lwsl_emit_stderr(int level, const char *line)
749 unsigned long long now;
753 for (n = 0; n < LLL_COUNT; n++)
754 if (level == (1 << n)) {
755 now = time_in_microseconds() / 100;
756 sprintf(buf, "[%llu:%04d] %s: ", (unsigned long long) now / 10000,
757 (int)(now % 10000), log_level_names[n]);
761 fprintf(stderr, "%s%s", buf, line);
765 LWS_VISIBLE void _lws_logv(int filter, const char *format, va_list vl)
769 if (!(log_level & filter))
772 vsnprintf(buf, sizeof(buf), format, vl);
773 buf[sizeof(buf) - 1] = '\0';
775 lwsl_emit(filter, buf);
778 LWS_VISIBLE void _lws_log(int filter, const char *format, ...)
782 va_start(ap, format);
783 _lws_logv(filter, format, ap);
788 * lws_set_log_level() - Set the logging bitfield
789 * @level: OR together the LLL_ debug contexts you want output from
790 * @log_emit_function: NULL to leave it as it is, or a user-supplied
791 * function to perform log string emission instead of
792 * the default stderr one.
794 * log level defaults to "err", "warn" and "notice" contexts enabled and
795 * emission on stderr.
798 LWS_VISIBLE void lws_set_log_level(int level, void (*log_emit_function)(int level,
802 if (log_emit_function)
803 lwsl_emit = log_emit_function;
807 * lws_use_ssl() - Find out if connection is using SSL
808 * @wsi: websocket connection to check
810 * Returns 0 if the connection is not using SSL, 1 if using SSL and
811 * using verified cert, and 2 if using SSL but the cert was not
812 * checked (appears for client wsi told to skip check on connection)
815 lws_is_ssl(struct libwebsocket *wsi)
817 #ifdef LWS_OPENSSL_SUPPORT
825 * lws_partial_buffered() - find out if lws buffered the last write
826 * @wsi: websocket connection to check
828 * Returns 1 if you cannot use libwebsocket_write because the last
829 * write on this connection is still buffered, and can't be cleared without
830 * returning to the service loop and waiting for the connection to be
833 * If you will try to do >1 libwebsocket_write call inside a single
834 * WRITEABLE callback, you must check this after every write and bail if
835 * set, ask for a new writeable callback and continue writing from there.
837 * This is never set at the start of a writeable callback, but any write
842 lws_partial_buffered(struct libwebsocket *wsi)
844 return !!wsi->truncated_send_len;
847 void lws_set_protocol_write_pending(struct libwebsocket_context *context,
848 struct libwebsocket *wsi,
849 enum lws_pending_protocol_send pend)
851 lwsl_info("setting pps %d\n", pend);
854 lwsl_err("pps overwrite\n");
856 libwebsocket_rx_flow_control(wsi, 0);
857 libwebsocket_callback_on_writable(context, wsi);
861 lws_get_peer_write_allowance(struct libwebsocket *wsi)
864 /* only if we are using HTTP2 on this connection */
865 if (wsi->mode != LWS_CONNMODE_HTTP2_SERVING)
867 /* user is only interested in how much he can send, or that he can't */
868 if (wsi->u.http2.tx_credit <= 0)
871 return wsi->u.http2.tx_credit;
878 lws_union_transition(struct libwebsocket *wsi, enum connection_mode mode)
880 memset(&wsi->u, 0, sizeof(wsi->u));