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_USE_POLARSSL)
39 #if defined(LWS_USE_MBEDTLS)
41 #if defined(LWS_OPENSSL_SUPPORT) && defined(LWS_HAVE_SSL_CTX_set1_param)
42 /* location of the certificate revocation list */
43 extern char crl_path[1024];
48 extern int debug_level;
54 PROTOCOL_DUMB_INCREMENT,
62 * We take a strict whitelist approach to stop ../ attacks
70 * this is just an example of parsing handshake headers, you don't need this
71 * in your code unless you will filter allowing connections by the header
75 dump_handshake_info(struct lws *wsi)
79 const unsigned char *c;
82 c = lws_token_to_string(n);
88 len = lws_hdr_total_length(wsi, n);
89 if (!len || len > sizeof(buf) - 1) {
94 lws_hdr_copy(wsi, buf, sizeof buf, n);
95 buf[sizeof(buf) - 1] = '\0';
97 fprintf(stderr, " %s = %s\n", (char *)c, buf);
102 const char * get_mimetype(const char *file)
104 int n = strlen(file);
109 if (!strcmp(&file[n - 4], ".ico"))
110 return "image/x-icon";
112 if (!strcmp(&file[n - 4], ".png"))
115 if (!strcmp(&file[n - 5], ".html"))
118 if (!strcmp(&file[n - 4], ".css"))
124 /* this protocol server (always the first one) handles HTTP,
126 * Some misc callbacks that aren't associated with a protocol also turn up only
127 * here on the first protocol server.
130 int callback_http(struct lws *wsi, enum lws_callback_reasons reason, void *user,
131 void *in, size_t len)
133 struct per_session_data__http *pss =
134 (struct per_session_data__http *)user;
135 unsigned char buffer[4096 + LWS_PRE];
136 unsigned long amount, file_len, sent;
137 char leaf_path[1024];
138 const char *mimetype;
140 unsigned char *end, *start;
143 #ifndef LWS_NO_CLIENT
144 struct per_session_data__http *pss1;
151 struct lws_pollargs *pa = (struct lws_pollargs *)in;
156 case LWS_CALLBACK_HTTP:
158 lwsl_notice("lws_http_serve: %s\n",in);
160 if (debug_level & LLL_INFO) {
161 dump_handshake_info(wsi);
163 /* dump the individual URI Arg parameters */
165 while (lws_hdr_copy_fragment(wsi, buf, sizeof(buf),
166 WSI_TOKEN_HTTP_URI_ARGS, n) > 0) {
167 lwsl_notice("URI Arg %d: %s\n", ++n, buf);
172 char name[100], rip[50];
173 lws_get_peer_addresses(wsi, lws_get_socket_fd(wsi), name,
174 sizeof(name), rip, sizeof(rip));
175 sprintf(buf, "%s (%s)", name, rip);
176 lwsl_notice("HTTP connect from %s\n", buf);
180 lws_return_http_status(wsi,
181 HTTP_STATUS_BAD_REQUEST, NULL);
185 #ifndef LWS_NO_CLIENT
186 if (!strncmp(in, "/proxytest", 10)) {
187 struct lws_client_connect_info i;
188 char *rootpath = "/";
189 const char *p = (const char *)in;
191 if (lws_get_child(wsi))
194 pss->client_finished = 0;
195 memset(&i,0, sizeof(i));
196 i.context = lws_get_context(wsi);
197 i.address = "git.libwebsockets.org";
199 i.ssl_connection = 0;
201 i.path = (char *)in + 10;
204 i.host = "git.libwebsockets.org";
208 i.uri_replace_from = "git.libwebsockets.org/";
209 i.uri_replace_to = "/proxytest/";
210 if (!lws_client_connect_via_info(&i)) {
211 lwsl_err("proxy connect fail\n");
222 /* this example server has no concept of directories */
223 if (strchr((const char *)in + 1, '/')) {
224 lws_return_http_status(wsi, HTTP_STATUS_NOT_ACCEPTABLE, NULL);
229 if (!strncmp(in, "/postresults", 12)) {
230 m = sprintf(buf, "<html><body>Form results: '%s'<br>"
231 "</body></html>", pss->post_string);
233 p = buffer + LWS_PRE;
235 end = p + sizeof(buffer) - LWS_PRE;
237 if (lws_add_http_header_status(wsi, 200, &p, end))
239 if (lws_add_http_header_by_token(wsi,
240 WSI_TOKEN_HTTP_CONTENT_TYPE,
241 (unsigned char *)"text/html",
244 if (lws_add_http_header_content_length(wsi, m, &p,
247 if (lws_finalize_http_header(wsi, &p, end))
250 n = lws_write(wsi, start, p - start,
251 LWS_WRITE_HTTP_HEADERS);
255 n = lws_write(wsi, (unsigned char *)buf, m, LWS_WRITE_HTTP);
262 /* if a legal POST URL, let it continue and accept data */
263 if (lws_hdr_total_length(wsi, WSI_TOKEN_POST_URI))
266 /* check for the "send a big file by hand" example case */
268 if (!strcmp((const char *)in, "/leaf.jpg")) {
269 if (strlen(resource_path) > sizeof(leaf_path) - 10)
271 sprintf(leaf_path, "%s/leaf.jpg", resource_path);
273 /* well, let's demonstrate how to send the hard way */
275 p = buffer + LWS_PRE;
276 end = p + sizeof(buffer) - LWS_PRE;
278 pss->fd = lws_plat_file_open(wsi, leaf_path, &file_len,
281 if (pss->fd == LWS_INVALID_FILE) {
282 lwsl_err("faild to open file %s\n", leaf_path);
287 * we will send a big jpeg file, but it could be
288 * anything. Set the Content-Type: appropriately
289 * so the browser knows what to do with it.
291 * Notice we use the APIs to build the header, which
292 * will do the right thing for HTTP 1/1.1 and HTTP2
293 * depending on what connection it happens to be working
296 if (lws_add_http_header_status(wsi, 200, &p, end))
298 if (lws_add_http_header_by_token(wsi, WSI_TOKEN_HTTP_SERVER,
299 (unsigned char *)"libwebsockets",
302 if (lws_add_http_header_by_token(wsi,
303 WSI_TOKEN_HTTP_CONTENT_TYPE,
304 (unsigned char *)"image/jpeg",
307 if (lws_add_http_header_content_length(wsi,
311 if (lws_finalize_http_header(wsi, &p, end))
315 * send the http headers...
316 * this won't block since it's the first payload sent
317 * on the connection since it was established
318 * (too small for partial)
320 * Notice they are sent using LWS_WRITE_HTTP_HEADERS
321 * which also means you can't send body too in one step,
322 * this is mandated by changes in HTTP2
326 lwsl_info("%s\n", buffer + LWS_PRE);
328 n = lws_write(wsi, buffer + LWS_PRE,
329 p - (buffer + LWS_PRE),
330 LWS_WRITE_HTTP_HEADERS);
332 lws_plat_file_close(wsi, pss->fd);
336 * book us a LWS_CALLBACK_HTTP_WRITEABLE callback
338 lws_callback_on_writable(wsi);
342 /* if not, send a file the easy way */
343 if (!strncmp(in, "/cgit-data/", 11)) {
344 in = (char *)in + 11;
345 strcpy(buf, "/usr/share/cgit");
347 strcpy(buf, resource_path);
349 if (strcmp(in, "/")) {
350 if (*((const char *)in) != '/')
352 strncat(buf, in, sizeof(buf) - strlen(buf) - 1);
353 } else /* default file to serve */
354 strcat(buf, "/test.html");
355 buf[sizeof(buf) - 1] = '\0';
357 /* refuse to serve files we don't understand */
358 mimetype = get_mimetype(buf);
360 lwsl_err("Unknown mimetype for %s\n", buf);
361 lws_return_http_status(wsi,
362 HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE, NULL);
366 /* demonstrates how to set a cookie on / */
368 other_headers = leaf_path;
369 p = (unsigned char *)leaf_path;
370 if (!strcmp((const char *)in, "/") &&
371 !lws_hdr_total_length(wsi, WSI_TOKEN_HTTP_COOKIE)) {
372 /* this isn't very unguessable but it'll do for us */
373 gettimeofday(&tv, NULL);
374 n = sprintf(b64, "test=LWS_%u_%u_COOKIE;Max-Age=360000",
375 (unsigned int)tv.tv_sec,
376 (unsigned int)tv.tv_usec);
378 if (lws_add_http_header_by_name(wsi,
379 (unsigned char *)"set-cookie:",
380 (unsigned char *)b64, n, &p,
381 (unsigned char *)leaf_path + sizeof(leaf_path)))
384 if (lws_is_ssl(wsi) && lws_add_http_header_by_name(wsi,
386 "Strict-Transport-Security:",
388 "max-age=15768000 ; "
389 "includeSubDomains", 36, &p,
390 (unsigned char *)leaf_path +
393 n = (char *)p - leaf_path;
395 n = lws_serve_http_file(wsi, buf, mimetype, other_headers, n);
396 if (n < 0 || ((n > 0) && lws_http_transaction_completed(wsi)))
397 return -1; /* error or can't reuse connection: close the socket */
400 * notice that the sending of the file completes asynchronously,
401 * we'll get a LWS_CALLBACK_HTTP_FILE_COMPLETION callback when
406 case LWS_CALLBACK_HTTP_BODY:
407 lwsl_notice("LWS_CALLBACK_HTTP_BODY: len %d\n", (int)len);
408 strncpy(pss->post_string, in, sizeof (pss->post_string) -1);
409 pss->post_string[sizeof(pss->post_string) - 1] = '\0';
412 case LWS_CALLBACK_HTTP_BODY_COMPLETION:
413 lwsl_notice("LWS_CALLBACK_HTTP_BODY_COMPLETION\n");
415 * the whole of the sent body arrived,
416 * respond to the client with a redirect to show the
419 p = (unsigned char *)buf + LWS_PRE;
420 n = lws_http_redirect(wsi,
421 HTTP_STATUS_SEE_OTHER, /* 303 */
422 (unsigned char *)"/postresults", 12, /* location + len */
423 &p, /* temp buffer to use */
424 p + sizeof(buf) - 1 - LWS_PRE /* buffer len */
428 case LWS_CALLBACK_HTTP_FILE_COMPLETION:
431 case LWS_CALLBACK_HTTP_WRITEABLE:
432 lwsl_info("LWS_CALLBACK_HTTP_WRITEABLE\n");
434 if (pss->client_finished)
437 if (pss->fd == LWS_INVALID_FILE)
440 #ifndef LWS_NO_CLIENT
441 if (pss->reason_bf & 2) {
442 char *px = buf + LWS_PRE;
443 int lenx = sizeof(buf) - LWS_PRE;
445 * our sink is writeable and our source has something
446 * to read. So read a lump of source material of
447 * suitable size to send or what's available, whichever
450 pss->reason_bf &= ~2;
451 wsi1 = lws_get_child(wsi);
454 if (lws_http_client_read(wsi1, &px, &lenx) < 0)
457 if (pss->client_finished)
463 * we can send more of whatever it is we were sending
467 /* we'd like the send this much */
468 n = sizeof(buffer) - LWS_PRE;
470 /* but if the peer told us he wants less, we can adapt */
471 m = lws_get_peer_write_allowance(wsi);
473 /* -1 means not using a protocol that has this info */
475 /* right now, peer can't handle anything */
478 if (m != -1 && m < n)
479 /* he couldn't handle that much */
482 n = lws_plat_file_read(wsi, pss->fd,
483 &amount, buffer + LWS_PRE, n);
484 /* problem reading, close conn */
486 lwsl_err("problem reading file\n");
490 /* sent it all, close conn */
494 * To support HTTP2, must take care about preamble space
496 * identification of when we send the last payload frame
497 * is handled by the library itself if you sent a
498 * content-length header
500 m = lws_write(wsi, buffer + LWS_PRE, n, LWS_WRITE_HTTP);
502 lwsl_err("write failed\n");
503 /* write failed, close conn */
506 if (m) /* while still active, extend timeout */
507 lws_set_timeout(wsi, PENDING_TIMEOUT_HTTP_CONTENT, 5);
510 } while (!lws_send_pipe_choked(wsi) && (sent < 1024 * 1024));
512 lws_callback_on_writable(wsi);
515 lws_plat_file_close(wsi, pss->fd);
516 pss->fd = LWS_INVALID_FILE;
520 lws_plat_file_close(wsi, pss->fd);
525 * callback for confirming to continue with client IP appear in
526 * protocol 0 callback since no websocket protocol has been agreed
527 * yet. You can just ignore this if you won't filter on client IP
528 * since the default unhandled callback return is 0 meaning let the
529 * connection continue.
531 case LWS_CALLBACK_FILTER_NETWORK_CONNECTION:
532 /* if we returned non-zero from here, we kill the connection */
535 #ifndef LWS_NO_CLIENT
536 case LWS_CALLBACK_ESTABLISHED_CLIENT_HTTP: {
537 char ctype[64], ctlen = 0;
538 lwsl_err("LWS_CALLBACK_ESTABLISHED_CLIENT_HTTP\n");
539 p = buffer + LWS_PRE;
540 end = p + sizeof(buffer) - LWS_PRE;
541 if (lws_add_http_header_status(lws_get_parent(wsi), 200, &p, end))
543 if (lws_add_http_header_by_token(lws_get_parent(wsi),
544 WSI_TOKEN_HTTP_SERVER,
545 (unsigned char *)"libwebsockets",
549 ctlen = lws_hdr_copy(wsi, ctype, sizeof(ctype), WSI_TOKEN_HTTP_CONTENT_TYPE);
551 if (lws_add_http_header_by_token(lws_get_parent(wsi),
552 WSI_TOKEN_HTTP_CONTENT_TYPE,
553 (unsigned char *)ctype, ctlen, &p, end))
557 if (lws_add_http_header_content_length(lws_get_parent(wsi),
561 if (lws_finalize_http_header(lws_get_parent(wsi), &p, end))
565 lwsl_info("%s\n", buffer + LWS_PRE);
567 n = lws_write(lws_get_parent(wsi), buffer + LWS_PRE,
568 p - (buffer + LWS_PRE),
569 LWS_WRITE_HTTP_HEADERS);
574 case LWS_CALLBACK_CLOSED_CLIENT_HTTP:
575 //lwsl_err("LWS_CALLBACK_CLOSED_CLIENT_HTTP\n");
578 case LWS_CALLBACK_RECEIVE_CLIENT_HTTP:
579 //lwsl_err("LWS_CALLBACK_RECEIVE_CLIENT_HTTP: wsi %p\n", wsi);
580 assert(lws_get_parent(wsi));
581 if (!lws_get_parent(wsi))
583 // lwsl_err("LWS_CALLBACK_RECEIVE_CLIENT_HTTP: wsi %p: sock: %d, parent_wsi: %p, parent_sock:%d, len %d\n",
584 // wsi, lws_get_socket_fd(wsi),
585 // lws_get_parent(wsi),
586 // lws_get_socket_fd(lws_get_parent(wsi)), len);
587 pss1 = lws_wsi_user(lws_get_parent(wsi));
588 pss1->reason_bf |= 2;
589 lws_callback_on_writable(lws_get_parent(wsi));
591 case LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ:
592 //lwsl_err("LWS_CALLBACK_RECEIVE_CLIENT_HTTP_READ len %d\n", len);
593 assert(lws_get_parent(wsi));
594 m = lws_write(lws_get_parent(wsi), (unsigned char *)in,
595 len, LWS_WRITE_HTTP);
599 case LWS_CALLBACK_COMPLETED_CLIENT_HTTP:
600 //lwsl_err("LWS_CALLBACK_COMPLETED_CLIENT_HTTP\n");
601 assert(lws_get_parent(wsi));
602 if (!lws_get_parent(wsi))
604 pss1 = lws_wsi_user(lws_get_parent(wsi));
605 pss1->client_finished = 1;
610 * callbacks for managing the external poll() array appear in
611 * protocol 0 callback
614 case LWS_CALLBACK_LOCK_POLL:
616 * lock mutex to protect pollfd state
617 * called before any other POLL related callback
618 * if protecting wsi lifecycle change, len == 1
620 test_server_lock(len);
623 case LWS_CALLBACK_UNLOCK_POLL:
625 * unlock mutex to protect pollfd state when
626 * called after any other POLL related callback
627 * if protecting wsi lifecycle change, len == 1
629 test_server_unlock(len);
633 case LWS_CALLBACK_ADD_POLL_FD:
635 if (count_pollfds >= max_poll_elements) {
636 lwsl_err("LWS_CALLBACK_ADD_POLL_FD: too many sockets to track\n");
640 fd_lookup[pa->fd] = count_pollfds;
641 pollfds[count_pollfds].fd = pa->fd;
642 pollfds[count_pollfds].events = pa->events;
643 pollfds[count_pollfds++].revents = 0;
646 case LWS_CALLBACK_DEL_POLL_FD:
647 if (!--count_pollfds)
649 m = fd_lookup[pa->fd];
650 /* have the last guy take up the vacant slot */
651 pollfds[m] = pollfds[count_pollfds];
652 fd_lookup[pollfds[count_pollfds].fd] = m;
655 case LWS_CALLBACK_CHANGE_MODE_POLL_FD:
656 pollfds[fd_lookup[pa->fd]].events = pa->events;
660 case LWS_CALLBACK_GET_THREAD_ID:
662 * if you will call "lws_callback_on_writable"
663 * from a different thread, return the caller thread ID
664 * here so lws can use this information to work out if it
665 * should signal the poll() loop to exit and restart early
668 /* return pthread_getthreadid_np(); */
672 #if defined(LWS_USE_POLARSSL)
674 #if defined(LWS_USE_MBEDTLS)
676 #if defined(LWS_OPENSSL_SUPPORT)
677 case LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION:
678 /* Verify the client certificate */
679 if (!len || (SSL_get_verify_result((SSL*)in) != X509_V_OK)) {
680 int err = X509_STORE_CTX_get_error((X509_STORE_CTX*)user);
681 int depth = X509_STORE_CTX_get_error_depth((X509_STORE_CTX*)user);
682 const char* msg = X509_verify_cert_error_string(err);
683 lwsl_err("LWS_CALLBACK_OPENSSL_PERFORM_CLIENT_CERT_VERIFICATION: SSL error: %s (%d), depth: %d\n", msg, err, depth);
687 #if defined(LWS_HAVE_SSL_CTX_set1_param)
688 case LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS:
690 /* Enable CRL checking */
691 X509_VERIFY_PARAM *param = X509_VERIFY_PARAM_new();
692 X509_VERIFY_PARAM_set_flags(param, X509_V_FLAG_CRL_CHECK);
693 SSL_CTX_set1_param((SSL_CTX*)user, param);
694 X509_STORE *store = SSL_CTX_get_cert_store((SSL_CTX*)user);
695 X509_LOOKUP *lookup = X509_STORE_add_lookup(store, X509_LOOKUP_file());
696 n = X509_load_cert_crl_file(lookup, crl_path, X509_FILETYPE_PEM);
697 X509_VERIFY_PARAM_free(param);
701 lwsl_err("LWS_CALLBACK_OPENSSL_LOAD_EXTRA_SERVER_VERIFY_CERTS: SSL error: %s (%d)\n", ERR_error_string(n, errbuf), n);
717 /* if we're on HTTP1.1 or 2.0, will keep the idle connection alive */
719 if (lws_http_transaction_completed(wsi))