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