Summary: This lib would be used in efl_network_websocket. Signed-off-by: Srivardhan Hebbar <sri.hebbar@samsung.com> Reviewers: cedric Reviewed By: cedric Differential Revision: https://phab.enlightenment.org/D3244 Signed-off-by: Cedric BAIL <cedric@osg.samsung.com>devs/discomfitor/xdg-shedsmanship
Srivardhan Hebbar
8 years ago
committed by
Cedric BAIL
parent
b9913d52e8
commit
e5a9c7844f
11 changed files with 6466 additions and 1 deletions
@ -0,0 +1,23 @@ |
||||
http_parser.c is based on src/http/ngx_http_parse.c from NGINX copyright |
||||
Igor Sysoev. |
||||
|
||||
Additional changes are licensed under the same terms as NGINX and |
||||
copyright Joyent, Inc. and other Node contributors. All rights reserved. |
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
of this software and associated documentation files (the "Software"), to |
||||
deal in the Software without restriction, including without limitation the |
||||
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
||||
sell copies of the Software, and to permit persons to whom the Software is |
||||
furnished to do so, subject to the following conditions: |
||||
|
||||
The above copyright notice and this permission notice shall be included in |
||||
all copies or substantial portions of the Software. |
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
||||
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS |
||||
IN THE SOFTWARE. |
||||
@ -0,0 +1,4 @@ |
||||
Contributors must agree to the Contributor License Agreement before patches |
||||
can be accepted. |
||||
|
||||
http://spreadsheets2.google.com/viewform?hl=en&formkey=dDJXOGUwbzlYaWM4cHN1MERwQS1CSnc6MQ |
||||
@ -0,0 +1,183 @@ |
||||
HTTP Parser |
||||
=========== |
||||
|
||||
[](https://travis-ci.org/joyent/http-parser) |
||||
|
||||
This is a parser for HTTP messages written in C. It parses both requests and |
||||
responses. The parser is designed to be used in performance HTTP |
||||
applications. It does not make any syscalls nor allocations, it does not |
||||
buffer data, it can be interrupted at anytime. Depending on your |
||||
architecture, it only requires about 40 bytes of data per message |
||||
stream (in a web server that is per connection). |
||||
|
||||
Features: |
||||
|
||||
* No dependencies |
||||
* Handles persistent streams (keep-alive). |
||||
* Decodes chunked encoding. |
||||
* Upgrade support |
||||
* Defends against buffer overflow attacks. |
||||
|
||||
The parser extracts the following information from HTTP messages: |
||||
|
||||
* Header fields and values |
||||
* Content-Length |
||||
* Request method |
||||
* Response status code |
||||
* Transfer-Encoding |
||||
* HTTP version |
||||
* Request URL |
||||
* Message body |
||||
|
||||
|
||||
Usage |
||||
----- |
||||
|
||||
One `http_parser` object is used per TCP connection. Initialize the struct |
||||
using `http_parser_init()` and set the callbacks. That might look something |
||||
like this for a request parser: |
||||
```c |
||||
http_parser_settings settings; |
||||
settings.on_url = my_url_callback; |
||||
settings.on_header_field = my_header_field_callback; |
||||
/* ... */ |
||||
|
||||
http_parser *parser = malloc(sizeof(http_parser)); |
||||
http_parser_init(parser, HTTP_REQUEST); |
||||
parser->data = my_socket; |
||||
``` |
||||
|
||||
When data is received on the socket execute the parser and check for errors. |
||||
|
||||
```c |
||||
size_t len = 80*1024, nparsed; |
||||
char buf[len]; |
||||
ssize_t recved; |
||||
|
||||
recved = recv(fd, buf, len, 0); |
||||
|
||||
if (recved < 0) { |
||||
/* Handle error. */ |
||||
} |
||||
|
||||
/* Start up / continue the parser. |
||||
* Note we pass recved==0 to signal that EOF has been recieved. |
||||
*/ |
||||
nparsed = http_parser_execute(parser, &settings, buf, recved); |
||||
|
||||
if (parser->upgrade) { |
||||
/* handle new protocol */ |
||||
} else if (nparsed != recved) { |
||||
/* Handle error. Usually just close the connection. */ |
||||
} |
||||
``` |
||||
|
||||
HTTP needs to know where the end of the stream is. For example, sometimes |
||||
servers send responses without Content-Length and expect the client to |
||||
consume input (for the body) until EOF. To tell http_parser about EOF, give |
||||
`0` as the forth parameter to `http_parser_execute()`. Callbacks and errors |
||||
can still be encountered during an EOF, so one must still be prepared |
||||
to receive them. |
||||
|
||||
Scalar valued message information such as `status_code`, `method`, and the |
||||
HTTP version are stored in the parser structure. This data is only |
||||
temporally stored in `http_parser` and gets reset on each new message. If |
||||
this information is needed later, copy it out of the structure during the |
||||
`headers_complete` callback. |
||||
|
||||
The parser decodes the transfer-encoding for both requests and responses |
||||
transparently. That is, a chunked encoding is decoded before being sent to |
||||
the on_body callback. |
||||
|
||||
|
||||
The Special Problem of Upgrade |
||||
------------------------------ |
||||
|
||||
HTTP supports upgrading the connection to a different protocol. An |
||||
increasingly common example of this is the Web Socket protocol which sends |
||||
a request like |
||||
|
||||
GET /demo HTTP/1.1 |
||||
Upgrade: WebSocket |
||||
Connection: Upgrade |
||||
Host: example.com |
||||
Origin: http://example.com |
||||
WebSocket-Protocol: sample |
||||
|
||||
followed by non-HTTP data. |
||||
|
||||
(See http://tools.ietf.org/html/draft-hixie-thewebsocketprotocol-75 for more |
||||
information the Web Socket protocol.) |
||||
|
||||
To support this, the parser will treat this as a normal HTTP message without a |
||||
body. Issuing both on_headers_complete and on_message_complete callbacks. However |
||||
http_parser_execute() will stop parsing at the end of the headers and return. |
||||
|
||||
The user is expected to check if `parser->upgrade` has been set to 1 after |
||||
`http_parser_execute()` returns. Non-HTTP data begins at the buffer supplied |
||||
offset by the return value of `http_parser_execute()`. |
||||
|
||||
|
||||
Callbacks |
||||
--------- |
||||
|
||||
During the `http_parser_execute()` call, the callbacks set in |
||||
`http_parser_settings` will be executed. The parser maintains state and |
||||
never looks behind, so buffering the data is not necessary. If you need to |
||||
save certain data for later usage, you can do that from the callbacks. |
||||
|
||||
There are two types of callbacks: |
||||
|
||||
* notification `typedef int (*http_cb) (http_parser*);` |
||||
Callbacks: on_message_begin, on_headers_complete, on_message_complete. |
||||
* data `typedef int (*http_data_cb) (http_parser*, const char *at, size_t length);` |
||||
Callbacks: (requests only) on_uri, |
||||
(common) on_header_field, on_header_value, on_body; |
||||
|
||||
Callbacks must return 0 on success. Returning a non-zero value indicates |
||||
error to the parser, making it exit immediately. |
||||
|
||||
In case you parse HTTP message in chunks (i.e. `read()` request line |
||||
from socket, parse, read half headers, parse, etc) your data callbacks |
||||
may be called more than once. Http-parser guarantees that data pointer is only |
||||
valid for the lifetime of callback. You can also `read()` into a heap allocated |
||||
buffer to avoid copying memory around if this fits your application. |
||||
|
||||
Reading headers may be a tricky task if you read/parse headers partially. |
||||
Basically, you need to remember whether last header callback was field or value |
||||
and apply following logic: |
||||
|
||||
(on_header_field and on_header_value shortened to on_h_*) |
||||
------------------------ ------------ -------------------------------------------- |
||||
| State (prev. callback) | Callback | Description/action | |
||||
------------------------ ------------ -------------------------------------------- |
||||
| nothing (first call) | on_h_field | Allocate new buffer and copy callback data | |
||||
| | | into it | |
||||
------------------------ ------------ -------------------------------------------- |
||||
| value | on_h_field | New header started. | |
||||
| | | Copy current name,value buffers to headers | |
||||
| | | list and allocate new buffer for new name | |
||||
------------------------ ------------ -------------------------------------------- |
||||
| field | on_h_field | Previous name continues. Reallocate name | |
||||
| | | buffer and append callback data to it | |
||||
------------------------ ------------ -------------------------------------------- |
||||
| field | on_h_value | Value for current header started. Allocate | |
||||
| | | new buffer and copy callback data to it | |
||||
------------------------ ------------ -------------------------------------------- |
||||
| value | on_h_value | Value continues. Reallocate value buffer | |
||||
| | | and append callback data to it | |
||||
------------------------ ------------ -------------------------------------------- |
||||
|
||||
|
||||
Parsing URLs |
||||
------------ |
||||
|
||||
A simplistic zero-copy URL parser is provided as `http_parser_parse_url()`. |
||||
Users of this library may wish to use it to parse URLs constructed from |
||||
consecutive `on_url` callbacks. |
||||
|
||||
See examples of reading in headers: |
||||
|
||||
* [partial example](http://gist.github.com/155877) in C |
||||
* [from http-parser tests](http://github.com/joyent/http-parser/blob/37a0ff8/test.c#L403) in C |
||||
* [from Node library](http://github.com/joyent/node/blob/842eaf4/src/http.js#L284) in Javascript |
||||
@ -0,0 +1,156 @@ |
||||
/* Based on src/http/ngx_http_parse.c from NGINX copyright Igor Sysoev
|
||||
* |
||||
* Additional changes are licensed under the same terms as NGINX and |
||||
* copyright Joyent, Inc. and other Node contributors. All rights reserved. |
||||
* |
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
* of this software and associated documentation files (the "Software"), to |
||||
* deal in the Software without restriction, including without limitation the |
||||
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
||||
* sell copies of the Software, and to permit persons to whom the Software is |
||||
* furnished to do so, subject to the following conditions: |
||||
* |
||||
* The above copyright notice and this permission notice shall be included in |
||||
* all copies or substantial portions of the Software. |
||||
* |
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
||||
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS |
||||
* IN THE SOFTWARE. |
||||
*/ |
||||
|
||||
/* Dump what the parser finds to stdout as it happen */ |
||||
|
||||
#include "http_parser.h" |
||||
#include <stdio.h> |
||||
#include <stdlib.h> |
||||
#include <string.h> |
||||
|
||||
int on_message_begin(http_parser* _) { |
||||
(void)_; |
||||
printf("\n***MESSAGE BEGIN***\n\n"); |
||||
return 0; |
||||
} |
||||
|
||||
int on_headers_complete(http_parser* _) { |
||||
(void)_; |
||||
printf("\n***HEADERS COMPLETE***\n\n"); |
||||
return 0; |
||||
} |
||||
|
||||
int on_message_complete(http_parser* _) { |
||||
(void)_; |
||||
printf("\n***MESSAGE COMPLETE***\n\n"); |
||||
return 0; |
||||
} |
||||
|
||||
int on_url(http_parser* _, const char* at, size_t length) { |
||||
(void)_; |
||||
printf("Url: %.*s\n", (int)length, at); |
||||
return 0; |
||||
} |
||||
|
||||
int on_header_field(http_parser* _, const char* at, size_t length) { |
||||
(void)_; |
||||
printf("Header field: %.*s\n", (int)length, at); |
||||
return 0; |
||||
} |
||||
|
||||
int on_header_value(http_parser* _, const char* at, size_t length) { |
||||
(void)_; |
||||
printf("Header value: %.*s\n", (int)length, at); |
||||
return 0; |
||||
} |
||||
|
||||
int on_body(http_parser* _, const char* at, size_t length) { |
||||
(void)_; |
||||
printf("Body: %.*s\n", (int)length, at); |
||||
return 0; |
||||
} |
||||
|
||||
void usage(const char* name) { |
||||
fprintf(stderr, |
||||
"Usage: %s $type $filename\n" |
||||
" type: -x, where x is one of {r,b,q}\n" |
||||
" parses file as a Response, reQuest, or Both\n", |
||||
name); |
||||
exit(EXIT_FAILURE); |
||||
} |
||||
|
||||
int main(int argc, char* argv[]) { |
||||
enum http_parser_type file_type; |
||||
|
||||
if (argc != 3) { |
||||
usage(argv[0]); |
||||
} |
||||
|
||||
char* type = argv[1]; |
||||
if (type[0] != '-') { |
||||
usage(argv[0]); |
||||
} |
||||
|
||||
switch (type[1]) { |
||||
/* in the case of "-", type[1] will be NUL */ |
||||
case 'r': |
||||
file_type = HTTP_RESPONSE; |
||||
break; |
||||
case 'q': |
||||
file_type = HTTP_REQUEST; |
||||
break; |
||||
case 'b': |
||||
file_type = HTTP_BOTH; |
||||
break; |
||||
default: |
||||
usage(argv[0]); |
||||
} |
||||
|
||||
char* filename = argv[2]; |
||||
FILE* file = fopen(filename, "r"); |
||||
if (file == NULL) { |
||||
perror("fopen"); |
||||
return EXIT_FAILURE; |
||||
} |
||||
|
||||
fseek(file, 0, SEEK_END); |
||||
long file_length = ftell(file); |
||||
if (file_length == -1) { |
||||
perror("ftell"); |
||||
return EXIT_FAILURE; |
||||
} |
||||
fseek(file, 0, SEEK_SET); |
||||
|
||||
char* data = malloc(file_length); |
||||
if (fread(data, 1, file_length, file) != (size_t)file_length) { |
||||
fprintf(stderr, "couldn't read entire file\n"); |
||||
free(data); |
||||
return EXIT_FAILURE; |
||||
} |
||||
|
||||
http_parser_settings settings; |
||||
memset(&settings, 0, sizeof(settings)); |
||||
settings.on_message_begin = on_message_begin; |
||||
settings.on_url = on_url; |
||||
settings.on_header_field = on_header_field; |
||||
settings.on_header_value = on_header_value; |
||||
settings.on_headers_complete = on_headers_complete; |
||||
settings.on_body = on_body; |
||||
settings.on_message_complete = on_message_complete; |
||||
|
||||
http_parser parser; |
||||
http_parser_init(&parser, file_type); |
||||
size_t nparsed = http_parser_execute(&parser, &settings, data, file_length); |
||||
free(data); |
||||
|
||||
if (nparsed != (size_t)file_length) { |
||||
fprintf(stderr, |
||||
"Error: %s (%s)\n", |
||||
http_errno_description(HTTP_PARSER_ERRNO(&parser)), |
||||
http_errno_name(HTTP_PARSER_ERRNO(&parser))); |
||||
return EXIT_FAILURE; |
||||
} |
||||
|
||||
return EXIT_SUCCESS; |
||||
} |
||||
@ -0,0 +1,44 @@ |
||||
#include "http_parser.h" |
||||
#include <stdio.h> |
||||
#include <string.h> |
||||
|
||||
void |
||||
dump_url (const char *url, const struct http_parser_url *u) |
||||
{ |
||||
unsigned int i; |
||||
|
||||
printf("\tfield_set: 0x%x, port: %u\n", u->field_set, u->port); |
||||
for (i = 0; i < UF_MAX; i++) { |
||||
if ((u->field_set & (1 << i)) == 0) { |
||||
printf("\tfield_data[%u]: unset\n", i); |
||||
continue; |
||||
} |
||||
|
||||
printf("\tfield_data[%u]: off: %u len: %u part: \"%.*s\n", |
||||
i, |
||||
u->field_data[i].off, |
||||
u->field_data[i].len, |
||||
u->field_data[i].len, |
||||
url + u->field_data[i].off); |
||||
} |
||||
} |
||||
|
||||
int main(int argc, char ** argv) { |
||||
if (argc != 3) { |
||||
printf("Syntax : %s connect|get url\n", argv[0]); |
||||
return 1; |
||||
} |
||||
struct http_parser_url u; |
||||
int len = strlen(argv[2]); |
||||
int connect = strcmp("connect", argv[1]) == 0 ? 1 : 0; |
||||
printf("Parsing %s, connect %d\n", argv[2], connect); |
||||
|
||||
int result = http_parser_parse_url(argv[2], len, connect, &u); |
||||
if (result != 0) { |
||||
printf("Parse error : %d\n", result); |
||||
return result; |
||||
} |
||||
printf("Parse ok, result : \n"); |
||||
dump_url(argv[2], &u); |
||||
return 0; |
||||
} |
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,318 @@ |
||||
/* Copyright Joyent, Inc. and other Node contributors. All rights reserved.
|
||||
* |
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy |
||||
* of this software and associated documentation files (the "Software"), to |
||||
* deal in the Software without restriction, including without limitation the |
||||
* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
||||
* sell copies of the Software, and to permit persons to whom the Software is |
||||
* furnished to do so, subject to the following conditions: |
||||
* |
||||
* The above copyright notice and this permission notice shall be included in |
||||
* all copies or substantial portions of the Software. |
||||
* |
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
||||
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
||||
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
||||
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
||||
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
||||
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS |
||||
* IN THE SOFTWARE. |
||||
*/ |
||||
#ifndef http_parser_h |
||||
#define http_parser_h |
||||
#ifdef __cplusplus |
||||
extern "C" { |
||||
#endif |
||||
|
||||
/* Also update SONAME in the Makefile whenever you change these. */ |
||||
#define HTTP_PARSER_VERSION_MAJOR 2 |
||||
#define HTTP_PARSER_VERSION_MINOR 1 |
||||
#define HTTP_PARSER_VERSION_PATCH 0 |
||||
|
||||
#include <sys/types.h> |
||||
#if defined(_WIN32) && !defined(__MINGW32__) && (!defined(_MSC_VER) || _MSC_VER<1600) |
||||
#include <BaseTsd.h> |
||||
#include <stddef.h> |
||||
typedef __int8 int8_t; |
||||
typedef unsigned __int8 uint8_t; |
||||
typedef __int16 int16_t; |
||||
typedef unsigned __int16 uint16_t; |
||||
typedef __int32 int32_t; |
||||
typedef unsigned __int32 uint32_t; |
||||
typedef __int64 int64_t; |
||||
typedef unsigned __int64 uint64_t; |
||||
#else |
||||
#include <stdint.h> |
||||
#endif |
||||
|
||||
/* Compile with -DHTTP_PARSER_STRICT=0 to make less checks, but run
|
||||
* faster |
||||
*/ |
||||
#ifndef HTTP_PARSER_STRICT |
||||
# define HTTP_PARSER_STRICT 1 |
||||
#endif |
||||
|
||||
/* Maximium header size allowed */ |
||||
#define HTTP_MAX_HEADER_SIZE (80*1024) |
||||
|
||||
|
||||
typedef struct http_parser http_parser; |
||||
typedef struct http_parser_settings http_parser_settings; |
||||
|
||||
|
||||
/* Callbacks should return non-zero to indicate an error. The parser will
|
||||
* then halt execution. |
||||
* |
||||
* The one exception is on_headers_complete. In a HTTP_RESPONSE parser |
||||
* returning '1' from on_headers_complete will tell the parser that it |
||||
* should not expect a body. This is used when receiving a response to a |
||||
* HEAD request which may contain 'Content-Length' or 'Transfer-Encoding: |
||||
* chunked' headers that indicate the presence of a body. |
||||
* |
||||
* http_data_cb does not return data chunks. It will be call arbitrarally |
||||
* many times for each string. E.G. you might get 10 callbacks for "on_url" |
||||
* each providing just a few characters more data. |
||||
*/ |
||||
typedef int (*http_data_cb) (http_parser*, const char *at, size_t length); |
||||
typedef int (*http_cb) (http_parser*); |
||||
|
||||
|
||||
/* Request Methods */ |
||||
#define HTTP_METHOD_MAP(XX) \ |
||||
XX(0, DELETE, DELETE) \
|
||||
XX(1, GET, GET) \
|
||||
XX(2, HEAD, HEAD) \
|
||||
XX(3, POST, POST) \
|
||||
XX(4, PUT, PUT) \
|
||||
/* pathological */ \
|
||||
XX(5, CONNECT, CONNECT) \
|
||||
XX(6, OPTIONS, OPTIONS) \
|
||||
XX(7, TRACE, TRACE) \
|
||||
/* webdav */ \
|
||||
XX(8, COPY, COPY) \
|
||||
XX(9, LOCK, LOCK) \
|
||||
XX(10, MKCOL, MKCOL) \
|
||||
XX(11, MOVE, MOVE) \
|
||||
XX(12, PROPFIND, PROPFIND) \
|
||||
XX(13, PROPPATCH, PROPPATCH) \
|
||||
XX(14, SEARCH, SEARCH) \
|
||||
XX(15, UNLOCK, UNLOCK) \
|
||||
/* subversion */ \
|
||||
XX(16, REPORT, REPORT) \
|
||||
XX(17, MKACTIVITY, MKACTIVITY) \
|
||||
XX(18, CHECKOUT, CHECKOUT) \
|
||||
XX(19, MERGE, MERGE) \
|
||||
/* upnp */ \
|
||||
XX(20, MSEARCH, M-SEARCH) \
|
||||
XX(21, NOTIFY, NOTIFY) \
|
||||
XX(22, SUBSCRIBE, SUBSCRIBE) \
|
||||
XX(23, UNSUBSCRIBE, UNSUBSCRIBE) \
|
||||
/* RFC-5789 */ \
|
||||
XX(24, PATCH, PATCH) \
|
||||
XX(25, PURGE, PURGE) \
|
||||
|
||||
enum http_method |
||||
{ |
||||
#define XX(num, name, string) HTTP_##name = num, |
||||
HTTP_METHOD_MAP(XX) |
||||
#undef XX |
||||
}; |
||||
|
||||
|
||||
enum http_parser_type { HTTP_REQUEST, HTTP_RESPONSE, HTTP_BOTH }; |
||||
|
||||
|
||||
/* Flag values for http_parser.flags field */ |
||||
enum flags |
||||
{ F_CHUNKED = 1 << 0 |
||||
, F_CONNECTION_KEEP_ALIVE = 1 << 1 |
||||
, F_CONNECTION_CLOSE = 1 << 2 |
||||
, F_TRAILING = 1 << 3 |
||||
, F_UPGRADE = 1 << 4 |
||||
, F_SKIPBODY = 1 << 5 |
||||
}; |
||||
|
||||
|
||||
/* Map for errno-related constants
|
||||
*
|
||||
* The provided argument should be a macro that takes 2 arguments. |
||||
*/ |
||||
#define HTTP_ERRNO_MAP(XX) \ |
||||
/* No error */ \
|
||||
XX(OK, "success") \
|
||||
\
|
||||
/* Callback-related errors */ \
|
||||
XX(CB_message_begin, "the on_message_begin callback failed") \
|
||||
XX(CB_status_complete, "the on_status_complete callback failed") \
|
||||
XX(CB_url, "the on_url callback failed") \
|
||||
XX(CB_header_field, "the on_header_field callback failed") \
|
||||
XX(CB_header_value, "the on_header_value callback failed") \
|
||||
XX(CB_headers_complete, "the on_headers_complete callback failed") \
|
||||
XX(CB_body, "the on_body callback failed") \
|
||||
XX(CB_message_complete, "the on_message_complete callback failed") \
|
||||
\
|
||||
/* Parsing-related errors */ \
|
||||
XX(INVALID_EOF_STATE, "stream ended at an unexpected time") \
|
||||
XX(HEADER_OVERFLOW, \
|
||||
"too many header bytes seen; overflow detected") \
|
||||
XX(CLOSED_CONNECTION, \
|
||||
"data received after completed connection: close message") \
|
||||
XX(INVALID_VERSION, "invalid HTTP version") \
|
||||
XX(INVALID_STATUS, "invalid HTTP status code") \
|
||||
XX(INVALID_METHOD, "invalid HTTP method") \
|
||||
XX(INVALID_URL, "invalid URL") \
|
||||
XX(INVALID_HOST, "invalid host") \
|
||||
XX(INVALID_PORT, "invalid port") \
|
||||
XX(INVALID_PATH, "invalid path") \
|
||||
XX(INVALID_QUERY_STRING, "invalid query string") \
|
||||
XX(INVALID_FRAGMENT, "invalid fragment") \
|
||||
XX(LF_EXPECTED, "LF character expected") \
|
||||
XX(INVALID_HEADER_TOKEN, "invalid character in header") \
|
||||
XX(INVALID_CONTENT_LENGTH, \
|
||||
"invalid character in content-length header") \
|
||||
XX(INVALID_CHUNK_SIZE, \
|
||||
"invalid character in chunk size header") \
|
||||
XX(INVALID_CONSTANT, "invalid constant string") \
|
||||
XX(INVALID_INTERNAL_STATE, "encountered unexpected internal state")\
|
||||
XX(STRICT, "strict mode assertion failed") \
|
||||
XX(PAUSED, "parser is paused") \
|
||||
XX(UNKNOWN, "an unknown error occurred") |
||||
|
||||
|
||||
/* Define HPE_* values for each errno value above */ |
||||
#define HTTP_ERRNO_GEN(n, s) HPE_##n, |
||||
enum http_errno { |
||||
HTTP_ERRNO_MAP(HTTP_ERRNO_GEN) |
||||
}; |
||||
#undef HTTP_ERRNO_GEN |
||||
|
||||
|
||||
/* Get an http_errno value from an http_parser */ |
||||
#define HTTP_PARSER_ERRNO(p) ((enum http_errno) (p)->http_errno) |
||||
|
||||
|
||||
struct http_parser { |
||||
/** PRIVATE **/ |
||||
unsigned int type : 2; /* enum http_parser_type */ |
||||
unsigned int flags : 6; /* F_* values from 'flags' enum; semi-public */ |
||||
unsigned int state : 8; /* enum state from http_parser.c */ |
||||
unsigned int header_state : 8; /* enum header_state from http_parser.c */ |
||||
unsigned int index : 8; /* index into current matcher */ |
||||
|
||||
uint32_t nread; /* # bytes read in various scenarios */ |
||||
uint64_t content_length; /* # bytes in body (0 if no Content-Length header) */ |
||||
|
||||
/** READ-ONLY **/ |
||||
unsigned short http_major; |
||||
unsigned short http_minor; |
||||
unsigned int status_code : 16; /* responses only */ |
||||
unsigned int method : 8; /* requests only */ |
||||
unsigned int http_errno : 7; |
||||
|
||||
/* 1 = Upgrade header was present and the parser has exited because of that.
|
||||
* 0 = No upgrade header present. |
||||
* Should be checked when http_parser_execute() returns in addition to |
||||
* error checking. |
||||
*/ |
||||
unsigned int upgrade : 1; |
||||
|
||||
/** PUBLIC **/ |
||||
void *data; /* A pointer to get hook to the "connection" or "socket" object */ |
||||
}; |
||||
|
||||
|
||||
struct http_parser_settings { |
||||
http_cb on_message_begin; |
||||
http_data_cb on_url; |
||||
http_cb on_status_complete; |
||||
http_data_cb on_header_field; |
||||
http_data_cb on_header_value; |
||||
http_cb on_headers_complete; |
||||
http_data_cb on_body; |
||||
http_cb on_message_complete; |
||||
}; |
||||
|
||||
|
||||
enum http_parser_url_fields |
||||
{ UF_SCHEMA = 0 |
||||
, UF_HOST = 1 |
||||
, UF_PORT = 2 |
||||
, UF_PATH = 3 |
||||
, UF_QUERY = 4 |
||||
, UF_FRAGMENT = 5 |
||||
, UF_USERINFO = 6 |
||||
, UF_MAX = 7 |
||||
}; |
||||
|
||||
|
||||
/* Result structure for http_parser_parse_url().
|
||||
* |
||||
* Callers should index into field_data[] with UF_* values iff field_set |
||||
* has the relevant (1 << UF_*) bit set. As a courtesy to clients (and |
||||
* because we probably have padding left over), we convert any port to |
||||
* a uint16_t. |
||||
*/ |
||||
struct http_parser_url { |
||||
uint16_t field_set; /* Bitmask of (1 << UF_*) values */ |
||||
uint16_t port; /* Converted UF_PORT string */ |
||||
|
||||
struct { |
||||
uint16_t off; /* Offset into buffer in which field starts */ |
||||
uint16_t len; /* Length of run in buffer */ |
||||
} field_data[UF_MAX]; |
||||
}; |
||||
|
||||
|
||||
/* Returns the library version. Bits 16-23 contain the major version number,
|
||||
* bits 8-15 the minor version number and bits 0-7 the patch level. |
||||
* Usage example: |
||||
* |
||||
* unsigned long version = http_parser_version(); |
||||
* unsigned major = (version >> 16) & 255; |
||||
* unsigned minor = (version >> 8) & 255; |
||||
* unsigned patch = version & 255; |
||||
* printf("http_parser v%u.%u.%u\n", major, minor, version); |
||||
*/ |
||||
unsigned long http_parser_version(void); |
||||
|
||||
void http_parser_init(http_parser *parser, enum http_parser_type type); |
||||
|
||||
|
||||
size_t http_parser_execute(http_parser *parser, |
||||
const http_parser_settings *settings, |
||||
const char *data, |
||||
size_t len); |
||||
|
||||
|
||||
/* If http_should_keep_alive() in the on_headers_complete or
|
||||
* on_message_complete callback returns 0, then this should be |
||||
* the last message on the connection. |
||||
* If you are the server, respond with the "Connection: close" header. |
||||
* If you are the client, close the connection. |
||||
*/ |
||||
int http_should_keep_alive(const http_parser *parser); |
||||
|
||||
/* Returns a string version of the HTTP method. */ |
||||
const char *http_method_str(enum http_method m); |
||||
|
||||
/* Return a string name of the given error */ |
||||
const char *http_errno_name(enum http_errno err); |
||||
|
||||
/* Return a string description of the given error */ |
||||
const char *http_errno_description(enum http_errno err); |
||||
|
||||
/* Parse a URL; return nonzero on failure */ |
||||
int http_parser_parse_url(const char *buf, size_t buflen, |
||||
int is_connect, |
||||
struct http_parser_url *u); |
||||
|
||||
/* Pause or un-pause the parser; a nonzero value pauses */ |
||||
void http_parser_pause(http_parser *parser, int paused); |
||||
|
||||
/* Checks if this is the final chunk of the body. */ |
||||
int http_body_is_final(const http_parser *parser); |
||||
|
||||
#ifdef __cplusplus |
||||
} |
||||
#endif |
||||
#endif |
||||
File diff suppressed because it is too large
Load Diff
Loading…
Reference in new issue