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;
146 strncpy(pss->filename, filename, sizeof(pss->filename) - 1);
147 /* we get the original filename in @filename arg, but for
148 * simple demo use a fixed name so we don't have to deal with
150 pss->post_fd = open("/tmp/post-file",
151 O_CREAT | O_TRUNC | O_RDWR, 0600);
153 case LWS_UFS_FINAL_CONTENT:
154 case LWS_UFS_CONTENT:
156 pss->file_length += len;
158 /* if the file length is too big, drop it */
159 if (pss->file_length > 100000)
162 n = write(pss->post_fd, buf, len);
163 lwsl_notice("%s: write %d says %d\n", __func__, len, n);
165 if (state == LWS_UFS_CONTENT)
168 pss->post_fd = LWS_INVALID_FILE;
175 /* this protocol server (always the first one) handles HTTP,
177 * Some misc callbacks that aren't associated with a protocol also turn up only
178 * here on the first protocol server.
181 int callback_http(struct lws *wsi, enum lws_callback_reasons reason, void *user,
182 void *in, size_t len)
184 struct per_session_data__http *pss =
185 (struct per_session_data__http *)user;
186 unsigned char buffer[4096 + LWS_PRE];
187 lws_filepos_t amount, file_len, sent;
188 char leaf_path[1024];
189 const char *mimetype;
191 unsigned char *end, *start;
194 #ifndef LWS_NO_CLIENT
195 struct per_session_data__http *pss1;
202 struct lws_pollargs *pa = (struct lws_pollargs *)in;
207 case LWS_CALLBACK_HTTP:
209 lwsl_info("lws_http_serve: %s\n", (const char *)in);
211 if (debug_level & LLL_INFO) {
212 dump_handshake_info(wsi);
214 /* dump the individual URI Arg parameters */
216 while (lws_hdr_copy_fragment(wsi, buf, sizeof(buf),
217 WSI_TOKEN_HTTP_URI_ARGS, n) > 0) {
218 lwsl_notice("URI Arg %d: %s\n", ++n, buf);
223 lws_get_peer_simple(wsi, buf, sizeof(buf));
224 lwsl_info("HTTP connect from %s\n", buf);
228 lws_return_http_status(wsi,
229 HTTP_STATUS_BAD_REQUEST, NULL);
233 #ifndef LWS_NO_CLIENT
234 if (!strncmp(in, "/proxytest", 10)) {
235 struct lws_client_connect_info i;
236 char *rootpath = "/";
237 const char *p = (const char *)in;
239 if (lws_get_child(wsi))
242 pss->client_finished = 0;
243 memset(&i,0, sizeof(i));
244 i.context = lws_get_context(wsi);
245 i.address = "git.libwebsockets.org";
247 i.ssl_connection = 0;
249 i.path = (char *)in + 10;
252 i.host = "git.libwebsockets.org";
256 i.uri_replace_from = "git.libwebsockets.org/";
257 i.uri_replace_to = "/proxytest/";
258 if (!lws_client_connect_via_info(&i)) {
259 lwsl_err("proxy connect fail\n");
270 /* this example server has no concept of directories */
271 if (strchr((const char *)in + 1, '/')) {
272 lws_return_http_status(wsi, HTTP_STATUS_NOT_ACCEPTABLE, NULL);
277 /* if a legal POST URL, let it continue and accept data */
278 if (lws_hdr_total_length(wsi, WSI_TOKEN_POST_URI))
281 /* check for the "send a big file by hand" example case */
283 if (!strcmp((const char *)in, "/leaf.jpg")) {
284 lws_fop_flags_t flags = LWS_O_RDONLY;
286 if (strlen(resource_path) > sizeof(leaf_path) - 10)
288 sprintf(leaf_path, "%s/leaf.jpg", resource_path);
290 /* well, let's demonstrate how to send the hard way */
292 p = buffer + LWS_PRE;
293 end = p + sizeof(buffer) - LWS_PRE;
295 pss->fop_fd = lws_vfs_file_open(
296 lws_get_fops(lws_get_context(wsi)),
299 lwsl_err("failed to open file %s\n", leaf_path);
302 file_len = lws_vfs_get_length(pss->fop_fd);
305 * we will send a big jpeg file, but it could be
306 * anything. Set the Content-Type: appropriately
307 * so the browser knows what to do with it.
309 * Notice we use the APIs to build the header, which
310 * will do the right thing for HTTP 1/1.1 and HTTP2
311 * depending on what connection it happens to be working
314 if (lws_add_http_header_status(wsi, HTTP_STATUS_OK, &p, end))
316 if (lws_add_http_header_by_token(wsi, WSI_TOKEN_HTTP_SERVER,
317 (unsigned char *)"libwebsockets",
320 if (lws_add_http_header_by_token(wsi,
321 WSI_TOKEN_HTTP_CONTENT_TYPE,
322 (unsigned char *)"image/jpeg",
325 if (lws_add_http_header_content_length(wsi,
329 if (lws_finalize_http_header(wsi, &p, end))
333 * send the http headers...
334 * this won't block since it's the first payload sent
335 * on the connection since it was established
336 * (too small for partial)
338 * Notice they are sent using LWS_WRITE_HTTP_HEADERS
339 * which also means you can't send body too in one step,
340 * this is mandated by changes in HTTP2
344 lwsl_info("%s\n", buffer + LWS_PRE);
346 n = lws_write(wsi, buffer + LWS_PRE,
347 p - (buffer + LWS_PRE),
348 LWS_WRITE_HTTP_HEADERS);
350 lws_vfs_file_close(&pss->fop_fd);
354 * book us a LWS_CALLBACK_HTTP_WRITEABLE callback
356 lws_callback_on_writable(wsi);
360 /* if not, send a file the easy way */
361 if (!strncmp(in, "/cgit-data/", 11)) {
362 in = (char *)in + 11;
363 strcpy(buf, "/usr/share/cgit");
365 strcpy(buf, resource_path);
367 if (strcmp(in, "/")) {
368 if (*((const char *)in) != '/')
370 strncat(buf, in, sizeof(buf) - strlen(buf) - 1);
371 } else /* default file to serve */
372 strcat(buf, "/test.html");
373 buf[sizeof(buf) - 1] = '\0';
375 /* refuse to serve files we don't understand */
376 mimetype = get_mimetype(buf);
378 lwsl_err("Unknown mimetype for %s\n", buf);
379 lws_return_http_status(wsi,
380 HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE, NULL);
384 /* demonstrates how to set a cookie on / */
386 other_headers = leaf_path;
387 p = (unsigned char *)leaf_path;
388 if (!strcmp((const char *)in, "/") &&
389 !lws_hdr_total_length(wsi, WSI_TOKEN_HTTP_COOKIE)) {
390 /* this isn't very unguessable but it'll do for us */
391 gettimeofday(&tv, NULL);
392 n = sprintf(b64, "test=LWS_%u_%u_COOKIE;Max-Age=360000",
393 (unsigned int)tv.tv_sec,
394 (unsigned int)tv.tv_usec);
396 if (lws_add_http_header_by_name(wsi,
397 (unsigned char *)"set-cookie:",
398 (unsigned char *)b64, n, &p,
399 (unsigned char *)leaf_path + sizeof(leaf_path)))
402 if (lws_is_ssl(wsi) && lws_add_http_header_by_name(wsi,
404 "Strict-Transport-Security:",
406 "max-age=15768000 ; "
407 "includeSubDomains", 36, &p,
408 (unsigned char *)leaf_path +
411 n = (char *)p - leaf_path;
413 n = lws_serve_http_file(wsi, buf, mimetype, other_headers, n);
414 if (n < 0 || ((n > 0) && lws_http_transaction_completed(wsi)))
415 return -1; /* error or can't reuse connection: close the socket */
418 * notice that the sending of the file completes asynchronously,
419 * we'll get a LWS_CALLBACK_HTTP_FILE_COMPLETION callback when
424 case LWS_CALLBACK_HTTP_BODY:
425 /* create the POST argument parser if not already existing */
427 pss->spa = lws_spa_create(wsi, param_names,
428 ARRAY_SIZE(param_names), 1024,
429 file_upload_cb, pss);
433 pss->filename[0] = '\0';
434 pss->file_length = 0;
437 /* let it parse the POST data */
438 if (lws_spa_process(pss->spa, in, len))
442 case LWS_CALLBACK_HTTP_BODY_COMPLETION:
443 lwsl_debug("LWS_CALLBACK_HTTP_BODY_COMPLETION\n");
445 * the whole of the sent body arrived,
446 * respond to the client with a redirect to show the
450 /* call to inform no more payload data coming */
451 lws_spa_finalize(pss->spa);
453 p = (unsigned char *)pss->result + LWS_PRE;
454 end = p + sizeof(pss->result) - LWS_PRE - 1;
455 p += sprintf((char *)p,
456 "<html><body><h1>Form results (after urldecoding)</h1>"
457 "<table><tr><td>Name</td><td>Length</td><td>Value</td></tr>");
459 for (n = 0; n < ARRAY_SIZE(param_names); n++)
460 p += lws_snprintf((char *)p, end - p,
461 "<tr><td><b>%s</b></td><td>%d</td><td>%s</td></tr>",
463 lws_spa_get_length(pss->spa, n),
464 lws_spa_get_string(pss->spa, n));
466 p += lws_snprintf((char *)p, end - p, "</table><br><b>filename:</b> %s, <b>length</b> %ld",
467 pss->filename, pss->file_length);
469 p += lws_snprintf((char *)p, end - p, "</body></html>");
470 pss->result_len = p - (unsigned char *)(pss->result + LWS_PRE);
472 p = buffer + LWS_PRE;
474 end = p + sizeof(buffer) - LWS_PRE;
476 if (lws_add_http_header_status(wsi, HTTP_STATUS_OK, &p, end))
479 if (lws_add_http_header_by_token(wsi, WSI_TOKEN_HTTP_CONTENT_TYPE,
480 (unsigned char *)"text/html", 9, &p, end))
482 if (lws_add_http_header_content_length(wsi, pss->result_len, &p, end))
484 if (lws_finalize_http_header(wsi, &p, end))
487 n = lws_write(wsi, start, p - start, LWS_WRITE_HTTP_HEADERS);
491 n = lws_write(wsi, (unsigned char *)pss->result + LWS_PRE,
492 pss->result_len, LWS_WRITE_HTTP);
496 case LWS_CALLBACK_HTTP_DROP_PROTOCOL:
497 lwsl_debug("LWS_CALLBACK_HTTP_DROP_PROTOCOL\n");
499 /* called when our wsi user_space is going to be destroyed */
501 lws_spa_destroy(pss->spa);
505 case LWS_CALLBACK_HTTP_FILE_COMPLETION:
508 case LWS_CALLBACK_HTTP_WRITEABLE:
509 lwsl_info("LWS_CALLBACK_HTTP_WRITEABLE\n");
511 if (pss->client_finished)
517 #ifndef LWS_NO_CLIENT
518 if (pss->reason_bf & 2) {
519 char *px = buf + LWS_PRE;
520 int lenx = sizeof(buf) - LWS_PRE;
522 * our sink is writeable and our source has something
523 * to read. So read a lump of source material of
524 * suitable size to send or what's available, whichever
527 pss->reason_bf &= ~2;
528 wsi1 = lws_get_child(wsi);
531 if (lws_http_client_read(wsi1, &px, &lenx) < 0)
534 if (pss->client_finished)
540 * we can send more of whatever it is we were sending
544 /* we'd like the send this much */
545 n = sizeof(buffer) - LWS_PRE;
547 /* but if the peer told us he wants less, we can adapt */
548 m = lws_get_peer_write_allowance(wsi);
550 /* -1 means not using a protocol that has this info */
552 /* right now, peer can't handle anything */
555 if (m != -1 && m < n)
556 /* he couldn't handle that much */
559 n = lws_vfs_file_read(pss->fop_fd,
560 &amount, buffer + LWS_PRE, n);
561 /* problem reading, close conn */
563 lwsl_err("problem reading file\n");
567 /* sent it all, close conn */
571 * To support HTTP2, must take care about preamble space
573 * identification of when we send the last payload frame
574 * is handled by the library itself if you sent a
575 * content-length header
577 m = lws_write(wsi, buffer + LWS_PRE, n, LWS_WRITE_HTTP);
579 lwsl_err("write failed\n");
580 /* write failed, close conn */
583 if (m) /* while still active, extend timeout */
584 lws_set_timeout(wsi, PENDING_TIMEOUT_HTTP_CONTENT, 5);
587 } while (!lws_send_pipe_choked(wsi) && (sent < 1024 * 1024));
589 lws_callback_on_writable(wsi);
592 lws_vfs_file_close(&pss->fop_fd);
597 lws_vfs_file_close(&pss->fop_fd);
602 * callback for confirming to continue with client IP appear in
603 * protocol 0 callback since no websocket protocol has been agreed
604 * yet. You can just ignore this if you won't filter on client IP
605 * since the default unhandled callback return is 0 meaning let the
606 * connection continue.
608 case LWS_CALLBACK_FILTER_NETWORK_CONNECTION:
609 /* if we returned non-zero from here, we kill the connection */
612 #ifndef LWS_NO_CLIENT
613 case LWS_CALLBACK_ESTABLISHED_CLIENT_HTTP: {
614 char ctype[64], ctlen = 0;
615 lwsl_err("LWS_CALLBACK_ESTABLISHED_CLIENT_HTTP\n");
616 p = buffer + LWS_PRE;
617 end = p + sizeof(buffer) - LWS_PRE;
618 if (lws_add_http_header_status(lws_get_parent(wsi), HTTP_STATUS_OK, &p, end))
620 if (lws_add_http_header_by_token(lws_get_parent(wsi),
621 WSI_TOKEN_HTTP_SERVER,
622 (unsigned char *)"libwebsockets",
626 ctlen = lws_hdr_copy(wsi, ctype, sizeof(ctype), WSI_TOKEN_HTTP_CONTENT_TYPE);
628 if (lws_add_http_header_by_token(lws_get_parent(wsi),
629 WSI_TOKEN_HTTP_CONTENT_TYPE,
630 (unsigned char *)ctype, ctlen, &p, end))
634 if (lws_add_http_header_content_length(lws_get_parent(wsi),
638 if (lws_finalize_http_header(lws_get_parent(wsi), &p, end))
642 lwsl_info("%s\n", buffer + LWS_PRE);
644 n = lws_write(lws_get_parent(wsi), buffer + LWS_PRE,
645 p - (buffer + LWS_PRE),
646 LWS_WRITE_HTTP_HEADERS);
651 case LWS_CALLBACK_CLOSED_CLIENT_HTTP:
652 //lwsl_err("LWS_CALLBACK_CLOSED_CLIENT_HTTP\n");
655 case LWS_CALLBACK_RECEIVE_CLIENT_HTTP:
656 //lwsl_err("LWS_CALLBACK_RECEIVE_CLIENT_HTTP: wsi %p\n", wsi);
657 assert(lws_get_parent(wsi));
658 if (!lws_get_parent(wsi))
660 // lwsl_err("LWS_CALLBACK_RECEIVE_CLIENT_HTTP: wsi %p: sock: %d, parent_wsi: %p, parent_sock:%d, len %d\n",
661 // wsi, lws_get_socket_fd(wsi),
662 // lws_get_parent(wsi),
663 // lws_get_socket_fd(lws_get_parent(wsi)), len);
664 pss1 = lws_wsi_user(lws_get_parent(wsi));
665 pss1->reason_bf |= 2;
666 lws_callback_on_writable(lws_get_parent(wsi));
668 case LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ:
669 //lwsl_err("LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ len %d\n", len);
670 assert(lws_get_parent(wsi));
671 m = lws_write(lws_get_parent(wsi), (unsigned char *)in,
672 len, LWS_WRITE_HTTP);
676 case LWS_CALLBACK_COMPLETED_CLIENT_HTTP:
677 //lwsl_err("LWS_CALLBACK_COMPLETED_CLIENT_HTTP\n");
678 assert(lws_get_parent(wsi));
679 if (!lws_get_parent(wsi))
681 pss1 = lws_wsi_user(lws_get_parent(wsi));
682 pss1->client_finished = 1;
687 * callbacks for managing the external poll() array appear in
688 * protocol 0 callback
691 case LWS_CALLBACK_LOCK_POLL:
693 * lock mutex to protect pollfd state
694 * called before any other POLL related callback
695 * if protecting wsi lifecycle change, len == 1
697 test_server_lock(len);
700 case LWS_CALLBACK_UNLOCK_POLL:
702 * unlock mutex to protect pollfd state when
703 * called after any other POLL related callback
704 * if protecting wsi lifecycle change, len == 1
706 test_server_unlock(len);
710 case LWS_CALLBACK_ADD_POLL_FD:
712 if (count_pollfds >= max_poll_elements) {
713 lwsl_err("LWS_CALLBACK_ADD_POLL_FD: too many sockets to track\n");
717 fd_lookup[pa->fd] = count_pollfds;
718 pollfds[count_pollfds].fd = pa->fd;
719 pollfds[count_pollfds].events = pa->events;
720 pollfds[count_pollfds++].revents = 0;
723 case LWS_CALLBACK_DEL_POLL_FD:
724 if (!--count_pollfds)
726 m = fd_lookup[pa->fd];
727 /* have the last guy take up the vacant slot */
728 pollfds[m] = pollfds[count_pollfds];
729 fd_lookup[pollfds[count_pollfds].fd] = m;
732 case LWS_CALLBACK_CHANGE_MODE_POLL_FD:
733 pollfds[fd_lookup[pa->fd]].events = pa->events;
737 case LWS_CALLBACK_GET_THREAD_ID:
739 * if you will call "lws_callback_on_writable"
740 * from a different thread, return the caller thread ID
741 * here so lws can use this information to work out if it
742 * should signal the poll() loop to exit and restart early
745 /* return pthread_getthreadid_np(); */
749 #if defined(LWS_OPENSSL_SUPPORT)
750 case LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION:
751 /* Verify the client certificate */
752 if (!len || (SSL_get_verify_result((SSL*)in) != X509_V_OK)) {
753 int err = X509_STORE_CTX_get_error((X509_STORE_CTX*)user);
754 int depth = X509_STORE_CTX_get_error_depth((X509_STORE_CTX*)user);
755 const char* msg = X509_verify_cert_error_string(err);
756 lwsl_err("LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION: SSL error: %s (%d), depth: %d\n", msg, err, depth);
760 #if defined(LWS_HAVE_SSL_CTX_set1_param)
761 case LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS:
763 /* Enable CRL checking */
764 X509_VERIFY_PARAM *param = X509_VERIFY_PARAM_new();
765 X509_VERIFY_PARAM_set_flags(param, X509_V_FLAG_CRL_CHECK);
766 SSL_CTX_set1_param((SSL_CTX*)user, param);
767 X509_STORE *store = SSL_CTX_get_cert_store((SSL_CTX*)user);
768 X509_LOOKUP *lookup = X509_STORE_add_lookup(store, X509_LOOKUP_file());
769 n = X509_load_cert_crl_file(lookup, crl_path, X509_FILETYPE_PEM);
770 X509_VERIFY_PARAM_free(param);
774 lwsl_err("LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS: SSL error: %s (%d)\n", ERR_error_string(n, errbuf), n);
788 /* if we're on HTTP1.1 or 2.0, will keep the idle connection alive */
790 if (lws_http_transaction_completed(wsi))