2 * libwebsockets-test-server - libwebsockets test implementation
4 * Copyright (C) 2010-2015 Andy Green <andy@warmcat.com>
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.
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.
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,
21 #include "test-server.h"
24 * This demo server shows how to use libwebsockets for one or more
25 * websocket protocols in the same server
27 * It defines the following websocket protocols:
29 * dumb-increment-protocol: once the socket is opened, an incrementing
30 * ascii string is sent down it every 50ms.
31 * If you send "reset\n" on the websocket, then
32 * the incrementing number is reset to 0.
34 * lws-mirror-protocol: copies any received packet to every connection also
35 * using this protocol, including the sender
42 PROTOCOL_DUMB_INCREMENT,
50 * We take a strict whitelist approach to stop ../ attacks
58 * this is just an example of parsing handshake headers, you don't need this
59 * in your code unless you will filter allowing connections by the header
63 dump_handshake_info(struct lws *wsi)
67 const unsigned char *c;
70 c = lws_token_to_string(n);
76 if (!lws_hdr_total_length(wsi, n)) {
81 lws_hdr_copy(wsi, buf, sizeof buf, n);
83 fprintf(stderr, " %s = %s\n", (char *)c, buf);
88 const char * get_mimetype(const char *file)
95 if (!strcmp(&file[n - 4], ".ico"))
96 return "image/x-icon";
98 if (!strcmp(&file[n - 4], ".png"))
101 if (!strcmp(&file[n - 5], ".html"))
107 /* this protocol server (always the first one) handles HTTP,
109 * Some misc callbacks that aren't associated with a protocol also turn up only
110 * here on the first protocol server.
113 int callback_http(struct lws *wsi, enum lws_callback_reasons reason, void *user,
114 void *in, size_t len)
116 struct per_session_data__http *pss =
117 (struct per_session_data__http *)user;
118 static unsigned char buffer[4096];
119 unsigned long amount, file_len;
120 char leaf_path[1024];
121 const char *mimetype;
131 struct lws_pollargs *pa = (struct lws_pollargs *)in;
135 case LWS_CALLBACK_HTTP:
137 dump_handshake_info(wsi);
139 /* dump the individual URI Arg parameters */
143 m = lws_hdr_copy_fragment(wsi, buf, sizeof(buf),
144 WSI_TOKEN_HTTP_URI_ARGS, n);
148 lwsl_info("URI Arg %d: %s\n", n, buf);
152 lws_return_http_status(wsi,
153 HTTP_STATUS_BAD_REQUEST, NULL);
157 /* this example server has no concept of directories */
158 if (strchr((const char *)in + 1, '/')) {
159 lws_return_http_status(wsi,
160 HTTP_STATUS_FORBIDDEN, NULL);
164 /* if a legal POST URL, let it continue and accept data */
165 if (lws_hdr_total_length(wsi, WSI_TOKEN_POST_URI))
168 /* check for the "send a big file by hand" example case */
170 if (!strcmp((const char *)in, "/leaf.jpg")) {
171 if (strlen(resource_path) > sizeof(leaf_path) - 10)
173 sprintf(leaf_path, "%s/leaf.jpg", resource_path);
175 /* well, let's demonstrate how to send the hard way */
177 p = buffer + LWS_SEND_BUFFER_PRE_PADDING;
178 end = p + sizeof(buffer) - LWS_SEND_BUFFER_PRE_PADDING;
180 pss->fd = lws_plat_file_open(wsi, leaf_path, &file_len,
183 if (pss->fd == LWS_INVALID_FILE)
187 * we will send a big jpeg file, but it could be
188 * anything. Set the Content-Type: appropriately
189 * so the browser knows what to do with it.
191 * Notice we use the APIs to build the header, which
192 * will do the right thing for HTTP 1/1.1 and HTTP2
193 * depending on what connection it happens to be working
196 if (lws_add_http_header_status(wsi, 200, &p, end))
198 if (lws_add_http_header_by_token(wsi, WSI_TOKEN_HTTP_SERVER,
199 (unsigned char *)"libwebsockets",
202 if (lws_add_http_header_by_token(wsi,
203 WSI_TOKEN_HTTP_CONTENT_TYPE,
204 (unsigned char *)"image/jpeg",
207 if (lws_add_http_header_content_length(wsi,
211 if (lws_finalize_http_header(wsi, &p, end))
215 * send the http headers...
216 * this won't block since it's the first payload sent
217 * on the connection since it was established
218 * (too small for partial)
220 * Notice they are sent using LWS_WRITE_HTTP_HEADERS
221 * which also means you can't send body too in one step,
222 * this is mandated by changes in HTTP2
225 n = lws_write(wsi, buffer + LWS_SEND_BUFFER_PRE_PADDING,
226 p - (buffer + LWS_SEND_BUFFER_PRE_PADDING),
227 LWS_WRITE_HTTP_HEADERS);
230 lws_plat_file_close(wsi, pss->fd);
234 * book us a LWS_CALLBACK_HTTP_WRITEABLE callback
236 lws_callback_on_writable(wsi);
240 /* if not, send a file the easy way */
241 strcpy(buf, resource_path);
242 if (strcmp(in, "/")) {
243 if (*((const char *)in) != '/')
245 strncat(buf, in, sizeof(buf) - strlen(resource_path));
246 } else /* default file to serve */
247 strcat(buf, "/test.html");
248 buf[sizeof(buf) - 1] = '\0';
250 /* refuse to serve files we don't understand */
251 mimetype = get_mimetype(buf);
253 lwsl_err("Unknown mimetype for %s\n", buf);
254 lws_return_http_status(wsi,
255 HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE, NULL);
259 /* demonstrates how to set a cookie on / */
261 other_headers = NULL;
263 if (!strcmp((const char *)in, "/") &&
264 !lws_hdr_total_length(wsi, WSI_TOKEN_HTTP_COOKIE)) {
265 /* this isn't very unguessable but it'll do for us */
266 gettimeofday(&tv, NULL);
267 n = sprintf(b64, "test=LWS_%u_%u_COOKIE;Max-Age=360000",
268 (unsigned int)tv.tv_sec,
269 (unsigned int)tv.tv_usec);
271 p = (unsigned char *)leaf_path;
273 if (lws_add_http_header_by_name(wsi,
274 (unsigned char *)"set-cookie:",
275 (unsigned char *)b64, n, &p,
276 (unsigned char *)leaf_path + sizeof(leaf_path)))
278 n = (char *)p - leaf_path;
279 other_headers = leaf_path;
282 n = lws_serve_http_file(wsi, buf, mimetype, other_headers, n);
283 if (n < 0 || ((n > 0) && lws_http_transaction_completed(wsi)))
284 return -1; /* error or can't reuse connection: close the socket */
287 * notice that the sending of the file completes asynchronously,
288 * we'll get a LWS_CALLBACK_HTTP_FILE_COMPLETION callback when
294 case LWS_CALLBACK_HTTP_BODY:
295 strncpy(buf, in, 20);
300 lwsl_notice("LWS_CALLBACK_HTTP_BODY: %s... len %d\n",
301 (const char *)buf, (int)len);
305 case LWS_CALLBACK_HTTP_BODY_COMPLETION:
306 lwsl_notice("LWS_CALLBACK_HTTP_BODY_COMPLETION\n");
307 /* the whole of the sent body arrived, close or reuse the connection */
308 lws_return_http_status(wsi, HTTP_STATUS_OK, NULL);
311 case LWS_CALLBACK_HTTP_FILE_COMPLETION:
314 case LWS_CALLBACK_HTTP_WRITEABLE:
316 * we can send more of whatever it is we were sending
319 /* we'd like the send this much */
320 n = sizeof(buffer) - LWS_SEND_BUFFER_PRE_PADDING;
322 /* but if the peer told us he wants less, we can adapt */
323 m = lws_get_peer_write_allowance(wsi);
325 /* -1 means not using a protocol that has this info */
327 /* right now, peer can't handle anything */
330 if (m != -1 && m < n)
331 /* he couldn't handle that much */
334 n = lws_plat_file_read(wsi, pss->fd,
336 LWS_SEND_BUFFER_PRE_PADDING, n);
337 /* problem reading, close conn */
341 /* sent it all, close conn */
345 * To support HTTP2, must take care about preamble space
347 * identification of when we send the last payload frame
348 * is handled by the library itself if you sent a
349 * content-length header
351 m = lws_write(wsi, buffer + LWS_SEND_BUFFER_PRE_PADDING,
354 /* write failed, close conn */
358 * http2 won't do this
361 /* partial write, adjust */
362 if (lws_plat_file_seek_cur(wsi, pss->fd, m - n) ==
366 if (m) /* while still active, extend timeout */
368 PENDING_TIMEOUT_HTTP_CONTENT, 5);
370 /* if we have indigestion, let him clear it
371 * before eating more */
372 if (lws_partial_buffered(wsi))
375 } while (!lws_send_pipe_choked(wsi));
378 lws_callback_on_writable(wsi);
381 /* true if still partial pending */
382 if (lws_partial_buffered(wsi)) {
383 lws_callback_on_writable(wsi);
386 lws_plat_file_close(wsi, pss->fd);
390 lws_plat_file_close(wsi, pss->fd);
394 * callback for confirming to continue with client IP appear in
395 * protocol 0 callback since no websocket protocol has been agreed
396 * yet. You can just ignore this if you won't filter on client IP
397 * since the default uhandled callback return is 0 meaning let the
398 * connection continue.
400 case LWS_CALLBACK_FILTER_NETWORK_CONNECTION:
402 /* if we returned non-zero from here, we kill the connection */
406 * callbacks for managing the external poll() array appear in
407 * protocol 0 callback
410 case LWS_CALLBACK_LOCK_POLL:
412 * lock mutex to protect pollfd state
413 * called before any other POLL related callback
414 * if protecting wsi lifecycle change, len == 1
416 test_server_lock(len);
419 case LWS_CALLBACK_UNLOCK_POLL:
421 * unlock mutex to protect pollfd state when
422 * called after any other POLL related callback
423 * if protecting wsi lifecycle change, len == 1
425 test_server_unlock(len);
429 case LWS_CALLBACK_ADD_POLL_FD:
431 if (count_pollfds >= max_poll_elements) {
432 lwsl_err("LWS_CALLBACK_ADD_POLL_FD: too many sockets to track\n");
436 fd_lookup[pa->fd] = count_pollfds;
437 pollfds[count_pollfds].fd = pa->fd;
438 pollfds[count_pollfds].events = pa->events;
439 pollfds[count_pollfds++].revents = 0;
442 case LWS_CALLBACK_DEL_POLL_FD:
443 if (!--count_pollfds)
445 m = fd_lookup[pa->fd];
446 /* have the last guy take up the vacant slot */
447 pollfds[m] = pollfds[count_pollfds];
448 fd_lookup[pollfds[count_pollfds].fd] = m;
451 case LWS_CALLBACK_CHANGE_MODE_POLL_FD:
452 pollfds[fd_lookup[pa->fd]].events = pa->events;
456 case LWS_CALLBACK_GET_THREAD_ID:
458 * if you will call "lws_callback_on_writable"
459 * from a different thread, return the caller thread ID
460 * here so lws can use this information to work out if it
461 * should signal the poll() loop to exit and restart early
464 /* return pthread_getthreadid_np(); */
474 /* if we're on HTTP1.1 or 2.0, will keep the idle connection alive */
476 if (lws_http_transaction_completed(wsi))