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