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"
29 #ifdef LWS_BUILTIN_GETIFADDRS
30 #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 static int log_level = LLL_ERR | LLL_WARN | LLL_NOTICE;
52 static void lwsl_emit_stderr(int level, const char *line);
53 static void (*lwsl_emit)(int level, const char *line) = lwsl_emit_stderr;
55 static const char *log_level_names[] = {
68 insert_wsi_socket_into_fds(struct libwebsocket_context *context, struct libwebsocket *wsi)
70 if (context->fds_count >= context->max_fds) {
71 lwsl_err("Reached limit of fds tracking (%d)\n", context->max_fds);
75 if (wsi->sock > context->max_fds) {
76 lwsl_err("Socket fd %d is beyond what we can index (%d)\n", wsi->sock, context->max_fds);
83 lwsl_info("insert_wsi_socket_into_fds: wsi=%p, sock=%d, fds pos=%d\n", wsi, wsi->sock, context->fds_count);
85 context->lws_lookup[wsi->sock] = wsi;
86 wsi->position_in_fds_table = context->fds_count;
87 context->fds[context->fds_count].fd = wsi->sock;
88 context->fds[context->fds_count].events = POLLIN;
89 context->fds[context->fds_count++].revents = 0;
91 /* external POLL support via protocol 0 */
92 context->protocols[0].callback(context, wsi,
93 LWS_CALLBACK_ADD_POLL_FD,
94 (void *)(long)wsi->sock, NULL, POLLIN);
100 remove_wsi_socket_from_fds(struct libwebsocket_context *context, struct libwebsocket *wsi)
104 if (!--context->fds_count)
107 if (wsi->sock > context->max_fds) {
108 lwsl_err("Socket fd %d is beyond what we can index (%d)\n", wsi->sock, context->max_fds);
112 lwsl_info("remove_wsi_socket_from_fds: wsi=%p, sock=%d, fds pos=%d\n", wsi, wsi->sock, wsi->position_in_fds_table);
114 m = wsi->position_in_fds_table; /* replace the contents for this */
116 /* have the last guy take up the vacant slot */
117 context->fds[m] = context->fds[context->fds_count]; /* vacant fds slot filled with end one */
118 /* end guy's fds_lookup entry remains unchanged (still same fd pointing to same wsi) */
119 /* end guy's "position in fds table" changed */
120 context->lws_lookup[context->fds[context->fds_count].fd]->position_in_fds_table = m;
121 /* deletion guy's lws_lookup entry needs nuking */
122 context->lws_lookup[wsi->sock] = NULL; /* no WSI for the socket of the wsi being removed*/
123 wsi->position_in_fds_table = -1; /* removed wsi has no position any more */
126 /* remove also from external POLL support via protocol 0 */
128 context->protocols[0].callback(context, wsi,
129 LWS_CALLBACK_DEL_POLL_FD, (void *)(long)wsi->sock, NULL, 0);
136 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
137 struct libwebsocket *wsi, enum lws_close_status reason)
141 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 2 +
142 LWS_SEND_BUFFER_POST_PADDING];
145 struct lws_tokens eff_buf;
146 struct libwebsocket_extension *ext;
151 old_state = wsi->state;
153 if (old_state == WSI_STATE_DEAD_SOCKET)
156 wsi->close_reason = reason;
159 * are his extensions okay with him closing? Eg he might be a mux
160 * parent and just his ch1 aspect is closing?
164 for (n = 0; n < wsi->count_active_extensions; n++) {
165 if (!wsi->active_extensions[n]->callback)
168 m = wsi->active_extensions[n]->callback(context,
169 wsi->active_extensions[n], wsi,
170 LWS_EXT_CALLBACK_CHECK_OK_TO_REALLY_CLOSE,
171 wsi->active_extensions_user[n], NULL, 0);
174 * if somebody vetoed actually closing him at this time....
175 * up to the extension to track the attempted close, let's
180 lwsl_ext("extension vetoed close\n");
188 * flush any tx pending from extensions, since we may send close packet
189 * if there are problems with send, just nuke the connection
195 /* default to nobody has more to spill */
198 eff_buf.token = NULL;
199 eff_buf.token_len = 0;
201 /* show every extension the new incoming data */
203 for (n = 0; n < wsi->count_active_extensions; n++) {
204 m = wsi->active_extensions[n]->callback(
205 wsi->protocol->owning_server,
206 wsi->active_extensions[n], wsi,
207 LWS_EXT_CALLBACK_FLUSH_PENDING_TX,
208 wsi->active_extensions_user[n], &eff_buf, 0);
210 lwsl_ext("Extension reports fatal error\n");
211 goto just_kill_connection;
215 * at least one extension told us he has more
216 * to spill, so we will go around again after
221 /* assuming they left us something to send, send it */
223 if (eff_buf.token_len)
224 if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
225 eff_buf.token_len)) {
226 lwsl_debug("close: sending final extension spill had problems\n");
227 goto just_kill_connection;
232 * signal we are closing, libsocket_write will
233 * add any necessary version-specific stuff. If the write fails,
234 * no worries we are closing anyway. If we didn't initiate this
235 * close, then our state has been changed to
236 * WSI_STATE_RETURNED_CLOSE_ALREADY and we will skip this.
238 * Likewise if it's a second call to close this connection after we
239 * sent the close indication to the peer already, we are in state
240 * WSI_STATE_AWAITING_CLOSE_ACK and will skip doing this a second time.
243 if (old_state == WSI_STATE_ESTABLISHED &&
244 reason != LWS_CLOSE_STATUS_NOSTATUS) {
246 lwsl_debug("sending close indication...\n");
248 n = libwebsocket_write(wsi, &buf[LWS_SEND_BUFFER_PRE_PADDING],
252 * we have sent a nice protocol level indication we
253 * now wish to close, we should not send anything more
256 wsi->state = WSI_STATE_AWAITING_CLOSE_ACK;
258 /* and we should wait for a reply for a bit out of politeness */
260 libwebsocket_set_timeout(wsi,
261 PENDING_TIMEOUT_CLOSE_ACK, 1);
263 lwsl_debug("sent close indication, awaiting ack\n");
268 lwsl_info("close: sending the close packet failed, hanging up\n");
270 /* else, the send failed and we should just hang up */
273 just_kill_connection:
275 lwsl_debug("libwebsocket_close_and_free_session: just_kill_connection\n");
278 * we won't be servicing or receiving anything further from this guy
279 * delete socket from the internal poll list if still present
282 remove_wsi_socket_from_fds(context, wsi);
284 wsi->state = WSI_STATE_DEAD_SOCKET;
286 /* tell the user it's all over for this guy */
288 if (wsi->protocol && wsi->protocol->callback &&
289 ((old_state == WSI_STATE_ESTABLISHED) ||
290 (old_state == WSI_STATE_RETURNED_CLOSE_ALREADY) ||
291 (old_state == WSI_STATE_AWAITING_CLOSE_ACK))) {
292 lwsl_debug("calling back CLOSED\n");
293 wsi->protocol->callback(context, wsi, LWS_CALLBACK_CLOSED,
294 wsi->user_space, NULL, 0);
296 lwsl_debug("not calling back closed, old_state=%d\n", old_state);
298 /* deallocate any active extension contexts */
300 for (n = 0; n < wsi->count_active_extensions; n++) {
301 if (!wsi->active_extensions[n]->callback)
304 wsi->active_extensions[n]->callback(context,
305 wsi->active_extensions[n], wsi,
306 LWS_EXT_CALLBACK_DESTROY,
307 wsi->active_extensions_user[n], NULL, 0);
309 free(wsi->active_extensions_user[n]);
313 * inform all extensions in case they tracked this guy out of band
314 * even though not active on him specifically
317 ext = context->extensions;
318 while (ext && ext->callback) {
319 ext->callback(context, ext, wsi,
320 LWS_EXT_CALLBACK_DESTROY_ANY_WSI_CLOSING,
325 /* free up his parsing allocations */
327 for (n = 0; n < WSI_TOKEN_COUNT; n++)
328 if (wsi->utf8_token[n].token)
329 free(wsi->utf8_token[n].token);
330 #ifndef LWS_NO_CLIENT
332 free(wsi->c_address);
334 if (wsi->rxflow_buffer)
335 free(wsi->rxflow_buffer);
337 /* lwsl_info("closing fd=%d\n", wsi->sock); */
339 #ifdef LWS_OPENSSL_SUPPORT
341 n = SSL_get_fd(wsi->ssl);
342 SSL_shutdown(wsi->ssl);
348 n = shutdown(wsi->sock, SHUT_RDWR);
350 lwsl_debug("closing: shutdown returned %d\n", errno);
352 n = compatible_close(wsi->sock);
354 lwsl_debug("closing: close returned %d\n", errno);
356 #ifdef LWS_OPENSSL_SUPPORT
359 if (wsi->protocol && wsi->protocol->per_session_data_size && wsi->user_space) /* user code may own */
360 free(wsi->user_space);
366 * libwebsockets_hangup_on_client() - Server calls to terminate client
368 * @context: libwebsockets context
369 * @fd: Connection socket descriptor
373 libwebsockets_hangup_on_client(struct libwebsocket_context *context, int fd)
375 struct libwebsocket *wsi = context->lws_lookup[fd];
378 libwebsocket_close_and_free_session(context,
379 wsi, LWS_CLOSE_STATUS_NOSTATUS);
386 * libwebsockets_get_peer_addresses() - Get client address information
387 * @fd: Connection socket descriptor
388 * @name: Buffer to take client address name
389 * @name_len: Length of client address name buffer
390 * @rip: Buffer to take client address IP qotted quad
391 * @rip_len: Length of client address IP buffer
393 * This function fills in @name and @rip with the name and IP of
394 * the client connected with socket descriptor @fd. Names may be
395 * truncated if there is not enough room. If either cannot be
396 * determined, they will be returned as valid zero-length strings.
400 libwebsockets_get_peer_addresses(int fd, char *name, int name_len,
401 char *rip, int rip_len)
404 struct sockaddr_in sin;
405 struct hostent *host;
406 struct hostent *host1;
411 struct sockaddr_un *un;
418 if (getpeername(fd, (struct sockaddr *) &sin, &len) < 0) {
419 perror("getpeername");
423 host = gethostbyaddr((char *) &sin.sin_addr, sizeof sin.sin_addr,
426 perror("gethostbyaddr");
430 strncpy(name, host->h_name, name_len);
431 name[name_len - 1] = '\0';
433 host1 = gethostbyname(host->h_name);
436 p = (unsigned char *)host1;
439 p = (unsigned char *)host1->h_addr_list[n++];
442 if ((host1->h_addrtype != AF_INET)
444 && (host1->h_addrtype != AF_LOCAL)
449 if (host1->h_addrtype == AF_INET)
450 sprintf(ip, "%u.%u.%u.%u", p[0], p[1], p[2], p[3]);
453 un = (struct sockaddr_un *)p;
454 strncpy(ip, un->sun_path, sizeof(ip) - 1);
455 ip[sizeof(ip) - 1] = '\0';
459 strncpy(rip, ip, rip_len);
460 rip[rip_len - 1] = '\0';
464 int libwebsockets_get_random(struct libwebsocket_context *context,
468 char *p = (char *)buf;
471 for (n = 0; n < len; n++)
472 p[n] = (unsigned char)rand();
474 n = read(context->fd_random, p, len);
481 libwebsockets_SHA1(const unsigned char *d, size_t n, unsigned char *md)
483 return SHA1(d, n, md);
486 int lws_send_pipe_choked(struct libwebsocket *wsi)
491 fds.events = POLLOUT;
494 if (poll(&fds, 1, 0) != 1)
497 if ((fds.revents & POLLOUT) == 0)
500 /* okay to send another packet without blocking */
506 lws_handle_POLLOUT_event(struct libwebsocket_context *context,
507 struct libwebsocket *wsi, struct pollfd *pollfd)
509 struct lws_tokens eff_buf;
515 for (n = 0; n < wsi->count_active_extensions; n++) {
516 if (!wsi->active_extensions[n]->callback)
519 m = wsi->active_extensions[n]->callback(context,
520 wsi->active_extensions[n], wsi,
521 LWS_EXT_CALLBACK_IS_WRITEABLE,
522 wsi->active_extensions_user[n], NULL, 0);
530 if (!wsi->extension_data_pending || handled == 2)
534 * check in on the active extensions, see if they
535 * had pending stuff to spill... they need to get the
536 * first look-in otherwise sequence will be disordered
538 * NULL, zero-length eff_buf means just spill pending
544 /* default to nobody has more to spill */
547 eff_buf.token = NULL;
548 eff_buf.token_len = 0;
550 /* give every extension a chance to spill */
552 for (n = 0; n < wsi->count_active_extensions; n++) {
553 m = wsi->active_extensions[n]->callback(
554 wsi->protocol->owning_server,
555 wsi->active_extensions[n], wsi,
556 LWS_EXT_CALLBACK_PACKET_TX_PRESEND,
557 wsi->active_extensions_user[n], &eff_buf, 0);
559 lwsl_err("ext reports fatal error\n");
564 * at least one extension told us he has more
565 * to spill, so we will go around again after
570 /* assuming they gave us something to send, send it */
572 if (eff_buf.token_len) {
573 if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
579 /* no extension has more to spill */
585 * There's more to spill from an extension, but we just sent
586 * something... did that leave the pipe choked?
589 if (!lws_send_pipe_choked(wsi))
590 /* no we could add more */
593 lwsl_info("choked in POLLOUT service\n");
596 * Yes, he's choked. Leave the POLLOUT masked on so we will
597 * come back here when he is unchoked. Don't call the user
598 * callback to enforce ordering of spilling, he'll get called
599 * when we come back here and there's nothing more to spill.
605 wsi->extension_data_pending = 0;
611 pollfd->events &= ~POLLOUT;
613 /* external POLL support via protocol 0 */
614 context->protocols[0].callback(context, wsi,
615 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
616 (void *)(long)wsi->sock, NULL, POLLOUT);
621 if (wsi->mode == LWS_CONNMODE_WS_CLIENT)
622 n = LWS_CALLBACK_CLIENT_WRITEABLE;
624 n = LWS_CALLBACK_SERVER_WRITEABLE;
626 user_callback_handle_rxflow(wsi->protocol->callback, context,
627 wsi, (enum libwebsocket_callback_reasons) n, wsi->user_space, NULL, 0);
635 libwebsocket_service_timeout_check(struct libwebsocket_context *context,
636 struct libwebsocket *wsi, unsigned int sec)
641 * if extensions want in on it (eg, we are a mux parent)
642 * give them a chance to service child timeouts
645 for (n = 0; n < wsi->count_active_extensions; n++)
646 wsi->active_extensions[n]->callback(
647 context, wsi->active_extensions[n],
648 wsi, LWS_EXT_CALLBACK_1HZ,
649 wsi->active_extensions_user[n], NULL, sec);
651 if (!wsi->pending_timeout)
655 * if we went beyond the allowed time, kill the
659 if (sec > wsi->pending_timeout_limit) {
660 lwsl_info("TIMEDOUT WAITING\n");
661 libwebsocket_close_and_free_session(context,
662 wsi, LWS_CLOSE_STATUS_NOSTATUS);
667 * libwebsocket_service_fd() - Service polled socket with something waiting
668 * @context: Websocket context
669 * @pollfd: The pollfd entry describing the socket fd and which events
672 * This function closes any active connections and then frees the
673 * context. After calling this, any further use of the context is
678 libwebsocket_service_fd(struct libwebsocket_context *context,
679 struct pollfd *pollfd)
681 struct libwebsocket *wsi;
682 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 1 +
683 MAX_BROADCAST_PAYLOAD + LWS_SEND_BUFFER_POST_PADDING];
688 struct lws_tokens eff_buf;
689 #ifndef LWS_NO_CLIENT
690 extern int lws_client_socket_service(struct libwebsocket_context *context, struct libwebsocket *wsi, struct pollfd *pollfd);
692 #ifndef LWS_NO_SERVER
693 extern int lws_server_socket_service(struct libwebsocket_context *context, struct libwebsocket *wsi, struct pollfd *pollfd);
696 * you can call us with pollfd = NULL to just allow the once-per-second
697 * global timeout checks; if less than a second since the last check
698 * it returns immediately then.
701 gettimeofday(&tv, NULL);
703 if (context->last_timeout_check_s != tv.tv_sec) {
704 context->last_timeout_check_s = tv.tv_sec;
706 /* if our parent went down, don't linger around */
707 if (context->started_with_parent && kill(context->started_with_parent, 0) < 0)
708 kill(getpid(), SIGTERM);
710 /* global timeout check once per second */
712 for (n = 0; n < context->fds_count; n++) {
713 struct libwebsocket *new_wsi = context->lws_lookup[context->fds[n].fd];
716 libwebsocket_service_timeout_check(context,
721 /* just here for timeout management? */
726 /* no, here to service a socket descriptor */
729 * deal with listen service piggybacking
730 * every listen_service_modulo services of other fds, we
731 * sneak one in to service the listen socket if there's anything waiting
733 * To handle connection storms, as found in ab, if we previously saw a
734 * pending connection here, it causes us to check again next time.
737 if (context->listen_service_fd && pollfd->fd != context->listen_service_fd) {
738 context->listen_service_count++;
739 if (context->listen_service_extraseen ||
740 context->listen_service_count == context->listen_service_modulo) {
741 context->listen_service_count = 0;
743 if (context->listen_service_extraseen > 5)
746 /* even with extpoll, we prepared this internal fds for listen */
747 n = poll(&context->fds[0], 1, 0);
748 if (n > 0) { /* there's a connection waiting for us */
749 libwebsocket_service_fd(context, &context->fds[0]);
750 context->listen_service_extraseen++;
752 if (context->listen_service_extraseen)
753 context->listen_service_extraseen--;
761 /* okay, what we came here to do... */
763 wsi = context->lws_lookup[pollfd->fd];
766 lwsl_err("unexpected NULL wsi fd=%d fds_count=%d\n", pollfd->fd, context->fds_count);
772 #ifndef LWS_NO_SERVER
773 case LWS_CONNMODE_HTTP_SERVING:
774 case LWS_CONNMODE_SERVER_LISTENER:
775 case LWS_CONNMODE_BROADCAST_PROXY_LISTENER:
776 case LWS_CONNMODE_BROADCAST_PROXY:
777 return lws_server_socket_service(context, wsi, pollfd);
780 case LWS_CONNMODE_WS_SERVING:
781 case LWS_CONNMODE_WS_CLIENT:
783 /* handle session socket closed */
785 if (pollfd->revents & (POLLERR | POLLHUP)) {
787 lwsl_debug("Session Socket %p (fd=%d) dead\n",
788 (void *)wsi, pollfd->fd);
790 libwebsocket_close_and_free_session(context, wsi,
791 LWS_CLOSE_STATUS_NOSTATUS);
795 /* the guy requested a callback when it was OK to write */
797 if ((pollfd->revents & POLLOUT) &&
798 wsi->state == WSI_STATE_ESTABLISHED)
799 if (lws_handle_POLLOUT_event(context, wsi,
801 libwebsocket_close_and_free_session(
802 context, wsi, LWS_CLOSE_STATUS_NORMAL);
807 /* any incoming data ready? */
809 if (!(pollfd->revents & POLLIN))
812 #ifdef LWS_OPENSSL_SUPPORT
815 eff_buf.token_len = SSL_read(wsi->ssl, buf, sizeof buf);
819 recv(pollfd->fd, buf, sizeof buf, 0);
821 if (eff_buf.token_len < 0) {
822 lwsl_debug("Socket read returned %d\n",
824 if (errno != EINTR && errno != EAGAIN)
825 libwebsocket_close_and_free_session(context,
826 wsi, LWS_CLOSE_STATUS_NOSTATUS);
829 if (!eff_buf.token_len) {
830 libwebsocket_close_and_free_session(context, wsi,
831 LWS_CLOSE_STATUS_NOSTATUS);
836 * give any active extensions a chance to munge the buffer
837 * before parse. We pass in a pointer to an lws_tokens struct
838 * prepared with the default buffer and content length that's in
839 * there. Rather than rewrite the default buffer, extensions
840 * that expect to grow the buffer can adapt .token to
841 * point to their own per-connection buffer in the extension
842 * user allocation. By default with no extensions or no
843 * extension callback handling, just the normal input buffer is
844 * used then so it is efficient.
847 eff_buf.token = (char *)buf;
854 for (n = 0; n < wsi->count_active_extensions; n++) {
855 m = wsi->active_extensions[n]->callback(context,
856 wsi->active_extensions[n], wsi,
857 LWS_EXT_CALLBACK_PACKET_RX_PREPARSE,
858 wsi->active_extensions_user[n],
862 "Extension reports fatal error\n");
863 libwebsocket_close_and_free_session(
865 LWS_CLOSE_STATUS_NOSTATUS);
872 /* service incoming data */
874 if (eff_buf.token_len) {
875 n = libwebsocket_read(context, wsi,
876 (unsigned char *)eff_buf.token,
883 eff_buf.token = NULL;
884 eff_buf.token_len = 0;
887 #ifdef LWS_OPENSSL_SUPPORT
888 if (wsi->ssl && SSL_pending(wsi->ssl))
897 return lws_client_socket_service(context, wsi, pollfd);
906 * libwebsocket_context_destroy() - Destroy the websocket context
907 * @context: Websocket context
909 * This function closes any active connections and then frees the
910 * context. After calling this, any further use of the context is
914 libwebsocket_context_destroy(struct libwebsocket_context *context)
918 struct libwebsocket_extension *ext;
920 for (n = 0; n < context->fds_count; n++) {
921 struct libwebsocket *wsi = context->lws_lookup[context->fds[n].fd];
922 libwebsocket_close_and_free_session(context,
923 wsi, LWS_CLOSE_STATUS_GOINGAWAY);
927 * give all extensions a chance to clean up any per-context
928 * allocations they might have made
931 ext = context->extensions;
932 m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_DESTRUCT;
933 if (context->listen_port)
934 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_DESTRUCT;
935 while (ext && ext->callback) {
936 ext->callback(context, ext, NULL, (enum libwebsocket_extension_callback_reasons)m, NULL, NULL, 0);
942 close(context->fd_random);
945 #ifdef LWS_OPENSSL_SUPPORT
946 if (context->ssl_ctx)
947 SSL_CTX_free(context->ssl_ctx);
948 if (context->ssl_client_ctx)
949 SSL_CTX_free(context->ssl_client_ctx);
960 libwebsocket_context_user(struct libwebsocket_context *context)
962 return context->user_space;
966 * libwebsocket_service() - Service any pending websocket activity
967 * @context: Websocket context
968 * @timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
969 * service otherwise block and service immediately, returning
970 * after the timeout if nothing needed service.
972 * This function deals with any pending websocket traffic, for three
973 * kinds of event. It handles these events on both server and client
974 * types of connection the same.
976 * 1) Accept new connections to our context's server
978 * 2) Perform pending broadcast writes initiated from other forked
979 * processes (effectively serializing asynchronous broadcasts)
981 * 3) Call the receive callback for incoming frame data received by
982 * server or client connections.
984 * You need to call this service function periodically to all the above
985 * functions to happen; if your application is single-threaded you can
986 * just call it in your main event loop.
988 * Alternatively you can fork a new process that asynchronously handles
989 * calling this service in a loop. In that case you are happy if this
990 * call blocks your thread until it needs to take care of something and
991 * would call it with a large nonzero timeout. Your loop then takes no
992 * CPU while there is nothing happening.
994 * If you are calling it in a single-threaded app, you don't want it to
995 * wait around blocking other things in your loop from happening, so you
996 * would call it with a timeout_ms of 0, so it returns immediately if
997 * nothing is pending, or as soon as it services whatever was pending.
1002 libwebsocket_service(struct libwebsocket_context *context, int timeout_ms)
1006 /* stay dead once we are dead */
1008 if (context == NULL)
1011 /* wait for something to need service */
1013 n = poll(context->fds, context->fds_count, timeout_ms);
1014 if (n == 0) /* poll timeout */
1020 /* any socket with events to service? */
1022 for (n = 0; n < context->fds_count; n++)
1023 if (context->fds[n].revents)
1024 if (libwebsocket_service_fd(context,
1025 &context->fds[n]) < 0)
1031 lws_any_extension_handled(struct libwebsocket_context *context,
1032 struct libwebsocket *wsi,
1033 enum libwebsocket_extension_callback_reasons r,
1034 void *v, size_t len)
1039 /* maybe an extension will take care of it for us */
1041 for (n = 0; n < wsi->count_active_extensions && !handled; n++) {
1042 if (!wsi->active_extensions[n]->callback)
1045 handled |= wsi->active_extensions[n]->callback(context,
1046 wsi->active_extensions[n], wsi,
1047 r, wsi->active_extensions_user[n], v, len);
1055 lws_get_extension_user_matching_ext(struct libwebsocket *wsi,
1056 struct libwebsocket_extension *ext)
1063 while (n < wsi->count_active_extensions) {
1064 if (wsi->active_extensions[n] != ext) {
1068 return wsi->active_extensions_user[n];
1075 * libwebsocket_callback_on_writable() - Request a callback when this socket
1076 * becomes able to be written to without
1079 * @context: libwebsockets context
1080 * @wsi: Websocket connection instance to get callback for
1084 libwebsocket_callback_on_writable(struct libwebsocket_context *context,
1085 struct libwebsocket *wsi)
1090 /* maybe an extension will take care of it for us */
1092 for (n = 0; n < wsi->count_active_extensions; n++) {
1093 if (!wsi->active_extensions[n]->callback)
1096 handled |= wsi->active_extensions[n]->callback(context,
1097 wsi->active_extensions[n], wsi,
1098 LWS_EXT_CALLBACK_REQUEST_ON_WRITEABLE,
1099 wsi->active_extensions_user[n], NULL, 0);
1105 if (wsi->position_in_fds_table < 0) {
1106 lwsl_err("libwebsocket_callback_on_writable: "
1107 "failed to find socket %d\n", wsi->sock);
1111 context->fds[wsi->position_in_fds_table].events |= POLLOUT;
1113 /* external POLL support via protocol 0 */
1114 context->protocols[0].callback(context, wsi,
1115 LWS_CALLBACK_SET_MODE_POLL_FD,
1116 (void *)(long)wsi->sock, NULL, POLLOUT);
1122 * libwebsocket_callback_on_writable_all_protocol() - Request a callback for
1123 * all connections using the given protocol when it
1124 * becomes possible to write to each socket without
1127 * @protocol: Protocol whose connections will get callbacks
1131 libwebsocket_callback_on_writable_all_protocol(
1132 const struct libwebsocket_protocols *protocol)
1134 struct libwebsocket_context *context = protocol->owning_server;
1136 struct libwebsocket *wsi;
1138 for (n = 0; n < context->fds_count; n++) {
1139 wsi = context->lws_lookup[context->fds[n].fd];
1142 if (wsi->protocol == protocol)
1143 libwebsocket_callback_on_writable(context, wsi);
1150 * libwebsocket_set_timeout() - marks the wsi as subject to a timeout
1152 * You will not need this unless you are doing something special
1154 * @wsi: Websocket connection instance
1155 * @reason: timeout reason
1156 * @secs: how many seconds
1160 libwebsocket_set_timeout(struct libwebsocket *wsi,
1161 enum pending_timeout reason, int secs)
1165 gettimeofday(&tv, NULL);
1167 wsi->pending_timeout_limit = tv.tv_sec + secs;
1168 wsi->pending_timeout = reason;
1173 * libwebsocket_get_socket_fd() - returns the socket file descriptor
1175 * You will not need this unless you are doing something special
1177 * @wsi: Websocket connection instance
1181 libwebsocket_get_socket_fd(struct libwebsocket *wsi)
1186 #ifdef LWS_NO_SERVER
1188 _libwebsocket_rx_flow_control(struct libwebsocket *wsi)
1194 _libwebsocket_rx_flow_control(struct libwebsocket *wsi)
1196 struct libwebsocket_context *context = wsi->protocol->owning_server;
1199 if (!(wsi->rxflow_change_to & 2))
1202 wsi->rxflow_change_to &= ~2;
1204 lwsl_info("rxflow: wsi %p change_to %d\n", wsi, wsi->rxflow_change_to);
1206 /* if we're letting it come again, did we interrupt anything? */
1207 if ((wsi->rxflow_change_to & 1) && wsi->rxflow_buffer) {
1208 n = libwebsocket_interpret_incoming_packet(wsi, NULL, 0);
1210 libwebsocket_close_and_free_session(context, wsi, LWS_CLOSE_STATUS_NOSTATUS);
1214 /* oh he stuck again, do nothing */
1218 if (wsi->rxflow_change_to & 1)
1219 context->fds[wsi->position_in_fds_table].events |= POLLIN;
1221 context->fds[wsi->position_in_fds_table].events &= ~POLLIN;
1223 if (wsi->rxflow_change_to & 1)
1224 /* external POLL support via protocol 0 */
1225 context->protocols[0].callback(context, wsi,
1226 LWS_CALLBACK_SET_MODE_POLL_FD,
1227 (void *)(long)wsi->sock, NULL, POLLIN);
1229 /* external POLL support via protocol 0 */
1230 context->protocols[0].callback(context, wsi,
1231 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
1232 (void *)(long)wsi->sock, NULL, POLLIN);
1239 * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
1240 * receieved packets.
1242 * If the output side of a server process becomes choked, this allows flow
1243 * control for the input side.
1245 * @wsi: Websocket connection instance to get callback for
1246 * @enable: 0 = disable read servicing for this connection, 1 = enable
1250 libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
1252 wsi->rxflow_change_to = 2 | !!enable;
1259 * libwebsocket_canonical_hostname() - returns this host's hostname
1261 * This is typically used by client code to fill in the host parameter
1262 * when making a client connection. You can only call it after the context
1265 * @context: Websocket context
1270 libwebsocket_canonical_hostname(struct libwebsocket_context *context)
1272 return (const char *)context->canonical_hostname;
1276 static void sigpipe_handler(int x)
1280 #ifdef LWS_OPENSSL_SUPPORT
1282 OpenSSL_verify_callback(int preverify_ok, X509_STORE_CTX *x509_ctx)
1287 struct libwebsocket_context *context;
1289 ssl = X509_STORE_CTX_get_ex_data(x509_ctx,
1290 SSL_get_ex_data_X509_STORE_CTX_idx());
1293 * !!! nasty openssl requires the index to come as a library-scope
1296 context = SSL_get_ex_data(ssl, openssl_websocket_private_data_index);
1298 n = context->protocols[0].callback(NULL, NULL,
1299 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION,
1300 x509_ctx, ssl, preverify_ok);
1302 /* convert return code from 0 = OK to 1 = OK */
1313 int user_callback_handle_rxflow(callback_function callback_function,
1314 struct libwebsocket_context * context,
1315 struct libwebsocket *wsi,
1316 enum libwebsocket_callback_reasons reason, void *user,
1317 void *in, size_t len)
1321 n = callback_function(context, wsi, reason, user, in, len);
1325 _libwebsocket_rx_flow_control(wsi);
1332 * libwebsocket_create_context() - Create the websocket handler
1333 * @port: Port to listen on... you can use 0 to suppress listening on
1334 * any port, that's what you want if you are not running a
1335 * websocket server at all but just using it as a client
1336 * @interf: NULL to bind the listen socket to all interfaces, or the
1337 * interface name, eg, "eth2"
1338 * @protocols: Array of structures listing supported protocols and a protocol-
1339 * specific callback for each one. The list is ended with an
1340 * entry that has a NULL callback pointer.
1341 * It's not const because we write the owning_server member
1342 * @extensions: NULL or array of libwebsocket_extension structs listing the
1343 * extensions this context supports
1344 * @ssl_cert_filepath: If libwebsockets was compiled to use ssl, and you want
1345 * to listen using SSL, set to the filepath to fetch the
1346 * server cert from, otherwise NULL for unencrypted
1347 * @ssl_private_key_filepath: filepath to private key if wanting SSL mode,
1349 * @ssl_ca_filepath: CA certificate filepath or NULL
1350 * @gid: group id to change to after setting listen socket, or -1.
1351 * @uid: user id to change to after setting listen socket, or -1.
1352 * @options: 0, or LWS_SERVER_OPTION_DEFEAT_CLIENT_MASK
1353 * @user: optional user pointer that can be recovered via the context
1354 * pointer using libwebsocket_context_user
1356 * This function creates the listening socket and takes care
1357 * of all initialization in one step.
1359 * After initialization, it returns a struct libwebsocket_context * that
1360 * represents this server. After calling, user code needs to take care
1361 * of calling libwebsocket_service() with the context pointer to get the
1362 * server's sockets serviced. This can be done in the same process context
1363 * or a forked process, or another thread,
1365 * The protocol callback functions are called for a handful of events
1366 * including http requests coming in, websocket connections becoming
1367 * established, and data arriving; it's also called periodically to allow
1368 * async transmission.
1370 * HTTP requests are sent always to the FIRST protocol in @protocol, since
1371 * at that time websocket protocol has not been negotiated. Other
1372 * protocols after the first one never see any HTTP callack activity.
1374 * The server created is a simple http server by default; part of the
1375 * websocket standard is upgrading this http connection to a websocket one.
1377 * This allows the same server to provide files like scripts and favicon /
1378 * images or whatever over http and dynamic data over websockets all in
1379 * one place; they're all handled in the user callback.
1382 struct libwebsocket_context *
1383 libwebsocket_create_context(int port, const char *interf,
1384 struct libwebsocket_protocols *protocols,
1385 struct libwebsocket_extension *extensions,
1386 const char *ssl_cert_filepath,
1387 const char *ssl_private_key_filepath,
1388 const char *ssl_ca_filepath,
1389 int gid, int uid, unsigned int options,
1395 struct sockaddr_in serv_addr, cli_addr;
1397 struct libwebsocket_context *context = NULL;
1400 struct libwebsocket *wsi;
1402 #ifdef LWS_OPENSSL_SUPPORT
1404 char ssl_err_buf[512];
1407 lwsl_notice("Initial logging level %d\n", log_level);
1408 lwsl_info(" LWS_MAX_HEADER_NAME_LENGTH: %u\n", LWS_MAX_HEADER_NAME_LENGTH);
1409 lwsl_info(" LWS_MAX_HEADER_LEN: %u\n", LWS_MAX_HEADER_LEN);
1410 lwsl_info(" LWS_INITIAL_HDR_ALLOC: %u\n", LWS_INITIAL_HDR_ALLOC);
1411 lwsl_info(" LWS_ADDITIONAL_HDR_ALLOC: %u\n", LWS_ADDITIONAL_HDR_ALLOC);
1412 lwsl_info(" MAX_USER_RX_BUFFER: %u\n", MAX_USER_RX_BUFFER);
1413 lwsl_info(" MAX_BROADCAST_PAYLOAD: %u\n", MAX_BROADCAST_PAYLOAD);
1414 lwsl_info(" LWS_MAX_PROTOCOLS: %u\n", LWS_MAX_PROTOCOLS);
1415 lwsl_info(" LWS_MAX_EXTENSIONS_ACTIVE: %u\n", LWS_MAX_EXTENSIONS_ACTIVE);
1416 lwsl_info(" SPEC_LATEST_SUPPORTED: %u\n", SPEC_LATEST_SUPPORTED);
1417 lwsl_info(" AWAITING_TIMEOUT: %u\n", AWAITING_TIMEOUT);
1418 lwsl_info(" CIPHERS_LIST_STRING: '%s'\n", CIPHERS_LIST_STRING);
1419 lwsl_info(" SYSTEM_RANDOM_FILEPATH: '%s'\n", SYSTEM_RANDOM_FILEPATH);
1420 lwsl_info(" LWS_MAX_ZLIB_CONN_BUFFER: %u\n", LWS_MAX_ZLIB_CONN_BUFFER);
1424 WORD wVersionRequested;
1429 /* Use the MAKEWORD(lowbyte, highbyte) macro from Windef.h */
1430 wVersionRequested = MAKEWORD(2, 2);
1432 err = WSAStartup(wVersionRequested, &wsaData);
1434 /* Tell the user that we could not find a usable */
1436 lwsl_err("WSAStartup failed with error: %d\n", err);
1440 /* default to a poll() made out of select() */
1441 poll = emulated_poll;
1443 /* if windows socket lib available, use his WSAPoll */
1444 wsdll = GetModuleHandle(_T("Ws2_32.dll"));
1446 poll = (PFNWSAPOLL)GetProcAddress(wsdll, "WSAPoll");
1450 context = (struct libwebsocket_context *) malloc(sizeof(struct libwebsocket_context));
1452 lwsl_err("No memory for websocket context\n");
1455 #ifndef NO_DAEMONIZE
1456 extern int pid_daemon;
1457 context->started_with_parent = pid_daemon;
1458 lwsl_notice(" Started with daemon pid %d\n", pid_daemon);
1461 context->protocols = protocols;
1462 context->listen_port = port;
1463 context->http_proxy_port = 0;
1464 context->http_proxy_address[0] = '\0';
1465 context->options = options;
1466 /* to reduce this allocation, */
1467 context->max_fds = getdtablesize();
1468 lwsl_notice(" max fd tracked: %u\n", context->max_fds);
1470 context->fds = (struct pollfd *)malloc(sizeof(struct pollfd) * context->max_fds);
1471 if (context->fds == NULL) {
1472 lwsl_err("Unable to allocate fds array for %d connections\n", context->max_fds);
1476 context->lws_lookup = (struct libwebsocket **)malloc(sizeof(struct libwebsocket *) * context->max_fds);
1477 if (context->lws_lookup == NULL) {
1478 lwsl_err("Unable to allocate lws_lookup array for %d connections\n", context->max_fds);
1483 context->fds_count = 0;
1484 context->extensions = extensions;
1485 context->last_timeout_check_s = 0;
1486 context->user_space = user;
1489 context->fd_random = 0;
1491 context->fd_random = open(SYSTEM_RANDOM_FILEPATH, O_RDONLY);
1492 if (context->fd_random < 0) {
1494 lwsl_err("Unable to open random device %s %d\n",
1495 SYSTEM_RANDOM_FILEPATH, context->fd_random);
1500 #ifdef LWS_OPENSSL_SUPPORT
1501 context->use_ssl = 0;
1502 context->ssl_ctx = NULL;
1503 context->ssl_client_ctx = NULL;
1504 openssl_websocket_private_data_index = 0;
1507 strcpy(context->canonical_hostname, "unknown");
1509 #ifndef LWS_NO_SERVER
1510 if (!(options & LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME)) {
1512 char hostname[1024] = "";
1514 /* find canonical hostname */
1516 hostname[(sizeof hostname) - 1] = '\0';
1517 memset(&sa, 0, sizeof(sa));
1518 sa.sa_family = AF_INET;
1519 sa.sa_data[(sizeof sa.sa_data) - 1] = '\0';
1520 gethostname(hostname, (sizeof hostname) - 1);
1524 if (strlen(hostname) < sizeof(sa.sa_data) - 1) {
1525 strcpy(sa.sa_data, hostname);
1526 // lwsl_debug("my host name is %s\n", sa.sa_data);
1527 n = getnameinfo(&sa, sizeof(sa), hostname,
1528 (sizeof hostname) - 1, NULL, 0, 0);
1532 strncpy(context->canonical_hostname, hostname,
1533 sizeof context->canonical_hostname - 1);
1534 context->canonical_hostname[
1535 sizeof context->canonical_hostname - 1] = '\0';
1537 strncpy(context->canonical_hostname, hostname,
1538 sizeof context->canonical_hostname - 1);
1540 lwsl_notice(" canonical_hostname = %s\n", context->canonical_hostname);
1544 /* split the proxy ads:port if given */
1546 p = getenv("http_proxy");
1548 strncpy(context->http_proxy_address, p,
1549 sizeof context->http_proxy_address - 1);
1550 context->http_proxy_address[
1551 sizeof context->http_proxy_address - 1] = '\0';
1553 p = strchr(context->http_proxy_address, ':');
1555 lwsl_err("http_proxy needs to be ads:port\n");
1559 context->http_proxy_port = atoi(p + 1);
1561 lwsl_notice(" Proxy %s:%u\n",
1562 context->http_proxy_address,
1563 context->http_proxy_port);
1566 #ifndef LWS_NO_SERVER
1569 #ifdef LWS_OPENSSL_SUPPORT
1570 context->use_ssl = ssl_cert_filepath != NULL &&
1571 ssl_private_key_filepath != NULL;
1572 if (context->use_ssl)
1573 lwsl_notice(" Compiled with SSL support, using it\n");
1575 lwsl_notice(" Compiled with SSL support, not using it\n");
1578 if (ssl_cert_filepath != NULL &&
1579 ssl_private_key_filepath != NULL) {
1580 lwsl_notice(" Not compiled for OpenSSl support!\n");
1583 lwsl_notice(" Compiled without SSL support, "
1584 "serving unencrypted\n");
1589 /* ignore SIGPIPE */
1592 signal(SIGPIPE, sigpipe_handler);
1596 #ifdef LWS_OPENSSL_SUPPORT
1598 /* basic openssl init */
1602 OpenSSL_add_all_algorithms();
1603 SSL_load_error_strings();
1605 openssl_websocket_private_data_index =
1606 SSL_get_ex_new_index(0, "libwebsockets", NULL, NULL, NULL);
1609 * Firefox insists on SSLv23 not SSLv3
1610 * Konq disables SSLv2 by default now, SSLv23 works
1613 method = (SSL_METHOD *)SSLv23_server_method();
1615 lwsl_err("problem creating ssl method: %s\n",
1616 ERR_error_string(ERR_get_error(), ssl_err_buf));
1619 context->ssl_ctx = SSL_CTX_new(method); /* create context */
1620 if (!context->ssl_ctx) {
1621 lwsl_err("problem creating ssl context: %s\n",
1622 ERR_error_string(ERR_get_error(), ssl_err_buf));
1626 #ifdef SSL_OP_NO_COMPRESSION
1627 SSL_CTX_set_options(context->ssl_ctx, SSL_OP_NO_COMPRESSION);
1629 SSL_CTX_set_options(context->ssl_ctx, SSL_OP_CIPHER_SERVER_PREFERENCE);
1630 SSL_CTX_set_cipher_list(context->ssl_ctx, CIPHERS_LIST_STRING);
1632 #ifndef LWS_NO_CLIENT
1634 /* client context */
1636 if (port == CONTEXT_PORT_NO_LISTEN) {
1637 method = (SSL_METHOD *)SSLv23_client_method();
1639 lwsl_err("problem creating ssl method: %s\n",
1640 ERR_error_string(ERR_get_error(), ssl_err_buf));
1643 /* create context */
1644 context->ssl_client_ctx = SSL_CTX_new(method);
1645 if (!context->ssl_client_ctx) {
1646 lwsl_err("problem creating ssl context: %s\n",
1647 ERR_error_string(ERR_get_error(), ssl_err_buf));
1651 #ifdef SSL_OP_NO_COMPRESSION
1652 SSL_CTX_set_options(context->ssl_client_ctx, SSL_OP_NO_COMPRESSION);
1654 SSL_CTX_set_options(context->ssl_client_ctx, SSL_OP_CIPHER_SERVER_PREFERENCE);
1655 SSL_CTX_set_cipher_list(context->ssl_client_ctx, CIPHERS_LIST_STRING);
1657 /* openssl init for cert verification (for client sockets) */
1658 if (!ssl_ca_filepath) {
1659 if (!SSL_CTX_load_verify_locations(
1660 context->ssl_client_ctx, NULL,
1661 LWS_OPENSSL_CLIENT_CERTS))
1663 "Unable to load SSL Client certs from %s "
1664 "(set by --with-client-cert-dir= in configure) -- "
1665 " client ssl isn't going to work",
1666 LWS_OPENSSL_CLIENT_CERTS);
1668 if (!SSL_CTX_load_verify_locations(
1669 context->ssl_client_ctx, ssl_ca_filepath,
1672 "Unable to load SSL Client certs "
1673 "file from %s -- client ssl isn't "
1674 "going to work", ssl_ca_filepath);
1677 * callback allowing user code to load extra verification certs
1678 * helping the client to verify server identity
1681 context->protocols[0].callback(context, NULL,
1682 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS,
1683 context->ssl_client_ctx, NULL, 0);
1687 /* as a server, are we requiring clients to identify themselves? */
1689 if (options & LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT) {
1691 /* absolutely require the client cert */
1693 SSL_CTX_set_verify(context->ssl_ctx,
1694 SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
1695 OpenSSL_verify_callback);
1698 * give user code a chance to load certs into the server
1699 * allowing it to verify incoming client certs
1702 context->protocols[0].callback(context, NULL,
1703 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS,
1704 context->ssl_ctx, NULL, 0);
1707 if (context->use_ssl) {
1709 /* openssl init for server sockets */
1711 /* set the local certificate from CertFile */
1712 n = SSL_CTX_use_certificate_chain_file(context->ssl_ctx,
1715 lwsl_err("problem getting cert '%s': %s\n",
1717 ERR_error_string(ERR_get_error(), ssl_err_buf));
1720 /* set the private key from KeyFile */
1721 if (SSL_CTX_use_PrivateKey_file(context->ssl_ctx,
1722 ssl_private_key_filepath, SSL_FILETYPE_PEM) != 1) {
1723 lwsl_err("ssl problem getting key '%s': %s\n",
1724 ssl_private_key_filepath,
1725 ERR_error_string(ERR_get_error(), ssl_err_buf));
1728 /* verify private key */
1729 if (!SSL_CTX_check_private_key(context->ssl_ctx)) {
1730 lwsl_err("Private SSL key doesn't match cert\n");
1734 /* SSL is happy and has a cert it's content with */
1740 if (lws_b64_selftest())
1743 #ifndef LWS_NO_SERVER
1744 /* set up our external listening socket we serve on */
1747 extern int interface_to_sa(const char *ifname, struct sockaddr_in *addr, size_t addrlen);
1750 sockfd = socket(AF_INET, SOCK_STREAM, 0);
1752 lwsl_err("ERROR opening socket\n");
1756 /* allow us to restart even if old sockets in TIME_WAIT */
1757 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR,
1758 (const void *)&opt, sizeof(opt));
1762 setsockopt(sockfd, IPPROTO_TCP, TCP_NODELAY,
1763 (const void *)&opt, sizeof(opt));
1765 bzero((char *) &serv_addr, sizeof(serv_addr));
1766 serv_addr.sin_family = AF_INET;
1768 serv_addr.sin_addr.s_addr = INADDR_ANY;
1770 interface_to_sa(interf, &serv_addr,
1772 serv_addr.sin_port = htons(port);
1774 n = bind(sockfd, (struct sockaddr *) &serv_addr,
1777 lwsl_err("ERROR on binding to port %d (%d %d)\n",
1783 wsi = (struct libwebsocket *)malloc(sizeof(struct libwebsocket));
1785 lwsl_err("Out of mem\n");
1789 memset(wsi, 0, sizeof (struct libwebsocket));
1791 wsi->count_active_extensions = 0;
1792 wsi->mode = LWS_CONNMODE_SERVER_LISTENER;
1794 insert_wsi_socket_into_fds(context, wsi);
1796 context->listen_service_modulo = LWS_LISTEN_SERVICE_MODULO;
1797 context->listen_service_count = 0;
1798 context->listen_service_fd = sockfd;
1800 listen(sockfd, LWS_SOMAXCONN);
1801 lwsl_notice(" Listening on port %d\n", port);
1806 * drop any root privs for this process
1807 * to listen on port < 1023 we would have needed root, but now we are
1808 * listening, we don't want the power for anything else
1814 lwsl_warn("setgid: %s\n", strerror(errno));
1817 lwsl_warn("setuid: %s\n", strerror(errno));
1820 /* set up our internal broadcast trigger sockets per-protocol */
1822 for (context->count_protocols = 0;
1823 protocols[context->count_protocols].callback;
1824 context->count_protocols++) {
1826 lwsl_parser(" Protocol: %s\n",
1827 protocols[context->count_protocols].name);
1829 protocols[context->count_protocols].owning_server = context;
1830 protocols[context->count_protocols].protocol_index =
1831 context->count_protocols;
1833 fd = socket(AF_INET, SOCK_STREAM, 0);
1835 lwsl_err("ERROR opening socket\n");
1839 /* allow us to restart even if old sockets in TIME_WAIT */
1840 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (const void *)&opt,
1843 bzero((char *) &serv_addr, sizeof(serv_addr));
1844 serv_addr.sin_family = AF_INET;
1845 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
1846 serv_addr.sin_port = 0; /* pick the port for us */
1848 n = bind(fd, (struct sockaddr *) &serv_addr, sizeof(serv_addr));
1850 lwsl_err("ERROR on binding to port %d (%d %d)\n",
1855 slen = sizeof cli_addr;
1856 n = getsockname(fd, (struct sockaddr *)&cli_addr, &slen);
1858 lwsl_err("getsockname failed\n");
1861 protocols[context->count_protocols].broadcast_socket_port =
1862 ntohs(cli_addr.sin_port);
1865 lwsl_debug(" Protocol %s broadcast socket %d\n",
1866 protocols[context->count_protocols].name,
1867 ntohs(cli_addr.sin_port));
1869 /* dummy wsi per broadcast proxy socket */
1871 wsi = (struct libwebsocket *)malloc(sizeof(struct libwebsocket));
1873 lwsl_err("Out of mem\n");
1877 memset(wsi, 0, sizeof (struct libwebsocket));
1879 wsi->mode = LWS_CONNMODE_BROADCAST_PROXY_LISTENER;
1880 wsi->count_active_extensions = 0;
1881 /* note which protocol we are proxying */
1882 wsi->protocol_index_for_broadcast_proxy =
1883 context->count_protocols;
1885 insert_wsi_socket_into_fds(context, wsi);
1889 * give all extensions a chance to create any per-context
1890 * allocations they need
1893 m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_CONSTRUCT;
1895 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_CONSTRUCT;
1898 while (extensions->callback) {
1899 lwsl_ext(" Extension: %s\n", extensions->name);
1900 extensions->callback(context, extensions, NULL,
1901 (enum libwebsocket_extension_callback_reasons)m,
1914 * libwebsockets_fork_service_loop() - Optional helper function forks off
1915 * a process for the websocket server loop.
1916 * You don't have to use this but if not, you
1917 * have to make sure you are calling
1918 * libwebsocket_service periodically to service
1919 * the websocket traffic
1920 * @context: server context returned by creation function
1924 libwebsockets_fork_service_loop(struct libwebsocket_context *context)
1927 struct sockaddr_in cli_addr;
1937 /* main process context */
1940 * set up the proxy sockets to allow broadcast from
1941 * service process context
1944 for (p = 0; p < context->count_protocols; p++) {
1945 fd = socket(AF_INET, SOCK_STREAM, 0);
1947 lwsl_err("Unable to create socket\n");
1950 cli_addr.sin_family = AF_INET;
1951 cli_addr.sin_port = htons(
1952 context->protocols[p].broadcast_socket_port);
1953 cli_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
1954 n = connect(fd, (struct sockaddr *)&cli_addr,
1957 lwsl_err("Unable to connect to "
1958 "broadcast socket %d, %s\n",
1959 n, strerror(errno));
1963 context->protocols[p].broadcast_socket_user_fd = fd;
1969 #ifdef HAVE_SYS_PRCTL_H
1970 /* we want a SIGHUP when our parent goes down */
1971 signal(SIGHUP, SIG_DFL);
1972 prctl(PR_SET_PDEATHSIG, SIGHUP);
1975 /* in this forked process, sit and service websocket connections */
1978 if (libwebsocket_service(context, 1000))
1980 //#ifndef HAVE_SYS_PRCTL_H
1982 * on systems without prctl() (i.e. anything but linux) we can notice that our
1983 * parent is dead if getppid() returns 1. FIXME apparently this is not true for
1984 * solaris, could remember ppid right after fork and wait for it to change.
1987 /* if our parent went down, don't linger around */
1988 if (context->started_with_parent && kill(context->started_with_parent, 0) < 0)
1989 kill(getpid(), SIGTERM);
2003 * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
2005 * @wsi: pointer to struct websocket you want to know the protocol of
2008 * This is useful to get the protocol to broadcast back to from inside
2012 const struct libwebsocket_protocols *
2013 libwebsockets_get_protocol(struct libwebsocket *wsi)
2015 return wsi->protocol;
2019 * libwebsockets_broadcast() - Sends a buffer to the callback for all active
2020 * connections of the given protocol.
2021 * @protocol: pointer to the protocol you will broadcast to all members of
2022 * @buf: buffer containing the data to be broadcase. NOTE: this has to be
2023 * allocated with LWS_SEND_BUFFER_PRE_PADDING valid bytes before
2024 * the pointer and LWS_SEND_BUFFER_POST_PADDING afterwards in the
2025 * case you are calling this function from callback context.
2026 * @len: length of payload data in buf, starting from buf.
2028 * This function allows bulk sending of a packet to every connection using
2029 * the given protocol. It does not send the data directly; instead it calls
2030 * the callback with a reason type of LWS_CALLBACK_BROADCAST. If the callback
2031 * wants to actually send the data for that connection, the callback itself
2032 * should call libwebsocket_write().
2034 * libwebsockets_broadcast() can be called from another fork context without
2035 * having to take any care about data visibility between the processes, it'll
2041 libwebsockets_broadcast(const struct libwebsocket_protocols *protocol,
2042 unsigned char *buf, size_t len)
2044 struct libwebsocket_context *context = protocol->owning_server;
2046 struct libwebsocket *wsi;
2048 if (!protocol->broadcast_socket_user_fd) {
2050 * We are either running unforked / flat, or we are being
2051 * called from poll thread context
2052 * eg, from a callback. In that case don't use sockets for
2053 * broadcast IPC (since we can't open a socket connection to
2054 * a socket listening on our own thread) but directly do the
2057 * Locking is not needed because we are by definition being
2058 * called in the poll thread context and are serialized.
2061 for (n = 0; n < context->fds_count; n++) {
2063 wsi = context->lws_lookup[context->fds[n].fd];
2067 if (wsi->mode != LWS_CONNMODE_WS_SERVING)
2071 * never broadcast to non-established connections
2073 if (wsi->state != WSI_STATE_ESTABLISHED)
2076 /* only broadcast to guys using
2077 * requested protocol
2079 if (wsi->protocol != protocol)
2082 user_callback_handle_rxflow(wsi->protocol->callback,
2084 LWS_CALLBACK_BROADCAST,
2093 * We're being called from a different process context than the server
2094 * loop. Instead of broadcasting directly, we send our
2095 * payload on a socket to do the IPC; the server process will serialize
2096 * the broadcast action in its main poll() loop.
2098 * There's one broadcast socket listening for each protocol supported
2099 * set up when the websocket server initializes
2102 n = send(protocol->broadcast_socket_user_fd, buf, len, MSG_NOSIGNAL);
2108 libwebsocket_is_final_fragment(struct libwebsocket *wsi)
2114 libwebsocket_get_reserved_bits(struct libwebsocket *wsi)
2120 libwebsocket_ensure_user_space(struct libwebsocket *wsi)
2122 /* allocate the per-connection user memory (if any) */
2124 if (wsi->protocol->per_session_data_size && !wsi->user_space) {
2125 wsi->user_space = malloc(
2126 wsi->protocol->per_session_data_size);
2127 if (wsi->user_space == NULL) {
2128 lwsl_err("Out of memory for conn user space\n");
2131 memset(wsi->user_space, 0,
2132 wsi->protocol->per_session_data_size);
2134 return wsi->user_space;
2138 * lws_confirm_legit_wsi: returns nonzero if the wsi looks bad
2140 * @wsi: struct libwebsocket to assess
2142 * Performs consistecy checks on what the wsi claims and what the
2143 * polling arrays hold. This'll catch a closed wsi still in use.
2144 * Don't try to use on the listen (nonconnection) wsi as it will
2145 * fail it. Otherwise 0 return == wsi seems consistent.
2148 int lws_confirm_legit_wsi(struct libwebsocket *wsi)
2150 struct libwebsocket_context *context;
2152 if (!(wsi && wsi->protocol && wsi->protocol->owning_server))
2155 context = wsi->protocol->owning_server;
2160 if (!wsi->position_in_fds_table)
2161 return 3; /* position in fds table looks bad */
2162 if (context->fds[wsi->position_in_fds_table].fd != wsi->sock)
2163 return 4; /* pollfd entry does not wait on our socket descriptor */
2164 if (context->lws_lookup[wsi->sock] != wsi)
2165 return 5; /* lookup table does not agree with wsi */
2170 static void lwsl_emit_stderr(int level, const char *line)
2176 gettimeofday(&tv, NULL);
2179 for (n = 0; n < LLL_COUNT; n++)
2180 if (level == (1 << n)) {
2181 sprintf(buf, "[%ld:%04d] %s: ", tv.tv_sec,
2182 (int)(tv.tv_usec / 100), log_level_names[n]);
2186 fprintf(stderr, "%s%s", buf, line);
2189 void lwsl_emit_syslog(int level, const char *line)
2191 int syslog_level = LOG_DEBUG;
2195 syslog_level = LOG_ERR;
2198 syslog_level = LOG_WARNING;
2201 syslog_level = LOG_NOTICE;
2204 syslog_level = LOG_INFO;
2207 syslog(syslog_level, "%s", line);
2210 void _lws_log(int filter, const char *format, ...)
2215 if (!(log_level & filter))
2218 va_start(ap, format);
2219 vsnprintf(buf, (sizeof buf), format, ap);
2220 buf[(sizeof buf) - 1] = '\0';
2223 lwsl_emit(filter, buf);
2227 * lws_set_log_level() - Set the logging bitfield
2228 * @level: OR together the LLL_ debug contexts you want output from
2229 * @log_emit_function: NULL to leave it as it is, or a user-supplied
2230 * function to perform log string emission instead of
2231 * the default stderr one.
2233 * log level defaults to "err" and "warn" contexts enabled only and
2234 * emission on stderr.
2237 void lws_set_log_level(int level, void (*log_emit_function)(int level, const char *line))
2240 if (log_emit_function)
2241 lwsl_emit = log_emit_function;