deps/http_parser/http_parser.h

   1 /* Copyright Joyent, Inc. and other Node contributors. All rights reserved.
   2  *
   3  * Permission is hereby granted, free of charge, to any person obtaining a copy
   4  * of this software and associated documentation files (the "Software"), to
   5  * deal in the Software without restriction, including without limitation the
   6  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   7  * sell copies of the Software, and to permit persons to whom the Software is
   8  * furnished to do so, subject to the following conditions:
   9  *
  10  * The above copyright notice and this permission notice shall be included in
  11  * all copies or substantial portions of the Software.
  12  *
  13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  18  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  19  * IN THE SOFTWARE.
  20  */
  21 #ifndef http_parser_h
  22 #define http_parser_h
  23 #ifdef __cplusplus
  24 extern "C" {
  25 #endif
  26
  27 /* Also update SONAME in the Makefile whenever you change these. */
  28 #define HTTP_PARSER_VERSION_MAJOR 2
  29 #define HTTP_PARSER_VERSION_MINOR 5
  30 #define HTTP_PARSER_VERSION_PATCH 2
  31
  32 #include <sys/types.h>
  33 #if defined(_WIN32) && !defined(__MINGW32__) && (!defined(_MSC_VER) || _MSC_VER<1600)
  34 #include <BaseTsd.h>
  35 #include <stddef.h>
  36 typedef __int8 int8_t;
  37 typedef unsigned __int8 uint8_t;
  38 typedef __int16 int16_t;
  39 typedef unsigned __int16 uint16_t;
  40 typedef __int32 int32_t;
  41 typedef unsigned __int32 uint32_t;
  42 typedef __int64 int64_t;
  43 typedef unsigned __int64 uint64_t;
  44 #else
  45 #include <stdint.h>
  46 #endif
  47
  48 /* Compile with -DHTTP_PARSER_STRICT=0 to make less checks, but run
  49  * faster
  50  */
  51 #ifndef HTTP_PARSER_STRICT
  52 # define HTTP_PARSER_STRICT 1
  53 #endif
  54
  55 /* Maximium header size allowed. If the macro is not defined
  56  * before including this header then the default is used. To
  57  * change the maximum header size, define the macro in the build
  58  * environment (e.g. -DHTTP_MAX_HEADER_SIZE=<value>). To remove
  59  * the effective limit on the size of the header, define the macro
  60  * to a very large number (e.g. -DHTTP_MAX_HEADER_SIZE=0x7fffffff)
  61  */
  62 #ifndef HTTP_MAX_HEADER_SIZE
  63 # define HTTP_MAX_HEADER_SIZE (80*1024)
  64 #endif
  65
  66 typedef struct http_parser http_parser;
  67 typedef struct http_parser_settings http_parser_settings;
  68
  69
  70 /* Callbacks should return non-zero to indicate an error. The parser will
  71  * then halt execution.
  72  *
  73  * The one exception is on_headers_complete. In a HTTP_RESPONSE parser
  74  * returning '1' from on_headers_complete will tell the parser that it
  75  * should not expect a body. This is used when receiving a response to a
  76  * HEAD request which may contain 'Content-Length' or 'Transfer-Encoding:
  77  * chunked' headers that indicate the presence of a body.
  78  *
  79  * http_data_cb does not return data chunks. It will be called arbitrarily
  80  * many times for each string. E.G. you might get 10 callbacks for "on_url"
  81  * each providing just a few characters more data.
  82  */
  83 typedef int (*http_data_cb) (http_parser*, const char *at, size_t length);
  84 typedef int (*http_cb) (http_parser*);
  85
  86
  87 /* Request Methods */
  88 #define HTTP_METHOD_MAP(XX)         \
  89   XX(0,  DELETE,      DELETE)       \
  90   XX(1,  GET,         GET)          \
  91   XX(2,  HEAD,        HEAD)         \
  92   XX(3,  POST,        POST)         \
  93   XX(4,  PUT,         PUT)          \
  94   /* pathological */                \
  95   XX(5,  CONNECT,     CONNECT)      \
  96   XX(6,  OPTIONS,     OPTIONS)      \
  97   XX(7,  TRACE,       TRACE)        \
  98   /* webdav */                      \
  99   XX(8,  COPY,        COPY)         \
 100   XX(9,  LOCK,        LOCK)         \
 101   XX(10, MKCOL,       MKCOL)        \
 102   XX(11, MOVE,        MOVE)         \
 103   XX(12, PROPFIND,    PROPFIND)     \
 104   XX(13, PROPPATCH,   PROPPATCH)    \
 105   XX(14, SEARCH,      SEARCH)       \
 106   XX(15, UNLOCK,      UNLOCK)       \
 107   /* subversion */                  \
 108   XX(16, REPORT,      REPORT)       \
 109   XX(17, MKACTIVITY,  MKACTIVITY)   \
 110   XX(18, CHECKOUT,    CHECKOUT)     \
 111   XX(19, MERGE,       MERGE)        \
 112   /* upnp */                        \
 113   XX(20, MSEARCH,     M-SEARCH)     \
 114   XX(21, NOTIFY,      NOTIFY)       \
 115   XX(22, SUBSCRIBE,   SUBSCRIBE)    \
 116   XX(23, UNSUBSCRIBE, UNSUBSCRIBE)  \
 117   /* RFC-5789 */                    \
 118   XX(24, PATCH,       PATCH)        \
 119   XX(25, PURGE,       PURGE)        \
 120   /* CalDAV */                      \
 121   XX(26, MKCALENDAR,  MKCALENDAR)   \
 122
 123 enum http_method
 124   {
 125 #define XX(num, name, string) HTTP_##name = num,
 126   HTTP_METHOD_MAP(XX)
 127 #undef XX
 128   };
 129
 130
 131 enum http_parser_type { HTTP_REQUEST, HTTP_RESPONSE, HTTP_BOTH };
 132
 133
 134 /* Flag values for http_parser.flags field */
 135 enum flags
 136   { F_CHUNKED               = 1 << 0
 137   , F_CONNECTION_KEEP_ALIVE = 1 << 1
 138   , F_CONNECTION_CLOSE      = 1 << 2
 139   , F_CONNECTION_UPGRADE    = 1 << 3
 140   , F_TRAILING              = 1 << 4
 141   , F_UPGRADE               = 1 << 5
 142   , F_SKIPBODY              = 1 << 6
 143   , F_CONTENTLENGTH         = 1 << 7
 144   };
 145
 146
 147 /* Map for errno-related constants
 148  *
 149  * The provided argument should be a macro that takes 2 arguments.
 150  */
 151 #define HTTP_ERRNO_MAP(XX)                                           \
 152   /* No error */                                                     \
 153   XX(OK, "success")                                                  \
 154                                                                      \
 155   /* Callback-related errors */                                      \
 156   XX(CB_message_begin, "the on_message_begin callback failed")       \
 157   XX(CB_url, "the on_url callback failed")                           \
 158   XX(CB_header_field, "the on_header_field callback failed")         \
 159   XX(CB_header_value, "the on_header_value callback failed")         \
 160   XX(CB_headers_complete, "the on_headers_complete callback failed") \
 161   XX(CB_body, "the on_body callback failed")                         \
 162   XX(CB_message_complete, "the on_message_complete callback failed") \
 163   XX(CB_status, "the on_status callback failed")                     \
 164   XX(CB_chunk_header, "the on_chunk_header callback failed")         \
 165   XX(CB_chunk_complete, "the on_chunk_complete callback failed")     \
 166                                                                      \
 167   /* Parsing-related errors */                                       \
 168   XX(INVALID_EOF_STATE, "stream ended at an unexpected time")        \
 169   XX(HEADER_OVERFLOW,                                                \
 170      "too many header bytes seen; overflow detected")                \
 171   XX(CLOSED_CONNECTION,                                              \
 172      "data received after completed connection: close message")      \
 173   XX(INVALID_VERSION, "invalid HTTP version")                        \
 174   XX(INVALID_STATUS, "invalid HTTP status code")                     \
 175   XX(INVALID_METHOD, "invalid HTTP method")                          \
 176   XX(INVALID_URL, "invalid URL")                                     \
 177   XX(INVALID_HOST, "invalid host")                                   \
 178   XX(INVALID_PORT, "invalid port")                                   \
 179   XX(INVALID_PATH, "invalid path")                                   \
 180   XX(INVALID_QUERY_STRING, "invalid query string")                   \
 181   XX(INVALID_FRAGMENT, "invalid fragment")                           \
 182   XX(LF_EXPECTED, "LF character expected")                           \
 183   XX(INVALID_HEADER_TOKEN, "invalid character in header")            \
 184   XX(INVALID_CONTENT_LENGTH,                                         \
 185      "invalid character in content-length header")                   \
 186   XX(UNEXPECTED_CONTENT_LENGTH,                                      \
 187      "unexpected content-length header")                             \
 188   XX(INVALID_CHUNK_SIZE,                                             \
 189      "invalid character in chunk size header")                       \
 190   XX(INVALID_CONSTANT, "invalid constant string")                    \
 191   XX(INVALID_INTERNAL_STATE, "encountered unexpected internal state")\
 192   XX(STRICT, "strict mode assertion failed")                         \
 193   XX(PAUSED, "parser is paused")                                     \
 194   XX(UNKNOWN, "an unknown error occurred")
 195
 196
 197 /* Define HPE_* values for each errno value above */
 198 #define HTTP_ERRNO_GEN(n, s) HPE_##n,
 199 enum http_errno {
 200   HTTP_ERRNO_MAP(HTTP_ERRNO_GEN)
 201 };
 202 #undef HTTP_ERRNO_GEN
 203
 204
 205 /* Get an http_errno value from an http_parser */
 206 #define HTTP_PARSER_ERRNO(p)            ((enum http_errno) (p)->http_errno)
 207
 208
 209 struct http_parser {
 210   /** PRIVATE **/
 211   unsigned int type : 2;         /* enum http_parser_type */
 212   unsigned int flags : 8;        /* F_* values from 'flags' enum; semi-public */
 213   unsigned int state : 7;        /* enum state from http_parser.c */
 214   unsigned int header_state : 7; /* enum header_state from http_parser.c */
 215   unsigned int index : 7;        /* index into current matcher */
 216   unsigned int lenient_http_headers : 1;
 217
 218   uint32_t nread;          /* # bytes read in various scenarios */
 219   uint64_t content_length; /* # bytes in body (0 if no Content-Length header) */
 220
 221   /** READ-ONLY **/
 222   unsigned short http_major;
 223   unsigned short http_minor;
 224   unsigned int status_code : 16; /* responses only */
 225   unsigned int method : 8;       /* requests only */
 226   unsigned int http_errno : 7;
 227
 228   /* 1 = Upgrade header was present and the parser has exited because of that.
 229    * 0 = No upgrade header present.
 230    * Should be checked when http_parser_execute() returns in addition to
 231    * error checking.
 232    */
 233   unsigned int upgrade : 1;
 234
 235   /** PUBLIC **/
 236   void *data; /* A pointer to get hook to the "connection" or "socket" object */
 237 };
 238
 239
 240 struct http_parser_settings {
 241   http_cb      on_message_begin;
 242   http_data_cb on_url;
 243   http_data_cb on_status;
 244   http_data_cb on_header_field;
 245   http_data_cb on_header_value;
 246   http_cb      on_headers_complete;
 247   http_data_cb on_body;
 248   http_cb      on_message_complete;
 249   /* When on_chunk_header is called, the current chunk length is stored
 250    * in parser->content_length.
 251    */
 252   http_cb      on_chunk_header;
 253   http_cb      on_chunk_complete;
 254 };
 255
 256
 257 enum http_parser_url_fields
 258   { UF_SCHEMA           = 0
 259   , UF_HOST             = 1
 260   , UF_PORT             = 2
 261   , UF_PATH             = 3
 262   , UF_QUERY            = 4
 263   , UF_FRAGMENT         = 5
 264   , UF_USERINFO         = 6
 265   , UF_MAX              = 7
 266   };
 267
 268
 269 /* Result structure for http_parser_parse_url().
 270  *
 271  * Callers should index into field_data[] with UF_* values iff field_set
 272  * has the relevant (1 << UF_*) bit set. As a courtesy to clients (and
 273  * because we probably have padding left over), we convert any port to
 274  * a uint16_t.
 275  */
 276 struct http_parser_url {
 277   uint16_t field_set;           /* Bitmask of (1 << UF_*) values */
 278   uint16_t port;                /* Converted UF_PORT string */
 279
 280   struct {
 281     uint16_t off;               /* Offset into buffer in which field starts */
 282     uint16_t len;               /* Length of run in buffer */
 283   } field_data[UF_MAX];
 284 };
 285
 286
 287 /* Returns the library version. Bits 16-23 contain the major version number,
 288  * bits 8-15 the minor version number and bits 0-7 the patch level.
 289  * Usage example:
 290  *
 291  *   unsigned long version = http_parser_version();
 292  *   unsigned major = (version >> 16) & 255;
 293  *   unsigned minor = (version >> 8) & 255;
 294  *   unsigned patch = version & 255;
 295  *   printf("http_parser v%u.%u.%u\n", major, minor, patch);
 296  */
 297 unsigned long http_parser_version(void);
 298
 299 void http_parser_init(http_parser *parser, enum http_parser_type type);
 300
 301
 302 /* Initialize http_parser_settings members to 0
 303  */
 304 void http_parser_settings_init(http_parser_settings *settings);
 305
 306
 307 /* Executes the parser. Returns number of parsed bytes. Sets
 308  * `parser->http_errno` on error. */
 309 size_t http_parser_execute(http_parser *parser,
 310                            const http_parser_settings *settings,
 311                            const char *data,
 312                            size_t len);
 313
 314
 315 /* If http_should_keep_alive() in the on_headers_complete or
 316  * on_message_complete callback returns 0, then this should be
 317  * the last message on the connection.
 318  * If you are the server, respond with the "Connection: close" header.
 319  * If you are the client, close the connection.
 320  */
 321 int http_should_keep_alive(const http_parser *parser);
 322
 323 /* Returns a string version of the HTTP method. */
 324 const char *http_method_str(enum http_method m);
 325
 326 /* Return a string name of the given error */
 327 const char *http_errno_name(enum http_errno err);
 328
 329 /* Return a string description of the given error */
 330 const char *http_errno_description(enum http_errno err);
 331
 332 /* Parse a URL; return nonzero on failure */
 333 int http_parser_parse_url(const char *buf, size_t buflen,
 334                           int is_connect,
 335                           struct http_parser_url *u);
 336
 337 /* Pause or un-pause the parser; a nonzero value pauses */
 338 void http_parser_pause(http_parser *parser, int paused);
 339
 340 /* Checks if this is the final chunk of the body. */
 341 int http_body_is_final(const http_parser *parser);
 342
 343 #ifdef __cplusplus
 344 }
 345 #endif
 346 #endif