2 * libwebsockets-test-server - libwebsockets test implementation
4 * Copyright (C) 2010-2016 Andy Green <andy@warmcat.com>
6 * This file is made available under the Creative Commons CC0 1.0
7 * Universal Public Domain Dedication.
9 * The person who associated a work with this deed has dedicated
10 * the work to the public domain by waiving all of his or her rights
11 * to the work worldwide under copyright law, including all related
12 * and neighboring rights, to the extent allowed by law. You can copy,
13 * modify, distribute and perform the work, even for commercial purposes,
14 * all without asking permission.
16 * The test apps are intended to be adapted for use in your code, which
17 * may be proprietary. So unlike the library itself, they are licensed
20 #include "test-server.h"
23 * This demo server shows how to use libwebsockets for one or more
24 * websocket protocols in the same server
26 * It defines the following websocket protocols:
28 * dumb-increment-protocol: once the socket is opened, an incrementing
29 * ascii string is sent down it every 50ms.
30 * If you send "reset\n" on the websocket, then
31 * the incrementing number is reset to 0.
33 * lws-mirror-protocol: copies any received packet to every connection also
34 * using this protocol, including the sender
37 extern int debug_level;
43 PROTOCOL_DUMB_INCREMENT,
51 * We take a strict whitelist approach to stop ../ attacks
59 * this is just an example of parsing handshake headers, you don't need this
60 * in your code unless you will filter allowing connections by the header
64 dump_handshake_info(struct lws *wsi)
68 const unsigned char *c;
71 c = lws_token_to_string(n);
77 len = lws_hdr_total_length(wsi, n);
78 if (!len || len > sizeof(buf) - 1) {
83 lws_hdr_copy(wsi, buf, sizeof buf, n);
84 buf[sizeof(buf) - 1] = '\0';
86 fprintf(stderr, " %s = %s\n", (char *)c, buf);
91 const char * get_mimetype(const char *file)
98 if (!strcmp(&file[n - 4], ".ico"))
99 return "image/x-icon";
101 if (!strcmp(&file[n - 4], ".png"))
104 if (!strcmp(&file[n - 5], ".html"))
110 /* this protocol server (always the first one) handles HTTP,
112 * Some misc callbacks that aren't associated with a protocol also turn up only
113 * here on the first protocol server.
116 int callback_http(struct lws *wsi, enum lws_callback_reasons reason, void *user,
117 void *in, size_t len)
119 struct per_session_data__http *pss =
120 (struct per_session_data__http *)user;
121 unsigned char buffer[4096 + LWS_PRE];
122 unsigned long amount, file_len, sent;
123 char leaf_path[1024];
124 const char *mimetype;
134 struct lws_pollargs *pa = (struct lws_pollargs *)in;
138 case LWS_CALLBACK_HTTP:
140 if (debug_level & LLL_INFO) {
141 dump_handshake_info(wsi);
143 /* dump the individual URI Arg parameters */
145 while (lws_hdr_copy_fragment(wsi, buf, sizeof(buf),
146 WSI_TOKEN_HTTP_URI_ARGS, n) > 0) {
147 lwsl_notice("URI Arg %d: %s\n", ++n, buf);
151 lws_return_http_status(wsi,
152 HTTP_STATUS_BAD_REQUEST, NULL);
156 /* this example server has no concept of directories */
157 if (strchr((const char *)in + 1, '/')) {
158 lws_return_http_status(wsi, HTTP_STATUS_FORBIDDEN, NULL);
162 /* if a legal POST URL, let it continue and accept data */
163 if (lws_hdr_total_length(wsi, WSI_TOKEN_POST_URI))
166 /* check for the "send a big file by hand" example case */
168 if (!strcmp((const char *)in, "/leaf.jpg")) {
169 if (strlen(resource_path) > sizeof(leaf_path) - 10)
171 sprintf(leaf_path, "%s/leaf.jpg", resource_path);
173 /* well, let's demonstrate how to send the hard way */
175 p = buffer + LWS_PRE;
176 end = p + sizeof(buffer) - LWS_PRE;
178 pss->fd = lws_plat_file_open(wsi, leaf_path, &file_len,
181 if (pss->fd == LWS_INVALID_FILE) {
182 lwsl_err("faild to open file %s\n", leaf_path);
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
226 lwsl_info("%s\n", buffer + LWS_PRE);
228 n = lws_write(wsi, buffer + LWS_PRE, p - (buffer + LWS_PRE),
229 LWS_WRITE_HTTP_HEADERS);
231 lws_plat_file_close(wsi, pss->fd);
235 * book us a LWS_CALLBACK_HTTP_WRITEABLE callback
237 lws_callback_on_writable(wsi);
241 /* if not, send a file the easy way */
242 strcpy(buf, resource_path);
243 if (strcmp(in, "/")) {
244 if (*((const char *)in) != '/')
246 strncat(buf, in, sizeof(buf) - strlen(resource_path));
247 } else /* default file to serve */
248 strcat(buf, "/test.html");
249 buf[sizeof(buf) - 1] = '\0';
251 /* refuse to serve files we don't understand */
252 mimetype = get_mimetype(buf);
254 lwsl_err("Unknown mimetype for %s\n", buf);
255 lws_return_http_status(wsi,
256 HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE, NULL);
260 /* demonstrates how to set a cookie on / */
262 other_headers = leaf_path;
263 p = (unsigned char *)leaf_path;
264 if (!strcmp((const char *)in, "/") &&
265 !lws_hdr_total_length(wsi, WSI_TOKEN_HTTP_COOKIE)) {
266 /* this isn't very unguessable but it'll do for us */
267 gettimeofday(&tv, NULL);
268 n = sprintf(b64, "test=LWS_%u_%u_COOKIE;Max-Age=360000",
269 (unsigned int)tv.tv_sec,
270 (unsigned int)tv.tv_usec);
272 if (lws_add_http_header_by_name(wsi,
273 (unsigned char *)"set-cookie:",
274 (unsigned char *)b64, n, &p,
275 (unsigned char *)leaf_path + sizeof(leaf_path)))
278 if (lws_is_ssl(wsi) && lws_add_http_header_by_name(wsi,
280 "Strict-Transport-Security:",
282 "max-age=15768000 ; "
283 "includeSubDomains", 36, &p,
284 (unsigned char *)leaf_path +
287 n = (char *)p - leaf_path;
289 n = lws_serve_http_file(wsi, buf, mimetype, other_headers, n);
290 if (n < 0 || ((n > 0) && lws_http_transaction_completed(wsi)))
291 return -1; /* error or can't reuse connection: close the socket */
294 * notice that the sending of the file completes asynchronously,
295 * we'll get a LWS_CALLBACK_HTTP_FILE_COMPLETION callback when
300 case LWS_CALLBACK_HTTP_BODY:
301 strncpy(buf, in, 20);
306 lwsl_notice("LWS_CALLBACK_HTTP_BODY: %s... len %d\n",
307 (const char *)buf, (int)len);
311 case LWS_CALLBACK_HTTP_BODY_COMPLETION:
312 lwsl_notice("LWS_CALLBACK_HTTP_BODY_COMPLETION\n");
313 /* the whole of the sent body arrived, close or reuse the connection */
314 lws_return_http_status(wsi, HTTP_STATUS_OK, NULL);
317 case LWS_CALLBACK_HTTP_FILE_COMPLETION:
320 case LWS_CALLBACK_HTTP_WRITEABLE:
321 lwsl_info("LWS_CALLBACK_HTTP_WRITEABLE\n");
323 if (pss->fd == LWS_INVALID_FILE)
327 * we can send more of whatever it is we were sending
331 /* we'd like the send this much */
332 n = sizeof(buffer) - LWS_PRE;
334 /* but if the peer told us he wants less, we can adapt */
335 m = lws_get_peer_write_allowance(wsi);
337 /* -1 means not using a protocol that has this info */
339 /* right now, peer can't handle anything */
342 if (m != -1 && m < n)
343 /* he couldn't handle that much */
346 n = lws_plat_file_read(wsi, pss->fd,
347 &amount, buffer + LWS_PRE, n);
348 /* problem reading, close conn */
350 lwsl_err("problem reading file\n");
354 /* sent it all, close conn */
358 * To support HTTP2, must take care about preamble space
360 * identification of when we send the last payload frame
361 * is handled by the library itself if you sent a
362 * content-length header
364 m = lws_write(wsi, buffer + LWS_PRE, n, LWS_WRITE_HTTP);
366 lwsl_err("write failed\n");
367 /* write failed, close conn */
370 if (m) /* while still active, extend timeout */
371 lws_set_timeout(wsi, PENDING_TIMEOUT_HTTP_CONTENT, 5);
374 } while (!lws_send_pipe_choked(wsi) && (sent < 1024 * 1024));
376 lws_callback_on_writable(wsi);
379 lws_plat_file_close(wsi, pss->fd);
380 pss->fd = LWS_INVALID_FILE;
384 lws_plat_file_close(wsi, pss->fd);
389 * callback for confirming to continue with client IP appear in
390 * protocol 0 callback since no websocket protocol has been agreed
391 * yet. You can just ignore this if you won't filter on client IP
392 * since the default uhandled callback return is 0 meaning let the
393 * connection continue.
395 case LWS_CALLBACK_FILTER_NETWORK_CONNECTION:
397 /* if we returned non-zero from here, we kill the connection */
401 * callbacks for managing the external poll() array appear in
402 * protocol 0 callback
405 case LWS_CALLBACK_LOCK_POLL:
407 * lock mutex to protect pollfd state
408 * called before any other POLL related callback
409 * if protecting wsi lifecycle change, len == 1
411 test_server_lock(len);
414 case LWS_CALLBACK_UNLOCK_POLL:
416 * unlock mutex to protect pollfd state when
417 * called after any other POLL related callback
418 * if protecting wsi lifecycle change, len == 1
420 test_server_unlock(len);
424 case LWS_CALLBACK_ADD_POLL_FD:
426 if (count_pollfds >= max_poll_elements) {
427 lwsl_err("LWS_CALLBACK_ADD_POLL_FD: too many sockets to track\n");
431 fd_lookup[pa->fd] = count_pollfds;
432 pollfds[count_pollfds].fd = pa->fd;
433 pollfds[count_pollfds].events = pa->events;
434 pollfds[count_pollfds++].revents = 0;
437 case LWS_CALLBACK_DEL_POLL_FD:
438 if (!--count_pollfds)
440 m = fd_lookup[pa->fd];
441 /* have the last guy take up the vacant slot */
442 pollfds[m] = pollfds[count_pollfds];
443 fd_lookup[pollfds[count_pollfds].fd] = m;
446 case LWS_CALLBACK_CHANGE_MODE_POLL_FD:
447 pollfds[fd_lookup[pa->fd]].events = pa->events;
451 case LWS_CALLBACK_GET_THREAD_ID:
453 * if you will call "lws_callback_on_writable"
454 * from a different thread, return the caller thread ID
455 * here so lws can use this information to work out if it
456 * should signal the poll() loop to exit and restart early
459 /* return pthread_getthreadid_np(); */
469 /* if we're on HTTP1.1 or 2.0, will keep the idle connection alive */
471 if (lws_http_transaction_completed(wsi))