2
0

http_parser.h 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432
  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. /* Also update SONAME in the Makefile whenever you change these. */
  27. #define HTTP_PARSER_VERSION_MAJOR 2
  28. #define HTTP_PARSER_VERSION_MINOR 7
  29. #define HTTP_PARSER_VERSION_PATCH 1
  30. #include <sys/types.h>
  31. #if defined(_WIN32) && !defined(__MINGW32__) && \
  32. (!defined(_MSC_VER) || _MSC_VER<1600) && !defined(__WINE__)
  33. #include <BaseTsd.h>
  34. #include <stddef.h>
  35. typedef __int8 int8_t;
  36. typedef unsigned __int8 uint8_t;
  37. typedef __int16 int16_t;
  38. typedef unsigned __int16 uint16_t;
  39. typedef __int32 int32_t;
  40. typedef unsigned __int32 uint32_t;
  41. typedef __int64 int64_t;
  42. typedef unsigned __int64 uint64_t;
  43. #else
  44. #include <stdint.h>
  45. #endif
  46. /* Compile with -DHTTP_PARSER_STRICT=0 to make less checks, but run
  47. * faster
  48. */
  49. #ifndef HTTP_PARSER_STRICT
  50. # define HTTP_PARSER_STRICT 1
  51. #endif
  52. /* Maximium header size allowed. If the macro is not defined
  53. * before including this header then the default is used. To
  54. * change the maximum header size, define the macro in the build
  55. * environment (e.g. -DHTTP_MAX_HEADER_SIZE=<value>). To remove
  56. * the effective limit on the size of the header, define the macro
  57. * to a very large number (e.g. -DHTTP_MAX_HEADER_SIZE=0x7fffffff)
  58. */
  59. #ifndef HTTP_MAX_HEADER_SIZE
  60. # define HTTP_MAX_HEADER_SIZE (80*1024)
  61. #endif
  62. typedef struct http_parser http_parser;
  63. typedef struct http_parser_settings http_parser_settings;
  64. /* Callbacks should return non-zero to indicate an error. The parser will
  65. * then halt execution.
  66. *
  67. * The one exception is on_headers_complete. In a HTTP_RESPONSE parser
  68. * returning '1' from on_headers_complete will tell the parser that it
  69. * should not expect a body. This is used when receiving a response to a
  70. * HEAD request which may contain 'Content-Length' or 'Transfer-Encoding:
  71. * chunked' headers that indicate the presence of a body.
  72. *
  73. * Returning `2` from on_headers_complete will tell parser that it should not
  74. * expect neither a body nor any futher responses on this connection. This is
  75. * useful for handling responses to a CONNECT request which may not contain
  76. * `Upgrade` or `Connection: upgrade` headers.
  77. *
  78. * http_data_cb does not return data chunks. It will be called arbitrarily
  79. * many times for each string. E.G. you might get 10 callbacks for "on_url"
  80. * each providing just a few characters more data.
  81. */
  82. typedef int (*http_data_cb) (http_parser*, const char *at, size_t length);
  83. typedef int (*http_cb) (http_parser*);
  84. /* Status Codes */
  85. #define HTTP_STATUS_MAP(XX) \
  86. XX(100, CONTINUE, Continue) \
  87. XX(101, SWITCHING_PROTOCOLS, Switching Protocols) \
  88. XX(102, PROCESSING, Processing) \
  89. XX(200, OK, OK) \
  90. XX(201, CREATED, Created) \
  91. XX(202, ACCEPTED, Accepted) \
  92. XX(203, NON_AUTHORITATIVE_INFORMATION, Non-Authoritative Information) \
  93. XX(204, NO_CONTENT, No Content) \
  94. XX(205, RESET_CONTENT, Reset Content) \
  95. XX(206, PARTIAL_CONTENT, Partial Content) \
  96. XX(207, MULTI_STATUS, Multi-Status) \
  97. XX(208, ALREADY_REPORTED, Already Reported) \
  98. XX(226, IM_USED, IM Used) \
  99. XX(300, MULTIPLE_CHOICES, Multiple Choices) \
  100. XX(301, MOVED_PERMANENTLY, Moved Permanently) \
  101. XX(302, FOUND, Found) \
  102. XX(303, SEE_OTHER, See Other) \
  103. XX(304, NOT_MODIFIED, Not Modified) \
  104. XX(305, USE_PROXY, Use Proxy) \
  105. XX(307, TEMPORARY_REDIRECT, Temporary Redirect) \
  106. XX(308, PERMANENT_REDIRECT, Permanent Redirect) \
  107. XX(400, BAD_REQUEST, Bad Request) \
  108. XX(401, UNAUTHORIZED, Unauthorized) \
  109. XX(402, PAYMENT_REQUIRED, Payment Required) \
  110. XX(403, FORBIDDEN, Forbidden) \
  111. XX(404, NOT_FOUND, Not Found) \
  112. XX(405, METHOD_NOT_ALLOWED, Method Not Allowed) \
  113. XX(406, NOT_ACCEPTABLE, Not Acceptable) \
  114. XX(407, PROXY_AUTHENTICATION_REQUIRED, Proxy Authentication Required) \
  115. XX(408, REQUEST_TIMEOUT, Request Timeout) \
  116. XX(409, CONFLICT, Conflict) \
  117. XX(410, GONE, Gone) \
  118. XX(411, LENGTH_REQUIRED, Length Required) \
  119. XX(412, PRECONDITION_FAILED, Precondition Failed) \
  120. XX(413, PAYLOAD_TOO_LARGE, Payload Too Large) \
  121. XX(414, URI_TOO_LONG, URI Too Long) \
  122. XX(415, UNSUPPORTED_MEDIA_TYPE, Unsupported Media Type) \
  123. XX(416, RANGE_NOT_SATISFIABLE, Range Not Satisfiable) \
  124. XX(417, EXPECTATION_FAILED, Expectation Failed) \
  125. XX(421, MISDIRECTED_REQUEST, Misdirected Request) \
  126. XX(422, UNPROCESSABLE_ENTITY, Unprocessable Entity) \
  127. XX(423, LOCKED, Locked) \
  128. XX(424, FAILED_DEPENDENCY, Failed Dependency) \
  129. XX(426, UPGRADE_REQUIRED, Upgrade Required) \
  130. XX(428, PRECONDITION_REQUIRED, Precondition Required) \
  131. XX(429, TOO_MANY_REQUESTS, Too Many Requests) \
  132. XX(431, REQUEST_HEADER_FIELDS_TOO_LARGE, Request Header Fields Too Large) \
  133. XX(451, UNAVAILABLE_FOR_LEGAL_REASONS, Unavailable For Legal Reasons) \
  134. XX(500, INTERNAL_SERVER_ERROR, Internal Server Error) \
  135. XX(501, NOT_IMPLEMENTED, Not Implemented) \
  136. XX(502, BAD_GATEWAY, Bad Gateway) \
  137. XX(503, SERVICE_UNAVAILABLE, Service Unavailable) \
  138. XX(504, GATEWAY_TIMEOUT, Gateway Timeout) \
  139. XX(505, HTTP_VERSION_NOT_SUPPORTED, HTTP Version Not Supported) \
  140. XX(506, VARIANT_ALSO_NEGOTIATES, Variant Also Negotiates) \
  141. XX(507, INSUFFICIENT_STORAGE, Insufficient Storage) \
  142. XX(508, LOOP_DETECTED, Loop Detected) \
  143. XX(510, NOT_EXTENDED, Not Extended) \
  144. XX(511, NETWORK_AUTHENTICATION_REQUIRED, Network Authentication Required) \
  145. enum http_status
  146. {
  147. #define XX(num, name, string) HTTP_STATUS_##name = num,
  148. HTTP_STATUS_MAP(XX)
  149. #undef XX
  150. };
  151. /* Request Methods */
  152. #define HTTP_METHOD_MAP(XX) \
  153. XX(0, DELETE, DELETE) \
  154. XX(1, GET, GET) \
  155. XX(2, HEAD, HEAD) \
  156. XX(3, POST, POST) \
  157. XX(4, PUT, PUT) \
  158. /* pathological */ \
  159. XX(5, CONNECT, CONNECT) \
  160. XX(6, OPTIONS, OPTIONS) \
  161. XX(7, TRACE, TRACE) \
  162. /* WebDAV */ \
  163. XX(8, COPY, COPY) \
  164. XX(9, LOCK, LOCK) \
  165. XX(10, MKCOL, MKCOL) \
  166. XX(11, MOVE, MOVE) \
  167. XX(12, PROPFIND, PROPFIND) \
  168. XX(13, PROPPATCH, PROPPATCH) \
  169. XX(14, SEARCH, SEARCH) \
  170. XX(15, UNLOCK, UNLOCK) \
  171. XX(16, BIND, BIND) \
  172. XX(17, REBIND, REBIND) \
  173. XX(18, UNBIND, UNBIND) \
  174. XX(19, ACL, ACL) \
  175. /* subversion */ \
  176. XX(20, REPORT, REPORT) \
  177. XX(21, MKACTIVITY, MKACTIVITY) \
  178. XX(22, CHECKOUT, CHECKOUT) \
  179. XX(23, MERGE, MERGE) \
  180. /* upnp */ \
  181. XX(24, MSEARCH, M-SEARCH) \
  182. XX(25, NOTIFY, NOTIFY) \
  183. XX(26, SUBSCRIBE, SUBSCRIBE) \
  184. XX(27, UNSUBSCRIBE, UNSUBSCRIBE) \
  185. /* RFC-5789 */ \
  186. XX(28, PATCH, PATCH) \
  187. XX(29, PURGE, PURGE) \
  188. /* CalDAV */ \
  189. XX(30, MKCALENDAR, MKCALENDAR) \
  190. /* RFC-2068, section 19.6.1.2 */ \
  191. XX(31, LINK, LINK) \
  192. XX(32, UNLINK, UNLINK) \
  193. enum http_method
  194. {
  195. #define XX(num, name, string) HTTP_##name = num,
  196. HTTP_METHOD_MAP(XX)
  197. #undef XX
  198. };
  199. enum http_parser_type { HTTP_REQUEST, HTTP_RESPONSE, HTTP_BOTH };
  200. /* Flag values for http_parser.flags field */
  201. enum flags
  202. { F_CHUNKED = 1 << 0
  203. , F_CONNECTION_KEEP_ALIVE = 1 << 1
  204. , F_CONNECTION_CLOSE = 1 << 2
  205. , F_CONNECTION_UPGRADE = 1 << 3
  206. , F_TRAILING = 1 << 4
  207. , F_UPGRADE = 1 << 5
  208. , F_SKIPBODY = 1 << 6
  209. , F_CONTENTLENGTH = 1 << 7
  210. };
  211. /* Map for errno-related constants
  212. *
  213. * The provided argument should be a macro that takes 2 arguments.
  214. */
  215. #define HTTP_ERRNO_MAP(XX) \
  216. /* No error */ \
  217. XX(OK, "success") \
  218. \
  219. /* Callback-related errors */ \
  220. XX(CB_message_begin, "the on_message_begin callback failed") \
  221. XX(CB_url, "the on_url callback failed") \
  222. XX(CB_header_field, "the on_header_field callback failed") \
  223. XX(CB_header_value, "the on_header_value callback failed") \
  224. XX(CB_headers_complete, "the on_headers_complete callback failed") \
  225. XX(CB_body, "the on_body callback failed") \
  226. XX(CB_message_complete, "the on_message_complete callback failed") \
  227. XX(CB_status, "the on_status callback failed") \
  228. XX(CB_chunk_header, "the on_chunk_header callback failed") \
  229. XX(CB_chunk_complete, "the on_chunk_complete callback failed") \
  230. \
  231. /* Parsing-related errors */ \
  232. XX(INVALID_EOF_STATE, "stream ended at an unexpected time") \
  233. XX(HEADER_OVERFLOW, \
  234. "too many header bytes seen; overflow detected") \
  235. XX(CLOSED_CONNECTION, \
  236. "data received after completed connection: close message") \
  237. XX(INVALID_VERSION, "invalid HTTP version") \
  238. XX(INVALID_STATUS, "invalid HTTP status code") \
  239. XX(INVALID_METHOD, "invalid HTTP method") \
  240. XX(INVALID_URL, "invalid URL") \
  241. XX(INVALID_HOST, "invalid host") \
  242. XX(INVALID_PORT, "invalid port") \
  243. XX(INVALID_PATH, "invalid path") \
  244. XX(INVALID_QUERY_STRING, "invalid query string") \
  245. XX(INVALID_FRAGMENT, "invalid fragment") \
  246. XX(LF_EXPECTED, "LF character expected") \
  247. XX(INVALID_HEADER_TOKEN, "invalid character in header") \
  248. XX(INVALID_CONTENT_LENGTH, \
  249. "invalid character in content-length header") \
  250. XX(UNEXPECTED_CONTENT_LENGTH, \
  251. "unexpected content-length header") \
  252. XX(INVALID_CHUNK_SIZE, \
  253. "invalid character in chunk size header") \
  254. XX(INVALID_CONSTANT, "invalid constant string") \
  255. XX(INVALID_INTERNAL_STATE, "encountered unexpected internal state")\
  256. XX(STRICT, "strict mode assertion failed") \
  257. XX(PAUSED, "parser is paused") \
  258. XX(UNKNOWN, "an unknown error occurred")
  259. /* Define HPE_* values for each errno value above */
  260. #define HTTP_ERRNO_GEN(n, s) HPE_##n,
  261. enum http_errno {
  262. HTTP_ERRNO_MAP(HTTP_ERRNO_GEN)
  263. };
  264. #undef HTTP_ERRNO_GEN
  265. /* Get an http_errno value from an http_parser */
  266. #define HTTP_PARSER_ERRNO(p) ((enum http_errno) (p)->http_errno)
  267. struct http_parser {
  268. /** PRIVATE **/
  269. unsigned int type : 2; /* enum http_parser_type */
  270. unsigned int flags : 8; /* F_* values from 'flags' enum; semi-public */
  271. unsigned int state : 7; /* enum state from http_parser.c */
  272. unsigned int header_state : 7; /* enum header_state from http_parser.c */
  273. unsigned int index : 7; /* index into current matcher */
  274. unsigned int lenient_http_headers : 1;
  275. uint32_t nread; /* # bytes read in various scenarios */
  276. uint64_t content_length; /* # bytes in body (0 if no Content-Length header) */
  277. /** READ-ONLY **/
  278. unsigned short http_major;
  279. unsigned short http_minor;
  280. unsigned int status_code : 16; /* responses only */
  281. unsigned int method : 8; /* requests only */
  282. unsigned int http_errno : 7;
  283. /* 1 = Upgrade header was present and the parser has exited because of that.
  284. * 0 = No upgrade header present.
  285. * Should be checked when http_parser_execute() returns in addition to
  286. * error checking.
  287. */
  288. unsigned int upgrade : 1;
  289. /** PUBLIC **/
  290. void *data; /* A pointer to get hook to the "connection" or "socket" object */
  291. };
  292. struct http_parser_settings {
  293. http_cb on_message_begin;
  294. http_data_cb on_url;
  295. http_data_cb on_status;
  296. http_data_cb on_header_field;
  297. http_data_cb on_header_value;
  298. http_cb on_headers_complete;
  299. http_data_cb on_body;
  300. http_cb on_message_complete;
  301. /* When on_chunk_header is called, the current chunk length is stored
  302. * in parser->content_length.
  303. */
  304. http_cb on_chunk_header;
  305. http_cb on_chunk_complete;
  306. };
  307. enum http_parser_url_fields
  308. { UF_SCHEMA = 0
  309. , UF_HOST = 1
  310. , UF_PORT = 2
  311. , UF_PATH = 3
  312. , UF_QUERY = 4
  313. , UF_FRAGMENT = 5
  314. , UF_USERINFO = 6
  315. , UF_MAX = 7
  316. };
  317. /* Result structure for http_parser_parse_url().
  318. *
  319. * Callers should index into field_data[] with UF_* values iff field_set
  320. * has the relevant (1 << UF_*) bit set. As a courtesy to clients (and
  321. * because we probably have padding left over), we convert any port to
  322. * a uint16_t.
  323. */
  324. struct http_parser_url {
  325. uint16_t field_set; /* Bitmask of (1 << UF_*) values */
  326. uint16_t port; /* Converted UF_PORT string */
  327. struct {
  328. uint16_t off; /* Offset into buffer in which field starts */
  329. uint16_t len; /* Length of run in buffer */
  330. } field_data[UF_MAX];
  331. };
  332. /* Returns the library version. Bits 16-23 contain the major version number,
  333. * bits 8-15 the minor version number and bits 0-7 the patch level.
  334. * Usage example:
  335. *
  336. * unsigned long version = http_parser_version();
  337. * unsigned major = (version >> 16) & 255;
  338. * unsigned minor = (version >> 8) & 255;
  339. * unsigned patch = version & 255;
  340. * printf("http_parser v%u.%u.%u\n", major, minor, patch);
  341. */
  342. unsigned long http_parser_version(void);
  343. void http_parser_init(http_parser *parser, enum http_parser_type type);
  344. /* Initialize http_parser_settings members to 0
  345. */
  346. void http_parser_settings_init(http_parser_settings *settings);
  347. /* Executes the parser. Returns number of parsed bytes. Sets
  348. * `parser->http_errno` on error. */
  349. size_t http_parser_execute(http_parser *parser,
  350. const http_parser_settings *settings,
  351. const char *data,
  352. size_t len);
  353. /* If http_should_keep_alive() in the on_headers_complete or
  354. * on_message_complete callback returns 0, then this should be
  355. * the last message on the connection.
  356. * If you are the server, respond with the "Connection: close" header.
  357. * If you are the client, close the connection.
  358. */
  359. int http_should_keep_alive(const http_parser *parser);
  360. /* Returns a string version of the HTTP method. */
  361. const char *http_method_str(enum http_method m);
  362. /* Return a string name of the given error */
  363. const char *http_errno_name(enum http_errno err);
  364. /* Return a string description of the given error */
  365. const char *http_errno_description(enum http_errno err);
  366. /* Initialize all http_parser_url members to 0 */
  367. void http_parser_url_init(struct http_parser_url *u);
  368. /* Parse a URL; return nonzero on failure */
  369. int http_parser_parse_url(const char *buf, size_t buflen,
  370. int is_connect,
  371. struct http_parser_url *u);
  372. /* Pause or un-pause the parser; a nonzero value pauses */
  373. void http_parser_pause(http_parser *parser, int paused);
  374. /* Checks if this is the final chunk of the body. */
  375. int http_body_is_final(const http_parser *parser);
  376. #ifdef __cplusplus
  377. }
  378. #endif
  379. #endif