|
@@ -24,11 +24,13 @@
|
|
|
extern "C" {
|
|
|
#endif
|
|
|
|
|
|
-#define HTTP_PARSER_VERSION_MAJOR 1
|
|
|
-#define HTTP_PARSER_VERSION_MINOR 0
|
|
|
+#define HTTP_PARSER_VERSION_MAJOR 2
|
|
|
+#define HTTP_PARSER_VERSION_MINOR 1
|
|
|
|
|
|
#include <sys/types.h>
|
|
|
-#if defined(_WIN32) && !defined(__MINGW32__)
|
|
|
+#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;
|
|
@@ -37,9 +39,6 @@ typedef __int32 int32_t;
|
|
|
typedef unsigned __int32 uint32_t;
|
|
|
typedef __int64 int64_t;
|
|
|
typedef unsigned __int64 uint64_t;
|
|
|
-
|
|
|
-typedef unsigned int size_t;
|
|
|
-typedef int ssize_t;
|
|
|
#else
|
|
|
#include <stdint.h>
|
|
|
#endif
|
|
@@ -49,11 +48,8 @@ typedef int ssize_t;
|
|
|
*/
|
|
|
#ifndef HTTP_PARSER_STRICT
|
|
|
# define HTTP_PARSER_STRICT 1
|
|
|
-#else
|
|
|
-# define HTTP_PARSER_STRICT 0
|
|
|
#endif
|
|
|
|
|
|
-
|
|
|
/* Maximium header size allowed */
|
|
|
#define HTTP_MAX_HEADER_SIZE (80*1024)
|
|
|
|
|
@@ -72,7 +68,7 @@ typedef struct http_parser_settings http_parser_settings;
|
|
|
* 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_path"
|
|
|
+ * 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);
|
|
@@ -80,63 +76,143 @@ 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
|
|
|
- { HTTP_DELETE = 0
|
|
|
- , HTTP_GET
|
|
|
- , HTTP_HEAD
|
|
|
- , HTTP_POST
|
|
|
- , HTTP_PUT
|
|
|
- /* pathological */
|
|
|
- , HTTP_CONNECT
|
|
|
- , HTTP_OPTIONS
|
|
|
- , HTTP_TRACE
|
|
|
- /* webdav */
|
|
|
- , HTTP_COPY
|
|
|
- , HTTP_LOCK
|
|
|
- , HTTP_MKCOL
|
|
|
- , HTTP_MOVE
|
|
|
- , HTTP_PROPFIND
|
|
|
- , HTTP_PROPPATCH
|
|
|
- , HTTP_UNLOCK
|
|
|
- /* subversion */
|
|
|
- , HTTP_REPORT
|
|
|
- , HTTP_MKACTIVITY
|
|
|
- , HTTP_CHECKOUT
|
|
|
- , HTTP_MERGE
|
|
|
- /* upnp */
|
|
|
- , HTTP_MSEARCH
|
|
|
- , HTTP_NOTIFY
|
|
|
- , HTTP_SUBSCRIBE
|
|
|
- , HTTP_UNSUBSCRIBE
|
|
|
+ {
|
|
|
+#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 char type : 2;
|
|
|
- unsigned char flags : 6;
|
|
|
- unsigned char state;
|
|
|
- unsigned char header_state;
|
|
|
- unsigned char index;
|
|
|
+ unsigned char type : 2; /* enum http_parser_type */
|
|
|
+ unsigned char flags : 6; /* F_* values from 'flags' enum; semi-public */
|
|
|
+ unsigned char state; /* enum state from http_parser.c */
|
|
|
+ unsigned char header_state; /* enum header_state from http_parser.c */
|
|
|
+ unsigned char index; /* index into current matcher */
|
|
|
|
|
|
- uint32_t nread;
|
|
|
- int64_t content_length;
|
|
|
+ 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 short status_code; /* responses only */
|
|
|
- unsigned char method; /* requests only */
|
|
|
+ unsigned char method; /* requests only */
|
|
|
+ unsigned char 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.
|
|
|
*/
|
|
|
- char upgrade;
|
|
|
+ unsigned char upgrade : 1;
|
|
|
|
|
|
/** PUBLIC **/
|
|
|
void *data; /* A pointer to get hook to the "connection" or "socket" object */
|
|
@@ -145,10 +221,8 @@ struct http_parser {
|
|
|
|
|
|
struct http_parser_settings {
|
|
|
http_cb on_message_begin;
|
|
|
- http_data_cb on_path;
|
|
|
- http_data_cb on_query_string;
|
|
|
http_data_cb on_url;
|
|
|
- http_data_cb on_fragment;
|
|
|
+ http_cb on_status_complete;
|
|
|
http_data_cb on_header_field;
|
|
|
http_data_cb on_header_value;
|
|
|
http_cb on_headers_complete;
|
|
@@ -157,6 +231,36 @@ struct http_parser_settings {
|
|
|
};
|
|
|
|
|
|
|
|
|
+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];
|
|
|
+};
|
|
|
+
|
|
|
+
|
|
|
void http_parser_init(http_parser *parser, enum http_parser_type type);
|
|
|
|
|
|
|
|
@@ -167,15 +271,32 @@ size_t http_parser_execute(http_parser *parser,
|
|
|
|
|
|
|
|
|
/* If http_should_keep_alive() in the on_headers_complete or
|
|
|
- * on_message_complete callback returns true, then this will be should be
|
|
|
+ * 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(http_parser *parser);
|
|
|
+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);
|
|
|
+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
|
|
|
}
|