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_context *this,
80 struct libwebsocket *wsi)
83 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 2 +
84 LWS_SEND_BUFFER_POST_PADDING];
91 if (n == WSI_STATE_DEAD_SOCKET)
94 /* remove this fd from wsi mapping hashtable */
96 delete_from_fd(this, wsi->sock);
98 /* delete it from the internal poll list if still present */
100 for (n = 0; n < this->fds_count; n++) {
101 if (this->fds[n].fd != wsi->sock)
103 while (n < this->fds_count - 1) {
104 this->fds[n] = this->fds[n + 1];
108 /* we only have to deal with one */
112 /* remove also from external POLL support via protocol 0 */
114 this->protocols[0].callback(wsi,
115 LWS_CALLBACK_DEL_POLL_FD, (void *)(long)wsi->sock, NULL, 0);
118 * signal we are closing, libsocket_write will
119 * add any necessary version-specific stuff. If the write fails,
120 * no worries we are closing anyway. If we didn't initiate this
121 * close, then our state has been changed to
122 * WSI_STATE_RETURNED_CLOSE_ALREADY and we will skip this
125 if (n == WSI_STATE_ESTABLISHED)
126 libwebsocket_write(wsi, &buf[LWS_SEND_BUFFER_PRE_PADDING], 0,
129 wsi->state = WSI_STATE_DEAD_SOCKET;
131 /* tell the user it's all over for this guy */
133 if (wsi->protocol->callback && n == WSI_STATE_ESTABLISHED)
134 wsi->protocol->callback(wsi, LWS_CALLBACK_CLOSED,
135 wsi->user_space, NULL, 0);
137 /* free up his allocations */
139 for (n = 0; n < WSI_TOKEN_COUNT; n++)
140 if (wsi->utf8_token[n].token)
141 free(wsi->utf8_token[n].token);
143 /* fprintf(stderr, "closing fd=%d\n", wsi->sock); */
145 #ifdef LWS_OPENSSL_SUPPORT
147 n = SSL_get_fd(wsi->ssl);
148 SSL_shutdown(wsi->ssl);
153 shutdown(wsi->sock, SHUT_RDWR);
155 #ifdef LWS_OPENSSL_SUPPORT
159 free(wsi->user_space);
165 * libwebsockets_hangup_on_client() - Server calls to terminate client
167 * @this: libwebsockets context
168 * @fd: Connection socket descriptor
172 libwebsockets_hangup_on_client(struct libwebsocket_context *this, int fd)
174 struct libwebsocket *wsi = wsi_from_fd(this, fd);
180 delete_from_fd(this, fd);
182 for (n = 0; n < this->fds_count - 1; n++)
183 if (this->fds[n].fd == fd) {
184 while (n < this->fds_count - 1) {
185 this->fds[n] = this->fds[n + 1];
192 libwebsocket_close_and_free_session(this, wsi);
197 * libwebsockets_get_peer_addresses() - Get client address information
198 * @fd: Connection socket descriptor
199 * @name: Buffer to take client address name
200 * @name_len: Length of client address name buffer
201 * @rip: Buffer to take client address IP qotted quad
202 * @rip_len: Length of client address IP buffer
204 * This function fills in @name and @rip with the name and IP of
205 * the client connected with socket descriptor @fd. Names may be
206 * truncated if there is not enough room. If either cannot be
207 * determined, they will be returned as valid zero-length strings.
211 libwebsockets_get_peer_addresses(int fd, char *name, int name_len,
212 char *rip, int rip_len)
215 struct sockaddr_in sin;
216 struct hostent *host;
217 struct hostent *host1;
226 if (getpeername(fd, (struct sockaddr *) &sin, &len) < 0) {
227 perror("getpeername");
231 host = gethostbyaddr((char *) &sin.sin_addr, sizeof sin.sin_addr,
234 perror("gethostbyaddr");
238 strncpy(name, host->h_name, name_len);
239 name[name_len - 1] = '\0';
241 host1 = gethostbyname(host->h_name);
247 p = host1->h_addr_list[n++];
250 if (host1->h_addrtype != AF_INET)
253 sprintf(ip, "%d.%d.%d.%d",
254 p[0], p[1], p[2], p[3]);
256 strncpy(rip, ip, rip_len);
257 rip[rip_len - 1] = '\0';
262 * libwebsocket_service_fd() - Service polled socket with something waiting
263 * @this: Websocket context
264 * @pollfd: The pollfd entry describing the socket fd and which events
267 * This function closes any active connections and then frees the
268 * context. After calling this, any further use of the context is
273 libwebsocket_service_fd(struct libwebsocket_context *this,
274 struct pollfd *pollfd)
276 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + MAX_BROADCAST_PAYLOAD +
277 LWS_SEND_BUFFER_POST_PADDING];
278 struct libwebsocket *wsi = wsi_from_fd(this, pollfd->fd);
279 struct libwebsocket *new_wsi;
285 struct sockaddr_in cli_addr;
291 case LWS_CONNMODE_SERVER_LISTENER:
293 /* pollin means a client has connected to us then */
295 if (!pollfd->revents & POLLIN)
298 /* listen socket got an unencrypted connection... */
300 clilen = sizeof(cli_addr);
301 accept_fd = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
304 fprintf(stderr, "ERROR on accept");
308 if (this->fds_count >= MAX_CLIENTS) {
309 fprintf(stderr, "too busy to accept new client\n");
315 * look at who we connected to and give user code a chance
316 * to reject based on client IP. There's no protocol selected
317 * yet so we issue this to protocols[0]
320 if ((this->protocols[0].callback)(wsi,
321 LWS_CALLBACK_FILTER_NETWORK_CONNECTION,
322 (void*)(long)accept_fd, NULL, 0)) {
323 fprintf(stderr, "Callback denied network connection\n");
328 /* accepting connection to main listener */
330 new_wsi = malloc(sizeof(struct libwebsocket));
331 if (new_wsi == NULL) {
332 fprintf(stderr, "Out of memory for new connection\n");
336 memset(new_wsi, 0, sizeof (struct libwebsocket));
337 new_wsi->sock = accept_fd;
339 #ifdef LWS_OPENSSL_SUPPORT
341 this->ssl_ctx = NULL;
345 new_wsi->ssl = SSL_new(this->ssl_ctx);
346 if (new_wsi->ssl == NULL) {
347 fprintf(stderr, "SSL_new failed: %s\n",
348 ERR_error_string(SSL_get_error(
349 new_wsi->ssl, 0), NULL));
354 SSL_set_fd(new_wsi->ssl, accept_fd);
356 n = SSL_accept(new_wsi->ssl);
359 * browsers seem to probe with various
360 * ssl params which fail then retry
363 debug("SSL_accept failed skt %u: %s\n",
365 ERR_error_string(SSL_get_error(
366 new_wsi->ssl, n), NULL));
372 debug("accepted new SSL conn "
373 "port %u on fd=%d SSL ver %s\n",
374 ntohs(cli_addr.sin_port), accept_fd,
375 SSL_get_version(new_wsi->ssl));
379 debug("accepted new conn port %u on fd=%d\n",
380 ntohs(cli_addr.sin_port), accept_fd);
382 /* intialize the instance struct */
384 new_wsi->state = WSI_STATE_HTTP;
385 new_wsi->name_buffer_pos = 0;
386 new_wsi->mode = LWS_CONNMODE_WS_SERVING;
388 for (n = 0; n < WSI_TOKEN_COUNT; n++) {
389 new_wsi->utf8_token[n].token = NULL;
390 new_wsi->utf8_token[n].token_len = 0;
394 * these can only be set once the protocol is known
395 * we set an unestablished connection's protocol pointer
396 * to the start of the supported list, so it can look
397 * for matching ones during the handshake
399 new_wsi->protocol = this->protocols;
400 new_wsi->user_space = NULL;
403 * Default protocol is 76 / 00
404 * After 76, there's a header specified to inform which
405 * draft the client wants, when that's seen we modify
406 * the individual connection's spec revision accordingly
408 new_wsi->ietf_spec_revision = 0;
410 insert_wsi(this, new_wsi);
413 * make sure NO events are seen yet on this new socket
414 * (otherwise we inherit old fds[client].revents from
415 * previous socket there and die mysteriously! )
417 this->fds[this->fds_count].revents = 0;
419 this->fds[this->fds_count].events = POLLIN;
420 this->fds[this->fds_count++].fd = accept_fd;
422 /* external POLL support via protocol 0 */
423 this->protocols[0].callback(new_wsi,
424 LWS_CALLBACK_ADD_POLL_FD,
425 (void *)(long)accept_fd, NULL, POLLIN);
429 case LWS_CONNMODE_BROADCAST_PROXY_LISTENER:
431 /* as we are listening, POLLIN means accept() is needed */
433 if (!pollfd->revents & POLLIN)
436 /* listen socket got an unencrypted connection... */
438 clilen = sizeof(cli_addr);
439 accept_fd = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
442 fprintf(stderr, "ERROR on accept");
446 if (this->fds_count >= MAX_CLIENTS) {
447 fprintf(stderr, "too busy to accept new broadcast "
453 /* create a dummy wsi for the connection and add it */
455 new_wsi = malloc(sizeof(struct libwebsocket));
456 memset(new_wsi, 0, sizeof (struct libwebsocket));
457 new_wsi->sock = accept_fd;
458 new_wsi->mode = LWS_CONNMODE_BROADCAST_PROXY;
459 new_wsi->state = WSI_STATE_ESTABLISHED;
460 /* note which protocol we are proxying */
461 new_wsi->protocol_index_for_broadcast_proxy =
462 wsi->protocol_index_for_broadcast_proxy;
463 insert_wsi(this, new_wsi);
465 /* add connected socket to internal poll array */
467 this->fds[this->fds_count].revents = 0;
468 this->fds[this->fds_count].events = POLLIN;
469 this->fds[this->fds_count++].fd = accept_fd;
471 /* external POLL support via protocol 0 */
472 this->protocols[0].callback(new_wsi,
473 LWS_CALLBACK_ADD_POLL_FD,
474 (void *)(long)accept_fd, NULL, POLLIN);
478 case LWS_CONNMODE_BROADCAST_PROXY:
480 /* handle session socket closed */
482 if (pollfd->revents & (POLLERR | POLLHUP)) {
484 debug("Session Socket %p (fd=%d) dead\n",
485 (void *)wsi, accept_fd);
487 libwebsocket_close_and_free_session(this, wsi);
491 /* the guy requested a callback when it was OK to write */
493 if (pollfd->revents & POLLOUT) {
497 pollfd->events &= ~POLLOUT;
499 /* external POLL support via protocol 0 */
500 this->protocols[0].callback(wsi,
501 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
502 (void *)(long)wsi->sock, NULL, POLLOUT);
504 wsi->protocol->callback(wsi,
505 LWS_CALLBACK_CLIENT_WRITEABLE,
510 /* any incoming data ready? */
512 if (!(pollfd->revents & POLLIN))
515 /* get the issued broadcast payload from the socket */
517 len = read(pollfd->fd, buf + LWS_SEND_BUFFER_PRE_PADDING,
518 MAX_BROADCAST_PAYLOAD);
520 fprintf(stderr, "Error reading broadcast payload\n");
524 /* broadcast it to all guys with this protocol index */
526 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
528 for (m = 0; m < this->fd_hashtable[n].length; m++) {
530 new_wsi = this->fd_hashtable[n].wsi[m];
532 /* only to clients we are serving to */
534 if (new_wsi->mode != LWS_CONNMODE_WS_SERVING)
538 * never broadcast to non-established
542 if (new_wsi->state != WSI_STATE_ESTABLISHED)
546 * only broadcast to connections using
547 * the requested protocol
550 if (new_wsi->protocol->protocol_index !=
551 wsi->protocol_index_for_broadcast_proxy)
554 /* broadcast it to this connection */
556 new_wsi->protocol->callback(new_wsi,
557 LWS_CALLBACK_BROADCAST,
559 buf + LWS_SEND_BUFFER_PRE_PADDING, len);
564 case LWS_CONNMODE_WS_SERVING:
565 case LWS_CONNMODE_WS_CLIENT:
567 /* handle session socket closed */
569 if (pollfd->revents & (POLLERR | POLLHUP)) {
571 debug("Session Socket %p (fd=%d) dead\n",
572 (void *)wsi, pollfd->fd);
574 libwebsocket_close_and_free_session(this, wsi);
578 /* the guy requested a callback when it was OK to write */
580 if (pollfd->revents & POLLOUT) {
582 pollfd->events &= ~POLLOUT;
584 /* external POLL support via protocol 0 */
585 this->protocols[0].callback(wsi,
586 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
587 (void *)(long)wsi->sock, NULL, POLLOUT);
589 wsi->protocol->callback(wsi,
590 LWS_CALLBACK_CLIENT_WRITEABLE,
595 /* any incoming data ready? */
597 if (!(pollfd->revents & POLLIN))
600 #ifdef LWS_OPENSSL_SUPPORT
602 n = SSL_read(wsi->ssl, buf, sizeof buf);
605 n = recv(pollfd->fd, buf, sizeof buf, 0);
608 fprintf(stderr, "Socket read returned %d\n", n);
612 libwebsocket_close_and_free_session(this, wsi);
616 /* service incoming data */
618 n = libwebsocket_read(this, wsi, buf, n);
632 * libwebsocket_context_destroy() - Destroy the websocket context
633 * @this: Websocket context
635 * This function closes any active connections and then frees the
636 * context. After calling this, any further use of the context is
640 libwebsocket_context_destroy(struct libwebsocket_context *this)
644 struct libwebsocket *wsi;
646 for (n = 0; n < FD_HASHTABLE_MODULUS; n++)
647 for (m = 0; m < this->fd_hashtable[n].length; m++) {
648 wsi = this->fd_hashtable[n].wsi[m];
649 libwebsocket_close_and_free_session(this, wsi);
652 close(this->fd_random);
654 #ifdef LWS_OPENSSL_SUPPORT
656 SSL_CTX_free(this->ssl_ctx);
657 if (this->ssl_client_ctx)
658 SSL_CTX_free(this->ssl_client_ctx);
665 * libwebsocket_service() - Service any pending websocket activity
666 * @this: Websocket context
667 * @timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
668 * service otherwise block and service immediately, returning
669 * after the timeout if nothing needed service.
671 * This function deals with any pending websocket traffic, for three
672 * kinds of event. It handles these events on both server and client
673 * types of connection the same.
675 * 1) Accept new connections to our context's server
677 * 2) Perform pending broadcast writes initiated from other forked
678 * processes (effectively serializing asynchronous broadcasts)
680 * 3) Call the receive callback for incoming frame data received by
681 * server or client connections.
683 * You need to call this service function periodically to all the above
684 * functions to happen; if your application is single-threaded you can
685 * just call it in your main event loop.
687 * Alternatively you can fork a new process that asynchronously handles
688 * calling this service in a loop. In that case you are happy if this
689 * call blocks your thread until it needs to take care of something and
690 * would call it with a large nonzero timeout. Your loop then takes no
691 * CPU while there is nothing happening.
693 * If you are calling it in a single-threaded app, you don't want it to
694 * wait around blocking other things in your loop from happening, so you
695 * would call it with a timeout_ms of 0, so it returns immediately if
696 * nothing is pending, or as soon as it services whatever was pending.
701 libwebsocket_service(struct libwebsocket_context *this, int timeout_ms)
705 /* stay dead once we are dead */
710 /* wait for something to need service */
712 n = poll(this->fds, this->fds_count, timeout_ms);
713 if (n == 0) /* poll timeout */
716 if (n < 0 || this->fds[0].revents & (POLLERR | POLLHUP)) {
718 fprintf(stderr, "Listen Socket dead\n");
723 /* handle accept on listening socket? */
725 for (n = 0; n < this->fds_count; n++)
726 if (this->fds[n].revents)
727 libwebsocket_service_fd(this, &this->fds[n]);
733 * libwebsocket_callback_on_writable() - Request a callback when this socket
734 * becomes able to be written to without
737 * @wsi: Websocket connection instance to get callback for
741 libwebsocket_callback_on_writable(struct libwebsocket *wsi)
743 struct libwebsocket_context *this = wsi->protocol->owning_server;
746 for (n = 0; n < this->fds_count; n++)
747 if (this->fds[n].fd == wsi->sock) {
748 this->fds[n].events |= POLLOUT;
752 /* external POLL support via protocol 0 */
753 this->protocols[0].callback(wsi,
754 LWS_CALLBACK_SET_MODE_POLL_FD,
755 (void *)(long)wsi->sock, NULL, POLLOUT);
761 * libwebsocket_callback_on_writable_all_protocol() - Request a callback for
762 * all connections using the given protocol when it
763 * becomes possible to write to each socket without
766 * @protocol: Protocol whose connections will get callbacks
770 libwebsocket_callback_on_writable_all_protocol(
771 const struct libwebsocket_protocols *protocol)
773 struct libwebsocket_context *this = protocol->owning_server;
776 struct libwebsocket *wsi;
778 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
780 for (m = 0; m < this->fd_hashtable[n].length; m++) {
782 wsi = this->fd_hashtable[n].wsi[m];
784 if (wsi->protocol == protocol)
785 libwebsocket_callback_on_writable(wsi);
794 * libwebsocket_get_socket_fd() - returns the socket file descriptor
796 * You will not need this unless you are doing something special
798 * @wsi: Websocket connection instance
802 libwebsocket_get_socket_fd(struct libwebsocket *wsi)
808 * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
811 * If the output side of a server process becomes choked, this allows flow
812 * control for the input side.
814 * @wsi: Websocket connection instance to get callback for
815 * @enable: 0 = disable read servicing for this connection, 1 = enable
819 libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
821 struct libwebsocket_context *this = wsi->protocol->owning_server;
824 for (n = 0; n < this->fds_count; n++)
825 if (this->fds[n].fd == wsi->sock) {
827 this->fds[n].events |= POLLIN;
829 this->fds[n].events &= ~POLLIN;
835 /* external POLL support via protocol 0 */
836 this->protocols[0].callback(wsi,
837 LWS_CALLBACK_SET_MODE_POLL_FD,
838 (void *)(long)wsi->sock, NULL, POLLIN);
840 /* external POLL support via protocol 0 */
841 this->protocols[0].callback(wsi,
842 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
843 (void *)(long)wsi->sock, NULL, POLLIN);
846 fprintf(stderr, "libwebsocket_callback_on_writable "
847 "unable to find socket\n");
852 * libwebsocket_canonical_hostname() - returns this host's hostname
854 * This is typically used by client code to fill in the host parameter
855 * when making a client connection. You can only call it after the context
858 * @this: Websocket context
863 libwebsocket_canonical_hostname(struct libwebsocket_context *this)
865 return (const char *)this->canonical_hostname;
869 static void sigpipe_handler(int x)
876 * libwebsocket_create_context() - Create the websocket handler
877 * @port: Port to listen on... you can use 0 to suppress listening on
878 * any port, that's what you want if you are not running a
879 * websocket server at all but just using it as a client
880 * @protocols: Array of structures listing supported protocols and a protocol-
881 * specific callback for each one. The list is ended with an
882 * entry that has a NULL callback pointer.
883 * It's not const because we write the owning_server member
884 * @ssl_cert_filepath: If libwebsockets was compiled to use ssl, and you want
885 * to listen using SSL, set to the filepath to fetch the
886 * server cert from, otherwise NULL for unencrypted
887 * @ssl_private_key_filepath: filepath to private key if wanting SSL mode,
889 * @gid: group id to change to after setting listen socket, or -1.
890 * @uid: user id to change to after setting listen socket, or -1.
891 * @options: 0, or LWS_SERVER_OPTION_DEFEAT_CLIENT_MASK
893 * This function creates the listening socket and takes care
894 * of all initialization in one step.
896 * After initialization, it returns a struct libwebsocket_context * that
897 * represents this server. After calling, user code needs to take care
898 * of calling libwebsocket_service() with the context pointer to get the
899 * server's sockets serviced. This can be done in the same process context
900 * or a forked process, or another thread,
902 * The protocol callback functions are called for a handful of events
903 * including http requests coming in, websocket connections becoming
904 * established, and data arriving; it's also called periodically to allow
905 * async transmission.
907 * HTTP requests are sent always to the FIRST protocol in @protocol, since
908 * at that time websocket protocol has not been negotiated. Other
909 * protocols after the first one never see any HTTP callack activity.
911 * The server created is a simple http server by default; part of the
912 * websocket standard is upgrading this http connection to a websocket one.
914 * This allows the same server to provide files like scripts and favicon /
915 * images or whatever over http and dynamic data over websockets all in
916 * one place; they're all handled in the user callback.
919 struct libwebsocket_context *
920 libwebsocket_create_context(int port,
921 struct libwebsocket_protocols *protocols,
922 const char *ssl_cert_filepath,
923 const char *ssl_private_key_filepath,
924 int gid, int uid, unsigned int options)
929 struct sockaddr_in serv_addr, cli_addr;
931 struct libwebsocket_context *this = NULL;
936 struct libwebsocket *wsi;
938 #ifdef LWS_OPENSSL_SUPPORT
940 char ssl_err_buf[512];
943 this = malloc(sizeof(struct libwebsocket_context));
945 fprintf(stderr, "No memory for websocket context\n");
948 this->protocols = protocols;
949 this->listen_port = port;
950 this->http_proxy_port = 0;
951 this->http_proxy_address[0] = '\0';
952 this->options = options;
955 this->fd_random = open(SYSTEM_RANDOM_FILEPATH, O_RDONLY);
956 if (this->fd_random < 0) {
957 fprintf(stderr, "Unable to open random device %s %d\n",
958 SYSTEM_RANDOM_FILEPATH, this->fd_random);
962 /* find canonical hostname */
964 hostname[(sizeof hostname) - 1] = '\0';
965 gethostname(hostname, (sizeof hostname) - 1);
966 he = gethostbyname(hostname);
967 strncpy(this->canonical_hostname, he->h_name,
968 sizeof this->canonical_hostname - 1);
969 this->canonical_hostname[sizeof this->canonical_hostname - 1] = '\0';
971 /* split the proxy ads:port if given */
973 p = getenv("http_proxy");
975 strncpy(this->http_proxy_address, p,
976 sizeof this->http_proxy_address - 1);
977 this->http_proxy_address[
978 sizeof this->http_proxy_address - 1] = '\0';
980 p = strchr(this->http_proxy_address, ':');
982 fprintf(stderr, "http_proxy needs to be ads:port\n");
986 this->http_proxy_port = atoi(p + 1);
988 fprintf(stderr, "Using proxy %s:%u\n",
989 this->http_proxy_address,
990 this->http_proxy_port);
995 #ifdef LWS_OPENSSL_SUPPORT
996 this->use_ssl = ssl_cert_filepath != NULL &&
997 ssl_private_key_filepath != NULL;
999 fprintf(stderr, " Compiled with SSL support, "
1002 fprintf(stderr, " Compiled with SSL support, "
1006 if (ssl_cert_filepath != NULL &&
1007 ssl_private_key_filepath != NULL) {
1008 fprintf(stderr, " Not compiled for OpenSSl support!\n");
1011 fprintf(stderr, " Compiled without SSL support, "
1012 "serving unencrypted\n");
1016 /* ignore SIGPIPE */
1018 signal(SIGPIPE, sigpipe_handler);
1021 #ifdef LWS_OPENSSL_SUPPORT
1023 /* basic openssl init */
1027 OpenSSL_add_all_algorithms();
1028 SSL_load_error_strings();
1031 * Firefox insists on SSLv23 not SSLv3
1032 * Konq disables SSLv2 by default now, SSLv23 works
1035 method = (SSL_METHOD *)SSLv23_server_method();
1037 fprintf(stderr, "problem creating ssl method: %s\n",
1038 ERR_error_string(ERR_get_error(), ssl_err_buf));
1041 this->ssl_ctx = SSL_CTX_new(method); /* create context */
1042 if (!this->ssl_ctx) {
1043 fprintf(stderr, "problem creating ssl context: %s\n",
1044 ERR_error_string(ERR_get_error(), ssl_err_buf));
1048 /* client context */
1050 method = (SSL_METHOD *)SSLv23_client_method();
1052 fprintf(stderr, "problem creating ssl method: %s\n",
1053 ERR_error_string(ERR_get_error(), ssl_err_buf));
1056 this->ssl_client_ctx = SSL_CTX_new(method); /* create context */
1057 if (!this->ssl_client_ctx) {
1058 fprintf(stderr, "problem creating ssl context: %s\n",
1059 ERR_error_string(ERR_get_error(), ssl_err_buf));
1064 /* openssl init for cert verification (used with client sockets) */
1066 if (!SSL_CTX_load_verify_locations(this->ssl_client_ctx, NULL,
1067 LWS_OPENSSL_CLIENT_CERTS)) {
1068 fprintf(stderr, "Unable to load SSL Client certs from %s "
1069 "(set by --with-client-cert-dir= in configure) -- "
1070 " client ssl isn't going to work",
1071 LWS_OPENSSL_CLIENT_CERTS);
1074 if (this->use_ssl) {
1076 /* openssl init for server sockets */
1078 /* set the local certificate from CertFile */
1079 n = SSL_CTX_use_certificate_file(this->ssl_ctx,
1080 ssl_cert_filepath, SSL_FILETYPE_PEM);
1082 fprintf(stderr, "problem getting cert '%s': %s\n",
1084 ERR_error_string(ERR_get_error(), ssl_err_buf));
1087 /* set the private key from KeyFile */
1088 if (SSL_CTX_use_PrivateKey_file(this->ssl_ctx,
1089 ssl_private_key_filepath,
1090 SSL_FILETYPE_PEM) != 1) {
1091 fprintf(stderr, "ssl problem getting key '%s': %s\n",
1092 ssl_private_key_filepath,
1093 ERR_error_string(ERR_get_error(), ssl_err_buf));
1096 /* verify private key */
1097 if (!SSL_CTX_check_private_key(this->ssl_ctx)) {
1098 fprintf(stderr, "Private SSL key doesn't match cert\n");
1102 /* SSL is happy and has a cert it's content with */
1108 if (lws_b64_selftest())
1111 /* fd hashtable init */
1113 for (n = 0; n < FD_HASHTABLE_MODULUS; n++)
1114 this->fd_hashtable[n].length = 0;
1116 /* set up our external listening socket we serve on */
1120 sockfd = socket(AF_INET, SOCK_STREAM, 0);
1122 fprintf(stderr, "ERROR opening socket");
1126 /* allow us to restart even if old sockets in TIME_WAIT */
1127 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
1129 bzero((char *) &serv_addr, sizeof(serv_addr));
1130 serv_addr.sin_family = AF_INET;
1131 serv_addr.sin_addr.s_addr = INADDR_ANY;
1132 serv_addr.sin_port = htons(port);
1134 n = bind(sockfd, (struct sockaddr *) &serv_addr,
1137 fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
1142 wsi = malloc(sizeof(struct libwebsocket));
1143 memset(wsi, 0, sizeof (struct libwebsocket));
1145 wsi->mode = LWS_CONNMODE_SERVER_LISTENER;
1146 insert_wsi(this, wsi);
1149 fprintf(stderr, " Listening on port %d\n", port);
1151 /* list in the internal poll array */
1153 this->fds[this->fds_count].fd = sockfd;
1154 this->fds[this->fds_count++].events = POLLIN;
1156 /* external POLL support via protocol 0 */
1157 this->protocols[0].callback(wsi,
1158 LWS_CALLBACK_ADD_POLL_FD,
1159 (void *)(long)sockfd, NULL, POLLIN);
1163 /* drop any root privs for this process */
1167 fprintf(stderr, "setgid: %s\n", strerror(errno));
1170 fprintf(stderr, "setuid: %s\n", strerror(errno));
1173 /* set up our internal broadcast trigger sockets per-protocol */
1175 for (this->count_protocols = 0;
1176 protocols[this->count_protocols].callback;
1177 this->count_protocols++) {
1178 protocols[this->count_protocols].owning_server = this;
1179 protocols[this->count_protocols].protocol_index =
1180 this->count_protocols;
1182 fd = socket(AF_INET, SOCK_STREAM, 0);
1184 fprintf(stderr, "ERROR opening socket");
1188 /* allow us to restart even if old sockets in TIME_WAIT */
1189 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
1191 bzero((char *) &serv_addr, sizeof(serv_addr));
1192 serv_addr.sin_family = AF_INET;
1193 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
1194 serv_addr.sin_port = 0; /* pick the port for us */
1196 n = bind(fd, (struct sockaddr *) &serv_addr, sizeof(serv_addr));
1198 fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
1203 slen = sizeof cli_addr;
1204 n = getsockname(fd, (struct sockaddr *)&cli_addr, &slen);
1206 fprintf(stderr, "getsockname failed\n");
1209 protocols[this->count_protocols].broadcast_socket_port =
1210 ntohs(cli_addr.sin_port);
1213 debug(" Protocol %s broadcast socket %d\n",
1214 protocols[this->count_protocols].name,
1215 ntohs(cli_addr.sin_port));
1217 /* dummy wsi per broadcast proxy socket */
1219 wsi = malloc(sizeof(struct libwebsocket));
1220 memset(wsi, 0, sizeof (struct libwebsocket));
1222 wsi->mode = LWS_CONNMODE_BROADCAST_PROXY_LISTENER;
1223 /* note which protocol we are proxying */
1224 wsi->protocol_index_for_broadcast_proxy = this->count_protocols;
1225 insert_wsi(this, wsi);
1227 /* list in internal poll array */
1229 this->fds[this->fds_count].fd = fd;
1230 this->fds[this->fds_count].events = POLLIN;
1231 this->fds[this->fds_count].revents = 0;
1234 /* external POLL support via protocol 0 */
1235 this->protocols[0].callback(wsi,
1236 LWS_CALLBACK_ADD_POLL_FD,
1237 (void *)(long)fd, NULL, POLLIN);
1247 * libwebsockets_fork_service_loop() - Optional helper function forks off
1248 * a process for the websocket server loop.
1249 * You don't have to use this but if not, you
1250 * have to make sure you are calling
1251 * libwebsocket_service periodically to service
1252 * the websocket traffic
1253 * @this: server context returned by creation function
1257 libwebsockets_fork_service_loop(struct libwebsocket_context *this)
1260 struct sockaddr_in cli_addr;
1270 /* main process context */
1273 * set up the proxy sockets to allow broadcast from
1274 * service process context
1277 for (p = 0; p < this->count_protocols; p++) {
1278 fd = socket(AF_INET, SOCK_STREAM, 0);
1280 fprintf(stderr, "Unable to create socket\n");
1283 cli_addr.sin_family = AF_INET;
1284 cli_addr.sin_port = htons(
1285 this->protocols[p].broadcast_socket_port);
1286 cli_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
1287 n = connect(fd, (struct sockaddr *)&cli_addr,
1290 fprintf(stderr, "Unable to connect to "
1291 "broadcast socket %d, %s\n",
1292 n, strerror(errno));
1296 this->protocols[p].broadcast_socket_user_fd = fd;
1302 /* we want a SIGHUP when our parent goes down */
1303 prctl(PR_SET_PDEATHSIG, SIGHUP);
1305 /* in this forked process, sit and service websocket connections */
1308 if (libwebsocket_service(this, 1000))
1317 * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
1319 * @wsi: pointer to struct websocket you want to know the protocol of
1322 * This is useful to get the protocol to broadcast back to from inside
1326 const struct libwebsocket_protocols *
1327 libwebsockets_get_protocol(struct libwebsocket *wsi)
1329 return wsi->protocol;
1333 * libwebsockets_broadcast() - Sends a buffer to the callback for all active
1334 * connections of the given protocol.
1335 * @protocol: pointer to the protocol you will broadcast to all members of
1336 * @buf: buffer containing the data to be broadcase. NOTE: this has to be
1337 * allocated with LWS_SEND_BUFFER_PRE_PADDING valid bytes before
1338 * the pointer and LWS_SEND_BUFFER_POST_PADDING afterwards in the
1339 * case you are calling this function from callback context.
1340 * @len: length of payload data in buf, starting from buf.
1342 * This function allows bulk sending of a packet to every connection using
1343 * the given protocol. It does not send the data directly; instead it calls
1344 * the callback with a reason type of LWS_CALLBACK_BROADCAST. If the callback
1345 * wants to actually send the data for that connection, the callback itself
1346 * should call libwebsocket_write().
1348 * libwebsockets_broadcast() can be called from another fork context without
1349 * having to take any care about data visibility between the processes, it'll
1355 libwebsockets_broadcast(const struct libwebsocket_protocols *protocol,
1356 unsigned char *buf, size_t len)
1358 struct libwebsocket_context *this = protocol->owning_server;
1361 struct libwebsocket * wsi;
1363 if (!protocol->broadcast_socket_user_fd) {
1365 * We are either running unforked / flat, or we are being
1366 * called from poll thread context
1367 * eg, from a callback. In that case don't use sockets for
1368 * broadcast IPC (since we can't open a socket connection to
1369 * a socket listening on our own thread) but directly do the
1372 * Locking is not needed because we are by definition being
1373 * called in the poll thread context and are serialized.
1376 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
1378 for (m = 0; m < this->fd_hashtable[n].length; m++) {
1380 wsi = this->fd_hashtable[n].wsi[m];
1382 if (wsi->mode != LWS_CONNMODE_WS_SERVING)
1386 * never broadcast to
1387 * non-established connections
1389 if (wsi->state != WSI_STATE_ESTABLISHED)
1392 /* only broadcast to guys using
1393 * requested protocol
1395 if (wsi->protocol != protocol)
1398 wsi->protocol->callback(wsi,
1399 LWS_CALLBACK_BROADCAST,
1409 * We're being called from a different process context than the server
1410 * loop. Instead of broadcasting directly, we send our
1411 * payload on a socket to do the IPC; the server process will serialize
1412 * the broadcast action in its main poll() loop.
1414 * There's one broadcast socket listening for each protocol supported
1415 * set up when the websocket server initializes
1418 n = send(protocol->broadcast_socket_user_fd, buf, len, MSG_NOSIGNAL);