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