test-server/test-server-http.c

   1 /*
   2  * libwebsockets-test-server - libwebsockets test implementation
   3  *
   4  * Copyright (C) 2010-2015 Andy Green <andy@warmcat.com>
   5  *
   6  *  This library is free software; you can redistribute it and/or
   7  *  modify it under the terms of the GNU Lesser General Public
   8  *  License as published by the Free Software Foundation:
   9  *  version 2.1 of the License.
  10  *
  11  *  This library is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  *  Lesser General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU Lesser General Public
  17  *  License along with this library; if not, write to the Free Software
  18  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  19  *  MA  02110-1301  USA
  20  */
  21 #include "test-server.h"
  22
  23 /*
  24  * This demo server shows how to use libwebsockets for one or more
  25  * websocket protocols in the same server
  26  *
  27  * It defines the following websocket protocols:
  28  *
  29  *  dumb-increment-protocol:  once the socket is opened, an incrementing
  30  *                              ascii string is sent down it every 50ms.
  31  *                              If you send "reset\n" on the websocket, then
  32  *                              the incrementing number is reset to 0.
  33  *
  34  *  lws-mirror-protocol: copies any received packet to every connection also
  35  *                              using this protocol, including the sender
  36  */
  37
  38 enum demo_protocols {
  39         /* always first */
  40         PROTOCOL_HTTP = 0,
  41
  42         PROTOCOL_DUMB_INCREMENT,
  43         PROTOCOL_LWS_MIRROR,
  44
  45         /* always last */
  46         DEMO_PROTOCOL_COUNT
  47 };
  48
  49 /*
  50  * We take a strict whitelist approach to stop ../ attacks
  51  */
  52 struct serveable {
  53         const char *urlpath;
  54         const char *mimetype;
  55 };
  56
  57 /*
  58  * this is just an example of parsing handshake headers, you don't need this
  59  * in your code unless you will filter allowing connections by the header
  60  * content
  61  */
  62 void
  63 dump_handshake_info(struct lws *wsi)
  64 {
  65         int n = 0;
  66         char buf[256];
  67         const unsigned char *c;
  68
  69         do {
  70                 c = lws_token_to_string(n);
  71                 if (!c) {
  72                         n++;
  73                         continue;
  74                 }
  75
  76                 if (!lws_hdr_total_length(wsi, n)) {
  77                         n++;
  78                         continue;
  79                 }
  80
  81                 lws_hdr_copy(wsi, buf, sizeof buf, n);
  82
  83                 fprintf(stderr, "    %s = %s\n", (char *)c, buf);
  84                 n++;
  85         } while (c);
  86 }
  87
  88 const char * get_mimetype(const char *file)
  89 {
  90         int n = strlen(file);
  91
  92         if (n < 5)
  93                 return NULL;
  94
  95         if (!strcmp(&file[n - 4], ".ico"))
  96                 return "image/x-icon";
  97
  98         if (!strcmp(&file[n - 4], ".png"))
  99                 return "image/png";
 100
 101         if (!strcmp(&file[n - 5], ".html"))
 102                 return "text/html";
 103
 104         return NULL;
 105 }
 106
 107 /* this protocol server (always the first one) handles HTTP,
 108  *
 109  * Some misc callbacks that aren't associated with a protocol also turn up only
 110  * here on the first protocol server.
 111  */
 112
 113 int callback_http(struct lws_context *context, struct lws *wsi,
 114                   enum lws_callback_reasons reason, void *user,
 115                   void *in, size_t len)
 116 {
 117         struct per_session_data__http *pss =
 118                         (struct per_session_data__http *)user;
 119         static unsigned char buffer[4096];
 120         unsigned long amount, file_len;
 121         char leaf_path[1024];
 122         const char *mimetype;
 123         char *other_headers;
 124         unsigned char *end;
 125         struct timeval tv;
 126         unsigned char *p;
 127         char buf[256];
 128         char b64[64];
 129         int n, m;
 130
 131 #ifdef EXTERNAL_POLL
 132         struct lws_pollargs *pa = (struct lws_pollargs *)in;
 133 #endif
 134
 135         switch (reason) {
 136         case LWS_CALLBACK_HTTP:
 137
 138                 dump_handshake_info(wsi);
 139
 140                 /* dump the individual URI Arg parameters */
 141                 m = 1;
 142                 n = 0;
 143                 while (m > 0) {
 144                         m = lws_hdr_copy_fragment(wsi, buf, sizeof(buf),
 145                                                   WSI_TOKEN_HTTP_URI_ARGS, n);
 146                         if (m < 0)
 147                                 continue;
 148                         n++;
 149                         lwsl_info("URI Arg %d: %s\n", n, buf);
 150                 }
 151
 152                 if (len < 1) {
 153                         lws_return_http_status(context, wsi,
 154                                                 HTTP_STATUS_BAD_REQUEST, NULL);
 155                         goto try_to_reuse;
 156                 }
 157
 158                 /* this example server has no concept of directories */
 159                 if (strchr((const char *)in + 1, '/')) {
 160                         lws_return_http_status(context, wsi,
 161                                                 HTTP_STATUS_FORBIDDEN, NULL);
 162                         goto try_to_reuse;
 163                 }
 164
 165                 /* if a legal POST URL, let it continue and accept data */
 166                 if (lws_hdr_total_length(wsi, WSI_TOKEN_POST_URI))
 167                         return 0;
 168
 169                 /* check for the "send a big file by hand" example case */
 170
 171                 if (!strcmp((const char *)in, "/leaf.jpg")) {
 172                         if (strlen(resource_path) > sizeof(leaf_path) - 10)
 173                                 return -1;
 174                         sprintf(leaf_path, "%s/leaf.jpg", resource_path);
 175
 176                         /* well, let's demonstrate how to send the hard way */
 177
 178                         p = buffer + LWS_SEND_BUFFER_PRE_PADDING;
 179                         end = p + sizeof(buffer) - LWS_SEND_BUFFER_PRE_PADDING;
 180
 181                         pss->fd = lws_plat_file_open(wsi, leaf_path, &file_len,
 182                                                      LWS_O_RDONLY);
 183
 184                         if (pss->fd == LWS_INVALID_FILE)
 185                                 return -1;
 186
 187                         /*
 188                          * we will send a big jpeg file, but it could be
 189                          * anything.  Set the Content-Type: appropriately
 190                          * so the browser knows what to do with it.
 191                          *
 192                          * Notice we use the APIs to build the header, which
 193                          * will do the right thing for HTTP 1/1.1 and HTTP2
 194                          * depending on what connection it happens to be working
 195                          * on
 196                          */
 197                         if (lws_add_http_header_status(context, wsi, 200, &p, end))
 198                                 return 1;
 199                         if (lws_add_http_header_by_token(context, wsi,
 200                                         WSI_TOKEN_HTTP_SERVER,
 201                                         (unsigned char *)"libwebsockets",
 202                                         13, &p, end))
 203                                 return 1;
 204                         if (lws_add_http_header_by_token(context, wsi,
 205                                         WSI_TOKEN_HTTP_CONTENT_TYPE,
 206                                         (unsigned char *)"image/jpeg",
 207                                         10, &p, end))
 208                                 return 1;
 209                         if (lws_add_http_header_content_length(context, wsi,
 210                                                                file_len, &p,
 211                                                                end))
 212                                 return 1;
 213                         if (lws_finalize_http_header(context, wsi, &p, end))
 214                                 return 1;
 215
 216                         /*
 217                          * send the http headers...
 218                          * this won't block since it's the first payload sent
 219                          * on the connection since it was established
 220                          * (too small for partial)
 221                          *
 222                          * Notice they are sent using LWS_WRITE_HTTP_HEADERS
 223                          * which also means you can't send body too in one step,
 224                          * this is mandated by changes in HTTP2
 225                          */
 226
 227                         n = lws_write(wsi, buffer + LWS_SEND_BUFFER_PRE_PADDING,
 228                                       p - (buffer + LWS_SEND_BUFFER_PRE_PADDING),
 229                                       LWS_WRITE_HTTP_HEADERS);
 230
 231                         if (n < 0) {
 232                                 lws_plat_file_close(wsi, pss->fd);
 233                                 return -1;
 234                         }
 235                         /*
 236                          * book us a LWS_CALLBACK_HTTP_WRITEABLE callback
 237                          */
 238                         lws_callback_on_writable(context, wsi);
 239                         break;
 240                 }
 241
 242                 /* if not, send a file the easy way */
 243                 strcpy(buf, resource_path);
 244                 if (strcmp(in, "/")) {
 245                         if (*((const char *)in) != '/')
 246                                 strcat(buf, "/");
 247                         strncat(buf, in, sizeof(buf) - strlen(resource_path));
 248                 } else /* default file to serve */
 249                         strcat(buf, "/test.html");
 250                 buf[sizeof(buf) - 1] = '\0';
 251
 252                 /* refuse to serve files we don't understand */
 253                 mimetype = get_mimetype(buf);
 254                 if (!mimetype) {
 255                         lwsl_err("Unknown mimetype for %s\n", buf);
 256                         lws_return_http_status(context, wsi,
 257                                       HTTP_STATUS_UNSUPPORTED_MEDIA_TYPE, NULL);
 258                         return -1;
 259                 }
 260
 261                 /* demostrates how to set a cookie on / */
 262
 263                 other_headers = NULL;
 264                 n = 0;
 265                 if (!strcmp((const char *)in, "/") &&
 266                            !lws_hdr_total_length(wsi, WSI_TOKEN_HTTP_COOKIE)) {
 267                         /* this isn't very unguessable but it'll do for us */
 268                         gettimeofday(&tv, NULL);
 269                         n = sprintf(b64, "test=LWS_%u_%u_COOKIE;Max-Age=360000",
 270                                 (unsigned int)tv.tv_sec,
 271                                 (unsigned int)tv.tv_usec);
 272
 273                         p = (unsigned char *)leaf_path;
 274
 275                         if (lws_add_http_header_by_name(context, wsi,
 276                                 (unsigned char *)"set-cookie:",
 277                                 (unsigned char *)b64, n, &p,
 278                                 (unsigned char *)leaf_path + sizeof(leaf_path)))
 279                                 return 1;
 280                         n = (char *)p - leaf_path;
 281                         other_headers = leaf_path;
 282                 }
 283
 284                 n = lws_serve_http_file(context, wsi, buf,
 285                                                 mimetype, other_headers, n);
 286                 if (n < 0 || ((n > 0) && lws_http_transaction_completed(wsi)))
 287                         return -1; /* error or can't reuse connection: close the socket */
 288
 289                 /*
 290                  * notice that the sending of the file completes asynchronously,
 291                  * we'll get a LWS_CALLBACK_HTTP_FILE_COMPLETION callback when
 292                  * it's done
 293                  */
 294
 295                 break;
 296
 297         case LWS_CALLBACK_HTTP_BODY:
 298                 strncpy(buf, in, 20);
 299                 buf[20] = '\0';
 300                 if (len < 20)
 301                         buf[len] = '\0';
 302
 303                 lwsl_notice("LWS_CALLBACK_HTTP_BODY: %s... len %d\n",
 304                                 (const char *)buf, (int)len);
 305
 306                 break;
 307
 308         case LWS_CALLBACK_HTTP_BODY_COMPLETION:
 309                 lwsl_notice("LWS_CALLBACK_HTTP_BODY_COMPLETION\n");
 310                 /* the whole of the sent body arrived, close or reuse the connection */
 311                 lws_return_http_status(context, wsi,
 312                                                 HTTP_STATUS_OK, NULL);
 313                 goto try_to_reuse;
 314
 315         case LWS_CALLBACK_HTTP_FILE_COMPLETION:
 316                 goto try_to_reuse;
 317
 318         case LWS_CALLBACK_HTTP_WRITEABLE:
 319                 /*
 320                  * we can send more of whatever it is we were sending
 321                  */
 322                 do {
 323                         /* we'd like the send this much */
 324                         n = sizeof(buffer) - LWS_SEND_BUFFER_PRE_PADDING;
 325
 326                         /* but if the peer told us he wants less, we can adapt */
 327                         m = lws_get_peer_write_allowance(wsi);
 328
 329                         /* -1 means not using a protocol that has this info */
 330                         if (m == 0)
 331                                 /* right now, peer can't handle anything */
 332                                 goto later;
 333
 334                         if (m != -1 && m < n)
 335                                 /* he couldn't handle that much */
 336                                 n = m;
 337
 338                         n = lws_plat_file_read(wsi, pss->fd,
 339                                                &amount, buffer +
 340                                                 LWS_SEND_BUFFER_PRE_PADDING, n);
 341                         /* problem reading, close conn */
 342                         if (n < 0)
 343                                 goto bail;
 344                         n = (int)amount;
 345                         /* sent it all, close conn */
 346                         if (n == 0)
 347                                 goto flush_bail;
 348                         /*
 349                          * To support HTTP2, must take care about preamble space
 350                          *
 351                          * identification of when we send the last payload frame
 352                          * is handled by the library itself if you sent a
 353                          * content-length header
 354                          */
 355                         m = lws_write(wsi, buffer + LWS_SEND_BUFFER_PRE_PADDING,
 356                                       n, LWS_WRITE_HTTP);
 357                         if (m < 0)
 358                                 /* write failed, close conn */
 359                                 goto bail;
 360
 361                         /*
 362                          * http2 won't do this
 363                          */
 364                         if (m != n)
 365                                 /* partial write, adjust */
 366                                 if (lws_plat_file_seek_cur(wsi, pss->fd, m - n) ==
 367                                                              (unsigned long)-1)
 368                                         goto bail;
 369
 370                         if (m) /* while still active, extend timeout */
 371                                 lws_set_timeout(wsi,
 372                                                 PENDING_TIMEOUT_HTTP_CONTENT, 5);
 373
 374                         /* if we have indigestion, let him clear it
 375                          * before eating more */
 376                         if (lws_partial_buffered(wsi))
 377                                 break;
 378
 379                 } while (!lws_send_pipe_choked(wsi));
 380
 381 later:
 382                 lws_callback_on_writable(context, wsi);
 383                 break;
 384 flush_bail:
 385                 /* true if still partial pending */
 386                 if (lws_partial_buffered(wsi)) {
 387                         lws_callback_on_writable(context, wsi);
 388                         break;
 389                 }
 390                 lws_plat_file_close(wsi, pss->fd);
 391                 goto try_to_reuse;
 392
 393 bail:
 394                 lws_plat_file_close(wsi, pss->fd);
 395                 return -1;
 396
 397         /*
 398          * callback for confirming to continue with client IP appear in
 399          * protocol 0 callback since no websocket protocol has been agreed
 400          * yet.  You can just ignore this if you won't filter on client IP
 401          * since the default uhandled callback return is 0 meaning let the
 402          * connection continue.
 403          */
 404         case LWS_CALLBACK_FILTER_NETWORK_CONNECTION:
 405
 406                 /* if we returned non-zero from here, we kill the connection */
 407                 break;
 408
 409         /*
 410          * callbacks for managing the external poll() array appear in
 411          * protocol 0 callback
 412          */
 413
 414         case LWS_CALLBACK_LOCK_POLL:
 415                 /*
 416                  * lock mutex to protect pollfd state
 417                  * called before any other POLL related callback
 418                  * if protecting wsi lifecycle change, len == 1
 419                  */
 420                 test_server_lock(len);
 421                 break;
 422
 423         case LWS_CALLBACK_UNLOCK_POLL:
 424                 /*
 425                  * unlock mutex to protect pollfd state when
 426                  * called after any other POLL related callback
 427                  * if protecting wsi lifecycle change, len == 1
 428                  */
 429                 test_server_unlock(len);
 430                 break;
 431
 432 #ifdef EXTERNAL_POLL
 433         case LWS_CALLBACK_ADD_POLL_FD:
 434
 435                 if (count_pollfds >= max_poll_elements) {
 436                         lwsl_err("LWS_CALLBACK_ADD_POLL_FD: too many sockets to track\n");
 437                         return 1;
 438                 }
 439
 440                 fd_lookup[pa->fd] = count_pollfds;
 441                 pollfds[count_pollfds].fd = pa->fd;
 442                 pollfds[count_pollfds].events = pa->events;
 443                 pollfds[count_pollfds++].revents = 0;
 444                 break;
 445
 446         case LWS_CALLBACK_DEL_POLL_FD:
 447                 if (!--count_pollfds)
 448                         break;
 449                 m = fd_lookup[pa->fd];
 450                 /* have the last guy take up the vacant slot */
 451                 pollfds[m] = pollfds[count_pollfds];
 452                 fd_lookup[pollfds[count_pollfds].fd] = m;
 453                 break;
 454
 455         case LWS_CALLBACK_CHANGE_MODE_POLL_FD:
 456                 pollfds[fd_lookup[pa->fd]].events = pa->events;
 457                 break;
 458 #endif
 459
 460         case LWS_CALLBACK_GET_THREAD_ID:
 461                 /*
 462                  * if you will call "lws_callback_on_writable"
 463                  * from a different thread, return the caller thread ID
 464                  * here so lws can use this information to work out if it
 465                  * should signal the poll() loop to exit and restart early
 466                  */
 467
 468                 /* return pthread_getthreadid_np(); */
 469
 470                 break;
 471
 472         default:
 473                 break;
 474         }
 475
 476         return 0;
 477
 478         /* if we're on HTTP1.1 or 2.0, will keep the idle connection alive */
 479 try_to_reuse:
 480         if (lws_http_transaction_completed(wsi))
 481                 return -1;
 482
 483         return 0;
 484 }