blob: e6db157164e9564f3b80d0e453751380d00d66ad [file] [log] [blame]
Andy Green05a0a7b2010-10-31 17:51:39 +00001/*
Andy Greena0da8a82010-11-08 17:12:19 +00002 * libwebsockets - small server side websockets and web server implementation
Andy Green8f037e42010-12-19 22:13:26 +00003 *
Andy Greena0da8a82010-11-08 17:12:19 +00004 * 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
Andy Green05a0a7b2010-10-31 17:51:39 +000020 */
21
Andy Green7c212cc2010-11-08 20:20:42 +000022#include "private-libwebsockets.h"
Andy Greenff95d7a2010-10-28 22:36:01 +010023
Andy Green8f037e42010-12-19 22:13:26 +000024void
Andy Green251f6fa2010-11-03 11:13:06 +000025libwebsocket_close_and_free_session(struct libwebsocket *wsi)
26{
Andy Greenb45993c2010-12-18 15:13:50 +000027 int n;
28
29 if ((unsigned long)wsi < LWS_MAX_PROTOCOLS)
30 return;
31
32 n = wsi->state;
Andy Green251f6fa2010-11-03 11:13:06 +000033
34 wsi->state = WSI_STATE_DEAD_SOCKET;
35
Andy Green4f3943a2010-11-12 10:44:16 +000036 if (wsi->protocol->callback && n == WSI_STATE_ESTABLISHED)
Andy Greene77ddd82010-11-13 10:03:47 +000037 wsi->protocol->callback(wsi, LWS_CALLBACK_CLOSED,
38 wsi->user_space, NULL, 0);
Andy Green251f6fa2010-11-03 11:13:06 +000039
40 for (n = 0; n < WSI_TOKEN_COUNT; n++)
41 if (wsi->utf8_token[n].token)
42 free(wsi->utf8_token[n].token);
43
Andy Green0ca6a172010-12-19 20:50:01 +000044/* fprintf(stderr, "closing fd=%d\n", wsi->sock); */
Andy Green251f6fa2010-11-03 11:13:06 +000045
Andy Green3faa9c72010-11-08 17:03:03 +000046#ifdef LWS_OPENSSL_SUPPORT
Andy Green90c7cbc2011-01-27 06:26:52 +000047 if (wsi->ssl) {
Andy Green3faa9c72010-11-08 17:03:03 +000048 n = SSL_get_fd(wsi->ssl);
49 SSL_shutdown(wsi->ssl);
50 close(n);
51 SSL_free(wsi->ssl);
52 } else {
53#endif
54 shutdown(wsi->sock, SHUT_RDWR);
55 close(wsi->sock);
56#ifdef LWS_OPENSSL_SUPPORT
57 }
58#endif
Andy Green4f3943a2010-11-12 10:44:16 +000059 if (wsi->user_space)
60 free(wsi->user_space);
61
Andy Green251f6fa2010-11-03 11:13:06 +000062 free(wsi);
63}
64
Andy Greenb45993c2010-12-18 15:13:50 +000065static int
66libwebsocket_poll_connections(struct libwebsocket_context *this)
67{
68 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + MAX_BROADCAST_PAYLOAD +
69 LWS_SEND_BUFFER_POST_PADDING];
Andy Green8f037e42010-12-19 22:13:26 +000070 int client = this->count_protocols + 1;
71 struct libwebsocket *wsi;
Andy Greenb45993c2010-12-18 15:13:50 +000072 int n;
73 size_t len;
74
75 /* check for activity on client sockets */
Andy Green8f037e42010-12-19 22:13:26 +000076
77 for (; client < this->fds_count; client++) {
78
Andy Greenb45993c2010-12-18 15:13:50 +000079 /* handle session socket closed */
Andy Green8f037e42010-12-19 22:13:26 +000080
Andy Greenb45993c2010-12-18 15:13:50 +000081 if (this->fds[client].revents & (POLLERR | POLLHUP)) {
Andy Green8f037e42010-12-19 22:13:26 +000082
Andy Greenb45993c2010-12-18 15:13:50 +000083 debug("Session Socket %d %p (fd=%d) dead\n",
Andy Green6964bb52011-01-23 16:50:33 +000084 client, (void *)this->wsi[client],
85 this->fds[client].fd);
Andy Greenb45993c2010-12-18 15:13:50 +000086
87 libwebsocket_close_and_free_session(this->wsi[client]);
88 goto nuke_this;
89 }
Andy Green8f037e42010-12-19 22:13:26 +000090
Andy Green90c7cbc2011-01-27 06:26:52 +000091 /* the guy requested a callback when it was OK to write */
92
93 if ((unsigned long)this->wsi[client] > LWS_MAX_PROTOCOLS &&
94 this->fds[client].revents & POLLOUT) {
95
96 this->fds[client].events &= ~POLLOUT;
97
98 this->wsi[client]->protocol->callback(this->wsi[client],
99 LWS_CALLBACK_CLIENT_WRITEABLE,
100 this->wsi[client]->user_space,
101 NULL, 0);
102 }
103
Andy Greenb45993c2010-12-18 15:13:50 +0000104 /* any incoming data ready? */
105
106 if (!(this->fds[client].revents & POLLIN))
107 continue;
108
109 /* broadcast? */
110
111 if ((unsigned long)this->wsi[client] < LWS_MAX_PROTOCOLS) {
112
Andy Green8f037e42010-12-19 22:13:26 +0000113 /* get the issued broadcast payload from the socket */
114
Andy Greenb45993c2010-12-18 15:13:50 +0000115 len = read(this->fds[client].fd,
116 buf + LWS_SEND_BUFFER_PRE_PADDING,
117 MAX_BROADCAST_PAYLOAD);
Andy Green8f037e42010-12-19 22:13:26 +0000118
Andy Greenb45993c2010-12-18 15:13:50 +0000119 if (len < 0) {
Andy Green8f037e42010-12-19 22:13:26 +0000120 fprintf(stderr,
121 "Error reading broadcast payload\n");
Andy Greenb45993c2010-12-18 15:13:50 +0000122 continue;
123 }
124
125 /* broadcast it to all guys with this protocol index */
126
127 for (n = this->count_protocols + 1;
128 n < this->fds_count; n++) {
129
Andy Green8f037e42010-12-19 22:13:26 +0000130 wsi = this->wsi[n];
131
132 if ((unsigned long)wsi < LWS_MAX_PROTOCOLS)
Andy Greenb45993c2010-12-18 15:13:50 +0000133 continue;
134
135 /*
136 * never broadcast to non-established
137 * connection
138 */
139
Andy Green8f037e42010-12-19 22:13:26 +0000140 if (wsi->state != WSI_STATE_ESTABLISHED)
Andy Greenb45993c2010-12-18 15:13:50 +0000141 continue;
142
Andy Green4739e5c2011-01-22 12:51:57 +0000143 /* only to clients connected to us */
Andy Green6964bb52011-01-23 16:50:33 +0000144
Andy Green4739e5c2011-01-22 12:51:57 +0000145 if (wsi->client_mode)
146 continue;
147
Andy Greenb45993c2010-12-18 15:13:50 +0000148 /*
149 * only broadcast to connections using
150 * the requested protocol
151 */
152
Andy Green8f037e42010-12-19 22:13:26 +0000153 if (wsi->protocol->protocol_index !=
154 (int)(unsigned long)this->wsi[client])
Andy Greenb45993c2010-12-18 15:13:50 +0000155 continue;
156
Andy Green8f037e42010-12-19 22:13:26 +0000157 /* broadcast it to this connection */
158
159 wsi->protocol->callback(wsi,
160 LWS_CALLBACK_BROADCAST,
161 wsi->user_space,
Andy Green0ca6a172010-12-19 20:50:01 +0000162 buf + LWS_SEND_BUFFER_PRE_PADDING, len);
Andy Greenb45993c2010-12-18 15:13:50 +0000163 }
164
165 continue;
166 }
167
168#ifdef LWS_OPENSSL_SUPPORT
Andy Green90c7cbc2011-01-27 06:26:52 +0000169 if (this->wsi[client]->ssl)
Andy Greenb45993c2010-12-18 15:13:50 +0000170 n = SSL_read(this->wsi[client]->ssl, buf, sizeof buf);
171 else
172#endif
173 n = recv(this->fds[client].fd, buf, sizeof buf, 0);
174
175 if (n < 0) {
176 fprintf(stderr, "Socket read returned %d\n", n);
177 continue;
178 }
179 if (!n) {
Andy Green8f037e42010-12-19 22:13:26 +0000180 libwebsocket_close_and_free_session(this->wsi[client]);
Andy Greenb45993c2010-12-18 15:13:50 +0000181 goto nuke_this;
182 }
183
Andy Greenb45993c2010-12-18 15:13:50 +0000184 /* service incoming data */
185
Andy Green6964bb52011-01-23 16:50:33 +0000186 n = libwebsocket_read(this->wsi[client], buf, n);
187 if (n >= 0)
Andy Greenb45993c2010-12-18 15:13:50 +0000188 continue;
Andy Greenb45993c2010-12-18 15:13:50 +0000189 /*
190 * it closed and nuked wsi[client], so remove the
191 * socket handle and wsi from our service list
192 */
193nuke_this:
194
195 debug("nuking wsi %p, fsd_count = %d\n",
Andy Green6964bb52011-01-23 16:50:33 +0000196 (void *)this->wsi[client], this->fds_count - 1);
Andy Greenb45993c2010-12-18 15:13:50 +0000197
198 this->fds_count--;
199 for (n = client; n < this->fds_count; n++) {
200 this->fds[n] = this->fds[n + 1];
201 this->wsi[n] = this->wsi[n + 1];
202 }
Andy Green6964bb52011-01-23 16:50:33 +0000203
204 return 0;
205
Andy Greenb45993c2010-12-18 15:13:50 +0000206 }
207
208 return 0;
209}
210
Andy Green6964bb52011-01-23 16:50:33 +0000211/**
212 * libwebsocket_context_destroy() - Destroy the websocket context
213 * @this: Websocket context
214 *
215 * This function closes any active connections and then frees the
216 * context. After calling this, any further use of the context is
217 * undefined.
218 */
219void
220libwebsocket_context_destroy(struct libwebsocket_context *this)
221{
222 int client;
223
224 /* close listening skt and per-protocol broadcast sockets */
225 for (client = 0; client < this->fds_count; client++)
226 libwebsocket_close_and_free_session(this->wsi[client]);
227
228#ifdef LWS_OPENSSL_SUPPORT
Andy Green90c7cbc2011-01-27 06:26:52 +0000229 if (this->ssl_ctx)
230 SSL_CTX_free(this->ssl_ctx);
Andy Green6964bb52011-01-23 16:50:33 +0000231#endif
232
233 if (this)
234 free(this);
235}
236
237/**
238 * libwebsocket_service() - Service any pending websocket activity
239 * @this: Websocket context
240 * @timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
241 * service otherwise block and service immediately, returning
242 * after the timeout if nothing needed service.
243 *
244 * This function deals with any pending websocket traffic, for three
245 * kinds of event. It handles these events on both server and client
246 * types of connection the same.
247 *
248 * 1) Accept new connections to our context's server
249 *
250 * 2) Perform pending broadcast writes initiated from other forked
251 * processes (effectively serializing asynchronous broadcasts)
252 *
253 * 3) Call the receive callback for incoming frame data received by
254 * server or client connections.
255 *
256 * You need to call this service function periodically to all the above
257 * functions to happen; if your application is single-threaded you can
258 * just call it in your main event loop.
259 *
260 * Alternatively you can fork a new process that asynchronously handles
261 * calling this service in a loop. In that case you are happy if this
262 * call blocks your thread until it needs to take care of something and
263 * would call it with a large nonzero timeout. Your loop then takes no
264 * CPU while there is nothing happening.
265 *
266 * If you are calling it in a single-threaded app, you don't want it to
267 * wait around blocking other things in your loop from happening, so you
268 * would call it with a timeout_ms of 0, so it returns immediately if
269 * nothing is pending, or as soon as it services whatever was pending.
270 */
271
Andy Greenb45993c2010-12-18 15:13:50 +0000272
Andy Greene92cd172011-01-19 13:11:55 +0000273int
274libwebsocket_service(struct libwebsocket_context *this, int timeout_ms)
275{
276 int n;
277 int client;
278 unsigned int clilen;
279 struct sockaddr_in cli_addr;
280 int fd;
281
282 /* stay dead once we are dead */
283
284 if (this == NULL)
285 return 1;
286
Andy Green4739e5c2011-01-22 12:51:57 +0000287 /* don't check listen socket if we are not listening */
288
289 if (this->listen_port)
290 n = poll(this->fds, this->fds_count, timeout_ms);
291 else
292 n = poll(&this->fds[1], this->fds_count - 1, timeout_ms);
Andy Green6964bb52011-01-23 16:50:33 +0000293
Andy Greene92cd172011-01-19 13:11:55 +0000294
295 if (n < 0 || this->fds[0].revents & (POLLERR | POLLHUP)) {
296 fprintf(stderr, "Listen Socket dead\n");
297 goto fatal;
298 }
299 if (n == 0) /* poll timeout */
300 return 0;
301
302 /* handle accept on listening socket? */
303
304 for (client = 0; client < this->count_protocols + 1; client++) {
305
306 if (!this->fds[client].revents & POLLIN)
307 continue;
308
309 /* listen socket got an unencrypted connection... */
310
311 clilen = sizeof(cli_addr);
312 fd = accept(this->fds[client].fd,
313 (struct sockaddr *)&cli_addr, &clilen);
314 if (fd < 0) {
315 fprintf(stderr, "ERROR on accept");
316 continue;
317 }
318
319 if (this->fds_count >= MAX_CLIENTS) {
320 fprintf(stderr, "too busy");
321 close(fd);
322 continue;
323 }
324
325 if (client) {
326 /*
327 * accepting a connection to broadcast socket
328 * set wsi to be protocol index not pointer
329 */
330
331 this->wsi[this->fds_count] =
332 (struct libwebsocket *)(long)(client - 1);
333
334 goto fill_in_fds;
335 }
336
337 /* accepting connection to main listener */
338
339 this->wsi[this->fds_count] =
340 malloc(sizeof(struct libwebsocket));
341 if (!this->wsi[this->fds_count]) {
342 fprintf(stderr, "Out of memory for new connection\n");
343 continue;
344 }
345
346#ifdef LWS_OPENSSL_SUPPORT
Andy Green90c7cbc2011-01-27 06:26:52 +0000347 this->wsi[this->fds_count]->ssl = NULL;
348
Andy Greene92cd172011-01-19 13:11:55 +0000349 if (this->use_ssl) {
350
Andy Green90c7cbc2011-01-27 06:26:52 +0000351 this->wsi[this->fds_count]->ssl =
352 SSL_new(this->ssl_ctx);
Andy Greene92cd172011-01-19 13:11:55 +0000353 if (this->wsi[this->fds_count]->ssl == NULL) {
354 fprintf(stderr, "SSL_new failed: %s\n",
355 ERR_error_string(SSL_get_error(
356 this->wsi[this->fds_count]->ssl, 0),
357 NULL));
358 free(this->wsi[this->fds_count]);
359 continue;
360 }
361
362 SSL_set_fd(this->wsi[this->fds_count]->ssl, fd);
363
364 n = SSL_accept(this->wsi[this->fds_count]->ssl);
365 if (n != 1) {
366 /*
367 * browsers seem to probe with various
368 * ssl params which fail then retry
369 * and succeed
370 */
371 debug("SSL_accept failed skt %u: %s\n",
372 fd,
373 ERR_error_string(SSL_get_error(
374 this->wsi[this->fds_count]->ssl,
375 n), NULL));
376 SSL_free(
377 this->wsi[this->fds_count]->ssl);
378 free(this->wsi[this->fds_count]);
379 continue;
380 }
381 debug("accepted new SSL conn "
382 "port %u on fd=%d SSL ver %s\n",
383 ntohs(cli_addr.sin_port), fd,
384 SSL_get_version(this->wsi[
385 this->fds_count]->ssl));
386
387 } else
388#endif
389 debug("accepted new conn port %u on fd=%d\n",
390 ntohs(cli_addr.sin_port), fd);
391
392 /* intialize the instance struct */
393
394 this->wsi[this->fds_count]->sock = fd;
395 this->wsi[this->fds_count]->state = WSI_STATE_HTTP;
396 this->wsi[this->fds_count]->name_buffer_pos = 0;
Andy Green4739e5c2011-01-22 12:51:57 +0000397 this->wsi[this->fds_count]->client_mode = 0;
Andy Greene92cd172011-01-19 13:11:55 +0000398
399 for (n = 0; n < WSI_TOKEN_COUNT; n++) {
400 this->wsi[this->fds_count]->
401 utf8_token[n].token = NULL;
402 this->wsi[this->fds_count]->
403 utf8_token[n].token_len = 0;
404 }
405
406 /*
407 * these can only be set once the protocol is known
408 * we set an unestablished connection's protocol pointer
409 * to the start of the supported list, so it can look
410 * for matching ones during the handshake
411 */
412 this->wsi[this->fds_count]->protocol = this->protocols;
413 this->wsi[this->fds_count]->user_space = NULL;
414
415 /*
416 * Default protocol is 76 / 00
417 * After 76, there's a header specified to inform which
418 * draft the client wants, when that's seen we modify
419 * the individual connection's spec revision accordingly
420 */
421 this->wsi[this->fds_count]->ietf_spec_revision = 0;
422
423fill_in_fds:
424
425 /*
426 * make sure NO events are seen yet on this new socket
427 * (otherwise we inherit old fds[client].revents from
428 * previous socket there and die mysteriously! )
429 */
430 this->fds[this->fds_count].revents = 0;
431
432 this->fds[this->fds_count].events = POLLIN;
433 this->fds[this->fds_count++].fd = fd;
434
435 }
436
437 /* service anything incoming on websocket connection */
438
439 libwebsocket_poll_connections(this);
440
441 /* this round is done */
442
443 return 0;
444
445fatal:
446
Andy Green6964bb52011-01-23 16:50:33 +0000447 fprintf(stderr, "service hits fatal\n");
448
Andy Greene92cd172011-01-19 13:11:55 +0000449 /* close listening skt and per-protocol broadcast sockets */
450 for (client = 0; client < this->fds_count; client++)
451 close(this->fds[0].fd);
452
453#ifdef LWS_OPENSSL_SUPPORT
Andy Green90c7cbc2011-01-27 06:26:52 +0000454 if (this->ssl_ctx)
455 SSL_CTX_free(this->ssl_ctx);
Andy Greene92cd172011-01-19 13:11:55 +0000456#endif
Andy Greene92cd172011-01-19 13:11:55 +0000457
458 if (this)
459 free(this);
460
461 this = NULL;
462
463 /* inform caller we are dead */
464
465 return 1;
466}
467
Andy Green90c7cbc2011-01-27 06:26:52 +0000468/**
469 * libwebsocket_callback_on_writable() - Request a callback when this socket
470 * becomes able to be written to without
471 * blocking
472 *
473 * @wsi: Websocket connection instance to get callback for
474 */
475
476int
477libwebsocket_callback_on_writable(struct libwebsocket *wsi)
478{
479 struct libwebsocket_context *this = wsi->protocol->owning_server;
480 int n;
481
482 for (n = this->count_protocols + 1; n < this->fds_count; n++)
483 if (this->wsi[n] == wsi) {
484 this->fds[n].events |= POLLOUT;
485 return 0;
486 }
487
488 fprintf(stderr, "libwebsocket_callback_on_writable "
489 "didn't find socket\n");
490 return 1;
491}
492
493/**
494 * libwebsocket_callback_on_writable_all_protocol() - Request a callback for
495 * all connections using the given protocol when it
496 * becomes possible to write to each socket without
497 * blocking in turn.
498 *
499 * @protocol: Protocol whose connections will get callbacks
500 */
501
502int
503libwebsocket_callback_on_writable_all_protocol(
504 const struct libwebsocket_protocols *protocol)
505{
506 struct libwebsocket_context *this = protocol->owning_server;
507 int n;
508
509 for (n = this->count_protocols + 1; n < this->fds_count; n++)
510 if ((unsigned long)this->wsi[n] > LWS_MAX_PROTOCOLS)
511 if (this->wsi[n]->protocol == protocol)
512 this->fds[n].events |= POLLOUT;
513
514 return 0;
515}
516
Andy Greena6cbece2011-01-27 20:06:03 +0000517
518/**
519 * libwebsocket_get_socket_fd() - returns the socket file descriptor
520 *
521 * You will not need this unless you are doing something special
522 *
523 * @wsi: Websocket connection instance
524 */
525
526int
527libwebsocket_get_socket_fd(struct libwebsocket *wsi)
528{
529 return wsi->sock;
530}
531
Andy Green90c7cbc2011-01-27 06:26:52 +0000532/**
533 * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
534 * receieved packets.
535 *
536 * If the output side of a server process becomes choked, this allows flow
537 * control for the input side.
538 *
539 * @wsi: Websocket connection instance to get callback for
540 * @enable: 0 = disable read servicing for this connection, 1 = enable
541 */
542
543int
544libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
545{
546 struct libwebsocket_context *this = wsi->protocol->owning_server;
547 int n;
548
549 for (n = this->count_protocols + 1; n < this->fds_count; n++)
550 if (this->wsi[n] == wsi) {
551 if (enable)
552 this->fds[n].events |= POLLIN;
553 else
554 this->fds[n].events &= ~POLLIN;
555
556 return 0;
557 }
558
559 fprintf(stderr, "libwebsocket_callback_on_writable "
560 "unable to find socket\n");
561 return 1;
562}
563
564static void sigpipe_handler(int x)
565{
566}
567
Andy Greenb45993c2010-12-18 15:13:50 +0000568
Andy Greenab990e42010-10-31 12:42:52 +0000569/**
Andy Green4739e5c2011-01-22 12:51:57 +0000570 * libwebsocket_create_context() - Create the websocket handler
571 * @port: Port to listen on... you can use 0 to suppress listening on
Andy Green6964bb52011-01-23 16:50:33 +0000572 * any port, that's what you want if you are not running a
573 * websocket server at all but just using it as a client
Andy Green4f3943a2010-11-12 10:44:16 +0000574 * @protocols: Array of structures listing supported protocols and a protocol-
Andy Green8f037e42010-12-19 22:13:26 +0000575 * specific callback for each one. The list is ended with an
576 * entry that has a NULL callback pointer.
Andy Green6964bb52011-01-23 16:50:33 +0000577 * It's not const because we write the owning_server member
Andy Green3faa9c72010-11-08 17:03:03 +0000578 * @ssl_cert_filepath: If libwebsockets was compiled to use ssl, and you want
Andy Green8f037e42010-12-19 22:13:26 +0000579 * to listen using SSL, set to the filepath to fetch the
580 * server cert from, otherwise NULL for unencrypted
Andy Green3faa9c72010-11-08 17:03:03 +0000581 * @ssl_private_key_filepath: filepath to private key if wanting SSL mode,
Andy Green8f037e42010-12-19 22:13:26 +0000582 * else ignored
Andy Green3faa9c72010-11-08 17:03:03 +0000583 * @gid: group id to change to after setting listen socket, or -1.
584 * @uid: user id to change to after setting listen socket, or -1.
Andy Green05464c62010-11-12 10:44:18 +0000585 *
Andy Green8f037e42010-12-19 22:13:26 +0000586 * This function creates the listening socket and takes care
587 * of all initialization in one step.
588 *
Andy Greene92cd172011-01-19 13:11:55 +0000589 * After initialization, it returns a struct libwebsocket_context * that
590 * represents this server. After calling, user code needs to take care
591 * of calling libwebsocket_service() with the context pointer to get the
592 * server's sockets serviced. This can be done in the same process context
593 * or a forked process, or another thread,
Andy Green05464c62010-11-12 10:44:18 +0000594 *
Andy Green8f037e42010-12-19 22:13:26 +0000595 * The protocol callback functions are called for a handful of events
596 * including http requests coming in, websocket connections becoming
597 * established, and data arriving; it's also called periodically to allow
598 * async transmission.
599 *
600 * HTTP requests are sent always to the FIRST protocol in @protocol, since
601 * at that time websocket protocol has not been negotiated. Other
602 * protocols after the first one never see any HTTP callack activity.
603 *
604 * The server created is a simple http server by default; part of the
605 * websocket standard is upgrading this http connection to a websocket one.
606 *
607 * This allows the same server to provide files like scripts and favicon /
608 * images or whatever over http and dynamic data over websockets all in
609 * one place; they're all handled in the user callback.
Andy Greenab990e42010-10-31 12:42:52 +0000610 */
Andy Green4ea60062010-10-30 12:15:07 +0100611
Andy Greene92cd172011-01-19 13:11:55 +0000612struct libwebsocket_context *
Andy Green4739e5c2011-01-22 12:51:57 +0000613libwebsocket_create_context(int port,
Andy Greenb45993c2010-12-18 15:13:50 +0000614 struct libwebsocket_protocols *protocols,
Andy Green8f037e42010-12-19 22:13:26 +0000615 const char *ssl_cert_filepath,
616 const char *ssl_private_key_filepath,
Andy Greence510c62010-11-11 12:48:13 +0000617 int gid, int uid)
Andy Greenff95d7a2010-10-28 22:36:01 +0100618{
619 int n;
Andy Green4739e5c2011-01-22 12:51:57 +0000620 int sockfd = 0;
Andy Green251f6fa2010-11-03 11:13:06 +0000621 int fd;
Andy Greenff95d7a2010-10-28 22:36:01 +0100622 struct sockaddr_in serv_addr, cli_addr;
Andy Green251f6fa2010-11-03 11:13:06 +0000623 int opt = 1;
Andy Green8f037e42010-12-19 22:13:26 +0000624 struct libwebsocket_context *this = NULL;
Andy Greenb45993c2010-12-18 15:13:50 +0000625 unsigned int slen;
Andy Greenff95d7a2010-10-28 22:36:01 +0100626
Andy Green3faa9c72010-11-08 17:03:03 +0000627#ifdef LWS_OPENSSL_SUPPORT
Andy Greenf2f54d52010-11-15 22:08:00 +0000628 SSL_METHOD *method;
Andy Green3faa9c72010-11-08 17:03:03 +0000629 char ssl_err_buf[512];
Andy Green3faa9c72010-11-08 17:03:03 +0000630#endif
631
Andy Green90c7cbc2011-01-27 06:26:52 +0000632 this = malloc(sizeof(struct libwebsocket_context));
633 if (!this) {
634 fprintf(stderr, "No memory for websocket context\n");
635 return NULL;
636 }
637 this->protocols = protocols;
638 this->listen_port = port;
639
640 if (port) {
641
Andy Green3faa9c72010-11-08 17:03:03 +0000642#ifdef LWS_OPENSSL_SUPPORT
Andy Green90c7cbc2011-01-27 06:26:52 +0000643 this->use_ssl = ssl_cert_filepath != NULL &&
644 ssl_private_key_filepath != NULL;
645 if (this->use_ssl)
646 fprintf(stderr, " Compiled with SSL support, "
647 "using it\n");
648 else
649 fprintf(stderr, " Compiled with SSL support, "
650 "not using it\n");
Andy Green3faa9c72010-11-08 17:03:03 +0000651
Andy Green90c7cbc2011-01-27 06:26:52 +0000652#else
653 if (ssl_cert_filepath != NULL &&
654 ssl_private_key_filepath != NULL) {
655 fprintf(stderr, " Not compiled for OpenSSl support!\n");
Andy Greene92cd172011-01-19 13:11:55 +0000656 return NULL;
Andy Green3faa9c72010-11-08 17:03:03 +0000657 }
Andy Green90c7cbc2011-01-27 06:26:52 +0000658 fprintf(stderr, " Compiled without SSL support, "
659 "serving unencrypted\n");
660#endif
661 }
662
663 /* ignore SIGPIPE */
664
665 signal(SIGPIPE, sigpipe_handler);
666
667
668#ifdef LWS_OPENSSL_SUPPORT
669
670 /* basic openssl init */
671
672 SSL_library_init();
673
674 OpenSSL_add_all_algorithms();
675 SSL_load_error_strings();
676
677 /*
678 * Firefox insists on SSLv23 not SSLv3
679 * Konq disables SSLv2 by default now, SSLv23 works
680 */
681
682 method = (SSL_METHOD *)SSLv23_server_method();
683 if (!method) {
684 fprintf(stderr, "problem creating ssl method: %s\n",
685 ERR_error_string(ERR_get_error(), ssl_err_buf));
686 return NULL;
687 }
688 this->ssl_ctx = SSL_CTX_new(method); /* create context */
689 if (!this->ssl_ctx) {
690 fprintf(stderr, "problem creating ssl context: %s\n",
691 ERR_error_string(ERR_get_error(), ssl_err_buf));
692 return NULL;
693 }
694
695 /* client context */
696
697 method = (SSL_METHOD *)SSLv23_client_method();
698 if (!method) {
699 fprintf(stderr, "problem creating ssl method: %s\n",
700 ERR_error_string(ERR_get_error(), ssl_err_buf));
701 return NULL;
702 }
703 this->ssl_client_ctx = SSL_CTX_new(method); /* create context */
704 if (!this->ssl_client_ctx) {
705 fprintf(stderr, "problem creating ssl context: %s\n",
706 ERR_error_string(ERR_get_error(), ssl_err_buf));
707 return NULL;
708 }
709
710
711 /* openssl init for cert verification (used with client sockets) */
712
713 if (!SSL_CTX_load_verify_locations(this->ssl_client_ctx, NULL,
714 LWS_OPENSSL_CLIENT_CERTS)) {
715 fprintf(stderr, "Unable to load SSL Client certs from %s "
716 "(set by --with-client-cert-dir= in configure) -- "
717 " client ssl isn't going to work",
718 LWS_OPENSSL_CLIENT_CERTS);
719 }
720
721 if (this->use_ssl) {
722
723 /* openssl init for server sockets */
724
Andy Green3faa9c72010-11-08 17:03:03 +0000725 /* set the local certificate from CertFile */
Andy Green90c7cbc2011-01-27 06:26:52 +0000726 n = SSL_CTX_use_certificate_file(this->ssl_ctx,
Andy Green3faa9c72010-11-08 17:03:03 +0000727 ssl_cert_filepath, SSL_FILETYPE_PEM);
728 if (n != 1) {
729 fprintf(stderr, "problem getting cert '%s': %s\n",
730 ssl_cert_filepath,
731 ERR_error_string(ERR_get_error(), ssl_err_buf));
Andy Greene92cd172011-01-19 13:11:55 +0000732 return NULL;
Andy Green3faa9c72010-11-08 17:03:03 +0000733 }
734 /* set the private key from KeyFile */
Andy Green90c7cbc2011-01-27 06:26:52 +0000735 if (SSL_CTX_use_PrivateKey_file(this->ssl_ctx,
Andy Green018d8eb2010-11-08 21:04:23 +0000736 ssl_private_key_filepath,
Andy Green4739e5c2011-01-22 12:51:57 +0000737 SSL_FILETYPE_PEM) != 1) {
Andy Green018d8eb2010-11-08 21:04:23 +0000738 fprintf(stderr, "ssl problem getting key '%s': %s\n",
739 ssl_private_key_filepath,
740 ERR_error_string(ERR_get_error(), ssl_err_buf));
Andy Greene92cd172011-01-19 13:11:55 +0000741 return NULL;
Andy Green3faa9c72010-11-08 17:03:03 +0000742 }
743 /* verify private key */
Andy Green90c7cbc2011-01-27 06:26:52 +0000744 if (!SSL_CTX_check_private_key(this->ssl_ctx)) {
Andy Green018d8eb2010-11-08 21:04:23 +0000745 fprintf(stderr, "Private SSL key doesn't match cert\n");
Andy Greene92cd172011-01-19 13:11:55 +0000746 return NULL;
Andy Green3faa9c72010-11-08 17:03:03 +0000747 }
748
749 /* SSL is happy and has a cert it's content with */
750 }
751#endif
Andy Greenb45993c2010-12-18 15:13:50 +0000752
Andy Greendf736162011-01-18 15:39:02 +0000753 /* selftest */
754
755 if (lws_b64_selftest())
Andy Greene92cd172011-01-19 13:11:55 +0000756 return NULL;
Andy Greendf736162011-01-18 15:39:02 +0000757
Andy Greenb45993c2010-12-18 15:13:50 +0000758 /* set up our external listening socket we serve on */
Andy Green8f037e42010-12-19 22:13:26 +0000759
Andy Green4739e5c2011-01-22 12:51:57 +0000760 if (port) {
Andy Green8f037e42010-12-19 22:13:26 +0000761
Andy Green4739e5c2011-01-22 12:51:57 +0000762 sockfd = socket(AF_INET, SOCK_STREAM, 0);
763 if (sockfd < 0) {
764 fprintf(stderr, "ERROR opening socket");
765 return NULL;
766 }
Andy Green775c0dd2010-10-29 14:15:22 +0100767
Andy Green4739e5c2011-01-22 12:51:57 +0000768 /* allow us to restart even if old sockets in TIME_WAIT */
769 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
Andy Greene77ddd82010-11-13 10:03:47 +0000770
Andy Green4739e5c2011-01-22 12:51:57 +0000771 bzero((char *) &serv_addr, sizeof(serv_addr));
772 serv_addr.sin_family = AF_INET;
773 serv_addr.sin_addr.s_addr = INADDR_ANY;
774 serv_addr.sin_port = htons(port);
775
776 n = bind(sockfd, (struct sockaddr *) &serv_addr,
777 sizeof(serv_addr));
778 if (n < 0) {
779 fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
Andy Green8f037e42010-12-19 22:13:26 +0000780 port, n, errno);
Andy Green4739e5c2011-01-22 12:51:57 +0000781 return NULL;
782 }
Andy Green8f037e42010-12-19 22:13:26 +0000783 }
Andy Greenb45993c2010-12-18 15:13:50 +0000784
Andy Greene77ddd82010-11-13 10:03:47 +0000785 /* drop any root privs for this process */
Andy Green3faa9c72010-11-08 17:03:03 +0000786
787 if (gid != -1)
788 if (setgid(gid))
789 fprintf(stderr, "setgid: %s\n", strerror(errno));
790 if (uid != -1)
791 if (setuid(uid))
792 fprintf(stderr, "setuid: %s\n", strerror(errno));
793
Andy Green8f037e42010-12-19 22:13:26 +0000794 /*
Andy Greenb45993c2010-12-18 15:13:50 +0000795 * prepare the poll() fd array... it's like this
796 *
797 * [0] = external listening socket
798 * [1 .. this->count_protocols] = per-protocol broadcast sockets
799 * [this->count_protocols + 1 ... this->fds_count-1] = connection skts
Andy Green4f3943a2010-11-12 10:44:16 +0000800 */
801
Andy Greenb45993c2010-12-18 15:13:50 +0000802 this->fds_count = 1;
803 this->fds[0].fd = sockfd;
804 this->fds[0].events = POLLIN;
805 this->count_protocols = 0;
Andy Greenb45993c2010-12-18 15:13:50 +0000806
Andy Green4739e5c2011-01-22 12:51:57 +0000807 if (port) {
808 listen(sockfd, 5);
809 fprintf(stderr, " Listening on port %d\n", port);
810 }
Andy Greenb45993c2010-12-18 15:13:50 +0000811
812 /* set up our internal broadcast trigger sockets per-protocol */
813
814 for (; protocols[this->count_protocols].callback;
815 this->count_protocols++) {
816 protocols[this->count_protocols].owning_server = this;
817 protocols[this->count_protocols].protocol_index =
818 this->count_protocols;
819
820 fd = socket(AF_INET, SOCK_STREAM, 0);
821 if (fd < 0) {
822 fprintf(stderr, "ERROR opening socket");
Andy Greene92cd172011-01-19 13:11:55 +0000823 return NULL;
Andy Greenb45993c2010-12-18 15:13:50 +0000824 }
Andy Green8f037e42010-12-19 22:13:26 +0000825
Andy Greenb45993c2010-12-18 15:13:50 +0000826 /* allow us to restart even if old sockets in TIME_WAIT */
827 setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt));
828
829 bzero((char *) &serv_addr, sizeof(serv_addr));
830 serv_addr.sin_family = AF_INET;
831 serv_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
832 serv_addr.sin_port = 0; /* pick the port for us */
833
834 n = bind(fd, (struct sockaddr *) &serv_addr, sizeof(serv_addr));
835 if (n < 0) {
Andy Green8f037e42010-12-19 22:13:26 +0000836 fprintf(stderr, "ERROR on binding to port %d (%d %d)\n",
Andy Greenb45993c2010-12-18 15:13:50 +0000837 port, n, errno);
Andy Greene92cd172011-01-19 13:11:55 +0000838 return NULL;
Andy Greenb45993c2010-12-18 15:13:50 +0000839 }
840
841 slen = sizeof cli_addr;
842 n = getsockname(fd, (struct sockaddr *)&cli_addr, &slen);
843 if (n < 0) {
844 fprintf(stderr, "getsockname failed\n");
Andy Greene92cd172011-01-19 13:11:55 +0000845 return NULL;
Andy Greenb45993c2010-12-18 15:13:50 +0000846 }
847 protocols[this->count_protocols].broadcast_socket_port =
848 ntohs(cli_addr.sin_port);
849 listen(fd, 5);
850
851 debug(" Protocol %s broadcast socket %d\n",
852 protocols[this->count_protocols].name,
853 ntohs(cli_addr.sin_port));
854
855 this->fds[this->fds_count].fd = fd;
856 this->fds[this->fds_count].events = POLLIN;
857 /* wsi only exists for connections, not broadcast listener */
858 this->wsi[this->fds_count] = NULL;
859 this->fds_count++;
860 }
861
Andy Greene92cd172011-01-19 13:11:55 +0000862 return this;
863}
Andy Greenb45993c2010-12-18 15:13:50 +0000864
Andy Green4739e5c2011-01-22 12:51:57 +0000865
Andy Greened11a022011-01-20 10:23:50 +0000866#ifndef LWS_NO_FORK
867
Andy Greene92cd172011-01-19 13:11:55 +0000868/**
869 * libwebsockets_fork_service_loop() - Optional helper function forks off
870 * a process for the websocket server loop.
Andy Green6964bb52011-01-23 16:50:33 +0000871 * You don't have to use this but if not, you
872 * have to make sure you are calling
873 * libwebsocket_service periodically to service
874 * the websocket traffic
Andy Greene92cd172011-01-19 13:11:55 +0000875 * @this: server context returned by creation function
876 */
Andy Greenb45993c2010-12-18 15:13:50 +0000877
Andy Greene92cd172011-01-19 13:11:55 +0000878int
879libwebsockets_fork_service_loop(struct libwebsocket_context *this)
880{
881 int client;
882 int fd;
883 struct sockaddr_in cli_addr;
884 int n;
Andy Greenb45993c2010-12-18 15:13:50 +0000885
Andy Greened11a022011-01-20 10:23:50 +0000886 n = fork();
887 if (n < 0)
888 return n;
889
890 if (!n) {
891
892 /* main process context */
893
894 for (client = 1; client < this->count_protocols + 1; client++) {
895 fd = socket(AF_INET, SOCK_STREAM, 0);
896 if (fd < 0) {
897 fprintf(stderr, "Unable to create socket\n");
898 return -1;
899 }
900 cli_addr.sin_family = AF_INET;
901 cli_addr.sin_port = htons(
Andy Green4739e5c2011-01-22 12:51:57 +0000902 this->protocols[client - 1].broadcast_socket_port);
Andy Greened11a022011-01-20 10:23:50 +0000903 cli_addr.sin_addr.s_addr = inet_addr("127.0.0.1");
904 n = connect(fd, (struct sockaddr *)&cli_addr,
905 sizeof cli_addr);
906 if (n < 0) {
907 fprintf(stderr, "Unable to connect to "
908 "broadcast socket %d, %s\n",
909 client, strerror(errno));
910 return -1;
911 }
912
Andy Green4739e5c2011-01-22 12:51:57 +0000913 this->protocols[client - 1].broadcast_socket_user_fd =
914 fd;
Andy Greened11a022011-01-20 10:23:50 +0000915 }
916
917
Andy Greene92cd172011-01-19 13:11:55 +0000918 return 0;
Andy Greenb45993c2010-12-18 15:13:50 +0000919 }
920
921 /* we want a SIGHUP when our parent goes down */
922 prctl(PR_SET_PDEATHSIG, SIGHUP);
923
924 /* in this forked process, sit and service websocket connections */
Andy Green8f037e42010-12-19 22:13:26 +0000925
Andy Greene92cd172011-01-19 13:11:55 +0000926 while (1)
927 if (libwebsocket_service(this, 1000))
928 return -1;
Andy Green8f037e42010-12-19 22:13:26 +0000929
Andy Green251f6fa2010-11-03 11:13:06 +0000930 return 0;
Andy Greenff95d7a2010-10-28 22:36:01 +0100931}
932
Andy Greened11a022011-01-20 10:23:50 +0000933#endif
934
Andy Greenb45993c2010-12-18 15:13:50 +0000935/**
936 * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
Andy Green8f037e42010-12-19 22:13:26 +0000937 * connection.
Andy Greenb45993c2010-12-18 15:13:50 +0000938 * @wsi: pointer to struct websocket you want to know the protocol of
939 *
Andy Green8f037e42010-12-19 22:13:26 +0000940 *
941 * This is useful to get the protocol to broadcast back to from inside
Andy Greenb45993c2010-12-18 15:13:50 +0000942 * the callback.
943 */
Andy Greenab990e42010-10-31 12:42:52 +0000944
Andy Greenb45993c2010-12-18 15:13:50 +0000945const struct libwebsocket_protocols *
946libwebsockets_get_protocol(struct libwebsocket *wsi)
947{
948 return wsi->protocol;
949}
950
951/**
Andy Greene92cd172011-01-19 13:11:55 +0000952 * libwebsockets_broadcast() - Sends a buffer to the callback for all active
Andy Green8f037e42010-12-19 22:13:26 +0000953 * connections of the given protocol.
Andy Greenb45993c2010-12-18 15:13:50 +0000954 * @protocol: pointer to the protocol you will broadcast to all members of
955 * @buf: buffer containing the data to be broadcase. NOTE: this has to be
Andy Green8f037e42010-12-19 22:13:26 +0000956 * allocated with LWS_SEND_BUFFER_PRE_PADDING valid bytes before
957 * the pointer and LWS_SEND_BUFFER_POST_PADDING afterwards in the
958 * case you are calling this function from callback context.
Andy Greenb45993c2010-12-18 15:13:50 +0000959 * @len: length of payload data in buf, starting from buf.
Andy Green8f037e42010-12-19 22:13:26 +0000960 *
961 * This function allows bulk sending of a packet to every connection using
Andy Greenb45993c2010-12-18 15:13:50 +0000962 * the given protocol. It does not send the data directly; instead it calls
963 * the callback with a reason type of LWS_CALLBACK_BROADCAST. If the callback
964 * wants to actually send the data for that connection, the callback itself
965 * should call libwebsocket_write().
966 *
967 * libwebsockets_broadcast() can be called from another fork context without
968 * having to take any care about data visibility between the processes, it'll
969 * "just work".
970 */
971
972
973int
Andy Green8f037e42010-12-19 22:13:26 +0000974libwebsockets_broadcast(const struct libwebsocket_protocols *protocol,
Andy Greenb45993c2010-12-18 15:13:50 +0000975 unsigned char *buf, size_t len)
976{
Andy Green8f037e42010-12-19 22:13:26 +0000977 struct libwebsocket_context *this = protocol->owning_server;
Andy Greenb45993c2010-12-18 15:13:50 +0000978 int n;
979
980 if (!protocol->broadcast_socket_user_fd) {
981 /*
Andy Greene92cd172011-01-19 13:11:55 +0000982 * We are either running unforked / flat, or we are being
983 * called from poll thread context
Andy Greenb45993c2010-12-18 15:13:50 +0000984 * eg, from a callback. In that case don't use sockets for
985 * broadcast IPC (since we can't open a socket connection to
986 * a socket listening on our own thread) but directly do the
987 * send action.
988 *
989 * Locking is not needed because we are by definition being
990 * called in the poll thread context and are serialized.
991 */
992
993 for (n = this->count_protocols + 1; n < this->fds_count; n++) {
994
995 if ((unsigned long)this->wsi[n] < LWS_MAX_PROTOCOLS)
996 continue;
997
998 /* never broadcast to non-established connection */
Andy Greenb45993c2010-12-18 15:13:50 +0000999 if (this->wsi[n]->state != WSI_STATE_ESTABLISHED)
1000 continue;
1001
1002 /* only broadcast to guys using requested protocol */
Andy Greenb45993c2010-12-18 15:13:50 +00001003 if (this->wsi[n]->protocol != protocol)
1004 continue;
1005
Andy Green8f037e42010-12-19 22:13:26 +00001006 this->wsi[n]->protocol->callback(this->wsi[n],
1007 LWS_CALLBACK_BROADCAST,
Andy Greenb45993c2010-12-18 15:13:50 +00001008 this->wsi[n]->user_space,
1009 buf, len);
1010 }
1011
1012 return 0;
1013 }
1014
Andy Green0ca6a172010-12-19 20:50:01 +00001015 /*
1016 * We're being called from a different process context than the server
1017 * loop. Instead of broadcasting directly, we send our
1018 * payload on a socket to do the IPC; the server process will serialize
1019 * the broadcast action in its main poll() loop.
1020 *
1021 * There's one broadcast socket listening for each protocol supported
1022 * set up when the websocket server initializes
1023 */
1024
Andy Green6964bb52011-01-23 16:50:33 +00001025 n = send(protocol->broadcast_socket_user_fd, buf, len, MSG_NOSIGNAL);
Andy Greenb45993c2010-12-18 15:13:50 +00001026
1027 return n;
1028}