1 /* Copyright Joyent, Inc. and other Node contributors. All rights reserved.
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:
10 * The above copyright notice and this permission notice shall be included in
11 * all copies or substantial portions of the Software.
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
27 /* Also update SONAME in the Makefile whenever you change these. */
28 #define HTTP_PARSER_VERSION_MAJOR 2
29 #define HTTP_PARSER_VERSION_MINOR 4
30 #define HTTP_PARSER_VERSION_PATCH 2
32 #include <sys/types.h>
33 #if defined(_WIN32) && !defined(__MINGW32__) && (!defined(_MSC_VER) || _MSC_VER<1600)
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;
48 /* Compile with -DHTTP_PARSER_STRICT=0 to make less checks, but run
51 #ifndef HTTP_PARSER_STRICT
52 # define HTTP_PARSER_STRICT 1
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)
62 #ifndef HTTP_MAX_HEADER_SIZE
63 # define HTTP_MAX_HEADER_SIZE (80*1024)
66 typedef struct http_parser http_parser;
67 typedef struct http_parser_settings http_parser_settings;
70 /* Callbacks should return non-zero to indicate an error. The parser will
71 * then halt execution.
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.
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.
83 typedef int (*http_data_cb) (http_parser*, const char *at, size_t length);
84 typedef int (*http_cb) (http_parser*);
88 #define HTTP_METHOD_MAP(XX) \
89 XX(0, DELETE, DELETE) \
95 XX(5, CONNECT, CONNECT) \
96 XX(6, OPTIONS, OPTIONS) \
101 XX(10, MKCOL, MKCOL) \
103 XX(12, PROPFIND, PROPFIND) \
104 XX(13, PROPPATCH, PROPPATCH) \
105 XX(14, SEARCH, SEARCH) \
106 XX(15, UNLOCK, UNLOCK) \
108 XX(16, REPORT, REPORT) \
109 XX(17, MKACTIVITY, MKACTIVITY) \
110 XX(18, CHECKOUT, CHECKOUT) \
111 XX(19, MERGE, MERGE) \
113 XX(20, MSEARCH, M-SEARCH) \
114 XX(21, NOTIFY, NOTIFY) \
115 XX(22, SUBSCRIBE, SUBSCRIBE) \
116 XX(23, UNSUBSCRIBE, UNSUBSCRIBE) \
118 XX(24, PATCH, PATCH) \
119 XX(25, PURGE, PURGE) \
121 XX(26, MKCALENDAR, MKCALENDAR) \
125 #define XX(num, name, string) HTTP_##name = num,
131 enum http_parser_type { HTTP_REQUEST, HTTP_RESPONSE, HTTP_BOTH };
134 /* Flag values for http_parser.flags field */
137 , F_CONNECTION_KEEP_ALIVE = 1 << 1
138 , F_CONNECTION_CLOSE = 1 << 2
139 , F_CONNECTION_UPGRADE = 1 << 3
140 , F_TRAILING = 1 << 4
142 , F_SKIPBODY = 1 << 6
146 /* Map for errno-related constants
148 * The provided argument should be a macro that takes 2 arguments.
150 #define HTTP_ERRNO_MAP(XX) \
154 /* Callback-related errors */ \
155 XX(CB_message_begin, "the on_message_begin callback failed") \
156 XX(CB_url, "the on_url callback failed") \
157 XX(CB_header_field, "the on_header_field callback failed") \
158 XX(CB_header_value, "the on_header_value callback failed") \
159 XX(CB_headers_complete, "the on_headers_complete callback failed") \
160 XX(CB_body, "the on_body callback failed") \
161 XX(CB_message_complete, "the on_message_complete callback failed") \
162 XX(CB_status, "the on_status callback failed") \
164 /* Parsing-related errors */ \
165 XX(INVALID_EOF_STATE, "stream ended at an unexpected time") \
166 XX(HEADER_OVERFLOW, \
167 "too many header bytes seen; overflow detected") \
168 XX(CLOSED_CONNECTION, \
169 "data received after completed connection: close message") \
170 XX(INVALID_VERSION, "invalid HTTP version") \
171 XX(INVALID_STATUS, "invalid HTTP status code") \
172 XX(INVALID_METHOD, "invalid HTTP method") \
173 XX(INVALID_URL, "invalid URL") \
174 XX(INVALID_HOST, "invalid host") \
175 XX(INVALID_PORT, "invalid port") \
176 XX(INVALID_PATH, "invalid path") \
177 XX(INVALID_QUERY_STRING, "invalid query string") \
178 XX(INVALID_FRAGMENT, "invalid fragment") \
179 XX(LF_EXPECTED, "LF character expected") \
180 XX(INVALID_HEADER_TOKEN, "invalid character in header") \
181 XX(INVALID_CONTENT_LENGTH, \
182 "invalid character in content-length header") \
183 XX(INVALID_CHUNK_SIZE, \
184 "invalid character in chunk size header") \
185 XX(INVALID_CONSTANT, "invalid constant string") \
186 XX(INVALID_INTERNAL_STATE, "encountered unexpected internal state")\
187 XX(STRICT, "strict mode assertion failed") \
188 XX(PAUSED, "parser is paused") \
189 XX(UNKNOWN, "an unknown error occurred")
192 /* Define HPE_* values for each errno value above */
193 #define HTTP_ERRNO_GEN(n, s) HPE_##n,
195 HTTP_ERRNO_MAP(HTTP_ERRNO_GEN)
197 #undef HTTP_ERRNO_GEN
200 /* Get an http_errno value from an http_parser */
201 #define HTTP_PARSER_ERRNO(p) ((enum http_errno) (p)->http_errno)
206 unsigned int type : 2; /* enum http_parser_type */
207 unsigned int flags : 7; /* F_* values from 'flags' enum; semi-public */
208 unsigned int state : 7; /* enum state from http_parser.c */
209 unsigned int header_state : 8; /* enum header_state from http_parser.c */
210 unsigned int index : 8; /* index into current matcher */
212 uint32_t nread; /* # bytes read in various scenarios */
213 uint64_t content_length; /* # bytes in body (0 if no Content-Length header) */
216 unsigned short http_major;
217 unsigned short http_minor;
218 unsigned int status_code : 16; /* responses only */
219 unsigned int method : 8; /* requests only */
220 unsigned int http_errno : 7;
222 /* 1 = Upgrade header was present and the parser has exited because of that.
223 * 0 = No upgrade header present.
224 * Should be checked when http_parser_execute() returns in addition to
227 unsigned int upgrade : 1;
230 void *data; /* A pointer to get hook to the "connection" or "socket" object */
234 struct http_parser_settings {
235 http_cb on_message_begin;
237 http_data_cb on_status;
238 http_data_cb on_header_field;
239 http_data_cb on_header_value;
240 http_cb on_headers_complete;
241 http_data_cb on_body;
242 http_cb on_message_complete;
246 enum http_parser_url_fields
258 /* Result structure for http_parser_parse_url().
260 * Callers should index into field_data[] with UF_* values iff field_set
261 * has the relevant (1 << UF_*) bit set. As a courtesy to clients (and
262 * because we probably have padding left over), we convert any port to
265 struct http_parser_url {
266 uint16_t field_set; /* Bitmask of (1 << UF_*) values */
267 uint16_t port; /* Converted UF_PORT string */
270 uint16_t off; /* Offset into buffer in which field starts */
271 uint16_t len; /* Length of run in buffer */
272 } field_data[UF_MAX];
276 /* Returns the library version. Bits 16-23 contain the major version number,
277 * bits 8-15 the minor version number and bits 0-7 the patch level.
280 * unsigned long version = http_parser_version();
281 * unsigned major = (version >> 16) & 255;
282 * unsigned minor = (version >> 8) & 255;
283 * unsigned patch = version & 255;
284 * printf("http_parser v%u.%u.%u\n", major, minor, patch);
286 unsigned long http_parser_version(void);
288 void http_parser_init(http_parser *parser, enum http_parser_type type);
291 /* Initialize http_parser_settings members to 0
293 void http_parser_settings_init(http_parser_settings *settings);
296 /* Executes the parser. Returns number of parsed bytes. Sets
297 * `parser->http_errno` on error. */
298 size_t http_parser_execute(http_parser *parser,
299 const http_parser_settings *settings,
304 /* If http_should_keep_alive() in the on_headers_complete or
305 * on_message_complete callback returns 0, then this should be
306 * the last message on the connection.
307 * If you are the server, respond with the "Connection: close" header.
308 * If you are the client, close the connection.
310 int http_should_keep_alive(const http_parser *parser);
312 /* Returns a string version of the HTTP method. */
313 const char *http_method_str(enum http_method m);
315 /* Return a string name of the given error */
316 const char *http_errno_name(enum http_errno err);
318 /* Return a string description of the given error */
319 const char *http_errno_description(enum http_errno err);
321 /* Parse a URL; return nonzero on failure */
322 int http_parser_parse_url(const char *buf, size_t buflen,
324 struct http_parser_url *u);
326 /* Pause or un-pause the parser; a nonzero value pauses */
327 void http_parser_pause(http_parser *parser, int paused);
329 /* Checks if this is the final chunk of the body. */
330 int http_body_is_final(const http_parser *parser);