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_filefd_type
 124 test_server_fops_open(struct lws *wsi, const char *filename,
 125                       unsigned long *filelen, int *flags)
 126 {
 127         lws_filefd_type n;
 128
 129         /* call through to original platform implementation */
 130         n = fops_plat.open(wsi, filename, filelen, flags);
 131
 132         lwsl_info("%s: opening %s, ret %ld, len %lu\n", __func__, filename,
 133                         (long)n, *filelen);
 134
 135         return n;
 136 }
 137
 138 void sighandler(int sig)
 139 {
 140         force_exit = 1;
 141         lws_cancel_service(context);
 142 }
 143
 144 static const struct lws_extension exts[] = {
 145         {
 146                 "permessage-deflate",
 147                 lws_extension_callback_pm_deflate,
 148                 "permessage-deflate"
 149         },
 150         {
 151                 "deflate-frame",
 152                 lws_extension_callback_pm_deflate,
 153                 "deflate_frame"
 154         },
 155         { NULL, NULL, NULL /* terminator */ }
 156 };
 157
 158
 159
 160 static struct option options[] = {
 161         { "help",       no_argument,            NULL, 'h' },
 162         { "debug",      required_argument,      NULL, 'd' },
 163         { "port",       required_argument,      NULL, 'p' },
 164         { "ssl",        no_argument,            NULL, 's' },
 165         { "allow-non-ssl",      no_argument,    NULL, 'a' },
 166         { "interface",  required_argument,      NULL, 'i' },
 167         { "closetest",  no_argument,            NULL, 'c' },
 168         { "ssl-cert",  required_argument,       NULL, 'C' },
 169         { "ssl-key",  required_argument,        NULL, 'K' },
 170         { "ssl-ca",  required_argument,         NULL, 'A' },
 171 #if defined(LWS_OPENSSL_SUPPORT)
 172         { "ssl-verify-client",  no_argument,            NULL, 'v' },
 173 #if defined(LWS_HAVE_SSL_CTX_set1_param)
 174         { "ssl-crl",  required_argument,                NULL, 'R' },
 175 #endif
 176 #endif
 177         { "libev",  no_argument,                NULL, 'e' },
 178 #ifndef LWS_NO_DAEMONIZE
 179         { "daemonize",  no_argument,            NULL, 'D' },
 180 #endif
 181         { "resource_path", required_argument,   NULL, 'r' },
 182         { "pingpong-secs", required_argument,   NULL, 'P' },
 183         { NULL, 0, 0, 0 }
 184 };
 185
 186 int main(int argc, char **argv)
 187 {
 188         struct lws_context_creation_info info;
 189         char interface_name[128] = "";
 190         unsigned int ms, oldms = 0;
 191         const char *iface = NULL;
 192         char cert_path[1024] = "";
 193         char key_path[1024] = "";
 194         char ca_path[1024] = "";
 195         int uid = -1, gid = -1;
 196         int use_ssl = 0;
 197         int pp_secs = 0;
 198         int opts = 0;
 199         int n = 0;
 200 #ifndef _WIN32
 201 /* LOG_PERROR is not POSIX standard, and may not be portable */
 202 #ifdef __sun
 203         int syslog_options = LOG_PID;
 204 #else
 205         int syslog_options = LOG_PID | LOG_PERROR;
 206 #endif
 207 #endif
 208 #ifndef LWS_NO_DAEMONIZE
 209         int daemonize = 0;
 210 #endif
 211
 212         /*
 213          * take care to zero down the info struct, he contains random garbaage
 214          * from the stack otherwise
 215          */
 216         memset(&info, 0, sizeof info);
 217         info.port = 7681;
 218
 219         while (n >= 0) {
 220                 n = getopt_long(argc, argv, "eci:hsap:d:Dr:C:K:A:R:vu:g:P:", options, NULL);
 221                 if (n < 0)
 222                         continue;
 223                 switch (n) {
 224                 case 'e':
 225                         opts |= LWS_SERVER_OPTION_LIBEV;
 226                         break;
 227 #ifndef LWS_NO_DAEMONIZE
 228                 case 'D':
 229                         daemonize = 1;
 230                         #if !defined(_WIN32) && !defined(__sun)
 231                         syslog_options &= ~LOG_PERROR;
 232                         #endif
 233                         break;
 234 #endif
 235                 case 'u':
 236                         uid = atoi(optarg);
 237                         break;
 238                 case 'g':
 239                         gid = atoi(optarg);
 240                         break;
 241                 case 'd':
 242                         debug_level = atoi(optarg);
 243                         break;
 244                 case 's':
 245                         use_ssl = 1;
 246                         break;
 247                 case 'a':
 248                         opts |= LWS_SERVER_OPTION_ALLOW_NON_SSL_ON_SSL_PORT;
 249                         break;
 250                 case 'p':
 251                         info.port = atoi(optarg);
 252                         break;
 253                 case 'i':
 254                         strncpy(interface_name, optarg, sizeof interface_name);
 255                         interface_name[(sizeof interface_name) - 1] = '\0';
 256                         iface = interface_name;
 257                         break;
 258                 case 'c':
 259                         close_testing = 1;
 260                         fprintf(stderr, " Close testing mode -- closes on "
 261                                            "client after 50 dumb increments"
 262                                            "and suppresses lws_mirror spam\n");
 263                         break;
 264                 case 'r':
 265                         resource_path = optarg;
 266                         printf("Setting resource path to \"%s\"\n", resource_path);
 267                         break;
 268                 case 'C':
 269                         strncpy(cert_path, optarg, sizeof(cert_path) - 1);
 270                         cert_path[sizeof(cert_path) - 1] = '\0';
 271                         break;
 272                 case 'K':
 273                         strncpy(key_path, optarg, sizeof(key_path) - 1);
 274                         key_path[sizeof(key_path) - 1] = '\0';
 275                         break;
 276                 case 'A':
 277                         strncpy(ca_path, optarg, sizeof(ca_path) - 1);
 278                         ca_path[sizeof(ca_path) - 1] = '\0';
 279                         break;
 280                 case 'P':
 281                         pp_secs = atoi(optarg);
 282                         lwsl_notice("Setting pingpong interval to %d\n", pp_secs);
 283                         break;
 284 #if defined(LWS_OPENSSL_SUPPORT)
 285                 case 'v':
 286                         use_ssl = 1;
 287                         opts |= LWS_SERVER_OPTION_REQUIRE_VALID_OPENSSL_CLIENT_CERT;
 288                         break;
 289
 290 #if defined(LWS_HAVE_SSL_CTX_set1_param)
 291                 case 'R':
 292                         strncpy(crl_path, optarg, sizeof(crl_path) - 1);
 293                         crl_path[sizeof(crl_path) - 1] = '\0';
 294                         break;
 295 #endif
 296 #endif
 297                 case 'h':
 298                         fprintf(stderr, "Usage: test-server "
 299                                         "[--port=<p>] [--ssl] "
 300                                         "[-d <log bitfield>] "
 301                                         "[--resource_path <path>]\n");
 302                         exit(1);
 303                 }
 304         }
 305
 306 #if !defined(LWS_NO_DAEMONIZE) && !defined(WIN32)
 307         /*
 308          * normally lock path would be /var/lock/lwsts or similar, to
 309          * simplify getting started without having to take care about
 310          * permissions or running as root, set to /tmp/.lwsts-lock
 311          */
 312         if (daemonize && lws_daemonize("/tmp/.lwsts-lock")) {
 313                 fprintf(stderr, "Failed to daemonize\n");
 314                 return 10;
 315         }
 316 #endif
 317
 318         signal(SIGINT, sighandler);
 319
 320 #ifndef _WIN32
 321         /* we will only try to log things according to our debug_level */
 322         setlogmask(LOG_UPTO (LOG_DEBUG));
 323         openlog("lwsts", syslog_options, LOG_DAEMON);
 324 #endif
 325
 326         /* tell the library what debug level to emit and to send it to syslog */
 327         lws_set_log_level(debug_level, lwsl_emit_syslog);
 328
 329         lwsl_notice("libwebsockets test server - license LGPL2.1+SLE\n");
 330         lwsl_notice("(C) Copyright 2010-2016 Andy Green <andy@warmcat.com>\n");
 331
 332         printf("Using resource path \"%s\"\n", resource_path);
 333 #ifdef EXTERNAL_POLL
 334         max_poll_elements = getdtablesize();
 335         pollfds = malloc(max_poll_elements * sizeof (struct lws_pollfd));
 336         fd_lookup = malloc(max_poll_elements * sizeof (int));
 337         if (pollfds == NULL || fd_lookup == NULL) {
 338                 lwsl_err("Out of memory pollfds=%d\n", max_poll_elements);
 339                 return -1;
 340         }
 341 #endif
 342
 343         info.iface = iface;
 344         info.protocols = protocols;
 345         info.ssl_cert_filepath = NULL;
 346         info.ssl_private_key_filepath = NULL;
 347         info.ws_ping_pong_interval = pp_secs;
 348
 349         if (use_ssl) {
 350                 if (strlen(resource_path) > sizeof(cert_path) - 32) {
 351                         lwsl_err("resource path too long\n");
 352                         return -1;
 353                 }
 354                 if (!cert_path[0])
 355                         sprintf(cert_path, "%s/libwebsockets-test-server.pem",
 356                                                                 resource_path);
 357                 if (strlen(resource_path) > sizeof(key_path) - 32) {
 358                         lwsl_err("resource path too long\n");
 359                         return -1;
 360                 }
 361                 if (!key_path[0])
 362                         sprintf(key_path, "%s/libwebsockets-test-server.key.pem",
 363                                                                 resource_path);
 364
 365                 info.ssl_cert_filepath = cert_path;
 366                 info.ssl_private_key_filepath = key_path;
 367                 if (ca_path[0])
 368                         info.ssl_ca_filepath = ca_path;
 369         }
 370         info.gid = gid;
 371         info.uid = uid;
 372         info.max_http_header_pool = 16;
 373         info.options = opts | LWS_SERVER_OPTION_VALIDATE_UTF8;
 374         info.extensions = exts;
 375         info.timeout_secs = 5;
 376         info.ssl_cipher_list = "ECDHE-ECDSA-AES256-GCM-SHA384:"
 377                                "ECDHE-RSA-AES256-GCM-SHA384:"
 378                                "DHE-RSA-AES256-GCM-SHA384:"
 379                                "ECDHE-RSA-AES256-SHA384:"
 380                                "HIGH:!aNULL:!eNULL:!EXPORT:"
 381                                "!DES:!MD5:!PSK:!RC4:!HMAC_SHA1:"
 382                                "!SHA1:!DHE-RSA-AES128-GCM-SHA256:"
 383                                "!DHE-RSA-AES128-SHA256:"
 384                                "!AES128-GCM-SHA256:"
 385                                "!AES128-SHA256:"
 386                                "!DHE-RSA-AES256-SHA256:"
 387                                "!AES256-GCM-SHA384:"
 388                                "!AES256-SHA256";
 389
 390         if (use_ssl)
 391                 /* redirect guys coming on http */
 392                 info.options |= LWS_SERVER_OPTION_REDIRECT_HTTP_TO_HTTPS;
 393
 394         context = lws_create_context(&info);
 395         if (context == NULL) {
 396                 lwsl_err("libwebsocket init failed\n");
 397                 return -1;
 398         }
 399
 400         /* this shows how to override the lws file operations.  You don't need
 401          * to do any of this unless you have a reason (eg, want to serve
 402          * compressed files without decompressing the whole archive)
 403          */
 404         /* stash original platform fops */
 405         fops_plat = *(lws_get_fops(context));
 406         /* override the active fops */
 407         lws_get_fops(context)->open = test_server_fops_open;
 408
 409         n = 0;
 410 #ifdef EXTERNAL_POLL
 411         int ms_1sec = 0;
 412 #endif
 413         while (n >= 0 && !force_exit) {
 414                 struct timeval tv;
 415
 416                 gettimeofday(&tv, NULL);
 417
 418                 /*
 419                  * This provokes the LWS_CALLBACK_SERVER_WRITEABLE for every
 420                  * live websocket connection using the DUMB_INCREMENT protocol,
 421                  * as soon as it can take more packets (usually immediately)
 422                  */
 423
 424                 ms = (tv.tv_sec * 1000) + (tv.tv_usec / 1000);
 425                 if ((ms - oldms) > 50) {
 426                         lws_callback_on_writable_all_protocol(context,
 427                                 &protocols[PROTOCOL_DUMB_INCREMENT]);
 428                         oldms = ms;
 429                 }
 430
 431 #ifdef EXTERNAL_POLL
 432                 /*
 433                  * this represents an existing server's single poll action
 434                  * which also includes libwebsocket sockets
 435                  */
 436
 437                 n = poll(pollfds, count_pollfds, 50);
 438                 if (n < 0)
 439                         continue;
 440
 441                 if (n) {
 442                         for (n = 0; n < count_pollfds; n++)
 443                                 if (pollfds[n].revents)
 444                                         /*
 445                                         * returns immediately if the fd does not
 446                                         * match anything under libwebsockets
 447                                         * control
 448                                         */
 449                                         if (lws_service_fd(context,
 450                                                                   &pollfds[n]) < 0)
 451                                                 goto done;
 452
 453                         /* if needed, force-service wsis that may not have read all input */
 454                         while (!lws_service_adjust_timeout(context, 1, 0)) {
 455                                 lwsl_notice("extpoll doing forced service!\n");
 456                                 lws_service_tsi(context, -1, 0);
 457                         }
 458                 } else {
 459                         /* no revents, but before polling again, make lws check for any timeouts */
 460                         if (ms - ms_1sec > 1000) {
 461                                 lwsl_notice("1 per sec\n");
 462                                 lws_service_fd(context, NULL);
 463                                 ms_1sec = ms;
 464                         }
 465                 }
 466 #else
 467                 /*
 468                  * If libwebsockets sockets are all we care about,
 469                  * you can use this api which takes care of the poll()
 470                  * and looping through finding who needed service.
 471                  *
 472                  * If no socket needs service, it'll return anyway after
 473                  * the number of ms in the second argument.
 474                  */
 475
 476                 n = lws_service(context, 50);
 477 #endif
 478         }
 479
 480 #ifdef EXTERNAL_POLL
 481 done:
 482 #endif
 483
 484         lws_context_destroy(context);
 485
 486         lwsl_notice("libwebsockets-test-server exited cleanly\n");
 487
 488 #ifndef _WIN32
 489         closelog();
 490 #endif
 491
 492         return 0;
 493 }