lib/output.c

   1 /*
   2  * libwebsockets - small server side websockets and web server implementation
   3  *
   4  * Copyright (C) 2010-2014 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
  22 #include "private-libwebsockets.h"
  23
  24 static int
  25 libwebsocket_0405_frame_mask_generate(struct libwebsocket *wsi)
  26 {
  27         int n;
  28
  29         /* fetch the per-frame nonce */
  30
  31         n = libwebsockets_get_random(wsi->protocol->owning_server,
  32                                            wsi->u.ws.frame_masking_nonce_04, 4);
  33         if (n != 4) {
  34                 lwsl_parser("Unable to read from random device %s %d\n",
  35                                                      SYSTEM_RANDOM_FILEPATH, n);
  36                 return 1;
  37         }
  38
  39         /* start masking from first byte of masking key buffer */
  40         wsi->u.ws.frame_mask_index = 0;
  41
  42         return 0;
  43 }
  44
  45 #ifdef _DEBUG
  46
  47 LWS_VISIBLE void lwsl_hexdump(void *vbuf, size_t len)
  48 {
  49         int n;
  50         int m;
  51         int start;
  52         unsigned char *buf = (unsigned char *)vbuf;
  53         char line[80];
  54         char *p;
  55
  56         lwsl_parser("\n");
  57
  58         for (n = 0; n < len;) {
  59                 start = n;
  60                 p = line;
  61
  62                 p += sprintf(p, "%04X: ", start);
  63
  64                 for (m = 0; m < 16 && n < len; m++)
  65                         p += sprintf(p, "%02X ", buf[n++]);
  66                 while (m++ < 16)
  67                         p += sprintf(p, "   ");
  68
  69                 p += sprintf(p, "   ");
  70
  71                 for (m = 0; m < 16 && (start + m) < len; m++) {
  72                         if (buf[start + m] >= ' ' && buf[start + m] < 127)
  73                                 *p++ = buf[start + m];
  74                         else
  75                                 *p++ = '.';
  76                 }
  77                 while (m++ < 16)
  78                         *p++ = ' ';
  79
  80                 *p++ = '\n';
  81                 *p = '\0';
  82                 lwsl_debug("%s", line);
  83         }
  84         lwsl_debug("\n");
  85 }
  86
  87 #endif
  88
  89 /*
  90  * notice this returns number of bytes consumed, or -1
  91  */
  92
  93 int lws_issue_raw(struct libwebsocket *wsi, unsigned char *buf, size_t len)
  94 {
  95         struct libwebsocket_context *context = wsi->protocol->owning_server;
  96         int n;
  97         size_t real_len = len;
  98         int m;
  99
 100         if (!len)
 101                 return 0;
 102
 103         if (wsi->truncated_send_len && (buf < wsi->truncated_send_malloc ||
 104                         buf > (wsi->truncated_send_malloc +
 105                                 wsi->truncated_send_len +
 106                                 wsi->truncated_send_offset))) {
 107                 lwsl_err("****** %x Sending new, pending truncated ...\n", wsi);
 108                 assert(0);
 109         }
 110
 111         m = lws_ext_callback_for_each_active(wsi,
 112                         LWS_EXT_CALLBACK_PACKET_TX_DO_SEND, &buf, len);
 113         if (m < 0)
 114                 return -1;
 115         if (m) /* handled */ {
 116                 n = m;
 117                 goto handle_truncated_send;
 118         }
 119         if (wsi->sock < 0)
 120                 lwsl_warn("** error invalid sock but expected to send\n");
 121
 122         /*
 123          * nope, send it on the socket directly
 124          */
 125         lws_latency_pre(context, wsi);
 126
 127         n = lws_ssl_capable_write(wsi, buf, len);
 128         lws_latency(context, wsi, "send lws_issue_raw", n, n == len);
 129         switch (n) {
 130         case LWS_SSL_CAPABLE_ERROR:
 131                 return -1;
 132         case LWS_SSL_CAPABLE_MORE_SERVICE:
 133                 n = 0;
 134                 goto handle_truncated_send;
 135         }
 136
 137 handle_truncated_send:
 138         /*
 139          * already handling a truncated send?
 140          */
 141         if (wsi->truncated_send_len) {
 142                 lwsl_info("***** %x partial send moved on by %d (vs %d)\n",
 143                                                              wsi, n, real_len);
 144                 wsi->truncated_send_offset += n;
 145                 wsi->truncated_send_len -= n;
 146
 147                 if (!wsi->truncated_send_len) {
 148                         lwsl_info("***** %x partial send completed\n", wsi);
 149                         /* done with it, but don't free it */
 150                         n = real_len;
 151                 } else
 152                         libwebsocket_callback_on_writable(
 153                                              wsi->protocol->owning_server, wsi);
 154
 155                 return n;
 156         }
 157
 158         if (n < real_len) {
 159                 if (n && wsi->u.ws.clean_buffer)
 160                         /*
 161                          * This buffer unaffected by extension rewriting.
 162                          * It means the user code is expected to deal with
 163                          * partial sends.  (lws knows the header was already
 164                          * sent, so on next send will just resume sending
 165                          * payload)
 166                          */
 167                          return n;
 168
 169                 /*
 170                  * Newly truncated send.  Buffer the remainder (it will get
 171                  * first priority next time the socket is writable)
 172                  */
 173                 lwsl_info("***** %x new partial sent %d from %d total\n",
 174                                                               wsi, n, real_len);
 175
 176                 /*
 177                  *  - if we still have a suitable malloc lying around, use it
 178                  *  - or, if too small, reallocate it
 179                  *  - or, if no buffer, create it
 180                  */
 181                 if (!wsi->truncated_send_malloc ||
 182                                 real_len - n > wsi->truncated_send_allocation) {
 183                         if (wsi->truncated_send_malloc)
 184                                 free(wsi->truncated_send_malloc);
 185
 186                         wsi->truncated_send_allocation = real_len - n;
 187                         wsi->truncated_send_malloc = malloc(real_len - n);
 188                         if (!wsi->truncated_send_malloc) {
 189                                 lwsl_err(
 190                                    "truncated send: unable to malloc %d\n",
 191                                                                   real_len - n);
 192                                 return -1;
 193                         }
 194                 }
 195                 wsi->truncated_send_offset = 0;
 196                 wsi->truncated_send_len = real_len - n;
 197                 memcpy(wsi->truncated_send_malloc, buf + n, real_len - n);
 198
 199                 libwebsocket_callback_on_writable(
 200                                              wsi->protocol->owning_server, wsi);
 201
 202                 return real_len;
 203         }
 204
 205         return n;
 206 }
 207
 208 /**
 209  * libwebsocket_write() - Apply protocol then write data to client
 210  * @wsi:        Websocket instance (available from user callback)
 211  * @buf:        The data to send.  For data being sent on a websocket
 212  *              connection (ie, not default http), this buffer MUST have
 213  *              LWS_SEND_BUFFER_PRE_PADDING bytes valid BEFORE the pointer
 214  *              and an additional LWS_SEND_BUFFER_POST_PADDING bytes valid
 215  *              in the buffer after (buf + len).  This is so the protocol
 216  *              header and trailer data can be added in-situ.
 217  * @len:        Count of the data bytes in the payload starting from buf
 218  * @protocol:   Use LWS_WRITE_HTTP to reply to an http connection, and one
 219  *              of LWS_WRITE_BINARY or LWS_WRITE_TEXT to send appropriate
 220  *              data on a websockets connection.  Remember to allow the extra
 221  *              bytes before and after buf if LWS_WRITE_BINARY or LWS_WRITE_TEXT
 222  *              are used.
 223  *
 224  *      This function provides the way to issue data back to the client
 225  *      for both http and websocket protocols.
 226  *
 227  *      In the case of sending using websocket protocol, be sure to allocate
 228  *      valid storage before and after buf as explained above.  This scheme
 229  *      allows maximum efficiency of sending data and protocol in a single
 230  *      packet while not burdening the user code with any protocol knowledge.
 231  *
 232  *      Return may be -1 for a fatal error needing connection close, or a
 233  *      positive number reflecting the amount of bytes actually sent.  This
 234  *      can be less than the requested number of bytes due to OS memory
 235  *      pressure at any given time.
 236  */
 237
 238 LWS_VISIBLE int libwebsocket_write(struct libwebsocket *wsi, unsigned char *buf,
 239                           size_t len, enum libwebsocket_write_protocol protocol)
 240 {
 241         int n;
 242         int pre = 0;
 243         int post = 0;
 244         int masked7 = wsi->mode == LWS_CONNMODE_WS_CLIENT;
 245         unsigned char *dropmask = NULL;
 246         unsigned char is_masked_bit = 0;
 247         size_t orig_len = len;
 248         struct lws_tokens eff_buf;
 249
 250         if (len == 0 && protocol != LWS_WRITE_CLOSE &&
 251                      protocol != LWS_WRITE_PING && protocol != LWS_WRITE_PONG) {
 252                 lwsl_warn("zero length libwebsocket_write attempt\n");
 253                 return 0;
 254         }
 255
 256         if (protocol == LWS_WRITE_HTTP)
 257                 goto send_raw;
 258
 259         /* websocket protocol, either binary or text */
 260
 261         if (wsi->state != WSI_STATE_ESTABLISHED)
 262                 return -1;
 263
 264         /* if we are continuing a frame that already had its header done */
 265
 266         if (wsi->u.ws.inside_frame)
 267                 goto do_more_inside_frame;
 268
 269         /* if he wants all partials buffered, never have a clean_buffer */
 270         wsi->u.ws.clean_buffer = !wsi->protocol->no_buffer_all_partial_tx;
 271
 272         /*
 273          * give a chance to the extensions to modify payload
 274          * pre-TX mangling is not allowed to truncate
 275          */
 276         eff_buf.token = (char *)buf;
 277         eff_buf.token_len = len;
 278
 279         switch (protocol) {
 280         case LWS_WRITE_PING:
 281         case LWS_WRITE_PONG:
 282         case LWS_WRITE_CLOSE:
 283                 break;
 284         default:
 285                 if (lws_ext_callback_for_each_active(wsi,
 286                                LWS_EXT_CALLBACK_PAYLOAD_TX, &eff_buf, 0) < 0)
 287                         return -1;
 288         }
 289
 290         /*
 291          * an extension did something we need to keep... for example, if
 292          * compression extension, it has already updated its state according
 293          * to this being issued
 294          */
 295         if ((char *)buf != eff_buf.token)
 296                 /*
 297                  * extension recreated it:
 298                  * need to buffer this if not all sent
 299                  */
 300                 wsi->u.ws.clean_buffer = 0;
 301
 302         buf = (unsigned char *)eff_buf.token;
 303         len = eff_buf.token_len;
 304
 305         switch (wsi->ietf_spec_revision) {
 306         case 13:
 307
 308                 if (masked7) {
 309                         pre += 4;
 310                         dropmask = &buf[0 - pre];
 311                         is_masked_bit = 0x80;
 312                 }
 313
 314                 switch (protocol & 0xf) {
 315                 case LWS_WRITE_TEXT:
 316                         n = LWS_WS_OPCODE_07__TEXT_FRAME;
 317                         break;
 318                 case LWS_WRITE_BINARY:
 319                         n = LWS_WS_OPCODE_07__BINARY_FRAME;
 320                         break;
 321                 case LWS_WRITE_CONTINUATION:
 322                         n = LWS_WS_OPCODE_07__CONTINUATION;
 323                         break;
 324
 325                 case LWS_WRITE_CLOSE:
 326                         n = LWS_WS_OPCODE_07__CLOSE;
 327
 328                         /*
 329                          * 06+ has a 2-byte status code in network order
 330                          * we can do this because we demand post-buf
 331                          */
 332
 333                         if (wsi->u.ws.close_reason) {
 334                                 /* reason codes count as data bytes */
 335                                 buf -= 2;
 336                                 buf[0] = wsi->u.ws.close_reason >> 8;
 337                                 buf[1] = wsi->u.ws.close_reason;
 338                                 len += 2;
 339                         }
 340                         break;
 341                 case LWS_WRITE_PING:
 342                         n = LWS_WS_OPCODE_07__PING;
 343                         break;
 344                 case LWS_WRITE_PONG:
 345                         n = LWS_WS_OPCODE_07__PONG;
 346                         break;
 347                 default:
 348                         lwsl_warn("lws_write: unknown write opc / protocol\n");
 349                         return -1;
 350                 }
 351
 352                 if (!(protocol & LWS_WRITE_NO_FIN))
 353                         n |= 1 << 7;
 354
 355                 if (len < 126) {
 356                         pre += 2;
 357                         buf[-pre] = n;
 358                         buf[-pre + 1] = len | is_masked_bit;
 359                 } else {
 360                         if (len < 65536) {
 361                                 pre += 4;
 362                                 buf[-pre] = n;
 363                                 buf[-pre + 1] = 126 | is_masked_bit;
 364                                 buf[-pre + 2] = len >> 8;
 365                                 buf[-pre + 3] = len;
 366                         } else {
 367                                 pre += 10;
 368                                 buf[-pre] = n;
 369                                 buf[-pre + 1] = 127 | is_masked_bit;
 370 #if defined __LP64__
 371                                         buf[-pre + 2] = (len >> 56) & 0x7f;
 372                                         buf[-pre + 3] = len >> 48;
 373                                         buf[-pre + 4] = len >> 40;
 374                                         buf[-pre + 5] = len >> 32;
 375 #else
 376                                         buf[-pre + 2] = 0;
 377                                         buf[-pre + 3] = 0;
 378                                         buf[-pre + 4] = 0;
 379                                         buf[-pre + 5] = 0;
 380 #endif
 381                                 buf[-pre + 6] = len >> 24;
 382                                 buf[-pre + 7] = len >> 16;
 383                                 buf[-pre + 8] = len >> 8;
 384                                 buf[-pre + 9] = len;
 385                         }
 386                 }
 387                 break;
 388         }
 389
 390 do_more_inside_frame:
 391
 392         /*
 393          * Deal with masking if we are in client -> server direction and
 394          * the protocol demands it
 395          */
 396
 397         if (wsi->mode == LWS_CONNMODE_WS_CLIENT) {
 398
 399                 if (!wsi->u.ws.inside_frame)
 400                         if (libwebsocket_0405_frame_mask_generate(wsi)) {
 401                                 lwsl_err("frame mask generation failed\n");
 402                                 return -1;
 403                         }
 404
 405                 /*
 406                  * in v7, just mask the payload
 407                  */
 408                 if (dropmask) { /* never set if already inside frame */
 409                         for (n = 4; n < (int)len + 4; n++)
 410                                 dropmask[n] = dropmask[n] ^
 411                                 wsi->u.ws.frame_masking_nonce_04[
 412                                         (wsi->u.ws.frame_mask_index++) & 3];
 413
 414                         /* copy the frame nonce into place */
 415                         memcpy(dropmask, wsi->u.ws.frame_masking_nonce_04, 4);
 416                 }
 417         }
 418
 419 send_raw:
 420         switch (protocol) {
 421         case LWS_WRITE_CLOSE:
 422 /*              lwsl_hexdump(&buf[-pre], len + post); */
 423         case LWS_WRITE_HTTP:
 424         case LWS_WRITE_PONG:
 425         case LWS_WRITE_PING:
 426                 return lws_issue_raw(wsi, (unsigned char *)buf - pre,
 427                                                               len + pre + post);
 428         default:
 429                 break;
 430         }
 431
 432         wsi->u.ws.inside_frame = 1;
 433
 434         /*
 435          * give any active extensions a chance to munge the buffer
 436          * before send.  We pass in a pointer to an lws_tokens struct
 437          * prepared with the default buffer and content length that's in
 438          * there.  Rather than rewrite the default buffer, extensions
 439          * that expect to grow the buffer can adapt .token to
 440          * point to their own per-connection buffer in the extension
 441          * user allocation.  By default with no extensions or no
 442          * extension callback handling, just the normal input buffer is
 443          * used then so it is efficient.
 444          *
 445          * callback returns 1 in case it wants to spill more buffers
 446          *
 447          * This takes care of holding the buffer if send is incomplete, ie,
 448          * if wsi->u.ws.clean_buffer is 0 (meaning an extension meddled with
 449          * the buffer).  If wsi->u.ws.clean_buffer is 1, it will instead
 450          * return to the user code how much OF THE USER BUFFER was consumed.
 451          */
 452
 453         n = lws_issue_raw_ext_access(wsi, buf - pre, len + pre + post);
 454         if (n <= 0)
 455                 return n;
 456
 457         if (n == len + pre + post) {
 458                 /* everything in the buffer was handled (or rebuffered...) */
 459                 wsi->u.ws.inside_frame = 0;
 460                 return orig_len;
 461         }
 462
 463         /*
 464          * it is how many bytes of user buffer got sent... may be < orig_len
 465          * in which case callback when writable has already been arranged
 466          * and user code can call libwebsocket_write() again with the rest
 467          * later.
 468          */
 469
 470         return n - (pre + post);
 471 }
 472
 473 LWS_VISIBLE int libwebsockets_serve_http_file_fragment(
 474                 struct libwebsocket_context *context, struct libwebsocket *wsi)
 475 {
 476         int n;
 477         int m;
 478
 479         while (!lws_send_pipe_choked(wsi)) {
 480
 481                 if (wsi->truncated_send_len) {
 482                         lws_issue_raw(wsi, wsi->truncated_send_malloc +
 483                                         wsi->truncated_send_offset,
 484                                                        wsi->truncated_send_len);
 485                         continue;
 486                 }
 487
 488                 if (wsi->u.http.filepos == wsi->u.http.filelen)
 489                         goto all_sent;
 490
 491                 compatible_file_read(n, wsi->u.http.fd, context->service_buffer,
 492                                                sizeof(context->service_buffer));
 493                 if (n < 0)
 494                         return -1; /* caller will close */
 495                 if (n) {
 496                         m = libwebsocket_write(wsi, context->service_buffer, n,
 497                                                                 LWS_WRITE_HTTP);
 498                         if (m < 0)
 499                                 return -1;
 500
 501                         wsi->u.http.filepos += m;
 502                         if (m != n)
 503                                 /* adjust for what was not sent */
 504                                 compatible_file_seek_cur(wsi->u.http.fd, m - n);
 505                 }
 506 all_sent:
 507                 if (!wsi->truncated_send_len &&
 508                                 wsi->u.http.filepos == wsi->u.http.filelen) {
 509                         wsi->state = WSI_STATE_HTTP;
 510
 511                         if (wsi->protocol->callback)
 512                                 /* ignore callback returned value */
 513                                 user_callback_handle_rxflow(
 514                                         wsi->protocol->callback, context, wsi,
 515                                         LWS_CALLBACK_HTTP_FILE_COMPLETION,
 516                                         wsi->user_space, NULL, 0);
 517                         return 1;  /* >0 indicates completed */
 518                 }
 519         }
 520
 521         lwsl_info("choked before able to send whole file (post)\n");
 522         libwebsocket_callback_on_writable(context, wsi);
 523
 524         return 0; /* indicates further processing must be done */
 525 }
 526
 527 LWS_VISIBLE int
 528 lws_ssl_capable_read_no_ssl(struct libwebsocket *wsi, unsigned char *buf, int len)
 529 {
 530         int n;
 531
 532         n = recv(wsi->sock, buf, len, 0);
 533         if (n < 0) {
 534                 lwsl_warn("error on reading from skt\n");
 535                 return LWS_SSL_CAPABLE_ERROR;
 536         }
 537
 538         return n;
 539 }
 540
 541 LWS_VISIBLE int
 542 lws_ssl_capable_write_no_ssl(struct libwebsocket *wsi, unsigned char *buf, int len)
 543 {
 544         int n;
 545
 546         n = send(wsi->sock, buf, len, MSG_NOSIGNAL);
 547         if (n < 0) {
 548                 if (LWS_ERRNO == LWS_EAGAIN ||
 549                     LWS_ERRNO == LWS_EWOULDBLOCK ||
 550                     LWS_ERRNO == LWS_EINTR) {
 551                         if (LWS_ERRNO == LWS_EWOULDBLOCK)
 552                                 lws_set_blocking_send(wsi);
 553                         return LWS_SSL_CAPABLE_MORE_SERVICE;
 554                 }
 555                 lwsl_debug("ERROR writing len %d to skt %d\n", len, n);
 556                 return LWS_SSL_CAPABLE_ERROR;
 557         }
 558
 559         return n;
 560 }