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 */
397 int lws_send_pipe_choked(struct libwebsocket *wsi)
402 fds.events = POLLOUT;
405 if (poll(&fds, 1, 0) != 1)
408 if ((fds.revents & POLLOUT) == 0)
411 /* okay to send another packet without blocking */
417 lws_handle_POLLOUT_event(struct libwebsocket_context *context,
418 struct libwebsocket *wsi, struct pollfd *pollfd)
420 struct lws_tokens eff_buf;
425 if (!wsi->extension_data_pending)
429 * check in on the active extensions, see if they
430 * had pending stuff to spill... they need to get the
431 * first look-in otherwise sequence will be disordered
433 * NULL, zero-length eff_buf means just spill pending
439 /* default to nobody has more to spill */
442 eff_buf.token = NULL;
443 eff_buf.token_len = 0;
445 /* give every extension a chance to spill */
447 for (n = 0; n < wsi->count_active_extensions; n++) {
448 m = wsi->active_extensions[n]->callback(
449 wsi->protocol->owning_server, wsi,
450 LWS_EXT_CALLBACK_PACKET_TX_PRESEND,
451 wsi->active_extensions_user[n], &eff_buf, 0);
453 fprintf(stderr, "extension reports fatal error\n");
458 * at least one extension told us he has more
459 * to spill, so we will go around again after
464 /* assuming they gave us something to send, send it */
466 if (eff_buf.token_len) {
467 if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
473 /* no extension has more to spill */
479 * There's more to spill from an extension, but we just sent
480 * something... did that leave the pipe choked?
483 if (!lws_send_pipe_choked(wsi))
484 /* no we could add more */
487 fprintf(stderr, "choked in POLLOUT service\n");
490 * Yes, he's choked. Leave the POLLOUT masked on so we will
491 * come back here when he is unchoked. Don't call the user
492 * callback to enforce ordering of spilling, he'll get called
493 * when we come back here and there's nothing more to spill.
499 wsi->extension_data_pending = 0;
504 pollfd->events &= ~POLLOUT;
506 /* external POLL support via protocol 0 */
507 context->protocols[0].callback(context, wsi,
508 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
509 (void *)(long)wsi->sock, NULL, POLLOUT);
511 wsi->protocol->callback(context, wsi,
512 LWS_CALLBACK_CLIENT_WRITEABLE,
522 * libwebsocket_service_fd() - Service polled socket with something waiting
523 * @context: Websocket context
524 * @pollfd: The pollfd entry describing the socket fd and which events
527 * This function closes any active connections and then frees the
528 * context. After calling this, any further use of the context is
533 libwebsocket_service_fd(struct libwebsocket_context *context,
534 struct pollfd *pollfd)
536 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 1 + MAX_BROADCAST_PAYLOAD +
537 LWS_SEND_BUFFER_POST_PADDING];
538 struct libwebsocket *wsi;
539 struct libwebsocket *new_wsi;
545 struct sockaddr_in cli_addr;
547 static const char magic_websocket_guid[] =
548 "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
549 static const char magic_websocket_04_masking_guid[] =
550 "61AC5F19-FBBA-4540-B96F-6561F1AB40A8";
556 struct lws_tokens eff_buf;
558 #ifdef LWS_OPENSSL_SUPPORT
559 char ssl_err_buf[512];
562 * you can call us with pollfd = NULL to just allow the once-per-second
563 * global timeout checks; if less than a second since the last check
564 * it returns immediately then.
567 gettimeofday(&tv, NULL);
569 if (context->last_timeout_check_s != tv.tv_sec) {
570 context->last_timeout_check_s = tv.tv_sec;
572 /* global timeout check once per second */
574 for (n = 0; n < context->fds_count; n++) {
575 wsi = wsi_from_fd(context, context->fds[n].fd);
576 if (!wsi->pending_timeout)
580 * if we went beyond the allowed time, kill the
584 if (tv.tv_sec > wsi->pending_timeout_limit)
585 libwebsocket_close_and_free_session(context,
586 wsi, LWS_CLOSE_STATUS_NOSTATUS);
590 /* just here for timeout management? */
595 /* no, here to service a socket descriptor */
597 wsi = wsi_from_fd(context, pollfd->fd);
603 case LWS_CONNMODE_SERVER_LISTENER:
605 /* pollin means a client has connected to us then */
607 if (!pollfd->revents & POLLIN)
610 /* listen socket got an unencrypted connection... */
612 clilen = sizeof(cli_addr);
613 accept_fd = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
616 fprintf(stderr, "ERROR on accept");
620 if (context->fds_count >= MAX_CLIENTS) {
621 fprintf(stderr, "too busy to accept new client\n");
623 closesocket(accept_fd);
631 * look at who we connected to and give user code a chance
632 * to reject based on client IP. There's no protocol selected
633 * yet so we issue this to protocols[0]
636 if ((context->protocols[0].callback)(context, wsi,
637 LWS_CALLBACK_FILTER_NETWORK_CONNECTION,
638 (void*)(long)accept_fd, NULL, 0)) {
639 fprintf(stderr, "Callback denied network connection\n");
641 closesocket(accept_fd);
648 /* accepting connection to main listener */
650 new_wsi = malloc(sizeof(struct libwebsocket));
651 if (new_wsi == NULL) {
652 fprintf(stderr, "Out of memory for new connection\n");
656 memset(new_wsi, 0, sizeof (struct libwebsocket));
657 new_wsi->sock = accept_fd;
658 new_wsi->count_active_extensions = 0;
659 new_wsi->pending_timeout = NO_PENDING_TIMEOUT;
661 #ifdef LWS_OPENSSL_SUPPORT
664 if (context->use_ssl) {
666 new_wsi->ssl = SSL_new(context->ssl_ctx);
667 if (new_wsi->ssl == NULL) {
668 fprintf(stderr, "SSL_new failed: %s\n",
669 ERR_error_string(SSL_get_error(
670 new_wsi->ssl, 0), NULL));
671 libwebsockets_decode_ssl_error();
676 SSL_set_fd(new_wsi->ssl, accept_fd);
678 n = SSL_accept(new_wsi->ssl);
681 * browsers seem to probe with various
682 * ssl params which fail then retry
685 debug("SSL_accept failed skt %u: %s\n",
687 ERR_error_string(SSL_get_error(
688 new_wsi->ssl, n), NULL));
695 debug("accepted new SSL conn "
696 "port %u on fd=%d SSL ver %s\n",
697 ntohs(cli_addr.sin_port), accept_fd,
698 SSL_get_version(new_wsi->ssl));
702 debug("accepted new conn port %u on fd=%d\n",
703 ntohs(cli_addr.sin_port), accept_fd);
705 /* intialize the instance struct */
707 new_wsi->state = WSI_STATE_HTTP;
708 new_wsi->name_buffer_pos = 0;
709 new_wsi->mode = LWS_CONNMODE_WS_SERVING;
711 for (n = 0; n < WSI_TOKEN_COUNT; n++) {
712 new_wsi->utf8_token[n].token = NULL;
713 new_wsi->utf8_token[n].token_len = 0;
717 * these can only be set once the protocol is known
718 * we set an unestablished connection's protocol pointer
719 * to the start of the supported list, so it can look
720 * for matching ones during the handshake
722 new_wsi->protocol = context->protocols;
723 new_wsi->user_space = NULL;
726 * Default protocol is 76 / 00
727 * After 76, there's a header specified to inform which
728 * draft the client wants, when that's seen we modify
729 * the individual connection's spec revision accordingly
731 new_wsi->ietf_spec_revision = 0;
733 insert_wsi(context, new_wsi);
736 * make sure NO events are seen yet on this new socket
737 * (otherwise we inherit old fds[client].revents from
738 * previous socket there and die mysteriously! )
740 context->fds[context->fds_count].revents = 0;
742 context->fds[context->fds_count].events = POLLIN;
743 context->fds[context->fds_count++].fd = accept_fd;
745 /* external POLL support via protocol 0 */
746 context->protocols[0].callback(context, new_wsi,
747 LWS_CALLBACK_ADD_POLL_FD,
748 (void *)(long)accept_fd, NULL, POLLIN);
752 case LWS_CONNMODE_BROADCAST_PROXY_LISTENER:
754 /* as we are listening, POLLIN means accept() is needed */
756 if (!pollfd->revents & POLLIN)
759 /* listen socket got an unencrypted connection... */
761 clilen = sizeof(cli_addr);
762 accept_fd = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
765 fprintf(stderr, "ERROR on accept");
769 if (context->fds_count >= MAX_CLIENTS) {
770 fprintf(stderr, "too busy to accept new broadcast "
773 closesocket(accept_fd);
780 /* create a dummy wsi for the connection and add it */
782 new_wsi = malloc(sizeof(struct libwebsocket));
783 memset(new_wsi, 0, sizeof (struct libwebsocket));
784 new_wsi->sock = accept_fd;
785 new_wsi->mode = LWS_CONNMODE_BROADCAST_PROXY;
786 new_wsi->state = WSI_STATE_ESTABLISHED;
787 new_wsi->count_active_extensions = 0;
788 /* note which protocol we are proxying */
789 new_wsi->protocol_index_for_broadcast_proxy =
790 wsi->protocol_index_for_broadcast_proxy;
791 insert_wsi(context, new_wsi);
793 /* add connected socket to internal poll array */
795 context->fds[context->fds_count].revents = 0;
796 context->fds[context->fds_count].events = POLLIN;
797 context->fds[context->fds_count++].fd = accept_fd;
799 /* external POLL support via protocol 0 */
800 context->protocols[0].callback(context, new_wsi,
801 LWS_CALLBACK_ADD_POLL_FD,
802 (void *)(long)accept_fd, NULL, POLLIN);
806 case LWS_CONNMODE_BROADCAST_PROXY:
808 /* handle session socket closed */
810 if (pollfd->revents & (POLLERR | POLLHUP)) {
812 debug("Session Socket %p (fd=%d) dead\n",
813 (void *)wsi, pollfd->fd);
815 libwebsocket_close_and_free_session(context, wsi,
816 LWS_CLOSE_STATUS_NORMAL);
821 * either extension code with stuff to spill, or the user code,
822 * requested a callback when it was OK to write
825 if (pollfd->revents & POLLOUT)
826 if (lws_handle_POLLOUT_event(context, wsi, pollfd) < 0) {
827 libwebsocket_close_and_free_session(context, wsi,
828 LWS_CLOSE_STATUS_NORMAL);
832 /* any incoming data ready? */
834 if (!(pollfd->revents & POLLIN))
837 /* get the issued broadcast payload from the socket */
839 len = read(pollfd->fd, buf + LWS_SEND_BUFFER_PRE_PADDING,
840 MAX_BROADCAST_PAYLOAD);
842 fprintf(stderr, "Error reading broadcast payload\n");
846 /* broadcast it to all guys with this protocol index */
848 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
850 for (m = 0; m < context->fd_hashtable[n].length; m++) {
852 new_wsi = context->fd_hashtable[n].wsi[m];
854 /* only to clients we are serving to */
856 if (new_wsi->mode != LWS_CONNMODE_WS_SERVING)
860 * never broadcast to non-established
864 if (new_wsi->state != WSI_STATE_ESTABLISHED)
868 * only broadcast to connections using
869 * the requested protocol
872 if (new_wsi->protocol->protocol_index !=
873 wsi->protocol_index_for_broadcast_proxy)
876 /* broadcast it to this connection */
878 new_wsi->protocol->callback(context, new_wsi,
879 LWS_CALLBACK_BROADCAST,
881 buf + LWS_SEND_BUFFER_PRE_PADDING, len);
886 case LWS_CONNMODE_WS_CLIENT_WAITING_PROXY_REPLY:
888 /* handle proxy hung up on us */
890 if (pollfd->revents & (POLLERR | POLLHUP)) {
892 fprintf(stderr, "Proxy connection %p (fd=%d) dead\n",
893 (void *)wsi, pollfd->fd);
895 libwebsocket_close_and_free_session(context, wsi,
896 LWS_CLOSE_STATUS_NOSTATUS);
900 n = recv(wsi->sock, pkt, sizeof pkt, 0);
902 libwebsocket_close_and_free_session(context, wsi,
903 LWS_CLOSE_STATUS_NOSTATUS);
904 fprintf(stderr, "ERROR reading from proxy socket\n");
909 if (strcmp(pkt, "HTTP/1.0 200 ") != 0) {
910 libwebsocket_close_and_free_session(context, wsi,
911 LWS_CLOSE_STATUS_NOSTATUS);
912 fprintf(stderr, "ERROR from proxy: %s\n", pkt);
916 /* clear his proxy connection timeout */
918 libwebsocket_set_timeout(wsi, NO_PENDING_TIMEOUT, 0);
922 case LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE:
924 #ifdef LWS_OPENSSL_SUPPORT
927 wsi->ssl = SSL_new(context->ssl_client_ctx);
928 wsi->client_bio = BIO_new_socket(wsi->sock,
930 SSL_set_bio(wsi->ssl, wsi->client_bio, wsi->client_bio);
932 SSL_set_ex_data(wsi->ssl,
933 openssl_websocket_private_data_index,
936 if (SSL_connect(wsi->ssl) <= 0) {
937 fprintf(stderr, "SSL connect error %s\n",
938 ERR_error_string(ERR_get_error(),
940 libwebsocket_close_and_free_session(context, wsi,
941 LWS_CLOSE_STATUS_NOSTATUS);
945 n = SSL_get_verify_result(wsi->ssl);
946 if ((n != X509_V_OK) && (
947 n != X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT ||
948 wsi->use_ssl != 2)) {
950 fprintf(stderr, "server's cert didn't "
951 "look good %d\n", n);
952 libwebsocket_close_and_free_session(context,
953 wsi, LWS_CLOSE_STATUS_NOSTATUS);
961 #ifdef LWS_OPENSSL_SUPPORT
966 * create the random key
969 n = libwebsockets_get_random(context, hash, 16);
971 fprintf(stderr, "Unable to read from random dev %s\n",
972 SYSTEM_RANDOM_FILEPATH);
978 free(wsi->c_protocol);
979 libwebsocket_close_and_free_session(context, wsi,
980 LWS_CLOSE_STATUS_NOSTATUS);
984 lws_b64_encode_string(hash, 16, wsi->key_b64,
985 sizeof wsi->key_b64);
988 * 00 example client handshake
990 * GET /socket.io/websocket HTTP/1.1
992 * Connection: Upgrade
993 * Host: 127.0.0.1:9999
994 * Origin: http://127.0.0.1
995 * Sec-WebSocket-Key1: 1 0 2#0W 9 89 7 92 ^
996 * Sec-WebSocket-Key2: 7 7Y 4328 B2v[8(z1
997 * Cookie: socketio=websocket
1001 * 04 example client handshake
1003 * GET /chat HTTP/1.1
1004 * Host: server.example.com
1005 * Upgrade: websocket
1006 * Connection: Upgrade
1007 * Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
1008 * Sec-WebSocket-Origin: http://example.com
1009 * Sec-WebSocket-Protocol: chat, superchat
1010 * Sec-WebSocket-Version: 4
1013 p += sprintf(p, "GET %s HTTP/1.1\x0d\x0a", wsi->c_path);
1015 if (wsi->ietf_spec_revision == 0) {
1016 unsigned char spaces_1, spaces_2;
1017 unsigned int max_1, max_2;
1018 unsigned int num_1, num_2;
1019 unsigned long product_1, product_2;
1026 libwebsockets_get_random(context, &spaces_1,
1028 libwebsockets_get_random(context, &spaces_2,
1031 spaces_1 = (spaces_1 % 12) + 1;
1032 spaces_2 = (spaces_2 % 12) + 1;
1034 max_1 = 4294967295 / spaces_1;
1035 max_2 = 4294967295 / spaces_2;
1037 libwebsockets_get_random(context, &num_1, sizeof(int));
1038 libwebsockets_get_random(context, &num_2, sizeof(int));
1040 num_1 = (num_1 % max_1);
1041 num_2 = (num_2 % max_2);
1043 challenge[0] = num_1 >> 24;
1044 challenge[1] = num_1 >> 16;
1045 challenge[2] = num_1 >> 8;
1046 challenge[3] = num_1;
1047 challenge[4] = num_2 >> 24;
1048 challenge[5] = num_2 >> 16;
1049 challenge[6] = num_2 >> 8;
1050 challenge[7] = num_2;
1052 product_1 = num_1 * spaces_1;
1053 product_2 = num_2 * spaces_2;
1055 sprintf(key_1, "%lu", product_1);
1056 sprintf(key_2, "%lu", product_2);
1058 libwebsockets_get_random(context, &seed, sizeof(int));
1059 libwebsockets_get_random(context, &count, sizeof(int));
1061 libwebsockets_00_spam(key_1, (count % 12) + 1, seed);
1063 libwebsockets_get_random(context, &seed, sizeof(int));
1064 libwebsockets_get_random(context, &count, sizeof(int));
1066 libwebsockets_00_spam(key_2, (count % 12) + 1, seed);
1068 libwebsockets_get_random(context, &seed, sizeof(int));
1070 libwebsockets_00_spaceout(key_1, spaces_1, seed);
1071 libwebsockets_00_spaceout(key_2, spaces_2, seed >> 16);
1073 p += sprintf(p, "Upgrade: websocket\x0d\x0a"
1074 "Connection: Upgrade\x0d\x0aHost: %s\x0d\x0a",
1077 p += sprintf(p, "Origin: %s\x0d\x0a",
1080 if (wsi->c_protocol)
1081 p += sprintf(p, "Sec-WebSocket-Protocol: %s"
1082 "\x0d\x0a", wsi->c_protocol);
1084 p += sprintf(p, "Sec-WebSocket-Key1: %s\x0d\x0a",
1086 p += sprintf(p, "Sec-WebSocket-Key2: %s\x0d\x0a",
1089 /* give userland a chance to append, eg, cookies */
1091 context->protocols[0].callback(context, wsi,
1092 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER,
1093 NULL, &p, (pkt + sizeof(pkt)) - p - 12);
1095 p += sprintf(p, "\x0d\x0a");
1097 read(context->fd_random, p, 8);
1098 memcpy(&challenge[8], p, 8);
1101 /* precompute what we want to see from the server */
1103 MD5((unsigned char *)challenge, 16,
1104 (unsigned char *)wsi->initial_handshake_hash_base64);
1109 p += sprintf(p, "Host: %s\x0d\x0a", wsi->c_host);
1110 p += sprintf(p, "Upgrade: websocket\x0d\x0a");
1111 p += sprintf(p, "Connection: Upgrade\x0d\x0a"
1112 "Sec-WebSocket-Key: ");
1113 strcpy(p, wsi->key_b64);
1114 p += strlen(wsi->key_b64);
1115 p += sprintf(p, "\x0d\x0a");
1117 p += sprintf(p, "Sec-WebSocket-Origin: %s\x0d\x0a",
1119 if (wsi->c_protocol)
1120 p += sprintf(p, "Sec-WebSocket-Protocol: %s\x0d\x0a",
1122 p += sprintf(p, "Sec-WebSocket-Version: %d\x0d\x0a",
1123 wsi->ietf_spec_revision);
1124 /* give userland a chance to append, eg, cookies */
1126 context->protocols[0].callback(context, wsi,
1127 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER,
1128 NULL, &p, (pkt + sizeof(pkt)) - p - 12);
1130 p += sprintf(p, "\x0d\x0a");
1132 /* prepare the expected server accept response */
1134 strcpy((char *)buf, wsi->key_b64);
1135 strcpy((char *)&buf[strlen((char *)buf)], magic_websocket_guid);
1137 SHA1(buf, strlen((char *)buf), (unsigned char *)hash);
1139 lws_b64_encode_string(hash, 20,
1140 wsi->initial_handshake_hash_base64,
1141 sizeof wsi->initial_handshake_hash_base64);
1145 /* done with these now */
1150 free(wsi->c_origin);
1152 /* send our request to the server */
1154 #ifdef LWS_OPENSSL_SUPPORT
1156 n = SSL_write(wsi->ssl, pkt, p - pkt);
1159 n = send(wsi->sock, pkt, p - pkt, 0);
1162 fprintf(stderr, "ERROR writing to client socket\n");
1163 libwebsocket_close_and_free_session(context, wsi,
1164 LWS_CLOSE_STATUS_NOSTATUS);
1168 wsi->parser_state = WSI_TOKEN_NAME_PART;
1169 wsi->mode = LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY;
1170 libwebsocket_set_timeout(wsi,
1171 PENDING_TIMEOUT_AWAITING_SERVER_RESPONSE, 5);
1175 case LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY:
1177 /* handle server hung up on us */
1179 if (pollfd->revents & (POLLERR | POLLHUP)) {
1181 fprintf(stderr, "Server connection %p (fd=%d) dead\n",
1182 (void *)wsi, pollfd->fd);
1188 /* interpret the server response */
1191 * HTTP/1.1 101 Switching Protocols
1192 * Upgrade: websocket
1193 * Connection: Upgrade
1194 * Sec-WebSocket-Accept: me89jWimTRKTWwrS3aRrL53YZSo=
1195 * Sec-WebSocket-Nonce: AQIDBAUGBwgJCgsMDQ4PEC==
1196 * Sec-WebSocket-Protocol: chat
1199 #ifdef LWS_OPENSSL_SUPPORT
1201 len = SSL_read(wsi->ssl, pkt, sizeof pkt);
1204 len = recv(wsi->sock, pkt, sizeof pkt, 0);
1208 "libwebsocket_client_handshake read error\n");
1213 for (n = 0; n < len; n++)
1214 libwebsocket_parse(wsi, *p++);
1216 if (wsi->parser_state != WSI_PARSING_COMPLETE) {
1217 fprintf(stderr, "libwebsocket_client_handshake "
1218 "server response failed parsing\n");
1225 * HTTP/1.1 101 WebSocket Protocol Handshake
1226 * Upgrade: WebSocket
1227 * Connection: Upgrade
1228 * Sec-WebSocket-Origin: http://127.0.0.1
1229 * Sec-WebSocket-Location: ws://127.0.0.1:9999/socket.io/websocket
1234 if (wsi->ietf_spec_revision == 0) {
1235 if (!wsi->utf8_token[WSI_TOKEN_HTTP].token_len ||
1236 !wsi->utf8_token[WSI_TOKEN_UPGRADE].token_len ||
1237 !wsi->utf8_token[WSI_TOKEN_CHALLENGE].token_len ||
1238 !wsi->utf8_token[WSI_TOKEN_CONNECTION].token_len ||
1239 (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len &&
1240 wsi->c_protocol != NULL)) {
1241 fprintf(stderr, "libwebsocket_client_handshake "
1242 "missing required header(s)\n");
1244 fprintf(stderr, "%s", pkt);
1248 strtolower(wsi->utf8_token[WSI_TOKEN_HTTP].token);
1249 if (strcmp(wsi->utf8_token[WSI_TOKEN_HTTP].token,
1250 "101 websocket protocol handshake")) {
1251 fprintf(stderr, "libwebsocket_client_handshake "
1252 "server sent bad HTTP response '%s'\n",
1253 wsi->utf8_token[WSI_TOKEN_HTTP].token);
1257 if (wsi->utf8_token[WSI_TOKEN_CHALLENGE].token_len <
1259 fprintf(stderr, "libwebsocket_client_handshake "
1260 "challenge reply too short %d\n",
1262 WSI_TOKEN_CHALLENGE].token_len);
1264 fprintf(stderr, "%s", pkt);
1269 goto select_protocol;
1273 * well, what the server sent looked reasonable for syntax.
1274 * Now let's confirm it sent all the necessary headers
1277 if (!wsi->utf8_token[WSI_TOKEN_HTTP].token_len ||
1278 !wsi->utf8_token[WSI_TOKEN_UPGRADE].token_len ||
1279 !wsi->utf8_token[WSI_TOKEN_CONNECTION].token_len ||
1280 !wsi->utf8_token[WSI_TOKEN_ACCEPT].token_len ||
1281 (!wsi->utf8_token[WSI_TOKEN_NONCE].token_len &&
1282 wsi->ietf_spec_revision == 4) ||
1283 (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len &&
1284 wsi->c_protocol != NULL)) {
1285 fprintf(stderr, "libwebsocket_client_handshake "
1286 "missing required header(s)\n");
1288 fprintf(stderr, "%s", pkt);
1293 * Everything seems to be there, now take a closer look at what
1297 strtolower(wsi->utf8_token[WSI_TOKEN_HTTP].token);
1298 if (strcmp(wsi->utf8_token[WSI_TOKEN_HTTP].token,
1299 "101 switching protocols")) {
1300 fprintf(stderr, "libwebsocket_client_handshake "
1301 "server sent bad HTTP response '%s'\n",
1302 wsi->utf8_token[WSI_TOKEN_HTTP].token);
1306 strtolower(wsi->utf8_token[WSI_TOKEN_UPGRADE].token);
1307 if (strcmp(wsi->utf8_token[WSI_TOKEN_UPGRADE].token,
1309 fprintf(stderr, "libwebsocket_client_handshake server "
1310 "sent bad Upgrade header '%s'\n",
1311 wsi->utf8_token[WSI_TOKEN_UPGRADE].token);
1315 strtolower(wsi->utf8_token[WSI_TOKEN_CONNECTION].token);
1316 if (strcmp(wsi->utf8_token[WSI_TOKEN_CONNECTION].token,
1318 fprintf(stderr, "libwebsocket_client_handshake server "
1319 "sent bad Connection hdr '%s'\n",
1320 wsi->utf8_token[WSI_TOKEN_CONNECTION].token);
1325 pc = wsi->c_protocol;
1328 * confirm the protocol the server wants to talk was in the list
1329 * of protocols we offered
1332 if (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len) {
1335 * no protocol name to work from,
1336 * default to first protocol
1338 wsi->protocol = &context->protocols[0];
1340 free(wsi->c_protocol);
1345 while (*pc && !okay) {
1347 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token,
1348 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len)) &&
1349 (pc[wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len] == ',' ||
1350 pc[wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len] == '\0')) {
1354 while (*pc && *pc != ',')
1356 while (*pc && *pc != ' ')
1360 /* done with him now */
1362 if (wsi->c_protocol)
1363 free(wsi->c_protocol);
1367 fprintf(stderr, "libwebsocket_client_handshake server "
1368 "sent bad protocol '%s'\n",
1369 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token);
1374 * identify the selected protocol struct and set it
1377 wsi->protocol = NULL;
1378 while (context->protocols[n].callback) {
1379 if (strcmp(wsi->utf8_token[WSI_TOKEN_PROTOCOL].token,
1380 context->protocols[n].name) == 0)
1381 wsi->protocol = &context->protocols[n];
1385 if (wsi->protocol == NULL) {
1386 fprintf(stderr, "libwebsocket_client_handshake server "
1387 "requested protocol '%s', which we "
1388 "said we supported but we don't!\n",
1389 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token);
1395 if (wsi->ietf_spec_revision == 0) {
1397 if (memcmp(wsi->initial_handshake_hash_base64,
1398 wsi->utf8_token[WSI_TOKEN_CHALLENGE].token, 16)) {
1399 fprintf(stderr, "libwebsocket_client_handshake "
1400 "failed 00 challenge compare\n");
1402 fprintf(stderr, "%s", pkt);
1410 * Confirm his accept token is the one we precomputed
1413 if (strcmp(wsi->utf8_token[WSI_TOKEN_ACCEPT].token,
1414 wsi->initial_handshake_hash_base64)) {
1415 fprintf(stderr, "libwebsocket_client_handshake server "
1416 "sent bad ACCEPT '%s' vs computed '%s'\n",
1417 wsi->utf8_token[WSI_TOKEN_ACCEPT].token,
1418 wsi->initial_handshake_hash_base64);
1422 if (wsi->ietf_spec_revision == 4) {
1424 * Calculate the 04 masking key to use when
1425 * sending data to server
1428 strcpy((char *)buf, wsi->key_b64);
1429 p = (char *)buf + strlen(wsi->key_b64);
1430 strcpy(p, wsi->utf8_token[WSI_TOKEN_NONCE].token);
1431 p += wsi->utf8_token[WSI_TOKEN_NONCE].token_len;
1432 strcpy(p, magic_websocket_04_masking_guid);
1433 SHA1(buf, strlen((char *)buf), wsi->masking_key_04);
1437 /* allocate the per-connection user memory (if any) */
1439 if (wsi->protocol->per_session_data_size) {
1440 wsi->user_space = malloc(
1441 wsi->protocol->per_session_data_size);
1442 if (wsi->user_space == NULL) {
1443 fprintf(stderr, "Out of memory for "
1444 "conn user space\n");
1448 wsi->user_space = NULL;
1450 /* clear his proxy connection timeout */
1452 libwebsocket_set_timeout(wsi, NO_PENDING_TIMEOUT, 0);
1454 /* mark him as being alive */
1456 wsi->state = WSI_STATE_ESTABLISHED;
1457 wsi->mode = LWS_CONNMODE_WS_CLIENT;
1459 fprintf(stderr, "handshake OK for protocol %s\n",
1460 wsi->protocol->name);
1462 /* call him back to inform him he is up */
1464 wsi->protocol->callback(context, wsi,
1465 LWS_CALLBACK_CLIENT_ESTABLISHED,
1472 if (wsi->c_protocol)
1473 free(wsi->c_protocol);
1476 libwebsocket_close_and_free_session(context, wsi,
1477 LWS_CLOSE_STATUS_NOSTATUS);
1481 case LWS_CONNMODE_WS_SERVING:
1482 case LWS_CONNMODE_WS_CLIENT:
1484 /* handle session socket closed */
1486 if (pollfd->revents & (POLLERR | POLLHUP)) {
1488 fprintf(stderr, "Session Socket %p (fd=%d) dead\n",
1489 (void *)wsi, pollfd->fd);
1491 libwebsocket_close_and_free_session(context, wsi,
1492 LWS_CLOSE_STATUS_NOSTATUS);
1496 /* the guy requested a callback when it was OK to write */
1498 if (pollfd->revents & POLLOUT)
1499 if (lws_handle_POLLOUT_event(context, wsi, pollfd) < 0) {
1500 libwebsocket_close_and_free_session(context, wsi,
1501 LWS_CLOSE_STATUS_NORMAL);
1506 /* any incoming data ready? */
1508 if (!(pollfd->revents & POLLIN))
1511 #ifdef LWS_OPENSSL_SUPPORT
1513 eff_buf.token_len = SSL_read(wsi->ssl, buf, sizeof buf);
1517 recv(pollfd->fd, buf, sizeof buf, 0);
1519 if (eff_buf.token_len < 0) {
1520 fprintf(stderr, "Socket read returned %d\n",
1524 if (!eff_buf.token_len) {
1525 libwebsocket_close_and_free_session(context, wsi,
1526 LWS_CLOSE_STATUS_NOSTATUS);
1531 * give any active extensions a chance to munge the buffer
1532 * before parse. We pass in a pointer to an lws_tokens struct
1533 * prepared with the default buffer and content length that's in
1534 * there. Rather than rewrite the default buffer, extensions
1535 * that expect to grow the buffer can adapt .token to
1536 * point to their own per-connection buffer in the extension
1537 * user allocation. By default with no extensions or no
1538 * extension callback handling, just the normal input buffer is
1539 * used then so it is efficient.
1542 eff_buf.token = (char *)buf;
1549 for (n = 0; n < wsi->count_active_extensions; n++) {
1550 m = wsi->active_extensions[n]->callback(context, wsi,
1551 LWS_EXT_CALLBACK_PACKET_RX_PREPARSE,
1552 wsi->active_extensions_user[n], &eff_buf, 0);
1554 fprintf(stderr, "Extension reports fatal error\n");
1555 libwebsocket_close_and_free_session(context, wsi,
1556 LWS_CLOSE_STATUS_NOSTATUS);
1563 /* service incoming data */
1565 if (eff_buf.token_len) {
1566 n = libwebsocket_read(context, wsi,
1567 (unsigned char *)eff_buf.token, eff_buf.token_len);
1573 eff_buf.token = NULL;
1574 eff_buf.token_len = 0;
1584 * libwebsocket_context_destroy() - Destroy the websocket context
1585 * @context: Websocket context
1587 * This function closes any active connections and then frees the
1588 * context. After calling this, any further use of the context is
1592 libwebsocket_context_destroy(struct libwebsocket_context *context)
1596 struct libwebsocket *wsi;
1598 for (n = 0; n < FD_HASHTABLE_MODULUS; n++)
1599 for (m = 0; m < context->fd_hashtable[n].length; m++) {
1600 wsi = context->fd_hashtable[n].wsi[m];
1601 libwebsocket_close_and_free_session(context, wsi,
1602 LWS_CLOSE_STATUS_GOINGAWAY);
1607 close(context->fd_random);
1610 #ifdef LWS_OPENSSL_SUPPORT
1611 if (context->ssl_ctx)
1612 SSL_CTX_free(context->ssl_ctx);
1613 if (context->ssl_client_ctx)
1614 SSL_CTX_free(context->ssl_client_ctx);
1625 * libwebsocket_service() - Service any pending websocket activity
1626 * @context: Websocket context
1627 * @timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
1628 * service otherwise block and service immediately, returning
1629 * after the timeout if nothing needed service.
1631 * This function deals with any pending websocket traffic, for three
1632 * kinds of event. It handles these events on both server and client
1633 * types of connection the same.
1635 * 1) Accept new connections to our context's server
1637 * 2) Perform pending broadcast writes initiated from other forked
1638 * processes (effectively serializing asynchronous broadcasts)
1640 * 3) Call the receive callback for incoming frame data received by
1641 * server or client connections.
1643 * You need to call this service function periodically to all the above
1644 * functions to happen; if your application is single-threaded you can
1645 * just call it in your main event loop.
1647 * Alternatively you can fork a new process that asynchronously handles
1648 * calling this service in a loop. In that case you are happy if this
1649 * call blocks your thread until it needs to take care of something and
1650 * would call it with a large nonzero timeout. Your loop then takes no
1651 * CPU while there is nothing happening.
1653 * If you are calling it in a single-threaded app, you don't want it to
1654 * wait around blocking other things in your loop from happening, so you
1655 * would call it with a timeout_ms of 0, so it returns immediately if
1656 * nothing is pending, or as soon as it services whatever was pending.
1661 libwebsocket_service(struct libwebsocket_context *context, int timeout_ms)
1665 /* stay dead once we are dead */
1667 if (context == NULL)
1670 /* wait for something to need service */
1672 n = poll(context->fds, context->fds_count, timeout_ms);
1673 if (n == 0) /* poll timeout */
1678 fprintf(stderr, "Listen Socket dead\n");
1683 /* handle accept on listening socket? */
1685 for (n = 0; n < context->fds_count; n++)
1686 if (context->fds[n].revents)
1687 libwebsocket_service_fd(context, &context->fds[n]);
1693 * libwebsocket_callback_on_writable() - Request a callback when this socket
1694 * becomes able to be written to without
1697 * @context: libwebsockets context
1698 * @wsi: Websocket connection instance to get callback for
1702 libwebsocket_callback_on_writable(struct libwebsocket_context *context,
1703 struct libwebsocket *wsi)
1707 for (n = 0; n < context->fds_count; n++)
1708 if (context->fds[n].fd == wsi->sock) {
1709 context->fds[n].events |= POLLOUT;
1710 n = context->fds_count;
1713 /* external POLL support via protocol 0 */
1714 context->protocols[0].callback(context, wsi,
1715 LWS_CALLBACK_SET_MODE_POLL_FD,
1716 (void *)(long)wsi->sock, NULL, POLLOUT);
1722 * libwebsocket_callback_on_writable_all_protocol() - Request a callback for
1723 * all connections using the given protocol when it
1724 * becomes possible to write to each socket without
1727 * @protocol: Protocol whose connections will get callbacks
1731 libwebsocket_callback_on_writable_all_protocol(
1732 const struct libwebsocket_protocols *protocol)
1734 struct libwebsocket_context *context = protocol->owning_server;
1737 struct libwebsocket *wsi;
1739 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
1741 for (m = 0; m < context->fd_hashtable[n].length; m++) {
1743 wsi = context->fd_hashtable[n].wsi[m];
1745 if (wsi->protocol == protocol)
1746 libwebsocket_callback_on_writable(context, wsi);
1754 * libwebsocket_set_timeout() - marks the wsi as subject to a timeout
1756 * You will not need this unless you are doing something special
1758 * @wsi: Websocket connection instance
1759 * @reason: timeout reason
1760 * @secs: how many seconds
1764 libwebsocket_set_timeout(struct libwebsocket *wsi,
1765 enum pending_timeout reason, int secs)
1769 gettimeofday(&tv, NULL);
1771 wsi->pending_timeout_limit = tv.tv_sec + secs;
1772 wsi->pending_timeout = reason;
1777 * libwebsocket_get_socket_fd() - returns the socket file descriptor
1779 * You will not need this unless you are doing something special
1781 * @wsi: Websocket connection instance
1785 libwebsocket_get_socket_fd(struct libwebsocket *wsi)
1791 * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
1792 * receieved packets.
1794 * If the output side of a server process becomes choked, this allows flow
1795 * control for the input side.
1797 * @wsi: Websocket connection instance to get callback for
1798 * @enable: 0 = disable read servicing for this connection, 1 = enable
1802 libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
1804 struct libwebsocket_context *context = wsi->protocol->owning_server;
1807 for (n = 0; n < context->fds_count; n++)
1808 if (context->fds[n].fd == wsi->sock) {
1810 context->fds[n].events |= POLLIN;
1812 context->fds[n].events &= ~POLLIN;
1818 /* external POLL support via protocol 0 */
1819 context->protocols[0].callback(context, wsi,
1820 LWS_CALLBACK_SET_MODE_POLL_FD,
1821 (void *)(long)wsi->sock, NULL, POLLIN);
1823 /* external POLL support via protocol 0 */
1824 context->protocols[0].callback(context, wsi,
1825 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
1826 (void *)(long)wsi->sock, NULL, POLLIN);
1829 fprintf(stderr, "libwebsocket_callback_on_writable "
1830 "unable to find socket\n");
1835 * libwebsocket_canonical_hostname() - returns this host's hostname
1837 * This is typically used by client code to fill in the host parameter
1838 * when making a client connection. You can only call it after the context
1841 * @context: Websocket context
1846 libwebsocket_canonical_hostname(struct libwebsocket_context *context)
1848 return (const char *)context->canonical_hostname;
1852 static void sigpipe_handler(int x)
1856 #ifdef LWS_OPENSSL_SUPPORT
1858 OpenSSL_verify_callback(int preverify_ok, X509_STORE_CTX *x509_ctx)
1863 struct libwebsocket_context *context;
1865 ssl = X509_STORE_CTX_get_ex_data(x509_ctx,
1866 SSL_get_ex_data_X509_STORE_CTX_idx());
1869 * !!! nasty openssl requires the index to come as a library-scope
1872 context = SSL_get_ex_data(ssl, openssl_websocket_private_data_index);
1874 n = context->protocols[0].callback(NULL, NULL,
1875 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION,
1876 x509_ctx, ssl, preverify_ok);
1878 /* convert return code from 0 = OK to 1 = OK */
1891 * libwebsocket_create_context() - Create the websocket handler
1892 * @port: Port to listen on... you can use 0 to suppress listening on
1893 * any port, that's what you want if you are not running a
1894 * websocket server at all but just using it as a client
1895 * @interf: NULL to bind the listen socket to all interfaces, or the
1896 * interface name, eg, "eth2"
1897 * @protocols: Array of structures listing supported protocols and a protocol-
1898 * specific callback for each one. The list is ended with an
1899 * entry that has a NULL callback pointer.
1900 * It's not const because we write the owning_server member
1901 * @extensions: NULL or array of libwebsocket_extension structs listing the
1902 * extensions this context supports
1903 * @ssl_cert_filepath: If libwebsockets was compiled to use ssl, and you want
1904 * to listen using SSL, set to the filepath to fetch the
1905 * server cert from, otherwise NULL for unencrypted
1906 * @ssl_private_key_filepath: filepath to private key if wanting SSL mode,
1908 * @gid: group id to change to after setting listen socket, or -1.
1909 * @uid: user id to change to after setting listen socket, or -1.
1910 * @options: 0, or LWS_SERVER_OPTION_DEFEAT_CLIENT_MASK
1912 * This function creates the listening socket and takes care
1913 * of all initialization in one step.
1915 * After initialization, it returns a struct libwebsocket_context * that
1916 * represents this server. After calling, user code needs to take care
1917 * of calling libwebsocket_service() with the context pointer to get the
1918 * server's sockets serviced. This can be done in the same process context
1919 * or a forked process, or another thread,
1921 * The protocol callback functions are called for a handful of events
1922 * including http requests coming in, websocket connections becoming
1923 * established, and data arriving; it's also called periodically to allow
1924 * async transmission.
1926 * HTTP requests are sent always to the FIRST protocol in @protocol, since
1927 * at that time websocket protocol has not been negotiated. Other
1928 * protocols after the first one never see any HTTP callack activity.
1930 * The server created is a simple http server by default; part of the
1931 * websocket standard is upgrading this http connection to a websocket one.
1933 * This allows the same server to provide files like scripts and favicon /
1934 * images or whatever over http and dynamic data over websockets all in
1935 * one place; they're all handled in the user callback.
1938 struct libwebsocket_context *
1939 libwebsocket_create_context(int port, const char *interf,
1940 struct libwebsocket_protocols *protocols,
1941 struct libwebsocket_extension *extensions,
1942 const char *ssl_cert_filepath,
1943 const char *ssl_private_key_filepath,
1944 int gid, int uid, unsigned int options)
1949 struct sockaddr_in serv_addr, cli_addr;
1951 struct libwebsocket_context *context = NULL;
1954 char hostname[1024];
1956 struct libwebsocket *wsi;
1958 #ifdef LWS_OPENSSL_SUPPORT
1960 char ssl_err_buf[512];
1965 WORD wVersionRequested;
1969 /* Use the MAKEWORD(lowbyte, highbyte) macro from Windef.h */
1970 wVersionRequested = MAKEWORD(2, 2);
1972 err = WSAStartup(wVersionRequested, &wsaData);
1974 /* Tell the user that we could not find a usable */
1976 fprintf(stderr, "WSAStartup failed with error: %d\n",
1984 context = malloc(sizeof(struct libwebsocket_context));
1986 fprintf(stderr, "No memory for websocket context\n");
1989 context->protocols = protocols;
1990 context->listen_port = port;
1991 context->http_proxy_port = 0;
1992 context->http_proxy_address[0] = '\0';
1993 context->options = options;
1994 context->fds_count = 0;
1995 context->extensions = extensions;
1998 context->fd_random = 0;
2000 context->fd_random = open(SYSTEM_RANDOM_FILEPATH, O_RDONLY);
2001 if (context->fd_random < 0) {
2002 fprintf(stderr, "Unable to open random device %s %d\n",
2003 SYSTEM_RANDOM_FILEPATH, context->fd_random);
2008 #ifdef LWS_OPENSSL_SUPPORT
2009 context->use_ssl = 0;
2010 context->ssl_ctx = NULL;
2011 context->ssl_client_ctx = NULL;
2012 openssl_websocket_private_data_index = 0;
2014 /* find canonical hostname */
2016 hostname[(sizeof hostname) - 1] = '\0';
2017 gethostname(hostname, (sizeof hostname) - 1);
2018 he = gethostbyname(hostname);
2020 strncpy(context->canonical_hostname, he->h_name,
2021 sizeof context->canonical_hostname - 1);
2022 context->canonical_hostname[
2023 sizeof context->canonical_hostname - 1] = '\0';
2025 strncpy(context->canonical_hostname, hostname,
2026 sizeof context->canonical_hostname - 1);
2028 /* split the proxy ads:port if given */
2030 p = getenv("http_proxy");
2032 strncpy(context->http_proxy_address, p,
2033 sizeof context->http_proxy_address - 1);
2034 context->http_proxy_address[
2035 sizeof context->http_proxy_address - 1] = '\0';
2037 p = strchr(context->http_proxy_address, ':');
2039 fprintf(stderr, "http_proxy needs to be ads:port\n");
2043 context->http_proxy_port = atoi(p + 1);
2045 fprintf(stderr, "Using proxy %s:%u\n",
2046 context->http_proxy_address,
2047 context->http_proxy_port);
2052 #ifdef LWS_OPENSSL_SUPPORT
2053 context->use_ssl = ssl_cert_filepath != NULL &&
2054 ssl_private_key_filepath != NULL;
2055 if (context->use_ssl)
2056 fprintf(stderr, " Compiled with SSL support, "
2059 fprintf(stderr, " Compiled with SSL support, "
2063 if (ssl_cert_filepath != NULL &&
2064 ssl_private_key_filepath != NULL) {
2065 fprintf(stderr, " Not compiled for OpenSSl support!\n");
2068 fprintf(stderr, " Compiled without SSL support, "
2069 "serving unencrypted\n");
2073 /* ignore SIGPIPE */
2076 signal(SIGPIPE, sigpipe_handler);
2080 #ifdef LWS_OPENSSL_SUPPORT
2082 /* basic openssl init */
2086 OpenSSL_add_all_algorithms();
2087 SSL_load_error_strings();
2089 openssl_websocket_private_data_index =
2090 SSL_get_ex_new_index(0, "libwebsockets", NULL, NULL, NULL);
2093 * Firefox insists on SSLv23 not SSLv3
2094 * Konq disables SSLv2 by default now, SSLv23 works
2097 method = (SSL_METHOD *)SSLv23_server_method();
2099 fprintf(stderr, "problem creating ssl method: %s\n",
2100 ERR_error_string(ERR_get_error(), ssl_err_buf));
2103 context->ssl_ctx = SSL_CTX_new(method); /* create context */
2104 if (!context->ssl_ctx) {
2105 fprintf(stderr, "problem creating ssl context: %s\n",
2106 ERR_error_string(ERR_get_error(), ssl_err_buf));
2110 /* client context */
2111 if (port == CONTEXT_PORT_NO_LISTEN)
2113 method = (SSL_METHOD *)SSLv23_client_method();
2115 fprintf(stderr, "problem creating ssl method: %s\n",
2116 ERR_error_string(ERR_get_error(), ssl_err_buf));
2119 /* create context */
2120 context->ssl_client_ctx = SSL_CTX_new(method);
2121 if (!context->ssl_client_ctx) {
2122 fprintf(stderr, "problem creating ssl context: %s\n",
2123 ERR_error_string(ERR_get_error(), ssl_err_buf));
2127 /* openssl init for cert verification (for client sockets) */
2129 if (!SSL_CTX_load_verify_locations(
2130 context->ssl_client_ctx, NULL,
2131 LWS_OPENSSL_CLIENT_CERTS))
2133 "Unable to load SSL Client certs from %s "
2134 "(set by --with-client-cert-dir= in configure) -- "
2135 " client ssl isn't going to work",
2136 LWS_OPENSSL_CLIENT_CERTS);
2139 * callback allowing user code to load extra verification certs
2140 * helping the client to verify server identity
2143 context->protocols[0].callback(context, NULL,
2144 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS,
2145 context->ssl_client_ctx, NULL, 0);
2147 /* as a server, are we requiring clients to identify themselves? */
2149 if (options & LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT) {
2151 /* absolutely require the client cert */
2153 SSL_CTX_set_verify(context->ssl_ctx,
2154 SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
2155 OpenSSL_verify_callback);
2158 * give user code a chance to load certs into the server
2159 * allowing it to verify incoming client certs
2162 context->protocols[0].callback(context, NULL,
2163 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS,
2164 context->ssl_ctx, NULL, 0);
2167 if (context->use_ssl) {
2169 /* openssl init for server sockets */
2171 /* set the local certificate from CertFile */
2172 n = SSL_CTX_use_certificate_file(context->ssl_ctx,
2173 ssl_cert_filepath, SSL_FILETYPE_PEM);
2175 fprintf(stderr, "problem getting cert '%s': %s\n",
2177 ERR_error_string(ERR_get_error(), ssl_err_buf));
2180 /* set the private key from KeyFile */
2181 if (SSL_CTX_use_PrivateKey_file(context->ssl_ctx,
2182 ssl_private_key_filepath, SSL_FILETYPE_PEM) != 1) {
2183 fprintf(stderr, "ssl problem getting key '%s': %s\n",
2184 ssl_private_key_filepath,
2185 ERR_error_string(ERR_get_error(), ssl_err_buf));
2188 /* verify private key */
2189 if (!SSL_CTX_check_private_key(context->ssl_ctx)) {
2190 fprintf(stderr, "Private SSL key doesn't match cert\n");
2194 /* SSL is happy and has a cert it's content with */
2200 if (lws_b64_selftest())
2203 /* fd hashtable init */
2205 for (n = 0; n < FD_HASHTABLE_MODULUS; n++)
2206 context->fd_hashtable[n].length = 0;
2208 /* set up our external listening socket we serve on */
2212 sockfd = socket(AF_INET, SOCK_STREAM, 0);
2214 fprintf(stderr, "ERROR opening socket");
2218 /* allow us to restart even if old sockets in TIME_WAIT */
2219 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
2221 bzero((char *) &serv_addr, sizeof(serv_addr));
2222 serv_addr.sin_family = AF_INET;
2224 serv_addr.sin_addr.s_addr = INADDR_ANY;
2226 interface_to_sa(interf, &serv_addr,
2228 serv_addr.sin_port = htons(port);
2230 n = bind(sockfd, (struct sockaddr *) &serv_addr,
2233 fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
2238 wsi = malloc(sizeof(struct libwebsocket));
2239 memset(wsi, 0, sizeof (struct libwebsocket));
2241 wsi->count_active_extensions = 0;
2242 wsi->mode = LWS_CONNMODE_SERVER_LISTENER;
2243 insert_wsi(context, wsi);
2246 fprintf(stderr, " Listening on port %d\n", port);
2248 /* list in the internal poll array */
2250 context->fds[context->fds_count].fd = sockfd;
2251 context->fds[context->fds_count++].events = POLLIN;
2253 /* external POLL support via protocol 0 */
2254 context->protocols[0].callback(context, wsi,
2255 LWS_CALLBACK_ADD_POLL_FD,
2256 (void *)(long)sockfd, NULL, POLLIN);
2260 /* drop any root privs for this process */
2265 fprintf(stderr, "setgid: %s\n", strerror(errno));
2268 fprintf(stderr, "setuid: %s\n", strerror(errno));
2271 /* set up our internal broadcast trigger sockets per-protocol */
2273 for (context->count_protocols = 0;
2274 protocols[context->count_protocols].callback;
2275 context->count_protocols++) {
2276 protocols[context->count_protocols].owning_server = context;
2277 protocols[context->count_protocols].protocol_index =
2278 context->count_protocols;
2280 fd = socket(AF_INET, SOCK_STREAM, 0);
2282 fprintf(stderr, "ERROR opening socket");
2286 /* allow us to restart even if old sockets in TIME_WAIT */
2287 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
2289 bzero((char *) &serv_addr, sizeof(serv_addr));
2290 serv_addr.sin_family = AF_INET;
2291 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
2292 serv_addr.sin_port = 0; /* pick the port for us */
2294 n = bind(fd, (struct sockaddr *) &serv_addr, sizeof(serv_addr));
2296 fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
2301 slen = sizeof cli_addr;
2302 n = getsockname(fd, (struct sockaddr *)&cli_addr, &slen);
2304 fprintf(stderr, "getsockname failed\n");
2307 protocols[context->count_protocols].broadcast_socket_port =
2308 ntohs(cli_addr.sin_port);
2311 debug(" Protocol %s broadcast socket %d\n",
2312 protocols[context->count_protocols].name,
2313 ntohs(cli_addr.sin_port));
2315 /* dummy wsi per broadcast proxy socket */
2317 wsi = malloc(sizeof(struct libwebsocket));
2318 memset(wsi, 0, sizeof (struct libwebsocket));
2320 wsi->mode = LWS_CONNMODE_BROADCAST_PROXY_LISTENER;
2321 wsi->count_active_extensions = 0;
2322 /* note which protocol we are proxying */
2323 wsi->protocol_index_for_broadcast_proxy =
2324 context->count_protocols;
2325 insert_wsi(context, wsi);
2327 /* list in internal poll array */
2329 context->fds[context->fds_count].fd = fd;
2330 context->fds[context->fds_count].events = POLLIN;
2331 context->fds[context->fds_count].revents = 0;
2332 context->fds_count++;
2334 /* external POLL support via protocol 0 */
2335 context->protocols[0].callback(context, wsi,
2336 LWS_CALLBACK_ADD_POLL_FD,
2337 (void *)(long)fd, NULL, POLLIN);
2347 * libwebsockets_fork_service_loop() - Optional helper function forks off
2348 * a process for the websocket server loop.
2349 * You don't have to use this but if not, you
2350 * have to make sure you are calling
2351 * libwebsocket_service periodically to service
2352 * the websocket traffic
2353 * @context: server context returned by creation function
2357 libwebsockets_fork_service_loop(struct libwebsocket_context *context)
2360 struct sockaddr_in cli_addr;
2370 /* main process context */
2373 * set up the proxy sockets to allow broadcast from
2374 * service process context
2377 for (p = 0; p < context->count_protocols; p++) {
2378 fd = socket(AF_INET, SOCK_STREAM, 0);
2380 fprintf(stderr, "Unable to create socket\n");
2383 cli_addr.sin_family = AF_INET;
2384 cli_addr.sin_port = htons(
2385 context->protocols[p].broadcast_socket_port);
2386 cli_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
2387 n = connect(fd, (struct sockaddr *)&cli_addr,
2390 fprintf(stderr, "Unable to connect to "
2391 "broadcast socket %d, %s\n",
2392 n, strerror(errno));
2396 context->protocols[p].broadcast_socket_user_fd = fd;
2402 /* we want a SIGHUP when our parent goes down */
2403 prctl(PR_SET_PDEATHSIG, SIGHUP);
2405 /* in this forked process, sit and service websocket connections */
2408 if (libwebsocket_service(context, 1000))
2417 * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
2419 * @wsi: pointer to struct websocket you want to know the protocol of
2422 * This is useful to get the protocol to broadcast back to from inside
2426 const struct libwebsocket_protocols *
2427 libwebsockets_get_protocol(struct libwebsocket *wsi)
2429 return wsi->protocol;
2433 * libwebsockets_broadcast() - Sends a buffer to the callback for all active
2434 * connections of the given protocol.
2435 * @protocol: pointer to the protocol you will broadcast to all members of
2436 * @buf: buffer containing the data to be broadcase. NOTE: this has to be
2437 * allocated with LWS_SEND_BUFFER_PRE_PADDING valid bytes before
2438 * the pointer and LWS_SEND_BUFFER_POST_PADDING afterwards in the
2439 * case you are calling this function from callback context.
2440 * @len: length of payload data in buf, starting from buf.
2442 * This function allows bulk sending of a packet to every connection using
2443 * the given protocol. It does not send the data directly; instead it calls
2444 * the callback with a reason type of LWS_CALLBACK_BROADCAST. If the callback
2445 * wants to actually send the data for that connection, the callback itself
2446 * should call libwebsocket_write().
2448 * libwebsockets_broadcast() can be called from another fork context without
2449 * having to take any care about data visibility between the processes, it'll
2455 libwebsockets_broadcast(const struct libwebsocket_protocols *protocol,
2456 unsigned char *buf, size_t len)
2458 struct libwebsocket_context *context = protocol->owning_server;
2461 struct libwebsocket * wsi;
2463 if (!protocol->broadcast_socket_user_fd) {
2465 * We are either running unforked / flat, or we are being
2466 * called from poll thread context
2467 * eg, from a callback. In that case don't use sockets for
2468 * broadcast IPC (since we can't open a socket connection to
2469 * a socket listening on our own thread) but directly do the
2472 * Locking is not needed because we are by definition being
2473 * called in the poll thread context and are serialized.
2476 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
2478 for (m = 0; m < context->fd_hashtable[n].length; m++) {
2480 wsi = context->fd_hashtable[n].wsi[m];
2482 if (wsi->mode != LWS_CONNMODE_WS_SERVING)
2486 * never broadcast to
2487 * non-established connections
2489 if (wsi->state != WSI_STATE_ESTABLISHED)
2492 /* only broadcast to guys using
2493 * requested protocol
2495 if (wsi->protocol != protocol)
2498 wsi->protocol->callback(context, wsi,
2499 LWS_CALLBACK_BROADCAST,
2509 * We're being called from a different process context than the server
2510 * loop. Instead of broadcasting directly, we send our
2511 * payload on a socket to do the IPC; the server process will serialize
2512 * the broadcast action in its main poll() loop.
2514 * There's one broadcast socket listening for each protocol supported
2515 * set up when the websocket server initializes
2518 n = send(protocol->broadcast_socket_user_fd, buf, len, MSG_NOSIGNAL);