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, dynamic_vhost_enable = 0;
  33 struct lws_vhost *dynamic_vhost;
  34 struct lws_context *context;
  35 struct lws_plat_file_ops fops_plat;
  36
  37 /* http server gets files from this path */
  38 #define LOCAL_RESOURCE_PATH INSTALL_DATADIR"/libwebsockets-test-server"
  39 char *resource_path = LOCAL_RESOURCE_PATH;
  40 #if defined(LWS_OPENSSL_SUPPORT) && defined(LWS_HAVE_SSL_CTX_set1_param)
  41 char crl_path[1024] = "";
  42 #endif
  43
  44 /*
  45  * This demonstrates how to use the clean protocol service separation of
  46  * plugins, but with static inclusion instead of runtime dynamic loading
  47  * (which requires libuv).
  48  *
  49  * dumb-increment doesn't use the plugin, both to demonstrate how to
  50  * do the protocols directly, and because it wants libuv for a timer.
  51  *
  52  * Please consider using test-server-v2.0.c instead of this: it has the
  53  * same functionality but
  54  *
  55  * 1) uses lws built-in http handling so you don't need to deal with it in
  56  * your callback
  57  *
  58  * 2) Links with libuv and uses the plugins at runtime
  59  *
  60  * 3) Uses advanced lws features like mounts to bind parts of the filesystem
  61  * to the served URL space
  62  *
  63  * Another option is lwsws, this operates like test-server-v2,0.c but is
  64  * configured using JSON, do you do not need to provide any code for the
  65  * serving action at all, just implement your protocols in plugins.
  66  */
  67
  68 #define LWS_PLUGIN_STATIC
  69 #include "../plugins/protocol_lws_mirror.c"
  70 #include "../plugins/protocol_lws_status.c"
  71
  72 /* singlethreaded version --> no locks */
  73
  74 void test_server_lock(int care)
  75 {
  76 }
  77 void test_server_unlock(int care)
  78 {
  79 }
  80
  81 /*
  82  * This demo server shows how to use libwebsockets for one or more
  83  * websocket protocols in the same server
  84  *
  85  * It defines the following websocket protocols:
  86  *
  87  *  dumb-increment-protocol:  once the socket is opened, an incrementing
  88  *                              ascii string is sent down it every 50ms.
  89  *                              If you send "reset\n" on the websocket, then
  90  *                              the incrementing number is reset to 0.
  91  *
  92  *  lws-mirror-protocol: copies any received packet to every connection also
  93  *                              using this protocol, including the sender
  94  *
  95  *  lws-status:                 informs connected browsers of who else is
  96  *                              connected.
  97  */
  98
  99 enum demo_protocols {
 100         /* always first */
 101         PROTOCOL_HTTP = 0,
 102
 103         PROTOCOL_DUMB_INCREMENT,
 104         PROTOCOL_LWS_MIRROR,
 105         PROTOCOL_LWS_STATUS,
 106
 107         /* always last */
 108         DEMO_PROTOCOL_COUNT
 109 };
 110
 111 /* list of supported protocols and callbacks */
 112
 113 static struct lws_protocols protocols[] = {
 114         /* first protocol must always be HTTP handler */
 115
 116         {
 117                 "http-only",            /* name */
 118                 callback_http,          /* callback */
 119                 sizeof (struct per_session_data__http), /* per_session_data_size */
 120                 0,                      /* max frame size / rx buffer */
 121         },
 122         {
 123                 "dumb-increment-protocol",
 124                 callback_dumb_increment,
 125                 sizeof(struct per_session_data__dumb_increment),
 126                 10, /* rx buf size must be >= permessage-deflate rx size
 127                      * dumb-increment only sends very small packets, so we set
 128                      * this accordingly.  If your protocol will send bigger
 129                      * things, adjust this to match */
 130         },
 131         LWS_PLUGIN_PROTOCOL_MIRROR,
 132         LWS_PLUGIN_PROTOCOL_LWS_STATUS,
 133         { NULL, NULL, 0, 0 } /* terminator */
 134 };
 135
 136
 137 /* this shows how to override the lws file operations.  You don't need
 138  * to do any of this unless you have a reason (eg, want to serve
 139  * compressed files without decompressing the whole archive)
 140  */
 141 static lws_fop_fd_t
 142 test_server_fops_open(const struct lws_plat_file_ops *fops,
 143                      const char *vfs_path, const char *vpath,
 144                      lws_fop_flags_t *flags)
 145 {
 146         lws_fop_fd_t fop_fd;
 147
 148         /* call through to original platform implementation */
 149         fop_fd = fops_plat.open(fops, vfs_path, vpath, flags);
 150
 151         if (fop_fd)
 152                 lwsl_info("%s: opening %s, ret %p, len %lu\n", __func__,
 153                                 vfs_path, fop_fd,
 154                                 (long)lws_vfs_get_length(fop_fd));
 155         else
 156                 lwsl_info("%s: open %s failed\n", __func__, vfs_path);
 157
 158         return fop_fd;
 159 }
 160
 161 void sighandler(int sig)
 162 {
 163 #if !defined(WIN32) && !defined(_WIN32)
 164         /* because windows is too dumb to have SIGUSR1... */
 165         if (sig == SIGUSR1) {
 166                 /*
 167                  * For testing, you can fire a SIGUSR1 at the test server
 168                  * to toggle the existence of an identical server on
 169                  * port + 1
 170                  */
 171                 dynamic_vhost_enable ^= 1;
 172                 lwsl_notice("SIGUSR1: dynamic_vhost_enable: %d\n",
 173                                 dynamic_vhost_enable);
 174                 return;
 175         }
 176 #endif
 177         force_exit = 1;
 178         lws_cancel_service(context);
 179 }
 180
 181 static const struct lws_extension exts[] = {
 182         {
 183                 "permessage-deflate",
 184                 lws_extension_callback_pm_deflate,
 185                 "permessage-deflate"
 186         },
 187         {
 188                 "deflate-frame",
 189                 lws_extension_callback_pm_deflate,
 190                 "deflate_frame"
 191         },
 192         { NULL, NULL, NULL /* terminator */ }
 193 };
 194
 195
 196
 197 static struct option options[] = {
 198         { "help",       no_argument,            NULL, 'h' },
 199         { "debug",      required_argument,      NULL, 'd' },
 200         { "port",       required_argument,      NULL, 'p' },
 201         { "ssl",        no_argument,            NULL, 's' },
 202         { "allow-non-ssl",      no_argument,    NULL, 'a' },
 203         { "interface",  required_argument,      NULL, 'i' },
 204         { "closetest",  no_argument,            NULL, 'c' },
 205         { "ssl-cert",  required_argument,       NULL, 'C' },
 206         { "ssl-key",  required_argument,        NULL, 'K' },
 207         { "ssl-ca",  required_argument,         NULL, 'A' },
 208 #if defined(LWS_OPENSSL_SUPPORT)
 209         { "ssl-verify-client",  no_argument,            NULL, 'v' },
 210 #if defined(LWS_HAVE_SSL_CTX_set1_param)
 211         { "ssl-crl",  required_argument,                NULL, 'R' },
 212 #endif
 213 #endif
 214         { "libev",  no_argument,                NULL, 'e' },
 215 #ifndef LWS_NO_DAEMONIZE
 216         { "daemonize",  no_argument,            NULL, 'D' },
 217 #endif
 218         { "resource_path", required_argument,   NULL, 'r' },
 219         { "pingpong-secs", required_argument,   NULL, 'P' },
 220         { NULL, 0, 0, 0 }
 221 };
 222
 223 int main(int argc, char **argv)
 224 {
 225         struct lws_context_creation_info info;
 226         struct lws_vhost *vhost;
 227         char interface_name[128] = "";
 228         unsigned int ms, oldms = 0;
 229         const char *iface = NULL;
 230         char cert_path[1024] = "";
 231         char key_path[1024] = "";
 232         char ca_path[1024] = "";
 233         int uid = -1, gid = -1;
 234         int use_ssl = 0;
 235         int pp_secs = 0;
 236         int opts = 0;
 237         int n = 0;
 238 #ifndef _WIN32
 239 /* LOG_PERROR is not POSIX standard, and may not be portable */
 240 #ifdef __sun
 241         int syslog_options = LOG_PID;
 242 #else
 243         int syslog_options = LOG_PID | LOG_PERROR;
 244 #endif
 245 #endif
 246 #ifndef LWS_NO_DAEMONIZE
 247         int daemonize = 0;
 248 #endif
 249
 250         /*
 251          * take care to zero down the info struct, he contains random garbaage
 252          * from the stack otherwise
 253          */
 254         memset(&info, 0, sizeof info);
 255         info.port = 7681;
 256
 257         while (n >= 0) {
 258                 n = getopt_long(argc, argv, "eci:hsap:d:Dr:C:K:A:R:vu:g:P:k", options, NULL);
 259                 if (n < 0)
 260                         continue;
 261                 switch (n) {
 262                 case 'e':
 263                         opts |= LWS_SERVER_OPTION_LIBEV;
 264                         break;
 265 #ifndef LWS_NO_DAEMONIZE
 266                 case 'D':
 267                         daemonize = 1;
 268                         #if !defined(_WIN32) && !defined(__sun)
 269                         syslog_options &= ~LOG_PERROR;
 270                         #endif
 271                         break;
 272 #endif
 273                 case 'u':
 274                         uid = atoi(optarg);
 275                         break;
 276                 case 'g':
 277                         gid = atoi(optarg);
 278                         break;
 279                 case 'd':
 280                         debug_level = atoi(optarg);
 281                         break;
 282                 case 's':
 283                         use_ssl = 1;
 284                         opts |= LWS_SERVER_OPTION_DO_SSL_GLOBAL_INIT;
 285                         break;
 286                 case 'a':
 287                         opts |= LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT;
 288                         break;
 289                 case 'p':
 290                         info.port = atoi(optarg);
 291                         break;
 292                 case 'i':
 293                         strncpy(interface_name, optarg, sizeof interface_name);
 294                         interface_name[(sizeof interface_name) - 1] = '\0';
 295                         iface = interface_name;
 296                         break;
 297                 case 'k':
 298                         info.bind_iface = 1;
 299 #if defined(LWS_HAVE_SYS_CAPABILITY_H) && defined(LWS_HAVE_LIBCAP)
 300                         info.caps[0] = CAP_NET_RAW;
 301                         info.count_caps = 1;
 302 #endif
 303                         break;
 304                 case 'c':
 305                         close_testing = 1;
 306                         fprintf(stderr, " Close testing mode -- closes on "
 307                                            "client after 50 dumb increments"
 308                                            "and suppresses lws_mirror spam\n");
 309                         break;
 310                 case 'r':
 311                         resource_path = optarg;
 312                         printf("Setting resource path to \"%s\"\n", resource_path);
 313                         break;
 314                 case 'C':
 315                         strncpy(cert_path, optarg, sizeof(cert_path) - 1);
 316                         cert_path[sizeof(cert_path) - 1] = '\0';
 317                         break;
 318                 case 'K':
 319                         strncpy(key_path, optarg, sizeof(key_path) - 1);
 320                         key_path[sizeof(key_path) - 1] = '\0';
 321                         break;
 322                 case 'A':
 323                         strncpy(ca_path, optarg, sizeof(ca_path) - 1);
 324                         ca_path[sizeof(ca_path) - 1] = '\0';
 325                         break;
 326                 case 'P':
 327                         pp_secs = atoi(optarg);
 328                         lwsl_notice("Setting pingpong interval to %d\n", pp_secs);
 329                         break;
 330 #if defined(LWS_OPENSSL_SUPPORT)
 331                 case 'v':
 332                         use_ssl = 1;
 333                         opts |= LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT;
 334                         break;
 335
 336 #if defined(LWS_HAVE_SSL_CTX_set1_param)
 337                 case 'R':
 338                         strncpy(crl_path, optarg, sizeof(crl_path) - 1);
 339                         crl_path[sizeof(crl_path) - 1] = '\0';
 340                         break;
 341 #endif
 342 #endif
 343                 case 'h':
 344                         fprintf(stderr, "Usage: test-server "
 345                                         "[--port=<p>] [--ssl] "
 346                                         "[-d <log bitfield>] "
 347                                         "[--resource_path <path>]\n");
 348                         exit(1);
 349                 }
 350         }
 351
 352 #if !defined(LWS_NO_DAEMONIZE) && !defined(WIN32)
 353         /*
 354          * normally lock path would be /var/lock/lwsts or similar, to
 355          * simplify getting started without having to take care about
 356          * permissions or running as root, set to /tmp/.lwsts-lock
 357          */
 358         if (daemonize && lws_daemonize("/tmp/.lwsts-lock")) {
 359                 fprintf(stderr, "Failed to daemonize\n");
 360                 return 10;
 361         }
 362 #endif
 363
 364         signal(SIGINT, sighandler);
 365 #if !defined(WIN32) && !defined(_WIN32)
 366         /* because windows is too dumb to have SIGUSR1... */
 367         /* dynamic vhost create / destroy toggle (on port + 1) */
 368         signal(SIGUSR1, sighandler);
 369 #endif
 370
 371 #ifndef _WIN32
 372         /* we will only try to log things according to our debug_level */
 373         setlogmask(LOG_UPTO (LOG_DEBUG));
 374         openlog("lwsts", syslog_options, LOG_DAEMON);
 375 #endif
 376
 377         /* tell the library what debug level to emit and to send it to syslog */
 378         lws_set_log_level(debug_level, lwsl_emit_syslog);
 379
 380         lwsl_notice("libwebsockets test server - license LGPL2.1+SLE\n");
 381         lwsl_notice("(C) Copyright 2010-2016 Andy Green <andy@warmcat.com>\n");
 382
 383         printf("Using resource path \"%s\"\n", resource_path);
 384 #ifdef EXTERNAL_POLL
 385         max_poll_elements = getdtablesize();
 386         pollfds = malloc(max_poll_elements * sizeof (struct lws_pollfd));
 387         fd_lookup = malloc(max_poll_elements * sizeof (int));
 388         if (pollfds == NULL || fd_lookup == NULL) {
 389                 lwsl_err("Out of memory pollfds=%d\n", max_poll_elements);
 390                 return -1;
 391         }
 392 #endif
 393
 394         info.iface = iface;
 395         info.protocols = protocols;
 396         info.ssl_cert_filepath = NULL;
 397         info.ssl_private_key_filepath = NULL;
 398         info.ws_ping_pong_interval = pp_secs;
 399
 400         if (use_ssl) {
 401                 if (strlen(resource_path) > sizeof(cert_path) - 32) {
 402                         lwsl_err("resource path too long\n");
 403                         return -1;
 404                 }
 405                 if (!cert_path[0])
 406                         sprintf(cert_path, "%s/libwebsockets-test-server.pem",
 407                                                                 resource_path);
 408                 if (strlen(resource_path) > sizeof(key_path) - 32) {
 409                         lwsl_err("resource path too long\n");
 410                         return -1;
 411                 }
 412                 if (!key_path[0])
 413                         sprintf(key_path, "%s/libwebsockets-test-server.key.pem",
 414                                                                 resource_path);
 415
 416                 info.ssl_cert_filepath = cert_path;
 417                 info.ssl_private_key_filepath = key_path;
 418                 if (ca_path[0])
 419                         info.ssl_ca_filepath = ca_path;
 420         }
 421         info.gid = gid;
 422         info.uid = uid;
 423         info.max_http_header_pool = 16;
 424         info.options = opts | LWS_SERVER_OPTION_VALIDATE_UTF8 | LWS_SERVER_OPTION_EXPLICIT_VHOSTS;
 425         info.extensions = exts;
 426         info.timeout_secs = 5;
 427         info.ssl_cipher_list = "ECDHE-ECDSA-AES256-GCM-SHA384:"
 428                                "ECDHE-RSA-AES256-GCM-SHA384:"
 429                                "DHE-RSA-AES256-GCM-SHA384:"
 430                                "ECDHE-RSA-AES256-SHA384:"
 431                                "HIGH:!aNULL:!eNULL:!EXPORT:"
 432                                "!DES:!MD5:!PSK:!RC4:!HMAC_SHA1:"
 433                                "!SHA1:!DHE-RSA-AES128-GCM-SHA256:"
 434                                "!DHE-RSA-AES128-SHA256:"
 435                                "!AES128-GCM-SHA256:"
 436                                "!AES128-SHA256:"
 437                                "!DHE-RSA-AES256-SHA256:"
 438                                "!AES256-GCM-SHA384:"
 439                                "!AES256-SHA256";
 440
 441         if (use_ssl)
 442                 /* redirect guys coming on http */
 443                 info.options |= LWS_SERVER_OPTION_REDIRECT_HTTP_TO_HTTPS;
 444
 445         context = lws_create_context(&info);
 446         if (context == NULL) {
 447                 lwsl_err("libwebsocket init failed\n");
 448                 return -1;
 449         }
 450
 451         vhost = lws_create_vhost(context, &info);
 452         if (!vhost) {
 453                 lwsl_err("vhost creation failed\n");
 454                 return -1;
 455         }
 456
 457         /*
 458          * For testing dynamic vhost create / destroy later, we use port + 1
 459          * Normally if you were creating more vhosts, you would set info.name
 460          * for each to be the hostname external clients use to reach it
 461          */
 462
 463         info.port++;
 464
 465 #if !defined(LWS_NO_CLIENT) && defined(LWS_OPENSSL_SUPPORT)
 466         lws_init_vhost_client_ssl(&info, vhost);
 467 #endif
 468
 469         /* this shows how to override the lws file operations.  You don't need
 470          * to do any of this unless you have a reason (eg, want to serve
 471          * compressed files without decompressing the whole archive)
 472          */
 473         /* stash original platform fops */
 474         fops_plat = *(lws_get_fops(context));
 475         /* override the active fops */
 476         lws_get_fops(context)->open = test_server_fops_open;
 477
 478         n = 0;
 479 #ifdef EXTERNAL_POLL
 480         int ms_1sec = 0;
 481 #endif
 482         while (n >= 0 && !force_exit) {
 483                 struct timeval tv;
 484
 485                 gettimeofday(&tv, NULL);
 486
 487                 /*
 488                  * This provokes the LWS_CALLBACK_SERVER_WRITEABLE for every
 489                  * live websocket connection using the DUMB_INCREMENT protocol,
 490                  * as soon as it can take more packets (usually immediately)
 491                  */
 492
 493                 ms = (tv.tv_sec * 1000) + (tv.tv_usec / 1000);
 494                 if ((ms - oldms) > 50) {
 495                         lws_callback_on_writable_all_protocol(context,
 496                                 &protocols[PROTOCOL_DUMB_INCREMENT]);
 497                         oldms = ms;
 498                 }
 499
 500 #ifdef EXTERNAL_POLL
 501                 /*
 502                  * this represents an existing server's single poll action
 503                  * which also includes libwebsocket sockets
 504                  */
 505
 506                 n = poll(pollfds, count_pollfds, 50);
 507                 if (n < 0)
 508                         continue;
 509
 510                 if (n) {
 511                         for (n = 0; n < count_pollfds; n++)
 512                                 if (pollfds[n].revents)
 513                                         /*
 514                                         * returns immediately if the fd does not
 515                                         * match anything under libwebsockets
 516                                         * control
 517                                         */
 518                                         if (lws_service_fd(context,
 519                                                                   &pollfds[n]) < 0)
 520                                                 goto done;
 521
 522                         /* if needed, force-service wsis that may not have read all input */
 523                         while (!lws_service_adjust_timeout(context, 1, 0)) {
 524                                 lwsl_notice("extpoll doing forced service!\n");
 525                                 lws_service_tsi(context, -1, 0);
 526                         }
 527                 } else {
 528                         /* no revents, but before polling again, make lws check for any timeouts */
 529                         if (ms - ms_1sec > 1000) {
 530                                 lwsl_notice("1 per sec\n");
 531                                 lws_service_fd(context, NULL);
 532                                 ms_1sec = ms;
 533                         }
 534                 }
 535 #else
 536                 /*
 537                  * If libwebsockets sockets are all we care about,
 538                  * you can use this api which takes care of the poll()
 539                  * and looping through finding who needed service.
 540                  *
 541                  * If no socket needs service, it'll return anyway after
 542                  * the number of ms in the second argument.
 543                  */
 544
 545                 n = lws_service(context, 50);
 546 #endif
 547
 548                 if (dynamic_vhost_enable && !dynamic_vhost) {
 549                         lwsl_notice("creating dynamic vhost...\n");
 550                         dynamic_vhost = lws_create_vhost(context, &info);
 551                 } else
 552                         if (!dynamic_vhost_enable && dynamic_vhost) {
 553                                 lwsl_notice("destroying dynamic vhost...\n");
 554                                 lws_vhost_destroy(dynamic_vhost);
 555                                 dynamic_vhost = NULL;
 556                         }
 557
 558         }
 559
 560 #ifdef EXTERNAL_POLL
 561 done:
 562 #endif
 563
 564         lws_context_destroy(context);
 565
 566         lwsl_notice("libwebsockets-test-server exited cleanly\n");
 567
 568 #ifndef _WIN32
 569         closelog();
 570 #endif
 571
 572         return 0;
 573 }