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"
24 /* file descriptor hash management */
27 wsi_from_fd(struct libwebsocket_context *this, int fd)
29 int h = LWS_FD_HASH(fd);
32 for (n = 0; n < this->fd_hashtable[h].length; n++)
33 if (this->fd_hashtable[h].wsi[n]->sock == fd)
34 return this->fd_hashtable[h].wsi[n];
40 insert_wsi(struct libwebsocket_context *this, struct libwebsocket *wsi)
42 int h = LWS_FD_HASH(wsi->sock);
44 if (this->fd_hashtable[h].length == MAX_CLIENTS - 1) {
45 fprintf(stderr, "hash table overflow\n");
49 this->fd_hashtable[h].wsi[this->fd_hashtable[h].length++] = wsi;
55 delete_from_fd(struct libwebsocket_context *this, int fd)
57 int h = LWS_FD_HASH(fd);
60 for (n = 0; n < this->fd_hashtable[h].length; n++)
61 if (this->fd_hashtable[h].wsi[n]->sock == fd) {
62 while (n < this->fd_hashtable[h].length) {
63 this->fd_hashtable[h].wsi[n] =
64 this->fd_hashtable[h].wsi[n + 1];
67 this->fd_hashtable[h].length--;
72 fprintf(stderr, "Failed to find fd %d requested for "
73 "delete in hashtable\n", fd);
79 libwebsocket_close_and_free_session(struct libwebsocket *wsi)
82 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 2 +
83 LWS_SEND_BUFFER_POST_PADDING];
85 if ((unsigned long)wsi < LWS_MAX_PROTOCOLS)
90 if (n == WSI_STATE_DEAD_SOCKET)
94 * signal we are closing, libsocket_write will
95 * add any necessary version-specific stuff. If the write fails,
96 * no worries we are closing anyway. If we didn't initiate this
97 * close, then our state has been changed to
98 * WSI_STATE_RETURNED_CLOSE_ALREADY and we can skip this
101 if (n == WSI_STATE_ESTABLISHED)
102 libwebsocket_write(wsi, &buf[LWS_SEND_BUFFER_PRE_PADDING], 0,
105 wsi->state = WSI_STATE_DEAD_SOCKET;
107 if (wsi->protocol->callback && n == WSI_STATE_ESTABLISHED)
108 wsi->protocol->callback(wsi, LWS_CALLBACK_CLOSED,
109 wsi->user_space, NULL, 0);
111 for (n = 0; n < WSI_TOKEN_COUNT; n++)
112 if (wsi->utf8_token[n].token)
113 free(wsi->utf8_token[n].token);
115 /* fprintf(stderr, "closing fd=%d\n", wsi->sock); */
117 #ifdef LWS_OPENSSL_SUPPORT
119 n = SSL_get_fd(wsi->ssl);
120 SSL_shutdown(wsi->ssl);
125 shutdown(wsi->sock, SHUT_RDWR);
127 #ifdef LWS_OPENSSL_SUPPORT
131 free(wsi->user_space);
137 * libwebsockets_get_peer_addresses() - Get client address information
138 * @fd: Connection socket descriptor
139 * @name: Buffer to take client address name
140 * @name_len: Length of client address name buffer
141 * @rip: Buffer to take client address IP qotted quad
142 * @rip_len: Length of client address IP buffer
144 * This function fills in @name and @rip with the name and IP of
145 * the client connected with socket descriptor @fd. Names may be
146 * truncated if there is not enough room. If either cannot be
147 * determined, they will be returned as valid zero-length strings.
151 libwebsockets_get_peer_addresses(int fd, char *name, int name_len,
152 char *rip, int rip_len)
155 struct sockaddr_in sin;
156 struct hostent *host;
157 struct hostent *host1;
166 if (getpeername(fd, (struct sockaddr *) &sin, &len) < 0) {
167 perror("getpeername");
171 host = gethostbyaddr((char *) &sin.sin_addr, sizeof sin.sin_addr,
174 perror("gethostbyaddr");
178 strncpy(name, host->h_name, name_len);
179 name[name_len - 1] = '\0';
181 host1 = gethostbyname(host->h_name);
187 p = host1->h_addr_list[n++];
190 if (host1->h_addrtype != AF_INET)
193 sprintf(ip, "%d.%d.%d.%d",
194 p[0], p[1], p[2], p[3]);
196 strncpy(rip, ip, rip_len);
197 rip[rip_len - 1] = '\0';
202 * libwebsocket_service_fd() - Service polled socket with something waiting
203 * @this: Websocket context
204 * @pollfd: The pollfd entry describing the socket fd and which events
207 * This function closes any active connections and then frees the
208 * context. After calling this, any further use of the context is
213 libwebsocket_service_fd(struct libwebsocket_context *this,
214 struct pollfd *pollfd)
216 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + MAX_BROADCAST_PAYLOAD +
217 LWS_SEND_BUFFER_POST_PADDING];
218 struct libwebsocket *wsi = wsi_from_fd(this, pollfd->fd);
219 struct libwebsocket *new_wsi;
225 struct sockaddr_in cli_addr;
231 case LWS_CONNMODE_SERVER_LISTENER:
233 /* pollin means a client has connected to us then */
235 if (!pollfd->revents & POLLIN)
238 /* listen socket got an unencrypted connection... */
240 clilen = sizeof(cli_addr);
241 accept_fd = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
244 fprintf(stderr, "ERROR on accept");
248 if (this->fds_count >= MAX_CLIENTS) {
249 fprintf(stderr, "too busy to accept new client\n");
255 * look at who we connected to and give user code a chance
256 * to reject based on client IP. There's no protocol selected
257 * yet so we issue this to protocols[0]
260 if ((this->protocols[0].callback)(wsi,
261 LWS_CALLBACK_FILTER_NETWORK_CONNECTION,
262 (void*)(long)accept_fd, NULL, 0)) {
263 fprintf(stderr, "Callback denied network connection\n");
268 /* accepting connection to main listener */
270 new_wsi = malloc(sizeof(struct libwebsocket));
271 if (new_wsi == NULL) {
272 fprintf(stderr, "Out of memory for new connection\n");
276 memset(new_wsi, 0, sizeof (struct libwebsocket));
277 new_wsi->sock = accept_fd;
279 #ifdef LWS_OPENSSL_SUPPORT
281 this->ssl_ctx = NULL;
285 new_wsi->ssl = SSL_new(this->ssl_ctx);
286 if (new_wsi->ssl == NULL) {
287 fprintf(stderr, "SSL_new failed: %s\n",
288 ERR_error_string(SSL_get_error(
289 new_wsi->ssl, 0), NULL));
294 SSL_set_fd(new_wsi->ssl, accept_fd);
296 n = SSL_accept(new_wsi->ssl);
299 * browsers seem to probe with various
300 * ssl params which fail then retry
303 debug("SSL_accept failed skt %u: %s\n",
305 ERR_error_string(SSL_get_error(
306 new_wsi->ssl, n), NULL));
312 debug("accepted new SSL conn "
313 "port %u on fd=%d SSL ver %s\n",
314 ntohs(cli_addr.sin_port), accept_fd,
315 SSL_get_version(new_wsi->ssl));
319 debug("accepted new conn port %u on fd=%d\n",
320 ntohs(cli_addr.sin_port), accept_fd);
322 /* intialize the instance struct */
324 new_wsi->state = WSI_STATE_HTTP;
325 new_wsi->name_buffer_pos = 0;
326 new_wsi->mode = LWS_CONNMODE_WS_SERVING;
328 for (n = 0; n < WSI_TOKEN_COUNT; n++) {
329 new_wsi->utf8_token[n].token = NULL;
330 new_wsi->utf8_token[n].token_len = 0;
334 * these can only be set once the protocol is known
335 * we set an unestablished connection's protocol pointer
336 * to the start of the supported list, so it can look
337 * for matching ones during the handshake
339 new_wsi->protocol = this->protocols;
340 new_wsi->user_space = NULL;
343 * Default protocol is 76 / 00
344 * After 76, there's a header specified to inform which
345 * draft the client wants, when that's seen we modify
346 * the individual connection's spec revision accordingly
348 new_wsi->ietf_spec_revision = 0;
350 insert_wsi(this, new_wsi);
353 * make sure NO events are seen yet on this new socket
354 * (otherwise we inherit old fds[client].revents from
355 * previous socket there and die mysteriously! )
357 this->fds[this->fds_count].revents = 0;
359 this->fds[this->fds_count].events = POLLIN;
360 this->fds[this->fds_count++].fd = accept_fd;
362 /* external POLL support via protocol 0 */
363 this->protocols[0].callback(new_wsi,
364 LWS_CALLBACK_ADD_POLL_FD,
365 (void *)(long)accept_fd, NULL, POLLIN);
369 case LWS_CONNMODE_BROADCAST_PROXY_LISTENER:
371 /* as we are listening, POLLIN means accept() is needed */
373 if (!pollfd->revents & POLLIN)
376 /* listen socket got an unencrypted connection... */
378 clilen = sizeof(cli_addr);
379 accept_fd = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
382 fprintf(stderr, "ERROR on accept");
386 if (this->fds_count >= MAX_CLIENTS) {
387 fprintf(stderr, "too busy to accept new broadcast "
393 /* create a dummy wsi for the connection and add it */
395 new_wsi = malloc(sizeof(struct libwebsocket));
396 memset(new_wsi, 0, sizeof (struct libwebsocket));
397 new_wsi->sock = accept_fd;
398 new_wsi->mode = LWS_CONNMODE_BROADCAST_PROXY;
399 new_wsi->state = WSI_STATE_ESTABLISHED;
400 /* note which protocol we are proxying */
401 new_wsi->protocol_index_for_broadcast_proxy =
402 wsi->protocol_index_for_broadcast_proxy;
403 insert_wsi(this, new_wsi);
405 /* add connected socket to internal poll array */
407 this->fds[this->fds_count].revents = 0;
408 this->fds[this->fds_count].events = POLLIN;
409 this->fds[this->fds_count++].fd = accept_fd;
411 /* external POLL support via protocol 0 */
412 this->protocols[0].callback(new_wsi,
413 LWS_CALLBACK_ADD_POLL_FD,
414 (void *)(long)accept_fd, NULL, POLLIN);
418 case LWS_CONNMODE_BROADCAST_PROXY:
420 /* handle session socket closed */
422 if (pollfd->revents & (POLLERR | POLLHUP)) {
424 debug("Session Socket %p (fd=%d) dead\n",
425 (void *)wsi, accept_fd);
427 libwebsocket_close_and_free_session(wsi);
431 /* the guy requested a callback when it was OK to write */
433 if (pollfd->revents & POLLOUT) {
437 pollfd->events &= ~POLLOUT;
439 /* external POLL support via protocol 0 */
440 this->protocols[0].callback(wsi,
441 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
442 (void *)(long)wsi->sock, NULL, POLLOUT);
444 wsi->protocol->callback(wsi,
445 LWS_CALLBACK_CLIENT_WRITEABLE,
450 /* any incoming data ready? */
452 if (!(pollfd->revents & POLLIN))
455 /* get the issued broadcast payload from the socket */
457 len = read(pollfd->fd, buf + LWS_SEND_BUFFER_PRE_PADDING,
458 MAX_BROADCAST_PAYLOAD);
460 fprintf(stderr, "Error reading broadcast payload\n");
464 /* broadcast it to all guys with this protocol index */
466 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
468 for (m = 0; m < this->fd_hashtable[n].length; m++) {
470 new_wsi = this->fd_hashtable[n].wsi[m];
472 /* only to clients we are serving to */
474 if (new_wsi->mode != LWS_CONNMODE_WS_SERVING)
478 * never broadcast to non-established
482 if (new_wsi->state != WSI_STATE_ESTABLISHED)
486 * only broadcast to connections using
487 * the requested protocol
490 if (new_wsi->protocol->protocol_index !=
491 wsi->protocol_index_for_broadcast_proxy)
494 /* broadcast it to this connection */
496 new_wsi->protocol->callback(new_wsi,
497 LWS_CALLBACK_BROADCAST,
499 buf + LWS_SEND_BUFFER_PRE_PADDING, len);
504 case LWS_CONNMODE_WS_SERVING:
505 case LWS_CONNMODE_WS_CLIENT:
507 /* handle session socket closed */
509 if (pollfd->revents & (POLLERR | POLLHUP)) {
511 debug("Session Socket %p (fd=%d) dead\n",
512 (void *)wsi, pollfd->fd);
514 libwebsocket_close_and_free_session(wsi);
518 /* the guy requested a callback when it was OK to write */
520 if (pollfd->revents & POLLOUT) {
522 pollfd->events &= ~POLLOUT;
524 /* external POLL support via protocol 0 */
525 this->protocols[0].callback(wsi,
526 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
527 (void *)(long)wsi->sock, NULL, POLLOUT);
529 wsi->protocol->callback(wsi,
530 LWS_CALLBACK_CLIENT_WRITEABLE,
535 /* any incoming data ready? */
537 if (!(pollfd->revents & POLLIN))
540 #ifdef LWS_OPENSSL_SUPPORT
542 n = SSL_read(wsi->ssl, buf, sizeof buf);
545 n = recv(pollfd->fd, buf, sizeof buf, 0);
548 fprintf(stderr, "Socket read returned %d\n", n);
552 libwebsocket_close_and_free_session(wsi);
556 /* service incoming data */
558 n = libwebsocket_read(wsi, buf, n);
562 * it closed and nuked wsi[client], so remove the
563 * socket handle and wsi from our service list
567 debug("nuking wsi %p, fsd_count = %d\n",
568 (void *)wsi, this->fds_count - 1);
570 delete_from_fd(this, pollfd->fd);
573 for (n = 0; n < this->fds_count; n++)
574 if (this->fds[n].fd == pollfd->fd) {
575 while (n < this->fds_count) {
576 this->fds[n] = this->fds[n + 1];
582 /* external POLL support via protocol 0 */
583 this->protocols[0].callback(wsi,
584 LWS_CALLBACK_DEL_POLL_FD,
585 (void *)(long)pollfd->fd, NULL, 0);
596 * libwebsocket_context_destroy() - Destroy the websocket context
597 * @this: Websocket context
599 * This function closes any active connections and then frees the
600 * context. After calling this, any further use of the context is
604 libwebsocket_context_destroy(struct libwebsocket_context *this)
608 struct libwebsocket *wsi;
610 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
612 for (m = 0; m < this->fd_hashtable[n].length; m++) {
614 wsi = this->fd_hashtable[n].wsi[m];
617 case LWS_CONNMODE_WS_SERVING:
618 libwebsocket_close_and_free_session(wsi);
620 case LWS_CONNMODE_WS_CLIENT:
621 libwebsocket_client_close(wsi);
629 close(this->fd_random);
631 #ifdef LWS_OPENSSL_SUPPORT
633 SSL_CTX_free(this->ssl_ctx);
634 if (this->ssl_client_ctx)
635 SSL_CTX_free(this->ssl_client_ctx);
642 * libwebsocket_service() - Service any pending websocket activity
643 * @this: Websocket context
644 * @timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
645 * service otherwise block and service immediately, returning
646 * after the timeout if nothing needed service.
648 * This function deals with any pending websocket traffic, for three
649 * kinds of event. It handles these events on both server and client
650 * types of connection the same.
652 * 1) Accept new connections to our context's server
654 * 2) Perform pending broadcast writes initiated from other forked
655 * processes (effectively serializing asynchronous broadcasts)
657 * 3) Call the receive callback for incoming frame data received by
658 * server or client connections.
660 * You need to call this service function periodically to all the above
661 * functions to happen; if your application is single-threaded you can
662 * just call it in your main event loop.
664 * Alternatively you can fork a new process that asynchronously handles
665 * calling this service in a loop. In that case you are happy if this
666 * call blocks your thread until it needs to take care of something and
667 * would call it with a large nonzero timeout. Your loop then takes no
668 * CPU while there is nothing happening.
670 * If you are calling it in a single-threaded app, you don't want it to
671 * wait around blocking other things in your loop from happening, so you
672 * would call it with a timeout_ms of 0, so it returns immediately if
673 * nothing is pending, or as soon as it services whatever was pending.
678 libwebsocket_service(struct libwebsocket_context *this, int timeout_ms)
682 /* stay dead once we are dead */
687 /* wait for something to need service */
689 n = poll(this->fds, this->fds_count, timeout_ms);
690 if (n == 0) /* poll timeout */
693 if (n < 0 || this->fds[0].revents & (POLLERR | POLLHUP)) {
695 fprintf(stderr, "Listen Socket dead\n");
700 /* handle accept on listening socket? */
702 for (n = 0; n < this->fds_count; n++)
703 if (this->fds[n].revents)
704 libwebsocket_service_fd(this, &this->fds[n]);
710 * libwebsocket_callback_on_writable() - Request a callback when this socket
711 * becomes able to be written to without
714 * @wsi: Websocket connection instance to get callback for
718 libwebsocket_callback_on_writable(struct libwebsocket *wsi)
720 struct libwebsocket_context *this = wsi->protocol->owning_server;
723 for (n = 0; n < this->fds_count; n++)
724 if (this->fds[n].fd == wsi->sock) {
725 this->fds[n].events |= POLLOUT;
729 /* external POLL support via protocol 0 */
730 this->protocols[0].callback(wsi,
731 LWS_CALLBACK_SET_MODE_POLL_FD,
732 (void *)(long)wsi->sock, NULL, POLLOUT);
738 * libwebsocket_callback_on_writable_all_protocol() - Request a callback for
739 * all connections using the given protocol when it
740 * becomes possible to write to each socket without
743 * @protocol: Protocol whose connections will get callbacks
747 libwebsocket_callback_on_writable_all_protocol(
748 const struct libwebsocket_protocols *protocol)
750 struct libwebsocket_context *this = protocol->owning_server;
753 struct libwebsocket *wsi;
755 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
757 for (m = 0; m < this->fd_hashtable[n].length; m++) {
759 wsi = this->fd_hashtable[n].wsi[m];
761 if (wsi->protocol == protocol)
762 libwebsocket_callback_on_writable(wsi);
771 * libwebsocket_get_socket_fd() - returns the socket file descriptor
773 * You will not need this unless you are doing something special
775 * @wsi: Websocket connection instance
779 libwebsocket_get_socket_fd(struct libwebsocket *wsi)
785 * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
788 * If the output side of a server process becomes choked, this allows flow
789 * control for the input side.
791 * @wsi: Websocket connection instance to get callback for
792 * @enable: 0 = disable read servicing for this connection, 1 = enable
796 libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
798 struct libwebsocket_context *this = wsi->protocol->owning_server;
801 for (n = 0; n < this->fds_count; n++)
802 if (this->fds[n].fd == wsi->sock) {
804 this->fds[n].events |= POLLIN;
806 this->fds[n].events &= ~POLLIN;
812 /* external POLL support via protocol 0 */
813 this->protocols[0].callback(wsi,
814 LWS_CALLBACK_SET_MODE_POLL_FD,
815 (void *)(long)wsi->sock, NULL, POLLIN);
817 /* external POLL support via protocol 0 */
818 this->protocols[0].callback(wsi,
819 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
820 (void *)(long)wsi->sock, NULL, POLLIN);
823 fprintf(stderr, "libwebsocket_callback_on_writable "
824 "unable to find socket\n");
829 * libwebsocket_canonical_hostname() - returns this host's hostname
831 * This is typically used by client code to fill in the host parameter
832 * when making a client connection. You can only call it after the context
835 * @this: Websocket context
840 libwebsocket_canonical_hostname(struct libwebsocket_context *this)
842 return (const char *)this->canonical_hostname;
846 static void sigpipe_handler(int x)
853 * libwebsocket_create_context() - Create the websocket handler
854 * @port: Port to listen on... you can use 0 to suppress listening on
855 * any port, that's what you want if you are not running a
856 * websocket server at all but just using it as a client
857 * @protocols: Array of structures listing supported protocols and a protocol-
858 * specific callback for each one. The list is ended with an
859 * entry that has a NULL callback pointer.
860 * It's not const because we write the owning_server member
861 * @ssl_cert_filepath: If libwebsockets was compiled to use ssl, and you want
862 * to listen using SSL, set to the filepath to fetch the
863 * server cert from, otherwise NULL for unencrypted
864 * @ssl_private_key_filepath: filepath to private key if wanting SSL mode,
866 * @gid: group id to change to after setting listen socket, or -1.
867 * @uid: user id to change to after setting listen socket, or -1.
868 * @options: 0, or LWS_SERVER_OPTION_DEFEAT_CLIENT_MASK
870 * This function creates the listening socket and takes care
871 * of all initialization in one step.
873 * After initialization, it returns a struct libwebsocket_context * that
874 * represents this server. After calling, user code needs to take care
875 * of calling libwebsocket_service() with the context pointer to get the
876 * server's sockets serviced. This can be done in the same process context
877 * or a forked process, or another thread,
879 * The protocol callback functions are called for a handful of events
880 * including http requests coming in, websocket connections becoming
881 * established, and data arriving; it's also called periodically to allow
882 * async transmission.
884 * HTTP requests are sent always to the FIRST protocol in @protocol, since
885 * at that time websocket protocol has not been negotiated. Other
886 * protocols after the first one never see any HTTP callack activity.
888 * The server created is a simple http server by default; part of the
889 * websocket standard is upgrading this http connection to a websocket one.
891 * This allows the same server to provide files like scripts and favicon /
892 * images or whatever over http and dynamic data over websockets all in
893 * one place; they're all handled in the user callback.
896 struct libwebsocket_context *
897 libwebsocket_create_context(int port,
898 struct libwebsocket_protocols *protocols,
899 const char *ssl_cert_filepath,
900 const char *ssl_private_key_filepath,
901 int gid, int uid, unsigned int options)
906 struct sockaddr_in serv_addr, cli_addr;
908 struct libwebsocket_context *this = NULL;
913 struct libwebsocket *wsi;
915 #ifdef LWS_OPENSSL_SUPPORT
917 char ssl_err_buf[512];
920 this = malloc(sizeof(struct libwebsocket_context));
922 fprintf(stderr, "No memory for websocket context\n");
925 this->protocols = protocols;
926 this->listen_port = port;
927 this->http_proxy_port = 0;
928 this->http_proxy_address[0] = '\0';
929 this->options = options;
932 this->fd_random = open(SYSTEM_RANDOM_FILEPATH, O_RDONLY);
933 if (this->fd_random < 0) {
934 fprintf(stderr, "Unable to open random device %s %d\n",
935 SYSTEM_RANDOM_FILEPATH, this->fd_random);
939 /* find canonical hostname */
941 hostname[(sizeof hostname) - 1] = '\0';
942 gethostname(hostname, (sizeof hostname) - 1);
943 he = gethostbyname(hostname);
944 strncpy(this->canonical_hostname, he->h_name,
945 sizeof this->canonical_hostname - 1);
946 this->canonical_hostname[sizeof this->canonical_hostname - 1] = '\0';
947 fprintf(stderr, " canonical hostname = '%s'\n",
948 this->canonical_hostname);
950 /* split the proxy ads:port if given */
952 p = getenv("http_proxy");
954 strncpy(this->http_proxy_address, p,
955 sizeof this->http_proxy_address - 1);
956 this->http_proxy_address[
957 sizeof this->http_proxy_address - 1] = '\0';
959 p = strchr(this->http_proxy_address, ':');
961 fprintf(stderr, "http_proxy needs to be ads:port\n");
965 this->http_proxy_port = atoi(p + 1);
967 fprintf(stderr, "Using proxy %s:%u\n",
968 this->http_proxy_address,
969 this->http_proxy_port);
974 #ifdef LWS_OPENSSL_SUPPORT
975 this->use_ssl = ssl_cert_filepath != NULL &&
976 ssl_private_key_filepath != NULL;
978 fprintf(stderr, " Compiled with SSL support, "
981 fprintf(stderr, " Compiled with SSL support, "
985 if (ssl_cert_filepath != NULL &&
986 ssl_private_key_filepath != NULL) {
987 fprintf(stderr, " Not compiled for OpenSSl support!\n");
990 fprintf(stderr, " Compiled without SSL support, "
991 "serving unencrypted\n");
997 signal(SIGPIPE, sigpipe_handler);
1000 #ifdef LWS_OPENSSL_SUPPORT
1002 /* basic openssl init */
1006 OpenSSL_add_all_algorithms();
1007 SSL_load_error_strings();
1010 * Firefox insists on SSLv23 not SSLv3
1011 * Konq disables SSLv2 by default now, SSLv23 works
1014 method = (SSL_METHOD *)SSLv23_server_method();
1016 fprintf(stderr, "problem creating ssl method: %s\n",
1017 ERR_error_string(ERR_get_error(), ssl_err_buf));
1020 this->ssl_ctx = SSL_CTX_new(method); /* create context */
1021 if (!this->ssl_ctx) {
1022 fprintf(stderr, "problem creating ssl context: %s\n",
1023 ERR_error_string(ERR_get_error(), ssl_err_buf));
1027 /* client context */
1029 method = (SSL_METHOD *)SSLv23_client_method();
1031 fprintf(stderr, "problem creating ssl method: %s\n",
1032 ERR_error_string(ERR_get_error(), ssl_err_buf));
1035 this->ssl_client_ctx = SSL_CTX_new(method); /* create context */
1036 if (!this->ssl_client_ctx) {
1037 fprintf(stderr, "problem creating ssl context: %s\n",
1038 ERR_error_string(ERR_get_error(), ssl_err_buf));
1043 /* openssl init for cert verification (used with client sockets) */
1045 if (!SSL_CTX_load_verify_locations(this->ssl_client_ctx, NULL,
1046 LWS_OPENSSL_CLIENT_CERTS)) {
1047 fprintf(stderr, "Unable to load SSL Client certs from %s "
1048 "(set by --with-client-cert-dir= in configure) -- "
1049 " client ssl isn't going to work",
1050 LWS_OPENSSL_CLIENT_CERTS);
1053 if (this->use_ssl) {
1055 /* openssl init for server sockets */
1057 /* set the local certificate from CertFile */
1058 n = SSL_CTX_use_certificate_file(this->ssl_ctx,
1059 ssl_cert_filepath, SSL_FILETYPE_PEM);
1061 fprintf(stderr, "problem getting cert '%s': %s\n",
1063 ERR_error_string(ERR_get_error(), ssl_err_buf));
1066 /* set the private key from KeyFile */
1067 if (SSL_CTX_use_PrivateKey_file(this->ssl_ctx,
1068 ssl_private_key_filepath,
1069 SSL_FILETYPE_PEM) != 1) {
1070 fprintf(stderr, "ssl problem getting key '%s': %s\n",
1071 ssl_private_key_filepath,
1072 ERR_error_string(ERR_get_error(), ssl_err_buf));
1075 /* verify private key */
1076 if (!SSL_CTX_check_private_key(this->ssl_ctx)) {
1077 fprintf(stderr, "Private SSL key doesn't match cert\n");
1081 /* SSL is happy and has a cert it's content with */
1087 if (lws_b64_selftest())
1090 /* fd hashtable init */
1092 for (n = 0; n < FD_HASHTABLE_MODULUS; n++)
1093 this->fd_hashtable[n].length = 0;
1095 /* set up our external listening socket we serve on */
1099 sockfd = socket(AF_INET, SOCK_STREAM, 0);
1101 fprintf(stderr, "ERROR opening socket");
1105 /* allow us to restart even if old sockets in TIME_WAIT */
1106 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
1108 bzero((char *) &serv_addr, sizeof(serv_addr));
1109 serv_addr.sin_family = AF_INET;
1110 serv_addr.sin_addr.s_addr = INADDR_ANY;
1111 serv_addr.sin_port = htons(port);
1113 n = bind(sockfd, (struct sockaddr *) &serv_addr,
1116 fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
1121 wsi = malloc(sizeof(struct libwebsocket));
1122 memset(wsi, 0, sizeof (struct libwebsocket));
1124 wsi->mode = LWS_CONNMODE_SERVER_LISTENER;
1125 insert_wsi(this, wsi);
1128 fprintf(stderr, " Listening on port %d\n", port);
1130 /* list in the internal poll array */
1132 this->fds[this->fds_count].fd = sockfd;
1133 this->fds[this->fds_count++].events = POLLIN;
1135 /* external POLL support via protocol 0 */
1136 this->protocols[0].callback(wsi,
1137 LWS_CALLBACK_ADD_POLL_FD,
1138 (void *)(long)sockfd, NULL, POLLIN);
1142 /* drop any root privs for this process */
1146 fprintf(stderr, "setgid: %s\n", strerror(errno));
1149 fprintf(stderr, "setuid: %s\n", strerror(errno));
1152 /* set up our internal broadcast trigger sockets per-protocol */
1154 for (this->count_protocols = 0;
1155 protocols[this->count_protocols].callback;
1156 this->count_protocols++) {
1157 protocols[this->count_protocols].owning_server = this;
1158 protocols[this->count_protocols].protocol_index =
1159 this->count_protocols;
1161 fd = socket(AF_INET, SOCK_STREAM, 0);
1163 fprintf(stderr, "ERROR opening socket");
1167 /* allow us to restart even if old sockets in TIME_WAIT */
1168 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
1170 bzero((char *) &serv_addr, sizeof(serv_addr));
1171 serv_addr.sin_family = AF_INET;
1172 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
1173 serv_addr.sin_port = 0; /* pick the port for us */
1175 n = bind(fd, (struct sockaddr *) &serv_addr, sizeof(serv_addr));
1177 fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
1182 slen = sizeof cli_addr;
1183 n = getsockname(fd, (struct sockaddr *)&cli_addr, &slen);
1185 fprintf(stderr, "getsockname failed\n");
1188 protocols[this->count_protocols].broadcast_socket_port =
1189 ntohs(cli_addr.sin_port);
1192 debug(" Protocol %s broadcast socket %d\n",
1193 protocols[this->count_protocols].name,
1194 ntohs(cli_addr.sin_port));
1196 /* dummy wsi per broadcast proxy socket */
1198 wsi = malloc(sizeof(struct libwebsocket));
1199 memset(wsi, 0, sizeof (struct libwebsocket));
1201 wsi->mode = LWS_CONNMODE_BROADCAST_PROXY_LISTENER;
1202 /* note which protocol we are proxying */
1203 wsi->protocol_index_for_broadcast_proxy = this->count_protocols;
1204 insert_wsi(this, wsi);
1206 /* list in internal poll array */
1208 this->fds[this->fds_count].fd = fd;
1209 this->fds[this->fds_count].events = POLLIN;
1210 this->fds[this->fds_count].revents = 0;
1213 /* external POLL support via protocol 0 */
1214 this->protocols[0].callback(wsi,
1215 LWS_CALLBACK_ADD_POLL_FD,
1216 (void *)(long)fd, NULL, POLLIN);
1226 * libwebsockets_fork_service_loop() - Optional helper function forks off
1227 * a process for the websocket server loop.
1228 * You don't have to use this but if not, you
1229 * have to make sure you are calling
1230 * libwebsocket_service periodically to service
1231 * the websocket traffic
1232 * @this: server context returned by creation function
1236 libwebsockets_fork_service_loop(struct libwebsocket_context *this)
1239 struct sockaddr_in cli_addr;
1249 /* main process context */
1252 * set up the proxy sockets to allow broadcast from
1253 * service process context
1256 for (p = 0; p < this->count_protocols; p++) {
1257 fd = socket(AF_INET, SOCK_STREAM, 0);
1259 fprintf(stderr, "Unable to create socket\n");
1262 cli_addr.sin_family = AF_INET;
1263 cli_addr.sin_port = htons(
1264 this->protocols[p].broadcast_socket_port);
1265 cli_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
1266 n = connect(fd, (struct sockaddr *)&cli_addr,
1269 fprintf(stderr, "Unable to connect to "
1270 "broadcast socket %d, %s\n",
1271 n, strerror(errno));
1275 this->protocols[p].broadcast_socket_user_fd = fd;
1281 /* we want a SIGHUP when our parent goes down */
1282 prctl(PR_SET_PDEATHSIG, SIGHUP);
1284 /* in this forked process, sit and service websocket connections */
1287 if (libwebsocket_service(this, 1000))
1296 * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
1298 * @wsi: pointer to struct websocket you want to know the protocol of
1301 * This is useful to get the protocol to broadcast back to from inside
1305 const struct libwebsocket_protocols *
1306 libwebsockets_get_protocol(struct libwebsocket *wsi)
1308 return wsi->protocol;
1312 * libwebsockets_broadcast() - Sends a buffer to the callback for all active
1313 * connections of the given protocol.
1314 * @protocol: pointer to the protocol you will broadcast to all members of
1315 * @buf: buffer containing the data to be broadcase. NOTE: this has to be
1316 * allocated with LWS_SEND_BUFFER_PRE_PADDING valid bytes before
1317 * the pointer and LWS_SEND_BUFFER_POST_PADDING afterwards in the
1318 * case you are calling this function from callback context.
1319 * @len: length of payload data in buf, starting from buf.
1321 * This function allows bulk sending of a packet to every connection using
1322 * the given protocol. It does not send the data directly; instead it calls
1323 * the callback with a reason type of LWS_CALLBACK_BROADCAST. If the callback
1324 * wants to actually send the data for that connection, the callback itself
1325 * should call libwebsocket_write().
1327 * libwebsockets_broadcast() can be called from another fork context without
1328 * having to take any care about data visibility between the processes, it'll
1334 libwebsockets_broadcast(const struct libwebsocket_protocols *protocol,
1335 unsigned char *buf, size_t len)
1337 struct libwebsocket_context *this = protocol->owning_server;
1340 struct libwebsocket * wsi;
1342 if (!protocol->broadcast_socket_user_fd) {
1344 * We are either running unforked / flat, or we are being
1345 * called from poll thread context
1346 * eg, from a callback. In that case don't use sockets for
1347 * broadcast IPC (since we can't open a socket connection to
1348 * a socket listening on our own thread) but directly do the
1351 * Locking is not needed because we are by definition being
1352 * called in the poll thread context and are serialized.
1355 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
1357 for (m = 0; m < this->fd_hashtable[n].length; m++) {
1359 wsi = this->fd_hashtable[n].wsi[m];
1361 if (wsi->mode != LWS_CONNMODE_WS_SERVING)
1365 * never broadcast to
1366 * non-established connections
1368 if (wsi->state != WSI_STATE_ESTABLISHED)
1371 /* only broadcast to guys using
1372 * requested protocol
1374 if (wsi->protocol != protocol)
1377 wsi->protocol->callback(wsi,
1378 LWS_CALLBACK_BROADCAST,
1388 * We're being called from a different process context than the server
1389 * loop. Instead of broadcasting directly, we send our
1390 * payload on a socket to do the IPC; the server process will serialize
1391 * the broadcast action in its main poll() loop.
1393 * There's one broadcast socket listening for each protocol supported
1394 * set up when the websocket server initializes
1397 n = send(protocol->broadcast_socket_user_fd, buf, len, MSG_NOSIGNAL);