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"
31 #ifdef LWS_OPENSSL_SUPPORT
32 int openssl_websocket_private_data_index;
36 * In-place str to lower case
48 /* file descriptor hash management */
51 wsi_from_fd(struct libwebsocket_context *context, int fd)
53 int h = LWS_FD_HASH(fd);
56 for (n = 0; n < context->fd_hashtable[h].length; n++)
57 if (context->fd_hashtable[h].wsi[n]->sock == fd)
58 return context->fd_hashtable[h].wsi[n];
64 insert_wsi(struct libwebsocket_context *context, struct libwebsocket *wsi)
66 int h = LWS_FD_HASH(wsi->sock);
68 if (context->fd_hashtable[h].length == MAX_CLIENTS - 1) {
69 fprintf(stderr, "hash table overflow\n");
73 context->fd_hashtable[h].wsi[context->fd_hashtable[h].length++] = wsi;
79 delete_from_fd(struct libwebsocket_context *context, int fd)
81 int h = LWS_FD_HASH(fd);
84 for (n = 0; n < context->fd_hashtable[h].length; n++)
85 if (context->fd_hashtable[h].wsi[n]->sock == fd) {
86 while (n < context->fd_hashtable[h].length) {
87 context->fd_hashtable[h].wsi[n] =
88 context->fd_hashtable[h].wsi[n + 1];
91 context->fd_hashtable[h].length--;
96 fprintf(stderr, "Failed to find fd %d requested for "
97 "delete in hashtable\n", fd);
101 #ifdef LWS_OPENSSL_SUPPORT
103 libwebsockets_decode_ssl_error(void)
108 while ((err = ERR_get_error()) != 0) {
109 ERR_error_string_n(err, buf, sizeof(buf));
110 fprintf(stderr, "*** %s\n", buf);
117 interface_to_sa(const char* ifname, struct sockaddr_in *addr, size_t addrlen)
125 struct sockaddr_in *sin;
128 for (ifc = ifr; ifc != NULL; ifc = ifc->ifa_next) {
129 if (strcmp(ifc->ifa_name, ifname))
131 if (ifc->ifa_addr == NULL)
133 sin = (struct sockaddr_in *)ifc->ifa_addr;
134 if (sin->sin_family != AF_INET)
136 memcpy(addr, sin, addrlen);
146 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
147 struct libwebsocket *wsi, enum lws_close_status reason)
151 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 2 +
152 LWS_SEND_BUFFER_POST_PADDING];
155 struct lws_tokens eff_buf;
156 struct libwebsocket_extension *ext;
161 old_state = wsi->state;
163 if (old_state == WSI_STATE_DEAD_SOCKET)
166 wsi->close_reason = reason;
169 * are his extensions okay with him closing? Eg he might be a mux
170 * parent and just his ch1 aspect is closing?
174 for (n = 0; n < wsi->count_active_extensions; n++) {
175 if (!wsi->active_extensions[n]->callback)
178 m = wsi->active_extensions[n]->callback(context,
179 wsi->active_extensions[n], wsi,
180 LWS_EXT_CALLBACK_CHECK_OK_TO_REALLY_CLOSE,
181 wsi->active_extensions_user[n], NULL, 0);
184 * if somebody vetoed actually closing him at this time....
185 * up to the extension to track the attempted close, let's
190 debug("extension vetoed close\n");
198 * flush any tx pending from extensions, since we may send close packet
199 * if there are problems with send, just nuke the connection
205 /* default to nobody has more to spill */
208 eff_buf.token = NULL;
209 eff_buf.token_len = 0;
211 /* show every extension the new incoming data */
213 for (n = 0; n < wsi->count_active_extensions; n++) {
214 m = wsi->active_extensions[n]->callback(
215 wsi->protocol->owning_server,
216 wsi->active_extensions[n], wsi,
217 LWS_EXT_CALLBACK_FLUSH_PENDING_TX,
218 wsi->active_extensions_user[n], &eff_buf, 0);
220 fprintf(stderr, "Extension reports "
222 goto just_kill_connection;
226 * at least one extension told us he has more
227 * to spill, so we will go around again after
232 /* assuming they left us something to send, send it */
234 if (eff_buf.token_len)
235 if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
237 goto just_kill_connection;
241 * signal we are closing, libsocket_write will
242 * add any necessary version-specific stuff. If the write fails,
243 * no worries we are closing anyway. If we didn't initiate this
244 * close, then our state has been changed to
245 * WSI_STATE_RETURNED_CLOSE_ALREADY and we will skip this.
247 * Likewise if it's a second call to close this connection after we
248 * sent the close indication to the peer already, we are in state
249 * WSI_STATE_AWAITING_CLOSE_ACK and will skip doing this a second time.
252 if (old_state == WSI_STATE_ESTABLISHED &&
253 reason != LWS_CLOSE_STATUS_NOSTATUS) {
255 debug("sending close indication...\n");
257 n = libwebsocket_write(wsi, &buf[LWS_SEND_BUFFER_PRE_PADDING],
261 * we have sent a nice protocol level indication we
262 * now wish to close, we should not send anything more
265 wsi->state = WSI_STATE_AWAITING_CLOSE_ACK;
267 /* and we should wait for a reply for a bit */
269 libwebsocket_set_timeout(wsi,
270 PENDING_TIMEOUT_CLOSE_ACK, 5);
272 debug("sent close indication, awaiting ack\n");
277 /* else, the send failed and we should just hang up */
280 just_kill_connection:
282 debug("libwebsocket_close_and_free_session: just_kill_connection\n");
285 * we won't be servicing or receiving anything further from this guy
286 * remove this fd from wsi mapping hashtable
290 delete_from_fd(context, wsi->sock);
292 /* delete it from the internal poll list if still present */
294 for (n = 0; n < context->fds_count; n++) {
295 if (context->fds[n].fd != wsi->sock)
297 while (n < context->fds_count - 1) {
298 context->fds[n] = context->fds[n + 1];
301 context->fds_count--;
302 /* we only have to deal with one */
303 n = context->fds_count;
306 /* remove also from external POLL support via protocol 0 */
308 context->protocols[0].callback(context, wsi,
309 LWS_CALLBACK_DEL_POLL_FD, (void *)(long)wsi->sock, NULL, 0);
311 wsi->state = WSI_STATE_DEAD_SOCKET;
313 /* tell the user it's all over for this guy */
315 if (wsi->protocol && wsi->protocol->callback &&
316 ((old_state == WSI_STATE_ESTABLISHED) ||
317 (old_state == WSI_STATE_RETURNED_CLOSE_ALREADY) ||
318 (old_state == WSI_STATE_AWAITING_CLOSE_ACK))) {
319 debug("calling back CLOSED\n");
320 wsi->protocol->callback(context, wsi, LWS_CALLBACK_CLOSED,
321 wsi->user_space, NULL, 0);
323 debug("not calling back closed due to old_state=%d\n",
327 /* deallocate any active extension contexts */
329 for (n = 0; n < wsi->count_active_extensions; n++) {
330 if (!wsi->active_extensions[n]->callback)
333 wsi->active_extensions[n]->callback(context,
334 wsi->active_extensions[n], wsi,
335 LWS_EXT_CALLBACK_DESTROY,
336 wsi->active_extensions_user[n], NULL, 0);
338 free(wsi->active_extensions_user[n]);
342 * inform all extensions in case they tracked this guy out of band
343 * even though not active on him specifically
346 ext = context->extensions;
347 while (ext && ext->callback) {
348 ext->callback(context, ext, wsi,
349 LWS_EXT_CALLBACK_DESTROY_ANY_WSI_CLOSING,
354 /* free up his parsing allocations */
356 for (n = 0; n < WSI_TOKEN_COUNT; n++)
357 if (wsi->utf8_token[n].token)
358 free(wsi->utf8_token[n].token);
361 free(wsi->c_address);
363 /* fprintf(stderr, "closing fd=%d\n", wsi->sock); */
365 #ifdef LWS_OPENSSL_SUPPORT
367 n = SSL_get_fd(wsi->ssl);
368 SSL_shutdown(wsi->ssl);
377 shutdown(wsi->sock, SHUT_RDWR);
380 closesocket(wsi->sock);
385 #ifdef LWS_OPENSSL_SUPPORT
389 free(wsi->user_space);
395 * libwebsockets_hangup_on_client() - Server calls to terminate client
397 * @context: libwebsockets context
398 * @fd: Connection socket descriptor
402 libwebsockets_hangup_on_client(struct libwebsocket_context *context, int fd)
404 struct libwebsocket *wsi = wsi_from_fd(context, fd);
409 libwebsocket_close_and_free_session(context, wsi,
410 LWS_CLOSE_STATUS_NOSTATUS);
415 * libwebsockets_get_peer_addresses() - Get client address information
416 * @fd: Connection socket descriptor
417 * @name: Buffer to take client address name
418 * @name_len: Length of client address name buffer
419 * @rip: Buffer to take client address IP qotted quad
420 * @rip_len: Length of client address IP buffer
422 * This function fills in @name and @rip with the name and IP of
423 * the client connected with socket descriptor @fd. Names may be
424 * truncated if there is not enough room. If either cannot be
425 * determined, they will be returned as valid zero-length strings.
429 libwebsockets_get_peer_addresses(int fd, char *name, int name_len,
430 char *rip, int rip_len)
433 struct sockaddr_in sin;
434 struct hostent *host;
435 struct hostent *host1;
439 struct sockaddr_un *un;
445 if (getpeername(fd, (struct sockaddr *) &sin, &len) < 0) {
446 perror("getpeername");
450 host = gethostbyaddr((char *) &sin.sin_addr, sizeof sin.sin_addr,
453 perror("gethostbyaddr");
457 strncpy(name, host->h_name, name_len);
458 name[name_len - 1] = '\0';
460 host1 = gethostbyname(host->h_name);
463 p = (unsigned char *)host1;
466 p = (unsigned char *)host1->h_addr_list[n++];
469 if ((host1->h_addrtype != AF_INET)
471 && (host1->h_addrtype != AF_LOCAL)
476 if (host1->h_addrtype == AF_INET)
477 sprintf(ip, "%u.%u.%u.%u", p[0], p[1], p[2], p[3]);
480 un = (struct sockaddr_un *)p;
481 strncpy(ip, un->sun_path, sizeof(ip) -1);
482 ip[sizeof(ip) - 1] = '\0';
486 strncpy(rip, ip, rip_len);
487 rip[rip_len - 1] = '\0';
491 int libwebsockets_get_random(struct libwebsocket_context *context,
498 for (n = 0; n < len; n++)
499 p[n] = (unsigned char)rand();
501 n = read(context->fd_random, p, len);
508 libwebsockets_SHA1(const unsigned char *d, size_t n, unsigned char *md)
510 return SHA1(d, n, md);
513 void libwebsockets_00_spaceout(char *key, int spaces, int seed)
519 if (*key && (seed & 1))
523 p = key + strlen(key);
532 void libwebsockets_00_spam(char *key, int count, int seed)
539 if (*key && (seed & 1))
543 p = key + strlen(key);
548 *key++ = 0x21 + ((seed & 0xffff) % 15);
549 /* 4 would use it up too fast.. not like it matters */
554 int lws_send_pipe_choked(struct libwebsocket *wsi)
559 fds.events = POLLOUT;
562 if (poll(&fds, 1, 0) != 1)
565 if ((fds.revents & POLLOUT) == 0)
568 /* okay to send another packet without blocking */
574 lws_handle_POLLOUT_event(struct libwebsocket_context *context,
575 struct libwebsocket *wsi, struct pollfd *pollfd)
577 struct lws_tokens eff_buf;
583 for (n = 0; n < wsi->count_active_extensions; n++) {
584 if (!wsi->active_extensions[n]->callback)
587 m = wsi->active_extensions[n]->callback(context,
588 wsi->active_extensions[n], wsi,
589 LWS_EXT_CALLBACK_IS_WRITEABLE,
590 wsi->active_extensions_user[n], NULL, 0);
598 if (!wsi->extension_data_pending || handled == 2)
602 * check in on the active extensions, see if they
603 * had pending stuff to spill... they need to get the
604 * first look-in otherwise sequence will be disordered
606 * NULL, zero-length eff_buf means just spill pending
612 /* default to nobody has more to spill */
615 eff_buf.token = NULL;
616 eff_buf.token_len = 0;
618 /* give every extension a chance to spill */
620 for (n = 0; n < wsi->count_active_extensions; n++) {
621 m = wsi->active_extensions[n]->callback(
622 wsi->protocol->owning_server,
623 wsi->active_extensions[n], wsi,
624 LWS_EXT_CALLBACK_PACKET_TX_PRESEND,
625 wsi->active_extensions_user[n], &eff_buf, 0);
627 fprintf(stderr, "extension reports fatal error\n");
632 * at least one extension told us he has more
633 * to spill, so we will go around again after
638 /* assuming they gave us something to send, send it */
640 if (eff_buf.token_len) {
641 if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
647 /* no extension has more to spill */
653 * There's more to spill from an extension, but we just sent
654 * something... did that leave the pipe choked?
657 if (!lws_send_pipe_choked(wsi))
658 /* no we could add more */
661 debug("choked in POLLOUT service\n");
664 * Yes, he's choked. Leave the POLLOUT masked on so we will
665 * come back here when he is unchoked. Don't call the user
666 * callback to enforce ordering of spilling, he'll get called
667 * when we come back here and there's nothing more to spill.
673 wsi->extension_data_pending = 0;
679 pollfd->events &= ~POLLOUT;
681 /* external POLL support via protocol 0 */
682 context->protocols[0].callback(context, wsi,
683 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
684 (void *)(long)wsi->sock, NULL, POLLOUT);
689 if (wsi->mode == LWS_CONNMODE_WS_CLIENT)
690 n = LWS_CALLBACK_CLIENT_WRITEABLE;
692 n = LWS_CALLBACK_SERVER_WRITEABLE;
694 wsi->protocol->callback(context, wsi, n, wsi->user_space, NULL, 0);
702 libwebsocket_service_timeout_check(struct libwebsocket_context *context,
703 struct libwebsocket *wsi, unsigned int sec)
708 * if extensions want in on it (eg, we are a mux parent)
709 * give them a chance to service child timeouts
712 for (n = 0; n < wsi->count_active_extensions; n++)
713 wsi->active_extensions[n]->callback(
714 context, wsi->active_extensions[n],
715 wsi, LWS_EXT_CALLBACK_1HZ,
716 wsi->active_extensions_user[n], NULL, sec);
718 if (!wsi->pending_timeout)
722 * if we went beyond the allowed time, kill the
726 if (sec > wsi->pending_timeout_limit) {
727 debug("TIMEDOUT WAITING\n");
728 libwebsocket_close_and_free_session(context,
729 wsi, LWS_CLOSE_STATUS_NOSTATUS);
733 struct libwebsocket *
734 libwebsocket_create_new_server_wsi(struct libwebsocket_context *context)
736 struct libwebsocket *new_wsi;
739 new_wsi = malloc(sizeof(struct libwebsocket));
740 if (new_wsi == NULL) {
741 fprintf(stderr, "Out of memory for new connection\n");
745 memset(new_wsi, 0, sizeof (struct libwebsocket));
746 new_wsi->count_active_extensions = 0;
747 new_wsi->pending_timeout = NO_PENDING_TIMEOUT;
749 /* intialize the instance struct */
751 new_wsi->state = WSI_STATE_HTTP;
752 new_wsi->name_buffer_pos = 0;
753 new_wsi->mode = LWS_CONNMODE_WS_SERVING;
755 for (n = 0; n < WSI_TOKEN_COUNT; n++) {
756 new_wsi->utf8_token[n].token = NULL;
757 new_wsi->utf8_token[n].token_len = 0;
761 * these can only be set once the protocol is known
762 * we set an unestablished connection's protocol pointer
763 * to the start of the supported list, so it can look
764 * for matching ones during the handshake
766 new_wsi->protocol = context->protocols;
767 new_wsi->user_space = NULL;
770 * Default protocol is 76 / 00
771 * After 76, there's a header specified to inform which
772 * draft the client wants, when that's seen we modify
773 * the individual connection's spec revision accordingly
775 new_wsi->ietf_spec_revision = 0;
781 libwebsockets_generate_client_handshake(struct libwebsocket_context *context,
782 struct libwebsocket *wsi, char *pkt)
787 struct libwebsocket_extension *ext;
788 struct libwebsocket_extension *ext1;
790 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 1 + MAX_BROADCAST_PAYLOAD +
791 LWS_SEND_BUFFER_POST_PADDING];
792 static const char magic_websocket_guid[] =
793 "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
796 * create the random key
799 n = libwebsockets_get_random(context, hash, 16);
801 fprintf(stderr, "Unable to read from random dev %s\n",
802 SYSTEM_RANDOM_FILEPATH);
808 free(wsi->c_protocol);
809 libwebsocket_close_and_free_session(context, wsi,
810 LWS_CLOSE_STATUS_NOSTATUS);
814 lws_b64_encode_string(hash, 16, wsi->key_b64,
815 sizeof wsi->key_b64);
818 * 00 example client handshake
820 * GET /socket.io/websocket HTTP/1.1
822 * Connection: Upgrade
823 * Host: 127.0.0.1:9999
824 * Origin: http://127.0.0.1
825 * Sec-WebSocket-Key1: 1 0 2#0W 9 89 7 92 ^
826 * Sec-WebSocket-Key2: 7 7Y 4328 B2v[8(z1
827 * Cookie: socketio=websocket
831 * 04 example client handshake
834 * Host: server.example.com
836 * Connection: Upgrade
837 * Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
838 * Sec-WebSocket-Origin: http://example.com
839 * Sec-WebSocket-Protocol: chat, superchat
840 * Sec-WebSocket-Version: 4
843 p += sprintf(p, "GET %s HTTP/1.1\x0d\x0a", wsi->c_path);
845 if (wsi->ietf_spec_revision == 0) {
846 unsigned char spaces_1, spaces_2;
847 unsigned int max_1, max_2;
848 unsigned int num_1, num_2;
849 unsigned long product_1, product_2;
856 libwebsockets_get_random(context, &spaces_1,
858 libwebsockets_get_random(context, &spaces_2,
861 spaces_1 = (spaces_1 % 12) + 1;
862 spaces_2 = (spaces_2 % 12) + 1;
864 max_1 = 4294967295 / spaces_1;
865 max_2 = 4294967295 / spaces_2;
867 libwebsockets_get_random(context, &num_1, sizeof(int));
868 libwebsockets_get_random(context, &num_2, sizeof(int));
870 num_1 = (num_1 % max_1);
871 num_2 = (num_2 % max_2);
873 challenge[0] = num_1 >> 24;
874 challenge[1] = num_1 >> 16;
875 challenge[2] = num_1 >> 8;
876 challenge[3] = num_1;
877 challenge[4] = num_2 >> 24;
878 challenge[5] = num_2 >> 16;
879 challenge[6] = num_2 >> 8;
880 challenge[7] = num_2;
882 product_1 = num_1 * spaces_1;
883 product_2 = num_2 * spaces_2;
885 sprintf(key_1, "%lu", product_1);
886 sprintf(key_2, "%lu", product_2);
888 libwebsockets_get_random(context, &seed, sizeof(int));
889 libwebsockets_get_random(context, &count, sizeof(int));
891 libwebsockets_00_spam(key_1, (count % 12) + 1, seed);
893 libwebsockets_get_random(context, &seed, sizeof(int));
894 libwebsockets_get_random(context, &count, sizeof(int));
896 libwebsockets_00_spam(key_2, (count % 12) + 1, seed);
898 libwebsockets_get_random(context, &seed, sizeof(int));
900 libwebsockets_00_spaceout(key_1, spaces_1, seed);
901 libwebsockets_00_spaceout(key_2, spaces_2, seed >> 16);
903 p += sprintf(p, "Upgrade: WebSocket\x0d\x0a"
904 "Connection: Upgrade\x0d\x0aHost: %s\x0d\x0a",
907 p += sprintf(p, "Origin: %s\x0d\x0a",
911 p += sprintf(p, "Sec-WebSocket-Protocol: %s"
912 "\x0d\x0a", wsi->c_protocol);
914 p += sprintf(p, "Sec-WebSocket-Key1: %s\x0d\x0a",
916 p += sprintf(p, "Sec-WebSocket-Key2: %s\x0d\x0a",
919 /* give userland a chance to append, eg, cookies */
921 context->protocols[0].callback(context, wsi,
922 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER,
923 NULL, &p, (pkt + sizeof(pkt)) - p - 12);
925 p += sprintf(p, "\x0d\x0a");
927 if (libwebsockets_get_random(context, p, 8) != 8)
929 memcpy(&challenge[8], p, 8);
932 /* precompute what we want to see from the server */
934 MD5((unsigned char *)challenge, 16,
935 (unsigned char *)wsi->initial_handshake_hash_base64);
940 p += sprintf(p, "Host: %s\x0d\x0a", wsi->c_host);
941 p += sprintf(p, "Upgrade: websocket\x0d\x0a");
942 p += sprintf(p, "Connection: Upgrade\x0d\x0a"
943 "Sec-WebSocket-Key: ");
944 strcpy(p, wsi->key_b64);
945 p += strlen(wsi->key_b64);
946 p += sprintf(p, "\x0d\x0a");
948 p += sprintf(p, "Sec-WebSocket-Origin: %s\x0d\x0a",
951 p += sprintf(p, "Sec-WebSocket-Protocol: %s\x0d\x0a",
954 /* tell the server what extensions we could support */
956 p += sprintf(p, "Sec-WebSocket-Extensions: ");
958 ext =context->extensions;
959 while (ext && ext->callback) {
962 ext1 = context->extensions;
963 while (ext1 && ext1->callback) {
965 n |= ext1->callback(context, ext1, wsi,
966 LWS_EXT_CALLBACK_CHECK_OK_TO_PROPOSE_EXTENSION,
967 NULL, (char *)ext->name, 0);
974 /* an extension vetos us */
975 debug("ext %s vetoed\n", (char *)ext->name);
980 n = context->protocols[0].callback(context, wsi,
981 LWS_CALLBACK_CLIENT_CONFIRM_EXTENSION_SUPPORTED,
982 wsi->user_space, (char *)ext->name, 0);
985 * zero return from callback means
986 * go ahead and allow the extension,
987 * it's what we get if the callback is
1000 p += sprintf(p, "%s", ext->name);
1006 p += sprintf(p, "\x0d\x0a");
1008 if (wsi->ietf_spec_revision)
1009 p += sprintf(p, "Sec-WebSocket-Version: %d\x0d\x0a",
1010 wsi->ietf_spec_revision);
1012 /* give userland a chance to append, eg, cookies */
1014 context->protocols[0].callback(context, wsi,
1015 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER,
1016 NULL, &p, (pkt + sizeof(pkt)) - p - 12);
1018 p += sprintf(p, "\x0d\x0a");
1020 /* prepare the expected server accept response */
1022 strcpy((char *)buf, wsi->key_b64);
1023 strcpy((char *)&buf[strlen((char *)buf)], magic_websocket_guid);
1025 SHA1(buf, strlen((char *)buf), (unsigned char *)hash);
1027 lws_b64_encode_string(hash, 20,
1028 wsi->initial_handshake_hash_base64,
1029 sizeof wsi->initial_handshake_hash_base64);
1035 /* done with these now */
1040 free(wsi->c_origin);
1046 lws_client_interpret_server_handshake(struct libwebsocket_context *context,
1047 struct libwebsocket *wsi)
1049 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 1 + MAX_BROADCAST_PAYLOAD +
1050 LWS_SEND_BUFFER_POST_PADDING];
1058 struct libwebsocket_extension *ext;
1062 static const char magic_websocket_04_masking_guid[] =
1063 "61AC5F19-FBBA-4540-B96F-6561F1AB40A8";
1068 * HTTP/1.1 101 WebSocket Protocol Handshake
1069 * Upgrade: WebSocket
1070 * Connection: Upgrade
1071 * Sec-WebSocket-Origin: http://127.0.0.1
1072 * Sec-WebSocket-Location: ws://127.0.0.1:9999/socket.io/websocket
1077 if (wsi->ietf_spec_revision == 0) {
1078 if (!wsi->utf8_token[WSI_TOKEN_HTTP].token_len ||
1079 !wsi->utf8_token[WSI_TOKEN_UPGRADE].token_len ||
1080 !wsi->utf8_token[WSI_TOKEN_CHALLENGE].token_len ||
1081 !wsi->utf8_token[WSI_TOKEN_CONNECTION].token_len ||
1082 (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len &&
1083 wsi->c_protocol != NULL)) {
1084 debug("libwebsocket_client_handshake "
1085 "missing required header(s)\n");
1091 strtolower(wsi->utf8_token[WSI_TOKEN_HTTP].token);
1092 if (strncmp(wsi->utf8_token[WSI_TOKEN_HTTP].token,
1094 fprintf(stderr, "libwebsocket_client_handshake "
1095 "server sent bad HTTP response '%s'\n",
1096 wsi->utf8_token[WSI_TOKEN_HTTP].token);
1100 if (wsi->utf8_token[WSI_TOKEN_CHALLENGE].token_len <
1102 fprintf(stderr, "libwebsocket_client_handshake "
1103 "challenge reply too short %d\n",
1105 WSI_TOKEN_CHALLENGE].token_len);
1112 goto select_protocol;
1116 * well, what the server sent looked reasonable for syntax.
1117 * Now let's confirm it sent all the necessary headers
1120 fprintf(stderr, "WSI_TOKEN_HTTP: %d\n", wsi->utf8_token[WSI_TOKEN_HTTP].token_len);
1121 fprintf(stderr, "WSI_TOKEN_UPGRADE: %d\n", wsi->utf8_token[WSI_TOKEN_UPGRADE].token_len);
1122 fprintf(stderr, "WSI_TOKEN_CONNECTION: %d\n", wsi->utf8_token[WSI_TOKEN_CONNECTION].token_len);
1123 fprintf(stderr, "WSI_TOKEN_ACCEPT: %d\n", wsi->utf8_token[WSI_TOKEN_ACCEPT].token_len);
1124 fprintf(stderr, "WSI_TOKEN_NONCE: %d\n", wsi->utf8_token[WSI_TOKEN_NONCE].token_len);
1125 fprintf(stderr, "WSI_TOKEN_PROTOCOL: %d\n", wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len);
1127 if (!wsi->utf8_token[WSI_TOKEN_HTTP].token_len ||
1128 !wsi->utf8_token[WSI_TOKEN_UPGRADE].token_len ||
1129 !wsi->utf8_token[WSI_TOKEN_CONNECTION].token_len ||
1130 !wsi->utf8_token[WSI_TOKEN_ACCEPT].token_len ||
1131 (!wsi->utf8_token[WSI_TOKEN_NONCE].token_len &&
1132 wsi->ietf_spec_revision == 4) ||
1133 (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len &&
1134 wsi->c_protocol != NULL)) {
1135 debug("libwebsocket_client_handshake "
1136 "missing required header(s)\n");
1143 * Everything seems to be there, now take a closer look at what
1147 strtolower(wsi->utf8_token[WSI_TOKEN_HTTP].token);
1148 if (strncmp(wsi->utf8_token[WSI_TOKEN_HTTP].token, "101", 3)) {
1149 fprintf(stderr, "libwebsocket_client_handshake "
1150 "server sent bad HTTP response '%s'\n",
1151 wsi->utf8_token[WSI_TOKEN_HTTP].token);
1155 strtolower(wsi->utf8_token[WSI_TOKEN_UPGRADE].token);
1156 if (strcmp(wsi->utf8_token[WSI_TOKEN_UPGRADE].token,
1158 fprintf(stderr, "libwebsocket_client_handshake server "
1159 "sent bad Upgrade header '%s'\n",
1160 wsi->utf8_token[WSI_TOKEN_UPGRADE].token);
1164 strtolower(wsi->utf8_token[WSI_TOKEN_CONNECTION].token);
1165 if (strcmp(wsi->utf8_token[WSI_TOKEN_CONNECTION].token,
1167 fprintf(stderr, "libwebsocket_client_handshake server "
1168 "sent bad Connection hdr '%s'\n",
1169 wsi->utf8_token[WSI_TOKEN_CONNECTION].token);
1174 pc = wsi->c_protocol;
1176 fprintf(stderr, "lws_client_interpret_server_handshake: NULL c_protocol\n");
1178 debug("lws_client_interpret_server_handshake: cPprotocol='%s'\n", pc);
1181 * confirm the protocol the server wants to talk was in the list
1182 * of protocols we offered
1185 if (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len) {
1187 fprintf(stderr, "lws_client_interpret_server_handshake WSI_TOKEN_PROTOCOL is null\n");
1189 * no protocol name to work from,
1190 * default to first protocol
1192 wsi->protocol = &context->protocols[0];
1194 free(wsi->c_protocol);
1199 while (*pc && !okay) {
1201 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token,
1202 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len)) &&
1203 (pc[wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len] == ',' ||
1204 pc[wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len] == '\0')) {
1208 while (*pc && *pc != ',')
1210 while (*pc && *pc != ' ')
1214 /* done with him now */
1216 if (wsi->c_protocol)
1217 free(wsi->c_protocol);
1221 fprintf(stderr, "libwebsocket_client_handshake server "
1222 "sent bad protocol '%s'\n",
1223 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token);
1228 * identify the selected protocol struct and set it
1231 wsi->protocol = NULL;
1232 while (context->protocols[n].callback) {
1233 if (strcmp(wsi->utf8_token[WSI_TOKEN_PROTOCOL].token,
1234 context->protocols[n].name) == 0)
1235 wsi->protocol = &context->protocols[n];
1239 if (wsi->protocol == NULL) {
1240 fprintf(stderr, "libwebsocket_client_handshake server "
1241 "requested protocol '%s', which we "
1242 "said we supported but we don't!\n",
1243 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token);
1248 /* instantiate the accepted extensions */
1250 if (!wsi->utf8_token[WSI_TOKEN_EXTENSIONS].token_len) {
1251 debug("no client extenstions allowed by server \n");
1256 * break down the list of server accepted extensions
1257 * and go through matching them or identifying bogons
1260 c = wsi->utf8_token[WSI_TOKEN_EXTENSIONS].token;
1264 if (*c && (*c != ',' && *c != ' ' && *c != '\t')) {
1266 if (n < sizeof(ext_name) - 1)
1279 /* check we actually support it */
1281 debug("checking client ext %s\n", ext_name);
1284 ext = wsi->protocol->owning_server->extensions;
1285 while (ext && ext->callback) {
1287 if (strcmp(ext_name, ext->name)) {
1294 debug("instantiating client ext %s\n", ext_name);
1296 /* instantiate the extension on this conn */
1298 wsi->active_extensions_user[
1299 wsi->count_active_extensions] =
1300 malloc(ext->per_session_data_size);
1301 memset(wsi->active_extensions_user[
1302 wsi->count_active_extensions], 0,
1303 ext->per_session_data_size);
1304 wsi->active_extensions[
1305 wsi->count_active_extensions] = ext;
1307 /* allow him to construct his context */
1309 ext->callback(wsi->protocol->owning_server,
1311 LWS_EXT_CALLBACK_CLIENT_CONSTRUCT,
1312 wsi->active_extensions_user[
1313 wsi->count_active_extensions],
1316 wsi->count_active_extensions++;
1322 fprintf(stderr, "Server said we should use"
1323 "an unknown extension '%s'!\n", ext_name);
1333 if (wsi->ietf_spec_revision == 0) {
1335 if (memcmp(wsi->initial_handshake_hash_base64,
1336 wsi->utf8_token[WSI_TOKEN_CHALLENGE].token, 16)) {
1337 fprintf(stderr, "libwebsocket_client_handshake "
1338 "failed 00 challenge compare\n");
1340 fprintf(stderr, "%s", pkt);
1348 * Confirm his accept token is the one we precomputed
1351 if (strcmp(wsi->utf8_token[WSI_TOKEN_ACCEPT].token,
1352 wsi->initial_handshake_hash_base64)) {
1353 fprintf(stderr, "libwebsocket_client_handshake server "
1354 "sent bad ACCEPT '%s' vs computed '%s'\n",
1355 wsi->utf8_token[WSI_TOKEN_ACCEPT].token,
1356 wsi->initial_handshake_hash_base64);
1360 if (wsi->ietf_spec_revision == 4) {
1362 * Calculate the 04 masking key to use when
1363 * sending data to server
1366 strcpy((char *)buf, wsi->key_b64);
1367 p = (char *)buf + strlen(wsi->key_b64);
1368 strcpy(p, wsi->utf8_token[WSI_TOKEN_NONCE].token);
1369 p += wsi->utf8_token[WSI_TOKEN_NONCE].token_len;
1370 strcpy(p, magic_websocket_04_masking_guid);
1371 SHA1(buf, strlen((char *)buf), wsi->masking_key_04);
1375 /* allocate the per-connection user memory (if any) */
1376 if (wsi->protocol->per_session_data_size && !libwebsocket_ensure_user_space(wsi))
1379 /* clear his proxy connection timeout */
1381 libwebsocket_set_timeout(wsi, NO_PENDING_TIMEOUT, 0);
1383 /* mark him as being alive */
1385 wsi->state = WSI_STATE_ESTABLISHED;
1386 wsi->mode = LWS_CONNMODE_WS_CLIENT;
1388 fprintf(stderr, "handshake OK for protocol %s\n",
1389 wsi->protocol->name);
1391 /* call him back to inform him he is up */
1393 wsi->protocol->callback(context, wsi,
1394 LWS_CALLBACK_CLIENT_ESTABLISHED,
1399 * inform all extensions, not just active ones since they
1403 ext = context->extensions;
1405 while (ext && ext->callback) {
1407 for (n = 0; n < wsi->count_active_extensions; n++)
1408 if (wsi->active_extensions[n] == ext)
1409 v = wsi->active_extensions_user[n];
1411 ext->callback(context, ext, wsi,
1412 LWS_EXT_CALLBACK_ANY_WSI_ESTABLISHED, v, NULL, 0);
1419 if (wsi->c_protocol)
1420 free(wsi->c_protocol);
1423 libwebsocket_close_and_free_session(context, wsi,
1424 LWS_CLOSE_STATUS_NOSTATUS);
1431 * libwebsocket_service_fd() - Service polled socket with something waiting
1432 * @context: Websocket context
1433 * @pollfd: The pollfd entry describing the socket fd and which events
1436 * This function closes any active connections and then frees the
1437 * context. After calling this, any further use of the context is
1442 libwebsocket_service_fd(struct libwebsocket_context *context,
1443 struct pollfd *pollfd)
1445 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 1 + MAX_BROADCAST_PAYLOAD +
1446 LWS_SEND_BUFFER_POST_PADDING];
1447 struct libwebsocket *wsi;
1448 struct libwebsocket *new_wsi;
1453 unsigned int clilen;
1454 struct sockaddr_in cli_addr;
1459 struct lws_tokens eff_buf;
1463 #ifdef LWS_OPENSSL_SUPPORT
1464 char ssl_err_buf[512];
1467 * you can call us with pollfd = NULL to just allow the once-per-second
1468 * global timeout checks; if less than a second since the last check
1469 * it returns immediately then.
1472 gettimeofday(&tv, NULL);
1474 if (context->last_timeout_check_s != tv.tv_sec) {
1475 context->last_timeout_check_s = tv.tv_sec;
1477 /* global timeout check once per second */
1479 for (n = 0; n < context->fds_count; n++) {
1480 wsi = wsi_from_fd(context, context->fds[n].fd);
1482 libwebsocket_service_timeout_check(context, wsi,
1487 /* just here for timeout management? */
1492 /* no, here to service a socket descriptor */
1494 wsi = wsi_from_fd(context, pollfd->fd);
1499 switch (wsi->mode) {
1500 case LWS_CONNMODE_SERVER_LISTENER:
1502 /* pollin means a client has connected to us then */
1504 if (!pollfd->revents & POLLIN)
1507 if (context->fds_count >= MAX_CLIENTS) {
1508 fprintf(stderr, "too busy to accept new client\n");
1512 /* listen socket got an unencrypted connection... */
1514 clilen = sizeof(cli_addr);
1515 accept_fd = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
1517 if (accept_fd < 0) {
1518 fprintf(stderr, "ERROR on accept");
1524 setsockopt(accept_fd, IPPROTO_TCP, TCP_NODELAY, (const void *)&opt,
1528 * look at who we connected to and give user code a chance
1529 * to reject based on client IP. There's no protocol selected
1530 * yet so we issue this to protocols[0]
1533 if ((context->protocols[0].callback)(context, wsi,
1534 LWS_CALLBACK_FILTER_NETWORK_CONNECTION,
1535 (void*)(long)accept_fd, NULL, 0)) {
1536 debug("Callback denied network connection\n");
1538 closesocket(accept_fd);
1545 /* accepting connection to main listener */
1547 new_wsi = libwebsocket_create_new_server_wsi(context);
1548 if (new_wsi == NULL)
1551 new_wsi->sock = accept_fd;
1554 #ifdef LWS_OPENSSL_SUPPORT
1555 new_wsi->ssl = NULL;
1557 if (context->use_ssl) {
1559 new_wsi->ssl = SSL_new(context->ssl_ctx);
1560 if (new_wsi->ssl == NULL) {
1561 fprintf(stderr, "SSL_new failed: %s\n",
1562 ERR_error_string(SSL_get_error(
1563 new_wsi->ssl, 0), NULL));
1564 libwebsockets_decode_ssl_error();
1569 SSL_set_fd(new_wsi->ssl, accept_fd);
1571 n = SSL_accept(new_wsi->ssl);
1574 * browsers seem to probe with various
1575 * ssl params which fail then retry
1578 debug("SSL_accept failed skt %u: %s\n",
1580 ERR_error_string(SSL_get_error(
1581 new_wsi->ssl, n), NULL));
1588 debug("accepted new SSL conn "
1589 "port %u on fd=%d SSL ver %s\n",
1590 ntohs(cli_addr.sin_port), accept_fd,
1591 SSL_get_version(new_wsi->ssl));
1595 debug("accepted new conn port %u on fd=%d\n",
1596 ntohs(cli_addr.sin_port), accept_fd);
1598 insert_wsi(context, new_wsi);
1601 * make sure NO events are seen yet on this new socket
1602 * (otherwise we inherit old fds[client].revents from
1603 * previous socket there and die mysteriously! )
1605 context->fds[context->fds_count].revents = 0;
1607 context->fds[context->fds_count].events = POLLIN;
1608 context->fds[context->fds_count++].fd = accept_fd;
1610 /* external POLL support via protocol 0 */
1611 context->protocols[0].callback(context, new_wsi,
1612 LWS_CALLBACK_ADD_POLL_FD,
1613 (void *)(long)accept_fd, NULL, POLLIN);
1617 case LWS_CONNMODE_BROADCAST_PROXY_LISTENER:
1619 /* as we are listening, POLLIN means accept() is needed */
1621 if (!pollfd->revents & POLLIN)
1624 /* listen socket got an unencrypted connection... */
1626 clilen = sizeof(cli_addr);
1627 accept_fd = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
1629 if (accept_fd < 0) {
1630 fprintf(stderr, "ERROR on accept");
1634 if (context->fds_count >= MAX_CLIENTS) {
1635 fprintf(stderr, "too busy to accept new broadcast "
1638 closesocket(accept_fd);
1645 /* create a dummy wsi for the connection and add it */
1647 new_wsi = malloc(sizeof(struct libwebsocket));
1648 memset(new_wsi, 0, sizeof (struct libwebsocket));
1649 new_wsi->sock = accept_fd;
1650 new_wsi->mode = LWS_CONNMODE_BROADCAST_PROXY;
1651 new_wsi->state = WSI_STATE_ESTABLISHED;
1652 new_wsi->count_active_extensions = 0;
1653 /* note which protocol we are proxying */
1654 new_wsi->protocol_index_for_broadcast_proxy =
1655 wsi->protocol_index_for_broadcast_proxy;
1656 insert_wsi(context, new_wsi);
1658 /* add connected socket to internal poll array */
1660 context->fds[context->fds_count].revents = 0;
1661 context->fds[context->fds_count].events = POLLIN;
1662 context->fds[context->fds_count++].fd = accept_fd;
1664 /* external POLL support via protocol 0 */
1665 context->protocols[0].callback(context, new_wsi,
1666 LWS_CALLBACK_ADD_POLL_FD,
1667 (void *)(long)accept_fd, NULL, POLLIN);
1671 case LWS_CONNMODE_BROADCAST_PROXY:
1673 /* handle session socket closed */
1675 if (pollfd->revents & (POLLERR | POLLHUP)) {
1677 debug("Session Socket %p (fd=%d) dead\n",
1678 (void *)wsi, pollfd->fd);
1680 libwebsocket_close_and_free_session(context, wsi,
1681 LWS_CLOSE_STATUS_NORMAL);
1686 * either extension code with stuff to spill, or the user code,
1687 * requested a callback when it was OK to write
1690 if (pollfd->revents & POLLOUT)
1691 if (lws_handle_POLLOUT_event(context, wsi, pollfd) < 0) {
1692 libwebsocket_close_and_free_session(context, wsi,
1693 LWS_CLOSE_STATUS_NORMAL);
1697 /* any incoming data ready? */
1699 if (!(pollfd->revents & POLLIN))
1702 /* get the issued broadcast payload from the socket */
1704 len = read(pollfd->fd, buf + LWS_SEND_BUFFER_PRE_PADDING,
1705 MAX_BROADCAST_PAYLOAD);
1707 fprintf(stderr, "Error reading broadcast payload\n");
1711 /* broadcast it to all guys with this protocol index */
1713 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
1715 for (m = 0; m < context->fd_hashtable[n].length; m++) {
1717 new_wsi = context->fd_hashtable[n].wsi[m];
1719 /* only to clients we are serving to */
1721 if (new_wsi->mode != LWS_CONNMODE_WS_SERVING)
1725 * never broadcast to non-established
1729 if (new_wsi->state != WSI_STATE_ESTABLISHED)
1733 * only broadcast to connections using
1734 * the requested protocol
1737 if (new_wsi->protocol->protocol_index !=
1738 wsi->protocol_index_for_broadcast_proxy)
1741 /* broadcast it to this connection */
1743 new_wsi->protocol->callback(context, new_wsi,
1744 LWS_CALLBACK_BROADCAST,
1745 new_wsi->user_space,
1746 buf + LWS_SEND_BUFFER_PRE_PADDING, len);
1751 case LWS_CONNMODE_WS_CLIENT_WAITING_PROXY_REPLY:
1753 /* handle proxy hung up on us */
1755 if (pollfd->revents & (POLLERR | POLLHUP)) {
1757 fprintf(stderr, "Proxy connection %p (fd=%d) dead\n",
1758 (void *)wsi, pollfd->fd);
1760 libwebsocket_close_and_free_session(context, wsi,
1761 LWS_CLOSE_STATUS_NOSTATUS);
1765 n = recv(wsi->sock, pkt, sizeof pkt, 0);
1767 libwebsocket_close_and_free_session(context, wsi,
1768 LWS_CLOSE_STATUS_NOSTATUS);
1769 fprintf(stderr, "ERROR reading from proxy socket\n");
1774 if (strcmp(pkt, "HTTP/1.0 200 ") != 0) {
1775 libwebsocket_close_and_free_session(context, wsi,
1776 LWS_CLOSE_STATUS_NOSTATUS);
1777 fprintf(stderr, "ERROR from proxy: %s\n", pkt);
1781 /* clear his proxy connection timeout */
1783 libwebsocket_set_timeout(wsi, NO_PENDING_TIMEOUT, 0);
1787 case LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE:
1789 #ifdef LWS_OPENSSL_SUPPORT
1792 wsi->ssl = SSL_new(context->ssl_client_ctx);
1793 wsi->client_bio = BIO_new_socket(wsi->sock,
1795 SSL_set_bio(wsi->ssl, wsi->client_bio, wsi->client_bio);
1797 SSL_set_ex_data(wsi->ssl,
1798 openssl_websocket_private_data_index,
1801 if (SSL_connect(wsi->ssl) <= 0) {
1802 fprintf(stderr, "SSL connect error %s\n",
1803 ERR_error_string(ERR_get_error(),
1805 libwebsocket_close_and_free_session(context, wsi,
1806 LWS_CLOSE_STATUS_NOSTATUS);
1810 n = SSL_get_verify_result(wsi->ssl);
1811 if ((n != X509_V_OK) && (
1812 n != X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT ||
1813 wsi->use_ssl != 2)) {
1815 fprintf(stderr, "server's cert didn't "
1816 "look good %d\n", n);
1817 libwebsocket_close_and_free_session(context,
1818 wsi, LWS_CLOSE_STATUS_NOSTATUS);
1826 #ifdef LWS_OPENSSL_SUPPORT
1830 p = libwebsockets_generate_client_handshake(context, wsi, p);
1834 /* send our request to the server */
1836 #ifdef LWS_OPENSSL_SUPPORT
1838 n = SSL_write(wsi->ssl, pkt, p - pkt);
1841 n = send(wsi->sock, pkt, p - pkt, 0);
1844 fprintf(stderr, "ERROR writing to client socket\n");
1845 libwebsocket_close_and_free_session(context, wsi,
1846 LWS_CLOSE_STATUS_NOSTATUS);
1850 wsi->parser_state = WSI_TOKEN_NAME_PART;
1851 wsi->mode = LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY;
1852 libwebsocket_set_timeout(wsi,
1853 PENDING_TIMEOUT_AWAITING_SERVER_RESPONSE, 5);
1857 case LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY:
1859 /* handle server hung up on us */
1861 if (pollfd->revents & (POLLERR | POLLHUP)) {
1863 fprintf(stderr, "Server connection %p (fd=%d) dead\n",
1864 (void *)wsi, pollfd->fd);
1870 /* interpret the server response */
1873 * HTTP/1.1 101 Switching Protocols
1874 * Upgrade: websocket
1875 * Connection: Upgrade
1876 * Sec-WebSocket-Accept: me89jWimTRKTWwrS3aRrL53YZSo=
1877 * Sec-WebSocket-Nonce: AQIDBAUGBwgJCgsMDQ4PEC==
1878 * Sec-WebSocket-Protocol: chat
1882 * we have to take some care here to only take from the
1883 * socket bytewise. The browser may (and has been seen to
1884 * in the case that onopen() performs websocket traffic)
1885 * coalesce both handshake response and websocket traffic
1886 * in one packet, since at that point the connection is
1887 * definitively ready from browser pov.
1891 while (wsi->parser_state != WSI_PARSING_COMPLETE && len > 0) {
1892 #ifdef LWS_OPENSSL_SUPPORT
1894 len = SSL_read(wsi->ssl, &c, 1);
1897 len = recv(wsi->sock, &c, 1, 0);
1899 libwebsocket_parse(wsi, c);
1903 * hs may also be coming in multiple packets, there is a 5-second
1904 * libwebsocket timeout still active here too, so if parsing did
1905 * not complete just wait for next packet coming in this state
1908 if (wsi->parser_state != WSI_PARSING_COMPLETE)
1912 * otherwise deal with the handshake. If there's any
1913 * packet traffic already arrived we'll trigger poll() again
1914 * right away and deal with it that way
1917 return lws_client_interpret_server_handshake(context, wsi);
1920 if (wsi->c_protocol)
1921 free(wsi->c_protocol);
1922 libwebsocket_close_and_free_session(context, wsi,
1923 LWS_CLOSE_STATUS_NOSTATUS);
1926 case LWS_CONNMODE_WS_CLIENT_WAITING_EXTENSION_CONNECT:
1927 fprintf(stderr, "LWS_CONNMODE_WS_CLIENT_WAITING_EXTENSION_CONNECT\n");
1930 case LWS_CONNMODE_WS_CLIENT_PENDING_CANDIDATE_CHILD:
1931 fprintf(stderr, "LWS_CONNMODE_WS_CLIENT_PENDING_CANDIDATE_CHILD\n");
1935 case LWS_CONNMODE_WS_SERVING:
1936 case LWS_CONNMODE_WS_CLIENT:
1938 /* handle session socket closed */
1940 if (pollfd->revents & (POLLERR | POLLHUP)) {
1942 fprintf(stderr, "Session Socket %p (fd=%d) dead\n",
1943 (void *)wsi, pollfd->fd);
1945 libwebsocket_close_and_free_session(context, wsi,
1946 LWS_CLOSE_STATUS_NOSTATUS);
1950 /* the guy requested a callback when it was OK to write */
1952 if ((pollfd->revents & POLLOUT) &&
1953 wsi->state == WSI_STATE_ESTABLISHED)
1954 if (lws_handle_POLLOUT_event(context, wsi,
1956 libwebsocket_close_and_free_session(
1957 context, wsi, LWS_CLOSE_STATUS_NORMAL);
1962 /* any incoming data ready? */
1964 if (!(pollfd->revents & POLLIN))
1967 #ifdef LWS_OPENSSL_SUPPORT
1969 eff_buf.token_len = SSL_read(wsi->ssl, buf, sizeof buf);
1973 recv(pollfd->fd, buf, sizeof buf, 0);
1975 if (eff_buf.token_len < 0) {
1976 fprintf(stderr, "Socket read returned %d\n",
1979 libwebsocket_close_and_free_session(context, wsi,
1980 LWS_CLOSE_STATUS_NOSTATUS);
1983 if (!eff_buf.token_len) {
1984 libwebsocket_close_and_free_session(context, wsi,
1985 LWS_CLOSE_STATUS_NOSTATUS);
1990 * give any active extensions a chance to munge the buffer
1991 * before parse. We pass in a pointer to an lws_tokens struct
1992 * prepared with the default buffer and content length that's in
1993 * there. Rather than rewrite the default buffer, extensions
1994 * that expect to grow the buffer can adapt .token to
1995 * point to their own per-connection buffer in the extension
1996 * user allocation. By default with no extensions or no
1997 * extension callback handling, just the normal input buffer is
1998 * used then so it is efficient.
2001 eff_buf.token = (char *)buf;
2008 for (n = 0; n < wsi->count_active_extensions; n++) {
2009 m = wsi->active_extensions[n]->callback(context,
2010 wsi->active_extensions[n], wsi,
2011 LWS_EXT_CALLBACK_PACKET_RX_PREPARSE,
2012 wsi->active_extensions_user[n],
2015 fprintf(stderr, "Extension reports fatal error\n");
2016 libwebsocket_close_and_free_session(context, wsi,
2017 LWS_CLOSE_STATUS_NOSTATUS);
2024 /* service incoming data */
2026 if (eff_buf.token_len) {
2027 n = libwebsocket_read(context, wsi,
2028 (unsigned char *)eff_buf.token, eff_buf.token_len);
2034 eff_buf.token = NULL;
2035 eff_buf.token_len = 0;
2045 * libwebsocket_context_destroy() - Destroy the websocket context
2046 * @context: Websocket context
2048 * This function closes any active connections and then frees the
2049 * context. After calling this, any further use of the context is
2053 libwebsocket_context_destroy(struct libwebsocket_context *context)
2057 struct libwebsocket *wsi;
2058 struct libwebsocket_extension *ext;
2060 for (n = 0; n < FD_HASHTABLE_MODULUS; n++)
2061 for (m = 0; m < context->fd_hashtable[n].length; m++) {
2062 wsi = context->fd_hashtable[n].wsi[m];
2063 libwebsocket_close_and_free_session(context, wsi,
2064 LWS_CLOSE_STATUS_GOINGAWAY);
2068 * give all extensions a chance to clean up any per-context
2069 * allocations they might have made
2072 ext = context->extensions;
2073 m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_DESTRUCT;
2074 if (context->listen_port)
2075 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_DESTRUCT;
2076 while (ext->callback) {
2077 ext->callback(context, ext, NULL, m, NULL, NULL, 0);
2083 close(context->fd_random);
2086 #ifdef LWS_OPENSSL_SUPPORT
2087 if (context->ssl_ctx)
2088 SSL_CTX_free(context->ssl_ctx);
2089 if (context->ssl_client_ctx)
2090 SSL_CTX_free(context->ssl_client_ctx);
2101 * libwebsocket_service() - Service any pending websocket activity
2102 * @context: Websocket context
2103 * @timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
2104 * service otherwise block and service immediately, returning
2105 * after the timeout if nothing needed service.
2107 * This function deals with any pending websocket traffic, for three
2108 * kinds of event. It handles these events on both server and client
2109 * types of connection the same.
2111 * 1) Accept new connections to our context's server
2113 * 2) Perform pending broadcast writes initiated from other forked
2114 * processes (effectively serializing asynchronous broadcasts)
2116 * 3) Call the receive callback for incoming frame data received by
2117 * server or client connections.
2119 * You need to call this service function periodically to all the above
2120 * functions to happen; if your application is single-threaded you can
2121 * just call it in your main event loop.
2123 * Alternatively you can fork a new process that asynchronously handles
2124 * calling this service in a loop. In that case you are happy if this
2125 * call blocks your thread until it needs to take care of something and
2126 * would call it with a large nonzero timeout. Your loop then takes no
2127 * CPU while there is nothing happening.
2129 * If you are calling it in a single-threaded app, you don't want it to
2130 * wait around blocking other things in your loop from happening, so you
2131 * would call it with a timeout_ms of 0, so it returns immediately if
2132 * nothing is pending, or as soon as it services whatever was pending.
2137 libwebsocket_service(struct libwebsocket_context *context, int timeout_ms)
2141 /* stay dead once we are dead */
2143 if (context == NULL)
2146 /* wait for something to need service */
2148 n = poll(context->fds, context->fds_count, timeout_ms);
2149 if (n == 0) /* poll timeout */
2154 fprintf(stderr, "Listen Socket dead\n");
2159 /* handle accept on listening socket? */
2161 for (n = 0; n < context->fds_count; n++)
2162 if (context->fds[n].revents)
2163 libwebsocket_service_fd(context, &context->fds[n]);
2169 lws_any_extension_handled(struct libwebsocket_context *context,
2170 struct libwebsocket *wsi,
2171 enum libwebsocket_extension_callback_reasons r,
2172 void *v, size_t len)
2177 /* maybe an extension will take care of it for us */
2179 for (n = 0; n < wsi->count_active_extensions && !handled; n++) {
2180 if (!wsi->active_extensions[n]->callback)
2183 handled |= wsi->active_extensions[n]->callback(context,
2184 wsi->active_extensions[n], wsi,
2185 r, wsi->active_extensions_user[n], v, len);
2193 lws_get_extension_user_matching_ext(struct libwebsocket *wsi,
2194 struct libwebsocket_extension * ext)
2201 while (n < wsi->count_active_extensions) {
2202 if (wsi->active_extensions[n] != ext) {
2206 return wsi->active_extensions_user[n];
2213 * libwebsocket_callback_on_writable() - Request a callback when this socket
2214 * becomes able to be written to without
2217 * @context: libwebsockets context
2218 * @wsi: Websocket connection instance to get callback for
2222 libwebsocket_callback_on_writable(struct libwebsocket_context *context,
2223 struct libwebsocket *wsi)
2228 /* maybe an extension will take care of it for us */
2230 for (n = 0; n < wsi->count_active_extensions; n++) {
2231 if (!wsi->active_extensions[n]->callback)
2234 handled |= wsi->active_extensions[n]->callback(context,
2235 wsi->active_extensions[n], wsi,
2236 LWS_EXT_CALLBACK_REQUEST_ON_WRITEABLE,
2237 wsi->active_extensions_user[n], NULL, 0);
2243 for (n = 0; n < context->fds_count; n++)
2244 if (context->fds[n].fd == wsi->sock) {
2245 context->fds[n].events |= POLLOUT;
2246 n = context->fds_count + 1;
2249 if (n == context->fds_count)
2250 fprintf(stderr, "libwebsocket_callback_on_writable: failed to find socket %d\n", wsi->sock);
2252 /* external POLL support via protocol 0 */
2253 context->protocols[0].callback(context, wsi,
2254 LWS_CALLBACK_SET_MODE_POLL_FD,
2255 (void *)(long)wsi->sock, NULL, POLLOUT);
2261 * libwebsocket_callback_on_writable_all_protocol() - Request a callback for
2262 * all connections using the given protocol when it
2263 * becomes possible to write to each socket without
2266 * @protocol: Protocol whose connections will get callbacks
2270 libwebsocket_callback_on_writable_all_protocol(
2271 const struct libwebsocket_protocols *protocol)
2273 struct libwebsocket_context *context = protocol->owning_server;
2276 struct libwebsocket *wsi;
2278 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
2280 for (m = 0; m < context->fd_hashtable[n].length; m++) {
2282 wsi = context->fd_hashtable[n].wsi[m];
2284 if (wsi->protocol == protocol)
2285 libwebsocket_callback_on_writable(context, wsi);
2293 * libwebsocket_set_timeout() - marks the wsi as subject to a timeout
2295 * You will not need this unless you are doing something special
2297 * @wsi: Websocket connection instance
2298 * @reason: timeout reason
2299 * @secs: how many seconds
2303 libwebsocket_set_timeout(struct libwebsocket *wsi,
2304 enum pending_timeout reason, int secs)
2308 gettimeofday(&tv, NULL);
2310 wsi->pending_timeout_limit = tv.tv_sec + secs;
2311 wsi->pending_timeout = reason;
2316 * libwebsocket_get_socket_fd() - returns the socket file descriptor
2318 * You will not need this unless you are doing something special
2320 * @wsi: Websocket connection instance
2324 libwebsocket_get_socket_fd(struct libwebsocket *wsi)
2330 * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
2331 * receieved packets.
2333 * If the output side of a server process becomes choked, this allows flow
2334 * control for the input side.
2336 * @wsi: Websocket connection instance to get callback for
2337 * @enable: 0 = disable read servicing for this connection, 1 = enable
2341 libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
2343 struct libwebsocket_context *context = wsi->protocol->owning_server;
2346 for (n = 0; n < context->fds_count; n++)
2347 if (context->fds[n].fd == wsi->sock) {
2349 context->fds[n].events |= POLLIN;
2351 context->fds[n].events &= ~POLLIN;
2357 /* external POLL support via protocol 0 */
2358 context->protocols[0].callback(context, wsi,
2359 LWS_CALLBACK_SET_MODE_POLL_FD,
2360 (void *)(long)wsi->sock, NULL, POLLIN);
2362 /* external POLL support via protocol 0 */
2363 context->protocols[0].callback(context, wsi,
2364 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
2365 (void *)(long)wsi->sock, NULL, POLLIN);
2368 fprintf(stderr, "libwebsocket_rx_flow_control "
2369 "unable to find socket\n");
2375 * libwebsocket_canonical_hostname() - returns this host's hostname
2377 * This is typically used by client code to fill in the host parameter
2378 * when making a client connection. You can only call it after the context
2381 * @context: Websocket context
2386 libwebsocket_canonical_hostname(struct libwebsocket_context *context)
2388 return (const char *)context->canonical_hostname;
2392 static void sigpipe_handler(int x)
2396 #ifdef LWS_OPENSSL_SUPPORT
2398 OpenSSL_verify_callback(int preverify_ok, X509_STORE_CTX *x509_ctx)
2403 struct libwebsocket_context *context;
2405 ssl = X509_STORE_CTX_get_ex_data(x509_ctx,
2406 SSL_get_ex_data_X509_STORE_CTX_idx());
2409 * !!! nasty openssl requires the index to come as a library-scope
2412 context = SSL_get_ex_data(ssl, openssl_websocket_private_data_index);
2414 n = context->protocols[0].callback(NULL, NULL,
2415 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION,
2416 x509_ctx, ssl, preverify_ok);
2418 /* convert return code from 0 = OK to 1 = OK */
2431 * libwebsocket_create_context() - Create the websocket handler
2432 * @port: Port to listen on... you can use 0 to suppress listening on
2433 * any port, that's what you want if you are not running a
2434 * websocket server at all but just using it as a client
2435 * @interf: NULL to bind the listen socket to all interfaces, or the
2436 * interface name, eg, "eth2"
2437 * @protocols: Array of structures listing supported protocols and a protocol-
2438 * specific callback for each one. The list is ended with an
2439 * entry that has a NULL callback pointer.
2440 * It's not const because we write the owning_server member
2441 * @extensions: NULL or array of libwebsocket_extension structs listing the
2442 * extensions this context supports
2443 * @ssl_cert_filepath: If libwebsockets was compiled to use ssl, and you want
2444 * to listen using SSL, set to the filepath to fetch the
2445 * server cert from, otherwise NULL for unencrypted
2446 * @ssl_private_key_filepath: filepath to private key if wanting SSL mode,
2448 * @gid: group id to change to after setting listen socket, or -1.
2449 * @uid: user id to change to after setting listen socket, or -1.
2450 * @options: 0, or LWS_SERVER_OPTION_DEFEAT_CLIENT_MASK
2452 * This function creates the listening socket and takes care
2453 * of all initialization in one step.
2455 * After initialization, it returns a struct libwebsocket_context * that
2456 * represents this server. After calling, user code needs to take care
2457 * of calling libwebsocket_service() with the context pointer to get the
2458 * server's sockets serviced. This can be done in the same process context
2459 * or a forked process, or another thread,
2461 * The protocol callback functions are called for a handful of events
2462 * including http requests coming in, websocket connections becoming
2463 * established, and data arriving; it's also called periodically to allow
2464 * async transmission.
2466 * HTTP requests are sent always to the FIRST protocol in @protocol, since
2467 * at that time websocket protocol has not been negotiated. Other
2468 * protocols after the first one never see any HTTP callack activity.
2470 * The server created is a simple http server by default; part of the
2471 * websocket standard is upgrading this http connection to a websocket one.
2473 * This allows the same server to provide files like scripts and favicon /
2474 * images or whatever over http and dynamic data over websockets all in
2475 * one place; they're all handled in the user callback.
2478 struct libwebsocket_context *
2479 libwebsocket_create_context(int port, const char *interf,
2480 struct libwebsocket_protocols *protocols,
2481 struct libwebsocket_extension *extensions,
2482 const char *ssl_cert_filepath,
2483 const char *ssl_private_key_filepath,
2484 int gid, int uid, unsigned int options)
2490 struct sockaddr_in serv_addr, cli_addr;
2492 struct libwebsocket_context *context = NULL;
2495 char hostname[1024];
2497 struct libwebsocket *wsi;
2499 #ifdef LWS_OPENSSL_SUPPORT
2501 char ssl_err_buf[512];
2506 WORD wVersionRequested;
2511 /* Use the MAKEWORD(lowbyte, highbyte) macro from Windef.h */
2512 wVersionRequested = MAKEWORD(2, 2);
2514 err = WSAStartup(wVersionRequested, &wsaData);
2516 /* Tell the user that we could not find a usable */
2518 fprintf(stderr, "WSAStartup failed with error: %d\n",
2523 wsdll = GetModuleHandle("Ws2_32.dll");
2526 poll = (PFNWSAPOLL)GetProcAddress(wsdll, "WSAPoll");
2531 poll = emulated_poll;
2537 context = malloc(sizeof(struct libwebsocket_context));
2539 fprintf(stderr, "No memory for websocket context\n");
2542 context->protocols = protocols;
2543 context->listen_port = port;
2544 context->http_proxy_port = 0;
2545 context->http_proxy_address[0] = '\0';
2546 context->options = options;
2547 context->fds_count = 0;
2548 context->extensions = extensions;
2551 context->fd_random = 0;
2553 context->fd_random = open(SYSTEM_RANDOM_FILEPATH, O_RDONLY);
2554 if (context->fd_random < 0) {
2555 fprintf(stderr, "Unable to open random device %s %d\n",
2556 SYSTEM_RANDOM_FILEPATH, context->fd_random);
2561 #ifdef LWS_OPENSSL_SUPPORT
2562 context->use_ssl = 0;
2563 context->ssl_ctx = NULL;
2564 context->ssl_client_ctx = NULL;
2565 openssl_websocket_private_data_index = 0;
2567 /* find canonical hostname */
2569 hostname[(sizeof hostname) - 1] = '\0';
2570 gethostname(hostname, (sizeof hostname) - 1);
2571 he = gethostbyname(hostname);
2573 strncpy(context->canonical_hostname, he->h_name,
2574 sizeof context->canonical_hostname - 1);
2575 context->canonical_hostname[
2576 sizeof context->canonical_hostname - 1] = '\0';
2578 strncpy(context->canonical_hostname, hostname,
2579 sizeof context->canonical_hostname - 1);
2581 /* split the proxy ads:port if given */
2583 p = getenv("http_proxy");
2585 strncpy(context->http_proxy_address, p,
2586 sizeof context->http_proxy_address - 1);
2587 context->http_proxy_address[
2588 sizeof context->http_proxy_address - 1] = '\0';
2590 p = strchr(context->http_proxy_address, ':');
2592 fprintf(stderr, "http_proxy needs to be ads:port\n");
2596 context->http_proxy_port = atoi(p + 1);
2598 fprintf(stderr, "Using proxy %s:%u\n",
2599 context->http_proxy_address,
2600 context->http_proxy_port);
2605 #ifdef LWS_OPENSSL_SUPPORT
2606 context->use_ssl = ssl_cert_filepath != NULL &&
2607 ssl_private_key_filepath != NULL;
2608 if (context->use_ssl)
2609 fprintf(stderr, " Compiled with SSL support, "
2612 fprintf(stderr, " Compiled with SSL support, "
2616 if (ssl_cert_filepath != NULL &&
2617 ssl_private_key_filepath != NULL) {
2618 fprintf(stderr, " Not compiled for OpenSSl support!\n");
2621 fprintf(stderr, " Compiled without SSL support, "
2622 "serving unencrypted\n");
2626 /* ignore SIGPIPE */
2629 signal(SIGPIPE, sigpipe_handler);
2633 #ifdef LWS_OPENSSL_SUPPORT
2635 /* basic openssl init */
2639 OpenSSL_add_all_algorithms();
2640 SSL_load_error_strings();
2642 openssl_websocket_private_data_index =
2643 SSL_get_ex_new_index(0, "libwebsockets", NULL, NULL, NULL);
2646 * Firefox insists on SSLv23 not SSLv3
2647 * Konq disables SSLv2 by default now, SSLv23 works
2650 method = (SSL_METHOD *)SSLv23_server_method();
2652 fprintf(stderr, "problem creating ssl method: %s\n",
2653 ERR_error_string(ERR_get_error(), ssl_err_buf));
2656 context->ssl_ctx = SSL_CTX_new(method); /* create context */
2657 if (!context->ssl_ctx) {
2658 fprintf(stderr, "problem creating ssl context: %s\n",
2659 ERR_error_string(ERR_get_error(), ssl_err_buf));
2663 /* client context */
2664 if (port == CONTEXT_PORT_NO_LISTEN)
2666 method = (SSL_METHOD *)SSLv23_client_method();
2668 fprintf(stderr, "problem creating ssl method: %s\n",
2669 ERR_error_string(ERR_get_error(), ssl_err_buf));
2672 /* create context */
2673 context->ssl_client_ctx = SSL_CTX_new(method);
2674 if (!context->ssl_client_ctx) {
2675 fprintf(stderr, "problem creating ssl context: %s\n",
2676 ERR_error_string(ERR_get_error(), ssl_err_buf));
2680 /* openssl init for cert verification (for client sockets) */
2682 if (!SSL_CTX_load_verify_locations(
2683 context->ssl_client_ctx, NULL,
2684 LWS_OPENSSL_CLIENT_CERTS))
2686 "Unable to load SSL Client certs from %s "
2687 "(set by --with-client-cert-dir= in configure) -- "
2688 " client ssl isn't going to work",
2689 LWS_OPENSSL_CLIENT_CERTS);
2692 * callback allowing user code to load extra verification certs
2693 * helping the client to verify server identity
2696 context->protocols[0].callback(context, NULL,
2697 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS,
2698 context->ssl_client_ctx, NULL, 0);
2700 /* as a server, are we requiring clients to identify themselves? */
2702 if (options & LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT) {
2704 /* absolutely require the client cert */
2706 SSL_CTX_set_verify(context->ssl_ctx,
2707 SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
2708 OpenSSL_verify_callback);
2711 * give user code a chance to load certs into the server
2712 * allowing it to verify incoming client certs
2715 context->protocols[0].callback(context, NULL,
2716 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS,
2717 context->ssl_ctx, NULL, 0);
2720 if (context->use_ssl) {
2722 /* openssl init for server sockets */
2724 /* set the local certificate from CertFile */
2725 n = SSL_CTX_use_certificate_file(context->ssl_ctx,
2726 ssl_cert_filepath, SSL_FILETYPE_PEM);
2728 fprintf(stderr, "problem getting cert '%s': %s\n",
2730 ERR_error_string(ERR_get_error(), ssl_err_buf));
2733 /* set the private key from KeyFile */
2734 if (SSL_CTX_use_PrivateKey_file(context->ssl_ctx,
2735 ssl_private_key_filepath, SSL_FILETYPE_PEM) != 1) {
2736 fprintf(stderr, "ssl problem getting key '%s': %s\n",
2737 ssl_private_key_filepath,
2738 ERR_error_string(ERR_get_error(), ssl_err_buf));
2741 /* verify private key */
2742 if (!SSL_CTX_check_private_key(context->ssl_ctx)) {
2743 fprintf(stderr, "Private SSL key doesn't match cert\n");
2747 /* SSL is happy and has a cert it's content with */
2753 if (lws_b64_selftest())
2756 /* fd hashtable init */
2758 for (n = 0; n < FD_HASHTABLE_MODULUS; n++)
2759 context->fd_hashtable[n].length = 0;
2761 /* set up our external listening socket we serve on */
2765 sockfd = socket(AF_INET, SOCK_STREAM, 0);
2767 fprintf(stderr, "ERROR opening socket");
2771 /* allow us to restart even if old sockets in TIME_WAIT */
2772 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, (const void *)&opt, sizeof(opt));
2777 setsockopt(sockfd, IPPROTO_TCP, TCP_NODELAY, (const void *)&opt, sizeof(opt));
2779 bzero((char *) &serv_addr, sizeof(serv_addr));
2780 serv_addr.sin_family = AF_INET;
2782 serv_addr.sin_addr.s_addr = INADDR_ANY;
2784 interface_to_sa(interf, &serv_addr,
2786 serv_addr.sin_port = htons(port);
2788 n = bind(sockfd, (struct sockaddr *) &serv_addr,
2791 fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
2796 wsi = malloc(sizeof(struct libwebsocket));
2797 memset(wsi, 0, sizeof (struct libwebsocket));
2799 wsi->count_active_extensions = 0;
2800 wsi->mode = LWS_CONNMODE_SERVER_LISTENER;
2801 insert_wsi(context, wsi);
2804 fprintf(stderr, " Listening on port %d\n", port);
2806 /* list in the internal poll array */
2808 context->fds[context->fds_count].fd = sockfd;
2809 context->fds[context->fds_count++].events = POLLIN;
2811 /* external POLL support via protocol 0 */
2812 context->protocols[0].callback(context, wsi,
2813 LWS_CALLBACK_ADD_POLL_FD,
2814 (void *)(long)sockfd, NULL, POLLIN);
2818 /* drop any root privs for this process */
2823 fprintf(stderr, "setgid: %s\n", strerror(errno));
2826 fprintf(stderr, "setuid: %s\n", strerror(errno));
2829 /* set up our internal broadcast trigger sockets per-protocol */
2831 for (context->count_protocols = 0;
2832 protocols[context->count_protocols].callback;
2833 context->count_protocols++) {
2835 fprintf(stderr, " Protocol: %s\n", protocols[context->count_protocols].name);
2837 protocols[context->count_protocols].owning_server = context;
2838 protocols[context->count_protocols].protocol_index =
2839 context->count_protocols;
2841 fd = socket(AF_INET, SOCK_STREAM, 0);
2843 fprintf(stderr, "ERROR opening socket");
2847 /* allow us to restart even if old sockets in TIME_WAIT */
2848 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (const void *)&opt, sizeof(opt));
2850 bzero((char *) &serv_addr, sizeof(serv_addr));
2851 serv_addr.sin_family = AF_INET;
2852 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
2853 serv_addr.sin_port = 0; /* pick the port for us */
2855 n = bind(fd, (struct sockaddr *) &serv_addr, sizeof(serv_addr));
2857 fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
2862 slen = sizeof cli_addr;
2863 n = getsockname(fd, (struct sockaddr *)&cli_addr, &slen);
2865 fprintf(stderr, "getsockname failed\n");
2868 protocols[context->count_protocols].broadcast_socket_port =
2869 ntohs(cli_addr.sin_port);
2872 debug(" Protocol %s broadcast socket %d\n",
2873 protocols[context->count_protocols].name,
2874 ntohs(cli_addr.sin_port));
2876 /* dummy wsi per broadcast proxy socket */
2878 wsi = malloc(sizeof(struct libwebsocket));
2879 memset(wsi, 0, sizeof (struct libwebsocket));
2881 wsi->mode = LWS_CONNMODE_BROADCAST_PROXY_LISTENER;
2882 wsi->count_active_extensions = 0;
2883 /* note which protocol we are proxying */
2884 wsi->protocol_index_for_broadcast_proxy =
2885 context->count_protocols;
2886 insert_wsi(context, wsi);
2888 /* list in internal poll array */
2890 context->fds[context->fds_count].fd = fd;
2891 context->fds[context->fds_count].events = POLLIN;
2892 context->fds[context->fds_count].revents = 0;
2893 context->fds_count++;
2895 /* external POLL support via protocol 0 */
2896 context->protocols[0].callback(context, wsi,
2897 LWS_CALLBACK_ADD_POLL_FD,
2898 (void *)(long)fd, NULL, POLLIN);
2902 * give all extensions a chance to create any per-context
2903 * allocations they need
2906 m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_CONSTRUCT;
2908 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_CONSTRUCT;
2909 while (extensions->callback) {
2910 fprintf(stderr, " Extension: %s\n", extensions->name);
2911 extensions->callback(context, extensions,
2912 NULL, m, NULL, NULL, 0);
2923 * libwebsockets_fork_service_loop() - Optional helper function forks off
2924 * a process for the websocket server loop.
2925 * You don't have to use this but if not, you
2926 * have to make sure you are calling
2927 * libwebsocket_service periodically to service
2928 * the websocket traffic
2929 * @context: server context returned by creation function
2933 libwebsockets_fork_service_loop(struct libwebsocket_context *context)
2936 struct sockaddr_in cli_addr;
2946 /* main process context */
2949 * set up the proxy sockets to allow broadcast from
2950 * service process context
2953 for (p = 0; p < context->count_protocols; p++) {
2954 fd = socket(AF_INET, SOCK_STREAM, 0);
2956 fprintf(stderr, "Unable to create socket\n");
2959 cli_addr.sin_family = AF_INET;
2960 cli_addr.sin_port = htons(
2961 context->protocols[p].broadcast_socket_port);
2962 cli_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
2963 n = connect(fd, (struct sockaddr *)&cli_addr,
2966 fprintf(stderr, "Unable to connect to "
2967 "broadcast socket %d, %s\n",
2968 n, strerror(errno));
2972 context->protocols[p].broadcast_socket_user_fd = fd;
2978 /* we want a SIGHUP when our parent goes down */
2979 prctl(PR_SET_PDEATHSIG, SIGHUP);
2981 /* in this forked process, sit and service websocket connections */
2984 if (libwebsocket_service(context, 1000))
2993 * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
2995 * @wsi: pointer to struct websocket you want to know the protocol of
2998 * This is useful to get the protocol to broadcast back to from inside
3002 const struct libwebsocket_protocols *
3003 libwebsockets_get_protocol(struct libwebsocket *wsi)
3005 return wsi->protocol;
3009 * libwebsockets_broadcast() - Sends a buffer to the callback for all active
3010 * connections of the given protocol.
3011 * @protocol: pointer to the protocol you will broadcast to all members of
3012 * @buf: buffer containing the data to be broadcase. NOTE: this has to be
3013 * allocated with LWS_SEND_BUFFER_PRE_PADDING valid bytes before
3014 * the pointer and LWS_SEND_BUFFER_POST_PADDING afterwards in the
3015 * case you are calling this function from callback context.
3016 * @len: length of payload data in buf, starting from buf.
3018 * This function allows bulk sending of a packet to every connection using
3019 * the given protocol. It does not send the data directly; instead it calls
3020 * the callback with a reason type of LWS_CALLBACK_BROADCAST. If the callback
3021 * wants to actually send the data for that connection, the callback itself
3022 * should call libwebsocket_write().
3024 * libwebsockets_broadcast() can be called from another fork context without
3025 * having to take any care about data visibility between the processes, it'll
3031 libwebsockets_broadcast(const struct libwebsocket_protocols *protocol,
3032 unsigned char *buf, size_t len)
3034 struct libwebsocket_context *context = protocol->owning_server;
3037 struct libwebsocket * wsi;
3039 if (!protocol->broadcast_socket_user_fd) {
3041 * We are either running unforked / flat, or we are being
3042 * called from poll thread context
3043 * eg, from a callback. In that case don't use sockets for
3044 * broadcast IPC (since we can't open a socket connection to
3045 * a socket listening on our own thread) but directly do the
3048 * Locking is not needed because we are by definition being
3049 * called in the poll thread context and are serialized.
3052 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
3054 for (m = 0; m < context->fd_hashtable[n].length; m++) {
3056 wsi = context->fd_hashtable[n].wsi[m];
3058 if (wsi->mode != LWS_CONNMODE_WS_SERVING)
3062 * never broadcast to
3063 * non-established connections
3065 if (wsi->state != WSI_STATE_ESTABLISHED)
3068 /* only broadcast to guys using
3069 * requested protocol
3071 if (wsi->protocol != protocol)
3074 wsi->protocol->callback(context, wsi,
3075 LWS_CALLBACK_BROADCAST,
3085 * We're being called from a different process context than the server
3086 * loop. Instead of broadcasting directly, we send our
3087 * payload on a socket to do the IPC; the server process will serialize
3088 * the broadcast action in its main poll() loop.
3090 * There's one broadcast socket listening for each protocol supported
3091 * set up when the websocket server initializes
3094 n = send(protocol->broadcast_socket_user_fd, buf, len, MSG_NOSIGNAL);
3100 libwebsocket_is_final_fragment(struct libwebsocket *wsi)
3106 libwebsocket_ensure_user_space(struct libwebsocket *wsi)
3108 /* allocate the per-connection user memory (if any) */
3110 if (wsi->protocol->per_session_data_size && !wsi->user_space) {
3111 wsi->user_space = malloc(
3112 wsi->protocol->per_session_data_size);
3113 if (wsi->user_space == NULL) {
3114 fprintf(stderr, "Out of memory for "
3115 "conn user space\n");
3118 memset(wsi->user_space, 0, wsi->protocol->per_session_data_size);
3120 return wsi->user_space;