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"
30 #ifdef LWS_OPENSSL_SUPPORT
31 int openssl_websocket_private_data_index;
35 * In-place str to lower case
47 /* file descriptor hash management */
50 wsi_from_fd(struct libwebsocket_context *context, int fd)
52 int h = LWS_FD_HASH(fd);
55 for (n = 0; n < context->fd_hashtable[h].length; n++)
56 if (context->fd_hashtable[h].wsi[n]->sock == fd)
57 return context->fd_hashtable[h].wsi[n];
63 insert_wsi(struct libwebsocket_context *context, struct libwebsocket *wsi)
65 int h = LWS_FD_HASH(wsi->sock);
67 if (context->fd_hashtable[h].length == MAX_CLIENTS - 1) {
68 fprintf(stderr, "hash table overflow\n");
72 context->fd_hashtable[h].wsi[context->fd_hashtable[h].length++] = wsi;
78 delete_from_fd(struct libwebsocket_context *context, int fd)
80 int h = LWS_FD_HASH(fd);
83 for (n = 0; n < context->fd_hashtable[h].length; n++)
84 if (context->fd_hashtable[h].wsi[n]->sock == fd) {
85 while (n < context->fd_hashtable[h].length) {
86 context->fd_hashtable[h].wsi[n] =
87 context->fd_hashtable[h].wsi[n + 1];
90 context->fd_hashtable[h].length--;
95 fprintf(stderr, "Failed to find fd %d requested for "
96 "delete in hashtable\n", fd);
100 #ifdef LWS_OPENSSL_SUPPORT
102 libwebsockets_decode_ssl_error(void)
107 while ((err = ERR_get_error()) != 0) {
108 ERR_error_string_n(err, buf, sizeof(buf));
109 fprintf(stderr, "*** %s\n", buf);
116 interface_to_sa(const char* ifname, struct sockaddr_in *addr, size_t addrlen)
124 struct sockaddr_in *sin;
127 for (ifc = ifr; ifc != NULL; ifc = ifc->ifa_next) {
128 if (strcmp(ifc->ifa_name, ifname))
130 if (ifc->ifa_addr == NULL)
132 sin = (struct sockaddr_in *)ifc->ifa_addr;
133 if (sin->sin_family != AF_INET)
135 memcpy(addr, sin, addrlen);
145 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
146 struct libwebsocket *wsi, enum lws_close_status reason)
150 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 2 +
151 LWS_SEND_BUFFER_POST_PADDING];
156 old_state = wsi->state;
158 if (old_state == WSI_STATE_DEAD_SOCKET)
161 /* remove this fd from wsi mapping hashtable */
163 delete_from_fd(context, wsi->sock);
165 /* delete it from the internal poll list if still present */
167 for (n = 0; n < context->fds_count; n++) {
168 if (context->fds[n].fd != wsi->sock)
170 while (n < context->fds_count - 1) {
171 context->fds[n] = context->fds[n + 1];
174 context->fds_count--;
175 /* we only have to deal with one */
176 n = context->fds_count;
179 /* remove also from external POLL support via protocol 0 */
181 context->protocols[0].callback(context, wsi,
182 LWS_CALLBACK_DEL_POLL_FD, (void *)(long)wsi->sock, NULL, 0);
184 wsi->close_reason = reason;
187 * signal we are closing, libsocket_write will
188 * add any necessary version-specific stuff. If the write fails,
189 * no worries we are closing anyway. If we didn't initiate this
190 * close, then our state has been changed to
191 * WSI_STATE_RETURNED_CLOSE_ALREADY and we will skip this
194 if (old_state == WSI_STATE_ESTABLISHED)
195 libwebsocket_write(wsi, &buf[LWS_SEND_BUFFER_PRE_PADDING], 0,
198 wsi->state = WSI_STATE_DEAD_SOCKET;
200 /* tell the user it's all over for this guy */
202 if (wsi->protocol && wsi->protocol->callback &&
203 old_state == WSI_STATE_ESTABLISHED)
204 wsi->protocol->callback(context, wsi, LWS_CALLBACK_CLOSED,
205 wsi->user_space, NULL, 0);
207 /* deallocate any active extension contexts */
209 for (n = 0; n < wsi->count_active_extensions; n++) {
210 if (!wsi->active_extensions[n]->callback)
213 wsi->active_extensions[n]->callback(context, wsi,
214 LWS_EXT_CALLBACK_DESTROY,
215 wsi->active_extensions_user[n], NULL, 0);
217 free(wsi->active_extensions_user[n]);
220 /* free up his parsing allocations */
222 for (n = 0; n < WSI_TOKEN_COUNT; n++)
223 if (wsi->utf8_token[n].token)
224 free(wsi->utf8_token[n].token);
226 /* fprintf(stderr, "closing fd=%d\n", wsi->sock); */
228 #ifdef LWS_OPENSSL_SUPPORT
230 n = SSL_get_fd(wsi->ssl);
231 SSL_shutdown(wsi->ssl);
240 shutdown(wsi->sock, SHUT_RDWR);
242 closesocket(wsi->sock);
246 #ifdef LWS_OPENSSL_SUPPORT
250 free(wsi->user_space);
256 * libwebsockets_hangup_on_client() - Server calls to terminate client
258 * @context: libwebsockets context
259 * @fd: Connection socket descriptor
263 libwebsockets_hangup_on_client(struct libwebsocket_context *context, int fd)
265 struct libwebsocket *wsi = wsi_from_fd(context, fd);
270 libwebsocket_close_and_free_session(context, wsi,
271 LWS_CLOSE_STATUS_NOSTATUS);
276 * libwebsockets_get_peer_addresses() - Get client address information
277 * @fd: Connection socket descriptor
278 * @name: Buffer to take client address name
279 * @name_len: Length of client address name buffer
280 * @rip: Buffer to take client address IP qotted quad
281 * @rip_len: Length of client address IP buffer
283 * This function fills in @name and @rip with the name and IP of
284 * the client connected with socket descriptor @fd. Names may be
285 * truncated if there is not enough room. If either cannot be
286 * determined, they will be returned as valid zero-length strings.
290 libwebsockets_get_peer_addresses(int fd, char *name, int name_len,
291 char *rip, int rip_len)
294 struct sockaddr_in sin;
295 struct hostent *host;
296 struct hostent *host1;
305 if (getpeername(fd, (struct sockaddr *) &sin, &len) < 0) {
306 perror("getpeername");
310 host = gethostbyaddr((char *) &sin.sin_addr, sizeof sin.sin_addr,
313 perror("gethostbyaddr");
317 strncpy(name, host->h_name, name_len);
318 name[name_len - 1] = '\0';
320 host1 = gethostbyname(host->h_name);
326 p = host1->h_addr_list[n++];
329 if (host1->h_addrtype != AF_INET)
332 sprintf(ip, "%d.%d.%d.%d",
333 p[0], p[1], p[2], p[3]);
335 strncpy(rip, ip, rip_len);
336 rip[rip_len - 1] = '\0';
340 int libwebsockets_get_random(struct libwebsocket_context *context,
347 for (n = 0; n < len; n++)
348 p[n] = (unsigned char)rand();
350 n = read(context->fd_random, p, len);
356 void libwebsockets_00_spaceout(char *key, int spaces, int seed)
362 if (*key && (seed & 1))
366 p = key + strlen(key);
375 void libwebsockets_00_spam(char *key, int count, int seed)
382 if (*key && (seed & 1))
386 p = key + strlen(key);
391 *key++ = 0x21 + ((seed & 0xffff) % 15);
392 /* 4 would use it up too fast.. not like it matters */
398 * libwebsocket_service_fd() - Service polled socket with something waiting
399 * @context: Websocket context
400 * @pollfd: The pollfd entry describing the socket fd and which events
403 * This function closes any active connections and then frees the
404 * context. After calling this, any further use of the context is
409 libwebsocket_service_fd(struct libwebsocket_context *context,
410 struct pollfd *pollfd)
412 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + MAX_BROADCAST_PAYLOAD +
413 LWS_SEND_BUFFER_POST_PADDING];
414 struct libwebsocket *wsi;
415 struct libwebsocket *new_wsi;
421 struct sockaddr_in cli_addr;
423 static const char magic_websocket_guid[] =
424 "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
425 static const char magic_websocket_04_masking_guid[] =
426 "61AC5F19-FBBA-4540-B96F-6561F1AB40A8";
432 #ifdef LWS_OPENSSL_SUPPORT
433 char ssl_err_buf[512];
436 * you can call us with pollfd = NULL to just allow the once-per-second
437 * global timeout checks; if less than a second since the last check
438 * it returns immediately then.
441 gettimeofday(&tv, NULL);
443 if (context->last_timeout_check_s != tv.tv_sec) {
444 context->last_timeout_check_s = tv.tv_sec;
446 /* global timeout check once per second */
448 for (n = 0; n < context->fds_count; n++) {
449 wsi = wsi_from_fd(context, context->fds[n].fd);
450 if (!wsi->pending_timeout)
454 * if we went beyond the allowed time, kill the
458 if (tv.tv_sec > wsi->pending_timeout_limit)
459 libwebsocket_close_and_free_session(context,
460 wsi, LWS_CLOSE_STATUS_NOSTATUS);
464 /* just here for timeout management? */
469 /* no, here to service a socket descriptor */
471 wsi = wsi_from_fd(context, pollfd->fd);
477 case LWS_CONNMODE_SERVER_LISTENER:
479 /* pollin means a client has connected to us then */
481 if (!pollfd->revents & POLLIN)
484 /* listen socket got an unencrypted connection... */
486 clilen = sizeof(cli_addr);
487 accept_fd = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
490 fprintf(stderr, "ERROR on accept");
494 if (context->fds_count >= MAX_CLIENTS) {
495 fprintf(stderr, "too busy to accept new client\n");
497 closesocket(accept_fd);
505 * look at who we connected to and give user code a chance
506 * to reject based on client IP. There's no protocol selected
507 * yet so we issue this to protocols[0]
510 if ((context->protocols[0].callback)(context, wsi,
511 LWS_CALLBACK_FILTER_NETWORK_CONNECTION,
512 (void*)(long)accept_fd, NULL, 0)) {
513 fprintf(stderr, "Callback denied network connection\n");
515 closesocket(accept_fd);
522 /* accepting connection to main listener */
524 new_wsi = malloc(sizeof(struct libwebsocket));
525 if (new_wsi == NULL) {
526 fprintf(stderr, "Out of memory for new connection\n");
530 memset(new_wsi, 0, sizeof (struct libwebsocket));
531 new_wsi->sock = accept_fd;
532 new_wsi->count_active_extensions = 0;
533 new_wsi->pending_timeout = NO_PENDING_TIMEOUT;
535 #ifdef LWS_OPENSSL_SUPPORT
538 if (context->use_ssl) {
540 new_wsi->ssl = SSL_new(context->ssl_ctx);
541 if (new_wsi->ssl == NULL) {
542 fprintf(stderr, "SSL_new failed: %s\n",
543 ERR_error_string(SSL_get_error(
544 new_wsi->ssl, 0), NULL));
545 libwebsockets_decode_ssl_error();
550 SSL_set_fd(new_wsi->ssl, accept_fd);
552 n = SSL_accept(new_wsi->ssl);
555 * browsers seem to probe with various
556 * ssl params which fail then retry
559 debug("SSL_accept failed skt %u: %s\n",
561 ERR_error_string(SSL_get_error(
562 new_wsi->ssl, n), NULL));
569 debug("accepted new SSL conn "
570 "port %u on fd=%d SSL ver %s\n",
571 ntohs(cli_addr.sin_port), accept_fd,
572 SSL_get_version(new_wsi->ssl));
576 debug("accepted new conn port %u on fd=%d\n",
577 ntohs(cli_addr.sin_port), accept_fd);
579 /* intialize the instance struct */
581 new_wsi->state = WSI_STATE_HTTP;
582 new_wsi->name_buffer_pos = 0;
583 new_wsi->mode = LWS_CONNMODE_WS_SERVING;
585 for (n = 0; n < WSI_TOKEN_COUNT; n++) {
586 new_wsi->utf8_token[n].token = NULL;
587 new_wsi->utf8_token[n].token_len = 0;
591 * these can only be set once the protocol is known
592 * we set an unestablished connection's protocol pointer
593 * to the start of the supported list, so it can look
594 * for matching ones during the handshake
596 new_wsi->protocol = context->protocols;
597 new_wsi->user_space = NULL;
600 * Default protocol is 76 / 00
601 * After 76, there's a header specified to inform which
602 * draft the client wants, when that's seen we modify
603 * the individual connection's spec revision accordingly
605 new_wsi->ietf_spec_revision = 0;
607 insert_wsi(context, new_wsi);
610 * make sure NO events are seen yet on this new socket
611 * (otherwise we inherit old fds[client].revents from
612 * previous socket there and die mysteriously! )
614 context->fds[context->fds_count].revents = 0;
616 context->fds[context->fds_count].events = POLLIN;
617 context->fds[context->fds_count++].fd = accept_fd;
619 /* external POLL support via protocol 0 */
620 context->protocols[0].callback(context, new_wsi,
621 LWS_CALLBACK_ADD_POLL_FD,
622 (void *)(long)accept_fd, NULL, POLLIN);
626 case LWS_CONNMODE_BROADCAST_PROXY_LISTENER:
628 /* as we are listening, POLLIN means accept() is needed */
630 if (!pollfd->revents & POLLIN)
633 /* listen socket got an unencrypted connection... */
635 clilen = sizeof(cli_addr);
636 accept_fd = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
639 fprintf(stderr, "ERROR on accept");
643 if (context->fds_count >= MAX_CLIENTS) {
644 fprintf(stderr, "too busy to accept new broadcast "
647 closesocket(accept_fd);
654 /* create a dummy wsi for the connection and add it */
656 new_wsi = malloc(sizeof(struct libwebsocket));
657 memset(new_wsi, 0, sizeof (struct libwebsocket));
658 new_wsi->sock = accept_fd;
659 new_wsi->mode = LWS_CONNMODE_BROADCAST_PROXY;
660 new_wsi->state = WSI_STATE_ESTABLISHED;
661 new_wsi->count_active_extensions = 0;
662 /* note which protocol we are proxying */
663 new_wsi->protocol_index_for_broadcast_proxy =
664 wsi->protocol_index_for_broadcast_proxy;
665 insert_wsi(context, new_wsi);
667 /* add connected socket to internal poll array */
669 context->fds[context->fds_count].revents = 0;
670 context->fds[context->fds_count].events = POLLIN;
671 context->fds[context->fds_count++].fd = accept_fd;
673 /* external POLL support via protocol 0 */
674 context->protocols[0].callback(context, new_wsi,
675 LWS_CALLBACK_ADD_POLL_FD,
676 (void *)(long)accept_fd, NULL, POLLIN);
680 case LWS_CONNMODE_BROADCAST_PROXY:
682 /* handle session socket closed */
684 if (pollfd->revents & (POLLERR | POLLHUP)) {
686 debug("Session Socket %p (fd=%d) dead\n",
687 (void *)wsi, pollfd->fd);
689 libwebsocket_close_and_free_session(context, wsi,
690 LWS_CLOSE_STATUS_NORMAL);
694 /* the guy requested a callback when it was OK to write */
696 if (pollfd->revents & POLLOUT) {
700 pollfd->events &= ~POLLOUT;
702 /* external POLL support via protocol 0 */
703 context->protocols[0].callback(context, wsi,
704 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
705 (void *)(long)wsi->sock, NULL, POLLOUT);
707 wsi->protocol->callback(context, wsi,
708 LWS_CALLBACK_CLIENT_WRITEABLE,
713 /* any incoming data ready? */
715 if (!(pollfd->revents & POLLIN))
718 /* get the issued broadcast payload from the socket */
720 len = read(pollfd->fd, buf + LWS_SEND_BUFFER_PRE_PADDING,
721 MAX_BROADCAST_PAYLOAD);
723 fprintf(stderr, "Error reading broadcast payload\n");
727 /* broadcast it to all guys with this protocol index */
729 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
731 for (m = 0; m < context->fd_hashtable[n].length; m++) {
733 new_wsi = context->fd_hashtable[n].wsi[m];
735 /* only to clients we are serving to */
737 if (new_wsi->mode != LWS_CONNMODE_WS_SERVING)
741 * never broadcast to non-established
745 if (new_wsi->state != WSI_STATE_ESTABLISHED)
749 * only broadcast to connections using
750 * the requested protocol
753 if (new_wsi->protocol->protocol_index !=
754 wsi->protocol_index_for_broadcast_proxy)
757 /* broadcast it to this connection */
759 new_wsi->protocol->callback(context, new_wsi,
760 LWS_CALLBACK_BROADCAST,
762 buf + LWS_SEND_BUFFER_PRE_PADDING, len);
767 case LWS_CONNMODE_WS_CLIENT_WAITING_PROXY_REPLY:
769 /* handle proxy hung up on us */
771 if (pollfd->revents & (POLLERR | POLLHUP)) {
773 fprintf(stderr, "Proxy connection %p (fd=%d) dead\n",
774 (void *)wsi, pollfd->fd);
776 libwebsocket_close_and_free_session(context, wsi,
777 LWS_CLOSE_STATUS_NOSTATUS);
781 n = recv(wsi->sock, pkt, sizeof pkt, 0);
783 libwebsocket_close_and_free_session(context, wsi,
784 LWS_CLOSE_STATUS_NOSTATUS);
785 fprintf(stderr, "ERROR reading from proxy socket\n");
790 if (strcmp(pkt, "HTTP/1.0 200 ") != 0) {
791 libwebsocket_close_and_free_session(context, wsi,
792 LWS_CLOSE_STATUS_NOSTATUS);
793 fprintf(stderr, "ERROR from proxy: %s\n", pkt);
797 /* clear his proxy connection timeout */
799 libwebsocket_set_timeout(wsi, NO_PENDING_TIMEOUT, 0);
803 case LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE:
805 #ifdef LWS_OPENSSL_SUPPORT
808 wsi->ssl = SSL_new(context->ssl_client_ctx);
809 wsi->client_bio = BIO_new_socket(wsi->sock,
811 SSL_set_bio(wsi->ssl, wsi->client_bio, wsi->client_bio);
813 SSL_set_ex_data(wsi->ssl,
814 openssl_websocket_private_data_index,
817 if (SSL_connect(wsi->ssl) <= 0) {
818 fprintf(stderr, "SSL connect error %s\n",
819 ERR_error_string(ERR_get_error(),
821 libwebsocket_close_and_free_session(context, wsi,
822 LWS_CLOSE_STATUS_NOSTATUS);
826 n = SSL_get_verify_result(wsi->ssl);
827 if ((n != X509_V_OK) && (
828 n != X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT ||
829 wsi->use_ssl != 2)) {
831 fprintf(stderr, "server's cert didn't "
832 "look good %d\n", n);
833 libwebsocket_close_and_free_session(context,
834 wsi, LWS_CLOSE_STATUS_NOSTATUS);
842 #ifdef LWS_OPENSSL_SUPPORT
847 * create the random key
850 n = libwebsockets_get_random(context, hash, 16);
852 fprintf(stderr, "Unable to read from random dev %s\n",
853 SYSTEM_RANDOM_FILEPATH);
859 free(wsi->c_protocol);
860 libwebsocket_close_and_free_session(context, wsi,
861 LWS_CLOSE_STATUS_NOSTATUS);
865 lws_b64_encode_string(hash, 16, wsi->key_b64,
866 sizeof wsi->key_b64);
869 * 00 example client handshake
871 * GET /socket.io/websocket HTTP/1.1
873 * Connection: Upgrade
874 * Host: 127.0.0.1:9999
875 * Origin: http://127.0.0.1
876 * Sec-WebSocket-Key1: 1 0 2#0W 9 89 7 92 ^
877 * Sec-WebSocket-Key2: 7 7Y 4328 B2v[8(z1
878 * Cookie: socketio=websocket
882 * 04 example client handshake
885 * Host: server.example.com
887 * Connection: Upgrade
888 * Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
889 * Sec-WebSocket-Origin: http://example.com
890 * Sec-WebSocket-Protocol: chat, superchat
891 * Sec-WebSocket-Version: 4
894 p += sprintf(p, "GET %s HTTP/1.1\x0d\x0a", wsi->c_path);
896 if (wsi->ietf_spec_revision == 0) {
897 unsigned char spaces_1, spaces_2;
898 unsigned int max_1, max_2;
899 unsigned int num_1, num_2;
900 unsigned long product_1, product_2;
907 libwebsockets_get_random(context, &spaces_1,
909 libwebsockets_get_random(context, &spaces_2,
912 spaces_1 = (spaces_1 % 12) + 1;
913 spaces_2 = (spaces_2 % 12) + 1;
915 max_1 = 4294967295 / spaces_1;
916 max_2 = 4294967295 / spaces_2;
918 libwebsockets_get_random(context, &num_1, sizeof(int));
919 libwebsockets_get_random(context, &num_2, sizeof(int));
921 num_1 = (num_1 % max_1);
922 num_2 = (num_2 % max_2);
924 challenge[0] = num_1 >> 24;
925 challenge[1] = num_1 >> 16;
926 challenge[2] = num_1 >> 8;
927 challenge[3] = num_1;
928 challenge[4] = num_2 >> 24;
929 challenge[5] = num_2 >> 16;
930 challenge[6] = num_2 >> 8;
931 challenge[7] = num_2;
933 product_1 = num_1 * spaces_1;
934 product_2 = num_2 * spaces_2;
936 sprintf(key_1, "%lu", product_1);
937 sprintf(key_2, "%lu", product_2);
939 libwebsockets_get_random(context, &seed, sizeof(int));
940 libwebsockets_get_random(context, &count, sizeof(int));
942 libwebsockets_00_spam(key_1, (count % 12) + 1, seed);
944 libwebsockets_get_random(context, &seed, sizeof(int));
945 libwebsockets_get_random(context, &count, sizeof(int));
947 libwebsockets_00_spam(key_2, (count % 12) + 1, seed);
949 libwebsockets_get_random(context, &seed, sizeof(int));
951 libwebsockets_00_spaceout(key_1, spaces_1, seed);
952 libwebsockets_00_spaceout(key_2, spaces_2, seed >> 16);
954 p += sprintf(p, "Upgrade: websocket\x0d\x0a"
955 "Connection: Upgrade\x0d\x0aHost: %s\x0d\x0a",
958 p += sprintf(p, "Origin: %s\x0d\x0a",
962 p += sprintf(p, "Sec-WebSocket-Protocol: %s"
963 "\x0d\x0a", wsi->c_protocol);
965 p += sprintf(p, "Sec-WebSocket-Key1: %s\x0d\x0a",
967 p += sprintf(p, "Sec-WebSocket-Key2: %s\x0d\x0a",
970 /* give userland a chance to append, eg, cookies */
972 context->protocols[0].callback(context, wsi,
973 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER,
974 NULL, &p, (pkt + sizeof(pkt)) - p - 12);
976 p += sprintf(p, "\x0d\x0a");
978 read(context->fd_random, p, 8);
979 memcpy(&challenge[8], p, 8);
982 /* precompute what we want to see from the server */
984 MD5((unsigned char *)challenge, 16,
985 (unsigned char *)wsi->initial_handshake_hash_base64);
990 p += sprintf(p, "Host: %s\x0d\x0a", wsi->c_host);
991 p += sprintf(p, "Upgrade: websocket\x0d\x0a");
992 p += sprintf(p, "Connection: Upgrade\x0d\x0a"
993 "Sec-WebSocket-Key: ");
994 strcpy(p, wsi->key_b64);
995 p += strlen(wsi->key_b64);
996 p += sprintf(p, "\x0d\x0a");
998 p += sprintf(p, "Sec-WebSocket-Origin: %s\x0d\x0a",
1000 if (wsi->c_protocol)
1001 p += sprintf(p, "Sec-WebSocket-Protocol: %s\x0d\x0a",
1003 p += sprintf(p, "Sec-WebSocket-Version: %d\x0d\x0a",
1004 wsi->ietf_spec_revision);
1005 /* give userland a chance to append, eg, cookies */
1007 context->protocols[0].callback(context, wsi,
1008 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER,
1009 NULL, &p, (pkt + sizeof(pkt)) - p - 12);
1011 p += sprintf(p, "\x0d\x0a");
1013 /* prepare the expected server accept response */
1015 strcpy((char *)buf, wsi->key_b64);
1016 strcpy((char *)&buf[strlen((char *)buf)], magic_websocket_guid);
1018 SHA1(buf, strlen((char *)buf), (unsigned char *)hash);
1020 lws_b64_encode_string(hash, 20,
1021 wsi->initial_handshake_hash_base64,
1022 sizeof wsi->initial_handshake_hash_base64);
1026 /* done with these now */
1031 free(wsi->c_origin);
1033 /* send our request to the server */
1035 #ifdef LWS_OPENSSL_SUPPORT
1037 n = SSL_write(wsi->ssl, pkt, p - pkt);
1040 n = send(wsi->sock, pkt, p - pkt, 0);
1043 fprintf(stderr, "ERROR writing to client socket\n");
1044 libwebsocket_close_and_free_session(context, wsi,
1045 LWS_CLOSE_STATUS_NOSTATUS);
1049 wsi->parser_state = WSI_TOKEN_NAME_PART;
1050 wsi->mode = LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY;
1051 libwebsocket_set_timeout(wsi,
1052 PENDING_TIMEOUT_AWAITING_SERVER_RESPONSE, 5);
1056 case LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY:
1058 /* handle server hung up on us */
1060 if (pollfd->revents & (POLLERR | POLLHUP)) {
1062 fprintf(stderr, "Server connection %p (fd=%d) dead\n",
1063 (void *)wsi, pollfd->fd);
1069 /* interpret the server response */
1072 * HTTP/1.1 101 Switching Protocols
1073 * Upgrade: websocket
1074 * Connection: Upgrade
1075 * Sec-WebSocket-Accept: me89jWimTRKTWwrS3aRrL53YZSo=
1076 * Sec-WebSocket-Nonce: AQIDBAUGBwgJCgsMDQ4PEC==
1077 * Sec-WebSocket-Protocol: chat
1080 #ifdef LWS_OPENSSL_SUPPORT
1082 len = SSL_read(wsi->ssl, pkt, sizeof pkt);
1085 len = recv(wsi->sock, pkt, sizeof pkt, 0);
1089 "libwebsocket_client_handshake read error\n");
1094 for (n = 0; n < len; n++)
1095 libwebsocket_parse(wsi, *p++);
1097 if (wsi->parser_state != WSI_PARSING_COMPLETE) {
1098 fprintf(stderr, "libwebsocket_client_handshake "
1099 "server response failed parsing\n");
1106 * HTTP/1.1 101 WebSocket Protocol Handshake
1107 * Upgrade: WebSocket
1108 * Connection: Upgrade
1109 * Sec-WebSocket-Origin: http://127.0.0.1
1110 * Sec-WebSocket-Location: ws://127.0.0.1:9999/socket.io/websocket
1115 if (wsi->ietf_spec_revision == 0) {
1116 if (!wsi->utf8_token[WSI_TOKEN_HTTP].token_len ||
1117 !wsi->utf8_token[WSI_TOKEN_UPGRADE].token_len ||
1118 !wsi->utf8_token[WSI_TOKEN_CHALLENGE].token_len ||
1119 !wsi->utf8_token[WSI_TOKEN_CONNECTION].token_len ||
1120 (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len &&
1121 wsi->c_protocol != NULL)) {
1122 fprintf(stderr, "libwebsocket_client_handshake "
1123 "missing required header(s)\n");
1125 fprintf(stderr, "%s", pkt);
1129 strtolower(wsi->utf8_token[WSI_TOKEN_HTTP].token);
1130 if (strcmp(wsi->utf8_token[WSI_TOKEN_HTTP].token,
1131 "101 websocket protocol handshake")) {
1132 fprintf(stderr, "libwebsocket_client_handshake "
1133 "server sent bad HTTP response '%s'\n",
1134 wsi->utf8_token[WSI_TOKEN_HTTP].token);
1138 if (wsi->utf8_token[WSI_TOKEN_CHALLENGE].token_len <
1140 fprintf(stderr, "libwebsocket_client_handshake "
1141 "challenge reply too short %d\n",
1143 WSI_TOKEN_CHALLENGE].token_len);
1145 fprintf(stderr, "%s", pkt);
1150 goto select_protocol;
1154 * well, what the server sent looked reasonable for syntax.
1155 * Now let's confirm it sent all the necessary headers
1158 if (!wsi->utf8_token[WSI_TOKEN_HTTP].token_len ||
1159 !wsi->utf8_token[WSI_TOKEN_UPGRADE].token_len ||
1160 !wsi->utf8_token[WSI_TOKEN_CONNECTION].token_len ||
1161 !wsi->utf8_token[WSI_TOKEN_ACCEPT].token_len ||
1162 (!wsi->utf8_token[WSI_TOKEN_NONCE].token_len &&
1163 wsi->ietf_spec_revision == 4) ||
1164 (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len &&
1165 wsi->c_protocol != NULL)) {
1166 fprintf(stderr, "libwebsocket_client_handshake "
1167 "missing required header(s)\n");
1169 fprintf(stderr, "%s", pkt);
1174 * Everything seems to be there, now take a closer look at what
1178 strtolower(wsi->utf8_token[WSI_TOKEN_HTTP].token);
1179 if (strcmp(wsi->utf8_token[WSI_TOKEN_HTTP].token,
1180 "101 switching protocols")) {
1181 fprintf(stderr, "libwebsocket_client_handshake "
1182 "server sent bad HTTP response '%s'\n",
1183 wsi->utf8_token[WSI_TOKEN_HTTP].token);
1187 strtolower(wsi->utf8_token[WSI_TOKEN_UPGRADE].token);
1188 if (strcmp(wsi->utf8_token[WSI_TOKEN_UPGRADE].token,
1190 fprintf(stderr, "libwebsocket_client_handshake server "
1191 "sent bad Upgrade header '%s'\n",
1192 wsi->utf8_token[WSI_TOKEN_UPGRADE].token);
1196 strtolower(wsi->utf8_token[WSI_TOKEN_CONNECTION].token);
1197 if (strcmp(wsi->utf8_token[WSI_TOKEN_CONNECTION].token,
1199 fprintf(stderr, "libwebsocket_client_handshake server "
1200 "sent bad Connection hdr '%s'\n",
1201 wsi->utf8_token[WSI_TOKEN_CONNECTION].token);
1206 pc = wsi->c_protocol;
1209 * confirm the protocol the server wants to talk was in the list
1210 * of protocols we offered
1213 if (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len) {
1216 * no protocol name to work from,
1217 * default to first protocol
1219 wsi->protocol = &context->protocols[0];
1221 free(wsi->c_protocol);
1226 while (*pc && !okay) {
1228 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token,
1229 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len)) &&
1230 (pc[wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len] == ',' ||
1231 pc[wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len] == '\0')) {
1235 while (*pc && *pc != ',')
1237 while (*pc && *pc != ' ')
1241 /* done with him now */
1243 if (wsi->c_protocol)
1244 free(wsi->c_protocol);
1248 fprintf(stderr, "libwebsocket_client_handshake server "
1249 "sent bad protocol '%s'\n",
1250 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token);
1255 * identify the selected protocol struct and set it
1258 wsi->protocol = NULL;
1259 while (context->protocols[n].callback) {
1260 if (strcmp(wsi->utf8_token[WSI_TOKEN_PROTOCOL].token,
1261 context->protocols[n].name) == 0)
1262 wsi->protocol = &context->protocols[n];
1266 if (wsi->protocol == NULL) {
1267 fprintf(stderr, "libwebsocket_client_handshake server "
1268 "requested protocol '%s', which we "
1269 "said we supported but we don't!\n",
1270 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token);
1276 if (wsi->ietf_spec_revision == 0) {
1278 if (memcmp(wsi->initial_handshake_hash_base64,
1279 wsi->utf8_token[WSI_TOKEN_CHALLENGE].token, 16)) {
1280 fprintf(stderr, "libwebsocket_client_handshake "
1281 "failed 00 challenge compare\n");
1283 fprintf(stderr, "%s", pkt);
1291 * Confirm his accept token is the one we precomputed
1294 if (strcmp(wsi->utf8_token[WSI_TOKEN_ACCEPT].token,
1295 wsi->initial_handshake_hash_base64)) {
1296 fprintf(stderr, "libwebsocket_client_handshake server "
1297 "sent bad ACCEPT '%s' vs computed '%s'\n",
1298 wsi->utf8_token[WSI_TOKEN_ACCEPT].token,
1299 wsi->initial_handshake_hash_base64);
1303 if (wsi->ietf_spec_revision == 4) {
1305 * Calculate the 04 masking key to use when
1306 * sending data to server
1309 strcpy((char *)buf, wsi->key_b64);
1310 p = (char *)buf + strlen(wsi->key_b64);
1311 strcpy(p, wsi->utf8_token[WSI_TOKEN_NONCE].token);
1312 p += wsi->utf8_token[WSI_TOKEN_NONCE].token_len;
1313 strcpy(p, magic_websocket_04_masking_guid);
1314 SHA1(buf, strlen((char *)buf), wsi->masking_key_04);
1318 /* allocate the per-connection user memory (if any) */
1320 if (wsi->protocol->per_session_data_size) {
1321 wsi->user_space = malloc(
1322 wsi->protocol->per_session_data_size);
1323 if (wsi->user_space == NULL) {
1324 fprintf(stderr, "Out of memory for "
1325 "conn user space\n");
1329 wsi->user_space = NULL;
1331 /* clear his proxy connection timeout */
1333 libwebsocket_set_timeout(wsi, NO_PENDING_TIMEOUT, 0);
1335 /* mark him as being alive */
1337 wsi->state = WSI_STATE_ESTABLISHED;
1338 wsi->mode = LWS_CONNMODE_WS_CLIENT;
1340 fprintf(stderr, "handshake OK for protocol %s\n",
1341 wsi->protocol->name);
1343 /* call him back to inform him he is up */
1345 wsi->protocol->callback(context, wsi,
1346 LWS_CALLBACK_CLIENT_ESTABLISHED,
1353 if (wsi->c_protocol)
1354 free(wsi->c_protocol);
1357 libwebsocket_close_and_free_session(context, wsi,
1358 LWS_CLOSE_STATUS_NOSTATUS);
1362 case LWS_CONNMODE_WS_SERVING:
1363 case LWS_CONNMODE_WS_CLIENT:
1365 /* handle session socket closed */
1367 if (pollfd->revents & (POLLERR | POLLHUP)) {
1369 fprintf(stderr, "Session Socket %p (fd=%d) dead\n",
1370 (void *)wsi, pollfd->fd);
1372 libwebsocket_close_and_free_session(context, wsi,
1373 LWS_CLOSE_STATUS_NOSTATUS);
1377 /* the guy requested a callback when it was OK to write */
1379 if (pollfd->revents & POLLOUT) {
1381 pollfd->events &= ~POLLOUT;
1383 /* external POLL support via protocol 0 */
1384 context->protocols[0].callback(context, wsi,
1385 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
1386 (void *)(long)wsi->sock, NULL, POLLOUT);
1388 wsi->protocol->callback(context, wsi,
1389 LWS_CALLBACK_CLIENT_WRITEABLE,
1394 /* any incoming data ready? */
1396 if (!(pollfd->revents & POLLIN))
1399 #ifdef LWS_OPENSSL_SUPPORT
1401 n = SSL_read(wsi->ssl, buf, sizeof buf);
1404 n = recv(pollfd->fd, buf, sizeof buf, 0);
1407 fprintf(stderr, "Socket read returned %d\n", n);
1411 libwebsocket_close_and_free_session(context, wsi,
1412 LWS_CLOSE_STATUS_NOSTATUS);
1416 /* service incoming data */
1418 n = libwebsocket_read(context, wsi, buf, n);
1432 * libwebsocket_context_destroy() - Destroy the websocket context
1433 * @context: Websocket context
1435 * This function closes any active connections and then frees the
1436 * context. After calling this, any further use of the context is
1440 libwebsocket_context_destroy(struct libwebsocket_context *context)
1444 struct libwebsocket *wsi;
1446 for (n = 0; n < FD_HASHTABLE_MODULUS; n++)
1447 for (m = 0; m < context->fd_hashtable[n].length; m++) {
1448 wsi = context->fd_hashtable[n].wsi[m];
1449 libwebsocket_close_and_free_session(context, wsi,
1450 LWS_CLOSE_STATUS_GOINGAWAY);
1455 close(context->fd_random);
1458 #ifdef LWS_OPENSSL_SUPPORT
1459 if (context->ssl_ctx)
1460 SSL_CTX_free(context->ssl_ctx);
1461 if (context->ssl_client_ctx)
1462 SSL_CTX_free(context->ssl_client_ctx);
1473 * libwebsocket_service() - Service any pending websocket activity
1474 * @context: Websocket context
1475 * @timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
1476 * service otherwise block and service immediately, returning
1477 * after the timeout if nothing needed service.
1479 * This function deals with any pending websocket traffic, for three
1480 * kinds of event. It handles these events on both server and client
1481 * types of connection the same.
1483 * 1) Accept new connections to our context's server
1485 * 2) Perform pending broadcast writes initiated from other forked
1486 * processes (effectively serializing asynchronous broadcasts)
1488 * 3) Call the receive callback for incoming frame data received by
1489 * server or client connections.
1491 * You need to call this service function periodically to all the above
1492 * functions to happen; if your application is single-threaded you can
1493 * just call it in your main event loop.
1495 * Alternatively you can fork a new process that asynchronously handles
1496 * calling this service in a loop. In that case you are happy if this
1497 * call blocks your thread until it needs to take care of something and
1498 * would call it with a large nonzero timeout. Your loop then takes no
1499 * CPU while there is nothing happening.
1501 * If you are calling it in a single-threaded app, you don't want it to
1502 * wait around blocking other things in your loop from happening, so you
1503 * would call it with a timeout_ms of 0, so it returns immediately if
1504 * nothing is pending, or as soon as it services whatever was pending.
1509 libwebsocket_service(struct libwebsocket_context *context, int timeout_ms)
1513 /* stay dead once we are dead */
1515 if (context == NULL)
1518 /* wait for something to need service */
1520 n = poll(context->fds, context->fds_count, timeout_ms);
1521 if (n == 0) /* poll timeout */
1526 fprintf(stderr, "Listen Socket dead\n");
1531 /* handle accept on listening socket? */
1533 for (n = 0; n < context->fds_count; n++)
1534 if (context->fds[n].revents)
1535 libwebsocket_service_fd(context, &context->fds[n]);
1541 * libwebsocket_callback_on_writable() - Request a callback when this socket
1542 * becomes able to be written to without
1545 * @context: libwebsockets context
1546 * @wsi: Websocket connection instance to get callback for
1550 libwebsocket_callback_on_writable(struct libwebsocket_context *context,
1551 struct libwebsocket *wsi)
1555 for (n = 0; n < context->fds_count; n++)
1556 if (context->fds[n].fd == wsi->sock) {
1557 context->fds[n].events |= POLLOUT;
1558 n = context->fds_count;
1561 /* external POLL support via protocol 0 */
1562 context->protocols[0].callback(context, wsi,
1563 LWS_CALLBACK_SET_MODE_POLL_FD,
1564 (void *)(long)wsi->sock, NULL, POLLOUT);
1570 * libwebsocket_callback_on_writable_all_protocol() - Request a callback for
1571 * all connections using the given protocol when it
1572 * becomes possible to write to each socket without
1575 * @protocol: Protocol whose connections will get callbacks
1579 libwebsocket_callback_on_writable_all_protocol(
1580 const struct libwebsocket_protocols *protocol)
1582 struct libwebsocket_context *context = protocol->owning_server;
1585 struct libwebsocket *wsi;
1587 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
1589 for (m = 0; m < context->fd_hashtable[n].length; m++) {
1591 wsi = context->fd_hashtable[n].wsi[m];
1593 if (wsi->protocol == protocol)
1594 libwebsocket_callback_on_writable(context, wsi);
1602 * libwebsocket_set_timeout() - marks the wsi as subject to a timeout
1604 * You will not need this unless you are doing something special
1606 * @wsi: Websocket connection instance
1607 * @reason: timeout reason
1608 * @secs: how many seconds
1612 libwebsocket_set_timeout(struct libwebsocket *wsi,
1613 enum pending_timeout reason, int secs)
1617 gettimeofday(&tv, NULL);
1619 wsi->pending_timeout_limit = tv.tv_sec + secs;
1620 wsi->pending_timeout = reason;
1625 * libwebsocket_get_socket_fd() - returns the socket file descriptor
1627 * You will not need this unless you are doing something special
1629 * @wsi: Websocket connection instance
1633 libwebsocket_get_socket_fd(struct libwebsocket *wsi)
1639 * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
1640 * receieved packets.
1642 * If the output side of a server process becomes choked, this allows flow
1643 * control for the input side.
1645 * @wsi: Websocket connection instance to get callback for
1646 * @enable: 0 = disable read servicing for this connection, 1 = enable
1650 libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
1652 struct libwebsocket_context *context = wsi->protocol->owning_server;
1655 for (n = 0; n < context->fds_count; n++)
1656 if (context->fds[n].fd == wsi->sock) {
1658 context->fds[n].events |= POLLIN;
1660 context->fds[n].events &= ~POLLIN;
1666 /* external POLL support via protocol 0 */
1667 context->protocols[0].callback(context, wsi,
1668 LWS_CALLBACK_SET_MODE_POLL_FD,
1669 (void *)(long)wsi->sock, NULL, POLLIN);
1671 /* external POLL support via protocol 0 */
1672 context->protocols[0].callback(context, wsi,
1673 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
1674 (void *)(long)wsi->sock, NULL, POLLIN);
1677 fprintf(stderr, "libwebsocket_callback_on_writable "
1678 "unable to find socket\n");
1683 * libwebsocket_canonical_hostname() - returns this host's hostname
1685 * This is typically used by client code to fill in the host parameter
1686 * when making a client connection. You can only call it after the context
1689 * @context: Websocket context
1694 libwebsocket_canonical_hostname(struct libwebsocket_context *context)
1696 return (const char *)context->canonical_hostname;
1700 static void sigpipe_handler(int x)
1704 #ifdef LWS_OPENSSL_SUPPORT
1706 OpenSSL_verify_callback(int preverify_ok, X509_STORE_CTX *x509_ctx)
1711 struct libwebsocket_context *context;
1713 ssl = X509_STORE_CTX_get_ex_data(x509_ctx,
1714 SSL_get_ex_data_X509_STORE_CTX_idx());
1717 * !!! nasty openssl requires the index to come as a library-scope
1720 context = SSL_get_ex_data(ssl, openssl_websocket_private_data_index);
1722 n = context->protocols[0].callback(NULL, NULL,
1723 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION,
1724 x509_ctx, ssl, preverify_ok);
1726 /* convert return code from 0 = OK to 1 = OK */
1739 * libwebsocket_create_context() - Create the websocket handler
1740 * @port: Port to listen on... you can use 0 to suppress listening on
1741 * any port, that's what you want if you are not running a
1742 * websocket server at all but just using it as a client
1743 * @interf: NULL to bind the listen socket to all interfaces, or the
1744 * interface name, eg, "eth2"
1745 * @protocols: Array of structures listing supported protocols and a protocol-
1746 * specific callback for each one. The list is ended with an
1747 * entry that has a NULL callback pointer.
1748 * It's not const because we write the owning_server member
1749 * @extensions: NULL or array of libwebsocket_extension structs listing the
1750 * extensions this context supports
1751 * @ssl_cert_filepath: If libwebsockets was compiled to use ssl, and you want
1752 * to listen using SSL, set to the filepath to fetch the
1753 * server cert from, otherwise NULL for unencrypted
1754 * @ssl_private_key_filepath: filepath to private key if wanting SSL mode,
1756 * @gid: group id to change to after setting listen socket, or -1.
1757 * @uid: user id to change to after setting listen socket, or -1.
1758 * @options: 0, or LWS_SERVER_OPTION_DEFEAT_CLIENT_MASK
1760 * This function creates the listening socket and takes care
1761 * of all initialization in one step.
1763 * After initialization, it returns a struct libwebsocket_context * that
1764 * represents this server. After calling, user code needs to take care
1765 * of calling libwebsocket_service() with the context pointer to get the
1766 * server's sockets serviced. This can be done in the same process context
1767 * or a forked process, or another thread,
1769 * The protocol callback functions are called for a handful of events
1770 * including http requests coming in, websocket connections becoming
1771 * established, and data arriving; it's also called periodically to allow
1772 * async transmission.
1774 * HTTP requests are sent always to the FIRST protocol in @protocol, since
1775 * at that time websocket protocol has not been negotiated. Other
1776 * protocols after the first one never see any HTTP callack activity.
1778 * The server created is a simple http server by default; part of the
1779 * websocket standard is upgrading this http connection to a websocket one.
1781 * This allows the same server to provide files like scripts and favicon /
1782 * images or whatever over http and dynamic data over websockets all in
1783 * one place; they're all handled in the user callback.
1786 struct libwebsocket_context *
1787 libwebsocket_create_context(int port, const char *interf,
1788 struct libwebsocket_protocols *protocols,
1789 struct libwebsocket_extension *extensions,
1790 const char *ssl_cert_filepath,
1791 const char *ssl_private_key_filepath,
1792 int gid, int uid, unsigned int options)
1797 struct sockaddr_in serv_addr, cli_addr;
1799 struct libwebsocket_context *context = NULL;
1802 char hostname[1024];
1804 struct libwebsocket *wsi;
1806 #ifdef LWS_OPENSSL_SUPPORT
1808 char ssl_err_buf[512];
1813 WORD wVersionRequested;
1817 /* Use the MAKEWORD(lowbyte, highbyte) macro from Windef.h */
1818 wVersionRequested = MAKEWORD(2, 2);
1820 err = WSAStartup(wVersionRequested, &wsaData);
1822 /* Tell the user that we could not find a usable */
1824 fprintf(stderr, "WSAStartup failed with error: %d\n",
1832 context = malloc(sizeof(struct libwebsocket_context));
1834 fprintf(stderr, "No memory for websocket context\n");
1837 context->protocols = protocols;
1838 context->listen_port = port;
1839 context->http_proxy_port = 0;
1840 context->http_proxy_address[0] = '\0';
1841 context->options = options;
1842 context->fds_count = 0;
1843 context->extensions = extensions;
1846 context->fd_random = 0;
1848 context->fd_random = open(SYSTEM_RANDOM_FILEPATH, O_RDONLY);
1849 if (context->fd_random < 0) {
1850 fprintf(stderr, "Unable to open random device %s %d\n",
1851 SYSTEM_RANDOM_FILEPATH, context->fd_random);
1856 #ifdef LWS_OPENSSL_SUPPORT
1857 context->use_ssl = 0;
1858 context->ssl_ctx = NULL;
1859 context->ssl_client_ctx = NULL;
1860 openssl_websocket_private_data_index = 0;
1862 /* find canonical hostname */
1864 hostname[(sizeof hostname) - 1] = '\0';
1865 gethostname(hostname, (sizeof hostname) - 1);
1866 he = gethostbyname(hostname);
1868 strncpy(context->canonical_hostname, he->h_name,
1869 sizeof context->canonical_hostname - 1);
1870 context->canonical_hostname[
1871 sizeof context->canonical_hostname - 1] = '\0';
1873 strncpy(context->canonical_hostname, hostname,
1874 sizeof context->canonical_hostname - 1);
1876 /* split the proxy ads:port if given */
1878 p = getenv("http_proxy");
1880 strncpy(context->http_proxy_address, p,
1881 sizeof context->http_proxy_address - 1);
1882 context->http_proxy_address[
1883 sizeof context->http_proxy_address - 1] = '\0';
1885 p = strchr(context->http_proxy_address, ':');
1887 fprintf(stderr, "http_proxy needs to be ads:port\n");
1891 context->http_proxy_port = atoi(p + 1);
1893 fprintf(stderr, "Using proxy %s:%u\n",
1894 context->http_proxy_address,
1895 context->http_proxy_port);
1900 #ifdef LWS_OPENSSL_SUPPORT
1901 context->use_ssl = ssl_cert_filepath != NULL &&
1902 ssl_private_key_filepath != NULL;
1903 if (context->use_ssl)
1904 fprintf(stderr, " Compiled with SSL support, "
1907 fprintf(stderr, " Compiled with SSL support, "
1911 if (ssl_cert_filepath != NULL &&
1912 ssl_private_key_filepath != NULL) {
1913 fprintf(stderr, " Not compiled for OpenSSl support!\n");
1916 fprintf(stderr, " Compiled without SSL support, "
1917 "serving unencrypted\n");
1921 /* ignore SIGPIPE */
1924 signal(SIGPIPE, sigpipe_handler);
1928 #ifdef LWS_OPENSSL_SUPPORT
1930 /* basic openssl init */
1934 OpenSSL_add_all_algorithms();
1935 SSL_load_error_strings();
1937 openssl_websocket_private_data_index =
1938 SSL_get_ex_new_index(0, "libwebsockets", NULL, NULL, NULL);
1941 * Firefox insists on SSLv23 not SSLv3
1942 * Konq disables SSLv2 by default now, SSLv23 works
1945 method = (SSL_METHOD *)SSLv23_server_method();
1947 fprintf(stderr, "problem creating ssl method: %s\n",
1948 ERR_error_string(ERR_get_error(), ssl_err_buf));
1951 context->ssl_ctx = SSL_CTX_new(method); /* create context */
1952 if (!context->ssl_ctx) {
1953 fprintf(stderr, "problem creating ssl context: %s\n",
1954 ERR_error_string(ERR_get_error(), ssl_err_buf));
1958 /* client context */
1959 if (port == CONTEXT_PORT_NO_LISTEN)
1961 method = (SSL_METHOD *)SSLv23_client_method();
1963 fprintf(stderr, "problem creating ssl method: %s\n",
1964 ERR_error_string(ERR_get_error(), ssl_err_buf));
1967 /* create context */
1968 context->ssl_client_ctx = SSL_CTX_new(method);
1969 if (!context->ssl_client_ctx) {
1970 fprintf(stderr, "problem creating ssl context: %s\n",
1971 ERR_error_string(ERR_get_error(), ssl_err_buf));
1975 /* openssl init for cert verification (for client sockets) */
1977 if (!SSL_CTX_load_verify_locations(
1978 context->ssl_client_ctx, NULL,
1979 LWS_OPENSSL_CLIENT_CERTS))
1981 "Unable to load SSL Client certs from %s "
1982 "(set by --with-client-cert-dir= in configure) -- "
1983 " client ssl isn't going to work",
1984 LWS_OPENSSL_CLIENT_CERTS);
1987 * callback allowing user code to load extra verification certs
1988 * helping the client to verify server identity
1991 context->protocols[0].callback(context, NULL,
1992 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS,
1993 context->ssl_client_ctx, NULL, 0);
1995 /* as a server, are we requiring clients to identify themselves? */
1997 if (options & LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT) {
1999 /* absolutely require the client cert */
2001 SSL_CTX_set_verify(context->ssl_ctx,
2002 SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
2003 OpenSSL_verify_callback);
2006 * give user code a chance to load certs into the server
2007 * allowing it to verify incoming client certs
2010 context->protocols[0].callback(context, NULL,
2011 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS,
2012 context->ssl_ctx, NULL, 0);
2015 if (context->use_ssl) {
2017 /* openssl init for server sockets */
2019 /* set the local certificate from CertFile */
2020 n = SSL_CTX_use_certificate_file(context->ssl_ctx,
2021 ssl_cert_filepath, SSL_FILETYPE_PEM);
2023 fprintf(stderr, "problem getting cert '%s': %s\n",
2025 ERR_error_string(ERR_get_error(), ssl_err_buf));
2028 /* set the private key from KeyFile */
2029 if (SSL_CTX_use_PrivateKey_file(context->ssl_ctx,
2030 ssl_private_key_filepath, SSL_FILETYPE_PEM) != 1) {
2031 fprintf(stderr, "ssl problem getting key '%s': %s\n",
2032 ssl_private_key_filepath,
2033 ERR_error_string(ERR_get_error(), ssl_err_buf));
2036 /* verify private key */
2037 if (!SSL_CTX_check_private_key(context->ssl_ctx)) {
2038 fprintf(stderr, "Private SSL key doesn't match cert\n");
2042 /* SSL is happy and has a cert it's content with */
2048 if (lws_b64_selftest())
2051 /* fd hashtable init */
2053 for (n = 0; n < FD_HASHTABLE_MODULUS; n++)
2054 context->fd_hashtable[n].length = 0;
2056 /* set up our external listening socket we serve on */
2060 sockfd = socket(AF_INET, SOCK_STREAM, 0);
2062 fprintf(stderr, "ERROR opening socket");
2066 /* allow us to restart even if old sockets in TIME_WAIT */
2067 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
2069 bzero((char *) &serv_addr, sizeof(serv_addr));
2070 serv_addr.sin_family = AF_INET;
2072 serv_addr.sin_addr.s_addr = INADDR_ANY;
2074 interface_to_sa(interf, &serv_addr,
2076 serv_addr.sin_port = htons(port);
2078 n = bind(sockfd, (struct sockaddr *) &serv_addr,
2081 fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
2086 wsi = malloc(sizeof(struct libwebsocket));
2087 memset(wsi, 0, sizeof (struct libwebsocket));
2089 wsi->count_active_extensions = 0;
2090 wsi->mode = LWS_CONNMODE_SERVER_LISTENER;
2091 insert_wsi(context, wsi);
2094 fprintf(stderr, " Listening on port %d\n", port);
2096 /* list in the internal poll array */
2098 context->fds[context->fds_count].fd = sockfd;
2099 context->fds[context->fds_count++].events = POLLIN;
2101 /* external POLL support via protocol 0 */
2102 context->protocols[0].callback(context, wsi,
2103 LWS_CALLBACK_ADD_POLL_FD,
2104 (void *)(long)sockfd, NULL, POLLIN);
2108 /* drop any root privs for this process */
2113 fprintf(stderr, "setgid: %s\n", strerror(errno));
2116 fprintf(stderr, "setuid: %s\n", strerror(errno));
2119 /* set up our internal broadcast trigger sockets per-protocol */
2121 for (context->count_protocols = 0;
2122 protocols[context->count_protocols].callback;
2123 context->count_protocols++) {
2124 protocols[context->count_protocols].owning_server = context;
2125 protocols[context->count_protocols].protocol_index =
2126 context->count_protocols;
2128 fd = socket(AF_INET, SOCK_STREAM, 0);
2130 fprintf(stderr, "ERROR opening socket");
2134 /* allow us to restart even if old sockets in TIME_WAIT */
2135 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
2137 bzero((char *) &serv_addr, sizeof(serv_addr));
2138 serv_addr.sin_family = AF_INET;
2139 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
2140 serv_addr.sin_port = 0; /* pick the port for us */
2142 n = bind(fd, (struct sockaddr *) &serv_addr, sizeof(serv_addr));
2144 fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
2149 slen = sizeof cli_addr;
2150 n = getsockname(fd, (struct sockaddr *)&cli_addr, &slen);
2152 fprintf(stderr, "getsockname failed\n");
2155 protocols[context->count_protocols].broadcast_socket_port =
2156 ntohs(cli_addr.sin_port);
2159 debug(" Protocol %s broadcast socket %d\n",
2160 protocols[context->count_protocols].name,
2161 ntohs(cli_addr.sin_port));
2163 /* dummy wsi per broadcast proxy socket */
2165 wsi = malloc(sizeof(struct libwebsocket));
2166 memset(wsi, 0, sizeof (struct libwebsocket));
2168 wsi->mode = LWS_CONNMODE_BROADCAST_PROXY_LISTENER;
2169 wsi->count_active_extensions = 0;
2170 /* note which protocol we are proxying */
2171 wsi->protocol_index_for_broadcast_proxy =
2172 context->count_protocols;
2173 insert_wsi(context, wsi);
2175 /* list in internal poll array */
2177 context->fds[context->fds_count].fd = fd;
2178 context->fds[context->fds_count].events = POLLIN;
2179 context->fds[context->fds_count].revents = 0;
2180 context->fds_count++;
2182 /* external POLL support via protocol 0 */
2183 context->protocols[0].callback(context, wsi,
2184 LWS_CALLBACK_ADD_POLL_FD,
2185 (void *)(long)fd, NULL, POLLIN);
2195 * libwebsockets_fork_service_loop() - Optional helper function forks off
2196 * a process for the websocket server loop.
2197 * You don't have to use this but if not, you
2198 * have to make sure you are calling
2199 * libwebsocket_service periodically to service
2200 * the websocket traffic
2201 * @context: server context returned by creation function
2205 libwebsockets_fork_service_loop(struct libwebsocket_context *context)
2208 struct sockaddr_in cli_addr;
2218 /* main process context */
2221 * set up the proxy sockets to allow broadcast from
2222 * service process context
2225 for (p = 0; p < context->count_protocols; p++) {
2226 fd = socket(AF_INET, SOCK_STREAM, 0);
2228 fprintf(stderr, "Unable to create socket\n");
2231 cli_addr.sin_family = AF_INET;
2232 cli_addr.sin_port = htons(
2233 context->protocols[p].broadcast_socket_port);
2234 cli_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
2235 n = connect(fd, (struct sockaddr *)&cli_addr,
2238 fprintf(stderr, "Unable to connect to "
2239 "broadcast socket %d, %s\n",
2240 n, strerror(errno));
2244 context->protocols[p].broadcast_socket_user_fd = fd;
2250 /* we want a SIGHUP when our parent goes down */
2251 prctl(PR_SET_PDEATHSIG, SIGHUP);
2253 /* in this forked process, sit and service websocket connections */
2256 if (libwebsocket_service(context, 1000))
2265 * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
2267 * @wsi: pointer to struct websocket you want to know the protocol of
2270 * This is useful to get the protocol to broadcast back to from inside
2274 const struct libwebsocket_protocols *
2275 libwebsockets_get_protocol(struct libwebsocket *wsi)
2277 return wsi->protocol;
2281 * libwebsockets_broadcast() - Sends a buffer to the callback for all active
2282 * connections of the given protocol.
2283 * @protocol: pointer to the protocol you will broadcast to all members of
2284 * @buf: buffer containing the data to be broadcase. NOTE: this has to be
2285 * allocated with LWS_SEND_BUFFER_PRE_PADDING valid bytes before
2286 * the pointer and LWS_SEND_BUFFER_POST_PADDING afterwards in the
2287 * case you are calling this function from callback context.
2288 * @len: length of payload data in buf, starting from buf.
2290 * This function allows bulk sending of a packet to every connection using
2291 * the given protocol. It does not send the data directly; instead it calls
2292 * the callback with a reason type of LWS_CALLBACK_BROADCAST. If the callback
2293 * wants to actually send the data for that connection, the callback itself
2294 * should call libwebsocket_write().
2296 * libwebsockets_broadcast() can be called from another fork context without
2297 * having to take any care about data visibility between the processes, it'll
2303 libwebsockets_broadcast(const struct libwebsocket_protocols *protocol,
2304 unsigned char *buf, size_t len)
2306 struct libwebsocket_context *context = protocol->owning_server;
2309 struct libwebsocket * wsi;
2311 if (!protocol->broadcast_socket_user_fd) {
2313 * We are either running unforked / flat, or we are being
2314 * called from poll thread context
2315 * eg, from a callback. In that case don't use sockets for
2316 * broadcast IPC (since we can't open a socket connection to
2317 * a socket listening on our own thread) but directly do the
2320 * Locking is not needed because we are by definition being
2321 * called in the poll thread context and are serialized.
2324 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
2326 for (m = 0; m < context->fd_hashtable[n].length; m++) {
2328 wsi = context->fd_hashtable[n].wsi[m];
2330 if (wsi->mode != LWS_CONNMODE_WS_SERVING)
2334 * never broadcast to
2335 * non-established connections
2337 if (wsi->state != WSI_STATE_ESTABLISHED)
2340 /* only broadcast to guys using
2341 * requested protocol
2343 if (wsi->protocol != protocol)
2346 wsi->protocol->callback(context, wsi,
2347 LWS_CALLBACK_BROADCAST,
2357 * We're being called from a different process context than the server
2358 * loop. Instead of broadcasting directly, we send our
2359 * payload on a socket to do the IPC; the server process will serialize
2360 * the broadcast action in its main poll() loop.
2362 * There's one broadcast socket listening for each protocol supported
2363 * set up when the websocket server initializes
2366 n = send(protocol->broadcast_socket_user_fd, buf, len, MSG_NOSIGNAL);