2 * libwebsockets - small server side websockets and web server implementation
4 * Copyright (C) 2010 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"
28 #ifdef LWS_BUILTIN_GETIFADDRS
29 #include <getifaddrs.h>
35 #include <sys/socket.h>
39 #ifdef LWS_OPENSSL_SUPPORT
40 int openssl_websocket_private_data_index;
44 #include "../win32port/win32helpers/websock-w32.c"
47 #include "../win32port/win32helpers/websock-w32.c"
51 #ifndef LWS_BUILD_HASH
52 #define LWS_BUILD_HASH "unknown-build-hash"
55 static int log_level = LLL_ERR | LLL_WARN | LLL_NOTICE;
56 static void lwsl_emit_stderr(int level, const char *line);
57 static void (*lwsl_emit)(int level, const char *line) = lwsl_emit_stderr;
59 static const char *library_version = LWS_LIBRARY_VERSION " " LWS_BUILD_HASH;
61 static const char *log_level_names[] = {
75 * lws_get_library_version: get version and git hash library built from
77 * returns a const char * to a string like "1.1 178d78c"
78 * representing the library version followed by the git head hash it
83 lws_get_library_version(void)
85 return library_version;
89 insert_wsi_socket_into_fds(struct libwebsocket_context *context, struct libwebsocket *wsi)
91 if (context->fds_count >= context->max_fds) {
92 lwsl_err("Reached limit of fds tracking (%d)\n", context->max_fds);
96 if (wsi->sock > context->max_fds) {
97 lwsl_err("Socket fd %d is beyond what we can index (%d)\n", wsi->sock, context->max_fds);
104 lwsl_info("insert_wsi_socket_into_fds: wsi=%p, sock=%d, fds pos=%d\n", wsi, wsi->sock, context->fds_count);
106 context->lws_lookup[wsi->sock] = wsi;
107 wsi->position_in_fds_table = context->fds_count;
108 context->fds[context->fds_count].fd = wsi->sock;
109 context->fds[context->fds_count].events = POLLIN;
110 context->fds[context->fds_count++].revents = 0;
112 /* external POLL support via protocol 0 */
113 context->protocols[0].callback(context, wsi,
114 LWS_CALLBACK_ADD_POLL_FD,
115 (void *)(long)wsi->sock, NULL, POLLIN);
121 remove_wsi_socket_from_fds(struct libwebsocket_context *context, struct libwebsocket *wsi)
125 if (!--context->fds_count)
128 if (wsi->sock > context->max_fds) {
129 lwsl_err("Socket fd %d is beyond what we can index (%d)\n", wsi->sock, context->max_fds);
133 lwsl_info("remove_wsi_socket_from_fds: wsi=%p, sock=%d, fds pos=%d\n", wsi, wsi->sock, wsi->position_in_fds_table);
135 m = wsi->position_in_fds_table; /* replace the contents for this */
137 /* have the last guy take up the vacant slot */
138 context->fds[m] = context->fds[context->fds_count]; /* vacant fds slot filled with end one */
139 /* end guy's fds_lookup entry remains unchanged (still same fd pointing to same wsi) */
140 /* end guy's "position in fds table" changed */
141 context->lws_lookup[context->fds[context->fds_count].fd]->position_in_fds_table = m;
142 /* deletion guy's lws_lookup entry needs nuking */
143 context->lws_lookup[wsi->sock] = NULL; /* no WSI for the socket of the wsi being removed*/
144 wsi->position_in_fds_table = -1; /* removed wsi has no position any more */
147 /* remove also from external POLL support via protocol 0 */
149 context->protocols[0].callback(context, wsi,
150 LWS_CALLBACK_DEL_POLL_FD, (void *)(long)wsi->sock, NULL, 0);
157 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
158 struct libwebsocket *wsi, enum lws_close_status reason)
162 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 2 +
163 LWS_SEND_BUFFER_POST_PADDING];
164 #ifndef LWS_NO_EXTENSIONS
167 struct lws_tokens eff_buf;
168 struct libwebsocket_extension *ext;
174 old_state = wsi->state;
176 if (old_state == WSI_STATE_DEAD_SOCKET)
179 wsi->u.ws.close_reason = reason;
181 if (wsi->mode == LWS_CONNMODE_HTTP_SERVING && wsi->u.http.fd) {
182 close(wsi->u.http.fd);
186 #ifndef LWS_NO_EXTENSIONS
188 * are his extensions okay with him closing? Eg he might be a mux
189 * parent and just his ch1 aspect is closing?
192 for (n = 0; n < wsi->count_active_extensions; n++) {
193 if (!wsi->active_extensions[n]->callback)
196 m = wsi->active_extensions[n]->callback(context,
197 wsi->active_extensions[n], wsi,
198 LWS_EXT_CALLBACK_CHECK_OK_TO_REALLY_CLOSE,
199 wsi->active_extensions_user[n], NULL, 0);
202 * if somebody vetoed actually closing him at this time....
203 * up to the extension to track the attempted close, let's
208 lwsl_ext("extension vetoed close\n");
214 * flush any tx pending from extensions, since we may send close packet
215 * if there are problems with send, just nuke the connection
221 /* default to nobody has more to spill */
224 eff_buf.token = NULL;
225 eff_buf.token_len = 0;
227 /* show every extension the new incoming data */
229 for (n = 0; n < wsi->count_active_extensions; n++) {
230 m = wsi->active_extensions[n]->callback(
231 wsi->protocol->owning_server,
232 wsi->active_extensions[n], wsi,
233 LWS_EXT_CALLBACK_FLUSH_PENDING_TX,
234 wsi->active_extensions_user[n], &eff_buf, 0);
236 lwsl_ext("Extension reports fatal error\n");
237 goto just_kill_connection;
241 * at least one extension told us he has more
242 * to spill, so we will go around again after
247 /* assuming they left us something to send, send it */
249 if (eff_buf.token_len)
250 if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
251 eff_buf.token_len)) {
252 lwsl_debug("close: sending final extension spill had problems\n");
253 goto just_kill_connection;
259 * signal we are closing, libsocket_write will
260 * add any necessary version-specific stuff. If the write fails,
261 * no worries we are closing anyway. If we didn't initiate this
262 * close, then our state has been changed to
263 * WSI_STATE_RETURNED_CLOSE_ALREADY and we will skip this.
265 * Likewise if it's a second call to close this connection after we
266 * sent the close indication to the peer already, we are in state
267 * WSI_STATE_AWAITING_CLOSE_ACK and will skip doing this a second time.
270 if (old_state == WSI_STATE_ESTABLISHED &&
271 reason != LWS_CLOSE_STATUS_NOSTATUS) {
273 lwsl_debug("sending close indication...\n");
275 n = libwebsocket_write(wsi, &buf[LWS_SEND_BUFFER_PRE_PADDING],
279 * we have sent a nice protocol level indication we
280 * now wish to close, we should not send anything more
283 wsi->state = WSI_STATE_AWAITING_CLOSE_ACK;
285 /* and we should wait for a reply for a bit out of politeness */
287 libwebsocket_set_timeout(wsi,
288 PENDING_TIMEOUT_CLOSE_ACK, 1);
290 lwsl_debug("sent close indication, awaiting ack\n");
295 lwsl_info("close: sending the close packet failed, hanging up\n");
297 /* else, the send failed and we should just hang up */
300 #ifndef LWS_NO_EXTENSIONS
301 just_kill_connection:
304 lwsl_debug("libwebsocket_close_and_free_session: just_kill_connection\n");
307 * we won't be servicing or receiving anything further from this guy
308 * delete socket from the internal poll list if still present
311 remove_wsi_socket_from_fds(context, wsi);
313 wsi->state = WSI_STATE_DEAD_SOCKET;
315 /* tell the user it's all over for this guy */
317 if (wsi->protocol && wsi->protocol->callback &&
318 ((old_state == WSI_STATE_ESTABLISHED) ||
319 (old_state == WSI_STATE_RETURNED_CLOSE_ALREADY) ||
320 (old_state == WSI_STATE_AWAITING_CLOSE_ACK))) {
321 lwsl_debug("calling back CLOSED\n");
322 wsi->protocol->callback(context, wsi, LWS_CALLBACK_CLOSED,
323 wsi->user_space, NULL, 0);
325 lwsl_debug("not calling back closed, old_state=%d\n", old_state);
327 #ifndef LWS_NO_EXTENSIONS
328 /* deallocate any active extension contexts */
330 for (n = 0; n < wsi->count_active_extensions; n++) {
331 if (!wsi->active_extensions[n]->callback)
334 wsi->active_extensions[n]->callback(context,
335 wsi->active_extensions[n], wsi,
336 LWS_EXT_CALLBACK_DESTROY,
337 wsi->active_extensions_user[n], NULL, 0);
339 free(wsi->active_extensions_user[n]);
343 * inform all extensions in case they tracked this guy out of band
344 * even though not active on him specifically
347 ext = context->extensions;
348 while (ext && ext->callback) {
349 ext->callback(context, ext, wsi,
350 LWS_EXT_CALLBACK_DESTROY_ANY_WSI_CLOSING,
356 #ifndef LWS_NO_CLIENT
358 free(wsi->c_address);
360 if (wsi->u.ws.rxflow_buffer)
361 free(wsi->u.ws.rxflow_buffer);
363 /* lwsl_info("closing fd=%d\n", wsi->sock); */
365 #ifdef LWS_OPENSSL_SUPPORT
367 n = SSL_get_fd(wsi->ssl);
368 SSL_shutdown(wsi->ssl);
374 n = shutdown(wsi->sock, SHUT_RDWR);
376 lwsl_debug("closing: shutdown returned %d\n", errno);
378 n = compatible_close(wsi->sock);
380 lwsl_debug("closing: close returned %d\n", errno);
382 #ifdef LWS_OPENSSL_SUPPORT
385 if (wsi->protocol && wsi->protocol->per_session_data_size && wsi->user_space) /* user code may own */
386 free(wsi->user_space);
392 * libwebsockets_hangup_on_client() - Server calls to terminate client
394 * @context: libwebsockets context
395 * @fd: Connection socket descriptor
399 libwebsockets_hangup_on_client(struct libwebsocket_context *context, int fd)
401 struct libwebsocket *wsi = context->lws_lookup[fd];
404 lwsl_info("closing connection at libwebsockets_hangup_on_client:\n");
405 libwebsocket_close_and_free_session(context,
406 wsi, LWS_CLOSE_STATUS_NOSTATUS);
413 * libwebsockets_get_peer_addresses() - Get client address information
414 * @context: Libwebsockets context
415 * @wsi: Local struct libwebsocket associated with
416 * @fd: Connection socket descriptor
417 * @name: Buffer to take client address name
418 * @name_len: Length of client address name buffer
419 * @rip: Buffer to take client address IP qotted quad
420 * @rip_len: Length of client address IP buffer
422 * This function fills in @name and @rip with the name and IP of
423 * the client connected with socket descriptor @fd. Names may be
424 * truncated if there is not enough room. If either cannot be
425 * determined, they will be returned as valid zero-length strings.
429 libwebsockets_get_peer_addresses(struct libwebsocket_context *context,
430 struct libwebsocket *wsi, int fd, char *name, int name_len,
431 char *rip, int rip_len)
434 struct sockaddr_in sin;
435 struct hostent *host;
436 struct hostent *host1;
442 struct sockaddr_un *un;
448 lws_latency_pre(context, wsi);
451 if (getpeername(fd, (struct sockaddr *) &sin, &len) < 0) {
452 perror("getpeername");
456 host = gethostbyaddr((char *) &sin.sin_addr, sizeof sin.sin_addr,
459 perror("gethostbyaddr");
463 strncpy(name, host->h_name, name_len);
464 name[name_len - 1] = '\0';
466 host1 = gethostbyname(host->h_name);
469 p = (unsigned char *)host1;
472 p = (unsigned char *)host1->h_addr_list[n++];
475 if ((host1->h_addrtype != AF_INET)
477 && (host1->h_addrtype != AF_LOCAL)
482 if (host1->h_addrtype == AF_INET)
483 sprintf(ip, "%u.%u.%u.%u", p[0], p[1], p[2], p[3]);
486 un = (struct sockaddr_un *)p;
487 strncpy(ip, un->sun_path, sizeof(ip) - 1);
488 ip[sizeof(ip) - 1] = '\0';
492 strncpy(rip, ip, rip_len);
493 rip[rip_len - 1] = '\0';
498 lws_latency(context, wsi, "libwebsockets_get_peer_addresses", ret, 1);
501 int libwebsockets_get_random(struct libwebsocket_context *context,
505 char *p = (char *)buf;
508 for (n = 0; n < len; n++)
509 p[n] = (unsigned char)rand();
511 n = read(context->fd_random, p, len);
517 int lws_send_pipe_choked(struct libwebsocket *wsi)
522 fds.events = POLLOUT;
525 if (poll(&fds, 1, 0) != 1)
528 if ((fds.revents & POLLOUT) == 0)
531 /* okay to send another packet without blocking */
537 lws_handle_POLLOUT_event(struct libwebsocket_context *context,
538 struct libwebsocket *wsi, struct pollfd *pollfd)
542 #ifndef LWS_NO_EXTENSIONS
543 struct lws_tokens eff_buf;
548 for (n = 0; n < wsi->count_active_extensions; n++) {
549 if (!wsi->active_extensions[n]->callback)
552 m = wsi->active_extensions[n]->callback(context,
553 wsi->active_extensions[n], wsi,
554 LWS_EXT_CALLBACK_IS_WRITEABLE,
555 wsi->active_extensions_user[n], NULL, 0);
563 if (!wsi->extension_data_pending || handled == 2)
567 * check in on the active extensions, see if they
568 * had pending stuff to spill... they need to get the
569 * first look-in otherwise sequence will be disordered
571 * NULL, zero-length eff_buf means just spill pending
577 /* default to nobody has more to spill */
580 eff_buf.token = NULL;
581 eff_buf.token_len = 0;
583 /* give every extension a chance to spill */
585 for (n = 0; n < wsi->count_active_extensions; n++) {
586 m = wsi->active_extensions[n]->callback(
587 wsi->protocol->owning_server,
588 wsi->active_extensions[n], wsi,
589 LWS_EXT_CALLBACK_PACKET_TX_PRESEND,
590 wsi->active_extensions_user[n], &eff_buf, 0);
592 lwsl_err("ext reports fatal error\n");
597 * at least one extension told us he has more
598 * to spill, so we will go around again after
603 /* assuming they gave us something to send, send it */
605 if (eff_buf.token_len) {
606 if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
612 /* no extension has more to spill */
618 * There's more to spill from an extension, but we just sent
619 * something... did that leave the pipe choked?
622 if (!lws_send_pipe_choked(wsi))
623 /* no we could add more */
626 lwsl_info("choked in POLLOUT service\n");
629 * Yes, he's choked. Leave the POLLOUT masked on so we will
630 * come back here when he is unchoked. Don't call the user
631 * callback to enforce ordering of spilling, he'll get called
632 * when we come back here and there's nothing more to spill.
638 wsi->extension_data_pending = 0;
645 pollfd->events &= ~POLLOUT;
647 /* external POLL support via protocol 0 */
648 context->protocols[0].callback(context, wsi,
649 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
650 (void *)(long)wsi->sock, NULL, POLLOUT);
652 #ifndef LWS_NO_EXTENSIONS
656 if (wsi->mode == LWS_CONNMODE_WS_CLIENT)
657 n = LWS_CALLBACK_CLIENT_WRITEABLE;
659 n = LWS_CALLBACK_SERVER_WRITEABLE;
661 return user_callback_handle_rxflow(wsi->protocol->callback, context,
662 wsi, (enum libwebsocket_callback_reasons) n, wsi->user_space, NULL, 0);
668 libwebsocket_service_timeout_check(struct libwebsocket_context *context,
669 struct libwebsocket *wsi, unsigned int sec)
671 #ifndef LWS_NO_EXTENSIONS
675 * if extensions want in on it (eg, we are a mux parent)
676 * give them a chance to service child timeouts
679 for (n = 0; n < wsi->count_active_extensions; n++)
680 wsi->active_extensions[n]->callback(
681 context, wsi->active_extensions[n],
682 wsi, LWS_EXT_CALLBACK_1HZ,
683 wsi->active_extensions_user[n], NULL, sec);
686 if (!wsi->pending_timeout)
690 * if we went beyond the allowed time, kill the
694 if (sec > wsi->pending_timeout_limit) {
695 lwsl_info("TIMEDOUT WAITING\n");
696 libwebsocket_close_and_free_session(context,
697 wsi, LWS_CLOSE_STATUS_NOSTATUS);
702 * libwebsocket_service_fd() - Service polled socket with something waiting
703 * @context: Websocket context
704 * @pollfd: The pollfd entry describing the socket fd and which events
707 * This function takes a pollfd that has POLLIN or POLLOUT activity and
708 * services it according to the state of the associated struct libwebsocket.
710 * The one call deals with all "service" that might happen on a socket
711 * including listen accepts, http files as well as websocket protocol.
715 libwebsocket_service_fd(struct libwebsocket_context *context,
716 struct pollfd *pollfd)
718 struct libwebsocket *wsi;
722 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 1 +
723 MAX_USER_RX_BUFFER + LWS_SEND_BUFFER_POST_PADDING];
724 #ifdef LWS_OPENSSL_SUPPORT
725 char ssl_err_buf[512];
728 #ifndef LWS_NO_EXTENSIONS
731 struct lws_tokens eff_buf;
732 #ifndef LWS_NO_CLIENT
733 extern int lws_client_socket_service(struct libwebsocket_context *context, struct libwebsocket *wsi, struct pollfd *pollfd);
735 #ifndef LWS_NO_SERVER
736 extern int lws_server_socket_service(struct libwebsocket_context *context, struct libwebsocket *wsi, struct pollfd *pollfd);
739 * you can call us with pollfd = NULL to just allow the once-per-second
740 * global timeout checks; if less than a second since the last check
741 * it returns immediately then.
744 gettimeofday(&tv, NULL);
746 if (context->last_timeout_check_s != tv.tv_sec) {
747 context->last_timeout_check_s = tv.tv_sec;
750 /* if our parent went down, don't linger around */
751 if (context->started_with_parent && kill(context->started_with_parent, 0) < 0)
752 kill(getpid(), SIGTERM);
755 /* global timeout check once per second */
757 for (n = 0; n < context->fds_count; n++) {
758 struct libwebsocket *new_wsi = context->lws_lookup[context->fds[n].fd];
761 libwebsocket_service_timeout_check(context,
766 /* just here for timeout management? */
771 /* no, here to service a socket descriptor */
774 * deal with listen service piggybacking
775 * every listen_service_modulo services of other fds, we
776 * sneak one in to service the listen socket if there's anything waiting
778 * To handle connection storms, as found in ab, if we previously saw a
779 * pending connection here, it causes us to check again next time.
782 if (context->listen_service_fd && pollfd->fd != context->listen_service_fd) {
783 context->listen_service_count++;
784 if (context->listen_service_extraseen ||
785 context->listen_service_count == context->listen_service_modulo) {
786 context->listen_service_count = 0;
788 if (context->listen_service_extraseen > 5)
791 /* even with extpoll, we prepared this internal fds for listen */
792 n = poll(&context->fds[0], 1, 0);
793 if (n > 0) { /* there's a connection waiting for us */
794 libwebsocket_service_fd(context, &context->fds[0]);
795 context->listen_service_extraseen++;
797 if (context->listen_service_extraseen)
798 context->listen_service_extraseen--;
806 /* okay, what we came here to do... */
808 wsi = context->lws_lookup[pollfd->fd];
811 lwsl_err("unexpected NULL wsi fd=%d fds_count=%d\n", pollfd->fd, context->fds_count);
817 #ifndef LWS_NO_SERVER
818 case LWS_CONNMODE_HTTP_SERVING:
819 case LWS_CONNMODE_SERVER_LISTENER:
820 case LWS_CONNMODE_SSL_ACK_PENDING:
821 return lws_server_socket_service(context, wsi, pollfd);
824 case LWS_CONNMODE_WS_SERVING:
825 case LWS_CONNMODE_WS_CLIENT:
827 /* handle session socket closed */
829 if (pollfd->revents & (POLLERR | POLLHUP)) {
831 lwsl_debug("Session Socket %p (fd=%d) dead\n",
832 (void *)wsi, pollfd->fd);
834 libwebsocket_close_and_free_session(context, wsi,
835 LWS_CLOSE_STATUS_NOSTATUS);
839 /* the guy requested a callback when it was OK to write */
841 if ((pollfd->revents & POLLOUT) &&
842 wsi->state == WSI_STATE_ESTABLISHED)
843 if (lws_handle_POLLOUT_event(context, wsi,
845 libwebsocket_close_and_free_session(
846 context, wsi, LWS_CLOSE_STATUS_NORMAL);
851 /* any incoming data ready? */
853 if (!(pollfd->revents & POLLIN))
856 #ifdef LWS_OPENSSL_SUPPORT
859 eff_buf.token_len = SSL_read(wsi->ssl, buf, sizeof buf);
860 if (!eff_buf.token_len) {
861 n = SSL_get_error(wsi->ssl, eff_buf.token_len);
862 lwsl_err("SSL_read returned 0 with reason %s\n", ERR_error_string(n, ssl_err_buf));
867 recv(pollfd->fd, buf, sizeof buf, 0);
869 if (eff_buf.token_len < 0) {
870 lwsl_debug("Socket read returned %d\n",
872 if (errno != EINTR && errno != EAGAIN)
873 libwebsocket_close_and_free_session(context,
874 wsi, LWS_CLOSE_STATUS_NOSTATUS);
877 if (!eff_buf.token_len) {
878 lwsl_info("closing connection due to zero length read\n");
879 libwebsocket_close_and_free_session(context, wsi,
880 LWS_CLOSE_STATUS_NOSTATUS);
885 * give any active extensions a chance to munge the buffer
886 * before parse. We pass in a pointer to an lws_tokens struct
887 * prepared with the default buffer and content length that's in
888 * there. Rather than rewrite the default buffer, extensions
889 * that expect to grow the buffer can adapt .token to
890 * point to their own per-connection buffer in the extension
891 * user allocation. By default with no extensions or no
892 * extension callback handling, just the normal input buffer is
893 * used then so it is efficient.
896 eff_buf.token = (char *)buf;
897 #ifndef LWS_NO_EXTENSIONS
903 for (n = 0; n < wsi->count_active_extensions; n++) {
904 m = wsi->active_extensions[n]->callback(context,
905 wsi->active_extensions[n], wsi,
906 LWS_EXT_CALLBACK_PACKET_RX_PREPARSE,
907 wsi->active_extensions_user[n],
911 "Extension reports fatal error\n");
912 libwebsocket_close_and_free_session(
914 LWS_CLOSE_STATUS_NOSTATUS);
921 /* service incoming data */
923 if (eff_buf.token_len) {
924 n = libwebsocket_read(context, wsi,
925 (unsigned char *)eff_buf.token,
931 #ifndef LWS_NO_EXTENSIONS
932 eff_buf.token = NULL;
933 eff_buf.token_len = 0;
937 #ifdef LWS_OPENSSL_SUPPORT
938 if (wsi->ssl && SSL_pending(wsi->ssl))
947 return lws_client_socket_service(context, wsi, pollfd);
956 * libwebsocket_context_destroy() - Destroy the websocket context
957 * @context: Websocket context
959 * This function closes any active connections and then frees the
960 * context. After calling this, any further use of the context is
964 libwebsocket_context_destroy(struct libwebsocket_context *context)
966 #ifndef LWS_NO_EXTENSIONS
969 struct libwebsocket_extension *ext;
972 if (context->worst_latency_info[0])
973 lwsl_notice("Worst latency: %s\n", context->worst_latency_info);
976 for (n = 0; n < context->fds_count; n++) {
977 struct libwebsocket *wsi = context->lws_lookup[context->fds[n].fd];
978 libwebsocket_close_and_free_session(context,
979 wsi, LWS_CLOSE_STATUS_GOINGAWAY);
983 * give all extensions a chance to clean up any per-context
984 * allocations they might have made
987 ext = context->extensions;
988 m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_DESTRUCT;
989 if (context->listen_port)
990 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_DESTRUCT;
991 while (ext && ext->callback) {
992 ext->callback(context, ext, NULL, (enum libwebsocket_extension_callback_reasons)m, NULL, NULL, 0);
999 close(context->fd_random);
1002 #ifdef LWS_OPENSSL_SUPPORT
1003 if (context->ssl_ctx)
1004 SSL_CTX_free(context->ssl_ctx);
1005 if (context->ssl_client_ctx)
1006 SSL_CTX_free(context->ssl_client_ctx);
1017 * libwebsocket_context_user() - get the user data associated with the whole context
1018 * @context: Websocket context
1020 * This returns the optional user allocation that can be attached to
1021 * the context the sockets live in at context_create time. It's a way
1022 * to let all sockets serviced in the same context share data without
1023 * using globals statics in the user code.
1028 libwebsocket_context_user(struct libwebsocket_context *context)
1030 return context->user_space;
1034 * libwebsocket_service() - Service any pending websocket activity
1035 * @context: Websocket context
1036 * @timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
1037 * service otherwise block and service immediately, returning
1038 * after the timeout if nothing needed service.
1040 * This function deals with any pending websocket traffic, for three
1041 * kinds of event. It handles these events on both server and client
1042 * types of connection the same.
1044 * 1) Accept new connections to our context's server
1046 * 2) Call the receive callback for incoming frame data received by
1047 * server or client connections.
1049 * You need to call this service function periodically to all the above
1050 * functions to happen; if your application is single-threaded you can
1051 * just call it in your main event loop.
1053 * Alternatively you can fork a new process that asynchronously handles
1054 * calling this service in a loop. In that case you are happy if this
1055 * call blocks your thread until it needs to take care of something and
1056 * would call it with a large nonzero timeout. Your loop then takes no
1057 * CPU while there is nothing happening.
1059 * If you are calling it in a single-threaded app, you don't want it to
1060 * wait around blocking other things in your loop from happening, so you
1061 * would call it with a timeout_ms of 0, so it returns immediately if
1062 * nothing is pending, or as soon as it services whatever was pending.
1067 libwebsocket_service(struct libwebsocket_context *context, int timeout_ms)
1071 /* stay dead once we are dead */
1073 if (context == NULL)
1076 /* wait for something to need service */
1078 n = poll(context->fds, context->fds_count, timeout_ms);
1079 if (n == 0) /* poll timeout */
1085 /* any socket with events to service? */
1087 for (n = 0; n < context->fds_count; n++)
1088 if (context->fds[n].revents)
1089 if (libwebsocket_service_fd(context,
1090 &context->fds[n]) < 0)
1095 #ifndef LWS_NO_EXTENSIONS
1097 lws_any_extension_handled(struct libwebsocket_context *context,
1098 struct libwebsocket *wsi,
1099 enum libwebsocket_extension_callback_reasons r,
1100 void *v, size_t len)
1105 /* maybe an extension will take care of it for us */
1107 for (n = 0; n < wsi->count_active_extensions && !handled; n++) {
1108 if (!wsi->active_extensions[n]->callback)
1111 handled |= wsi->active_extensions[n]->callback(context,
1112 wsi->active_extensions[n], wsi,
1113 r, wsi->active_extensions_user[n], v, len);
1121 lws_get_extension_user_matching_ext(struct libwebsocket *wsi,
1122 struct libwebsocket_extension *ext)
1129 while (n < wsi->count_active_extensions) {
1130 if (wsi->active_extensions[n] != ext) {
1134 return wsi->active_extensions_user[n];
1142 * libwebsocket_callback_on_writable() - Request a callback when this socket
1143 * becomes able to be written to without
1146 * @context: libwebsockets context
1147 * @wsi: Websocket connection instance to get callback for
1151 libwebsocket_callback_on_writable(struct libwebsocket_context *context,
1152 struct libwebsocket *wsi)
1154 #ifndef LWS_NO_EXTENSIONS
1158 /* maybe an extension will take care of it for us */
1160 for (n = 0; n < wsi->count_active_extensions; n++) {
1161 if (!wsi->active_extensions[n]->callback)
1164 handled |= wsi->active_extensions[n]->callback(context,
1165 wsi->active_extensions[n], wsi,
1166 LWS_EXT_CALLBACK_REQUEST_ON_WRITEABLE,
1167 wsi->active_extensions_user[n], NULL, 0);
1173 if (wsi->position_in_fds_table < 0) {
1174 lwsl_err("libwebsocket_callback_on_writable: "
1175 "failed to find socket %d\n", wsi->sock);
1179 context->fds[wsi->position_in_fds_table].events |= POLLOUT;
1181 /* external POLL support via protocol 0 */
1182 context->protocols[0].callback(context, wsi,
1183 LWS_CALLBACK_SET_MODE_POLL_FD,
1184 (void *)(long)wsi->sock, NULL, POLLOUT);
1190 * libwebsocket_callback_on_writable_all_protocol() - Request a callback for
1191 * all connections using the given protocol when it
1192 * becomes possible to write to each socket without
1195 * @protocol: Protocol whose connections will get callbacks
1199 libwebsocket_callback_on_writable_all_protocol(
1200 const struct libwebsocket_protocols *protocol)
1202 struct libwebsocket_context *context = protocol->owning_server;
1204 struct libwebsocket *wsi;
1206 for (n = 0; n < context->fds_count; n++) {
1207 wsi = context->lws_lookup[context->fds[n].fd];
1210 if (wsi->protocol == protocol)
1211 libwebsocket_callback_on_writable(context, wsi);
1218 * libwebsocket_set_timeout() - marks the wsi as subject to a timeout
1220 * You will not need this unless you are doing something special
1222 * @wsi: Websocket connection instance
1223 * @reason: timeout reason
1224 * @secs: how many seconds
1228 libwebsocket_set_timeout(struct libwebsocket *wsi,
1229 enum pending_timeout reason, int secs)
1233 gettimeofday(&tv, NULL);
1235 wsi->pending_timeout_limit = tv.tv_sec + secs;
1236 wsi->pending_timeout = reason;
1241 * libwebsocket_get_socket_fd() - returns the socket file descriptor
1243 * You will not need this unless you are doing something special
1245 * @wsi: Websocket connection instance
1249 libwebsocket_get_socket_fd(struct libwebsocket *wsi)
1256 lws_latency(struct libwebsocket_context *context, struct libwebsocket *wsi, const char *action, int ret, int completed)
1262 gettimeofday(&tv, NULL);
1264 u = (tv.tv_sec * 1000000) + tv.tv_usec;
1268 if (wsi->action_start == wsi->latency_start)
1269 sprintf(buf, "Completion first try lat %luus: %p: ret %d: %s\n", u - wsi->latency_start, (void *)wsi, ret, action);
1271 sprintf(buf, "Completion %luus: lat %luus: %p: ret %d: %s\n", u - wsi->action_start, u - wsi->latency_start, (void *)wsi, ret, action);
1272 wsi->action_start = 0;
1274 sprintf(buf, "lat %luus: %p: ret %d: %s\n", u - wsi->latency_start, (void *)wsi, ret, action);
1275 if (u - wsi->latency_start > context->worst_latency) {
1276 context->worst_latency = u - wsi->latency_start;
1277 strcpy(context->worst_latency_info, buf);
1279 lwsl_latency("%s", buf);
1281 wsi->latency_start = u;
1282 if (!wsi->action_start)
1283 wsi->action_start = u;
1288 #ifdef LWS_NO_SERVER
1290 _libwebsocket_rx_flow_control(struct libwebsocket *wsi)
1296 _libwebsocket_rx_flow_control(struct libwebsocket *wsi)
1298 struct libwebsocket_context *context = wsi->protocol->owning_server;
1301 if (!(wsi->u.ws.rxflow_change_to & 2))
1304 wsi->u.ws.rxflow_change_to &= ~2;
1306 lwsl_info("rxflow: wsi %p change_to %d\n", wsi, wsi->u.ws.rxflow_change_to);
1308 /* if we're letting it come again, did we interrupt anything? */
1309 if ((wsi->u.ws.rxflow_change_to & 1) && wsi->u.ws.rxflow_buffer) {
1310 n = libwebsocket_interpret_incoming_packet(wsi, NULL, 0);
1312 lwsl_info("closing connection at libwebsocket_rx_flow_control:\n");
1313 libwebsocket_close_and_free_session(context, wsi, LWS_CLOSE_STATUS_NOSTATUS);
1317 /* oh he stuck again, do nothing */
1321 if (wsi->u.ws.rxflow_change_to & 1)
1322 context->fds[wsi->position_in_fds_table].events |= POLLIN;
1324 context->fds[wsi->position_in_fds_table].events &= ~POLLIN;
1326 if (wsi->u.ws.rxflow_change_to & 1)
1327 /* external POLL support via protocol 0 */
1328 context->protocols[0].callback(context, wsi,
1329 LWS_CALLBACK_SET_MODE_POLL_FD,
1330 (void *)(long)wsi->sock, NULL, POLLIN);
1332 /* external POLL support via protocol 0 */
1333 context->protocols[0].callback(context, wsi,
1334 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
1335 (void *)(long)wsi->sock, NULL, POLLIN);
1342 * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
1343 * receieved packets.
1345 * If the output side of a server process becomes choked, this allows flow
1346 * control for the input side.
1348 * @wsi: Websocket connection instance to get callback for
1349 * @enable: 0 = disable read servicing for this connection, 1 = enable
1353 libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
1355 wsi->u.ws.rxflow_change_to = 2 | !!enable;
1362 * libwebsocket_canonical_hostname() - returns this host's hostname
1364 * This is typically used by client code to fill in the host parameter
1365 * when making a client connection. You can only call it after the context
1368 * @context: Websocket context
1373 libwebsocket_canonical_hostname(struct libwebsocket_context *context)
1375 return (const char *)context->canonical_hostname;
1379 static void sigpipe_handler(int x)
1383 #ifdef LWS_OPENSSL_SUPPORT
1385 OpenSSL_verify_callback(int preverify_ok, X509_STORE_CTX *x509_ctx)
1390 struct libwebsocket_context *context;
1392 ssl = X509_STORE_CTX_get_ex_data(x509_ctx,
1393 SSL_get_ex_data_X509_STORE_CTX_idx());
1396 * !!! nasty openssl requires the index to come as a library-scope
1399 context = SSL_get_ex_data(ssl, openssl_websocket_private_data_index);
1401 n = context->protocols[0].callback(NULL, NULL,
1402 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION,
1403 x509_ctx, ssl, preverify_ok);
1405 /* convert return code from 0 = OK to 1 = OK */
1416 int user_callback_handle_rxflow(callback_function callback_function,
1417 struct libwebsocket_context * context,
1418 struct libwebsocket *wsi,
1419 enum libwebsocket_callback_reasons reason, void *user,
1420 void *in, size_t len)
1424 n = callback_function(context, wsi, reason, user, in, len);
1426 libwebsocket_close_and_free_session(context, wsi,
1427 LWS_CLOSE_STATUS_NOSTATUS);
1431 _libwebsocket_rx_flow_control(wsi);
1438 * libwebsocket_create_context() - Create the websocket handler
1439 * @port: Port to listen on... you can use 0 to suppress listening on
1440 * any port, that's what you want if you are not running a
1441 * websocket server at all but just using it as a client
1442 * @interf: NULL to bind the listen socket to all interfaces, or the
1443 * interface name, eg, "eth2"
1444 * @protocols: Array of structures listing supported protocols and a protocol-
1445 * specific callback for each one. The list is ended with an
1446 * entry that has a NULL callback pointer.
1447 * It's not const because we write the owning_server member
1448 * @extensions: NULL or array of libwebsocket_extension structs listing the
1449 * extensions this context supports. If you configured with
1450 * --without-extensions, you should give NULL here.
1451 * @ssl_cert_filepath: If libwebsockets was compiled to use ssl, and you want
1452 * to listen using SSL, set to the filepath to fetch the
1453 * server cert from, otherwise NULL for unencrypted
1454 * @ssl_private_key_filepath: filepath to private key if wanting SSL mode,
1456 * @ssl_ca_filepath: CA certificate filepath or NULL
1457 * @gid: group id to change to after setting listen socket, or -1.
1458 * @uid: user id to change to after setting listen socket, or -1.
1459 * @options: 0, or LWS_SERVER_OPTION_DEFEAT_CLIENT_MASK
1460 * @user: optional user pointer that can be recovered via the context
1461 * pointer using libwebsocket_context_user
1463 * This function creates the listening socket and takes care
1464 * of all initialization in one step.
1466 * After initialization, it returns a struct libwebsocket_context * that
1467 * represents this server. After calling, user code needs to take care
1468 * of calling libwebsocket_service() with the context pointer to get the
1469 * server's sockets serviced. This can be done in the same process context
1470 * or a forked process, or another thread,
1472 * The protocol callback functions are called for a handful of events
1473 * including http requests coming in, websocket connections becoming
1474 * established, and data arriving; it's also called periodically to allow
1475 * async transmission.
1477 * HTTP requests are sent always to the FIRST protocol in @protocol, since
1478 * at that time websocket protocol has not been negotiated. Other
1479 * protocols after the first one never see any HTTP callack activity.
1481 * The server created is a simple http server by default; part of the
1482 * websocket standard is upgrading this http connection to a websocket one.
1484 * This allows the same server to provide files like scripts and favicon /
1485 * images or whatever over http and dynamic data over websockets all in
1486 * one place; they're all handled in the user callback.
1489 struct libwebsocket_context *
1490 libwebsocket_create_context(int port, const char *interf,
1491 struct libwebsocket_protocols *protocols,
1492 struct libwebsocket_extension *extensions,
1493 const char *ssl_cert_filepath,
1494 const char *ssl_private_key_filepath,
1495 const char *ssl_ca_filepath,
1496 int gid, int uid, unsigned int options,
1500 struct libwebsocket_context *context = NULL;
1502 #ifndef LWS_NO_SERVER
1504 struct libwebsocket *wsi;
1505 struct sockaddr_in serv_addr;
1507 #ifndef LWS_NO_EXTENSIONS
1511 #ifdef LWS_OPENSSL_SUPPORT
1513 char ssl_err_buf[512];
1516 #ifndef LWS_NO_DAEMONIZE
1517 extern int get_daemonize_pid();
1518 int pid_daemon = get_daemonize_pid();
1521 lwsl_notice("Initial logging level %d\n", log_level);
1522 lwsl_notice("Library version: %s\n", library_version);
1523 lwsl_info(" LWS_MAX_HEADER_NAME_LENGTH: %u\n", LWS_MAX_HEADER_NAME_LENGTH);
1524 lwsl_info(" LWS_MAX_HEADER_LEN: %u\n", LWS_MAX_HEADER_LEN);
1525 lwsl_info(" LWS_INITIAL_HDR_ALLOC: %u\n", LWS_INITIAL_HDR_ALLOC);
1526 lwsl_info(" LWS_ADDITIONAL_HDR_ALLOC: %u\n", LWS_ADDITIONAL_HDR_ALLOC);
1527 lwsl_info(" MAX_USER_RX_BUFFER: %u\n", MAX_USER_RX_BUFFER);
1528 lwsl_info(" LWS_MAX_PROTOCOLS: %u\n", LWS_MAX_PROTOCOLS);
1529 #ifndef LWS_NO_EXTENSIONS
1530 lwsl_info(" LWS_MAX_EXTENSIONS_ACTIVE: %u\n", LWS_MAX_EXTENSIONS_ACTIVE);
1532 lwsl_notice(" Configured without extension support\n");
1534 lwsl_info(" SPEC_LATEST_SUPPORTED: %u\n", SPEC_LATEST_SUPPORTED);
1535 lwsl_info(" AWAITING_TIMEOUT: %u\n", AWAITING_TIMEOUT);
1536 lwsl_info(" CIPHERS_LIST_STRING: '%s'\n", CIPHERS_LIST_STRING);
1537 lwsl_info(" SYSTEM_RANDOM_FILEPATH: '%s'\n", SYSTEM_RANDOM_FILEPATH);
1538 lwsl_info(" LWS_MAX_ZLIB_CONN_BUFFER: %u\n", LWS_MAX_ZLIB_CONN_BUFFER);
1542 WORD wVersionRequested;
1547 /* Use the MAKEWORD(lowbyte, highbyte) macro from Windef.h */
1548 wVersionRequested = MAKEWORD(2, 2);
1550 err = WSAStartup(wVersionRequested, &wsaData);
1552 /* Tell the user that we could not find a usable */
1554 lwsl_err("WSAStartup failed with error: %d\n", err);
1558 /* default to a poll() made out of select() */
1559 poll = emulated_poll;
1561 /* if windows socket lib available, use his WSAPoll */
1562 wsdll = GetModuleHandle(_T("Ws2_32.dll"));
1564 poll = (PFNWSAPOLL)GetProcAddress(wsdll, "WSAPoll");
1566 /* Finally fall back to emulated poll if all else fails */
1568 poll = emulated_poll;
1572 context = (struct libwebsocket_context *) malloc(sizeof(struct libwebsocket_context));
1574 lwsl_err("No memory for websocket context\n");
1577 memset(context, 0, sizeof(*context));
1578 #ifndef LWS_NO_DAEMONIZE
1579 context->started_with_parent = pid_daemon;
1580 lwsl_notice(" Started with daemon pid %d\n", pid_daemon);
1583 context->listen_service_extraseen = 0;
1584 context->protocols = protocols;
1585 context->listen_port = port;
1586 context->http_proxy_port = 0;
1587 context->http_proxy_address[0] = '\0';
1588 context->options = options;
1589 /* to reduce this allocation, */
1590 context->max_fds = getdtablesize();
1591 lwsl_notice(" max fd tracked: %u\n", context->max_fds);
1592 lwsl_notice(" static allocation: %u bytes\n",
1593 (sizeof(struct pollfd) * context->max_fds) +
1594 (sizeof(struct libwebsocket *) * context->max_fds));
1596 context->fds = (struct pollfd *)malloc(sizeof(struct pollfd) * context->max_fds);
1597 if (context->fds == NULL) {
1598 lwsl_err("Unable to allocate fds array for %d connections\n", context->max_fds);
1602 context->lws_lookup = (struct libwebsocket **)malloc(sizeof(struct libwebsocket *) * context->max_fds);
1603 if (context->lws_lookup == NULL) {
1604 lwsl_err("Unable to allocate lws_lookup array for %d connections\n", context->max_fds);
1610 context->fds_count = 0;
1611 #ifndef LWS_NO_EXTENSIONS
1612 context->extensions = extensions;
1614 context->last_timeout_check_s = 0;
1615 context->user_space = user;
1618 context->fd_random = 0;
1620 context->fd_random = open(SYSTEM_RANDOM_FILEPATH, O_RDONLY);
1621 if (context->fd_random < 0) {
1622 lwsl_err("Unable to open random device %s %d\n",
1623 SYSTEM_RANDOM_FILEPATH, context->fd_random);
1628 #ifdef LWS_OPENSSL_SUPPORT
1629 context->use_ssl = 0;
1630 context->ssl_ctx = NULL;
1631 context->ssl_client_ctx = NULL;
1632 openssl_websocket_private_data_index = 0;
1635 strcpy(context->canonical_hostname, "unknown");
1637 #ifndef LWS_NO_SERVER
1638 if (!(options & LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME)) {
1640 char hostname[1024] = "";
1642 /* find canonical hostname */
1644 hostname[(sizeof hostname) - 1] = '\0';
1645 memset(&sa, 0, sizeof(sa));
1646 sa.sa_family = AF_INET;
1647 sa.sa_data[(sizeof sa.sa_data) - 1] = '\0';
1648 gethostname(hostname, (sizeof hostname) - 1);
1652 if (strlen(hostname) < sizeof(sa.sa_data) - 1) {
1653 strcpy(sa.sa_data, hostname);
1654 lwsl_debug("my host name is %s\n", sa.sa_data);
1655 n = getnameinfo(&sa, sizeof(sa), hostname,
1656 (sizeof hostname) - 1, NULL, 0, NI_NAMEREQD);
1660 strncpy(context->canonical_hostname, hostname,
1661 sizeof context->canonical_hostname - 1);
1662 context->canonical_hostname[
1663 sizeof context->canonical_hostname - 1] = '\0';
1665 strncpy(context->canonical_hostname, hostname,
1666 sizeof context->canonical_hostname - 1);
1668 lwsl_notice(" canonical_hostname = %s\n", context->canonical_hostname);
1672 /* split the proxy ads:port if given */
1674 p = getenv("http_proxy");
1676 strncpy(context->http_proxy_address, p,
1677 sizeof context->http_proxy_address - 1);
1678 context->http_proxy_address[
1679 sizeof context->http_proxy_address - 1] = '\0';
1681 p = strchr(context->http_proxy_address, ':');
1683 lwsl_err("http_proxy needs to be ads:port\n");
1687 context->http_proxy_port = atoi(p + 1);
1689 lwsl_notice(" Proxy %s:%u\n",
1690 context->http_proxy_address,
1691 context->http_proxy_port);
1694 #ifndef LWS_NO_SERVER
1697 #ifdef LWS_OPENSSL_SUPPORT
1698 context->use_ssl = ssl_cert_filepath != NULL &&
1699 ssl_private_key_filepath != NULL;
1701 lwsl_notice(" Compiled with CYASSL support\n");
1703 lwsl_notice(" Compiled with OpenSSL support\n");
1705 if (context->use_ssl)
1706 lwsl_notice(" Using SSL mode\n");
1708 lwsl_notice(" Using non-SSL mode\n");
1711 if (ssl_cert_filepath != NULL &&
1712 ssl_private_key_filepath != NULL) {
1713 lwsl_notice(" Not compiled for OpenSSl support!\n");
1716 lwsl_notice(" Compiled without SSL support, "
1717 "serving unencrypted\n");
1720 lwsl_notice(" per-connection allocation: %u + headers\n", sizeof(struct libwebsocket));
1724 /* ignore SIGPIPE */
1727 signal(SIGPIPE, sigpipe_handler);
1731 #ifdef LWS_OPENSSL_SUPPORT
1733 /* basic openssl init */
1737 OpenSSL_add_all_algorithms();
1738 SSL_load_error_strings();
1740 openssl_websocket_private_data_index =
1741 SSL_get_ex_new_index(0, "libwebsockets", NULL, NULL, NULL);
1744 * Firefox insists on SSLv23 not SSLv3
1745 * Konq disables SSLv2 by default now, SSLv23 works
1748 method = (SSL_METHOD *)SSLv23_server_method();
1750 lwsl_err("problem creating ssl method: %s\n",
1751 ERR_error_string(ERR_get_error(), ssl_err_buf));
1754 context->ssl_ctx = SSL_CTX_new(method); /* create context */
1755 if (!context->ssl_ctx) {
1756 lwsl_err("problem creating ssl context: %s\n",
1757 ERR_error_string(ERR_get_error(), ssl_err_buf));
1761 #ifdef SSL_OP_NO_COMPRESSION
1762 SSL_CTX_set_options(context->ssl_ctx, SSL_OP_NO_COMPRESSION);
1764 SSL_CTX_set_options(context->ssl_ctx, SSL_OP_CIPHER_SERVER_PREFERENCE);
1765 SSL_CTX_set_cipher_list(context->ssl_ctx, CIPHERS_LIST_STRING);
1767 #ifndef LWS_NO_CLIENT
1769 /* client context */
1771 if (port == CONTEXT_PORT_NO_LISTEN) {
1772 method = (SSL_METHOD *)SSLv23_client_method();
1774 lwsl_err("problem creating ssl method: %s\n",
1775 ERR_error_string(ERR_get_error(), ssl_err_buf));
1778 /* create context */
1779 context->ssl_client_ctx = SSL_CTX_new(method);
1780 if (!context->ssl_client_ctx) {
1781 lwsl_err("problem creating ssl context: %s\n",
1782 ERR_error_string(ERR_get_error(), ssl_err_buf));
1786 #ifdef SSL_OP_NO_COMPRESSION
1787 SSL_CTX_set_options(context->ssl_client_ctx, SSL_OP_NO_COMPRESSION);
1789 SSL_CTX_set_options(context->ssl_client_ctx, SSL_OP_CIPHER_SERVER_PREFERENCE);
1790 SSL_CTX_set_cipher_list(context->ssl_client_ctx, CIPHERS_LIST_STRING);
1792 /* openssl init for cert verification (for client sockets) */
1793 if (!ssl_ca_filepath) {
1794 if (!SSL_CTX_load_verify_locations(
1795 context->ssl_client_ctx, NULL,
1796 LWS_OPENSSL_CLIENT_CERTS))
1798 "Unable to load SSL Client certs from %s "
1799 "(set by --with-client-cert-dir= in configure) -- "
1800 " client ssl isn't going to work",
1801 LWS_OPENSSL_CLIENT_CERTS);
1803 if (!SSL_CTX_load_verify_locations(
1804 context->ssl_client_ctx, ssl_ca_filepath,
1807 "Unable to load SSL Client certs "
1808 "file from %s -- client ssl isn't "
1809 "going to work", ssl_ca_filepath);
1812 * callback allowing user code to load extra verification certs
1813 * helping the client to verify server identity
1816 context->protocols[0].callback(context, NULL,
1817 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS,
1818 context->ssl_client_ctx, NULL, 0);
1822 /* as a server, are we requiring clients to identify themselves? */
1824 if (options & LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT) {
1826 /* absolutely require the client cert */
1828 SSL_CTX_set_verify(context->ssl_ctx,
1829 SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
1830 OpenSSL_verify_callback);
1833 * give user code a chance to load certs into the server
1834 * allowing it to verify incoming client certs
1837 context->protocols[0].callback(context, NULL,
1838 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS,
1839 context->ssl_ctx, NULL, 0);
1842 if (context->use_ssl) {
1844 /* openssl init for server sockets */
1846 /* set the local certificate from CertFile */
1847 n = SSL_CTX_use_certificate_chain_file(context->ssl_ctx,
1850 lwsl_err("problem getting cert '%s': %s\n",
1852 ERR_error_string(ERR_get_error(), ssl_err_buf));
1855 /* set the private key from KeyFile */
1856 if (SSL_CTX_use_PrivateKey_file(context->ssl_ctx,
1857 ssl_private_key_filepath, SSL_FILETYPE_PEM) != 1) {
1858 lwsl_err("ssl problem getting key '%s': %s\n",
1859 ssl_private_key_filepath,
1860 ERR_error_string(ERR_get_error(), ssl_err_buf));
1863 /* verify private key */
1864 if (!SSL_CTX_check_private_key(context->ssl_ctx)) {
1865 lwsl_err("Private SSL key doesn't match cert\n");
1869 /* SSL is happy and has a cert it's content with */
1875 if (lws_b64_selftest())
1878 #ifndef LWS_NO_SERVER
1879 /* set up our external listening socket we serve on */
1882 extern int interface_to_sa(const char *ifname, struct sockaddr_in *addr, size_t addrlen);
1885 sockfd = socket(AF_INET, SOCK_STREAM, 0);
1887 lwsl_err("ERROR opening socket\n");
1892 /* allow us to restart even if old sockets in TIME_WAIT
1893 * (REUSEADDR on Unix means, "don't hang on to this address after the
1894 * listener is closed." On Windows, though, it means "don't keep other
1895 * processes from binding to this address while we're using it) */
1896 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR,
1897 (const void *)&opt, sizeof(opt));
1902 setsockopt(sockfd, IPPROTO_TCP, TCP_NODELAY,
1903 (const void *)&opt, sizeof(opt));
1907 ioctlsocket(sockfd, FIONBIO, (unsigned long *)&opt );
1909 fcntl(sockfd, F_SETFL, O_NONBLOCK);
1912 bzero((char *) &serv_addr, sizeof(serv_addr));
1913 serv_addr.sin_family = AF_INET;
1915 serv_addr.sin_addr.s_addr = INADDR_ANY;
1917 interface_to_sa(interf, &serv_addr,
1919 serv_addr.sin_port = htons(port);
1921 n = bind(sockfd, (struct sockaddr *) &serv_addr,
1924 lwsl_err("ERROR on binding to port %d (%d %d)\n",
1930 wsi = (struct libwebsocket *)malloc(sizeof(struct libwebsocket));
1932 lwsl_err("Out of mem\n");
1936 memset(wsi, 0, sizeof (struct libwebsocket));
1938 #ifndef LWS_NO_EXTENSIONS
1939 wsi->count_active_extensions = 0;
1941 wsi->mode = LWS_CONNMODE_SERVER_LISTENER;
1943 insert_wsi_socket_into_fds(context, wsi);
1945 context->listen_service_modulo = LWS_LISTEN_SERVICE_MODULO;
1946 context->listen_service_count = 0;
1947 context->listen_service_fd = sockfd;
1949 listen(sockfd, LWS_SOMAXCONN);
1950 lwsl_notice(" Listening on port %d\n", port);
1955 * drop any root privs for this process
1956 * to listen on port < 1023 we would have needed root, but now we are
1957 * listening, we don't want the power for anything else
1963 lwsl_warn("setgid: %s\n", strerror(errno));
1966 lwsl_warn("setuid: %s\n", strerror(errno));
1969 /* initialize supported protocols */
1971 for (context->count_protocols = 0;
1972 protocols[context->count_protocols].callback;
1973 context->count_protocols++) {
1975 lwsl_parser(" Protocol: %s\n",
1976 protocols[context->count_protocols].name);
1978 protocols[context->count_protocols].owning_server = context;
1979 protocols[context->count_protocols].protocol_index =
1980 context->count_protocols;
1983 #ifndef LWS_NO_EXTENSIONS
1985 * give all extensions a chance to create any per-context
1986 * allocations they need
1989 m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_CONSTRUCT;
1991 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_CONSTRUCT;
1994 while (extensions->callback) {
1995 lwsl_ext(" Extension: %s\n", extensions->name);
1996 extensions->callback(context, extensions, NULL,
1997 (enum libwebsocket_extension_callback_reasons)m,
2006 libwebsocket_context_destroy(context);
2011 * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
2013 * @wsi: pointer to struct websocket you want to know the protocol of
2016 * Some apis can act on all live connections of a given protocol,
2017 * this is how you can get a pointer to the active protocol if needed.
2020 const struct libwebsocket_protocols *
2021 libwebsockets_get_protocol(struct libwebsocket *wsi)
2023 return wsi->protocol;
2027 libwebsocket_is_final_fragment(struct libwebsocket *wsi)
2029 return wsi->u.ws.final;
2033 libwebsocket_get_reserved_bits(struct libwebsocket *wsi)
2035 return wsi->u.ws.rsv;
2039 libwebsocket_ensure_user_space(struct libwebsocket *wsi)
2041 /* allocate the per-connection user memory (if any) */
2043 if (wsi->protocol->per_session_data_size && !wsi->user_space) {
2044 wsi->user_space = malloc(
2045 wsi->protocol->per_session_data_size);
2046 if (wsi->user_space == NULL) {
2047 lwsl_err("Out of memory for conn user space\n");
2050 memset(wsi->user_space, 0,
2051 wsi->protocol->per_session_data_size);
2053 return wsi->user_space;
2056 static void lwsl_emit_stderr(int level, const char *line)
2062 gettimeofday(&tv, NULL);
2065 for (n = 0; n < LLL_COUNT; n++)
2066 if (level == (1 << n)) {
2067 sprintf(buf, "[%ld:%04d] %s: ", tv.tv_sec,
2068 (int)(tv.tv_usec / 100), log_level_names[n]);
2072 fprintf(stderr, "%s%s", buf, line);
2076 void lwsl_emit_syslog(int level, const char *line)
2078 lwsl_emit_stderr(level, line);
2081 void lwsl_emit_syslog(int level, const char *line)
2083 int syslog_level = LOG_DEBUG;
2087 syslog_level = LOG_ERR;
2090 syslog_level = LOG_WARNING;
2093 syslog_level = LOG_NOTICE;
2096 syslog_level = LOG_INFO;
2099 syslog(syslog_level, "%s", line);
2103 void _lws_log(int filter, const char *format, ...)
2108 if (!(log_level & filter))
2111 va_start(ap, format);
2112 vsnprintf(buf, (sizeof buf), format, ap);
2113 buf[(sizeof buf) - 1] = '\0';
2116 lwsl_emit(filter, buf);
2120 * lws_set_log_level() - Set the logging bitfield
2121 * @level: OR together the LLL_ debug contexts you want output from
2122 * @log_emit_function: NULL to leave it as it is, or a user-supplied
2123 * function to perform log string emission instead of
2124 * the default stderr one.
2126 * log level defaults to "err" and "warn" contexts enabled only and
2127 * emission on stderr.
2130 void lws_set_log_level(int level, void (*log_emit_function)(int level, const char *line))
2133 if (log_emit_function)
2134 lwsl_emit = log_emit_function;