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