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 #if defined(LWS_OPENSSL_SUPPORT) && defined(LWS_HAVE_SSL_CTX_set1_param)
38 /* location of the certificate revocation list */
39 extern char crl_path[1024];
42 extern int debug_level;
48 PROTOCOL_DUMB_INCREMENT,
56 * We take a strict whitelist approach to stop ../ attacks
64 * this is just an example of parsing handshake headers, you don't need this
65 * in your code unless you will filter allowing connections by the header
69 dump_handshake_info(struct lws *wsi)
73 const unsigned char *c;
76 c = lws_token_to_string(n);
82 len = lws_hdr_total_length(wsi, n);
83 if (!len || len > sizeof(buf) - 1) {
88 lws_hdr_copy(wsi, buf, sizeof buf, n);
89 buf[sizeof(buf) - 1] = '\0';
91 fprintf(stderr, " %s = %s\n", (char *)c, buf);
96 const char * get_mimetype(const char *file)
103 if (!strcmp(&file[n - 4], ".ico"))
104 return "image/x-icon";
106 if (!strcmp(&file[n - 4], ".png"))
109 if (!strcmp(&file[n - 5], ".html"))
112 if (!strcmp(&file[n - 4], ".css"))
115 if (!strcmp(&file[n - 3], ".js"))
116 return "text/javascript";
122 static const char * const param_names[] = {
129 enum enum_param_names {
137 file_upload_cb(void *data, const char *name, const char *filename,
138 char *buf, int len, enum lws_spa_fileupload_states state)
140 struct per_session_data__http *pss =
141 (struct per_session_data__http *)data;
148 strncpy(pss->filename, filename, sizeof(pss->filename) - 1);
149 /* we get the original filename in @filename arg, but for
150 * simple demo use a fixed name so we don't have to deal with
152 pss->post_fd = (lws_filefd_type)open("/tmp/post-file",
153 O_CREAT | O_TRUNC | O_RDWR, 0600);
155 case LWS_UFS_FINAL_CONTENT:
156 case LWS_UFS_CONTENT:
158 pss->file_length += len;
160 /* if the file length is too big, drop it */
161 if (pss->file_length > 100000)
164 n = write((int)pss->post_fd, buf, len);
165 lwsl_notice("%s: write %d says %d\n", __func__, len, n);
167 if (state == LWS_UFS_CONTENT)
169 close((int)pss->post_fd);
170 pss->post_fd = LWS_INVALID_FILE;
177 /* this protocol server (always the first one) handles HTTP,
179 * Some misc callbacks that aren't associated with a protocol also turn up only
180 * here on the first protocol server.
183 int callback_http(struct lws *wsi, enum lws_callback_reasons reason, void *user,
184 void *in, size_t len)
186 struct per_session_data__http *pss =
187 (struct per_session_data__http *)user;
188 unsigned char buffer[4096 + LWS_PRE];
189 lws_filepos_t amount, file_len, sent;
190 char leaf_path[1024];
191 const char *mimetype;
193 unsigned char *end, *start;
196 #ifndef LWS_NO_CLIENT
197 struct per_session_data__http *pss1;
204 struct lws_pollargs *pa = (struct lws_pollargs *)in;
209 case LWS_CALLBACK_HTTP:
211 lwsl_info("lws_http_serve: %s\n", (const char *)in);
213 if (debug_level & LLL_INFO) {
214 dump_handshake_info(wsi);
216 /* dump the individual URI Arg parameters */
218 while (lws_hdr_copy_fragment(wsi, buf, sizeof(buf),
219 WSI_TOKEN_HTTP_URI_ARGS, n) > 0) {
220 lwsl_notice("URI Arg %d: %s\n", ++n, buf);
225 lws_get_peer_simple(wsi, buf, sizeof(buf));
226 lwsl_info("HTTP connect from %s\n", buf);
230 lws_return_http_status(wsi,
231 HTTP_STATUS_BAD_REQUEST, NULL);
235 #if !defined(LWS_NO_CLIENT) && defined(LWS_OPENSSL_SUPPORT)
236 if (!strncmp(in, "/proxytest", 10)) {
237 struct lws_client_connect_info i;
238 char *rootpath = "/git/";
239 const char *p = (const char *)in;
241 if (lws_get_child(wsi))
244 pss->client_finished = 0;
245 memset(&i, 0, sizeof(i));
246 i.context = lws_get_context(wsi);
247 i.address = "libwebsockets.org";
249 i.ssl_connection = 1;
251 i.path = (char *)in + 10;
258 i.uri_replace_from = "libwebsockets.org/git/";
259 i.uri_replace_to = "/proxytest/";
261 if (!lws_client_connect_via_info(&i)) {
262 lwsl_err("proxy connect fail\n");
271 /* this example server has no concept of directories */
272 if (strchr((const char *)in + 1, '/')) {
273 lws_return_http_status(wsi, HTTP_STATUS_NOT_ACCEPTABLE, NULL);
278 /* if a legal POST URL, let it continue and accept data */
279 if (lws_hdr_total_length(wsi, WSI_TOKEN_POST_URI))
282 /* check for the "send a big file by hand" example case */
284 if (!strcmp((const char *)in, "/leaf.jpg")) {
285 lws_fop_flags_t flags = LWS_O_RDONLY;
287 if (strlen(resource_path) > sizeof(leaf_path) - 10)
289 sprintf(leaf_path, "%s/leaf.jpg", resource_path);
291 /* well, let's demonstrate how to send the hard way */
293 p = buffer + LWS_PRE;
294 end = p + sizeof(buffer) - LWS_PRE;
296 pss->fop_fd = lws_vfs_file_open(
297 lws_get_fops(lws_get_context(wsi)),
300 lwsl_err("failed to open file %s\n", leaf_path);
303 file_len = lws_vfs_get_length(pss->fop_fd);
306 * we will send a big jpeg file, but it could be
307 * anything. Set the Content-Type: appropriately
308 * so the browser knows what to do with it.
310 * Notice we use the APIs to build the header, which
311 * will do the right thing for HTTP 1/1.1 and HTTP2
312 * depending on what connection it happens to be working
315 if (lws_add_http_header_status(wsi, HTTP_STATUS_OK, &p, end))
317 if (lws_add_http_header_by_token(wsi, WSI_TOKEN_HTTP_SERVER,
318 (unsigned char *)"libwebsockets",
321 if (lws_add_http_header_by_token(wsi,
322 WSI_TOKEN_HTTP_CONTENT_TYPE,
323 (unsigned char *)"image/jpeg",
326 if (lws_add_http_header_content_length(wsi,
330 if (lws_finalize_http_header(wsi, &p, end))
334 * send the http headers...
335 * this won't block since it's the first payload sent
336 * on the connection since it was established
337 * (too small for partial)
339 * Notice they are sent using LWS_WRITE_HTTP_HEADERS
340 * which also means you can't send body too in one step,
341 * this is mandated by changes in HTTP2
345 lwsl_info("%s\n", buffer + LWS_PRE);
347 n = lws_write(wsi, buffer + LWS_PRE,
348 p - (buffer + LWS_PRE),
349 LWS_WRITE_HTTP_HEADERS);
351 lws_vfs_file_close(&pss->fop_fd);
355 * book us a LWS_CALLBACK_HTTP_WRITEABLE callback
357 lws_callback_on_writable(wsi);
361 /* if not, send a file the easy way */
362 if (!strncmp(in, "/cgit-data/", 11)) {
363 in = (char *)in + 11;
364 strcpy(buf, "/usr/share/cgit");
366 strcpy(buf, resource_path);
368 if (strcmp(in, "/")) {
369 if (*((const char *)in) != '/')
371 strncat(buf, in, sizeof(buf) - strlen(buf) - 1);
372 } else /* default file to serve */
373 strcat(buf, "/test.html");
374 buf[sizeof(buf) - 1] = '\0';
376 /* refuse to serve files we don't understand */
377 mimetype = get_mimetype(buf);
379 lwsl_err("Unknown mimetype for %s\n", buf);
380 lws_return_http_status(wsi,
381 HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE, NULL);
385 /* demonstrates how to set a cookie on / */
387 other_headers = leaf_path;
388 p = (unsigned char *)leaf_path;
389 if (!strcmp((const char *)in, "/") &&
390 !lws_hdr_total_length(wsi, WSI_TOKEN_HTTP_COOKIE)) {
391 /* this isn't very unguessable but it'll do for us */
392 gettimeofday(&tv, NULL);
393 n = sprintf(b64, "test=LWS_%u_%u_COOKIE;Max-Age=360000",
394 (unsigned int)tv.tv_sec,
395 (unsigned int)tv.tv_usec);
397 if (lws_add_http_header_by_name(wsi,
398 (unsigned char *)"set-cookie:",
399 (unsigned char *)b64, n, &p,
400 (unsigned char *)leaf_path + sizeof(leaf_path)))
403 if (lws_is_ssl(wsi) && lws_add_http_header_by_name(wsi,
405 "Strict-Transport-Security:",
407 "max-age=15768000 ; "
408 "includeSubDomains", 36, &p,
409 (unsigned char *)leaf_path +
412 n = (char *)p - leaf_path;
414 n = lws_serve_http_file(wsi, buf, mimetype, other_headers, n);
415 if (n < 0 || ((n > 0) && lws_http_transaction_completed(wsi)))
416 return -1; /* error or can't reuse connection: close the socket */
419 * notice that the sending of the file completes asynchronously,
420 * we'll get a LWS_CALLBACK_HTTP_FILE_COMPLETION callback when
425 case LWS_CALLBACK_CLIENT_RECEIVE:
426 ((char *)in)[len] = '\0';
427 lwsl_info("rx %d '%s'\n", (int)len, (char *)in);
430 case LWS_CALLBACK_HTTP_BODY:
431 /* create the POST argument parser if not already existing */
433 pss->spa = lws_spa_create(wsi, param_names,
434 ARRAY_SIZE(param_names), 1024,
435 file_upload_cb, pss);
439 pss->filename[0] = '\0';
440 pss->file_length = 0;
443 /* let it parse the POST data */
444 if (lws_spa_process(pss->spa, in, len))
448 case LWS_CALLBACK_HTTP_BODY_COMPLETION:
449 lwsl_debug("LWS_CALLBACK_HTTP_BODY_COMPLETION\n");
451 * the whole of the sent body arrived,
452 * respond to the client with a redirect to show the
456 /* call to inform no more payload data coming */
457 lws_spa_finalize(pss->spa);
459 p = (unsigned char *)pss->result + LWS_PRE;
460 end = p + sizeof(pss->result) - LWS_PRE - 1;
461 p += sprintf((char *)p,
462 "<html><body><h1>Form results (after urldecoding)</h1>"
463 "<table><tr><td>Name</td><td>Length</td><td>Value</td></tr>");
465 for (n = 0; n < ARRAY_SIZE(param_names); n++)
466 p += lws_snprintf((char *)p, end - p,
467 "<tr><td><b>%s</b></td><td>%d</td><td>%s</td></tr>",
469 lws_spa_get_length(pss->spa, n),
470 lws_spa_get_string(pss->spa, n));
472 p += lws_snprintf((char *)p, end - p, "</table><br><b>filename:</b> %s, <b>length</b> %ld",
473 pss->filename, pss->file_length);
475 p += lws_snprintf((char *)p, end - p, "</body></html>");
476 pss->result_len = p - (unsigned char *)(pss->result + LWS_PRE);
478 p = buffer + LWS_PRE;
480 end = p + sizeof(buffer) - LWS_PRE;
482 if (lws_add_http_header_status(wsi, HTTP_STATUS_OK, &p, end))
485 if (lws_add_http_header_by_token(wsi, WSI_TOKEN_HTTP_CONTENT_TYPE,
486 (unsigned char *)"text/html", 9, &p, end))
488 if (lws_add_http_header_content_length(wsi, pss->result_len, &p, end))
490 if (lws_finalize_http_header(wsi, &p, end))
493 n = lws_write(wsi, start, p - start, LWS_WRITE_HTTP_HEADERS);
497 n = lws_write(wsi, (unsigned char *)pss->result + LWS_PRE,
498 pss->result_len, LWS_WRITE_HTTP);
502 case LWS_CALLBACK_HTTP_DROP_PROTOCOL:
503 lwsl_debug("LWS_CALLBACK_HTTP_DROP_PROTOCOL\n");
505 /* called when our wsi user_space is going to be destroyed */
507 lws_spa_destroy(pss->spa);
511 case LWS_CALLBACK_HTTP_FILE_COMPLETION:
514 case LWS_CALLBACK_HTTP_WRITEABLE:
515 lwsl_info("LWS_CALLBACK_HTTP_WRITEABLE\n");
517 if (pss->client_finished)
520 if (!lws_get_child(wsi) && !pss->fop_fd) {
521 lwsl_notice("fop_fd NULL\n");
525 #ifndef LWS_NO_CLIENT
526 if (pss->reason_bf & 2) {
527 char *px = buf + LWS_PRE;
528 int lenx = sizeof(buf) - LWS_PRE;
530 * our sink is writeable and our source has something
531 * to read. So read a lump of source material of
532 * suitable size to send or what's available, whichever
537 pss->reason_bf &= ~2;
538 wsi1 = lws_get_child(wsi);
541 if (lws_http_client_read(wsi1, &px, &lenx) < 0)
544 if (pss->client_finished)
550 if (lws_get_child(wsi))
555 * we can send more of whatever it is we were sending
559 /* we'd like the send this much */
560 n = sizeof(buffer) - LWS_PRE;
562 /* but if the peer told us he wants less, we can adapt */
563 m = lws_get_peer_write_allowance(wsi);
565 /* -1 means not using a protocol that has this info */
567 /* right now, peer can't handle anything */
570 if (m != -1 && m < n)
571 /* he couldn't handle that much */
574 n = lws_vfs_file_read(pss->fop_fd,
575 &amount, buffer + LWS_PRE, n);
576 /* problem reading, close conn */
578 lwsl_err("problem reading file\n");
582 /* sent it all, close conn */
586 * To support HTTP2, must take care about preamble space
588 * identification of when we send the last payload frame
589 * is handled by the library itself if you sent a
590 * content-length header
592 m = lws_write(wsi, buffer + LWS_PRE, n, LWS_WRITE_HTTP);
594 lwsl_err("write failed\n");
595 /* write failed, close conn */
598 if (m) /* while still active, extend timeout */
599 lws_set_timeout(wsi, PENDING_TIMEOUT_HTTP_CONTENT, 5);
602 } while (!lws_send_pipe_choked(wsi) && (sent < 1024 * 1024));
604 lws_callback_on_writable(wsi);
607 lws_vfs_file_close(&pss->fop_fd);
612 lws_vfs_file_close(&pss->fop_fd);
617 * callback for confirming to continue with client IP appear in
618 * protocol 0 callback since no websocket protocol has been agreed
619 * yet. You can just ignore this if you won't filter on client IP
620 * since the default unhandled callback return is 0 meaning let the
621 * connection continue.
623 case LWS_CALLBACK_FILTER_NETWORK_CONNECTION:
624 /* if we returned non-zero from here, we kill the connection */
627 #ifndef LWS_NO_CLIENT
628 case LWS_CALLBACK_ESTABLISHED_CLIENT_HTTP: {
629 char ctype[64], ctlen = 0;
630 lwsl_err("LWS_CALLBACK_ESTABLISHED_CLIENT_HTTP\n");
631 p = buffer + LWS_PRE;
632 end = p + sizeof(buffer) - LWS_PRE;
633 if (lws_add_http_header_status(lws_get_parent(wsi), HTTP_STATUS_OK, &p, end))
635 if (lws_add_http_header_by_token(lws_get_parent(wsi),
636 WSI_TOKEN_HTTP_SERVER,
637 (unsigned char *)"libwebsockets",
641 ctlen = lws_hdr_copy(wsi, ctype, sizeof(ctype), WSI_TOKEN_HTTP_CONTENT_TYPE);
643 if (lws_add_http_header_by_token(lws_get_parent(wsi),
644 WSI_TOKEN_HTTP_CONTENT_TYPE,
645 (unsigned char *)ctype, ctlen, &p, end))
649 if (lws_add_http_header_content_length(lws_get_parent(wsi),
653 if (lws_finalize_http_header(lws_get_parent(wsi), &p, end))
657 lwsl_info("%s\n", buffer + LWS_PRE);
659 n = lws_write(lws_get_parent(wsi), buffer + LWS_PRE,
660 p - (buffer + LWS_PRE),
661 LWS_WRITE_HTTP_HEADERS);
666 case LWS_CALLBACK_CLOSED_CLIENT_HTTP:
667 //lwsl_err("LWS_CALLBACK_CLOSED_CLIENT_HTTP\n");
670 case LWS_CALLBACK_RECEIVE_CLIENT_HTTP:
671 //lwsl_err("LWS_CALLBACK_RECEIVE_CLIENT_HTTP: wsi %p\n", wsi);
672 assert(lws_get_parent(wsi));
673 if (!lws_get_parent(wsi))
675 pss1 = lws_wsi_user(lws_get_parent(wsi));
676 pss1->reason_bf |= 2;
677 lws_callback_on_writable(lws_get_parent(wsi));
679 case LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ:
680 //lwsl_err("LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ len %d\n", (int)len);
681 assert(lws_get_parent(wsi));
682 m = lws_write(lws_get_parent(wsi), (unsigned char *)in,
683 len, LWS_WRITE_HTTP);
687 case LWS_CALLBACK_COMPLETED_CLIENT_HTTP:
688 //lwsl_err("LWS_CALLBACK_COMPLETED_CLIENT_HTTP\n");
689 assert(lws_get_parent(wsi));
690 if (!lws_get_parent(wsi))
692 pss1 = lws_wsi_user(lws_get_parent(wsi));
693 pss1->client_finished = 1;
698 * callbacks for managing the external poll() array appear in
699 * protocol 0 callback
702 case LWS_CALLBACK_LOCK_POLL:
704 * lock mutex to protect pollfd state
705 * called before any other POLL related callback
706 * if protecting wsi lifecycle change, len == 1
708 test_server_lock(len);
711 case LWS_CALLBACK_UNLOCK_POLL:
713 * unlock mutex to protect pollfd state when
714 * called after any other POLL related callback
715 * if protecting wsi lifecycle change, len == 1
717 test_server_unlock(len);
721 case LWS_CALLBACK_ADD_POLL_FD:
723 if (count_pollfds >= max_poll_elements) {
724 lwsl_err("LWS_CALLBACK_ADD_POLL_FD: too many sockets to track\n");
728 fd_lookup[pa->fd] = count_pollfds;
729 pollfds[count_pollfds].fd = pa->fd;
730 pollfds[count_pollfds].events = pa->events;
731 pollfds[count_pollfds++].revents = 0;
734 case LWS_CALLBACK_DEL_POLL_FD:
735 if (!--count_pollfds)
737 m = fd_lookup[pa->fd];
738 /* have the last guy take up the vacant slot */
739 pollfds[m] = pollfds[count_pollfds];
740 fd_lookup[pollfds[count_pollfds].fd] = m;
743 case LWS_CALLBACK_CHANGE_MODE_POLL_FD:
744 pollfds[fd_lookup[pa->fd]].events = pa->events;
748 case LWS_CALLBACK_GET_THREAD_ID:
750 * if you will call "lws_callback_on_writable"
751 * from a different thread, return the caller thread ID
752 * here so lws can use this information to work out if it
753 * should signal the poll() loop to exit and restart early
756 /* return pthread_getthreadid_np(); */
760 #if defined(LWS_OPENSSL_SUPPORT)
761 case LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION:
762 /* Verify the client certificate */
763 if (!len || (SSL_get_verify_result((SSL*)in) != X509_V_OK)) {
764 int err = X509_STORE_CTX_get_error((X509_STORE_CTX*)user);
765 int depth = X509_STORE_CTX_get_error_depth((X509_STORE_CTX*)user);
766 const char* msg = X509_verify_cert_error_string(err);
767 lwsl_err("LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION: SSL error: %s (%d), depth: %d\n", msg, err, depth);
771 #if defined(LWS_HAVE_SSL_CTX_set1_param)
772 case LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS:
774 /* Enable CRL checking */
775 X509_VERIFY_PARAM *param = X509_VERIFY_PARAM_new();
776 X509_VERIFY_PARAM_set_flags(param, X509_V_FLAG_CRL_CHECK);
777 SSL_CTX_set1_param((SSL_CTX*)user, param);
778 X509_STORE *store = SSL_CTX_get_cert_store((SSL_CTX*)user);
779 X509_LOOKUP *lookup = X509_STORE_add_lookup(store, X509_LOOKUP_file());
780 n = X509_load_cert_crl_file(lookup, crl_path, X509_FILETYPE_PEM);
781 X509_VERIFY_PARAM_free(param);
785 lwsl_err("LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS: SSL error: %s (%d)\n", ERR_error_string(n, errbuf), n);
799 /* if we're on HTTP1.1 or 2.0, will keep the idle connection alive */
801 if (lws_http_transaction_completed(wsi))