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_hangup_on_client() - Server calls to terminate client
139 * @this: libwebsockets context
140 * @fd: Connection socket descriptor
144 libwebsockets_hangup_on_client(struct libwebsocket_context *this, int fd)
146 struct libwebsocket *wsi = wsi_from_fd(this, fd);
151 libwebsocket_close_and_free_session(wsi);
156 * libwebsockets_get_peer_addresses() - Get client address information
157 * @fd: Connection socket descriptor
158 * @name: Buffer to take client address name
159 * @name_len: Length of client address name buffer
160 * @rip: Buffer to take client address IP qotted quad
161 * @rip_len: Length of client address IP buffer
163 * This function fills in @name and @rip with the name and IP of
164 * the client connected with socket descriptor @fd. Names may be
165 * truncated if there is not enough room. If either cannot be
166 * determined, they will be returned as valid zero-length strings.
170 libwebsockets_get_peer_addresses(int fd, char *name, int name_len,
171 char *rip, int rip_len)
174 struct sockaddr_in sin;
175 struct hostent *host;
176 struct hostent *host1;
185 if (getpeername(fd, (struct sockaddr *) &sin, &len) < 0) {
186 perror("getpeername");
190 host = gethostbyaddr((char *) &sin.sin_addr, sizeof sin.sin_addr,
193 perror("gethostbyaddr");
197 strncpy(name, host->h_name, name_len);
198 name[name_len - 1] = '\0';
200 host1 = gethostbyname(host->h_name);
206 p = host1->h_addr_list[n++];
209 if (host1->h_addrtype != AF_INET)
212 sprintf(ip, "%d.%d.%d.%d",
213 p[0], p[1], p[2], p[3]);
215 strncpy(rip, ip, rip_len);
216 rip[rip_len - 1] = '\0';
221 * libwebsocket_service_fd() - Service polled socket with something waiting
222 * @this: Websocket context
223 * @pollfd: The pollfd entry describing the socket fd and which events
226 * This function closes any active connections and then frees the
227 * context. After calling this, any further use of the context is
232 libwebsocket_service_fd(struct libwebsocket_context *this,
233 struct pollfd *pollfd)
235 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + MAX_BROADCAST_PAYLOAD +
236 LWS_SEND_BUFFER_POST_PADDING];
237 struct libwebsocket *wsi = wsi_from_fd(this, pollfd->fd);
238 struct libwebsocket *new_wsi;
244 struct sockaddr_in cli_addr;
250 case LWS_CONNMODE_SERVER_LISTENER:
252 /* pollin means a client has connected to us then */
254 if (!pollfd->revents & POLLIN)
257 /* listen socket got an unencrypted connection... */
259 clilen = sizeof(cli_addr);
260 accept_fd = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
263 fprintf(stderr, "ERROR on accept");
267 if (this->fds_count >= MAX_CLIENTS) {
268 fprintf(stderr, "too busy to accept new client\n");
274 * look at who we connected to and give user code a chance
275 * to reject based on client IP. There's no protocol selected
276 * yet so we issue this to protocols[0]
279 if ((this->protocols[0].callback)(wsi,
280 LWS_CALLBACK_FILTER_NETWORK_CONNECTION,
281 (void*)(long)accept_fd, NULL, 0)) {
282 fprintf(stderr, "Callback denied network connection\n");
287 /* accepting connection to main listener */
289 new_wsi = malloc(sizeof(struct libwebsocket));
290 if (new_wsi == NULL) {
291 fprintf(stderr, "Out of memory for new connection\n");
295 memset(new_wsi, 0, sizeof (struct libwebsocket));
296 new_wsi->sock = accept_fd;
298 #ifdef LWS_OPENSSL_SUPPORT
300 this->ssl_ctx = NULL;
304 new_wsi->ssl = SSL_new(this->ssl_ctx);
305 if (new_wsi->ssl == NULL) {
306 fprintf(stderr, "SSL_new failed: %s\n",
307 ERR_error_string(SSL_get_error(
308 new_wsi->ssl, 0), NULL));
313 SSL_set_fd(new_wsi->ssl, accept_fd);
315 n = SSL_accept(new_wsi->ssl);
318 * browsers seem to probe with various
319 * ssl params which fail then retry
322 debug("SSL_accept failed skt %u: %s\n",
324 ERR_error_string(SSL_get_error(
325 new_wsi->ssl, n), NULL));
331 debug("accepted new SSL conn "
332 "port %u on fd=%d SSL ver %s\n",
333 ntohs(cli_addr.sin_port), accept_fd,
334 SSL_get_version(new_wsi->ssl));
338 debug("accepted new conn port %u on fd=%d\n",
339 ntohs(cli_addr.sin_port), accept_fd);
341 /* intialize the instance struct */
343 new_wsi->state = WSI_STATE_HTTP;
344 new_wsi->name_buffer_pos = 0;
345 new_wsi->mode = LWS_CONNMODE_WS_SERVING;
347 for (n = 0; n < WSI_TOKEN_COUNT; n++) {
348 new_wsi->utf8_token[n].token = NULL;
349 new_wsi->utf8_token[n].token_len = 0;
353 * these can only be set once the protocol is known
354 * we set an unestablished connection's protocol pointer
355 * to the start of the supported list, so it can look
356 * for matching ones during the handshake
358 new_wsi->protocol = this->protocols;
359 new_wsi->user_space = NULL;
362 * Default protocol is 76 / 00
363 * After 76, there's a header specified to inform which
364 * draft the client wants, when that's seen we modify
365 * the individual connection's spec revision accordingly
367 new_wsi->ietf_spec_revision = 0;
369 insert_wsi(this, new_wsi);
372 * make sure NO events are seen yet on this new socket
373 * (otherwise we inherit old fds[client].revents from
374 * previous socket there and die mysteriously! )
376 this->fds[this->fds_count].revents = 0;
378 this->fds[this->fds_count].events = POLLIN;
379 this->fds[this->fds_count++].fd = accept_fd;
381 /* external POLL support via protocol 0 */
382 this->protocols[0].callback(new_wsi,
383 LWS_CALLBACK_ADD_POLL_FD,
384 (void *)(long)accept_fd, NULL, POLLIN);
388 case LWS_CONNMODE_BROADCAST_PROXY_LISTENER:
390 /* as we are listening, POLLIN means accept() is needed */
392 if (!pollfd->revents & POLLIN)
395 /* listen socket got an unencrypted connection... */
397 clilen = sizeof(cli_addr);
398 accept_fd = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
401 fprintf(stderr, "ERROR on accept");
405 if (this->fds_count >= MAX_CLIENTS) {
406 fprintf(stderr, "too busy to accept new broadcast "
412 /* create a dummy wsi for the connection and add it */
414 new_wsi = malloc(sizeof(struct libwebsocket));
415 memset(new_wsi, 0, sizeof (struct libwebsocket));
416 new_wsi->sock = accept_fd;
417 new_wsi->mode = LWS_CONNMODE_BROADCAST_PROXY;
418 new_wsi->state = WSI_STATE_ESTABLISHED;
419 /* note which protocol we are proxying */
420 new_wsi->protocol_index_for_broadcast_proxy =
421 wsi->protocol_index_for_broadcast_proxy;
422 insert_wsi(this, new_wsi);
424 /* add connected socket to internal poll array */
426 this->fds[this->fds_count].revents = 0;
427 this->fds[this->fds_count].events = POLLIN;
428 this->fds[this->fds_count++].fd = accept_fd;
430 /* external POLL support via protocol 0 */
431 this->protocols[0].callback(new_wsi,
432 LWS_CALLBACK_ADD_POLL_FD,
433 (void *)(long)accept_fd, NULL, POLLIN);
437 case LWS_CONNMODE_BROADCAST_PROXY:
439 /* handle session socket closed */
441 if (pollfd->revents & (POLLERR | POLLHUP)) {
443 debug("Session Socket %p (fd=%d) dead\n",
444 (void *)wsi, accept_fd);
446 libwebsocket_close_and_free_session(wsi);
450 /* the guy requested a callback when it was OK to write */
452 if (pollfd->revents & POLLOUT) {
456 pollfd->events &= ~POLLOUT;
458 /* external POLL support via protocol 0 */
459 this->protocols[0].callback(wsi,
460 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
461 (void *)(long)wsi->sock, NULL, POLLOUT);
463 wsi->protocol->callback(wsi,
464 LWS_CALLBACK_CLIENT_WRITEABLE,
469 /* any incoming data ready? */
471 if (!(pollfd->revents & POLLIN))
474 /* get the issued broadcast payload from the socket */
476 len = read(pollfd->fd, buf + LWS_SEND_BUFFER_PRE_PADDING,
477 MAX_BROADCAST_PAYLOAD);
479 fprintf(stderr, "Error reading broadcast payload\n");
483 /* broadcast it to all guys with this protocol index */
485 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
487 for (m = 0; m < this->fd_hashtable[n].length; m++) {
489 new_wsi = this->fd_hashtable[n].wsi[m];
491 /* only to clients we are serving to */
493 if (new_wsi->mode != LWS_CONNMODE_WS_SERVING)
497 * never broadcast to non-established
501 if (new_wsi->state != WSI_STATE_ESTABLISHED)
505 * only broadcast to connections using
506 * the requested protocol
509 if (new_wsi->protocol->protocol_index !=
510 wsi->protocol_index_for_broadcast_proxy)
513 /* broadcast it to this connection */
515 new_wsi->protocol->callback(new_wsi,
516 LWS_CALLBACK_BROADCAST,
518 buf + LWS_SEND_BUFFER_PRE_PADDING, len);
523 case LWS_CONNMODE_WS_SERVING:
524 case LWS_CONNMODE_WS_CLIENT:
526 /* handle session socket closed */
528 if (pollfd->revents & (POLLERR | POLLHUP)) {
530 debug("Session Socket %p (fd=%d) dead\n",
531 (void *)wsi, pollfd->fd);
533 libwebsocket_close_and_free_session(wsi);
537 /* the guy requested a callback when it was OK to write */
539 if (pollfd->revents & POLLOUT) {
541 pollfd->events &= ~POLLOUT;
543 /* external POLL support via protocol 0 */
544 this->protocols[0].callback(wsi,
545 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
546 (void *)(long)wsi->sock, NULL, POLLOUT);
548 wsi->protocol->callback(wsi,
549 LWS_CALLBACK_CLIENT_WRITEABLE,
554 /* any incoming data ready? */
556 if (!(pollfd->revents & POLLIN))
559 #ifdef LWS_OPENSSL_SUPPORT
561 n = SSL_read(wsi->ssl, buf, sizeof buf);
564 n = recv(pollfd->fd, buf, sizeof buf, 0);
567 fprintf(stderr, "Socket read returned %d\n", n);
571 libwebsocket_close_and_free_session(wsi);
575 /* service incoming data */
577 n = libwebsocket_read(wsi, buf, n);
581 * it closed and nuked wsi[client], so remove the
582 * socket handle and wsi from our service list
586 debug("nuking wsi %p, fsd_count = %d\n",
587 (void *)wsi, this->fds_count - 1);
589 delete_from_fd(this, pollfd->fd);
592 for (n = 0; n < this->fds_count; n++)
593 if (this->fds[n].fd == pollfd->fd) {
594 while (n < this->fds_count) {
595 this->fds[n] = this->fds[n + 1];
601 /* external POLL support via protocol 0 */
602 this->protocols[0].callback(wsi,
603 LWS_CALLBACK_DEL_POLL_FD,
604 (void *)(long)pollfd->fd, NULL, 0);
615 * libwebsocket_context_destroy() - Destroy the websocket context
616 * @this: Websocket context
618 * This function closes any active connections and then frees the
619 * context. After calling this, any further use of the context is
623 libwebsocket_context_destroy(struct libwebsocket_context *this)
627 struct libwebsocket *wsi;
629 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
631 for (m = 0; m < this->fd_hashtable[n].length; m++) {
633 wsi = this->fd_hashtable[n].wsi[m];
636 case LWS_CONNMODE_WS_SERVING:
637 libwebsocket_close_and_free_session(wsi);
639 case LWS_CONNMODE_WS_CLIENT:
640 libwebsocket_client_close(wsi);
648 close(this->fd_random);
650 #ifdef LWS_OPENSSL_SUPPORT
652 SSL_CTX_free(this->ssl_ctx);
653 if (this->ssl_client_ctx)
654 SSL_CTX_free(this->ssl_client_ctx);
661 * libwebsocket_service() - Service any pending websocket activity
662 * @this: Websocket context
663 * @timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
664 * service otherwise block and service immediately, returning
665 * after the timeout if nothing needed service.
667 * This function deals with any pending websocket traffic, for three
668 * kinds of event. It handles these events on both server and client
669 * types of connection the same.
671 * 1) Accept new connections to our context's server
673 * 2) Perform pending broadcast writes initiated from other forked
674 * processes (effectively serializing asynchronous broadcasts)
676 * 3) Call the receive callback for incoming frame data received by
677 * server or client connections.
679 * You need to call this service function periodically to all the above
680 * functions to happen; if your application is single-threaded you can
681 * just call it in your main event loop.
683 * Alternatively you can fork a new process that asynchronously handles
684 * calling this service in a loop. In that case you are happy if this
685 * call blocks your thread until it needs to take care of something and
686 * would call it with a large nonzero timeout. Your loop then takes no
687 * CPU while there is nothing happening.
689 * If you are calling it in a single-threaded app, you don't want it to
690 * wait around blocking other things in your loop from happening, so you
691 * would call it with a timeout_ms of 0, so it returns immediately if
692 * nothing is pending, or as soon as it services whatever was pending.
697 libwebsocket_service(struct libwebsocket_context *this, int timeout_ms)
701 /* stay dead once we are dead */
706 /* wait for something to need service */
708 n = poll(this->fds, this->fds_count, timeout_ms);
709 if (n == 0) /* poll timeout */
712 if (n < 0 || this->fds[0].revents & (POLLERR | POLLHUP)) {
714 fprintf(stderr, "Listen Socket dead\n");
719 /* handle accept on listening socket? */
721 for (n = 0; n < this->fds_count; n++)
722 if (this->fds[n].revents)
723 libwebsocket_service_fd(this, &this->fds[n]);
729 * libwebsocket_callback_on_writable() - Request a callback when this socket
730 * becomes able to be written to without
733 * @wsi: Websocket connection instance to get callback for
737 libwebsocket_callback_on_writable(struct libwebsocket *wsi)
739 struct libwebsocket_context *this = wsi->protocol->owning_server;
742 for (n = 0; n < this->fds_count; n++)
743 if (this->fds[n].fd == wsi->sock) {
744 this->fds[n].events |= POLLOUT;
748 /* external POLL support via protocol 0 */
749 this->protocols[0].callback(wsi,
750 LWS_CALLBACK_SET_MODE_POLL_FD,
751 (void *)(long)wsi->sock, NULL, POLLOUT);
757 * libwebsocket_callback_on_writable_all_protocol() - Request a callback for
758 * all connections using the given protocol when it
759 * becomes possible to write to each socket without
762 * @protocol: Protocol whose connections will get callbacks
766 libwebsocket_callback_on_writable_all_protocol(
767 const struct libwebsocket_protocols *protocol)
769 struct libwebsocket_context *this = protocol->owning_server;
772 struct libwebsocket *wsi;
774 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
776 for (m = 0; m < this->fd_hashtable[n].length; m++) {
778 wsi = this->fd_hashtable[n].wsi[m];
780 if (wsi->protocol == protocol)
781 libwebsocket_callback_on_writable(wsi);
790 * libwebsocket_get_socket_fd() - returns the socket file descriptor
792 * You will not need this unless you are doing something special
794 * @wsi: Websocket connection instance
798 libwebsocket_get_socket_fd(struct libwebsocket *wsi)
804 * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
807 * If the output side of a server process becomes choked, this allows flow
808 * control for the input side.
810 * @wsi: Websocket connection instance to get callback for
811 * @enable: 0 = disable read servicing for this connection, 1 = enable
815 libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
817 struct libwebsocket_context *this = wsi->protocol->owning_server;
820 for (n = 0; n < this->fds_count; n++)
821 if (this->fds[n].fd == wsi->sock) {
823 this->fds[n].events |= POLLIN;
825 this->fds[n].events &= ~POLLIN;
831 /* external POLL support via protocol 0 */
832 this->protocols[0].callback(wsi,
833 LWS_CALLBACK_SET_MODE_POLL_FD,
834 (void *)(long)wsi->sock, NULL, POLLIN);
836 /* external POLL support via protocol 0 */
837 this->protocols[0].callback(wsi,
838 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
839 (void *)(long)wsi->sock, NULL, POLLIN);
842 fprintf(stderr, "libwebsocket_callback_on_writable "
843 "unable to find socket\n");
848 * libwebsocket_canonical_hostname() - returns this host's hostname
850 * This is typically used by client code to fill in the host parameter
851 * when making a client connection. You can only call it after the context
854 * @this: Websocket context
859 libwebsocket_canonical_hostname(struct libwebsocket_context *this)
861 return (const char *)this->canonical_hostname;
865 static void sigpipe_handler(int x)
872 * libwebsocket_create_context() - Create the websocket handler
873 * @port: Port to listen on... you can use 0 to suppress listening on
874 * any port, that's what you want if you are not running a
875 * websocket server at all but just using it as a client
876 * @protocols: Array of structures listing supported protocols and a protocol-
877 * specific callback for each one. The list is ended with an
878 * entry that has a NULL callback pointer.
879 * It's not const because we write the owning_server member
880 * @ssl_cert_filepath: If libwebsockets was compiled to use ssl, and you want
881 * to listen using SSL, set to the filepath to fetch the
882 * server cert from, otherwise NULL for unencrypted
883 * @ssl_private_key_filepath: filepath to private key if wanting SSL mode,
885 * @gid: group id to change to after setting listen socket, or -1.
886 * @uid: user id to change to after setting listen socket, or -1.
887 * @options: 0, or LWS_SERVER_OPTION_DEFEAT_CLIENT_MASK
889 * This function creates the listening socket and takes care
890 * of all initialization in one step.
892 * After initialization, it returns a struct libwebsocket_context * that
893 * represents this server. After calling, user code needs to take care
894 * of calling libwebsocket_service() with the context pointer to get the
895 * server's sockets serviced. This can be done in the same process context
896 * or a forked process, or another thread,
898 * The protocol callback functions are called for a handful of events
899 * including http requests coming in, websocket connections becoming
900 * established, and data arriving; it's also called periodically to allow
901 * async transmission.
903 * HTTP requests are sent always to the FIRST protocol in @protocol, since
904 * at that time websocket protocol has not been negotiated. Other
905 * protocols after the first one never see any HTTP callack activity.
907 * The server created is a simple http server by default; part of the
908 * websocket standard is upgrading this http connection to a websocket one.
910 * This allows the same server to provide files like scripts and favicon /
911 * images or whatever over http and dynamic data over websockets all in
912 * one place; they're all handled in the user callback.
915 struct libwebsocket_context *
916 libwebsocket_create_context(int port,
917 struct libwebsocket_protocols *protocols,
918 const char *ssl_cert_filepath,
919 const char *ssl_private_key_filepath,
920 int gid, int uid, unsigned int options)
925 struct sockaddr_in serv_addr, cli_addr;
927 struct libwebsocket_context *this = NULL;
932 struct libwebsocket *wsi;
934 #ifdef LWS_OPENSSL_SUPPORT
936 char ssl_err_buf[512];
939 this = malloc(sizeof(struct libwebsocket_context));
941 fprintf(stderr, "No memory for websocket context\n");
944 this->protocols = protocols;
945 this->listen_port = port;
946 this->http_proxy_port = 0;
947 this->http_proxy_address[0] = '\0';
948 this->options = options;
951 this->fd_random = open(SYSTEM_RANDOM_FILEPATH, O_RDONLY);
952 if (this->fd_random < 0) {
953 fprintf(stderr, "Unable to open random device %s %d\n",
954 SYSTEM_RANDOM_FILEPATH, this->fd_random);
958 /* find canonical hostname */
960 hostname[(sizeof hostname) - 1] = '\0';
961 gethostname(hostname, (sizeof hostname) - 1);
962 he = gethostbyname(hostname);
963 strncpy(this->canonical_hostname, he->h_name,
964 sizeof this->canonical_hostname - 1);
965 this->canonical_hostname[sizeof this->canonical_hostname - 1] = '\0';
966 fprintf(stderr, " canonical hostname = '%s'\n",
967 this->canonical_hostname);
969 /* split the proxy ads:port if given */
971 p = getenv("http_proxy");
973 strncpy(this->http_proxy_address, p,
974 sizeof this->http_proxy_address - 1);
975 this->http_proxy_address[
976 sizeof this->http_proxy_address - 1] = '\0';
978 p = strchr(this->http_proxy_address, ':');
980 fprintf(stderr, "http_proxy needs to be ads:port\n");
984 this->http_proxy_port = atoi(p + 1);
986 fprintf(stderr, "Using proxy %s:%u\n",
987 this->http_proxy_address,
988 this->http_proxy_port);
993 #ifdef LWS_OPENSSL_SUPPORT
994 this->use_ssl = ssl_cert_filepath != NULL &&
995 ssl_private_key_filepath != NULL;
997 fprintf(stderr, " Compiled with SSL support, "
1000 fprintf(stderr, " Compiled with SSL support, "
1004 if (ssl_cert_filepath != NULL &&
1005 ssl_private_key_filepath != NULL) {
1006 fprintf(stderr, " Not compiled for OpenSSl support!\n");
1009 fprintf(stderr, " Compiled without SSL support, "
1010 "serving unencrypted\n");
1014 /* ignore SIGPIPE */
1016 signal(SIGPIPE, sigpipe_handler);
1019 #ifdef LWS_OPENSSL_SUPPORT
1021 /* basic openssl init */
1025 OpenSSL_add_all_algorithms();
1026 SSL_load_error_strings();
1029 * Firefox insists on SSLv23 not SSLv3
1030 * Konq disables SSLv2 by default now, SSLv23 works
1033 method = (SSL_METHOD *)SSLv23_server_method();
1035 fprintf(stderr, "problem creating ssl method: %s\n",
1036 ERR_error_string(ERR_get_error(), ssl_err_buf));
1039 this->ssl_ctx = SSL_CTX_new(method); /* create context */
1040 if (!this->ssl_ctx) {
1041 fprintf(stderr, "problem creating ssl context: %s\n",
1042 ERR_error_string(ERR_get_error(), ssl_err_buf));
1046 /* client context */
1048 method = (SSL_METHOD *)SSLv23_client_method();
1050 fprintf(stderr, "problem creating ssl method: %s\n",
1051 ERR_error_string(ERR_get_error(), ssl_err_buf));
1054 this->ssl_client_ctx = SSL_CTX_new(method); /* create context */
1055 if (!this->ssl_client_ctx) {
1056 fprintf(stderr, "problem creating ssl context: %s\n",
1057 ERR_error_string(ERR_get_error(), ssl_err_buf));
1062 /* openssl init for cert verification (used with client sockets) */
1064 if (!SSL_CTX_load_verify_locations(this->ssl_client_ctx, NULL,
1065 LWS_OPENSSL_CLIENT_CERTS)) {
1066 fprintf(stderr, "Unable to load SSL Client certs from %s "
1067 "(set by --with-client-cert-dir= in configure) -- "
1068 " client ssl isn't going to work",
1069 LWS_OPENSSL_CLIENT_CERTS);
1072 if (this->use_ssl) {
1074 /* openssl init for server sockets */
1076 /* set the local certificate from CertFile */
1077 n = SSL_CTX_use_certificate_file(this->ssl_ctx,
1078 ssl_cert_filepath, SSL_FILETYPE_PEM);
1080 fprintf(stderr, "problem getting cert '%s': %s\n",
1082 ERR_error_string(ERR_get_error(), ssl_err_buf));
1085 /* set the private key from KeyFile */
1086 if (SSL_CTX_use_PrivateKey_file(this->ssl_ctx,
1087 ssl_private_key_filepath,
1088 SSL_FILETYPE_PEM) != 1) {
1089 fprintf(stderr, "ssl problem getting key '%s': %s\n",
1090 ssl_private_key_filepath,
1091 ERR_error_string(ERR_get_error(), ssl_err_buf));
1094 /* verify private key */
1095 if (!SSL_CTX_check_private_key(this->ssl_ctx)) {
1096 fprintf(stderr, "Private SSL key doesn't match cert\n");
1100 /* SSL is happy and has a cert it's content with */
1106 if (lws_b64_selftest())
1109 /* fd hashtable init */
1111 for (n = 0; n < FD_HASHTABLE_MODULUS; n++)
1112 this->fd_hashtable[n].length = 0;
1114 /* set up our external listening socket we serve on */
1118 sockfd = socket(AF_INET, SOCK_STREAM, 0);
1120 fprintf(stderr, "ERROR opening socket");
1124 /* allow us to restart even if old sockets in TIME_WAIT */
1125 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
1127 bzero((char *) &serv_addr, sizeof(serv_addr));
1128 serv_addr.sin_family = AF_INET;
1129 serv_addr.sin_addr.s_addr = INADDR_ANY;
1130 serv_addr.sin_port = htons(port);
1132 n = bind(sockfd, (struct sockaddr *) &serv_addr,
1135 fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
1140 wsi = malloc(sizeof(struct libwebsocket));
1141 memset(wsi, 0, sizeof (struct libwebsocket));
1143 wsi->mode = LWS_CONNMODE_SERVER_LISTENER;
1144 insert_wsi(this, wsi);
1147 fprintf(stderr, " Listening on port %d\n", port);
1149 /* list in the internal poll array */
1151 this->fds[this->fds_count].fd = sockfd;
1152 this->fds[this->fds_count++].events = POLLIN;
1154 /* external POLL support via protocol 0 */
1155 this->protocols[0].callback(wsi,
1156 LWS_CALLBACK_ADD_POLL_FD,
1157 (void *)(long)sockfd, NULL, POLLIN);
1161 /* drop any root privs for this process */
1165 fprintf(stderr, "setgid: %s\n", strerror(errno));
1168 fprintf(stderr, "setuid: %s\n", strerror(errno));
1171 /* set up our internal broadcast trigger sockets per-protocol */
1173 for (this->count_protocols = 0;
1174 protocols[this->count_protocols].callback;
1175 this->count_protocols++) {
1176 protocols[this->count_protocols].owning_server = this;
1177 protocols[this->count_protocols].protocol_index =
1178 this->count_protocols;
1180 fd = socket(AF_INET, SOCK_STREAM, 0);
1182 fprintf(stderr, "ERROR opening socket");
1186 /* allow us to restart even if old sockets in TIME_WAIT */
1187 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
1189 bzero((char *) &serv_addr, sizeof(serv_addr));
1190 serv_addr.sin_family = AF_INET;
1191 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
1192 serv_addr.sin_port = 0; /* pick the port for us */
1194 n = bind(fd, (struct sockaddr *) &serv_addr, sizeof(serv_addr));
1196 fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
1201 slen = sizeof cli_addr;
1202 n = getsockname(fd, (struct sockaddr *)&cli_addr, &slen);
1204 fprintf(stderr, "getsockname failed\n");
1207 protocols[this->count_protocols].broadcast_socket_port =
1208 ntohs(cli_addr.sin_port);
1211 debug(" Protocol %s broadcast socket %d\n",
1212 protocols[this->count_protocols].name,
1213 ntohs(cli_addr.sin_port));
1215 /* dummy wsi per broadcast proxy socket */
1217 wsi = malloc(sizeof(struct libwebsocket));
1218 memset(wsi, 0, sizeof (struct libwebsocket));
1220 wsi->mode = LWS_CONNMODE_BROADCAST_PROXY_LISTENER;
1221 /* note which protocol we are proxying */
1222 wsi->protocol_index_for_broadcast_proxy = this->count_protocols;
1223 insert_wsi(this, wsi);
1225 /* list in internal poll array */
1227 this->fds[this->fds_count].fd = fd;
1228 this->fds[this->fds_count].events = POLLIN;
1229 this->fds[this->fds_count].revents = 0;
1232 /* external POLL support via protocol 0 */
1233 this->protocols[0].callback(wsi,
1234 LWS_CALLBACK_ADD_POLL_FD,
1235 (void *)(long)fd, NULL, POLLIN);
1245 * libwebsockets_fork_service_loop() - Optional helper function forks off
1246 * a process for the websocket server loop.
1247 * You don't have to use this but if not, you
1248 * have to make sure you are calling
1249 * libwebsocket_service periodically to service
1250 * the websocket traffic
1251 * @this: server context returned by creation function
1255 libwebsockets_fork_service_loop(struct libwebsocket_context *this)
1258 struct sockaddr_in cli_addr;
1268 /* main process context */
1271 * set up the proxy sockets to allow broadcast from
1272 * service process context
1275 for (p = 0; p < this->count_protocols; p++) {
1276 fd = socket(AF_INET, SOCK_STREAM, 0);
1278 fprintf(stderr, "Unable to create socket\n");
1281 cli_addr.sin_family = AF_INET;
1282 cli_addr.sin_port = htons(
1283 this->protocols[p].broadcast_socket_port);
1284 cli_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
1285 n = connect(fd, (struct sockaddr *)&cli_addr,
1288 fprintf(stderr, "Unable to connect to "
1289 "broadcast socket %d, %s\n",
1290 n, strerror(errno));
1294 this->protocols[p].broadcast_socket_user_fd = fd;
1300 /* we want a SIGHUP when our parent goes down */
1301 prctl(PR_SET_PDEATHSIG, SIGHUP);
1303 /* in this forked process, sit and service websocket connections */
1306 if (libwebsocket_service(this, 1000))
1315 * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
1317 * @wsi: pointer to struct websocket you want to know the protocol of
1320 * This is useful to get the protocol to broadcast back to from inside
1324 const struct libwebsocket_protocols *
1325 libwebsockets_get_protocol(struct libwebsocket *wsi)
1327 return wsi->protocol;
1331 * libwebsockets_broadcast() - Sends a buffer to the callback for all active
1332 * connections of the given protocol.
1333 * @protocol: pointer to the protocol you will broadcast to all members of
1334 * @buf: buffer containing the data to be broadcase. NOTE: this has to be
1335 * allocated with LWS_SEND_BUFFER_PRE_PADDING valid bytes before
1336 * the pointer and LWS_SEND_BUFFER_POST_PADDING afterwards in the
1337 * case you are calling this function from callback context.
1338 * @len: length of payload data in buf, starting from buf.
1340 * This function allows bulk sending of a packet to every connection using
1341 * the given protocol. It does not send the data directly; instead it calls
1342 * the callback with a reason type of LWS_CALLBACK_BROADCAST. If the callback
1343 * wants to actually send the data for that connection, the callback itself
1344 * should call libwebsocket_write().
1346 * libwebsockets_broadcast() can be called from another fork context without
1347 * having to take any care about data visibility between the processes, it'll
1353 libwebsockets_broadcast(const struct libwebsocket_protocols *protocol,
1354 unsigned char *buf, size_t len)
1356 struct libwebsocket_context *this = protocol->owning_server;
1359 struct libwebsocket * wsi;
1361 if (!protocol->broadcast_socket_user_fd) {
1363 * We are either running unforked / flat, or we are being
1364 * called from poll thread context
1365 * eg, from a callback. In that case don't use sockets for
1366 * broadcast IPC (since we can't open a socket connection to
1367 * a socket listening on our own thread) but directly do the
1370 * Locking is not needed because we are by definition being
1371 * called in the poll thread context and are serialized.
1374 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
1376 for (m = 0; m < this->fd_hashtable[n].length; m++) {
1378 wsi = this->fd_hashtable[n].wsi[m];
1380 if (wsi->mode != LWS_CONNMODE_WS_SERVING)
1384 * never broadcast to
1385 * non-established connections
1387 if (wsi->state != WSI_STATE_ESTABLISHED)
1390 /* only broadcast to guys using
1391 * requested protocol
1393 if (wsi->protocol != protocol)
1396 wsi->protocol->callback(wsi,
1397 LWS_CALLBACK_BROADCAST,
1407 * We're being called from a different process context than the server
1408 * loop. Instead of broadcasting directly, we send our
1409 * payload on a socket to do the IPC; the server process will serialize
1410 * the broadcast action in its main poll() loop.
1412 * There's one broadcast socket listening for each protocol supported
1413 * set up when the websocket server initializes
1416 n = send(protocol->broadcast_socket_user_fd, buf, len, MSG_NOSIGNAL);