lib/parsers.c

   1 /*
   2  * libwebsockets - small server side websockets and web server implementation
   3  *
   4  * Copyright (C) 2010-2013 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 #ifdef WIN32
  25 #include <io.h>
  26 #endif
  27
  28
  29 unsigned char lextable[] = {
  30 /* pos 0: state 0 */
  31    0x47 /* 'G' */, 0x07 /* to pos 14 state 1 */,
  32    0x48 /* 'H' */, 0x0A /* to pos 22 state 5 */,
  33    0x43 /* 'C' */, 0x0F /* to pos 34 state 10 */,
  34    0x53 /* 'S' */, 0x19 /* to pos 56 state 21 */,
  35    0x55 /* 'U' */, 0x3F /* to pos 134 state 51 */,
  36    0x4F /* 'O' */, 0x46 /* to pos 150 state 59 */,
  37    0x8D /* '.' */, 0x52 /* to pos 176 state 72 */,
  38 /* pos 14: state 1 */
  39    0xC5 /* 'E' */, 0x01 /* to pos 16 state 2 */,
  40 /* pos 16: state 2 */
  41    0xD4 /* 'T' */, 0x01 /* to pos 18 state 3 */,
  42 /* pos 18: state 3 */
  43    0xA0 /* ' ' */, 0x01 /* to pos 20 state 4 */,
  44 /* pos 20: state 4 */
  45    0x80, 0x00 /* terminal marker */,
  46 /* pos 22: state 5 */
  47    0x6F /* 'o' */, 0x02 /* to pos 26 state 6 */,
  48    0xD4 /* 'T' */, 0x76 /* to pos 260 state 114 */,
  49 /* pos 26: state 6 */
  50    0xF3 /* 's' */, 0x01 /* to pos 28 state 7 */,
  51 /* pos 28: state 7 */
  52    0xF4 /* 't' */, 0x01 /* to pos 30 state 8 */,
  53 /* pos 30: state 8 */
  54    0xBA /* ':' */, 0x01 /* to pos 32 state 9 */,
  55 /* pos 32: state 9 */
  56    0x81, 0x00 /* terminal marker */,
  57 /* pos 34: state 10 */
  58    0xEF /* 'o' */, 0x01 /* to pos 36 state 11 */,
  59 /* pos 36: state 11 */
  60    0xEE /* 'n' */, 0x01 /* to pos 38 state 12 */,
  61 /* pos 38: state 12 */
  62    0xEE /* 'n' */, 0x01 /* to pos 40 state 13 */,
  63 /* pos 40: state 13 */
  64    0xE5 /* 'e' */, 0x01 /* to pos 42 state 14 */,
  65 /* pos 42: state 14 */
  66    0xE3 /* 'c' */, 0x01 /* to pos 44 state 15 */,
  67 /* pos 44: state 15 */
  68    0xF4 /* 't' */, 0x01 /* to pos 46 state 16 */,
  69 /* pos 46: state 16 */
  70    0xE9 /* 'i' */, 0x01 /* to pos 48 state 17 */,
  71 /* pos 48: state 17 */
  72    0xEF /* 'o' */, 0x01 /* to pos 50 state 18 */,
  73 /* pos 50: state 18 */
  74    0xEE /* 'n' */, 0x01 /* to pos 52 state 19 */,
  75 /* pos 52: state 19 */
  76    0xBA /* ':' */, 0x01 /* to pos 54 state 20 */,
  77 /* pos 54: state 20 */
  78    0x82, 0x00 /* terminal marker */,
  79 /* pos 56: state 21 */
  80    0xE5 /* 'e' */, 0x01 /* to pos 58 state 22 */,
  81 /* pos 58: state 22 */
  82    0xE3 /* 'c' */, 0x01 /* to pos 60 state 23 */,
  83 /* pos 60: state 23 */
  84    0xAD /* '-' */, 0x01 /* to pos 62 state 24 */,
  85 /* pos 62: state 24 */
  86    0xD7 /* 'W' */, 0x01 /* to pos 64 state 25 */,
  87 /* pos 64: state 25 */
  88    0xE5 /* 'e' */, 0x01 /* to pos 66 state 26 */,
  89 /* pos 66: state 26 */
  90    0xE2 /* 'b' */, 0x01 /* to pos 68 state 27 */,
  91 /* pos 68: state 27 */
  92    0xD3 /* 'S' */, 0x01 /* to pos 70 state 28 */,
  93 /* pos 70: state 28 */
  94    0xEF /* 'o' */, 0x01 /* to pos 72 state 29 */,
  95 /* pos 72: state 29 */
  96    0xE3 /* 'c' */, 0x01 /* to pos 74 state 30 */,
  97 /* pos 74: state 30 */
  98    0xEB /* 'k' */, 0x01 /* to pos 76 state 31 */,
  99 /* pos 76: state 31 */
 100    0xE5 /* 'e' */, 0x01 /* to pos 78 state 32 */,
 101 /* pos 78: state 32 */
 102    0xF4 /* 't' */, 0x01 /* to pos 80 state 33 */,
 103 /* pos 80: state 33 */
 104    0xAD /* '-' */, 0x01 /* to pos 82 state 34 */,
 105 /* pos 82: state 34 */
 106    0x4B /* 'K' */, 0x08 /* to pos 98 state 35 */,
 107    0x50 /* 'P' */, 0x10 /* to pos 116 state 42 */,
 108    0x44 /* 'D' */, 0x27 /* to pos 164 state 66 */,
 109    0x56 /* 'V' */, 0x2F /* to pos 182 state 75 */,
 110    0x4F /* 'O' */, 0x36 /* to pos 198 state 83 */,
 111    0x45 /* 'E' */, 0x3C /* to pos 212 state 90 */,
 112    0x41 /* 'A' */, 0x46 /* to pos 234 state 101 */,
 113    0xCE /* 'N' */, 0x4C /* to pos 248 state 108 */,
 114 /* pos 98: state 35 */
 115    0xE5 /* 'e' */, 0x01 /* to pos 100 state 36 */,
 116 /* pos 100: state 36 */
 117    0xF9 /* 'y' */, 0x01 /* to pos 102 state 37 */,
 118 /* pos 102: state 37 */
 119    0x31 /* '1' */, 0x03 /* to pos 108 state 38 */,
 120    0x32 /* '2' */, 0x04 /* to pos 112 state 40 */,
 121    0xBA /* ':' */, 0x25 /* to pos 180 state 74 */,
 122 /* pos 108: state 38 */
 123    0xBA /* ':' */, 0x01 /* to pos 110 state 39 */,
 124 /* pos 110: state 39 */
 125    0x83, 0x00 /* terminal marker */,
 126 /* pos 112: state 40 */
 127    0xBA /* ':' */, 0x01 /* to pos 114 state 41 */,
 128 /* pos 114: state 41 */
 129    0x84, 0x00 /* terminal marker */,
 130 /* pos 116: state 42 */
 131    0xF2 /* 'r' */, 0x01 /* to pos 118 state 43 */,
 132 /* pos 118: state 43 */
 133    0xEF /* 'o' */, 0x01 /* to pos 120 state 44 */,
 134 /* pos 120: state 44 */
 135    0xF4 /* 't' */, 0x01 /* to pos 122 state 45 */,
 136 /* pos 122: state 45 */
 137    0xEF /* 'o' */, 0x01 /* to pos 124 state 46 */,
 138 /* pos 124: state 46 */
 139    0xE3 /* 'c' */, 0x01 /* to pos 126 state 47 */,
 140 /* pos 126: state 47 */
 141    0xEF /* 'o' */, 0x01 /* to pos 128 state 48 */,
 142 /* pos 128: state 48 */
 143    0xEC /* 'l' */, 0x01 /* to pos 130 state 49 */,
 144 /* pos 130: state 49 */
 145    0xBA /* ':' */, 0x01 /* to pos 132 state 50 */,
 146 /* pos 132: state 50 */
 147    0x85, 0x00 /* terminal marker */,
 148 /* pos 134: state 51 */
 149    0xF0 /* 'p' */, 0x01 /* to pos 136 state 52 */,
 150 /* pos 136: state 52 */
 151    0xE7 /* 'g' */, 0x01 /* to pos 138 state 53 */,
 152 /* pos 138: state 53 */
 153    0xF2 /* 'r' */, 0x01 /* to pos 140 state 54 */,
 154 /* pos 140: state 54 */
 155    0xE1 /* 'a' */, 0x01 /* to pos 142 state 55 */,
 156 /* pos 142: state 55 */
 157    0xE4 /* 'd' */, 0x01 /* to pos 144 state 56 */,
 158 /* pos 144: state 56 */
 159    0xE5 /* 'e' */, 0x01 /* to pos 146 state 57 */,
 160 /* pos 146: state 57 */
 161    0xBA /* ':' */, 0x01 /* to pos 148 state 58 */,
 162 /* pos 148: state 58 */
 163    0x86, 0x00 /* terminal marker */,
 164 /* pos 150: state 59 */
 165    0xF2 /* 'r' */, 0x01 /* to pos 152 state 60 */,
 166 /* pos 152: state 60 */
 167    0xE9 /* 'i' */, 0x01 /* to pos 154 state 61 */,
 168 /* pos 154: state 61 */
 169    0xE7 /* 'g' */, 0x01 /* to pos 156 state 62 */,
 170 /* pos 156: state 62 */
 171    0xE9 /* 'i' */, 0x01 /* to pos 158 state 63 */,
 172 /* pos 158: state 63 */
 173    0xEE /* 'n' */, 0x01 /* to pos 160 state 64 */,
 174 /* pos 160: state 64 */
 175    0xBA /* ':' */, 0x01 /* to pos 162 state 65 */,
 176 /* pos 162: state 65 */
 177    0x87, 0x00 /* terminal marker */,
 178 /* pos 164: state 66 */
 179    0xF2 /* 'r' */, 0x01 /* to pos 166 state 67 */,
 180 /* pos 166: state 67 */
 181    0xE1 /* 'a' */, 0x01 /* to pos 168 state 68 */,
 182 /* pos 168: state 68 */
 183    0xE6 /* 'f' */, 0x01 /* to pos 170 state 69 */,
 184 /* pos 170: state 69 */
 185    0xF4 /* 't' */, 0x01 /* to pos 172 state 70 */,
 186 /* pos 172: state 70 */
 187    0xBA /* ':' */, 0x01 /* to pos 174 state 71 */,
 188 /* pos 174: state 71 */
 189    0x88, 0x00 /* terminal marker */,
 190 /* pos 176: state 72 */
 191    0x8A /* '.' */, 0x01 /* to pos 178 state 73 */,
 192 /* pos 178: state 73 */
 193    0x89, 0x00 /* terminal marker */,
 194 /* pos 180: state 74 */
 195    0x8A, 0x00 /* terminal marker */,
 196 /* pos 182: state 75 */
 197    0xE5 /* 'e' */, 0x01 /* to pos 184 state 76 */,
 198 /* pos 184: state 76 */
 199    0xF2 /* 'r' */, 0x01 /* to pos 186 state 77 */,
 200 /* pos 186: state 77 */
 201    0xF3 /* 's' */, 0x01 /* to pos 188 state 78 */,
 202 /* pos 188: state 78 */
 203    0xE9 /* 'i' */, 0x01 /* to pos 190 state 79 */,
 204 /* pos 190: state 79 */
 205    0xEF /* 'o' */, 0x01 /* to pos 192 state 80 */,
 206 /* pos 192: state 80 */
 207    0xEE /* 'n' */, 0x01 /* to pos 194 state 81 */,
 208 /* pos 194: state 81 */
 209    0xBA /* ':' */, 0x01 /* to pos 196 state 82 */,
 210 /* pos 196: state 82 */
 211    0x8B, 0x00 /* terminal marker */,
 212 /* pos 198: state 83 */
 213    0xF2 /* 'r' */, 0x01 /* to pos 200 state 84 */,
 214 /* pos 200: state 84 */
 215    0xE9 /* 'i' */, 0x01 /* to pos 202 state 85 */,
 216 /* pos 202: state 85 */
 217    0xE7 /* 'g' */, 0x01 /* to pos 204 state 86 */,
 218 /* pos 204: state 86 */
 219    0xE9 /* 'i' */, 0x01 /* to pos 206 state 87 */,
 220 /* pos 206: state 87 */
 221    0xEE /* 'n' */, 0x01 /* to pos 208 state 88 */,
 222 /* pos 208: state 88 */
 223    0xBA /* ':' */, 0x01 /* to pos 210 state 89 */,
 224 /* pos 210: state 89 */
 225    0x8C, 0x00 /* terminal marker */,
 226 /* pos 212: state 90 */
 227    0xF8 /* 'x' */, 0x01 /* to pos 214 state 91 */,
 228 /* pos 214: state 91 */
 229    0xF4 /* 't' */, 0x01 /* to pos 216 state 92 */,
 230 /* pos 216: state 92 */
 231    0xE5 /* 'e' */, 0x01 /* to pos 218 state 93 */,
 232 /* pos 218: state 93 */
 233    0xEE /* 'n' */, 0x01 /* to pos 220 state 94 */,
 234 /* pos 220: state 94 */
 235    0xF3 /* 's' */, 0x01 /* to pos 222 state 95 */,
 236 /* pos 222: state 95 */
 237    0xE9 /* 'i' */, 0x01 /* to pos 224 state 96 */,
 238 /* pos 224: state 96 */
 239    0xEF /* 'o' */, 0x01 /* to pos 226 state 97 */,
 240 /* pos 226: state 97 */
 241    0xEE /* 'n' */, 0x01 /* to pos 228 state 98 */,
 242 /* pos 228: state 98 */
 243    0xF3 /* 's' */, 0x01 /* to pos 230 state 99 */,
 244 /* pos 230: state 99 */
 245    0xBA /* ':' */, 0x01 /* to pos 232 state 100 */,
 246 /* pos 232: state 100 */
 247    0x8D, 0x00 /* terminal marker */,
 248 /* pos 234: state 101 */
 249    0xE3 /* 'c' */, 0x01 /* to pos 236 state 102 */,
 250 /* pos 236: state 102 */
 251    0xE3 /* 'c' */, 0x01 /* to pos 238 state 103 */,
 252 /* pos 238: state 103 */
 253    0xE5 /* 'e' */, 0x01 /* to pos 240 state 104 */,
 254 /* pos 240: state 104 */
 255    0xF0 /* 'p' */, 0x01 /* to pos 242 state 105 */,
 256 /* pos 242: state 105 */
 257    0xF4 /* 't' */, 0x01 /* to pos 244 state 106 */,
 258 /* pos 244: state 106 */
 259    0xBA /* ':' */, 0x01 /* to pos 246 state 107 */,
 260 /* pos 246: state 107 */
 261    0x8E, 0x00 /* terminal marker */,
 262 /* pos 248: state 108 */
 263    0xEF /* 'o' */, 0x01 /* to pos 250 state 109 */,
 264 /* pos 250: state 109 */
 265    0xEE /* 'n' */, 0x01 /* to pos 252 state 110 */,
 266 /* pos 252: state 110 */
 267    0xE3 /* 'c' */, 0x01 /* to pos 254 state 111 */,
 268 /* pos 254: state 111 */
 269    0xE5 /* 'e' */, 0x01 /* to pos 256 state 112 */,
 270 /* pos 256: state 112 */
 271    0xBA /* ':' */, 0x01 /* to pos 258 state 113 */,
 272 /* pos 258: state 113 */
 273    0x8F, 0x00 /* terminal marker */,
 274 /* pos 260: state 114 */
 275    0xD4 /* 'T' */, 0x01 /* to pos 262 state 115 */,
 276 /* pos 262: state 115 */
 277    0xD0 /* 'P' */, 0x01 /* to pos 264 state 116 */,
 278 /* pos 264: state 116 */
 279    0xAF /* '/' */, 0x01 /* to pos 266 state 117 */,
 280 /* pos 266: state 117 */
 281    0xB1 /* '1' */, 0x01 /* to pos 268 state 118 */,
 282 /* pos 268: state 118 */
 283    0xAE /* '.' */, 0x01 /* to pos 270 state 119 */,
 284 /* pos 270: state 119 */
 285    0xB1 /* '1' */, 0x01 /* to pos 272 state 120 */,
 286 /* pos 272: state 120 */
 287    0xA0 /* ' ' */, 0x01 /* to pos 274 state 121 */,
 288 /* pos 274: state 121 */
 289    0x90, 0x00 /* terminal marker */,
 290 /* total size 276 bytes */
 291 };
 292
 293 int lextable_decode(int pos, char c)
 294 {
 295         while (pos >= 0) {
 296                 if (lextable[pos + 1] == 0) // terminal marker
 297                         return pos;
 298
 299                 if ((lextable[pos] & 0x7f) == c)
 300                         return pos + (lextable[pos + 1] << 1);
 301
 302                 if (lextable[pos] & 0x80)
 303                         return -1;
 304
 305                 pos += 2;
 306         }
 307         return pos;
 308 }
 309
 310
 311
 312 int libwebsocket_parse(struct libwebsocket *wsi, unsigned char c)
 313 {
 314         int n;
 315
 316         switch (wsi->u.hdr.parser_state) {
 317         case WSI_TOKEN_GET_URI:
 318         case WSI_TOKEN_HOST:
 319         case WSI_TOKEN_CONNECTION:
 320         case WSI_TOKEN_KEY1:
 321         case WSI_TOKEN_KEY2:
 322         case WSI_TOKEN_PROTOCOL:
 323         case WSI_TOKEN_UPGRADE:
 324         case WSI_TOKEN_ORIGIN:
 325         case WSI_TOKEN_SWORIGIN:
 326         case WSI_TOKEN_DRAFT:
 327         case WSI_TOKEN_CHALLENGE:
 328         case WSI_TOKEN_KEY:
 329         case WSI_TOKEN_VERSION:
 330         case WSI_TOKEN_ACCEPT:
 331         case WSI_TOKEN_NONCE:
 332         case WSI_TOKEN_EXTENSIONS:
 333         case WSI_TOKEN_HTTP:
 334         case WSI_TOKEN_MUXURL:
 335
 336                 lwsl_parser("WSI_TOKEN_(%d) '%c'\n", wsi->u.hdr.parser_state, c);
 337
 338                 /* collect into malloc'd buffers */
 339                 /* optional space swallow */
 340                 if (!wsi->u.hdr.hdrs[wsi->u.hdr.parser_state].token_len && c == ' ')
 341                         break;
 342
 343                 /* special case space terminator for get-uri */
 344                 if (wsi->u.hdr.parser_state == WSI_TOKEN_GET_URI && c == ' ') {
 345                         wsi->u.hdr.hdrs[wsi->u.hdr.parser_state].token[
 346                            wsi->u.hdr.hdrs[wsi->u.hdr.parser_state].token_len] = '\0';
 347 //                      lwsl_parser("uri '%s'\n", wsi->u.hdr.hdrs[wsi->u.hdr.parser_state].token);
 348                         wsi->u.hdr.parser_state = WSI_TOKEN_SKIPPING;
 349                         break;
 350                 }
 351
 352                 /* allocate appropriate memory */
 353                 if (wsi->u.hdr.hdrs[wsi->u.hdr.parser_state].token_len ==
 354                                              wsi->u.hdr.current_alloc_len - 1) {
 355                         /* need to extend */
 356                         wsi->u.hdr.current_alloc_len += LWS_ADDITIONAL_HDR_ALLOC;
 357                         if (wsi->u.hdr.current_alloc_len >= LWS_MAX_HEADER_LEN) {
 358                                 /* it's waaay to much payload, fail it */
 359                                 strcpy(wsi->u.hdr.hdrs[wsi->u.hdr.parser_state].token,
 360                                    "!!! Length exceeded maximum supported !!!");
 361                                 wsi->u.hdr.parser_state = WSI_TOKEN_SKIPPING;
 362                                 break;
 363                         }
 364                         wsi->u.hdr.hdrs[wsi->u.hdr.parser_state].token = (char *)
 365                                realloc(wsi->u.hdr.hdrs[wsi->u.hdr.parser_state].token,
 366                                                         wsi->u.hdr.current_alloc_len);
 367                         if (wsi->u.hdr.hdrs[wsi->u.hdr.parser_state].token == NULL) {
 368                                 lwsl_err("Out of mem\n");
 369                                 return -1;
 370                         }
 371                 }
 372
 373                 /* bail at EOL */
 374                 if (wsi->u.hdr.parser_state != WSI_TOKEN_CHALLENGE && c == '\x0d') {
 375                         wsi->u.hdr.hdrs[wsi->u.hdr.parser_state].token[
 376                            wsi->u.hdr.hdrs[wsi->u.hdr.parser_state].token_len] = '\0';
 377                         wsi->u.hdr.parser_state = WSI_TOKEN_SKIPPING_SAW_CR;
 378                         lwsl_parser("*\n");
 379                         break;
 380                 }
 381
 382                 wsi->u.hdr.hdrs[wsi->u.hdr.parser_state].token[
 383                             wsi->u.hdr.hdrs[wsi->u.hdr.parser_state].token_len++] = c;
 384
 385                 /* per-protocol end of headers management */
 386
 387                 if (wsi->u.hdr.parser_state != WSI_TOKEN_CHALLENGE)
 388                         break;
 389
 390                 goto set_parsing_complete;
 391
 392         case WSI_INIT_TOKEN_MUXURL:
 393                 wsi->u.hdr.parser_state = WSI_TOKEN_MUXURL;
 394                 wsi->u.hdr.current_alloc_len = LWS_INITIAL_HDR_ALLOC;
 395
 396                 wsi->u.hdr.hdrs[wsi->u.hdr.parser_state].token = (char *)
 397                                          malloc(wsi->u.hdr.current_alloc_len);
 398                 if (wsi->u.hdr.hdrs[wsi->u.hdr.parser_state].token == NULL) {
 399                         lwsl_err("Out of mem\n");
 400                         return -1;
 401                 }
 402                 wsi->u.hdr.hdrs[wsi->u.hdr.parser_state].token_len = 0;
 403                 break;
 404
 405                 /* collecting and checking a name part */
 406         case WSI_TOKEN_NAME_PART:
 407                 lwsl_parser("WSI_TOKEN_NAME_PART '%c'\n", c);
 408
 409                 if (wsi->u.hdr.name_buffer_pos == sizeof(wsi->u.hdr.name_buffer) - 1) {
 410                         /* name bigger than we can handle, skip until next */
 411                         wsi->u.hdr.parser_state = WSI_TOKEN_SKIPPING;
 412                         break;
 413                 }
 414                 wsi->u.hdr.name_buffer[wsi->u.hdr.name_buffer_pos++] = c;
 415                 wsi->u.hdr.name_buffer[wsi->u.hdr.name_buffer_pos] = '\0';
 416
 417                 wsi->u.hdr.lextable_pos = lextable_decode(wsi->u.hdr.lextable_pos, c);
 418                 if (wsi->u.hdr.lextable_pos < 0) {
 419                         /* this is not a header we know about */
 420                         if (wsi->u.hdr.hdrs[WSI_TOKEN_GET_URI].token_len) {
 421                                 /* if not the method, just skip it all */
 422                                 wsi->u.hdr.parser_state = WSI_TOKEN_SKIPPING;
 423                                 break;
 424                         }
 425                         /* hm it's an unknown http method in fact */
 426                         if (c == ' ') {
 427                                 lwsl_info("Unknown method %s\n", wsi->u.hdr.name_buffer);
 428                                 /* treat it as GET */
 429                                 wsi->u.hdr.parser_state = WSI_TOKEN_GET_URI;
 430                                 wsi->u.hdr.current_alloc_len = LWS_INITIAL_HDR_ALLOC;
 431                                 wsi->u.hdr.hdrs[WSI_TOKEN_GET_URI].token =
 432                                         (char *)malloc(wsi->u.hdr.current_alloc_len);
 433                                 if (wsi->u.hdr.hdrs[WSI_TOKEN_GET_URI].token == NULL) {
 434                                         lwsl_err("Out of mem\n");
 435                                         return -1;
 436                                 }
 437                                 break;
 438                         }
 439                 }
 440                 if (lextable[wsi->u.hdr.lextable_pos + 1] == 0) {
 441
 442                         /* terminal state */
 443
 444                         n = lextable[wsi->u.hdr.lextable_pos] & 0x7f;
 445
 446                         lwsl_parser("known hdr '%s'\n", wsi->u.hdr.name_buffer);
 447
 448                         /*
 449                          * WSORIGIN is protocol equiv to ORIGIN,
 450                          * JWebSocket likes to send it, map to ORIGIN
 451                          */
 452                         if (n == WSI_TOKEN_SWORIGIN)
 453                                 n = WSI_TOKEN_ORIGIN;
 454
 455                         wsi->u.hdr.parser_state = (enum lws_token_indexes) (WSI_TOKEN_GET_URI + n);
 456
 457                         n = WSI_TOKEN_COUNT;
 458
 459                         /*  If the header has been seen already, just append */
 460                         if (!wsi->u.hdr.hdrs[wsi->u.hdr.parser_state].token) {
 461
 462                                 wsi->u.hdr.current_alloc_len = LWS_INITIAL_HDR_ALLOC;
 463                                 wsi->u.hdr.hdrs[wsi->u.hdr.parser_state].token = (char *)
 464                                                          malloc(wsi->u.hdr.current_alloc_len);
 465                                 if (wsi->u.hdr.hdrs[wsi->u.hdr.parser_state].token == NULL) {
 466                                         lwsl_err("Out of mem\n");
 467                                         return -1;
 468                                 }
 469                                 wsi->u.hdr.hdrs[wsi->u.hdr.parser_state].token_len = 0;
 470                         }
 471                 }
 472
 473                 if (wsi->u.hdr.parser_state == WSI_TOKEN_CHALLENGE) {
 474                         if (wsi->u.hdr.hdrs[WSI_TOKEN_CHALLENGE].token) {
 475                                 free(wsi->u.hdr.hdrs[WSI_TOKEN_CHALLENGE].token);
 476                                 wsi->u.hdr.hdrs[WSI_TOKEN_CHALLENGE].token = NULL;
 477                         }
 478                         wsi->u.hdr.hdrs[WSI_TOKEN_CHALLENGE].token_len = 0;
 479                         goto set_parsing_complete;
 480                 }
 481
 482                 break;
 483
 484                 /* skipping arg part of a name we didn't recognize */
 485         case WSI_TOKEN_SKIPPING:
 486                 lwsl_parser("WSI_TOKEN_SKIPPING '%c'\n", c);
 487                 if (c == '\x0d')
 488                         wsi->u.hdr.parser_state = WSI_TOKEN_SKIPPING_SAW_CR;
 489                 break;
 490
 491         case WSI_TOKEN_SKIPPING_SAW_CR:
 492                 lwsl_parser("WSI_TOKEN_SKIPPING_SAW_CR '%c'\n", c);
 493                 if (c == '\x0a') {
 494                         wsi->u.hdr.parser_state = WSI_TOKEN_NAME_PART;
 495                         wsi->u.hdr.lextable_pos = 0;
 496                 } else
 497                         wsi->u.hdr.parser_state = WSI_TOKEN_SKIPPING;
 498                 wsi->u.hdr.name_buffer_pos = 0;
 499                 break;
 500                 /* we're done, ignore anything else */
 501         case WSI_PARSING_COMPLETE:
 502                 lwsl_parser("WSI_PARSING_COMPLETE '%c'\n", c);
 503                 break;
 504
 505         default:        /* keep gcc happy */
 506                 break;
 507         }
 508
 509         return 0;
 510
 511 set_parsing_complete:
 512
 513         if (wsi->u.hdr.hdrs[WSI_TOKEN_UPGRADE].token_len) {
 514                 if (!wsi->u.hdr.hdrs[WSI_TOKEN_VERSION].token_len) {
 515 //                      lwsl_info("Missing Version Header\n");
 516 //                      return 1;
 517                 } else
 518                         wsi->ietf_spec_revision =
 519                                 atoi(wsi->u.hdr.hdrs[WSI_TOKEN_VERSION].token);
 520
 521                 lwsl_parser("v%02d headers completed\n", wsi->ietf_spec_revision);
 522         }
 523         wsi->u.hdr.parser_state = WSI_PARSING_COMPLETE;
 524
 525         return 0;
 526 }
 527
 528
 529 /**
 530  * lws_frame_is_binary: true if the current frame was sent in binary mode
 531  *
 532  * @wsi: the connection we are inquiring about
 533  *
 534  * This is intended to be called from the LWS_CALLBACK_RECEIVE callback if
 535  * it's interested to see if the frame it's dealing with was sent in binary
 536  * mode.
 537  */
 538
 539 int lws_frame_is_binary(struct libwebsocket *wsi)
 540 {
 541         return wsi->u.ws.frame_is_binary;
 542 }
 543
 544 int
 545 libwebsocket_rx_sm(struct libwebsocket *wsi, unsigned char c)
 546 {
 547         int n;
 548         struct lws_tokens eff_buf;
 549 #ifndef LWS_NO_EXTENSIONS
 550         int handled;
 551         int m;
 552 #endif
 553
 554 #if 0
 555         lwsl_debug("RX: %02X ", c);
 556 #endif
 557
 558         switch (wsi->lws_rx_parse_state) {
 559         case LWS_RXPS_NEW:
 560
 561                 switch (wsi->ietf_spec_revision) {
 562                 case 13:
 563                         /*
 564                          * no prepended frame key any more
 565                          */
 566                         wsi->u.ws.all_zero_nonce = 1;
 567                         goto handle_first;
 568
 569                 default:
 570                         lwsl_warn("libwebsocket_rx_sm doesn't know "
 571                             "about spec version %d\n", wsi->ietf_spec_revision);
 572                         break;
 573                 }
 574                 break;
 575         case LWS_RXPS_04_MASK_NONCE_1:
 576                 wsi->u.ws.frame_masking_nonce_04[1] = c;
 577                 if (c)
 578                         wsi->u.ws.all_zero_nonce = 0;
 579                 wsi->lws_rx_parse_state = LWS_RXPS_04_MASK_NONCE_2;
 580                 break;
 581         case LWS_RXPS_04_MASK_NONCE_2:
 582                 wsi->u.ws.frame_masking_nonce_04[2] = c;
 583                 if (c)
 584                         wsi->u.ws.all_zero_nonce = 0;
 585                 wsi->lws_rx_parse_state = LWS_RXPS_04_MASK_NONCE_3;
 586                 break;
 587         case LWS_RXPS_04_MASK_NONCE_3:
 588                 wsi->u.ws.frame_masking_nonce_04[3] = c;
 589                 if (c)
 590                         wsi->u.ws.all_zero_nonce = 0;
 591
 592                 /*
 593                  * start from the zero'th byte in the XOR key buffer since
 594                  * this is the start of a frame with a new key
 595                  */
 596
 597                 wsi->u.ws.frame_mask_index = 0;
 598
 599                 wsi->lws_rx_parse_state = LWS_RXPS_04_FRAME_HDR_1;
 600                 break;
 601
 602         /*
 603          *  04 logical framing from the spec (all this is masked when incoming
 604          *  and has to be unmasked)
 605          *
 606          * We ignore the possibility of extension data because we don't
 607          * negotiate any extensions at the moment.
 608          *
 609          *    0                   1                   2                   3
 610          *    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 611          *   +-+-+-+-+-------+-+-------------+-------------------------------+
 612          *   |F|R|R|R| opcode|R| Payload len |    Extended payload length    |
 613          *   |I|S|S|S|  (4)  |S|     (7)     |             (16/63)           |
 614          *   |N|V|V|V|       |V|             |   (if payload len==126/127)   |
 615          *   | |1|2|3|       |4|             |                               |
 616          *   +-+-+-+-+-------+-+-------------+ - - - - - - - - - - - - - - - +
 617          *   |     Extended payload length continued, if payload len == 127  |
 618          *   + - - - - - - - - - - - - - - - +-------------------------------+
 619          *   |                               |         Extension data        |
 620          *   +-------------------------------+ - - - - - - - - - - - - - - - +
 621          *   :                                                               :
 622          *   +---------------------------------------------------------------+
 623          *   :                       Application data                        :
 624          *   +---------------------------------------------------------------+
 625          *
 626          *  We pass payload through to userland as soon as we get it, ignoring
 627          *  FIN.  It's up to userland to buffer it up if it wants to see a
 628          *  whole unfragmented block of the original size (which may be up to
 629          *  2^63 long!)
 630          */
 631
 632         case LWS_RXPS_04_FRAME_HDR_1:
 633 handle_first:
 634
 635                 /*
 636                  * 04 spec defines the opcode like this: (1, 2, and 3 are
 637                  * "control frame" opcodes which may not be fragmented or
 638                  * have size larger than 126)
 639                  *
 640                  *       frame-opcode           =
 641                  *             %x0 ; continuation frame
 642                  *              / %x1 ; connection close
 643                  *              / %x2 ; ping
 644                  *              / %x3 ; pong
 645                  *              / %x4 ; text frame
 646                  *              / %x5 ; binary frame
 647                  *              / %x6-F ; reserved
 648                  *
 649                  *              FIN (b7)
 650                  */
 651
 652                 wsi->u.ws.opcode = c & 0xf;
 653                 wsi->u.ws.rsv = c & 0x70;
 654                 wsi->u.ws.final = !!((c >> 7) & 1);
 655                 switch (wsi->u.ws.opcode) {
 656                 case LWS_WS_OPCODE_07__TEXT_FRAME:
 657                 case LWS_WS_OPCODE_07__BINARY_FRAME:
 658                         wsi->u.ws.frame_is_binary = wsi->u.ws.opcode == LWS_WS_OPCODE_07__BINARY_FRAME;
 659                         break;
 660                 }
 661                 wsi->lws_rx_parse_state = LWS_RXPS_04_FRAME_HDR_LEN;
 662                 break;
 663
 664         case LWS_RXPS_04_FRAME_HDR_LEN:
 665
 666                 wsi->u.ws.this_frame_masked = !!(c & 0x80);
 667
 668                 switch (c & 0x7f) {
 669                 case 126:
 670                         /* control frames are not allowed to have big lengths */
 671                         if (wsi->u.ws.opcode & 8)
 672                                 goto illegal_ctl_length;
 673
 674                         wsi->lws_rx_parse_state = LWS_RXPS_04_FRAME_HDR_LEN16_2;
 675                         break;
 676                 case 127:
 677                         /* control frames are not allowed to have big lengths */
 678                         if (wsi->u.ws.opcode & 8)
 679                                 goto illegal_ctl_length;
 680
 681                         wsi->lws_rx_parse_state = LWS_RXPS_04_FRAME_HDR_LEN64_8;
 682                         break;
 683                 default:
 684                         wsi->u.ws.rx_packet_length = c & 0x7f;
 685                         if (wsi->u.ws.this_frame_masked)
 686                                 wsi->lws_rx_parse_state =
 687                                                 LWS_RXPS_07_COLLECT_FRAME_KEY_1;
 688                         else
 689                                 wsi->lws_rx_parse_state =
 690                                         LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED;
 691                         break;
 692                 }
 693                 break;
 694
 695         case LWS_RXPS_04_FRAME_HDR_LEN16_2:
 696                 wsi->u.ws.rx_packet_length = c << 8;
 697                 wsi->lws_rx_parse_state = LWS_RXPS_04_FRAME_HDR_LEN16_1;
 698                 break;
 699
 700         case LWS_RXPS_04_FRAME_HDR_LEN16_1:
 701                 wsi->u.ws.rx_packet_length |= c;
 702                 if (wsi->u.ws.this_frame_masked)
 703                         wsi->lws_rx_parse_state =
 704                                         LWS_RXPS_07_COLLECT_FRAME_KEY_1;
 705                 else
 706                         wsi->lws_rx_parse_state =
 707                                 LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED;
 708                 break;
 709
 710         case LWS_RXPS_04_FRAME_HDR_LEN64_8:
 711                 if (c & 0x80) {
 712                         lwsl_warn("b63 of length must be zero\n");
 713                         /* kill the connection */
 714                         return -1;
 715                 }
 716 #if defined __LP64__
 717                 wsi->u.ws.rx_packet_length = ((size_t)c) << 56;
 718 #else
 719                 wsi->u.ws.rx_packet_length = 0;
 720 #endif
 721                 wsi->lws_rx_parse_state = LWS_RXPS_04_FRAME_HDR_LEN64_7;
 722                 break;
 723
 724         case LWS_RXPS_04_FRAME_HDR_LEN64_7:
 725 #if defined __LP64__
 726                 wsi->u.ws.rx_packet_length |= ((size_t)c) << 48;
 727 #endif
 728                 wsi->lws_rx_parse_state = LWS_RXPS_04_FRAME_HDR_LEN64_6;
 729                 break;
 730
 731         case LWS_RXPS_04_FRAME_HDR_LEN64_6:
 732 #if defined __LP64__
 733                 wsi->u.ws.rx_packet_length |= ((size_t)c) << 40;
 734 #endif
 735                 wsi->lws_rx_parse_state = LWS_RXPS_04_FRAME_HDR_LEN64_5;
 736                 break;
 737
 738         case LWS_RXPS_04_FRAME_HDR_LEN64_5:
 739 #if defined __LP64__
 740                 wsi->u.ws.rx_packet_length |= ((size_t)c) << 32;
 741 #endif
 742                 wsi->lws_rx_parse_state = LWS_RXPS_04_FRAME_HDR_LEN64_4;
 743                 break;
 744
 745         case LWS_RXPS_04_FRAME_HDR_LEN64_4:
 746                 wsi->u.ws.rx_packet_length |= ((size_t)c) << 24;
 747                 wsi->lws_rx_parse_state = LWS_RXPS_04_FRAME_HDR_LEN64_3;
 748                 break;
 749
 750         case LWS_RXPS_04_FRAME_HDR_LEN64_3:
 751                 wsi->u.ws.rx_packet_length |= ((size_t)c) << 16;
 752                 wsi->lws_rx_parse_state = LWS_RXPS_04_FRAME_HDR_LEN64_2;
 753                 break;
 754
 755         case LWS_RXPS_04_FRAME_HDR_LEN64_2:
 756                 wsi->u.ws.rx_packet_length |= ((size_t)c) << 8;
 757                 wsi->lws_rx_parse_state = LWS_RXPS_04_FRAME_HDR_LEN64_1;
 758                 break;
 759
 760         case LWS_RXPS_04_FRAME_HDR_LEN64_1:
 761                 wsi->u.ws.rx_packet_length |= ((size_t)c);
 762                 if (wsi->u.ws.this_frame_masked)
 763                         wsi->lws_rx_parse_state =
 764                                         LWS_RXPS_07_COLLECT_FRAME_KEY_1;
 765                 else
 766                         wsi->lws_rx_parse_state =
 767                                 LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED;
 768                 break;
 769
 770         case LWS_RXPS_07_COLLECT_FRAME_KEY_1:
 771                 wsi->u.ws.frame_masking_nonce_04[0] = c;
 772                 if (c)
 773                         wsi->u.ws.all_zero_nonce = 0;
 774                 wsi->lws_rx_parse_state = LWS_RXPS_07_COLLECT_FRAME_KEY_2;
 775                 break;
 776
 777         case LWS_RXPS_07_COLLECT_FRAME_KEY_2:
 778                 wsi->u.ws.frame_masking_nonce_04[1] = c;
 779                 if (c)
 780                         wsi->u.ws.all_zero_nonce = 0;
 781                 wsi->lws_rx_parse_state = LWS_RXPS_07_COLLECT_FRAME_KEY_3;
 782                 break;
 783
 784         case LWS_RXPS_07_COLLECT_FRAME_KEY_3:
 785                 wsi->u.ws.frame_masking_nonce_04[2] = c;
 786                 if (c)
 787                         wsi->u.ws.all_zero_nonce = 0;
 788                 wsi->lws_rx_parse_state = LWS_RXPS_07_COLLECT_FRAME_KEY_4;
 789                 break;
 790
 791         case LWS_RXPS_07_COLLECT_FRAME_KEY_4:
 792                 wsi->u.ws.frame_masking_nonce_04[3] = c;
 793                 if (c)
 794                         wsi->u.ws.all_zero_nonce = 0;
 795                 wsi->lws_rx_parse_state =
 796                                         LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED;
 797                 wsi->u.ws.frame_mask_index = 0;
 798                 break;
 799
 800
 801         case LWS_RXPS_PAYLOAD_UNTIL_LENGTH_EXHAUSTED:
 802
 803                 if (!wsi->u.ws.rx_user_buffer)
 804                         lwsl_err("NULL user buffer...\n");
 805
 806                 if (wsi->u.ws.all_zero_nonce)
 807                         wsi->u.ws.rx_user_buffer[LWS_SEND_BUFFER_PRE_PADDING +
 808                                (wsi->u.ws.rx_user_buffer_head++)] = c;
 809                 else
 810                         wsi->u.ws.rx_user_buffer[LWS_SEND_BUFFER_PRE_PADDING +
 811                                (wsi->u.ws.rx_user_buffer_head++)] =
 812                 c ^ wsi->u.ws.frame_masking_nonce_04[(wsi->u.ws.frame_mask_index++) & 3];
 813
 814                 if (--wsi->u.ws.rx_packet_length == 0) {
 815                         wsi->lws_rx_parse_state = LWS_RXPS_NEW;
 816                         goto spill;
 817                 }
 818                 if (wsi->u.ws.rx_user_buffer_head != wsi->protocol->rx_buffer_size)
 819                         break;
 820 spill:
 821                 /*
 822                  * is this frame a control packet we should take care of at this
 823                  * layer?  If so service it and hide it from the user callback
 824                  */
 825
 826                 lwsl_parser("spill on %s\n", wsi->protocol->name);
 827
 828                 switch (wsi->u.ws.opcode) {
 829                 case LWS_WS_OPCODE_07__CLOSE:
 830                         /* is this an acknowledgement of our close? */
 831                         if (wsi->state == WSI_STATE_AWAITING_CLOSE_ACK) {
 832                                 /*
 833                                  * fine he has told us he is closing too, let's
 834                                  * finish our close
 835                                  */
 836                                 lwsl_parser("seen client close ack\n");
 837                                 return -1;
 838                         }
 839                         lwsl_parser("server sees client close packet\n");
 840                         /* parrot the close packet payload back */
 841                         n = libwebsocket_write(wsi, (unsigned char *)
 842                            &wsi->u.ws.rx_user_buffer[LWS_SEND_BUFFER_PRE_PADDING],
 843                                      wsi->u.ws.rx_user_buffer_head, LWS_WRITE_CLOSE);
 844                         if (n)
 845                                 lwsl_info("write of close ack failed %d\n", n);
 846                         wsi->state = WSI_STATE_RETURNED_CLOSE_ALREADY;
 847                         /* close the connection */
 848                         return -1;
 849
 850                 case LWS_WS_OPCODE_07__PING:
 851                         lwsl_info("received %d byte ping, sending pong\n", wsi->u.ws.rx_user_buffer_head);
 852                         lwsl_hexdump(&wsi->u.ws.rx_user_buffer[LWS_SEND_BUFFER_PRE_PADDING], wsi->u.ws.rx_user_buffer_head);
 853                         /* parrot the ping packet payload back as a pong */
 854                         n = libwebsocket_write(wsi, (unsigned char *)
 855                             &wsi->u.ws.rx_user_buffer[LWS_SEND_BUFFER_PRE_PADDING], wsi->u.ws.rx_user_buffer_head, LWS_WRITE_PONG);
 856                         /* ... then just drop it */
 857                         wsi->u.ws.rx_user_buffer_head = 0;
 858                         return 0;
 859
 860                 case LWS_WS_OPCODE_07__PONG:
 861                         /* ... then just drop it */
 862                         wsi->u.ws.rx_user_buffer_head = 0;
 863                         return 0;
 864
 865                 case LWS_WS_OPCODE_07__TEXT_FRAME:
 866                 case LWS_WS_OPCODE_07__BINARY_FRAME:
 867                 case LWS_WS_OPCODE_07__CONTINUATION:
 868                         break;
 869
 870                 default:
 871 #ifndef LWS_NO_EXTENSIONS
 872                         lwsl_parser("passing opcode %x up to exts\n", wsi->u.ws.opcode);
 873
 874                         /*
 875                          * It's something special we can't understand here.
 876                          * Pass the payload up to the extension's parsing
 877                          * state machine.
 878                          */
 879
 880                         eff_buf.token = &wsi->u.ws.rx_user_buffer[
 881                                                    LWS_SEND_BUFFER_PRE_PADDING];
 882                         eff_buf.token_len = wsi->u.ws.rx_user_buffer_head;
 883
 884                         handled = 0;
 885                         for (n = 0; n < wsi->count_active_extensions; n++) {
 886                                 m = wsi->active_extensions[n]->callback(
 887                                         wsi->protocol->owning_server,
 888                                         wsi->active_extensions[n], wsi,
 889                                         LWS_EXT_CALLBACK_EXTENDED_PAYLOAD_RX,
 890                                             wsi->active_extensions_user[n],
 891                                                                    &eff_buf, 0);
 892                                 if (m)
 893                                         handled = 1;
 894                         }
 895
 896                         if (!handled)
 897 #endif
 898                                 lwsl_ext("Unhandled extended opcode "
 899                                         "0x%x - ignoring frame\n", wsi->u.ws.opcode);
 900
 901                         wsi->u.ws.rx_user_buffer_head = 0;
 902                         return 0;
 903                 }
 904
 905                 /*
 906                  * No it's real payload, pass it up to the user callback.
 907                  * It's nicely buffered with the pre-padding taken care of
 908                  * so it can be sent straight out again using libwebsocket_write
 909                  */
 910
 911                 eff_buf.token = &wsi->u.ws.rx_user_buffer[
 912                                                 LWS_SEND_BUFFER_PRE_PADDING];
 913                 eff_buf.token_len = wsi->u.ws.rx_user_buffer_head;
 914 #ifndef LWS_NO_EXTENSIONS
 915                 for (n = 0; n < wsi->count_active_extensions; n++) {
 916                         m = wsi->active_extensions[n]->callback(
 917                                 wsi->protocol->owning_server,
 918                                 wsi->active_extensions[n], wsi,
 919                                 LWS_EXT_CALLBACK_PAYLOAD_RX,
 920                                 wsi->active_extensions_user[n],
 921                                 &eff_buf, 0);
 922                         if (m < 0) {
 923                                 lwsl_ext(
 924                                   "Extension '%s' failed to handle payload!\n",
 925                                               wsi->active_extensions[n]->name);
 926                                 return -1;
 927                         }
 928                 }
 929 #endif
 930                 if (eff_buf.token_len > 0) {
 931                     eff_buf.token[eff_buf.token_len] = '\0';
 932
 933                     if (wsi->protocol->callback)
 934                             user_callback_handle_rxflow(wsi->protocol->callback,
 935                                                     wsi->protocol->owning_server,
 936                                                     wsi, LWS_CALLBACK_RECEIVE,
 937                                                     wsi->user_space,
 938                                                     eff_buf.token,
 939                                                     eff_buf.token_len);
 940                     else
 941                             lwsl_err("No callback on payload spill!\n");
 942                 }
 943
 944                 wsi->u.ws.rx_user_buffer_head = 0;
 945                 break;
 946         }
 947
 948         return 0;
 949
 950 illegal_ctl_length:
 951
 952         lwsl_warn("Control frame asking for "
 953                         "extended length is illegal\n");
 954         /* kill the connection */
 955         return -1;
 956 }
 957
 958
 959 int libwebsocket_interpret_incoming_packet(struct libwebsocket *wsi,
 960                                                  unsigned char *buf, size_t len)
 961 {
 962         size_t n;
 963         int m;
 964         int clear_rxflow = !!wsi->u.ws.rxflow_buffer;
 965         struct libwebsocket_context *context = wsi->protocol->owning_server;
 966
 967 #if 0
 968         lwsl_parser("received %d byte packet\n", (int)len);
 969         lwsl_hexdump(buf, len);
 970 #endif
 971
 972         if (buf && wsi->u.ws.rxflow_buffer)
 973                 lwsl_err("!!!! libwebsocket_interpret_incoming_packet: was pending rxflow, data loss\n");
 974
 975         /* let the rx protocol state machine have as much as it needs */
 976
 977         n = 0;
 978         if (!buf) {
 979                 lwsl_info("dumping stored rxflow buffer len %d pos=%d\n", wsi->u.ws.rxflow_len, wsi->u.ws.rxflow_pos);
 980                 buf = wsi->u.ws.rxflow_buffer;
 981                 n = wsi->u.ws.rxflow_pos;
 982                 len = wsi->u.ws.rxflow_len;
 983                 /* let's pretend he's already allowing input */
 984                 context->fds[wsi->position_in_fds_table].events |= POLLIN;
 985         }
 986
 987         while (n < len) {
 988                 if (!(context->fds[wsi->position_in_fds_table].events & POLLIN)) {
 989                         /* his RX is flowcontrolled */
 990                         if (!wsi->u.ws.rxflow_buffer) { /* a new rxflow in effect, buffer it and warn caller */
 991                                 lwsl_info("new rxflow input buffer len %d\n", len - n);
 992                                 wsi->u.ws.rxflow_buffer = (unsigned char *)malloc(len - n);
 993                                 wsi->u.ws.rxflow_len = len - n;
 994                                 wsi->u.ws.rxflow_pos = 0;
 995                                 memcpy(wsi->u.ws.rxflow_buffer, buf + n, len - n);
 996                         } else {
 997                                 lwsl_info("re-using rxflow input buffer\n");
 998                                 /* rxflow while we were spilling previous rxflow buffer */
 999                                 wsi->u.ws.rxflow_pos = n;
1000                         }
1001                         return 1;
1002                 }
1003                 m = libwebsocket_rx_sm(wsi, buf[n]);
1004                 if (m < 0)
1005                         return -1;
1006                 n++;
1007         }
1008
1009         if (clear_rxflow) {
1010                 lwsl_info("flow: clearing it\n");
1011                 free(wsi->u.ws.rxflow_buffer);
1012                 wsi->u.ws.rxflow_buffer = NULL;
1013                 context->fds[wsi->position_in_fds_table].events &= ~POLLIN;
1014         }
1015
1016         return 0;
1017 }
1018
1019
1020 /**
1021  * libwebsockets_remaining_packet_payload() - Bytes to come before "overall"
1022  *                                            rx packet is complete
1023  * @wsi:                Websocket instance (available from user callback)
1024  *
1025  *      This function is intended to be called from the callback if the
1026  *  user code is interested in "complete packets" from the client.
1027  *  libwebsockets just passes through payload as it comes and issues a buffer
1028  *  additionally when it hits a built-in limit.  The LWS_CALLBACK_RECEIVE
1029  *  callback handler can use this API to find out if the buffer it has just
1030  *  been given is the last piece of a "complete packet" from the client --
1031  *  when that is the case libwebsockets_remaining_packet_payload() will return
1032  *  0.
1033  *
1034  *  Many protocols won't care becuse their packets are always small.
1035  */
1036
1037 size_t
1038 libwebsockets_remaining_packet_payload(struct libwebsocket *wsi)
1039 {
1040         return wsi->u.ws.rx_packet_length;
1041 }