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 #ifdef LWS_OPENSSL_SUPPORT
723 char ssl_err_buf[512];
726 #ifndef LWS_NO_EXTENSIONS
729 struct lws_tokens eff_buf;
730 #ifndef LWS_NO_CLIENT
731 extern int lws_client_socket_service(struct libwebsocket_context *context, struct libwebsocket *wsi, struct pollfd *pollfd);
733 #ifndef LWS_NO_SERVER
734 extern int lws_server_socket_service(struct libwebsocket_context *context, struct libwebsocket *wsi, struct pollfd *pollfd);
737 * you can call us with pollfd = NULL to just allow the once-per-second
738 * global timeout checks; if less than a second since the last check
739 * it returns immediately then.
742 gettimeofday(&tv, NULL);
744 if (context->last_timeout_check_s != tv.tv_sec) {
745 context->last_timeout_check_s = tv.tv_sec;
748 /* if our parent went down, don't linger around */
749 if (context->started_with_parent && kill(context->started_with_parent, 0) < 0)
750 kill(getpid(), SIGTERM);
753 /* global timeout check once per second */
755 for (n = 0; n < context->fds_count; n++) {
756 struct libwebsocket *new_wsi = context->lws_lookup[context->fds[n].fd];
759 libwebsocket_service_timeout_check(context,
764 /* just here for timeout management? */
769 /* no, here to service a socket descriptor */
772 * deal with listen service piggybacking
773 * every listen_service_modulo services of other fds, we
774 * sneak one in to service the listen socket if there's anything waiting
776 * To handle connection storms, as found in ab, if we previously saw a
777 * pending connection here, it causes us to check again next time.
780 if (context->listen_service_fd && pollfd->fd != context->listen_service_fd) {
781 context->listen_service_count++;
782 if (context->listen_service_extraseen ||
783 context->listen_service_count == context->listen_service_modulo) {
784 context->listen_service_count = 0;
786 if (context->listen_service_extraseen > 5)
789 /* even with extpoll, we prepared this internal fds for listen */
790 n = poll(&context->fds[0], 1, 0);
791 if (n > 0) { /* there's a connection waiting for us */
792 libwebsocket_service_fd(context, &context->fds[0]);
793 context->listen_service_extraseen++;
795 if (context->listen_service_extraseen)
796 context->listen_service_extraseen--;
804 /* okay, what we came here to do... */
806 wsi = context->lws_lookup[pollfd->fd];
809 lwsl_err("unexpected NULL wsi fd=%d fds_count=%d\n", pollfd->fd, context->fds_count);
815 #ifndef LWS_NO_SERVER
816 case LWS_CONNMODE_HTTP_SERVING:
817 case LWS_CONNMODE_SERVER_LISTENER:
818 case LWS_CONNMODE_SSL_ACK_PENDING:
819 return lws_server_socket_service(context, wsi, pollfd);
822 case LWS_CONNMODE_WS_SERVING:
823 case LWS_CONNMODE_WS_CLIENT:
825 /* handle session socket closed */
827 if (pollfd->revents & (POLLERR | POLLHUP)) {
829 lwsl_debug("Session Socket %p (fd=%d) dead\n",
830 (void *)wsi, pollfd->fd);
832 libwebsocket_close_and_free_session(context, wsi,
833 LWS_CLOSE_STATUS_NOSTATUS);
837 /* the guy requested a callback when it was OK to write */
839 if ((pollfd->revents & POLLOUT) &&
840 wsi->state == WSI_STATE_ESTABLISHED)
841 if (lws_handle_POLLOUT_event(context, wsi,
843 libwebsocket_close_and_free_session(
844 context, wsi, LWS_CLOSE_STATUS_NORMAL);
849 /* any incoming data ready? */
851 if (!(pollfd->revents & POLLIN))
854 #ifdef LWS_OPENSSL_SUPPORT
857 eff_buf.token_len = SSL_read(wsi->ssl,
858 context->service_buffer,
859 sizeof context->service_buffer);
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",
863 ERR_error_string(n, ssl_err_buf));
867 eff_buf.token_len = recv(pollfd->fd,
868 context->service_buffer,
869 sizeof context->service_buffer, 0);
871 if (eff_buf.token_len < 0) {
872 lwsl_debug("Socket read returned %d\n",
874 if (errno != EINTR && errno != EAGAIN)
875 libwebsocket_close_and_free_session(context,
876 wsi, LWS_CLOSE_STATUS_NOSTATUS);
879 if (!eff_buf.token_len) {
880 lwsl_info("closing connection due to zero length read\n");
881 libwebsocket_close_and_free_session(context, wsi,
882 LWS_CLOSE_STATUS_NOSTATUS);
887 * give any active extensions a chance to munge the buffer
888 * before parse. We pass in a pointer to an lws_tokens struct
889 * prepared with the default buffer and content length that's in
890 * there. Rather than rewrite the default buffer, extensions
891 * that expect to grow the buffer can adapt .token to
892 * point to their own per-connection buffer in the extension
893 * user allocation. By default with no extensions or no
894 * extension callback handling, just the normal input buffer is
895 * used then so it is efficient.
898 eff_buf.token = (char *)context->service_buffer;
899 #ifndef LWS_NO_EXTENSIONS
905 for (n = 0; n < wsi->count_active_extensions; n++) {
906 m = wsi->active_extensions[n]->callback(context,
907 wsi->active_extensions[n], wsi,
908 LWS_EXT_CALLBACK_PACKET_RX_PREPARSE,
909 wsi->active_extensions_user[n],
913 "Extension reports fatal error\n");
914 libwebsocket_close_and_free_session(
916 LWS_CLOSE_STATUS_NOSTATUS);
923 /* service incoming data */
925 if (eff_buf.token_len) {
926 n = libwebsocket_read(context, wsi,
927 (unsigned char *)eff_buf.token,
933 #ifndef LWS_NO_EXTENSIONS
934 eff_buf.token = NULL;
935 eff_buf.token_len = 0;
939 #ifdef LWS_OPENSSL_SUPPORT
940 if (wsi->ssl && SSL_pending(wsi->ssl))
949 return lws_client_socket_service(context, wsi, pollfd);
958 * libwebsocket_context_destroy() - Destroy the websocket context
959 * @context: Websocket context
961 * This function closes any active connections and then frees the
962 * context. After calling this, any further use of the context is
966 libwebsocket_context_destroy(struct libwebsocket_context *context)
968 #ifndef LWS_NO_EXTENSIONS
971 struct libwebsocket_extension *ext;
974 if (context->worst_latency_info[0])
975 lwsl_notice("Worst latency: %s\n", context->worst_latency_info);
978 for (n = 0; n < context->fds_count; n++) {
979 struct libwebsocket *wsi = context->lws_lookup[context->fds[n].fd];
980 libwebsocket_close_and_free_session(context,
981 wsi, LWS_CLOSE_STATUS_GOINGAWAY);
985 * give all extensions a chance to clean up any per-context
986 * allocations they might have made
989 ext = context->extensions;
990 m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_DESTRUCT;
991 if (context->listen_port)
992 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_DESTRUCT;
993 while (ext && ext->callback) {
994 ext->callback(context, ext, NULL, (enum libwebsocket_extension_callback_reasons)m, NULL, NULL, 0);
1001 close(context->fd_random);
1004 #ifdef LWS_OPENSSL_SUPPORT
1005 if (context->ssl_ctx)
1006 SSL_CTX_free(context->ssl_ctx);
1007 if (context->ssl_client_ctx)
1008 SSL_CTX_free(context->ssl_client_ctx);
1019 * libwebsocket_context_user() - get the user data associated with the whole context
1020 * @context: Websocket context
1022 * This returns the optional user allocation that can be attached to
1023 * the context the sockets live in at context_create time. It's a way
1024 * to let all sockets serviced in the same context share data without
1025 * using globals statics in the user code.
1030 libwebsocket_context_user(struct libwebsocket_context *context)
1032 return context->user_space;
1036 * libwebsocket_service() - Service any pending websocket activity
1037 * @context: Websocket context
1038 * @timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
1039 * service otherwise block and service immediately, returning
1040 * after the timeout if nothing needed service.
1042 * This function deals with any pending websocket traffic, for three
1043 * kinds of event. It handles these events on both server and client
1044 * types of connection the same.
1046 * 1) Accept new connections to our context's server
1048 * 2) Call the receive callback for incoming frame data received by
1049 * server or client connections.
1051 * You need to call this service function periodically to all the above
1052 * functions to happen; if your application is single-threaded you can
1053 * just call it in your main event loop.
1055 * Alternatively you can fork a new process that asynchronously handles
1056 * calling this service in a loop. In that case you are happy if this
1057 * call blocks your thread until it needs to take care of something and
1058 * would call it with a large nonzero timeout. Your loop then takes no
1059 * CPU while there is nothing happening.
1061 * If you are calling it in a single-threaded app, you don't want it to
1062 * wait around blocking other things in your loop from happening, so you
1063 * would call it with a timeout_ms of 0, so it returns immediately if
1064 * nothing is pending, or as soon as it services whatever was pending.
1069 libwebsocket_service(struct libwebsocket_context *context, int timeout_ms)
1073 /* stay dead once we are dead */
1075 if (context == NULL)
1078 /* wait for something to need service */
1080 n = poll(context->fds, context->fds_count, timeout_ms);
1081 if (n == 0) /* poll timeout */
1087 /* any socket with events to service? */
1089 for (n = 0; n < context->fds_count; n++)
1090 if (context->fds[n].revents)
1091 if (libwebsocket_service_fd(context,
1092 &context->fds[n]) < 0)
1097 #ifndef LWS_NO_EXTENSIONS
1099 lws_any_extension_handled(struct libwebsocket_context *context,
1100 struct libwebsocket *wsi,
1101 enum libwebsocket_extension_callback_reasons r,
1102 void *v, size_t len)
1107 /* maybe an extension will take care of it for us */
1109 for (n = 0; n < wsi->count_active_extensions && !handled; n++) {
1110 if (!wsi->active_extensions[n]->callback)
1113 handled |= wsi->active_extensions[n]->callback(context,
1114 wsi->active_extensions[n], wsi,
1115 r, wsi->active_extensions_user[n], v, len);
1123 lws_get_extension_user_matching_ext(struct libwebsocket *wsi,
1124 struct libwebsocket_extension *ext)
1131 while (n < wsi->count_active_extensions) {
1132 if (wsi->active_extensions[n] != ext) {
1136 return wsi->active_extensions_user[n];
1144 * libwebsocket_callback_on_writable() - Request a callback when this socket
1145 * becomes able to be written to without
1148 * @context: libwebsockets context
1149 * @wsi: Websocket connection instance to get callback for
1153 libwebsocket_callback_on_writable(struct libwebsocket_context *context,
1154 struct libwebsocket *wsi)
1156 #ifndef LWS_NO_EXTENSIONS
1160 /* maybe an extension will take care of it for us */
1162 for (n = 0; n < wsi->count_active_extensions; n++) {
1163 if (!wsi->active_extensions[n]->callback)
1166 handled |= wsi->active_extensions[n]->callback(context,
1167 wsi->active_extensions[n], wsi,
1168 LWS_EXT_CALLBACK_REQUEST_ON_WRITEABLE,
1169 wsi->active_extensions_user[n], NULL, 0);
1175 if (wsi->position_in_fds_table < 0) {
1176 lwsl_err("libwebsocket_callback_on_writable: "
1177 "failed to find socket %d\n", wsi->sock);
1181 context->fds[wsi->position_in_fds_table].events |= POLLOUT;
1183 /* external POLL support via protocol 0 */
1184 context->protocols[0].callback(context, wsi,
1185 LWS_CALLBACK_SET_MODE_POLL_FD,
1186 (void *)(long)wsi->sock, NULL, POLLOUT);
1192 * libwebsocket_callback_on_writable_all_protocol() - Request a callback for
1193 * all connections using the given protocol when it
1194 * becomes possible to write to each socket without
1197 * @protocol: Protocol whose connections will get callbacks
1201 libwebsocket_callback_on_writable_all_protocol(
1202 const struct libwebsocket_protocols *protocol)
1204 struct libwebsocket_context *context = protocol->owning_server;
1206 struct libwebsocket *wsi;
1208 for (n = 0; n < context->fds_count; n++) {
1209 wsi = context->lws_lookup[context->fds[n].fd];
1212 if (wsi->protocol == protocol)
1213 libwebsocket_callback_on_writable(context, wsi);
1220 * libwebsocket_set_timeout() - marks the wsi as subject to a timeout
1222 * You will not need this unless you are doing something special
1224 * @wsi: Websocket connection instance
1225 * @reason: timeout reason
1226 * @secs: how many seconds
1230 libwebsocket_set_timeout(struct libwebsocket *wsi,
1231 enum pending_timeout reason, int secs)
1235 gettimeofday(&tv, NULL);
1237 wsi->pending_timeout_limit = tv.tv_sec + secs;
1238 wsi->pending_timeout = reason;
1243 * libwebsocket_get_socket_fd() - returns the socket file descriptor
1245 * You will not need this unless you are doing something special
1247 * @wsi: Websocket connection instance
1251 libwebsocket_get_socket_fd(struct libwebsocket *wsi)
1258 lws_latency(struct libwebsocket_context *context, struct libwebsocket *wsi, const char *action, int ret, int completed)
1264 gettimeofday(&tv, NULL);
1266 u = (tv.tv_sec * 1000000) + tv.tv_usec;
1270 if (wsi->action_start == wsi->latency_start)
1271 sprintf(buf, "Completion first try lat %luus: %p: ret %d: %s\n", u - wsi->latency_start, (void *)wsi, ret, action);
1273 sprintf(buf, "Completion %luus: lat %luus: %p: ret %d: %s\n", u - wsi->action_start, u - wsi->latency_start, (void *)wsi, ret, action);
1274 wsi->action_start = 0;
1276 sprintf(buf, "lat %luus: %p: ret %d: %s\n", u - wsi->latency_start, (void *)wsi, ret, action);
1277 if (u - wsi->latency_start > context->worst_latency) {
1278 context->worst_latency = u - wsi->latency_start;
1279 strcpy(context->worst_latency_info, buf);
1281 lwsl_latency("%s", buf);
1283 wsi->latency_start = u;
1284 if (!wsi->action_start)
1285 wsi->action_start = u;
1290 #ifdef LWS_NO_SERVER
1292 _libwebsocket_rx_flow_control(struct libwebsocket *wsi)
1298 _libwebsocket_rx_flow_control(struct libwebsocket *wsi)
1300 struct libwebsocket_context *context = wsi->protocol->owning_server;
1303 if (!(wsi->u.ws.rxflow_change_to & 2))
1306 wsi->u.ws.rxflow_change_to &= ~2;
1308 lwsl_info("rxflow: wsi %p change_to %d\n", wsi, wsi->u.ws.rxflow_change_to);
1310 /* if we're letting it come again, did we interrupt anything? */
1311 if ((wsi->u.ws.rxflow_change_to & 1) && wsi->u.ws.rxflow_buffer) {
1312 n = libwebsocket_interpret_incoming_packet(wsi, NULL, 0);
1314 lwsl_info("closing connection at libwebsocket_rx_flow_control:\n");
1315 libwebsocket_close_and_free_session(context, wsi, LWS_CLOSE_STATUS_NOSTATUS);
1319 /* oh he stuck again, do nothing */
1323 if (wsi->u.ws.rxflow_change_to & 1)
1324 context->fds[wsi->position_in_fds_table].events |= POLLIN;
1326 context->fds[wsi->position_in_fds_table].events &= ~POLLIN;
1328 if (wsi->u.ws.rxflow_change_to & 1)
1329 /* external POLL support via protocol 0 */
1330 context->protocols[0].callback(context, wsi,
1331 LWS_CALLBACK_SET_MODE_POLL_FD,
1332 (void *)(long)wsi->sock, NULL, POLLIN);
1334 /* external POLL support via protocol 0 */
1335 context->protocols[0].callback(context, wsi,
1336 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
1337 (void *)(long)wsi->sock, NULL, POLLIN);
1344 * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
1345 * receieved packets.
1347 * If the output side of a server process becomes choked, this allows flow
1348 * control for the input side.
1350 * @wsi: Websocket connection instance to get callback for
1351 * @enable: 0 = disable read servicing for this connection, 1 = enable
1355 libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
1357 wsi->u.ws.rxflow_change_to = 2 | !!enable;
1364 * libwebsocket_canonical_hostname() - returns this host's hostname
1366 * This is typically used by client code to fill in the host parameter
1367 * when making a client connection. You can only call it after the context
1370 * @context: Websocket context
1375 libwebsocket_canonical_hostname(struct libwebsocket_context *context)
1377 return (const char *)context->canonical_hostname;
1381 static void sigpipe_handler(int x)
1385 #ifdef LWS_OPENSSL_SUPPORT
1387 OpenSSL_verify_callback(int preverify_ok, X509_STORE_CTX *x509_ctx)
1392 struct libwebsocket_context *context;
1394 ssl = X509_STORE_CTX_get_ex_data(x509_ctx,
1395 SSL_get_ex_data_X509_STORE_CTX_idx());
1398 * !!! nasty openssl requires the index to come as a library-scope
1401 context = SSL_get_ex_data(ssl, openssl_websocket_private_data_index);
1403 n = context->protocols[0].callback(NULL, NULL,
1404 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION,
1405 x509_ctx, ssl, preverify_ok);
1407 /* convert return code from 0 = OK to 1 = OK */
1418 int user_callback_handle_rxflow(callback_function callback_function,
1419 struct libwebsocket_context * context,
1420 struct libwebsocket *wsi,
1421 enum libwebsocket_callback_reasons reason, void *user,
1422 void *in, size_t len)
1426 n = callback_function(context, wsi, reason, user, in, len);
1428 libwebsocket_close_and_free_session(context, wsi,
1429 LWS_CLOSE_STATUS_NOSTATUS);
1433 _libwebsocket_rx_flow_control(wsi);
1440 * libwebsocket_create_context() - Create the websocket handler
1441 * @port: Port to listen on... you can use 0 to suppress listening on
1442 * any port, that's what you want if you are not running a
1443 * websocket server at all but just using it as a client
1444 * @interf: NULL to bind the listen socket to all interfaces, or the
1445 * interface name, eg, "eth2"
1446 * @protocols: Array of structures listing supported protocols and a protocol-
1447 * specific callback for each one. The list is ended with an
1448 * entry that has a NULL callback pointer.
1449 * It's not const because we write the owning_server member
1450 * @extensions: NULL or array of libwebsocket_extension structs listing the
1451 * extensions this context supports. If you configured with
1452 * --without-extensions, you should give NULL here.
1453 * @ssl_cert_filepath: If libwebsockets was compiled to use ssl, and you want
1454 * to listen using SSL, set to the filepath to fetch the
1455 * server cert from, otherwise NULL for unencrypted
1456 * @ssl_private_key_filepath: filepath to private key if wanting SSL mode,
1458 * @ssl_ca_filepath: CA certificate filepath or NULL
1459 * @gid: group id to change to after setting listen socket, or -1.
1460 * @uid: user id to change to after setting listen socket, or -1.
1461 * @options: 0, or LWS_SERVER_OPTION_DEFEAT_CLIENT_MASK
1462 * @user: optional user pointer that can be recovered via the context
1463 * pointer using libwebsocket_context_user
1465 * This function creates the listening socket and takes care
1466 * of all initialization in one step.
1468 * After initialization, it returns a struct libwebsocket_context * that
1469 * represents this server. After calling, user code needs to take care
1470 * of calling libwebsocket_service() with the context pointer to get the
1471 * server's sockets serviced. This can be done in the same process context
1472 * or a forked process, or another thread,
1474 * The protocol callback functions are called for a handful of events
1475 * including http requests coming in, websocket connections becoming
1476 * established, and data arriving; it's also called periodically to allow
1477 * async transmission.
1479 * HTTP requests are sent always to the FIRST protocol in @protocol, since
1480 * at that time websocket protocol has not been negotiated. Other
1481 * protocols after the first one never see any HTTP callack activity.
1483 * The server created is a simple http server by default; part of the
1484 * websocket standard is upgrading this http connection to a websocket one.
1486 * This allows the same server to provide files like scripts and favicon /
1487 * images or whatever over http and dynamic data over websockets all in
1488 * one place; they're all handled in the user callback.
1491 struct libwebsocket_context *
1492 libwebsocket_create_context(int port, const char *interf,
1493 struct libwebsocket_protocols *protocols,
1494 struct libwebsocket_extension *extensions,
1495 const char *ssl_cert_filepath,
1496 const char *ssl_private_key_filepath,
1497 const char *ssl_ca_filepath,
1498 int gid, int uid, unsigned int options,
1502 struct libwebsocket_context *context = NULL;
1504 #ifndef LWS_NO_SERVER
1506 struct libwebsocket *wsi;
1507 struct sockaddr_in serv_addr;
1509 #ifndef LWS_NO_EXTENSIONS
1513 #ifdef LWS_OPENSSL_SUPPORT
1515 char ssl_err_buf[512];
1518 #ifndef LWS_NO_DAEMONIZE
1519 extern int get_daemonize_pid();
1520 int pid_daemon = get_daemonize_pid();
1523 lwsl_notice("Initial logging level %d\n", log_level);
1524 lwsl_notice("Library version: %s\n", library_version);
1525 lwsl_info(" LWS_MAX_HEADER_NAME_LENGTH: %u\n", LWS_MAX_HEADER_NAME_LENGTH);
1526 lwsl_info(" LWS_MAX_HEADER_LEN: %u\n", LWS_MAX_HEADER_LEN);
1527 lwsl_info(" LWS_INITIAL_HDR_ALLOC: %u\n", LWS_INITIAL_HDR_ALLOC);
1528 lwsl_info(" LWS_ADDITIONAL_HDR_ALLOC: %u\n", LWS_ADDITIONAL_HDR_ALLOC);
1529 lwsl_info(" MAX_USER_RX_BUFFER: %u\n", MAX_USER_RX_BUFFER);
1530 lwsl_info(" LWS_MAX_PROTOCOLS: %u\n", LWS_MAX_PROTOCOLS);
1531 #ifndef LWS_NO_EXTENSIONS
1532 lwsl_info(" LWS_MAX_EXTENSIONS_ACTIVE: %u\n", LWS_MAX_EXTENSIONS_ACTIVE);
1534 lwsl_notice(" Configured without extension support\n");
1536 lwsl_info(" SPEC_LATEST_SUPPORTED: %u\n", SPEC_LATEST_SUPPORTED);
1537 lwsl_info(" AWAITING_TIMEOUT: %u\n", AWAITING_TIMEOUT);
1538 lwsl_info(" CIPHERS_LIST_STRING: '%s'\n", CIPHERS_LIST_STRING);
1539 lwsl_info(" SYSTEM_RANDOM_FILEPATH: '%s'\n", SYSTEM_RANDOM_FILEPATH);
1540 lwsl_info(" LWS_MAX_ZLIB_CONN_BUFFER: %u\n", LWS_MAX_ZLIB_CONN_BUFFER);
1544 WORD wVersionRequested;
1549 /* Use the MAKEWORD(lowbyte, highbyte) macro from Windef.h */
1550 wVersionRequested = MAKEWORD(2, 2);
1552 err = WSAStartup(wVersionRequested, &wsaData);
1554 /* Tell the user that we could not find a usable */
1556 lwsl_err("WSAStartup failed with error: %d\n", err);
1560 /* default to a poll() made out of select() */
1561 poll = emulated_poll;
1563 /* if windows socket lib available, use his WSAPoll */
1564 wsdll = GetModuleHandle(_T("Ws2_32.dll"));
1566 poll = (PFNWSAPOLL)GetProcAddress(wsdll, "WSAPoll");
1568 /* Finally fall back to emulated poll if all else fails */
1570 poll = emulated_poll;
1574 context = (struct libwebsocket_context *) malloc(sizeof(struct libwebsocket_context));
1576 lwsl_err("No memory for websocket context\n");
1579 memset(context, 0, sizeof(*context));
1580 #ifndef LWS_NO_DAEMONIZE
1581 context->started_with_parent = pid_daemon;
1582 lwsl_notice(" Started with daemon pid %d\n", pid_daemon);
1585 context->listen_service_extraseen = 0;
1586 context->protocols = protocols;
1587 context->listen_port = port;
1588 context->http_proxy_port = 0;
1589 context->http_proxy_address[0] = '\0';
1590 context->options = options;
1591 /* to reduce this allocation, */
1592 context->max_fds = getdtablesize();
1593 lwsl_notice(" max fd tracked: %u\n", context->max_fds);
1594 lwsl_notice(" static allocation: %u bytes\n",
1595 (sizeof(struct pollfd) * context->max_fds) +
1596 (sizeof(struct libwebsocket *) * context->max_fds));
1598 context->fds = (struct pollfd *)malloc(sizeof(struct pollfd) * context->max_fds);
1599 if (context->fds == NULL) {
1600 lwsl_err("Unable to allocate fds array for %d connections\n", context->max_fds);
1604 context->lws_lookup = (struct libwebsocket **)malloc(sizeof(struct libwebsocket *) * context->max_fds);
1605 if (context->lws_lookup == NULL) {
1606 lwsl_err("Unable to allocate lws_lookup array for %d connections\n", context->max_fds);
1612 context->fds_count = 0;
1613 #ifndef LWS_NO_EXTENSIONS
1614 context->extensions = extensions;
1616 context->last_timeout_check_s = 0;
1617 context->user_space = user;
1620 context->fd_random = 0;
1622 context->fd_random = open(SYSTEM_RANDOM_FILEPATH, O_RDONLY);
1623 if (context->fd_random < 0) {
1624 lwsl_err("Unable to open random device %s %d\n",
1625 SYSTEM_RANDOM_FILEPATH, context->fd_random);
1630 #ifdef LWS_OPENSSL_SUPPORT
1631 context->use_ssl = 0;
1632 context->ssl_ctx = NULL;
1633 context->ssl_client_ctx = NULL;
1634 openssl_websocket_private_data_index = 0;
1637 strcpy(context->canonical_hostname, "unknown");
1639 #ifndef LWS_NO_SERVER
1640 if (!(options & LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME)) {
1642 char hostname[1024] = "";
1644 /* find canonical hostname */
1646 hostname[(sizeof hostname) - 1] = '\0';
1647 memset(&sa, 0, sizeof(sa));
1648 sa.sa_family = AF_INET;
1649 sa.sa_data[(sizeof sa.sa_data) - 1] = '\0';
1650 gethostname(hostname, (sizeof hostname) - 1);
1654 if (strlen(hostname) < sizeof(sa.sa_data) - 1) {
1655 strcpy(sa.sa_data, hostname);
1656 lwsl_debug("my host name is %s\n", sa.sa_data);
1657 n = getnameinfo(&sa, sizeof(sa), hostname,
1658 (sizeof hostname) - 1, NULL, 0, NI_NAMEREQD);
1662 strncpy(context->canonical_hostname, hostname,
1663 sizeof context->canonical_hostname - 1);
1664 context->canonical_hostname[
1665 sizeof context->canonical_hostname - 1] = '\0';
1667 strncpy(context->canonical_hostname, hostname,
1668 sizeof context->canonical_hostname - 1);
1670 lwsl_notice(" canonical_hostname = %s\n", context->canonical_hostname);
1674 /* split the proxy ads:port if given */
1676 p = getenv("http_proxy");
1678 strncpy(context->http_proxy_address, p,
1679 sizeof context->http_proxy_address - 1);
1680 context->http_proxy_address[
1681 sizeof context->http_proxy_address - 1] = '\0';
1683 p = strchr(context->http_proxy_address, ':');
1685 lwsl_err("http_proxy needs to be ads:port\n");
1689 context->http_proxy_port = atoi(p + 1);
1691 lwsl_notice(" Proxy %s:%u\n",
1692 context->http_proxy_address,
1693 context->http_proxy_port);
1696 #ifndef LWS_NO_SERVER
1699 #ifdef LWS_OPENSSL_SUPPORT
1700 context->use_ssl = ssl_cert_filepath != NULL &&
1701 ssl_private_key_filepath != NULL;
1703 lwsl_notice(" Compiled with CYASSL support\n");
1705 lwsl_notice(" Compiled with OpenSSL support\n");
1707 if (context->use_ssl)
1708 lwsl_notice(" Using SSL mode\n");
1710 lwsl_notice(" Using non-SSL mode\n");
1713 if (ssl_cert_filepath != NULL &&
1714 ssl_private_key_filepath != NULL) {
1715 lwsl_notice(" Not compiled for OpenSSl support!\n");
1718 lwsl_notice(" Compiled without SSL support, "
1719 "serving unencrypted\n");
1722 lwsl_notice(" per-connection allocation: %u + headers\n", sizeof(struct libwebsocket));
1726 /* ignore SIGPIPE */
1729 signal(SIGPIPE, sigpipe_handler);
1733 #ifdef LWS_OPENSSL_SUPPORT
1735 /* basic openssl init */
1739 OpenSSL_add_all_algorithms();
1740 SSL_load_error_strings();
1742 openssl_websocket_private_data_index =
1743 SSL_get_ex_new_index(0, "libwebsockets", NULL, NULL, NULL);
1746 * Firefox insists on SSLv23 not SSLv3
1747 * Konq disables SSLv2 by default now, SSLv23 works
1750 method = (SSL_METHOD *)SSLv23_server_method();
1752 lwsl_err("problem creating ssl method: %s\n",
1753 ERR_error_string(ERR_get_error(), ssl_err_buf));
1756 context->ssl_ctx = SSL_CTX_new(method); /* create context */
1757 if (!context->ssl_ctx) {
1758 lwsl_err("problem creating ssl context: %s\n",
1759 ERR_error_string(ERR_get_error(), ssl_err_buf));
1763 #ifdef SSL_OP_NO_COMPRESSION
1764 SSL_CTX_set_options(context->ssl_ctx, SSL_OP_NO_COMPRESSION);
1766 SSL_CTX_set_options(context->ssl_ctx, SSL_OP_CIPHER_SERVER_PREFERENCE);
1767 SSL_CTX_set_cipher_list(context->ssl_ctx, CIPHERS_LIST_STRING);
1769 #ifndef LWS_NO_CLIENT
1771 /* client context */
1773 if (port == CONTEXT_PORT_NO_LISTEN) {
1774 method = (SSL_METHOD *)SSLv23_client_method();
1776 lwsl_err("problem creating ssl method: %s\n",
1777 ERR_error_string(ERR_get_error(), ssl_err_buf));
1780 /* create context */
1781 context->ssl_client_ctx = SSL_CTX_new(method);
1782 if (!context->ssl_client_ctx) {
1783 lwsl_err("problem creating ssl context: %s\n",
1784 ERR_error_string(ERR_get_error(), ssl_err_buf));
1788 #ifdef SSL_OP_NO_COMPRESSION
1789 SSL_CTX_set_options(context->ssl_client_ctx, SSL_OP_NO_COMPRESSION);
1791 SSL_CTX_set_options(context->ssl_client_ctx, SSL_OP_CIPHER_SERVER_PREFERENCE);
1792 SSL_CTX_set_cipher_list(context->ssl_client_ctx, CIPHERS_LIST_STRING);
1794 /* openssl init for cert verification (for client sockets) */
1795 if (!ssl_ca_filepath) {
1796 if (!SSL_CTX_load_verify_locations(
1797 context->ssl_client_ctx, NULL,
1798 LWS_OPENSSL_CLIENT_CERTS))
1800 "Unable to load SSL Client certs from %s "
1801 "(set by --with-client-cert-dir= in configure) -- "
1802 " client ssl isn't going to work",
1803 LWS_OPENSSL_CLIENT_CERTS);
1805 if (!SSL_CTX_load_verify_locations(
1806 context->ssl_client_ctx, ssl_ca_filepath,
1809 "Unable to load SSL Client certs "
1810 "file from %s -- client ssl isn't "
1811 "going to work", ssl_ca_filepath);
1814 * callback allowing user code to load extra verification certs
1815 * helping the client to verify server identity
1818 context->protocols[0].callback(context, NULL,
1819 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS,
1820 context->ssl_client_ctx, NULL, 0);
1824 /* as a server, are we requiring clients to identify themselves? */
1826 if (options & LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT) {
1828 /* absolutely require the client cert */
1830 SSL_CTX_set_verify(context->ssl_ctx,
1831 SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
1832 OpenSSL_verify_callback);
1835 * give user code a chance to load certs into the server
1836 * allowing it to verify incoming client certs
1839 context->protocols[0].callback(context, NULL,
1840 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS,
1841 context->ssl_ctx, NULL, 0);
1844 if (context->use_ssl) {
1846 /* openssl init for server sockets */
1848 /* set the local certificate from CertFile */
1849 n = SSL_CTX_use_certificate_chain_file(context->ssl_ctx,
1852 lwsl_err("problem getting cert '%s': %s\n",
1854 ERR_error_string(ERR_get_error(), ssl_err_buf));
1857 /* set the private key from KeyFile */
1858 if (SSL_CTX_use_PrivateKey_file(context->ssl_ctx,
1859 ssl_private_key_filepath, SSL_FILETYPE_PEM) != 1) {
1860 lwsl_err("ssl problem getting key '%s': %s\n",
1861 ssl_private_key_filepath,
1862 ERR_error_string(ERR_get_error(), ssl_err_buf));
1865 /* verify private key */
1866 if (!SSL_CTX_check_private_key(context->ssl_ctx)) {
1867 lwsl_err("Private SSL key doesn't match cert\n");
1871 /* SSL is happy and has a cert it's content with */
1877 if (lws_b64_selftest())
1880 #ifndef LWS_NO_SERVER
1881 /* set up our external listening socket we serve on */
1884 extern int interface_to_sa(const char *ifname, struct sockaddr_in *addr, size_t addrlen);
1887 sockfd = socket(AF_INET, SOCK_STREAM, 0);
1889 lwsl_err("ERROR opening socket\n");
1894 /* allow us to restart even if old sockets in TIME_WAIT
1895 * (REUSEADDR on Unix means, "don't hang on to this address after the
1896 * listener is closed." On Windows, though, it means "don't keep other
1897 * processes from binding to this address while we're using it) */
1898 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR,
1899 (const void *)&opt, sizeof(opt));
1904 setsockopt(sockfd, IPPROTO_TCP, TCP_NODELAY,
1905 (const void *)&opt, sizeof(opt));
1909 ioctlsocket(sockfd, FIONBIO, (unsigned long *)&opt );
1911 fcntl(sockfd, F_SETFL, O_NONBLOCK);
1914 bzero((char *) &serv_addr, sizeof(serv_addr));
1915 serv_addr.sin_family = AF_INET;
1917 serv_addr.sin_addr.s_addr = INADDR_ANY;
1919 interface_to_sa(interf, &serv_addr,
1921 serv_addr.sin_port = htons(port);
1923 n = bind(sockfd, (struct sockaddr *) &serv_addr,
1926 lwsl_err("ERROR on binding to port %d (%d %d)\n",
1932 wsi = (struct libwebsocket *)malloc(sizeof(struct libwebsocket));
1934 lwsl_err("Out of mem\n");
1938 memset(wsi, 0, sizeof (struct libwebsocket));
1940 #ifndef LWS_NO_EXTENSIONS
1941 wsi->count_active_extensions = 0;
1943 wsi->mode = LWS_CONNMODE_SERVER_LISTENER;
1945 insert_wsi_socket_into_fds(context, wsi);
1947 context->listen_service_modulo = LWS_LISTEN_SERVICE_MODULO;
1948 context->listen_service_count = 0;
1949 context->listen_service_fd = sockfd;
1951 listen(sockfd, LWS_SOMAXCONN);
1952 lwsl_notice(" Listening on port %d\n", port);
1957 * drop any root privs for this process
1958 * to listen on port < 1023 we would have needed root, but now we are
1959 * listening, we don't want the power for anything else
1965 lwsl_warn("setgid: %s\n", strerror(errno));
1968 lwsl_warn("setuid: %s\n", strerror(errno));
1971 /* initialize supported protocols */
1973 for (context->count_protocols = 0;
1974 protocols[context->count_protocols].callback;
1975 context->count_protocols++) {
1977 lwsl_parser(" Protocol: %s\n",
1978 protocols[context->count_protocols].name);
1980 protocols[context->count_protocols].owning_server = context;
1981 protocols[context->count_protocols].protocol_index =
1982 context->count_protocols;
1985 #ifndef LWS_NO_EXTENSIONS
1987 * give all extensions a chance to create any per-context
1988 * allocations they need
1991 m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_CONSTRUCT;
1993 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_CONSTRUCT;
1996 while (extensions->callback) {
1997 lwsl_ext(" Extension: %s\n", extensions->name);
1998 extensions->callback(context, extensions, NULL,
1999 (enum libwebsocket_extension_callback_reasons)m,
2008 libwebsocket_context_destroy(context);
2013 * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
2015 * @wsi: pointer to struct websocket you want to know the protocol of
2018 * Some apis can act on all live connections of a given protocol,
2019 * this is how you can get a pointer to the active protocol if needed.
2022 const struct libwebsocket_protocols *
2023 libwebsockets_get_protocol(struct libwebsocket *wsi)
2025 return wsi->protocol;
2029 libwebsocket_is_final_fragment(struct libwebsocket *wsi)
2031 return wsi->u.ws.final;
2035 libwebsocket_get_reserved_bits(struct libwebsocket *wsi)
2037 return wsi->u.ws.rsv;
2041 libwebsocket_ensure_user_space(struct libwebsocket *wsi)
2043 /* allocate the per-connection user memory (if any) */
2045 if (wsi->protocol->per_session_data_size && !wsi->user_space) {
2046 wsi->user_space = malloc(
2047 wsi->protocol->per_session_data_size);
2048 if (wsi->user_space == NULL) {
2049 lwsl_err("Out of memory for conn user space\n");
2052 memset(wsi->user_space, 0,
2053 wsi->protocol->per_session_data_size);
2055 return wsi->user_space;
2058 static void lwsl_emit_stderr(int level, const char *line)
2064 gettimeofday(&tv, NULL);
2067 for (n = 0; n < LLL_COUNT; n++)
2068 if (level == (1 << n)) {
2069 sprintf(buf, "[%ld:%04d] %s: ", tv.tv_sec,
2070 (int)(tv.tv_usec / 100), log_level_names[n]);
2074 fprintf(stderr, "%s%s", buf, line);
2078 void lwsl_emit_syslog(int level, const char *line)
2080 lwsl_emit_stderr(level, line);
2083 void lwsl_emit_syslog(int level, const char *line)
2085 int syslog_level = LOG_DEBUG;
2089 syslog_level = LOG_ERR;
2092 syslog_level = LOG_WARNING;
2095 syslog_level = LOG_NOTICE;
2098 syslog_level = LOG_INFO;
2101 syslog(syslog_level, "%s", line);
2105 void _lws_log(int filter, const char *format, ...)
2110 if (!(log_level & filter))
2113 va_start(ap, format);
2114 vsnprintf(buf, (sizeof buf), format, ap);
2115 buf[(sizeof buf) - 1] = '\0';
2118 lwsl_emit(filter, buf);
2122 * lws_set_log_level() - Set the logging bitfield
2123 * @level: OR together the LLL_ debug contexts you want output from
2124 * @log_emit_function: NULL to leave it as it is, or a user-supplied
2125 * function to perform log string emission instead of
2126 * the default stderr one.
2128 * log level defaults to "err" and "warn" contexts enabled only and
2129 * emission on stderr.
2132 void lws_set_log_level(int level, void (*log_emit_function)(int level, const char *line))
2135 if (log_emit_function)
2136 lwsl_emit = log_emit_function;