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 fprintf(stderr, "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 fprintf(stderr, "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 fprintf(stderr, "sent close indication, awaiting ack\n");
277 /* else, the send failed and we should just hang up */
280 just_kill_connection:
282 fprintf(stderr, "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 fprintf(stderr, "calling back CLOSED\n");
320 wsi->protocol->callback(context, wsi, LWS_CALLBACK_CLOSED,
321 wsi->user_space, NULL, 0);
323 fprintf(stderr, "not calling back closed due to old_state=%d\n", old_state);
326 /* deallocate any active extension contexts */
328 for (n = 0; n < wsi->count_active_extensions; n++) {
329 if (!wsi->active_extensions[n]->callback)
332 wsi->active_extensions[n]->callback(context,
333 wsi->active_extensions[n], wsi,
334 LWS_EXT_CALLBACK_DESTROY,
335 wsi->active_extensions_user[n], NULL, 0);
337 free(wsi->active_extensions_user[n]);
341 * inform all extensions in case they tracked this guy out of band
342 * even though not active on him specifically
345 ext = context->extensions;
346 while (ext && ext->callback) {
347 ext->callback(context, ext, wsi,
348 LWS_EXT_CALLBACK_DESTROY_ANY_WSI_CLOSING,
353 /* free up his parsing allocations */
355 for (n = 0; n < WSI_TOKEN_COUNT; n++)
356 if (wsi->utf8_token[n].token)
357 free(wsi->utf8_token[n].token);
360 free(wsi->c_address);
362 /* fprintf(stderr, "closing fd=%d\n", wsi->sock); */
364 #ifdef LWS_OPENSSL_SUPPORT
366 n = SSL_get_fd(wsi->ssl);
367 SSL_shutdown(wsi->ssl);
376 shutdown(wsi->sock, SHUT_RDWR);
379 closesocket(wsi->sock);
384 #ifdef LWS_OPENSSL_SUPPORT
388 free(wsi->user_space);
394 * libwebsockets_hangup_on_client() - Server calls to terminate client
396 * @context: libwebsockets context
397 * @fd: Connection socket descriptor
401 libwebsockets_hangup_on_client(struct libwebsocket_context *context, int fd)
403 struct libwebsocket *wsi = wsi_from_fd(context, fd);
408 libwebsocket_close_and_free_session(context, wsi,
409 LWS_CLOSE_STATUS_NOSTATUS);
414 * libwebsockets_get_peer_addresses() - Get client address information
415 * @fd: Connection socket descriptor
416 * @name: Buffer to take client address name
417 * @name_len: Length of client address name buffer
418 * @rip: Buffer to take client address IP qotted quad
419 * @rip_len: Length of client address IP buffer
421 * This function fills in @name and @rip with the name and IP of
422 * the client connected with socket descriptor @fd. Names may be
423 * truncated if there is not enough room. If either cannot be
424 * determined, they will be returned as valid zero-length strings.
428 libwebsockets_get_peer_addresses(int fd, char *name, int name_len,
429 char *rip, int rip_len)
432 struct sockaddr_in sin;
433 struct hostent *host;
434 struct hostent *host1;
438 struct sockaddr_un *un;
444 if (getpeername(fd, (struct sockaddr *) &sin, &len) < 0) {
445 perror("getpeername");
449 host = gethostbyaddr((char *) &sin.sin_addr, sizeof sin.sin_addr,
452 perror("gethostbyaddr");
456 strncpy(name, host->h_name, name_len);
457 name[name_len - 1] = '\0';
459 host1 = gethostbyname(host->h_name);
462 p = (unsigned char *)host1;
465 p = (unsigned char *)host1->h_addr_list[n++];
468 if ((host1->h_addrtype != AF_INET)
470 && (host1->h_addrtype != AF_LOCAL)
475 if (host1->h_addrtype == AF_INET)
476 sprintf(ip, "%u.%u.%u.%u", p[0], p[1], p[2], p[3]);
479 un = (struct sockaddr_un *)p;
480 strncpy(ip, un->sun_path, sizeof(ip) -1);
481 ip[sizeof(ip) - 1] = '\0';
485 strncpy(rip, ip, rip_len);
486 rip[rip_len - 1] = '\0';
490 int libwebsockets_get_random(struct libwebsocket_context *context,
497 for (n = 0; n < len; n++)
498 p[n] = (unsigned char)rand();
500 n = read(context->fd_random, p, len);
507 libwebsockets_SHA1(const unsigned char *d, size_t n, unsigned char *md)
509 return SHA1(d, n, md);
512 void libwebsockets_00_spaceout(char *key, int spaces, int seed)
518 if (*key && (seed & 1))
522 p = key + strlen(key);
531 void libwebsockets_00_spam(char *key, int count, int seed)
538 if (*key && (seed & 1))
542 p = key + strlen(key);
547 *key++ = 0x21 + ((seed & 0xffff) % 15);
548 /* 4 would use it up too fast.. not like it matters */
553 int lws_send_pipe_choked(struct libwebsocket *wsi)
558 fds.events = POLLOUT;
561 if (poll(&fds, 1, 0) != 1)
564 if ((fds.revents & POLLOUT) == 0)
567 /* okay to send another packet without blocking */
573 lws_handle_POLLOUT_event(struct libwebsocket_context *context,
574 struct libwebsocket *wsi, struct pollfd *pollfd)
576 struct lws_tokens eff_buf;
582 for (n = 0; n < wsi->count_active_extensions; n++) {
583 if (!wsi->active_extensions[n]->callback)
586 m = wsi->active_extensions[n]->callback(context,
587 wsi->active_extensions[n], wsi,
588 LWS_EXT_CALLBACK_IS_WRITEABLE,
589 wsi->active_extensions_user[n], NULL, 0);
597 if (!wsi->extension_data_pending || handled == 2)
601 * check in on the active extensions, see if they
602 * had pending stuff to spill... they need to get the
603 * first look-in otherwise sequence will be disordered
605 * NULL, zero-length eff_buf means just spill pending
611 /* default to nobody has more to spill */
614 eff_buf.token = NULL;
615 eff_buf.token_len = 0;
617 /* give every extension a chance to spill */
619 for (n = 0; n < wsi->count_active_extensions; n++) {
620 m = wsi->active_extensions[n]->callback(
621 wsi->protocol->owning_server,
622 wsi->active_extensions[n], wsi,
623 LWS_EXT_CALLBACK_PACKET_TX_PRESEND,
624 wsi->active_extensions_user[n], &eff_buf, 0);
626 fprintf(stderr, "extension reports fatal error\n");
631 * at least one extension told us he has more
632 * to spill, so we will go around again after
637 /* assuming they gave us something to send, send it */
639 if (eff_buf.token_len) {
640 if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
646 /* no extension has more to spill */
652 * There's more to spill from an extension, but we just sent
653 * something... did that leave the pipe choked?
656 if (!lws_send_pipe_choked(wsi))
657 /* no we could add more */
660 fprintf(stderr, "choked in POLLOUT service\n");
663 * Yes, he's choked. Leave the POLLOUT masked on so we will
664 * come back here when he is unchoked. Don't call the user
665 * callback to enforce ordering of spilling, he'll get called
666 * when we come back here and there's nothing more to spill.
672 wsi->extension_data_pending = 0;
678 pollfd->events &= ~POLLOUT;
680 /* external POLL support via protocol 0 */
681 context->protocols[0].callback(context, wsi,
682 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
683 (void *)(long)wsi->sock, NULL, POLLOUT);
688 if (wsi->mode == LWS_CONNMODE_WS_CLIENT)
689 n = LWS_CALLBACK_CLIENT_WRITEABLE;
691 n = LWS_CALLBACK_SERVER_WRITEABLE;
693 wsi->protocol->callback(context, wsi, n, wsi->user_space, NULL, 0);
701 libwebsocket_service_timeout_check(struct libwebsocket_context *context,
702 struct libwebsocket *wsi, unsigned int sec)
707 * if extensions want in on it (eg, we are a mux parent)
708 * give them a chance to service child timeouts
711 for (n = 0; n < wsi->count_active_extensions; n++)
712 wsi->active_extensions[n]->callback(
713 context, wsi->active_extensions[n],
714 wsi, LWS_EXT_CALLBACK_1HZ,
715 wsi->active_extensions_user[n], NULL, sec);
717 if (!wsi->pending_timeout)
721 * if we went beyond the allowed time, kill the
725 if (sec > wsi->pending_timeout_limit) {
726 fprintf(stderr, "TIMEDOUT WAITING\n");
727 libwebsocket_close_and_free_session(context,
728 wsi, LWS_CLOSE_STATUS_NOSTATUS);
732 struct libwebsocket *
733 libwebsocket_create_new_server_wsi(struct libwebsocket_context *context)
735 struct libwebsocket *new_wsi;
738 new_wsi = malloc(sizeof(struct libwebsocket));
739 if (new_wsi == NULL) {
740 fprintf(stderr, "Out of memory for new connection\n");
744 memset(new_wsi, 0, sizeof (struct libwebsocket));
745 new_wsi->count_active_extensions = 0;
746 new_wsi->pending_timeout = NO_PENDING_TIMEOUT;
748 /* intialize the instance struct */
750 new_wsi->state = WSI_STATE_HTTP;
751 new_wsi->name_buffer_pos = 0;
752 new_wsi->mode = LWS_CONNMODE_WS_SERVING;
754 for (n = 0; n < WSI_TOKEN_COUNT; n++) {
755 new_wsi->utf8_token[n].token = NULL;
756 new_wsi->utf8_token[n].token_len = 0;
760 * these can only be set once the protocol is known
761 * we set an unestablished connection's protocol pointer
762 * to the start of the supported list, so it can look
763 * for matching ones during the handshake
765 new_wsi->protocol = context->protocols;
766 new_wsi->user_space = NULL;
769 * Default protocol is 76 / 00
770 * After 76, there's a header specified to inform which
771 * draft the client wants, when that's seen we modify
772 * the individual connection's spec revision accordingly
774 new_wsi->ietf_spec_revision = 0;
780 libwebsockets_generate_client_handshake(struct libwebsocket_context *context,
781 struct libwebsocket *wsi, char *pkt)
786 struct libwebsocket_extension *ext;
787 struct libwebsocket_extension *ext1;
789 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 1 + MAX_BROADCAST_PAYLOAD +
790 LWS_SEND_BUFFER_POST_PADDING];
791 static const char magic_websocket_guid[] =
792 "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
795 * create the random key
798 n = libwebsockets_get_random(context, hash, 16);
800 fprintf(stderr, "Unable to read from random dev %s\n",
801 SYSTEM_RANDOM_FILEPATH);
807 free(wsi->c_protocol);
808 libwebsocket_close_and_free_session(context, wsi,
809 LWS_CLOSE_STATUS_NOSTATUS);
813 lws_b64_encode_string(hash, 16, wsi->key_b64,
814 sizeof wsi->key_b64);
817 * 00 example client handshake
819 * GET /socket.io/websocket HTTP/1.1
821 * Connection: Upgrade
822 * Host: 127.0.0.1:9999
823 * Origin: http://127.0.0.1
824 * Sec-WebSocket-Key1: 1 0 2#0W 9 89 7 92 ^
825 * Sec-WebSocket-Key2: 7 7Y 4328 B2v[8(z1
826 * Cookie: socketio=websocket
830 * 04 example client handshake
833 * Host: server.example.com
835 * Connection: Upgrade
836 * Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
837 * Sec-WebSocket-Origin: http://example.com
838 * Sec-WebSocket-Protocol: chat, superchat
839 * Sec-WebSocket-Version: 4
842 p += sprintf(p, "GET %s HTTP/1.1\x0d\x0a", wsi->c_path);
844 if (wsi->ietf_spec_revision == 0) {
845 unsigned char spaces_1, spaces_2;
846 unsigned int max_1, max_2;
847 unsigned int num_1, num_2;
848 unsigned long product_1, product_2;
855 libwebsockets_get_random(context, &spaces_1,
857 libwebsockets_get_random(context, &spaces_2,
860 spaces_1 = (spaces_1 % 12) + 1;
861 spaces_2 = (spaces_2 % 12) + 1;
863 max_1 = 4294967295 / spaces_1;
864 max_2 = 4294967295 / spaces_2;
866 libwebsockets_get_random(context, &num_1, sizeof(int));
867 libwebsockets_get_random(context, &num_2, sizeof(int));
869 num_1 = (num_1 % max_1);
870 num_2 = (num_2 % max_2);
872 challenge[0] = num_1 >> 24;
873 challenge[1] = num_1 >> 16;
874 challenge[2] = num_1 >> 8;
875 challenge[3] = num_1;
876 challenge[4] = num_2 >> 24;
877 challenge[5] = num_2 >> 16;
878 challenge[6] = num_2 >> 8;
879 challenge[7] = num_2;
881 product_1 = num_1 * spaces_1;
882 product_2 = num_2 * spaces_2;
884 sprintf(key_1, "%lu", product_1);
885 sprintf(key_2, "%lu", product_2);
887 libwebsockets_get_random(context, &seed, sizeof(int));
888 libwebsockets_get_random(context, &count, sizeof(int));
890 libwebsockets_00_spam(key_1, (count % 12) + 1, seed);
892 libwebsockets_get_random(context, &seed, sizeof(int));
893 libwebsockets_get_random(context, &count, sizeof(int));
895 libwebsockets_00_spam(key_2, (count % 12) + 1, seed);
897 libwebsockets_get_random(context, &seed, sizeof(int));
899 libwebsockets_00_spaceout(key_1, spaces_1, seed);
900 libwebsockets_00_spaceout(key_2, spaces_2, seed >> 16);
902 p += sprintf(p, "Upgrade: WebSocket\x0d\x0a"
903 "Connection: Upgrade\x0d\x0aHost: %s\x0d\x0a",
906 p += sprintf(p, "Origin: %s\x0d\x0a",
910 p += sprintf(p, "Sec-WebSocket-Protocol: %s"
911 "\x0d\x0a", wsi->c_protocol);
913 p += sprintf(p, "Sec-WebSocket-Key1: %s\x0d\x0a",
915 p += sprintf(p, "Sec-WebSocket-Key2: %s\x0d\x0a",
918 /* give userland a chance to append, eg, cookies */
920 context->protocols[0].callback(context, wsi,
921 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER,
922 NULL, &p, (pkt + sizeof(pkt)) - p - 12);
924 p += sprintf(p, "\x0d\x0a");
926 if (libwebsockets_get_random(context, p, 8) != 8)
928 memcpy(&challenge[8], p, 8);
931 /* precompute what we want to see from the server */
933 MD5((unsigned char *)challenge, 16,
934 (unsigned char *)wsi->initial_handshake_hash_base64);
939 p += sprintf(p, "Host: %s\x0d\x0a", wsi->c_host);
940 p += sprintf(p, "Upgrade: websocket\x0d\x0a");
941 p += sprintf(p, "Connection: Upgrade\x0d\x0a"
942 "Sec-WebSocket-Key: ");
943 strcpy(p, wsi->key_b64);
944 p += strlen(wsi->key_b64);
945 p += sprintf(p, "\x0d\x0a");
947 p += sprintf(p, "Sec-WebSocket-Origin: %s\x0d\x0a",
950 p += sprintf(p, "Sec-WebSocket-Protocol: %s\x0d\x0a",
953 /* tell the server what extensions we could support */
955 p += sprintf(p, "Sec-WebSocket-Extensions: ");
957 ext =context->extensions;
958 while (ext && ext->callback) {
961 ext1 = context->extensions;
962 while (ext1 && ext1->callback) {
964 n |= ext1->callback(context, ext1, wsi,
965 LWS_EXT_CALLBACK_CHECK_OK_TO_PROPOSE_EXTENSION,
966 NULL, (char *)ext->name, 0);
973 /* an extension vetos us */
974 fprintf(stderr, "ext %s vetoed\n", (char *)ext->name);
979 n = context->protocols[0].callback(context, wsi,
980 LWS_CALLBACK_CLIENT_CONFIRM_EXTENSION_SUPPORTED,
981 wsi->user_space, (char *)ext->name, 0);
984 * zero return from callback means
985 * go ahead and allow the extension,
986 * it's what we get if the callback is
999 p += sprintf(p, "%s", ext->name);
1005 p += sprintf(p, "\x0d\x0a");
1007 if (wsi->ietf_spec_revision)
1008 p += sprintf(p, "Sec-WebSocket-Version: %d\x0d\x0a",
1009 wsi->ietf_spec_revision);
1011 /* give userland a chance to append, eg, cookies */
1013 context->protocols[0].callback(context, wsi,
1014 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER,
1015 NULL, &p, (pkt + sizeof(pkt)) - p - 12);
1017 p += sprintf(p, "\x0d\x0a");
1019 /* prepare the expected server accept response */
1021 strcpy((char *)buf, wsi->key_b64);
1022 strcpy((char *)&buf[strlen((char *)buf)], magic_websocket_guid);
1024 SHA1(buf, strlen((char *)buf), (unsigned char *)hash);
1026 lws_b64_encode_string(hash, 20,
1027 wsi->initial_handshake_hash_base64,
1028 sizeof wsi->initial_handshake_hash_base64);
1034 /* done with these now */
1039 free(wsi->c_origin);
1045 lws_client_interpret_server_handshake(struct libwebsocket_context *context,
1046 struct libwebsocket *wsi)
1048 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 1 + MAX_BROADCAST_PAYLOAD +
1049 LWS_SEND_BUFFER_POST_PADDING];
1057 struct libwebsocket_extension *ext;
1061 static const char magic_websocket_04_masking_guid[] =
1062 "61AC5F19-FBBA-4540-B96F-6561F1AB40A8";
1067 * HTTP/1.1 101 WebSocket Protocol Handshake
1068 * Upgrade: WebSocket
1069 * Connection: Upgrade
1070 * Sec-WebSocket-Origin: http://127.0.0.1
1071 * Sec-WebSocket-Location: ws://127.0.0.1:9999/socket.io/websocket
1076 if (wsi->ietf_spec_revision == 0) {
1077 if (!wsi->utf8_token[WSI_TOKEN_HTTP].token_len ||
1078 !wsi->utf8_token[WSI_TOKEN_UPGRADE].token_len ||
1079 !wsi->utf8_token[WSI_TOKEN_CHALLENGE].token_len ||
1080 !wsi->utf8_token[WSI_TOKEN_CONNECTION].token_len ||
1081 (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len &&
1082 wsi->c_protocol != NULL)) {
1083 fprintf(stderr, "libwebsocket_client_handshake "
1084 "missing required header(s)\n");
1086 fprintf(stderr, "%s", pkt);
1090 strtolower(wsi->utf8_token[WSI_TOKEN_HTTP].token);
1091 if (strcmp(wsi->utf8_token[WSI_TOKEN_HTTP].token,
1092 "101 websocket protocol handshake")) {
1093 fprintf(stderr, "libwebsocket_client_handshake "
1094 "server sent bad HTTP response '%s'\n",
1095 wsi->utf8_token[WSI_TOKEN_HTTP].token);
1099 if (wsi->utf8_token[WSI_TOKEN_CHALLENGE].token_len <
1101 fprintf(stderr, "libwebsocket_client_handshake "
1102 "challenge reply too short %d\n",
1104 WSI_TOKEN_CHALLENGE].token_len);
1106 fprintf(stderr, "%s", pkt);
1111 goto select_protocol;
1115 * well, what the server sent looked reasonable for syntax.
1116 * Now let's confirm it sent all the necessary headers
1119 fprintf(stderr, "WSI_TOKEN_HTTP: %d\n", wsi->utf8_token[WSI_TOKEN_HTTP].token_len);
1120 fprintf(stderr, "WSI_TOKEN_UPGRADE: %d\n", wsi->utf8_token[WSI_TOKEN_UPGRADE].token_len);
1121 fprintf(stderr, "WSI_TOKEN_CONNECTION: %d\n", wsi->utf8_token[WSI_TOKEN_CONNECTION].token_len);
1122 fprintf(stderr, "WSI_TOKEN_ACCEPT: %d\n", wsi->utf8_token[WSI_TOKEN_ACCEPT].token_len);
1123 fprintf(stderr, "WSI_TOKEN_NONCE: %d\n", wsi->utf8_token[WSI_TOKEN_NONCE].token_len);
1124 fprintf(stderr, "WSI_TOKEN_PROTOCOL: %d\n", wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len);
1126 if (!wsi->utf8_token[WSI_TOKEN_HTTP].token_len ||
1127 !wsi->utf8_token[WSI_TOKEN_UPGRADE].token_len ||
1128 !wsi->utf8_token[WSI_TOKEN_CONNECTION].token_len ||
1129 !wsi->utf8_token[WSI_TOKEN_ACCEPT].token_len ||
1130 (!wsi->utf8_token[WSI_TOKEN_NONCE].token_len &&
1131 wsi->ietf_spec_revision == 4) ||
1132 (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len &&
1133 wsi->c_protocol != NULL)) {
1134 fprintf(stderr, "libwebsocket_client_handshake "
1135 "missing required header(s)\n");
1137 fprintf(stderr, "%s", pkt);
1142 * Everything seems to be there, now take a closer look at what
1146 strtolower(wsi->utf8_token[WSI_TOKEN_HTTP].token);
1147 if (strcmp(wsi->utf8_token[WSI_TOKEN_HTTP].token,
1148 "101 switching protocols")) {
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 fprintf(stderr, "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 fprintf(stderr, "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 fprintf(stderr, "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 fprintf(stderr, "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) */
1377 if (wsi->protocol->per_session_data_size) {
1378 wsi->user_space = malloc(
1379 wsi->protocol->per_session_data_size);
1380 if (wsi->user_space == NULL) {
1381 fprintf(stderr, "Out of memory for "
1382 "conn user space\n");
1386 wsi->user_space = NULL;
1388 /* clear his proxy connection timeout */
1390 libwebsocket_set_timeout(wsi, NO_PENDING_TIMEOUT, 0);
1392 /* mark him as being alive */
1394 wsi->state = WSI_STATE_ESTABLISHED;
1395 wsi->mode = LWS_CONNMODE_WS_CLIENT;
1397 fprintf(stderr, "handshake OK for protocol %s\n",
1398 wsi->protocol->name);
1400 /* call him back to inform him he is up */
1402 wsi->protocol->callback(context, wsi,
1403 LWS_CALLBACK_CLIENT_ESTABLISHED,
1408 * inform all extensions, not just active ones since they
1412 ext = context->extensions;
1414 while (ext && ext->callback) {
1416 for (n = 0; n < wsi->count_active_extensions; n++)
1417 if (wsi->active_extensions[n] == ext)
1418 v = wsi->active_extensions_user[n];
1420 ext->callback(context, ext, wsi,
1421 LWS_EXT_CALLBACK_ANY_WSI_ESTABLISHED, v, NULL, 0);
1428 if (wsi->c_protocol)
1429 free(wsi->c_protocol);
1432 libwebsocket_close_and_free_session(context, wsi,
1433 LWS_CLOSE_STATUS_NOSTATUS);
1440 * libwebsocket_service_fd() - Service polled socket with something waiting
1441 * @context: Websocket context
1442 * @pollfd: The pollfd entry describing the socket fd and which events
1445 * This function closes any active connections and then frees the
1446 * context. After calling this, any further use of the context is
1451 libwebsocket_service_fd(struct libwebsocket_context *context,
1452 struct pollfd *pollfd)
1454 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 1 + MAX_BROADCAST_PAYLOAD +
1455 LWS_SEND_BUFFER_POST_PADDING];
1456 struct libwebsocket *wsi;
1457 struct libwebsocket *new_wsi;
1462 unsigned int clilen;
1463 struct sockaddr_in cli_addr;
1468 struct lws_tokens eff_buf;
1471 #ifdef LWS_OPENSSL_SUPPORT
1472 char ssl_err_buf[512];
1475 * you can call us with pollfd = NULL to just allow the once-per-second
1476 * global timeout checks; if less than a second since the last check
1477 * it returns immediately then.
1480 gettimeofday(&tv, NULL);
1482 if (context->last_timeout_check_s != tv.tv_sec) {
1483 context->last_timeout_check_s = tv.tv_sec;
1485 /* global timeout check once per second */
1487 for (n = 0; n < context->fds_count; n++) {
1488 wsi = wsi_from_fd(context, context->fds[n].fd);
1490 libwebsocket_service_timeout_check(context, wsi,
1495 /* just here for timeout management? */
1500 /* no, here to service a socket descriptor */
1502 wsi = wsi_from_fd(context, pollfd->fd);
1507 switch (wsi->mode) {
1508 case LWS_CONNMODE_SERVER_LISTENER:
1510 /* pollin means a client has connected to us then */
1512 if (!pollfd->revents & POLLIN)
1515 /* listen socket got an unencrypted connection... */
1517 clilen = sizeof(cli_addr);
1518 accept_fd = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
1520 if (accept_fd < 0) {
1521 fprintf(stderr, "ERROR on accept");
1527 setsockopt(accept_fd, IPPROTO_TCP, TCP_NODELAY, &opt,
1530 if (context->fds_count >= MAX_CLIENTS) {
1531 fprintf(stderr, "too busy to accept new client\n");
1533 closesocket(accept_fd);
1541 * look at who we connected to and give user code a chance
1542 * to reject based on client IP. There's no protocol selected
1543 * yet so we issue this to protocols[0]
1546 if ((context->protocols[0].callback)(context, wsi,
1547 LWS_CALLBACK_FILTER_NETWORK_CONNECTION,
1548 (void*)(long)accept_fd, NULL, 0)) {
1549 fprintf(stderr, "Callback denied network connection\n");
1551 closesocket(accept_fd);
1558 /* accepting connection to main listener */
1560 new_wsi = libwebsocket_create_new_server_wsi(context);
1561 if (new_wsi == NULL)
1564 new_wsi->sock = accept_fd;
1567 #ifdef LWS_OPENSSL_SUPPORT
1568 new_wsi->ssl = NULL;
1570 if (context->use_ssl) {
1572 new_wsi->ssl = SSL_new(context->ssl_ctx);
1573 if (new_wsi->ssl == NULL) {
1574 fprintf(stderr, "SSL_new failed: %s\n",
1575 ERR_error_string(SSL_get_error(
1576 new_wsi->ssl, 0), NULL));
1577 libwebsockets_decode_ssl_error();
1582 SSL_set_fd(new_wsi->ssl, accept_fd);
1584 n = SSL_accept(new_wsi->ssl);
1587 * browsers seem to probe with various
1588 * ssl params which fail then retry
1591 debug("SSL_accept failed skt %u: %s\n",
1593 ERR_error_string(SSL_get_error(
1594 new_wsi->ssl, n), NULL));
1601 debug("accepted new SSL conn "
1602 "port %u on fd=%d SSL ver %s\n",
1603 ntohs(cli_addr.sin_port), accept_fd,
1604 SSL_get_version(new_wsi->ssl));
1608 debug("accepted new conn port %u on fd=%d\n",
1609 ntohs(cli_addr.sin_port), accept_fd);
1611 insert_wsi(context, new_wsi);
1614 * make sure NO events are seen yet on this new socket
1615 * (otherwise we inherit old fds[client].revents from
1616 * previous socket there and die mysteriously! )
1618 context->fds[context->fds_count].revents = 0;
1620 context->fds[context->fds_count].events = POLLIN;
1621 context->fds[context->fds_count++].fd = accept_fd;
1623 /* external POLL support via protocol 0 */
1624 context->protocols[0].callback(context, new_wsi,
1625 LWS_CALLBACK_ADD_POLL_FD,
1626 (void *)(long)accept_fd, NULL, POLLIN);
1630 case LWS_CONNMODE_BROADCAST_PROXY_LISTENER:
1632 /* as we are listening, POLLIN means accept() is needed */
1634 if (!pollfd->revents & POLLIN)
1637 /* listen socket got an unencrypted connection... */
1639 clilen = sizeof(cli_addr);
1640 accept_fd = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
1642 if (accept_fd < 0) {
1643 fprintf(stderr, "ERROR on accept");
1647 if (context->fds_count >= MAX_CLIENTS) {
1648 fprintf(stderr, "too busy to accept new broadcast "
1651 closesocket(accept_fd);
1658 /* create a dummy wsi for the connection and add it */
1660 new_wsi = malloc(sizeof(struct libwebsocket));
1661 memset(new_wsi, 0, sizeof (struct libwebsocket));
1662 new_wsi->sock = accept_fd;
1663 new_wsi->mode = LWS_CONNMODE_BROADCAST_PROXY;
1664 new_wsi->state = WSI_STATE_ESTABLISHED;
1665 new_wsi->count_active_extensions = 0;
1666 /* note which protocol we are proxying */
1667 new_wsi->protocol_index_for_broadcast_proxy =
1668 wsi->protocol_index_for_broadcast_proxy;
1669 insert_wsi(context, new_wsi);
1671 /* add connected socket to internal poll array */
1673 context->fds[context->fds_count].revents = 0;
1674 context->fds[context->fds_count].events = POLLIN;
1675 context->fds[context->fds_count++].fd = accept_fd;
1677 /* external POLL support via protocol 0 */
1678 context->protocols[0].callback(context, new_wsi,
1679 LWS_CALLBACK_ADD_POLL_FD,
1680 (void *)(long)accept_fd, NULL, POLLIN);
1684 case LWS_CONNMODE_BROADCAST_PROXY:
1686 /* handle session socket closed */
1688 if (pollfd->revents & (POLLERR | POLLHUP)) {
1690 debug("Session Socket %p (fd=%d) dead\n",
1691 (void *)wsi, pollfd->fd);
1693 libwebsocket_close_and_free_session(context, wsi,
1694 LWS_CLOSE_STATUS_NORMAL);
1699 * either extension code with stuff to spill, or the user code,
1700 * requested a callback when it was OK to write
1703 if (pollfd->revents & POLLOUT)
1704 if (lws_handle_POLLOUT_event(context, wsi, pollfd) < 0) {
1705 libwebsocket_close_and_free_session(context, wsi,
1706 LWS_CLOSE_STATUS_NORMAL);
1710 /* any incoming data ready? */
1712 if (!(pollfd->revents & POLLIN))
1715 /* get the issued broadcast payload from the socket */
1717 len = read(pollfd->fd, buf + LWS_SEND_BUFFER_PRE_PADDING,
1718 MAX_BROADCAST_PAYLOAD);
1720 fprintf(stderr, "Error reading broadcast payload\n");
1724 /* broadcast it to all guys with this protocol index */
1726 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
1728 for (m = 0; m < context->fd_hashtable[n].length; m++) {
1730 new_wsi = context->fd_hashtable[n].wsi[m];
1732 /* only to clients we are serving to */
1734 if (new_wsi->mode != LWS_CONNMODE_WS_SERVING)
1738 * never broadcast to non-established
1742 if (new_wsi->state != WSI_STATE_ESTABLISHED)
1746 * only broadcast to connections using
1747 * the requested protocol
1750 if (new_wsi->protocol->protocol_index !=
1751 wsi->protocol_index_for_broadcast_proxy)
1754 /* broadcast it to this connection */
1756 new_wsi->protocol->callback(context, new_wsi,
1757 LWS_CALLBACK_BROADCAST,
1758 new_wsi->user_space,
1759 buf + LWS_SEND_BUFFER_PRE_PADDING, len);
1764 case LWS_CONNMODE_WS_CLIENT_WAITING_PROXY_REPLY:
1766 /* handle proxy hung up on us */
1768 if (pollfd->revents & (POLLERR | POLLHUP)) {
1770 fprintf(stderr, "Proxy connection %p (fd=%d) dead\n",
1771 (void *)wsi, pollfd->fd);
1773 libwebsocket_close_and_free_session(context, wsi,
1774 LWS_CLOSE_STATUS_NOSTATUS);
1778 n = recv(wsi->sock, pkt, sizeof pkt, 0);
1780 libwebsocket_close_and_free_session(context, wsi,
1781 LWS_CLOSE_STATUS_NOSTATUS);
1782 fprintf(stderr, "ERROR reading from proxy socket\n");
1787 if (strcmp(pkt, "HTTP/1.0 200 ") != 0) {
1788 libwebsocket_close_and_free_session(context, wsi,
1789 LWS_CLOSE_STATUS_NOSTATUS);
1790 fprintf(stderr, "ERROR from proxy: %s\n", pkt);
1794 /* clear his proxy connection timeout */
1796 libwebsocket_set_timeout(wsi, NO_PENDING_TIMEOUT, 0);
1800 case LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE:
1802 #ifdef LWS_OPENSSL_SUPPORT
1805 wsi->ssl = SSL_new(context->ssl_client_ctx);
1806 wsi->client_bio = BIO_new_socket(wsi->sock,
1808 SSL_set_bio(wsi->ssl, wsi->client_bio, wsi->client_bio);
1810 SSL_set_ex_data(wsi->ssl,
1811 openssl_websocket_private_data_index,
1814 if (SSL_connect(wsi->ssl) <= 0) {
1815 fprintf(stderr, "SSL connect error %s\n",
1816 ERR_error_string(ERR_get_error(),
1818 libwebsocket_close_and_free_session(context, wsi,
1819 LWS_CLOSE_STATUS_NOSTATUS);
1823 n = SSL_get_verify_result(wsi->ssl);
1824 if ((n != X509_V_OK) && (
1825 n != X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT ||
1826 wsi->use_ssl != 2)) {
1828 fprintf(stderr, "server's cert didn't "
1829 "look good %d\n", n);
1830 libwebsocket_close_and_free_session(context,
1831 wsi, LWS_CLOSE_STATUS_NOSTATUS);
1839 #ifdef LWS_OPENSSL_SUPPORT
1843 p = libwebsockets_generate_client_handshake(context, wsi, p);
1847 /* send our request to the server */
1849 #ifdef LWS_OPENSSL_SUPPORT
1851 n = SSL_write(wsi->ssl, pkt, p - pkt);
1854 n = send(wsi->sock, pkt, p - pkt, 0);
1857 fprintf(stderr, "ERROR writing to client socket\n");
1858 libwebsocket_close_and_free_session(context, wsi,
1859 LWS_CLOSE_STATUS_NOSTATUS);
1863 wsi->parser_state = WSI_TOKEN_NAME_PART;
1864 wsi->mode = LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY;
1865 libwebsocket_set_timeout(wsi,
1866 PENDING_TIMEOUT_AWAITING_SERVER_RESPONSE, 5);
1870 case LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY:
1872 /* handle server hung up on us */
1874 if (pollfd->revents & (POLLERR | POLLHUP)) {
1876 fprintf(stderr, "Server connection %p (fd=%d) dead\n",
1877 (void *)wsi, pollfd->fd);
1883 /* interpret the server response */
1886 * HTTP/1.1 101 Switching Protocols
1887 * Upgrade: websocket
1888 * Connection: Upgrade
1889 * Sec-WebSocket-Accept: me89jWimTRKTWwrS3aRrL53YZSo=
1890 * Sec-WebSocket-Nonce: AQIDBAUGBwgJCgsMDQ4PEC==
1891 * Sec-WebSocket-Protocol: chat
1894 #ifdef LWS_OPENSSL_SUPPORT
1896 len = SSL_read(wsi->ssl, pkt, sizeof pkt);
1899 len = recv(wsi->sock, pkt, sizeof pkt, 0);
1903 "libwebsocket_client_handshake read error\n");
1908 for (n = 0; n < len; n++)
1909 libwebsocket_parse(wsi, *p++);
1912 * may be coming in multiple packets, there is a 5-second
1913 * libwebsocket timeout still active here too, so if parsing did
1914 * not complete just wait for next packet coming in this state
1917 if (wsi->parser_state != WSI_PARSING_COMPLETE)
1920 return lws_client_interpret_server_handshake(context, wsi);
1923 if (wsi->c_protocol)
1924 free(wsi->c_protocol);
1925 libwebsocket_close_and_free_session(context, wsi,
1926 LWS_CLOSE_STATUS_NOSTATUS);
1929 case LWS_CONNMODE_WS_CLIENT_WAITING_EXTENSION_CONNECT:
1930 fprintf(stderr, "LWS_CONNMODE_WS_CLIENT_WAITING_EXTENSION_CONNECT\n");
1933 case LWS_CONNMODE_WS_CLIENT_PENDING_CANDIDATE_CHILD:
1934 fprintf(stderr, "LWS_CONNMODE_WS_CLIENT_PENDING_CANDIDATE_CHILD\n");
1938 case LWS_CONNMODE_WS_SERVING:
1939 case LWS_CONNMODE_WS_CLIENT:
1941 /* handle session socket closed */
1943 if (pollfd->revents & (POLLERR | POLLHUP)) {
1945 fprintf(stderr, "Session Socket %p (fd=%d) dead\n",
1946 (void *)wsi, pollfd->fd);
1948 libwebsocket_close_and_free_session(context, wsi,
1949 LWS_CLOSE_STATUS_NOSTATUS);
1953 /* the guy requested a callback when it was OK to write */
1955 if ((pollfd->revents & POLLOUT) &&
1956 wsi->state == WSI_STATE_ESTABLISHED)
1957 if (lws_handle_POLLOUT_event(context, wsi,
1959 libwebsocket_close_and_free_session(
1960 context, wsi, LWS_CLOSE_STATUS_NORMAL);
1965 /* any incoming data ready? */
1967 if (!(pollfd->revents & POLLIN))
1970 #ifdef LWS_OPENSSL_SUPPORT
1972 eff_buf.token_len = SSL_read(wsi->ssl, buf, sizeof buf);
1976 recv(pollfd->fd, buf, sizeof buf, 0);
1978 if (eff_buf.token_len < 0) {
1979 fprintf(stderr, "Socket read returned %d\n",
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;
2510 /* Use the MAKEWORD(lowbyte, highbyte) macro from Windef.h */
2511 wVersionRequested = MAKEWORD(2, 2);
2513 err = WSAStartup(wVersionRequested, &wsaData);
2515 /* Tell the user that we could not find a usable */
2517 fprintf(stderr, "WSAStartup failed with error: %d\n",
2525 context = malloc(sizeof(struct libwebsocket_context));
2527 fprintf(stderr, "No memory for websocket context\n");
2530 context->protocols = protocols;
2531 context->listen_port = port;
2532 context->http_proxy_port = 0;
2533 context->http_proxy_address[0] = '\0';
2534 context->options = options;
2535 context->fds_count = 0;
2536 context->extensions = extensions;
2539 context->fd_random = 0;
2541 context->fd_random = open(SYSTEM_RANDOM_FILEPATH, O_RDONLY);
2542 if (context->fd_random < 0) {
2543 fprintf(stderr, "Unable to open random device %s %d\n",
2544 SYSTEM_RANDOM_FILEPATH, context->fd_random);
2549 #ifdef LWS_OPENSSL_SUPPORT
2550 context->use_ssl = 0;
2551 context->ssl_ctx = NULL;
2552 context->ssl_client_ctx = NULL;
2553 openssl_websocket_private_data_index = 0;
2555 /* find canonical hostname */
2557 hostname[(sizeof hostname) - 1] = '\0';
2558 gethostname(hostname, (sizeof hostname) - 1);
2559 he = gethostbyname(hostname);
2561 strncpy(context->canonical_hostname, he->h_name,
2562 sizeof context->canonical_hostname - 1);
2563 context->canonical_hostname[
2564 sizeof context->canonical_hostname - 1] = '\0';
2566 strncpy(context->canonical_hostname, hostname,
2567 sizeof context->canonical_hostname - 1);
2569 /* split the proxy ads:port if given */
2571 p = getenv("http_proxy");
2573 strncpy(context->http_proxy_address, p,
2574 sizeof context->http_proxy_address - 1);
2575 context->http_proxy_address[
2576 sizeof context->http_proxy_address - 1] = '\0';
2578 p = strchr(context->http_proxy_address, ':');
2580 fprintf(stderr, "http_proxy needs to be ads:port\n");
2584 context->http_proxy_port = atoi(p + 1);
2586 fprintf(stderr, "Using proxy %s:%u\n",
2587 context->http_proxy_address,
2588 context->http_proxy_port);
2593 #ifdef LWS_OPENSSL_SUPPORT
2594 context->use_ssl = ssl_cert_filepath != NULL &&
2595 ssl_private_key_filepath != NULL;
2596 if (context->use_ssl)
2597 fprintf(stderr, " Compiled with SSL support, "
2600 fprintf(stderr, " Compiled with SSL support, "
2604 if (ssl_cert_filepath != NULL &&
2605 ssl_private_key_filepath != NULL) {
2606 fprintf(stderr, " Not compiled for OpenSSl support!\n");
2609 fprintf(stderr, " Compiled without SSL support, "
2610 "serving unencrypted\n");
2614 /* ignore SIGPIPE */
2617 signal(SIGPIPE, sigpipe_handler);
2621 #ifdef LWS_OPENSSL_SUPPORT
2623 /* basic openssl init */
2627 OpenSSL_add_all_algorithms();
2628 SSL_load_error_strings();
2630 openssl_websocket_private_data_index =
2631 SSL_get_ex_new_index(0, "libwebsockets", NULL, NULL, NULL);
2634 * Firefox insists on SSLv23 not SSLv3
2635 * Konq disables SSLv2 by default now, SSLv23 works
2638 method = (SSL_METHOD *)SSLv23_server_method();
2640 fprintf(stderr, "problem creating ssl method: %s\n",
2641 ERR_error_string(ERR_get_error(), ssl_err_buf));
2644 context->ssl_ctx = SSL_CTX_new(method); /* create context */
2645 if (!context->ssl_ctx) {
2646 fprintf(stderr, "problem creating ssl context: %s\n",
2647 ERR_error_string(ERR_get_error(), ssl_err_buf));
2651 /* client context */
2652 if (port == CONTEXT_PORT_NO_LISTEN)
2654 method = (SSL_METHOD *)SSLv23_client_method();
2656 fprintf(stderr, "problem creating ssl method: %s\n",
2657 ERR_error_string(ERR_get_error(), ssl_err_buf));
2660 /* create context */
2661 context->ssl_client_ctx = SSL_CTX_new(method);
2662 if (!context->ssl_client_ctx) {
2663 fprintf(stderr, "problem creating ssl context: %s\n",
2664 ERR_error_string(ERR_get_error(), ssl_err_buf));
2668 /* openssl init for cert verification (for client sockets) */
2670 if (!SSL_CTX_load_verify_locations(
2671 context->ssl_client_ctx, NULL,
2672 LWS_OPENSSL_CLIENT_CERTS))
2674 "Unable to load SSL Client certs from %s "
2675 "(set by --with-client-cert-dir= in configure) -- "
2676 " client ssl isn't going to work",
2677 LWS_OPENSSL_CLIENT_CERTS);
2680 * callback allowing user code to load extra verification certs
2681 * helping the client to verify server identity
2684 context->protocols[0].callback(context, NULL,
2685 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS,
2686 context->ssl_client_ctx, NULL, 0);
2688 /* as a server, are we requiring clients to identify themselves? */
2690 if (options & LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT) {
2692 /* absolutely require the client cert */
2694 SSL_CTX_set_verify(context->ssl_ctx,
2695 SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
2696 OpenSSL_verify_callback);
2699 * give user code a chance to load certs into the server
2700 * allowing it to verify incoming client certs
2703 context->protocols[0].callback(context, NULL,
2704 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS,
2705 context->ssl_ctx, NULL, 0);
2708 if (context->use_ssl) {
2710 /* openssl init for server sockets */
2712 /* set the local certificate from CertFile */
2713 n = SSL_CTX_use_certificate_file(context->ssl_ctx,
2714 ssl_cert_filepath, SSL_FILETYPE_PEM);
2716 fprintf(stderr, "problem getting cert '%s': %s\n",
2718 ERR_error_string(ERR_get_error(), ssl_err_buf));
2721 /* set the private key from KeyFile */
2722 if (SSL_CTX_use_PrivateKey_file(context->ssl_ctx,
2723 ssl_private_key_filepath, SSL_FILETYPE_PEM) != 1) {
2724 fprintf(stderr, "ssl problem getting key '%s': %s\n",
2725 ssl_private_key_filepath,
2726 ERR_error_string(ERR_get_error(), ssl_err_buf));
2729 /* verify private key */
2730 if (!SSL_CTX_check_private_key(context->ssl_ctx)) {
2731 fprintf(stderr, "Private SSL key doesn't match cert\n");
2735 /* SSL is happy and has a cert it's content with */
2741 if (lws_b64_selftest())
2744 /* fd hashtable init */
2746 for (n = 0; n < FD_HASHTABLE_MODULUS; n++)
2747 context->fd_hashtable[n].length = 0;
2749 /* set up our external listening socket we serve on */
2753 sockfd = socket(AF_INET, SOCK_STREAM, 0);
2755 fprintf(stderr, "ERROR opening socket");
2759 /* allow us to restart even if old sockets in TIME_WAIT */
2760 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
2765 setsockopt(sockfd, IPPROTO_TCP, TCP_NODELAY, &opt, sizeof(opt));
2767 bzero((char *) &serv_addr, sizeof(serv_addr));
2768 serv_addr.sin_family = AF_INET;
2770 serv_addr.sin_addr.s_addr = INADDR_ANY;
2772 interface_to_sa(interf, &serv_addr,
2774 serv_addr.sin_port = htons(port);
2776 n = bind(sockfd, (struct sockaddr *) &serv_addr,
2779 fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
2784 wsi = malloc(sizeof(struct libwebsocket));
2785 memset(wsi, 0, sizeof (struct libwebsocket));
2787 wsi->count_active_extensions = 0;
2788 wsi->mode = LWS_CONNMODE_SERVER_LISTENER;
2789 insert_wsi(context, wsi);
2792 fprintf(stderr, " Listening on port %d\n", port);
2794 /* list in the internal poll array */
2796 context->fds[context->fds_count].fd = sockfd;
2797 context->fds[context->fds_count++].events = POLLIN;
2799 /* external POLL support via protocol 0 */
2800 context->protocols[0].callback(context, wsi,
2801 LWS_CALLBACK_ADD_POLL_FD,
2802 (void *)(long)sockfd, NULL, POLLIN);
2806 /* drop any root privs for this process */
2811 fprintf(stderr, "setgid: %s\n", strerror(errno));
2814 fprintf(stderr, "setuid: %s\n", strerror(errno));
2817 /* set up our internal broadcast trigger sockets per-protocol */
2819 for (context->count_protocols = 0;
2820 protocols[context->count_protocols].callback;
2821 context->count_protocols++) {
2823 fprintf(stderr, " Protocol: %s\n", protocols[context->count_protocols].name);
2825 protocols[context->count_protocols].owning_server = context;
2826 protocols[context->count_protocols].protocol_index =
2827 context->count_protocols;
2829 fd = socket(AF_INET, SOCK_STREAM, 0);
2831 fprintf(stderr, "ERROR opening socket");
2835 /* allow us to restart even if old sockets in TIME_WAIT */
2836 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
2838 bzero((char *) &serv_addr, sizeof(serv_addr));
2839 serv_addr.sin_family = AF_INET;
2840 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
2841 serv_addr.sin_port = 0; /* pick the port for us */
2843 n = bind(fd, (struct sockaddr *) &serv_addr, sizeof(serv_addr));
2845 fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
2850 slen = sizeof cli_addr;
2851 n = getsockname(fd, (struct sockaddr *)&cli_addr, &slen);
2853 fprintf(stderr, "getsockname failed\n");
2856 protocols[context->count_protocols].broadcast_socket_port =
2857 ntohs(cli_addr.sin_port);
2860 debug(" Protocol %s broadcast socket %d\n",
2861 protocols[context->count_protocols].name,
2862 ntohs(cli_addr.sin_port));
2864 /* dummy wsi per broadcast proxy socket */
2866 wsi = malloc(sizeof(struct libwebsocket));
2867 memset(wsi, 0, sizeof (struct libwebsocket));
2869 wsi->mode = LWS_CONNMODE_BROADCAST_PROXY_LISTENER;
2870 wsi->count_active_extensions = 0;
2871 /* note which protocol we are proxying */
2872 wsi->protocol_index_for_broadcast_proxy =
2873 context->count_protocols;
2874 insert_wsi(context, wsi);
2876 /* list in internal poll array */
2878 context->fds[context->fds_count].fd = fd;
2879 context->fds[context->fds_count].events = POLLIN;
2880 context->fds[context->fds_count].revents = 0;
2881 context->fds_count++;
2883 /* external POLL support via protocol 0 */
2884 context->protocols[0].callback(context, wsi,
2885 LWS_CALLBACK_ADD_POLL_FD,
2886 (void *)(long)fd, NULL, POLLIN);
2890 * give all extensions a chance to create any per-context
2891 * allocations they need
2894 m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_CONSTRUCT;
2896 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_CONSTRUCT;
2897 while (extensions->callback) {
2898 fprintf(stderr, " Extension: %s\n", extensions->name);
2899 extensions->callback(context, extensions,
2900 NULL, m, NULL, NULL, 0);
2911 * libwebsockets_fork_service_loop() - Optional helper function forks off
2912 * a process for the websocket server loop.
2913 * You don't have to use this but if not, you
2914 * have to make sure you are calling
2915 * libwebsocket_service periodically to service
2916 * the websocket traffic
2917 * @context: server context returned by creation function
2921 libwebsockets_fork_service_loop(struct libwebsocket_context *context)
2924 struct sockaddr_in cli_addr;
2934 /* main process context */
2937 * set up the proxy sockets to allow broadcast from
2938 * service process context
2941 for (p = 0; p < context->count_protocols; p++) {
2942 fd = socket(AF_INET, SOCK_STREAM, 0);
2944 fprintf(stderr, "Unable to create socket\n");
2947 cli_addr.sin_family = AF_INET;
2948 cli_addr.sin_port = htons(
2949 context->protocols[p].broadcast_socket_port);
2950 cli_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
2951 n = connect(fd, (struct sockaddr *)&cli_addr,
2954 fprintf(stderr, "Unable to connect to "
2955 "broadcast socket %d, %s\n",
2956 n, strerror(errno));
2960 context->protocols[p].broadcast_socket_user_fd = fd;
2966 /* we want a SIGHUP when our parent goes down */
2967 prctl(PR_SET_PDEATHSIG, SIGHUP);
2969 /* in this forked process, sit and service websocket connections */
2972 if (libwebsocket_service(context, 1000))
2981 * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
2983 * @wsi: pointer to struct websocket you want to know the protocol of
2986 * This is useful to get the protocol to broadcast back to from inside
2990 const struct libwebsocket_protocols *
2991 libwebsockets_get_protocol(struct libwebsocket *wsi)
2993 return wsi->protocol;
2997 * libwebsockets_broadcast() - Sends a buffer to the callback for all active
2998 * connections of the given protocol.
2999 * @protocol: pointer to the protocol you will broadcast to all members of
3000 * @buf: buffer containing the data to be broadcase. NOTE: this has to be
3001 * allocated with LWS_SEND_BUFFER_PRE_PADDING valid bytes before
3002 * the pointer and LWS_SEND_BUFFER_POST_PADDING afterwards in the
3003 * case you are calling this function from callback context.
3004 * @len: length of payload data in buf, starting from buf.
3006 * This function allows bulk sending of a packet to every connection using
3007 * the given protocol. It does not send the data directly; instead it calls
3008 * the callback with a reason type of LWS_CALLBACK_BROADCAST. If the callback
3009 * wants to actually send the data for that connection, the callback itself
3010 * should call libwebsocket_write().
3012 * libwebsockets_broadcast() can be called from another fork context without
3013 * having to take any care about data visibility between the processes, it'll
3019 libwebsockets_broadcast(const struct libwebsocket_protocols *protocol,
3020 unsigned char *buf, size_t len)
3022 struct libwebsocket_context *context = protocol->owning_server;
3025 struct libwebsocket * wsi;
3027 if (!protocol->broadcast_socket_user_fd) {
3029 * We are either running unforked / flat, or we are being
3030 * called from poll thread context
3031 * eg, from a callback. In that case don't use sockets for
3032 * broadcast IPC (since we can't open a socket connection to
3033 * a socket listening on our own thread) but directly do the
3036 * Locking is not needed because we are by definition being
3037 * called in the poll thread context and are serialized.
3040 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
3042 for (m = 0; m < context->fd_hashtable[n].length; m++) {
3044 wsi = context->fd_hashtable[n].wsi[m];
3046 if (wsi->mode != LWS_CONNMODE_WS_SERVING)
3050 * never broadcast to
3051 * non-established connections
3053 if (wsi->state != WSI_STATE_ESTABLISHED)
3056 /* only broadcast to guys using
3057 * requested protocol
3059 if (wsi->protocol != protocol)
3062 wsi->protocol->callback(context, wsi,
3063 LWS_CALLBACK_BROADCAST,
3073 * We're being called from a different process context than the server
3074 * loop. Instead of broadcasting directly, we send our
3075 * payload on a socket to do the IPC; the server process will serialize
3076 * the broadcast action in its main poll() loop.
3078 * There's one broadcast socket listening for each protocol supported
3079 * set up when the websocket server initializes
3082 n = send(protocol->broadcast_socket_user_fd, buf, len, MSG_NOSIGNAL);
3088 libwebsocket_is_final_fragment(struct libwebsocket *wsi)