1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
/*
* nghttp3
*
* Copyright (c) 2019 nghttp3 contributors
* Copyright (c) 2015 nghttp2 contributors
*
* 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 NGHTTP3_HTTP_H
#define NGHTTP3_HTTP_H
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif /* HAVE_CONFIG_H */
#include <nghttp3/nghttp3.h>
typedef struct nghttp3_stream nghttp3_stream;
typedef struct nghttp3_http_state nghttp3_http_state;
/* HTTP related flags to enforce HTTP semantics */
/* NGHTTP3_HTTP_FLAG_NONE indicates that no flag is set. */
#define NGHTTP3_HTTP_FLAG_NONE 0x00u
/* header field seen so far */
#define NGHTTP3_HTTP_FLAG__AUTHORITY 0x01u
#define NGHTTP3_HTTP_FLAG__PATH 0x02u
#define NGHTTP3_HTTP_FLAG__METHOD 0x04u
#define NGHTTP3_HTTP_FLAG__SCHEME 0x08u
/* host is not pseudo header, but we require either host or
:authority */
#define NGHTTP3_HTTP_FLAG_HOST 0x10u
#define NGHTTP3_HTTP_FLAG__STATUS 0x20u
/* required header fields for HTTP request except for CONNECT
method. */
#define NGHTTP3_HTTP_FLAG_REQ_HEADERS \
(NGHTTP3_HTTP_FLAG__METHOD | NGHTTP3_HTTP_FLAG__PATH | \
NGHTTP3_HTTP_FLAG__SCHEME)
#define NGHTTP3_HTTP_FLAG_PSEUDO_HEADER_DISALLOWED 0x40u
/* HTTP method flags */
#define NGHTTP3_HTTP_FLAG_METH_CONNECT 0x80u
#define NGHTTP3_HTTP_FLAG_METH_HEAD 0x0100u
#define NGHTTP3_HTTP_FLAG_METH_OPTIONS 0x0200u
#define NGHTTP3_HTTP_FLAG_METH_ALL \
(NGHTTP3_HTTP_FLAG_METH_CONNECT | NGHTTP3_HTTP_FLAG_METH_HEAD | \
NGHTTP3_HTTP_FLAG_METH_OPTIONS)
/* :path category */
/* path starts with "/" */
#define NGHTTP3_HTTP_FLAG_PATH_REGULAR 0x0400u
/* path "*" */
#define NGHTTP3_HTTP_FLAG_PATH_ASTERISK 0x0800u
/* scheme */
/* "http" or "https" scheme */
#define NGHTTP3_HTTP_FLAG_SCHEME_HTTP 0x1000u
/* set if final response is expected */
#define NGHTTP3_HTTP_FLAG_EXPECT_FINAL_RESPONSE 0x2000u
/* NGHTTP3_HTTP_FLAG__PROTOCOL is set when :protocol pseudo header
field is seen. */
#define NGHTTP3_HTTP_FLAG__PROTOCOL 0x4000u
/* NGHTTP3_HTTP_FLAG_PRIORITY is set when priority header field is
processed. */
#define NGHTTP3_HTTP_FLAG_PRIORITY 0x8000u
/* NGHTTP3_HTTP_FLAG_BAD_PRIORITY is set when an error is encountered
while parsing priority header field. */
#define NGHTTP3_HTTP_FLAG_BAD_PRIORITY 0x010000u
/*
* This function is called when HTTP header field |nv| received for
* |http|. This function will validate |nv| against the current state
* of stream. Pass nonzero if this is request headers. Pass nonzero
* to |trailers| if |nv| is included in trailers. |connect_protocol|
* is nonzero if Extended CONNECT Method is enabled.
*
* This function returns 0 if it succeeds, or one of the following
* negative error codes:
*
* NGHTTP3_ERR_MALFORMED_HTTP_HEADER
* Invalid HTTP header field was received.
* NGHTTP3_ERR_REMOVE_HTTP_HEADER
* Invalid HTTP header field was received but it can be treated as
* if it was not received because of compatibility reasons.
*/
int nghttp3_http_on_header(nghttp3_http_state *http, nghttp3_qpack_nv *nv,
int request, int trailers, int connect_protocol);
/*
* This function is called when request header is received. This
* function performs validation and returns 0 if it succeeds, or one
* of the following negative error codes:
*
* NGHTTP3_ERR_MALFORMED_HTTP_HEADER
* Required HTTP header field was not received; or an invalid
* header field was received.
*/
int nghttp3_http_on_request_headers(nghttp3_http_state *http);
/*
* This function is called when response header is received. This
* function performs validation and returns 0 if it succeeds, or one
* of the following negative error codes:
*
* NGHTTP3_ERR_MALFORMED_HTTP_HEADER
* Required HTTP header field was not received; or an invalid
* header field was received.
*/
int nghttp3_http_on_response_headers(nghttp3_http_state *http);
/*
* This function is called when read side stream is closed. This
* function performs validation and returns 0 if it succeeds, or one
* of the following negative error codes:
*
* NGHTTP3_ERR_MALFORMED_HTTP_MESSAGING
* HTTP messaging is violated.
*/
int nghttp3_http_on_remote_end_stream(nghttp3_stream *stream);
/*
* This function is called when chunk of data is received. This
* function performs validation and returns 0 if it succeeds, or one
* of the following negative error codes:
*
* NGHTTP3_ERR_MALFORMED_HTTP_MESSAGING
* HTTP messaging is violated.
*/
int nghttp3_http_on_data_chunk(nghttp3_stream *stream, size_t n);
/*
* This function inspects header fields in |nva| of length |nvlen| and
* records its method in stream->http_flags.
*/
void nghttp3_http_record_request_method(nghttp3_stream *stream,
const nghttp3_nv *nva, size_t nvlen);
/*
* RFC 8941 Structured Field Values.
*/
typedef enum nghttp3_sf_value_type {
NGHTTP3_SF_VALUE_TYPE_BOOLEAN,
NGHTTP3_SF_VALUE_TYPE_INTEGER,
NGHTTP3_SF_VALUE_TYPE_DECIMAL,
NGHTTP3_SF_VALUE_TYPE_STRING,
NGHTTP3_SF_VALUE_TYPE_TOKEN,
NGHTTP3_SF_VALUE_TYPE_BYTESEQ,
NGHTTP3_SF_VALUE_TYPE_INNER_LIST,
} nghttp3_sf_value_type;
/*
* nghttp3_sf_value stores Structured Field Values item. For Inner
* List, only type is set to NGHTTP3_SF_VALUE_TYPE_INNER_LIST.
*/
typedef struct nghttp3_sf_value {
uint8_t type;
union {
int b;
int64_t i;
double d;
struct {
const uint8_t *base;
size_t len;
} s;
};
} nghttp3_sf_value;
/*
* nghttp3_sf_parse_item parses the input sequence [|begin|, |end|)
* and stores the parsed an Item in |dest|. It returns the number of
* bytes consumed if it succeeds, or -1. This function is declared
* here for unit tests.
*/
nghttp3_ssize nghttp3_sf_parse_item(nghttp3_sf_value *dest,
const uint8_t *begin, const uint8_t *end);
/*
* nghttp3_sf_parse_inner_list parses the input sequence [|begin|, |end|)
* and stores the parsed an Inner List in |dest|. It returns the number of
* bytes consumed if it succeeds, or -1. This function is declared
* here for unit tests.
*/
nghttp3_ssize nghttp3_sf_parse_inner_list(nghttp3_sf_value *dest,
const uint8_t *begin,
const uint8_t *end);
#endif /* NGHTTP3_HTTP_H */
|
