AusweisApp
Lade ...
Suche ...
Keine Treffer
http_parser.h
gehe zur Dokumentation dieser Datei
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
24extern "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 9
30#define HTTP_PARSER_VERSION_PATCH 4
31
32#include <stddef.h>
33#if defined(_WIN32) && !defined(__MINGW32__) && \
34 (!defined(_MSC_VER) || _MSC_VER<1600) && !defined(__WINE__)
35#include <BaseTsd.h>
36typedef __int8 int8_t;
37typedef unsigned __int8 uint8_t;
38typedef __int16 int16_t;
39typedef unsigned __int16 uint16_t;
40typedef __int32 int32_t;
41typedef unsigned __int32 uint32_t;
42typedef __int64 int64_t;
43typedef 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
66typedef struct http_parser http_parser;
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 * Returning `2` from on_headers_complete will tell parser that it should not
80 * expect neither a body nor any futher responses on this connection. This is
81 * useful for handling responses to a CONNECT request which may not contain
82 * `Upgrade` or `Connection: upgrade` headers.
83 *
84 * http_data_cb does not return data chunks. It will be called arbitrarily
85 * many times for each string. E.G. you might get 10 callbacks for "on_url"
86 * each providing just a few characters more data.
87 */
88typedef int (*http_data_cb) (http_parser*, const char *at, size_t length);
89typedef int (*http_cb) (http_parser*);
90
91
92/* Status Codes */
93#define HTTP_STATUS_MAP(XX) \
94 XX(100, CONTINUE, Continue) \
95 XX(101, SWITCHING_PROTOCOLS, Switching Protocols) \
96 XX(102, PROCESSING, Processing) \
97 XX(200, OK, OK) \
98 XX(201, CREATED, Created) \
99 XX(202, ACCEPTED, Accepted) \
100 XX(203, NON_AUTHORITATIVE_INFORMATION, Non-Authoritative Information) \
101 XX(204, NO_CONTENT, No Content) \
102 XX(205, RESET_CONTENT, Reset Content) \
103 XX(206, PARTIAL_CONTENT, Partial Content) \
104 XX(207, MULTI_STATUS, Multi-Status) \
105 XX(208, ALREADY_REPORTED, Already Reported) \
106 XX(226, IM_USED, IM Used) \
107 XX(300, MULTIPLE_CHOICES, Multiple Choices) \
108 XX(301, MOVED_PERMANENTLY, Moved Permanently) \
109 XX(302, FOUND, Found) \
110 XX(303, SEE_OTHER, See Other) \
111 XX(304, NOT_MODIFIED, Not Modified) \
112 XX(305, USE_PROXY, Use Proxy) \
113 XX(307, TEMPORARY_REDIRECT, Temporary Redirect) \
114 XX(308, PERMANENT_REDIRECT, Permanent Redirect) \
115 XX(400, BAD_REQUEST, Bad Request) \
116 XX(401, UNAUTHORIZED, Unauthorized) \
117 XX(402, PAYMENT_REQUIRED, Payment Required) \
118 XX(403, FORBIDDEN, Forbidden) \
119 XX(404, NOT_FOUND, Not Found) \
120 XX(405, METHOD_NOT_ALLOWED, Method Not Allowed) \
121 XX(406, NOT_ACCEPTABLE, Not Acceptable) \
122 XX(407, PROXY_AUTHENTICATION_REQUIRED, Proxy Authentication Required) \
123 XX(408, REQUEST_TIMEOUT, Request Timeout) \
124 XX(409, CONFLICT, Conflict) \
125 XX(410, GONE, Gone) \
126 XX(411, LENGTH_REQUIRED, Length Required) \
127 XX(412, PRECONDITION_FAILED, Precondition Failed) \
128 XX(413, PAYLOAD_TOO_LARGE, Payload Too Large) \
129 XX(414, URI_TOO_LONG, URI Too Long) \
130 XX(415, UNSUPPORTED_MEDIA_TYPE, Unsupported Media Type) \
131 XX(416, RANGE_NOT_SATISFIABLE, Range Not Satisfiable) \
132 XX(417, EXPECTATION_FAILED, Expectation Failed) \
133 XX(421, MISDIRECTED_REQUEST, Misdirected Request) \
134 XX(422, UNPROCESSABLE_ENTITY, Unprocessable Entity) \
135 XX(423, LOCKED, Locked) \
136 XX(424, FAILED_DEPENDENCY, Failed Dependency) \
137 XX(426, UPGRADE_REQUIRED, Upgrade Required) \
138 XX(428, PRECONDITION_REQUIRED, Precondition Required) \
139 XX(429, TOO_MANY_REQUESTS, Too Many Requests) \
140 XX(431, REQUEST_HEADER_FIELDS_TOO_LARGE, Request Header Fields Too Large) \
141 XX(451, UNAVAILABLE_FOR_LEGAL_REASONS, Unavailable For Legal Reasons) \
142 XX(500, INTERNAL_SERVER_ERROR, Internal Server Error) \
143 XX(501, NOT_IMPLEMENTED, Not Implemented) \
144 XX(502, BAD_GATEWAY, Bad Gateway) \
145 XX(503, SERVICE_UNAVAILABLE, Service Unavailable) \
146 XX(504, GATEWAY_TIMEOUT, Gateway Timeout) \
147 XX(505, HTTP_VERSION_NOT_SUPPORTED, HTTP Version Not Supported) \
148 XX(506, VARIANT_ALSO_NEGOTIATES, Variant Also Negotiates) \
149 XX(507, INSUFFICIENT_STORAGE, Insufficient Storage) \
150 XX(508, LOOP_DETECTED, Loop Detected) \
151 XX(510, NOT_EXTENDED, Not Extended) \
152 XX(511, NETWORK_AUTHENTICATION_REQUIRED, Network Authentication Required) \
153
155 {
156#define XX(num, name, string) HTTP_STATUS_##name = num,
158#undef XX
159 };
160
161
162/* Request Methods */
163#define HTTP_METHOD_MAP(XX) \
164 XX(0, DELETE, DELETE) \
165 XX(1, GET, GET) \
166 XX(2, HEAD, HEAD) \
167 XX(3, POST, POST) \
168 XX(4, PUT, PUT) \
169 /* pathological */ \
170 XX(5, CONNECT, CONNECT) \
171 XX(6, OPTIONS, OPTIONS) \
172 XX(7, TRACE, TRACE) \
173 /* WebDAV */ \
174 XX(8, COPY, COPY) \
175 XX(9, LOCK, LOCK) \
176 XX(10, MKCOL, MKCOL) \
177 XX(11, MOVE, MOVE) \
178 XX(12, PROPFIND, PROPFIND) \
179 XX(13, PROPPATCH, PROPPATCH) \
180 XX(14, SEARCH, SEARCH) \
181 XX(15, UNLOCK, UNLOCK) \
182 XX(16, BIND, BIND) \
183 XX(17, REBIND, REBIND) \
184 XX(18, UNBIND, UNBIND) \
185 XX(19, ACL, ACL) \
186 /* subversion */ \
187 XX(20, REPORT, REPORT) \
188 XX(21, MKACTIVITY, MKACTIVITY) \
189 XX(22, CHECKOUT, CHECKOUT) \
190 XX(23, MERGE, MERGE) \
191 /* upnp */ \
192 XX(24, MSEARCH, M-SEARCH) \
193 XX(25, NOTIFY, NOTIFY) \
194 XX(26, SUBSCRIBE, SUBSCRIBE) \
195 XX(27, UNSUBSCRIBE, UNSUBSCRIBE) \
196 /* RFC-5789 */ \
197 XX(28, PATCH, PATCH) \
198 XX(29, PURGE, PURGE) \
199 /* CalDAV */ \
200 XX(30, MKCALENDAR, MKCALENDAR) \
201 /* RFC-2068, section 19.6.1.2 */ \
202 XX(31, LINK, LINK) \
203 XX(32, UNLINK, UNLINK) \
204 /* icecast */ \
205 XX(33, SOURCE, SOURCE) \
206
208 {
209#define XX(num, name, string) HTTP_##name = num,
211#undef XX
212 };
213
214
216
217
218/* Flag values for http_parser.flags field */
220 { F_CHUNKED = 1 << 0
224 , F_TRAILING = 1 << 4
225 , F_UPGRADE = 1 << 5
226 , F_SKIPBODY = 1 << 6
228 , F_TRANSFER_ENCODING = 1 << 8 /* Never set in http_parser.flags */
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 XX(INVALID_TRANSFER_ENCODING, \
281 "request has invalid transfer-encoding") \
282
283
284/* Define HPE_* values for each errno value above */
285#define HTTP_ERRNO_GEN(n, s) HPE_##n,
289#undef HTTP_ERRNO_GEN
290
291
292/* Get an http_errno value from an http_parser */
293#define HTTP_PARSER_ERRNO(p) ((enum http_errno) (p)->http_errno)
294
295
298 unsigned int type : 2; /* enum http_parser_type */
299 unsigned int flags : 8; /* F_* values from 'flags' enum; semi-public */
300 unsigned int state : 7; /* enum state from http_parser.c */
301 unsigned int header_state : 7; /* enum header_state from http_parser.c */
302 unsigned int index : 5; /* index into current matcher */
303 unsigned int extra_flags : 2;
304 unsigned int lenient_http_headers : 1;
305
306 uint32_t nread; /* # bytes read in various scenarios */
307 uint64_t content_length; /* # bytes in body (0 if no Content-Length header) */
308
310 unsigned short http_major;
311 unsigned short http_minor;
312 unsigned int status_code : 16; /* responses only */
313 unsigned int method : 8; /* requests only */
314 unsigned int http_errno : 7;
315
316 /* 1 = Upgrade header was present and the parser has exited because of that.
317 * 0 = No upgrade header present.
318 * Should be checked when http_parser_execute() returns in addition to
319 * error checking.
320 */
321 unsigned int upgrade : 1;
322
324 void *data; /* A pointer to get hook to the "connection" or "socket" object */
325};
326
327
343
344
355
356
357/* Result structure for http_parser_parse_url().
358 *
359 * Callers should index into field_data[] with UF_* values iff field_set
360 * has the relevant (1 << UF_*) bit set. As a courtesy to clients (and
361 * because we probably have padding left over), we convert any port to
362 * a uint16_t.
363 */
365 uint16_t field_set; /* Bitmask of (1 << UF_*) values */
366 uint16_t port; /* Converted UF_PORT string */
367
368 struct {
369 uint16_t off; /* Offset into buffer in which field starts */
370 uint16_t len; /* Length of run in buffer */
372};
373
374
375/* Returns the library version. Bits 16-23 contain the major version number,
376 * bits 8-15 the minor version number and bits 0-7 the patch level.
377 * Usage example:
378 *
379 * unsigned long version = http_parser_version();
380 * unsigned major = (version >> 16) & 255;
381 * unsigned minor = (version >> 8) & 255;
382 * unsigned patch = version & 255;
383 * printf("http_parser v%u.%u.%u\n", major, minor, patch);
384 */
385unsigned long http_parser_version(void);
386
387void http_parser_init(http_parser *parser, enum http_parser_type type);
388
389
390/* Initialize http_parser_settings members to 0
391 */
393
394
395/* Executes the parser. Returns number of parsed bytes. Sets
396 * `parser->http_errno` on error. */
397size_t http_parser_execute(http_parser *parser,
398 const http_parser_settings *settings,
399 const char *data,
400 size_t len);
401
402
403/* If http_should_keep_alive() in the on_headers_complete or
404 * on_message_complete callback returns 0, then this should be
405 * the last message on the connection.
406 * If you are the server, respond with the "Connection: close" header.
407 * If you are the client, close the connection.
408 */
409int http_should_keep_alive(const http_parser *parser);
410
411/* Returns a string version of the HTTP method. */
412const char *http_method_str(enum http_method m);
413
414/* Returns a string version of the HTTP status code. */
415const char *http_status_str(enum http_status s);
416
417/* Return a string name of the given error */
418const char *http_errno_name(enum http_errno err);
419
420/* Return a string description of the given error */
421const char *http_errno_description(enum http_errno err);
422
423/* Initialize all http_parser_url members to 0 */
425
426/* Parse a URL; return nonzero on failure */
427int http_parser_parse_url(const char *buf, size_t buflen,
428 int is_connect,
429 struct http_parser_url *u);
430
431/* Pause or un-pause the parser; a nonzero value pauses */
432void http_parser_pause(http_parser *parser, int paused);
433
434/* Checks if this is the final chunk of the body. */
436
437/* Change the maximum header size provided at compile time. */
438void http_parser_set_max_header_size(uint32_t size);
439
440#ifdef __cplusplus
441}
442#endif
443#endif
#define XX(num, name, string)
Definition http_parser.h:156
void http_parser_settings_init(http_parser_settings *settings)
Definition http_parser.cpp:2229
#define HTTP_METHOD_MAP(XX)
Definition http_parser.h:163
void http_parser_init(http_parser *parser, enum http_parser_type type)
Definition http_parser.cpp:2218
http_errno
Definition http_parser.h:286
unsigned long http_parser_version(void)
Definition http_parser.cpp:2559
const char * http_status_str(enum http_status s)
Definition http_parser.cpp:2207
size_t http_parser_execute(http_parser *parser, const http_parser_settings *settings, const char *data, size_t len)
Definition http_parser.cpp:641
#define HTTP_ERRNO_MAP(XX)
Definition http_parser.h:236
void http_parser_url_init(struct http_parser_url *u)
Definition http_parser.cpp:2411
#define HTTP_ERRNO_GEN(n, s)
Definition http_parser.h:285
int(* http_data_cb)(http_parser *, const char *at, size_t length)
Definition http_parser.h:88
const char * http_errno_description(enum http_errno err)
Definition http_parser.cpp:2241
http_parser_url_fields
Definition http_parser.h:346
@ UF_FRAGMENT
Definition http_parser.h:351
@ UF_PORT
Definition http_parser.h:348
@ UF_MAX
Definition http_parser.h:353
@ UF_PATH
Definition http_parser.h:349
@ UF_SCHEMA
Definition http_parser.h:346
@ UF_QUERY
Definition http_parser.h:350
@ UF_USERINFO
Definition http_parser.h:352
@ UF_HOST
Definition http_parser.h:347
int(* http_cb)(http_parser *)
Definition http_parser.h:89
http_method
Definition http_parser.h:208
void http_parser_pause(http_parser *parser, int paused)
Definition http_parser.cpp:2539
flags
Definition http_parser.h:220
@ F_CHUNKED
Definition http_parser.h:220
@ F_CONNECTION_CLOSE
Definition http_parser.h:222
@ F_CONNECTION_KEEP_ALIVE
Definition http_parser.h:221
@ F_UPGRADE
Definition http_parser.h:225
@ F_TRANSFER_ENCODING
Definition http_parser.h:228
@ F_CONTENTLENGTH
Definition http_parser.h:227
@ F_TRAILING
Definition http_parser.h:224
@ F_SKIPBODY
Definition http_parser.h:226
@ F_CONNECTION_UPGRADE
Definition http_parser.h:223
const char * http_method_str(enum http_method m)
Definition http_parser.cpp:2201
http_status
Definition http_parser.h:155
int http_should_keep_alive(const http_parser *parser)
Definition http_parser.cpp:2182
void http_parser_set_max_header_size(uint32_t size)
Definition http_parser.cpp:2566
#define HTTP_STATUS_MAP(XX)
Definition http_parser.h:93
const char * http_errno_name(enum http_errno err)
Definition http_parser.cpp:2235
int http_parser_parse_url(const char *buf, size_t buflen, int is_connect, struct http_parser_url *u)
Definition http_parser.cpp:2416
int http_body_is_final(const http_parser *parser)
http_parser_type
Definition http_parser.h:215
@ HTTP_RESPONSE
Definition http_parser.h:215
@ HTTP_REQUEST
Definition http_parser.h:215
@ HTTP_BOTH
Definition http_parser.h:215
Definition http_parser.h:328
http_data_cb on_header_value
Definition http_parser.h:333
http_cb on_chunk_header
Definition http_parser.h:340
http_data_cb on_status
Definition http_parser.h:331
http_cb on_headers_complete
Definition http_parser.h:334
http_data_cb on_url
Definition http_parser.h:330
http_data_cb on_body
Definition http_parser.h:335
http_cb on_chunk_complete
Definition http_parser.h:341
http_cb on_message_begin
Definition http_parser.h:329
http_data_cb on_header_field
Definition http_parser.h:332
http_cb on_message_complete
Definition http_parser.h:336
Definition http_parser.h:364
struct http_parser_url::@1 field_data[UF_MAX]
uint16_t len
Definition http_parser.h:370
uint16_t off
Definition http_parser.h:369
uint16_t field_set
Definition http_parser.h:365
uint16_t port
Definition http_parser.h:366
Definition http_parser.h:296
unsigned int flags
Definition http_parser.h:299
unsigned int state
Definition http_parser.h:300
unsigned int index
Definition http_parser.h:302
unsigned int upgrade
Definition http_parser.h:321
uint32_t nread
Definition http_parser.h:306
unsigned int method
Definition http_parser.h:313
void * data
Definition http_parser.h:324
uint64_t content_length
Definition http_parser.h:307
unsigned int status_code
Definition http_parser.h:312
unsigned int http_errno
Definition http_parser.h:314
unsigned int header_state
Definition http_parser.h:301
unsigned int type
Definition http_parser.h:298
unsigned short http_major
Definition http_parser.h:310
unsigned int lenient_http_headers
Definition http_parser.h:304
unsigned int extra_flags
Definition http_parser.h:303
unsigned short http_minor
Definition http_parser.h:311