72a3fe5e3d55dce6b1a53df073c25f788b71d572
[profile/ivi/libwebsockets.git] / lib / libwebsockets.c
1 /*
2  * libwebsockets - small server side websockets and web server implementation
3  *
4  * Copyright (C) 2010 Andy Green <andy@warmcat.com>
5  *
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.
10  *
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.
15  *
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,
19  *  MA  02110-1301  USA
20  */
21
22 #include "private-libwebsockets.h"
23
24 #ifdef WIN32
25
26 #else
27 #include <ifaddrs.h>
28 #endif
29
30 #ifdef LWS_OPENSSL_SUPPORT
31 int openssl_websocket_private_data_index;
32 #endif
33
34 /*
35  * In-place str to lower case
36  */
37
38 static void
39 strtolower(char *s)
40 {
41         while (*s) {
42                 *s = tolower(*s);
43                 s++;
44         }
45 }
46
47 /* file descriptor hash management */
48
49 struct libwebsocket *
50 wsi_from_fd(struct libwebsocket_context *context, int fd)
51 {
52         int h = LWS_FD_HASH(fd);
53         int n = 0;
54
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];
58
59         return NULL;
60 }
61
62 int
63 insert_wsi(struct libwebsocket_context *context, struct libwebsocket *wsi)
64 {
65         int h = LWS_FD_HASH(wsi->sock);
66
67         if (context->fd_hashtable[h].length == MAX_CLIENTS - 1) {
68                 fprintf(stderr, "hash table overflow\n");
69                 return 1;
70         }
71
72         context->fd_hashtable[h].wsi[context->fd_hashtable[h].length++] = wsi;
73
74         return 0;
75 }
76
77 int
78 delete_from_fd(struct libwebsocket_context *context, int fd)
79 {
80         int h = LWS_FD_HASH(fd);
81         int n = 0;
82
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];
88                                 n++;
89                         }
90                         context->fd_hashtable[h].length--;
91
92                         return 0;
93                 }
94
95         fprintf(stderr, "Failed to find fd %d requested for "
96                                                    "delete in hashtable\n", fd);
97         return 1;
98 }
99
100 #ifdef LWS_OPENSSL_SUPPORT
101 static void
102 libwebsockets_decode_ssl_error(void)
103 {
104         char buf[256];
105         u_long err;
106
107         while ((err = ERR_get_error()) != 0) {
108                 ERR_error_string_n(err, buf, sizeof(buf));
109                 fprintf(stderr, "*** %s\n", buf);
110         }
111 }
112 #endif
113
114
115 static int
116 interface_to_sa(const char* ifname, struct sockaddr_in *addr, size_t addrlen)
117 {
118         int rc = -1;
119 #ifdef WIN32
120         // TODO
121 #else
122         struct ifaddrs *ifr;
123         struct ifaddrs *ifc;
124         struct sockaddr_in *sin;
125
126         getifaddrs(&ifr);
127         for (ifc = ifr; ifc != NULL; ifc = ifc->ifa_next) {
128                 if (strcmp(ifc->ifa_name, ifname))
129                         continue;
130                 if (ifc->ifa_addr == NULL)
131                         continue;
132                 sin = (struct sockaddr_in *)ifc->ifa_addr;
133                 if (sin->sin_family != AF_INET)
134                         continue;
135                 memcpy(addr, sin, addrlen);
136                 rc = 0; 
137         }
138
139         freeifaddrs(ifr);
140 #endif
141         return rc;
142 }
143
144 void
145 libwebsocket_close_and_free_session(struct libwebsocket_context *context,
146                          struct libwebsocket *wsi, enum lws_close_status reason)
147 {
148         int n;
149         int old_state;
150         unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 2 +
151                                                   LWS_SEND_BUFFER_POST_PADDING];
152         int ret;
153         int m;
154         struct lws_tokens eff_buf;
155
156         if (!wsi)
157                 return;
158
159         old_state = wsi->state;
160
161         if (old_state == WSI_STATE_DEAD_SOCKET)
162                 return;
163
164         wsi->close_reason = reason;
165
166         /*
167          * flush any tx pending from extensions, since we may send close packet
168          * if there are problems with send, just nuke the connection
169          */
170
171         ret = 1;
172         while (ret == 1) {
173
174                 /* default to nobody has more to spill */
175
176                 ret = 0;
177                 eff_buf.token = NULL;
178                 eff_buf.token_len = 0;
179
180                 /* show every extension the new incoming data */
181
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);
187                         if (m < 0) {
188                                 fprintf(stderr, "Extension reports "
189                                                                "fatal error\n");
190                                 goto just_kill_connection;
191                         }
192                         if (m)
193                                 /*
194                                  * at least one extension told us he has more
195                                  * to spill, so we will go around again after
196                                  */
197                                 ret = 1;
198                 }
199
200                 /* assuming they left us something to send, send it */
201
202                 if (eff_buf.token_len)
203                         if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
204                                                              eff_buf.token_len))
205                                 goto just_kill_connection;
206         }
207
208         /*
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.
214          *
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.
218          */
219
220         if (old_state == WSI_STATE_ESTABLISHED &&
221                                           reason != LWS_CLOSE_STATUS_NOSTATUS) {
222                 n = libwebsocket_write(wsi, &buf[LWS_SEND_BUFFER_PRE_PADDING],
223                                                             0, LWS_WRITE_CLOSE);
224                 if (!n) {
225                         /*
226                          * we have sent a nice protocol level indication we
227                          * now wish to close, we should not send anything more
228                          */
229
230                         wsi->state = WSI_STATE_AWAITING_CLOSE_ACK;
231
232                         /* and we should wait for a reply for a bit */
233
234                         libwebsocket_set_timeout(wsi,
235                                                   PENDING_TIMEOUT_CLOSE_ACK, 5);
236
237                         fprintf(stderr, "sent close indication, awaiting ack\n");
238
239                         return;
240                 }
241
242                 /* else, the send failed and we should just hang up */
243         }
244
245 just_kill_connection:
246         /*
247          * we won't be servicing or receiving anything further from this guy
248          * remove this fd from wsi mapping hashtable
249          */
250
251         delete_from_fd(context, wsi->sock);
252
253         /* delete it from the internal poll list if still present */
254
255         for (n = 0; n < context->fds_count; n++) {
256                 if (context->fds[n].fd != wsi->sock)
257                         continue;
258                 while (n < context->fds_count - 1) {
259                         context->fds[n] = context->fds[n + 1];
260                         n++;
261                 }
262                 context->fds_count--;
263                 /* we only have to deal with one */
264                 n = context->fds_count;
265         }
266
267         /* remove also from external POLL support via protocol 0 */
268
269         context->protocols[0].callback(context, wsi,
270                     LWS_CALLBACK_DEL_POLL_FD, (void *)(long)wsi->sock, NULL, 0);
271
272         wsi->state = WSI_STATE_DEAD_SOCKET;
273
274         /* tell the user it's all over for this guy */
275
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);
280
281         /* deallocate any active extension contexts */
282
283         for (n = 0; n < wsi->count_active_extensions; n++) {
284                 if (!wsi->active_extensions[n]->callback)
285                         continue;
286
287                 wsi->active_extensions[n]->callback(context, wsi,
288                         LWS_EXT_CALLBACK_DESTROY,
289                         wsi->active_extensions_user[n], NULL, 0);
290
291                 free(wsi->active_extensions_user[n]);
292         }
293
294         /* free up his parsing allocations */
295
296         for (n = 0; n < WSI_TOKEN_COUNT; n++)
297                 if (wsi->utf8_token[n].token)
298                         free(wsi->utf8_token[n].token);
299
300 /*      fprintf(stderr, "closing fd=%d\n", wsi->sock); */
301
302 #ifdef LWS_OPENSSL_SUPPORT
303         if (wsi->ssl) {
304                 n = SSL_get_fd(wsi->ssl);
305                 SSL_shutdown(wsi->ssl);
306 #ifdef WIN32
307                 closesocket(n);
308 #else
309                 close(n);
310 #endif
311                 SSL_free(wsi->ssl);
312         } else {
313 #endif
314                 shutdown(wsi->sock, SHUT_RDWR);
315 #ifdef WIN32
316                 closesocket(wsi->sock);
317 #else
318                 close(wsi->sock);
319 #endif
320 #ifdef LWS_OPENSSL_SUPPORT
321         }
322 #endif
323         if (wsi->user_space)
324                 free(wsi->user_space);
325
326         free(wsi);
327 }
328
329 /**
330  * libwebsockets_hangup_on_client() - Server calls to terminate client
331  *                                      connection
332  * @context:    libwebsockets context
333  * @fd:         Connection socket descriptor
334  */
335
336 void
337 libwebsockets_hangup_on_client(struct libwebsocket_context *context, int fd)
338 {
339         struct libwebsocket *wsi = wsi_from_fd(context, fd);
340
341         if (wsi == NULL)
342                 return;
343
344         libwebsocket_close_and_free_session(context, wsi,
345                                                      LWS_CLOSE_STATUS_NOSTATUS);
346 }
347
348
349 /**
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
356  *
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.
361  */
362
363 void
364 libwebsockets_get_peer_addresses(int fd, char *name, int name_len,
365                                         char *rip, int rip_len)
366 {
367         unsigned int len;
368         struct sockaddr_in sin;
369         struct hostent *host;
370         struct hostent *host1;
371         char ip[128];
372         char *p;
373         int n;
374
375         rip[0] = '\0';
376         name[0] = '\0';
377
378         len = sizeof sin;
379         if (getpeername(fd, (struct sockaddr *) &sin, &len) < 0) {
380                 perror("getpeername");
381                 return;
382         }
383                 
384         host = gethostbyaddr((char *) &sin.sin_addr, sizeof sin.sin_addr,
385                                                                        AF_INET);
386         if (host == NULL) {
387                 perror("gethostbyaddr");
388                 return;
389         }
390
391         strncpy(name, host->h_name, name_len);
392         name[name_len - 1] = '\0';
393
394         host1 = gethostbyname(host->h_name);
395         if (host1 == NULL)
396                 return;
397         p = (char *)host1;
398         n = 0;
399         while (p != NULL) {
400                 p = host1->h_addr_list[n++];
401                 if (p == NULL)
402                         continue;
403                 if (host1->h_addrtype != AF_INET)
404                         continue;
405
406                 sprintf(ip, "%d.%d.%d.%d",
407                                 p[0], p[1], p[2], p[3]);
408                 p = NULL;
409                 strncpy(rip, ip, rip_len);
410                 rip[rip_len - 1] = '\0';
411         }
412 }
413
414 int libwebsockets_get_random(struct libwebsocket_context *context,
415                                                              void *buf, int len)
416 {
417         int n;
418         char *p = buf;
419
420 #ifdef WIN32
421         for (n = 0; n < len; n++)
422                 p[n] = (unsigned char)rand();
423 #else
424         n = read(context->fd_random, p, len);
425 #endif
426
427         return n;
428 }
429
430 void libwebsockets_00_spaceout(char *key, int spaces, int seed)
431 {
432         char *p;
433         
434         key++;
435         while (spaces--) {
436                 if (*key && (seed & 1))
437                         key++;
438                 seed >>= 1;
439                 
440                 p = key + strlen(key);
441                 while (p >= key) {
442                         p[1] = p[0];
443                         p--;
444                 }
445                 *key++ = ' ';
446         }
447 }
448
449 void libwebsockets_00_spam(char *key, int count, int seed)
450 {
451         char *p;
452
453         key++;
454         while (count--) {
455                 
456                 if (*key && (seed & 1))
457                         key++;
458                 seed >>= 1;
459
460                 p = key + strlen(key);
461                 while (p >= key) {
462                         p[1] = p[0];
463                         p--;
464                 }
465                 *key++ = 0x21 + ((seed & 0xffff) % 15);
466                 /* 4 would use it up too fast.. not like it matters */
467                 seed >>= 1;
468         }
469 }
470
471 int lws_send_pipe_choked(struct libwebsocket *wsi)
472 {
473         struct pollfd fds;
474
475         fds.fd = wsi->sock;
476         fds.events = POLLOUT;
477         fds.revents = 0;
478
479         if (poll(&fds, 1, 0) != 1)
480                 return 1;
481
482         if ((fds.revents & POLLOUT) == 0)
483                 return 1;
484
485         /* okay to send another packet without blocking */
486
487         return 0;
488 }
489
490 static int
491 lws_handle_POLLOUT_event(struct libwebsocket_context *context,
492                                 struct libwebsocket *wsi, struct pollfd *pollfd)
493 {
494         struct lws_tokens eff_buf;
495         int n;
496         int ret;
497         int m;
498
499         if (!wsi->extension_data_pending)
500                 goto user_service;
501
502         /*
503          * check in on the active extensions, see if they
504          * had pending stuff to spill... they need to get the
505          * first look-in otherwise sequence will be disordered
506          *
507          * NULL, zero-length eff_buf means just spill pending
508          */
509
510         ret = 1;
511         while (ret == 1) {
512
513                 /* default to nobody has more to spill */
514
515                 ret = 0;
516                 eff_buf.token = NULL;
517                 eff_buf.token_len = 0;
518
519                 /* give every extension a chance to spill */
520
521                 for (n = 0; n < wsi->count_active_extensions; n++) {
522                         m = wsi->active_extensions[n]->callback(
523                                 wsi->protocol->owning_server, wsi,
524                                         LWS_EXT_CALLBACK_PACKET_TX_PRESEND,
525                                    wsi->active_extensions_user[n], &eff_buf, 0);
526                         if (m < 0) {
527                                 fprintf(stderr, "extension reports fatal error\n");
528                                 return -1;
529                         }
530                         if (m)
531                                 /*
532                                  * at least one extension told us he has more
533                                  * to spill, so we will go around again after
534                                  */
535                                 ret = 1;
536                 }
537
538                 /* assuming they gave us something to send, send it */
539
540                 if (eff_buf.token_len) {
541                         if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
542                                                              eff_buf.token_len))
543                                 return -1;
544                 } else
545                         continue;
546
547                 /* no extension has more to spill */
548
549                 if (!ret)
550                         continue;
551
552                 /*
553                  * There's more to spill from an extension, but we just sent
554                  * something... did that leave the pipe choked?
555                  */
556
557                 if (!lws_send_pipe_choked(wsi))
558                         /* no we could add more */
559                         continue;
560
561                 fprintf(stderr, "choked in POLLOUT service\n");
562
563                 /*
564                  * Yes, he's choked.  Leave the POLLOUT masked on so we will
565                  * come back here when he is unchoked.  Don't call the user
566                  * callback to enforce ordering of spilling, he'll get called
567                  * when we come back here and there's nothing more to spill.
568                  */
569
570                 return 0;
571         }
572
573         wsi->extension_data_pending = 0;
574
575 user_service:
576         /* one shot */
577
578         pollfd->events &= ~POLLOUT;
579
580         /* external POLL support via protocol 0 */
581         context->protocols[0].callback(context, wsi,
582                 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
583                 (void *)(long)wsi->sock, NULL, POLLOUT);
584
585         wsi->protocol->callback(context, wsi,
586                 LWS_CALLBACK_CLIENT_WRITEABLE,
587                 wsi->user_space,
588                 NULL, 0);
589
590         return 0;
591 }
592
593
594
595 /**
596  * libwebsocket_service_fd() - Service polled socket with something waiting
597  * @context:    Websocket context
598  * @pollfd:     The pollfd entry describing the socket fd and which events
599  *              happened.
600  *
601  *      This function closes any active connections and then frees the
602  *      context.  After calling this, any further use of the context is
603  *      undefined.
604  */
605
606 int
607 libwebsocket_service_fd(struct libwebsocket_context *context,
608                                                           struct pollfd *pollfd)
609 {
610         unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 1 + MAX_BROADCAST_PAYLOAD +
611                                                   LWS_SEND_BUFFER_POST_PADDING];
612         struct libwebsocket *wsi;
613         struct libwebsocket *new_wsi;
614         int n;
615         int m;
616         size_t len;
617         int accept_fd;
618         unsigned int clilen;
619         struct sockaddr_in cli_addr;
620         struct timeval tv;
621         static const char magic_websocket_guid[] =
622                                          "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
623         static const char magic_websocket_04_masking_guid[] =
624                                          "61AC5F19-FBBA-4540-B96F-6561F1AB40A8";
625         char hash[20];
626         char pkt[1024];
627         char *p = &pkt[0];
628         const char *pc;
629         const char *c;
630         int more = 1;
631         int okay = 0;
632         char ext_name[128];
633         struct lws_tokens eff_buf;
634         int ext_count = 0;
635         struct libwebsocket_extension *ext;
636
637 #ifdef LWS_OPENSSL_SUPPORT
638         char ssl_err_buf[512];
639 #endif
640         /*
641          * you can call us with pollfd = NULL to just allow the once-per-second
642          * global timeout checks; if less than a second since the last check
643          * it returns immediately then.
644          */
645
646         gettimeofday(&tv, NULL);
647
648         if (context->last_timeout_check_s != tv.tv_sec) {
649                 context->last_timeout_check_s = tv.tv_sec;
650
651                 /* global timeout check once per second */
652
653                 for (n = 0; n < context->fds_count; n++) {
654                         wsi = wsi_from_fd(context, context->fds[n].fd);
655                         if (!wsi->pending_timeout)
656                                 continue;
657
658                         /*
659                          * if we went beyond the allowed time, kill the
660                          * connection
661                          */
662
663                         if (tv.tv_sec > wsi->pending_timeout_limit) {
664                                 fprintf(stderr, "TIMEDOUT WAITING\n");
665                                 libwebsocket_close_and_free_session(context,
666                                                 wsi, LWS_CLOSE_STATUS_NOSTATUS);
667                         }
668                 }
669         }
670
671         /* just here for timeout management? */
672
673         if (pollfd == NULL)
674                 return 0;
675
676         /* no, here to service a socket descriptor */
677
678         wsi = wsi_from_fd(context, pollfd->fd);
679
680         if (wsi == NULL)
681                 return 1;
682
683         switch (wsi->mode) {
684         case LWS_CONNMODE_SERVER_LISTENER:
685
686                 /* pollin means a client has connected to us then */
687
688                 if (!pollfd->revents & POLLIN)
689                         break;
690
691                 /* listen socket got an unencrypted connection... */
692
693                 clilen = sizeof(cli_addr);
694                 accept_fd  = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
695                                                                        &clilen);
696                 if (accept_fd < 0) {
697                         fprintf(stderr, "ERROR on accept");
698                         break;
699                 }
700
701                 if (context->fds_count >= MAX_CLIENTS) {
702                         fprintf(stderr, "too busy to accept new client\n");
703 #ifdef WIN32
704                         closesocket(accept_fd);
705 #else
706                         close(accept_fd);
707 #endif
708                         break;
709                 }
710
711                 /*
712                  * look at who we connected to and give user code a chance
713                  * to reject based on client IP.  There's no protocol selected
714                  * yet so we issue this to protocols[0]
715                  */
716
717                 if ((context->protocols[0].callback)(context, wsi,
718                                 LWS_CALLBACK_FILTER_NETWORK_CONNECTION,
719                                              (void*)(long)accept_fd, NULL, 0)) {
720                         fprintf(stderr, "Callback denied network connection\n");
721 #ifdef WIN32
722                         closesocket(accept_fd);
723 #else
724                         close(accept_fd);
725 #endif
726                         break;
727                 }
728
729                 /* accepting connection to main listener */
730
731                 new_wsi = malloc(sizeof(struct libwebsocket));
732                 if (new_wsi == NULL) {
733                         fprintf(stderr, "Out of memory for new connection\n");
734                         break;
735                 }
736
737                 memset(new_wsi, 0, sizeof (struct libwebsocket));
738                 new_wsi->sock = accept_fd;
739                 new_wsi->count_active_extensions = 0;
740                 new_wsi->pending_timeout = NO_PENDING_TIMEOUT;
741
742 #ifdef LWS_OPENSSL_SUPPORT
743                 new_wsi->ssl = NULL;
744
745                 if (context->use_ssl) {
746
747                         new_wsi->ssl = SSL_new(context->ssl_ctx);
748                         if (new_wsi->ssl == NULL) {
749                                 fprintf(stderr, "SSL_new failed: %s\n",
750                                     ERR_error_string(SSL_get_error(
751                                     new_wsi->ssl, 0), NULL));
752                                     libwebsockets_decode_ssl_error();
753                                 free(new_wsi);
754                                 break;
755                         }
756
757                         SSL_set_fd(new_wsi->ssl, accept_fd);
758
759                         n = SSL_accept(new_wsi->ssl);
760                         if (n != 1) {
761                                 /*
762                                  * browsers seem to probe with various
763                                  * ssl params which fail then retry
764                                  * and succeed
765                                  */
766                                 debug("SSL_accept failed skt %u: %s\n",
767                                       pollfd->fd,
768                                       ERR_error_string(SSL_get_error(
769                                       new_wsi->ssl, n), NULL));
770                                 SSL_free(
771                                        new_wsi->ssl);
772                                 free(new_wsi);
773                                 break;
774                         }
775                         
776                         debug("accepted new SSL conn  "
777                               "port %u on fd=%d SSL ver %s\n",
778                                 ntohs(cli_addr.sin_port), accept_fd,
779                                   SSL_get_version(new_wsi->ssl));
780
781                 } else
782 #endif
783                         debug("accepted new conn  port %u on fd=%d\n",
784                                           ntohs(cli_addr.sin_port), accept_fd);
785
786                 /* intialize the instance struct */
787
788                 new_wsi->state = WSI_STATE_HTTP;
789                 new_wsi->name_buffer_pos = 0;
790                 new_wsi->mode = LWS_CONNMODE_WS_SERVING;
791
792                 for (n = 0; n < WSI_TOKEN_COUNT; n++) {
793                         new_wsi->utf8_token[n].token = NULL;
794                         new_wsi->utf8_token[n].token_len = 0;
795                 }
796
797                 /*
798                  * these can only be set once the protocol is known
799                  * we set an unestablished connection's protocol pointer
800                  * to the start of the supported list, so it can look
801                  * for matching ones during the handshake
802                  */
803                 new_wsi->protocol = context->protocols;
804                 new_wsi->user_space = NULL;
805
806                 /*
807                  * Default protocol is 76 / 00
808                  * After 76, there's a header specified to inform which
809                  * draft the client wants, when that's seen we modify
810                  * the individual connection's spec revision accordingly
811                  */
812                 new_wsi->ietf_spec_revision = 0;
813
814                 insert_wsi(context, new_wsi);
815
816                 /*
817                  * make sure NO events are seen yet on this new socket
818                  * (otherwise we inherit old fds[client].revents from
819                  * previous socket there and die mysteriously! )
820                  */
821                 context->fds[context->fds_count].revents = 0;
822
823                 context->fds[context->fds_count].events = POLLIN;
824                 context->fds[context->fds_count++].fd = accept_fd;
825
826                 /* external POLL support via protocol 0 */
827                 context->protocols[0].callback(context, new_wsi,
828                         LWS_CALLBACK_ADD_POLL_FD,
829                         (void *)(long)accept_fd, NULL, POLLIN);
830
831                 break;
832
833         case LWS_CONNMODE_BROADCAST_PROXY_LISTENER:
834
835                 /* as we are listening, POLLIN means accept() is needed */
836         
837                 if (!pollfd->revents & POLLIN)
838                         break;
839
840                 /* listen socket got an unencrypted connection... */
841
842                 clilen = sizeof(cli_addr);
843                 accept_fd  = accept(pollfd->fd, (struct sockaddr *)&cli_addr,
844                                                                        &clilen);
845                 if (accept_fd < 0) {
846                         fprintf(stderr, "ERROR on accept");
847                         break;
848                 }
849
850                 if (context->fds_count >= MAX_CLIENTS) {
851                         fprintf(stderr, "too busy to accept new broadcast "
852                                                               "proxy client\n");
853 #ifdef WIN32
854                         closesocket(accept_fd);
855 #else
856                         close(accept_fd);
857 #endif
858                         break;
859                 }
860
861                 /* create a dummy wsi for the connection and add it */
862
863                 new_wsi = malloc(sizeof(struct libwebsocket));
864                 memset(new_wsi, 0, sizeof (struct libwebsocket));
865                 new_wsi->sock = accept_fd;
866                 new_wsi->mode = LWS_CONNMODE_BROADCAST_PROXY;
867                 new_wsi->state = WSI_STATE_ESTABLISHED;
868                 new_wsi->count_active_extensions = 0;
869                 /* note which protocol we are proxying */
870                 new_wsi->protocol_index_for_broadcast_proxy =
871                                         wsi->protocol_index_for_broadcast_proxy;
872                 insert_wsi(context, new_wsi);
873
874                 /* add connected socket to internal poll array */
875
876                 context->fds[context->fds_count].revents = 0;
877                 context->fds[context->fds_count].events = POLLIN;
878                 context->fds[context->fds_count++].fd = accept_fd;
879
880                 /* external POLL support via protocol 0 */
881                 context->protocols[0].callback(context, new_wsi,
882                         LWS_CALLBACK_ADD_POLL_FD,
883                         (void *)(long)accept_fd, NULL, POLLIN);
884
885                 break;
886
887         case LWS_CONNMODE_BROADCAST_PROXY:
888
889                 /* handle session socket closed */
890
891                 if (pollfd->revents & (POLLERR | POLLHUP)) {
892
893                         debug("Session Socket %p (fd=%d) dead\n",
894                                 (void *)wsi, pollfd->fd);
895
896                         libwebsocket_close_and_free_session(context, wsi,
897                                                        LWS_CLOSE_STATUS_NORMAL);
898                         return 1;
899                 }
900
901                 /*
902                  * either extension code with stuff to spill, or the user code,
903                  * requested a callback when it was OK to write
904                  */
905
906                 if (pollfd->revents & POLLOUT)
907                         if (lws_handle_POLLOUT_event(context, wsi, pollfd) < 0) {
908                                 libwebsocket_close_and_free_session(context, wsi,
909                                                        LWS_CLOSE_STATUS_NORMAL);
910                                 return 1;
911                         }
912
913                 /* any incoming data ready? */
914
915                 if (!(pollfd->revents & POLLIN))
916                         break;
917
918                 /* get the issued broadcast payload from the socket */
919
920                 len = read(pollfd->fd, buf + LWS_SEND_BUFFER_PRE_PADDING,
921                                                          MAX_BROADCAST_PAYLOAD);
922                 if (len < 0) {
923                         fprintf(stderr, "Error reading broadcast payload\n");
924                         break;
925                 }
926
927                 /* broadcast it to all guys with this protocol index */
928
929                 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
930
931                         for (m = 0; m < context->fd_hashtable[n].length; m++) {
932
933                                 new_wsi = context->fd_hashtable[n].wsi[m];
934
935                                 /* only to clients we are serving to */
936
937                                 if (new_wsi->mode != LWS_CONNMODE_WS_SERVING)
938                                         continue;
939
940                                 /*
941                                  * never broadcast to non-established
942                                  * connection
943                                  */
944
945                                 if (new_wsi->state != WSI_STATE_ESTABLISHED)
946                                         continue;
947
948                                 /*
949                                  * only broadcast to connections using
950                                  * the requested protocol
951                                  */
952
953                                 if (new_wsi->protocol->protocol_index !=
954                                         wsi->protocol_index_for_broadcast_proxy)
955                                         continue;
956
957                                 /* broadcast it to this connection */
958
959                                 new_wsi->protocol->callback(context, new_wsi,
960                                         LWS_CALLBACK_BROADCAST,
961                                         new_wsi->user_space,
962                                         buf + LWS_SEND_BUFFER_PRE_PADDING, len);
963                         }
964                 }
965                 break;
966
967         case LWS_CONNMODE_WS_CLIENT_WAITING_PROXY_REPLY:
968
969                 /* handle proxy hung up on us */
970
971                 if (pollfd->revents & (POLLERR | POLLHUP)) {
972
973                         fprintf(stderr, "Proxy connection %p (fd=%d) dead\n",
974                                 (void *)wsi, pollfd->fd);
975
976                         libwebsocket_close_and_free_session(context, wsi,
977                                                      LWS_CLOSE_STATUS_NOSTATUS);
978                         return 1;
979                 }
980
981                 n = recv(wsi->sock, pkt, sizeof pkt, 0);
982                 if (n < 0) {
983                         libwebsocket_close_and_free_session(context, wsi,
984                                                      LWS_CLOSE_STATUS_NOSTATUS);
985                         fprintf(stderr, "ERROR reading from proxy socket\n");
986                         return 1;
987                 }
988
989                 pkt[13] = '\0';
990                 if (strcmp(pkt, "HTTP/1.0 200 ") != 0) {
991                         libwebsocket_close_and_free_session(context, wsi,
992                                                      LWS_CLOSE_STATUS_NOSTATUS);
993                         fprintf(stderr, "ERROR from proxy: %s\n", pkt);
994                         return 1;
995                 }
996
997                 /* clear his proxy connection timeout */
998
999                 libwebsocket_set_timeout(wsi, NO_PENDING_TIMEOUT, 0);
1000
1001                 /* fallthru */
1002
1003         case LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE:
1004
1005         #ifdef LWS_OPENSSL_SUPPORT
1006                 if (wsi->use_ssl) {
1007
1008                         wsi->ssl = SSL_new(context->ssl_client_ctx);
1009                         wsi->client_bio = BIO_new_socket(wsi->sock,
1010                                                                    BIO_NOCLOSE);
1011                         SSL_set_bio(wsi->ssl, wsi->client_bio, wsi->client_bio);
1012
1013                         SSL_set_ex_data(wsi->ssl,
1014                                         openssl_websocket_private_data_index,
1015                                                                        context);
1016
1017                         if (SSL_connect(wsi->ssl) <= 0) {
1018                                 fprintf(stderr, "SSL connect error %s\n",
1019                                         ERR_error_string(ERR_get_error(),
1020                                                                   ssl_err_buf));
1021                                 libwebsocket_close_and_free_session(context, wsi,
1022                                                      LWS_CLOSE_STATUS_NOSTATUS);
1023                                 return 1;
1024                         }
1025
1026                         n = SSL_get_verify_result(wsi->ssl);
1027                         if ((n != X509_V_OK) && (
1028                                 n != X509_V_ERR_DEPTH_ZERO_SELF_SIGNED_CERT ||
1029                                                            wsi->use_ssl != 2)) {
1030
1031                                 fprintf(stderr, "server's cert didn't "
1032                                                            "look good %d\n", n);
1033                                 libwebsocket_close_and_free_session(context,
1034                                                 wsi, LWS_CLOSE_STATUS_NOSTATUS);
1035                                 return 1;
1036                         }
1037                 } else {
1038                         wsi->ssl = NULL;
1039         #endif
1040
1041
1042         #ifdef LWS_OPENSSL_SUPPORT
1043                 }
1044         #endif
1045
1046                 /*
1047                  * create the random key
1048                  */
1049
1050                 n = libwebsockets_get_random(context, hash, 16);
1051                 if (n != 16) {
1052                         fprintf(stderr, "Unable to read from random dev %s\n",
1053                                                         SYSTEM_RANDOM_FILEPATH);
1054                         free(wsi->c_path);
1055                         free(wsi->c_host);
1056                         if (wsi->c_origin)
1057                                 free(wsi->c_origin);
1058                         if (wsi->c_protocol)
1059                                 free(wsi->c_protocol);
1060                         libwebsocket_close_and_free_session(context, wsi,
1061                                                      LWS_CLOSE_STATUS_NOSTATUS);
1062                         return 1;
1063                 }
1064
1065                 lws_b64_encode_string(hash, 16, wsi->key_b64,
1066                                                            sizeof wsi->key_b64);
1067
1068                 /*
1069                  * 00 example client handshake
1070                  *
1071                  * GET /socket.io/websocket HTTP/1.1
1072                  * Upgrade: WebSocket
1073                  * Connection: Upgrade
1074                  * Host: 127.0.0.1:9999
1075                  * Origin: http://127.0.0.1
1076                  * Sec-WebSocket-Key1: 1 0 2#0W 9 89 7  92 ^
1077                  * Sec-WebSocket-Key2: 7 7Y 4328 B2v[8(z1
1078                  * Cookie: socketio=websocket
1079                  * 
1080                  * (Á®Ä0¶†≥
1081                  * 
1082                  * 04 example client handshake
1083                  *
1084                  * GET /chat HTTP/1.1
1085                  * Host: server.example.com
1086                  * Upgrade: websocket
1087                  * Connection: Upgrade
1088                  * Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
1089                  * Sec-WebSocket-Origin: http://example.com
1090                  * Sec-WebSocket-Protocol: chat, superchat
1091                  * Sec-WebSocket-Version: 4
1092                  */
1093
1094                 p += sprintf(p, "GET %s HTTP/1.1\x0d\x0a", wsi->c_path);
1095
1096                 if (wsi->ietf_spec_revision == 0) {
1097                         unsigned char spaces_1, spaces_2;
1098                         unsigned int max_1, max_2;
1099                         unsigned int num_1, num_2;
1100                         unsigned long product_1, product_2;
1101                         char key_1[40];
1102                         char key_2[40];
1103                         unsigned int seed;
1104                         unsigned int count;
1105                         char challenge[16];
1106
1107                         libwebsockets_get_random(context, &spaces_1,
1108                                                                   sizeof(char));
1109                         libwebsockets_get_random(context, &spaces_2,
1110                                                                   sizeof(char));
1111                         
1112                         spaces_1 = (spaces_1 % 12) + 1;
1113                         spaces_2 = (spaces_2 % 12) + 1;
1114                         
1115                         max_1 = 4294967295 / spaces_1;
1116                         max_2 = 4294967295 / spaces_2;
1117
1118                         libwebsockets_get_random(context, &num_1, sizeof(int));
1119                         libwebsockets_get_random(context, &num_2, sizeof(int));
1120                         
1121                         num_1 = (num_1 % max_1);
1122                         num_2 = (num_2 % max_2);
1123                         
1124                         challenge[0] = num_1 >> 24;
1125                         challenge[1] = num_1 >> 16;
1126                         challenge[2] = num_1 >> 8;
1127                         challenge[3] = num_1;
1128                         challenge[4] = num_2 >> 24;
1129                         challenge[5] = num_2 >> 16;
1130                         challenge[6] = num_2 >> 8;
1131                         challenge[7] = num_2;
1132                         
1133                         product_1 = num_1 * spaces_1;
1134                         product_2 = num_2 * spaces_2;
1135                         
1136                         sprintf(key_1, "%lu", product_1);
1137                         sprintf(key_2, "%lu", product_2);
1138
1139                         libwebsockets_get_random(context, &seed, sizeof(int));
1140                         libwebsockets_get_random(context, &count, sizeof(int));
1141                         
1142                         libwebsockets_00_spam(key_1, (count % 12) + 1, seed);
1143                         
1144                         libwebsockets_get_random(context, &seed, sizeof(int));
1145                         libwebsockets_get_random(context, &count, sizeof(int));
1146                         
1147                         libwebsockets_00_spam(key_2, (count % 12) + 1, seed);
1148                         
1149                         libwebsockets_get_random(context, &seed, sizeof(int));
1150                         
1151                         libwebsockets_00_spaceout(key_1, spaces_1, seed);
1152                         libwebsockets_00_spaceout(key_2, spaces_2, seed >> 16);
1153                         
1154                         p += sprintf(p, "Upgrade: websocket\x0d\x0a"
1155                                 "Connection: Upgrade\x0d\x0aHost: %s\x0d\x0a",
1156                                 wsi->c_host);
1157                         if (wsi->c_origin)
1158                                 p += sprintf(p, "Origin: %s\x0d\x0a",
1159                                 wsi->c_origin);
1160                         
1161                         if (wsi->c_protocol)
1162                                 p += sprintf(p, "Sec-WebSocket-Protocol: %s"
1163                                                  "\x0d\x0a", wsi->c_protocol);
1164                         
1165                         p += sprintf(p, "Sec-WebSocket-Key1: %s\x0d\x0a",
1166                                 key_1);
1167                         p += sprintf(p, "Sec-WebSocket-Key2: %s\x0d\x0a",
1168                                 key_2);
1169
1170                         /* give userland a chance to append, eg, cookies */
1171                         
1172                         context->protocols[0].callback(context, wsi,
1173                                 LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER,
1174                                         NULL, &p, (pkt + sizeof(pkt)) - p - 12);
1175
1176                         p += sprintf(p, "\x0d\x0a");
1177                         
1178                         read(context->fd_random, p, 8);
1179                         memcpy(&challenge[8], p, 8);
1180                         p += 8;
1181                         
1182                         /* precompute what we want to see from the server */
1183                         
1184                         MD5((unsigned char *)challenge, 16,
1185                            (unsigned char *)wsi->initial_handshake_hash_base64);
1186                         
1187                         goto issue_hdr;
1188                 }
1189
1190                 p += sprintf(p, "Host: %s\x0d\x0a", wsi->c_host);
1191                 p += sprintf(p, "Upgrade: websocket\x0d\x0a");
1192                 p += sprintf(p, "Connection: Upgrade\x0d\x0a"
1193                                         "Sec-WebSocket-Key: ");
1194                 strcpy(p, wsi->key_b64);
1195                 p += strlen(wsi->key_b64);
1196                 p += sprintf(p, "\x0d\x0a");
1197                 if (wsi->c_origin)
1198                         p += sprintf(p, "Sec-WebSocket-Origin: %s\x0d\x0a",
1199                                                                  wsi->c_origin);
1200                 if (wsi->c_protocol)
1201                         p += sprintf(p, "Sec-WebSocket-Protocol: %s\x0d\x0a",
1202                                                                wsi->c_protocol);
1203
1204                 /* tell the server what extensions we could support */
1205
1206                 p += sprintf(p, "Sec-WebSocket-Extensions: ");
1207
1208                 ext =context->extensions;
1209                 while (ext && ext->callback) {
1210
1211                         n = 0;
1212                         n = context->protocols[0].callback(context, wsi,
1213                                 LWS_CALLBACK_CLIENT_CONFIRM_EXTENSION_SUPPORTED,
1214                                         wsi->user_space, (char *)ext->name, 0);
1215
1216                         /*
1217                          * zero return from callback means
1218                          * go ahead and allow the extension,
1219                          * it's what we get if the callback is
1220                          * unhandled
1221                          */
1222
1223                         if (n) {
1224                                 ext++;
1225                                 continue;
1226                         }
1227
1228                         /* apply it */
1229                         
1230                         if (ext_count)
1231                                 *p++ = ',';
1232                         p += sprintf(p, ext->name);
1233                         ext_count++;
1234
1235                         ext++;
1236                 }
1237
1238                 p += sprintf(p, "\x0d\x0a");
1239
1240                 if (wsi->ietf_spec_revision)
1241                         p += sprintf(p, "Sec-WebSocket-Version: %d\x0d\x0a",
1242                                                        wsi->ietf_spec_revision); 
1243
1244                 /* give userland a chance to append, eg, cookies */
1245                 
1246                 context->protocols[0].callback(context, wsi,
1247                         LWS_CALLBACK_CLIENT_APPEND_HANDSHAKE_HEADER,
1248                         NULL, &p, (pkt + sizeof(pkt)) - p - 12);
1249                 
1250                 p += sprintf(p, "\x0d\x0a");
1251
1252                 /* prepare the expected server accept response */
1253
1254                 strcpy((char *)buf, wsi->key_b64);
1255                 strcpy((char *)&buf[strlen((char *)buf)], magic_websocket_guid);
1256
1257                 SHA1(buf, strlen((char *)buf), (unsigned char *)hash);
1258
1259                 lws_b64_encode_string(hash, 20,
1260                                 wsi->initial_handshake_hash_base64,
1261                                      sizeof wsi->initial_handshake_hash_base64);
1262
1263 issue_hdr:
1264                 
1265                 /* done with these now */
1266                 
1267                 free(wsi->c_path);
1268                 free(wsi->c_host);
1269                 if (wsi->c_origin)
1270                         free(wsi->c_origin);
1271
1272                 /* send our request to the server */
1273
1274         #ifdef LWS_OPENSSL_SUPPORT
1275                 if (wsi->use_ssl)
1276                         n = SSL_write(wsi->ssl, pkt, p - pkt);
1277                 else
1278         #endif
1279                         n = send(wsi->sock, pkt, p - pkt, 0);
1280
1281                 if (n < 0) {
1282                         fprintf(stderr, "ERROR writing to client socket\n");
1283                         libwebsocket_close_and_free_session(context, wsi,
1284                                                      LWS_CLOSE_STATUS_NOSTATUS);
1285                         return 1;
1286                 }
1287
1288                 wsi->parser_state = WSI_TOKEN_NAME_PART;
1289                 wsi->mode = LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY;
1290                 libwebsocket_set_timeout(wsi,
1291                                 PENDING_TIMEOUT_AWAITING_SERVER_RESPONSE, 5);
1292
1293                 break;
1294
1295         case LWS_CONNMODE_WS_CLIENT_WAITING_SERVER_REPLY:
1296
1297                 /* handle server hung up on us */
1298
1299                 if (pollfd->revents & (POLLERR | POLLHUP)) {
1300
1301                         fprintf(stderr, "Server connection %p (fd=%d) dead\n",
1302                                 (void *)wsi, pollfd->fd);
1303
1304                         goto bail3;
1305                 }
1306
1307
1308                 /* interpret the server response */
1309
1310                 /*
1311                  *  HTTP/1.1 101 Switching Protocols
1312                  *  Upgrade: websocket
1313                  *  Connection: Upgrade
1314                  *  Sec-WebSocket-Accept: me89jWimTRKTWwrS3aRrL53YZSo=
1315                  *  Sec-WebSocket-Nonce: AQIDBAUGBwgJCgsMDQ4PEC==
1316                  *  Sec-WebSocket-Protocol: chat
1317                  */
1318
1319         #ifdef LWS_OPENSSL_SUPPORT
1320                 if (wsi->use_ssl)
1321                         len = SSL_read(wsi->ssl, pkt, sizeof pkt);
1322                 else
1323         #endif
1324                         len = recv(wsi->sock, pkt, sizeof pkt, 0);
1325
1326                 if (len < 0) {
1327                         fprintf(stderr,
1328                                   "libwebsocket_client_handshake read error\n");
1329                         goto bail3;
1330                 }
1331
1332                 p = pkt;
1333                 for (n = 0; n < len; n++)
1334                         libwebsocket_parse(wsi, *p++);
1335
1336                 if (wsi->parser_state != WSI_PARSING_COMPLETE) {
1337                         fprintf(stderr, "libwebsocket_client_handshake "
1338                                         "server response failed parsing\n");
1339                         goto bail3;
1340                 }
1341
1342                 /*
1343                  * 00 / 76 -->
1344                  *
1345                  * HTTP/1.1 101 WebSocket Protocol Handshake
1346                  * Upgrade: WebSocket
1347                  * Connection: Upgrade
1348                  * Sec-WebSocket-Origin: http://127.0.0.1
1349                  * Sec-WebSocket-Location: ws://127.0.0.1:9999/socket.io/websocket
1350                  *
1351                  * xxxxxxxxxxxxxxxx
1352                  */
1353                 
1354                 if (wsi->ietf_spec_revision == 0) {
1355                         if (!wsi->utf8_token[WSI_TOKEN_HTTP].token_len ||
1356                             !wsi->utf8_token[WSI_TOKEN_UPGRADE].token_len ||
1357                             !wsi->utf8_token[WSI_TOKEN_CHALLENGE].token_len ||
1358                             !wsi->utf8_token[WSI_TOKEN_CONNECTION].token_len ||
1359                             (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len &&
1360                             wsi->c_protocol != NULL)) {
1361                                 fprintf(stderr, "libwebsocket_client_handshake "
1362                                                 "missing required header(s)\n");
1363                                 pkt[len] = '\0';
1364                                 fprintf(stderr, "%s", pkt);
1365                                 goto bail3;
1366                         }
1367                         
1368                         strtolower(wsi->utf8_token[WSI_TOKEN_HTTP].token);
1369                         if (strcmp(wsi->utf8_token[WSI_TOKEN_HTTP].token,
1370                                 "101 websocket protocol handshake")) {
1371                                 fprintf(stderr, "libwebsocket_client_handshake "
1372                                         "server sent bad HTTP response '%s'\n",
1373                                         wsi->utf8_token[WSI_TOKEN_HTTP].token);
1374                                 goto bail3;
1375                         }
1376                         
1377                         if (wsi->utf8_token[WSI_TOKEN_CHALLENGE].token_len <
1378                                                                            16) {
1379                                 fprintf(stderr, "libwebsocket_client_handshake "
1380                                         "challenge reply too short %d\n",
1381                                         wsi->utf8_token[
1382                                                 WSI_TOKEN_CHALLENGE].token_len);
1383                                 pkt[len] = '\0';
1384                                 fprintf(stderr, "%s", pkt);
1385                                 goto bail3;
1386                                 
1387                         }
1388                         
1389                         goto select_protocol;
1390                 }
1391                 
1392                 /*
1393                  * well, what the server sent looked reasonable for syntax.
1394                  * Now let's confirm it sent all the necessary headers
1395                  */
1396
1397                  if (!wsi->utf8_token[WSI_TOKEN_HTTP].token_len ||
1398                         !wsi->utf8_token[WSI_TOKEN_UPGRADE].token_len ||
1399                         !wsi->utf8_token[WSI_TOKEN_CONNECTION].token_len ||
1400                         !wsi->utf8_token[WSI_TOKEN_ACCEPT].token_len ||
1401                         (!wsi->utf8_token[WSI_TOKEN_NONCE].token_len &&
1402                                            wsi->ietf_spec_revision == 4) ||
1403                         (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len &&
1404                                                      wsi->c_protocol != NULL)) {
1405                         fprintf(stderr, "libwebsocket_client_handshake "
1406                                                 "missing required header(s)\n");
1407                         pkt[len] = '\0';
1408                         fprintf(stderr, "%s", pkt);
1409                         goto bail3;
1410                 }
1411
1412                 /*
1413                  * Everything seems to be there, now take a closer look at what
1414                  * is in each header
1415                  */
1416
1417                 strtolower(wsi->utf8_token[WSI_TOKEN_HTTP].token);
1418                 if (strcmp(wsi->utf8_token[WSI_TOKEN_HTTP].token,
1419                                                    "101 switching protocols")) {
1420                         fprintf(stderr, "libwebsocket_client_handshake "
1421                                         "server sent bad HTTP response '%s'\n",
1422                                          wsi->utf8_token[WSI_TOKEN_HTTP].token);
1423                         goto bail3;
1424                 }
1425
1426                 strtolower(wsi->utf8_token[WSI_TOKEN_UPGRADE].token);
1427                 if (strcmp(wsi->utf8_token[WSI_TOKEN_UPGRADE].token,
1428                                                                  "websocket")) {
1429                         fprintf(stderr, "libwebsocket_client_handshake server "
1430                                         "sent bad Upgrade header '%s'\n",
1431                                       wsi->utf8_token[WSI_TOKEN_UPGRADE].token);
1432                         goto bail3;
1433                 }
1434
1435                 strtolower(wsi->utf8_token[WSI_TOKEN_CONNECTION].token);
1436                 if (strcmp(wsi->utf8_token[WSI_TOKEN_CONNECTION].token,
1437                                                                    "upgrade")) {
1438                         fprintf(stderr, "libwebsocket_client_handshake server "
1439                                         "sent bad Connection hdr '%s'\n",
1440                                    wsi->utf8_token[WSI_TOKEN_CONNECTION].token);
1441                         goto bail3;
1442                 }
1443
1444 select_protocol:
1445                 pc = wsi->c_protocol;
1446
1447                 /*
1448                  * confirm the protocol the server wants to talk was in the list
1449                  * of protocols we offered
1450                  */
1451
1452                 if (!wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len) {
1453
1454                         /*
1455                          * no protocol name to work from,
1456                          * default to first protocol
1457                          */
1458                         wsi->protocol = &context->protocols[0];
1459
1460                         free(wsi->c_protocol);
1461
1462                         goto check_accept;
1463                 }
1464
1465                 while (*pc && !okay) {
1466                         if ((!strncmp(pc,
1467                                 wsi->utf8_token[WSI_TOKEN_PROTOCOL].token,
1468                            wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len)) &&
1469                  (pc[wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len] == ',' ||
1470                    pc[wsi->utf8_token[WSI_TOKEN_PROTOCOL].token_len] == '\0')) {
1471                                 okay = 1;
1472                                 continue;
1473                         }
1474                         while (*pc && *pc != ',')
1475                                 pc++;
1476                         while (*pc && *pc != ' ')
1477                                 pc++;
1478                 }
1479
1480                 /* done with him now */
1481
1482                 if (wsi->c_protocol)
1483                         free(wsi->c_protocol);
1484
1485
1486                 if (!okay) {
1487                         fprintf(stderr, "libwebsocket_client_handshake server "
1488                                                 "sent bad protocol '%s'\n",
1489                                      wsi->utf8_token[WSI_TOKEN_PROTOCOL].token);
1490                         goto bail2;
1491                 }
1492
1493                 /*
1494                  * identify the selected protocol struct and set it
1495                  */
1496                 n = 0;
1497                 wsi->protocol = NULL;
1498                 while (context->protocols[n].callback) {
1499                         if (strcmp(wsi->utf8_token[WSI_TOKEN_PROTOCOL].token,
1500                                                context->protocols[n].name) == 0)
1501                                 wsi->protocol = &context->protocols[n];
1502                         n++;
1503                 }
1504
1505                 if (wsi->protocol == NULL) {
1506                         fprintf(stderr, "libwebsocket_client_handshake server "
1507                                         "requested protocol '%s', which we "
1508                                         "said we supported but we don't!\n",
1509                                      wsi->utf8_token[WSI_TOKEN_PROTOCOL].token);
1510                         goto bail2;
1511                 }
1512
1513
1514                 /* instantiate the accepted extensions */
1515
1516                 if (!wsi->utf8_token[WSI_TOKEN_EXTENSIONS].token_len)
1517                         goto check_accept;
1518
1519                 /*
1520                  * break down the list of server accepted extensions
1521                  * and go through matching them or identifying bogons
1522                  */
1523
1524                 c = wsi->utf8_token[WSI_TOKEN_EXTENSIONS].token;
1525                 n = 0;
1526                 while (more) {
1527                         
1528                         if (*c && *c != ',') {
1529                                 ext_name[n] = *c++;
1530                                 if (n < sizeof(ext_name) - 1)
1531                                         n++;
1532                                 continue;
1533                         }
1534                         ext_name[n] = '\0';
1535                         if (!*c)
1536                                 more = 0;
1537
1538                         /* check we actually support it */
1539
1540                         n = 0;
1541                         ext = wsi->protocol->owning_server->extensions;
1542                         while (ext && ext->callback) {
1543
1544                                 if (strcmp(ext_name, ext->name)) {
1545                                         ext++;
1546                                         continue;
1547                                 }
1548
1549                                 n = 1;
1550
1551                                 /* instantiate the extension on this conn */
1552
1553                                 wsi->active_extensions_user[
1554                                         wsi->count_active_extensions] =
1555                                              malloc(ext->per_session_data_size);
1556                                 wsi->active_extensions[
1557                                           wsi->count_active_extensions] = ext;
1558
1559                                 /* allow him to construct his context */
1560
1561                                 ext->callback(wsi->protocol->owning_server,
1562                                         wsi, LWS_EXT_CALLBACK_CLIENT_CONSTRUCT,
1563                                                 wsi->active_extensions_user[
1564                                         wsi->count_active_extensions], NULL, 0);
1565
1566                                 wsi->count_active_extensions++;
1567
1568                                 ext++;
1569                         }
1570
1571                         if (n == 0) {
1572                                 fprintf(stderr, "Server said we should use"
1573                                       "an unknown extension '%s'!\n", ext_name);
1574                                 goto bail2;
1575                         }
1576
1577                         n = 0;
1578                 }
1579
1580
1581         check_accept:
1582
1583                 if (wsi->ietf_spec_revision == 0) {
1584                         
1585                         if (memcmp(wsi->initial_handshake_hash_base64,
1586                               wsi->utf8_token[WSI_TOKEN_CHALLENGE].token, 16)) {
1587                                 fprintf(stderr, "libwebsocket_client_handshake "
1588                                                "failed 00 challenge compare\n");        
1589                                         pkt[len] = '\0';
1590                                         fprintf(stderr, "%s", pkt);
1591                                         goto bail2;
1592                         }
1593                         
1594                         goto accept_ok;
1595                 }
1596
1597                 /*
1598                  * Confirm his accept token is the one we precomputed
1599                  */
1600
1601                 if (strcmp(wsi->utf8_token[WSI_TOKEN_ACCEPT].token,
1602                                           wsi->initial_handshake_hash_base64)) {
1603                         fprintf(stderr, "libwebsocket_client_handshake server "
1604                                 "sent bad ACCEPT '%s' vs computed '%s'\n",
1605                                 wsi->utf8_token[WSI_TOKEN_ACCEPT].token,
1606                                             wsi->initial_handshake_hash_base64);
1607                         goto bail2;
1608                 }
1609
1610                 if (wsi->ietf_spec_revision == 4) {
1611                         /*
1612                          * Calculate the 04 masking key to use when
1613                          * sending data to server
1614                          */
1615
1616                         strcpy((char *)buf, wsi->key_b64);
1617                         p = (char *)buf + strlen(wsi->key_b64);
1618                         strcpy(p, wsi->utf8_token[WSI_TOKEN_NONCE].token);
1619                         p += wsi->utf8_token[WSI_TOKEN_NONCE].token_len;
1620                         strcpy(p, magic_websocket_04_masking_guid);
1621                         SHA1(buf, strlen((char *)buf), wsi->masking_key_04);
1622                 }
1623 accept_ok:
1624
1625                 /* allocate the per-connection user memory (if any) */
1626
1627                 if (wsi->protocol->per_session_data_size) {
1628                         wsi->user_space = malloc(
1629                                           wsi->protocol->per_session_data_size);
1630                         if (wsi->user_space  == NULL) {
1631                                 fprintf(stderr, "Out of memory for "
1632                                                            "conn user space\n");
1633                                 goto bail2;
1634                         }
1635                 } else
1636                         wsi->user_space = NULL;
1637
1638                 /* clear his proxy connection timeout */
1639
1640                 libwebsocket_set_timeout(wsi, NO_PENDING_TIMEOUT, 0);
1641
1642                 /* mark him as being alive */
1643
1644                 wsi->state = WSI_STATE_ESTABLISHED;
1645                 wsi->mode = LWS_CONNMODE_WS_CLIENT;
1646
1647                 fprintf(stderr, "handshake OK for protocol %s\n",
1648                                                            wsi->protocol->name);
1649
1650                 /* call him back to inform him he is up */
1651
1652                 wsi->protocol->callback(context, wsi,
1653                                  LWS_CALLBACK_CLIENT_ESTABLISHED,
1654                                  wsi->user_space,
1655                                  NULL, 0);
1656
1657                 break;
1658
1659 bail3:
1660                 if (wsi->c_protocol)
1661                         free(wsi->c_protocol);
1662
1663 bail2:
1664                 libwebsocket_close_and_free_session(context, wsi,
1665                                                      LWS_CLOSE_STATUS_NOSTATUS);
1666                 return 1;
1667                 
1668
1669         case LWS_CONNMODE_WS_SERVING:
1670         case LWS_CONNMODE_WS_CLIENT:
1671
1672                 /* handle session socket closed */
1673
1674                 if (pollfd->revents & (POLLERR | POLLHUP)) {
1675
1676                         fprintf(stderr, "Session Socket %p (fd=%d) dead\n",
1677                                 (void *)wsi, pollfd->fd);
1678
1679                         libwebsocket_close_and_free_session(context, wsi,
1680                                                      LWS_CLOSE_STATUS_NOSTATUS);
1681                         return 1;
1682                 }
1683
1684                 /* the guy requested a callback when it was OK to write */
1685
1686                 if ((pollfd->revents & POLLOUT) &&
1687                                             wsi->state == WSI_STATE_ESTABLISHED)
1688                         if (lws_handle_POLLOUT_event(context, wsi,
1689                                                                   pollfd) < 0) {
1690                                 libwebsocket_close_and_free_session(
1691                                          context, wsi, LWS_CLOSE_STATUS_NORMAL);
1692                                 return 1;
1693                         }
1694
1695
1696                 /* any incoming data ready? */
1697
1698                 if (!(pollfd->revents & POLLIN))
1699                         break;
1700
1701 #ifdef LWS_OPENSSL_SUPPORT
1702                 if (wsi->ssl)
1703                         eff_buf.token_len = SSL_read(wsi->ssl, buf, sizeof buf);
1704                 else
1705 #endif
1706                         eff_buf.token_len =
1707                                            recv(pollfd->fd, buf, sizeof buf, 0);
1708
1709                 if (eff_buf.token_len < 0) {
1710                         fprintf(stderr, "Socket read returned %d\n",
1711                                                             eff_buf.token_len);
1712                         break;
1713                 }
1714                 if (!eff_buf.token_len) {
1715                         libwebsocket_close_and_free_session(context, wsi,
1716                                                      LWS_CLOSE_STATUS_NOSTATUS);
1717                         return 1;
1718                 }
1719
1720                 /*
1721                  * give any active extensions a chance to munge the buffer
1722                  * before parse.  We pass in a pointer to an lws_tokens struct
1723                  * prepared with the default buffer and content length that's in
1724                  * there.  Rather than rewrite the default buffer, extensions
1725                  * that expect to grow the buffer can adapt .token to
1726                  * point to their own per-connection buffer in the extension
1727                  * user allocation.  By default with no extensions or no
1728                  * extension callback handling, just the normal input buffer is
1729                  * used then so it is efficient.
1730                  */
1731
1732                 eff_buf.token = (char *)buf;
1733
1734                 more = 1;
1735                 while (more) {
1736
1737                         more = 0;
1738
1739                         for (n = 0; n < wsi->count_active_extensions; n++) {
1740                                 m = wsi->active_extensions[n]->callback(context, wsi,
1741                                         LWS_EXT_CALLBACK_PACKET_RX_PREPARSE,
1742                                      wsi->active_extensions_user[n], &eff_buf, 0);
1743                                 if (m < 0) {
1744                                         fprintf(stderr, "Extension reports fatal error\n");
1745                                         libwebsocket_close_and_free_session(context, wsi,
1746                                                              LWS_CLOSE_STATUS_NOSTATUS);
1747                                         return 1;
1748                                 }
1749                                 if (m)
1750                                         more = 1;
1751                         }
1752
1753                         /* service incoming data */
1754
1755                         if (eff_buf.token_len) {
1756                                 n = libwebsocket_read(context, wsi,
1757                                      (unsigned char *)eff_buf.token, eff_buf.token_len);
1758                                 if (n < 0)
1759                                         /* we closed wsi */
1760                                         return 1;
1761                         }
1762
1763                         eff_buf.token = NULL;
1764                         eff_buf.token_len = 0;
1765                 }
1766                 break;
1767         }
1768
1769         return 0;
1770 }
1771
1772
1773 /**
1774  * libwebsocket_context_destroy() - Destroy the websocket context
1775  * @context:    Websocket context
1776  *
1777  *      This function closes any active connections and then frees the
1778  *      context.  After calling this, any further use of the context is
1779  *      undefined.
1780  */
1781 void
1782 libwebsocket_context_destroy(struct libwebsocket_context *context)
1783 {
1784         int n;
1785         int m;
1786         struct libwebsocket *wsi;
1787
1788         for (n = 0; n < FD_HASHTABLE_MODULUS; n++)
1789                 for (m = 0; m < context->fd_hashtable[n].length; m++) {
1790                         wsi = context->fd_hashtable[n].wsi[m];
1791                         libwebsocket_close_and_free_session(context, wsi,
1792                                                     LWS_CLOSE_STATUS_GOINGAWAY);
1793                 }
1794
1795 #ifdef WIN32
1796 #else
1797         close(context->fd_random);
1798 #endif
1799
1800 #ifdef LWS_OPENSSL_SUPPORT
1801         if (context->ssl_ctx)
1802                 SSL_CTX_free(context->ssl_ctx);
1803         if (context->ssl_client_ctx)
1804                 SSL_CTX_free(context->ssl_client_ctx);
1805 #endif
1806
1807         free(context);
1808
1809 #ifdef WIN32
1810         WSACleanup();
1811 #endif
1812 }
1813
1814 /**
1815  * libwebsocket_service() - Service any pending websocket activity
1816  * @context:    Websocket context
1817  * @timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
1818  *              service otherwise block and service immediately, returning
1819  *              after the timeout if nothing needed service.
1820  *
1821  *      This function deals with any pending websocket traffic, for three
1822  *      kinds of event.  It handles these events on both server and client
1823  *      types of connection the same.
1824  *
1825  *      1) Accept new connections to our context's server
1826  *
1827  *      2) Perform pending broadcast writes initiated from other forked
1828  *         processes (effectively serializing asynchronous broadcasts)
1829  *
1830  *      3) Call the receive callback for incoming frame data received by
1831  *          server or client connections.
1832  *
1833  *      You need to call this service function periodically to all the above
1834  *      functions to happen; if your application is single-threaded you can
1835  *      just call it in your main event loop.
1836  *
1837  *      Alternatively you can fork a new process that asynchronously handles
1838  *      calling this service in a loop.  In that case you are happy if this
1839  *      call blocks your thread until it needs to take care of something and
1840  *      would call it with a large nonzero timeout.  Your loop then takes no
1841  *      CPU while there is nothing happening.
1842  *
1843  *      If you are calling it in a single-threaded app, you don't want it to
1844  *      wait around blocking other things in your loop from happening, so you
1845  *      would call it with a timeout_ms of 0, so it returns immediately if
1846  *      nothing is pending, or as soon as it services whatever was pending.
1847  */
1848
1849
1850 int
1851 libwebsocket_service(struct libwebsocket_context *context, int timeout_ms)
1852 {
1853         int n;
1854
1855         /* stay dead once we are dead */
1856
1857         if (context == NULL)
1858                 return 1;
1859
1860         /* wait for something to need service */
1861
1862         n = poll(context->fds, context->fds_count, timeout_ms);
1863         if (n == 0) /* poll timeout */
1864                 return 0;
1865
1866         if (n < 0) {
1867                 /*
1868                 fprintf(stderr, "Listen Socket dead\n");
1869                 */
1870                 return 1;
1871         }
1872
1873         /* handle accept on listening socket? */
1874
1875         for (n = 0; n < context->fds_count; n++)
1876                 if (context->fds[n].revents)
1877                         libwebsocket_service_fd(context, &context->fds[n]);
1878
1879         return 0;
1880 }
1881
1882 /**
1883  * libwebsocket_callback_on_writable() - Request a callback when this socket
1884  *                                       becomes able to be written to without
1885  *                                       blocking
1886  *
1887  * @context:    libwebsockets context
1888  * @wsi:        Websocket connection instance to get callback for
1889  */
1890
1891 int
1892 libwebsocket_callback_on_writable(struct libwebsocket_context *context,
1893                                                        struct libwebsocket *wsi)
1894 {
1895         int n;
1896
1897         for (n = 0; n < context->fds_count; n++)
1898                 if (context->fds[n].fd == wsi->sock) {
1899                         context->fds[n].events |= POLLOUT;
1900                         n = context->fds_count;
1901                 }
1902
1903         /* external POLL support via protocol 0 */
1904         context->protocols[0].callback(context, wsi,
1905                 LWS_CALLBACK_SET_MODE_POLL_FD,
1906                 (void *)(long)wsi->sock, NULL, POLLOUT);
1907
1908         return 1;
1909 }
1910
1911 /**
1912  * libwebsocket_callback_on_writable_all_protocol() - Request a callback for
1913  *                      all connections using the given protocol when it
1914  *                      becomes possible to write to each socket without
1915  *                      blocking in turn.
1916  *
1917  * @protocol:   Protocol whose connections will get callbacks
1918  */
1919
1920 int
1921 libwebsocket_callback_on_writable_all_protocol(
1922                                   const struct libwebsocket_protocols *protocol)
1923 {
1924         struct libwebsocket_context *context = protocol->owning_server;
1925         int n;
1926         int m;
1927         struct libwebsocket *wsi;
1928
1929         for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
1930
1931                 for (m = 0; m < context->fd_hashtable[n].length; m++) {
1932
1933                         wsi = context->fd_hashtable[n].wsi[m];
1934
1935                         if (wsi->protocol == protocol)
1936                                 libwebsocket_callback_on_writable(context, wsi);
1937                 }
1938         }
1939
1940         return 0;
1941 }
1942
1943 /**
1944  * libwebsocket_set_timeout() - marks the wsi as subject to a timeout
1945  *
1946  * You will not need this unless you are doing something special
1947  *
1948  * @wsi:        Websocket connection instance
1949  * @reason:     timeout reason
1950  * @secs:       how many seconds
1951  */
1952
1953 void
1954 libwebsocket_set_timeout(struct libwebsocket *wsi,
1955                                           enum pending_timeout reason, int secs)
1956 {
1957         struct timeval tv;
1958
1959         gettimeofday(&tv, NULL);
1960
1961         wsi->pending_timeout_limit = tv.tv_sec + secs;
1962         wsi->pending_timeout = reason;
1963 }
1964
1965
1966 /**
1967  * libwebsocket_get_socket_fd() - returns the socket file descriptor
1968  *
1969  * You will not need this unless you are doing something special
1970  *
1971  * @wsi:        Websocket connection instance
1972  */
1973
1974 int
1975 libwebsocket_get_socket_fd(struct libwebsocket *wsi)
1976 {
1977         return wsi->sock;
1978 }
1979
1980 /**
1981  * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
1982  *                              receieved packets.
1983  *
1984  * If the output side of a server process becomes choked, this allows flow
1985  * control for the input side.
1986  *
1987  * @wsi:        Websocket connection instance to get callback for
1988  * @enable:     0 = disable read servicing for this connection, 1 = enable
1989  */
1990
1991 int
1992 libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
1993 {
1994         struct libwebsocket_context *context = wsi->protocol->owning_server;
1995         int n;
1996
1997         for (n = 0; n < context->fds_count; n++)
1998                 if (context->fds[n].fd == wsi->sock) {
1999                         if (enable)
2000                                 context->fds[n].events |= POLLIN;
2001                         else
2002                                 context->fds[n].events &= ~POLLIN;
2003
2004                         return 0;
2005                 }
2006
2007         if (enable)
2008                 /* external POLL support via protocol 0 */
2009                 context->protocols[0].callback(context, wsi,
2010                         LWS_CALLBACK_SET_MODE_POLL_FD,
2011                         (void *)(long)wsi->sock, NULL, POLLIN);
2012         else
2013                 /* external POLL support via protocol 0 */
2014                 context->protocols[0].callback(context, wsi,
2015                         LWS_CALLBACK_CLEAR_MODE_POLL_FD,
2016                         (void *)(long)wsi->sock, NULL, POLLIN);
2017
2018
2019         fprintf(stderr, "libwebsocket_callback_on_writable "
2020                                                      "unable to find socket\n");
2021         return 1;
2022 }
2023
2024 /**
2025  * libwebsocket_canonical_hostname() - returns this host's hostname
2026  *
2027  * This is typically used by client code to fill in the host parameter
2028  * when making a client connection.  You can only call it after the context
2029  * has been created.
2030  *
2031  * @context:    Websocket context
2032  */
2033
2034
2035 extern const char *
2036 libwebsocket_canonical_hostname(struct libwebsocket_context *context)
2037 {
2038         return (const char *)context->canonical_hostname;
2039 }
2040
2041
2042 static void sigpipe_handler(int x)
2043 {
2044 }
2045
2046 #ifdef LWS_OPENSSL_SUPPORT
2047 static int
2048 OpenSSL_verify_callback(int preverify_ok, X509_STORE_CTX *x509_ctx)
2049 {
2050
2051         SSL *ssl;
2052         int n;
2053         struct libwebsocket_context *context;
2054
2055         ssl = X509_STORE_CTX_get_ex_data(x509_ctx,
2056                 SSL_get_ex_data_X509_STORE_CTX_idx());
2057
2058         /*
2059          * !!! nasty openssl requires the index to come as a library-scope
2060          * static
2061          */
2062         context = SSL_get_ex_data(ssl, openssl_websocket_private_data_index);
2063         
2064         n = context->protocols[0].callback(NULL, NULL,
2065                 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION,
2066                                                    x509_ctx, ssl, preverify_ok);
2067
2068         /* convert return code from 0 = OK to 1 = OK */
2069
2070         if (!n)
2071                 n = 1;
2072         else
2073                 n = 0;
2074
2075         return n;
2076 }
2077 #endif
2078
2079
2080 /**
2081  * libwebsocket_create_context() - Create the websocket handler
2082  * @port:       Port to listen on... you can use 0 to suppress listening on
2083  *              any port, that's what you want if you are not running a
2084  *              websocket server at all but just using it as a client
2085  * @interf:  NULL to bind the listen socket to all interfaces, or the
2086  *              interface name, eg, "eth2"
2087  * @protocols:  Array of structures listing supported protocols and a protocol-
2088  *              specific callback for each one.  The list is ended with an
2089  *              entry that has a NULL callback pointer.
2090  *              It's not const because we write the owning_server member
2091  * @extensions: NULL or array of libwebsocket_extension structs listing the
2092  *              extensions this context supports
2093  * @ssl_cert_filepath:  If libwebsockets was compiled to use ssl, and you want
2094  *                      to listen using SSL, set to the filepath to fetch the
2095  *                      server cert from, otherwise NULL for unencrypted
2096  * @ssl_private_key_filepath: filepath to private key if wanting SSL mode,
2097  *                      else ignored
2098  * @gid:        group id to change to after setting listen socket, or -1.
2099  * @uid:        user id to change to after setting listen socket, or -1.
2100  * @options:    0, or LWS_SERVER_OPTION_DEFEAT_CLIENT_MASK
2101  *
2102  *      This function creates the listening socket and takes care
2103  *      of all initialization in one step.
2104  *
2105  *      After initialization, it returns a struct libwebsocket_context * that
2106  *      represents this server.  After calling, user code needs to take care
2107  *      of calling libwebsocket_service() with the context pointer to get the
2108  *      server's sockets serviced.  This can be done in the same process context
2109  *      or a forked process, or another thread,
2110  *
2111  *      The protocol callback functions are called for a handful of events
2112  *      including http requests coming in, websocket connections becoming
2113  *      established, and data arriving; it's also called periodically to allow
2114  *      async transmission.
2115  *
2116  *      HTTP requests are sent always to the FIRST protocol in @protocol, since
2117  *      at that time websocket protocol has not been negotiated.  Other
2118  *      protocols after the first one never see any HTTP callack activity.
2119  *
2120  *      The server created is a simple http server by default; part of the
2121  *      websocket standard is upgrading this http connection to a websocket one.
2122  *
2123  *      This allows the same server to provide files like scripts and favicon /
2124  *      images or whatever over http and dynamic data over websockets all in
2125  *      one place; they're all handled in the user callback.
2126  */
2127
2128 struct libwebsocket_context *
2129 libwebsocket_create_context(int port, const char *interf,
2130                                struct libwebsocket_protocols *protocols,
2131                                struct libwebsocket_extension *extensions,
2132                                const char *ssl_cert_filepath,
2133                                const char *ssl_private_key_filepath,
2134                                int gid, int uid, unsigned int options)
2135 {
2136         int n;
2137         int sockfd = 0;
2138         int fd;
2139         struct sockaddr_in serv_addr, cli_addr;
2140         int opt = 1;
2141         struct libwebsocket_context *context = NULL;
2142         unsigned int slen;
2143         char *p;
2144         char hostname[1024];
2145         struct hostent *he;
2146         struct libwebsocket *wsi;
2147
2148 #ifdef LWS_OPENSSL_SUPPORT
2149         SSL_METHOD *method;
2150         char ssl_err_buf[512];
2151 #endif
2152
2153 #ifdef _WIN32
2154         {
2155                 WORD wVersionRequested;
2156                 WSADATA wsaData;
2157                 int err;
2158
2159                 /* Use the MAKEWORD(lowbyte, highbyte) macro from Windef.h */
2160                 wVersionRequested = MAKEWORD(2, 2);
2161
2162                 err = WSAStartup(wVersionRequested, &wsaData);
2163                 if (err != 0) {
2164                         /* Tell the user that we could not find a usable */
2165                         /* Winsock DLL.                                  */
2166                         fprintf(stderr, "WSAStartup failed with error: %d\n",
2167                                                                            err);
2168                         return NULL;
2169                 }
2170         }
2171 #endif
2172
2173
2174         context = malloc(sizeof(struct libwebsocket_context));
2175         if (!context) {
2176                 fprintf(stderr, "No memory for websocket context\n");
2177                 return NULL;
2178         }
2179         context->protocols = protocols;
2180         context->listen_port = port;
2181         context->http_proxy_port = 0;
2182         context->http_proxy_address[0] = '\0';
2183         context->options = options;
2184         context->fds_count = 0;
2185         context->extensions = extensions;
2186
2187 #ifdef WIN32
2188         context->fd_random = 0;
2189 #else
2190         context->fd_random = open(SYSTEM_RANDOM_FILEPATH, O_RDONLY);
2191         if (context->fd_random < 0) {
2192                 fprintf(stderr, "Unable to open random device %s %d\n",
2193                                     SYSTEM_RANDOM_FILEPATH, context->fd_random);
2194                 return NULL;
2195         }
2196 #endif
2197
2198 #ifdef LWS_OPENSSL_SUPPORT
2199         context->use_ssl = 0;
2200         context->ssl_ctx = NULL;
2201         context->ssl_client_ctx = NULL;
2202         openssl_websocket_private_data_index = 0;
2203 #endif
2204         /* find canonical hostname */
2205
2206         hostname[(sizeof hostname) - 1] = '\0';
2207         gethostname(hostname, (sizeof hostname) - 1);
2208         he = gethostbyname(hostname);
2209         if (he) {
2210                 strncpy(context->canonical_hostname, he->h_name,
2211                                         sizeof context->canonical_hostname - 1);
2212                 context->canonical_hostname[
2213                                 sizeof context->canonical_hostname - 1] = '\0';
2214         } else
2215                 strncpy(context->canonical_hostname, hostname,
2216                                         sizeof context->canonical_hostname - 1);
2217
2218         /* split the proxy ads:port if given */
2219
2220         p = getenv("http_proxy");
2221         if (p) {
2222                 strncpy(context->http_proxy_address, p,
2223                                         sizeof context->http_proxy_address - 1);
2224                 context->http_proxy_address[
2225                                  sizeof context->http_proxy_address - 1] = '\0';
2226
2227                 p = strchr(context->http_proxy_address, ':');
2228                 if (p == NULL) {
2229                         fprintf(stderr, "http_proxy needs to be ads:port\n");
2230                         return NULL;
2231                 }
2232                 *p = '\0';
2233                 context->http_proxy_port = atoi(p + 1);
2234
2235                 fprintf(stderr, "Using proxy %s:%u\n",
2236                                 context->http_proxy_address,
2237                                                       context->http_proxy_port);
2238         }
2239
2240         if (port) {
2241
2242 #ifdef LWS_OPENSSL_SUPPORT
2243                 context->use_ssl = ssl_cert_filepath != NULL &&
2244                                                ssl_private_key_filepath != NULL;
2245                 if (context->use_ssl)
2246                         fprintf(stderr, " Compiled with SSL support, "
2247                                                                   "using it\n");
2248                 else
2249                         fprintf(stderr, " Compiled with SSL support, "
2250                                                               "not using it\n");
2251
2252 #else
2253                 if (ssl_cert_filepath != NULL &&
2254                                              ssl_private_key_filepath != NULL) {
2255                         fprintf(stderr, " Not compiled for OpenSSl support!\n");
2256                         return NULL;
2257                 }
2258                 fprintf(stderr, " Compiled without SSL support, "
2259                                                        "serving unencrypted\n");
2260 #endif
2261         }
2262
2263         /* ignore SIGPIPE */
2264 #ifdef WIN32
2265 #else
2266         signal(SIGPIPE, sigpipe_handler);
2267 #endif
2268
2269
2270 #ifdef LWS_OPENSSL_SUPPORT
2271
2272         /* basic openssl init */
2273
2274         SSL_library_init();
2275
2276         OpenSSL_add_all_algorithms();
2277         SSL_load_error_strings();
2278
2279         openssl_websocket_private_data_index =
2280                 SSL_get_ex_new_index(0, "libwebsockets", NULL, NULL, NULL);
2281
2282         /*
2283          * Firefox insists on SSLv23 not SSLv3
2284          * Konq disables SSLv2 by default now, SSLv23 works
2285          */
2286
2287         method = (SSL_METHOD *)SSLv23_server_method();
2288         if (!method) {
2289                 fprintf(stderr, "problem creating ssl method: %s\n",
2290                         ERR_error_string(ERR_get_error(), ssl_err_buf));
2291                 return NULL;
2292         }
2293         context->ssl_ctx = SSL_CTX_new(method); /* create context */
2294         if (!context->ssl_ctx) {
2295                 fprintf(stderr, "problem creating ssl context: %s\n",
2296                         ERR_error_string(ERR_get_error(), ssl_err_buf));
2297                 return NULL;
2298         }
2299
2300         /* client context */
2301         if (port == CONTEXT_PORT_NO_LISTEN)
2302         {
2303                 method = (SSL_METHOD *)SSLv23_client_method();
2304                 if (!method) {
2305                         fprintf(stderr, "problem creating ssl method: %s\n",
2306                                 ERR_error_string(ERR_get_error(), ssl_err_buf));
2307                         return NULL;
2308                 }
2309                 /* create context */
2310                 context->ssl_client_ctx = SSL_CTX_new(method);
2311                 if (!context->ssl_client_ctx) {
2312                         fprintf(stderr, "problem creating ssl context: %s\n",
2313                                 ERR_error_string(ERR_get_error(), ssl_err_buf));
2314                         return NULL;
2315                 }
2316
2317                 /* openssl init for cert verification (for client sockets) */
2318
2319                 if (!SSL_CTX_load_verify_locations(
2320                                         context->ssl_client_ctx, NULL,
2321                                                       LWS_OPENSSL_CLIENT_CERTS))
2322                         fprintf(stderr,
2323                             "Unable to load SSL Client certs from %s "
2324                             "(set by --with-client-cert-dir= in configure) -- "
2325                                 " client ssl isn't going to work",
2326                                                       LWS_OPENSSL_CLIENT_CERTS);
2327
2328                 /*
2329                  * callback allowing user code to load extra verification certs
2330                  * helping the client to verify server identity
2331                  */
2332
2333                 context->protocols[0].callback(context, NULL,
2334                         LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS,
2335                         context->ssl_client_ctx, NULL, 0);
2336         }
2337         /* as a server, are we requiring clients to identify themselves? */
2338
2339         if (options & LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT) {
2340
2341                 /* absolutely require the client cert */
2342                 
2343                 SSL_CTX_set_verify(context->ssl_ctx,
2344                        SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
2345                                                        OpenSSL_verify_callback);
2346
2347                 /*
2348                  * give user code a chance to load certs into the server
2349                  * allowing it to verify incoming client certs
2350                  */
2351
2352                 context->protocols[0].callback(context, NULL,
2353                         LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS,
2354                                                      context->ssl_ctx, NULL, 0);
2355         }
2356
2357         if (context->use_ssl) {
2358
2359                 /* openssl init for server sockets */
2360
2361                 /* set the local certificate from CertFile */
2362                 n = SSL_CTX_use_certificate_file(context->ssl_ctx,
2363                                         ssl_cert_filepath, SSL_FILETYPE_PEM);
2364                 if (n != 1) {
2365                         fprintf(stderr, "problem getting cert '%s': %s\n",
2366                                 ssl_cert_filepath,
2367                                 ERR_error_string(ERR_get_error(), ssl_err_buf));
2368                         return NULL;
2369                 }
2370                 /* set the private key from KeyFile */
2371                 if (SSL_CTX_use_PrivateKey_file(context->ssl_ctx,
2372                              ssl_private_key_filepath, SSL_FILETYPE_PEM) != 1) {
2373                         fprintf(stderr, "ssl problem getting key '%s': %s\n",
2374                                                 ssl_private_key_filepath,
2375                                 ERR_error_string(ERR_get_error(), ssl_err_buf));
2376                         return NULL;
2377                 }
2378                 /* verify private key */
2379                 if (!SSL_CTX_check_private_key(context->ssl_ctx)) {
2380                         fprintf(stderr, "Private SSL key doesn't match cert\n");
2381                         return NULL;
2382                 }
2383
2384                 /* SSL is happy and has a cert it's content with */
2385         }
2386 #endif
2387
2388         /* selftest */
2389
2390         if (lws_b64_selftest())
2391                 return NULL;
2392
2393         /* fd hashtable init */
2394
2395         for (n = 0; n < FD_HASHTABLE_MODULUS; n++)
2396                 context->fd_hashtable[n].length = 0;
2397
2398         /* set up our external listening socket we serve on */
2399
2400         if (port) {
2401
2402                 sockfd = socket(AF_INET, SOCK_STREAM, 0);
2403                 if (sockfd < 0) {
2404                         fprintf(stderr, "ERROR opening socket");
2405                         return NULL;
2406                 }
2407
2408                 /* allow us to restart even if old sockets in TIME_WAIT */
2409                 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
2410
2411                 bzero((char *) &serv_addr, sizeof(serv_addr));
2412                 serv_addr.sin_family = AF_INET;
2413                 if (interf == NULL)
2414                         serv_addr.sin_addr.s_addr = INADDR_ANY;
2415                 else
2416                         interface_to_sa(interf, &serv_addr,
2417                                                 sizeof(serv_addr));
2418                 serv_addr.sin_port = htons(port);
2419
2420                 n = bind(sockfd, (struct sockaddr *) &serv_addr,
2421                                                              sizeof(serv_addr));
2422                 if (n < 0) {
2423                         fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
2424                                                                 port, n, errno);
2425                         return NULL;
2426                 }
2427
2428                 wsi = malloc(sizeof(struct libwebsocket));
2429                 memset(wsi, 0, sizeof (struct libwebsocket));
2430                 wsi->sock = sockfd;
2431                 wsi->count_active_extensions = 0;
2432                 wsi->mode = LWS_CONNMODE_SERVER_LISTENER;
2433                 insert_wsi(context, wsi);
2434
2435                 listen(sockfd, 5);
2436                 fprintf(stderr, " Listening on port %d\n", port);
2437
2438                 /* list in the internal poll array */
2439                 
2440                 context->fds[context->fds_count].fd = sockfd;
2441                 context->fds[context->fds_count++].events = POLLIN;
2442
2443                 /* external POLL support via protocol 0 */
2444                 context->protocols[0].callback(context, wsi,
2445                         LWS_CALLBACK_ADD_POLL_FD,
2446                         (void *)(long)sockfd, NULL, POLLIN);
2447
2448         }
2449
2450         /* drop any root privs for this process */
2451 #ifdef WIN32
2452 #else
2453         if (gid != -1)
2454                 if (setgid(gid))
2455                         fprintf(stderr, "setgid: %s\n", strerror(errno));
2456         if (uid != -1)
2457                 if (setuid(uid))
2458                         fprintf(stderr, "setuid: %s\n", strerror(errno));
2459 #endif
2460
2461         /* set up our internal broadcast trigger sockets per-protocol */
2462
2463         for (context->count_protocols = 0;
2464                         protocols[context->count_protocols].callback;
2465                                                    context->count_protocols++) {
2466                 protocols[context->count_protocols].owning_server = context;
2467                 protocols[context->count_protocols].protocol_index =
2468                                                        context->count_protocols;
2469
2470                 fd = socket(AF_INET, SOCK_STREAM, 0);
2471                 if (fd < 0) {
2472                         fprintf(stderr, "ERROR opening socket");
2473                         return NULL;
2474                 }
2475
2476                 /* allow us to restart even if old sockets in TIME_WAIT */
2477                 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
2478
2479                 bzero((char *) &serv_addr, sizeof(serv_addr));
2480                 serv_addr.sin_family = AF_INET;
2481                 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
2482                 serv_addr.sin_port = 0; /* pick the port for us */
2483
2484                 n = bind(fd, (struct sockaddr *) &serv_addr, sizeof(serv_addr));
2485                 if (n < 0) {
2486                         fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
2487                                                                 port, n, errno);
2488                         return NULL;
2489                 }
2490
2491                 slen = sizeof cli_addr;
2492                 n = getsockname(fd, (struct sockaddr *)&cli_addr, &slen);
2493                 if (n < 0) {
2494                         fprintf(stderr, "getsockname failed\n");
2495                         return NULL;
2496                 }
2497                 protocols[context->count_protocols].broadcast_socket_port =
2498                                                        ntohs(cli_addr.sin_port);
2499                 listen(fd, 5);
2500
2501                 debug("  Protocol %s broadcast socket %d\n",
2502                                 protocols[context->count_protocols].name,
2503                                                       ntohs(cli_addr.sin_port));
2504
2505                 /* dummy wsi per broadcast proxy socket */
2506
2507                 wsi = malloc(sizeof(struct libwebsocket));
2508                 memset(wsi, 0, sizeof (struct libwebsocket));
2509                 wsi->sock = fd;
2510                 wsi->mode = LWS_CONNMODE_BROADCAST_PROXY_LISTENER;
2511                 wsi->count_active_extensions = 0;
2512                 /* note which protocol we are proxying */
2513                 wsi->protocol_index_for_broadcast_proxy =
2514                                                        context->count_protocols;
2515                 insert_wsi(context, wsi);
2516
2517                 /* list in internal poll array */
2518
2519                 context->fds[context->fds_count].fd = fd;
2520                 context->fds[context->fds_count].events = POLLIN;
2521                 context->fds[context->fds_count].revents = 0;
2522                 context->fds_count++;
2523
2524                 /* external POLL support via protocol 0 */
2525                 context->protocols[0].callback(context, wsi,
2526                         LWS_CALLBACK_ADD_POLL_FD,
2527                         (void *)(long)fd, NULL, POLLIN);
2528         }
2529
2530         return context;
2531 }
2532
2533
2534 #ifndef LWS_NO_FORK
2535
2536 /**
2537  * libwebsockets_fork_service_loop() - Optional helper function forks off
2538  *                                a process for the websocket server loop.
2539  *                              You don't have to use this but if not, you
2540  *                              have to make sure you are calling
2541  *                              libwebsocket_service periodically to service
2542  *                              the websocket traffic
2543  * @context:    server context returned by creation function
2544  */
2545
2546 int
2547 libwebsockets_fork_service_loop(struct libwebsocket_context *context)
2548 {
2549         int fd;
2550         struct sockaddr_in cli_addr;
2551         int n;
2552         int p;
2553
2554         n = fork();
2555         if (n < 0)
2556                 return n;
2557
2558         if (!n) {
2559
2560                 /* main process context */
2561
2562                 /*
2563                  * set up the proxy sockets to allow broadcast from
2564                  * service process context
2565                  */
2566
2567                 for (p = 0; p < context->count_protocols; p++) {
2568                         fd = socket(AF_INET, SOCK_STREAM, 0);
2569                         if (fd < 0) {
2570                                 fprintf(stderr, "Unable to create socket\n");
2571                                 return -1;
2572                         }
2573                         cli_addr.sin_family = AF_INET;
2574                         cli_addr.sin_port = htons(
2575                              context->protocols[p].broadcast_socket_port);
2576                         cli_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
2577                         n = connect(fd, (struct sockaddr *)&cli_addr,
2578                                                                sizeof cli_addr);
2579                         if (n < 0) {
2580                                 fprintf(stderr, "Unable to connect to "
2581                                                 "broadcast socket %d, %s\n",
2582                                                 n, strerror(errno));
2583                                 return -1;
2584                         }
2585
2586                         context->protocols[p].broadcast_socket_user_fd = fd;
2587                 }
2588
2589                 return 0;
2590         }
2591
2592         /* we want a SIGHUP when our parent goes down */
2593         prctl(PR_SET_PDEATHSIG, SIGHUP);
2594
2595         /* in this forked process, sit and service websocket connections */
2596
2597         while (1)
2598                 if (libwebsocket_service(context, 1000))
2599                         return -1;
2600
2601         return 0;
2602 }
2603
2604 #endif
2605
2606 /**
2607  * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
2608  *                                connection.
2609  * @wsi:        pointer to struct websocket you want to know the protocol of
2610  *
2611  *
2612  *      This is useful to get the protocol to broadcast back to from inside
2613  * the callback.
2614  */
2615
2616 const struct libwebsocket_protocols *
2617 libwebsockets_get_protocol(struct libwebsocket *wsi)
2618 {
2619         return wsi->protocol;
2620 }
2621
2622 /**
2623  * libwebsockets_broadcast() - Sends a buffer to the callback for all active
2624  *                                connections of the given protocol.
2625  * @protocol:   pointer to the protocol you will broadcast to all members of
2626  * @buf:  buffer containing the data to be broadcase.  NOTE: this has to be
2627  *              allocated with LWS_SEND_BUFFER_PRE_PADDING valid bytes before
2628  *              the pointer and LWS_SEND_BUFFER_POST_PADDING afterwards in the
2629  *              case you are calling this function from callback context.
2630  * @len:        length of payload data in buf, starting from buf.
2631  *
2632  *      This function allows bulk sending of a packet to every connection using
2633  * the given protocol.  It does not send the data directly; instead it calls
2634  * the callback with a reason type of LWS_CALLBACK_BROADCAST.  If the callback
2635  * wants to actually send the data for that connection, the callback itself
2636  * should call libwebsocket_write().
2637  *
2638  * libwebsockets_broadcast() can be called from another fork context without
2639  * having to take any care about data visibility between the processes, it'll
2640  * "just work".
2641  */
2642
2643
2644 int
2645 libwebsockets_broadcast(const struct libwebsocket_protocols *protocol,
2646                                                  unsigned char *buf, size_t len)
2647 {
2648         struct libwebsocket_context *context = protocol->owning_server;
2649         int n;
2650         int m;
2651         struct libwebsocket * wsi;
2652
2653         if (!protocol->broadcast_socket_user_fd) {
2654                 /*
2655                  * We are either running unforked / flat, or we are being
2656                  * called from poll thread context
2657                  * eg, from a callback.  In that case don't use sockets for
2658                  * broadcast IPC (since we can't open a socket connection to
2659                  * a socket listening on our own thread) but directly do the
2660                  * send action.
2661                  *
2662                  * Locking is not needed because we are by definition being
2663                  * called in the poll thread context and are serialized.
2664                  */
2665
2666                 for (n = 0; n < FD_HASHTABLE_MODULUS; n++) {
2667
2668                         for (m = 0; m < context->fd_hashtable[n].length; m++) {
2669
2670                                 wsi = context->fd_hashtable[n].wsi[m];
2671
2672                                 if (wsi->mode != LWS_CONNMODE_WS_SERVING)
2673                                         continue;
2674
2675                                 /*
2676                                  * never broadcast to
2677                                  * non-established connections
2678                                  */
2679                                 if (wsi->state != WSI_STATE_ESTABLISHED)
2680                                         continue;
2681
2682                                 /* only broadcast to guys using
2683                                  * requested protocol
2684                                  */
2685                                 if (wsi->protocol != protocol)
2686                                         continue;
2687
2688                                 wsi->protocol->callback(context, wsi,
2689                                          LWS_CALLBACK_BROADCAST,
2690                                          wsi->user_space,
2691                                          buf, len);
2692                         }
2693                 }
2694
2695                 return 0;
2696         }
2697
2698         /*
2699          * We're being called from a different process context than the server
2700          * loop.  Instead of broadcasting directly, we send our
2701          * payload on a socket to do the IPC; the server process will serialize
2702          * the broadcast action in its main poll() loop.
2703          *
2704          * There's one broadcast socket listening for each protocol supported
2705          * set up when the websocket server initializes
2706          */
2707
2708         n = send(protocol->broadcast_socket_user_fd, buf, len, MSG_NOSIGNAL);
2709
2710         return n;
2711 }