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 /* singlethreaded version --> no locks */
  44
  45 void test_server_lock(int care)
  46 {
  47 }
  48 void test_server_unlock(int care)
  49 {
  50 }
  51
  52 /*
  53  * This demo server shows how to use libwebsockets for one or more
  54  * websocket protocols in the same server
  55  *
  56  * It defines the following websocket protocols:
  57  *
  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.
  62  *
  63  *  lws-mirror-protocol: copies any received packet to every connection also
  64  *                              using this protocol, including the sender
  65  */
  66
  67 enum demo_protocols {
  68         /* always first */
  69         PROTOCOL_HTTP = 0,
  70
  71         PROTOCOL_DUMB_INCREMENT,
  72         PROTOCOL_LWS_MIRROR,
  73         PROTOCOL_LWS_ECHOGEN,
  74         PROTOCOL_LWS_STATUS,
  75
  76         /* always last */
  77         DEMO_PROTOCOL_COUNT
  78 };
  79
  80 /* list of supported protocols and callbacks */
  81
  82 static struct lws_protocols protocols[] = {
  83         /* first protocol must always be HTTP handler */
  84
  85         {
  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 */
  90         },
  91         {
  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 */
  96         },
  97         {
  98                 "lws-mirror-protocol",
  99                 callback_lws_mirror,
 100                 sizeof(struct per_session_data__lws_mirror),
 101                 128, /* rx buf size must be >= permessage-deflate rx size */
 102         },
 103         {
 104                 "lws-echogen",
 105                 callback_lws_echogen,
 106                 sizeof(struct per_session_data__echogen),
 107                 128, /* rx buf size must be >= permessage-deflate rx size */
 108         },
 109         {
 110                 "lws-status",
 111                 callback_lws_status,
 112                 sizeof(struct per_session_data__lws_status),
 113                 128, /* rx buf size must be >= permessage-deflate rx size */
 114         },
 115         { NULL, NULL, 0, 0 } /* terminator */
 116 };
 117
 118
 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)
 122  */
 123 static lws_fop_fd_t
 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)
 127 {
 128         lws_fop_fd_t fop_fd;
 129
 130         /* call through to original platform implementation */
 131         fop_fd = fops_plat.open(fops, vfs_path, vpath, flags);
 132
 133         if (fop_fd)
 134                 lwsl_info("%s: opening %s, ret %p, len %lu\n", __func__,
 135                                 vfs_path, fop_fd,
 136                                 (long)lws_vfs_get_length(fop_fd));
 137         else
 138                 lwsl_info("%s: open %s failed\n", __func__, vfs_path);
 139
 140         return fop_fd;
 141 }
 142
 143 void sighandler(int sig)
 144 {
 145         force_exit = 1;
 146         lws_cancel_service(context);
 147 }
 148
 149 static const struct lws_extension exts[] = {
 150         {
 151                 "permessage-deflate",
 152                 lws_extension_callback_pm_deflate,
 153                 "permessage-deflate"
 154         },
 155         {
 156                 "deflate-frame",
 157                 lws_extension_callback_pm_deflate,
 158                 "deflate_frame"
 159         },
 160         { NULL, NULL, NULL /* terminator */ }
 161 };
 162
 163
 164
 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' },
 180 #endif
 181 #endif
 182         { "libev",  no_argument,                NULL, 'e' },
 183 #ifndef LWS_NO_DAEMONIZE
 184         { "daemonize",  no_argument,            NULL, 'D' },
 185 #endif
 186         { "resource_path", required_argument,   NULL, 'r' },
 187         { "pingpong-secs", required_argument,   NULL, 'P' },
 188         { NULL, 0, 0, 0 }
 189 };
 190
 191 int main(int argc, char **argv)
 192 {
 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;
 202         int use_ssl = 0;
 203         int pp_secs = 0;
 204         int opts = 0;
 205         int n = 0;
 206 #ifndef _WIN32
 207 /* LOG_PERROR is not POSIX standard, and may not be portable */
 208 #ifdef __sun
 209         int syslog_options = LOG_PID;
 210 #else
 211         int syslog_options = LOG_PID | LOG_PERROR;
 212 #endif
 213 #endif
 214 #ifndef LWS_NO_DAEMONIZE
 215         int daemonize = 0;
 216 #endif
 217
 218         /*
 219          * take care to zero down the info struct, he contains random garbaage
 220          * from the stack otherwise
 221          */
 222         memset(&info, 0, sizeof info);
 223         info.port = 7681;
 224
 225         while (n >= 0) {
 226                 n = getopt_long(argc, argv, "eci:hsap:d:Dr:C:K:A:R:vu:g:P:k", options, NULL);
 227                 if (n < 0)
 228                         continue;
 229                 switch (n) {
 230                 case 'e':
 231                         opts |= LWS_SERVER_OPTION_LIBEV;
 232                         break;
 233 #ifndef LWS_NO_DAEMONIZE
 234                 case 'D':
 235                         daemonize = 1;
 236                         #if !defined(_WIN32) && !defined(__sun)
 237                         syslog_options &= ~LOG_PERROR;
 238                         #endif
 239                         break;
 240 #endif
 241                 case 'u':
 242                         uid = atoi(optarg);
 243                         break;
 244                 case 'g':
 245                         gid = atoi(optarg);
 246                         break;
 247                 case 'd':
 248                         debug_level = atoi(optarg);
 249                         break;
 250                 case 's':
 251                         use_ssl = 1;
 252                         break;
 253                 case 'a':
 254                         opts |= LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT;
 255                         break;
 256                 case 'p':
 257                         info.port = atoi(optarg);
 258                         break;
 259                 case 'i':
 260                         strncpy(interface_name, optarg, sizeof interface_name);
 261                         interface_name[(sizeof interface_name) - 1] = '\0';
 262                         iface = interface_name;
 263                         break;
 264                 case 'k':
 265                         info.bind_iface = 1;
 266 #if defined(LWS_HAVE_SYS_CAPABILITY_H) && defined(LWS_HAVE_LIBCAP)
 267                         info.caps[0] = CAP_NET_RAW;
 268                         info.count_caps = 1;
 269 #endif
 270                         break;
 271                 case 'c':
 272                         close_testing = 1;
 273                         fprintf(stderr, " Close testing mode -- closes on "
 274                                            "client after 50 dumb increments"
 275                                            "and suppresses lws_mirror spam\n");
 276                         break;
 277                 case 'r':
 278                         resource_path = optarg;
 279                         printf("Setting resource path to \"%s\"\n", resource_path);
 280                         break;
 281                 case 'C':
 282                         strncpy(cert_path, optarg, sizeof(cert_path) - 1);
 283                         cert_path[sizeof(cert_path) - 1] = '\0';
 284                         break;
 285                 case 'K':
 286                         strncpy(key_path, optarg, sizeof(key_path) - 1);
 287                         key_path[sizeof(key_path) - 1] = '\0';
 288                         break;
 289                 case 'A':
 290                         strncpy(ca_path, optarg, sizeof(ca_path) - 1);
 291                         ca_path[sizeof(ca_path) - 1] = '\0';
 292                         break;
 293                 case 'P':
 294                         pp_secs = atoi(optarg);
 295                         lwsl_notice("Setting pingpong interval to %d\n", pp_secs);
 296                         break;
 297 #if defined(LWS_OPENSSL_SUPPORT)
 298                 case 'v':
 299                         use_ssl = 1;
 300                         opts |= LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT;
 301                         break;
 302
 303 #if defined(LWS_HAVE_SSL_CTX_set1_param)
 304                 case 'R':
 305                         strncpy(crl_path, optarg, sizeof(crl_path) - 1);
 306                         crl_path[sizeof(crl_path) - 1] = '\0';
 307                         break;
 308 #endif
 309 #endif
 310                 case 'h':
 311                         fprintf(stderr, "Usage: test-server "
 312                                         "[--port=<p>] [--ssl] "
 313                                         "[-d <log bitfield>] "
 314                                         "[--resource_path <path>]\n");
 315                         exit(1);
 316                 }
 317         }
 318
 319 #if !defined(LWS_NO_DAEMONIZE) && !defined(WIN32)
 320         /*
 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
 324          */
 325         if (daemonize && lws_daemonize("/tmp/.lwsts-lock")) {
 326                 fprintf(stderr, "Failed to daemonize\n");
 327                 return 10;
 328         }
 329 #endif
 330
 331         signal(SIGINT, sighandler);
 332
 333 #ifndef _WIN32
 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);
 337 #endif
 338
 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);
 341
 342         lwsl_notice("libwebsockets test server - license LGPL2.1+SLE\n");
 343         lwsl_notice("(C) Copyright 2010-2016 Andy Green <andy@warmcat.com>\n");
 344
 345         printf("Using resource path \"%s\"\n", resource_path);
 346 #ifdef EXTERNAL_POLL
 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);
 352                 return -1;
 353         }
 354 #endif
 355
 356         info.iface = iface;
 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;
 361
 362         if (use_ssl) {
 363                 if (strlen(resource_path) > sizeof(cert_path) - 32) {
 364                         lwsl_err("resource path too long\n");
 365                         return -1;
 366                 }
 367                 if (!cert_path[0])
 368                         sprintf(cert_path, "%s/libwebsockets-test-server.pem",
 369                                                                 resource_path);
 370                 if (strlen(resource_path) > sizeof(key_path) - 32) {
 371                         lwsl_err("resource path too long\n");
 372                         return -1;
 373                 }
 374                 if (!key_path[0])
 375                         sprintf(key_path, "%s/libwebsockets-test-server.key.pem",
 376                                                                 resource_path);
 377
 378                 info.ssl_cert_filepath = cert_path;
 379                 info.ssl_private_key_filepath = key_path;
 380                 if (ca_path[0])
 381                         info.ssl_ca_filepath = ca_path;
 382         }
 383         info.gid = gid;
 384         info.uid = uid;
 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:"
 398                                "!AES128-SHA256:"
 399                                "!DHE-RSA-AES256-SHA256:"
 400                                "!AES256-GCM-SHA384:"
 401                                "!AES256-SHA256";
 402
 403         if (use_ssl)
 404                 /* redirect guys coming on http */
 405                 info.options |= LWS_SERVER_OPTION_REDIRECT_HTTP_TO_HTTPS;
 406
 407         context = lws_create_context(&info);
 408         if (context == NULL) {
 409                 lwsl_err("libwebsocket init failed\n");
 410                 return -1;
 411         }
 412
 413         vhost = lws_create_vhost(context, &info);
 414         if (!vhost) {
 415                 lwsl_err("vhost creation failed\n");
 416                 return -1;
 417         }
 418
 419 #if !defined(LWS_NO_CLIENT) && defined(LWS_OPENSSL_SUPPORT)
 420         lws_init_vhost_client_ssl(&info, vhost);
 421 #endif
 422
 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)
 426          */
 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;
 431
 432         n = 0;
 433 #ifdef EXTERNAL_POLL
 434         int ms_1sec = 0;
 435 #endif
 436         while (n >= 0 && !force_exit) {
 437                 struct timeval tv;
 438
 439                 gettimeofday(&tv, NULL);
 440
 441                 /*
 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)
 445                  */
 446
 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]);
 451                         oldms = ms;
 452                 }
 453
 454 #ifdef EXTERNAL_POLL
 455                 /*
 456                  * this represents an existing server's single poll action
 457                  * which also includes libwebsocket sockets
 458                  */
 459
 460                 n = poll(pollfds, count_pollfds, 50);
 461                 if (n < 0)
 462                         continue;
 463
 464                 if (n) {
 465                         for (n = 0; n < count_pollfds; n++)
 466                                 if (pollfds[n].revents)
 467                                         /*
 468                                         * returns immediately if the fd does not
 469                                         * match anything under libwebsockets
 470                                         * control
 471                                         */
 472                                         if (lws_service_fd(context,
 473                                                                   &pollfds[n]) < 0)
 474                                                 goto done;
 475
 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);
 480                         }
 481                 } else {
 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);
 486                                 ms_1sec = ms;
 487                         }
 488                 }
 489 #else
 490                 /*
 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.
 494                  *
 495                  * If no socket needs service, it'll return anyway after
 496                  * the number of ms in the second argument.
 497                  */
 498
 499                 n = lws_service(context, 50);
 500 #endif
 501         }
 502
 503 #ifdef EXTERNAL_POLL
 504 done:
 505 #endif
 506
 507         lws_context_destroy(context);
 508
 509         lwsl_notice("libwebsockets-test-server exited cleanly\n");
 510
 511 #ifndef _WIN32
 512         closelog();
 513 #endif
 514
 515         return 0;
 516 }