blob: 946082028a6f232c5b8404d212bb889707c41b1b [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 Greenff95d7a2010-10-28 22:36:01 +010023
Andreas Pakulat68bd4bd2013-10-28 15:18:04 +010024#if defined(WIN32) || defined(_WIN32)
David Galeanocb193682013-01-09 15:29:00 +080025#include <tchar.h>
26#include <io.h>
Joakim Soderberg63ff1202013-02-11 17:52:23 +010027#include <mstcpip.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
Joakim Soderberg4c531232013-02-06 15:26:58 +090034#include <syslog.h>
Andy Green7627af52011-03-09 15:13:52 +000035#include <sys/un.h>
Andy Greena69f0512012-05-03 12:32:38 +080036#include <sys/socket.h>
37#include <netdb.h>
Peter Hinz56885f32011-03-02 22:03:47 +000038#endif
Andy Green2e24da02011-03-05 16:12:04 +000039
Andy Green3b3fa9e2013-12-25 16:34:37 +080040#include <sys/types.h>
41
Andy Green2e24da02011-03-05 16:12:04 +000042#ifdef LWS_OPENSSL_SUPPORT
43int openssl_websocket_private_data_index;
44#endif
45
Andy Greenaa6fc442012-04-12 13:26:49 +080046#ifdef __MINGW32__
47#include "../win32port/win32helpers/websock-w32.c"
48#else
49#ifdef __MINGW64__
50#include "../win32port/win32helpers/websock-w32.c"
51#endif
52#endif
53
Andy Green7b405452013-02-01 10:50:15 +080054#ifndef LWS_BUILD_HASH
55#define LWS_BUILD_HASH "unknown-build-hash"
56#endif
Andy Green3182ece2013-01-20 17:08:31 +080057
Andy Green7c19c342013-01-19 12:18:07 +080058static int log_level = LLL_ERR | LLL_WARN | LLL_NOTICE;
Andy Green058ba812013-01-19 11:32:18 +080059static void lwsl_emit_stderr(int level, const char *line);
60static void (*lwsl_emit)(int level, const char *line) = lwsl_emit_stderr;
61
Andy Green7b405452013-02-01 10:50:15 +080062static const char *library_version = LWS_LIBRARY_VERSION " " LWS_BUILD_HASH;
63
Andy Greenb5b23192013-02-11 17:13:32 +080064static const char * const log_level_names[] = {
Andy Green43db0452013-01-10 19:50:35 +080065 "ERR",
66 "WARN",
Andy Green7c19c342013-01-19 12:18:07 +080067 "NOTICE",
Andy Green43db0452013-01-10 19:50:35 +080068 "INFO",
69 "DEBUG",
70 "PARSER",
71 "HEADER",
72 "EXTENSION",
73 "CLIENT",
Andy Greend636e352013-01-29 12:36:17 +080074 "LATENCY",
Andy Green43db0452013-01-10 19:50:35 +080075};
76
Andy Greenb5b23192013-02-11 17:13:32 +080077#ifndef LWS_NO_CLIENT
78 extern int lws_client_socket_service(
79 struct libwebsocket_context *context,
80 struct libwebsocket *wsi, struct pollfd *pollfd);
81#endif
82#ifndef LWS_NO_SERVER
83 extern int lws_server_socket_service(
84 struct libwebsocket_context *context,
85 struct libwebsocket *wsi, struct pollfd *pollfd);
86#endif
87
Andy Green3b3fa9e2013-12-25 16:34:37 +080088
89#ifdef LWS_HAS_PPOLL
90/*
91 * set to the Thread ID that's doing the service loop just before entry to ppoll
92 * indicates service thread likely idling in ppoll()
93 * volatile because other threads may check it as part of processing for pollfd
94 * event change.
95 */
96static volatile int lws_idling_ppoll_tid;
97#endif
98
Andy Green7b405452013-02-01 10:50:15 +080099/**
100 * lws_get_library_version: get version and git hash library built from
101 *
102 * returns a const char * to a string like "1.1 178d78c"
103 * representing the library version followed by the git head hash it
104 * was built from
105 */
106
Peter Pentchev9a4fef72013-03-30 09:52:21 +0800107LWS_VISIBLE const char *
Andy Green7b405452013-02-01 10:50:15 +0800108lws_get_library_version(void)
109{
110 return library_version;
111}
112
Andy Green0d338332011-02-12 11:57:43 +0000113int
Andy Greenb5b23192013-02-11 17:13:32 +0800114insert_wsi_socket_into_fds(struct libwebsocket_context *context,
115 struct libwebsocket *wsi)
Andy Green0d338332011-02-12 11:57:43 +0000116{
Andy Greendfb23042013-01-17 12:26:48 +0800117 if (context->fds_count >= context->max_fds) {
Andy Greenb5b23192013-02-11 17:13:32 +0800118 lwsl_err("Too many fds (%d)\n", context->max_fds);
Andy Green0d338332011-02-12 11:57:43 +0000119 return 1;
120 }
121
nononamef1624922014-01-11 13:12:34 +0800122 if (wsi->sock >= context->max_fds) {
Andy Greenb5b23192013-02-11 17:13:32 +0800123 lwsl_err("Socket fd %d is too high (%d)\n",
124 wsi->sock, context->max_fds);
Andy Greendfb23042013-01-17 12:26:48 +0800125 return 1;
126 }
127
128 assert(wsi);
Andy Green512c2462013-09-18 12:59:33 +0800129 assert(wsi->sock >= 0);
Andy Greendfb23042013-01-17 12:26:48 +0800130
Andy Greenb5b23192013-02-11 17:13:32 +0800131 lwsl_info("insert_wsi_socket_into_fds: wsi=%p, sock=%d, fds pos=%d\n",
132 wsi, wsi->sock, context->fds_count);
Andy Greendfb23042013-01-17 12:26:48 +0800133
Andy Green7a132792013-12-18 09:48:26 +0800134 context->protocols[0].callback(context, wsi,
135 LWS_CALLBACK_LOCK_POLL,
136 wsi->user_space, (void *)(long)wsi->sock, 0);
137
Andy Greendfb23042013-01-17 12:26:48 +0800138 context->lws_lookup[wsi->sock] = wsi;
139 wsi->position_in_fds_table = context->fds_count;
140 context->fds[context->fds_count].fd = wsi->sock;
141 context->fds[context->fds_count].events = POLLIN;
142 context->fds[context->fds_count++].revents = 0;
143
144 /* external POLL support via protocol 0 */
145 context->protocols[0].callback(context, wsi,
146 LWS_CALLBACK_ADD_POLL_FD,
Andy Green50097dd2013-02-15 22:36:30 +0800147 wsi->user_space, (void *)(long)wsi->sock, POLLIN);
Andy Green0d338332011-02-12 11:57:43 +0000148
Andy Green7a132792013-12-18 09:48:26 +0800149 context->protocols[0].callback(context, wsi,
150 LWS_CALLBACK_UNLOCK_POLL,
151 wsi->user_space, (void *)(long)wsi->sock, 0);
152
Andy Green0d338332011-02-12 11:57:43 +0000153 return 0;
154}
155
Andy Greendfb23042013-01-17 12:26:48 +0800156static int
Andy Greenb5b23192013-02-11 17:13:32 +0800157remove_wsi_socket_from_fds(struct libwebsocket_context *context,
158 struct libwebsocket *wsi)
Andy Green0d338332011-02-12 11:57:43 +0000159{
Andy Greendfb23042013-01-17 12:26:48 +0800160 int m;
Andy Green0d338332011-02-12 11:57:43 +0000161
Andy Green7a132792013-12-18 09:48:26 +0800162 if (!--context->fds_count) {
163 context->protocols[0].callback(context, wsi,
164 LWS_CALLBACK_LOCK_POLL,
165 wsi->user_space, (void *)(long)wsi->sock, 0);
Andy Greendfb23042013-01-17 12:26:48 +0800166 goto do_ext;
Andy Green7a132792013-12-18 09:48:26 +0800167 }
Andy Green0d338332011-02-12 11:57:43 +0000168
Andy Greendfb23042013-01-17 12:26:48 +0800169 if (wsi->sock > context->max_fds) {
Andy Greenb5b23192013-02-11 17:13:32 +0800170 lwsl_err("Socket fd %d too high (%d)\n",
171 wsi->sock, context->max_fds);
Andy Greendfb23042013-01-17 12:26:48 +0800172 return 1;
173 }
Andy Green0d338332011-02-12 11:57:43 +0000174
Andy Greenb5b23192013-02-11 17:13:32 +0800175 lwsl_info("remove_wsi_socket_from_fds: wsi=%p, sock=%d, fds pos=%d\n",
176 wsi, wsi->sock, wsi->position_in_fds_table);
Andy Greendfb23042013-01-17 12:26:48 +0800177
Andy Green7a132792013-12-18 09:48:26 +0800178 context->protocols[0].callback(context, wsi,
179 LWS_CALLBACK_LOCK_POLL,
180 wsi->user_space, (void *)(long)wsi->sock, 0);
181
Andy Greendfb23042013-01-17 12:26:48 +0800182 m = wsi->position_in_fds_table; /* replace the contents for this */
183
184 /* have the last guy take up the vacant slot */
Andy Greenb5b23192013-02-11 17:13:32 +0800185 context->fds[m] = context->fds[context->fds_count];
186 /*
187 * end guy's fds_lookup entry remains unchanged
188 * (still same fd pointing to same wsi)
189 */
Andy Greendfb23042013-01-17 12:26:48 +0800190 /* end guy's "position in fds table" changed */
Andy Greenb5b23192013-02-11 17:13:32 +0800191 context->lws_lookup[context->fds[context->fds_count].fd]->
192 position_in_fds_table = m;
Andy Greendfb23042013-01-17 12:26:48 +0800193 /* deletion guy's lws_lookup entry needs nuking */
Andy Greenb5b23192013-02-11 17:13:32 +0800194 context->lws_lookup[wsi->sock] = NULL;
195 /* removed wsi has no position any more */
196 wsi->position_in_fds_table = -1;
Andy Greendfb23042013-01-17 12:26:48 +0800197
198do_ext:
199 /* remove also from external POLL support via protocol 0 */
200 if (wsi->sock)
201 context->protocols[0].callback(context, wsi,
Andy Green50097dd2013-02-15 22:36:30 +0800202 LWS_CALLBACK_DEL_POLL_FD, wsi->user_space,
203 (void *)(long)wsi->sock, 0);
Andy Greendfb23042013-01-17 12:26:48 +0800204
Andy Green7a132792013-12-18 09:48:26 +0800205 context->protocols[0].callback(context, wsi,
206 LWS_CALLBACK_UNLOCK_POLL,
207 wsi->user_space, (void *)(long)wsi->sock, 0);
208
Andy Greendfb23042013-01-17 12:26:48 +0800209 return 0;
Andy Green0d338332011-02-12 11:57:43 +0000210}
211
Andy Green32375b72011-02-19 08:32:53 +0000212
Andy Green8f037e42010-12-19 22:13:26 +0000213void
Peter Hinz56885f32011-03-02 22:03:47 +0000214libwebsocket_close_and_free_session(struct libwebsocket_context *context,
Andy Green687b0182011-02-26 11:04:01 +0000215 struct libwebsocket *wsi, enum lws_close_status reason)
Andy Green251f6fa2010-11-03 11:13:06 +0000216{
Andy Greenb45993c2010-12-18 15:13:50 +0000217 int n;
Andy Green62c54d22011-02-14 09:14:25 +0000218 int old_state;
Andy Green5e1fa172011-02-10 09:07:05 +0000219 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 2 +
220 LWS_SEND_BUFFER_POST_PADDING];
Andy Green3182ece2013-01-20 17:08:31 +0800221#ifndef LWS_NO_EXTENSIONS
Andy Greenc44159f2011-03-07 07:08:18 +0000222 int ret;
223 int m;
224 struct lws_tokens eff_buf;
Andy Greena41314f2011-05-23 10:00:03 +0100225 struct libwebsocket_extension *ext;
Andy Green3182ece2013-01-20 17:08:31 +0800226#endif
Andy Greenb45993c2010-12-18 15:13:50 +0000227
Andy Green4b6fbe12011-02-14 08:03:48 +0000228 if (!wsi)
Andy Greenb45993c2010-12-18 15:13:50 +0000229 return;
230
Andy Green62c54d22011-02-14 09:14:25 +0000231 old_state = wsi->state;
Andy Green251f6fa2010-11-03 11:13:06 +0000232
Andy Green62c54d22011-02-14 09:14:25 +0000233 if (old_state == WSI_STATE_DEAD_SOCKET)
Andy Green5e1fa172011-02-10 09:07:05 +0000234 return;
235
Andy Green22524a62013-02-15 22:48:58 +0800236 /* we tried the polite way... */
237 if (old_state == WSI_STATE_AWAITING_CLOSE_ACK)
238 goto just_kill_connection;
239
Andy Green623a98d2013-01-21 11:04:23 +0800240 wsi->u.ws.close_reason = reason;
Andy Greenda527df2011-03-07 07:08:12 +0000241
Andy Green5dc62ea2013-09-20 20:26:12 +0800242 if (wsi->mode == LWS_CONNMODE_WS_CLIENT_WAITING_CONNECT ||
243 wsi->mode == LWS_CONNMODE_WS_CLIENT_ISSUE_HANDSHAKE) {
244
245 context->protocols[0].callback(context, wsi,
246 LWS_CALLBACK_CLIENT_CONNECTION_ERROR, NULL, NULL, 0);
247
248 free(wsi->u.hdr.ah);
249 goto just_kill_connection;
250 }
251
252
kapejodce64fb02013-11-19 13:38:16 +0100253 if (wsi->mode == LWS_CONNMODE_HTTP_SERVING_ACCEPTED) {
254 if (wsi->u.http.post_buffer) {
255 free(wsi->u.http.post_buffer);
256 wsi->u.http.post_buffer = NULL;
257 }
258 if (wsi->u.http.fd >= 0) {
259 lwsl_debug("closing http fd %d\n", wsi->u.http.fd);
260 close(wsi->u.http.fd);
261 wsi->u.http.fd = -1;
262 context->protocols[0].callback(context, wsi,
263 LWS_CALLBACK_CLOSED_HTTP, wsi->user_space, NULL, 0);
264 }
Andy Greenb8b247d2013-01-22 07:20:08 +0800265 }
266
Andy Green3182ece2013-01-20 17:08:31 +0800267#ifndef LWS_NO_EXTENSIONS
Andy Greenda527df2011-03-07 07:08:12 +0000268 /*
Andy Green68b45042011-05-25 21:41:57 +0100269 * are his extensions okay with him closing? Eg he might be a mux
270 * parent and just his ch1 aspect is closing?
271 */
272
Andy Green68b45042011-05-25 21:41:57 +0100273 for (n = 0; n < wsi->count_active_extensions; n++) {
274 if (!wsi->active_extensions[n]->callback)
275 continue;
276
277 m = wsi->active_extensions[n]->callback(context,
278 wsi->active_extensions[n], wsi,
279 LWS_EXT_CALLBACK_CHECK_OK_TO_REALLY_CLOSE,
280 wsi->active_extensions_user[n], NULL, 0);
281
282 /*
283 * if somebody vetoed actually closing him at this time....
284 * up to the extension to track the attempted close, let's
285 * just bail
286 */
287
288 if (m) {
Andy Green43db0452013-01-10 19:50:35 +0800289 lwsl_ext("extension vetoed close\n");
Andy Green68b45042011-05-25 21:41:57 +0100290 return;
291 }
292 }
293
Andy Green68b45042011-05-25 21:41:57 +0100294 /*
Andy Greenc44159f2011-03-07 07:08:18 +0000295 * flush any tx pending from extensions, since we may send close packet
296 * if there are problems with send, just nuke the connection
297 */
298
299 ret = 1;
300 while (ret == 1) {
301
302 /* default to nobody has more to spill */
303
304 ret = 0;
305 eff_buf.token = NULL;
306 eff_buf.token_len = 0;
307
308 /* show every extension the new incoming data */
309
310 for (n = 0; n < wsi->count_active_extensions; n++) {
311 m = wsi->active_extensions[n]->callback(
Andy Green46c2ea02011-03-22 09:04:01 +0000312 wsi->protocol->owning_server,
313 wsi->active_extensions[n], wsi,
Andy Greenc44159f2011-03-07 07:08:18 +0000314 LWS_EXT_CALLBACK_FLUSH_PENDING_TX,
315 wsi->active_extensions_user[n], &eff_buf, 0);
316 if (m < 0) {
Andy Green43db0452013-01-10 19:50:35 +0800317 lwsl_ext("Extension reports fatal error\n");
Andy Greenc44159f2011-03-07 07:08:18 +0000318 goto just_kill_connection;
319 }
320 if (m)
321 /*
322 * at least one extension told us he has more
323 * to spill, so we will go around again after
324 */
325 ret = 1;
326 }
327
328 /* assuming they left us something to send, send it */
329
330 if (eff_buf.token_len)
331 if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
Andy Greenfc7c5e42013-02-23 10:50:10 +0800332 eff_buf.token_len) != eff_buf.token_len) {
Andy Greenb5b23192013-02-11 17:13:32 +0800333 lwsl_debug("close: ext spill failed\n");
Andy Greenc44159f2011-03-07 07:08:18 +0000334 goto just_kill_connection;
Andy Green0303db42013-01-17 14:46:43 +0800335 }
Andy Greenc44159f2011-03-07 07:08:18 +0000336 }
Andy Green3182ece2013-01-20 17:08:31 +0800337#endif
Andy Greenc44159f2011-03-07 07:08:18 +0000338
339 /*
Andy Greenda527df2011-03-07 07:08:12 +0000340 * signal we are closing, libsocket_write will
341 * add any necessary version-specific stuff. If the write fails,
342 * no worries we are closing anyway. If we didn't initiate this
343 * close, then our state has been changed to
344 * WSI_STATE_RETURNED_CLOSE_ALREADY and we will skip this.
345 *
346 * Likewise if it's a second call to close this connection after we
347 * sent the close indication to the peer already, we are in state
348 * WSI_STATE_AWAITING_CLOSE_ACK and will skip doing this a second time.
349 */
350
351 if (old_state == WSI_STATE_ESTABLISHED &&
352 reason != LWS_CLOSE_STATUS_NOSTATUS) {
Andy Green66a16f32011-05-24 22:07:45 +0100353
Andy Green43db0452013-01-10 19:50:35 +0800354 lwsl_debug("sending close indication...\n");
Andy Green66a16f32011-05-24 22:07:45 +0100355
Andy Greenfdd305a2013-02-11 14:32:48 +0800356 /* make valgrind happy */
Andy Greenb5b23192013-02-11 17:13:32 +0800357 memset(buf, 0, sizeof(buf));
358 n = libwebsocket_write(wsi,
359 &buf[LWS_SEND_BUFFER_PRE_PADDING + 2],
Andy Greenda527df2011-03-07 07:08:12 +0000360 0, LWS_WRITE_CLOSE);
Andy Greenfc7c5e42013-02-23 10:50:10 +0800361 if (n >= 0) {
Andy Greenda527df2011-03-07 07:08:12 +0000362 /*
363 * we have sent a nice protocol level indication we
364 * now wish to close, we should not send anything more
365 */
366
367 wsi->state = WSI_STATE_AWAITING_CLOSE_ACK;
368
Andy Greenb5b23192013-02-11 17:13:32 +0800369 /*
370 * ...and we should wait for a reply for a bit
371 * out of politeness
372 */
Andy Greenda527df2011-03-07 07:08:12 +0000373
374 libwebsocket_set_timeout(wsi,
Andy Green0303db42013-01-17 14:46:43 +0800375 PENDING_TIMEOUT_CLOSE_ACK, 1);
Andy Greenda527df2011-03-07 07:08:12 +0000376
Andy Green43db0452013-01-10 19:50:35 +0800377 lwsl_debug("sent close indication, awaiting ack\n");
Andy Greenda527df2011-03-07 07:08:12 +0000378
379 return;
380 }
381
Andy Greenb5b23192013-02-11 17:13:32 +0800382 lwsl_info("close: sending close packet failed, hanging up\n");
Andy Green0303db42013-01-17 14:46:43 +0800383
Andy Greenda527df2011-03-07 07:08:12 +0000384 /* else, the send failed and we should just hang up */
385 }
386
Andy Greenc44159f2011-03-07 07:08:18 +0000387just_kill_connection:
Andy Green66a16f32011-05-24 22:07:45 +0100388
Andy Greenb5b23192013-02-11 17:13:32 +0800389 lwsl_debug("close: just_kill_connection\n");
Andy Green66a16f32011-05-24 22:07:45 +0100390
Andy Greenda527df2011-03-07 07:08:12 +0000391 /*
392 * we won't be servicing or receiving anything further from this guy
Andy Greendfb23042013-01-17 12:26:48 +0800393 * delete socket from the internal poll list if still present
Andy Greenda527df2011-03-07 07:08:12 +0000394 */
Andy Green4b6fbe12011-02-14 08:03:48 +0000395
Andy Greendfb23042013-01-17 12:26:48 +0800396 remove_wsi_socket_from_fds(context, wsi);
Andy Green4b6fbe12011-02-14 08:03:48 +0000397
Andy Green251f6fa2010-11-03 11:13:06 +0000398 wsi->state = WSI_STATE_DEAD_SOCKET;
399
Andy Greenb5b23192013-02-11 17:13:32 +0800400 if ((old_state == WSI_STATE_ESTABLISHED ||
401 wsi->mode == LWS_CONNMODE_WS_SERVING ||
Andy Green3ee9b312013-02-12 12:52:39 +0800402 wsi->mode == LWS_CONNMODE_WS_CLIENT)) {
403
404 if (wsi->u.ws.rx_user_buffer) {
405 free(wsi->u.ws.rx_user_buffer);
406 wsi->u.ws.rx_user_buffer = NULL;
407 }
408 if (wsi->u.ws.rxflow_buffer) {
409 free(wsi->u.ws.rxflow_buffer);
410 wsi->u.ws.rxflow_buffer = NULL;
411 }
Andy Green2764eba2013-12-09 14:16:17 +0800412 if (wsi->truncated_send_malloc) {
Andy Green1f4267b2013-10-17 08:09:19 +0800413 /* not going to be completed... nuke it */
Andy Green2764eba2013-12-09 14:16:17 +0800414 free(wsi->truncated_send_malloc);
415 wsi->truncated_send_malloc = NULL;
Andy Green1f4267b2013-10-17 08:09:19 +0800416 }
Andy Green54495112013-02-06 21:10:16 +0900417 }
418
Andy Green4b6fbe12011-02-14 08:03:48 +0000419 /* tell the user it's all over for this guy */
420
Andy Greend4302732011-02-28 07:45:29 +0000421 if (wsi->protocol && wsi->protocol->callback &&
Andy Green6ee372f2012-04-09 15:09:01 +0800422 ((old_state == WSI_STATE_ESTABLISHED) ||
423 (old_state == WSI_STATE_RETURNED_CLOSE_ALREADY) ||
424 (old_state == WSI_STATE_AWAITING_CLOSE_ACK))) {
Andy Green43db0452013-01-10 19:50:35 +0800425 lwsl_debug("calling back CLOSED\n");
Peter Hinz56885f32011-03-02 22:03:47 +0000426 wsi->protocol->callback(context, wsi, LWS_CALLBACK_CLOSED,
Andy Greene77ddd82010-11-13 10:03:47 +0000427 wsi->user_space, NULL, 0);
Niall T. Davidsondb761be2013-06-29 10:16:18 +0800428 } else if ( wsi->mode == LWS_CONNMODE_HTTP_SERVING_ACCEPTED ) {
429 lwsl_debug("calling back CLOSED_HTTP\n");
430 context->protocols[0].callback(context, wsi,
431 LWS_CALLBACK_CLOSED_HTTP, wsi->user_space, NULL, 0 );
Andy Greencc012472011-11-07 19:53:23 +0800432 } else
Andy Greenb5b23192013-02-11 17:13:32 +0800433 lwsl_debug("not calling back closed\n");
Andy Green251f6fa2010-11-03 11:13:06 +0000434
Andy Green3182ece2013-01-20 17:08:31 +0800435#ifndef LWS_NO_EXTENSIONS
Andy Greenef660a92011-03-06 10:29:38 +0000436 /* deallocate any active extension contexts */
437
438 for (n = 0; n < wsi->count_active_extensions; n++) {
439 if (!wsi->active_extensions[n]->callback)
440 continue;
441
Andy Green46c2ea02011-03-22 09:04:01 +0000442 wsi->active_extensions[n]->callback(context,
443 wsi->active_extensions[n], wsi,
444 LWS_EXT_CALLBACK_DESTROY,
445 wsi->active_extensions_user[n], NULL, 0);
Andy Greenef660a92011-03-06 10:29:38 +0000446
447 free(wsi->active_extensions_user[n]);
448 }
449
Andy Greena41314f2011-05-23 10:00:03 +0100450 /*
451 * inform all extensions in case they tracked this guy out of band
452 * even though not active on him specifically
453 */
454
455 ext = context->extensions;
456 while (ext && ext->callback) {
457 ext->callback(context, ext, wsi,
458 LWS_EXT_CALLBACK_DESTROY_ANY_WSI_CLOSING,
459 NULL, NULL, 0);
460 ext++;
461 }
Andy Green3182ece2013-01-20 17:08:31 +0800462#endif
Andy Greena41314f2011-05-23 10:00:03 +0100463
Andy Green43db0452013-01-10 19:50:35 +0800464/* lwsl_info("closing fd=%d\n", wsi->sock); */
Andy Green251f6fa2010-11-03 11:13:06 +0000465
Andy Green3faa9c72010-11-08 17:03:03 +0000466#ifdef LWS_OPENSSL_SUPPORT
Andy Green90c7cbc2011-01-27 06:26:52 +0000467 if (wsi->ssl) {
Andy Green3faa9c72010-11-08 17:03:03 +0000468 n = SSL_get_fd(wsi->ssl);
469 SSL_shutdown(wsi->ssl);
Andy Green3fc2c652013-01-14 15:35:02 +0800470 compatible_close(n);
Andy Green3faa9c72010-11-08 17:03:03 +0000471 SSL_free(wsi->ssl);
472 } else {
473#endif
Andy Green0303db42013-01-17 14:46:43 +0800474 if (wsi->sock) {
475 n = shutdown(wsi->sock, SHUT_RDWR);
476 if (n)
Andy Greenb5b23192013-02-11 17:13:32 +0800477 lwsl_debug("closing: shutdown returned %d\n",
478 errno);
Andy Green3fc2c652013-01-14 15:35:02 +0800479
Andy Green0303db42013-01-17 14:46:43 +0800480 n = compatible_close(wsi->sock);
481 if (n)
Andy Greenb5b23192013-02-11 17:13:32 +0800482 lwsl_debug("closing: close returned %d\n",
483 errno);
Andy Green0303db42013-01-17 14:46:43 +0800484 }
Andy Green3faa9c72010-11-08 17:03:03 +0000485#ifdef LWS_OPENSSL_SUPPORT
486 }
487#endif
Andy Greenb5b23192013-02-11 17:13:32 +0800488 if (wsi->protocol && wsi->protocol->per_session_data_size &&
489 wsi->user_space) /* user code may own */
Andy Green4f3943a2010-11-12 10:44:16 +0000490 free(wsi->user_space);
491
Andy Green251f6fa2010-11-03 11:13:06 +0000492 free(wsi);
493}
494
Andy Green07034092011-02-13 08:37:12 +0000495/**
496 * libwebsockets_get_peer_addresses() - Get client address information
Andy Greenaaf0b9f2013-01-30 08:12:20 +0800497 * @context: Libwebsockets context
498 * @wsi: Local struct libwebsocket associated with
Andy Green07034092011-02-13 08:37:12 +0000499 * @fd: Connection socket descriptor
500 * @name: Buffer to take client address name
501 * @name_len: Length of client address name buffer
502 * @rip: Buffer to take client address IP qotted quad
503 * @rip_len: Length of client address IP buffer
504 *
505 * This function fills in @name and @rip with the name and IP of
Andy Green6ee372f2012-04-09 15:09:01 +0800506 * the client connected with socket descriptor @fd. Names may be
507 * truncated if there is not enough room. If either cannot be
508 * determined, they will be returned as valid zero-length strings.
Andy Green07034092011-02-13 08:37:12 +0000509 */
510
Peter Pentchev9a4fef72013-03-30 09:52:21 +0800511LWS_VISIBLE void
Andy Greenaaf0b9f2013-01-30 08:12:20 +0800512libwebsockets_get_peer_addresses(struct libwebsocket_context *context,
513 struct libwebsocket *wsi, int fd, char *name, int name_len,
Andy Green07034092011-02-13 08:37:12 +0000514 char *rip, int rip_len)
515{
Bob Robertsac049112013-04-25 09:16:30 +0800516 socklen_t len;
Andy Green07034092011-02-13 08:37:12 +0000517 struct sockaddr_in sin;
518 struct hostent *host;
519 struct hostent *host1;
520 char ip[128];
Andy Greenf92def72011-03-09 15:02:20 +0000521 unsigned char *p;
Andy Green07034092011-02-13 08:37:12 +0000522 int n;
Andy Greenaaf0b9f2013-01-30 08:12:20 +0800523 int ret = -1;
David Galeanocb193682013-01-09 15:29:00 +0800524#ifdef AF_LOCAL
Andy Greenb5b23192013-02-11 17:13:32 +0800525 struct sockaddr_un *un;
David Galeanocb193682013-01-09 15:29:00 +0800526#endif
Andy Green07034092011-02-13 08:37:12 +0000527
528 rip[0] = '\0';
529 name[0] = '\0';
530
Andy Greenaaf0b9f2013-01-30 08:12:20 +0800531 lws_latency_pre(context, wsi);
532
Andy Greenb5b23192013-02-11 17:13:32 +0800533 len = sizeof(sin);
Andy Green07034092011-02-13 08:37:12 +0000534 if (getpeername(fd, (struct sockaddr *) &sin, &len) < 0) {
535 perror("getpeername");
Andy Greenaaf0b9f2013-01-30 08:12:20 +0800536 goto bail;
Andy Green07034092011-02-13 08:37:12 +0000537 }
Andy Green6ee372f2012-04-09 15:09:01 +0800538
Andy Greenb5b23192013-02-11 17:13:32 +0800539 host = gethostbyaddr((char *) &sin.sin_addr, sizeof(sin.sin_addr),
Andy Green07034092011-02-13 08:37:12 +0000540 AF_INET);
541 if (host == NULL) {
542 perror("gethostbyaddr");
Andy Greenaaf0b9f2013-01-30 08:12:20 +0800543 goto bail;
Andy Green07034092011-02-13 08:37:12 +0000544 }
545
546 strncpy(name, host->h_name, name_len);
547 name[name_len - 1] = '\0';
548
549 host1 = gethostbyname(host->h_name);
550 if (host1 == NULL)
Andy Greenaaf0b9f2013-01-30 08:12:20 +0800551 goto bail;
Andy Greenf92def72011-03-09 15:02:20 +0000552 p = (unsigned char *)host1;
Andy Green07034092011-02-13 08:37:12 +0000553 n = 0;
554 while (p != NULL) {
Andy Greenf92def72011-03-09 15:02:20 +0000555 p = (unsigned char *)host1->h_addr_list[n++];
Andy Green07034092011-02-13 08:37:12 +0000556 if (p == NULL)
557 continue;
Peter Hinzbb45a902011-03-10 18:14:01 +0000558 if ((host1->h_addrtype != AF_INET)
559#ifdef AF_LOCAL
560 && (host1->h_addrtype != AF_LOCAL)
561#endif
562 )
Andy Green07034092011-02-13 08:37:12 +0000563 continue;
564
Andy Green7627af52011-03-09 15:13:52 +0000565 if (host1->h_addrtype == AF_INET)
566 sprintf(ip, "%u.%u.%u.%u", p[0], p[1], p[2], p[3]);
Peter Hinzbb45a902011-03-10 18:14:01 +0000567#ifdef AF_LOCAL
Andy Green7627af52011-03-09 15:13:52 +0000568 else {
569 un = (struct sockaddr_un *)p;
Andy Green6ee372f2012-04-09 15:09:01 +0800570 strncpy(ip, un->sun_path, sizeof(ip) - 1);
Andy Green7627af52011-03-09 15:13:52 +0000571 ip[sizeof(ip) - 1] = '\0';
572 }
Peter Hinzbb45a902011-03-10 18:14:01 +0000573#endif
Andy Green07034092011-02-13 08:37:12 +0000574 p = NULL;
575 strncpy(rip, ip, rip_len);
576 rip[rip_len - 1] = '\0';
577 }
Andy Greenaaf0b9f2013-01-30 08:12:20 +0800578
579 ret = 0;
580bail:
581 lws_latency(context, wsi, "libwebsockets_get_peer_addresses", ret, 1);
Andy Green07034092011-02-13 08:37:12 +0000582}
Andy Green9f990342011-02-12 11:57:45 +0000583
Peter Pentchev9a4fef72013-03-30 09:52:21 +0800584LWS_VISIBLE int libwebsockets_get_random(struct libwebsocket_context *context,
Peter Hinz56885f32011-03-02 22:03:47 +0000585 void *buf, int len)
586{
587 int n;
Aaron Zinman4550f1d2013-01-10 12:35:18 +0800588 char *p = (char *)buf;
Peter Hinz56885f32011-03-02 22:03:47 +0000589
Andreas Pakulat68bd4bd2013-10-28 15:18:04 +0100590#if defined(WIN32) || defined(_WIN32)
Peter Hinz56885f32011-03-02 22:03:47 +0000591 for (n = 0; n < len; n++)
592 p[n] = (unsigned char)rand();
593#else
594 n = read(context->fd_random, p, len);
595#endif
596
597 return n;
598}
599
Andy Greena690cd02013-02-09 12:25:31 +0800600int lws_set_socket_options(struct libwebsocket_context *context, int fd)
601{
602 int optval = 1;
603 socklen_t optlen = sizeof(optval);
Andreas Pakulat68bd4bd2013-10-28 15:18:04 +0100604#if defined(WIN32) || defined(_WIN32)
Andy Greena690cd02013-02-09 12:25:31 +0800605 unsigned long optl = 0;
606#endif
607#if defined(__APPLE__) || defined(__FreeBSD__) || defined(__NetBSD__)
608 struct protoent *tcp_proto;
609#endif
610
611 if (context->ka_time) {
612 /* enable keepalive on this socket */
613 optval = 1;
614 if (setsockopt(fd, SOL_SOCKET, SO_KEEPALIVE,
615 (const void *)&optval, optlen) < 0)
616 return 1;
617
Bob Robertsac049112013-04-25 09:16:30 +0800618#if defined(__APPLE__) || defined(__FreeBSD__) || defined(__NetBSD__) || defined(__CYGWIN__)
Andy Greena47865f2013-02-10 09:39:47 +0800619
620 /*
621 * didn't find a way to set these per-socket, need to
622 * tune kernel systemwide values
623 */
Joakim Soderberg63ff1202013-02-11 17:52:23 +0100624#elif WIN32
625 {
626 DWORD dwBytesRet;
627 struct tcp_keepalive alive;
628 alive.onoff = TRUE;
629 alive.keepalivetime = context->ka_time;
630 alive.keepaliveinterval = context->ka_interval;
Andy Greena47865f2013-02-10 09:39:47 +0800631
Joakim Soderberg63ff1202013-02-11 17:52:23 +0100632 if (WSAIoctl(fd, SIO_KEEPALIVE_VALS, &alive, sizeof(alive),
633 NULL, 0, &dwBytesRet, NULL, NULL))
634 return 1;
635 }
Andy Greena47865f2013-02-10 09:39:47 +0800636#else
Andy Greena690cd02013-02-09 12:25:31 +0800637 /* set the keepalive conditions we want on it too */
638 optval = context->ka_time;
639 if (setsockopt(fd, IPPROTO_IP, TCP_KEEPIDLE,
640 (const void *)&optval, optlen) < 0)
641 return 1;
642
Larry Hayesbb66ac62013-02-22 09:16:20 +0800643 optval = context->ka_interval;
Andy Greena690cd02013-02-09 12:25:31 +0800644 if (setsockopt(fd, IPPROTO_IP, TCP_KEEPINTVL,
645 (const void *)&optval, optlen) < 0)
646 return 1;
647
Larry Hayesbb66ac62013-02-22 09:16:20 +0800648 optval = context->ka_probes;
Andy Greena690cd02013-02-09 12:25:31 +0800649 if (setsockopt(fd, IPPROTO_IP, TCP_KEEPCNT,
650 (const void *)&optval, optlen) < 0)
651 return 1;
Andy Greena47865f2013-02-10 09:39:47 +0800652#endif
Andy Greena690cd02013-02-09 12:25:31 +0800653 }
654
655 /* Disable Nagle */
656 optval = 1;
657#if !defined(__APPLE__) && !defined(__FreeBSD__) && !defined(__NetBSD__)
658 setsockopt(fd, SOL_TCP, TCP_NODELAY, (const void *)&optval, optlen);
659#else
660 tcp_proto = getprotobyname("TCP");
661 setsockopt(fd, tcp_proto->p_proto, TCP_NODELAY, &optval, optlen);
662#endif
663
664 /* We are nonblocking... */
Andreas Pakulat68bd4bd2013-10-28 15:18:04 +0100665#if defined(WIN32) || defined(_WIN32)
Andy Greena690cd02013-02-09 12:25:31 +0800666 ioctlsocket(fd, FIONBIO, &optl);
667#else
668 fcntl(fd, F_SETFL, O_NONBLOCK);
669#endif
670
671 return 0;
672}
673
Peter Pentchev9a4fef72013-03-30 09:52:21 +0800674LWS_VISIBLE int lws_send_pipe_choked(struct libwebsocket *wsi)
Andy Green95a7b5d2011-03-06 10:29:39 +0000675{
676 struct pollfd fds;
677
Andy Green2764eba2013-12-09 14:16:17 +0800678 /* treat the fact we got a truncated send pending as if we're choked */
679 if (wsi->truncated_send_malloc)
680 return 1;
681
Andy Green95a7b5d2011-03-06 10:29:39 +0000682 fds.fd = wsi->sock;
683 fds.events = POLLOUT;
684 fds.revents = 0;
685
686 if (poll(&fds, 1, 0) != 1)
687 return 1;
688
689 if ((fds.revents & POLLOUT) == 0)
690 return 1;
691
692 /* okay to send another packet without blocking */
693
694 return 0;
695}
696
Andy Greena41314f2011-05-23 10:00:03 +0100697int
Andy Green3b84c002011-03-06 13:14:42 +0000698lws_handle_POLLOUT_event(struct libwebsocket_context *context,
699 struct libwebsocket *wsi, struct pollfd *pollfd)
700{
Andy Green3b84c002011-03-06 13:14:42 +0000701 int n;
Andy Green6f520a52013-01-29 17:57:39 +0800702
Andy Green3182ece2013-01-20 17:08:31 +0800703#ifndef LWS_NO_EXTENSIONS
704 struct lws_tokens eff_buf;
Andy Green3b84c002011-03-06 13:14:42 +0000705 int ret;
706 int m;
Andy Greena41314f2011-05-23 10:00:03 +0100707 int handled = 0;
Andy Green3b84c002011-03-06 13:14:42 +0000708
Andy Green1f4267b2013-10-17 08:09:19 +0800709 /* pending truncated sends have uber priority */
710
Andy Green2764eba2013-12-09 14:16:17 +0800711 if (wsi->truncated_send_malloc) {
712 lws_issue_raw(wsi, wsi->truncated_send_malloc +
713 wsi->truncated_send_offset,
714 wsi->truncated_send_len);
Andy Green1f4267b2013-10-17 08:09:19 +0800715 /* leave POLLOUT active either way */
716 return 0;
717 }
718
Andy Greena41314f2011-05-23 10:00:03 +0100719 for (n = 0; n < wsi->count_active_extensions; n++) {
720 if (!wsi->active_extensions[n]->callback)
721 continue;
722
723 m = wsi->active_extensions[n]->callback(context,
724 wsi->active_extensions[n], wsi,
725 LWS_EXT_CALLBACK_IS_WRITEABLE,
726 wsi->active_extensions_user[n], NULL, 0);
727 if (m > handled)
728 handled = m;
729 }
730
731 if (handled == 1)
732 goto notify_action;
733
734 if (!wsi->extension_data_pending || handled == 2)
Andy Green3b84c002011-03-06 13:14:42 +0000735 goto user_service;
736
737 /*
738 * check in on the active extensions, see if they
739 * had pending stuff to spill... they need to get the
740 * first look-in otherwise sequence will be disordered
741 *
742 * NULL, zero-length eff_buf means just spill pending
743 */
744
745 ret = 1;
746 while (ret == 1) {
747
748 /* default to nobody has more to spill */
749
750 ret = 0;
751 eff_buf.token = NULL;
752 eff_buf.token_len = 0;
753
754 /* give every extension a chance to spill */
755
756 for (n = 0; n < wsi->count_active_extensions; n++) {
757 m = wsi->active_extensions[n]->callback(
Andy Green46c2ea02011-03-22 09:04:01 +0000758 wsi->protocol->owning_server,
759 wsi->active_extensions[n], wsi,
Andy Green3b84c002011-03-06 13:14:42 +0000760 LWS_EXT_CALLBACK_PACKET_TX_PRESEND,
761 wsi->active_extensions_user[n], &eff_buf, 0);
762 if (m < 0) {
Andy Green43db0452013-01-10 19:50:35 +0800763 lwsl_err("ext reports fatal error\n");
Andy Green3b84c002011-03-06 13:14:42 +0000764 return -1;
765 }
766 if (m)
767 /*
768 * at least one extension told us he has more
769 * to spill, so we will go around again after
770 */
771 ret = 1;
772 }
773
774 /* assuming they gave us something to send, send it */
775
776 if (eff_buf.token_len) {
Andy Greenfc7c5e42013-02-23 10:50:10 +0800777 n = lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
778 eff_buf.token_len);
779 if (n < 0)
Andy Green3b84c002011-03-06 13:14:42 +0000780 return -1;
Andy Greenfc7c5e42013-02-23 10:50:10 +0800781 /*
782 * Keep amount spilled small to minimize chance of this
783 */
784 if (n != eff_buf.token_len) {
785 lwsl_err("Unable to spill ext %d vs %s\n",
786 eff_buf.token_len, n);
787 return -1;
788 }
Andy Green3b84c002011-03-06 13:14:42 +0000789 } else
790 continue;
791
792 /* no extension has more to spill */
793
794 if (!ret)
795 continue;
796
797 /*
798 * There's more to spill from an extension, but we just sent
799 * something... did that leave the pipe choked?
800 */
801
802 if (!lws_send_pipe_choked(wsi))
803 /* no we could add more */
804 continue;
805
Andy Green43db0452013-01-10 19:50:35 +0800806 lwsl_info("choked in POLLOUT service\n");
Andy Green3b84c002011-03-06 13:14:42 +0000807
808 /*
809 * Yes, he's choked. Leave the POLLOUT masked on so we will
810 * come back here when he is unchoked. Don't call the user
811 * callback to enforce ordering of spilling, he'll get called
812 * when we come back here and there's nothing more to spill.
813 */
814
815 return 0;
816 }
817
818 wsi->extension_data_pending = 0;
819
820user_service:
Andy Green3182ece2013-01-20 17:08:31 +0800821#endif
Andy Green3b84c002011-03-06 13:14:42 +0000822 /* one shot */
823
Andy Green91f19d82013-12-21 11:18:34 +0800824 if (pollfd)
825 lws_change_pollfd(wsi, POLLOUT, 0);
Andy Green7a132792013-12-18 09:48:26 +0800826
Andy Green3182ece2013-01-20 17:08:31 +0800827#ifndef LWS_NO_EXTENSIONS
Andy Greena41314f2011-05-23 10:00:03 +0100828notify_action:
Andy Green3182ece2013-01-20 17:08:31 +0800829#endif
Andy Green3b84c002011-03-06 13:14:42 +0000830
Andy Green9e4c2b62011-03-07 20:47:39 +0000831 if (wsi->mode == LWS_CONNMODE_WS_CLIENT)
832 n = LWS_CALLBACK_CLIENT_WRITEABLE;
833 else
834 n = LWS_CALLBACK_SERVER_WRITEABLE;
835
Andy Greenb8b247d2013-01-22 07:20:08 +0800836 return user_callback_handle_rxflow(wsi->protocol->callback, context,
Andy Greenb5b23192013-02-11 17:13:32 +0800837 wsi, (enum libwebsocket_callback_reasons) n,
838 wsi->user_space, NULL, 0);
Andy Green3b84c002011-03-06 13:14:42 +0000839}
840
841
842
Andy Green1c6e1422013-02-20 19:11:31 +0800843int
Andy Greena41314f2011-05-23 10:00:03 +0100844libwebsocket_service_timeout_check(struct libwebsocket_context *context,
845 struct libwebsocket *wsi, unsigned int sec)
846{
Andy Green3182ece2013-01-20 17:08:31 +0800847#ifndef LWS_NO_EXTENSIONS
Andy Greena41314f2011-05-23 10:00:03 +0100848 int n;
849
850 /*
851 * if extensions want in on it (eg, we are a mux parent)
852 * give them a chance to service child timeouts
853 */
854
855 for (n = 0; n < wsi->count_active_extensions; n++)
856 wsi->active_extensions[n]->callback(
857 context, wsi->active_extensions[n],
858 wsi, LWS_EXT_CALLBACK_1HZ,
859 wsi->active_extensions_user[n], NULL, sec);
860
Andy Green3182ece2013-01-20 17:08:31 +0800861#endif
Andy Greena41314f2011-05-23 10:00:03 +0100862 if (!wsi->pending_timeout)
Andy Green1c6e1422013-02-20 19:11:31 +0800863 return 0;
Andy Green6ee372f2012-04-09 15:09:01 +0800864
Andy Greena41314f2011-05-23 10:00:03 +0100865 /*
866 * if we went beyond the allowed time, kill the
867 * connection
868 */
869
870 if (sec > wsi->pending_timeout_limit) {
Andy Green43db0452013-01-10 19:50:35 +0800871 lwsl_info("TIMEDOUT WAITING\n");
Andy Greena41314f2011-05-23 10:00:03 +0100872 libwebsocket_close_and_free_session(context,
873 wsi, LWS_CLOSE_STATUS_NOSTATUS);
Andy Green1c6e1422013-02-20 19:11:31 +0800874 return 1;
Andy Greena41314f2011-05-23 10:00:03 +0100875 }
Andy Green1c6e1422013-02-20 19:11:31 +0800876
877 return 0;
Andy Greena41314f2011-05-23 10:00:03 +0100878}
879
Andy Green9f990342011-02-12 11:57:45 +0000880/**
881 * libwebsocket_service_fd() - Service polled socket with something waiting
Peter Hinz56885f32011-03-02 22:03:47 +0000882 * @context: Websocket context
Andy Green9f990342011-02-12 11:57:45 +0000883 * @pollfd: The pollfd entry describing the socket fd and which events
Andy Green6ee372f2012-04-09 15:09:01 +0800884 * happened.
Andy Green9f990342011-02-12 11:57:45 +0000885 *
Andy Green75006172013-01-22 12:32:11 +0800886 * This function takes a pollfd that has POLLIN or POLLOUT activity and
Andy Greenb5b23192013-02-11 17:13:32 +0800887 * services it according to the state of the associated
888 * struct libwebsocket.
Andy Green75006172013-01-22 12:32:11 +0800889 *
890 * The one call deals with all "service" that might happen on a socket
891 * including listen accepts, http files as well as websocket protocol.
Andy Green2577c832013-03-11 20:37:03 +0800892 *
893 * If a pollfd says it has something, you can just pass it to
894 * libwebsocket_serice_fd() whether it is a socket handled by lws or not.
895 * If it sees it is a lws socket, the traffic will be handled and
896 * pollfd->revents will be zeroed now.
897 *
898 * If the socket is foreign to lws, it leaves revents alone. So you can
899 * see if you should service yourself by checking the pollfd revents
900 * after letting lws try to service it.
Andy Green9f990342011-02-12 11:57:45 +0000901 */
902
Peter Pentchev9a4fef72013-03-30 09:52:21 +0800903LWS_VISIBLE int
Peter Hinz56885f32011-03-02 22:03:47 +0000904libwebsocket_service_fd(struct libwebsocket_context *context,
Andy Green0d338332011-02-12 11:57:43 +0000905 struct pollfd *pollfd)
Andy Greenb45993c2010-12-18 15:13:50 +0000906{
Andy Greena1ce6be2013-01-18 11:43:21 +0800907 struct libwebsocket *wsi;
Andy Greenb45993c2010-12-18 15:13:50 +0000908 int n;
Andy Green0d338332011-02-12 11:57:43 +0000909 int m;
Andy Greenf0b79e22013-02-10 10:46:45 +0800910 int listen_socket_fds_index = 0;
Andy Greena71eafc2011-02-14 17:59:43 +0000911 struct timeval tv;
Andy Green1c6e1422013-02-20 19:11:31 +0800912 int timed_out = 0;
913 int our_fd = 0;
Andy Greenca0a1292013-03-16 11:24:23 +0800914 char draining_flow = 0;
Andy Green6f520a52013-01-29 17:57:39 +0800915
Andy Green3182ece2013-01-20 17:08:31 +0800916#ifndef LWS_NO_EXTENSIONS
Andy Green2366b1c2011-03-06 13:15:31 +0000917 int more = 1;
Andy Green3182ece2013-01-20 17:08:31 +0800918#endif
Andy Green98a717c2011-03-06 13:14:15 +0000919 struct lws_tokens eff_buf;
Andy Greenf0b79e22013-02-10 10:46:45 +0800920
921 if (context->listen_service_fd)
922 listen_socket_fds_index = context->lws_lookup[
923 context->listen_service_fd]->position_in_fds_table;
924
Andy Greena71eafc2011-02-14 17:59:43 +0000925 /*
926 * you can call us with pollfd = NULL to just allow the once-per-second
927 * global timeout checks; if less than a second since the last check
928 * it returns immediately then.
929 */
930
931 gettimeofday(&tv, NULL);
932
Peter Hinz56885f32011-03-02 22:03:47 +0000933 if (context->last_timeout_check_s != tv.tv_sec) {
934 context->last_timeout_check_s = tv.tv_sec;
Andy Greena71eafc2011-02-14 17:59:43 +0000935
Joakim Soderberg4c531232013-02-06 15:26:58 +0900936 #ifndef WIN32
Andy Green24cba922013-01-19 13:56:10 +0800937 /* if our parent went down, don't linger around */
Andy Greenb5b23192013-02-11 17:13:32 +0800938 if (context->started_with_parent &&
939 kill(context->started_with_parent, 0) < 0)
Andy Green24cba922013-01-19 13:56:10 +0800940 kill(getpid(), SIGTERM);
Joakim Soderberg4c531232013-02-06 15:26:58 +0900941 #endif
Andy Green24cba922013-01-19 13:56:10 +0800942
Andy Greena71eafc2011-02-14 17:59:43 +0000943 /* global timeout check once per second */
944
Andy Green1c6e1422013-02-20 19:11:31 +0800945 if (pollfd)
946 our_fd = pollfd->fd;
947
Peter Hinz56885f32011-03-02 22:03:47 +0000948 for (n = 0; n < context->fds_count; n++) {
Andy Green1c6e1422013-02-20 19:11:31 +0800949 m = context->fds[n].fd;
950 wsi = context->lws_lookup[m];
951 if (!wsi)
Andy Greendfb23042013-01-17 12:26:48 +0800952 continue;
Andy Green1c6e1422013-02-20 19:11:31 +0800953
954 if (libwebsocket_service_timeout_check(context, wsi,
955 tv.tv_sec))
956 /* he did time out... */
Andy Greenb1a5e6c2013-03-09 12:34:30 +0800957 if (m == our_fd) {
Andy Green1c6e1422013-02-20 19:11:31 +0800958 /* it was the guy we came to service! */
959 timed_out = 1;
Andy Greenb1a5e6c2013-03-09 12:34:30 +0800960 /* mark as handled */
961 pollfd->revents = 0;
962 }
Andy Greena71eafc2011-02-14 17:59:43 +0000963 }
964 }
965
Andy Green1c6e1422013-02-20 19:11:31 +0800966 /* the socket we came to service timed out, nothing to do */
967 if (timed_out)
968 return 0;
969
Andy Greena71eafc2011-02-14 17:59:43 +0000970 /* just here for timeout management? */
Andy Greena71eafc2011-02-14 17:59:43 +0000971 if (pollfd == NULL)
972 return 0;
973
974 /* no, here to service a socket descriptor */
Andy Greenb1a5e6c2013-03-09 12:34:30 +0800975 wsi = context->lws_lookup[pollfd->fd];
976 if (wsi == NULL)
977 /* not lws connection ... leave revents alone and return */
978 return 0;
979
980 /*
981 * so that caller can tell we handled, past here we need to
982 * zero down pollfd->revents after handling
983 */
984
Andy Green65b0e912013-01-16 07:59:47 +0800985 /*
986 * deal with listen service piggybacking
987 * every listen_service_modulo services of other fds, we
988 * sneak one in to service the listen socket if there's anything waiting
989 *
990 * To handle connection storms, as found in ab, if we previously saw a
991 * pending connection here, it causes us to check again next time.
992 */
993
Andy Greenb5b23192013-02-11 17:13:32 +0800994 if (context->listen_service_fd && pollfd !=
995 &context->fds[listen_socket_fds_index]) {
Andy Green65b0e912013-01-16 07:59:47 +0800996 context->listen_service_count++;
997 if (context->listen_service_extraseen ||
Andy Greenb5b23192013-02-11 17:13:32 +0800998 context->listen_service_count ==
999 context->listen_service_modulo) {
Andy Green65b0e912013-01-16 07:59:47 +08001000 context->listen_service_count = 0;
1001 m = 1;
1002 if (context->listen_service_extraseen > 5)
1003 m = 2;
1004 while (m--) {
Andy Greenb5b23192013-02-11 17:13:32 +08001005 /*
1006 * even with extpoll, we prepared this
1007 * internal fds for listen
1008 */
1009 n = poll(&context->fds[listen_socket_fds_index],
1010 1, 0);
1011 if (n > 0) { /* there's a conn waiting for us */
1012 libwebsocket_service_fd(context,
1013 &context->
1014 fds[listen_socket_fds_index]);
Andy Green65b0e912013-01-16 07:59:47 +08001015 context->listen_service_extraseen++;
1016 } else {
1017 if (context->listen_service_extraseen)
Andy Greenb5b23192013-02-11 17:13:32 +08001018 context->
1019 listen_service_extraseen--;
Andy Green65b0e912013-01-16 07:59:47 +08001020 break;
1021 }
1022 }
1023 }
1024
1025 }
1026
Graham Newtonb1aa1d32013-11-04 09:47:06 +08001027 /* handle session socket closed */
1028
1029 if ((!(pollfd->revents & POLLIN)) &&
1030 (pollfd->revents & (POLLERR | POLLHUP))) {
1031
1032 lwsl_debug("Session Socket %p (fd=%d) dead\n",
1033 (void *)wsi, pollfd->fd);
1034
1035 goto close_and_handled;
1036 }
1037
Andy Green65b0e912013-01-16 07:59:47 +08001038 /* okay, what we came here to do... */
1039
Andy Green0d338332011-02-12 11:57:43 +00001040 switch (wsi->mode) {
Andy Greend280b6e2013-01-15 13:40:23 +08001041
Andy Greena1ce6be2013-01-18 11:43:21 +08001042#ifndef LWS_NO_SERVER
Andy Greend280b6e2013-01-15 13:40:23 +08001043 case LWS_CONNMODE_HTTP_SERVING:
Andy Green7cf6cb02013-05-19 14:04:10 +08001044 case LWS_CONNMODE_HTTP_SERVING_ACCEPTED:
Andy Green0d338332011-02-12 11:57:43 +00001045 case LWS_CONNMODE_SERVER_LISTENER:
Andy Greene2160712013-01-28 12:19:10 +08001046 case LWS_CONNMODE_SSL_ACK_PENDING:
Andy Greenb1a5e6c2013-03-09 12:34:30 +08001047 n = lws_server_socket_service(context, wsi, pollfd);
1048 goto handled;
Andy Greena1ce6be2013-01-18 11:43:21 +08001049#endif
Andy Greenbe93fef2011-02-14 20:25:43 +00001050
Andy Green0d338332011-02-12 11:57:43 +00001051 case LWS_CONNMODE_WS_SERVING:
1052 case LWS_CONNMODE_WS_CLIENT:
1053
Andy Green0d338332011-02-12 11:57:43 +00001054 /* the guy requested a callback when it was OK to write */
1055
Andy Greenda527df2011-03-07 07:08:12 +00001056 if ((pollfd->revents & POLLOUT) &&
Andy Greenca0a1292013-03-16 11:24:23 +08001057 wsi->state == WSI_STATE_ESTABLISHED &&
1058 lws_handle_POLLOUT_event(context, wsi, pollfd) < 0) {
Andy Green91f19d82013-12-21 11:18:34 +08001059 lwsl_info("libwebsocket_service_fd: closing\n");
1060 goto close_and_handled;
Graham Newtonb1aa1d32013-11-04 09:47:06 +08001061 }
Andy Green0d338332011-02-12 11:57:43 +00001062
Andy Greenca0a1292013-03-16 11:24:23 +08001063 if (wsi->u.ws.rxflow_buffer &&
1064 (wsi->u.ws.rxflow_change_to & LWS_RXFLOW_ALLOW)) {
1065 lwsl_info("draining rxflow\n");
1066 /* well, drain it */
1067 eff_buf.token = (char *)wsi->u.ws.rxflow_buffer +
1068 wsi->u.ws.rxflow_pos;
1069 eff_buf.token_len = wsi->u.ws.rxflow_len -
1070 wsi->u.ws.rxflow_pos;
1071 draining_flow = 1;
1072 goto drain;
1073 }
1074
Andy Green0d338332011-02-12 11:57:43 +00001075 /* any incoming data ready? */
1076
1077 if (!(pollfd->revents & POLLIN))
1078 break;
1079
Andy Greenb45993c2010-12-18 15:13:50 +00001080#ifdef LWS_OPENSSL_SUPPORT
David Galeano7ffbe1b2013-01-10 10:35:32 +08001081read_pending:
Andy Green467c7ef2013-01-30 12:28:34 +08001082 if (wsi->ssl) {
Andy Greene84652c2013-02-08 13:01:02 +08001083 eff_buf.token_len = SSL_read(wsi->ssl,
1084 context->service_buffer,
Andy Greenb5b23192013-02-11 17:13:32 +08001085 sizeof(context->service_buffer));
Andy Green467c7ef2013-01-30 12:28:34 +08001086 if (!eff_buf.token_len) {
1087 n = SSL_get_error(wsi->ssl, eff_buf.token_len);
Andy Greene84652c2013-02-08 13:01:02 +08001088 lwsl_err("SSL_read returned 0 with reason %s\n",
Andy Greenb5b23192013-02-11 17:13:32 +08001089 ERR_error_string(n,
1090 (char *)context->service_buffer));
Andy Green467c7ef2013-01-30 12:28:34 +08001091 }
1092 } else
Andy Greenb45993c2010-12-18 15:13:50 +00001093#endif
Andy Greene84652c2013-02-08 13:01:02 +08001094 eff_buf.token_len = recv(pollfd->fd,
Andy Greenb5b23192013-02-11 17:13:32 +08001095 context->service_buffer,
1096 sizeof(context->service_buffer), 0);
Andy Greenb45993c2010-12-18 15:13:50 +00001097
Andy Green98a717c2011-03-06 13:14:15 +00001098 if (eff_buf.token_len < 0) {
Andy Green98ba9e02013-03-23 09:44:47 +08001099 lwsl_debug("service_fd read ret = %d, errno = %d\n",
1100 eff_buf.token_len, errno);
Alon Levydc93b7f2012-10-19 11:21:57 +02001101 if (errno != EINTR && errno != EAGAIN)
Andy Greenb1a5e6c2013-03-09 12:34:30 +08001102 goto close_and_handled;
1103 n = 0;
1104 goto handled;
Andy Greenb45993c2010-12-18 15:13:50 +00001105 }
Andy Green98a717c2011-03-06 13:14:15 +00001106 if (!eff_buf.token_len) {
Andy Green98ba9e02013-03-23 09:44:47 +08001107 lwsl_info("service_fd: closing due to 0 length read\n");
Andy Greenb1a5e6c2013-03-09 12:34:30 +08001108 goto close_and_handled;
Andy Greenb45993c2010-12-18 15:13:50 +00001109 }
1110
Andy Green98a717c2011-03-06 13:14:15 +00001111 /*
1112 * give any active extensions a chance to munge the buffer
1113 * before parse. We pass in a pointer to an lws_tokens struct
1114 * prepared with the default buffer and content length that's in
1115 * there. Rather than rewrite the default buffer, extensions
1116 * that expect to grow the buffer can adapt .token to
1117 * point to their own per-connection buffer in the extension
1118 * user allocation. By default with no extensions or no
1119 * extension callback handling, just the normal input buffer is
1120 * used then so it is efficient.
1121 */
Andy Greenb45993c2010-12-18 15:13:50 +00001122
Andy Greene84652c2013-02-08 13:01:02 +08001123 eff_buf.token = (char *)context->service_buffer;
Andy Greenca0a1292013-03-16 11:24:23 +08001124drain:
Andy Green3182ece2013-01-20 17:08:31 +08001125#ifndef LWS_NO_EXTENSIONS
Andy Green98a717c2011-03-06 13:14:15 +00001126 more = 1;
1127 while (more) {
Andy Green0d338332011-02-12 11:57:43 +00001128
Andy Green98a717c2011-03-06 13:14:15 +00001129 more = 0;
1130
1131 for (n = 0; n < wsi->count_active_extensions; n++) {
Andy Green46c2ea02011-03-22 09:04:01 +00001132 m = wsi->active_extensions[n]->callback(context,
1133 wsi->active_extensions[n], wsi,
Andy Green98a717c2011-03-06 13:14:15 +00001134 LWS_EXT_CALLBACK_PACKET_RX_PREPARSE,
Andy Green46c2ea02011-03-22 09:04:01 +00001135 wsi->active_extensions_user[n],
1136 &eff_buf, 0);
Andy Green98a717c2011-03-06 13:14:15 +00001137 if (m < 0) {
Andy Green43db0452013-01-10 19:50:35 +08001138 lwsl_ext(
Andy Green6ee372f2012-04-09 15:09:01 +08001139 "Extension reports fatal error\n");
Andy Greenb1a5e6c2013-03-09 12:34:30 +08001140 goto close_and_handled;
Andy Green98a717c2011-03-06 13:14:15 +00001141 }
1142 if (m)
1143 more = 1;
1144 }
Andy Green3182ece2013-01-20 17:08:31 +08001145#endif
Andy Green98a717c2011-03-06 13:14:15 +00001146 /* service incoming data */
1147
1148 if (eff_buf.token_len) {
1149 n = libwebsocket_read(context, wsi,
Andy Green6ee372f2012-04-09 15:09:01 +08001150 (unsigned char *)eff_buf.token,
1151 eff_buf.token_len);
Andy Greenb1a5e6c2013-03-09 12:34:30 +08001152 if (n < 0) {
Andy Green98a717c2011-03-06 13:14:15 +00001153 /* we closed wsi */
Andy Greenb1a5e6c2013-03-09 12:34:30 +08001154 n = 0;
1155 goto handled;
1156 }
Andy Green98a717c2011-03-06 13:14:15 +00001157 }
Andy Green3182ece2013-01-20 17:08:31 +08001158#ifndef LWS_NO_EXTENSIONS
Andy Green98a717c2011-03-06 13:14:15 +00001159 eff_buf.token = NULL;
1160 eff_buf.token_len = 0;
1161 }
Andy Green3182ece2013-01-20 17:08:31 +08001162#endif
Andy Greenca0a1292013-03-16 11:24:23 +08001163 if (draining_flow && wsi->u.ws.rxflow_buffer &&
1164 wsi->u.ws.rxflow_pos == wsi->u.ws.rxflow_len) {
1165 lwsl_info("flow buffer: drained\n");
1166 free(wsi->u.ws.rxflow_buffer);
1167 wsi->u.ws.rxflow_buffer = NULL;
1168 /* having drained the rxflow buffer, can rearm POLLIN */
1169 _libwebsocket_rx_flow_control(wsi);
1170 }
David Galeano7ffbe1b2013-01-10 10:35:32 +08001171
1172#ifdef LWS_OPENSSL_SUPPORT
1173 if (wsi->ssl && SSL_pending(wsi->ssl))
1174 goto read_pending;
1175#endif
Andy Green98a717c2011-03-06 13:14:15 +00001176 break;
Andy Green76f61e72013-01-16 11:53:05 +08001177
1178 default:
Andy Green03674a62013-01-16 11:47:40 +08001179#ifdef LWS_NO_CLIENT
1180 break;
1181#else
Andy Greenb1a5e6c2013-03-09 12:34:30 +08001182 n = lws_client_socket_service(context, wsi, pollfd);
1183 goto handled;
Andy Green03674a62013-01-16 11:47:40 +08001184#endif
Andy Greenb45993c2010-12-18 15:13:50 +00001185 }
1186
Andy Greenb1a5e6c2013-03-09 12:34:30 +08001187 n = 0;
1188 goto handled;
1189
1190close_and_handled:
Andy Greenca0a1292013-03-16 11:24:23 +08001191 libwebsocket_close_and_free_session(context, wsi,
1192 LWS_CLOSE_STATUS_NOSTATUS);
1193 n = 1;
Andy Greenb1a5e6c2013-03-09 12:34:30 +08001194
1195handled:
1196 pollfd->revents = 0;
1197 return n;
Andy Greenb45993c2010-12-18 15:13:50 +00001198}
1199
Andy Green0d338332011-02-12 11:57:43 +00001200
Andy Green6964bb52011-01-23 16:50:33 +00001201/**
1202 * libwebsocket_context_destroy() - Destroy the websocket context
Peter Hinz56885f32011-03-02 22:03:47 +00001203 * @context: Websocket context
Andy Green6964bb52011-01-23 16:50:33 +00001204 *
1205 * This function closes any active connections and then frees the
1206 * context. After calling this, any further use of the context is
1207 * undefined.
1208 */
Peter Pentchev9a4fef72013-03-30 09:52:21 +08001209LWS_VISIBLE void
Peter Hinz56885f32011-03-02 22:03:47 +00001210libwebsocket_context_destroy(struct libwebsocket_context *context)
Andy Green6964bb52011-01-23 16:50:33 +00001211{
Andy Green0d338332011-02-12 11:57:43 +00001212 int n;
arnaudviala7c6f26c2014-02-15 14:39:40 +08001213#ifndef LWS_NO_EXTENSIONS
Andy Green0d338332011-02-12 11:57:43 +00001214 int m;
Andy Greena41314f2011-05-23 10:00:03 +01001215 struct libwebsocket_extension *ext;
arnaudviala7c6f26c2014-02-15 14:39:40 +08001216#endif /* ndef LWS_NO_EXTENSIONS */
Andy Greena7109e62013-02-11 12:05:54 +08001217 struct libwebsocket_protocols *protocol = context->protocols;
Andy Green6964bb52011-01-23 16:50:33 +00001218
Andy Greend636e352013-01-29 12:36:17 +08001219#ifdef LWS_LATENCY
1220 if (context->worst_latency_info[0])
1221 lwsl_notice("Worst latency: %s\n", context->worst_latency_info);
1222#endif
1223
Andy Greendfb23042013-01-17 12:26:48 +08001224 for (n = 0; n < context->fds_count; n++) {
Andy Greenb5b23192013-02-11 17:13:32 +08001225 struct libwebsocket *wsi =
1226 context->lws_lookup[context->fds[n].fd];
Andy Greendfb23042013-01-17 12:26:48 +08001227 libwebsocket_close_and_free_session(context,
Andy Green7b922052013-02-11 11:43:05 +08001228 wsi, LWS_CLOSE_STATUS_NOSTATUS /* no protocol close */);
1229 n--;
Andy Greendfb23042013-01-17 12:26:48 +08001230 }
Andy Green6964bb52011-01-23 16:50:33 +00001231
arnaudviala7c6f26c2014-02-15 14:39:40 +08001232#ifndef LWS_NO_EXTENSIONS
Andy Greena41314f2011-05-23 10:00:03 +01001233 /*
1234 * give all extensions a chance to clean up any per-context
1235 * allocations they might have made
1236 */
1237
1238 ext = context->extensions;
1239 m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_DESTRUCT;
1240 if (context->listen_port)
1241 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_DESTRUCT;
Paulo Roberto Urio1f680ab2012-06-04 08:40:28 +08001242 while (ext && ext->callback) {
Andy Greenb5b23192013-02-11 17:13:32 +08001243 ext->callback(context, ext, NULL,
1244 (enum libwebsocket_extension_callback_reasons)m,
1245 NULL, NULL, 0);
Andy Greena41314f2011-05-23 10:00:03 +01001246 ext++;
1247 }
arnaudviala7c6f26c2014-02-15 14:39:40 +08001248#endif /* ndef LWS_NO_EXTENSIONS */
Andy Greena7109e62013-02-11 12:05:54 +08001249
1250 /*
1251 * inform all the protocols that they are done and will have no more
1252 * callbacks
1253 */
1254
1255 while (protocol->callback) {
1256 protocol->callback(context, NULL, LWS_CALLBACK_PROTOCOL_DESTROY,
1257 NULL, NULL, 0);
1258 protocol++;
1259 }
1260
Andy Greena41314f2011-05-23 10:00:03 +01001261
Andreas Pakulat68bd4bd2013-10-28 15:18:04 +01001262#if defined(WIN32) || defined(_WIN32)
Peter Hinz56885f32011-03-02 22:03:47 +00001263#else
1264 close(context->fd_random);
Andy Green6964bb52011-01-23 16:50:33 +00001265#endif
1266
Peter Hinz56885f32011-03-02 22:03:47 +00001267#ifdef LWS_OPENSSL_SUPPORT
1268 if (context->ssl_ctx)
1269 SSL_CTX_free(context->ssl_ctx);
1270 if (context->ssl_client_ctx)
1271 SSL_CTX_free(context->ssl_client_ctx);
Andy Greenad686392013-02-11 14:50:45 +08001272
1273 ERR_remove_state(0);
1274 ERR_free_strings();
1275 EVP_cleanup();
1276 CRYPTO_cleanup_all_ex_data();
Peter Hinz56885f32011-03-02 22:03:47 +00001277#endif
1278
Andy Green46596482013-02-11 11:04:01 +08001279 if (context->fds)
1280 free(context->fds);
1281 if (context->lws_lookup)
1282 free(context->lws_lookup);
1283
Peter Hinz56885f32011-03-02 22:03:47 +00001284 free(context);
1285
Andreas Pakulat68bd4bd2013-10-28 15:18:04 +01001286#if defined(WIN32) || defined(_WIN32)
Peter Hinz56885f32011-03-02 22:03:47 +00001287 WSACleanup();
1288#endif
Andy Green6964bb52011-01-23 16:50:33 +00001289}
1290
Andy Greend88146d2013-01-22 12:40:35 +08001291/**
Andy Greenb5b23192013-02-11 17:13:32 +08001292 * libwebsocket_context_user() - get the user data associated with the context
Andy Greend88146d2013-01-22 12:40:35 +08001293 * @context: Websocket context
1294 *
1295 * This returns the optional user allocation that can be attached to
1296 * the context the sockets live in at context_create time. It's a way
1297 * to let all sockets serviced in the same context share data without
1298 * using globals statics in the user code.
1299 */
Alon Levy0291eb32012-10-19 11:21:56 +02001300LWS_EXTERN void *
1301libwebsocket_context_user(struct libwebsocket_context *context)
1302{
Andy Greenb5b23192013-02-11 17:13:32 +08001303 return context->user_space;
Alon Levy0291eb32012-10-19 11:21:56 +02001304}
1305
Andy Green6964bb52011-01-23 16:50:33 +00001306/**
1307 * libwebsocket_service() - Service any pending websocket activity
Peter Hinz56885f32011-03-02 22:03:47 +00001308 * @context: Websocket context
Andy Green6964bb52011-01-23 16:50:33 +00001309 * @timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
1310 * service otherwise block and service immediately, returning
1311 * after the timeout if nothing needed service.
1312 *
1313 * This function deals with any pending websocket traffic, for three
1314 * kinds of event. It handles these events on both server and client
1315 * types of connection the same.
1316 *
1317 * 1) Accept new connections to our context's server
1318 *
Andy Green6f520a52013-01-29 17:57:39 +08001319 * 2) Call the receive callback for incoming frame data received by
Andy Green6964bb52011-01-23 16:50:33 +00001320 * server or client connections.
1321 *
1322 * You need to call this service function periodically to all the above
1323 * functions to happen; if your application is single-threaded you can
1324 * just call it in your main event loop.
1325 *
1326 * Alternatively you can fork a new process that asynchronously handles
1327 * calling this service in a loop. In that case you are happy if this
1328 * call blocks your thread until it needs to take care of something and
1329 * would call it with a large nonzero timeout. Your loop then takes no
1330 * CPU while there is nothing happening.
1331 *
1332 * If you are calling it in a single-threaded app, you don't want it to
1333 * wait around blocking other things in your loop from happening, so you
1334 * would call it with a timeout_ms of 0, so it returns immediately if
1335 * nothing is pending, or as soon as it services whatever was pending.
1336 */
1337
Peter Pentchev9a4fef72013-03-30 09:52:21 +08001338LWS_VISIBLE int
Peter Hinz56885f32011-03-02 22:03:47 +00001339libwebsocket_service(struct libwebsocket_context *context, int timeout_ms)
Andy Greene92cd172011-01-19 13:11:55 +00001340{
1341 int n;
Andy Greenca0a1292013-03-16 11:24:23 +08001342 int m;
Andy Green3b3fa9e2013-12-25 16:34:37 +08001343#ifdef LWS_HAS_PPOLL
1344 struct timespec timeout_ts;
1345 sigset_t sigmask;
1346#endif
Andy Greene92cd172011-01-19 13:11:55 +00001347
1348 /* stay dead once we are dead */
1349
Peter Hinz56885f32011-03-02 22:03:47 +00001350 if (context == NULL)
Andy Greene92cd172011-01-19 13:11:55 +00001351 return 1;
1352
Andy Green3b3fa9e2013-12-25 16:34:37 +08001353#ifdef LWS_HAS_PPOLL
1354 lws_idling_ppoll_tid = context->protocols[0].callback(context, NULL,
1355 LWS_CALLBACK_GET_THREAD_ID, NULL, NULL, 0);
1356
1357 timeout_ts.tv_sec = timeout_ms / 1000;
1358 timeout_ts.tv_nsec = timeout_ms % 1000;
Andy Greened451d52014-01-11 12:37:07 +08001359
1360 sigprocmask(SIG_BLOCK, NULL, &sigmask);
1361 sigdelset(&sigmask, SIGUSR2);
Andy Green3b3fa9e2013-12-25 16:34:37 +08001362
Andy Green0d338332011-02-12 11:57:43 +00001363 /* wait for something to need service */
Andy Green4739e5c2011-01-22 12:51:57 +00001364
Andy Green3b3fa9e2013-12-25 16:34:37 +08001365 n = ppoll(context->fds, context->fds_count, &timeout_ts, &sigmask);
1366 lws_idling_ppoll_tid = 0;
1367#else
Peter Hinz56885f32011-03-02 22:03:47 +00001368 n = poll(context->fds, context->fds_count, timeout_ms);
Andy Green3b3fa9e2013-12-25 16:34:37 +08001369#endif
Andy Green5dc62ea2013-09-20 20:26:12 +08001370 if (n == 0) /* poll timeout */ {
1371 libwebsocket_service_fd(context, NULL);
Andy Green3221f922011-02-12 13:14:11 +00001372 return 0;
Andy Green5dc62ea2013-09-20 20:26:12 +08001373 }
Andy Greene92cd172011-01-19 13:11:55 +00001374
Andy Greened451d52014-01-11 12:37:07 +08001375 if (n < 0) {
1376 if (errno != EINTR)
1377 return -1;
1378 else
1379 return 0;
1380 }
Andy Greene92cd172011-01-19 13:11:55 +00001381
Andy Greendfb23042013-01-17 12:26:48 +08001382 /* any socket with events to service? */
Andy Greene92cd172011-01-19 13:11:55 +00001383
Andy Greenca0a1292013-03-16 11:24:23 +08001384 for (n = 0; n < context->fds_count; n++) {
1385 if (!context->fds[n].revents)
1386 continue;
1387 m = libwebsocket_service_fd(context, &context->fds[n]);
1388 if (m < 0)
1389 return -1;
1390 /* if something closed, retry this slot */
1391 if (m)
1392 n--;
1393 }
1394
Andy Greene92cd172011-01-19 13:11:55 +00001395 return 0;
Andy Greene92cd172011-01-19 13:11:55 +00001396}
1397
Andy Green3182ece2013-01-20 17:08:31 +08001398#ifndef LWS_NO_EXTENSIONS
Andy Greena41314f2011-05-23 10:00:03 +01001399int
1400lws_any_extension_handled(struct libwebsocket_context *context,
Andy Green6ee372f2012-04-09 15:09:01 +08001401 struct libwebsocket *wsi,
1402 enum libwebsocket_extension_callback_reasons r,
Andy Greena41314f2011-05-23 10:00:03 +01001403 void *v, size_t len)
1404{
1405 int n;
1406 int handled = 0;
1407
1408 /* maybe an extension will take care of it for us */
1409
1410 for (n = 0; n < wsi->count_active_extensions && !handled; n++) {
1411 if (!wsi->active_extensions[n]->callback)
1412 continue;
1413
1414 handled |= wsi->active_extensions[n]->callback(context,
1415 wsi->active_extensions[n], wsi,
1416 r, wsi->active_extensions_user[n], v, len);
1417 }
1418
1419 return handled;
1420}
1421
1422
1423void *
1424lws_get_extension_user_matching_ext(struct libwebsocket *wsi,
Andy Green6ee372f2012-04-09 15:09:01 +08001425 struct libwebsocket_extension *ext)
Andy Greena41314f2011-05-23 10:00:03 +01001426{
1427 int n = 0;
1428
Andy Green68b45042011-05-25 21:41:57 +01001429 if (wsi == NULL)
1430 return NULL;
1431
Andy Greena41314f2011-05-23 10:00:03 +01001432 while (n < wsi->count_active_extensions) {
1433 if (wsi->active_extensions[n] != ext) {
1434 n++;
1435 continue;
1436 }
1437 return wsi->active_extensions_user[n];
1438 }
1439
1440 return NULL;
1441}
Andy Green3182ece2013-01-20 17:08:31 +08001442#endif
Andy Greena41314f2011-05-23 10:00:03 +01001443
Andy Green91f19d82013-12-21 11:18:34 +08001444void
1445lws_change_pollfd(struct libwebsocket *wsi, int _and, int _or)
1446{
1447 struct libwebsocket_context *context = wsi->protocol->owning_server;
Andy Green3b3fa9e2013-12-25 16:34:37 +08001448 int events;
1449#ifdef LWS_HAS_PPOLL
1450 int tid;
1451 int sampled_ppoll_tid;
1452#endif
Andy Green91f19d82013-12-21 11:18:34 +08001453
1454 context->protocols[0].callback(context, wsi,
1455 LWS_CALLBACK_LOCK_POLL,
1456 wsi->user_space, (void *)(long)wsi->sock, 0);
1457
Andy Green3b3fa9e2013-12-25 16:34:37 +08001458 events = context->fds[wsi->position_in_fds_table].events;
1459
1460 context->fds[wsi->position_in_fds_table].events = (events & ~_and) | _or;
Andy Green91f19d82013-12-21 11:18:34 +08001461
1462 /* external POLL support via protocol 0 */
1463 if (_and)
1464 context->protocols[0].callback(context, wsi,
1465 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
1466 wsi->user_space, (void *)(long)wsi->sock, _and);
1467
1468 if (_or)
1469 context->protocols[0].callback(context, wsi,
1470 LWS_CALLBACK_SET_MODE_POLL_FD,
1471 wsi->user_space, (void *)(long)wsi->sock, _or);
1472
Andy Green3b3fa9e2013-12-25 16:34:37 +08001473#ifdef LWS_HAS_PPOLL
1474 /*
1475 * if we changed something in this pollfd...
1476 * ... and we're running in a different thread context
1477 * than the service thread...
1478 * ... and the service thread is waiting in ppoll()...
1479 * then fire a SIGUSR2 at the service thread to force it to
1480 * restart the ppoll() with our changed events
1481 */
1482 if (events != context->fds[wsi->position_in_fds_table].events) {
1483 sampled_ppoll_tid = lws_idling_ppoll_tid;
1484 if (sampled_ppoll_tid) {
1485 tid = context->protocols[0].callback(context, NULL,
1486 LWS_CALLBACK_GET_THREAD_ID, NULL, NULL, 0);
1487 if (tid != sampled_ppoll_tid)
1488 kill(sampled_ppoll_tid, SIGUSR2);
1489 }
1490 }
1491#endif
1492
Andy Green91f19d82013-12-21 11:18:34 +08001493 context->protocols[0].callback(context, wsi,
1494 LWS_CALLBACK_UNLOCK_POLL,
1495 wsi->user_space, (void *)(long)wsi->sock, 0);
1496}
1497
1498
Andy Green90c7cbc2011-01-27 06:26:52 +00001499/**
1500 * libwebsocket_callback_on_writable() - Request a callback when this socket
1501 * becomes able to be written to without
1502 * blocking
Andy Green32375b72011-02-19 08:32:53 +00001503 *
Peter Hinz56885f32011-03-02 22:03:47 +00001504 * @context: libwebsockets context
Andy Green90c7cbc2011-01-27 06:26:52 +00001505 * @wsi: Websocket connection instance to get callback for
1506 */
1507
Peter Pentchev9a4fef72013-03-30 09:52:21 +08001508LWS_VISIBLE int
Peter Hinz56885f32011-03-02 22:03:47 +00001509libwebsocket_callback_on_writable(struct libwebsocket_context *context,
Andy Green6ee372f2012-04-09 15:09:01 +08001510 struct libwebsocket *wsi)
Andy Green90c7cbc2011-01-27 06:26:52 +00001511{
Andy Green3182ece2013-01-20 17:08:31 +08001512#ifndef LWS_NO_EXTENSIONS
Andy Green90c7cbc2011-01-27 06:26:52 +00001513 int n;
Andy Greena41314f2011-05-23 10:00:03 +01001514 int handled = 0;
1515
1516 /* maybe an extension will take care of it for us */
1517
1518 for (n = 0; n < wsi->count_active_extensions; n++) {
1519 if (!wsi->active_extensions[n]->callback)
1520 continue;
1521
1522 handled |= wsi->active_extensions[n]->callback(context,
1523 wsi->active_extensions[n], wsi,
1524 LWS_EXT_CALLBACK_REQUEST_ON_WRITEABLE,
1525 wsi->active_extensions_user[n], NULL, 0);
1526 }
1527
1528 if (handled)
1529 return 1;
Andy Green3182ece2013-01-20 17:08:31 +08001530#endif
Andy Greendfb23042013-01-17 12:26:48 +08001531 if (wsi->position_in_fds_table < 0) {
Andy Greenb5b23192013-02-11 17:13:32 +08001532 lwsl_err("libwebsocket_callback_on_writable: failed to find socket %d\n",
1533 wsi->sock);
Andy Greendfb23042013-01-17 12:26:48 +08001534 return -1;
1535 }
1536
Andy Green91f19d82013-12-21 11:18:34 +08001537 lws_change_pollfd(wsi, 0, POLLOUT);
Andy Green7a132792013-12-18 09:48:26 +08001538
Andy Green90c7cbc2011-01-27 06:26:52 +00001539 return 1;
1540}
1541
1542/**
1543 * libwebsocket_callback_on_writable_all_protocol() - Request a callback for
1544 * all connections using the given protocol when it
1545 * becomes possible to write to each socket without
1546 * blocking in turn.
1547 *
1548 * @protocol: Protocol whose connections will get callbacks
1549 */
1550
Peter Pentchev9a4fef72013-03-30 09:52:21 +08001551LWS_VISIBLE int
Andy Green90c7cbc2011-01-27 06:26:52 +00001552libwebsocket_callback_on_writable_all_protocol(
1553 const struct libwebsocket_protocols *protocol)
1554{
Peter Hinz56885f32011-03-02 22:03:47 +00001555 struct libwebsocket_context *context = protocol->owning_server;
Andy Green90c7cbc2011-01-27 06:26:52 +00001556 int n;
Andy Green0d338332011-02-12 11:57:43 +00001557 struct libwebsocket *wsi;
Andy Green90c7cbc2011-01-27 06:26:52 +00001558
Andy Greendfb23042013-01-17 12:26:48 +08001559 for (n = 0; n < context->fds_count; n++) {
1560 wsi = context->lws_lookup[context->fds[n].fd];
1561 if (!wsi)
1562 continue;
1563 if (wsi->protocol == protocol)
1564 libwebsocket_callback_on_writable(context, wsi);
Andy Green0d338332011-02-12 11:57:43 +00001565 }
Andy Green90c7cbc2011-01-27 06:26:52 +00001566
1567 return 0;
1568}
1569
Andy Greenbe93fef2011-02-14 20:25:43 +00001570/**
Andy Greene39e6ef2014-02-15 16:36:38 +08001571 * libwebsocket_callback_all_protocol() - Callback all connections using
1572 * the given protocol with the given reason
1573 *
1574 * @protocol: Protocol whose connections will get callbacks
1575 * @reason: Callback reason index
1576 */
1577
1578LWS_VISIBLE int
1579libwebsocket_callback_all_protocol(
1580 const struct libwebsocket_protocols *protocol, int reason)
1581{
1582 struct libwebsocket_context *context = protocol->owning_server;
1583 int n;
1584 struct libwebsocket *wsi;
1585
1586 for (n = 0; n < context->fds_count; n++) {
1587 wsi = context->lws_lookup[context->fds[n].fd];
1588 if (!wsi)
1589 continue;
1590 if (wsi->protocol == protocol)
1591 protocol->callback(context, wsi,
1592 reason, wsi->user_space, NULL, 0);
1593 }
1594
1595 return 0;
1596}
1597
1598/**
Andy Greenbe93fef2011-02-14 20:25:43 +00001599 * libwebsocket_set_timeout() - marks the wsi as subject to a timeout
1600 *
1601 * You will not need this unless you are doing something special
1602 *
1603 * @wsi: Websocket connection instance
1604 * @reason: timeout reason
1605 * @secs: how many seconds
1606 */
1607
1608void
1609libwebsocket_set_timeout(struct libwebsocket *wsi,
1610 enum pending_timeout reason, int secs)
1611{
1612 struct timeval tv;
1613
1614 gettimeofday(&tv, NULL);
1615
1616 wsi->pending_timeout_limit = tv.tv_sec + secs;
1617 wsi->pending_timeout = reason;
1618}
1619
Andy Greena6cbece2011-01-27 20:06:03 +00001620
1621/**
1622 * libwebsocket_get_socket_fd() - returns the socket file descriptor
1623 *
1624 * You will not need this unless you are doing something special
1625 *
1626 * @wsi: Websocket connection instance
1627 */
1628
Peter Pentchev9a4fef72013-03-30 09:52:21 +08001629LWS_VISIBLE int
Andy Greena6cbece2011-01-27 20:06:03 +00001630libwebsocket_get_socket_fd(struct libwebsocket *wsi)
1631{
1632 return wsi->sock;
1633}
1634
Andy Greend636e352013-01-29 12:36:17 +08001635#ifdef LWS_LATENCY
1636void
Andy Greenb5b23192013-02-11 17:13:32 +08001637lws_latency(struct libwebsocket_context *context, struct libwebsocket *wsi,
1638 const char *action, int ret, int completed)
Andy Greend636e352013-01-29 12:36:17 +08001639{
1640 struct timeval tv;
1641 unsigned long u;
1642 char buf[256];
1643
1644 gettimeofday(&tv, NULL);
1645
1646 u = (tv.tv_sec * 1000000) + tv.tv_usec;
1647
1648 if (action) {
1649 if (completed) {
1650 if (wsi->action_start == wsi->latency_start)
Andy Greenb5b23192013-02-11 17:13:32 +08001651 sprintf(buf,
1652 "Completion first try lat %luus: %p: ret %d: %s\n",
1653 u - wsi->latency_start,
1654 (void *)wsi, ret, action);
Andy Greend636e352013-01-29 12:36:17 +08001655 else
Andy Greenb5b23192013-02-11 17:13:32 +08001656 sprintf(buf,
1657 "Completion %luus: lat %luus: %p: ret %d: %s\n",
1658 u - wsi->action_start,
1659 u - wsi->latency_start,
1660 (void *)wsi, ret, action);
Andy Greend636e352013-01-29 12:36:17 +08001661 wsi->action_start = 0;
1662 } else
Andy Greenb5b23192013-02-11 17:13:32 +08001663 sprintf(buf, "lat %luus: %p: ret %d: %s\n",
1664 u - wsi->latency_start,
1665 (void *)wsi, ret, action);
Andy Greend636e352013-01-29 12:36:17 +08001666 if (u - wsi->latency_start > context->worst_latency) {
1667 context->worst_latency = u - wsi->latency_start;
1668 strcpy(context->worst_latency_info, buf);
1669 }
1670 lwsl_latency("%s", buf);
1671 } else {
1672 wsi->latency_start = u;
1673 if (!wsi->action_start)
1674 wsi->action_start = u;
1675 }
1676}
1677#endif
1678
Andy Greena1ce6be2013-01-18 11:43:21 +08001679#ifdef LWS_NO_SERVER
1680int
Andy Green8d15cf42013-10-24 21:47:06 +08001681_libwebsocket_rx_flow_control(struct libwebsocket *wsi)
Andy Greena1ce6be2013-01-18 11:43:21 +08001682{
1683 return 0;
1684}
1685#else
Andy Green706961d2013-01-17 16:50:35 +08001686int
1687_libwebsocket_rx_flow_control(struct libwebsocket *wsi)
1688{
1689 struct libwebsocket_context *context = wsi->protocol->owning_server;
Andy Green706961d2013-01-17 16:50:35 +08001690
Andy Greenca0a1292013-03-16 11:24:23 +08001691 /* there is no pending change */
1692 if (!(wsi->u.ws.rxflow_change_to & LWS_RXFLOW_PENDING_CHANGE))
Andy Green706961d2013-01-17 16:50:35 +08001693 return 0;
1694
Andy Greenca0a1292013-03-16 11:24:23 +08001695 /* stuff is still buffered, not ready to really accept new input */
1696 if (wsi->u.ws.rxflow_buffer) {
1697 /* get ourselves called back to deal with stashed buffer */
1698 libwebsocket_callback_on_writable(context, wsi);
1699 return 0;
Andy Green706961d2013-01-17 16:50:35 +08001700 }
1701
Andy Greenca0a1292013-03-16 11:24:23 +08001702 /* pending is cleared, we can change rxflow state */
1703
1704 wsi->u.ws.rxflow_change_to &= ~LWS_RXFLOW_PENDING_CHANGE;
1705
1706 lwsl_info("rxflow: wsi %p change_to %d\n", wsi,
1707 wsi->u.ws.rxflow_change_to & LWS_RXFLOW_ALLOW);
1708
1709 /* adjust the pollfd for this wsi */
1710
1711 if (wsi->u.ws.rxflow_change_to & LWS_RXFLOW_ALLOW)
Andy Green91f19d82013-12-21 11:18:34 +08001712 lws_change_pollfd(wsi, 0, POLLIN);
Andy Green706961d2013-01-17 16:50:35 +08001713 else
Andy Green91f19d82013-12-21 11:18:34 +08001714 lws_change_pollfd(wsi, POLLIN, 0);
Andy Green7a132792013-12-18 09:48:26 +08001715
Andy Green706961d2013-01-17 16:50:35 +08001716 return 1;
1717}
Andy Greena1ce6be2013-01-18 11:43:21 +08001718#endif
Andy Green706961d2013-01-17 16:50:35 +08001719
Andy Green90c7cbc2011-01-27 06:26:52 +00001720/**
1721 * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
1722 * receieved packets.
1723 *
1724 * If the output side of a server process becomes choked, this allows flow
1725 * control for the input side.
1726 *
1727 * @wsi: Websocket connection instance to get callback for
1728 * @enable: 0 = disable read servicing for this connection, 1 = enable
1729 */
1730
Peter Pentchev9a4fef72013-03-30 09:52:21 +08001731LWS_VISIBLE int
Andy Green90c7cbc2011-01-27 06:26:52 +00001732libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
1733{
Andy Greenca0a1292013-03-16 11:24:23 +08001734 if (enable == (wsi->u.ws.rxflow_change_to & LWS_RXFLOW_ALLOW))
1735 return 0;
1736
1737 lwsl_info("libwebsocket_rx_flow_control(0x%p, %d)\n", wsi, enable);
1738 wsi->u.ws.rxflow_change_to = LWS_RXFLOW_PENDING_CHANGE | !!enable;
Andy Green90c7cbc2011-01-27 06:26:52 +00001739
Andy Green706961d2013-01-17 16:50:35 +08001740 return 0;
Andy Green90c7cbc2011-01-27 06:26:52 +00001741}
1742
Andy Greenb55451c2013-03-16 12:32:27 +08001743/**
1744 * libwebsocket_rx_flow_allow_all_protocol() - Allow all connections with this protocol to receive
1745 *
1746 * When the user server code realizes it can accept more input, it can
1747 * call this to have the RX flow restriction removed from all connections using
1748 * the given protocol.
1749 *
1750 * @protocol: all connections using this protocol will be allowed to receive
1751 */
1752
Peter Pentchev9a4fef72013-03-30 09:52:21 +08001753LWS_VISIBLE void
Andy Greenb55451c2013-03-16 12:32:27 +08001754libwebsocket_rx_flow_allow_all_protocol(
1755 const struct libwebsocket_protocols *protocol)
1756{
1757 struct libwebsocket_context *context = protocol->owning_server;
1758 int n;
1759 struct libwebsocket *wsi;
1760
1761 for (n = 0; n < context->fds_count; n++) {
1762 wsi = context->lws_lookup[context->fds[n].fd];
1763 if (!wsi)
1764 continue;
1765 if (wsi->protocol == protocol)
1766 libwebsocket_rx_flow_control(wsi, LWS_RXFLOW_ALLOW);
1767 }
1768}
1769
Andy Green706961d2013-01-17 16:50:35 +08001770
Andy Green2ac5a6f2011-01-28 10:00:18 +00001771/**
1772 * libwebsocket_canonical_hostname() - returns this host's hostname
1773 *
1774 * This is typically used by client code to fill in the host parameter
1775 * when making a client connection. You can only call it after the context
1776 * has been created.
1777 *
Peter Hinz56885f32011-03-02 22:03:47 +00001778 * @context: Websocket context
Andy Green2ac5a6f2011-01-28 10:00:18 +00001779 */
1780
1781
Peter Pentchev9a4fef72013-03-30 09:52:21 +08001782LWS_VISIBLE extern const char *
Peter Hinz56885f32011-03-02 22:03:47 +00001783libwebsocket_canonical_hostname(struct libwebsocket_context *context)
Andy Green2ac5a6f2011-01-28 10:00:18 +00001784{
Peter Hinz56885f32011-03-02 22:03:47 +00001785 return (const char *)context->canonical_hostname;
Andy Green2ac5a6f2011-01-28 10:00:18 +00001786}
1787
1788
Andy Green90c7cbc2011-01-27 06:26:52 +00001789static void sigpipe_handler(int x)
1790{
1791}
1792
Andy Green6901cb32011-02-21 08:06:47 +00001793#ifdef LWS_OPENSSL_SUPPORT
1794static int
1795OpenSSL_verify_callback(int preverify_ok, X509_STORE_CTX *x509_ctx)
1796{
1797
1798 SSL *ssl;
1799 int n;
Andy Green2e24da02011-03-05 16:12:04 +00001800 struct libwebsocket_context *context;
Andy Green6901cb32011-02-21 08:06:47 +00001801
1802 ssl = X509_STORE_CTX_get_ex_data(x509_ctx,
1803 SSL_get_ex_data_X509_STORE_CTX_idx());
1804
1805 /*
Andy Green2e24da02011-03-05 16:12:04 +00001806 * !!! nasty openssl requires the index to come as a library-scope
1807 * static
Andy Green6901cb32011-02-21 08:06:47 +00001808 */
Andy Green2e24da02011-03-05 16:12:04 +00001809 context = SSL_get_ex_data(ssl, openssl_websocket_private_data_index);
Andy Green6ee372f2012-04-09 15:09:01 +08001810
Peter Hinz56885f32011-03-02 22:03:47 +00001811 n = context->protocols[0].callback(NULL, NULL,
Andy Green6901cb32011-02-21 08:06:47 +00001812 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION,
1813 x509_ctx, ssl, preverify_ok);
1814
1815 /* convert return code from 0 = OK to 1 = OK */
1816
1817 if (!n)
1818 n = 1;
1819 else
1820 n = 0;
1821
1822 return n;
1823}
1824#endif
1825
Andy Green706961d2013-01-17 16:50:35 +08001826int user_callback_handle_rxflow(callback_function callback_function,
Andy Greenb5b23192013-02-11 17:13:32 +08001827 struct libwebsocket_context *context,
Andy Green706961d2013-01-17 16:50:35 +08001828 struct libwebsocket *wsi,
1829 enum libwebsocket_callback_reasons reason, void *user,
1830 void *in, size_t len)
1831{
1832 int n;
1833
1834 n = callback_function(context, wsi, reason, user, in, len);
Andy Greenaedc9532013-02-10 21:21:24 +08001835 if (!n)
1836 n = _libwebsocket_rx_flow_control(wsi);
Andy Green706961d2013-01-17 16:50:35 +08001837
Andy Greenaedc9532013-02-10 21:21:24 +08001838 return n;
Andy Green706961d2013-01-17 16:50:35 +08001839}
1840
Andy Green3b3fa9e2013-12-25 16:34:37 +08001841/*
1842 * This is just used to interrupt poll waiting
1843 * we don't have to do anything with it.
1844 */
arnaudviala7c6f26c2014-02-15 14:39:40 +08001845#ifdef LWS_OPENSSL_SUPPORT
Andy Green3b3fa9e2013-12-25 16:34:37 +08001846static void lws_sigusr2(int sig)
1847{
1848}
arnaudviala7c6f26c2014-02-15 14:39:40 +08001849#endif
Andy Greenb45993c2010-12-18 15:13:50 +00001850
Andy Greenab990e42010-10-31 12:42:52 +00001851/**
Andy Green4739e5c2011-01-22 12:51:57 +00001852 * libwebsocket_create_context() - Create the websocket handler
Andy Green1b265272013-02-09 14:01:09 +08001853 * @info: pointer to struct with parameters
Andy Green05464c62010-11-12 10:44:18 +00001854 *
Andy Green1b265272013-02-09 14:01:09 +08001855 * This function creates the listening socket (if serving) and takes care
Andy Green8f037e42010-12-19 22:13:26 +00001856 * of all initialization in one step.
1857 *
Andy Greene92cd172011-01-19 13:11:55 +00001858 * After initialization, it returns a struct libwebsocket_context * that
1859 * represents this server. After calling, user code needs to take care
1860 * of calling libwebsocket_service() with the context pointer to get the
1861 * server's sockets serviced. This can be done in the same process context
1862 * or a forked process, or another thread,
Andy Green05464c62010-11-12 10:44:18 +00001863 *
Andy Green8f037e42010-12-19 22:13:26 +00001864 * The protocol callback functions are called for a handful of events
1865 * including http requests coming in, websocket connections becoming
1866 * established, and data arriving; it's also called periodically to allow
1867 * async transmission.
1868 *
1869 * HTTP requests are sent always to the FIRST protocol in @protocol, since
1870 * at that time websocket protocol has not been negotiated. Other
1871 * protocols after the first one never see any HTTP callack activity.
1872 *
1873 * The server created is a simple http server by default; part of the
1874 * websocket standard is upgrading this http connection to a websocket one.
1875 *
1876 * This allows the same server to provide files like scripts and favicon /
1877 * images or whatever over http and dynamic data over websockets all in
1878 * one place; they're all handled in the user callback.
Andy Greenab990e42010-10-31 12:42:52 +00001879 */
Andy Green4ea60062010-10-30 12:15:07 +01001880
Peter Pentchev9a4fef72013-03-30 09:52:21 +08001881LWS_VISIBLE struct libwebsocket_context *
Andy Green1b265272013-02-09 14:01:09 +08001882libwebsocket_create_context(struct lws_context_creation_info *info)
Andy Greenff95d7a2010-10-28 22:36:01 +01001883{
Peter Hinz56885f32011-03-02 22:03:47 +00001884 struct libwebsocket_context *context = NULL;
Andy Green9659f372011-01-27 22:01:43 +00001885 char *p;
Andy Green14f47292013-02-11 19:36:15 +08001886 int n;
Joakim Soderberg3baa08c2013-02-22 09:27:59 +08001887#ifndef LWS_NO_SERVER
Andy Greencbb31222013-01-31 09:57:05 +08001888 int opt = 1;
Andy Green0d338332011-02-12 11:57:43 +00001889 struct libwebsocket *wsi;
Andy Greencbb31222013-01-31 09:57:05 +08001890 struct sockaddr_in serv_addr;
1891#endif
Andy Green3182ece2013-01-20 17:08:31 +08001892#ifndef LWS_NO_EXTENSIONS
1893 int m;
Andy Green1b265272013-02-09 14:01:09 +08001894 struct libwebsocket_extension *ext;
Andy Green3182ece2013-01-20 17:08:31 +08001895#endif
Andy Greenff95d7a2010-10-28 22:36:01 +01001896
Andy Green3faa9c72010-11-08 17:03:03 +00001897#ifdef LWS_OPENSSL_SUPPORT
Andy Greenf2f54d52010-11-15 22:08:00 +00001898 SSL_METHOD *method;
Andy Green3faa9c72010-11-08 17:03:03 +00001899#endif
1900
Joakim Soderberg4c531232013-02-06 15:26:58 +09001901#ifndef LWS_NO_DAEMONIZE
Joakim Söderberg68e8d732013-02-06 15:27:39 +09001902 int pid_daemon = get_daemonize_pid();
Joakim Soderberg4c531232013-02-06 15:26:58 +09001903#endif
1904
Andy Greenb3a614a2013-01-19 13:08:17 +08001905 lwsl_notice("Initial logging level %d\n", log_level);
Andy Green7b405452013-02-01 10:50:15 +08001906 lwsl_notice("Library version: %s\n", library_version);
Andy Greenc0d6b632013-01-12 23:42:17 +08001907 lwsl_info(" LWS_MAX_HEADER_LEN: %u\n", LWS_MAX_HEADER_LEN);
Andy Greenc0d6b632013-01-12 23:42:17 +08001908 lwsl_info(" LWS_MAX_PROTOCOLS: %u\n", LWS_MAX_PROTOCOLS);
Andy Green3182ece2013-01-20 17:08:31 +08001909#ifndef LWS_NO_EXTENSIONS
Andy Greenb5b23192013-02-11 17:13:32 +08001910 lwsl_info(" LWS_MAX_EXTENSIONS_ACTIVE: %u\n",
1911 LWS_MAX_EXTENSIONS_ACTIVE);
Andy Green3182ece2013-01-20 17:08:31 +08001912#else
1913 lwsl_notice(" Configured without extension support\n");
1914#endif
Andy Greenc0d6b632013-01-12 23:42:17 +08001915 lwsl_info(" SPEC_LATEST_SUPPORTED: %u\n", SPEC_LATEST_SUPPORTED);
1916 lwsl_info(" AWAITING_TIMEOUT: %u\n", AWAITING_TIMEOUT);
Andy Green2672fb22013-02-22 09:54:35 +08001917 if (info->ssl_cipher_list)
1918 lwsl_info(" SSL ciphers: '%s'\n", info->ssl_cipher_list);
Andy Greenc0d6b632013-01-12 23:42:17 +08001919 lwsl_info(" SYSTEM_RANDOM_FILEPATH: '%s'\n", SYSTEM_RANDOM_FILEPATH);
1920 lwsl_info(" LWS_MAX_ZLIB_CONN_BUFFER: %u\n", LWS_MAX_ZLIB_CONN_BUFFER);
Andy Green43db0452013-01-10 19:50:35 +08001921
Peter Hinz56885f32011-03-02 22:03:47 +00001922#ifdef _WIN32
1923 {
1924 WORD wVersionRequested;
1925 WSADATA wsaData;
1926 int err;
Andy Green6ee372f2012-04-09 15:09:01 +08001927 HMODULE wsdll;
Peter Hinz56885f32011-03-02 22:03:47 +00001928
1929 /* Use the MAKEWORD(lowbyte, highbyte) macro from Windef.h */
1930 wVersionRequested = MAKEWORD(2, 2);
1931
1932 err = WSAStartup(wVersionRequested, &wsaData);
1933 if (err != 0) {
1934 /* Tell the user that we could not find a usable */
1935 /* Winsock DLL. */
Andy Green43db0452013-01-10 19:50:35 +08001936 lwsl_err("WSAStartup failed with error: %d\n", err);
Peter Hinz56885f32011-03-02 22:03:47 +00001937 return NULL;
1938 }
David Galeano7b11fec2011-10-04 19:55:18 +08001939
Andy Green6ee372f2012-04-09 15:09:01 +08001940 /* default to a poll() made out of select() */
1941 poll = emulated_poll;
David Galeano7b11fec2011-10-04 19:55:18 +08001942
Andy Green6ee372f2012-04-09 15:09:01 +08001943 /* if windows socket lib available, use his WSAPoll */
David Galeanocb193682013-01-09 15:29:00 +08001944 wsdll = GetModuleHandle(_T("Ws2_32.dll"));
Andy Green6ee372f2012-04-09 15:09:01 +08001945 if (wsdll)
1946 poll = (PFNWSAPOLL)GetProcAddress(wsdll, "WSAPoll");
Joakim Soderberg4c531232013-02-06 15:26:58 +09001947
Joakim Söderberg68e8d732013-02-06 15:27:39 +09001948 /* Finally fall back to emulated poll if all else fails */
Joakim Soderberg4c531232013-02-06 15:26:58 +09001949 if (!poll)
1950 poll = emulated_poll;
Peter Hinz56885f32011-03-02 22:03:47 +00001951 }
1952#endif
1953
Andy Greenb5b23192013-02-11 17:13:32 +08001954 context = (struct libwebsocket_context *)
1955 malloc(sizeof(struct libwebsocket_context));
Peter Hinz56885f32011-03-02 22:03:47 +00001956 if (!context) {
Andy Green43db0452013-01-10 19:50:35 +08001957 lwsl_err("No memory for websocket context\n");
Andy Green90c7cbc2011-01-27 06:26:52 +00001958 return NULL;
1959 }
Peter Pentchev3b233cb2013-02-07 16:31:19 +02001960 memset(context, 0, sizeof(*context));
Andy Green35f332b2013-01-21 13:06:38 +08001961#ifndef LWS_NO_DAEMONIZE
Andy Green24cba922013-01-19 13:56:10 +08001962 context->started_with_parent = pid_daemon;
1963 lwsl_notice(" Started with daemon pid %d\n", pid_daemon);
1964#endif
Andy Greenb5b23192013-02-11 17:13:32 +08001965
Joakim Soderberg4c531232013-02-06 15:26:58 +09001966 context->listen_service_extraseen = 0;
Andy Green1b265272013-02-09 14:01:09 +08001967 context->protocols = info->protocols;
1968 context->listen_port = info->port;
Peter Hinz56885f32011-03-02 22:03:47 +00001969 context->http_proxy_port = 0;
1970 context->http_proxy_address[0] = '\0';
Andy Green1b265272013-02-09 14:01:09 +08001971 context->options = info->options;
Andy Greendfb23042013-01-17 12:26:48 +08001972 /* to reduce this allocation, */
1973 context->max_fds = getdtablesize();
Andy Greena86f6342013-02-11 11:04:56 +08001974 lwsl_notice(" static allocation: %u + (%u x %u fds) = %u bytes\n",
1975 sizeof(struct libwebsocket_context),
1976 sizeof(struct pollfd) + sizeof(struct libwebsocket *),
1977 context->max_fds,
Andy Greenb5b23192013-02-11 17:13:32 +08001978 sizeof(struct libwebsocket_context) +
1979 ((sizeof(struct pollfd) + sizeof(struct libwebsocket *)) *
1980 context->max_fds));
Andy Greendfb23042013-01-17 12:26:48 +08001981
Andy Greenb5b23192013-02-11 17:13:32 +08001982 context->fds = (struct pollfd *)malloc(sizeof(struct pollfd) *
1983 context->max_fds);
Andy Greendfb23042013-01-17 12:26:48 +08001984 if (context->fds == NULL) {
Andy Greenb5b23192013-02-11 17:13:32 +08001985 lwsl_err("Unable to allocate fds array for %d connections\n",
1986 context->max_fds);
Andy Greendfb23042013-01-17 12:26:48 +08001987 free(context);
1988 return NULL;
1989 }
Andy Greenb5b23192013-02-11 17:13:32 +08001990 context->lws_lookup = (struct libwebsocket **)
1991 malloc(sizeof(struct libwebsocket *) * context->max_fds);
Andy Greendfb23042013-01-17 12:26:48 +08001992 if (context->lws_lookup == NULL) {
Andy Greenb5b23192013-02-11 17:13:32 +08001993 lwsl_err(
1994 "Unable to allocate lws_lookup array for %d connections\n",
1995 context->max_fds);
Andy Greendfb23042013-01-17 12:26:48 +08001996 free(context->fds);
1997 free(context);
1998 return NULL;
1999 }
Andy Greenb1a5e6c2013-03-09 12:34:30 +08002000 memset(context->lws_lookup, 0, sizeof(struct libwebsocket *) *
2001 context->max_fds);
Andy Greena17c6922013-01-20 20:21:54 +08002002
Peter Hinz56885f32011-03-02 22:03:47 +00002003 context->fds_count = 0;
Andy Green3182ece2013-01-20 17:08:31 +08002004#ifndef LWS_NO_EXTENSIONS
Andy Green1b265272013-02-09 14:01:09 +08002005 context->extensions = info->extensions;
Andy Green3182ece2013-01-20 17:08:31 +08002006#endif
Paulo Roberto Urio1e326632012-06-04 10:52:19 +08002007 context->last_timeout_check_s = 0;
Andy Green1b265272013-02-09 14:01:09 +08002008 context->user_space = info->user;
Andy Green9659f372011-01-27 22:01:43 +00002009
Andreas Pakulat68bd4bd2013-10-28 15:18:04 +01002010#if defined(WIN32) || defined(_WIN32)
Peter Hinz56885f32011-03-02 22:03:47 +00002011 context->fd_random = 0;
2012#else
2013 context->fd_random = open(SYSTEM_RANDOM_FILEPATH, O_RDONLY);
2014 if (context->fd_random < 0) {
Andy Green43db0452013-01-10 19:50:35 +08002015 lwsl_err("Unable to open random device %s %d\n",
Peter Hinz56885f32011-03-02 22:03:47 +00002016 SYSTEM_RANDOM_FILEPATH, context->fd_random);
Peter Pentchev3b233cb2013-02-07 16:31:19 +02002017 goto bail;
Andy Green44eee682011-02-10 09:32:24 +00002018 }
Peter Hinz56885f32011-03-02 22:03:47 +00002019#endif
Andy Green44eee682011-02-10 09:32:24 +00002020
Peter Hinz56885f32011-03-02 22:03:47 +00002021#ifdef LWS_OPENSSL_SUPPORT
2022 context->use_ssl = 0;
James Devine5b34c972013-12-14 11:41:29 +08002023 context->allow_non_ssl_on_ssl_port = 0;
Peter Hinz56885f32011-03-02 22:03:47 +00002024 context->ssl_ctx = NULL;
2025 context->ssl_client_ctx = NULL;
Andy Green2e24da02011-03-05 16:12:04 +00002026 openssl_websocket_private_data_index = 0;
Peter Hinz56885f32011-03-02 22:03:47 +00002027#endif
Andy Green2ac5a6f2011-01-28 10:00:18 +00002028
Andy Greena1ce6be2013-01-18 11:43:21 +08002029 strcpy(context->canonical_hostname, "unknown");
Andy Greena69f0512012-05-03 12:32:38 +08002030
Andy Greena1ce6be2013-01-18 11:43:21 +08002031#ifndef LWS_NO_SERVER
Andy Green1b265272013-02-09 14:01:09 +08002032 if (!(info->options & LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME)) {
Andy Green788c4a82012-10-22 12:29:57 +01002033 /* find canonical hostname */
Andy Greenadc71462013-02-14 17:11:22 +08002034 gethostname((char *)context->canonical_hostname,
Andy Greenb5b23192013-02-11 17:13:32 +08002035 sizeof(context->canonical_hostname) - 1);
Andy Green788c4a82012-10-22 12:29:57 +01002036
Andy Greenb5b23192013-02-11 17:13:32 +08002037 lwsl_notice(" canonical_hostname = %s\n",
2038 context->canonical_hostname);
Andy Greena69f0512012-05-03 12:32:38 +08002039 }
Andy Greena1ce6be2013-01-18 11:43:21 +08002040#endif
Andy Greena69f0512012-05-03 12:32:38 +08002041
Andy Green9659f372011-01-27 22:01:43 +00002042 /* split the proxy ads:port if given */
2043
2044 p = getenv("http_proxy");
2045 if (p) {
Peter Hinz56885f32011-03-02 22:03:47 +00002046 strncpy(context->http_proxy_address, p,
Andy Greenb5b23192013-02-11 17:13:32 +08002047 sizeof(context->http_proxy_address) - 1);
Peter Hinz56885f32011-03-02 22:03:47 +00002048 context->http_proxy_address[
Andy Greenb5b23192013-02-11 17:13:32 +08002049 sizeof(context->http_proxy_address) - 1] = '\0';
Andy Green9659f372011-01-27 22:01:43 +00002050
Peter Hinz56885f32011-03-02 22:03:47 +00002051 p = strchr(context->http_proxy_address, ':');
Andy Green9659f372011-01-27 22:01:43 +00002052 if (p == NULL) {
Andy Green43db0452013-01-10 19:50:35 +08002053 lwsl_err("http_proxy needs to be ads:port\n");
Peter Pentchev3b233cb2013-02-07 16:31:19 +02002054 goto bail;
Andy Green9659f372011-01-27 22:01:43 +00002055 }
2056 *p = '\0';
Peter Hinz56885f32011-03-02 22:03:47 +00002057 context->http_proxy_port = atoi(p + 1);
Andy Green9659f372011-01-27 22:01:43 +00002058
Andy Greenb3a614a2013-01-19 13:08:17 +08002059 lwsl_notice(" Proxy %s:%u\n",
Peter Hinz56885f32011-03-02 22:03:47 +00002060 context->http_proxy_address,
2061 context->http_proxy_port);
Andy Green9659f372011-01-27 22:01:43 +00002062 }
Andy Green90c7cbc2011-01-27 06:26:52 +00002063
Andy Greena1ce6be2013-01-18 11:43:21 +08002064#ifndef LWS_NO_SERVER
Andy Green1b265272013-02-09 14:01:09 +08002065 if (info->port) {
Andy Green90c7cbc2011-01-27 06:26:52 +00002066
Andy Green3faa9c72010-11-08 17:03:03 +00002067#ifdef LWS_OPENSSL_SUPPORT
Andy Green1b265272013-02-09 14:01:09 +08002068 context->use_ssl = info->ssl_cert_filepath != NULL &&
2069 info->ssl_private_key_filepath != NULL;
Andy Green23c5f2e2013-02-06 15:43:00 +09002070#ifdef USE_CYASSL
2071 lwsl_notice(" Compiled with CYASSL support\n");
2072#else
2073 lwsl_notice(" Compiled with OpenSSL support\n");
2074#endif
Peter Hinz56885f32011-03-02 22:03:47 +00002075 if (context->use_ssl)
Andy Green23c5f2e2013-02-06 15:43:00 +09002076 lwsl_notice(" Using SSL mode\n");
Andy Green90c7cbc2011-01-27 06:26:52 +00002077 else
Andy Green23c5f2e2013-02-06 15:43:00 +09002078 lwsl_notice(" Using non-SSL mode\n");
Andy Green3faa9c72010-11-08 17:03:03 +00002079
Andy Green90c7cbc2011-01-27 06:26:52 +00002080#else
Andy Green2b40b792013-02-10 22:22:01 +08002081 if (info->ssl_cert_filepath != NULL &&
2082 info->ssl_private_key_filepath != NULL) {
Andy Greenb3a614a2013-01-19 13:08:17 +08002083 lwsl_notice(" Not compiled for OpenSSl support!\n");
Peter Pentchev3b233cb2013-02-07 16:31:19 +02002084 goto bail;
Andy Green3faa9c72010-11-08 17:03:03 +00002085 }
Andy Greenb5b23192013-02-11 17:13:32 +08002086 lwsl_notice(" Compiled without SSL support\n");
Andy Green90c7cbc2011-01-27 06:26:52 +00002087#endif
Andy Greena17c6922013-01-20 20:21:54 +08002088
Andy Greenb5b23192013-02-11 17:13:32 +08002089 lwsl_notice(
2090 " per-conn mem: %u + %u headers + protocol rx buf\n",
2091 sizeof(struct libwebsocket),
2092 sizeof(struct allocated_headers));
Andy Green90c7cbc2011-01-27 06:26:52 +00002093 }
Andy Greena1ce6be2013-01-18 11:43:21 +08002094#endif
Andy Green90c7cbc2011-01-27 06:26:52 +00002095
2096 /* ignore SIGPIPE */
Andreas Pakulat68bd4bd2013-10-28 15:18:04 +01002097#if defined(WIN32) || defined(_WIN32)
Peter Hinz56885f32011-03-02 22:03:47 +00002098#else
Andy Green90c7cbc2011-01-27 06:26:52 +00002099 signal(SIGPIPE, sigpipe_handler);
Peter Hinz56885f32011-03-02 22:03:47 +00002100#endif
Andy Green90c7cbc2011-01-27 06:26:52 +00002101
2102
2103#ifdef LWS_OPENSSL_SUPPORT
2104
2105 /* basic openssl init */
2106
2107 SSL_library_init();
2108
2109 OpenSSL_add_all_algorithms();
2110 SSL_load_error_strings();
2111
Andy Green2e24da02011-03-05 16:12:04 +00002112 openssl_websocket_private_data_index =
Andy Green6901cb32011-02-21 08:06:47 +00002113 SSL_get_ex_new_index(0, "libwebsockets", NULL, NULL, NULL);
2114
Andy Green90c7cbc2011-01-27 06:26:52 +00002115 /*
2116 * Firefox insists on SSLv23 not SSLv3
2117 * Konq disables SSLv2 by default now, SSLv23 works
2118 */
2119
2120 method = (SSL_METHOD *)SSLv23_server_method();
2121 if (!method) {
Jontie01cb9a2013-11-22 13:14:26 +02002122 int error = ERR_get_error();
Joakim Soderbergb82b0dd2013-02-22 09:28:15 +08002123 lwsl_err("problem creating ssl method %lu: %s\n",
Jontie01cb9a2013-11-22 13:14:26 +02002124 error,
2125 ERR_error_string(error,
Andy Greenb5b23192013-02-11 17:13:32 +08002126 (char *)context->service_buffer));
Peter Pentchev3b233cb2013-02-07 16:31:19 +02002127 goto bail;
Andy Green90c7cbc2011-01-27 06:26:52 +00002128 }
Peter Hinz56885f32011-03-02 22:03:47 +00002129 context->ssl_ctx = SSL_CTX_new(method); /* create context */
2130 if (!context->ssl_ctx) {
Jontie01cb9a2013-11-22 13:14:26 +02002131 int error = ERR_get_error();
Joakim Soderbergb82b0dd2013-02-22 09:28:15 +08002132 lwsl_err("problem creating ssl context %lu: %s\n",
Jontie01cb9a2013-11-22 13:14:26 +02002133 error,
2134 ERR_error_string(error,
2135 (char *)context->service_buffer));
Peter Pentchev3b233cb2013-02-07 16:31:19 +02002136 goto bail;
Andy Green90c7cbc2011-01-27 06:26:52 +00002137 }
2138
martell19c73f32014-01-22 18:17:03 +00002139#if defined(WIN32) || defined(_WIN32)
2140#else
Andy Green3b3fa9e2013-12-25 16:34:37 +08002141 signal(SIGUSR2, lws_sigusr2);
Andy Greened451d52014-01-11 12:37:07 +08002142 {
2143 sigset_t mask;
2144 sigemptyset (&mask);
2145 sigaddset (&mask, SIGUSR2);
2146
2147 sigprocmask(SIG_BLOCK, &mask, NULL);
2148 }
martell19c73f32014-01-22 18:17:03 +00002149#endif
Andy Green3b3fa9e2013-12-25 16:34:37 +08002150
David Galeanocc148e42013-01-10 10:18:59 +08002151#ifdef SSL_OP_NO_COMPRESSION
David Galeanoc72f6f92013-01-10 10:11:57 +08002152 SSL_CTX_set_options(context->ssl_ctx, SSL_OP_NO_COMPRESSION);
David Galeanocc148e42013-01-10 10:18:59 +08002153#endif
David Galeano77a677c2013-01-10 10:14:12 +08002154 SSL_CTX_set_options(context->ssl_ctx, SSL_OP_CIPHER_SERVER_PREFERENCE);
Andy Green2672fb22013-02-22 09:54:35 +08002155 if (info->ssl_cipher_list)
2156 SSL_CTX_set_cipher_list(context->ssl_ctx,
2157 info->ssl_cipher_list);
David Galeanoc72f6f92013-01-10 10:11:57 +08002158
Andy Greena1ce6be2013-01-18 11:43:21 +08002159#ifndef LWS_NO_CLIENT
2160
Andy Green90c7cbc2011-01-27 06:26:52 +00002161 /* client context */
Andy Green6ee372f2012-04-09 15:09:01 +08002162
Andy Green1b265272013-02-09 14:01:09 +08002163 if (info->port == CONTEXT_PORT_NO_LISTEN) {
Peter Hinz56885f32011-03-02 22:03:47 +00002164 method = (SSL_METHOD *)SSLv23_client_method();
2165 if (!method) {
Jontie01cb9a2013-11-22 13:14:26 +02002166 int error = ERR_get_error();
Joakim Soderbergb82b0dd2013-02-22 09:28:15 +08002167 lwsl_err("problem creating ssl method %lu: %s\n",
Jontie01cb9a2013-11-22 13:14:26 +02002168 error,
2169 ERR_error_string(error,
Andy Greenb5b23192013-02-11 17:13:32 +08002170 (char *)context->service_buffer));
Peter Pentchev3b233cb2013-02-07 16:31:19 +02002171 goto bail;
Peter Hinz56885f32011-03-02 22:03:47 +00002172 }
2173 /* create context */
2174 context->ssl_client_ctx = SSL_CTX_new(method);
2175 if (!context->ssl_client_ctx) {
Jontie01cb9a2013-11-22 13:14:26 +02002176 int error = ERR_get_error();
Joakim Soderbergb82b0dd2013-02-22 09:28:15 +08002177 lwsl_err("problem creating ssl context %lu: %s\n",
Jontie01cb9a2013-11-22 13:14:26 +02002178 error,
2179 ERR_error_string(error,
Andy Greenb5b23192013-02-11 17:13:32 +08002180 (char *)context->service_buffer));
Peter Pentchev3b233cb2013-02-07 16:31:19 +02002181 goto bail;
Peter Hinz56885f32011-03-02 22:03:47 +00002182 }
Andy Green90c7cbc2011-01-27 06:26:52 +00002183
David Galeanocc148e42013-01-10 10:18:59 +08002184#ifdef SSL_OP_NO_COMPRESSION
Andy Greenb5b23192013-02-11 17:13:32 +08002185 SSL_CTX_set_options(context->ssl_client_ctx,
2186 SSL_OP_NO_COMPRESSION);
David Galeanocc148e42013-01-10 10:18:59 +08002187#endif
Andy Greenb5b23192013-02-11 17:13:32 +08002188 SSL_CTX_set_options(context->ssl_client_ctx,
2189 SSL_OP_CIPHER_SERVER_PREFERENCE);
Andy Green2672fb22013-02-22 09:54:35 +08002190 if (info->ssl_cipher_list)
2191 SSL_CTX_set_cipher_list(context->ssl_client_ctx,
2192 info->ssl_cipher_list);
David Galeanoc72f6f92013-01-10 10:11:57 +08002193
Peter Hinz56885f32011-03-02 22:03:47 +00002194 /* openssl init for cert verification (for client sockets) */
Andy Green1b265272013-02-09 14:01:09 +08002195 if (!info->ssl_ca_filepath) {
David Galeano2f82be82013-01-09 16:25:54 +08002196 if (!SSL_CTX_load_verify_locations(
2197 context->ssl_client_ctx, NULL,
2198 LWS_OPENSSL_CLIENT_CERTS))
Andy Green43db0452013-01-10 19:50:35 +08002199 lwsl_err(
Andy Greenb5b23192013-02-11 17:13:32 +08002200 "Unable to load SSL Client certs from %s "
2201 "(set by --with-client-cert-dir= "
2202 "in configure) -- client ssl isn't "
2203 "going to work", LWS_OPENSSL_CLIENT_CERTS);
David Galeano2f82be82013-01-09 16:25:54 +08002204 } else
2205 if (!SSL_CTX_load_verify_locations(
Andy Green1b265272013-02-09 14:01:09 +08002206 context->ssl_client_ctx, info->ssl_ca_filepath,
David Galeano2f82be82013-01-09 16:25:54 +08002207 NULL))
Andy Green43db0452013-01-10 19:50:35 +08002208 lwsl_err(
David Galeano2f82be82013-01-09 16:25:54 +08002209 "Unable to load SSL Client certs "
2210 "file from %s -- client ssl isn't "
Andy Green1b265272013-02-09 14:01:09 +08002211 "going to work", info->ssl_ca_filepath);
Peter Hinz56885f32011-03-02 22:03:47 +00002212
2213 /*
2214 * callback allowing user code to load extra verification certs
2215 * helping the client to verify server identity
2216 */
2217
prasannateamf1b353a452013-11-12 17:21:01 -08002218 /* support for client-side certificate authentication */
2219 if (info->ssl_cert_filepath) {
2220 n = SSL_CTX_use_certificate_chain_file(
2221 context->ssl_client_ctx,
2222 info->ssl_cert_filepath);
2223 if (n != 1) {
2224 lwsl_err("problem getting cert '%s' %lu: %s\n",
2225 info->ssl_cert_filepath,
2226 ERR_get_error(),
2227 ERR_error_string(ERR_get_error(),
2228 (char *)context->service_buffer));
2229 goto bail;
2230 }
2231 }
2232 if (info->ssl_private_key_filepath) {
2233 /* set the private key from KeyFile */
2234 if (SSL_CTX_use_PrivateKey_file(context->ssl_client_ctx,
2235 info->ssl_private_key_filepath,
2236 SSL_FILETYPE_PEM) != 1) {
2237 lwsl_err("use_PrivateKey_file '%s' %lu: %s\n",
2238 info->ssl_private_key_filepath,
2239 ERR_get_error(),
2240 ERR_error_string(ERR_get_error(),
2241 (char *)context->service_buffer));
2242 goto bail;
2243 }
2244
2245 /* verify private key */
2246 if (!SSL_CTX_check_private_key(context->ssl_client_ctx)) {
2247 lwsl_err("Private SSL key doesn't match cert\n");
2248 goto bail;
2249 }
2250 }
2251
Peter Hinz56885f32011-03-02 22:03:47 +00002252 context->protocols[0].callback(context, NULL,
2253 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS,
2254 context->ssl_client_ctx, NULL, 0);
Andy Green90c7cbc2011-01-27 06:26:52 +00002255 }
Andy Greena1ce6be2013-01-18 11:43:21 +08002256#endif
Andy Green6ee372f2012-04-09 15:09:01 +08002257
Andy Greenc6bf2c22011-02-20 11:10:47 +00002258 /* as a server, are we requiring clients to identify themselves? */
2259
Andy Greenb5b23192013-02-11 17:13:32 +08002260 if (info->options &
2261 LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT) {
Andy Greenc6bf2c22011-02-20 11:10:47 +00002262
2263 /* absolutely require the client cert */
Andy Green6ee372f2012-04-09 15:09:01 +08002264
Peter Hinz56885f32011-03-02 22:03:47 +00002265 SSL_CTX_set_verify(context->ssl_ctx,
Andy Green6901cb32011-02-21 08:06:47 +00002266 SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
2267 OpenSSL_verify_callback);
Andy Greenc6bf2c22011-02-20 11:10:47 +00002268
2269 /*
2270 * give user code a chance to load certs into the server
2271 * allowing it to verify incoming client certs
2272 */
2273
Peter Hinz56885f32011-03-02 22:03:47 +00002274 context->protocols[0].callback(context, NULL,
Andy Greenc6bf2c22011-02-20 11:10:47 +00002275 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS,
Peter Hinz56885f32011-03-02 22:03:47 +00002276 context->ssl_ctx, NULL, 0);
Andy Greenc6bf2c22011-02-20 11:10:47 +00002277 }
2278
James Devine5b34c972013-12-14 11:41:29 +08002279 if(info->options & LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT) {
2280 /* Normally SSL listener rejects non-ssl, optionally allow */
2281 context->allow_non_ssl_on_ssl_port = 1;
2282 }
2283
Peter Hinz56885f32011-03-02 22:03:47 +00002284 if (context->use_ssl) {
Andy Green90c7cbc2011-01-27 06:26:52 +00002285
2286 /* openssl init for server sockets */
2287
Andy Green3faa9c72010-11-08 17:03:03 +00002288 /* set the local certificate from CertFile */
David Galeano9b3d4b22013-01-10 10:11:21 +08002289 n = SSL_CTX_use_certificate_chain_file(context->ssl_ctx,
Andy Green1b265272013-02-09 14:01:09 +08002290 info->ssl_cert_filepath);
Andy Green3faa9c72010-11-08 17:03:03 +00002291 if (n != 1) {
Jontie01cb9a2013-11-22 13:14:26 +02002292 int error = ERR_get_error();
Joakim Soderbergb82b0dd2013-02-22 09:28:15 +08002293 lwsl_err("problem getting cert '%s' %lu: %s\n",
Andy Green1b265272013-02-09 14:01:09 +08002294 info->ssl_cert_filepath,
Jontie01cb9a2013-11-22 13:14:26 +02002295 error,
2296 ERR_error_string(error,
Andy Greenb5b23192013-02-11 17:13:32 +08002297 (char *)context->service_buffer));
Peter Pentchev3b233cb2013-02-07 16:31:19 +02002298 goto bail;
Andy Green3faa9c72010-11-08 17:03:03 +00002299 }
2300 /* set the private key from KeyFile */
Peter Hinz56885f32011-03-02 22:03:47 +00002301 if (SSL_CTX_use_PrivateKey_file(context->ssl_ctx,
Andy Green1b265272013-02-09 14:01:09 +08002302 info->ssl_private_key_filepath,
2303 SSL_FILETYPE_PEM) != 1) {
Jontie01cb9a2013-11-22 13:14:26 +02002304 int error = ERR_get_error();
Joakim Soderbergb82b0dd2013-02-22 09:28:15 +08002305 lwsl_err("ssl problem getting key '%s' %lu: %s\n",
Andy Greenb5b23192013-02-11 17:13:32 +08002306 info->ssl_private_key_filepath,
Jontie01cb9a2013-11-22 13:14:26 +02002307 error,
2308 ERR_error_string(error,
Andy Greenb5b23192013-02-11 17:13:32 +08002309 (char *)context->service_buffer));
Peter Pentchev3b233cb2013-02-07 16:31:19 +02002310 goto bail;
Andy Green3faa9c72010-11-08 17:03:03 +00002311 }
2312 /* verify private key */
Peter Hinz56885f32011-03-02 22:03:47 +00002313 if (!SSL_CTX_check_private_key(context->ssl_ctx)) {
Andy Green43db0452013-01-10 19:50:35 +08002314 lwsl_err("Private SSL key doesn't match cert\n");
Peter Pentchev3b233cb2013-02-07 16:31:19 +02002315 goto bail;
Andy Green3faa9c72010-11-08 17:03:03 +00002316 }
2317
2318 /* SSL is happy and has a cert it's content with */
2319 }
2320#endif
Andy Greenb45993c2010-12-18 15:13:50 +00002321
Andy Greena1ce6be2013-01-18 11:43:21 +08002322#ifndef LWS_NO_SERVER
Andy Greenb45993c2010-12-18 15:13:50 +00002323 /* set up our external listening socket we serve on */
Andy Green8f037e42010-12-19 22:13:26 +00002324
Andy Green1b265272013-02-09 14:01:09 +08002325 if (info->port) {
Andy Greena1ce6be2013-01-18 11:43:21 +08002326 int sockfd;
Andy Green8f037e42010-12-19 22:13:26 +00002327
Andy Green4739e5c2011-01-22 12:51:57 +00002328 sockfd = socket(AF_INET, SOCK_STREAM, 0);
2329 if (sockfd < 0) {
Andy Greenf7609e92013-01-14 13:10:55 +08002330 lwsl_err("ERROR opening socket\n");
Peter Pentchev3b233cb2013-02-07 16:31:19 +02002331 goto bail;
Andy Green4739e5c2011-01-22 12:51:57 +00002332 }
Andy Green775c0dd2010-10-29 14:15:22 +01002333
Joakim Soderberg4c531232013-02-06 15:26:58 +09002334#ifndef WIN32
Andy Greenb5b23192013-02-11 17:13:32 +08002335 /*
2336 * allow us to restart even if old sockets in TIME_WAIT
2337 * (REUSEADDR on Unix means, "don't hang on to this
2338 * address after the listener is closed." On Windows, though,
2339 * it means "don't keep other processes from binding to
2340 * this address while we're using it)
2341 */
Andy Green6ee372f2012-04-09 15:09:01 +08002342 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR,
2343 (const void *)&opt, sizeof(opt));
Joakim Soderberg4c531232013-02-06 15:26:58 +09002344#endif
Andy Green6c939552011-03-08 08:56:57 +00002345
2346 /* Disable Nagle */
2347 opt = 1;
Andy Green6ee372f2012-04-09 15:09:01 +08002348 setsockopt(sockfd, IPPROTO_TCP, TCP_NODELAY,
2349 (const void *)&opt, sizeof(opt));
Andy Green6c939552011-03-08 08:56:57 +00002350
Andreas Pakulat68bd4bd2013-10-28 15:18:04 +01002351 #if defined(WIN32) || defined(_WIN32)
Joakim Soderberg4c531232013-02-06 15:26:58 +09002352 opt = 0;
Andy Greenb5b23192013-02-11 17:13:32 +08002353 ioctlsocket(sockfd, FIONBIO, (unsigned long *)&opt);
Joakim Soderberg4c531232013-02-06 15:26:58 +09002354 #else
Andy Greene2160712013-01-28 12:19:10 +08002355 fcntl(sockfd, F_SETFL, O_NONBLOCK);
Joakim Soderberg4c531232013-02-06 15:26:58 +09002356 #endif
Andy Greene2160712013-01-28 12:19:10 +08002357
Andy Green4739e5c2011-01-22 12:51:57 +00002358 bzero((char *) &serv_addr, sizeof(serv_addr));
2359 serv_addr.sin_family = AF_INET;
Joakim Soderberg63ff1202013-02-11 17:52:23 +01002360 if (info->iface == NULL)
Andy Green32375b72011-02-19 08:32:53 +00002361 serv_addr.sin_addr.s_addr = INADDR_ANY;
2362 else
Andy Greend1eac602013-11-09 08:07:38 +08002363 if (interface_to_sa(info->iface, &serv_addr,
2364 sizeof(serv_addr)) < 0) {
2365 lwsl_err("Unable to find interface %s\n",
2366 info->iface);
2367 compatible_close(sockfd);
2368 goto bail;
2369 }
Andy Green1b265272013-02-09 14:01:09 +08002370 serv_addr.sin_port = htons(info->port);
Andy Green4739e5c2011-01-22 12:51:57 +00002371
2372 n = bind(sockfd, (struct sockaddr *) &serv_addr,
2373 sizeof(serv_addr));
2374 if (n < 0) {
Andy Green43db0452013-01-10 19:50:35 +08002375 lwsl_err("ERROR on binding to port %d (%d %d)\n",
Andy Green1b265272013-02-09 14:01:09 +08002376 info->port, n, errno);
Andy Green8b2d6f02013-10-22 06:49:30 +08002377 compatible_close(sockfd);
Peter Pentchev3b233cb2013-02-07 16:31:19 +02002378 goto bail;
Andy Green4739e5c2011-01-22 12:51:57 +00002379 }
Andy Green0d338332011-02-12 11:57:43 +00002380
Andy Greenb5b23192013-02-11 17:13:32 +08002381 wsi = (struct libwebsocket *)malloc(
2382 sizeof(struct libwebsocket));
Andy Green41c58032013-01-12 13:21:08 +08002383 if (wsi == NULL) {
2384 lwsl_err("Out of mem\n");
Andy Green8b2d6f02013-10-22 06:49:30 +08002385 compatible_close(sockfd);
Peter Pentchev3b233cb2013-02-07 16:31:19 +02002386 goto bail;
Andy Green41c58032013-01-12 13:21:08 +08002387 }
Andy Greenb5b23192013-02-11 17:13:32 +08002388 memset(wsi, 0, sizeof(struct libwebsocket));
Andy Green0d338332011-02-12 11:57:43 +00002389 wsi->sock = sockfd;
Andy Green3182ece2013-01-20 17:08:31 +08002390#ifndef LWS_NO_EXTENSIONS
Andy Greend6e09112011-03-05 16:12:15 +00002391 wsi->count_active_extensions = 0;
Andy Green3182ece2013-01-20 17:08:31 +08002392#endif
Andy Green0d338332011-02-12 11:57:43 +00002393 wsi->mode = LWS_CONNMODE_SERVER_LISTENER;
Andy Greendfb23042013-01-17 12:26:48 +08002394
2395 insert_wsi_socket_into_fds(context, wsi);
Andy Green0d338332011-02-12 11:57:43 +00002396
Andy Green65b0e912013-01-16 07:59:47 +08002397 context->listen_service_modulo = LWS_LISTEN_SERVICE_MODULO;
2398 context->listen_service_count = 0;
2399 context->listen_service_fd = sockfd;
2400
Andy Greena824d182013-01-15 20:52:29 +08002401 listen(sockfd, LWS_SOMAXCONN);
Andy Green1b265272013-02-09 14:01:09 +08002402 lwsl_notice(" Listening on port %d\n", info->port);
Andy Green8f037e42010-12-19 22:13:26 +00002403 }
Andy Greena1ce6be2013-01-18 11:43:21 +08002404#endif
Andy Greenb45993c2010-12-18 15:13:50 +00002405
Andy Green6ee372f2012-04-09 15:09:01 +08002406 /*
2407 * drop any root privs for this process
2408 * to listen on port < 1023 we would have needed root, but now we are
2409 * listening, we don't want the power for anything else
2410 */
Andreas Pakulat68bd4bd2013-10-28 15:18:04 +01002411#if defined(WIN32) || defined(_WIN32)
Peter Hinz56885f32011-03-02 22:03:47 +00002412#else
Andy Green1b265272013-02-09 14:01:09 +08002413 if (info->gid != -1)
2414 if (setgid(info->gid))
Andy Green43db0452013-01-10 19:50:35 +08002415 lwsl_warn("setgid: %s\n", strerror(errno));
Andy Green1b265272013-02-09 14:01:09 +08002416 if (info->uid != -1)
2417 if (setuid(info->uid))
Andy Green43db0452013-01-10 19:50:35 +08002418 lwsl_warn("setuid: %s\n", strerror(errno));
Peter Hinz56885f32011-03-02 22:03:47 +00002419#endif
Andy Greenb45993c2010-12-18 15:13:50 +00002420
Andy Green6f520a52013-01-29 17:57:39 +08002421 /* initialize supported protocols */
Andy Greenb45993c2010-12-18 15:13:50 +00002422
Peter Hinz56885f32011-03-02 22:03:47 +00002423 for (context->count_protocols = 0;
Andy Green1b265272013-02-09 14:01:09 +08002424 info->protocols[context->count_protocols].callback;
Peter Hinz56885f32011-03-02 22:03:47 +00002425 context->count_protocols++) {
Andy Green2d1301e2011-05-24 10:14:41 +01002426
Andy Green43db0452013-01-10 19:50:35 +08002427 lwsl_parser(" Protocol: %s\n",
Andy Green1b265272013-02-09 14:01:09 +08002428 info->protocols[context->count_protocols].name);
Andy Green2d1301e2011-05-24 10:14:41 +01002429
Andy Green1b265272013-02-09 14:01:09 +08002430 info->protocols[context->count_protocols].owning_server =
2431 context;
2432 info->protocols[context->count_protocols].protocol_index =
Peter Hinz56885f32011-03-02 22:03:47 +00002433 context->count_protocols;
Andy Greena7109e62013-02-11 12:05:54 +08002434
2435 /*
2436 * inform all the protocols that they are doing their one-time
2437 * initialization if they want to
2438 */
2439 info->protocols[context->count_protocols].callback(context,
2440 NULL, LWS_CALLBACK_PROTOCOL_INIT, NULL, NULL, 0);
Andy Greenb45993c2010-12-18 15:13:50 +00002441 }
Andy Greenf5bc1302013-01-21 09:09:52 +08002442
Andy Green3182ece2013-01-20 17:08:31 +08002443#ifndef LWS_NO_EXTENSIONS
Andy Greena41314f2011-05-23 10:00:03 +01002444 /*
2445 * give all extensions a chance to create any per-context
2446 * allocations they need
2447 */
2448
2449 m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_CONSTRUCT;
Andy Green1b265272013-02-09 14:01:09 +08002450 if (info->port)
Andy Greena41314f2011-05-23 10:00:03 +01002451 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_CONSTRUCT;
Andy Greenb5b23192013-02-11 17:13:32 +08002452
Andy Green1b265272013-02-09 14:01:09 +08002453 if (info->extensions) {
2454 ext = info->extensions;
2455 while (ext->callback) {
2456 lwsl_ext(" Extension: %s\n", ext->name);
2457 ext->callback(context, ext, NULL,
Aaron Zinman4550f1d2013-01-10 12:35:18 +08002458 (enum libwebsocket_extension_callback_reasons)m,
2459 NULL, NULL, 0);
Andy Green1b265272013-02-09 14:01:09 +08002460 ext++;
2461 }
Andy Greena41314f2011-05-23 10:00:03 +01002462 }
Andy Green3182ece2013-01-20 17:08:31 +08002463#endif
Andy Green3b3fa9e2013-12-25 16:34:37 +08002464
Peter Hinz56885f32011-03-02 22:03:47 +00002465 return context;
Peter Pentchev3b233cb2013-02-07 16:31:19 +02002466
2467bail:
2468 libwebsocket_context_destroy(context);
2469 return NULL;
Andy Greene92cd172011-01-19 13:11:55 +00002470}
Andy Greenb45993c2010-12-18 15:13:50 +00002471
Andy Greenb45993c2010-12-18 15:13:50 +00002472/**
shysb4e800e2013-10-24 22:12:03 +08002473 * libwebsocket_set_proxy() - Setups proxy to libwebsocket_context.
2474 * @context: pointer to struct libwebsocket_context you want set proxy to
2475 * @proxy: pointer to c string containing proxy in format address:port
2476 *
2477 * Returns 0 if proxy string was parsed and proxy was setup.
2478 * Returns -1 if @proxy is NULL or has incorrect format.
2479 *
2480 * This is only required if your OS does not provide the http_proxy
2481 * enviroment variable (eg, OSX)
2482 *
2483 * IMPORTANT! You should call this function right after creation of the
2484 * libwebsocket_context and before call to connect. If you call this
2485 * function after connect behavior is undefined.
2486 * This function will override proxy settings made on libwebsocket_context
2487 * creation with genenv() call.
2488 */
2489
2490LWS_VISIBLE int
2491libwebsocket_set_proxy(struct libwebsocket_context *context, const char *proxy)
2492{
2493 char *p;
2494
2495 if (!proxy)
2496 return -1;
2497
2498 strncpy(context->http_proxy_address, proxy,
2499 sizeof(context->http_proxy_address) - 1);
2500 context->http_proxy_address[
2501 sizeof(context->http_proxy_address) - 1] = '\0';
2502
2503 p = strchr(context->http_proxy_address, ':');
2504 if (!p) {
2505 lwsl_err("http_proxy needs to be ads:port\n");
2506
2507 return -1;
2508 }
2509 *p = '\0';
2510 context->http_proxy_port = atoi(p + 1);
2511
2512 lwsl_notice(" Proxy %s:%u\n", context->http_proxy_address,
2513 context->http_proxy_port);
2514
2515 return 0;
2516}
2517
2518/**
Andy Greenb45993c2010-12-18 15:13:50 +00002519 * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
Andy Green8f037e42010-12-19 22:13:26 +00002520 * connection.
Andy Greenb45993c2010-12-18 15:13:50 +00002521 * @wsi: pointer to struct websocket you want to know the protocol of
2522 *
Andy Green8f037e42010-12-19 22:13:26 +00002523 *
Andy Green6f520a52013-01-29 17:57:39 +08002524 * Some apis can act on all live connections of a given protocol,
2525 * this is how you can get a pointer to the active protocol if needed.
Andy Greenb45993c2010-12-18 15:13:50 +00002526 */
Andy Greenab990e42010-10-31 12:42:52 +00002527
Peter Pentchev9a4fef72013-03-30 09:52:21 +08002528LWS_VISIBLE const struct libwebsocket_protocols *
Andy Greenb45993c2010-12-18 15:13:50 +00002529libwebsockets_get_protocol(struct libwebsocket *wsi)
2530{
2531 return wsi->protocol;
2532}
2533
Peter Pentchev9a4fef72013-03-30 09:52:21 +08002534LWS_VISIBLE int
Andy Green82c3d542011-03-07 21:16:31 +00002535libwebsocket_is_final_fragment(struct libwebsocket *wsi)
2536{
Andy Green623a98d2013-01-21 11:04:23 +08002537 return wsi->u.ws.final;
Andy Green82c3d542011-03-07 21:16:31 +00002538}
Alex Bligh49146db2011-11-07 17:19:25 +08002539
Peter Pentchev9a4fef72013-03-30 09:52:21 +08002540LWS_VISIBLE unsigned char
David Galeanoe2cf9922013-01-09 18:06:55 +08002541libwebsocket_get_reserved_bits(struct libwebsocket *wsi)
2542{
Andy Green623a98d2013-01-21 11:04:23 +08002543 return wsi->u.ws.rsv;
David Galeanoe2cf9922013-01-09 18:06:55 +08002544}
2545
Andy Green2af4d5b2013-02-18 16:30:10 +08002546int
Alex Bligh49146db2011-11-07 17:19:25 +08002547libwebsocket_ensure_user_space(struct libwebsocket *wsi)
2548{
Andy Green67d556c2013-02-15 22:31:55 +08002549 if (!wsi->protocol)
Andy Green2af4d5b2013-02-18 16:30:10 +08002550 return 1;
Andy Green67d556c2013-02-15 22:31:55 +08002551
Alex Bligh49146db2011-11-07 17:19:25 +08002552 /* allocate the per-connection user memory (if any) */
2553
2554 if (wsi->protocol->per_session_data_size && !wsi->user_space) {
2555 wsi->user_space = malloc(
2556 wsi->protocol->per_session_data_size);
2557 if (wsi->user_space == NULL) {
Andy Green43db0452013-01-10 19:50:35 +08002558 lwsl_err("Out of memory for conn user space\n");
Andy Green2af4d5b2013-02-18 16:30:10 +08002559 return 1;
Alex Bligh49146db2011-11-07 17:19:25 +08002560 }
Andy Green6ee372f2012-04-09 15:09:01 +08002561 memset(wsi->user_space, 0,
2562 wsi->protocol->per_session_data_size);
Alex Bligh49146db2011-11-07 17:19:25 +08002563 }
Andy Green2af4d5b2013-02-18 16:30:10 +08002564 return 0;
Alex Bligh49146db2011-11-07 17:19:25 +08002565}
Andy Green43db0452013-01-10 19:50:35 +08002566
Andy Green0b319092013-01-19 11:17:56 +08002567static void lwsl_emit_stderr(int level, const char *line)
Andy Greende8f27a2013-01-12 09:17:42 +08002568{
Andy Green0b319092013-01-19 11:17:56 +08002569 char buf[300];
2570 struct timeval tv;
Andy Green0b319092013-01-19 11:17:56 +08002571 int n;
2572
2573 gettimeofday(&tv, NULL);
2574
2575 buf[0] = '\0';
2576 for (n = 0; n < LLL_COUNT; n++)
2577 if (level == (1 << n)) {
Andy Green058ba812013-01-19 11:32:18 +08002578 sprintf(buf, "[%ld:%04d] %s: ", tv.tv_sec,
Andy Greenb5b23192013-02-11 17:13:32 +08002579 (int)(tv.tv_usec / 100), log_level_names[n]);
Andy Green0b319092013-01-19 11:17:56 +08002580 break;
2581 }
Andy Greenb5b23192013-02-11 17:13:32 +08002582
Andy Green0b319092013-01-19 11:17:56 +08002583 fprintf(stderr, "%s%s", buf, line);
Andy Greende8f27a2013-01-12 09:17:42 +08002584}
2585
Andreas Pakulat68bd4bd2013-10-28 15:18:04 +01002586#if defined(WIN32) || defined(_WIN32)
Peter Pentchev9a4fef72013-03-30 09:52:21 +08002587LWS_VISIBLE void lwsl_emit_syslog(int level, const char *line)
Joakim Soderberg4c531232013-02-06 15:26:58 +09002588{
2589 lwsl_emit_stderr(level, line);
2590}
2591#else
Peter Pentchev9a4fef72013-03-30 09:52:21 +08002592LWS_VISIBLE void lwsl_emit_syslog(int level, const char *line)
Andy Greenc11db202013-01-19 11:12:16 +08002593{
2594 int syslog_level = LOG_DEBUG;
2595
2596 switch (level) {
2597 case LLL_ERR:
2598 syslog_level = LOG_ERR;
2599 break;
2600 case LLL_WARN:
2601 syslog_level = LOG_WARNING;
2602 break;
2603 case LLL_NOTICE:
2604 syslog_level = LOG_NOTICE;
2605 break;
2606 case LLL_INFO:
2607 syslog_level = LOG_INFO;
2608 break;
2609 }
Edwin van den Oetelaarf6eeabc2013-01-19 20:01:01 +08002610 syslog(syslog_level, "%s", line);
Andy Greenc11db202013-01-19 11:12:16 +08002611}
Joakim Soderberg4c531232013-02-06 15:26:58 +09002612#endif
Andy Greenc11db202013-01-19 11:12:16 +08002613
Peter Pentchev9a4fef72013-03-30 09:52:21 +08002614LWS_VISIBLE void _lws_log(int filter, const char *format, ...)
Andy Green43db0452013-01-10 19:50:35 +08002615{
Andy Greende8f27a2013-01-12 09:17:42 +08002616 char buf[256];
Andy Green43db0452013-01-10 19:50:35 +08002617 va_list ap;
Andy Green43db0452013-01-10 19:50:35 +08002618
2619 if (!(log_level & filter))
2620 return;
2621
Andy Green43db0452013-01-10 19:50:35 +08002622 va_start(ap, format);
Andy Greenb5b23192013-02-11 17:13:32 +08002623 vsnprintf(buf, sizeof(buf), format, ap);
2624 buf[sizeof(buf) - 1] = '\0';
Andy Greende8f27a2013-01-12 09:17:42 +08002625 va_end(ap);
2626
Andy Green0b319092013-01-19 11:17:56 +08002627 lwsl_emit(filter, buf);
Andy Green43db0452013-01-10 19:50:35 +08002628}
2629
2630/**
2631 * lws_set_log_level() - Set the logging bitfield
2632 * @level: OR together the LLL_ debug contexts you want output from
Andy Greende8f27a2013-01-12 09:17:42 +08002633 * @log_emit_function: NULL to leave it as it is, or a user-supplied
2634 * function to perform log string emission instead of
2635 * the default stderr one.
Andy Green43db0452013-01-10 19:50:35 +08002636 *
Andy Greenc6511a02013-02-19 10:01:48 +08002637 * log level defaults to "err", "warn" and "notice" contexts enabled and
Andy Greende8f27a2013-01-12 09:17:42 +08002638 * emission on stderr.
Andy Green43db0452013-01-10 19:50:35 +08002639 */
2640
Peter Pentchev9a4fef72013-03-30 09:52:21 +08002641LWS_VISIBLE void lws_set_log_level(int level, void (*log_emit_function)(int level,
Andy Greenb5b23192013-02-11 17:13:32 +08002642 const char *line))
Andy Green43db0452013-01-10 19:50:35 +08002643{
2644 log_level = level;
Andy Greende8f27a2013-01-12 09:17:42 +08002645 if (log_emit_function)
2646 lwsl_emit = log_emit_function;
Andy Green43db0452013-01-10 19:50:35 +08002647}