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;
160 old_state = wsi->state;
162 if (old_state == WSI_STATE_DEAD_SOCKET)
165 wsi->close_reason = reason;
168 * flush any tx pending from extensions, since we may send close packet
169 * if there are problems with send, just nuke the connection
175 /* default to nobody has more to spill */
178 eff_buf.token = NULL;
179 eff_buf.token_len = 0;
181 /* show every extension the new incoming data */
183 for (n = 0; n < wsi->count_active_extensions; n++) {
184 m = wsi->active_extensions[n]->callback(
185 wsi->protocol->owning_server, wsi,
186 LWS_EXT_CALLBACK_FLUSH_PENDING_TX,
187 wsi->active_extensions_user[n], &eff_buf, 0);
189 fprintf(stderr, "Extension reports "
191 goto just_kill_connection;
195 * at least one extension told us he has more
196 * to spill, so we will go around again after
201 /* assuming they left us something to send, send it */
203 if (eff_buf.token_len)
204 if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
206 goto just_kill_connection;
210 * signal we are closing, libsocket_write will
211 * add any necessary version-specific stuff. If the write fails,
212 * no worries we are closing anyway. If we didn't initiate this
213 * close, then our state has been changed to
214 * WSI_STATE_RETURNED_CLOSE_ALREADY and we will skip this.
216 * Likewise if it's a second call to close this connection after we
217 * sent the close indication to the peer already, we are in state
218 * WSI_STATE_AWAITING_CLOSE_ACK and will skip doing this a second time.
221 if (old_state == WSI_STATE_ESTABLISHED &&
222 reason != LWS_CLOSE_STATUS_NOSTATUS) {
223 n = libwebsocket_write(wsi, &buf[LWS_SEND_BUFFER_PRE_PADDING],
227 * we have sent a nice protocol level indication we
228 * now wish to close, we should not send anything more
231 wsi->state = WSI_STATE_AWAITING_CLOSE_ACK;
233 /* and we should wait for a reply for a bit */
235 libwebsocket_set_timeout(wsi,
236 PENDING_TIMEOUT_CLOSE_ACK, 5);
238 fprintf(stderr, "sent close indication, awaiting ack\n");
243 /* else, the send failed and we should just hang up */
246 just_kill_connection:
248 * we won't be servicing or receiving anything further from this guy
249 * remove this fd from wsi mapping hashtable
252 delete_from_fd(context, wsi->sock);
254 /* delete it from the internal poll list if still present */
256 for (n = 0; n < context->fds_count; n++) {
257 if (context->fds[n].fd != wsi->sock)
259 while (n < context->fds_count - 1) {
260 context->fds[n] = context->fds[n + 1];
263 context->fds_count--;
264 /* we only have to deal with one */
265 n = context->fds_count;
268 /* remove also from external POLL support via protocol 0 */
270 context->protocols[0].callback(context, wsi,
271 LWS_CALLBACK_DEL_POLL_FD, (void *)(long)wsi->sock, NULL, 0);
273 wsi->state = WSI_STATE_DEAD_SOCKET;
275 /* tell the user it's all over for this guy */
277 if (wsi->protocol && wsi->protocol->callback &&
278 old_state == WSI_STATE_ESTABLISHED)
279 wsi->protocol->callback(context, wsi, LWS_CALLBACK_CLOSED,
280 wsi->user_space, NULL, 0);
282 /* deallocate any active extension contexts */
284 for (n = 0; n < wsi->count_active_extensions; n++) {
285 if (!wsi->active_extensions[n]->callback)
288 wsi->active_extensions[n]->callback(context, wsi,
289 LWS_EXT_CALLBACK_DESTROY,
290 wsi->active_extensions_user[n], NULL, 0);
292 free(wsi->active_extensions_user[n]);
295 /* free up his parsing allocations */
297 for (n = 0; n < WSI_TOKEN_COUNT; n++)
298 if (wsi->utf8_token[n].token)
299 free(wsi->utf8_token[n].token);
301 /* fprintf(stderr, "closing fd=%d\n", wsi->sock); */
303 #ifdef LWS_OPENSSL_SUPPORT
305 n = SSL_get_fd(wsi->ssl);
306 SSL_shutdown(wsi->ssl);
315 shutdown(wsi->sock, SHUT_RDWR);
317 closesocket(wsi->sock);
321 #ifdef LWS_OPENSSL_SUPPORT
325 free(wsi->user_space);
331 * libwebsockets_hangup_on_client() - Server calls to terminate client
333 * @context: libwebsockets context
334 * @fd: Connection socket descriptor
338 libwebsockets_hangup_on_client(struct libwebsocket_context *context, int fd)
340 struct libwebsocket *wsi = wsi_from_fd(context, fd);
345 libwebsocket_close_and_free_session(context, wsi,
346 LWS_CLOSE_STATUS_NOSTATUS);
351 * libwebsockets_get_peer_addresses() - Get client address information
352 * @fd: Connection socket descriptor
353 * @name: Buffer to take client address name
354 * @name_len: Length of client address name buffer
355 * @rip: Buffer to take client address IP qotted quad
356 * @rip_len: Length of client address IP buffer
358 * This function fills in @name and @rip with the name and IP of
359 * the client connected with socket descriptor @fd. Names may be
360 * truncated if there is not enough room. If either cannot be
361 * determined, they will be returned as valid zero-length strings.
365 libwebsockets_get_peer_addresses(int fd, char *name, int name_len,
366 char *rip, int rip_len)
369 struct sockaddr_in sin;
370 struct hostent *host;
371 struct hostent *host1;
375 struct sockaddr_un *un;
381 if (getpeername(fd, (struct sockaddr *) &sin, &len) < 0) {
382 perror("getpeername");
386 host = gethostbyaddr((char *) &sin.sin_addr, sizeof sin.sin_addr,
389 perror("gethostbyaddr");
393 strncpy(name, host->h_name, name_len);
394 name[name_len - 1] = '\0';
396 host1 = gethostbyname(host->h_name);
399 p = (unsigned char *)host1;
402 p = (unsigned char *)host1->h_addr_list[n++];
405 if ((host1->h_addrtype != AF_INET) &&
406 (host1->h_addrtype != AF_LOCAL))
409 if (host1->h_addrtype == AF_INET)
410 sprintf(ip, "%u.%u.%u.%u", p[0], p[1], p[2], p[3]);
412 un = (struct sockaddr_un *)p;
413 strncpy(ip, un->sun_path, sizeof(ip) -1);
414 ip[sizeof(ip) - 1] = '\0';
417 strncpy(rip, ip, rip_len);
418 rip[rip_len - 1] = '\0';
422 int libwebsockets_get_random(struct libwebsocket_context *context,
429 for (n = 0; n < len; n++)
430 p[n] = (unsigned char)rand();
432 n = read(context->fd_random, p, len);
439 libwebsockets_SHA1(const unsigned char *d, size_t n, unsigned char *md)
441 return SHA1(d, n, md);
444 void libwebsockets_00_spaceout(char *key, int spaces, int seed)
450 if (*key && (seed & 1))
454 p = key + strlen(key);
463 void libwebsockets_00_spam(char *key, int count, int seed)
470 if (*key && (seed & 1))
474 p = key + strlen(key);
479 *key++ = 0x21 + ((seed & 0xffff) % 15);
480 /* 4 would use it up too fast.. not like it matters */
485 int lws_send_pipe_choked(struct libwebsocket *wsi)
490 fds.events = POLLOUT;
493 if (poll(&fds, 1, 0) != 1)
496 if ((fds.revents & POLLOUT) == 0)
499 /* okay to send another packet without blocking */
505 lws_handle_POLLOUT_event(struct libwebsocket_context *context,
506 struct libwebsocket *wsi, struct pollfd *pollfd)
508 struct lws_tokens eff_buf;
513 if (!wsi->extension_data_pending)
517 * check in on the active extensions, see if they
518 * had pending stuff to spill... they need to get the
519 * first look-in otherwise sequence will be disordered
521 * NULL, zero-length eff_buf means just spill pending
527 /* default to nobody has more to spill */
530 eff_buf.token = NULL;
531 eff_buf.token_len = 0;
533 /* give every extension a chance to spill */
535 for (n = 0; n < wsi->count_active_extensions; n++) {
536 m = wsi->active_extensions[n]->callback(
537 wsi->protocol->owning_server, wsi,
538 LWS_EXT_CALLBACK_PACKET_TX_PRESEND,
539 wsi->active_extensions_user[n], &eff_buf, 0);
541 fprintf(stderr, "extension reports fatal error\n");
546 * at least one extension told us he has more
547 * to spill, so we will go around again after
552 /* assuming they gave us something to send, send it */
554 if (eff_buf.token_len) {
555 if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
561 /* no extension has more to spill */
567 * There's more to spill from an extension, but we just sent
568 * something... did that leave the pipe choked?
571 if (!lws_send_pipe_choked(wsi))
572 /* no we could add more */
575 fprintf(stderr, "choked in POLLOUT service\n");
578 * Yes, he's choked. Leave the POLLOUT masked on so we will
579 * come back here when he is unchoked. Don't call the user
580 * callback to enforce ordering of spilling, he'll get called
581 * when we come back here and there's nothing more to spill.
587 wsi->extension_data_pending = 0;
592 pollfd->events &= ~POLLOUT;
594 /* external POLL support via protocol 0 */
595 context->protocols[0].callback(context, wsi,
596 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
597 (void *)(long)wsi->sock, NULL, POLLOUT);
599 if (wsi->mode == LWS_CONNMODE_WS_CLIENT)
600 n = LWS_CALLBACK_CLIENT_WRITEABLE;
602 n = LWS_CALLBACK_SERVER_WRITEABLE;
604 wsi->protocol->callback(context, wsi, n, wsi->user_space, NULL, 0);
612 * libwebsocket_service_fd() - Service polled socket with something waiting
613 * @context: Websocket context
614 * @pollfd: The pollfd entry describing the socket fd and which events
617 * This function closes any active connections and then frees the
618 * context. After calling this, any further use of the context is
623 libwebsocket_service_fd(struct libwebsocket_context *context,
624 struct pollfd *pollfd)
626 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 1 + MAX_BROADCAST_PAYLOAD +
627 LWS_SEND_BUFFER_POST_PADDING];
628 struct libwebsocket *wsi;
629 struct libwebsocket *new_wsi;
635 struct sockaddr_in cli_addr;
637 static const char magic_websocket_guid[] =
638 "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
639 static const char magic_websocket_04_masking_guid[] =
640 "61AC5F19-FBBA-4540-B96F-6561F1AB40A8";
649 struct lws_tokens eff_buf;
651 struct libwebsocket_extension *ext;
654 #ifdef LWS_OPENSSL_SUPPORT
655 char ssl_err_buf[512];
658 * you can call us with pollfd = NULL to just allow the once-per-second
659 * global timeout checks; if less than a second since the last check
660 * it returns immediately then.
663 gettimeofday(&tv, NULL);
665 if (context->last_timeout_check_s != tv.tv_sec) {
666 context->last_timeout_check_s = tv.tv_sec;
668 /* global timeout check once per second */
670 for (n = 0; n < context->fds_count; n++) {
671 wsi = wsi_from_fd(context, context->fds[n].fd);
672 if (!wsi->pending_timeout)
676 * if we went beyond the allowed time, kill the
680 if (tv.tv_sec > wsi->pending_timeout_limit) {
681 fprintf(stderr, "TIMEDOUT WAITING\n");
682 libwebsocket_close_and_free_session(context,
683 wsi, LWS_CLOSE_STATUS_NOSTATUS);
688 /* just here for timeout management? */
693 /* no, here to service a socket descriptor */
695 wsi = wsi_from_fd(context, pollfd->fd);
701 case LWS_CONNMODE_SERVER_LISTENER:
703 /* pollin means a client has connected to us then */
705 if (!pollfd->revents & POLLIN)
708 /* listen socket got an unencrypted connection... */
710 clilen = sizeof(cli_addr);
711 accept_fd = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
714 fprintf(stderr, "ERROR on accept");
720 setsockopt(accept_fd, SOL_TCP, TCP_NODELAY, &opt, sizeof(opt));
722 if (context->fds_count >= MAX_CLIENTS) {
723 fprintf(stderr, "too busy to accept new client\n");
725 closesocket(accept_fd);
733 * look at who we connected to and give user code a chance
734 * to reject based on client IP. There's no protocol selected
735 * yet so we issue this to protocols[0]
738 if ((context->protocols[0].callback)(context, wsi,
739 LWS_CALLBACK_FILTER_NETWORK_CONNECTION,
740 (void*)(long)accept_fd, NULL, 0)) {
741 fprintf(stderr, "Callback denied network connection\n");
743 closesocket(accept_fd);
750 /* accepting connection to main listener */
752 new_wsi = malloc(sizeof(struct libwebsocket));
753 if (new_wsi == NULL) {
754 fprintf(stderr, "Out of memory for new connection\n");
758 memset(new_wsi, 0, sizeof (struct libwebsocket));
759 new_wsi->sock = accept_fd;
760 new_wsi->count_active_extensions = 0;
761 new_wsi->pending_timeout = NO_PENDING_TIMEOUT;
763 #ifdef LWS_OPENSSL_SUPPORT
766 if (context->use_ssl) {
768 new_wsi->ssl = SSL_new(context->ssl_ctx);
769 if (new_wsi->ssl == NULL) {
770 fprintf(stderr, "SSL_new failed: %s\n",
771 ERR_error_string(SSL_get_error(
772 new_wsi->ssl, 0), NULL));
773 libwebsockets_decode_ssl_error();
778 SSL_set_fd(new_wsi->ssl, accept_fd);
780 n = SSL_accept(new_wsi->ssl);
783 * browsers seem to probe with various
784 * ssl params which fail then retry
787 debug("SSL_accept failed skt %u: %s\n",
789 ERR_error_string(SSL_get_error(
790 new_wsi->ssl, n), NULL));
797 debug("accepted new SSL conn "
798 "port %u on fd=%d SSL ver %s\n",
799 ntohs(cli_addr.sin_port), accept_fd,
800 SSL_get_version(new_wsi->ssl));
804 debug("accepted new conn port %u on fd=%d\n",
805 ntohs(cli_addr.sin_port), accept_fd);
807 /* intialize the instance struct */
809 new_wsi->state = WSI_STATE_HTTP;
810 new_wsi->name_buffer_pos = 0;
811 new_wsi->mode = LWS_CONNMODE_WS_SERVING;
813 for (n = 0; n < WSI_TOKEN_COUNT; n++) {
814 new_wsi->utf8_token[n].token = NULL;
815 new_wsi->utf8_token[n].token_len = 0;
819 * these can only be set once the protocol is known
820 * we set an unestablished connection's protocol pointer
821 * to the start of the supported list, so it can look
822 * for matching ones during the handshake
824 new_wsi->protocol = context->protocols;
825 new_wsi->user_space = NULL;
828 * Default protocol is 76 / 00
829 * After 76, there's a header specified to inform which
830 * draft the client wants, when that's seen we modify
831 * the individual connection's spec revision accordingly
833 new_wsi->ietf_spec_revision = 0;
835 insert_wsi(context, new_wsi);
838 * make sure NO events are seen yet on this new socket
839 * (otherwise we inherit old fds[client].revents from
840 * previous socket there and die mysteriously! )
842 context->fds[context->fds_count].revents = 0;
844 context->fds[context->fds_count].events = POLLIN;
845 context->fds[context->fds_count++].fd = accept_fd;
847 /* external POLL support via protocol 0 */
848 context->protocols[0].callback(context, new_wsi,
849 LWS_CALLBACK_ADD_POLL_FD,
850 (void *)(long)accept_fd, NULL, POLLIN);
854 case LWS_CONNMODE_BROADCAST_PROXY_LISTENER:
856 /* as we are listening, POLLIN means accept() is needed */
858 if (!pollfd->revents & POLLIN)
861 /* listen socket got an unencrypted connection... */
863 clilen = sizeof(cli_addr);
864 accept_fd = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
867 fprintf(stderr, "ERROR on accept");
871 if (context->fds_count >= MAX_CLIENTS) {
872 fprintf(stderr, "too busy to accept new broadcast "
875 closesocket(accept_fd);
882 /* create a dummy wsi for the connection and add it */
884 new_wsi = malloc(sizeof(struct libwebsocket));
885 memset(new_wsi, 0, sizeof (struct libwebsocket));
886 new_wsi->sock = accept_fd;
887 new_wsi->mode = LWS_CONNMODE_BROADCAST_PROXY;
888 new_wsi->state = WSI_STATE_ESTABLISHED;
889 new_wsi->count_active_extensions = 0;
890 /* note which protocol we are proxying */
891 new_wsi->protocol_index_for_broadcast_proxy =
892 wsi->protocol_index_for_broadcast_proxy;
893 insert_wsi(context, new_wsi);
895 /* add connected socket to internal poll array */
897 context->fds[context->fds_count].revents = 0;
898 context->fds[context->fds_count].events = POLLIN;
899 context->fds[context->fds_count++].fd = accept_fd;
901 /* external POLL support via protocol 0 */
902 context->protocols[0].callback(context, new_wsi,
903 LWS_CALLBACK_ADD_POLL_FD,
904 (void *)(long)accept_fd, NULL, POLLIN);
908 case LWS_CONNMODE_BROADCAST_PROXY:
910 /* handle session socket closed */
912 if (pollfd->revents & (POLLERR | POLLHUP)) {
914 debug("Session Socket %p (fd=%d) dead\n",
915 (void *)wsi, pollfd->fd);
917 libwebsocket_close_and_free_session(context, wsi,
918 LWS_CLOSE_STATUS_NORMAL);
923 * either extension code with stuff to spill, or the user code,
924 * requested a callback when it was OK to write
927 if (pollfd->revents & POLLOUT)
928 if (lws_handle_POLLOUT_event(context, wsi, pollfd) < 0) {
929 libwebsocket_close_and_free_session(context, wsi,
930 LWS_CLOSE_STATUS_NORMAL);
934 /* any incoming data ready? */
936 if (!(pollfd->revents & POLLIN))
939 /* get the issued broadcast payload from the socket */
941 len = read(pollfd->fd, buf + LWS_SEND_BUFFER_PRE_PADDING,
942 MAX_BROADCAST_PAYLOAD);
944 fprintf(stderr, "Error reading broadcast payload\n");
948 /* broadcast it to all guys with this protocol index */
950 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
952 for (m = 0; m < context->fd_hashtable[n].length; m++) {
954 new_wsi = context->fd_hashtable[n].wsi[m];
956 /* only to clients we are serving to */
958 if (new_wsi->mode != LWS_CONNMODE_WS_SERVING)
962 * never broadcast to non-established
966 if (new_wsi->state != WSI_STATE_ESTABLISHED)
970 * only broadcast to connections using
971 * the requested protocol
974 if (new_wsi->protocol->protocol_index !=
975 wsi->protocol_index_for_broadcast_proxy)
978 /* broadcast it to this connection */
980 new_wsi->protocol->callback(context, new_wsi,
981 LWS_CALLBACK_BROADCAST,
983 buf + LWS_SEND_BUFFER_PRE_PADDING, len);
988 case LWS_CONNMODE_WS_CLIENT_WAITING_PROXY_REPLY:
990 /* handle proxy hung up on us */
992 if (pollfd->revents & (POLLERR | POLLHUP)) {
994 fprintf(stderr, "Proxy connection %p (fd=%d) dead\n",
995 (void *)wsi, pollfd->fd);
997 libwebsocket_close_and_free_session(context, wsi,
998 LWS_CLOSE_STATUS_NOSTATUS);
1002 n = recv(wsi->sock, pkt, sizeof pkt, 0);
1004 libwebsocket_close_and_free_session(context, wsi,
1005 LWS_CLOSE_STATUS_NOSTATUS);
1006 fprintf(stderr, "ERROR reading from proxy socket\n");
1011 if (strcmp(pkt, "HTTP/1.0 200 ") != 0) {
1012 libwebsocket_close_and_free_session(context, wsi,
1013 LWS_CLOSE_STATUS_NOSTATUS);
1014 fprintf(stderr, "ERROR from proxy: %s\n", pkt);
1018 /* clear his proxy connection timeout */
1020 libwebsocket_set_timeout(wsi, NO_PENDING_TIMEOUT, 0);
1024 case LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE:
1026 #ifdef LWS_OPENSSL_SUPPORT
1029 wsi->ssl = SSL_new(context->ssl_client_ctx);
1030 wsi->client_bio = BIO_new_socket(wsi->sock,
1032 SSL_set_bio(wsi->ssl, wsi->client_bio, wsi->client_bio);
1034 SSL_set_ex_data(wsi->ssl,
1035 openssl_websocket_private_data_index,
1038 if (SSL_connect(wsi->ssl) <= 0) {
1039 fprintf(stderr, "SSL connect error %s\n",
1040 ERR_error_string(ERR_get_error(),
1042 libwebsocket_close_and_free_session(context, wsi,
1043 LWS_CLOSE_STATUS_NOSTATUS);
1047 n = SSL_get_verify_result(wsi->ssl);
1048 if ((n != X509_V_OK) && (
1049 n != X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT ||
1050 wsi->use_ssl != 2)) {
1052 fprintf(stderr, "server's cert didn't "
1053 "look good %d\n", n);
1054 libwebsocket_close_and_free_session(context,
1055 wsi, LWS_CLOSE_STATUS_NOSTATUS);
1063 #ifdef LWS_OPENSSL_SUPPORT
1068 * create the random key
1071 n = libwebsockets_get_random(context, hash, 16);
1073 fprintf(stderr, "Unable to read from random dev %s\n",
1074 SYSTEM_RANDOM_FILEPATH);
1078 free(wsi->c_origin);
1079 if (wsi->c_protocol)
1080 free(wsi->c_protocol);
1081 libwebsocket_close_and_free_session(context, wsi,
1082 LWS_CLOSE_STATUS_NOSTATUS);
1086 lws_b64_encode_string(hash, 16, wsi->key_b64,
1087 sizeof wsi->key_b64);
1090 * 00 example client handshake
1092 * GET /socket.io/websocket HTTP/1.1
1093 * Upgrade: WebSocket
1094 * Connection: Upgrade
1095 * Host: 127.0.0.1:9999
1096 * Origin: http://127.0.0.1
1097 * Sec-WebSocket-Key1: 1 0 2#0W 9 89 7 92 ^
1098 * Sec-WebSocket-Key2: 7 7Y 4328 B2v[8(z1
1099 * Cookie: socketio=websocket
1103 * 04 example client handshake
1105 * GET /chat HTTP/1.1
1106 * Host: server.example.com
1107 * Upgrade: websocket
1108 * Connection: Upgrade
1109 * Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
1110 * Sec-WebSocket-Origin: http://example.com
1111 * Sec-WebSocket-Protocol: chat, superchat
1112 * Sec-WebSocket-Version: 4
1115 p += sprintf(p, "GET %s HTTP/1.1\x0d\x0a", wsi->c_path);
1117 if (wsi->ietf_spec_revision == 0) {
1118 unsigned char spaces_1, spaces_2;
1119 unsigned int max_1, max_2;
1120 unsigned int num_1, num_2;
1121 unsigned long product_1, product_2;
1128 libwebsockets_get_random(context, &spaces_1,
1130 libwebsockets_get_random(context, &spaces_2,
1133 spaces_1 = (spaces_1 % 12) + 1;
1134 spaces_2 = (spaces_2 % 12) + 1;
1136 max_1 = 4294967295 / spaces_1;
1137 max_2 = 4294967295 / spaces_2;
1139 libwebsockets_get_random(context, &num_1, sizeof(int));
1140 libwebsockets_get_random(context, &num_2, sizeof(int));
1142 num_1 = (num_1 % max_1);
1143 num_2 = (num_2 % max_2);
1145 challenge[0] = num_1 >> 24;
1146 challenge[1] = num_1 >> 16;
1147 challenge[2] = num_1 >> 8;
1148 challenge[3] = num_1;
1149 challenge[4] = num_2 >> 24;
1150 challenge[5] = num_2 >> 16;
1151 challenge[6] = num_2 >> 8;
1152 challenge[7] = num_2;
1154 product_1 = num_1 * spaces_1;
1155 product_2 = num_2 * spaces_2;
1157 sprintf(key_1, "%lu", product_1);
1158 sprintf(key_2, "%lu", product_2);
1160 libwebsockets_get_random(context, &seed, sizeof(int));
1161 libwebsockets_get_random(context, &count, sizeof(int));
1163 libwebsockets_00_spam(key_1, (count % 12) + 1, seed);
1165 libwebsockets_get_random(context, &seed, sizeof(int));
1166 libwebsockets_get_random(context, &count, sizeof(int));
1168 libwebsockets_00_spam(key_2, (count % 12) + 1, seed);
1170 libwebsockets_get_random(context, &seed, sizeof(int));
1172 libwebsockets_00_spaceout(key_1, spaces_1, seed);
1173 libwebsockets_00_spaceout(key_2, spaces_2, seed >> 16);
1175 p += sprintf(p, "Upgrade: websocket\x0d\x0a"
1176 "Connection: Upgrade\x0d\x0aHost: %s\x0d\x0a",
1179 p += sprintf(p, "Origin: %s\x0d\x0a",
1182 if (wsi->c_protocol)
1183 p += sprintf(p, "Sec-WebSocket-Protocol: %s"
1184 "\x0d\x0a", wsi->c_protocol);
1186 p += sprintf(p, "Sec-WebSocket-Key1: %s\x0d\x0a",
1188 p += sprintf(p, "Sec-WebSocket-Key2: %s\x0d\x0a",
1191 /* give userland a chance to append, eg, cookies */
1193 context->protocols[0].callback(context, wsi,
1194 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER,
1195 NULL, &p, (pkt + sizeof(pkt)) - p - 12);
1197 p += sprintf(p, "\x0d\x0a");
1199 if (libwebsockets_get_random(context, p, 8) != 8)
1201 memcpy(&challenge[8], p, 8);
1204 /* precompute what we want to see from the server */
1206 MD5((unsigned char *)challenge, 16,
1207 (unsigned char *)wsi->initial_handshake_hash_base64);
1212 p += sprintf(p, "Host: %s\x0d\x0a", wsi->c_host);
1213 p += sprintf(p, "Upgrade: websocket\x0d\x0a");
1214 p += sprintf(p, "Connection: Upgrade\x0d\x0a"
1215 "Sec-WebSocket-Key: ");
1216 strcpy(p, wsi->key_b64);
1217 p += strlen(wsi->key_b64);
1218 p += sprintf(p, "\x0d\x0a");
1220 p += sprintf(p, "Sec-WebSocket-Origin: %s\x0d\x0a",
1222 if (wsi->c_protocol)
1223 p += sprintf(p, "Sec-WebSocket-Protocol: %s\x0d\x0a",
1226 /* tell the server what extensions we could support */
1228 p += sprintf(p, "Sec-WebSocket-Extensions: ");
1230 ext =context->extensions;
1231 while (ext && ext->callback) {
1234 n = context->protocols[0].callback(context, wsi,
1235 LWS_CALLBACK_CLIENT_CONFIRM_EXTENSION_SUPPORTED,
1236 wsi->user_space, (char *)ext->name, 0);
1239 * zero return from callback means
1240 * go ahead and allow the extension,
1241 * it's what we get if the callback is
1254 p += sprintf(p, "%s", ext->name);
1260 p += sprintf(p, "\x0d\x0a");
1262 if (wsi->ietf_spec_revision)
1263 p += sprintf(p, "Sec-WebSocket-Version: %d\x0d\x0a",
1264 wsi->ietf_spec_revision);
1266 /* give userland a chance to append, eg, cookies */
1268 context->protocols[0].callback(context, wsi,
1269 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER,
1270 NULL, &p, (pkt + sizeof(pkt)) - p - 12);
1272 p += sprintf(p, "\x0d\x0a");
1274 /* prepare the expected server accept response */
1276 strcpy((char *)buf, wsi->key_b64);
1277 strcpy((char *)&buf[strlen((char *)buf)], magic_websocket_guid);
1279 SHA1(buf, strlen((char *)buf), (unsigned char *)hash);
1281 lws_b64_encode_string(hash, 20,
1282 wsi->initial_handshake_hash_base64,
1283 sizeof wsi->initial_handshake_hash_base64);
1287 /* done with these now */
1292 free(wsi->c_origin);
1294 /* send our request to the server */
1296 #ifdef LWS_OPENSSL_SUPPORT
1298 n = SSL_write(wsi->ssl, pkt, p - pkt);
1301 n = send(wsi->sock, pkt, p - pkt, 0);
1304 fprintf(stderr, "ERROR writing to client socket\n");
1305 libwebsocket_close_and_free_session(context, wsi,
1306 LWS_CLOSE_STATUS_NOSTATUS);
1310 wsi->parser_state = WSI_TOKEN_NAME_PART;
1311 wsi->mode = LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY;
1312 libwebsocket_set_timeout(wsi,
1313 PENDING_TIMEOUT_AWAITING_SERVER_RESPONSE, 5);
1317 case LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY:
1319 /* handle server hung up on us */
1321 if (pollfd->revents & (POLLERR | POLLHUP)) {
1323 fprintf(stderr, "Server connection %p (fd=%d) dead\n",
1324 (void *)wsi, pollfd->fd);
1330 /* interpret the server response */
1333 * HTTP/1.1 101 Switching Protocols
1334 * Upgrade: websocket
1335 * Connection: Upgrade
1336 * Sec-WebSocket-Accept: me89jWimTRKTWwrS3aRrL53YZSo=
1337 * Sec-WebSocket-Nonce: AQIDBAUGBwgJCgsMDQ4PEC==
1338 * Sec-WebSocket-Protocol: chat
1341 #ifdef LWS_OPENSSL_SUPPORT
1343 len = SSL_read(wsi->ssl, pkt, sizeof pkt);
1346 len = recv(wsi->sock, pkt, sizeof pkt, 0);
1350 "libwebsocket_client_handshake read error\n");
1355 for (n = 0; n < len; n++)
1356 libwebsocket_parse(wsi, *p++);
1358 if (wsi->parser_state != WSI_PARSING_COMPLETE) {
1359 fprintf(stderr, "libwebsocket_client_handshake "
1360 "server response failed parsing\n");
1367 * HTTP/1.1 101 WebSocket Protocol Handshake
1368 * Upgrade: WebSocket
1369 * Connection: Upgrade
1370 * Sec-WebSocket-Origin: http://127.0.0.1
1371 * Sec-WebSocket-Location: ws://127.0.0.1:9999/socket.io/websocket
1376 if (wsi->ietf_spec_revision == 0) {
1377 if (!wsi->utf8_token[WSI_TOKEN_HTTP].token_len ||
1378 !wsi->utf8_token[WSI_TOKEN_UPGRADE].token_len ||
1379 !wsi->utf8_token[WSI_TOKEN_CHALLENGE].token_len ||
1380 !wsi->utf8_token[WSI_TOKEN_CONNECTION].token_len ||
1381 (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len &&
1382 wsi->c_protocol != NULL)) {
1383 fprintf(stderr, "libwebsocket_client_handshake "
1384 "missing required header(s)\n");
1386 fprintf(stderr, "%s", pkt);
1390 strtolower(wsi->utf8_token[WSI_TOKEN_HTTP].token);
1391 if (strcmp(wsi->utf8_token[WSI_TOKEN_HTTP].token,
1392 "101 websocket protocol handshake")) {
1393 fprintf(stderr, "libwebsocket_client_handshake "
1394 "server sent bad HTTP response '%s'\n",
1395 wsi->utf8_token[WSI_TOKEN_HTTP].token);
1399 if (wsi->utf8_token[WSI_TOKEN_CHALLENGE].token_len <
1401 fprintf(stderr, "libwebsocket_client_handshake "
1402 "challenge reply too short %d\n",
1404 WSI_TOKEN_CHALLENGE].token_len);
1406 fprintf(stderr, "%s", pkt);
1411 goto select_protocol;
1415 * well, what the server sent looked reasonable for syntax.
1416 * Now let's confirm it sent all the necessary headers
1419 if (!wsi->utf8_token[WSI_TOKEN_HTTP].token_len ||
1420 !wsi->utf8_token[WSI_TOKEN_UPGRADE].token_len ||
1421 !wsi->utf8_token[WSI_TOKEN_CONNECTION].token_len ||
1422 !wsi->utf8_token[WSI_TOKEN_ACCEPT].token_len ||
1423 (!wsi->utf8_token[WSI_TOKEN_NONCE].token_len &&
1424 wsi->ietf_spec_revision == 4) ||
1425 (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len &&
1426 wsi->c_protocol != NULL)) {
1427 fprintf(stderr, "libwebsocket_client_handshake "
1428 "missing required header(s)\n");
1430 fprintf(stderr, "%s", pkt);
1435 * Everything seems to be there, now take a closer look at what
1439 strtolower(wsi->utf8_token[WSI_TOKEN_HTTP].token);
1440 if (strcmp(wsi->utf8_token[WSI_TOKEN_HTTP].token,
1441 "101 switching protocols")) {
1442 fprintf(stderr, "libwebsocket_client_handshake "
1443 "server sent bad HTTP response '%s'\n",
1444 wsi->utf8_token[WSI_TOKEN_HTTP].token);
1448 strtolower(wsi->utf8_token[WSI_TOKEN_UPGRADE].token);
1449 if (strcmp(wsi->utf8_token[WSI_TOKEN_UPGRADE].token,
1451 fprintf(stderr, "libwebsocket_client_handshake server "
1452 "sent bad Upgrade header '%s'\n",
1453 wsi->utf8_token[WSI_TOKEN_UPGRADE].token);
1457 strtolower(wsi->utf8_token[WSI_TOKEN_CONNECTION].token);
1458 if (strcmp(wsi->utf8_token[WSI_TOKEN_CONNECTION].token,
1460 fprintf(stderr, "libwebsocket_client_handshake server "
1461 "sent bad Connection hdr '%s'\n",
1462 wsi->utf8_token[WSI_TOKEN_CONNECTION].token);
1467 pc = wsi->c_protocol;
1470 * confirm the protocol the server wants to talk was in the list
1471 * of protocols we offered
1474 if (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len) {
1477 * no protocol name to work from,
1478 * default to first protocol
1480 wsi->protocol = &context->protocols[0];
1482 free(wsi->c_protocol);
1487 while (*pc && !okay) {
1489 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token,
1490 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len)) &&
1491 (pc[wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len] == ',' ||
1492 pc[wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len] == '\0')) {
1496 while (*pc && *pc != ',')
1498 while (*pc && *pc != ' ')
1502 /* done with him now */
1504 if (wsi->c_protocol)
1505 free(wsi->c_protocol);
1509 fprintf(stderr, "libwebsocket_client_handshake server "
1510 "sent bad protocol '%s'\n",
1511 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token);
1516 * identify the selected protocol struct and set it
1519 wsi->protocol = NULL;
1520 while (context->protocols[n].callback) {
1521 if (strcmp(wsi->utf8_token[WSI_TOKEN_PROTOCOL].token,
1522 context->protocols[n].name) == 0)
1523 wsi->protocol = &context->protocols[n];
1527 if (wsi->protocol == NULL) {
1528 fprintf(stderr, "libwebsocket_client_handshake server "
1529 "requested protocol '%s', which we "
1530 "said we supported but we don't!\n",
1531 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token);
1536 /* instantiate the accepted extensions */
1538 if (!wsi->utf8_token[WSI_TOKEN_EXTENSIONS].token_len)
1542 * break down the list of server accepted extensions
1543 * and go through matching them or identifying bogons
1546 c = wsi->utf8_token[WSI_TOKEN_EXTENSIONS].token;
1550 if (*c && *c != ',') {
1552 if (n < sizeof(ext_name) - 1)
1560 /* check we actually support it */
1563 ext = wsi->protocol->owning_server->extensions;
1564 while (ext && ext->callback) {
1566 if (strcmp(ext_name, ext->name)) {
1573 /* instantiate the extension on this conn */
1575 wsi->active_extensions_user[
1576 wsi->count_active_extensions] =
1577 malloc(ext->per_session_data_size);
1578 wsi->active_extensions[
1579 wsi->count_active_extensions] = ext;
1581 /* allow him to construct his context */
1583 ext->callback(wsi->protocol->owning_server,
1584 wsi, LWS_EXT_CALLBACK_CLIENT_CONSTRUCT,
1585 wsi->active_extensions_user[
1586 wsi->count_active_extensions], NULL, 0);
1588 wsi->count_active_extensions++;
1594 fprintf(stderr, "Server said we should use"
1595 "an unknown extension '%s'!\n", ext_name);
1605 if (wsi->ietf_spec_revision == 0) {
1607 if (memcmp(wsi->initial_handshake_hash_base64,
1608 wsi->utf8_token[WSI_TOKEN_CHALLENGE].token, 16)) {
1609 fprintf(stderr, "libwebsocket_client_handshake "
1610 "failed 00 challenge compare\n");
1612 fprintf(stderr, "%s", pkt);
1620 * Confirm his accept token is the one we precomputed
1623 if (strcmp(wsi->utf8_token[WSI_TOKEN_ACCEPT].token,
1624 wsi->initial_handshake_hash_base64)) {
1625 fprintf(stderr, "libwebsocket_client_handshake server "
1626 "sent bad ACCEPT '%s' vs computed '%s'\n",
1627 wsi->utf8_token[WSI_TOKEN_ACCEPT].token,
1628 wsi->initial_handshake_hash_base64);
1632 if (wsi->ietf_spec_revision == 4) {
1634 * Calculate the 04 masking key to use when
1635 * sending data to server
1638 strcpy((char *)buf, wsi->key_b64);
1639 p = (char *)buf + strlen(wsi->key_b64);
1640 strcpy(p, wsi->utf8_token[WSI_TOKEN_NONCE].token);
1641 p += wsi->utf8_token[WSI_TOKEN_NONCE].token_len;
1642 strcpy(p, magic_websocket_04_masking_guid);
1643 SHA1(buf, strlen((char *)buf), wsi->masking_key_04);
1647 /* allocate the per-connection user memory (if any) */
1649 if (wsi->protocol->per_session_data_size) {
1650 wsi->user_space = malloc(
1651 wsi->protocol->per_session_data_size);
1652 if (wsi->user_space == NULL) {
1653 fprintf(stderr, "Out of memory for "
1654 "conn user space\n");
1658 wsi->user_space = NULL;
1660 /* clear his proxy connection timeout */
1662 libwebsocket_set_timeout(wsi, NO_PENDING_TIMEOUT, 0);
1664 /* mark him as being alive */
1666 wsi->state = WSI_STATE_ESTABLISHED;
1667 wsi->mode = LWS_CONNMODE_WS_CLIENT;
1669 fprintf(stderr, "handshake OK for protocol %s\n",
1670 wsi->protocol->name);
1672 /* call him back to inform him he is up */
1674 wsi->protocol->callback(context, wsi,
1675 LWS_CALLBACK_CLIENT_ESTABLISHED,
1682 if (wsi->c_protocol)
1683 free(wsi->c_protocol);
1686 libwebsocket_close_and_free_session(context, wsi,
1687 LWS_CLOSE_STATUS_NOSTATUS);
1691 case LWS_CONNMODE_WS_SERVING:
1692 case LWS_CONNMODE_WS_CLIENT:
1694 /* handle session socket closed */
1696 if (pollfd->revents & (POLLERR | POLLHUP)) {
1698 fprintf(stderr, "Session Socket %p (fd=%d) dead\n",
1699 (void *)wsi, pollfd->fd);
1701 libwebsocket_close_and_free_session(context, wsi,
1702 LWS_CLOSE_STATUS_NOSTATUS);
1706 /* the guy requested a callback when it was OK to write */
1708 if ((pollfd->revents & POLLOUT) &&
1709 wsi->state == WSI_STATE_ESTABLISHED)
1710 if (lws_handle_POLLOUT_event(context, wsi,
1712 libwebsocket_close_and_free_session(
1713 context, wsi, LWS_CLOSE_STATUS_NORMAL);
1718 /* any incoming data ready? */
1720 if (!(pollfd->revents & POLLIN))
1723 #ifdef LWS_OPENSSL_SUPPORT
1725 eff_buf.token_len = SSL_read(wsi->ssl, buf, sizeof buf);
1729 recv(pollfd->fd, buf, sizeof buf, 0);
1731 if (eff_buf.token_len < 0) {
1732 fprintf(stderr, "Socket read returned %d\n",
1736 if (!eff_buf.token_len) {
1737 libwebsocket_close_and_free_session(context, wsi,
1738 LWS_CLOSE_STATUS_NOSTATUS);
1743 * give any active extensions a chance to munge the buffer
1744 * before parse. We pass in a pointer to an lws_tokens struct
1745 * prepared with the default buffer and content length that's in
1746 * there. Rather than rewrite the default buffer, extensions
1747 * that expect to grow the buffer can adapt .token to
1748 * point to their own per-connection buffer in the extension
1749 * user allocation. By default with no extensions or no
1750 * extension callback handling, just the normal input buffer is
1751 * used then so it is efficient.
1754 eff_buf.token = (char *)buf;
1761 for (n = 0; n < wsi->count_active_extensions; n++) {
1762 m = wsi->active_extensions[n]->callback(context, wsi,
1763 LWS_EXT_CALLBACK_PACKET_RX_PREPARSE,
1764 wsi->active_extensions_user[n], &eff_buf, 0);
1766 fprintf(stderr, "Extension reports fatal error\n");
1767 libwebsocket_close_and_free_session(context, wsi,
1768 LWS_CLOSE_STATUS_NOSTATUS);
1775 /* service incoming data */
1777 if (eff_buf.token_len) {
1778 n = libwebsocket_read(context, wsi,
1779 (unsigned char *)eff_buf.token, eff_buf.token_len);
1785 eff_buf.token = NULL;
1786 eff_buf.token_len = 0;
1796 * libwebsocket_context_destroy() - Destroy the websocket context
1797 * @context: Websocket context
1799 * This function closes any active connections and then frees the
1800 * context. After calling this, any further use of the context is
1804 libwebsocket_context_destroy(struct libwebsocket_context *context)
1808 struct libwebsocket *wsi;
1810 for (n = 0; n < FD_HASHTABLE_MODULUS; n++)
1811 for (m = 0; m < context->fd_hashtable[n].length; m++) {
1812 wsi = context->fd_hashtable[n].wsi[m];
1813 libwebsocket_close_and_free_session(context, wsi,
1814 LWS_CLOSE_STATUS_GOINGAWAY);
1819 close(context->fd_random);
1822 #ifdef LWS_OPENSSL_SUPPORT
1823 if (context->ssl_ctx)
1824 SSL_CTX_free(context->ssl_ctx);
1825 if (context->ssl_client_ctx)
1826 SSL_CTX_free(context->ssl_client_ctx);
1837 * libwebsocket_service() - Service any pending websocket activity
1838 * @context: Websocket context
1839 * @timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
1840 * service otherwise block and service immediately, returning
1841 * after the timeout if nothing needed service.
1843 * This function deals with any pending websocket traffic, for three
1844 * kinds of event. It handles these events on both server and client
1845 * types of connection the same.
1847 * 1) Accept new connections to our context's server
1849 * 2) Perform pending broadcast writes initiated from other forked
1850 * processes (effectively serializing asynchronous broadcasts)
1852 * 3) Call the receive callback for incoming frame data received by
1853 * server or client connections.
1855 * You need to call this service function periodically to all the above
1856 * functions to happen; if your application is single-threaded you can
1857 * just call it in your main event loop.
1859 * Alternatively you can fork a new process that asynchronously handles
1860 * calling this service in a loop. In that case you are happy if this
1861 * call blocks your thread until it needs to take care of something and
1862 * would call it with a large nonzero timeout. Your loop then takes no
1863 * CPU while there is nothing happening.
1865 * If you are calling it in a single-threaded app, you don't want it to
1866 * wait around blocking other things in your loop from happening, so you
1867 * would call it with a timeout_ms of 0, so it returns immediately if
1868 * nothing is pending, or as soon as it services whatever was pending.
1873 libwebsocket_service(struct libwebsocket_context *context, int timeout_ms)
1877 /* stay dead once we are dead */
1879 if (context == NULL)
1882 /* wait for something to need service */
1884 n = poll(context->fds, context->fds_count, timeout_ms);
1885 if (n == 0) /* poll timeout */
1890 fprintf(stderr, "Listen Socket dead\n");
1895 /* handle accept on listening socket? */
1897 for (n = 0; n < context->fds_count; n++)
1898 if (context->fds[n].revents)
1899 libwebsocket_service_fd(context, &context->fds[n]);
1905 * libwebsocket_callback_on_writable() - Request a callback when this socket
1906 * becomes able to be written to without
1909 * @context: libwebsockets context
1910 * @wsi: Websocket connection instance to get callback for
1914 libwebsocket_callback_on_writable(struct libwebsocket_context *context,
1915 struct libwebsocket *wsi)
1919 for (n = 0; n < context->fds_count; n++)
1920 if (context->fds[n].fd == wsi->sock) {
1921 context->fds[n].events |= POLLOUT;
1922 n = context->fds_count;
1925 /* external POLL support via protocol 0 */
1926 context->protocols[0].callback(context, wsi,
1927 LWS_CALLBACK_SET_MODE_POLL_FD,
1928 (void *)(long)wsi->sock, NULL, POLLOUT);
1934 * libwebsocket_callback_on_writable_all_protocol() - Request a callback for
1935 * all connections using the given protocol when it
1936 * becomes possible to write to each socket without
1939 * @protocol: Protocol whose connections will get callbacks
1943 libwebsocket_callback_on_writable_all_protocol(
1944 const struct libwebsocket_protocols *protocol)
1946 struct libwebsocket_context *context = protocol->owning_server;
1949 struct libwebsocket *wsi;
1951 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
1953 for (m = 0; m < context->fd_hashtable[n].length; m++) {
1955 wsi = context->fd_hashtable[n].wsi[m];
1957 if (wsi->protocol == protocol)
1958 libwebsocket_callback_on_writable(context, wsi);
1966 * libwebsocket_set_timeout() - marks the wsi as subject to a timeout
1968 * You will not need this unless you are doing something special
1970 * @wsi: Websocket connection instance
1971 * @reason: timeout reason
1972 * @secs: how many seconds
1976 libwebsocket_set_timeout(struct libwebsocket *wsi,
1977 enum pending_timeout reason, int secs)
1981 gettimeofday(&tv, NULL);
1983 wsi->pending_timeout_limit = tv.tv_sec + secs;
1984 wsi->pending_timeout = reason;
1989 * libwebsocket_get_socket_fd() - returns the socket file descriptor
1991 * You will not need this unless you are doing something special
1993 * @wsi: Websocket connection instance
1997 libwebsocket_get_socket_fd(struct libwebsocket *wsi)
2003 * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
2004 * receieved packets.
2006 * If the output side of a server process becomes choked, this allows flow
2007 * control for the input side.
2009 * @wsi: Websocket connection instance to get callback for
2010 * @enable: 0 = disable read servicing for this connection, 1 = enable
2014 libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
2016 struct libwebsocket_context *context = wsi->protocol->owning_server;
2019 for (n = 0; n < context->fds_count; n++)
2020 if (context->fds[n].fd == wsi->sock) {
2022 context->fds[n].events |= POLLIN;
2024 context->fds[n].events &= ~POLLIN;
2030 /* external POLL support via protocol 0 */
2031 context->protocols[0].callback(context, wsi,
2032 LWS_CALLBACK_SET_MODE_POLL_FD,
2033 (void *)(long)wsi->sock, NULL, POLLIN);
2035 /* external POLL support via protocol 0 */
2036 context->protocols[0].callback(context, wsi,
2037 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
2038 (void *)(long)wsi->sock, NULL, POLLIN);
2041 fprintf(stderr, "libwebsocket_callback_on_writable "
2042 "unable to find socket\n");
2047 * libwebsocket_canonical_hostname() - returns this host's hostname
2049 * This is typically used by client code to fill in the host parameter
2050 * when making a client connection. You can only call it after the context
2053 * @context: Websocket context
2058 libwebsocket_canonical_hostname(struct libwebsocket_context *context)
2060 return (const char *)context->canonical_hostname;
2064 static void sigpipe_handler(int x)
2068 #ifdef LWS_OPENSSL_SUPPORT
2070 OpenSSL_verify_callback(int preverify_ok, X509_STORE_CTX *x509_ctx)
2075 struct libwebsocket_context *context;
2077 ssl = X509_STORE_CTX_get_ex_data(x509_ctx,
2078 SSL_get_ex_data_X509_STORE_CTX_idx());
2081 * !!! nasty openssl requires the index to come as a library-scope
2084 context = SSL_get_ex_data(ssl, openssl_websocket_private_data_index);
2086 n = context->protocols[0].callback(NULL, NULL,
2087 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION,
2088 x509_ctx, ssl, preverify_ok);
2090 /* convert return code from 0 = OK to 1 = OK */
2103 * libwebsocket_create_context() - Create the websocket handler
2104 * @port: Port to listen on... you can use 0 to suppress listening on
2105 * any port, that's what you want if you are not running a
2106 * websocket server at all but just using it as a client
2107 * @interf: NULL to bind the listen socket to all interfaces, or the
2108 * interface name, eg, "eth2"
2109 * @protocols: Array of structures listing supported protocols and a protocol-
2110 * specific callback for each one. The list is ended with an
2111 * entry that has a NULL callback pointer.
2112 * It's not const because we write the owning_server member
2113 * @extensions: NULL or array of libwebsocket_extension structs listing the
2114 * extensions this context supports
2115 * @ssl_cert_filepath: If libwebsockets was compiled to use ssl, and you want
2116 * to listen using SSL, set to the filepath to fetch the
2117 * server cert from, otherwise NULL for unencrypted
2118 * @ssl_private_key_filepath: filepath to private key if wanting SSL mode,
2120 * @gid: group id to change to after setting listen socket, or -1.
2121 * @uid: user id to change to after setting listen socket, or -1.
2122 * @options: 0, or LWS_SERVER_OPTION_DEFEAT_CLIENT_MASK
2124 * This function creates the listening socket and takes care
2125 * of all initialization in one step.
2127 * After initialization, it returns a struct libwebsocket_context * that
2128 * represents this server. After calling, user code needs to take care
2129 * of calling libwebsocket_service() with the context pointer to get the
2130 * server's sockets serviced. This can be done in the same process context
2131 * or a forked process, or another thread,
2133 * The protocol callback functions are called for a handful of events
2134 * including http requests coming in, websocket connections becoming
2135 * established, and data arriving; it's also called periodically to allow
2136 * async transmission.
2138 * HTTP requests are sent always to the FIRST protocol in @protocol, since
2139 * at that time websocket protocol has not been negotiated. Other
2140 * protocols after the first one never see any HTTP callack activity.
2142 * The server created is a simple http server by default; part of the
2143 * websocket standard is upgrading this http connection to a websocket one.
2145 * This allows the same server to provide files like scripts and favicon /
2146 * images or whatever over http and dynamic data over websockets all in
2147 * one place; they're all handled in the user callback.
2150 struct libwebsocket_context *
2151 libwebsocket_create_context(int port, const char *interf,
2152 struct libwebsocket_protocols *protocols,
2153 struct libwebsocket_extension *extensions,
2154 const char *ssl_cert_filepath,
2155 const char *ssl_private_key_filepath,
2156 int gid, int uid, unsigned int options)
2161 struct sockaddr_in serv_addr, cli_addr;
2163 struct libwebsocket_context *context = NULL;
2166 char hostname[1024];
2168 struct libwebsocket *wsi;
2170 #ifdef LWS_OPENSSL_SUPPORT
2172 char ssl_err_buf[512];
2177 WORD wVersionRequested;
2181 /* Use the MAKEWORD(lowbyte, highbyte) macro from Windef.h */
2182 wVersionRequested = MAKEWORD(2, 2);
2184 err = WSAStartup(wVersionRequested, &wsaData);
2186 /* Tell the user that we could not find a usable */
2188 fprintf(stderr, "WSAStartup failed with error: %d\n",
2196 context = malloc(sizeof(struct libwebsocket_context));
2198 fprintf(stderr, "No memory for websocket context\n");
2201 context->protocols = protocols;
2202 context->listen_port = port;
2203 context->http_proxy_port = 0;
2204 context->http_proxy_address[0] = '\0';
2205 context->options = options;
2206 context->fds_count = 0;
2207 context->extensions = extensions;
2210 context->fd_random = 0;
2212 context->fd_random = open(SYSTEM_RANDOM_FILEPATH, O_RDONLY);
2213 if (context->fd_random < 0) {
2214 fprintf(stderr, "Unable to open random device %s %d\n",
2215 SYSTEM_RANDOM_FILEPATH, context->fd_random);
2220 #ifdef LWS_OPENSSL_SUPPORT
2221 context->use_ssl = 0;
2222 context->ssl_ctx = NULL;
2223 context->ssl_client_ctx = NULL;
2224 openssl_websocket_private_data_index = 0;
2226 /* find canonical hostname */
2228 hostname[(sizeof hostname) - 1] = '\0';
2229 gethostname(hostname, (sizeof hostname) - 1);
2230 he = gethostbyname(hostname);
2232 strncpy(context->canonical_hostname, he->h_name,
2233 sizeof context->canonical_hostname - 1);
2234 context->canonical_hostname[
2235 sizeof context->canonical_hostname - 1] = '\0';
2237 strncpy(context->canonical_hostname, hostname,
2238 sizeof context->canonical_hostname - 1);
2240 /* split the proxy ads:port if given */
2242 p = getenv("http_proxy");
2244 strncpy(context->http_proxy_address, p,
2245 sizeof context->http_proxy_address - 1);
2246 context->http_proxy_address[
2247 sizeof context->http_proxy_address - 1] = '\0';
2249 p = strchr(context->http_proxy_address, ':');
2251 fprintf(stderr, "http_proxy needs to be ads:port\n");
2255 context->http_proxy_port = atoi(p + 1);
2257 fprintf(stderr, "Using proxy %s:%u\n",
2258 context->http_proxy_address,
2259 context->http_proxy_port);
2264 #ifdef LWS_OPENSSL_SUPPORT
2265 context->use_ssl = ssl_cert_filepath != NULL &&
2266 ssl_private_key_filepath != NULL;
2267 if (context->use_ssl)
2268 fprintf(stderr, " Compiled with SSL support, "
2271 fprintf(stderr, " Compiled with SSL support, "
2275 if (ssl_cert_filepath != NULL &&
2276 ssl_private_key_filepath != NULL) {
2277 fprintf(stderr, " Not compiled for OpenSSl support!\n");
2280 fprintf(stderr, " Compiled without SSL support, "
2281 "serving unencrypted\n");
2285 /* ignore SIGPIPE */
2288 signal(SIGPIPE, sigpipe_handler);
2292 #ifdef LWS_OPENSSL_SUPPORT
2294 /* basic openssl init */
2298 OpenSSL_add_all_algorithms();
2299 SSL_load_error_strings();
2301 openssl_websocket_private_data_index =
2302 SSL_get_ex_new_index(0, "libwebsockets", NULL, NULL, NULL);
2305 * Firefox insists on SSLv23 not SSLv3
2306 * Konq disables SSLv2 by default now, SSLv23 works
2309 method = (SSL_METHOD *)SSLv23_server_method();
2311 fprintf(stderr, "problem creating ssl method: %s\n",
2312 ERR_error_string(ERR_get_error(), ssl_err_buf));
2315 context->ssl_ctx = SSL_CTX_new(method); /* create context */
2316 if (!context->ssl_ctx) {
2317 fprintf(stderr, "problem creating ssl context: %s\n",
2318 ERR_error_string(ERR_get_error(), ssl_err_buf));
2322 /* client context */
2323 if (port == CONTEXT_PORT_NO_LISTEN)
2325 method = (SSL_METHOD *)SSLv23_client_method();
2327 fprintf(stderr, "problem creating ssl method: %s\n",
2328 ERR_error_string(ERR_get_error(), ssl_err_buf));
2331 /* create context */
2332 context->ssl_client_ctx = SSL_CTX_new(method);
2333 if (!context->ssl_client_ctx) {
2334 fprintf(stderr, "problem creating ssl context: %s\n",
2335 ERR_error_string(ERR_get_error(), ssl_err_buf));
2339 /* openssl init for cert verification (for client sockets) */
2341 if (!SSL_CTX_load_verify_locations(
2342 context->ssl_client_ctx, NULL,
2343 LWS_OPENSSL_CLIENT_CERTS))
2345 "Unable to load SSL Client certs from %s "
2346 "(set by --with-client-cert-dir= in configure) -- "
2347 " client ssl isn't going to work",
2348 LWS_OPENSSL_CLIENT_CERTS);
2351 * callback allowing user code to load extra verification certs
2352 * helping the client to verify server identity
2355 context->protocols[0].callback(context, NULL,
2356 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS,
2357 context->ssl_client_ctx, NULL, 0);
2359 /* as a server, are we requiring clients to identify themselves? */
2361 if (options & LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT) {
2363 /* absolutely require the client cert */
2365 SSL_CTX_set_verify(context->ssl_ctx,
2366 SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
2367 OpenSSL_verify_callback);
2370 * give user code a chance to load certs into the server
2371 * allowing it to verify incoming client certs
2374 context->protocols[0].callback(context, NULL,
2375 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS,
2376 context->ssl_ctx, NULL, 0);
2379 if (context->use_ssl) {
2381 /* openssl init for server sockets */
2383 /* set the local certificate from CertFile */
2384 n = SSL_CTX_use_certificate_file(context->ssl_ctx,
2385 ssl_cert_filepath, SSL_FILETYPE_PEM);
2387 fprintf(stderr, "problem getting cert '%s': %s\n",
2389 ERR_error_string(ERR_get_error(), ssl_err_buf));
2392 /* set the private key from KeyFile */
2393 if (SSL_CTX_use_PrivateKey_file(context->ssl_ctx,
2394 ssl_private_key_filepath, SSL_FILETYPE_PEM) != 1) {
2395 fprintf(stderr, "ssl problem getting key '%s': %s\n",
2396 ssl_private_key_filepath,
2397 ERR_error_string(ERR_get_error(), ssl_err_buf));
2400 /* verify private key */
2401 if (!SSL_CTX_check_private_key(context->ssl_ctx)) {
2402 fprintf(stderr, "Private SSL key doesn't match cert\n");
2406 /* SSL is happy and has a cert it's content with */
2412 if (lws_b64_selftest())
2415 /* fd hashtable init */
2417 for (n = 0; n < FD_HASHTABLE_MODULUS; n++)
2418 context->fd_hashtable[n].length = 0;
2420 /* set up our external listening socket we serve on */
2424 sockfd = socket(AF_INET, SOCK_STREAM, 0);
2426 fprintf(stderr, "ERROR opening socket");
2430 /* allow us to restart even if old sockets in TIME_WAIT */
2431 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
2436 setsockopt(sockfd, SOL_TCP, TCP_NODELAY, &opt, sizeof(opt));
2438 bzero((char *) &serv_addr, sizeof(serv_addr));
2439 serv_addr.sin_family = AF_INET;
2441 serv_addr.sin_addr.s_addr = INADDR_ANY;
2443 interface_to_sa(interf, &serv_addr,
2445 serv_addr.sin_port = htons(port);
2447 n = bind(sockfd, (struct sockaddr *) &serv_addr,
2450 fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
2455 wsi = malloc(sizeof(struct libwebsocket));
2456 memset(wsi, 0, sizeof (struct libwebsocket));
2458 wsi->count_active_extensions = 0;
2459 wsi->mode = LWS_CONNMODE_SERVER_LISTENER;
2460 insert_wsi(context, wsi);
2463 fprintf(stderr, " Listening on port %d\n", port);
2465 /* list in the internal poll array */
2467 context->fds[context->fds_count].fd = sockfd;
2468 context->fds[context->fds_count++].events = POLLIN;
2470 /* external POLL support via protocol 0 */
2471 context->protocols[0].callback(context, wsi,
2472 LWS_CALLBACK_ADD_POLL_FD,
2473 (void *)(long)sockfd, NULL, POLLIN);
2477 /* drop any root privs for this process */
2482 fprintf(stderr, "setgid: %s\n", strerror(errno));
2485 fprintf(stderr, "setuid: %s\n", strerror(errno));
2488 /* set up our internal broadcast trigger sockets per-protocol */
2490 for (context->count_protocols = 0;
2491 protocols[context->count_protocols].callback;
2492 context->count_protocols++) {
2493 protocols[context->count_protocols].owning_server = context;
2494 protocols[context->count_protocols].protocol_index =
2495 context->count_protocols;
2497 fd = socket(AF_INET, SOCK_STREAM, 0);
2499 fprintf(stderr, "ERROR opening socket");
2503 /* allow us to restart even if old sockets in TIME_WAIT */
2504 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
2506 bzero((char *) &serv_addr, sizeof(serv_addr));
2507 serv_addr.sin_family = AF_INET;
2508 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
2509 serv_addr.sin_port = 0; /* pick the port for us */
2511 n = bind(fd, (struct sockaddr *) &serv_addr, sizeof(serv_addr));
2513 fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
2518 slen = sizeof cli_addr;
2519 n = getsockname(fd, (struct sockaddr *)&cli_addr, &slen);
2521 fprintf(stderr, "getsockname failed\n");
2524 protocols[context->count_protocols].broadcast_socket_port =
2525 ntohs(cli_addr.sin_port);
2528 debug(" Protocol %s broadcast socket %d\n",
2529 protocols[context->count_protocols].name,
2530 ntohs(cli_addr.sin_port));
2532 /* dummy wsi per broadcast proxy socket */
2534 wsi = malloc(sizeof(struct libwebsocket));
2535 memset(wsi, 0, sizeof (struct libwebsocket));
2537 wsi->mode = LWS_CONNMODE_BROADCAST_PROXY_LISTENER;
2538 wsi->count_active_extensions = 0;
2539 /* note which protocol we are proxying */
2540 wsi->protocol_index_for_broadcast_proxy =
2541 context->count_protocols;
2542 insert_wsi(context, wsi);
2544 /* list in internal poll array */
2546 context->fds[context->fds_count].fd = fd;
2547 context->fds[context->fds_count].events = POLLIN;
2548 context->fds[context->fds_count].revents = 0;
2549 context->fds_count++;
2551 /* external POLL support via protocol 0 */
2552 context->protocols[0].callback(context, wsi,
2553 LWS_CALLBACK_ADD_POLL_FD,
2554 (void *)(long)fd, NULL, POLLIN);
2564 * libwebsockets_fork_service_loop() - Optional helper function forks off
2565 * a process for the websocket server loop.
2566 * You don't have to use this but if not, you
2567 * have to make sure you are calling
2568 * libwebsocket_service periodically to service
2569 * the websocket traffic
2570 * @context: server context returned by creation function
2574 libwebsockets_fork_service_loop(struct libwebsocket_context *context)
2577 struct sockaddr_in cli_addr;
2587 /* main process context */
2590 * set up the proxy sockets to allow broadcast from
2591 * service process context
2594 for (p = 0; p < context->count_protocols; p++) {
2595 fd = socket(AF_INET, SOCK_STREAM, 0);
2597 fprintf(stderr, "Unable to create socket\n");
2600 cli_addr.sin_family = AF_INET;
2601 cli_addr.sin_port = htons(
2602 context->protocols[p].broadcast_socket_port);
2603 cli_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
2604 n = connect(fd, (struct sockaddr *)&cli_addr,
2607 fprintf(stderr, "Unable to connect to "
2608 "broadcast socket %d, %s\n",
2609 n, strerror(errno));
2613 context->protocols[p].broadcast_socket_user_fd = fd;
2619 /* we want a SIGHUP when our parent goes down */
2620 prctl(PR_SET_PDEATHSIG, SIGHUP);
2622 /* in this forked process, sit and service websocket connections */
2625 if (libwebsocket_service(context, 1000))
2634 * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
2636 * @wsi: pointer to struct websocket you want to know the protocol of
2639 * This is useful to get the protocol to broadcast back to from inside
2643 const struct libwebsocket_protocols *
2644 libwebsockets_get_protocol(struct libwebsocket *wsi)
2646 return wsi->protocol;
2650 * libwebsockets_broadcast() - Sends a buffer to the callback for all active
2651 * connections of the given protocol.
2652 * @protocol: pointer to the protocol you will broadcast to all members of
2653 * @buf: buffer containing the data to be broadcase. NOTE: this has to be
2654 * allocated with LWS_SEND_BUFFER_PRE_PADDING valid bytes before
2655 * the pointer and LWS_SEND_BUFFER_POST_PADDING afterwards in the
2656 * case you are calling this function from callback context.
2657 * @len: length of payload data in buf, starting from buf.
2659 * This function allows bulk sending of a packet to every connection using
2660 * the given protocol. It does not send the data directly; instead it calls
2661 * the callback with a reason type of LWS_CALLBACK_BROADCAST. If the callback
2662 * wants to actually send the data for that connection, the callback itself
2663 * should call libwebsocket_write().
2665 * libwebsockets_broadcast() can be called from another fork context without
2666 * having to take any care about data visibility between the processes, it'll
2672 libwebsockets_broadcast(const struct libwebsocket_protocols *protocol,
2673 unsigned char *buf, size_t len)
2675 struct libwebsocket_context *context = protocol->owning_server;
2678 struct libwebsocket * wsi;
2680 if (!protocol->broadcast_socket_user_fd) {
2682 * We are either running unforked / flat, or we are being
2683 * called from poll thread context
2684 * eg, from a callback. In that case don't use sockets for
2685 * broadcast IPC (since we can't open a socket connection to
2686 * a socket listening on our own thread) but directly do the
2689 * Locking is not needed because we are by definition being
2690 * called in the poll thread context and are serialized.
2693 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
2695 for (m = 0; m < context->fd_hashtable[n].length; m++) {
2697 wsi = context->fd_hashtable[n].wsi[m];
2699 if (wsi->mode != LWS_CONNMODE_WS_SERVING)
2703 * never broadcast to
2704 * non-established connections
2706 if (wsi->state != WSI_STATE_ESTABLISHED)
2709 /* only broadcast to guys using
2710 * requested protocol
2712 if (wsi->protocol != protocol)
2715 wsi->protocol->callback(context, wsi,
2716 LWS_CALLBACK_BROADCAST,
2726 * We're being called from a different process context than the server
2727 * loop. Instead of broadcasting directly, we send our
2728 * payload on a socket to do the IPC; the server process will serialize
2729 * the broadcast action in its main poll() loop.
2731 * There's one broadcast socket listening for each protocol supported
2732 * set up when the websocket server initializes
2735 n = send(protocol->broadcast_socket_user_fd, buf, len, MSG_NOSIGNAL);
2741 libwebsocket_is_final_fragment(struct libwebsocket *wsi)