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[] = {
42 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
43 struct libwebsocket *wsi, enum lws_close_status reason)
47 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 2 +
48 LWS_SEND_BUFFER_POST_PADDING];
49 struct lws_tokens eff_buf;
54 old_state = wsi->state;
57 case WSI_STATE_DEAD_SOCKET:
60 /* we tried the polite way... */
61 case WSI_STATE_AWAITING_CLOSE_ACK:
62 goto just_kill_connection;
64 case WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE:
65 if (wsi->truncated_send_len) {
66 libwebsocket_callback_on_writable(context, wsi);
69 lwsl_info("wsi %p completed WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE\n", wsi);
70 goto just_kill_connection;
72 if (wsi->truncated_send_len) {
73 lwsl_info("wsi %p entering WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE\n", wsi);
74 wsi->state = WSI_STATE_FLUSHING_STORED_SEND_BEFORE_CLOSE;
80 wsi->u.ws.close_reason = reason;
82 if (wsi->mode == LWS_CONNMODE_WS_CLIENT_WAITING_CONNECT ||
83 wsi->mode == LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE) {
85 context->protocols[0].callback(context, wsi,
86 LWS_CALLBACK_CLIENT_CONNECTION_ERROR, NULL, NULL, 0);
89 goto just_kill_connection;
92 if (wsi->mode == LWS_CONNMODE_HTTP_SERVING_ACCEPTED) {
93 if (wsi->u.http.fd != LWS_INVALID_FILE) {
94 lwsl_debug("closing http file\n");
95 compatible_file_close(wsi->u.http.fd);
96 wsi->u.http.fd = LWS_INVALID_FILE;
97 context->protocols[0].callback(context, wsi,
98 LWS_CALLBACK_CLOSED_HTTP, wsi->user_space, NULL, 0);
103 * are his extensions okay with him closing? Eg he might be a mux
104 * parent and just his ch1 aspect is closing?
107 if (lws_ext_callback_for_each_active(wsi,
108 LWS_EXT_CALLBACK_CHECK_OK_TO_REALLY_CLOSE, NULL, 0) > 0) {
109 lwsl_ext("extension vetoed close\n");
114 * flush any tx pending from extensions, since we may send close packet
115 * if there are problems with send, just nuke the connection
120 eff_buf.token = NULL;
121 eff_buf.token_len = 0;
123 /* show every extension the new incoming data */
125 m = lws_ext_callback_for_each_active(wsi,
126 LWS_EXT_CALLBACK_FLUSH_PENDING_TX, &eff_buf, 0);
128 lwsl_ext("Extension reports fatal error\n");
129 goto just_kill_connection;
133 * at least one extension told us he has more
134 * to spill, so we will go around again after
138 /* assuming they left us something to send, send it */
140 if (eff_buf.token_len)
141 if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
142 eff_buf.token_len) != eff_buf.token_len) {
143 lwsl_debug("close: ext spill failed\n");
144 goto just_kill_connection;
149 * signal we are closing, libsocket_write will
150 * add any necessary version-specific stuff. If the write fails,
151 * no worries we are closing anyway. If we didn't initiate this
152 * close, then our state has been changed to
153 * WSI_STATE_RETURNED_CLOSE_ALREADY and we will skip this.
155 * Likewise if it's a second call to close this connection after we
156 * sent the close indication to the peer already, we are in state
157 * WSI_STATE_AWAITING_CLOSE_ACK and will skip doing this a second time.
160 if (old_state == WSI_STATE_ESTABLISHED &&
161 reason != LWS_CLOSE_STATUS_NOSTATUS) {
163 lwsl_debug("sending close indication...\n");
165 /* make valgrind happy */
166 memset(buf, 0, sizeof(buf));
167 n = libwebsocket_write(wsi,
168 &buf[LWS_SEND_BUFFER_PRE_PADDING + 2],
172 * we have sent a nice protocol level indication we
173 * now wish to close, we should not send anything more
176 wsi->state = WSI_STATE_AWAITING_CLOSE_ACK;
179 * ...and we should wait for a reply for a bit
183 libwebsocket_set_timeout(wsi,
184 PENDING_TIMEOUT_CLOSE_ACK, 1);
186 lwsl_debug("sent close indication, awaiting ack\n");
191 lwsl_info("close: sending close packet failed, hanging up\n");
193 /* else, the send failed and we should just hang up */
196 just_kill_connection:
198 lwsl_debug("close: just_kill_connection\n");
201 * we won't be servicing or receiving anything further from this guy
202 * delete socket from the internal poll list if still present
205 remove_wsi_socket_from_fds(context, wsi);
207 wsi->state = WSI_STATE_DEAD_SOCKET;
209 if ((old_state == WSI_STATE_ESTABLISHED ||
210 wsi->mode == LWS_CONNMODE_WS_SERVING ||
211 wsi->mode == LWS_CONNMODE_WS_CLIENT)) {
213 if (wsi->u.ws.rx_user_buffer) {
214 free(wsi->u.ws.rx_user_buffer);
215 wsi->u.ws.rx_user_buffer = NULL;
217 if (wsi->u.ws.rxflow_buffer) {
218 free(wsi->u.ws.rxflow_buffer);
219 wsi->u.ws.rxflow_buffer = NULL;
221 if (wsi->truncated_send_malloc) {
222 /* not going to be completed... nuke it */
223 free(wsi->truncated_send_malloc);
224 wsi->truncated_send_malloc = NULL;
225 wsi->truncated_send_len = 0;
229 /* tell the user it's all over for this guy */
231 if (wsi->protocol && wsi->protocol->callback &&
232 ((old_state == WSI_STATE_ESTABLISHED) ||
233 (old_state == WSI_STATE_RETURNED_CLOSE_ALREADY) ||
234 (old_state == WSI_STATE_AWAITING_CLOSE_ACK))) {
235 lwsl_debug("calling back CLOSED\n");
236 wsi->protocol->callback(context, wsi, LWS_CALLBACK_CLOSED,
237 wsi->user_space, NULL, 0);
238 } else if (wsi->mode == LWS_CONNMODE_HTTP_SERVING_ACCEPTED) {
239 lwsl_debug("calling back CLOSED_HTTP\n");
240 context->protocols[0].callback(context, wsi,
241 LWS_CALLBACK_CLOSED_HTTP, wsi->user_space, NULL, 0 );
243 lwsl_debug("not calling back closed\n");
245 /* deallocate any active extension contexts */
247 if (lws_ext_callback_for_each_active(wsi, LWS_EXT_CALLBACK_DESTROY, NULL, 0) < 0)
248 lwsl_warn("extension destruction failed\n");
249 #ifndef LWS_NO_EXTENSIONS
250 for (n = 0; n < wsi->count_active_extensions; n++)
251 free(wsi->active_extensions_user[n]);
254 * inform all extensions in case they tracked this guy out of band
255 * even though not active on him specifically
257 if (lws_ext_callback_for_each_extension_type(context, wsi,
258 LWS_EXT_CALLBACK_DESTROY_ANY_WSI_CLOSING, NULL, 0) < 0)
259 lwsl_warn("ext destroy wsi failed\n");
261 /* lwsl_info("closing fd=%d\n", wsi->sock); */
263 if (!lws_ssl_close(wsi) && wsi->sock >= 0) {
264 n = shutdown(wsi->sock, SHUT_RDWR);
266 lwsl_debug("closing: shutdown ret %d\n", LWS_ERRNO);
268 n = compatible_close(wsi->sock);
270 lwsl_debug("closing: close ret %d\n", LWS_ERRNO);
273 /* outermost destroy notification for wsi (user_space still intact) */
274 context->protocols[0].callback(context, wsi,
275 LWS_CALLBACK_WSI_DESTROY, wsi->user_space, NULL, 0);
277 if (wsi->protocol && wsi->protocol->per_session_data_size &&
278 wsi->user_space && !wsi->user_space_externally_allocated)
279 free(wsi->user_space);
285 * libwebsockets_get_peer_addresses() - Get client address information
286 * @context: Libwebsockets context
287 * @wsi: Local struct libwebsocket associated with
288 * @fd: Connection socket descriptor
289 * @name: Buffer to take client address name
290 * @name_len: Length of client address name buffer
291 * @rip: Buffer to take client address IP qotted quad
292 * @rip_len: Length of client address IP buffer
294 * This function fills in @name and @rip with the name and IP of
295 * the client connected with socket descriptor @fd. Names may be
296 * truncated if there is not enough room. If either cannot be
297 * determined, they will be returned as valid zero-length strings.
301 libwebsockets_get_peer_addresses(struct libwebsocket_context *context,
302 struct libwebsocket *wsi, int fd, char *name, int name_len,
303 char *rip, int rip_len)
307 struct sockaddr_in6 sin6;
309 struct sockaddr_in sin4;
310 struct hostent *host;
311 struct hostent *host1;
316 struct sockaddr_un *un;
323 lws_latency_pre(context, wsi);
326 if (LWS_IPV6_ENABLED(context)) {
329 if (getpeername(fd, (struct sockaddr *) &sin6, &len) < 0) {
330 lwsl_warn("getpeername: %s\n", strerror(LWS_ERRNO));
334 if (!lws_plat_inet_ntop(AF_INET6, &sin6.sin6_addr, rip, rip_len)) {
335 lwsl_err("inet_ntop", strerror(LWS_ERRNO));
339 // Strip off the IPv4 to IPv6 header if one exists
340 if (strncmp(rip, "::ffff:", 7) == 0)
341 memmove(rip, rip + 7, strlen(rip) - 6);
343 getnameinfo((struct sockaddr *)&sin6,
344 sizeof(struct sockaddr_in6), name,
345 name_len, NULL, 0, 0);
351 if (getpeername(fd, (struct sockaddr *) &sin4, &len) < 0) {
352 lwsl_warn("getpeername: %s\n", strerror(LWS_ERRNO));
355 host = gethostbyaddr((char *) &sin4.sin_addr,
356 sizeof(sin4.sin_addr), AF_INET);
358 lwsl_warn("gethostbyaddr: %s\n", strerror(LWS_ERRNO));
362 strncpy(name, host->h_name, name_len);
363 name[name_len - 1] = '\0';
365 host1 = gethostbyname(host->h_name);
368 p = (unsigned char *)host1;
371 p = (unsigned char *)host1->h_addr_list[n++];
374 if ((host1->h_addrtype != AF_INET)
376 && (host1->h_addrtype != AF_LOCAL)
381 if (host1->h_addrtype == AF_INET)
382 sprintf(ip, "%u.%u.%u.%u",
383 p[0], p[1], p[2], p[3]);
386 un = (struct sockaddr_un *)p;
387 strncpy(ip, un->sun_path, sizeof(ip) - 1);
388 ip[sizeof(ip) - 1] = '\0';
392 strncpy(rip, ip, rip_len);
393 rip[rip_len - 1] = '\0';
399 lws_latency(context, wsi, "libwebsockets_get_peer_addresses", ret, 1);
405 * libwebsocket_context_user() - get the user data associated with the context
406 * @context: Websocket context
408 * This returns the optional user allocation that can be attached to
409 * the context the sockets live in at context_create time. It's a way
410 * to let all sockets serviced in the same context share data without
411 * using globals statics in the user code.
414 libwebsocket_context_user(struct libwebsocket_context *context)
416 return context->user_space;
421 * libwebsocket_callback_all_protocol() - Callback all connections using
422 * the given protocol with the given reason
424 * @protocol: Protocol whose connections will get callbacks
425 * @reason: Callback reason index
429 libwebsocket_callback_all_protocol(
430 const struct libwebsocket_protocols *protocol, int reason)
432 struct libwebsocket_context *context = protocol->owning_server;
434 struct libwebsocket *wsi;
436 for (n = 0; n < context->fds_count; n++) {
437 wsi = context->lws_lookup[context->fds[n].fd];
440 if (wsi->protocol == protocol)
441 protocol->callback(context, wsi,
442 reason, wsi->user_space, NULL, 0);
449 * libwebsocket_set_timeout() - marks the wsi as subject to a timeout
451 * You will not need this unless you are doing something special
453 * @wsi: Websocket connection instance
454 * @reason: timeout reason
455 * @secs: how many seconds
459 libwebsocket_set_timeout(struct libwebsocket *wsi,
460 enum pending_timeout reason, int secs)
466 wsi->pending_timeout_limit = now + secs;
467 wsi->pending_timeout = reason;
472 * libwebsocket_get_socket_fd() - returns the socket file descriptor
474 * You will not need this unless you are doing something special
476 * @wsi: Websocket connection instance
480 libwebsocket_get_socket_fd(struct libwebsocket *wsi)
487 lws_latency(struct libwebsocket_context *context, struct libwebsocket *wsi,
488 const char *action, int ret, int completed)
490 unsigned long long u;
493 u = time_in_microseconds();
496 wsi->latency_start = u;
497 if (!wsi->action_start)
498 wsi->action_start = u;
502 if (wsi->action_start == wsi->latency_start)
504 "Completion first try lat %lluus: %p: ret %d: %s\n",
505 u - wsi->latency_start,
506 (void *)wsi, ret, action);
509 "Completion %lluus: lat %lluus: %p: ret %d: %s\n",
510 u - wsi->action_start,
511 u - wsi->latency_start,
512 (void *)wsi, ret, action);
513 wsi->action_start = 0;
515 sprintf(buf, "lat %lluus: %p: ret %d: %s\n",
516 u - wsi->latency_start, (void *)wsi, ret, action);
518 if (u - wsi->latency_start > context->worst_latency) {
519 context->worst_latency = u - wsi->latency_start;
520 strcpy(context->worst_latency_info, buf);
522 lwsl_latency("%s", buf);
529 * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
532 * If the output side of a server process becomes choked, this allows flow
533 * control for the input side.
535 * @wsi: Websocket connection instance to get callback for
536 * @enable: 0 = disable read servicing for this connection, 1 = enable
540 libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
542 if (enable == (wsi->u.ws.rxflow_change_to & LWS_RXFLOW_ALLOW))
545 lwsl_info("libwebsocket_rx_flow_control(0x%p, %d)\n", wsi, enable);
546 wsi->u.ws.rxflow_change_to = LWS_RXFLOW_PENDING_CHANGE | !!enable;
552 * libwebsocket_rx_flow_allow_all_protocol() - Allow all connections with this protocol to receive
554 * When the user server code realizes it can accept more input, it can
555 * call this to have the RX flow restriction removed from all connections using
556 * the given protocol.
558 * @protocol: all connections using this protocol will be allowed to receive
562 libwebsocket_rx_flow_allow_all_protocol(
563 const struct libwebsocket_protocols *protocol)
565 struct libwebsocket_context *context = protocol->owning_server;
567 struct libwebsocket *wsi;
569 for (n = 0; n < context->fds_count; n++) {
570 wsi = context->lws_lookup[context->fds[n].fd];
573 if (wsi->protocol == protocol)
574 libwebsocket_rx_flow_control(wsi, LWS_RXFLOW_ALLOW);
580 * libwebsocket_canonical_hostname() - returns this host's hostname
582 * This is typically used by client code to fill in the host parameter
583 * when making a client connection. You can only call it after the context
586 * @context: Websocket context
588 LWS_VISIBLE extern const char *
589 libwebsocket_canonical_hostname(struct libwebsocket_context *context)
591 return (const char *)context->canonical_hostname;
594 int user_callback_handle_rxflow(callback_function callback_function,
595 struct libwebsocket_context *context,
596 struct libwebsocket *wsi,
597 enum libwebsocket_callback_reasons reason, void *user,
598 void *in, size_t len)
602 n = callback_function(context, wsi, reason, user, in, len);
604 n = _libwebsocket_rx_flow_control(wsi);
611 * libwebsocket_set_proxy() - Setups proxy to libwebsocket_context.
612 * @context: pointer to struct libwebsocket_context you want set proxy to
613 * @proxy: pointer to c string containing proxy in format address:port
615 * Returns 0 if proxy string was parsed and proxy was setup.
616 * Returns -1 if @proxy is NULL or has incorrect format.
618 * This is only required if your OS does not provide the http_proxy
619 * enviroment variable (eg, OSX)
621 * IMPORTANT! You should call this function right after creation of the
622 * libwebsocket_context and before call to connect. If you call this
623 * function after connect behavior is undefined.
624 * This function will override proxy settings made on libwebsocket_context
625 * creation with genenv() call.
629 libwebsocket_set_proxy(struct libwebsocket_context *context, const char *proxy)
636 strncpy(context->http_proxy_address, proxy,
637 sizeof(context->http_proxy_address) - 1);
638 context->http_proxy_address[
639 sizeof(context->http_proxy_address) - 1] = '\0';
641 p = strchr(context->http_proxy_address, ':');
643 lwsl_err("http_proxy needs to be ads:port\n");
648 context->http_proxy_port = atoi(p + 1);
650 lwsl_notice(" Proxy %s:%u\n", context->http_proxy_address,
651 context->http_proxy_port);
657 * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
659 * @wsi: pointer to struct websocket you want to know the protocol of
662 * Some apis can act on all live connections of a given protocol,
663 * this is how you can get a pointer to the active protocol if needed.
666 LWS_VISIBLE const struct libwebsocket_protocols *
667 libwebsockets_get_protocol(struct libwebsocket *wsi)
669 return wsi->protocol;
673 libwebsocket_is_final_fragment(struct libwebsocket *wsi)
675 return wsi->u.ws.final;
678 LWS_VISIBLE unsigned char
679 libwebsocket_get_reserved_bits(struct libwebsocket *wsi)
681 return wsi->u.ws.rsv;
685 libwebsocket_ensure_user_space(struct libwebsocket *wsi)
690 /* allocate the per-connection user memory (if any) */
692 if (wsi->protocol->per_session_data_size && !wsi->user_space) {
693 wsi->user_space = malloc(
694 wsi->protocol->per_session_data_size);
695 if (wsi->user_space == NULL) {
696 lwsl_err("Out of memory for conn user space\n");
699 memset(wsi->user_space, 0,
700 wsi->protocol->per_session_data_size);
705 LWS_VISIBLE void lwsl_emit_stderr(int level, const char *line)
708 unsigned long long now;
712 for (n = 0; n < LLL_COUNT; n++)
713 if (level == (1 << n)) {
714 now = time_in_microseconds() / 100;
715 sprintf(buf, "[%lu:%04d] %s: ", (unsigned long) now / 10000,
716 (int)(now % 10000), log_level_names[n]);
720 fprintf(stderr, "%s%s", buf, line);
724 LWS_VISIBLE void _lws_log(int filter, const char *format, ...)
729 if (!(log_level & filter))
732 va_start(ap, format);
733 vsnprintf(buf, sizeof(buf), format, ap);
734 buf[sizeof(buf) - 1] = '\0';
737 lwsl_emit(filter, buf);
741 * lws_set_log_level() - Set the logging bitfield
742 * @level: OR together the LLL_ debug contexts you want output from
743 * @log_emit_function: NULL to leave it as it is, or a user-supplied
744 * function to perform log string emission instead of
745 * the default stderr one.
747 * log level defaults to "err", "warn" and "notice" contexts enabled and
748 * emission on stderr.
751 LWS_VISIBLE void lws_set_log_level(int level, void (*log_emit_function)(int level,
755 if (log_emit_function)
756 lwsl_emit = log_emit_function;
760 * lws_use_ssl() - Find out if connection is using SSL
761 * @wsi: websocket connection to check
763 * Returns 0 if the connection is not using SSL, 1 if using SSL and
764 * using verified cert, and 2 if using SSL but the cert was not
765 * checked (appears for client wsi told to skip check on connection)
768 lws_is_ssl(struct libwebsocket *wsi)
770 #ifdef LWS_OPENSSL_SUPPORT
778 * lws_partial_buffered() - find out if lws buffered the last write
779 * @wsi: websocket connection to check
781 * Returns 1 if you cannot use libwebsocket_write because the last
782 * write on this connection is still buffered, and can't be cleared without
783 * returning to the service loop and waiting for the connection to be
786 * If you will try to do >1 libwebsocket_write call inside a single
787 * WRITEABLE callback, you must check this after every write and bail if
788 * set, ask for a new writeable callback and continue writing from there.
790 * This is never set at the start of a writeable callback, but any write
795 lws_partial_buffered(struct libwebsocket *wsi)
797 return !!wsi->truncated_send_len;