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] = "";
43 /* singlethreaded version --> no locks */
45 void test_server_lock(int care)
48 void test_server_unlock(int care)
53 * This demo server shows how to use libwebsockets for one or more
54 * websocket protocols in the same server
56 * It defines the following websocket protocols:
58 * dumb-increment-protocol: once the socket is opened, an incrementing
59 * ascii string is sent down it every 50ms.
60 * If you send "reset\n" on the websocket, then
61 * the incrementing number is reset to 0.
63 * lws-mirror-protocol: copies any received packet to every connection also
64 * using this protocol, including the sender
71 PROTOCOL_DUMB_INCREMENT,
80 /* list of supported protocols and callbacks */
82 static struct lws_protocols protocols[] = {
83 /* first protocol must always be HTTP handler */
86 "http-only", /* name */
87 callback_http, /* callback */
88 sizeof (struct per_session_data__http), /* per_session_data_size */
89 0, /* max frame size / rx buffer */
92 "dumb-increment-protocol",
93 callback_dumb_increment,
94 sizeof(struct per_session_data__dumb_increment),
95 10, /* rx buf size must be >= permessage-deflate rx size */
98 "lws-mirror-protocol",
100 sizeof(struct per_session_data__lws_mirror),
101 128, /* rx buf size must be >= permessage-deflate rx size */
105 callback_lws_echogen,
106 sizeof(struct per_session_data__echogen),
107 128, /* rx buf size must be >= permessage-deflate rx size */
112 sizeof(struct per_session_data__lws_status),
113 128, /* rx buf size must be >= permessage-deflate rx size */
115 { NULL, NULL, 0, 0 } /* terminator */
119 /* this shows how to override the lws file operations. You don't need
120 * to do any of this unless you have a reason (eg, want to serve
121 * compressed files without decompressing the whole archive)
124 test_server_fops_open(const struct lws_plat_file_ops *fops,
125 const char *vfs_path, const char *vpath,
126 lws_fop_flags_t *flags)
130 /* call through to original platform implementation */
131 fop_fd = fops_plat.open(fops, vfs_path, vpath, flags);
134 lwsl_info("%s: opening %s, ret %p, len %lu\n", __func__,
136 (long)lws_vfs_get_length(fop_fd));
138 lwsl_info("%s: open %s failed\n", __func__, vfs_path);
143 void sighandler(int sig)
146 lws_cancel_service(context);
149 static const struct lws_extension exts[] = {
151 "permessage-deflate",
152 lws_extension_callback_pm_deflate,
157 lws_extension_callback_pm_deflate,
160 { NULL, NULL, NULL /* terminator */ }
165 static struct option options[] = {
166 { "help", no_argument, NULL, 'h' },
167 { "debug", required_argument, NULL, 'd' },
168 { "port", required_argument, NULL, 'p' },
169 { "ssl", no_argument, NULL, 's' },
170 { "allow-non-ssl", no_argument, NULL, 'a' },
171 { "interface", required_argument, NULL, 'i' },
172 { "closetest", no_argument, NULL, 'c' },
173 { "ssl-cert", required_argument, NULL, 'C' },
174 { "ssl-key", required_argument, NULL, 'K' },
175 { "ssl-ca", required_argument, NULL, 'A' },
176 #if defined(LWS_OPENSSL_SUPPORT)
177 { "ssl-verify-client", no_argument, NULL, 'v' },
178 #if defined(LWS_HAVE_SSL_CTX_set1_param)
179 { "ssl-crl", required_argument, NULL, 'R' },
182 { "libev", no_argument, NULL, 'e' },
183 #ifndef LWS_NO_DAEMONIZE
184 { "daemonize", no_argument, NULL, 'D' },
186 { "resource_path", required_argument, NULL, 'r' },
187 { "pingpong-secs", required_argument, NULL, 'P' },
191 int main(int argc, char **argv)
193 struct lws_context_creation_info info;
194 struct lws_vhost *vhost;
195 char interface_name[128] = "";
196 unsigned int ms, oldms = 0;
197 const char *iface = NULL;
198 char cert_path[1024] = "";
199 char key_path[1024] = "";
200 char ca_path[1024] = "";
201 int uid = -1, gid = -1;
207 /* LOG_PERROR is not POSIX standard, and may not be portable */
209 int syslog_options = LOG_PID;
211 int syslog_options = LOG_PID | LOG_PERROR;
214 #ifndef LWS_NO_DAEMONIZE
219 * take care to zero down the info struct, he contains random garbaage
220 * from the stack otherwise
222 memset(&info, 0, sizeof info);
226 n = getopt_long(argc, argv, "eci:hsap:d:Dr:C:K:A:R:vu:g:P:k", options, NULL);
231 opts |= LWS_SERVER_OPTION_LIBEV;
233 #ifndef LWS_NO_DAEMONIZE
236 #if !defined(_WIN32) && !defined(__sun)
237 syslog_options &= ~LOG_PERROR;
248 debug_level = atoi(optarg);
254 opts |= LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT;
257 info.port = atoi(optarg);
260 strncpy(interface_name, optarg, sizeof interface_name);
261 interface_name[(sizeof interface_name) - 1] = '\0';
262 iface = interface_name;
266 #if defined(LWS_HAVE_SYS_CAPABILITY_H) && defined(LWS_HAVE_LIBCAP)
267 info.caps[0] = CAP_NET_RAW;
273 fprintf(stderr, " Close testing mode -- closes on "
274 "client after 50 dumb increments"
275 "and suppresses lws_mirror spam\n");
278 resource_path = optarg;
279 printf("Setting resource path to \"%s\"\n", resource_path);
282 strncpy(cert_path, optarg, sizeof(cert_path) - 1);
283 cert_path[sizeof(cert_path) - 1] = '\0';
286 strncpy(key_path, optarg, sizeof(key_path) - 1);
287 key_path[sizeof(key_path) - 1] = '\0';
290 strncpy(ca_path, optarg, sizeof(ca_path) - 1);
291 ca_path[sizeof(ca_path) - 1] = '\0';
294 pp_secs = atoi(optarg);
295 lwsl_notice("Setting pingpong interval to %d\n", pp_secs);
297 #if defined(LWS_OPENSSL_SUPPORT)
300 opts |= LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT;
303 #if defined(LWS_HAVE_SSL_CTX_set1_param)
305 strncpy(crl_path, optarg, sizeof(crl_path) - 1);
306 crl_path[sizeof(crl_path) - 1] = '\0';
311 fprintf(stderr, "Usage: test-server "
312 "[--port=<p>] [--ssl] "
313 "[-d <log bitfield>] "
314 "[--resource_path <path>]\n");
319 #if !defined(LWS_NO_DAEMONIZE) && !defined(WIN32)
321 * normally lock path would be /var/lock/lwsts or similar, to
322 * simplify getting started without having to take care about
323 * permissions or running as root, set to /tmp/.lwsts-lock
325 if (daemonize && lws_daemonize("/tmp/.lwsts-lock")) {
326 fprintf(stderr, "Failed to daemonize\n");
331 signal(SIGINT, sighandler);
334 /* we will only try to log things according to our debug_level */
335 setlogmask(LOG_UPTO (LOG_DEBUG));
336 openlog("lwsts", syslog_options, LOG_DAEMON);
339 /* tell the library what debug level to emit and to send it to syslog */
340 lws_set_log_level(debug_level, lwsl_emit_syslog);
342 lwsl_notice("libwebsockets test server - license LGPL2.1+SLE\n");
343 lwsl_notice("(C) Copyright 2010-2016 Andy Green <andy@warmcat.com>\n");
345 printf("Using resource path \"%s\"\n", resource_path);
347 max_poll_elements = getdtablesize();
348 pollfds = malloc(max_poll_elements * sizeof (struct lws_pollfd));
349 fd_lookup = malloc(max_poll_elements * sizeof (int));
350 if (pollfds == NULL || fd_lookup == NULL) {
351 lwsl_err("Out of memory pollfds=%d\n", max_poll_elements);
357 info.protocols = protocols;
358 info.ssl_cert_filepath = NULL;
359 info.ssl_private_key_filepath = NULL;
360 info.ws_ping_pong_interval = pp_secs;
363 if (strlen(resource_path) > sizeof(cert_path) - 32) {
364 lwsl_err("resource path too long\n");
368 sprintf(cert_path, "%s/libwebsockets-test-server.pem",
370 if (strlen(resource_path) > sizeof(key_path) - 32) {
371 lwsl_err("resource path too long\n");
375 sprintf(key_path, "%s/libwebsockets-test-server.key.pem",
378 info.ssl_cert_filepath = cert_path;
379 info.ssl_private_key_filepath = key_path;
381 info.ssl_ca_filepath = ca_path;
385 info.max_http_header_pool = 16;
386 info.options = opts | LWS_SERVER_OPTION_VALIDATE_UTF8 | LWS_SERVER_OPTION_EXPLICIT_VHOSTS | LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT;
387 info.extensions = exts;
388 info.timeout_secs = 5;
389 info.ssl_cipher_list = "ECDHE-ECDSA-AES256-GCM-SHA384:"
390 "ECDHE-RSA-AES256-GCM-SHA384:"
391 "DHE-RSA-AES256-GCM-SHA384:"
392 "ECDHE-RSA-AES256-SHA384:"
393 "HIGH:!aNULL:!eNULL:!EXPORT:"
394 "!DES:!MD5:!PSK:!RC4:!HMAC_SHA1:"
395 "!SHA1:!DHE-RSA-AES128-GCM-SHA256:"
396 "!DHE-RSA-AES128-SHA256:"
397 "!AES128-GCM-SHA256:"
399 "!DHE-RSA-AES256-SHA256:"
400 "!AES256-GCM-SHA384:"
404 /* redirect guys coming on http */
405 info.options |= LWS_SERVER_OPTION_REDIRECT_HTTP_TO_HTTPS;
407 context = lws_create_context(&info);
408 if (context == NULL) {
409 lwsl_err("libwebsocket init failed\n");
413 vhost = lws_create_vhost(context, &info);
415 lwsl_err("vhost creation failed\n");
419 #if !defined(LWS_NO_CLIENT) && defined(LWS_OPENSSL_SUPPORT)
420 lws_init_vhost_client_ssl(&info, vhost);
423 /* this shows how to override the lws file operations. You don't need
424 * to do any of this unless you have a reason (eg, want to serve
425 * compressed files without decompressing the whole archive)
427 /* stash original platform fops */
428 fops_plat = *(lws_get_fops(context));
429 /* override the active fops */
430 lws_get_fops(context)->open = test_server_fops_open;
436 while (n >= 0 && !force_exit) {
439 gettimeofday(&tv, NULL);
442 * This provokes the LWS_CALLBACK_SERVER_WRITEABLE for every
443 * live websocket connection using the DUMB_INCREMENT protocol,
444 * as soon as it can take more packets (usually immediately)
447 ms = (tv.tv_sec * 1000) + (tv.tv_usec / 1000);
448 if ((ms - oldms) > 50) {
449 lws_callback_on_writable_all_protocol(context,
450 &protocols[PROTOCOL_DUMB_INCREMENT]);
456 * this represents an existing server's single poll action
457 * which also includes libwebsocket sockets
460 n = poll(pollfds, count_pollfds, 50);
465 for (n = 0; n < count_pollfds; n++)
466 if (pollfds[n].revents)
468 * returns immediately if the fd does not
469 * match anything under libwebsockets
472 if (lws_service_fd(context,
476 /* if needed, force-service wsis that may not have read all input */
477 while (!lws_service_adjust_timeout(context, 1, 0)) {
478 lwsl_notice("extpoll doing forced service!\n");
479 lws_service_tsi(context, -1, 0);
482 /* no revents, but before polling again, make lws check for any timeouts */
483 if (ms - ms_1sec > 1000) {
484 lwsl_notice("1 per sec\n");
485 lws_service_fd(context, NULL);
491 * If libwebsockets sockets are all we care about,
492 * you can use this api which takes care of the poll()
493 * and looping through finding who needed service.
495 * If no socket needs service, it'll return anyway after
496 * the number of ms in the second argument.
499 n = lws_service(context, 50);
507 lws_context_destroy(context);
509 lwsl_notice("libwebsockets-test-server exited cleanly\n");