http_parser.h 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348
  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 0
  30. #include <stddef.h>
  31. #include <stdint.h>
  32. /* Compile with -DHTTP_PARSER_STRICT=0 to make less checks, but run
  33. * faster
  34. */
  35. #ifndef HTTP_PARSER_STRICT
  36. # define HTTP_PARSER_STRICT 1
  37. #endif
  38. /* Maximium header size allowed. If the macro is not defined
  39. * before including this header then the default is used. To
  40. * change the maximum header size, define the macro in the build
  41. * environment (e.g. -DHTTP_MAX_HEADER_SIZE=<value>). To remove
  42. * the effective limit on the size of the header, define the macro
  43. * to a very large number (e.g. -DHTTP_MAX_HEADER_SIZE=0x7fffffff)
  44. */
  45. #ifndef HTTP_MAX_HEADER_SIZE
  46. # define HTTP_MAX_HEADER_SIZE (2*1024)
  47. #endif
  48. typedef struct http_parser http_parser;
  49. typedef struct http_parser_settings http_parser_settings;
  50. /* Callbacks should return non-zero to indicate an error. The parser will
  51. * then halt execution.
  52. *
  53. * The one exception is on_headers_complete. In a HTTP_RESPONSE parser
  54. * returning '1' from on_headers_complete will tell the parser that it
  55. * should not expect a body. This is used when receiving a response to a
  56. * HEAD request which may contain 'Content-Length' or 'Transfer-Encoding:
  57. * chunked' headers that indicate the presence of a body.
  58. *
  59. * Returning `2` from on_headers_complete will tell parser that it should not
  60. * expect neither a body nor any futher responses on this connection. This is
  61. * useful for handling responses to a CONNECT request which may not contain
  62. * `Upgrade` or `Connection: upgrade` headers.
  63. *
  64. * http_data_cb does not return data chunks. It will be called arbitrarily
  65. * many times for each string. E.G. you might get 10 callbacks for "on_url"
  66. * each providing just a few characters more data.
  67. */
  68. typedef int (*http_data_cb) (http_parser*, const char *at, size_t length);
  69. typedef int (*http_cb) (http_parser*);
  70. /* Request Methods */
  71. #define HTTP_METHOD_MAP(XX) \
  72. XX(0, DELETE, DELETE) \
  73. XX(1, GET, GET) \
  74. XX(2, HEAD, HEAD) \
  75. XX(3, POST, POST) \
  76. XX(4, PUT, PUT) \
  77. /* pathological */ \
  78. XX(5, CONNECT, CONNECT) \
  79. XX(6, OPTIONS, OPTIONS) \
  80. XX(7, TRACE, TRACE) \
  81. /* WebDAV */ \
  82. XX(8, COPY, COPY) \
  83. XX(9, LOCK, LOCK) \
  84. XX(10, MKCOL, MKCOL) \
  85. XX(11, MOVE, MOVE) \
  86. XX(12, PROPFIND, PROPFIND) \
  87. XX(13, PROPPATCH, PROPPATCH) \
  88. XX(14, SEARCH, SEARCH) \
  89. XX(15, UNLOCK, UNLOCK) \
  90. XX(16, BIND, BIND) \
  91. XX(17, REBIND, REBIND) \
  92. XX(18, UNBIND, UNBIND) \
  93. XX(19, ACL, ACL) \
  94. /* subversion */ \
  95. XX(20, REPORT, REPORT) \
  96. XX(21, MKACTIVITY, MKACTIVITY) \
  97. XX(22, CHECKOUT, CHECKOUT) \
  98. XX(23, MERGE, MERGE) \
  99. /* upnp */ \
  100. XX(24, MSEARCH, M-SEARCH) \
  101. XX(25, NOTIFY, NOTIFY) \
  102. XX(26, SUBSCRIBE, SUBSCRIBE) \
  103. XX(27, UNSUBSCRIBE, UNSUBSCRIBE) \
  104. /* RFC-5789 */ \
  105. XX(28, PATCH, PATCH) \
  106. XX(29, PURGE, PURGE) \
  107. /* CalDAV */ \
  108. XX(30, MKCALENDAR, MKCALENDAR) \
  109. /* RFC-2068, section 19.6.1.2 */ \
  110. XX(31, LINK, LINK) \
  111. XX(32, UNLINK, UNLINK) \
  112. enum http_method
  113. {
  114. #define XX(num, name, string) HTTP_##name = num,
  115. HTTP_METHOD_MAP(XX)
  116. #undef XX
  117. };
  118. enum http_parser_type { HTTP_REQUEST, HTTP_RESPONSE, HTTP_BOTH };
  119. /* Flag values for http_parser.flags field */
  120. enum flags
  121. { F_CHUNKED = 1 << 0
  122. , F_CONNECTION_KEEP_ALIVE = 1 << 1
  123. , F_CONNECTION_CLOSE = 1 << 2
  124. , F_CONNECTION_UPGRADE = 1 << 3
  125. , F_TRAILING = 1 << 4
  126. , F_UPGRADE = 1 << 5
  127. , F_SKIPBODY = 1 << 6
  128. , F_CONTENTLENGTH = 1 << 7
  129. };
  130. /* Map for errno-related constants
  131. *
  132. * The provided argument should be a macro that takes 2 arguments.
  133. */
  134. #define HTTP_ERRNO_MAP(XX) \
  135. /* No error */ \
  136. XX(OK, "success") \
  137. \
  138. /* Callback-related errors */ \
  139. XX(CB_message_begin, "the on_message_begin callback failed") \
  140. XX(CB_url, "the on_url callback failed") \
  141. XX(CB_header_field, "the on_header_field callback failed") \
  142. XX(CB_header_value, "the on_header_value callback failed") \
  143. XX(CB_headers_complete, "the on_headers_complete callback failed") \
  144. XX(CB_body, "the on_body callback failed") \
  145. XX(CB_message_complete, "the on_message_complete callback failed") \
  146. XX(CB_status, "the on_status callback failed") \
  147. XX(CB_chunk_header, "the on_chunk_header callback failed") \
  148. XX(CB_chunk_complete, "the on_chunk_complete callback failed") \
  149. \
  150. /* Parsing-related errors */ \
  151. XX(INVALID_EOF_STATE, "stream ended at an unexpected time") \
  152. XX(HEADER_OVERFLOW, \
  153. "too many header bytes seen; overflow detected") \
  154. XX(CLOSED_CONNECTION, \
  155. "data received after completed connection: close message") \
  156. XX(INVALID_VERSION, "invalid HTTP version") \
  157. XX(INVALID_STATUS, "invalid HTTP status code") \
  158. XX(INVALID_METHOD, "invalid HTTP method") \
  159. XX(INVALID_URL, "invalid URL") \
  160. XX(INVALID_HOST, "invalid host") \
  161. XX(INVALID_PORT, "invalid port") \
  162. XX(INVALID_PATH, "invalid path") \
  163. XX(INVALID_QUERY_STRING, "invalid query string") \
  164. XX(INVALID_FRAGMENT, "invalid fragment") \
  165. XX(LF_EXPECTED, "LF character expected") \
  166. XX(INVALID_HEADER_TOKEN, "invalid character in header") \
  167. XX(INVALID_CONTENT_LENGTH, \
  168. "invalid character in content-length header") \
  169. XX(UNEXPECTED_CONTENT_LENGTH, \
  170. "unexpected content-length header") \
  171. XX(INVALID_CHUNK_SIZE, \
  172. "invalid character in chunk size header") \
  173. XX(INVALID_CONSTANT, "invalid constant string") \
  174. XX(INVALID_INTERNAL_STATE, "encountered unexpected internal state")\
  175. XX(STRICT, "strict mode assertion failed") \
  176. XX(PAUSED, "parser is paused") \
  177. XX(UNKNOWN, "an unknown error occurred")
  178. /* Define HPE_* values for each errno value above */
  179. #define HTTP_ERRNO_GEN(n, s) HPE_##n,
  180. enum http_errno {
  181. HTTP_ERRNO_MAP(HTTP_ERRNO_GEN)
  182. };
  183. #undef HTTP_ERRNO_GEN
  184. /* Get an http_errno value from an http_parser */
  185. #define HTTP_PARSER_ERRNO(p) ((enum http_errno) (p)->http_errno)
  186. struct http_parser {
  187. /** PRIVATE **/
  188. unsigned int type : 2; /* enum http_parser_type */
  189. unsigned int flags : 8; /* F_* values from 'flags' enum; semi-public */
  190. unsigned int state : 7; /* enum state from http_parser.c */
  191. unsigned int header_state : 7; /* enum header_state from http_parser.c */
  192. unsigned int index : 7; /* index into current matcher */
  193. unsigned int lenient_http_headers : 1;
  194. uint32_t nread; /* # bytes read in various scenarios */
  195. uint64_t content_length; /* # bytes in body (0 if no Content-Length header) */
  196. /** READ-ONLY **/
  197. unsigned short http_major;
  198. unsigned short http_minor;
  199. unsigned int status_code : 16; /* responses only */
  200. unsigned int method : 8; /* requests only */
  201. unsigned int http_errno : 7;
  202. /* 1 = Upgrade header was present and the parser has exited because of that.
  203. * 0 = No upgrade header present.
  204. * Should be checked when http_parser_execute() returns in addition to
  205. * error checking.
  206. */
  207. unsigned int upgrade : 1;
  208. /** PUBLIC **/
  209. void *data; /* A pointer to get hook to the "connection" or "socket" object */
  210. };
  211. struct http_parser_settings {
  212. http_cb on_message_begin;
  213. http_data_cb on_url;
  214. http_data_cb on_status;
  215. http_data_cb on_header_field;
  216. http_data_cb on_header_value;
  217. http_cb on_headers_complete;
  218. http_data_cb on_body;
  219. http_cb on_message_complete;
  220. /* When on_chunk_header is called, the current chunk length is stored
  221. * in parser->content_length.
  222. */
  223. http_cb on_chunk_header;
  224. http_cb on_chunk_complete;
  225. };
  226. enum http_parser_url_fields
  227. { UF_SCHEMA = 0
  228. , UF_HOST = 1
  229. , UF_PORT = 2
  230. , UF_PATH = 3
  231. , UF_QUERY = 4
  232. , UF_FRAGMENT = 5
  233. , UF_USERINFO = 6
  234. , UF_MAX = 7
  235. };
  236. /* Result structure for http_parser_parse_url().
  237. *
  238. * Callers should index into field_data[] with UF_* values iff field_set
  239. * has the relevant (1 << UF_*) bit set. As a courtesy to clients (and
  240. * because we probably have padding left over), we convert any port to
  241. * a uint16_t.
  242. */
  243. struct http_parser_url {
  244. uint16_t field_set; /* Bitmask of (1 << UF_*) values */
  245. uint16_t port; /* Converted UF_PORT string */
  246. struct {
  247. uint16_t off; /* Offset into buffer in which field starts */
  248. uint16_t len; /* Length of run in buffer */
  249. } field_data[UF_MAX];
  250. };
  251. /* Returns the library version. Bits 16-23 contain the major version number,
  252. * bits 8-15 the minor version number and bits 0-7 the patch level.
  253. * Usage example:
  254. *
  255. * unsigned long version = http_parser_version();
  256. * unsigned major = (version >> 16) & 255;
  257. * unsigned minor = (version >> 8) & 255;
  258. * unsigned patch = version & 255;
  259. * printf("http_parser v%u.%u.%u\n", major, minor, patch);
  260. */
  261. unsigned long http_parser_version(void);
  262. void http_parser_init(http_parser *parser, enum http_parser_type type);
  263. /* Initialize http_parser_settings members to 0
  264. */
  265. void http_parser_settings_init(http_parser_settings *settings);
  266. /* Executes the parser. Returns number of parsed bytes. Sets
  267. * `parser->http_errno` on error. */
  268. size_t http_parser_execute(http_parser *parser,
  269. const http_parser_settings *settings,
  270. const char *data,
  271. size_t len);
  272. /* If http_should_keep_alive() in the on_headers_complete or
  273. * on_message_complete callback returns 0, then this should be
  274. * the last message on the connection.
  275. * If you are the server, respond with the "Connection: close" header.
  276. * If you are the client, close the connection.
  277. */
  278. int http_should_keep_alive(const http_parser *parser);
  279. /* Returns a string version of the HTTP method. */
  280. const char *http_method_str(enum http_method m);
  281. /* Return a string name of the given error */
  282. const char *http_errno_name(enum http_errno err);
  283. /* Return a string description of the given error */
  284. const char *http_errno_description(enum http_errno err);
  285. /* Initialize all http_parser_url members to 0 */
  286. void http_parser_url_init(struct http_parser_url *u);
  287. /* Parse a URL; return nonzero on failure */
  288. int http_parser_parse_url(const char *buf, size_t buflen,
  289. int is_connect,
  290. struct http_parser_url *u);
  291. /* Pause or un-pause the parser; a nonzero value pauses */
  292. void http_parser_pause(http_parser *parser, int paused);
  293. /* Checks if this is the final chunk of the body. */
  294. int http_body_is_final(const http_parser *parser);
  295. #ifdef __cplusplus
  296. }
  297. #endif
  298. #endif