blob: 1b406e6df6d83d2725c1f7c263daa2318149a502 [file] [log] [blame]
Andy Green58eaa742011-03-07 17:54:06 +00001/*
Andy Greena0da8a82010-11-08 17:12:19 +00002 * libwebsockets - small server side websockets and web server implementation
Andy Green8f037e42010-12-19 22:13:26 +00003 *
Andy Greena0da8a82010-11-08 17:12:19 +00004 * Copyright (C) 2010 Andy Green <andy@warmcat.com>
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation:
9 * version 2.1 of the License.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
19 * MA 02110-1301 USA
Andy Green05a0a7b2010-10-31 17:51:39 +000020 */
21
Andy Green7c212cc2010-11-08 20:20:42 +000022#include "private-libwebsockets.h"
Andy Greenc11db202013-01-19 11:12:16 +080023#include <syslog.h>
Andy Greenff95d7a2010-10-28 22:36:01 +010024
Peter Hinz56885f32011-03-02 22:03:47 +000025#ifdef WIN32
David Galeanocb193682013-01-09 15:29:00 +080026#include <tchar.h>
27#include <io.h>
Peter Hinz56885f32011-03-02 22:03:47 +000028#else
Davidc4ef7b12013-01-12 20:39:47 +080029#ifdef LWS_BUILTIN_GETIFADDRS
30#include <getifaddrs.h>
31#else
Peter Hinz56885f32011-03-02 22:03:47 +000032#include <ifaddrs.h>
Davidc4ef7b12013-01-12 20:39:47 +080033#endif
Andy Green7627af52011-03-09 15:13:52 +000034#include <sys/un.h>
Andy Greena69f0512012-05-03 12:32:38 +080035#include <sys/socket.h>
36#include <netdb.h>
Peter Hinz56885f32011-03-02 22:03:47 +000037#endif
Andy Green2e24da02011-03-05 16:12:04 +000038
39#ifdef LWS_OPENSSL_SUPPORT
40int openssl_websocket_private_data_index;
41#endif
42
Andy Greenaa6fc442012-04-12 13:26:49 +080043#ifdef __MINGW32__
44#include "../win32port/win32helpers/websock-w32.c"
45#else
46#ifdef __MINGW64__
47#include "../win32port/win32helpers/websock-w32.c"
48#endif
49#endif
50
Andy Green3182ece2013-01-20 17:08:31 +080051
Andy Green7c19c342013-01-19 12:18:07 +080052static int log_level = LLL_ERR | LLL_WARN | LLL_NOTICE;
Andy Green058ba812013-01-19 11:32:18 +080053static void lwsl_emit_stderr(int level, const char *line);
54static void (*lwsl_emit)(int level, const char *line) = lwsl_emit_stderr;
55
Andy Green43db0452013-01-10 19:50:35 +080056static const char *log_level_names[] = {
57 "ERR",
58 "WARN",
Andy Green7c19c342013-01-19 12:18:07 +080059 "NOTICE",
Andy Green43db0452013-01-10 19:50:35 +080060 "INFO",
61 "DEBUG",
62 "PARSER",
63 "HEADER",
64 "EXTENSION",
65 "CLIENT",
Andy Greend636e352013-01-29 12:36:17 +080066 "LATENCY",
Andy Green43db0452013-01-10 19:50:35 +080067};
68
Andy Green0d338332011-02-12 11:57:43 +000069int
Andy Greendfb23042013-01-17 12:26:48 +080070insert_wsi_socket_into_fds(struct libwebsocket_context *context, struct libwebsocket *wsi)
Andy Green0d338332011-02-12 11:57:43 +000071{
Andy Greendfb23042013-01-17 12:26:48 +080072 if (context->fds_count >= context->max_fds) {
73 lwsl_err("Reached limit of fds tracking (%d)\n", context->max_fds);
Andy Green0d338332011-02-12 11:57:43 +000074 return 1;
75 }
76
Andy Greendfb23042013-01-17 12:26:48 +080077 if (wsi->sock > context->max_fds) {
78 lwsl_err("Socket fd %d is beyond what we can index (%d)\n", wsi->sock, context->max_fds);
79 return 1;
80 }
81
82 assert(wsi);
83 assert(wsi->sock);
84
85 lwsl_info("insert_wsi_socket_into_fds: wsi=%p, sock=%d, fds pos=%d\n", wsi, wsi->sock, context->fds_count);
86
87 context->lws_lookup[wsi->sock] = wsi;
88 wsi->position_in_fds_table = context->fds_count;
89 context->fds[context->fds_count].fd = wsi->sock;
90 context->fds[context->fds_count].events = POLLIN;
91 context->fds[context->fds_count++].revents = 0;
92
93 /* external POLL support via protocol 0 */
94 context->protocols[0].callback(context, wsi,
95 LWS_CALLBACK_ADD_POLL_FD,
96 (void *)(long)wsi->sock, NULL, POLLIN);
Andy Green0d338332011-02-12 11:57:43 +000097
98 return 0;
99}
100
Andy Greendfb23042013-01-17 12:26:48 +0800101static int
102remove_wsi_socket_from_fds(struct libwebsocket_context *context, struct libwebsocket *wsi)
Andy Green0d338332011-02-12 11:57:43 +0000103{
Andy Greendfb23042013-01-17 12:26:48 +0800104 int m;
Andy Green0d338332011-02-12 11:57:43 +0000105
Andy Greendfb23042013-01-17 12:26:48 +0800106 if (!--context->fds_count)
107 goto do_ext;
Andy Green0d338332011-02-12 11:57:43 +0000108
Andy Greendfb23042013-01-17 12:26:48 +0800109 if (wsi->sock > context->max_fds) {
110 lwsl_err("Socket fd %d is beyond what we can index (%d)\n", wsi->sock, context->max_fds);
111 return 1;
112 }
Andy Green0d338332011-02-12 11:57:43 +0000113
Andy Greendfb23042013-01-17 12:26:48 +0800114 lwsl_info("remove_wsi_socket_from_fds: wsi=%p, sock=%d, fds pos=%d\n", wsi, wsi->sock, wsi->position_in_fds_table);
115
116 m = wsi->position_in_fds_table; /* replace the contents for this */
117
118 /* have the last guy take up the vacant slot */
119 context->fds[m] = context->fds[context->fds_count]; /* vacant fds slot filled with end one */
120 /* end guy's fds_lookup entry remains unchanged (still same fd pointing to same wsi) */
121 /* end guy's "position in fds table" changed */
122 context->lws_lookup[context->fds[context->fds_count].fd]->position_in_fds_table = m;
123 /* deletion guy's lws_lookup entry needs nuking */
124 context->lws_lookup[wsi->sock] = NULL; /* no WSI for the socket of the wsi being removed*/
125 wsi->position_in_fds_table = -1; /* removed wsi has no position any more */
126
127do_ext:
128 /* remove also from external POLL support via protocol 0 */
129 if (wsi->sock)
130 context->protocols[0].callback(context, wsi,
131 LWS_CALLBACK_DEL_POLL_FD, (void *)(long)wsi->sock, NULL, 0);
132
133 return 0;
Andy Green0d338332011-02-12 11:57:43 +0000134}
135
Andy Green32375b72011-02-19 08:32:53 +0000136
Andy Green8f037e42010-12-19 22:13:26 +0000137void
Peter Hinz56885f32011-03-02 22:03:47 +0000138libwebsocket_close_and_free_session(struct libwebsocket_context *context,
Andy Green687b0182011-02-26 11:04:01 +0000139 struct libwebsocket *wsi, enum lws_close_status reason)
Andy Green251f6fa2010-11-03 11:13:06 +0000140{
Andy Greenb45993c2010-12-18 15:13:50 +0000141 int n;
Andy Green62c54d22011-02-14 09:14:25 +0000142 int old_state;
Andy Green5e1fa172011-02-10 09:07:05 +0000143 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 2 +
144 LWS_SEND_BUFFER_POST_PADDING];
Andy Green3182ece2013-01-20 17:08:31 +0800145#ifndef LWS_NO_EXTENSIONS
Andy Greenc44159f2011-03-07 07:08:18 +0000146 int ret;
147 int m;
148 struct lws_tokens eff_buf;
Andy Greena41314f2011-05-23 10:00:03 +0100149 struct libwebsocket_extension *ext;
Andy Green3182ece2013-01-20 17:08:31 +0800150#endif
Andy Greenb45993c2010-12-18 15:13:50 +0000151
Andy Green4b6fbe12011-02-14 08:03:48 +0000152 if (!wsi)
Andy Greenb45993c2010-12-18 15:13:50 +0000153 return;
154
Andy Green62c54d22011-02-14 09:14:25 +0000155 old_state = wsi->state;
Andy Green251f6fa2010-11-03 11:13:06 +0000156
Andy Green62c54d22011-02-14 09:14:25 +0000157 if (old_state == WSI_STATE_DEAD_SOCKET)
Andy Green5e1fa172011-02-10 09:07:05 +0000158 return;
159
Andy Green623a98d2013-01-21 11:04:23 +0800160 wsi->u.ws.close_reason = reason;
Andy Greenda527df2011-03-07 07:08:12 +0000161
Andy Green3182ece2013-01-20 17:08:31 +0800162#ifndef LWS_NO_EXTENSIONS
Andy Greenda527df2011-03-07 07:08:12 +0000163 /*
Andy Green68b45042011-05-25 21:41:57 +0100164 * are his extensions okay with him closing? Eg he might be a mux
165 * parent and just his ch1 aspect is closing?
166 */
167
Andy Green68b45042011-05-25 21:41:57 +0100168 for (n = 0; n < wsi->count_active_extensions; n++) {
169 if (!wsi->active_extensions[n]->callback)
170 continue;
171
172 m = wsi->active_extensions[n]->callback(context,
173 wsi->active_extensions[n], wsi,
174 LWS_EXT_CALLBACK_CHECK_OK_TO_REALLY_CLOSE,
175 wsi->active_extensions_user[n], NULL, 0);
176
177 /*
178 * if somebody vetoed actually closing him at this time....
179 * up to the extension to track the attempted close, let's
180 * just bail
181 */
182
183 if (m) {
Andy Green43db0452013-01-10 19:50:35 +0800184 lwsl_ext("extension vetoed close\n");
Andy Green68b45042011-05-25 21:41:57 +0100185 return;
186 }
187 }
188
Andy Green68b45042011-05-25 21:41:57 +0100189 /*
Andy Greenc44159f2011-03-07 07:08:18 +0000190 * flush any tx pending from extensions, since we may send close packet
191 * if there are problems with send, just nuke the connection
192 */
193
194 ret = 1;
195 while (ret == 1) {
196
197 /* default to nobody has more to spill */
198
199 ret = 0;
200 eff_buf.token = NULL;
201 eff_buf.token_len = 0;
202
203 /* show every extension the new incoming data */
204
205 for (n = 0; n < wsi->count_active_extensions; n++) {
206 m = wsi->active_extensions[n]->callback(
Andy Green46c2ea02011-03-22 09:04:01 +0000207 wsi->protocol->owning_server,
208 wsi->active_extensions[n], wsi,
Andy Greenc44159f2011-03-07 07:08:18 +0000209 LWS_EXT_CALLBACK_FLUSH_PENDING_TX,
210 wsi->active_extensions_user[n], &eff_buf, 0);
211 if (m < 0) {
Andy Green43db0452013-01-10 19:50:35 +0800212 lwsl_ext("Extension reports fatal error\n");
Andy Greenc44159f2011-03-07 07:08:18 +0000213 goto just_kill_connection;
214 }
215 if (m)
216 /*
217 * at least one extension told us he has more
218 * to spill, so we will go around again after
219 */
220 ret = 1;
221 }
222
223 /* assuming they left us something to send, send it */
224
225 if (eff_buf.token_len)
226 if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
Andy Green0303db42013-01-17 14:46:43 +0800227 eff_buf.token_len)) {
228 lwsl_debug("close: sending final extension spill had problems\n");
Andy Greenc44159f2011-03-07 07:08:18 +0000229 goto just_kill_connection;
Andy Green0303db42013-01-17 14:46:43 +0800230 }
Andy Greenc44159f2011-03-07 07:08:18 +0000231 }
Andy Green3182ece2013-01-20 17:08:31 +0800232#endif
Andy Greenc44159f2011-03-07 07:08:18 +0000233
234 /*
Andy Greenda527df2011-03-07 07:08:12 +0000235 * signal we are closing, libsocket_write will
236 * add any necessary version-specific stuff. If the write fails,
237 * no worries we are closing anyway. If we didn't initiate this
238 * close, then our state has been changed to
239 * WSI_STATE_RETURNED_CLOSE_ALREADY and we will skip this.
240 *
241 * Likewise if it's a second call to close this connection after we
242 * sent the close indication to the peer already, we are in state
243 * WSI_STATE_AWAITING_CLOSE_ACK and will skip doing this a second time.
244 */
245
246 if (old_state == WSI_STATE_ESTABLISHED &&
247 reason != LWS_CLOSE_STATUS_NOSTATUS) {
Andy Green66a16f32011-05-24 22:07:45 +0100248
Andy Green43db0452013-01-10 19:50:35 +0800249 lwsl_debug("sending close indication...\n");
Andy Green66a16f32011-05-24 22:07:45 +0100250
Andy Greenda527df2011-03-07 07:08:12 +0000251 n = libwebsocket_write(wsi, &buf[LWS_SEND_BUFFER_PRE_PADDING],
252 0, LWS_WRITE_CLOSE);
253 if (!n) {
254 /*
255 * we have sent a nice protocol level indication we
256 * now wish to close, we should not send anything more
257 */
258
259 wsi->state = WSI_STATE_AWAITING_CLOSE_ACK;
260
Andy Green0303db42013-01-17 14:46:43 +0800261 /* and we should wait for a reply for a bit out of politeness */
Andy Greenda527df2011-03-07 07:08:12 +0000262
263 libwebsocket_set_timeout(wsi,
Andy Green0303db42013-01-17 14:46:43 +0800264 PENDING_TIMEOUT_CLOSE_ACK, 1);
Andy Greenda527df2011-03-07 07:08:12 +0000265
Andy Green43db0452013-01-10 19:50:35 +0800266 lwsl_debug("sent close indication, awaiting ack\n");
Andy Greenda527df2011-03-07 07:08:12 +0000267
268 return;
269 }
270
Andy Green0303db42013-01-17 14:46:43 +0800271 lwsl_info("close: sending the close packet failed, hanging up\n");
272
Andy Greenda527df2011-03-07 07:08:12 +0000273 /* else, the send failed and we should just hang up */
274 }
275
Andy Green3182ece2013-01-20 17:08:31 +0800276#ifndef LWS_NO_EXTENSIONS
Andy Greenc44159f2011-03-07 07:08:18 +0000277just_kill_connection:
Andy Green3182ece2013-01-20 17:08:31 +0800278#endif
Andy Green66a16f32011-05-24 22:07:45 +0100279
Andy Green43db0452013-01-10 19:50:35 +0800280 lwsl_debug("libwebsocket_close_and_free_session: just_kill_connection\n");
Andy Green66a16f32011-05-24 22:07:45 +0100281
Andy Greenda527df2011-03-07 07:08:12 +0000282 /*
283 * we won't be servicing or receiving anything further from this guy
Andy Greendfb23042013-01-17 12:26:48 +0800284 * delete socket from the internal poll list if still present
Andy Greenda527df2011-03-07 07:08:12 +0000285 */
Andy Green4b6fbe12011-02-14 08:03:48 +0000286
Andy Greendfb23042013-01-17 12:26:48 +0800287 remove_wsi_socket_from_fds(context, wsi);
Andy Green4b6fbe12011-02-14 08:03:48 +0000288
Andy Green251f6fa2010-11-03 11:13:06 +0000289 wsi->state = WSI_STATE_DEAD_SOCKET;
290
Andy Green4b6fbe12011-02-14 08:03:48 +0000291 /* tell the user it's all over for this guy */
292
Andy Greend4302732011-02-28 07:45:29 +0000293 if (wsi->protocol && wsi->protocol->callback &&
Andy Green6ee372f2012-04-09 15:09:01 +0800294 ((old_state == WSI_STATE_ESTABLISHED) ||
295 (old_state == WSI_STATE_RETURNED_CLOSE_ALREADY) ||
296 (old_state == WSI_STATE_AWAITING_CLOSE_ACK))) {
Andy Green43db0452013-01-10 19:50:35 +0800297 lwsl_debug("calling back CLOSED\n");
Peter Hinz56885f32011-03-02 22:03:47 +0000298 wsi->protocol->callback(context, wsi, LWS_CALLBACK_CLOSED,
Andy Greene77ddd82010-11-13 10:03:47 +0000299 wsi->user_space, NULL, 0);
Andy Greencc012472011-11-07 19:53:23 +0800300 } else
Andy Green43db0452013-01-10 19:50:35 +0800301 lwsl_debug("not calling back closed, old_state=%d\n", old_state);
Andy Green251f6fa2010-11-03 11:13:06 +0000302
Andy Green3182ece2013-01-20 17:08:31 +0800303#ifndef LWS_NO_EXTENSIONS
Andy Greenef660a92011-03-06 10:29:38 +0000304 /* deallocate any active extension contexts */
305
306 for (n = 0; n < wsi->count_active_extensions; n++) {
307 if (!wsi->active_extensions[n]->callback)
308 continue;
309
Andy Green46c2ea02011-03-22 09:04:01 +0000310 wsi->active_extensions[n]->callback(context,
311 wsi->active_extensions[n], wsi,
312 LWS_EXT_CALLBACK_DESTROY,
313 wsi->active_extensions_user[n], NULL, 0);
Andy Greenef660a92011-03-06 10:29:38 +0000314
315 free(wsi->active_extensions_user[n]);
316 }
317
Andy Greena41314f2011-05-23 10:00:03 +0100318 /*
319 * inform all extensions in case they tracked this guy out of band
320 * even though not active on him specifically
321 */
322
323 ext = context->extensions;
324 while (ext && ext->callback) {
325 ext->callback(context, ext, wsi,
326 LWS_EXT_CALLBACK_DESTROY_ANY_WSI_CLOSING,
327 NULL, NULL, 0);
328 ext++;
329 }
Andy Green3182ece2013-01-20 17:08:31 +0800330#endif
Andy Greena41314f2011-05-23 10:00:03 +0100331
Andy Greenef660a92011-03-06 10:29:38 +0000332 /* free up his parsing allocations */
Andy Green4b6fbe12011-02-14 08:03:48 +0000333
Andy Green251f6fa2010-11-03 11:13:06 +0000334 for (n = 0; n < WSI_TOKEN_COUNT; n++)
335 if (wsi->utf8_token[n].token)
336 free(wsi->utf8_token[n].token);
Andy Greena1ce6be2013-01-18 11:43:21 +0800337#ifndef LWS_NO_CLIENT
Andy Greena41314f2011-05-23 10:00:03 +0100338 if (wsi->c_address)
339 free(wsi->c_address);
Andy Greena1ce6be2013-01-18 11:43:21 +0800340#endif
Andy Green623a98d2013-01-21 11:04:23 +0800341 if (wsi->u.ws.rxflow_buffer)
342 free(wsi->u.ws.rxflow_buffer);
Andy Green706961d2013-01-17 16:50:35 +0800343
Andy Green43db0452013-01-10 19:50:35 +0800344/* lwsl_info("closing fd=%d\n", wsi->sock); */
Andy Green251f6fa2010-11-03 11:13:06 +0000345
Andy Green3faa9c72010-11-08 17:03:03 +0000346#ifdef LWS_OPENSSL_SUPPORT
Andy Green90c7cbc2011-01-27 06:26:52 +0000347 if (wsi->ssl) {
Andy Green3faa9c72010-11-08 17:03:03 +0000348 n = SSL_get_fd(wsi->ssl);
349 SSL_shutdown(wsi->ssl);
Andy Green3fc2c652013-01-14 15:35:02 +0800350 compatible_close(n);
Andy Green3faa9c72010-11-08 17:03:03 +0000351 SSL_free(wsi->ssl);
352 } else {
353#endif
Andy Green0303db42013-01-17 14:46:43 +0800354 if (wsi->sock) {
355 n = shutdown(wsi->sock, SHUT_RDWR);
356 if (n)
357 lwsl_debug("closing: shutdown returned %d\n", errno);
Andy Green3fc2c652013-01-14 15:35:02 +0800358
Andy Green0303db42013-01-17 14:46:43 +0800359 n = compatible_close(wsi->sock);
360 if (n)
361 lwsl_debug("closing: close returned %d\n", errno);
362 }
Andy Green3faa9c72010-11-08 17:03:03 +0000363#ifdef LWS_OPENSSL_SUPPORT
364 }
365#endif
David Brooks2c60d952012-04-20 12:19:01 +0800366 if (wsi->protocol && wsi->protocol->per_session_data_size && wsi->user_space) /* user code may own */
Andy Green4f3943a2010-11-12 10:44:16 +0000367 free(wsi->user_space);
368
Andy Green251f6fa2010-11-03 11:13:06 +0000369 free(wsi);
370}
371
Andy Green07034092011-02-13 08:37:12 +0000372/**
Andy Greenf7ee5492011-02-13 09:04:21 +0000373 * libwebsockets_hangup_on_client() - Server calls to terminate client
Andy Green6ee372f2012-04-09 15:09:01 +0800374 * connection
Peter Hinz56885f32011-03-02 22:03:47 +0000375 * @context: libwebsockets context
Andy Greenf7ee5492011-02-13 09:04:21 +0000376 * @fd: Connection socket descriptor
377 */
378
379void
Peter Hinz56885f32011-03-02 22:03:47 +0000380libwebsockets_hangup_on_client(struct libwebsocket_context *context, int fd)
Andy Greenf7ee5492011-02-13 09:04:21 +0000381{
Andy Greendfb23042013-01-17 12:26:48 +0800382 struct libwebsocket *wsi = context->lws_lookup[fd];
Andy Greenf7ee5492011-02-13 09:04:21 +0000383
Andy Greendfb23042013-01-17 12:26:48 +0800384 if (wsi) {
385 libwebsocket_close_and_free_session(context,
386 wsi, LWS_CLOSE_STATUS_NOSTATUS);
387 } else
388 close(fd);
Andy Greenf7ee5492011-02-13 09:04:21 +0000389}
390
391
392/**
Andy Green07034092011-02-13 08:37:12 +0000393 * libwebsockets_get_peer_addresses() - Get client address information
Andy Greenaaf0b9f2013-01-30 08:12:20 +0800394 * @context: Libwebsockets context
395 * @wsi: Local struct libwebsocket associated with
Andy Green07034092011-02-13 08:37:12 +0000396 * @fd: Connection socket descriptor
397 * @name: Buffer to take client address name
398 * @name_len: Length of client address name buffer
399 * @rip: Buffer to take client address IP qotted quad
400 * @rip_len: Length of client address IP buffer
401 *
402 * This function fills in @name and @rip with the name and IP of
Andy Green6ee372f2012-04-09 15:09:01 +0800403 * the client connected with socket descriptor @fd. Names may be
404 * truncated if there is not enough room. If either cannot be
405 * determined, they will be returned as valid zero-length strings.
Andy Green07034092011-02-13 08:37:12 +0000406 */
407
408void
Andy Greenaaf0b9f2013-01-30 08:12:20 +0800409libwebsockets_get_peer_addresses(struct libwebsocket_context *context,
410 struct libwebsocket *wsi, int fd, char *name, int name_len,
Andy Green07034092011-02-13 08:37:12 +0000411 char *rip, int rip_len)
412{
413 unsigned int len;
414 struct sockaddr_in sin;
415 struct hostent *host;
416 struct hostent *host1;
417 char ip[128];
Andy Greenf92def72011-03-09 15:02:20 +0000418 unsigned char *p;
Andy Green07034092011-02-13 08:37:12 +0000419 int n;
Andy Greenaaf0b9f2013-01-30 08:12:20 +0800420 int ret = -1;
David Galeanocb193682013-01-09 15:29:00 +0800421#ifdef AF_LOCAL
422 struct sockaddr_un *un;
423#endif
Andy Green07034092011-02-13 08:37:12 +0000424
425 rip[0] = '\0';
426 name[0] = '\0';
427
Andy Greenaaf0b9f2013-01-30 08:12:20 +0800428 lws_latency_pre(context, wsi);
429
Andy Green07034092011-02-13 08:37:12 +0000430 len = sizeof sin;
431 if (getpeername(fd, (struct sockaddr *) &sin, &len) < 0) {
432 perror("getpeername");
Andy Greenaaf0b9f2013-01-30 08:12:20 +0800433 goto bail;
Andy Green07034092011-02-13 08:37:12 +0000434 }
Andy Green6ee372f2012-04-09 15:09:01 +0800435
Andy Green07034092011-02-13 08:37:12 +0000436 host = gethostbyaddr((char *) &sin.sin_addr, sizeof sin.sin_addr,
437 AF_INET);
438 if (host == NULL) {
439 perror("gethostbyaddr");
Andy Greenaaf0b9f2013-01-30 08:12:20 +0800440 goto bail;
Andy Green07034092011-02-13 08:37:12 +0000441 }
442
443 strncpy(name, host->h_name, name_len);
444 name[name_len - 1] = '\0';
445
446 host1 = gethostbyname(host->h_name);
447 if (host1 == NULL)
Andy Greenaaf0b9f2013-01-30 08:12:20 +0800448 goto bail;
Andy Greenf92def72011-03-09 15:02:20 +0000449 p = (unsigned char *)host1;
Andy Green07034092011-02-13 08:37:12 +0000450 n = 0;
451 while (p != NULL) {
Andy Greenf92def72011-03-09 15:02:20 +0000452 p = (unsigned char *)host1->h_addr_list[n++];
Andy Green07034092011-02-13 08:37:12 +0000453 if (p == NULL)
454 continue;
Peter Hinzbb45a902011-03-10 18:14:01 +0000455 if ((host1->h_addrtype != AF_INET)
456#ifdef AF_LOCAL
457 && (host1->h_addrtype != AF_LOCAL)
458#endif
459 )
Andy Green07034092011-02-13 08:37:12 +0000460 continue;
461
Andy Green7627af52011-03-09 15:13:52 +0000462 if (host1->h_addrtype == AF_INET)
463 sprintf(ip, "%u.%u.%u.%u", p[0], p[1], p[2], p[3]);
Peter Hinzbb45a902011-03-10 18:14:01 +0000464#ifdef AF_LOCAL
Andy Green7627af52011-03-09 15:13:52 +0000465 else {
466 un = (struct sockaddr_un *)p;
Andy Green6ee372f2012-04-09 15:09:01 +0800467 strncpy(ip, un->sun_path, sizeof(ip) - 1);
Andy Green7627af52011-03-09 15:13:52 +0000468 ip[sizeof(ip) - 1] = '\0';
469 }
Peter Hinzbb45a902011-03-10 18:14:01 +0000470#endif
Andy Green07034092011-02-13 08:37:12 +0000471 p = NULL;
472 strncpy(rip, ip, rip_len);
473 rip[rip_len - 1] = '\0';
474 }
Andy Greenaaf0b9f2013-01-30 08:12:20 +0800475
476 ret = 0;
477bail:
478 lws_latency(context, wsi, "libwebsockets_get_peer_addresses", ret, 1);
Andy Green07034092011-02-13 08:37:12 +0000479}
Andy Green9f990342011-02-12 11:57:45 +0000480
Peter Hinz56885f32011-03-02 22:03:47 +0000481int libwebsockets_get_random(struct libwebsocket_context *context,
482 void *buf, int len)
483{
484 int n;
Aaron Zinman4550f1d2013-01-10 12:35:18 +0800485 char *p = (char *)buf;
Peter Hinz56885f32011-03-02 22:03:47 +0000486
487#ifdef WIN32
488 for (n = 0; n < len; n++)
489 p[n] = (unsigned char)rand();
490#else
491 n = read(context->fd_random, p, len);
492#endif
493
494 return n;
495}
496
Andy Green95a7b5d2011-03-06 10:29:39 +0000497int lws_send_pipe_choked(struct libwebsocket *wsi)
498{
499 struct pollfd fds;
500
501 fds.fd = wsi->sock;
502 fds.events = POLLOUT;
503 fds.revents = 0;
504
505 if (poll(&fds, 1, 0) != 1)
506 return 1;
507
508 if ((fds.revents & POLLOUT) == 0)
509 return 1;
510
511 /* okay to send another packet without blocking */
512
513 return 0;
514}
515
Andy Greena41314f2011-05-23 10:00:03 +0100516int
Andy Green3b84c002011-03-06 13:14:42 +0000517lws_handle_POLLOUT_event(struct libwebsocket_context *context,
518 struct libwebsocket *wsi, struct pollfd *pollfd)
519{
Andy Green3b84c002011-03-06 13:14:42 +0000520 int n;
Andy Green6f520a52013-01-29 17:57:39 +0800521
Andy Green3182ece2013-01-20 17:08:31 +0800522#ifndef LWS_NO_EXTENSIONS
523 struct lws_tokens eff_buf;
Andy Green3b84c002011-03-06 13:14:42 +0000524 int ret;
525 int m;
Andy Greena41314f2011-05-23 10:00:03 +0100526 int handled = 0;
Andy Green3b84c002011-03-06 13:14:42 +0000527
Andy Greena41314f2011-05-23 10:00:03 +0100528 for (n = 0; n < wsi->count_active_extensions; n++) {
529 if (!wsi->active_extensions[n]->callback)
530 continue;
531
532 m = wsi->active_extensions[n]->callback(context,
533 wsi->active_extensions[n], wsi,
534 LWS_EXT_CALLBACK_IS_WRITEABLE,
535 wsi->active_extensions_user[n], NULL, 0);
536 if (m > handled)
537 handled = m;
538 }
539
540 if (handled == 1)
541 goto notify_action;
542
543 if (!wsi->extension_data_pending || handled == 2)
Andy Green3b84c002011-03-06 13:14:42 +0000544 goto user_service;
545
546 /*
547 * check in on the active extensions, see if they
548 * had pending stuff to spill... they need to get the
549 * first look-in otherwise sequence will be disordered
550 *
551 * NULL, zero-length eff_buf means just spill pending
552 */
553
554 ret = 1;
555 while (ret == 1) {
556
557 /* default to nobody has more to spill */
558
559 ret = 0;
560 eff_buf.token = NULL;
561 eff_buf.token_len = 0;
562
563 /* give every extension a chance to spill */
564
565 for (n = 0; n < wsi->count_active_extensions; n++) {
566 m = wsi->active_extensions[n]->callback(
Andy Green46c2ea02011-03-22 09:04:01 +0000567 wsi->protocol->owning_server,
568 wsi->active_extensions[n], wsi,
Andy Green3b84c002011-03-06 13:14:42 +0000569 LWS_EXT_CALLBACK_PACKET_TX_PRESEND,
570 wsi->active_extensions_user[n], &eff_buf, 0);
571 if (m < 0) {
Andy Green43db0452013-01-10 19:50:35 +0800572 lwsl_err("ext reports fatal error\n");
Andy Green3b84c002011-03-06 13:14:42 +0000573 return -1;
574 }
575 if (m)
576 /*
577 * at least one extension told us he has more
578 * to spill, so we will go around again after
579 */
580 ret = 1;
581 }
582
583 /* assuming they gave us something to send, send it */
584
585 if (eff_buf.token_len) {
586 if (lws_issue_raw(wsi, (unsigned char *)eff_buf.token,
587 eff_buf.token_len))
588 return -1;
589 } else
590 continue;
591
592 /* no extension has more to spill */
593
594 if (!ret)
595 continue;
596
597 /*
598 * There's more to spill from an extension, but we just sent
599 * something... did that leave the pipe choked?
600 */
601
602 if (!lws_send_pipe_choked(wsi))
603 /* no we could add more */
604 continue;
605
Andy Green43db0452013-01-10 19:50:35 +0800606 lwsl_info("choked in POLLOUT service\n");
Andy Green3b84c002011-03-06 13:14:42 +0000607
608 /*
609 * Yes, he's choked. Leave the POLLOUT masked on so we will
610 * come back here when he is unchoked. Don't call the user
611 * callback to enforce ordering of spilling, he'll get called
612 * when we come back here and there's nothing more to spill.
613 */
614
615 return 0;
616 }
617
618 wsi->extension_data_pending = 0;
619
620user_service:
Andy Green3182ece2013-01-20 17:08:31 +0800621#endif
Andy Green3b84c002011-03-06 13:14:42 +0000622 /* one shot */
623
Andy Greena41314f2011-05-23 10:00:03 +0100624 if (pollfd) {
625 pollfd->events &= ~POLLOUT;
Andy Green3b84c002011-03-06 13:14:42 +0000626
Andy Greena41314f2011-05-23 10:00:03 +0100627 /* external POLL support via protocol 0 */
628 context->protocols[0].callback(context, wsi,
629 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
630 (void *)(long)wsi->sock, NULL, POLLOUT);
631 }
Andy Green3182ece2013-01-20 17:08:31 +0800632#ifndef LWS_NO_EXTENSIONS
Andy Greena41314f2011-05-23 10:00:03 +0100633notify_action:
Andy Green3182ece2013-01-20 17:08:31 +0800634#endif
Andy Green3b84c002011-03-06 13:14:42 +0000635
Andy Green9e4c2b62011-03-07 20:47:39 +0000636 if (wsi->mode == LWS_CONNMODE_WS_CLIENT)
637 n = LWS_CALLBACK_CLIENT_WRITEABLE;
638 else
639 n = LWS_CALLBACK_SERVER_WRITEABLE;
640
Andy Green706961d2013-01-17 16:50:35 +0800641 user_callback_handle_rxflow(wsi->protocol->callback, context,
642 wsi, (enum libwebsocket_callback_reasons) n, wsi->user_space, NULL, 0);
Andy Green3b84c002011-03-06 13:14:42 +0000643
644 return 0;
645}
646
647
648
Andy Greena41314f2011-05-23 10:00:03 +0100649void
650libwebsocket_service_timeout_check(struct libwebsocket_context *context,
651 struct libwebsocket *wsi, unsigned int sec)
652{
Andy Green3182ece2013-01-20 17:08:31 +0800653#ifndef LWS_NO_EXTENSIONS
Andy Greena41314f2011-05-23 10:00:03 +0100654 int n;
655
656 /*
657 * if extensions want in on it (eg, we are a mux parent)
658 * give them a chance to service child timeouts
659 */
660
661 for (n = 0; n < wsi->count_active_extensions; n++)
662 wsi->active_extensions[n]->callback(
663 context, wsi->active_extensions[n],
664 wsi, LWS_EXT_CALLBACK_1HZ,
665 wsi->active_extensions_user[n], NULL, sec);
666
Andy Green3182ece2013-01-20 17:08:31 +0800667#endif
Andy Greena41314f2011-05-23 10:00:03 +0100668 if (!wsi->pending_timeout)
669 return;
Andy Green6ee372f2012-04-09 15:09:01 +0800670
Andy Greena41314f2011-05-23 10:00:03 +0100671 /*
672 * if we went beyond the allowed time, kill the
673 * connection
674 */
675
676 if (sec > wsi->pending_timeout_limit) {
Andy Green43db0452013-01-10 19:50:35 +0800677 lwsl_info("TIMEDOUT WAITING\n");
Andy Greena41314f2011-05-23 10:00:03 +0100678 libwebsocket_close_and_free_session(context,
679 wsi, LWS_CLOSE_STATUS_NOSTATUS);
680 }
681}
682
Andy Green9f990342011-02-12 11:57:45 +0000683/**
684 * libwebsocket_service_fd() - Service polled socket with something waiting
Peter Hinz56885f32011-03-02 22:03:47 +0000685 * @context: Websocket context
Andy Green9f990342011-02-12 11:57:45 +0000686 * @pollfd: The pollfd entry describing the socket fd and which events
Andy Green6ee372f2012-04-09 15:09:01 +0800687 * happened.
Andy Green9f990342011-02-12 11:57:45 +0000688 *
Andy Green75006172013-01-22 12:32:11 +0800689 * This function takes a pollfd that has POLLIN or POLLOUT activity and
690 * services it according to the state of the associated struct libwebsocket.
691 *
692 * The one call deals with all "service" that might happen on a socket
693 * including listen accepts, http files as well as websocket protocol.
Andy Green9f990342011-02-12 11:57:45 +0000694 */
695
696int
Peter Hinz56885f32011-03-02 22:03:47 +0000697libwebsocket_service_fd(struct libwebsocket_context *context,
Andy Green0d338332011-02-12 11:57:43 +0000698 struct pollfd *pollfd)
Andy Greenb45993c2010-12-18 15:13:50 +0000699{
Andy Greena1ce6be2013-01-18 11:43:21 +0800700 struct libwebsocket *wsi;
Andy Greenb45993c2010-12-18 15:13:50 +0000701 int n;
Andy Green0d338332011-02-12 11:57:43 +0000702 int m;
Andy Greena71eafc2011-02-14 17:59:43 +0000703 struct timeval tv;
Andy Green6f520a52013-01-29 17:57:39 +0800704 unsigned char buf[LWS_SEND_BUFFER_PRE_PADDING + 1 +
705 MAX_USER_RX_BUFFER + LWS_SEND_BUFFER_POST_PADDING];
706
Andy Green3182ece2013-01-20 17:08:31 +0800707#ifndef LWS_NO_EXTENSIONS
Andy Green2366b1c2011-03-06 13:15:31 +0000708 int more = 1;
Andy Green3182ece2013-01-20 17:08:31 +0800709#endif
Andy Green98a717c2011-03-06 13:14:15 +0000710 struct lws_tokens eff_buf;
Andy Green03674a62013-01-16 11:47:40 +0800711#ifndef LWS_NO_CLIENT
Andy Green76f61e72013-01-16 11:53:05 +0800712 extern int lws_client_socket_service(struct libwebsocket_context *context, struct libwebsocket *wsi, struct pollfd *pollfd);
Andy Green03674a62013-01-16 11:47:40 +0800713#endif
Andy Greena1ce6be2013-01-18 11:43:21 +0800714#ifndef LWS_NO_SERVER
715 extern int lws_server_socket_service(struct libwebsocket_context *context, struct libwebsocket *wsi, struct pollfd *pollfd);
716#endif
Andy Greena71eafc2011-02-14 17:59:43 +0000717 /*
718 * you can call us with pollfd = NULL to just allow the once-per-second
719 * global timeout checks; if less than a second since the last check
720 * it returns immediately then.
721 */
722
723 gettimeofday(&tv, NULL);
724
Peter Hinz56885f32011-03-02 22:03:47 +0000725 if (context->last_timeout_check_s != tv.tv_sec) {
726 context->last_timeout_check_s = tv.tv_sec;
Andy Greena71eafc2011-02-14 17:59:43 +0000727
Andy Green24cba922013-01-19 13:56:10 +0800728 /* if our parent went down, don't linger around */
729 if (context->started_with_parent && kill(context->started_with_parent, 0) < 0)
730 kill(getpid(), SIGTERM);
731
Andy Greena71eafc2011-02-14 17:59:43 +0000732 /* global timeout check once per second */
733
Peter Hinz56885f32011-03-02 22:03:47 +0000734 for (n = 0; n < context->fds_count; n++) {
Andy Greendfb23042013-01-17 12:26:48 +0800735 struct libwebsocket *new_wsi = context->lws_lookup[context->fds[n].fd];
736 if (!new_wsi)
737 continue;
738 libwebsocket_service_timeout_check(context,
739 new_wsi, tv.tv_sec);
Andy Greena71eafc2011-02-14 17:59:43 +0000740 }
741 }
742
743 /* just here for timeout management? */
744
745 if (pollfd == NULL)
746 return 0;
747
748 /* no, here to service a socket descriptor */
749
Andy Green65b0e912013-01-16 07:59:47 +0800750 /*
751 * deal with listen service piggybacking
752 * every listen_service_modulo services of other fds, we
753 * sneak one in to service the listen socket if there's anything waiting
754 *
755 * To handle connection storms, as found in ab, if we previously saw a
756 * pending connection here, it causes us to check again next time.
757 */
758
759 if (context->listen_service_fd && pollfd->fd != context->listen_service_fd) {
760 context->listen_service_count++;
761 if (context->listen_service_extraseen ||
762 context->listen_service_count == context->listen_service_modulo) {
763 context->listen_service_count = 0;
764 m = 1;
765 if (context->listen_service_extraseen > 5)
766 m = 2;
767 while (m--) {
768 /* even with extpoll, we prepared this internal fds for listen */
769 n = poll(&context->fds[0], 1, 0);
770 if (n > 0) { /* there's a connection waiting for us */
771 libwebsocket_service_fd(context, &context->fds[0]);
772 context->listen_service_extraseen++;
773 } else {
774 if (context->listen_service_extraseen)
775 context->listen_service_extraseen--;
776 break;
777 }
778 }
779 }
780
781 }
782
783 /* okay, what we came here to do... */
784
Andy Greendfb23042013-01-17 12:26:48 +0800785 wsi = context->lws_lookup[pollfd->fd];
Andy Greend280b6e2013-01-15 13:40:23 +0800786 if (wsi == NULL) {
Andy Greendfb23042013-01-17 12:26:48 +0800787 if (pollfd->fd > 11)
788 lwsl_err("unexpected NULL wsi fd=%d fds_count=%d\n", pollfd->fd, context->fds_count);
Andy Greenfa3f4052012-10-07 20:40:35 +0800789 return 0;
Andy Greend280b6e2013-01-15 13:40:23 +0800790 }
Andy Green8f037e42010-12-19 22:13:26 +0000791
Andy Green0d338332011-02-12 11:57:43 +0000792 switch (wsi->mode) {
Andy Greend280b6e2013-01-15 13:40:23 +0800793
Andy Greena1ce6be2013-01-18 11:43:21 +0800794#ifndef LWS_NO_SERVER
Andy Greend280b6e2013-01-15 13:40:23 +0800795 case LWS_CONNMODE_HTTP_SERVING:
Andy Green0d338332011-02-12 11:57:43 +0000796 case LWS_CONNMODE_SERVER_LISTENER:
Andy Greene2160712013-01-28 12:19:10 +0800797 case LWS_CONNMODE_SSL_ACK_PENDING:
Andy Greena1ce6be2013-01-18 11:43:21 +0800798 return lws_server_socket_service(context, wsi, pollfd);
799#endif
Andy Greenbe93fef2011-02-14 20:25:43 +0000800
Andy Green0d338332011-02-12 11:57:43 +0000801 case LWS_CONNMODE_WS_SERVING:
802 case LWS_CONNMODE_WS_CLIENT:
803
804 /* handle session socket closed */
805
806 if (pollfd->revents & (POLLERR | POLLHUP)) {
807
Andy Green43db0452013-01-10 19:50:35 +0800808 lwsl_debug("Session Socket %p (fd=%d) dead\n",
Andy Green0d338332011-02-12 11:57:43 +0000809 (void *)wsi, pollfd->fd);
810
Peter Hinz56885f32011-03-02 22:03:47 +0000811 libwebsocket_close_and_free_session(context, wsi,
Andy Green687b0182011-02-26 11:04:01 +0000812 LWS_CLOSE_STATUS_NOSTATUS);
Andy Green040d2ef2013-01-16 13:40:43 +0800813 return 0;
Andy Greenb45993c2010-12-18 15:13:50 +0000814 }
815
Andy Green0d338332011-02-12 11:57:43 +0000816 /* the guy requested a callback when it was OK to write */
817
Andy Greenda527df2011-03-07 07:08:12 +0000818 if ((pollfd->revents & POLLOUT) &&
819 wsi->state == WSI_STATE_ESTABLISHED)
820 if (lws_handle_POLLOUT_event(context, wsi,
821 pollfd) < 0) {
822 libwebsocket_close_and_free_session(
823 context, wsi, LWS_CLOSE_STATUS_NORMAL);
Andy Green040d2ef2013-01-16 13:40:43 +0800824 return 0;
Andy Green3b84c002011-03-06 13:14:42 +0000825 }
Andy Green0d338332011-02-12 11:57:43 +0000826
Andy Green0d338332011-02-12 11:57:43 +0000827
828 /* any incoming data ready? */
829
830 if (!(pollfd->revents & POLLIN))
831 break;
832
Andy Greenb45993c2010-12-18 15:13:50 +0000833#ifdef LWS_OPENSSL_SUPPORT
David Galeano7ffbe1b2013-01-10 10:35:32 +0800834read_pending:
Andy Green0d338332011-02-12 11:57:43 +0000835 if (wsi->ssl)
Andy Green98a717c2011-03-06 13:14:15 +0000836 eff_buf.token_len = SSL_read(wsi->ssl, buf, sizeof buf);
Andy Greenb45993c2010-12-18 15:13:50 +0000837 else
838#endif
Andy Green98a717c2011-03-06 13:14:15 +0000839 eff_buf.token_len =
Andy Green72c34322011-04-16 10:46:21 +0100840 recv(pollfd->fd, buf, sizeof buf, 0);
Andy Greenb45993c2010-12-18 15:13:50 +0000841
Andy Green98a717c2011-03-06 13:14:15 +0000842 if (eff_buf.token_len < 0) {
Andy Green43db0452013-01-10 19:50:35 +0800843 lwsl_debug("Socket read returned %d\n",
Andy Green98a717c2011-03-06 13:14:15 +0000844 eff_buf.token_len);
Alon Levydc93b7f2012-10-19 11:21:57 +0200845 if (errno != EINTR && errno != EAGAIN)
Andy Green6ee372f2012-04-09 15:09:01 +0800846 libwebsocket_close_and_free_session(context,
847 wsi, LWS_CLOSE_STATUS_NOSTATUS);
Andy Green040d2ef2013-01-16 13:40:43 +0800848 return 0;
Andy Greenb45993c2010-12-18 15:13:50 +0000849 }
Andy Green98a717c2011-03-06 13:14:15 +0000850 if (!eff_buf.token_len) {
Peter Hinz56885f32011-03-02 22:03:47 +0000851 libwebsocket_close_and_free_session(context, wsi,
Andy Green6ee372f2012-04-09 15:09:01 +0800852 LWS_CLOSE_STATUS_NOSTATUS);
Andy Greenfa3f4052012-10-07 20:40:35 +0800853 return 0;
Andy Greenb45993c2010-12-18 15:13:50 +0000854 }
855
Andy Green98a717c2011-03-06 13:14:15 +0000856 /*
857 * give any active extensions a chance to munge the buffer
858 * before parse. We pass in a pointer to an lws_tokens struct
859 * prepared with the default buffer and content length that's in
860 * there. Rather than rewrite the default buffer, extensions
861 * that expect to grow the buffer can adapt .token to
862 * point to their own per-connection buffer in the extension
863 * user allocation. By default with no extensions or no
864 * extension callback handling, just the normal input buffer is
865 * used then so it is efficient.
866 */
Andy Greenb45993c2010-12-18 15:13:50 +0000867
Andy Green98a717c2011-03-06 13:14:15 +0000868 eff_buf.token = (char *)buf;
Andy Green3182ece2013-01-20 17:08:31 +0800869#ifndef LWS_NO_EXTENSIONS
Andy Green98a717c2011-03-06 13:14:15 +0000870 more = 1;
871 while (more) {
Andy Green0d338332011-02-12 11:57:43 +0000872
Andy Green98a717c2011-03-06 13:14:15 +0000873 more = 0;
874
875 for (n = 0; n < wsi->count_active_extensions; n++) {
Andy Green46c2ea02011-03-22 09:04:01 +0000876 m = wsi->active_extensions[n]->callback(context,
877 wsi->active_extensions[n], wsi,
Andy Green98a717c2011-03-06 13:14:15 +0000878 LWS_EXT_CALLBACK_PACKET_RX_PREPARSE,
Andy Green46c2ea02011-03-22 09:04:01 +0000879 wsi->active_extensions_user[n],
880 &eff_buf, 0);
Andy Green98a717c2011-03-06 13:14:15 +0000881 if (m < 0) {
Andy Green43db0452013-01-10 19:50:35 +0800882 lwsl_ext(
Andy Green6ee372f2012-04-09 15:09:01 +0800883 "Extension reports fatal error\n");
884 libwebsocket_close_and_free_session(
885 context, wsi,
886 LWS_CLOSE_STATUS_NOSTATUS);
Andy Green040d2ef2013-01-16 13:40:43 +0800887 return 0;
Andy Green98a717c2011-03-06 13:14:15 +0000888 }
889 if (m)
890 more = 1;
891 }
Andy Green3182ece2013-01-20 17:08:31 +0800892#endif
Andy Green98a717c2011-03-06 13:14:15 +0000893 /* service incoming data */
894
895 if (eff_buf.token_len) {
896 n = libwebsocket_read(context, wsi,
Andy Green6ee372f2012-04-09 15:09:01 +0800897 (unsigned char *)eff_buf.token,
898 eff_buf.token_len);
Andy Green98a717c2011-03-06 13:14:15 +0000899 if (n < 0)
900 /* we closed wsi */
Andy Green040d2ef2013-01-16 13:40:43 +0800901 return 0;
Andy Green98a717c2011-03-06 13:14:15 +0000902 }
Andy Green3182ece2013-01-20 17:08:31 +0800903#ifndef LWS_NO_EXTENSIONS
Andy Green98a717c2011-03-06 13:14:15 +0000904 eff_buf.token = NULL;
905 eff_buf.token_len = 0;
906 }
Andy Green3182ece2013-01-20 17:08:31 +0800907#endif
David Galeano7ffbe1b2013-01-10 10:35:32 +0800908
909#ifdef LWS_OPENSSL_SUPPORT
910 if (wsi->ssl && SSL_pending(wsi->ssl))
911 goto read_pending;
912#endif
Andy Green98a717c2011-03-06 13:14:15 +0000913 break;
Andy Green76f61e72013-01-16 11:53:05 +0800914
915 default:
Andy Green03674a62013-01-16 11:47:40 +0800916#ifdef LWS_NO_CLIENT
917 break;
918#else
Andy Green76f61e72013-01-16 11:53:05 +0800919 return lws_client_socket_service(context, wsi, pollfd);
Andy Green03674a62013-01-16 11:47:40 +0800920#endif
Andy Greenb45993c2010-12-18 15:13:50 +0000921 }
922
923 return 0;
924}
925
Andy Green0d338332011-02-12 11:57:43 +0000926
Andy Green6964bb52011-01-23 16:50:33 +0000927/**
928 * libwebsocket_context_destroy() - Destroy the websocket context
Peter Hinz56885f32011-03-02 22:03:47 +0000929 * @context: Websocket context
Andy Green6964bb52011-01-23 16:50:33 +0000930 *
931 * This function closes any active connections and then frees the
932 * context. After calling this, any further use of the context is
933 * undefined.
934 */
935void
Peter Hinz56885f32011-03-02 22:03:47 +0000936libwebsocket_context_destroy(struct libwebsocket_context *context)
Andy Green6964bb52011-01-23 16:50:33 +0000937{
Andy Green3182ece2013-01-20 17:08:31 +0800938#ifndef LWS_NO_EXTENSIONS
Andy Green0d338332011-02-12 11:57:43 +0000939 int n;
940 int m;
Andy Greena41314f2011-05-23 10:00:03 +0100941 struct libwebsocket_extension *ext;
Andy Green6964bb52011-01-23 16:50:33 +0000942
Andy Greend636e352013-01-29 12:36:17 +0800943#ifdef LWS_LATENCY
944 if (context->worst_latency_info[0])
945 lwsl_notice("Worst latency: %s\n", context->worst_latency_info);
946#endif
947
Andy Greendfb23042013-01-17 12:26:48 +0800948 for (n = 0; n < context->fds_count; n++) {
949 struct libwebsocket *wsi = context->lws_lookup[context->fds[n].fd];
950 libwebsocket_close_and_free_session(context,
951 wsi, LWS_CLOSE_STATUS_GOINGAWAY);
952 }
Andy Green6964bb52011-01-23 16:50:33 +0000953
Andy Greena41314f2011-05-23 10:00:03 +0100954 /*
955 * give all extensions a chance to clean up any per-context
956 * allocations they might have made
957 */
958
959 ext = context->extensions;
960 m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_DESTRUCT;
961 if (context->listen_port)
962 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_DESTRUCT;
Paulo Roberto Urio1f680ab2012-06-04 08:40:28 +0800963 while (ext && ext->callback) {
Aaron Zinman4550f1d2013-01-10 12:35:18 +0800964 ext->callback(context, ext, NULL, (enum libwebsocket_extension_callback_reasons)m, NULL, NULL, 0);
Andy Greena41314f2011-05-23 10:00:03 +0100965 ext++;
966 }
Andy Green3182ece2013-01-20 17:08:31 +0800967#endif
Andy Greena41314f2011-05-23 10:00:03 +0100968
Peter Hinz56885f32011-03-02 22:03:47 +0000969#ifdef WIN32
970#else
971 close(context->fd_random);
Andy Green6964bb52011-01-23 16:50:33 +0000972#endif
973
Peter Hinz56885f32011-03-02 22:03:47 +0000974#ifdef LWS_OPENSSL_SUPPORT
975 if (context->ssl_ctx)
976 SSL_CTX_free(context->ssl_ctx);
977 if (context->ssl_client_ctx)
978 SSL_CTX_free(context->ssl_client_ctx);
979#endif
980
981 free(context);
982
983#ifdef WIN32
984 WSACleanup();
985#endif
Andy Green6964bb52011-01-23 16:50:33 +0000986}
987
Andy Greend88146d2013-01-22 12:40:35 +0800988/**
989 * libwebsocket_context_user() - get the user data associated with the whole context
990 * @context: Websocket context
991 *
992 * This returns the optional user allocation that can be attached to
993 * the context the sockets live in at context_create time. It's a way
994 * to let all sockets serviced in the same context share data without
995 * using globals statics in the user code.
996 */
997
998
Alon Levy0291eb32012-10-19 11:21:56 +0200999LWS_EXTERN void *
1000libwebsocket_context_user(struct libwebsocket_context *context)
1001{
1002 return context->user_space;
1003}
1004
Andy Green6964bb52011-01-23 16:50:33 +00001005/**
1006 * libwebsocket_service() - Service any pending websocket activity
Peter Hinz56885f32011-03-02 22:03:47 +00001007 * @context: Websocket context
Andy Green6964bb52011-01-23 16:50:33 +00001008 * @timeout_ms: Timeout for poll; 0 means return immediately if nothing needed
1009 * service otherwise block and service immediately, returning
1010 * after the timeout if nothing needed service.
1011 *
1012 * This function deals with any pending websocket traffic, for three
1013 * kinds of event. It handles these events on both server and client
1014 * types of connection the same.
1015 *
1016 * 1) Accept new connections to our context's server
1017 *
Andy Green6f520a52013-01-29 17:57:39 +08001018 * 2) Call the receive callback for incoming frame data received by
Andy Green6964bb52011-01-23 16:50:33 +00001019 * server or client connections.
1020 *
1021 * You need to call this service function periodically to all the above
1022 * functions to happen; if your application is single-threaded you can
1023 * just call it in your main event loop.
1024 *
1025 * Alternatively you can fork a new process that asynchronously handles
1026 * calling this service in a loop. In that case you are happy if this
1027 * call blocks your thread until it needs to take care of something and
1028 * would call it with a large nonzero timeout. Your loop then takes no
1029 * CPU while there is nothing happening.
1030 *
1031 * If you are calling it in a single-threaded app, you don't want it to
1032 * wait around blocking other things in your loop from happening, so you
1033 * would call it with a timeout_ms of 0, so it returns immediately if
1034 * nothing is pending, or as soon as it services whatever was pending.
1035 */
1036
Andy Greenb45993c2010-12-18 15:13:50 +00001037
Andy Greene92cd172011-01-19 13:11:55 +00001038int
Peter Hinz56885f32011-03-02 22:03:47 +00001039libwebsocket_service(struct libwebsocket_context *context, int timeout_ms)
Andy Greene92cd172011-01-19 13:11:55 +00001040{
1041 int n;
Andy Greene92cd172011-01-19 13:11:55 +00001042
1043 /* stay dead once we are dead */
1044
Peter Hinz56885f32011-03-02 22:03:47 +00001045 if (context == NULL)
Andy Greene92cd172011-01-19 13:11:55 +00001046 return 1;
1047
Andy Green0d338332011-02-12 11:57:43 +00001048 /* wait for something to need service */
Andy Green4739e5c2011-01-22 12:51:57 +00001049
Peter Hinz56885f32011-03-02 22:03:47 +00001050 n = poll(context->fds, context->fds_count, timeout_ms);
Andy Green3221f922011-02-12 13:14:11 +00001051 if (n == 0) /* poll timeout */
1052 return 0;
Andy Greene92cd172011-01-19 13:11:55 +00001053
Andy Greendfb23042013-01-17 12:26:48 +08001054 if (n < 0)
Andy Green3928f612012-07-20 12:58:38 +08001055 return -1;
Andy Greene92cd172011-01-19 13:11:55 +00001056
Andy Greendfb23042013-01-17 12:26:48 +08001057 /* any socket with events to service? */
Andy Greene92cd172011-01-19 13:11:55 +00001058
Peter Hinz56885f32011-03-02 22:03:47 +00001059 for (n = 0; n < context->fds_count; n++)
1060 if (context->fds[n].revents)
Andy Green3928f612012-07-20 12:58:38 +08001061 if (libwebsocket_service_fd(context,
1062 &context->fds[n]) < 0)
1063 return -1;
Andy Greene92cd172011-01-19 13:11:55 +00001064 return 0;
Andy Greene92cd172011-01-19 13:11:55 +00001065}
1066
Andy Green3182ece2013-01-20 17:08:31 +08001067#ifndef LWS_NO_EXTENSIONS
Andy Greena41314f2011-05-23 10:00:03 +01001068int
1069lws_any_extension_handled(struct libwebsocket_context *context,
Andy Green6ee372f2012-04-09 15:09:01 +08001070 struct libwebsocket *wsi,
1071 enum libwebsocket_extension_callback_reasons r,
Andy Greena41314f2011-05-23 10:00:03 +01001072 void *v, size_t len)
1073{
1074 int n;
1075 int handled = 0;
1076
1077 /* maybe an extension will take care of it for us */
1078
1079 for (n = 0; n < wsi->count_active_extensions && !handled; n++) {
1080 if (!wsi->active_extensions[n]->callback)
1081 continue;
1082
1083 handled |= wsi->active_extensions[n]->callback(context,
1084 wsi->active_extensions[n], wsi,
1085 r, wsi->active_extensions_user[n], v, len);
1086 }
1087
1088 return handled;
1089}
1090
1091
1092void *
1093lws_get_extension_user_matching_ext(struct libwebsocket *wsi,
Andy Green6ee372f2012-04-09 15:09:01 +08001094 struct libwebsocket_extension *ext)
Andy Greena41314f2011-05-23 10:00:03 +01001095{
1096 int n = 0;
1097
Andy Green68b45042011-05-25 21:41:57 +01001098 if (wsi == NULL)
1099 return NULL;
1100
Andy Greena41314f2011-05-23 10:00:03 +01001101 while (n < wsi->count_active_extensions) {
1102 if (wsi->active_extensions[n] != ext) {
1103 n++;
1104 continue;
1105 }
1106 return wsi->active_extensions_user[n];
1107 }
1108
1109 return NULL;
1110}
Andy Green3182ece2013-01-20 17:08:31 +08001111#endif
Andy Greena41314f2011-05-23 10:00:03 +01001112
Andy Green90c7cbc2011-01-27 06:26:52 +00001113/**
1114 * libwebsocket_callback_on_writable() - Request a callback when this socket
1115 * becomes able to be written to without
1116 * blocking
Andy Green32375b72011-02-19 08:32:53 +00001117 *
Peter Hinz56885f32011-03-02 22:03:47 +00001118 * @context: libwebsockets context
Andy Green90c7cbc2011-01-27 06:26:52 +00001119 * @wsi: Websocket connection instance to get callback for
1120 */
1121
1122int
Peter Hinz56885f32011-03-02 22:03:47 +00001123libwebsocket_callback_on_writable(struct libwebsocket_context *context,
Andy Green6ee372f2012-04-09 15:09:01 +08001124 struct libwebsocket *wsi)
Andy Green90c7cbc2011-01-27 06:26:52 +00001125{
Andy Green3182ece2013-01-20 17:08:31 +08001126#ifndef LWS_NO_EXTENSIONS
Andy Green90c7cbc2011-01-27 06:26:52 +00001127 int n;
Andy Greena41314f2011-05-23 10:00:03 +01001128 int handled = 0;
1129
1130 /* maybe an extension will take care of it for us */
1131
1132 for (n = 0; n < wsi->count_active_extensions; n++) {
1133 if (!wsi->active_extensions[n]->callback)
1134 continue;
1135
1136 handled |= wsi->active_extensions[n]->callback(context,
1137 wsi->active_extensions[n], wsi,
1138 LWS_EXT_CALLBACK_REQUEST_ON_WRITEABLE,
1139 wsi->active_extensions_user[n], NULL, 0);
1140 }
1141
1142 if (handled)
1143 return 1;
Andy Green3182ece2013-01-20 17:08:31 +08001144#endif
Andy Greendfb23042013-01-17 12:26:48 +08001145 if (wsi->position_in_fds_table < 0) {
Andy Green43db0452013-01-10 19:50:35 +08001146 lwsl_err("libwebsocket_callback_on_writable: "
Andy Green6ee372f2012-04-09 15:09:01 +08001147 "failed to find socket %d\n", wsi->sock);
Andy Greendfb23042013-01-17 12:26:48 +08001148 return -1;
1149 }
1150
1151 context->fds[wsi->position_in_fds_table].events |= POLLOUT;
Andy Greena41314f2011-05-23 10:00:03 +01001152
Andy Green3221f922011-02-12 13:14:11 +00001153 /* external POLL support via protocol 0 */
Peter Hinz56885f32011-03-02 22:03:47 +00001154 context->protocols[0].callback(context, wsi,
Andy Green3221f922011-02-12 13:14:11 +00001155 LWS_CALLBACK_SET_MODE_POLL_FD,
1156 (void *)(long)wsi->sock, NULL, POLLOUT);
1157
Andy Green90c7cbc2011-01-27 06:26:52 +00001158 return 1;
1159}
1160
1161/**
1162 * libwebsocket_callback_on_writable_all_protocol() - Request a callback for
1163 * all connections using the given protocol when it
1164 * becomes possible to write to each socket without
1165 * blocking in turn.
1166 *
1167 * @protocol: Protocol whose connections will get callbacks
1168 */
1169
1170int
1171libwebsocket_callback_on_writable_all_protocol(
1172 const struct libwebsocket_protocols *protocol)
1173{
Peter Hinz56885f32011-03-02 22:03:47 +00001174 struct libwebsocket_context *context = protocol->owning_server;
Andy Green90c7cbc2011-01-27 06:26:52 +00001175 int n;
Andy Green0d338332011-02-12 11:57:43 +00001176 struct libwebsocket *wsi;
Andy Green90c7cbc2011-01-27 06:26:52 +00001177
Andy Greendfb23042013-01-17 12:26:48 +08001178 for (n = 0; n < context->fds_count; n++) {
1179 wsi = context->lws_lookup[context->fds[n].fd];
1180 if (!wsi)
1181 continue;
1182 if (wsi->protocol == protocol)
1183 libwebsocket_callback_on_writable(context, wsi);
Andy Green0d338332011-02-12 11:57:43 +00001184 }
Andy Green90c7cbc2011-01-27 06:26:52 +00001185
1186 return 0;
1187}
1188
Andy Greenbe93fef2011-02-14 20:25:43 +00001189/**
1190 * libwebsocket_set_timeout() - marks the wsi as subject to a timeout
1191 *
1192 * You will not need this unless you are doing something special
1193 *
1194 * @wsi: Websocket connection instance
1195 * @reason: timeout reason
1196 * @secs: how many seconds
1197 */
1198
1199void
1200libwebsocket_set_timeout(struct libwebsocket *wsi,
1201 enum pending_timeout reason, int secs)
1202{
1203 struct timeval tv;
1204
1205 gettimeofday(&tv, NULL);
1206
1207 wsi->pending_timeout_limit = tv.tv_sec + secs;
1208 wsi->pending_timeout = reason;
1209}
1210
Andy Greena6cbece2011-01-27 20:06:03 +00001211
1212/**
1213 * libwebsocket_get_socket_fd() - returns the socket file descriptor
1214 *
1215 * You will not need this unless you are doing something special
1216 *
1217 * @wsi: Websocket connection instance
1218 */
1219
1220int
1221libwebsocket_get_socket_fd(struct libwebsocket *wsi)
1222{
1223 return wsi->sock;
1224}
1225
Andy Greend636e352013-01-29 12:36:17 +08001226#ifdef LWS_LATENCY
1227void
1228lws_latency(struct libwebsocket_context *context, struct libwebsocket *wsi, const char *action, int ret, int completed)
1229{
1230 struct timeval tv;
1231 unsigned long u;
1232 char buf[256];
1233
1234 gettimeofday(&tv, NULL);
1235
1236 u = (tv.tv_sec * 1000000) + tv.tv_usec;
1237
1238 if (action) {
1239 if (completed) {
1240 if (wsi->action_start == wsi->latency_start)
1241 sprintf(buf, "Completion first try lat %luus: %p: ret %d: %s\n", u - wsi->latency_start, (void *)wsi, ret, action);
1242 else
1243 sprintf(buf, "Completion %luus: lat %luus: %p: ret %d: %s\n", u - wsi->action_start, u - wsi->latency_start, (void *)wsi, ret, action);
1244 wsi->action_start = 0;
1245 } else
1246 sprintf(buf, "lat %luus: %p: ret %d: %s\n", u - wsi->latency_start, (void *)wsi, ret, action);
1247 if (u - wsi->latency_start > context->worst_latency) {
1248 context->worst_latency = u - wsi->latency_start;
1249 strcpy(context->worst_latency_info, buf);
1250 }
1251 lwsl_latency("%s", buf);
1252 } else {
1253 wsi->latency_start = u;
1254 if (!wsi->action_start)
1255 wsi->action_start = u;
1256 }
1257}
1258#endif
1259
Andy Greena1ce6be2013-01-18 11:43:21 +08001260#ifdef LWS_NO_SERVER
1261int
1262_libwebsocket_rx_flow_control(struct libwebsocket *wsi)
1263{
1264 return 0;
1265}
1266#else
Andy Green706961d2013-01-17 16:50:35 +08001267int
1268_libwebsocket_rx_flow_control(struct libwebsocket *wsi)
1269{
1270 struct libwebsocket_context *context = wsi->protocol->owning_server;
1271 int n;
1272
Andy Green623a98d2013-01-21 11:04:23 +08001273 if (!(wsi->u.ws.rxflow_change_to & 2))
Andy Green706961d2013-01-17 16:50:35 +08001274 return 0;
1275
Andy Green623a98d2013-01-21 11:04:23 +08001276 wsi->u.ws.rxflow_change_to &= ~2;
Andy Green706961d2013-01-17 16:50:35 +08001277
Andy Green623a98d2013-01-21 11:04:23 +08001278 lwsl_info("rxflow: wsi %p change_to %d\n", wsi, wsi->u.ws.rxflow_change_to);
Andy Green706961d2013-01-17 16:50:35 +08001279
1280 /* if we're letting it come again, did we interrupt anything? */
Andy Green623a98d2013-01-21 11:04:23 +08001281 if ((wsi->u.ws.rxflow_change_to & 1) && wsi->u.ws.rxflow_buffer) {
Andy Green706961d2013-01-17 16:50:35 +08001282 n = libwebsocket_interpret_incoming_packet(wsi, NULL, 0);
1283 if (n < 0) {
1284 libwebsocket_close_and_free_session(context, wsi, LWS_CLOSE_STATUS_NOSTATUS);
1285 return -1;
1286 }
1287 if (n)
1288 /* oh he stuck again, do nothing */
1289 return 0;
1290 }
1291
Andy Green623a98d2013-01-21 11:04:23 +08001292 if (wsi->u.ws.rxflow_change_to & 1)
Andy Green706961d2013-01-17 16:50:35 +08001293 context->fds[wsi->position_in_fds_table].events |= POLLIN;
1294 else
1295 context->fds[wsi->position_in_fds_table].events &= ~POLLIN;
1296
Andy Green623a98d2013-01-21 11:04:23 +08001297 if (wsi->u.ws.rxflow_change_to & 1)
Andy Green706961d2013-01-17 16:50:35 +08001298 /* external POLL support via protocol 0 */
1299 context->protocols[0].callback(context, wsi,
1300 LWS_CALLBACK_SET_MODE_POLL_FD,
1301 (void *)(long)wsi->sock, NULL, POLLIN);
1302 else
1303 /* external POLL support via protocol 0 */
1304 context->protocols[0].callback(context, wsi,
1305 LWS_CALLBACK_CLEAR_MODE_POLL_FD,
1306 (void *)(long)wsi->sock, NULL, POLLIN);
1307
1308 return 1;
1309}
Andy Greena1ce6be2013-01-18 11:43:21 +08001310#endif
Andy Green706961d2013-01-17 16:50:35 +08001311
Andy Green90c7cbc2011-01-27 06:26:52 +00001312/**
1313 * libwebsocket_rx_flow_control() - Enable and disable socket servicing for
1314 * receieved packets.
1315 *
1316 * If the output side of a server process becomes choked, this allows flow
1317 * control for the input side.
1318 *
1319 * @wsi: Websocket connection instance to get callback for
1320 * @enable: 0 = disable read servicing for this connection, 1 = enable
1321 */
1322
1323int
1324libwebsocket_rx_flow_control(struct libwebsocket *wsi, int enable)
1325{
Andy Green623a98d2013-01-21 11:04:23 +08001326 wsi->u.ws.rxflow_change_to = 2 | !!enable;
Andy Green90c7cbc2011-01-27 06:26:52 +00001327
Andy Green706961d2013-01-17 16:50:35 +08001328 return 0;
Andy Green90c7cbc2011-01-27 06:26:52 +00001329}
1330
Andy Green706961d2013-01-17 16:50:35 +08001331
Andy Green2ac5a6f2011-01-28 10:00:18 +00001332/**
1333 * libwebsocket_canonical_hostname() - returns this host's hostname
1334 *
1335 * This is typically used by client code to fill in the host parameter
1336 * when making a client connection. You can only call it after the context
1337 * has been created.
1338 *
Peter Hinz56885f32011-03-02 22:03:47 +00001339 * @context: Websocket context
Andy Green2ac5a6f2011-01-28 10:00:18 +00001340 */
1341
1342
1343extern const char *
Peter Hinz56885f32011-03-02 22:03:47 +00001344libwebsocket_canonical_hostname(struct libwebsocket_context *context)
Andy Green2ac5a6f2011-01-28 10:00:18 +00001345{
Peter Hinz56885f32011-03-02 22:03:47 +00001346 return (const char *)context->canonical_hostname;
Andy Green2ac5a6f2011-01-28 10:00:18 +00001347}
1348
1349
Andy Green90c7cbc2011-01-27 06:26:52 +00001350static void sigpipe_handler(int x)
1351{
1352}
1353
Andy Green6901cb32011-02-21 08:06:47 +00001354#ifdef LWS_OPENSSL_SUPPORT
1355static int
1356OpenSSL_verify_callback(int preverify_ok, X509_STORE_CTX *x509_ctx)
1357{
1358
1359 SSL *ssl;
1360 int n;
Andy Green2e24da02011-03-05 16:12:04 +00001361 struct libwebsocket_context *context;
Andy Green6901cb32011-02-21 08:06:47 +00001362
1363 ssl = X509_STORE_CTX_get_ex_data(x509_ctx,
1364 SSL_get_ex_data_X509_STORE_CTX_idx());
1365
1366 /*
Andy Green2e24da02011-03-05 16:12:04 +00001367 * !!! nasty openssl requires the index to come as a library-scope
1368 * static
Andy Green6901cb32011-02-21 08:06:47 +00001369 */
Andy Green2e24da02011-03-05 16:12:04 +00001370 context = SSL_get_ex_data(ssl, openssl_websocket_private_data_index);
Andy Green6ee372f2012-04-09 15:09:01 +08001371
Peter Hinz56885f32011-03-02 22:03:47 +00001372 n = context->protocols[0].callback(NULL, NULL,
Andy Green6901cb32011-02-21 08:06:47 +00001373 LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION,
1374 x509_ctx, ssl, preverify_ok);
1375
1376 /* convert return code from 0 = OK to 1 = OK */
1377
1378 if (!n)
1379 n = 1;
1380 else
1381 n = 0;
1382
1383 return n;
1384}
1385#endif
1386
Andy Green706961d2013-01-17 16:50:35 +08001387int user_callback_handle_rxflow(callback_function callback_function,
1388 struct libwebsocket_context * context,
1389 struct libwebsocket *wsi,
1390 enum libwebsocket_callback_reasons reason, void *user,
1391 void *in, size_t len)
1392{
1393 int n;
1394
1395 n = callback_function(context, wsi, reason, user, in, len);
1396 if (n < 0)
1397 return n;
1398
1399 _libwebsocket_rx_flow_control(wsi);
1400
1401 return 0;
1402}
1403
Andy Greenb45993c2010-12-18 15:13:50 +00001404
Andy Greenab990e42010-10-31 12:42:52 +00001405/**
Andy Green4739e5c2011-01-22 12:51:57 +00001406 * libwebsocket_create_context() - Create the websocket handler
1407 * @port: Port to listen on... you can use 0 to suppress listening on
Andy Green6964bb52011-01-23 16:50:33 +00001408 * any port, that's what you want if you are not running a
1409 * websocket server at all but just using it as a client
Peter Hinz56885f32011-03-02 22:03:47 +00001410 * @interf: NULL to bind the listen socket to all interfaces, or the
Andy Green32375b72011-02-19 08:32:53 +00001411 * interface name, eg, "eth2"
Andy Green4f3943a2010-11-12 10:44:16 +00001412 * @protocols: Array of structures listing supported protocols and a protocol-
Andy Green8f037e42010-12-19 22:13:26 +00001413 * specific callback for each one. The list is ended with an
1414 * entry that has a NULL callback pointer.
Andy Green6964bb52011-01-23 16:50:33 +00001415 * It's not const because we write the owning_server member
Andy Greenc5114822011-03-06 10:29:35 +00001416 * @extensions: NULL or array of libwebsocket_extension structs listing the
Andy Green3182ece2013-01-20 17:08:31 +08001417 * extensions this context supports. If you configured with
1418 * --without-extensions, you should give NULL here.
Andy Green3faa9c72010-11-08 17:03:03 +00001419 * @ssl_cert_filepath: If libwebsockets was compiled to use ssl, and you want
Andy Green8f037e42010-12-19 22:13:26 +00001420 * to listen using SSL, set to the filepath to fetch the
1421 * server cert from, otherwise NULL for unencrypted
Andy Green3faa9c72010-11-08 17:03:03 +00001422 * @ssl_private_key_filepath: filepath to private key if wanting SSL mode,
Andy Green8f037e42010-12-19 22:13:26 +00001423 * else ignored
David Galeano2f82be82013-01-09 16:25:54 +08001424 * @ssl_ca_filepath: CA certificate filepath or NULL
Andy Green3faa9c72010-11-08 17:03:03 +00001425 * @gid: group id to change to after setting listen socket, or -1.
1426 * @uid: user id to change to after setting listen socket, or -1.
Andy Greenbfb051f2011-02-09 08:49:14 +00001427 * @options: 0, or LWS_SERVER_OPTION_DEFEAT_CLIENT_MASK
Andy Green15e31f32012-10-19 18:36:28 +08001428 * @user: optional user pointer that can be recovered via the context
1429 * pointer using libwebsocket_context_user
Andy Green05464c62010-11-12 10:44:18 +00001430 *
Andy Green8f037e42010-12-19 22:13:26 +00001431 * This function creates the listening socket and takes care
1432 * of all initialization in one step.
1433 *
Andy Greene92cd172011-01-19 13:11:55 +00001434 * After initialization, it returns a struct libwebsocket_context * that
1435 * represents this server. After calling, user code needs to take care
1436 * of calling libwebsocket_service() with the context pointer to get the
1437 * server's sockets serviced. This can be done in the same process context
1438 * or a forked process, or another thread,
Andy Green05464c62010-11-12 10:44:18 +00001439 *
Andy Green8f037e42010-12-19 22:13:26 +00001440 * The protocol callback functions are called for a handful of events
1441 * including http requests coming in, websocket connections becoming
1442 * established, and data arriving; it's also called periodically to allow
1443 * async transmission.
1444 *
1445 * HTTP requests are sent always to the FIRST protocol in @protocol, since
1446 * at that time websocket protocol has not been negotiated. Other
1447 * protocols after the first one never see any HTTP callack activity.
1448 *
1449 * The server created is a simple http server by default; part of the
1450 * websocket standard is upgrading this http connection to a websocket one.
1451 *
1452 * This allows the same server to provide files like scripts and favicon /
1453 * images or whatever over http and dynamic data over websockets all in
1454 * one place; they're all handled in the user callback.
Andy Greenab990e42010-10-31 12:42:52 +00001455 */
Andy Green4ea60062010-10-30 12:15:07 +01001456
Andy Greene92cd172011-01-19 13:11:55 +00001457struct libwebsocket_context *
Peter Hinz56885f32011-03-02 22:03:47 +00001458libwebsocket_create_context(int port, const char *interf,
Andy Greenb45993c2010-12-18 15:13:50 +00001459 struct libwebsocket_protocols *protocols,
Andy Greend6e09112011-03-05 16:12:15 +00001460 struct libwebsocket_extension *extensions,
Andy Green8f037e42010-12-19 22:13:26 +00001461 const char *ssl_cert_filepath,
1462 const char *ssl_private_key_filepath,
David Galeano2f82be82013-01-09 16:25:54 +08001463 const char *ssl_ca_filepath,
Alon Levy0291eb32012-10-19 11:21:56 +02001464 int gid, int uid, unsigned int options,
David Galeano2f82be82013-01-09 16:25:54 +08001465 void *user)
Andy Greenff95d7a2010-10-28 22:36:01 +01001466{
1467 int n;
Andy Greenf5bc1302013-01-21 09:09:52 +08001468 struct sockaddr_in serv_addr;
Andy Green251f6fa2010-11-03 11:13:06 +00001469 int opt = 1;
Peter Hinz56885f32011-03-02 22:03:47 +00001470 struct libwebsocket_context *context = NULL;
Andy Green9659f372011-01-27 22:01:43 +00001471 char *p;
Andy Green0d338332011-02-12 11:57:43 +00001472 struct libwebsocket *wsi;
Andy Green3182ece2013-01-20 17:08:31 +08001473#ifndef LWS_NO_EXTENSIONS
1474 int m;
1475#endif
Andy Greenff95d7a2010-10-28 22:36:01 +01001476
Andy Green3faa9c72010-11-08 17:03:03 +00001477#ifdef LWS_OPENSSL_SUPPORT
Andy Greenf2f54d52010-11-15 22:08:00 +00001478 SSL_METHOD *method;
Andy Green3faa9c72010-11-08 17:03:03 +00001479 char ssl_err_buf[512];
Andy Green3faa9c72010-11-08 17:03:03 +00001480#endif
1481
Andy Greenb3a614a2013-01-19 13:08:17 +08001482 lwsl_notice("Initial logging level %d\n", log_level);
Andy Greenc0d6b632013-01-12 23:42:17 +08001483 lwsl_info(" LWS_MAX_HEADER_NAME_LENGTH: %u\n", LWS_MAX_HEADER_NAME_LENGTH);
1484 lwsl_info(" LWS_MAX_HEADER_LEN: %u\n", LWS_MAX_HEADER_LEN);
1485 lwsl_info(" LWS_INITIAL_HDR_ALLOC: %u\n", LWS_INITIAL_HDR_ALLOC);
1486 lwsl_info(" LWS_ADDITIONAL_HDR_ALLOC: %u\n", LWS_ADDITIONAL_HDR_ALLOC);
1487 lwsl_info(" MAX_USER_RX_BUFFER: %u\n", MAX_USER_RX_BUFFER);
Andy Greenc0d6b632013-01-12 23:42:17 +08001488 lwsl_info(" LWS_MAX_PROTOCOLS: %u\n", LWS_MAX_PROTOCOLS);
Andy Green3182ece2013-01-20 17:08:31 +08001489#ifndef LWS_NO_EXTENSIONS
Andy Greenc0d6b632013-01-12 23:42:17 +08001490 lwsl_info(" LWS_MAX_EXTENSIONS_ACTIVE: %u\n", LWS_MAX_EXTENSIONS_ACTIVE);
Andy Green3182ece2013-01-20 17:08:31 +08001491#else
1492 lwsl_notice(" Configured without extension support\n");
1493#endif
Andy Greenc0d6b632013-01-12 23:42:17 +08001494 lwsl_info(" SPEC_LATEST_SUPPORTED: %u\n", SPEC_LATEST_SUPPORTED);
1495 lwsl_info(" AWAITING_TIMEOUT: %u\n", AWAITING_TIMEOUT);
1496 lwsl_info(" CIPHERS_LIST_STRING: '%s'\n", CIPHERS_LIST_STRING);
1497 lwsl_info(" SYSTEM_RANDOM_FILEPATH: '%s'\n", SYSTEM_RANDOM_FILEPATH);
1498 lwsl_info(" LWS_MAX_ZLIB_CONN_BUFFER: %u\n", LWS_MAX_ZLIB_CONN_BUFFER);
Andy Green43db0452013-01-10 19:50:35 +08001499
Peter Hinz56885f32011-03-02 22:03:47 +00001500#ifdef _WIN32
1501 {
1502 WORD wVersionRequested;
1503 WSADATA wsaData;
1504 int err;
Andy Green6ee372f2012-04-09 15:09:01 +08001505 HMODULE wsdll;
Peter Hinz56885f32011-03-02 22:03:47 +00001506
1507 /* Use the MAKEWORD(lowbyte, highbyte) macro from Windef.h */
1508 wVersionRequested = MAKEWORD(2, 2);
1509
1510 err = WSAStartup(wVersionRequested, &wsaData);
1511 if (err != 0) {
1512 /* Tell the user that we could not find a usable */
1513 /* Winsock DLL. */
Andy Green43db0452013-01-10 19:50:35 +08001514 lwsl_err("WSAStartup failed with error: %d\n", err);
Peter Hinz56885f32011-03-02 22:03:47 +00001515 return NULL;
1516 }
David Galeano7b11fec2011-10-04 19:55:18 +08001517
Andy Green6ee372f2012-04-09 15:09:01 +08001518 /* default to a poll() made out of select() */
1519 poll = emulated_poll;
David Galeano7b11fec2011-10-04 19:55:18 +08001520
Andy Green6ee372f2012-04-09 15:09:01 +08001521 /* if windows socket lib available, use his WSAPoll */
David Galeanocb193682013-01-09 15:29:00 +08001522 wsdll = GetModuleHandle(_T("Ws2_32.dll"));
Andy Green6ee372f2012-04-09 15:09:01 +08001523 if (wsdll)
1524 poll = (PFNWSAPOLL)GetProcAddress(wsdll, "WSAPoll");
Peter Hinz56885f32011-03-02 22:03:47 +00001525 }
1526#endif
1527
Aaron Zinman4550f1d2013-01-10 12:35:18 +08001528 context = (struct libwebsocket_context *) malloc(sizeof(struct libwebsocket_context));
Peter Hinz56885f32011-03-02 22:03:47 +00001529 if (!context) {
Andy Green43db0452013-01-10 19:50:35 +08001530 lwsl_err("No memory for websocket context\n");
Andy Green90c7cbc2011-01-27 06:26:52 +00001531 return NULL;
1532 }
Andy Green35f332b2013-01-21 13:06:38 +08001533#ifndef LWS_NO_DAEMONIZE
Andy Green24cba922013-01-19 13:56:10 +08001534 extern int pid_daemon;
1535 context->started_with_parent = pid_daemon;
1536 lwsl_notice(" Started with daemon pid %d\n", pid_daemon);
1537#endif
1538
Peter Hinz56885f32011-03-02 22:03:47 +00001539 context->protocols = protocols;
1540 context->listen_port = port;
1541 context->http_proxy_port = 0;
1542 context->http_proxy_address[0] = '\0';
1543 context->options = options;
Andy Greendfb23042013-01-17 12:26:48 +08001544 /* to reduce this allocation, */
1545 context->max_fds = getdtablesize();
Andy Greenb3a614a2013-01-19 13:08:17 +08001546 lwsl_notice(" max fd tracked: %u\n", context->max_fds);
Andy Greena17c6922013-01-20 20:21:54 +08001547 lwsl_notice(" static allocation: %u bytes\n",
1548 (sizeof(struct pollfd) * context->max_fds) +
1549 (sizeof(struct libwebsocket *) * context->max_fds));
Andy Greendfb23042013-01-17 12:26:48 +08001550
1551 context->fds = (struct pollfd *)malloc(sizeof(struct pollfd) * context->max_fds);
1552 if (context->fds == NULL) {
1553 lwsl_err("Unable to allocate fds array for %d connections\n", context->max_fds);
1554 free(context);
1555 return NULL;
1556 }
Edwin van den Oetelaarf6eeabc2013-01-19 20:01:01 +08001557 context->lws_lookup = (struct libwebsocket **)malloc(sizeof(struct libwebsocket *) * context->max_fds);
Andy Greendfb23042013-01-17 12:26:48 +08001558 if (context->lws_lookup == NULL) {
1559 lwsl_err("Unable to allocate lws_lookup array for %d connections\n", context->max_fds);
1560 free(context->fds);
1561 free(context);
1562 return NULL;
1563 }
Andy Greena17c6922013-01-20 20:21:54 +08001564
Peter Hinz56885f32011-03-02 22:03:47 +00001565 context->fds_count = 0;
Andy Green3182ece2013-01-20 17:08:31 +08001566#ifndef LWS_NO_EXTENSIONS
Andy Greend6e09112011-03-05 16:12:15 +00001567 context->extensions = extensions;
Andy Green3182ece2013-01-20 17:08:31 +08001568#endif
Paulo Roberto Urio1e326632012-06-04 10:52:19 +08001569 context->last_timeout_check_s = 0;
Andy Greendfb23042013-01-17 12:26:48 +08001570 context->user_space = user;
Andy Green9659f372011-01-27 22:01:43 +00001571
Peter Hinz56885f32011-03-02 22:03:47 +00001572#ifdef WIN32
1573 context->fd_random = 0;
1574#else
1575 context->fd_random = open(SYSTEM_RANDOM_FILEPATH, O_RDONLY);
1576 if (context->fd_random < 0) {
Andy Greendfb23042013-01-17 12:26:48 +08001577 free(context);
Andy Green43db0452013-01-10 19:50:35 +08001578 lwsl_err("Unable to open random device %s %d\n",
Peter Hinz56885f32011-03-02 22:03:47 +00001579 SYSTEM_RANDOM_FILEPATH, context->fd_random);
Andy Green44eee682011-02-10 09:32:24 +00001580 return NULL;
1581 }
Peter Hinz56885f32011-03-02 22:03:47 +00001582#endif
Andy Green44eee682011-02-10 09:32:24 +00001583
Peter Hinz56885f32011-03-02 22:03:47 +00001584#ifdef LWS_OPENSSL_SUPPORT
1585 context->use_ssl = 0;
1586 context->ssl_ctx = NULL;
1587 context->ssl_client_ctx = NULL;
Andy Green2e24da02011-03-05 16:12:04 +00001588 openssl_websocket_private_data_index = 0;
Peter Hinz56885f32011-03-02 22:03:47 +00001589#endif
Andy Green2ac5a6f2011-01-28 10:00:18 +00001590
Andy Greena1ce6be2013-01-18 11:43:21 +08001591 strcpy(context->canonical_hostname, "unknown");
Andy Greena69f0512012-05-03 12:32:38 +08001592
Andy Greena1ce6be2013-01-18 11:43:21 +08001593#ifndef LWS_NO_SERVER
1594 if (!(options & LWS_SERVER_OPTION_SKIP_SERVER_CANONICAL_NAME)) {
1595 struct sockaddr sa;
1596 char hostname[1024] = "";
Andy Green788c4a82012-10-22 12:29:57 +01001597
1598 /* find canonical hostname */
1599
1600 hostname[(sizeof hostname) - 1] = '\0';
1601 memset(&sa, 0, sizeof(sa));
1602 sa.sa_family = AF_INET;
1603 sa.sa_data[(sizeof sa.sa_data) - 1] = '\0';
1604 gethostname(hostname, (sizeof hostname) - 1);
1605
1606 n = 0;
1607
David Galeanoed3c8402013-01-10 10:45:24 +08001608 if (strlen(hostname) < sizeof(sa.sa_data) - 1) {
Andy Green788c4a82012-10-22 12:29:57 +01001609 strcpy(sa.sa_data, hostname);
Andy Green43db0452013-01-10 19:50:35 +08001610 // lwsl_debug("my host name is %s\n", sa.sa_data);
Andy Green788c4a82012-10-22 12:29:57 +01001611 n = getnameinfo(&sa, sizeof(sa), hostname,
1612 (sizeof hostname) - 1, NULL, 0, 0);
1613 }
1614
1615 if (!n) {
1616 strncpy(context->canonical_hostname, hostname,
1617 sizeof context->canonical_hostname - 1);
1618 context->canonical_hostname[
1619 sizeof context->canonical_hostname - 1] = '\0';
1620 } else
1621 strncpy(context->canonical_hostname, hostname,
1622 sizeof context->canonical_hostname - 1);
1623
Andy Greenb3a614a2013-01-19 13:08:17 +08001624 lwsl_notice(" canonical_hostname = %s\n", context->canonical_hostname);
Andy Greena69f0512012-05-03 12:32:38 +08001625 }
Andy Greena1ce6be2013-01-18 11:43:21 +08001626#endif
Andy Greena69f0512012-05-03 12:32:38 +08001627
Andy Green9659f372011-01-27 22:01:43 +00001628 /* split the proxy ads:port if given */
1629
1630 p = getenv("http_proxy");
1631 if (p) {
Peter Hinz56885f32011-03-02 22:03:47 +00001632 strncpy(context->http_proxy_address, p,
Andy Green6ee372f2012-04-09 15:09:01 +08001633 sizeof context->http_proxy_address - 1);
Peter Hinz56885f32011-03-02 22:03:47 +00001634 context->http_proxy_address[
1635 sizeof context->http_proxy_address - 1] = '\0';
Andy Green9659f372011-01-27 22:01:43 +00001636
Peter Hinz56885f32011-03-02 22:03:47 +00001637 p = strchr(context->http_proxy_address, ':');
Andy Green9659f372011-01-27 22:01:43 +00001638 if (p == NULL) {
Andy Green43db0452013-01-10 19:50:35 +08001639 lwsl_err("http_proxy needs to be ads:port\n");
Andy Green9659f372011-01-27 22:01:43 +00001640 return NULL;
1641 }
1642 *p = '\0';
Peter Hinz56885f32011-03-02 22:03:47 +00001643 context->http_proxy_port = atoi(p + 1);
Andy Green9659f372011-01-27 22:01:43 +00001644
Andy Greenb3a614a2013-01-19 13:08:17 +08001645 lwsl_notice(" Proxy %s:%u\n",
Peter Hinz56885f32011-03-02 22:03:47 +00001646 context->http_proxy_address,
1647 context->http_proxy_port);
Andy Green9659f372011-01-27 22:01:43 +00001648 }
Andy Green90c7cbc2011-01-27 06:26:52 +00001649
Andy Greena1ce6be2013-01-18 11:43:21 +08001650#ifndef LWS_NO_SERVER
Andy Green90c7cbc2011-01-27 06:26:52 +00001651 if (port) {
1652
Andy Green3faa9c72010-11-08 17:03:03 +00001653#ifdef LWS_OPENSSL_SUPPORT
Peter Hinz56885f32011-03-02 22:03:47 +00001654 context->use_ssl = ssl_cert_filepath != NULL &&
Andy Green90c7cbc2011-01-27 06:26:52 +00001655 ssl_private_key_filepath != NULL;
Peter Hinz56885f32011-03-02 22:03:47 +00001656 if (context->use_ssl)
Andy Greenb3a614a2013-01-19 13:08:17 +08001657 lwsl_notice(" Compiled with SSL support, using it\n");
Andy Green90c7cbc2011-01-27 06:26:52 +00001658 else
Andy Greenb3a614a2013-01-19 13:08:17 +08001659 lwsl_notice(" Compiled with SSL support, not using it\n");
Andy Green3faa9c72010-11-08 17:03:03 +00001660
Andy Green90c7cbc2011-01-27 06:26:52 +00001661#else
1662 if (ssl_cert_filepath != NULL &&
1663 ssl_private_key_filepath != NULL) {
Andy Greenb3a614a2013-01-19 13:08:17 +08001664 lwsl_notice(" Not compiled for OpenSSl support!\n");
Andy Greene92cd172011-01-19 13:11:55 +00001665 return NULL;
Andy Green3faa9c72010-11-08 17:03:03 +00001666 }
Andy Greenb3a614a2013-01-19 13:08:17 +08001667 lwsl_notice(" Compiled without SSL support, "
Andy Green90c7cbc2011-01-27 06:26:52 +00001668 "serving unencrypted\n");
1669#endif
Andy Greena17c6922013-01-20 20:21:54 +08001670
1671 lwsl_notice(" per-connection allocation: %u + headers\n", sizeof(struct libwebsocket));
Andy Green90c7cbc2011-01-27 06:26:52 +00001672 }
Andy Greena1ce6be2013-01-18 11:43:21 +08001673#endif
Andy Green90c7cbc2011-01-27 06:26:52 +00001674
1675 /* ignore SIGPIPE */
Peter Hinz56885f32011-03-02 22:03:47 +00001676#ifdef WIN32
1677#else
Andy Green90c7cbc2011-01-27 06:26:52 +00001678 signal(SIGPIPE, sigpipe_handler);
Peter Hinz56885f32011-03-02 22:03:47 +00001679#endif
Andy Green90c7cbc2011-01-27 06:26:52 +00001680
1681
1682#ifdef LWS_OPENSSL_SUPPORT
1683
1684 /* basic openssl init */
1685
1686 SSL_library_init();
1687
1688 OpenSSL_add_all_algorithms();
1689 SSL_load_error_strings();
1690
Andy Green2e24da02011-03-05 16:12:04 +00001691 openssl_websocket_private_data_index =
Andy Green6901cb32011-02-21 08:06:47 +00001692 SSL_get_ex_new_index(0, "libwebsockets", NULL, NULL, NULL);
1693
Andy Green90c7cbc2011-01-27 06:26:52 +00001694 /*
1695 * Firefox insists on SSLv23 not SSLv3
1696 * Konq disables SSLv2 by default now, SSLv23 works
1697 */
1698
1699 method = (SSL_METHOD *)SSLv23_server_method();
1700 if (!method) {
Andy Green43db0452013-01-10 19:50:35 +08001701 lwsl_err("problem creating ssl method: %s\n",
Andy Green90c7cbc2011-01-27 06:26:52 +00001702 ERR_error_string(ERR_get_error(), ssl_err_buf));
1703 return NULL;
1704 }
Peter Hinz56885f32011-03-02 22:03:47 +00001705 context->ssl_ctx = SSL_CTX_new(method); /* create context */
1706 if (!context->ssl_ctx) {
Andy Green43db0452013-01-10 19:50:35 +08001707 lwsl_err("problem creating ssl context: %s\n",
Andy Green90c7cbc2011-01-27 06:26:52 +00001708 ERR_error_string(ERR_get_error(), ssl_err_buf));
1709 return NULL;
1710 }
1711
David Galeanocc148e42013-01-10 10:18:59 +08001712#ifdef SSL_OP_NO_COMPRESSION
David Galeanoc72f6f92013-01-10 10:11:57 +08001713 SSL_CTX_set_options(context->ssl_ctx, SSL_OP_NO_COMPRESSION);
David Galeanocc148e42013-01-10 10:18:59 +08001714#endif
David Galeano77a677c2013-01-10 10:14:12 +08001715 SSL_CTX_set_options(context->ssl_ctx, SSL_OP_CIPHER_SERVER_PREFERENCE);
David Galeanof177f2a2013-01-10 10:15:19 +08001716 SSL_CTX_set_cipher_list(context->ssl_ctx, CIPHERS_LIST_STRING);
David Galeanoc72f6f92013-01-10 10:11:57 +08001717
Andy Greena1ce6be2013-01-18 11:43:21 +08001718#ifndef LWS_NO_CLIENT
1719
Andy Green90c7cbc2011-01-27 06:26:52 +00001720 /* client context */
Andy Green6ee372f2012-04-09 15:09:01 +08001721
1722 if (port == CONTEXT_PORT_NO_LISTEN) {
Peter Hinz56885f32011-03-02 22:03:47 +00001723 method = (SSL_METHOD *)SSLv23_client_method();
1724 if (!method) {
Andy Green43db0452013-01-10 19:50:35 +08001725 lwsl_err("problem creating ssl method: %s\n",
Peter Hinz56885f32011-03-02 22:03:47 +00001726 ERR_error_string(ERR_get_error(), ssl_err_buf));
1727 return NULL;
1728 }
1729 /* create context */
1730 context->ssl_client_ctx = SSL_CTX_new(method);
1731 if (!context->ssl_client_ctx) {
Andy Green43db0452013-01-10 19:50:35 +08001732 lwsl_err("problem creating ssl context: %s\n",
Peter Hinz56885f32011-03-02 22:03:47 +00001733 ERR_error_string(ERR_get_error(), ssl_err_buf));
1734 return NULL;
1735 }
Andy Green90c7cbc2011-01-27 06:26:52 +00001736
David Galeanocc148e42013-01-10 10:18:59 +08001737#ifdef SSL_OP_NO_COMPRESSION
David Galeanoc72f6f92013-01-10 10:11:57 +08001738 SSL_CTX_set_options(context->ssl_client_ctx, SSL_OP_NO_COMPRESSION);
David Galeanocc148e42013-01-10 10:18:59 +08001739#endif
David Galeano77a677c2013-01-10 10:14:12 +08001740 SSL_CTX_set_options(context->ssl_client_ctx, SSL_OP_CIPHER_SERVER_PREFERENCE);
David Galeanof177f2a2013-01-10 10:15:19 +08001741 SSL_CTX_set_cipher_list(context->ssl_client_ctx, CIPHERS_LIST_STRING);
David Galeanoc72f6f92013-01-10 10:11:57 +08001742
Peter Hinz56885f32011-03-02 22:03:47 +00001743 /* openssl init for cert verification (for client sockets) */
David Galeano2f82be82013-01-09 16:25:54 +08001744 if (!ssl_ca_filepath) {
1745 if (!SSL_CTX_load_verify_locations(
1746 context->ssl_client_ctx, NULL,
1747 LWS_OPENSSL_CLIENT_CERTS))
Andy Green43db0452013-01-10 19:50:35 +08001748 lwsl_err(
David Galeano2f82be82013-01-09 16:25:54 +08001749 "Unable to load SSL Client certs from %s "
1750 "(set by --with-client-cert-dir= in configure) -- "
1751 " client ssl isn't going to work",
1752 LWS_OPENSSL_CLIENT_CERTS);
1753 } else
1754 if (!SSL_CTX_load_verify_locations(
1755 context->ssl_client_ctx, ssl_ca_filepath,
1756 NULL))
Andy Green43db0452013-01-10 19:50:35 +08001757 lwsl_err(
David Galeano2f82be82013-01-09 16:25:54 +08001758 "Unable to load SSL Client certs "
1759 "file from %s -- client ssl isn't "
1760 "going to work", ssl_ca_filepath);
Peter Hinz56885f32011-03-02 22:03:47 +00001761
1762 /*
1763 * callback allowing user code to load extra verification certs
1764 * helping the client to verify server identity
1765 */
1766
1767 context->protocols[0].callback(context, NULL,
1768 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_CLIENT_VERIFY_CERTS,
1769 context->ssl_client_ctx, NULL, 0);
Andy Green90c7cbc2011-01-27 06:26:52 +00001770 }
Andy Greena1ce6be2013-01-18 11:43:21 +08001771#endif
Andy Green6ee372f2012-04-09 15:09:01 +08001772
Andy Greenc6bf2c22011-02-20 11:10:47 +00001773 /* as a server, are we requiring clients to identify themselves? */
1774
1775 if (options & LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT) {
1776
1777 /* absolutely require the client cert */
Andy Green6ee372f2012-04-09 15:09:01 +08001778
Peter Hinz56885f32011-03-02 22:03:47 +00001779 SSL_CTX_set_verify(context->ssl_ctx,
Andy Green6901cb32011-02-21 08:06:47 +00001780 SSL_VERIFY_PEER | SSL_VERIFY_FAIL_IF_NO_PEER_CERT,
1781 OpenSSL_verify_callback);
Andy Greenc6bf2c22011-02-20 11:10:47 +00001782
1783 /*
1784 * give user code a chance to load certs into the server
1785 * allowing it to verify incoming client certs
1786 */
1787
Peter Hinz56885f32011-03-02 22:03:47 +00001788 context->protocols[0].callback(context, NULL,
Andy Greenc6bf2c22011-02-20 11:10:47 +00001789 LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS,
Peter Hinz56885f32011-03-02 22:03:47 +00001790 context->ssl_ctx, NULL, 0);
Andy Greenc6bf2c22011-02-20 11:10:47 +00001791 }
1792
Peter Hinz56885f32011-03-02 22:03:47 +00001793 if (context->use_ssl) {
Andy Green90c7cbc2011-01-27 06:26:52 +00001794
1795 /* openssl init for server sockets */
1796
Andy Green3faa9c72010-11-08 17:03:03 +00001797 /* set the local certificate from CertFile */
David Galeano9b3d4b22013-01-10 10:11:21 +08001798 n = SSL_CTX_use_certificate_chain_file(context->ssl_ctx,
1799 ssl_cert_filepath);
Andy Green3faa9c72010-11-08 17:03:03 +00001800 if (n != 1) {
Andy Green43db0452013-01-10 19:50:35 +08001801 lwsl_err("problem getting cert '%s': %s\n",
Andy Green3faa9c72010-11-08 17:03:03 +00001802 ssl_cert_filepath,
1803 ERR_error_string(ERR_get_error(), ssl_err_buf));
Andy Greene92cd172011-01-19 13:11:55 +00001804 return NULL;
Andy Green3faa9c72010-11-08 17:03:03 +00001805 }
1806 /* set the private key from KeyFile */
Peter Hinz56885f32011-03-02 22:03:47 +00001807 if (SSL_CTX_use_PrivateKey_file(context->ssl_ctx,
1808 ssl_private_key_filepath, SSL_FILETYPE_PEM) != 1) {
Andy Green43db0452013-01-10 19:50:35 +08001809 lwsl_err("ssl problem getting key '%s': %s\n",
Andy Green018d8eb2010-11-08 21:04:23 +00001810 ssl_private_key_filepath,
1811 ERR_error_string(ERR_get_error(), ssl_err_buf));
Andy Greene92cd172011-01-19 13:11:55 +00001812 return NULL;
Andy Green3faa9c72010-11-08 17:03:03 +00001813 }
1814 /* verify private key */
Peter Hinz56885f32011-03-02 22:03:47 +00001815 if (!SSL_CTX_check_private_key(context->ssl_ctx)) {
Andy Green43db0452013-01-10 19:50:35 +08001816 lwsl_err("Private SSL key doesn't match cert\n");
Andy Greene92cd172011-01-19 13:11:55 +00001817 return NULL;
Andy Green3faa9c72010-11-08 17:03:03 +00001818 }
1819
1820 /* SSL is happy and has a cert it's content with */
1821 }
1822#endif
Andy Greenb45993c2010-12-18 15:13:50 +00001823
Andy Greendf736162011-01-18 15:39:02 +00001824 /* selftest */
1825
1826 if (lws_b64_selftest())
Andy Greene92cd172011-01-19 13:11:55 +00001827 return NULL;
Andy Greendf736162011-01-18 15:39:02 +00001828
Andy Greena1ce6be2013-01-18 11:43:21 +08001829#ifndef LWS_NO_SERVER
Andy Greenb45993c2010-12-18 15:13:50 +00001830 /* set up our external listening socket we serve on */
Andy Green8f037e42010-12-19 22:13:26 +00001831
Andy Green4739e5c2011-01-22 12:51:57 +00001832 if (port) {
Andy Greena1ce6be2013-01-18 11:43:21 +08001833 extern int interface_to_sa(const char *ifname, struct sockaddr_in *addr, size_t addrlen);
1834 int sockfd;
Andy Green8f037e42010-12-19 22:13:26 +00001835
Andy Green4739e5c2011-01-22 12:51:57 +00001836 sockfd = socket(AF_INET, SOCK_STREAM, 0);
1837 if (sockfd < 0) {
Andy Greenf7609e92013-01-14 13:10:55 +08001838 lwsl_err("ERROR opening socket\n");
Andy Green4739e5c2011-01-22 12:51:57 +00001839 return NULL;
1840 }
Andy Green775c0dd2010-10-29 14:15:22 +01001841
Andy Green4739e5c2011-01-22 12:51:57 +00001842 /* allow us to restart even if old sockets in TIME_WAIT */
Andy Green6ee372f2012-04-09 15:09:01 +08001843 setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR,
1844 (const void *)&opt, sizeof(opt));
Andy Green6c939552011-03-08 08:56:57 +00001845
1846 /* Disable Nagle */
1847 opt = 1;
Andy Green6ee372f2012-04-09 15:09:01 +08001848 setsockopt(sockfd, IPPROTO_TCP, TCP_NODELAY,
1849 (const void *)&opt, sizeof(opt));
Andy Green6c939552011-03-08 08:56:57 +00001850
Andy Greene2160712013-01-28 12:19:10 +08001851 fcntl(sockfd, F_SETFL, O_NONBLOCK);
1852
Andy Green4739e5c2011-01-22 12:51:57 +00001853 bzero((char *) &serv_addr, sizeof(serv_addr));
1854 serv_addr.sin_family = AF_INET;
Peter Hinz56885f32011-03-02 22:03:47 +00001855 if (interf == NULL)
Andy Green32375b72011-02-19 08:32:53 +00001856 serv_addr.sin_addr.s_addr = INADDR_ANY;
1857 else
Peter Hinz56885f32011-03-02 22:03:47 +00001858 interface_to_sa(interf, &serv_addr,
Andy Green32375b72011-02-19 08:32:53 +00001859 sizeof(serv_addr));
Andy Green4739e5c2011-01-22 12:51:57 +00001860 serv_addr.sin_port = htons(port);
1861
1862 n = bind(sockfd, (struct sockaddr *) &serv_addr,
1863 sizeof(serv_addr));
1864 if (n < 0) {
Andy Green43db0452013-01-10 19:50:35 +08001865 lwsl_err("ERROR on binding to port %d (%d %d)\n",
Andy Green8f037e42010-12-19 22:13:26 +00001866 port, n, errno);
Andy Green41c58032013-01-12 13:21:08 +08001867 close(sockfd);
Andy Green4739e5c2011-01-22 12:51:57 +00001868 return NULL;
1869 }
Andy Green0d338332011-02-12 11:57:43 +00001870
Aaron Zinman4550f1d2013-01-10 12:35:18 +08001871 wsi = (struct libwebsocket *)malloc(sizeof(struct libwebsocket));
Andy Green41c58032013-01-12 13:21:08 +08001872 if (wsi == NULL) {
1873 lwsl_err("Out of mem\n");
1874 close(sockfd);
1875 return NULL;
1876 }
Aaron Zinman4550f1d2013-01-10 12:35:18 +08001877 memset(wsi, 0, sizeof (struct libwebsocket));
Andy Green0d338332011-02-12 11:57:43 +00001878 wsi->sock = sockfd;
Andy Green3182ece2013-01-20 17:08:31 +08001879#ifndef LWS_NO_EXTENSIONS
Andy Greend6e09112011-03-05 16:12:15 +00001880 wsi->count_active_extensions = 0;
Andy Green3182ece2013-01-20 17:08:31 +08001881#endif
Andy Green0d338332011-02-12 11:57:43 +00001882 wsi->mode = LWS_CONNMODE_SERVER_LISTENER;
Andy Greendfb23042013-01-17 12:26:48 +08001883
1884 insert_wsi_socket_into_fds(context, wsi);
Andy Green0d338332011-02-12 11:57:43 +00001885
Andy Green65b0e912013-01-16 07:59:47 +08001886 context->listen_service_modulo = LWS_LISTEN_SERVICE_MODULO;
1887 context->listen_service_count = 0;
1888 context->listen_service_fd = sockfd;
1889
Andy Greena824d182013-01-15 20:52:29 +08001890 listen(sockfd, LWS_SOMAXCONN);
Andy Greenb3a614a2013-01-19 13:08:17 +08001891 lwsl_notice(" Listening on port %d\n", port);
Andy Green8f037e42010-12-19 22:13:26 +00001892 }
Andy Greena1ce6be2013-01-18 11:43:21 +08001893#endif
Andy Greenb45993c2010-12-18 15:13:50 +00001894
Andy Green6ee372f2012-04-09 15:09:01 +08001895 /*
1896 * drop any root privs for this process
1897 * to listen on port < 1023 we would have needed root, but now we are
1898 * listening, we don't want the power for anything else
1899 */
Peter Hinz56885f32011-03-02 22:03:47 +00001900#ifdef WIN32
1901#else
Andy Green3faa9c72010-11-08 17:03:03 +00001902 if (gid != -1)
1903 if (setgid(gid))
Andy Green43db0452013-01-10 19:50:35 +08001904 lwsl_warn("setgid: %s\n", strerror(errno));
Andy Green3faa9c72010-11-08 17:03:03 +00001905 if (uid != -1)
1906 if (setuid(uid))
Andy Green43db0452013-01-10 19:50:35 +08001907 lwsl_warn("setuid: %s\n", strerror(errno));
Peter Hinz56885f32011-03-02 22:03:47 +00001908#endif
Andy Greenb45993c2010-12-18 15:13:50 +00001909
Andy Green6f520a52013-01-29 17:57:39 +08001910 /* initialize supported protocols */
Andy Greenb45993c2010-12-18 15:13:50 +00001911
Peter Hinz56885f32011-03-02 22:03:47 +00001912 for (context->count_protocols = 0;
1913 protocols[context->count_protocols].callback;
1914 context->count_protocols++) {
Andy Green2d1301e2011-05-24 10:14:41 +01001915
Andy Green43db0452013-01-10 19:50:35 +08001916 lwsl_parser(" Protocol: %s\n",
1917 protocols[context->count_protocols].name);
Andy Green2d1301e2011-05-24 10:14:41 +01001918
Peter Hinz56885f32011-03-02 22:03:47 +00001919 protocols[context->count_protocols].owning_server = context;
1920 protocols[context->count_protocols].protocol_index =
1921 context->count_protocols;
Andy Greenb45993c2010-12-18 15:13:50 +00001922 }
Andy Greenf5bc1302013-01-21 09:09:52 +08001923
Andy Green3182ece2013-01-20 17:08:31 +08001924#ifndef LWS_NO_EXTENSIONS
Andy Greena41314f2011-05-23 10:00:03 +01001925 /*
1926 * give all extensions a chance to create any per-context
1927 * allocations they need
1928 */
1929
1930 m = LWS_EXT_CALLBACK_CLIENT_CONTEXT_CONSTRUCT;
1931 if (port)
1932 m = LWS_EXT_CALLBACK_SERVER_CONTEXT_CONSTRUCT;
Andrew Chambersd5512172012-05-20 08:17:09 +08001933
1934 if (extensions) {
1935 while (extensions->callback) {
Andy Green43db0452013-01-10 19:50:35 +08001936 lwsl_ext(" Extension: %s\n", extensions->name);
Aaron Zinman4550f1d2013-01-10 12:35:18 +08001937 extensions->callback(context, extensions, NULL,
1938 (enum libwebsocket_extension_callback_reasons)m,
1939 NULL, NULL, 0);
Andrew Chambersd5512172012-05-20 08:17:09 +08001940 extensions++;
1941 }
Andy Greena41314f2011-05-23 10:00:03 +01001942 }
Andy Green3182ece2013-01-20 17:08:31 +08001943#endif
Peter Hinz56885f32011-03-02 22:03:47 +00001944 return context;
Andy Greene92cd172011-01-19 13:11:55 +00001945}
Andy Greenb45993c2010-12-18 15:13:50 +00001946
Andy Greenb45993c2010-12-18 15:13:50 +00001947/**
1948 * libwebsockets_get_protocol() - Returns a protocol pointer from a websocket
Andy Green8f037e42010-12-19 22:13:26 +00001949 * connection.
Andy Greenb45993c2010-12-18 15:13:50 +00001950 * @wsi: pointer to struct websocket you want to know the protocol of
1951 *
Andy Green8f037e42010-12-19 22:13:26 +00001952 *
Andy Green6f520a52013-01-29 17:57:39 +08001953 * Some apis can act on all live connections of a given protocol,
1954 * this is how you can get a pointer to the active protocol if needed.
Andy Greenb45993c2010-12-18 15:13:50 +00001955 */
Andy Greenab990e42010-10-31 12:42:52 +00001956
Andy Greenb45993c2010-12-18 15:13:50 +00001957const struct libwebsocket_protocols *
1958libwebsockets_get_protocol(struct libwebsocket *wsi)
1959{
1960 return wsi->protocol;
1961}
1962
Andy Green82c3d542011-03-07 21:16:31 +00001963int
1964libwebsocket_is_final_fragment(struct libwebsocket *wsi)
1965{
Andy Green623a98d2013-01-21 11:04:23 +08001966 return wsi->u.ws.final;
Andy Green82c3d542011-03-07 21:16:31 +00001967}
Alex Bligh49146db2011-11-07 17:19:25 +08001968
David Galeanoe2cf9922013-01-09 18:06:55 +08001969unsigned char
1970libwebsocket_get_reserved_bits(struct libwebsocket *wsi)
1971{
Andy Green623a98d2013-01-21 11:04:23 +08001972 return wsi->u.ws.rsv;
David Galeanoe2cf9922013-01-09 18:06:55 +08001973}
1974
Alex Bligh49146db2011-11-07 17:19:25 +08001975void *
1976libwebsocket_ensure_user_space(struct libwebsocket *wsi)
1977{
1978 /* allocate the per-connection user memory (if any) */
1979
1980 if (wsi->protocol->per_session_data_size && !wsi->user_space) {
1981 wsi->user_space = malloc(
1982 wsi->protocol->per_session_data_size);
1983 if (wsi->user_space == NULL) {
Andy Green43db0452013-01-10 19:50:35 +08001984 lwsl_err("Out of memory for conn user space\n");
Alex Bligh49146db2011-11-07 17:19:25 +08001985 return NULL;
1986 }
Andy Green6ee372f2012-04-09 15:09:01 +08001987 memset(wsi->user_space, 0,
1988 wsi->protocol->per_session_data_size);
Alex Bligh49146db2011-11-07 17:19:25 +08001989 }
1990 return wsi->user_space;
1991}
Andy Green43db0452013-01-10 19:50:35 +08001992
Andy Green0b319092013-01-19 11:17:56 +08001993static void lwsl_emit_stderr(int level, const char *line)
Andy Greende8f27a2013-01-12 09:17:42 +08001994{
Andy Green0b319092013-01-19 11:17:56 +08001995 char buf[300];
1996 struct timeval tv;
Andy Green0b319092013-01-19 11:17:56 +08001997 int n;
1998
1999 gettimeofday(&tv, NULL);
2000
2001 buf[0] = '\0';
2002 for (n = 0; n < LLL_COUNT; n++)
2003 if (level == (1 << n)) {
Andy Green058ba812013-01-19 11:32:18 +08002004 sprintf(buf, "[%ld:%04d] %s: ", tv.tv_sec,
Andy Green0b319092013-01-19 11:17:56 +08002005 (int)(tv.tv_usec / 100), log_level_names[n]);
2006 break;
2007 }
2008
2009 fprintf(stderr, "%s%s", buf, line);
Andy Greende8f27a2013-01-12 09:17:42 +08002010}
2011
Andy Greenc11db202013-01-19 11:12:16 +08002012void lwsl_emit_syslog(int level, const char *line)
2013{
2014 int syslog_level = LOG_DEBUG;
2015
2016 switch (level) {
2017 case LLL_ERR:
2018 syslog_level = LOG_ERR;
2019 break;
2020 case LLL_WARN:
2021 syslog_level = LOG_WARNING;
2022 break;
2023 case LLL_NOTICE:
2024 syslog_level = LOG_NOTICE;
2025 break;
2026 case LLL_INFO:
2027 syslog_level = LOG_INFO;
2028 break;
2029 }
Edwin van den Oetelaarf6eeabc2013-01-19 20:01:01 +08002030 syslog(syslog_level, "%s", line);
Andy Greenc11db202013-01-19 11:12:16 +08002031}
2032
Andy Green43db0452013-01-10 19:50:35 +08002033void _lws_log(int filter, const char *format, ...)
2034{
Andy Greende8f27a2013-01-12 09:17:42 +08002035 char buf[256];
Andy Green43db0452013-01-10 19:50:35 +08002036 va_list ap;
Andy Green43db0452013-01-10 19:50:35 +08002037
2038 if (!(log_level & filter))
2039 return;
2040
Andy Green43db0452013-01-10 19:50:35 +08002041 va_start(ap, format);
Andy Green0b319092013-01-19 11:17:56 +08002042 vsnprintf(buf, (sizeof buf), format, ap);
Andy Greende8f27a2013-01-12 09:17:42 +08002043 buf[(sizeof buf) - 1] = '\0';
2044 va_end(ap);
2045
Andy Green0b319092013-01-19 11:17:56 +08002046 lwsl_emit(filter, buf);
Andy Green43db0452013-01-10 19:50:35 +08002047}
2048
2049/**
2050 * lws_set_log_level() - Set the logging bitfield
2051 * @level: OR together the LLL_ debug contexts you want output from
Andy Greende8f27a2013-01-12 09:17:42 +08002052 * @log_emit_function: NULL to leave it as it is, or a user-supplied
2053 * function to perform log string emission instead of
2054 * the default stderr one.
Andy Green43db0452013-01-10 19:50:35 +08002055 *
Andy Greende8f27a2013-01-12 09:17:42 +08002056 * log level defaults to "err" and "warn" contexts enabled only and
2057 * emission on stderr.
Andy Green43db0452013-01-10 19:50:35 +08002058 */
2059
Andy Green058ba812013-01-19 11:32:18 +08002060void lws_set_log_level(int level, void (*log_emit_function)(int level, const char *line))
Andy Green43db0452013-01-10 19:50:35 +08002061{
2062 log_level = level;
Andy Greende8f27a2013-01-12 09:17:42 +08002063 if (log_emit_function)
2064 lwsl_emit = log_emit_function;
Andy Green43db0452013-01-10 19:50:35 +08002065}