blob: 38fc098ad104dc9d2b11dbb5b95aa966b03266fa [file] [log] [blame]
Andy Green58eaa742011-03-07 17:54:06 +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 Greenc11db202013-01-19 11:12:16 +080023#include <syslog.h>
Andy Greenff95d7a2010-10-28 22:36:01 +010024
Peter Hinz56885f32011-03-02 22:03:47 +000025#ifdef WIN32
David Galeanocb193682013-01-09 15:29:00 +080026#include <tchar.h>
27#include <io.h>
Peter Hinz56885f32011-03-02 22:03:47 +000028#else
Davidc4ef7b12013-01-12 20:39:47 +080029#ifdef LWS_BUILTIN_GETIFADDRS
30#include <getifaddrs.h>
31#else
Peter Hinz56885f32011-03-02 22:03:47 +000032#include <ifaddrs.h>
Davidc4ef7b12013-01-12 20:39:47 +080033#endif
Andy Green7627af52011-03-09 15:13:52 +000034#include <sys/un.h>
Andy Greena69f0512012-05-03 12:32:38 +080035#include <sys/socket.h>
36#include <netdb.h>
Peter Hinz56885f32011-03-02 22:03:47 +000037#endif
Andy Green2e24da02011-03-05 16:12:04 +000038
39#ifdef LWS_OPENSSL_SUPPORT
40int openssl_websocket_private_data_index;
41#endif
42
Andy Greenaa6fc442012-04-12 13:26:49 +080043#ifdef __MINGW32__
44#include "../win32port/win32helpers/websock-w32.c"
45#else
46#ifdef __MINGW64__
47#include "../win32port/win32helpers/websock-w32.c"
48#endif
49#endif
50
Andy Green3182ece2013-01-20 17:08:31 +080051
Andy Green7c19c342013-01-19 12:18:07 +080052static int log_level = LLL_ERR | LLL_WARN | LLL_NOTICE;
Andy Green058ba812013-01-19 11:32:18 +080053static void lwsl_emit_stderr(int level, const char *line);
54static void (*lwsl_emit)(int level, const char *line) = lwsl_emit_stderr;
55
Andy Green43db0452013-01-10 19:50:35 +080056static const char *log_level_names[] = {
57 "ERR",
58 "WARN",
Andy Green7c19c342013-01-19 12:18:07 +080059 "NOTICE",
Andy Green43db0452013-01-10 19:50:35 +080060 "INFO",
61 "DEBUG",
62 "PARSER",
63 "HEADER",
64 "EXTENSION",
65 "CLIENT",
Andy Greend636e352013-01-29 12:36:17 +080066 "LATENCY",
Andy Green43db0452013-01-10 19:50:35 +080067};
68
Andy Green0d338332011-02-12 11:57:43 +000069int
Andy Greendfb23042013-01-17 12:26:48 +080070insert_wsi_socket_into_fds(struct libwebsocket_context *context, struct libwebsocket *wsi)
Andy Green0d338332011-02-12 11:57:43 +000071{
Andy Greendfb23042013-01-17 12:26:48 +080072 if (context->fds_count >= context->max_fds) {
73 lwsl_err("Reached limit of fds tracking (%d)\n", context->max_fds);
Andy Green0d338332011-02-12 11:57:43 +000074 return 1;
75 }
76
Andy Greendfb23042013-01-17 12:26:48 +080077 if (wsi->sock > context->max_fds) {
78 lwsl_err("Socket fd %d is beyond what we can index (%d)\n", wsi->sock, context->max_fds);
79 return 1;
80 }
81
82 assert(wsi);
83 assert(wsi->sock);
84
85 lwsl_info("insert_wsi_socket_into_fds: wsi=%p, sock=%d, fds pos=%d\n", wsi, wsi->sock, context->fds_count);
86
87 context->lws_lookup[wsi->sock] = wsi;
88 wsi->position_in_fds_table = context->fds_count;
89 context->fds[context->fds_count].fd = wsi->sock;
90 context->fds[context->fds_count].events = POLLIN;
91 context->fds[context->fds_count++].revents = 0;
92
93 /* external POLL support via protocol 0 */
94 context->protocols[0].callback(context, wsi,
95 LWS_CALLBACK_ADD_POLL_FD,
96 (void *)(long)wsi->sock, NULL, POLLIN);
Andy Green0d338332011-02-12 11:57:43 +000097
98 return 0;
99}
100
Andy Greendfb23042013-01-17 12:26:48 +0800101static int
102remove_wsi_socket_from_fds(struct libwebsocket_context *context, struct libwebsocket *wsi)
Andy Green0d338332011-02-12 11:57:43 +0000103{
Andy Greendfb23042013-01-17 12:26:48 +0800104 int m;
Andy Green0d338332011-02-12 11:57:43 +0000105
Andy Greendfb23042013-01-17 12:26:48 +0800106 if (!--context->fds_count)
107 goto do_ext;
Andy Green0d338332011-02-12 11:57:43 +0000108
Andy Greendfb23042013-01-17 12:26:48 +0800109 if (wsi->sock > context->max_fds) {
110 lwsl_err("Socket fd %d is beyond what we can index (%d)\n", wsi->sock, context->max_fds);
111 return 1;
112 }
Andy Green0d338332011-02-12 11:57:43 +0000113
Andy Greendfb23042013-01-17 12:26:48 +0800114 lwsl_info("remove_wsi_socket_from_fds: wsi=%p, sock=%d, fds pos=%d\n", wsi, wsi->sock, wsi->position_in_fds_table);
115
116 m = wsi->position_in_fds_table; /* replace the contents for this */
117
118 /* have the last guy take up the vacant slot */
119 context->fds[m] = context->fds[context->fds_count]; /* vacant fds slot filled with end one */
120 /* end guy's fds_lookup entry remains unchanged (still same fd pointing to same wsi) */
121 /* end guy's "position in fds table" changed */
122 context->lws_lookup[context->fds[context->fds_count].fd]->position_in_fds_table = m;
123 /* deletion guy's lws_lookup entry needs nuking */
124 context->lws_lookup[wsi->sock] = NULL; /* no WSI for the socket of the wsi being removed*/
125 wsi->position_in_fds_table = -1; /* removed wsi has no position any more */
126
127do_ext:
128 /* remove also from external POLL support via protocol 0 */
129 if (wsi->sock)
130 context->protocols[0].callback(context, wsi,
131 LWS_CALLBACK_DEL_POLL_FD, (void *)(long)wsi->sock, NULL, 0);
132
133 return 0;
Andy Green0d338332011-02-12 11:57:43 +0000134}
135
Andy Green32375b72011-02-19 08:32:53 +0000136
Andy Green8f037e42010-12-19 22:13:26 +0000137void
Peter Hinz56885f32011-03-02 22:03:47 +0000138libwebsocket_close_and_free_session(struct libwebsocket_context *context,
Andy Green687b0182011-02-26 11:04:01 +0000139 struct libwebsocket *wsi, enum lws_close_status reason)
Andy Green251f6fa2010-11-03 11:13:06 +0000140{
Andy Greenb45993c2010-12-18 15:13:50 +0000141 int n;
Andy Green62c54d22011-02-14 09:14:25 +0000142 int old_state;
Andy Green5e1fa172011-02-10 09:07:05 +0000143 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 2 +
144 LWS_SEND_BUFFER_POST_PADDING];
Andy Green3182ece2013-01-20 17:08:31 +0800145#ifndef LWS_NO_EXTENSIONS
Andy Greenc44159f2011-03-07 07:08:18 +0000146 int ret;
147 int m;
148 struct lws_tokens eff_buf;
Andy Greena41314f2011-05-23 10:00:03 +0100149 struct libwebsocket_extension *ext;
Andy Green3182ece2013-01-20 17:08:31 +0800150#endif
Andy Greenb45993c2010-12-18 15:13:50 +0000151
Andy Green4b6fbe12011-02-14 08:03:48 +0000152 if (!wsi)
Andy Greenb45993c2010-12-18 15:13:50 +0000153 return;
154
Andy Green62c54d22011-02-14 09:14:25 +0000155 old_state = wsi->state;
Andy Green251f6fa2010-11-03 11:13:06 +0000156
Andy Green62c54d22011-02-14 09:14:25 +0000157 if (old_state == WSI_STATE_DEAD_SOCKET)
Andy Green5e1fa172011-02-10 09:07:05 +0000158 return;
159
Andy Green623a98d2013-01-21 11:04:23 +0800160 wsi->u.ws.close_reason = reason;
Andy Greenda527df2011-03-07 07:08:12 +0000161
Andy Green3182ece2013-01-20 17:08:31 +0800162#ifndef LWS_NO_EXTENSIONS
Andy Greenda527df2011-03-07 07:08:12 +0000163 /*
Andy Green68b45042011-05-25 21:41:57 +0100164 * are his extensions okay with him closing? Eg he might be a mux
165 * parent and just his ch1 aspect is closing?
166 */
167
Andy Green68b45042011-05-25 21:41:57 +0100168 for (n = 0; n < wsi->count_active_extensions; n++) {
169 if (!wsi->active_extensions[n]->callback)
170 continue;
171
172 m = wsi->active_extensions[n]->callback(context,
173 wsi->active_extensions[n], wsi,
174 LWS_EXT_CALLBACK_CHECK_OK_TO_REALLY_CLOSE,
175 wsi->active_extensions_user[n], NULL, 0);
176
177 /*
178 * if somebody vetoed actually closing him at this time....
179 * up to the extension to track the attempted close, let's
180 * just bail
181 */
182
183 if (m) {
Andy Green43db0452013-01-10 19:50:35 +0800184 lwsl_ext("extension vetoed close\n");
Andy Green68b45042011-05-25 21:41:57 +0100185 return;
186 }
187 }
188
Andy Green68b45042011-05-25 21:41:57 +0100189 /*
Andy Greenc44159f2011-03-07 07:08:18 +0000190 * flush any tx pending from extensions, since we may send close packet
191 * if there are problems with send, just nuke the connection
192 */
193
194 ret = 1;
195 while (ret == 1) {
196
197 /* default to nobody has more to spill */
198
199 ret = 0;
200 eff_buf.token = NULL;
201 eff_buf.token_len = 0;
202
203 /* show every extension the new incoming data */
204
205 for (n = 0; n < wsi->count_active_extensions; n++) {
206 m = wsi->active_extensions[n]->callback(
Andy Green46c2ea02011-03-22 09:04:01 +0000207 wsi->protocol->owning_server,
208 wsi->active_extensions[n], wsi,
Andy Greenc44159f2011-03-07 07:08:18 +0000209 LWS_EXT_CALLBACK_FLUSH_PENDING_TX,
210 wsi->active_extensions_user[n], &eff_buf, 0);
211 if (m < 0) {
Andy Green43db0452013-01-10 19:50:35 +0800212 lwsl_ext("Extension reports fatal error\n");
Andy Greenc44159f2011-03-07 07:08:18 +0000213 goto just_kill_connection;
214 }
215 if (m)
216 /*
217 * at least one extension told us he has more
218 * to spill, so we will go around again after
219 */
220 ret = 1;
221 }
222
223 /* assuming they left us something to send, send it */
224
225 if (eff_buf.token_len)
226 if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
Andy Green0303db42013-01-17 14:46:43 +0800227 eff_buf.token_len)) {
228 lwsl_debug("close: sending final extension spill had problems\n");
Andy Greenc44159f2011-03-07 07:08:18 +0000229 goto just_kill_connection;
Andy Green0303db42013-01-17 14:46:43 +0800230 }
Andy Greenc44159f2011-03-07 07:08:18 +0000231 }
Andy Green3182ece2013-01-20 17:08:31 +0800232#endif
Andy Greenc44159f2011-03-07 07:08:18 +0000233
234 /*
Andy Greenda527df2011-03-07 07:08:12 +0000235 * signal we are closing, libsocket_write will
236 * add any necessary version-specific stuff. If the write fails,
237 * no worries we are closing anyway. If we didn't initiate this
238 * close, then our state has been changed to
239 * WSI_STATE_RETURNED_CLOSE_ALREADY and we will skip this.
240 *
241 * Likewise if it's a second call to close this connection after we
242 * sent the close indication to the peer already, we are in state
243 * WSI_STATE_AWAITING_CLOSE_ACK and will skip doing this a second time.
244 */
245
246 if (old_state == WSI_STATE_ESTABLISHED &&
247 reason != LWS_CLOSE_STATUS_NOSTATUS) {
Andy Green66a16f32011-05-24 22:07:45 +0100248
Andy Green43db0452013-01-10 19:50:35 +0800249 lwsl_debug("sending close indication...\n");
Andy Green66a16f32011-05-24 22:07:45 +0100250
Andy Greenda527df2011-03-07 07:08:12 +0000251 n = libwebsocket_write(wsi, &buf[LWS_SEND_BUFFER_PRE_PADDING],
252 0, LWS_WRITE_CLOSE);
253 if (!n) {
254 /*
255 * we have sent a nice protocol level indication we
256 * now wish to close, we should not send anything more
257 */
258
259 wsi->state = WSI_STATE_AWAITING_CLOSE_ACK;
260
Andy Green0303db42013-01-17 14:46:43 +0800261 /* and we should wait for a reply for a bit out of politeness */
Andy Greenda527df2011-03-07 07:08:12 +0000262
263 libwebsocket_set_timeout(wsi,
Andy Green0303db42013-01-17 14:46:43 +0800264 PENDING_TIMEOUT_CLOSE_ACK, 1);
Andy Greenda527df2011-03-07 07:08:12 +0000265
Andy Green43db0452013-01-10 19:50:35 +0800266 lwsl_debug("sent close indication, awaiting ack\n");
Andy Greenda527df2011-03-07 07:08:12 +0000267
268 return;
269 }
270
Andy Green0303db42013-01-17 14:46:43 +0800271 lwsl_info("close: sending the close packet failed, hanging up\n");
272
Andy Greenda527df2011-03-07 07:08:12 +0000273 /* else, the send failed and we should just hang up */
274 }
275
Andy Green3182ece2013-01-20 17:08:31 +0800276#ifndef LWS_NO_EXTENSIONS
Andy Greenc44159f2011-03-07 07:08:18 +0000277just_kill_connection:
Andy Green3182ece2013-01-20 17:08:31 +0800278#endif
Andy Green66a16f32011-05-24 22:07:45 +0100279
Andy Green43db0452013-01-10 19:50:35 +0800280 lwsl_debug("libwebsocket_close_and_free_session: just_kill_connection\n");
Andy Green66a16f32011-05-24 22:07:45 +0100281
Andy Greenda527df2011-03-07 07:08:12 +0000282 /*
283 * we won't be servicing or receiving anything further from this guy
Andy Greendfb23042013-01-17 12:26:48 +0800284 * delete socket from the internal poll list if still present
Andy Greenda527df2011-03-07 07:08:12 +0000285 */
Andy Green4b6fbe12011-02-14 08:03:48 +0000286
Andy Greendfb23042013-01-17 12:26:48 +0800287 remove_wsi_socket_from_fds(context, wsi);
Andy Green4b6fbe12011-02-14 08:03:48 +0000288
Andy Green251f6fa2010-11-03 11:13:06 +0000289 wsi->state = WSI_STATE_DEAD_SOCKET;
290
Andy Green4b6fbe12011-02-14 08:03:48 +0000291 /* tell the user it's all over for this guy */
292
Andy Greend4302732011-02-28 07:45:29 +0000293 if (wsi->protocol && wsi->protocol->callback &&
Andy Green6ee372f2012-04-09 15:09:01 +0800294 ((old_state == WSI_STATE_ESTABLISHED) ||
295 (old_state == WSI_STATE_RETURNED_CLOSE_ALREADY) ||
296 (old_state == WSI_STATE_AWAITING_CLOSE_ACK))) {
Andy Green43db0452013-01-10 19:50:35 +0800297 lwsl_debug("calling back CLOSED\n");
Peter Hinz56885f32011-03-02 22:03:47 +0000298 wsi->protocol->callback(context, wsi, LWS_CALLBACK_CLOSED,
Andy Greene77ddd82010-11-13 10:03:47 +0000299 wsi->user_space, NULL, 0);
Andy Greencc012472011-11-07 19:53:23 +0800300 } else
Andy Green43db0452013-01-10 19:50:35 +0800301 lwsl_debug("not calling back closed, old_state=%d\n", old_state);
Andy Green251f6fa2010-11-03 11:13:06 +0000302
Andy Green3182ece2013-01-20 17:08:31 +0800303#ifndef LWS_NO_EXTENSIONS
Andy Greenef660a92011-03-06 10:29:38 +0000304 /* deallocate any active extension contexts */
305
306 for (n = 0; n < wsi->count_active_extensions; n++) {
307 if (!wsi->active_extensions[n]->callback)
308 continue;
309
Andy Green46c2ea02011-03-22 09:04:01 +0000310 wsi->active_extensions[n]->callback(context,
311 wsi->active_extensions[n], wsi,
312 LWS_EXT_CALLBACK_DESTROY,
313 wsi->active_extensions_user[n], NULL, 0);
Andy Greenef660a92011-03-06 10:29:38 +0000314
315 free(wsi->active_extensions_user[n]);
316 }
317
Andy Greena41314f2011-05-23 10:00:03 +0100318 /*
319 * inform all extensions in case they tracked this guy out of band
320 * even though not active on him specifically
321 */
322
323 ext = context->extensions;
324 while (ext && ext->callback) {
325 ext->callback(context, ext, wsi,
326 LWS_EXT_CALLBACK_DESTROY_ANY_WSI_CLOSING,
327 NULL, NULL, 0);
328 ext++;
329 }
Andy Green3182ece2013-01-20 17:08:31 +0800330#endif
Andy Greena41314f2011-05-23 10:00:03 +0100331
Andy Greenef660a92011-03-06 10:29:38 +0000332 /* free up his parsing allocations */
Andy Green4b6fbe12011-02-14 08:03:48 +0000333
Andy Green251f6fa2010-11-03 11:13:06 +0000334 for (n = 0; n < WSI_TOKEN_COUNT; n++)
335 if (wsi->utf8_token[n].token)
336 free(wsi->utf8_token[n].token);
Andy Greena1ce6be2013-01-18 11:43:21 +0800337#ifndef LWS_NO_CLIENT
Andy Greena41314f2011-05-23 10:00:03 +0100338 if (wsi->c_address)
339 free(wsi->c_address);
Andy Greena1ce6be2013-01-18 11:43:21 +0800340#endif
Andy Green623a98d2013-01-21 11:04:23 +0800341 if (wsi->u.ws.rxflow_buffer)
342 free(wsi->u.ws.rxflow_buffer);
Andy Green706961d2013-01-17 16:50:35 +0800343
Andy Green43db0452013-01-10 19:50:35 +0800344/* lwsl_info("closing fd=%d\n", wsi->sock); */
Andy Green251f6fa2010-11-03 11:13:06 +0000345
Andy Green3faa9c72010-11-08 17:03:03 +0000346#ifdef LWS_OPENSSL_SUPPORT
Andy Green90c7cbc2011-01-27 06:26:52 +0000347 if (wsi->ssl) {
Andy Green3faa9c72010-11-08 17:03:03 +0000348 n = SSL_get_fd(wsi->ssl);
349 SSL_shutdown(wsi->ssl);
Andy Green3fc2c652013-01-14 15:35:02 +0800350 compatible_close(n);
Andy Green3faa9c72010-11-08 17:03:03 +0000351 SSL_free(wsi->ssl);
352 } else {
353#endif
Andy Green0303db42013-01-17 14:46:43 +0800354 if (wsi->sock) {
355 n = shutdown(wsi->sock, SHUT_RDWR);
356 if (n)
357 lwsl_debug("closing: shutdown returned %d\n", errno);
Andy Green3fc2c652013-01-14 15:35:02 +0800358
Andy Green0303db42013-01-17 14:46:43 +0800359 n = compatible_close(wsi->sock);
360 if (n)
361 lwsl_debug("closing: close returned %d\n", errno);
362 }
Andy Green3faa9c72010-11-08 17:03:03 +0000363#ifdef LWS_OPENSSL_SUPPORT
364 }
365#endif
David Brooks2c60d952012-04-20 12:19:01 +0800366 if (wsi->protocol && wsi->protocol->per_session_data_size && wsi->user_space) /* user code may own */
Andy Green4f3943a2010-11-12 10:44:16 +0000367 free(wsi->user_space);
368
Andy Green251f6fa2010-11-03 11:13:06 +0000369 free(wsi);
370}
371
Andy Green07034092011-02-13 08:37:12 +0000372/**
Andy Greenf7ee5492011-02-13 09:04:21 +0000373 * libwebsockets_hangup_on_client() - Server calls to terminate client
Andy Green6ee372f2012-04-09 15:09:01 +0800374 * connection
Peter Hinz56885f32011-03-02 22:03:47 +0000375 * @context: libwebsockets context
Andy Greenf7ee5492011-02-13 09:04:21 +0000376 * @fd: Connection socket descriptor
377 */
378
379void
Peter Hinz56885f32011-03-02 22:03:47 +0000380libwebsockets_hangup_on_client(struct libwebsocket_context *context, int fd)
Andy Greenf7ee5492011-02-13 09:04:21 +0000381{
Andy Greendfb23042013-01-17 12:26:48 +0800382 struct libwebsocket *wsi = context->lws_lookup[fd];
Andy Greenf7ee5492011-02-13 09:04:21 +0000383
Andy Greendfb23042013-01-17 12:26:48 +0800384 if (wsi) {
385 libwebsocket_close_and_free_session(context,
386 wsi, LWS_CLOSE_STATUS_NOSTATUS);
387 } else
388 close(fd);
Andy Greenf7ee5492011-02-13 09:04:21 +0000389}
390
391
392/**
Andy Green07034092011-02-13 08:37:12 +0000393 * libwebsockets_get_peer_addresses() - Get client address information
394 * @fd: Connection socket descriptor
395 * @name: Buffer to take client address name
396 * @name_len: Length of client address name buffer
397 * @rip: Buffer to take client address IP qotted quad
398 * @rip_len: Length of client address IP buffer
399 *
400 * This function fills in @name and @rip with the name and IP of
Andy Green6ee372f2012-04-09 15:09:01 +0800401 * the client connected with socket descriptor @fd. Names may be
402 * truncated if there is not enough room. If either cannot be
403 * determined, they will be returned as valid zero-length strings.
Andy Green07034092011-02-13 08:37:12 +0000404 */
405
406void
407libwebsockets_get_peer_addresses(int fd, char *name, int name_len,
408 char *rip, int rip_len)
409{
410 unsigned int len;
411 struct sockaddr_in sin;
412 struct hostent *host;
413 struct hostent *host1;
414 char ip[128];
Andy Greenf92def72011-03-09 15:02:20 +0000415 unsigned char *p;
Andy Green07034092011-02-13 08:37:12 +0000416 int n;
David Galeanocb193682013-01-09 15:29:00 +0800417#ifdef AF_LOCAL
418 struct sockaddr_un *un;
419#endif
Andy Green07034092011-02-13 08:37:12 +0000420
421 rip[0] = '\0';
422 name[0] = '\0';
423
424 len = sizeof sin;
425 if (getpeername(fd, (struct sockaddr *) &sin, &len) < 0) {
426 perror("getpeername");
427 return;
428 }
Andy Green6ee372f2012-04-09 15:09:01 +0800429
Andy Green07034092011-02-13 08:37:12 +0000430 host = gethostbyaddr((char *) &sin.sin_addr, sizeof sin.sin_addr,
431 AF_INET);
432 if (host == NULL) {
433 perror("gethostbyaddr");
434 return;
435 }
436
437 strncpy(name, host->h_name, name_len);
438 name[name_len - 1] = '\0';
439
440 host1 = gethostbyname(host->h_name);
441 if (host1 == NULL)
442 return;
Andy Greenf92def72011-03-09 15:02:20 +0000443 p = (unsigned char *)host1;
Andy Green07034092011-02-13 08:37:12 +0000444 n = 0;
445 while (p != NULL) {
Andy Greenf92def72011-03-09 15:02:20 +0000446 p = (unsigned char *)host1->h_addr_list[n++];
Andy Green07034092011-02-13 08:37:12 +0000447 if (p == NULL)
448 continue;
Peter Hinzbb45a902011-03-10 18:14:01 +0000449 if ((host1->h_addrtype != AF_INET)
450#ifdef AF_LOCAL
451 && (host1->h_addrtype != AF_LOCAL)
452#endif
453 )
Andy Green07034092011-02-13 08:37:12 +0000454 continue;
455
Andy Green7627af52011-03-09 15:13:52 +0000456 if (host1->h_addrtype == AF_INET)
457 sprintf(ip, "%u.%u.%u.%u", p[0], p[1], p[2], p[3]);
Peter Hinzbb45a902011-03-10 18:14:01 +0000458#ifdef AF_LOCAL
Andy Green7627af52011-03-09 15:13:52 +0000459 else {
460 un = (struct sockaddr_un *)p;
Andy Green6ee372f2012-04-09 15:09:01 +0800461 strncpy(ip, un->sun_path, sizeof(ip) - 1);
Andy Green7627af52011-03-09 15:13:52 +0000462 ip[sizeof(ip) - 1] = '\0';
463 }
Peter Hinzbb45a902011-03-10 18:14:01 +0000464#endif
Andy Green07034092011-02-13 08:37:12 +0000465 p = NULL;
466 strncpy(rip, ip, rip_len);
467 rip[rip_len - 1] = '\0';
468 }
469}
Andy Green9f990342011-02-12 11:57:45 +0000470
Peter Hinz56885f32011-03-02 22:03:47 +0000471int libwebsockets_get_random(struct libwebsocket_context *context,
472 void *buf, int len)
473{
474 int n;
Aaron Zinman4550f1d2013-01-10 12:35:18 +0800475 char *p = (char *)buf;
Peter Hinz56885f32011-03-02 22:03:47 +0000476
477#ifdef WIN32
478 for (n = 0; n < len; n++)
479 p[n] = (unsigned char)rand();
480#else
481 n = read(context->fd_random, p, len);
482#endif
483
484 return n;
485}
486
Andy Green95a7b5d2011-03-06 10:29:39 +0000487int lws_send_pipe_choked(struct libwebsocket *wsi)
488{
489 struct pollfd fds;
490
491 fds.fd = wsi->sock;
492 fds.events = POLLOUT;
493 fds.revents = 0;
494
495 if (poll(&fds, 1, 0) != 1)
496 return 1;
497
498 if ((fds.revents & POLLOUT) == 0)
499 return 1;
500
501 /* okay to send another packet without blocking */
502
503 return 0;
504}
505
Andy Greena41314f2011-05-23 10:00:03 +0100506int
Andy Green3b84c002011-03-06 13:14:42 +0000507lws_handle_POLLOUT_event(struct libwebsocket_context *context,
508 struct libwebsocket *wsi, struct pollfd *pollfd)
509{
Andy Green3b84c002011-03-06 13:14:42 +0000510 int n;
Andy Green6f520a52013-01-29 17:57:39 +0800511
Andy Green3182ece2013-01-20 17:08:31 +0800512#ifndef LWS_NO_EXTENSIONS
513 struct lws_tokens eff_buf;
Andy Green3b84c002011-03-06 13:14:42 +0000514 int ret;
515 int m;
Andy Greena41314f2011-05-23 10:00:03 +0100516 int handled = 0;
Andy Green3b84c002011-03-06 13:14:42 +0000517
Andy Greena41314f2011-05-23 10:00:03 +0100518 for (n = 0; n < wsi->count_active_extensions; n++) {
519 if (!wsi->active_extensions[n]->callback)
520 continue;
521
522 m = wsi->active_extensions[n]->callback(context,
523 wsi->active_extensions[n], wsi,
524 LWS_EXT_CALLBACK_IS_WRITEABLE,
525 wsi->active_extensions_user[n], NULL, 0);
526 if (m > handled)
527 handled = m;
528 }
529
530 if (handled == 1)
531 goto notify_action;
532
533 if (!wsi->extension_data_pending || handled == 2)
Andy Green3b84c002011-03-06 13:14:42 +0000534 goto user_service;
535
536 /*
537 * check in on the active extensions, see if they
538 * had pending stuff to spill... they need to get the
539 * first look-in otherwise sequence will be disordered
540 *
541 * NULL, zero-length eff_buf means just spill pending
542 */
543
544 ret = 1;
545 while (ret == 1) {
546
547 /* default to nobody has more to spill */
548
549 ret = 0;
550 eff_buf.token = NULL;
551 eff_buf.token_len = 0;
552
553 /* give every extension a chance to spill */
554
555 for (n = 0; n < wsi->count_active_extensions; n++) {
556 m = wsi->active_extensions[n]->callback(
Andy Green46c2ea02011-03-22 09:04:01 +0000557 wsi->protocol->owning_server,
558 wsi->active_extensions[n], wsi,
Andy Green3b84c002011-03-06 13:14:42 +0000559 LWS_EXT_CALLBACK_PACKET_TX_PRESEND,
560 wsi->active_extensions_user[n], &eff_buf, 0);
561 if (m < 0) {
Andy Green43db0452013-01-10 19:50:35 +0800562 lwsl_err("ext reports fatal error\n");
Andy Green3b84c002011-03-06 13:14:42 +0000563 return -1;
564 }
565 if (m)
566 /*
567 * at least one extension told us he has more
568 * to spill, so we will go around again after
569 */
570 ret = 1;
571 }
572
573 /* assuming they gave us something to send, send it */
574
575 if (eff_buf.token_len) {
576 if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
577 eff_buf.token_len))
578 return -1;
579 } else
580 continue;
581
582 /* no extension has more to spill */
583
584 if (!ret)
585 continue;
586
587 /*
588 * There's more to spill from an extension, but we just sent
589 * something... did that leave the pipe choked?
590 */
591
592 if (!lws_send_pipe_choked(wsi))
593 /* no we could add more */
594 continue;
595
Andy Green43db0452013-01-10 19:50:35 +0800596 lwsl_info("choked in POLLOUT service\n");
Andy Green3b84c002011-03-06 13:14:42 +0000597
598 /*
599 * Yes, he's choked. Leave the POLLOUT masked on so we will
600 * come back here when he is unchoked. Don't call the user
601 * callback to enforce ordering of spilling, he'll get called
602 * when we come back here and there's nothing more to spill.
603 */
604
605 return 0;
606 }
607
608 wsi->extension_data_pending = 0;
609
610user_service:
Andy Green3182ece2013-01-20 17:08:31 +0800611#endif
Andy Green3b84c002011-03-06 13:14:42 +0000612 /* one shot */
613
Andy Greena41314f2011-05-23 10:00:03 +0100614 if (pollfd) {
615 pollfd->events &= ~POLLOUT;
Andy Green3b84c002011-03-06 13:14:42 +0000616
Andy Greena41314f2011-05-23 10:00:03 +0100617 /* external POLL support via protocol 0 */
618 context->protocols[0].callback(context, wsi,
619 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
620 (void *)(long)wsi->sock, NULL, POLLOUT);
621 }
Andy Green3182ece2013-01-20 17:08:31 +0800622#ifndef LWS_NO_EXTENSIONS
Andy Greena41314f2011-05-23 10:00:03 +0100623notify_action:
Andy Green3182ece2013-01-20 17:08:31 +0800624#endif
Andy Green3b84c002011-03-06 13:14:42 +0000625
Andy Green9e4c2b62011-03-07 20:47:39 +0000626 if (wsi->mode == LWS_CONNMODE_WS_CLIENT)
627 n = LWS_CALLBACK_CLIENT_WRITEABLE;
628 else
629 n = LWS_CALLBACK_SERVER_WRITEABLE;
630
Andy Green706961d2013-01-17 16:50:35 +0800631 user_callback_handle_rxflow(wsi->protocol->callback, context,
632 wsi, (enum libwebsocket_callback_reasons) n, wsi->user_space, NULL, 0);
Andy Green3b84c002011-03-06 13:14:42 +0000633
634 return 0;
635}
636
637
638
Andy Greena41314f2011-05-23 10:00:03 +0100639void
640libwebsocket_service_timeout_check(struct libwebsocket_context *context,
641 struct libwebsocket *wsi, unsigned int sec)
642{
Andy Green3182ece2013-01-20 17:08:31 +0800643#ifndef LWS_NO_EXTENSIONS
Andy Greena41314f2011-05-23 10:00:03 +0100644 int n;
645
646 /*
647 * if extensions want in on it (eg, we are a mux parent)
648 * give them a chance to service child timeouts
649 */
650
651 for (n = 0; n < wsi->count_active_extensions; n++)
652 wsi->active_extensions[n]->callback(
653 context, wsi->active_extensions[n],
654 wsi, LWS_EXT_CALLBACK_1HZ,
655 wsi->active_extensions_user[n], NULL, sec);
656
Andy Green3182ece2013-01-20 17:08:31 +0800657#endif
Andy Greena41314f2011-05-23 10:00:03 +0100658 if (!wsi->pending_timeout)
659 return;
Andy Green6ee372f2012-04-09 15:09:01 +0800660
Andy Greena41314f2011-05-23 10:00:03 +0100661 /*
662 * if we went beyond the allowed time, kill the
663 * connection
664 */
665
666 if (sec > wsi->pending_timeout_limit) {
Andy Green43db0452013-01-10 19:50:35 +0800667 lwsl_info("TIMEDOUT WAITING\n");
Andy Greena41314f2011-05-23 10:00:03 +0100668 libwebsocket_close_and_free_session(context,
669 wsi, LWS_CLOSE_STATUS_NOSTATUS);
670 }
671}
672
Andy Green9f990342011-02-12 11:57:45 +0000673/**
674 * libwebsocket_service_fd() - Service polled socket with something waiting
Peter Hinz56885f32011-03-02 22:03:47 +0000675 * @context: Websocket context
Andy Green9f990342011-02-12 11:57:45 +0000676 * @pollfd: The pollfd entry describing the socket fd and which events
Andy Green6ee372f2012-04-09 15:09:01 +0800677 * happened.
Andy Green9f990342011-02-12 11:57:45 +0000678 *
Andy Green75006172013-01-22 12:32:11 +0800679 * This function takes a pollfd that has POLLIN or POLLOUT activity and
680 * services it according to the state of the associated struct libwebsocket.
681 *
682 * The one call deals with all "service" that might happen on a socket
683 * including listen accepts, http files as well as websocket protocol.
Andy Green9f990342011-02-12 11:57:45 +0000684 */
685
686int
Peter Hinz56885f32011-03-02 22:03:47 +0000687libwebsocket_service_fd(struct libwebsocket_context *context,
Andy Green0d338332011-02-12 11:57:43 +0000688 struct pollfd *pollfd)
Andy Greenb45993c2010-12-18 15:13:50 +0000689{
Andy Greena1ce6be2013-01-18 11:43:21 +0800690 struct libwebsocket *wsi;
Andy Greenb45993c2010-12-18 15:13:50 +0000691 int n;
Andy Green0d338332011-02-12 11:57:43 +0000692 int m;
Andy Greena71eafc2011-02-14 17:59:43 +0000693 struct timeval tv;
Andy Green6f520a52013-01-29 17:57:39 +0800694 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 1 +
695 MAX_USER_RX_BUFFER + LWS_SEND_BUFFER_POST_PADDING];
696
Andy Green3182ece2013-01-20 17:08:31 +0800697#ifndef LWS_NO_EXTENSIONS
Andy Green2366b1c2011-03-06 13:15:31 +0000698 int more = 1;
Andy Green3182ece2013-01-20 17:08:31 +0800699#endif
Andy Green98a717c2011-03-06 13:14:15 +0000700 struct lws_tokens eff_buf;
Andy Green03674a62013-01-16 11:47:40 +0800701#ifndef LWS_NO_CLIENT
Andy Green76f61e72013-01-16 11:53:05 +0800702 extern int lws_client_socket_service(struct libwebsocket_context *context, struct libwebsocket *wsi, struct pollfd *pollfd);
Andy Green03674a62013-01-16 11:47:40 +0800703#endif
Andy Greena1ce6be2013-01-18 11:43:21 +0800704#ifndef LWS_NO_SERVER
705 extern int lws_server_socket_service(struct libwebsocket_context *context, struct libwebsocket *wsi, struct pollfd *pollfd);
706#endif
Andy Greena71eafc2011-02-14 17:59:43 +0000707 /*
708 * you can call us with pollfd = NULL to just allow the once-per-second
709 * global timeout checks; if less than a second since the last check
710 * it returns immediately then.
711 */
712
713 gettimeofday(&tv, NULL);
714
Peter Hinz56885f32011-03-02 22:03:47 +0000715 if (context->last_timeout_check_s != tv.tv_sec) {
716 context->last_timeout_check_s = tv.tv_sec;
Andy Greena71eafc2011-02-14 17:59:43 +0000717
Andy Green24cba922013-01-19 13:56:10 +0800718 /* if our parent went down, don't linger around */
719 if (context->started_with_parent && kill(context->started_with_parent, 0) < 0)
720 kill(getpid(), SIGTERM);
721
Andy Greena71eafc2011-02-14 17:59:43 +0000722 /* global timeout check once per second */
723
Peter Hinz56885f32011-03-02 22:03:47 +0000724 for (n = 0; n < context->fds_count; n++) {
Andy Greendfb23042013-01-17 12:26:48 +0800725 struct libwebsocket *new_wsi = context->lws_lookup[context->fds[n].fd];
726 if (!new_wsi)
727 continue;
728 libwebsocket_service_timeout_check(context,
729 new_wsi, tv.tv_sec);
Andy Greena71eafc2011-02-14 17:59:43 +0000730 }
731 }
732
733 /* just here for timeout management? */
734
735 if (pollfd == NULL)
736 return 0;
737
738 /* no, here to service a socket descriptor */
739
Andy Green65b0e912013-01-16 07:59:47 +0800740 /*
741 * deal with listen service piggybacking
742 * every listen_service_modulo services of other fds, we
743 * sneak one in to service the listen socket if there's anything waiting
744 *
745 * To handle connection storms, as found in ab, if we previously saw a
746 * pending connection here, it causes us to check again next time.
747 */
748
749 if (context->listen_service_fd && pollfd->fd != context->listen_service_fd) {
750 context->listen_service_count++;
751 if (context->listen_service_extraseen ||
752 context->listen_service_count == context->listen_service_modulo) {
753 context->listen_service_count = 0;
754 m = 1;
755 if (context->listen_service_extraseen > 5)
756 m = 2;
757 while (m--) {
758 /* even with extpoll, we prepared this internal fds for listen */
759 n = poll(&context->fds[0], 1, 0);
760 if (n > 0) { /* there's a connection waiting for us */
761 libwebsocket_service_fd(context, &context->fds[0]);
762 context->listen_service_extraseen++;
763 } else {
764 if (context->listen_service_extraseen)
765 context->listen_service_extraseen--;
766 break;
767 }
768 }
769 }
770
771 }
772
773 /* okay, what we came here to do... */
774
Andy Greendfb23042013-01-17 12:26:48 +0800775 wsi = context->lws_lookup[pollfd->fd];
Andy Greend280b6e2013-01-15 13:40:23 +0800776 if (wsi == NULL) {
Andy Greendfb23042013-01-17 12:26:48 +0800777 if (pollfd->fd > 11)
778 lwsl_err("unexpected NULL wsi fd=%d fds_count=%d\n", pollfd->fd, context->fds_count);
Andy Greenfa3f4052012-10-07 20:40:35 +0800779 return 0;
Andy Greend280b6e2013-01-15 13:40:23 +0800780 }
Andy Green8f037e42010-12-19 22:13:26 +0000781
Andy Green0d338332011-02-12 11:57:43 +0000782 switch (wsi->mode) {
Andy Greend280b6e2013-01-15 13:40:23 +0800783
Andy Greena1ce6be2013-01-18 11:43:21 +0800784#ifndef LWS_NO_SERVER
Andy Greend280b6e2013-01-15 13:40:23 +0800785 case LWS_CONNMODE_HTTP_SERVING:
Andy Green0d338332011-02-12 11:57:43 +0000786 case LWS_CONNMODE_SERVER_LISTENER:
Andy Greene2160712013-01-28 12:19:10 +0800787 case LWS_CONNMODE_SSL_ACK_PENDING:
Andy Greena1ce6be2013-01-18 11:43:21 +0800788 return lws_server_socket_service(context, wsi, pollfd);
789#endif
Andy Greenbe93fef2011-02-14 20:25:43 +0000790
Andy Green0d338332011-02-12 11:57:43 +0000791 case LWS_CONNMODE_WS_SERVING:
792 case LWS_CONNMODE_WS_CLIENT:
793
794 /* handle session socket closed */
795
796 if (pollfd->revents & (POLLERR | POLLHUP)) {
797
Andy Green43db0452013-01-10 19:50:35 +0800798 lwsl_debug("Session Socket %p (fd=%d) dead\n",
Andy Green0d338332011-02-12 11:57:43 +0000799 (void *)wsi, pollfd->fd);
800
Peter Hinz56885f32011-03-02 22:03:47 +0000801 libwebsocket_close_and_free_session(context, wsi,
Andy Green687b0182011-02-26 11:04:01 +0000802 LWS_CLOSE_STATUS_NOSTATUS);
Andy Green040d2ef2013-01-16 13:40:43 +0800803 return 0;
Andy Greenb45993c2010-12-18 15:13:50 +0000804 }
805
Andy Green0d338332011-02-12 11:57:43 +0000806 /* the guy requested a callback when it was OK to write */
807
Andy Greenda527df2011-03-07 07:08:12 +0000808 if ((pollfd->revents & POLLOUT) &&
809 wsi->state == WSI_STATE_ESTABLISHED)
810 if (lws_handle_POLLOUT_event(context, wsi,
811 pollfd) < 0) {
812 libwebsocket_close_and_free_session(
813 context, wsi, LWS_CLOSE_STATUS_NORMAL);
Andy Green040d2ef2013-01-16 13:40:43 +0800814 return 0;
Andy Green3b84c002011-03-06 13:14:42 +0000815 }
Andy Green0d338332011-02-12 11:57:43 +0000816
Andy Green0d338332011-02-12 11:57:43 +0000817
818 /* any incoming data ready? */
819
820 if (!(pollfd->revents & POLLIN))
821 break;
822
Andy Greenb45993c2010-12-18 15:13:50 +0000823#ifdef LWS_OPENSSL_SUPPORT
David Galeano7ffbe1b2013-01-10 10:35:32 +0800824read_pending:
Andy Green0d338332011-02-12 11:57:43 +0000825 if (wsi->ssl)
Andy Green98a717c2011-03-06 13:14:15 +0000826 eff_buf.token_len = SSL_read(wsi->ssl, buf, sizeof buf);
Andy Greenb45993c2010-12-18 15:13:50 +0000827 else
828#endif
Andy Green98a717c2011-03-06 13:14:15 +0000829 eff_buf.token_len =
Andy Green72c34322011-04-16 10:46:21 +0100830 recv(pollfd->fd, buf, sizeof buf, 0);
Andy Greenb45993c2010-12-18 15:13:50 +0000831
Andy Green98a717c2011-03-06 13:14:15 +0000832 if (eff_buf.token_len < 0) {
Andy Green43db0452013-01-10 19:50:35 +0800833 lwsl_debug("Socket read returned %d\n",
Andy Green98a717c2011-03-06 13:14:15 +0000834 eff_buf.token_len);
Alon Levydc93b7f2012-10-19 11:21:57 +0200835 if (errno != EINTR && errno != EAGAIN)
Andy Green6ee372f2012-04-09 15:09:01 +0800836 libwebsocket_close_and_free_session(context,
837 wsi, LWS_CLOSE_STATUS_NOSTATUS);
Andy Green040d2ef2013-01-16 13:40:43 +0800838 return 0;
Andy Greenb45993c2010-12-18 15:13:50 +0000839 }
Andy Green98a717c2011-03-06 13:14:15 +0000840 if (!eff_buf.token_len) {
Peter Hinz56885f32011-03-02 22:03:47 +0000841 libwebsocket_close_and_free_session(context, wsi,
Andy Green6ee372f2012-04-09 15:09:01 +0800842 LWS_CLOSE_STATUS_NOSTATUS);
Andy Greenfa3f4052012-10-07 20:40:35 +0800843 return 0;
Andy Greenb45993c2010-12-18 15:13:50 +0000844 }
845
Andy Green98a717c2011-03-06 13:14:15 +0000846 /*
847 * give any active extensions a chance to munge the buffer
848 * before parse. We pass in a pointer to an lws_tokens struct
849 * prepared with the default buffer and content length that's in
850 * there. Rather than rewrite the default buffer, extensions
851 * that expect to grow the buffer can adapt .token to
852 * point to their own per-connection buffer in the extension
853 * user allocation. By default with no extensions or no
854 * extension callback handling, just the normal input buffer is
855 * used then so it is efficient.
856 */
Andy Greenb45993c2010-12-18 15:13:50 +0000857
Andy Green98a717c2011-03-06 13:14:15 +0000858 eff_buf.token = (char *)buf;
Andy Green3182ece2013-01-20 17:08:31 +0800859#ifndef LWS_NO_EXTENSIONS
Andy Green98a717c2011-03-06 13:14:15 +0000860 more = 1;
861 while (more) {
Andy Green0d338332011-02-12 11:57:43 +0000862
Andy Green98a717c2011-03-06 13:14:15 +0000863 more = 0;
864
865 for (n = 0; n < wsi->count_active_extensions; n++) {
Andy Green46c2ea02011-03-22 09:04:01 +0000866 m = wsi->active_extensions[n]->callback(context,
867 wsi->active_extensions[n], wsi,
Andy Green98a717c2011-03-06 13:14:15 +0000868 LWS_EXT_CALLBACK_PACKET_RX_PREPARSE,
Andy Green46c2ea02011-03-22 09:04:01 +0000869 wsi->active_extensions_user[n],
870 &eff_buf, 0);
Andy Green98a717c2011-03-06 13:14:15 +0000871 if (m < 0) {
Andy Green43db0452013-01-10 19:50:35 +0800872 lwsl_ext(
Andy Green6ee372f2012-04-09 15:09:01 +0800873 "Extension reports fatal error\n");
874 libwebsocket_close_and_free_session(
875 context, wsi,
876 LWS_CLOSE_STATUS_NOSTATUS);
Andy Green040d2ef2013-01-16 13:40:43 +0800877 return 0;
Andy Green98a717c2011-03-06 13:14:15 +0000878 }
879 if (m)
880 more = 1;
881 }
Andy Green3182ece2013-01-20 17:08:31 +0800882#endif
Andy Green98a717c2011-03-06 13:14:15 +0000883 /* service incoming data */
884
885 if (eff_buf.token_len) {
886 n = libwebsocket_read(context, wsi,
Andy Green6ee372f2012-04-09 15:09:01 +0800887 (unsigned char *)eff_buf.token,
888 eff_buf.token_len);
Andy Green98a717c2011-03-06 13:14:15 +0000889 if (n < 0)
890 /* we closed wsi */
Andy Green040d2ef2013-01-16 13:40:43 +0800891 return 0;
Andy Green98a717c2011-03-06 13:14:15 +0000892 }
Andy Green3182ece2013-01-20 17:08:31 +0800893#ifndef LWS_NO_EXTENSIONS
Andy Green98a717c2011-03-06 13:14:15 +0000894 eff_buf.token = NULL;
895 eff_buf.token_len = 0;
896 }
Andy Green3182ece2013-01-20 17:08:31 +0800897#endif
David Galeano7ffbe1b2013-01-10 10:35:32 +0800898
899#ifdef LWS_OPENSSL_SUPPORT
900 if (wsi->ssl && SSL_pending(wsi->ssl))
901 goto read_pending;
902#endif
Andy Green98a717c2011-03-06 13:14:15 +0000903 break;
Andy Green76f61e72013-01-16 11:53:05 +0800904
905 default:
Andy Green03674a62013-01-16 11:47:40 +0800906#ifdef LWS_NO_CLIENT
907 break;
908#else
Andy Green76f61e72013-01-16 11:53:05 +0800909 return lws_client_socket_service(context, wsi, pollfd);
Andy Green03674a62013-01-16 11:47:40 +0800910#endif
Andy Greenb45993c2010-12-18 15:13:50 +0000911 }
912
913 return 0;
914}
915
Andy Green0d338332011-02-12 11:57:43 +0000916
Andy Green6964bb52011-01-23 16:50:33 +0000917/**
918 * libwebsocket_context_destroy() - Destroy the websocket context
Peter Hinz56885f32011-03-02 22:03:47 +0000919 * @context: Websocket context
Andy Green6964bb52011-01-23 16:50:33 +0000920 *
921 * This function closes any active connections and then frees the
922 * context. After calling this, any further use of the context is
923 * undefined.
924 */
925void
Peter Hinz56885f32011-03-02 22:03:47 +0000926libwebsocket_context_destroy(struct libwebsocket_context *context)
Andy Green6964bb52011-01-23 16:50:33 +0000927{
Andy Green3182ece2013-01-20 17:08:31 +0800928#ifndef LWS_NO_EXTENSIONS
Andy Green0d338332011-02-12 11:57:43 +0000929 int n;
930 int m;
Andy Greena41314f2011-05-23 10:00:03 +0100931 struct libwebsocket_extension *ext;
Andy Green6964bb52011-01-23 16:50:33 +0000932
Andy Greend636e352013-01-29 12:36:17 +0800933#ifdef LWS_LATENCY
934 if (context->worst_latency_info[0])
935 lwsl_notice("Worst latency: %s\n", context->worst_latency_info);
936#endif
937
Andy Greendfb23042013-01-17 12:26:48 +0800938 for (n = 0; n < context->fds_count; n++) {
939 struct libwebsocket *wsi = context->lws_lookup[context->fds[n].fd];
940 libwebsocket_close_and_free_session(context,
941 wsi, LWS_CLOSE_STATUS_GOINGAWAY);
942 }
Andy Green6964bb52011-01-23 16:50:33 +0000943
Andy Greena41314f2011-05-23 10:00:03 +0100944 /*
945 * give all extensions a chance to clean up any per-context
946 * allocations they might have made
947 */
948
949 ext = context->extensions;
950 m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_DESTRUCT;
951 if (context->listen_port)
952 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_DESTRUCT;
Paulo Roberto Urio1f680ab2012-06-04 08:40:28 +0800953 while (ext && ext->callback) {
Aaron Zinman4550f1d2013-01-10 12:35:18 +0800954 ext->callback(context, ext, NULL, (enum libwebsocket_extension_callback_reasons)m, NULL, NULL, 0);
Andy Greena41314f2011-05-23 10:00:03 +0100955 ext++;
956 }
Andy Green3182ece2013-01-20 17:08:31 +0800957#endif
Andy Greena41314f2011-05-23 10:00:03 +0100958
Peter Hinz56885f32011-03-02 22:03:47 +0000959#ifdef WIN32
960#else
961 close(context->fd_random);
Andy Green6964bb52011-01-23 16:50:33 +0000962#endif
963
Peter Hinz56885f32011-03-02 22:03:47 +0000964#ifdef LWS_OPENSSL_SUPPORT
965 if (context->ssl_ctx)
966 SSL_CTX_free(context->ssl_ctx);
967 if (context->ssl_client_ctx)
968 SSL_CTX_free(context->ssl_client_ctx);
969#endif
970
971 free(context);
972
973#ifdef WIN32
974 WSACleanup();
975#endif
Andy Green6964bb52011-01-23 16:50:33 +0000976}
977
Andy Greend88146d2013-01-22 12:40:35 +0800978/**
979 * libwebsocket_context_user() - get the user data associated with the whole context
980 * @context: Websocket context
981 *
982 * This returns the optional user allocation that can be attached to
983 * the context the sockets live in at context_create time. It's a way
984 * to let all sockets serviced in the same context share data without
985 * using globals statics in the user code.
986 */
987
988
Alon Levy0291eb32012-10-19 11:21:56 +0200989LWS_EXTERN void *
990libwebsocket_context_user(struct libwebsocket_context *context)
991{
992 return context->user_space;
993}
994
Andy Green6964bb52011-01-23 16:50:33 +0000995/**
996 * libwebsocket_service() - Service any pending websocket activity
Peter Hinz56885f32011-03-02 22:03:47 +0000997 * @context: Websocket context
Andy Green6964bb52011-01-23 16:50:33 +0000998 * @timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
999 * service otherwise block and service immediately, returning
1000 * after the timeout if nothing needed service.
1001 *
1002 * This function deals with any pending websocket traffic, for three
1003 * kinds of event. It handles these events on both server and client
1004 * types of connection the same.
1005 *
1006 * 1) Accept new connections to our context's server
1007 *
Andy Green6f520a52013-01-29 17:57:39 +08001008 * 2) Call the receive callback for incoming frame data received by
Andy Green6964bb52011-01-23 16:50:33 +00001009 * server or client connections.
1010 *
1011 * You need to call this service function periodically to all the above
1012 * functions to happen; if your application is single-threaded you can
1013 * just call it in your main event loop.
1014 *
1015 * Alternatively you can fork a new process that asynchronously handles
1016 * calling this service in a loop. In that case you are happy if this
1017 * call blocks your thread until it needs to take care of something and
1018 * would call it with a large nonzero timeout. Your loop then takes no
1019 * CPU while there is nothing happening.
1020 *
1021 * If you are calling it in a single-threaded app, you don't want it to
1022 * wait around blocking other things in your loop from happening, so you
1023 * would call it with a timeout_ms of 0, so it returns immediately if
1024 * nothing is pending, or as soon as it services whatever was pending.
1025 */
1026
Andy Greenb45993c2010-12-18 15:13:50 +00001027
Andy Greene92cd172011-01-19 13:11:55 +00001028int
Peter Hinz56885f32011-03-02 22:03:47 +00001029libwebsocket_service(struct libwebsocket_context *context, int timeout_ms)
Andy Greene92cd172011-01-19 13:11:55 +00001030{
1031 int n;
Andy Greene92cd172011-01-19 13:11:55 +00001032
1033 /* stay dead once we are dead */
1034
Peter Hinz56885f32011-03-02 22:03:47 +00001035 if (context == NULL)
Andy Greene92cd172011-01-19 13:11:55 +00001036 return 1;
1037
Andy Green0d338332011-02-12 11:57:43 +00001038 /* wait for something to need service */
Andy Green4739e5c2011-01-22 12:51:57 +00001039
Peter Hinz56885f32011-03-02 22:03:47 +00001040 n = poll(context->fds, context->fds_count, timeout_ms);
Andy Green3221f922011-02-12 13:14:11 +00001041 if (n == 0) /* poll timeout */
1042 return 0;
Andy Greene92cd172011-01-19 13:11:55 +00001043
Andy Greendfb23042013-01-17 12:26:48 +08001044 if (n < 0)
Andy Green3928f612012-07-20 12:58:38 +08001045 return -1;
Andy Greene92cd172011-01-19 13:11:55 +00001046
Andy Greendfb23042013-01-17 12:26:48 +08001047 /* any socket with events to service? */
Andy Greene92cd172011-01-19 13:11:55 +00001048
Peter Hinz56885f32011-03-02 22:03:47 +00001049 for (n = 0; n < context->fds_count; n++)
1050 if (context->fds[n].revents)
Andy Green3928f612012-07-20 12:58:38 +08001051 if (libwebsocket_service_fd(context,
1052 &context->fds[n]) < 0)
1053 return -1;
Andy Greene92cd172011-01-19 13:11:55 +00001054 return 0;
Andy Greene92cd172011-01-19 13:11:55 +00001055}
1056
Andy Green3182ece2013-01-20 17:08:31 +08001057#ifndef LWS_NO_EXTENSIONS
Andy Greena41314f2011-05-23 10:00:03 +01001058int
1059lws_any_extension_handled(struct libwebsocket_context *context,
Andy Green6ee372f2012-04-09 15:09:01 +08001060 struct libwebsocket *wsi,
1061 enum libwebsocket_extension_callback_reasons r,
Andy Greena41314f2011-05-23 10:00:03 +01001062 void *v, size_t len)
1063{
1064 int n;
1065 int handled = 0;
1066
1067 /* maybe an extension will take care of it for us */
1068
1069 for (n = 0; n < wsi->count_active_extensions && !handled; n++) {
1070 if (!wsi->active_extensions[n]->callback)
1071 continue;
1072
1073 handled |= wsi->active_extensions[n]->callback(context,
1074 wsi->active_extensions[n], wsi,
1075 r, wsi->active_extensions_user[n], v, len);
1076 }
1077
1078 return handled;
1079}
1080
1081
1082void *
1083lws_get_extension_user_matching_ext(struct libwebsocket *wsi,
Andy Green6ee372f2012-04-09 15:09:01 +08001084 struct libwebsocket_extension *ext)
Andy Greena41314f2011-05-23 10:00:03 +01001085{
1086 int n = 0;
1087
Andy Green68b45042011-05-25 21:41:57 +01001088 if (wsi == NULL)
1089 return NULL;
1090
Andy Greena41314f2011-05-23 10:00:03 +01001091 while (n < wsi->count_active_extensions) {
1092 if (wsi->active_extensions[n] != ext) {
1093 n++;
1094 continue;
1095 }
1096 return wsi->active_extensions_user[n];
1097 }
1098
1099 return NULL;
1100}
Andy Green3182ece2013-01-20 17:08:31 +08001101#endif
Andy Greena41314f2011-05-23 10:00:03 +01001102
Andy Green90c7cbc2011-01-27 06:26:52 +00001103/**
1104 * libwebsocket_callback_on_writable() - Request a callback when this socket
1105 * becomes able to be written to without
1106 * blocking
Andy Green32375b72011-02-19 08:32:53 +00001107 *
Peter Hinz56885f32011-03-02 22:03:47 +00001108 * @context: libwebsockets context
Andy Green90c7cbc2011-01-27 06:26:52 +00001109 * @wsi: Websocket connection instance to get callback for
1110 */
1111
1112int
Peter Hinz56885f32011-03-02 22:03:47 +00001113libwebsocket_callback_on_writable(struct libwebsocket_context *context,
Andy Green6ee372f2012-04-09 15:09:01 +08001114 struct libwebsocket *wsi)
Andy Green90c7cbc2011-01-27 06:26:52 +00001115{
Andy Green3182ece2013-01-20 17:08:31 +08001116#ifndef LWS_NO_EXTENSIONS
Andy Green90c7cbc2011-01-27 06:26:52 +00001117 int n;
Andy Greena41314f2011-05-23 10:00:03 +01001118 int handled = 0;
1119
1120 /* maybe an extension will take care of it for us */
1121
1122 for (n = 0; n < wsi->count_active_extensions; n++) {
1123 if (!wsi->active_extensions[n]->callback)
1124 continue;
1125
1126 handled |= wsi->active_extensions[n]->callback(context,
1127 wsi->active_extensions[n], wsi,
1128 LWS_EXT_CALLBACK_REQUEST_ON_WRITEABLE,
1129 wsi->active_extensions_user[n], NULL, 0);
1130 }
1131
1132 if (handled)
1133 return 1;
Andy Green3182ece2013-01-20 17:08:31 +08001134#endif
Andy Greendfb23042013-01-17 12:26:48 +08001135 if (wsi->position_in_fds_table < 0) {
Andy Green43db0452013-01-10 19:50:35 +08001136 lwsl_err("libwebsocket_callback_on_writable: "
Andy Green6ee372f2012-04-09 15:09:01 +08001137 "failed to find socket %d\n", wsi->sock);
Andy Greendfb23042013-01-17 12:26:48 +08001138 return -1;
1139 }
1140
1141 context->fds[wsi->position_in_fds_table].events |= POLLOUT;
Andy Greena41314f2011-05-23 10:00:03 +01001142
Andy Green3221f922011-02-12 13:14:11 +00001143 /* external POLL support via protocol 0 */
Peter Hinz56885f32011-03-02 22:03:47 +00001144 context->protocols[0].callback(context, wsi,
Andy Green3221f922011-02-12 13:14:11 +00001145 LWS_CALLBACK_SET_MODE_POLL_FD,
1146 (void *)(long)wsi->sock, NULL, POLLOUT);
1147
Andy Green90c7cbc2011-01-27 06:26:52 +00001148 return 1;
1149}
1150
1151/**
1152 * libwebsocket_callback_on_writable_all_protocol() - Request a callback for
1153 * all connections using the given protocol when it
1154 * becomes possible to write to each socket without
1155 * blocking in turn.
1156 *
1157 * @protocol: Protocol whose connections will get callbacks
1158 */
1159
1160int
1161libwebsocket_callback_on_writable_all_protocol(
1162 const struct libwebsocket_protocols *protocol)
1163{
Peter Hinz56885f32011-03-02 22:03:47 +00001164 struct libwebsocket_context *context = protocol->owning_server;
Andy Green90c7cbc2011-01-27 06:26:52 +00001165 int n;
Andy Green0d338332011-02-12 11:57:43 +00001166 struct libwebsocket *wsi;
Andy Green90c7cbc2011-01-27 06:26:52 +00001167
Andy Greendfb23042013-01-17 12:26:48 +08001168 for (n = 0; n < context->fds_count; n++) {
1169 wsi = context->lws_lookup[context->fds[n].fd];
1170 if (!wsi)
1171 continue;
1172 if (wsi->protocol == protocol)
1173 libwebsocket_callback_on_writable(context, wsi);
Andy Green0d338332011-02-12 11:57:43 +00001174 }
Andy Green90c7cbc2011-01-27 06:26:52 +00001175
1176 return 0;
1177}
1178
Andy Greenbe93fef2011-02-14 20:25:43 +00001179/**
1180 * libwebsocket_set_timeout() - marks the wsi as subject to a timeout
1181 *
1182 * You will not need this unless you are doing something special
1183 *
1184 * @wsi: Websocket connection instance
1185 * @reason: timeout reason
1186 * @secs: how many seconds
1187 */
1188
1189void
1190libwebsocket_set_timeout(struct libwebsocket *wsi,
1191 enum pending_timeout reason, int secs)
1192{
1193 struct timeval tv;
1194
1195 gettimeofday(&tv, NULL);
1196
1197 wsi->pending_timeout_limit = tv.tv_sec + secs;
1198 wsi->pending_timeout = reason;
1199}
1200
Andy Greena6cbece2011-01-27 20:06:03 +00001201
1202/**
1203 * libwebsocket_get_socket_fd() - returns the socket file descriptor
1204 *
1205 * You will not need this unless you are doing something special
1206 *
1207 * @wsi: Websocket connection instance
1208 */
1209
1210int
1211libwebsocket_get_socket_fd(struct libwebsocket *wsi)
1212{
1213 return wsi->sock;
1214}
1215
Andy Greend636e352013-01-29 12:36:17 +08001216#ifdef LWS_LATENCY
1217void
1218lws_latency(struct libwebsocket_context *context, struct libwebsocket *wsi, const char *action, int ret, int completed)
1219{
1220 struct timeval tv;
1221 unsigned long u;
1222 char buf[256];
1223
1224 gettimeofday(&tv, NULL);
1225
1226 u = (tv.tv_sec * 1000000) + tv.tv_usec;
1227
1228 if (action) {
1229 if (completed) {
1230 if (wsi->action_start == wsi->latency_start)
1231 sprintf(buf, "Completion first try lat %luus: %p: ret %d: %s\n", u - wsi->latency_start, (void *)wsi, ret, action);
1232 else
1233 sprintf(buf, "Completion %luus: lat %luus: %p: ret %d: %s\n", u - wsi->action_start, u - wsi->latency_start, (void *)wsi, ret, action);
1234 wsi->action_start = 0;
1235 } else
1236 sprintf(buf, "lat %luus: %p: ret %d: %s\n", u - wsi->latency_start, (void *)wsi, ret, action);
1237 if (u - wsi->latency_start > context->worst_latency) {
1238 context->worst_latency = u - wsi->latency_start;
1239 strcpy(context->worst_latency_info, buf);
1240 }
1241 lwsl_latency("%s", buf);
1242 } else {
1243 wsi->latency_start = u;
1244 if (!wsi->action_start)
1245 wsi->action_start = u;
1246 }
1247}
1248#endif
1249
Andy Greena1ce6be2013-01-18 11:43:21 +08001250#ifdef LWS_NO_SERVER
1251int
1252_libwebsocket_rx_flow_control(struct libwebsocket *wsi)
1253{
1254 return 0;
1255}
1256#else
Andy Green706961d2013-01-17 16:50:35 +08001257int
1258_libwebsocket_rx_flow_control(struct libwebsocket *wsi)
1259{
1260 struct libwebsocket_context *context = wsi->protocol->owning_server;
1261 int n;
1262
Andy Green623a98d2013-01-21 11:04:23 +08001263 if (!(wsi->u.ws.rxflow_change_to & 2))
Andy Green706961d2013-01-17 16:50:35 +08001264 return 0;
1265
Andy Green623a98d2013-01-21 11:04:23 +08001266 wsi->u.ws.rxflow_change_to &= ~2;
Andy Green706961d2013-01-17 16:50:35 +08001267
Andy Green623a98d2013-01-21 11:04:23 +08001268 lwsl_info("rxflow: wsi %p change_to %d\n", wsi, wsi->u.ws.rxflow_change_to);
Andy Green706961d2013-01-17 16:50:35 +08001269
1270 /* if we're letting it come again, did we interrupt anything? */
Andy Green623a98d2013-01-21 11:04:23 +08001271 if ((wsi->u.ws.rxflow_change_to & 1) && wsi->u.ws.rxflow_buffer) {
Andy Green706961d2013-01-17 16:50:35 +08001272 n = libwebsocket_interpret_incoming_packet(wsi, NULL, 0);
1273 if (n < 0) {
1274 libwebsocket_close_and_free_session(context, wsi, LWS_CLOSE_STATUS_NOSTATUS);
1275 return -1;
1276 }
1277 if (n)
1278 /* oh he stuck again, do nothing */
1279 return 0;
1280 }
1281
Andy Green623a98d2013-01-21 11:04:23 +08001282 if (wsi->u.ws.rxflow_change_to & 1)
Andy Green706961d2013-01-17 16:50:35 +08001283 context->fds[wsi->position_in_fds_table].events |= POLLIN;
1284 else
1285 context->fds[wsi->position_in_fds_table].events &= ~POLLIN;
1286
Andy Green623a98d2013-01-21 11:04:23 +08001287 if (wsi->u.ws.rxflow_change_to & 1)
Andy Green706961d2013-01-17 16:50:35 +08001288 /* external POLL support via protocol 0 */
1289 context->protocols[0].callback(context, wsi,
1290 LWS_CALLBACK_SET_MODE_POLL_FD,
1291 (void *)(long)wsi->sock, NULL, POLLIN);
1292 else
1293 /* external POLL support via protocol 0 */
1294 context->protocols[0].callback(context, wsi,
1295 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
1296 (void *)(long)wsi->sock, NULL, POLLIN);
1297
1298 return 1;
1299}
Andy Greena1ce6be2013-01-18 11:43:21 +08001300#endif
Andy Green706961d2013-01-17 16:50:35 +08001301
Andy Green90c7cbc2011-01-27 06:26:52 +00001302/**
1303 * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
1304 * receieved packets.
1305 *
1306 * If the output side of a server process becomes choked, this allows flow
1307 * control for the input side.
1308 *
1309 * @wsi: Websocket connection instance to get callback for
1310 * @enable: 0 = disable read servicing for this connection, 1 = enable
1311 */
1312
1313int
1314libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
1315{
Andy Green623a98d2013-01-21 11:04:23 +08001316 wsi->u.ws.rxflow_change_to = 2 | !!enable;
Andy Green90c7cbc2011-01-27 06:26:52 +00001317
Andy Green706961d2013-01-17 16:50:35 +08001318 return 0;
Andy Green90c7cbc2011-01-27 06:26:52 +00001319}
1320
Andy Green706961d2013-01-17 16:50:35 +08001321
Andy Green2ac5a6f2011-01-28 10:00:18 +00001322/**
1323 * libwebsocket_canonical_hostname() - returns this host's hostname
1324 *
1325 * This is typically used by client code to fill in the host parameter
1326 * when making a client connection. You can only call it after the context
1327 * has been created.
1328 *
Peter Hinz56885f32011-03-02 22:03:47 +00001329 * @context: Websocket context
Andy Green2ac5a6f2011-01-28 10:00:18 +00001330 */
1331
1332
1333extern const char *
Peter Hinz56885f32011-03-02 22:03:47 +00001334libwebsocket_canonical_hostname(struct libwebsocket_context *context)
Andy Green2ac5a6f2011-01-28 10:00:18 +00001335{
Peter Hinz56885f32011-03-02 22:03:47 +00001336 return (const char *)context->canonical_hostname;
Andy Green2ac5a6f2011-01-28 10:00:18 +00001337}
1338
1339
Andy Green90c7cbc2011-01-27 06:26:52 +00001340static void sigpipe_handler(int x)
1341{
1342}
1343
Andy Green6901cb32011-02-21 08:06:47 +00001344#ifdef LWS_OPENSSL_SUPPORT
1345static int
1346OpenSSL_verify_callback(int preverify_ok, X509_STORE_CTX *x509_ctx)
1347{
1348
1349 SSL *ssl;
1350 int n;
Andy Green2e24da02011-03-05 16:12:04 +00001351 struct libwebsocket_context *context;
Andy Green6901cb32011-02-21 08:06:47 +00001352
1353 ssl = X509_STORE_CTX_get_ex_data(x509_ctx,
1354 SSL_get_ex_data_X509_STORE_CTX_idx());
1355
1356 /*
Andy Green2e24da02011-03-05 16:12:04 +00001357 * !!! nasty openssl requires the index to come as a library-scope
1358 * static
Andy Green6901cb32011-02-21 08:06:47 +00001359 */
Andy Green2e24da02011-03-05 16:12:04 +00001360 context = SSL_get_ex_data(ssl, openssl_websocket_private_data_index);
Andy Green6ee372f2012-04-09 15:09:01 +08001361
Peter Hinz56885f32011-03-02 22:03:47 +00001362 n = context->protocols[0].callback(NULL, NULL,
Andy Green6901cb32011-02-21 08:06:47 +00001363 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION,
1364 x509_ctx, ssl, preverify_ok);
1365
1366 /* convert return code from 0 = OK to 1 = OK */
1367
1368 if (!n)
1369 n = 1;
1370 else
1371 n = 0;
1372
1373 return n;
1374}
1375#endif
1376
Andy Green706961d2013-01-17 16:50:35 +08001377int user_callback_handle_rxflow(callback_function callback_function,
1378 struct libwebsocket_context * context,
1379 struct libwebsocket *wsi,
1380 enum libwebsocket_callback_reasons reason, void *user,
1381 void *in, size_t len)
1382{
1383 int n;
1384
1385 n = callback_function(context, wsi, reason, user, in, len);
1386 if (n < 0)
1387 return n;
1388
1389 _libwebsocket_rx_flow_control(wsi);
1390
1391 return 0;
1392}
1393
Andy Greenb45993c2010-12-18 15:13:50 +00001394
Andy Greenab990e42010-10-31 12:42:52 +00001395/**
Andy Green4739e5c2011-01-22 12:51:57 +00001396 * libwebsocket_create_context() - Create the websocket handler
1397 * @port: Port to listen on... you can use 0 to suppress listening on
Andy Green6964bb52011-01-23 16:50:33 +00001398 * any port, that's what you want if you are not running a
1399 * websocket server at all but just using it as a client
Peter Hinz56885f32011-03-02 22:03:47 +00001400 * @interf: NULL to bind the listen socket to all interfaces, or the
Andy Green32375b72011-02-19 08:32:53 +00001401 * interface name, eg, "eth2"
Andy Green4f3943a2010-11-12 10:44:16 +00001402 * @protocols: Array of structures listing supported protocols and a protocol-
Andy Green8f037e42010-12-19 22:13:26 +00001403 * specific callback for each one. The list is ended with an
1404 * entry that has a NULL callback pointer.
Andy Green6964bb52011-01-23 16:50:33 +00001405 * It's not const because we write the owning_server member
Andy Greenc5114822011-03-06 10:29:35 +00001406 * @extensions: NULL or array of libwebsocket_extension structs listing the
Andy Green3182ece2013-01-20 17:08:31 +08001407 * extensions this context supports. If you configured with
1408 * --without-extensions, you should give NULL here.
Andy Green3faa9c72010-11-08 17:03:03 +00001409 * @ssl_cert_filepath: If libwebsockets was compiled to use ssl, and you want
Andy Green8f037e42010-12-19 22:13:26 +00001410 * to listen using SSL, set to the filepath to fetch the
1411 * server cert from, otherwise NULL for unencrypted
Andy Green3faa9c72010-11-08 17:03:03 +00001412 * @ssl_private_key_filepath: filepath to private key if wanting SSL mode,
Andy Green8f037e42010-12-19 22:13:26 +00001413 * else ignored
David Galeano2f82be82013-01-09 16:25:54 +08001414 * @ssl_ca_filepath: CA certificate filepath or NULL
Andy Green3faa9c72010-11-08 17:03:03 +00001415 * @gid: group id to change to after setting listen socket, or -1.
1416 * @uid: user id to change to after setting listen socket, or -1.
Andy Greenbfb051f2011-02-09 08:49:14 +00001417 * @options: 0, or LWS_SERVER_OPTION_DEFEAT_CLIENT_MASK
Andy Green15e31f32012-10-19 18:36:28 +08001418 * @user: optional user pointer that can be recovered via the context
1419 * pointer using libwebsocket_context_user
Andy Green05464c62010-11-12 10:44:18 +00001420 *
Andy Green8f037e42010-12-19 22:13:26 +00001421 * This function creates the listening socket and takes care
1422 * of all initialization in one step.
1423 *
Andy Greene92cd172011-01-19 13:11:55 +00001424 * After initialization, it returns a struct libwebsocket_context * that
1425 * represents this server. After calling, user code needs to take care
1426 * of calling libwebsocket_service() with the context pointer to get the
1427 * server's sockets serviced. This can be done in the same process context
1428 * or a forked process, or another thread,
Andy Green05464c62010-11-12 10:44:18 +00001429 *
Andy Green8f037e42010-12-19 22:13:26 +00001430 * The protocol callback functions are called for a handful of events
1431 * including http requests coming in, websocket connections becoming
1432 * established, and data arriving; it's also called periodically to allow
1433 * async transmission.
1434 *
1435 * HTTP requests are sent always to the FIRST protocol in @protocol, since
1436 * at that time websocket protocol has not been negotiated. Other
1437 * protocols after the first one never see any HTTP callack activity.
1438 *
1439 * The server created is a simple http server by default; part of the
1440 * websocket standard is upgrading this http connection to a websocket one.
1441 *
1442 * This allows the same server to provide files like scripts and favicon /
1443 * images or whatever over http and dynamic data over websockets all in
1444 * one place; they're all handled in the user callback.
Andy Greenab990e42010-10-31 12:42:52 +00001445 */
Andy Green4ea60062010-10-30 12:15:07 +01001446
Andy Greene92cd172011-01-19 13:11:55 +00001447struct libwebsocket_context *
Peter Hinz56885f32011-03-02 22:03:47 +00001448libwebsocket_create_context(int port, const char *interf,
Andy Greenb45993c2010-12-18 15:13:50 +00001449 struct libwebsocket_protocols *protocols,
Andy Greend6e09112011-03-05 16:12:15 +00001450 struct libwebsocket_extension *extensions,
Andy Green8f037e42010-12-19 22:13:26 +00001451 const char *ssl_cert_filepath,
1452 const char *ssl_private_key_filepath,
David Galeano2f82be82013-01-09 16:25:54 +08001453 const char *ssl_ca_filepath,
Alon Levy0291eb32012-10-19 11:21:56 +02001454 int gid, int uid, unsigned int options,
David Galeano2f82be82013-01-09 16:25:54 +08001455 void *user)
Andy Greenff95d7a2010-10-28 22:36:01 +01001456{
1457 int n;
Andy Greenf5bc1302013-01-21 09:09:52 +08001458 struct sockaddr_in serv_addr;
Andy Green251f6fa2010-11-03 11:13:06 +00001459 int opt = 1;
Peter Hinz56885f32011-03-02 22:03:47 +00001460 struct libwebsocket_context *context = NULL;
Andy Green9659f372011-01-27 22:01:43 +00001461 char *p;
Andy Green0d338332011-02-12 11:57:43 +00001462 struct libwebsocket *wsi;
Andy Green3182ece2013-01-20 17:08:31 +08001463#ifndef LWS_NO_EXTENSIONS
1464 int m;
1465#endif
Andy Greenff95d7a2010-10-28 22:36:01 +01001466
Andy Green3faa9c72010-11-08 17:03:03 +00001467#ifdef LWS_OPENSSL_SUPPORT
Andy Greenf2f54d52010-11-15 22:08:00 +00001468 SSL_METHOD *method;
Andy Green3faa9c72010-11-08 17:03:03 +00001469 char ssl_err_buf[512];
Andy Green3faa9c72010-11-08 17:03:03 +00001470#endif
1471
Andy Greenb3a614a2013-01-19 13:08:17 +08001472 lwsl_notice("Initial logging level %d\n", log_level);
Andy Greenc0d6b632013-01-12 23:42:17 +08001473 lwsl_info(" LWS_MAX_HEADER_NAME_LENGTH: %u\n", LWS_MAX_HEADER_NAME_LENGTH);
1474 lwsl_info(" LWS_MAX_HEADER_LEN: %u\n", LWS_MAX_HEADER_LEN);
1475 lwsl_info(" LWS_INITIAL_HDR_ALLOC: %u\n", LWS_INITIAL_HDR_ALLOC);
1476 lwsl_info(" LWS_ADDITIONAL_HDR_ALLOC: %u\n", LWS_ADDITIONAL_HDR_ALLOC);
1477 lwsl_info(" MAX_USER_RX_BUFFER: %u\n", MAX_USER_RX_BUFFER);
Andy Greenc0d6b632013-01-12 23:42:17 +08001478 lwsl_info(" LWS_MAX_PROTOCOLS: %u\n", LWS_MAX_PROTOCOLS);
Andy Green3182ece2013-01-20 17:08:31 +08001479#ifndef LWS_NO_EXTENSIONS
Andy Greenc0d6b632013-01-12 23:42:17 +08001480 lwsl_info(" LWS_MAX_EXTENSIONS_ACTIVE: %u\n", LWS_MAX_EXTENSIONS_ACTIVE);
Andy Green3182ece2013-01-20 17:08:31 +08001481#else
1482 lwsl_notice(" Configured without extension support\n");
1483#endif
Andy Greenc0d6b632013-01-12 23:42:17 +08001484 lwsl_info(" SPEC_LATEST_SUPPORTED: %u\n", SPEC_LATEST_SUPPORTED);
1485 lwsl_info(" AWAITING_TIMEOUT: %u\n", AWAITING_TIMEOUT);
1486 lwsl_info(" CIPHERS_LIST_STRING: '%s'\n", CIPHERS_LIST_STRING);
1487 lwsl_info(" SYSTEM_RANDOM_FILEPATH: '%s'\n", SYSTEM_RANDOM_FILEPATH);
1488 lwsl_info(" LWS_MAX_ZLIB_CONN_BUFFER: %u\n", LWS_MAX_ZLIB_CONN_BUFFER);
Andy Green43db0452013-01-10 19:50:35 +08001489
Peter Hinz56885f32011-03-02 22:03:47 +00001490#ifdef _WIN32
1491 {
1492 WORD wVersionRequested;
1493 WSADATA wsaData;
1494 int err;
Andy Green6ee372f2012-04-09 15:09:01 +08001495 HMODULE wsdll;
Peter Hinz56885f32011-03-02 22:03:47 +00001496
1497 /* Use the MAKEWORD(lowbyte, highbyte) macro from Windef.h */
1498 wVersionRequested = MAKEWORD(2, 2);
1499
1500 err = WSAStartup(wVersionRequested, &wsaData);
1501 if (err != 0) {
1502 /* Tell the user that we could not find a usable */
1503 /* Winsock DLL. */
Andy Green43db0452013-01-10 19:50:35 +08001504 lwsl_err("WSAStartup failed with error: %d\n", err);
Peter Hinz56885f32011-03-02 22:03:47 +00001505 return NULL;
1506 }
David Galeano7b11fec2011-10-04 19:55:18 +08001507
Andy Green6ee372f2012-04-09 15:09:01 +08001508 /* default to a poll() made out of select() */
1509 poll = emulated_poll;
David Galeano7b11fec2011-10-04 19:55:18 +08001510
Andy Green6ee372f2012-04-09 15:09:01 +08001511 /* if windows socket lib available, use his WSAPoll */
David Galeanocb193682013-01-09 15:29:00 +08001512 wsdll = GetModuleHandle(_T("Ws2_32.dll"));
Andy Green6ee372f2012-04-09 15:09:01 +08001513 if (wsdll)
1514 poll = (PFNWSAPOLL)GetProcAddress(wsdll, "WSAPoll");
Peter Hinz56885f32011-03-02 22:03:47 +00001515 }
1516#endif
1517
Aaron Zinman4550f1d2013-01-10 12:35:18 +08001518 context = (struct libwebsocket_context *) malloc(sizeof(struct libwebsocket_context));
Peter Hinz56885f32011-03-02 22:03:47 +00001519 if (!context) {
Andy Green43db0452013-01-10 19:50:35 +08001520 lwsl_err("No memory for websocket context\n");
Andy Green90c7cbc2011-01-27 06:26:52 +00001521 return NULL;
1522 }
Andy Green35f332b2013-01-21 13:06:38 +08001523#ifndef LWS_NO_DAEMONIZE
Andy Green24cba922013-01-19 13:56:10 +08001524 extern int pid_daemon;
1525 context->started_with_parent = pid_daemon;
1526 lwsl_notice(" Started with daemon pid %d\n", pid_daemon);
1527#endif
1528
Peter Hinz56885f32011-03-02 22:03:47 +00001529 context->protocols = protocols;
1530 context->listen_port = port;
1531 context->http_proxy_port = 0;
1532 context->http_proxy_address[0] = '\0';
1533 context->options = options;
Andy Greendfb23042013-01-17 12:26:48 +08001534 /* to reduce this allocation, */
1535 context->max_fds = getdtablesize();
Andy Greenb3a614a2013-01-19 13:08:17 +08001536 lwsl_notice(" max fd tracked: %u\n", context->max_fds);
Andy Greena17c6922013-01-20 20:21:54 +08001537 lwsl_notice(" static allocation: %u bytes\n",
1538 (sizeof(struct pollfd) * context->max_fds) +
1539 (sizeof(struct libwebsocket *) * context->max_fds));
Andy Greendfb23042013-01-17 12:26:48 +08001540
1541 context->fds = (struct pollfd *)malloc(sizeof(struct pollfd) * context->max_fds);
1542 if (context->fds == NULL) {
1543 lwsl_err("Unable to allocate fds array for %d connections\n", context->max_fds);
1544 free(context);
1545 return NULL;
1546 }
Edwin van den Oetelaarf6eeabc2013-01-19 20:01:01 +08001547 context->lws_lookup = (struct libwebsocket **)malloc(sizeof(struct libwebsocket *) * context->max_fds);
Andy Greendfb23042013-01-17 12:26:48 +08001548 if (context->lws_lookup == NULL) {
1549 lwsl_err("Unable to allocate lws_lookup array for %d connections\n", context->max_fds);
1550 free(context->fds);
1551 free(context);
1552 return NULL;
1553 }
Andy Greena17c6922013-01-20 20:21:54 +08001554
Peter Hinz56885f32011-03-02 22:03:47 +00001555 context->fds_count = 0;
Andy Green3182ece2013-01-20 17:08:31 +08001556#ifndef LWS_NO_EXTENSIONS
Andy Greend6e09112011-03-05 16:12:15 +00001557 context->extensions = extensions;
Andy Green3182ece2013-01-20 17:08:31 +08001558#endif
Paulo Roberto Urio1e326632012-06-04 10:52:19 +08001559 context->last_timeout_check_s = 0;
Andy Greendfb23042013-01-17 12:26:48 +08001560 context->user_space = user;
Andy Green9659f372011-01-27 22:01:43 +00001561
Peter Hinz56885f32011-03-02 22:03:47 +00001562#ifdef WIN32
1563 context->fd_random = 0;
1564#else
1565 context->fd_random = open(SYSTEM_RANDOM_FILEPATH, O_RDONLY);
1566 if (context->fd_random < 0) {
Andy Greendfb23042013-01-17 12:26:48 +08001567 free(context);
Andy Green43db0452013-01-10 19:50:35 +08001568 lwsl_err("Unable to open random device %s %d\n",
Peter Hinz56885f32011-03-02 22:03:47 +00001569 SYSTEM_RANDOM_FILEPATH, context->fd_random);
Andy Green44eee682011-02-10 09:32:24 +00001570 return NULL;
1571 }
Peter Hinz56885f32011-03-02 22:03:47 +00001572#endif
Andy Green44eee682011-02-10 09:32:24 +00001573
Peter Hinz56885f32011-03-02 22:03:47 +00001574#ifdef LWS_OPENSSL_SUPPORT
1575 context->use_ssl = 0;
1576 context->ssl_ctx = NULL;
1577 context->ssl_client_ctx = NULL;
Andy Green2e24da02011-03-05 16:12:04 +00001578 openssl_websocket_private_data_index = 0;
Peter Hinz56885f32011-03-02 22:03:47 +00001579#endif
Andy Green2ac5a6f2011-01-28 10:00:18 +00001580
Andy Greena1ce6be2013-01-18 11:43:21 +08001581 strcpy(context->canonical_hostname, "unknown");
Andy Greena69f0512012-05-03 12:32:38 +08001582
Andy Greena1ce6be2013-01-18 11:43:21 +08001583#ifndef LWS_NO_SERVER
1584 if (!(options & LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME)) {
1585 struct sockaddr sa;
1586 char hostname[1024] = "";
Andy Green788c4a82012-10-22 12:29:57 +01001587
1588 /* find canonical hostname */
1589
1590 hostname[(sizeof hostname) - 1] = '\0';
1591 memset(&sa, 0, sizeof(sa));
1592 sa.sa_family = AF_INET;
1593 sa.sa_data[(sizeof sa.sa_data) - 1] = '\0';
1594 gethostname(hostname, (sizeof hostname) - 1);
1595
1596 n = 0;
1597
David Galeanoed3c8402013-01-10 10:45:24 +08001598 if (strlen(hostname) < sizeof(sa.sa_data) - 1) {
Andy Green788c4a82012-10-22 12:29:57 +01001599 strcpy(sa.sa_data, hostname);
Andy Green43db0452013-01-10 19:50:35 +08001600 // lwsl_debug("my host name is %s\n", sa.sa_data);
Andy Green788c4a82012-10-22 12:29:57 +01001601 n = getnameinfo(&sa, sizeof(sa), hostname,
1602 (sizeof hostname) - 1, NULL, 0, 0);
1603 }
1604
1605 if (!n) {
1606 strncpy(context->canonical_hostname, hostname,
1607 sizeof context->canonical_hostname - 1);
1608 context->canonical_hostname[
1609 sizeof context->canonical_hostname - 1] = '\0';
1610 } else
1611 strncpy(context->canonical_hostname, hostname,
1612 sizeof context->canonical_hostname - 1);
1613
Andy Greenb3a614a2013-01-19 13:08:17 +08001614 lwsl_notice(" canonical_hostname = %s\n", context->canonical_hostname);
Andy Greena69f0512012-05-03 12:32:38 +08001615 }
Andy Greena1ce6be2013-01-18 11:43:21 +08001616#endif
Andy Greena69f0512012-05-03 12:32:38 +08001617
Andy Green9659f372011-01-27 22:01:43 +00001618 /* split the proxy ads:port if given */
1619
1620 p = getenv("http_proxy");
1621 if (p) {
Peter Hinz56885f32011-03-02 22:03:47 +00001622 strncpy(context->http_proxy_address, p,
Andy Green6ee372f2012-04-09 15:09:01 +08001623 sizeof context->http_proxy_address - 1);
Peter Hinz56885f32011-03-02 22:03:47 +00001624 context->http_proxy_address[
1625 sizeof context->http_proxy_address - 1] = '\0';
Andy Green9659f372011-01-27 22:01:43 +00001626
Peter Hinz56885f32011-03-02 22:03:47 +00001627 p = strchr(context->http_proxy_address, ':');
Andy Green9659f372011-01-27 22:01:43 +00001628 if (p == NULL) {
Andy Green43db0452013-01-10 19:50:35 +08001629 lwsl_err("http_proxy needs to be ads:port\n");
Andy Green9659f372011-01-27 22:01:43 +00001630 return NULL;
1631 }
1632 *p = '\0';
Peter Hinz56885f32011-03-02 22:03:47 +00001633 context->http_proxy_port = atoi(p + 1);
Andy Green9659f372011-01-27 22:01:43 +00001634
Andy Greenb3a614a2013-01-19 13:08:17 +08001635 lwsl_notice(" Proxy %s:%u\n",
Peter Hinz56885f32011-03-02 22:03:47 +00001636 context->http_proxy_address,
1637 context->http_proxy_port);
Andy Green9659f372011-01-27 22:01:43 +00001638 }
Andy Green90c7cbc2011-01-27 06:26:52 +00001639
Andy Greena1ce6be2013-01-18 11:43:21 +08001640#ifndef LWS_NO_SERVER
Andy Green90c7cbc2011-01-27 06:26:52 +00001641 if (port) {
1642
Andy Green3faa9c72010-11-08 17:03:03 +00001643#ifdef LWS_OPENSSL_SUPPORT
Peter Hinz56885f32011-03-02 22:03:47 +00001644 context->use_ssl = ssl_cert_filepath != NULL &&
Andy Green90c7cbc2011-01-27 06:26:52 +00001645 ssl_private_key_filepath != NULL;
Peter Hinz56885f32011-03-02 22:03:47 +00001646 if (context->use_ssl)
Andy Greenb3a614a2013-01-19 13:08:17 +08001647 lwsl_notice(" Compiled with SSL support, using it\n");
Andy Green90c7cbc2011-01-27 06:26:52 +00001648 else
Andy Greenb3a614a2013-01-19 13:08:17 +08001649 lwsl_notice(" Compiled with SSL support, not using it\n");
Andy Green3faa9c72010-11-08 17:03:03 +00001650
Andy Green90c7cbc2011-01-27 06:26:52 +00001651#else
1652 if (ssl_cert_filepath != NULL &&
1653 ssl_private_key_filepath != NULL) {
Andy Greenb3a614a2013-01-19 13:08:17 +08001654 lwsl_notice(" Not compiled for OpenSSl support!\n");
Andy Greene92cd172011-01-19 13:11:55 +00001655 return NULL;
Andy Green3faa9c72010-11-08 17:03:03 +00001656 }
Andy Greenb3a614a2013-01-19 13:08:17 +08001657 lwsl_notice(" Compiled without SSL support, "
Andy Green90c7cbc2011-01-27 06:26:52 +00001658 "serving unencrypted\n");
1659#endif
Andy Greena17c6922013-01-20 20:21:54 +08001660
1661 lwsl_notice(" per-connection allocation: %u + headers\n", sizeof(struct libwebsocket));
Andy Green90c7cbc2011-01-27 06:26:52 +00001662 }
Andy Greena1ce6be2013-01-18 11:43:21 +08001663#endif
Andy Green90c7cbc2011-01-27 06:26:52 +00001664
1665 /* ignore SIGPIPE */
Peter Hinz56885f32011-03-02 22:03:47 +00001666#ifdef WIN32
1667#else
Andy Green90c7cbc2011-01-27 06:26:52 +00001668 signal(SIGPIPE, sigpipe_handler);
Peter Hinz56885f32011-03-02 22:03:47 +00001669#endif
Andy Green90c7cbc2011-01-27 06:26:52 +00001670
1671
1672#ifdef LWS_OPENSSL_SUPPORT
1673
1674 /* basic openssl init */
1675
1676 SSL_library_init();
1677
1678 OpenSSL_add_all_algorithms();
1679 SSL_load_error_strings();
1680
Andy Green2e24da02011-03-05 16:12:04 +00001681 openssl_websocket_private_data_index =
Andy Green6901cb32011-02-21 08:06:47 +00001682 SSL_get_ex_new_index(0, "libwebsockets", NULL, NULL, NULL);
1683
Andy Green90c7cbc2011-01-27 06:26:52 +00001684 /*
1685 * Firefox insists on SSLv23 not SSLv3
1686 * Konq disables SSLv2 by default now, SSLv23 works
1687 */
1688
1689 method = (SSL_METHOD *)SSLv23_server_method();
1690 if (!method) {
Andy Green43db0452013-01-10 19:50:35 +08001691 lwsl_err("problem creating ssl method: %s\n",
Andy Green90c7cbc2011-01-27 06:26:52 +00001692 ERR_error_string(ERR_get_error(), ssl_err_buf));
1693 return NULL;
1694 }
Peter Hinz56885f32011-03-02 22:03:47 +00001695 context->ssl_ctx = SSL_CTX_new(method); /* create context */
1696 if (!context->ssl_ctx) {
Andy Green43db0452013-01-10 19:50:35 +08001697 lwsl_err("problem creating ssl context: %s\n",
Andy Green90c7cbc2011-01-27 06:26:52 +00001698 ERR_error_string(ERR_get_error(), ssl_err_buf));
1699 return NULL;
1700 }
1701
David Galeanocc148e42013-01-10 10:18:59 +08001702#ifdef SSL_OP_NO_COMPRESSION
David Galeanoc72f6f92013-01-10 10:11:57 +08001703 SSL_CTX_set_options(context->ssl_ctx, SSL_OP_NO_COMPRESSION);
David Galeanocc148e42013-01-10 10:18:59 +08001704#endif
David Galeano77a677c2013-01-10 10:14:12 +08001705 SSL_CTX_set_options(context->ssl_ctx, SSL_OP_CIPHER_SERVER_PREFERENCE);
David Galeanof177f2a2013-01-10 10:15:19 +08001706 SSL_CTX_set_cipher_list(context->ssl_ctx, CIPHERS_LIST_STRING);
David Galeanoc72f6f92013-01-10 10:11:57 +08001707
Andy Greena1ce6be2013-01-18 11:43:21 +08001708#ifndef LWS_NO_CLIENT
1709
Andy Green90c7cbc2011-01-27 06:26:52 +00001710 /* client context */
Andy Green6ee372f2012-04-09 15:09:01 +08001711
1712 if (port == CONTEXT_PORT_NO_LISTEN) {
Peter Hinz56885f32011-03-02 22:03:47 +00001713 method = (SSL_METHOD *)SSLv23_client_method();
1714 if (!method) {
Andy Green43db0452013-01-10 19:50:35 +08001715 lwsl_err("problem creating ssl method: %s\n",
Peter Hinz56885f32011-03-02 22:03:47 +00001716 ERR_error_string(ERR_get_error(), ssl_err_buf));
1717 return NULL;
1718 }
1719 /* create context */
1720 context->ssl_client_ctx = SSL_CTX_new(method);
1721 if (!context->ssl_client_ctx) {
Andy Green43db0452013-01-10 19:50:35 +08001722 lwsl_err("problem creating ssl context: %s\n",
Peter Hinz56885f32011-03-02 22:03:47 +00001723 ERR_error_string(ERR_get_error(), ssl_err_buf));
1724 return NULL;
1725 }
Andy Green90c7cbc2011-01-27 06:26:52 +00001726
David Galeanocc148e42013-01-10 10:18:59 +08001727#ifdef SSL_OP_NO_COMPRESSION
David Galeanoc72f6f92013-01-10 10:11:57 +08001728 SSL_CTX_set_options(context->ssl_client_ctx, SSL_OP_NO_COMPRESSION);
David Galeanocc148e42013-01-10 10:18:59 +08001729#endif
David Galeano77a677c2013-01-10 10:14:12 +08001730 SSL_CTX_set_options(context->ssl_client_ctx, SSL_OP_CIPHER_SERVER_PREFERENCE);
David Galeanof177f2a2013-01-10 10:15:19 +08001731 SSL_CTX_set_cipher_list(context->ssl_client_ctx, CIPHERS_LIST_STRING);
David Galeanoc72f6f92013-01-10 10:11:57 +08001732
Peter Hinz56885f32011-03-02 22:03:47 +00001733 /* openssl init for cert verification (for client sockets) */
David Galeano2f82be82013-01-09 16:25:54 +08001734 if (!ssl_ca_filepath) {
1735 if (!SSL_CTX_load_verify_locations(
1736 context->ssl_client_ctx, NULL,
1737 LWS_OPENSSL_CLIENT_CERTS))
Andy Green43db0452013-01-10 19:50:35 +08001738 lwsl_err(
David Galeano2f82be82013-01-09 16:25:54 +08001739 "Unable to load SSL Client certs from %s "
1740 "(set by --with-client-cert-dir= in configure) -- "
1741 " client ssl isn't going to work",
1742 LWS_OPENSSL_CLIENT_CERTS);
1743 } else
1744 if (!SSL_CTX_load_verify_locations(
1745 context->ssl_client_ctx, ssl_ca_filepath,
1746 NULL))
Andy Green43db0452013-01-10 19:50:35 +08001747 lwsl_err(
David Galeano2f82be82013-01-09 16:25:54 +08001748 "Unable to load SSL Client certs "
1749 "file from %s -- client ssl isn't "
1750 "going to work", ssl_ca_filepath);
Peter Hinz56885f32011-03-02 22:03:47 +00001751
1752 /*
1753 * callback allowing user code to load extra verification certs
1754 * helping the client to verify server identity
1755 */
1756
1757 context->protocols[0].callback(context, NULL,
1758 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS,
1759 context->ssl_client_ctx, NULL, 0);
Andy Green90c7cbc2011-01-27 06:26:52 +00001760 }
Andy Greena1ce6be2013-01-18 11:43:21 +08001761#endif
Andy Green6ee372f2012-04-09 15:09:01 +08001762
Andy Greenc6bf2c22011-02-20 11:10:47 +00001763 /* as a server, are we requiring clients to identify themselves? */
1764
1765 if (options & LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT) {
1766
1767 /* absolutely require the client cert */
Andy Green6ee372f2012-04-09 15:09:01 +08001768
Peter Hinz56885f32011-03-02 22:03:47 +00001769 SSL_CTX_set_verify(context->ssl_ctx,
Andy Green6901cb32011-02-21 08:06:47 +00001770 SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
1771 OpenSSL_verify_callback);
Andy Greenc6bf2c22011-02-20 11:10:47 +00001772
1773 /*
1774 * give user code a chance to load certs into the server
1775 * allowing it to verify incoming client certs
1776 */
1777
Peter Hinz56885f32011-03-02 22:03:47 +00001778 context->protocols[0].callback(context, NULL,
Andy Greenc6bf2c22011-02-20 11:10:47 +00001779 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS,
Peter Hinz56885f32011-03-02 22:03:47 +00001780 context->ssl_ctx, NULL, 0);
Andy Greenc6bf2c22011-02-20 11:10:47 +00001781 }
1782
Peter Hinz56885f32011-03-02 22:03:47 +00001783 if (context->use_ssl) {
Andy Green90c7cbc2011-01-27 06:26:52 +00001784
1785 /* openssl init for server sockets */
1786
Andy Green3faa9c72010-11-08 17:03:03 +00001787 /* set the local certificate from CertFile */
David Galeano9b3d4b22013-01-10 10:11:21 +08001788 n = SSL_CTX_use_certificate_chain_file(context->ssl_ctx,
1789 ssl_cert_filepath);
Andy Green3faa9c72010-11-08 17:03:03 +00001790 if (n != 1) {
Andy Green43db0452013-01-10 19:50:35 +08001791 lwsl_err("problem getting cert '%s': %s\n",
Andy Green3faa9c72010-11-08 17:03:03 +00001792 ssl_cert_filepath,
1793 ERR_error_string(ERR_get_error(), ssl_err_buf));
Andy Greene92cd172011-01-19 13:11:55 +00001794 return NULL;
Andy Green3faa9c72010-11-08 17:03:03 +00001795 }
1796 /* set the private key from KeyFile */
Peter Hinz56885f32011-03-02 22:03:47 +00001797 if (SSL_CTX_use_PrivateKey_file(context->ssl_ctx,
1798 ssl_private_key_filepath, SSL_FILETYPE_PEM) != 1) {
Andy Green43db0452013-01-10 19:50:35 +08001799 lwsl_err("ssl problem getting key '%s': %s\n",
Andy Green018d8eb2010-11-08 21:04:23 +00001800 ssl_private_key_filepath,
1801 ERR_error_string(ERR_get_error(), ssl_err_buf));
Andy Greene92cd172011-01-19 13:11:55 +00001802 return NULL;
Andy Green3faa9c72010-11-08 17:03:03 +00001803 }
1804 /* verify private key */
Peter Hinz56885f32011-03-02 22:03:47 +00001805 if (!SSL_CTX_check_private_key(context->ssl_ctx)) {
Andy Green43db0452013-01-10 19:50:35 +08001806 lwsl_err("Private SSL key doesn't match cert\n");
Andy Greene92cd172011-01-19 13:11:55 +00001807 return NULL;
Andy Green3faa9c72010-11-08 17:03:03 +00001808 }
1809
1810 /* SSL is happy and has a cert it's content with */
1811 }
1812#endif
Andy Greenb45993c2010-12-18 15:13:50 +00001813
Andy Greendf736162011-01-18 15:39:02 +00001814 /* selftest */
1815
1816 if (lws_b64_selftest())
Andy Greene92cd172011-01-19 13:11:55 +00001817 return NULL;
Andy Greendf736162011-01-18 15:39:02 +00001818
Andy Greena1ce6be2013-01-18 11:43:21 +08001819#ifndef LWS_NO_SERVER
Andy Greenb45993c2010-12-18 15:13:50 +00001820 /* set up our external listening socket we serve on */
Andy Green8f037e42010-12-19 22:13:26 +00001821
Andy Green4739e5c2011-01-22 12:51:57 +00001822 if (port) {
Andy Greena1ce6be2013-01-18 11:43:21 +08001823 extern int interface_to_sa(const char *ifname, struct sockaddr_in *addr, size_t addrlen);
1824 int sockfd;
Andy Green8f037e42010-12-19 22:13:26 +00001825
Andy Green4739e5c2011-01-22 12:51:57 +00001826 sockfd = socket(AF_INET, SOCK_STREAM, 0);
1827 if (sockfd < 0) {
Andy Greenf7609e92013-01-14 13:10:55 +08001828 lwsl_err("ERROR opening socket\n");
Andy Green4739e5c2011-01-22 12:51:57 +00001829 return NULL;
1830 }
Andy Green775c0dd2010-10-29 14:15:22 +01001831
Andy Green4739e5c2011-01-22 12:51:57 +00001832 /* allow us to restart even if old sockets in TIME_WAIT */
Andy Green6ee372f2012-04-09 15:09:01 +08001833 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR,
1834 (const void *)&opt, sizeof(opt));
Andy Green6c939552011-03-08 08:56:57 +00001835
1836 /* Disable Nagle */
1837 opt = 1;
Andy Green6ee372f2012-04-09 15:09:01 +08001838 setsockopt(sockfd, IPPROTO_TCP, TCP_NODELAY,
1839 (const void *)&opt, sizeof(opt));
Andy Green6c939552011-03-08 08:56:57 +00001840
Andy Greene2160712013-01-28 12:19:10 +08001841 fcntl(sockfd, F_SETFL, O_NONBLOCK);
1842
Andy Green4739e5c2011-01-22 12:51:57 +00001843 bzero((char *) &serv_addr, sizeof(serv_addr));
1844 serv_addr.sin_family = AF_INET;
Peter Hinz56885f32011-03-02 22:03:47 +00001845 if (interf == NULL)
Andy Green32375b72011-02-19 08:32:53 +00001846 serv_addr.sin_addr.s_addr = INADDR_ANY;
1847 else
Peter Hinz56885f32011-03-02 22:03:47 +00001848 interface_to_sa(interf, &serv_addr,
Andy Green32375b72011-02-19 08:32:53 +00001849 sizeof(serv_addr));
Andy Green4739e5c2011-01-22 12:51:57 +00001850 serv_addr.sin_port = htons(port);
1851
1852 n = bind(sockfd, (struct sockaddr *) &serv_addr,
1853 sizeof(serv_addr));
1854 if (n < 0) {
Andy Green43db0452013-01-10 19:50:35 +08001855 lwsl_err("ERROR on binding to port %d (%d %d)\n",
Andy Green8f037e42010-12-19 22:13:26 +00001856 port, n, errno);
Andy Green41c58032013-01-12 13:21:08 +08001857 close(sockfd);
Andy Green4739e5c2011-01-22 12:51:57 +00001858 return NULL;
1859 }
Andy Green0d338332011-02-12 11:57:43 +00001860
Aaron Zinman4550f1d2013-01-10 12:35:18 +08001861 wsi = (struct libwebsocket *)malloc(sizeof(struct libwebsocket));
Andy Green41c58032013-01-12 13:21:08 +08001862 if (wsi == NULL) {
1863 lwsl_err("Out of mem\n");
1864 close(sockfd);
1865 return NULL;
1866 }
Aaron Zinman4550f1d2013-01-10 12:35:18 +08001867 memset(wsi, 0, sizeof (struct libwebsocket));
Andy Green0d338332011-02-12 11:57:43 +00001868 wsi->sock = sockfd;
Andy Green3182ece2013-01-20 17:08:31 +08001869#ifndef LWS_NO_EXTENSIONS
Andy Greend6e09112011-03-05 16:12:15 +00001870 wsi->count_active_extensions = 0;
Andy Green3182ece2013-01-20 17:08:31 +08001871#endif
Andy Green0d338332011-02-12 11:57:43 +00001872 wsi->mode = LWS_CONNMODE_SERVER_LISTENER;
Andy Greendfb23042013-01-17 12:26:48 +08001873
1874 insert_wsi_socket_into_fds(context, wsi);
Andy Green0d338332011-02-12 11:57:43 +00001875
Andy Green65b0e912013-01-16 07:59:47 +08001876 context->listen_service_modulo = LWS_LISTEN_SERVICE_MODULO;
1877 context->listen_service_count = 0;
1878 context->listen_service_fd = sockfd;
1879
Andy Greena824d182013-01-15 20:52:29 +08001880 listen(sockfd, LWS_SOMAXCONN);
Andy Greenb3a614a2013-01-19 13:08:17 +08001881 lwsl_notice(" Listening on port %d\n", port);
Andy Green8f037e42010-12-19 22:13:26 +00001882 }
Andy Greena1ce6be2013-01-18 11:43:21 +08001883#endif
Andy Greenb45993c2010-12-18 15:13:50 +00001884
Andy Green6ee372f2012-04-09 15:09:01 +08001885 /*
1886 * drop any root privs for this process
1887 * to listen on port < 1023 we would have needed root, but now we are
1888 * listening, we don't want the power for anything else
1889 */
Peter Hinz56885f32011-03-02 22:03:47 +00001890#ifdef WIN32
1891#else
Andy Green3faa9c72010-11-08 17:03:03 +00001892 if (gid != -1)
1893 if (setgid(gid))
Andy Green43db0452013-01-10 19:50:35 +08001894 lwsl_warn("setgid: %s\n", strerror(errno));
Andy Green3faa9c72010-11-08 17:03:03 +00001895 if (uid != -1)
1896 if (setuid(uid))
Andy Green43db0452013-01-10 19:50:35 +08001897 lwsl_warn("setuid: %s\n", strerror(errno));
Peter Hinz56885f32011-03-02 22:03:47 +00001898#endif
Andy Greenb45993c2010-12-18 15:13:50 +00001899
Andy Green6f520a52013-01-29 17:57:39 +08001900 /* initialize supported protocols */
Andy Greenb45993c2010-12-18 15:13:50 +00001901
Peter Hinz56885f32011-03-02 22:03:47 +00001902 for (context->count_protocols = 0;
1903 protocols[context->count_protocols].callback;
1904 context->count_protocols++) {
Andy Green2d1301e2011-05-24 10:14:41 +01001905
Andy Green43db0452013-01-10 19:50:35 +08001906 lwsl_parser(" Protocol: %s\n",
1907 protocols[context->count_protocols].name);
Andy Green2d1301e2011-05-24 10:14:41 +01001908
Peter Hinz56885f32011-03-02 22:03:47 +00001909 protocols[context->count_protocols].owning_server = context;
1910 protocols[context->count_protocols].protocol_index =
1911 context->count_protocols;
Andy Greenb45993c2010-12-18 15:13:50 +00001912 }
Andy Greenf5bc1302013-01-21 09:09:52 +08001913
Andy Green3182ece2013-01-20 17:08:31 +08001914#ifndef LWS_NO_EXTENSIONS
Andy Greena41314f2011-05-23 10:00:03 +01001915 /*
1916 * give all extensions a chance to create any per-context
1917 * allocations they need
1918 */
1919
1920 m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_CONSTRUCT;
1921 if (port)
1922 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_CONSTRUCT;
Andrew Chambersd5512172012-05-20 08:17:09 +08001923
1924 if (extensions) {
1925 while (extensions->callback) {
Andy Green43db0452013-01-10 19:50:35 +08001926 lwsl_ext(" Extension: %s\n", extensions->name);
Aaron Zinman4550f1d2013-01-10 12:35:18 +08001927 extensions->callback(context, extensions, NULL,
1928 (enum libwebsocket_extension_callback_reasons)m,
1929 NULL, NULL, 0);
Andrew Chambersd5512172012-05-20 08:17:09 +08001930 extensions++;
1931 }
Andy Greena41314f2011-05-23 10:00:03 +01001932 }
Andy Green3182ece2013-01-20 17:08:31 +08001933#endif
Peter Hinz56885f32011-03-02 22:03:47 +00001934 return context;
Andy Greene92cd172011-01-19 13:11:55 +00001935}
Andy Greenb45993c2010-12-18 15:13:50 +00001936
Andy Greenb45993c2010-12-18 15:13:50 +00001937/**
1938 * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
Andy Green8f037e42010-12-19 22:13:26 +00001939 * connection.
Andy Greenb45993c2010-12-18 15:13:50 +00001940 * @wsi: pointer to struct websocket you want to know the protocol of
1941 *
Andy Green8f037e42010-12-19 22:13:26 +00001942 *
Andy Green6f520a52013-01-29 17:57:39 +08001943 * Some apis can act on all live connections of a given protocol,
1944 * this is how you can get a pointer to the active protocol if needed.
Andy Greenb45993c2010-12-18 15:13:50 +00001945 */
Andy Greenab990e42010-10-31 12:42:52 +00001946
Andy Greenb45993c2010-12-18 15:13:50 +00001947const struct libwebsocket_protocols *
1948libwebsockets_get_protocol(struct libwebsocket *wsi)
1949{
1950 return wsi->protocol;
1951}
1952
Andy Green82c3d542011-03-07 21:16:31 +00001953int
1954libwebsocket_is_final_fragment(struct libwebsocket *wsi)
1955{
Andy Green623a98d2013-01-21 11:04:23 +08001956 return wsi->u.ws.final;
Andy Green82c3d542011-03-07 21:16:31 +00001957}
Alex Bligh49146db2011-11-07 17:19:25 +08001958
David Galeanoe2cf9922013-01-09 18:06:55 +08001959unsigned char
1960libwebsocket_get_reserved_bits(struct libwebsocket *wsi)
1961{
Andy Green623a98d2013-01-21 11:04:23 +08001962 return wsi->u.ws.rsv;
David Galeanoe2cf9922013-01-09 18:06:55 +08001963}
1964
Alex Bligh49146db2011-11-07 17:19:25 +08001965void *
1966libwebsocket_ensure_user_space(struct libwebsocket *wsi)
1967{
1968 /* allocate the per-connection user memory (if any) */
1969
1970 if (wsi->protocol->per_session_data_size && !wsi->user_space) {
1971 wsi->user_space = malloc(
1972 wsi->protocol->per_session_data_size);
1973 if (wsi->user_space == NULL) {
Andy Green43db0452013-01-10 19:50:35 +08001974 lwsl_err("Out of memory for conn user space\n");
Alex Bligh49146db2011-11-07 17:19:25 +08001975 return NULL;
1976 }
Andy Green6ee372f2012-04-09 15:09:01 +08001977 memset(wsi->user_space, 0,
1978 wsi->protocol->per_session_data_size);
Alex Bligh49146db2011-11-07 17:19:25 +08001979 }
1980 return wsi->user_space;
1981}
Andy Green43db0452013-01-10 19:50:35 +08001982
Andy Green0b319092013-01-19 11:17:56 +08001983static void lwsl_emit_stderr(int level, const char *line)
Andy Greende8f27a2013-01-12 09:17:42 +08001984{
Andy Green0b319092013-01-19 11:17:56 +08001985 char buf[300];
1986 struct timeval tv;
Andy Green0b319092013-01-19 11:17:56 +08001987 int n;
1988
1989 gettimeofday(&tv, NULL);
1990
1991 buf[0] = '\0';
1992 for (n = 0; n < LLL_COUNT; n++)
1993 if (level == (1 << n)) {
Andy Green058ba812013-01-19 11:32:18 +08001994 sprintf(buf, "[%ld:%04d] %s: ", tv.tv_sec,
Andy Green0b319092013-01-19 11:17:56 +08001995 (int)(tv.tv_usec / 100), log_level_names[n]);
1996 break;
1997 }
1998
1999 fprintf(stderr, "%s%s", buf, line);
Andy Greende8f27a2013-01-12 09:17:42 +08002000}
2001
Andy Greenc11db202013-01-19 11:12:16 +08002002void lwsl_emit_syslog(int level, const char *line)
2003{
2004 int syslog_level = LOG_DEBUG;
2005
2006 switch (level) {
2007 case LLL_ERR:
2008 syslog_level = LOG_ERR;
2009 break;
2010 case LLL_WARN:
2011 syslog_level = LOG_WARNING;
2012 break;
2013 case LLL_NOTICE:
2014 syslog_level = LOG_NOTICE;
2015 break;
2016 case LLL_INFO:
2017 syslog_level = LOG_INFO;
2018 break;
2019 }
Edwin van den Oetelaarf6eeabc2013-01-19 20:01:01 +08002020 syslog(syslog_level, "%s", line);
Andy Greenc11db202013-01-19 11:12:16 +08002021}
2022
Andy Green43db0452013-01-10 19:50:35 +08002023void _lws_log(int filter, const char *format, ...)
2024{
Andy Greende8f27a2013-01-12 09:17:42 +08002025 char buf[256];
Andy Green43db0452013-01-10 19:50:35 +08002026 va_list ap;
Andy Green43db0452013-01-10 19:50:35 +08002027
2028 if (!(log_level & filter))
2029 return;
2030
Andy Green43db0452013-01-10 19:50:35 +08002031 va_start(ap, format);
Andy Green0b319092013-01-19 11:17:56 +08002032 vsnprintf(buf, (sizeof buf), format, ap);
Andy Greende8f27a2013-01-12 09:17:42 +08002033 buf[(sizeof buf) - 1] = '\0';
2034 va_end(ap);
2035
Andy Green0b319092013-01-19 11:17:56 +08002036 lwsl_emit(filter, buf);
Andy Green43db0452013-01-10 19:50:35 +08002037}
2038
2039/**
2040 * lws_set_log_level() - Set the logging bitfield
2041 * @level: OR together the LLL_ debug contexts you want output from
Andy Greende8f27a2013-01-12 09:17:42 +08002042 * @log_emit_function: NULL to leave it as it is, or a user-supplied
2043 * function to perform log string emission instead of
2044 * the default stderr one.
Andy Green43db0452013-01-10 19:50:35 +08002045 *
Andy Greende8f27a2013-01-12 09:17:42 +08002046 * log level defaults to "err" and "warn" contexts enabled only and
2047 * emission on stderr.
Andy Green43db0452013-01-10 19:50:35 +08002048 */
2049
Andy Green058ba812013-01-19 11:32:18 +08002050void lws_set_log_level(int level, void (*log_emit_function)(int level, const char *line))
Andy Green43db0452013-01-10 19:50:35 +08002051{
2052 log_level = level;
Andy Greende8f27a2013-01-12 09:17:42 +08002053 if (log_emit_function)
2054 lwsl_emit = log_emit_function;
Andy Green43db0452013-01-10 19:50:35 +08002055}