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
21 #include "test-server.h"
24 int max_poll_elements;
28 struct lws_pollfd *pollfds;
32 volatile int force_exit = 0;
33 struct lws_context *context;
34 struct lws_plat_file_ops fops_plat;
36 /* http server gets files from this path */
37 #define LOCAL_RESOURCE_PATH INSTALL_DATADIR"/libwebsockets-test-server"
38 char *resource_path = LOCAL_RESOURCE_PATH;
39 #if defined(LWS_OPENSSL_SUPPORT) && defined(LWS_HAVE_SSL_CTX_set1_param)
40 char crl_path[1024] = "";
44 * This demonstrates how to use the clean protocol service separation of
45 * plugins, but with static inclusion instead of runtime dynamic loading
46 * (which requires libuv).
48 * dumb-increment doesn't use the plugin, both to demonstrate how to
49 * do the protocols directly, and because it wants libuv for a timer.
51 * Please consider using test-server-v2.0.c instead of this: it has the
52 * same functionality but
54 * 1) uses lws built-in http handling so you don't need to deal with it in
57 * 2) Links with libuv and uses the plugins at runtime
59 * 3) Uses advanced lws features like mounts to bind parts of the filesystem
60 * to the served URL space
62 * Another option is lwsws, this operates like test-server-v2,0.c but is
63 * configured using JSON, do you do not need to provide any code for the
64 * serving action at all, just implement your protocols in plugins.
67 #define LWS_PLUGIN_STATIC
68 #include "../plugins/protocol_lws_mirror.c"
69 #include "../plugins/protocol_lws_status.c"
71 /* singlethreaded version --> no locks */
73 void test_server_lock(int care)
76 void test_server_unlock(int care)
81 * This demo server shows how to use libwebsockets for one or more
82 * websocket protocols in the same server
84 * It defines the following websocket protocols:
86 * dumb-increment-protocol: once the socket is opened, an incrementing
87 * ascii string is sent down it every 50ms.
88 * If you send "reset\n" on the websocket, then
89 * the incrementing number is reset to 0.
91 * lws-mirror-protocol: copies any received packet to every connection also
92 * using this protocol, including the sender
94 * lws-status: informs connected browsers of who else is
102 PROTOCOL_DUMB_INCREMENT,
110 /* list of supported protocols and callbacks */
112 static struct lws_protocols protocols[] = {
113 /* first protocol must always be HTTP handler */
116 "http-only", /* name */
117 callback_http, /* callback */
118 sizeof (struct per_session_data__http), /* per_session_data_size */
119 0, /* max frame size / rx buffer */
122 "dumb-increment-protocol",
123 callback_dumb_increment,
124 sizeof(struct per_session_data__dumb_increment),
125 10, /* rx buf size must be >= permessage-deflate rx size
126 * dumb-increment only sends very small packets, so we set
127 * this accordingly. If your protocol will send bigger
128 * things, adjust this to match */
130 LWS_PLUGIN_PROTOCOL_MIRROR,
131 LWS_PLUGIN_PROTOCOL_LWS_STATUS,
132 { NULL, NULL, 0, 0 } /* terminator */
136 /* this shows how to override the lws file operations. You don't need
137 * to do any of this unless you have a reason (eg, want to serve
138 * compressed files without decompressing the whole archive)
141 test_server_fops_open(const struct lws_plat_file_ops *fops,
142 const char *vfs_path, const char *vpath,
143 lws_fop_flags_t *flags)
147 /* call through to original platform implementation */
148 fop_fd = fops_plat.open(fops, vfs_path, vpath, flags);
151 lwsl_info("%s: opening %s, ret %p, len %lu\n", __func__,
153 (long)lws_vfs_get_length(fop_fd));
155 lwsl_info("%s: open %s failed\n", __func__, vfs_path);
160 void sighandler(int sig)
163 lws_cancel_service(context);
166 static const struct lws_extension exts[] = {
168 "permessage-deflate",
169 lws_extension_callback_pm_deflate,
174 lws_extension_callback_pm_deflate,
177 { NULL, NULL, NULL /* terminator */ }
182 static struct option options[] = {
183 { "help", no_argument, NULL, 'h' },
184 { "debug", required_argument, NULL, 'd' },
185 { "port", required_argument, NULL, 'p' },
186 { "ssl", no_argument, NULL, 's' },
187 { "allow-non-ssl", no_argument, NULL, 'a' },
188 { "interface", required_argument, NULL, 'i' },
189 { "closetest", no_argument, NULL, 'c' },
190 { "ssl-cert", required_argument, NULL, 'C' },
191 { "ssl-key", required_argument, NULL, 'K' },
192 { "ssl-ca", required_argument, NULL, 'A' },
193 #if defined(LWS_OPENSSL_SUPPORT)
194 { "ssl-verify-client", no_argument, NULL, 'v' },
195 #if defined(LWS_HAVE_SSL_CTX_set1_param)
196 { "ssl-crl", required_argument, NULL, 'R' },
199 { "libev", no_argument, NULL, 'e' },
200 #ifndef LWS_NO_DAEMONIZE
201 { "daemonize", no_argument, NULL, 'D' },
203 { "resource_path", required_argument, NULL, 'r' },
204 { "pingpong-secs", required_argument, NULL, 'P' },
208 int main(int argc, char **argv)
210 struct lws_context_creation_info info;
211 struct lws_vhost *vhost;
212 char interface_name[128] = "";
213 unsigned int ms, oldms = 0;
214 const char *iface = NULL;
215 char cert_path[1024] = "";
216 char key_path[1024] = "";
217 char ca_path[1024] = "";
218 int uid = -1, gid = -1;
224 /* LOG_PERROR is not POSIX standard, and may not be portable */
226 int syslog_options = LOG_PID;
228 int syslog_options = LOG_PID | LOG_PERROR;
231 #ifndef LWS_NO_DAEMONIZE
236 * take care to zero down the info struct, he contains random garbaage
237 * from the stack otherwise
239 memset(&info, 0, sizeof info);
243 n = getopt_long(argc, argv, "eci:hsap:d:Dr:C:K:A:R:vu:g:P:k", options, NULL);
248 opts |= LWS_SERVER_OPTION_LIBEV;
250 #ifndef LWS_NO_DAEMONIZE
253 #if !defined(_WIN32) && !defined(__sun)
254 syslog_options &= ~LOG_PERROR;
265 debug_level = atoi(optarg);
271 opts |= LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT;
274 info.port = atoi(optarg);
277 strncpy(interface_name, optarg, sizeof interface_name);
278 interface_name[(sizeof interface_name) - 1] = '\0';
279 iface = interface_name;
283 #if defined(LWS_HAVE_SYS_CAPABILITY_H) && defined(LWS_HAVE_LIBCAP)
284 info.caps[0] = CAP_NET_RAW;
290 fprintf(stderr, " Close testing mode -- closes on "
291 "client after 50 dumb increments"
292 "and suppresses lws_mirror spam\n");
295 resource_path = optarg;
296 printf("Setting resource path to \"%s\"\n", resource_path);
299 strncpy(cert_path, optarg, sizeof(cert_path) - 1);
300 cert_path[sizeof(cert_path) - 1] = '\0';
303 strncpy(key_path, optarg, sizeof(key_path) - 1);
304 key_path[sizeof(key_path) - 1] = '\0';
307 strncpy(ca_path, optarg, sizeof(ca_path) - 1);
308 ca_path[sizeof(ca_path) - 1] = '\0';
311 pp_secs = atoi(optarg);
312 lwsl_notice("Setting pingpong interval to %d\n", pp_secs);
314 #if defined(LWS_OPENSSL_SUPPORT)
317 opts |= LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT;
320 #if defined(LWS_HAVE_SSL_CTX_set1_param)
322 strncpy(crl_path, optarg, sizeof(crl_path) - 1);
323 crl_path[sizeof(crl_path) - 1] = '\0';
328 fprintf(stderr, "Usage: test-server "
329 "[--port=<p>] [--ssl] "
330 "[-d <log bitfield>] "
331 "[--resource_path <path>]\n");
336 #if !defined(LWS_NO_DAEMONIZE) && !defined(WIN32)
338 * normally lock path would be /var/lock/lwsts or similar, to
339 * simplify getting started without having to take care about
340 * permissions or running as root, set to /tmp/.lwsts-lock
342 if (daemonize && lws_daemonize("/tmp/.lwsts-lock")) {
343 fprintf(stderr, "Failed to daemonize\n");
348 signal(SIGINT, sighandler);
351 /* we will only try to log things according to our debug_level */
352 setlogmask(LOG_UPTO (LOG_DEBUG));
353 openlog("lwsts", syslog_options, LOG_DAEMON);
356 /* tell the library what debug level to emit and to send it to syslog */
357 lws_set_log_level(debug_level, lwsl_emit_syslog);
359 lwsl_notice("libwebsockets test server - license LGPL2.1+SLE\n");
360 lwsl_notice("(C) Copyright 2010-2016 Andy Green <andy@warmcat.com>\n");
362 printf("Using resource path \"%s\"\n", resource_path);
364 max_poll_elements = getdtablesize();
365 pollfds = malloc(max_poll_elements * sizeof (struct lws_pollfd));
366 fd_lookup = malloc(max_poll_elements * sizeof (int));
367 if (pollfds == NULL || fd_lookup == NULL) {
368 lwsl_err("Out of memory pollfds=%d\n", max_poll_elements);
374 info.protocols = protocols;
375 info.ssl_cert_filepath = NULL;
376 info.ssl_private_key_filepath = NULL;
377 info.ws_ping_pong_interval = pp_secs;
380 if (strlen(resource_path) > sizeof(cert_path) - 32) {
381 lwsl_err("resource path too long\n");
385 sprintf(cert_path, "%s/libwebsockets-test-server.pem",
387 if (strlen(resource_path) > sizeof(key_path) - 32) {
388 lwsl_err("resource path too long\n");
392 sprintf(key_path, "%s/libwebsockets-test-server.key.pem",
395 info.ssl_cert_filepath = cert_path;
396 info.ssl_private_key_filepath = key_path;
398 info.ssl_ca_filepath = ca_path;
402 info.max_http_header_pool = 16;
403 info.options = opts | LWS_SERVER_OPTION_VALIDATE_UTF8 | LWS_SERVER_OPTION_EXPLICIT_VHOSTS | LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT;
404 info.extensions = exts;
405 info.timeout_secs = 5;
406 info.ssl_cipher_list = "ECDHE-ECDSA-AES256-GCM-SHA384:"
407 "ECDHE-RSA-AES256-GCM-SHA384:"
408 "DHE-RSA-AES256-GCM-SHA384:"
409 "ECDHE-RSA-AES256-SHA384:"
410 "HIGH:!aNULL:!eNULL:!EXPORT:"
411 "!DES:!MD5:!PSK:!RC4:!HMAC_SHA1:"
412 "!SHA1:!DHE-RSA-AES128-GCM-SHA256:"
413 "!DHE-RSA-AES128-SHA256:"
414 "!AES128-GCM-SHA256:"
416 "!DHE-RSA-AES256-SHA256:"
417 "!AES256-GCM-SHA384:"
421 /* redirect guys coming on http */
422 info.options |= LWS_SERVER_OPTION_REDIRECT_HTTP_TO_HTTPS;
424 context = lws_create_context(&info);
425 if (context == NULL) {
426 lwsl_err("libwebsocket init failed\n");
430 vhost = lws_create_vhost(context, &info);
432 lwsl_err("vhost creation failed\n");
436 #if !defined(LWS_NO_CLIENT) && defined(LWS_OPENSSL_SUPPORT)
437 lws_init_vhost_client_ssl(&info, vhost);
440 /* this shows how to override the lws file operations. You don't need
441 * to do any of this unless you have a reason (eg, want to serve
442 * compressed files without decompressing the whole archive)
444 /* stash original platform fops */
445 fops_plat = *(lws_get_fops(context));
446 /* override the active fops */
447 lws_get_fops(context)->open = test_server_fops_open;
453 while (n >= 0 && !force_exit) {
456 gettimeofday(&tv, NULL);
459 * This provokes the LWS_CALLBACK_SERVER_WRITEABLE for every
460 * live websocket connection using the DUMB_INCREMENT protocol,
461 * as soon as it can take more packets (usually immediately)
464 ms = (tv.tv_sec * 1000) + (tv.tv_usec / 1000);
465 if ((ms - oldms) > 50) {
466 lws_callback_on_writable_all_protocol(context,
467 &protocols[PROTOCOL_DUMB_INCREMENT]);
473 * this represents an existing server's single poll action
474 * which also includes libwebsocket sockets
477 n = poll(pollfds, count_pollfds, 50);
482 for (n = 0; n < count_pollfds; n++)
483 if (pollfds[n].revents)
485 * returns immediately if the fd does not
486 * match anything under libwebsockets
489 if (lws_service_fd(context,
493 /* if needed, force-service wsis that may not have read all input */
494 while (!lws_service_adjust_timeout(context, 1, 0)) {
495 lwsl_notice("extpoll doing forced service!\n");
496 lws_service_tsi(context, -1, 0);
499 /* no revents, but before polling again, make lws check for any timeouts */
500 if (ms - ms_1sec > 1000) {
501 lwsl_notice("1 per sec\n");
502 lws_service_fd(context, NULL);
508 * If libwebsockets sockets are all we care about,
509 * you can use this api which takes care of the poll()
510 * and looping through finding who needed service.
512 * If no socket needs service, it'll return anyway after
513 * the number of ms in the second argument.
516 n = lws_service(context, 50);
524 lws_context_destroy(context);
526 lwsl_notice("libwebsockets-test-server exited cleanly\n");