test-server/test-server.c

   1 /*
   2  * libwebsockets-test-server - libwebsockets test implementation
   3  *
   4  * Copyright (C) 2010-2016 Andy Green <andy@warmcat.com>
   5  *
   6  * This file is made available under the Creative Commons CC0 1.0
   7  * Universal Public Domain Dedication.
   8  *
   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.
  15  *
  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
  18  * Public Domain.
  19  */
  20
  21 #include "test-server.h"
  22
  23 int close_testing;
  24 int max_poll_elements;
  25 int debug_level = 7;
  26
  27 #ifdef EXTERNAL_POLL
  28 struct lws_pollfd *pollfds;
  29 int *fd_lookup;
  30 int count_pollfds;
  31 #endif
  32 volatile int force_exit = 0;
  33 struct lws_context *context;
  34 struct lws_plat_file_ops fops_plat;
  35
  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] = "";
  41 #endif
  42
  43 /*
  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).
  47  *
  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.
  50  *
  51  * Please consider using test-server-v2.0.c instead of this: it has the
  52  * same functionality but
  53  *
  54  * 1) uses lws built-in http handling so you don't need to deal with it in
  55  * your callback
  56  *
  57  * 2) Links with libuv and uses the plugins at runtime
  58  *
  59  * 3) Uses advanced lws features like mounts to bind parts of the filesystem
  60  * to the served URL space
  61  *
  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.
  65  */
  66
  67 #define LWS_PLUGIN_STATIC
  68 #include "../plugins/protocol_lws_mirror.c"
  69 #include "../plugins/protocol_lws_status.c"
  70
  71 /* singlethreaded version --> no locks */
  72
  73 void test_server_lock(int care)
  74 {
  75 }
  76 void test_server_unlock(int care)
  77 {
  78 }
  79
  80 /*
  81  * This demo server shows how to use libwebsockets for one or more
  82  * websocket protocols in the same server
  83  *
  84  * It defines the following websocket protocols:
  85  *
  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.
  90  *
  91  *  lws-mirror-protocol: copies any received packet to every connection also
  92  *                              using this protocol, including the sender
  93  *
  94  *  lws-status:                 informs connected browsers of who else is
  95  *                              connected.
  96  */
  97
  98 enum demo_protocols {
  99         /* always first */
 100         PROTOCOL_HTTP = 0,
 101
 102         PROTOCOL_DUMB_INCREMENT,
 103         PROTOCOL_LWS_MIRROR,
 104         PROTOCOL_LWS_STATUS,
 105
 106         /* always last */
 107         DEMO_PROTOCOL_COUNT
 108 };
 109
 110 /* list of supported protocols and callbacks */
 111
 112 static struct lws_protocols protocols[] = {
 113         /* first protocol must always be HTTP handler */
 114
 115         {
 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 */
 120         },
 121         {
 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 */
 129         },
 130         LWS_PLUGIN_PROTOCOL_MIRROR,
 131         LWS_PLUGIN_PROTOCOL_LWS_STATUS,
 132         { NULL, NULL, 0, 0 } /* terminator */
 133 };
 134
 135
 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)
 139  */
 140 static lws_fop_fd_t
 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)
 144 {
 145         lws_fop_fd_t fop_fd;
 146
 147         /* call through to original platform implementation */
 148         fop_fd = fops_plat.open(fops, vfs_path, vpath, flags);
 149
 150         if (fop_fd)
 151                 lwsl_info("%s: opening %s, ret %p, len %lu\n", __func__,
 152                                 vfs_path, fop_fd,
 153                                 (long)lws_vfs_get_length(fop_fd));
 154         else
 155                 lwsl_info("%s: open %s failed\n", __func__, vfs_path);
 156
 157         return fop_fd;
 158 }
 159
 160 void sighandler(int sig)
 161 {
 162         force_exit = 1;
 163         lws_cancel_service(context);
 164 }
 165
 166 static const struct lws_extension exts[] = {
 167         {
 168                 "permessage-deflate",
 169                 lws_extension_callback_pm_deflate,
 170                 "permessage-deflate"
 171         },
 172         {
 173                 "deflate-frame",
 174                 lws_extension_callback_pm_deflate,
 175                 "deflate_frame"
 176         },
 177         { NULL, NULL, NULL /* terminator */ }
 178 };
 179
 180
 181
 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' },
 197 #endif
 198 #endif
 199         { "libev",  no_argument,                NULL, 'e' },
 200 #ifndef LWS_NO_DAEMONIZE
 201         { "daemonize",  no_argument,            NULL, 'D' },
 202 #endif
 203         { "resource_path", required_argument,   NULL, 'r' },
 204         { "pingpong-secs", required_argument,   NULL, 'P' },
 205         { NULL, 0, 0, 0 }
 206 };
 207
 208 int main(int argc, char **argv)
 209 {
 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;
 219         int use_ssl = 0;
 220         int pp_secs = 0;
 221         int opts = 0;
 222         int n = 0;
 223 #ifndef _WIN32
 224 /* LOG_PERROR is not POSIX standard, and may not be portable */
 225 #ifdef __sun
 226         int syslog_options = LOG_PID;
 227 #else
 228         int syslog_options = LOG_PID | LOG_PERROR;
 229 #endif
 230 #endif
 231 #ifndef LWS_NO_DAEMONIZE
 232         int daemonize = 0;
 233 #endif
 234
 235         /*
 236          * take care to zero down the info struct, he contains random garbaage
 237          * from the stack otherwise
 238          */
 239         memset(&info, 0, sizeof info);
 240         info.port = 7681;
 241
 242         while (n >= 0) {
 243                 n = getopt_long(argc, argv, "eci:hsap:d:Dr:C:K:A:R:vu:g:P:k", options, NULL);
 244                 if (n < 0)
 245                         continue;
 246                 switch (n) {
 247                 case 'e':
 248                         opts |= LWS_SERVER_OPTION_LIBEV;
 249                         break;
 250 #ifndef LWS_NO_DAEMONIZE
 251                 case 'D':
 252                         daemonize = 1;
 253                         #if !defined(_WIN32) && !defined(__sun)
 254                         syslog_options &= ~LOG_PERROR;
 255                         #endif
 256                         break;
 257 #endif
 258                 case 'u':
 259                         uid = atoi(optarg);
 260                         break;
 261                 case 'g':
 262                         gid = atoi(optarg);
 263                         break;
 264                 case 'd':
 265                         debug_level = atoi(optarg);
 266                         break;
 267                 case 's':
 268                         use_ssl = 1;
 269                         break;
 270                 case 'a':
 271                         opts |= LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT;
 272                         break;
 273                 case 'p':
 274                         info.port = atoi(optarg);
 275                         break;
 276                 case 'i':
 277                         strncpy(interface_name, optarg, sizeof interface_name);
 278                         interface_name[(sizeof interface_name) - 1] = '\0';
 279                         iface = interface_name;
 280                         break;
 281                 case 'k':
 282                         info.bind_iface = 1;
 283 #if defined(LWS_HAVE_SYS_CAPABILITY_H) && defined(LWS_HAVE_LIBCAP)
 284                         info.caps[0] = CAP_NET_RAW;
 285                         info.count_caps = 1;
 286 #endif
 287                         break;
 288                 case 'c':
 289                         close_testing = 1;
 290                         fprintf(stderr, " Close testing mode -- closes on "
 291                                            "client after 50 dumb increments"
 292                                            "and suppresses lws_mirror spam\n");
 293                         break;
 294                 case 'r':
 295                         resource_path = optarg;
 296                         printf("Setting resource path to \"%s\"\n", resource_path);
 297                         break;
 298                 case 'C':
 299                         strncpy(cert_path, optarg, sizeof(cert_path) - 1);
 300                         cert_path[sizeof(cert_path) - 1] = '\0';
 301                         break;
 302                 case 'K':
 303                         strncpy(key_path, optarg, sizeof(key_path) - 1);
 304                         key_path[sizeof(key_path) - 1] = '\0';
 305                         break;
 306                 case 'A':
 307                         strncpy(ca_path, optarg, sizeof(ca_path) - 1);
 308                         ca_path[sizeof(ca_path) - 1] = '\0';
 309                         break;
 310                 case 'P':
 311                         pp_secs = atoi(optarg);
 312                         lwsl_notice("Setting pingpong interval to %d\n", pp_secs);
 313                         break;
 314 #if defined(LWS_OPENSSL_SUPPORT)
 315                 case 'v':
 316                         use_ssl = 1;
 317                         opts |= LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT;
 318                         break;
 319
 320 #if defined(LWS_HAVE_SSL_CTX_set1_param)
 321                 case 'R':
 322                         strncpy(crl_path, optarg, sizeof(crl_path) - 1);
 323                         crl_path[sizeof(crl_path) - 1] = '\0';
 324                         break;
 325 #endif
 326 #endif
 327                 case 'h':
 328                         fprintf(stderr, "Usage: test-server "
 329                                         "[--port=<p>] [--ssl] "
 330                                         "[-d <log bitfield>] "
 331                                         "[--resource_path <path>]\n");
 332                         exit(1);
 333                 }
 334         }
 335
 336 #if !defined(LWS_NO_DAEMONIZE) && !defined(WIN32)
 337         /*
 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
 341          */
 342         if (daemonize && lws_daemonize("/tmp/.lwsts-lock")) {
 343                 fprintf(stderr, "Failed to daemonize\n");
 344                 return 10;
 345         }
 346 #endif
 347
 348         signal(SIGINT, sighandler);
 349
 350 #ifndef _WIN32
 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);
 354 #endif
 355
 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);
 358
 359         lwsl_notice("libwebsockets test server - license LGPL2.1+SLE\n");
 360         lwsl_notice("(C) Copyright 2010-2016 Andy Green <andy@warmcat.com>\n");
 361
 362         printf("Using resource path \"%s\"\n", resource_path);
 363 #ifdef EXTERNAL_POLL
 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);
 369                 return -1;
 370         }
 371 #endif
 372
 373         info.iface = iface;
 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;
 378
 379         if (use_ssl) {
 380                 if (strlen(resource_path) > sizeof(cert_path) - 32) {
 381                         lwsl_err("resource path too long\n");
 382                         return -1;
 383                 }
 384                 if (!cert_path[0])
 385                         sprintf(cert_path, "%s/libwebsockets-test-server.pem",
 386                                                                 resource_path);
 387                 if (strlen(resource_path) > sizeof(key_path) - 32) {
 388                         lwsl_err("resource path too long\n");
 389                         return -1;
 390                 }
 391                 if (!key_path[0])
 392                         sprintf(key_path, "%s/libwebsockets-test-server.key.pem",
 393                                                                 resource_path);
 394
 395                 info.ssl_cert_filepath = cert_path;
 396                 info.ssl_private_key_filepath = key_path;
 397                 if (ca_path[0])
 398                         info.ssl_ca_filepath = ca_path;
 399         }
 400         info.gid = gid;
 401         info.uid = uid;
 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:"
 415                                "!AES128-SHA256:"
 416                                "!DHE-RSA-AES256-SHA256:"
 417                                "!AES256-GCM-SHA384:"
 418                                "!AES256-SHA256";
 419
 420         if (use_ssl)
 421                 /* redirect guys coming on http */
 422                 info.options |= LWS_SERVER_OPTION_REDIRECT_HTTP_TO_HTTPS;
 423
 424         context = lws_create_context(&info);
 425         if (context == NULL) {
 426                 lwsl_err("libwebsocket init failed\n");
 427                 return -1;
 428         }
 429
 430         vhost = lws_create_vhost(context, &info);
 431         if (!vhost) {
 432                 lwsl_err("vhost creation failed\n");
 433                 return -1;
 434         }
 435
 436 #if !defined(LWS_NO_CLIENT) && defined(LWS_OPENSSL_SUPPORT)
 437         lws_init_vhost_client_ssl(&info, vhost);
 438 #endif
 439
 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)
 443          */
 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;
 448
 449         n = 0;
 450 #ifdef EXTERNAL_POLL
 451         int ms_1sec = 0;
 452 #endif
 453         while (n >= 0 && !force_exit) {
 454                 struct timeval tv;
 455
 456                 gettimeofday(&tv, NULL);
 457
 458                 /*
 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)
 462                  */
 463
 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]);
 468                         oldms = ms;
 469                 }
 470
 471 #ifdef EXTERNAL_POLL
 472                 /*
 473                  * this represents an existing server's single poll action
 474                  * which also includes libwebsocket sockets
 475                  */
 476
 477                 n = poll(pollfds, count_pollfds, 50);
 478                 if (n < 0)
 479                         continue;
 480
 481                 if (n) {
 482                         for (n = 0; n < count_pollfds; n++)
 483                                 if (pollfds[n].revents)
 484                                         /*
 485                                         * returns immediately if the fd does not
 486                                         * match anything under libwebsockets
 487                                         * control
 488                                         */
 489                                         if (lws_service_fd(context,
 490                                                                   &pollfds[n]) < 0)
 491                                                 goto done;
 492
 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);
 497                         }
 498                 } else {
 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);
 503                                 ms_1sec = ms;
 504                         }
 505                 }
 506 #else
 507                 /*
 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.
 511                  *
 512                  * If no socket needs service, it'll return anyway after
 513                  * the number of ms in the second argument.
 514                  */
 515
 516                 n = lws_service(context, 50);
 517 #endif
 518         }
 519
 520 #ifdef EXTERNAL_POLL
 521 done:
 522 #endif
 523
 524         lws_context_destroy(context);
 525
 526         lwsl_notice("libwebsockets-test-server exited cleanly\n");
 527
 528 #ifndef _WIN32
 529         closelog();
 530 #endif
 531
 532         return 0;
 533 }