2 * libwebsockets - small server side websockets and web server implementation
4 * Copyright (C) 2010 Andy Green <andy@warmcat.com>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation:
9 * version 2.1 of the License.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
22 #include "private-libwebsockets.h"
30 #ifdef LWS_OPENSSL_SUPPORT
31 int openssl_websocket_private_data_index;
35 * In-place str to lower case
47 /* file descriptor hash management */
50 wsi_from_fd(struct libwebsocket_context *context, int fd)
52 int h = LWS_FD_HASH(fd);
55 for (n = 0; n < context->fd_hashtable[h].length; n++)
56 if (context->fd_hashtable[h].wsi[n]->sock == fd)
57 return context->fd_hashtable[h].wsi[n];
63 insert_wsi(struct libwebsocket_context *context, struct libwebsocket *wsi)
65 int h = LWS_FD_HASH(wsi->sock);
67 if (context->fd_hashtable[h].length == MAX_CLIENTS - 1) {
68 fprintf(stderr, "hash table overflow\n");
72 context->fd_hashtable[h].wsi[context->fd_hashtable[h].length++] = wsi;
78 delete_from_fd(struct libwebsocket_context *context, int fd)
80 int h = LWS_FD_HASH(fd);
83 for (n = 0; n < context->fd_hashtable[h].length; n++)
84 if (context->fd_hashtable[h].wsi[n]->sock == fd) {
85 while (n < context->fd_hashtable[h].length) {
86 context->fd_hashtable[h].wsi[n] =
87 context->fd_hashtable[h].wsi[n + 1];
90 context->fd_hashtable[h].length--;
95 fprintf(stderr, "Failed to find fd %d requested for "
96 "delete in hashtable\n", fd);
100 #ifdef LWS_OPENSSL_SUPPORT
102 libwebsockets_decode_ssl_error(void)
107 while ((err = ERR_get_error()) != 0) {
108 ERR_error_string_n(err, buf, sizeof(buf));
109 fprintf(stderr, "*** %s\n", buf);
116 interface_to_sa(const char* ifname, struct sockaddr_in *addr, size_t addrlen)
124 struct sockaddr_in *sin;
127 for (ifc = ifr; ifc != NULL; ifc = ifc->ifa_next) {
128 if (strcmp(ifc->ifa_name, ifname))
130 if (ifc->ifa_addr == NULL)
132 sin = (struct sockaddr_in *)ifc->ifa_addr;
133 if (sin->sin_family != AF_INET)
135 memcpy(addr, sin, addrlen);
145 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
146 struct libwebsocket *wsi, enum lws_close_status reason)
150 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 2 +
151 LWS_SEND_BUFFER_POST_PADDING];
154 struct lws_tokens eff_buf;
159 old_state = wsi->state;
161 if (old_state == WSI_STATE_DEAD_SOCKET)
164 wsi->close_reason = reason;
167 * flush any tx pending from extensions, since we may send close packet
168 * if there are problems with send, just nuke the connection
174 /* default to nobody has more to spill */
177 eff_buf.token = NULL;
178 eff_buf.token_len = 0;
180 /* show every extension the new incoming data */
182 for (n = 0; n < wsi->count_active_extensions; n++) {
183 m = wsi->active_extensions[n]->callback(
184 wsi->protocol->owning_server, wsi,
185 LWS_EXT_CALLBACK_FLUSH_PENDING_TX,
186 wsi->active_extensions_user[n], &eff_buf, 0);
188 fprintf(stderr, "Extension reports "
190 goto just_kill_connection;
194 * at least one extension told us he has more
195 * to spill, so we will go around again after
200 /* assuming they left us something to send, send it */
202 if (eff_buf.token_len)
203 if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
205 goto just_kill_connection;
209 * signal we are closing, libsocket_write will
210 * add any necessary version-specific stuff. If the write fails,
211 * no worries we are closing anyway. If we didn't initiate this
212 * close, then our state has been changed to
213 * WSI_STATE_RETURNED_CLOSE_ALREADY and we will skip this.
215 * Likewise if it's a second call to close this connection after we
216 * sent the close indication to the peer already, we are in state
217 * WSI_STATE_AWAITING_CLOSE_ACK and will skip doing this a second time.
220 if (old_state == WSI_STATE_ESTABLISHED &&
221 reason != LWS_CLOSE_STATUS_NOSTATUS) {
222 n = libwebsocket_write(wsi, &buf[LWS_SEND_BUFFER_PRE_PADDING],
226 * we have sent a nice protocol level indication we
227 * now wish to close, we should not send anything more
230 wsi->state = WSI_STATE_AWAITING_CLOSE_ACK;
232 /* and we should wait for a reply for a bit */
234 libwebsocket_set_timeout(wsi,
235 PENDING_TIMEOUT_CLOSE_ACK, 5);
237 fprintf(stderr, "sent close indication, awaiting ack\n");
242 /* else, the send failed and we should just hang up */
245 just_kill_connection:
247 * we won't be servicing or receiving anything further from this guy
248 * remove this fd from wsi mapping hashtable
251 delete_from_fd(context, wsi->sock);
253 /* delete it from the internal poll list if still present */
255 for (n = 0; n < context->fds_count; n++) {
256 if (context->fds[n].fd != wsi->sock)
258 while (n < context->fds_count - 1) {
259 context->fds[n] = context->fds[n + 1];
262 context->fds_count--;
263 /* we only have to deal with one */
264 n = context->fds_count;
267 /* remove also from external POLL support via protocol 0 */
269 context->protocols[0].callback(context, wsi,
270 LWS_CALLBACK_DEL_POLL_FD, (void *)(long)wsi->sock, NULL, 0);
272 wsi->state = WSI_STATE_DEAD_SOCKET;
274 /* tell the user it's all over for this guy */
276 if (wsi->protocol && wsi->protocol->callback &&
277 old_state == WSI_STATE_ESTABLISHED)
278 wsi->protocol->callback(context, wsi, LWS_CALLBACK_CLOSED,
279 wsi->user_space, NULL, 0);
281 /* deallocate any active extension contexts */
283 for (n = 0; n < wsi->count_active_extensions; n++) {
284 if (!wsi->active_extensions[n]->callback)
287 wsi->active_extensions[n]->callback(context, wsi,
288 LWS_EXT_CALLBACK_DESTROY,
289 wsi->active_extensions_user[n], NULL, 0);
291 free(wsi->active_extensions_user[n]);
294 /* free up his parsing allocations */
296 for (n = 0; n < WSI_TOKEN_COUNT; n++)
297 if (wsi->utf8_token[n].token)
298 free(wsi->utf8_token[n].token);
300 /* fprintf(stderr, "closing fd=%d\n", wsi->sock); */
302 #ifdef LWS_OPENSSL_SUPPORT
304 n = SSL_get_fd(wsi->ssl);
305 SSL_shutdown(wsi->ssl);
314 shutdown(wsi->sock, SHUT_RDWR);
316 closesocket(wsi->sock);
320 #ifdef LWS_OPENSSL_SUPPORT
324 free(wsi->user_space);
330 * libwebsockets_hangup_on_client() - Server calls to terminate client
332 * @context: libwebsockets context
333 * @fd: Connection socket descriptor
337 libwebsockets_hangup_on_client(struct libwebsocket_context *context, int fd)
339 struct libwebsocket *wsi = wsi_from_fd(context, fd);
344 libwebsocket_close_and_free_session(context, wsi,
345 LWS_CLOSE_STATUS_NOSTATUS);
350 * libwebsockets_get_peer_addresses() - Get client address information
351 * @fd: Connection socket descriptor
352 * @name: Buffer to take client address name
353 * @name_len: Length of client address name buffer
354 * @rip: Buffer to take client address IP qotted quad
355 * @rip_len: Length of client address IP buffer
357 * This function fills in @name and @rip with the name and IP of
358 * the client connected with socket descriptor @fd. Names may be
359 * truncated if there is not enough room. If either cannot be
360 * determined, they will be returned as valid zero-length strings.
364 libwebsockets_get_peer_addresses(int fd, char *name, int name_len,
365 char *rip, int rip_len)
368 struct sockaddr_in sin;
369 struct hostent *host;
370 struct hostent *host1;
379 if (getpeername(fd, (struct sockaddr *) &sin, &len) < 0) {
380 perror("getpeername");
384 host = gethostbyaddr((char *) &sin.sin_addr, sizeof sin.sin_addr,
387 perror("gethostbyaddr");
391 strncpy(name, host->h_name, name_len);
392 name[name_len - 1] = '\0';
394 host1 = gethostbyname(host->h_name);
400 p = host1->h_addr_list[n++];
403 if (host1->h_addrtype != AF_INET)
406 sprintf(ip, "%d.%d.%d.%d",
407 p[0], p[1], p[2], p[3]);
409 strncpy(rip, ip, rip_len);
410 rip[rip_len - 1] = '\0';
414 int libwebsockets_get_random(struct libwebsocket_context *context,
421 for (n = 0; n < len; n++)
422 p[n] = (unsigned char)rand();
424 n = read(context->fd_random, p, len);
431 libwebsockets_SHA1(const unsigned char *d, size_t n, unsigned char *md)
433 return SHA1(d, n, md);
436 void libwebsockets_00_spaceout(char *key, int spaces, int seed)
442 if (*key && (seed & 1))
446 p = key + strlen(key);
455 void libwebsockets_00_spam(char *key, int count, int seed)
462 if (*key && (seed & 1))
466 p = key + strlen(key);
471 *key++ = 0x21 + ((seed & 0xffff) % 15);
472 /* 4 would use it up too fast.. not like it matters */
477 int lws_send_pipe_choked(struct libwebsocket *wsi)
482 fds.events = POLLOUT;
485 if (poll(&fds, 1, 0) != 1)
488 if ((fds.revents & POLLOUT) == 0)
491 /* okay to send another packet without blocking */
497 lws_handle_POLLOUT_event(struct libwebsocket_context *context,
498 struct libwebsocket *wsi, struct pollfd *pollfd)
500 struct lws_tokens eff_buf;
505 if (!wsi->extension_data_pending)
509 * check in on the active extensions, see if they
510 * had pending stuff to spill... they need to get the
511 * first look-in otherwise sequence will be disordered
513 * NULL, zero-length eff_buf means just spill pending
519 /* default to nobody has more to spill */
522 eff_buf.token = NULL;
523 eff_buf.token_len = 0;
525 /* give every extension a chance to spill */
527 for (n = 0; n < wsi->count_active_extensions; n++) {
528 m = wsi->active_extensions[n]->callback(
529 wsi->protocol->owning_server, wsi,
530 LWS_EXT_CALLBACK_PACKET_TX_PRESEND,
531 wsi->active_extensions_user[n], &eff_buf, 0);
533 fprintf(stderr, "extension reports fatal error\n");
538 * at least one extension told us he has more
539 * to spill, so we will go around again after
544 /* assuming they gave us something to send, send it */
546 if (eff_buf.token_len) {
547 if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
553 /* no extension has more to spill */
559 * There's more to spill from an extension, but we just sent
560 * something... did that leave the pipe choked?
563 if (!lws_send_pipe_choked(wsi))
564 /* no we could add more */
567 fprintf(stderr, "choked in POLLOUT service\n");
570 * Yes, he's choked. Leave the POLLOUT masked on so we will
571 * come back here when he is unchoked. Don't call the user
572 * callback to enforce ordering of spilling, he'll get called
573 * when we come back here and there's nothing more to spill.
579 wsi->extension_data_pending = 0;
584 pollfd->events &= ~POLLOUT;
586 /* external POLL support via protocol 0 */
587 context->protocols[0].callback(context, wsi,
588 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
589 (void *)(long)wsi->sock, NULL, POLLOUT);
591 if (wsi->mode == LWS_CONNMODE_WS_CLIENT)
592 n = LWS_CALLBACK_CLIENT_WRITEABLE;
594 n = LWS_CALLBACK_SERVER_WRITEABLE;
596 wsi->protocol->callback(context, wsi, n, wsi->user_space, NULL, 0);
604 * libwebsocket_service_fd() - Service polled socket with something waiting
605 * @context: Websocket context
606 * @pollfd: The pollfd entry describing the socket fd and which events
609 * This function closes any active connections and then frees the
610 * context. After calling this, any further use of the context is
615 libwebsocket_service_fd(struct libwebsocket_context *context,
616 struct pollfd *pollfd)
618 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 1 + MAX_BROADCAST_PAYLOAD +
619 LWS_SEND_BUFFER_POST_PADDING];
620 struct libwebsocket *wsi;
621 struct libwebsocket *new_wsi;
627 struct sockaddr_in cli_addr;
629 static const char magic_websocket_guid[] =
630 "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
631 static const char magic_websocket_04_masking_guid[] =
632 "61AC5F19-FBBA-4540-B96F-6561F1AB40A8";
641 struct lws_tokens eff_buf;
643 struct libwebsocket_extension *ext;
646 #ifdef LWS_OPENSSL_SUPPORT
647 char ssl_err_buf[512];
650 * you can call us with pollfd = NULL to just allow the once-per-second
651 * global timeout checks; if less than a second since the last check
652 * it returns immediately then.
655 gettimeofday(&tv, NULL);
657 if (context->last_timeout_check_s != tv.tv_sec) {
658 context->last_timeout_check_s = tv.tv_sec;
660 /* global timeout check once per second */
662 for (n = 0; n < context->fds_count; n++) {
663 wsi = wsi_from_fd(context, context->fds[n].fd);
664 if (!wsi->pending_timeout)
668 * if we went beyond the allowed time, kill the
672 if (tv.tv_sec > wsi->pending_timeout_limit) {
673 fprintf(stderr, "TIMEDOUT WAITING\n");
674 libwebsocket_close_and_free_session(context,
675 wsi, LWS_CLOSE_STATUS_NOSTATUS);
680 /* just here for timeout management? */
685 /* no, here to service a socket descriptor */
687 wsi = wsi_from_fd(context, pollfd->fd);
693 case LWS_CONNMODE_SERVER_LISTENER:
695 /* pollin means a client has connected to us then */
697 if (!pollfd->revents & POLLIN)
700 /* listen socket got an unencrypted connection... */
702 clilen = sizeof(cli_addr);
703 accept_fd = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
706 fprintf(stderr, "ERROR on accept");
712 setsockopt(accept_fd, SOL_TCP, TCP_NODELAY, &opt, sizeof(opt));
714 if (context->fds_count >= MAX_CLIENTS) {
715 fprintf(stderr, "too busy to accept new client\n");
717 closesocket(accept_fd);
725 * look at who we connected to and give user code a chance
726 * to reject based on client IP. There's no protocol selected
727 * yet so we issue this to protocols[0]
730 if ((context->protocols[0].callback)(context, wsi,
731 LWS_CALLBACK_FILTER_NETWORK_CONNECTION,
732 (void*)(long)accept_fd, NULL, 0)) {
733 fprintf(stderr, "Callback denied network connection\n");
735 closesocket(accept_fd);
742 /* accepting connection to main listener */
744 new_wsi = malloc(sizeof(struct libwebsocket));
745 if (new_wsi == NULL) {
746 fprintf(stderr, "Out of memory for new connection\n");
750 memset(new_wsi, 0, sizeof (struct libwebsocket));
751 new_wsi->sock = accept_fd;
752 new_wsi->count_active_extensions = 0;
753 new_wsi->pending_timeout = NO_PENDING_TIMEOUT;
755 #ifdef LWS_OPENSSL_SUPPORT
758 if (context->use_ssl) {
760 new_wsi->ssl = SSL_new(context->ssl_ctx);
761 if (new_wsi->ssl == NULL) {
762 fprintf(stderr, "SSL_new failed: %s\n",
763 ERR_error_string(SSL_get_error(
764 new_wsi->ssl, 0), NULL));
765 libwebsockets_decode_ssl_error();
770 SSL_set_fd(new_wsi->ssl, accept_fd);
772 n = SSL_accept(new_wsi->ssl);
775 * browsers seem to probe with various
776 * ssl params which fail then retry
779 debug("SSL_accept failed skt %u: %s\n",
781 ERR_error_string(SSL_get_error(
782 new_wsi->ssl, n), NULL));
789 debug("accepted new SSL conn "
790 "port %u on fd=%d SSL ver %s\n",
791 ntohs(cli_addr.sin_port), accept_fd,
792 SSL_get_version(new_wsi->ssl));
796 debug("accepted new conn port %u on fd=%d\n",
797 ntohs(cli_addr.sin_port), accept_fd);
799 /* intialize the instance struct */
801 new_wsi->state = WSI_STATE_HTTP;
802 new_wsi->name_buffer_pos = 0;
803 new_wsi->mode = LWS_CONNMODE_WS_SERVING;
805 for (n = 0; n < WSI_TOKEN_COUNT; n++) {
806 new_wsi->utf8_token[n].token = NULL;
807 new_wsi->utf8_token[n].token_len = 0;
811 * these can only be set once the protocol is known
812 * we set an unestablished connection's protocol pointer
813 * to the start of the supported list, so it can look
814 * for matching ones during the handshake
816 new_wsi->protocol = context->protocols;
817 new_wsi->user_space = NULL;
820 * Default protocol is 76 / 00
821 * After 76, there's a header specified to inform which
822 * draft the client wants, when that's seen we modify
823 * the individual connection's spec revision accordingly
825 new_wsi->ietf_spec_revision = 0;
827 insert_wsi(context, new_wsi);
830 * make sure NO events are seen yet on this new socket
831 * (otherwise we inherit old fds[client].revents from
832 * previous socket there and die mysteriously! )
834 context->fds[context->fds_count].revents = 0;
836 context->fds[context->fds_count].events = POLLIN;
837 context->fds[context->fds_count++].fd = accept_fd;
839 /* external POLL support via protocol 0 */
840 context->protocols[0].callback(context, new_wsi,
841 LWS_CALLBACK_ADD_POLL_FD,
842 (void *)(long)accept_fd, NULL, POLLIN);
846 case LWS_CONNMODE_BROADCAST_PROXY_LISTENER:
848 /* as we are listening, POLLIN means accept() is needed */
850 if (!pollfd->revents & POLLIN)
853 /* listen socket got an unencrypted connection... */
855 clilen = sizeof(cli_addr);
856 accept_fd = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
859 fprintf(stderr, "ERROR on accept");
863 if (context->fds_count >= MAX_CLIENTS) {
864 fprintf(stderr, "too busy to accept new broadcast "
867 closesocket(accept_fd);
874 /* create a dummy wsi for the connection and add it */
876 new_wsi = malloc(sizeof(struct libwebsocket));
877 memset(new_wsi, 0, sizeof (struct libwebsocket));
878 new_wsi->sock = accept_fd;
879 new_wsi->mode = LWS_CONNMODE_BROADCAST_PROXY;
880 new_wsi->state = WSI_STATE_ESTABLISHED;
881 new_wsi->count_active_extensions = 0;
882 /* note which protocol we are proxying */
883 new_wsi->protocol_index_for_broadcast_proxy =
884 wsi->protocol_index_for_broadcast_proxy;
885 insert_wsi(context, new_wsi);
887 /* add connected socket to internal poll array */
889 context->fds[context->fds_count].revents = 0;
890 context->fds[context->fds_count].events = POLLIN;
891 context->fds[context->fds_count++].fd = accept_fd;
893 /* external POLL support via protocol 0 */
894 context->protocols[0].callback(context, new_wsi,
895 LWS_CALLBACK_ADD_POLL_FD,
896 (void *)(long)accept_fd, NULL, POLLIN);
900 case LWS_CONNMODE_BROADCAST_PROXY:
902 /* handle session socket closed */
904 if (pollfd->revents & (POLLERR | POLLHUP)) {
906 debug("Session Socket %p (fd=%d) dead\n",
907 (void *)wsi, pollfd->fd);
909 libwebsocket_close_and_free_session(context, wsi,
910 LWS_CLOSE_STATUS_NORMAL);
915 * either extension code with stuff to spill, or the user code,
916 * requested a callback when it was OK to write
919 if (pollfd->revents & POLLOUT)
920 if (lws_handle_POLLOUT_event(context, wsi, pollfd) < 0) {
921 libwebsocket_close_and_free_session(context, wsi,
922 LWS_CLOSE_STATUS_NORMAL);
926 /* any incoming data ready? */
928 if (!(pollfd->revents & POLLIN))
931 /* get the issued broadcast payload from the socket */
933 len = read(pollfd->fd, buf + LWS_SEND_BUFFER_PRE_PADDING,
934 MAX_BROADCAST_PAYLOAD);
936 fprintf(stderr, "Error reading broadcast payload\n");
940 /* broadcast it to all guys with this protocol index */
942 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
944 for (m = 0; m < context->fd_hashtable[n].length; m++) {
946 new_wsi = context->fd_hashtable[n].wsi[m];
948 /* only to clients we are serving to */
950 if (new_wsi->mode != LWS_CONNMODE_WS_SERVING)
954 * never broadcast to non-established
958 if (new_wsi->state != WSI_STATE_ESTABLISHED)
962 * only broadcast to connections using
963 * the requested protocol
966 if (new_wsi->protocol->protocol_index !=
967 wsi->protocol_index_for_broadcast_proxy)
970 /* broadcast it to this connection */
972 new_wsi->protocol->callback(context, new_wsi,
973 LWS_CALLBACK_BROADCAST,
975 buf + LWS_SEND_BUFFER_PRE_PADDING, len);
980 case LWS_CONNMODE_WS_CLIENT_WAITING_PROXY_REPLY:
982 /* handle proxy hung up on us */
984 if (pollfd->revents & (POLLERR | POLLHUP)) {
986 fprintf(stderr, "Proxy connection %p (fd=%d) dead\n",
987 (void *)wsi, pollfd->fd);
989 libwebsocket_close_and_free_session(context, wsi,
990 LWS_CLOSE_STATUS_NOSTATUS);
994 n = recv(wsi->sock, pkt, sizeof pkt, 0);
996 libwebsocket_close_and_free_session(context, wsi,
997 LWS_CLOSE_STATUS_NOSTATUS);
998 fprintf(stderr, "ERROR reading from proxy socket\n");
1003 if (strcmp(pkt, "HTTP/1.0 200 ") != 0) {
1004 libwebsocket_close_and_free_session(context, wsi,
1005 LWS_CLOSE_STATUS_NOSTATUS);
1006 fprintf(stderr, "ERROR from proxy: %s\n", pkt);
1010 /* clear his proxy connection timeout */
1012 libwebsocket_set_timeout(wsi, NO_PENDING_TIMEOUT, 0);
1016 case LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE:
1018 #ifdef LWS_OPENSSL_SUPPORT
1021 wsi->ssl = SSL_new(context->ssl_client_ctx);
1022 wsi->client_bio = BIO_new_socket(wsi->sock,
1024 SSL_set_bio(wsi->ssl, wsi->client_bio, wsi->client_bio);
1026 SSL_set_ex_data(wsi->ssl,
1027 openssl_websocket_private_data_index,
1030 if (SSL_connect(wsi->ssl) <= 0) {
1031 fprintf(stderr, "SSL connect error %s\n",
1032 ERR_error_string(ERR_get_error(),
1034 libwebsocket_close_and_free_session(context, wsi,
1035 LWS_CLOSE_STATUS_NOSTATUS);
1039 n = SSL_get_verify_result(wsi->ssl);
1040 if ((n != X509_V_OK) && (
1041 n != X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT ||
1042 wsi->use_ssl != 2)) {
1044 fprintf(stderr, "server's cert didn't "
1045 "look good %d\n", n);
1046 libwebsocket_close_and_free_session(context,
1047 wsi, LWS_CLOSE_STATUS_NOSTATUS);
1055 #ifdef LWS_OPENSSL_SUPPORT
1060 * create the random key
1063 n = libwebsockets_get_random(context, hash, 16);
1065 fprintf(stderr, "Unable to read from random dev %s\n",
1066 SYSTEM_RANDOM_FILEPATH);
1070 free(wsi->c_origin);
1071 if (wsi->c_protocol)
1072 free(wsi->c_protocol);
1073 libwebsocket_close_and_free_session(context, wsi,
1074 LWS_CLOSE_STATUS_NOSTATUS);
1078 lws_b64_encode_string(hash, 16, wsi->key_b64,
1079 sizeof wsi->key_b64);
1082 * 00 example client handshake
1084 * GET /socket.io/websocket HTTP/1.1
1085 * Upgrade: WebSocket
1086 * Connection: Upgrade
1087 * Host: 127.0.0.1:9999
1088 * Origin: http://127.0.0.1
1089 * Sec-WebSocket-Key1: 1 0 2#0W 9 89 7 92 ^
1090 * Sec-WebSocket-Key2: 7 7Y 4328 B2v[8(z1
1091 * Cookie: socketio=websocket
1095 * 04 example client handshake
1097 * GET /chat HTTP/1.1
1098 * Host: server.example.com
1099 * Upgrade: websocket
1100 * Connection: Upgrade
1101 * Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
1102 * Sec-WebSocket-Origin: http://example.com
1103 * Sec-WebSocket-Protocol: chat, superchat
1104 * Sec-WebSocket-Version: 4
1107 p += sprintf(p, "GET %s HTTP/1.1\x0d\x0a", wsi->c_path);
1109 if (wsi->ietf_spec_revision == 0) {
1110 unsigned char spaces_1, spaces_2;
1111 unsigned int max_1, max_2;
1112 unsigned int num_1, num_2;
1113 unsigned long product_1, product_2;
1120 libwebsockets_get_random(context, &spaces_1,
1122 libwebsockets_get_random(context, &spaces_2,
1125 spaces_1 = (spaces_1 % 12) + 1;
1126 spaces_2 = (spaces_2 % 12) + 1;
1128 max_1 = 4294967295 / spaces_1;
1129 max_2 = 4294967295 / spaces_2;
1131 libwebsockets_get_random(context, &num_1, sizeof(int));
1132 libwebsockets_get_random(context, &num_2, sizeof(int));
1134 num_1 = (num_1 % max_1);
1135 num_2 = (num_2 % max_2);
1137 challenge[0] = num_1 >> 24;
1138 challenge[1] = num_1 >> 16;
1139 challenge[2] = num_1 >> 8;
1140 challenge[3] = num_1;
1141 challenge[4] = num_2 >> 24;
1142 challenge[5] = num_2 >> 16;
1143 challenge[6] = num_2 >> 8;
1144 challenge[7] = num_2;
1146 product_1 = num_1 * spaces_1;
1147 product_2 = num_2 * spaces_2;
1149 sprintf(key_1, "%lu", product_1);
1150 sprintf(key_2, "%lu", product_2);
1152 libwebsockets_get_random(context, &seed, sizeof(int));
1153 libwebsockets_get_random(context, &count, sizeof(int));
1155 libwebsockets_00_spam(key_1, (count % 12) + 1, seed);
1157 libwebsockets_get_random(context, &seed, sizeof(int));
1158 libwebsockets_get_random(context, &count, sizeof(int));
1160 libwebsockets_00_spam(key_2, (count % 12) + 1, seed);
1162 libwebsockets_get_random(context, &seed, sizeof(int));
1164 libwebsockets_00_spaceout(key_1, spaces_1, seed);
1165 libwebsockets_00_spaceout(key_2, spaces_2, seed >> 16);
1167 p += sprintf(p, "Upgrade: websocket\x0d\x0a"
1168 "Connection: Upgrade\x0d\x0aHost: %s\x0d\x0a",
1171 p += sprintf(p, "Origin: %s\x0d\x0a",
1174 if (wsi->c_protocol)
1175 p += sprintf(p, "Sec-WebSocket-Protocol: %s"
1176 "\x0d\x0a", wsi->c_protocol);
1178 p += sprintf(p, "Sec-WebSocket-Key1: %s\x0d\x0a",
1180 p += sprintf(p, "Sec-WebSocket-Key2: %s\x0d\x0a",
1183 /* give userland a chance to append, eg, cookies */
1185 context->protocols[0].callback(context, wsi,
1186 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER,
1187 NULL, &p, (pkt + sizeof(pkt)) - p - 12);
1189 p += sprintf(p, "\x0d\x0a");
1191 if (libwebsockets_get_random(context, p, 8) != 8)
1193 memcpy(&challenge[8], p, 8);
1196 /* precompute what we want to see from the server */
1198 MD5((unsigned char *)challenge, 16,
1199 (unsigned char *)wsi->initial_handshake_hash_base64);
1204 p += sprintf(p, "Host: %s\x0d\x0a", wsi->c_host);
1205 p += sprintf(p, "Upgrade: websocket\x0d\x0a");
1206 p += sprintf(p, "Connection: Upgrade\x0d\x0a"
1207 "Sec-WebSocket-Key: ");
1208 strcpy(p, wsi->key_b64);
1209 p += strlen(wsi->key_b64);
1210 p += sprintf(p, "\x0d\x0a");
1212 p += sprintf(p, "Sec-WebSocket-Origin: %s\x0d\x0a",
1214 if (wsi->c_protocol)
1215 p += sprintf(p, "Sec-WebSocket-Protocol: %s\x0d\x0a",
1218 /* tell the server what extensions we could support */
1220 p += sprintf(p, "Sec-WebSocket-Extensions: ");
1222 ext =context->extensions;
1223 while (ext && ext->callback) {
1226 n = context->protocols[0].callback(context, wsi,
1227 LWS_CALLBACK_CLIENT_CONFIRM_EXTENSION_SUPPORTED,
1228 wsi->user_space, (char *)ext->name, 0);
1231 * zero return from callback means
1232 * go ahead and allow the extension,
1233 * it's what we get if the callback is
1246 p += sprintf(p, "%s", ext->name);
1252 p += sprintf(p, "\x0d\x0a");
1254 if (wsi->ietf_spec_revision)
1255 p += sprintf(p, "Sec-WebSocket-Version: %d\x0d\x0a",
1256 wsi->ietf_spec_revision);
1258 /* give userland a chance to append, eg, cookies */
1260 context->protocols[0].callback(context, wsi,
1261 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER,
1262 NULL, &p, (pkt + sizeof(pkt)) - p - 12);
1264 p += sprintf(p, "\x0d\x0a");
1266 /* prepare the expected server accept response */
1268 strcpy((char *)buf, wsi->key_b64);
1269 strcpy((char *)&buf[strlen((char *)buf)], magic_websocket_guid);
1271 SHA1(buf, strlen((char *)buf), (unsigned char *)hash);
1273 lws_b64_encode_string(hash, 20,
1274 wsi->initial_handshake_hash_base64,
1275 sizeof wsi->initial_handshake_hash_base64);
1279 /* done with these now */
1284 free(wsi->c_origin);
1286 /* send our request to the server */
1288 #ifdef LWS_OPENSSL_SUPPORT
1290 n = SSL_write(wsi->ssl, pkt, p - pkt);
1293 n = send(wsi->sock, pkt, p - pkt, 0);
1296 fprintf(stderr, "ERROR writing to client socket\n");
1297 libwebsocket_close_and_free_session(context, wsi,
1298 LWS_CLOSE_STATUS_NOSTATUS);
1302 wsi->parser_state = WSI_TOKEN_NAME_PART;
1303 wsi->mode = LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY;
1304 libwebsocket_set_timeout(wsi,
1305 PENDING_TIMEOUT_AWAITING_SERVER_RESPONSE, 5);
1309 case LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY:
1311 /* handle server hung up on us */
1313 if (pollfd->revents & (POLLERR | POLLHUP)) {
1315 fprintf(stderr, "Server connection %p (fd=%d) dead\n",
1316 (void *)wsi, pollfd->fd);
1322 /* interpret the server response */
1325 * HTTP/1.1 101 Switching Protocols
1326 * Upgrade: websocket
1327 * Connection: Upgrade
1328 * Sec-WebSocket-Accept: me89jWimTRKTWwrS3aRrL53YZSo=
1329 * Sec-WebSocket-Nonce: AQIDBAUGBwgJCgsMDQ4PEC==
1330 * Sec-WebSocket-Protocol: chat
1333 #ifdef LWS_OPENSSL_SUPPORT
1335 len = SSL_read(wsi->ssl, pkt, sizeof pkt);
1338 len = recv(wsi->sock, pkt, sizeof pkt, 0);
1342 "libwebsocket_client_handshake read error\n");
1347 for (n = 0; n < len; n++)
1348 libwebsocket_parse(wsi, *p++);
1350 if (wsi->parser_state != WSI_PARSING_COMPLETE) {
1351 fprintf(stderr, "libwebsocket_client_handshake "
1352 "server response failed parsing\n");
1359 * HTTP/1.1 101 WebSocket Protocol Handshake
1360 * Upgrade: WebSocket
1361 * Connection: Upgrade
1362 * Sec-WebSocket-Origin: http://127.0.0.1
1363 * Sec-WebSocket-Location: ws://127.0.0.1:9999/socket.io/websocket
1368 if (wsi->ietf_spec_revision == 0) {
1369 if (!wsi->utf8_token[WSI_TOKEN_HTTP].token_len ||
1370 !wsi->utf8_token[WSI_TOKEN_UPGRADE].token_len ||
1371 !wsi->utf8_token[WSI_TOKEN_CHALLENGE].token_len ||
1372 !wsi->utf8_token[WSI_TOKEN_CONNECTION].token_len ||
1373 (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len &&
1374 wsi->c_protocol != NULL)) {
1375 fprintf(stderr, "libwebsocket_client_handshake "
1376 "missing required header(s)\n");
1378 fprintf(stderr, "%s", pkt);
1382 strtolower(wsi->utf8_token[WSI_TOKEN_HTTP].token);
1383 if (strcmp(wsi->utf8_token[WSI_TOKEN_HTTP].token,
1384 "101 websocket protocol handshake")) {
1385 fprintf(stderr, "libwebsocket_client_handshake "
1386 "server sent bad HTTP response '%s'\n",
1387 wsi->utf8_token[WSI_TOKEN_HTTP].token);
1391 if (wsi->utf8_token[WSI_TOKEN_CHALLENGE].token_len <
1393 fprintf(stderr, "libwebsocket_client_handshake "
1394 "challenge reply too short %d\n",
1396 WSI_TOKEN_CHALLENGE].token_len);
1398 fprintf(stderr, "%s", pkt);
1403 goto select_protocol;
1407 * well, what the server sent looked reasonable for syntax.
1408 * Now let's confirm it sent all the necessary headers
1411 if (!wsi->utf8_token[WSI_TOKEN_HTTP].token_len ||
1412 !wsi->utf8_token[WSI_TOKEN_UPGRADE].token_len ||
1413 !wsi->utf8_token[WSI_TOKEN_CONNECTION].token_len ||
1414 !wsi->utf8_token[WSI_TOKEN_ACCEPT].token_len ||
1415 (!wsi->utf8_token[WSI_TOKEN_NONCE].token_len &&
1416 wsi->ietf_spec_revision == 4) ||
1417 (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len &&
1418 wsi->c_protocol != NULL)) {
1419 fprintf(stderr, "libwebsocket_client_handshake "
1420 "missing required header(s)\n");
1422 fprintf(stderr, "%s", pkt);
1427 * Everything seems to be there, now take a closer look at what
1431 strtolower(wsi->utf8_token[WSI_TOKEN_HTTP].token);
1432 if (strcmp(wsi->utf8_token[WSI_TOKEN_HTTP].token,
1433 "101 switching protocols")) {
1434 fprintf(stderr, "libwebsocket_client_handshake "
1435 "server sent bad HTTP response '%s'\n",
1436 wsi->utf8_token[WSI_TOKEN_HTTP].token);
1440 strtolower(wsi->utf8_token[WSI_TOKEN_UPGRADE].token);
1441 if (strcmp(wsi->utf8_token[WSI_TOKEN_UPGRADE].token,
1443 fprintf(stderr, "libwebsocket_client_handshake server "
1444 "sent bad Upgrade header '%s'\n",
1445 wsi->utf8_token[WSI_TOKEN_UPGRADE].token);
1449 strtolower(wsi->utf8_token[WSI_TOKEN_CONNECTION].token);
1450 if (strcmp(wsi->utf8_token[WSI_TOKEN_CONNECTION].token,
1452 fprintf(stderr, "libwebsocket_client_handshake server "
1453 "sent bad Connection hdr '%s'\n",
1454 wsi->utf8_token[WSI_TOKEN_CONNECTION].token);
1459 pc = wsi->c_protocol;
1462 * confirm the protocol the server wants to talk was in the list
1463 * of protocols we offered
1466 if (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len) {
1469 * no protocol name to work from,
1470 * default to first protocol
1472 wsi->protocol = &context->protocols[0];
1474 free(wsi->c_protocol);
1479 while (*pc && !okay) {
1481 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token,
1482 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len)) &&
1483 (pc[wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len] == ',' ||
1484 pc[wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len] == '\0')) {
1488 while (*pc && *pc != ',')
1490 while (*pc && *pc != ' ')
1494 /* done with him now */
1496 if (wsi->c_protocol)
1497 free(wsi->c_protocol);
1501 fprintf(stderr, "libwebsocket_client_handshake server "
1502 "sent bad protocol '%s'\n",
1503 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token);
1508 * identify the selected protocol struct and set it
1511 wsi->protocol = NULL;
1512 while (context->protocols[n].callback) {
1513 if (strcmp(wsi->utf8_token[WSI_TOKEN_PROTOCOL].token,
1514 context->protocols[n].name) == 0)
1515 wsi->protocol = &context->protocols[n];
1519 if (wsi->protocol == NULL) {
1520 fprintf(stderr, "libwebsocket_client_handshake server "
1521 "requested protocol '%s', which we "
1522 "said we supported but we don't!\n",
1523 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token);
1528 /* instantiate the accepted extensions */
1530 if (!wsi->utf8_token[WSI_TOKEN_EXTENSIONS].token_len)
1534 * break down the list of server accepted extensions
1535 * and go through matching them or identifying bogons
1538 c = wsi->utf8_token[WSI_TOKEN_EXTENSIONS].token;
1542 if (*c && *c != ',') {
1544 if (n < sizeof(ext_name) - 1)
1552 /* check we actually support it */
1555 ext = wsi->protocol->owning_server->extensions;
1556 while (ext && ext->callback) {
1558 if (strcmp(ext_name, ext->name)) {
1565 /* instantiate the extension on this conn */
1567 wsi->active_extensions_user[
1568 wsi->count_active_extensions] =
1569 malloc(ext->per_session_data_size);
1570 wsi->active_extensions[
1571 wsi->count_active_extensions] = ext;
1573 /* allow him to construct his context */
1575 ext->callback(wsi->protocol->owning_server,
1576 wsi, LWS_EXT_CALLBACK_CLIENT_CONSTRUCT,
1577 wsi->active_extensions_user[
1578 wsi->count_active_extensions], NULL, 0);
1580 wsi->count_active_extensions++;
1586 fprintf(stderr, "Server said we should use"
1587 "an unknown extension '%s'!\n", ext_name);
1597 if (wsi->ietf_spec_revision == 0) {
1599 if (memcmp(wsi->initial_handshake_hash_base64,
1600 wsi->utf8_token[WSI_TOKEN_CHALLENGE].token, 16)) {
1601 fprintf(stderr, "libwebsocket_client_handshake "
1602 "failed 00 challenge compare\n");
1604 fprintf(stderr, "%s", pkt);
1612 * Confirm his accept token is the one we precomputed
1615 if (strcmp(wsi->utf8_token[WSI_TOKEN_ACCEPT].token,
1616 wsi->initial_handshake_hash_base64)) {
1617 fprintf(stderr, "libwebsocket_client_handshake server "
1618 "sent bad ACCEPT '%s' vs computed '%s'\n",
1619 wsi->utf8_token[WSI_TOKEN_ACCEPT].token,
1620 wsi->initial_handshake_hash_base64);
1624 if (wsi->ietf_spec_revision == 4) {
1626 * Calculate the 04 masking key to use when
1627 * sending data to server
1630 strcpy((char *)buf, wsi->key_b64);
1631 p = (char *)buf + strlen(wsi->key_b64);
1632 strcpy(p, wsi->utf8_token[WSI_TOKEN_NONCE].token);
1633 p += wsi->utf8_token[WSI_TOKEN_NONCE].token_len;
1634 strcpy(p, magic_websocket_04_masking_guid);
1635 SHA1(buf, strlen((char *)buf), wsi->masking_key_04);
1639 /* allocate the per-connection user memory (if any) */
1641 if (wsi->protocol->per_session_data_size) {
1642 wsi->user_space = malloc(
1643 wsi->protocol->per_session_data_size);
1644 if (wsi->user_space == NULL) {
1645 fprintf(stderr, "Out of memory for "
1646 "conn user space\n");
1650 wsi->user_space = NULL;
1652 /* clear his proxy connection timeout */
1654 libwebsocket_set_timeout(wsi, NO_PENDING_TIMEOUT, 0);
1656 /* mark him as being alive */
1658 wsi->state = WSI_STATE_ESTABLISHED;
1659 wsi->mode = LWS_CONNMODE_WS_CLIENT;
1661 fprintf(stderr, "handshake OK for protocol %s\n",
1662 wsi->protocol->name);
1664 /* call him back to inform him he is up */
1666 wsi->protocol->callback(context, wsi,
1667 LWS_CALLBACK_CLIENT_ESTABLISHED,
1674 if (wsi->c_protocol)
1675 free(wsi->c_protocol);
1678 libwebsocket_close_and_free_session(context, wsi,
1679 LWS_CLOSE_STATUS_NOSTATUS);
1683 case LWS_CONNMODE_WS_SERVING:
1684 case LWS_CONNMODE_WS_CLIENT:
1686 /* handle session socket closed */
1688 if (pollfd->revents & (POLLERR | POLLHUP)) {
1690 fprintf(stderr, "Session Socket %p (fd=%d) dead\n",
1691 (void *)wsi, pollfd->fd);
1693 libwebsocket_close_and_free_session(context, wsi,
1694 LWS_CLOSE_STATUS_NOSTATUS);
1698 /* the guy requested a callback when it was OK to write */
1700 if ((pollfd->revents & POLLOUT) &&
1701 wsi->state == WSI_STATE_ESTABLISHED)
1702 if (lws_handle_POLLOUT_event(context, wsi,
1704 libwebsocket_close_and_free_session(
1705 context, wsi, LWS_CLOSE_STATUS_NORMAL);
1710 /* any incoming data ready? */
1712 if (!(pollfd->revents & POLLIN))
1715 #ifdef LWS_OPENSSL_SUPPORT
1717 eff_buf.token_len = SSL_read(wsi->ssl, buf, sizeof buf);
1721 recv(pollfd->fd, buf, sizeof buf, 0);
1723 if (eff_buf.token_len < 0) {
1724 fprintf(stderr, "Socket read returned %d\n",
1728 if (!eff_buf.token_len) {
1729 libwebsocket_close_and_free_session(context, wsi,
1730 LWS_CLOSE_STATUS_NOSTATUS);
1735 * give any active extensions a chance to munge the buffer
1736 * before parse. We pass in a pointer to an lws_tokens struct
1737 * prepared with the default buffer and content length that's in
1738 * there. Rather than rewrite the default buffer, extensions
1739 * that expect to grow the buffer can adapt .token to
1740 * point to their own per-connection buffer in the extension
1741 * user allocation. By default with no extensions or no
1742 * extension callback handling, just the normal input buffer is
1743 * used then so it is efficient.
1746 eff_buf.token = (char *)buf;
1753 for (n = 0; n < wsi->count_active_extensions; n++) {
1754 m = wsi->active_extensions[n]->callback(context, wsi,
1755 LWS_EXT_CALLBACK_PACKET_RX_PREPARSE,
1756 wsi->active_extensions_user[n], &eff_buf, 0);
1758 fprintf(stderr, "Extension reports fatal error\n");
1759 libwebsocket_close_and_free_session(context, wsi,
1760 LWS_CLOSE_STATUS_NOSTATUS);
1767 /* service incoming data */
1769 if (eff_buf.token_len) {
1770 n = libwebsocket_read(context, wsi,
1771 (unsigned char *)eff_buf.token, eff_buf.token_len);
1777 eff_buf.token = NULL;
1778 eff_buf.token_len = 0;
1788 * libwebsocket_context_destroy() - Destroy the websocket context
1789 * @context: Websocket context
1791 * This function closes any active connections and then frees the
1792 * context. After calling this, any further use of the context is
1796 libwebsocket_context_destroy(struct libwebsocket_context *context)
1800 struct libwebsocket *wsi;
1802 for (n = 0; n < FD_HASHTABLE_MODULUS; n++)
1803 for (m = 0; m < context->fd_hashtable[n].length; m++) {
1804 wsi = context->fd_hashtable[n].wsi[m];
1805 libwebsocket_close_and_free_session(context, wsi,
1806 LWS_CLOSE_STATUS_GOINGAWAY);
1811 close(context->fd_random);
1814 #ifdef LWS_OPENSSL_SUPPORT
1815 if (context->ssl_ctx)
1816 SSL_CTX_free(context->ssl_ctx);
1817 if (context->ssl_client_ctx)
1818 SSL_CTX_free(context->ssl_client_ctx);
1829 * libwebsocket_service() - Service any pending websocket activity
1830 * @context: Websocket context
1831 * @timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
1832 * service otherwise block and service immediately, returning
1833 * after the timeout if nothing needed service.
1835 * This function deals with any pending websocket traffic, for three
1836 * kinds of event. It handles these events on both server and client
1837 * types of connection the same.
1839 * 1) Accept new connections to our context's server
1841 * 2) Perform pending broadcast writes initiated from other forked
1842 * processes (effectively serializing asynchronous broadcasts)
1844 * 3) Call the receive callback for incoming frame data received by
1845 * server or client connections.
1847 * You need to call this service function periodically to all the above
1848 * functions to happen; if your application is single-threaded you can
1849 * just call it in your main event loop.
1851 * Alternatively you can fork a new process that asynchronously handles
1852 * calling this service in a loop. In that case you are happy if this
1853 * call blocks your thread until it needs to take care of something and
1854 * would call it with a large nonzero timeout. Your loop then takes no
1855 * CPU while there is nothing happening.
1857 * If you are calling it in a single-threaded app, you don't want it to
1858 * wait around blocking other things in your loop from happening, so you
1859 * would call it with a timeout_ms of 0, so it returns immediately if
1860 * nothing is pending, or as soon as it services whatever was pending.
1865 libwebsocket_service(struct libwebsocket_context *context, int timeout_ms)
1869 /* stay dead once we are dead */
1871 if (context == NULL)
1874 /* wait for something to need service */
1876 n = poll(context->fds, context->fds_count, timeout_ms);
1877 if (n == 0) /* poll timeout */
1882 fprintf(stderr, "Listen Socket dead\n");
1887 /* handle accept on listening socket? */
1889 for (n = 0; n < context->fds_count; n++)
1890 if (context->fds[n].revents)
1891 libwebsocket_service_fd(context, &context->fds[n]);
1897 * libwebsocket_callback_on_writable() - Request a callback when this socket
1898 * becomes able to be written to without
1901 * @context: libwebsockets context
1902 * @wsi: Websocket connection instance to get callback for
1906 libwebsocket_callback_on_writable(struct libwebsocket_context *context,
1907 struct libwebsocket *wsi)
1911 for (n = 0; n < context->fds_count; n++)
1912 if (context->fds[n].fd == wsi->sock) {
1913 context->fds[n].events |= POLLOUT;
1914 n = context->fds_count;
1917 /* external POLL support via protocol 0 */
1918 context->protocols[0].callback(context, wsi,
1919 LWS_CALLBACK_SET_MODE_POLL_FD,
1920 (void *)(long)wsi->sock, NULL, POLLOUT);
1926 * libwebsocket_callback_on_writable_all_protocol() - Request a callback for
1927 * all connections using the given protocol when it
1928 * becomes possible to write to each socket without
1931 * @protocol: Protocol whose connections will get callbacks
1935 libwebsocket_callback_on_writable_all_protocol(
1936 const struct libwebsocket_protocols *protocol)
1938 struct libwebsocket_context *context = protocol->owning_server;
1941 struct libwebsocket *wsi;
1943 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
1945 for (m = 0; m < context->fd_hashtable[n].length; m++) {
1947 wsi = context->fd_hashtable[n].wsi[m];
1949 if (wsi->protocol == protocol)
1950 libwebsocket_callback_on_writable(context, wsi);
1958 * libwebsocket_set_timeout() - marks the wsi as subject to a timeout
1960 * You will not need this unless you are doing something special
1962 * @wsi: Websocket connection instance
1963 * @reason: timeout reason
1964 * @secs: how many seconds
1968 libwebsocket_set_timeout(struct libwebsocket *wsi,
1969 enum pending_timeout reason, int secs)
1973 gettimeofday(&tv, NULL);
1975 wsi->pending_timeout_limit = tv.tv_sec + secs;
1976 wsi->pending_timeout = reason;
1981 * libwebsocket_get_socket_fd() - returns the socket file descriptor
1983 * You will not need this unless you are doing something special
1985 * @wsi: Websocket connection instance
1989 libwebsocket_get_socket_fd(struct libwebsocket *wsi)
1995 * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
1996 * receieved packets.
1998 * If the output side of a server process becomes choked, this allows flow
1999 * control for the input side.
2001 * @wsi: Websocket connection instance to get callback for
2002 * @enable: 0 = disable read servicing for this connection, 1 = enable
2006 libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
2008 struct libwebsocket_context *context = wsi->protocol->owning_server;
2011 for (n = 0; n < context->fds_count; n++)
2012 if (context->fds[n].fd == wsi->sock) {
2014 context->fds[n].events |= POLLIN;
2016 context->fds[n].events &= ~POLLIN;
2022 /* external POLL support via protocol 0 */
2023 context->protocols[0].callback(context, wsi,
2024 LWS_CALLBACK_SET_MODE_POLL_FD,
2025 (void *)(long)wsi->sock, NULL, POLLIN);
2027 /* external POLL support via protocol 0 */
2028 context->protocols[0].callback(context, wsi,
2029 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
2030 (void *)(long)wsi->sock, NULL, POLLIN);
2033 fprintf(stderr, "libwebsocket_callback_on_writable "
2034 "unable to find socket\n");
2039 * libwebsocket_canonical_hostname() - returns this host's hostname
2041 * This is typically used by client code to fill in the host parameter
2042 * when making a client connection. You can only call it after the context
2045 * @context: Websocket context
2050 libwebsocket_canonical_hostname(struct libwebsocket_context *context)
2052 return (const char *)context->canonical_hostname;
2056 static void sigpipe_handler(int x)
2060 #ifdef LWS_OPENSSL_SUPPORT
2062 OpenSSL_verify_callback(int preverify_ok, X509_STORE_CTX *x509_ctx)
2067 struct libwebsocket_context *context;
2069 ssl = X509_STORE_CTX_get_ex_data(x509_ctx,
2070 SSL_get_ex_data_X509_STORE_CTX_idx());
2073 * !!! nasty openssl requires the index to come as a library-scope
2076 context = SSL_get_ex_data(ssl, openssl_websocket_private_data_index);
2078 n = context->protocols[0].callback(NULL, NULL,
2079 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION,
2080 x509_ctx, ssl, preverify_ok);
2082 /* convert return code from 0 = OK to 1 = OK */
2095 * libwebsocket_create_context() - Create the websocket handler
2096 * @port: Port to listen on... you can use 0 to suppress listening on
2097 * any port, that's what you want if you are not running a
2098 * websocket server at all but just using it as a client
2099 * @interf: NULL to bind the listen socket to all interfaces, or the
2100 * interface name, eg, "eth2"
2101 * @protocols: Array of structures listing supported protocols and a protocol-
2102 * specific callback for each one. The list is ended with an
2103 * entry that has a NULL callback pointer.
2104 * It's not const because we write the owning_server member
2105 * @extensions: NULL or array of libwebsocket_extension structs listing the
2106 * extensions this context supports
2107 * @ssl_cert_filepath: If libwebsockets was compiled to use ssl, and you want
2108 * to listen using SSL, set to the filepath to fetch the
2109 * server cert from, otherwise NULL for unencrypted
2110 * @ssl_private_key_filepath: filepath to private key if wanting SSL mode,
2112 * @gid: group id to change to after setting listen socket, or -1.
2113 * @uid: user id to change to after setting listen socket, or -1.
2114 * @options: 0, or LWS_SERVER_OPTION_DEFEAT_CLIENT_MASK
2116 * This function creates the listening socket and takes care
2117 * of all initialization in one step.
2119 * After initialization, it returns a struct libwebsocket_context * that
2120 * represents this server. After calling, user code needs to take care
2121 * of calling libwebsocket_service() with the context pointer to get the
2122 * server's sockets serviced. This can be done in the same process context
2123 * or a forked process, or another thread,
2125 * The protocol callback functions are called for a handful of events
2126 * including http requests coming in, websocket connections becoming
2127 * established, and data arriving; it's also called periodically to allow
2128 * async transmission.
2130 * HTTP requests are sent always to the FIRST protocol in @protocol, since
2131 * at that time websocket protocol has not been negotiated. Other
2132 * protocols after the first one never see any HTTP callack activity.
2134 * The server created is a simple http server by default; part of the
2135 * websocket standard is upgrading this http connection to a websocket one.
2137 * This allows the same server to provide files like scripts and favicon /
2138 * images or whatever over http and dynamic data over websockets all in
2139 * one place; they're all handled in the user callback.
2142 struct libwebsocket_context *
2143 libwebsocket_create_context(int port, const char *interf,
2144 struct libwebsocket_protocols *protocols,
2145 struct libwebsocket_extension *extensions,
2146 const char *ssl_cert_filepath,
2147 const char *ssl_private_key_filepath,
2148 int gid, int uid, unsigned int options)
2153 struct sockaddr_in serv_addr, cli_addr;
2155 struct libwebsocket_context *context = NULL;
2158 char hostname[1024];
2160 struct libwebsocket *wsi;
2162 #ifdef LWS_OPENSSL_SUPPORT
2164 char ssl_err_buf[512];
2169 WORD wVersionRequested;
2173 /* Use the MAKEWORD(lowbyte, highbyte) macro from Windef.h */
2174 wVersionRequested = MAKEWORD(2, 2);
2176 err = WSAStartup(wVersionRequested, &wsaData);
2178 /* Tell the user that we could not find a usable */
2180 fprintf(stderr, "WSAStartup failed with error: %d\n",
2188 context = malloc(sizeof(struct libwebsocket_context));
2190 fprintf(stderr, "No memory for websocket context\n");
2193 context->protocols = protocols;
2194 context->listen_port = port;
2195 context->http_proxy_port = 0;
2196 context->http_proxy_address[0] = '\0';
2197 context->options = options;
2198 context->fds_count = 0;
2199 context->extensions = extensions;
2202 context->fd_random = 0;
2204 context->fd_random = open(SYSTEM_RANDOM_FILEPATH, O_RDONLY);
2205 if (context->fd_random < 0) {
2206 fprintf(stderr, "Unable to open random device %s %d\n",
2207 SYSTEM_RANDOM_FILEPATH, context->fd_random);
2212 #ifdef LWS_OPENSSL_SUPPORT
2213 context->use_ssl = 0;
2214 context->ssl_ctx = NULL;
2215 context->ssl_client_ctx = NULL;
2216 openssl_websocket_private_data_index = 0;
2218 /* find canonical hostname */
2220 hostname[(sizeof hostname) - 1] = '\0';
2221 gethostname(hostname, (sizeof hostname) - 1);
2222 he = gethostbyname(hostname);
2224 strncpy(context->canonical_hostname, he->h_name,
2225 sizeof context->canonical_hostname - 1);
2226 context->canonical_hostname[
2227 sizeof context->canonical_hostname - 1] = '\0';
2229 strncpy(context->canonical_hostname, hostname,
2230 sizeof context->canonical_hostname - 1);
2232 /* split the proxy ads:port if given */
2234 p = getenv("http_proxy");
2236 strncpy(context->http_proxy_address, p,
2237 sizeof context->http_proxy_address - 1);
2238 context->http_proxy_address[
2239 sizeof context->http_proxy_address - 1] = '\0';
2241 p = strchr(context->http_proxy_address, ':');
2243 fprintf(stderr, "http_proxy needs to be ads:port\n");
2247 context->http_proxy_port = atoi(p + 1);
2249 fprintf(stderr, "Using proxy %s:%u\n",
2250 context->http_proxy_address,
2251 context->http_proxy_port);
2256 #ifdef LWS_OPENSSL_SUPPORT
2257 context->use_ssl = ssl_cert_filepath != NULL &&
2258 ssl_private_key_filepath != NULL;
2259 if (context->use_ssl)
2260 fprintf(stderr, " Compiled with SSL support, "
2263 fprintf(stderr, " Compiled with SSL support, "
2267 if (ssl_cert_filepath != NULL &&
2268 ssl_private_key_filepath != NULL) {
2269 fprintf(stderr, " Not compiled for OpenSSl support!\n");
2272 fprintf(stderr, " Compiled without SSL support, "
2273 "serving unencrypted\n");
2277 /* ignore SIGPIPE */
2280 signal(SIGPIPE, sigpipe_handler);
2284 #ifdef LWS_OPENSSL_SUPPORT
2286 /* basic openssl init */
2290 OpenSSL_add_all_algorithms();
2291 SSL_load_error_strings();
2293 openssl_websocket_private_data_index =
2294 SSL_get_ex_new_index(0, "libwebsockets", NULL, NULL, NULL);
2297 * Firefox insists on SSLv23 not SSLv3
2298 * Konq disables SSLv2 by default now, SSLv23 works
2301 method = (SSL_METHOD *)SSLv23_server_method();
2303 fprintf(stderr, "problem creating ssl method: %s\n",
2304 ERR_error_string(ERR_get_error(), ssl_err_buf));
2307 context->ssl_ctx = SSL_CTX_new(method); /* create context */
2308 if (!context->ssl_ctx) {
2309 fprintf(stderr, "problem creating ssl context: %s\n",
2310 ERR_error_string(ERR_get_error(), ssl_err_buf));
2314 /* client context */
2315 if (port == CONTEXT_PORT_NO_LISTEN)
2317 method = (SSL_METHOD *)SSLv23_client_method();
2319 fprintf(stderr, "problem creating ssl method: %s\n",
2320 ERR_error_string(ERR_get_error(), ssl_err_buf));
2323 /* create context */
2324 context->ssl_client_ctx = SSL_CTX_new(method);
2325 if (!context->ssl_client_ctx) {
2326 fprintf(stderr, "problem creating ssl context: %s\n",
2327 ERR_error_string(ERR_get_error(), ssl_err_buf));
2331 /* openssl init for cert verification (for client sockets) */
2333 if (!SSL_CTX_load_verify_locations(
2334 context->ssl_client_ctx, NULL,
2335 LWS_OPENSSL_CLIENT_CERTS))
2337 "Unable to load SSL Client certs from %s "
2338 "(set by --with-client-cert-dir= in configure) -- "
2339 " client ssl isn't going to work",
2340 LWS_OPENSSL_CLIENT_CERTS);
2343 * callback allowing user code to load extra verification certs
2344 * helping the client to verify server identity
2347 context->protocols[0].callback(context, NULL,
2348 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS,
2349 context->ssl_client_ctx, NULL, 0);
2351 /* as a server, are we requiring clients to identify themselves? */
2353 if (options & LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT) {
2355 /* absolutely require the client cert */
2357 SSL_CTX_set_verify(context->ssl_ctx,
2358 SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
2359 OpenSSL_verify_callback);
2362 * give user code a chance to load certs into the server
2363 * allowing it to verify incoming client certs
2366 context->protocols[0].callback(context, NULL,
2367 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS,
2368 context->ssl_ctx, NULL, 0);
2371 if (context->use_ssl) {
2373 /* openssl init for server sockets */
2375 /* set the local certificate from CertFile */
2376 n = SSL_CTX_use_certificate_file(context->ssl_ctx,
2377 ssl_cert_filepath, SSL_FILETYPE_PEM);
2379 fprintf(stderr, "problem getting cert '%s': %s\n",
2381 ERR_error_string(ERR_get_error(), ssl_err_buf));
2384 /* set the private key from KeyFile */
2385 if (SSL_CTX_use_PrivateKey_file(context->ssl_ctx,
2386 ssl_private_key_filepath, SSL_FILETYPE_PEM) != 1) {
2387 fprintf(stderr, "ssl problem getting key '%s': %s\n",
2388 ssl_private_key_filepath,
2389 ERR_error_string(ERR_get_error(), ssl_err_buf));
2392 /* verify private key */
2393 if (!SSL_CTX_check_private_key(context->ssl_ctx)) {
2394 fprintf(stderr, "Private SSL key doesn't match cert\n");
2398 /* SSL is happy and has a cert it's content with */
2404 if (lws_b64_selftest())
2407 /* fd hashtable init */
2409 for (n = 0; n < FD_HASHTABLE_MODULUS; n++)
2410 context->fd_hashtable[n].length = 0;
2412 /* set up our external listening socket we serve on */
2416 sockfd = socket(AF_INET, SOCK_STREAM, 0);
2418 fprintf(stderr, "ERROR opening socket");
2422 /* allow us to restart even if old sockets in TIME_WAIT */
2423 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
2428 setsockopt(sockfd, SOL_TCP, TCP_NODELAY, &opt, sizeof(opt));
2430 bzero((char *) &serv_addr, sizeof(serv_addr));
2431 serv_addr.sin_family = AF_INET;
2433 serv_addr.sin_addr.s_addr = INADDR_ANY;
2435 interface_to_sa(interf, &serv_addr,
2437 serv_addr.sin_port = htons(port);
2439 n = bind(sockfd, (struct sockaddr *) &serv_addr,
2442 fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
2447 wsi = malloc(sizeof(struct libwebsocket));
2448 memset(wsi, 0, sizeof (struct libwebsocket));
2450 wsi->count_active_extensions = 0;
2451 wsi->mode = LWS_CONNMODE_SERVER_LISTENER;
2452 insert_wsi(context, wsi);
2455 fprintf(stderr, " Listening on port %d\n", port);
2457 /* list in the internal poll array */
2459 context->fds[context->fds_count].fd = sockfd;
2460 context->fds[context->fds_count++].events = POLLIN;
2462 /* external POLL support via protocol 0 */
2463 context->protocols[0].callback(context, wsi,
2464 LWS_CALLBACK_ADD_POLL_FD,
2465 (void *)(long)sockfd, NULL, POLLIN);
2469 /* drop any root privs for this process */
2474 fprintf(stderr, "setgid: %s\n", strerror(errno));
2477 fprintf(stderr, "setuid: %s\n", strerror(errno));
2480 /* set up our internal broadcast trigger sockets per-protocol */
2482 for (context->count_protocols = 0;
2483 protocols[context->count_protocols].callback;
2484 context->count_protocols++) {
2485 protocols[context->count_protocols].owning_server = context;
2486 protocols[context->count_protocols].protocol_index =
2487 context->count_protocols;
2489 fd = socket(AF_INET, SOCK_STREAM, 0);
2491 fprintf(stderr, "ERROR opening socket");
2495 /* allow us to restart even if old sockets in TIME_WAIT */
2496 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
2498 bzero((char *) &serv_addr, sizeof(serv_addr));
2499 serv_addr.sin_family = AF_INET;
2500 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
2501 serv_addr.sin_port = 0; /* pick the port for us */
2503 n = bind(fd, (struct sockaddr *) &serv_addr, sizeof(serv_addr));
2505 fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
2510 slen = sizeof cli_addr;
2511 n = getsockname(fd, (struct sockaddr *)&cli_addr, &slen);
2513 fprintf(stderr, "getsockname failed\n");
2516 protocols[context->count_protocols].broadcast_socket_port =
2517 ntohs(cli_addr.sin_port);
2520 debug(" Protocol %s broadcast socket %d\n",
2521 protocols[context->count_protocols].name,
2522 ntohs(cli_addr.sin_port));
2524 /* dummy wsi per broadcast proxy socket */
2526 wsi = malloc(sizeof(struct libwebsocket));
2527 memset(wsi, 0, sizeof (struct libwebsocket));
2529 wsi->mode = LWS_CONNMODE_BROADCAST_PROXY_LISTENER;
2530 wsi->count_active_extensions = 0;
2531 /* note which protocol we are proxying */
2532 wsi->protocol_index_for_broadcast_proxy =
2533 context->count_protocols;
2534 insert_wsi(context, wsi);
2536 /* list in internal poll array */
2538 context->fds[context->fds_count].fd = fd;
2539 context->fds[context->fds_count].events = POLLIN;
2540 context->fds[context->fds_count].revents = 0;
2541 context->fds_count++;
2543 /* external POLL support via protocol 0 */
2544 context->protocols[0].callback(context, wsi,
2545 LWS_CALLBACK_ADD_POLL_FD,
2546 (void *)(long)fd, NULL, POLLIN);
2556 * libwebsockets_fork_service_loop() - Optional helper function forks off
2557 * a process for the websocket server loop.
2558 * You don't have to use this but if not, you
2559 * have to make sure you are calling
2560 * libwebsocket_service periodically to service
2561 * the websocket traffic
2562 * @context: server context returned by creation function
2566 libwebsockets_fork_service_loop(struct libwebsocket_context *context)
2569 struct sockaddr_in cli_addr;
2579 /* main process context */
2582 * set up the proxy sockets to allow broadcast from
2583 * service process context
2586 for (p = 0; p < context->count_protocols; p++) {
2587 fd = socket(AF_INET, SOCK_STREAM, 0);
2589 fprintf(stderr, "Unable to create socket\n");
2592 cli_addr.sin_family = AF_INET;
2593 cli_addr.sin_port = htons(
2594 context->protocols[p].broadcast_socket_port);
2595 cli_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
2596 n = connect(fd, (struct sockaddr *)&cli_addr,
2599 fprintf(stderr, "Unable to connect to "
2600 "broadcast socket %d, %s\n",
2601 n, strerror(errno));
2605 context->protocols[p].broadcast_socket_user_fd = fd;
2611 /* we want a SIGHUP when our parent goes down */
2612 prctl(PR_SET_PDEATHSIG, SIGHUP);
2614 /* in this forked process, sit and service websocket connections */
2617 if (libwebsocket_service(context, 1000))
2626 * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
2628 * @wsi: pointer to struct websocket you want to know the protocol of
2631 * This is useful to get the protocol to broadcast back to from inside
2635 const struct libwebsocket_protocols *
2636 libwebsockets_get_protocol(struct libwebsocket *wsi)
2638 return wsi->protocol;
2642 * libwebsockets_broadcast() - Sends a buffer to the callback for all active
2643 * connections of the given protocol.
2644 * @protocol: pointer to the protocol you will broadcast to all members of
2645 * @buf: buffer containing the data to be broadcase. NOTE: this has to be
2646 * allocated with LWS_SEND_BUFFER_PRE_PADDING valid bytes before
2647 * the pointer and LWS_SEND_BUFFER_POST_PADDING afterwards in the
2648 * case you are calling this function from callback context.
2649 * @len: length of payload data in buf, starting from buf.
2651 * This function allows bulk sending of a packet to every connection using
2652 * the given protocol. It does not send the data directly; instead it calls
2653 * the callback with a reason type of LWS_CALLBACK_BROADCAST. If the callback
2654 * wants to actually send the data for that connection, the callback itself
2655 * should call libwebsocket_write().
2657 * libwebsockets_broadcast() can be called from another fork context without
2658 * having to take any care about data visibility between the processes, it'll
2664 libwebsockets_broadcast(const struct libwebsocket_protocols *protocol,
2665 unsigned char *buf, size_t len)
2667 struct libwebsocket_context *context = protocol->owning_server;
2670 struct libwebsocket * wsi;
2672 if (!protocol->broadcast_socket_user_fd) {
2674 * We are either running unforked / flat, or we are being
2675 * called from poll thread context
2676 * eg, from a callback. In that case don't use sockets for
2677 * broadcast IPC (since we can't open a socket connection to
2678 * a socket listening on our own thread) but directly do the
2681 * Locking is not needed because we are by definition being
2682 * called in the poll thread context and are serialized.
2685 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
2687 for (m = 0; m < context->fd_hashtable[n].length; m++) {
2689 wsi = context->fd_hashtable[n].wsi[m];
2691 if (wsi->mode != LWS_CONNMODE_WS_SERVING)
2695 * never broadcast to
2696 * non-established connections
2698 if (wsi->state != WSI_STATE_ESTABLISHED)
2701 /* only broadcast to guys using
2702 * requested protocol
2704 if (wsi->protocol != protocol)
2707 wsi->protocol->callback(context, wsi,
2708 LWS_CALLBACK_BROADCAST,
2718 * We're being called from a different process context than the server
2719 * loop. Instead of broadcasting directly, we send our
2720 * payload on a socket to do the IPC; the server process will serialize
2721 * the broadcast action in its main poll() loop.
2723 * There's one broadcast socket listening for each protocol supported
2724 * set up when the websocket server initializes
2727 n = send(protocol->broadcast_socket_user_fd, buf, len, MSG_NOSIGNAL);
2733 libwebsocket_is_final_fragment(struct libwebsocket *wsi)