blob: 507a291b081206da85a1a925943cf4cea1640fcb [file] [log] [blame]
Willy Tarreauffca7362016-12-13 18:25:15 +01001/*
2 * include/common/h2.h
3 * This file contains types and macros used for the HTTP/2 protocol
4 *
5 * Copyright (C) 2000-2017 Willy Tarreau - w@1wt.eu
6 * Copyright (C) 2017 HAProxy Technologies
7 *
Willy Tarreauf24ea8e2017-11-21 19:55:27 +01008 * Permission is hereby granted, free of charge, to any person obtaining
9 * a copy of this software and associated documentation files (the
10 * "Software"), to deal in the Software without restriction, including
11 * without limitation the rights to use, copy, modify, merge, publish,
12 * distribute, sublicense, and/or sell copies of the Software, and to
13 * permit persons to whom the Software is furnished to do so, subject to
14 * the following conditions:
Willy Tarreauffca7362016-12-13 18:25:15 +010015 *
Willy Tarreauf24ea8e2017-11-21 19:55:27 +010016 * The above copyright notice and this permission notice shall be
17 * included in all copies or substantial portions of the Software.
Willy Tarreauffca7362016-12-13 18:25:15 +010018 *
Willy Tarreauf24ea8e2017-11-21 19:55:27 +010019 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
20 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
21 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
22 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
23 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
24 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
25 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
26 * OTHER DEALINGS IN THE SOFTWARE.
Willy Tarreauffca7362016-12-13 18:25:15 +010027 */
28
29#ifndef _COMMON_H2_H
30#define _COMMON_H2_H
31
32#include <common/config.h>
Willy Tarreauf24ea8e2017-11-21 19:55:27 +010033#include <common/http-hdr.h>
Willy Tarreaub96b77e2018-12-11 10:22:41 +010034#include <common/htx.h>
Willy Tarreauf24ea8e2017-11-21 19:55:27 +010035#include <common/ist.h>
Willy Tarreauffca7362016-12-13 18:25:15 +010036
37
Willy Tarreauf24ea8e2017-11-21 19:55:27 +010038/* indexes of most important pseudo headers can be simplified to an almost
39 * linear array by dividing the index by 2 for all values from 1 to 9, and
40 * caping to 4 for values up to 14 ; thus it fits in a single 24-bit array
41 * shifted by 3 times the index value/2, or a 32-bit array shifted by 4x.
42 * Don't change these values, they are assumed by hpack_idx_to_phdr(). There
43 * is an entry for the Host header field which is not a pseudo-header but
44 * needs to be tracked as we should only use :authority if it's absent.
45 */
46enum {
47 H2_PHDR_IDX_NONE = 0,
48 H2_PHDR_IDX_AUTH = 1, /* :authority = 1 */
49 H2_PHDR_IDX_METH = 2, /* :method = 2..3 */
50 H2_PHDR_IDX_PATH = 3, /* :path = 4..5 */
51 H2_PHDR_IDX_SCHM = 4, /* :scheme = 6..7 */
52 H2_PHDR_IDX_STAT = 5, /* :status = 8..14 */
53 H2_PHDR_IDX_HOST = 6, /* Host, never returned, just a place-holder */
54 H2_PHDR_NUM_ENTRIES /* must be last */
55};
56
57/* bit fields indicating the pseudo-headers found. It also covers the HOST
58 * header field as well as any non-pseudo-header field (NONE).
59 */
60enum {
61 H2_PHDR_FND_NONE = 1 << H2_PHDR_IDX_NONE, /* found a regular header */
62 H2_PHDR_FND_AUTH = 1 << H2_PHDR_IDX_AUTH,
63 H2_PHDR_FND_METH = 1 << H2_PHDR_IDX_METH,
64 H2_PHDR_FND_PATH = 1 << H2_PHDR_IDX_PATH,
65 H2_PHDR_FND_SCHM = 1 << H2_PHDR_IDX_SCHM,
66 H2_PHDR_FND_STAT = 1 << H2_PHDR_IDX_STAT,
67 H2_PHDR_FND_HOST = 1 << H2_PHDR_IDX_HOST,
68};
69
Willy Tarreauffca7362016-12-13 18:25:15 +010070/* frame types, from the standard */
71enum h2_ft {
72 H2_FT_DATA = 0x00, // RFC7540 #6.1
73 H2_FT_HEADERS = 0x01, // RFC7540 #6.2
74 H2_FT_PRIORITY = 0x02, // RFC7540 #6.3
75 H2_FT_RST_STREAM = 0x03, // RFC7540 #6.4
76 H2_FT_SETTINGS = 0x04, // RFC7540 #6.5
77 H2_FT_PUSH_PROMISE = 0x05, // RFC7540 #6.6
78 H2_FT_PING = 0x06, // RFC7540 #6.7
79 H2_FT_GOAWAY = 0x07, // RFC7540 #6.8
80 H2_FT_WINDOW_UPDATE = 0x08, // RFC7540 #6.9
81 H2_FT_CONTINUATION = 0x09, // RFC7540 #6.10
82 H2_FT_ENTRIES /* must be last */
83} __attribute__((packed));
84
Willy Tarreaudeab2442018-12-21 14:56:57 +010085/* frame types, turned to bits or bit fields */
86enum {
87 /* one bit per frame type */
88 H2_FT_DATA_BIT = 1U << H2_FT_DATA,
89 H2_FT_HEADERS_BIT = 1U << H2_FT_HEADERS,
90 H2_FT_PRIORITY_BIT = 1U << H2_FT_PRIORITY,
91 H2_FT_RST_STREAM_BIT = 1U << H2_FT_RST_STREAM,
92 H2_FT_SETTINGS_BIT = 1U << H2_FT_SETTINGS,
93 H2_FT_PUSH_PROMISE_BIT = 1U << H2_FT_PUSH_PROMISE,
94 H2_FT_PING_BIT = 1U << H2_FT_PING,
95 H2_FT_GOAWAY_BIT = 1U << H2_FT_GOAWAY,
96 H2_FT_WINDOW_UPDATE_BIT = 1U << H2_FT_WINDOW_UPDATE,
97 H2_FT_CONTINUATION_BIT = 1U << H2_FT_CONTINUATION,
98 /* padded frames */
99 H2_FT_PADDED_MASK = (1U << H2_FT_DATA) | (1U << H2_FT_HEADERS) | (1U << H2_FT_PUSH_PROMISE),
100 /* flow controlled frames */
101 H2_FT_FC_MASK = (1U << H2_FT_DATA),
102};
103
104
Willy Tarreauffca7362016-12-13 18:25:15 +0100105/* flags defined for each frame type */
106
107// RFC7540 #6.1
108#define H2_F_DATA_END_STREAM 0x01
109#define H2_F_DATA_PADDED 0x08
110
111// RFC7540 #6.2
112#define H2_F_HEADERS_END_STREAM 0x01
113#define H2_F_HEADERS_END_HEADERS 0x04
114#define H2_F_HEADERS_PADDED 0x08
115#define H2_F_HEADERS_PRIORITY 0x20
116
117// RFC7540 #6.3 : PRIORITY defines no flags
118// RFC7540 #6.4 : RST_STREAM defines no flags
119
120// RFC7540 #6.5
121#define H2_F_SETTINGS_ACK 0x01
122
123// RFC7540 #6.6
124#define H2_F_PUSH_PROMISE_END_HEADERS 0x04
125#define H2_F_PUSH_PROMISE_PADDED 0x08
126
127// RFC7540 #6.7
128#define H2_F_PING_ACK 0x01
129
130// RFC7540 #6.8 : GOAWAY defines no flags
131// RFC7540 #6.9 : WINDOW_UPDATE defines no flags
132
Willy Tarreaudeab2442018-12-21 14:56:57 +0100133// PADDED is the exact same among DATA, HEADERS and PUSH_PROMISE (8)
134#define H2_F_PADDED 0x08
135
Willy Tarreauffca7362016-12-13 18:25:15 +0100136/* HTTP/2 error codes - RFC7540 #7 */
137enum h2_err {
138 H2_ERR_NO_ERROR = 0x0,
139 H2_ERR_PROTOCOL_ERROR = 0x1,
140 H2_ERR_INTERNAL_ERROR = 0x2,
141 H2_ERR_FLOW_CONTROL_ERROR = 0x3,
142 H2_ERR_SETTINGS_TIMEOUT = 0x4,
143 H2_ERR_STREAM_CLOSED = 0x5,
144 H2_ERR_FRAME_SIZE_ERROR = 0x6,
145 H2_ERR_REFUSED_STREAM = 0x7,
146 H2_ERR_CANCEL = 0x8,
147 H2_ERR_COMPRESSION_ERROR = 0x9,
148 H2_ERR_CONNECT_ERROR = 0xa,
149 H2_ERR_ENHANCE_YOUR_CALM = 0xb,
150 H2_ERR_INADEQUATE_SECURITY = 0xc,
151 H2_ERR_HTTP_1_1_REQUIRED = 0xd,
152} __attribute__((packed));
153
154// RFC7540 #11.3 : Settings Registry
155#define H2_SETTINGS_HEADER_TABLE_SIZE 0x0001
156#define H2_SETTINGS_ENABLE_PUSH 0x0002
157#define H2_SETTINGS_MAX_CONCURRENT_STREAMS 0x0003
158#define H2_SETTINGS_INITIAL_WINDOW_SIZE 0x0004
159#define H2_SETTINGS_MAX_FRAME_SIZE 0x0005
160#define H2_SETTINGS_MAX_HEADER_LIST_SIZE 0x0006
161
162
163/* some protocol constants */
164
165// PRI * HTTP/2.0\r\n\r\nSM\r\n\r\n
166#define H2_CONN_PREFACE \
167 "\x50\x52\x49\x20\x2a\x20\x48\x54" \
168 "\x54\x50\x2f\x32\x2e\x30\x0d\x0a" \
169 "\x0d\x0a\x53\x4d\x0d\x0a\x0d\x0a"
170
Willy Tarreauf24ea8e2017-11-21 19:55:27 +0100171
Willy Tarreau174b06a2018-04-25 18:13:58 +0200172/* some flags related to protocol parsing */
173#define H2_MSGF_BODY 0x0001 // a body is present
174#define H2_MSGF_BODY_CL 0x0002 // content-length is present
175#define H2_MSGF_BODY_TUNNEL 0x0004 // a tunnel is in use (CONNECT)
176
177
Willy Tarreauf24ea8e2017-11-21 19:55:27 +0100178/* various protocol processing functions */
179
Willy Tarreau174b06a2018-04-25 18:13:58 +0200180int h2_make_h1_request(struct http_hdr *list, char *out, int osize, unsigned int *msgf);
Willy Tarreau9d953e72019-01-03 16:18:14 +0100181int h2_make_h1_trailers(struct http_hdr *list, char *out, int osize);
Willy Tarreaubeefaee2018-12-19 13:08:08 +0100182int h2_parse_cont_len_header(unsigned int *msgf, struct ist *value, unsigned long long *body_len);
Willy Tarreau6deb4122018-11-27 15:34:18 +0100183int h2_make_htx_request(struct http_hdr *list, struct htx *htx, unsigned int *msgf);
Willy Tarreau1329b5b2018-10-08 14:49:20 +0200184int h2_make_htx_response(struct http_hdr *list, struct htx *htx, unsigned int *msgf);
Willy Tarreau1e1f27c2019-01-03 18:39:54 +0100185int h2_make_htx_trailers(struct http_hdr *list, struct htx *htx);
Willy Tarreauf24ea8e2017-11-21 19:55:27 +0100186
Willy Tarreauffca7362016-12-13 18:25:15 +0100187/*
188 * Some helpful debugging functions.
189 */
190
Willy Tarreaudeab2442018-12-21 14:56:57 +0100191/* returns a bit corresponding to the frame type */
192static inline unsigned int h2_ft_bit(enum h2_ft ft)
193{
194 return 1U << ft;
195}
196
Willy Tarreauffca7362016-12-13 18:25:15 +0100197/* returns the frame type as a string */
198static inline const char *h2_ft_str(int type)
199{
200 switch (type) {
201 case H2_FT_DATA : return "DATA";
202 case H2_FT_HEADERS : return "HEADERS";
203 case H2_FT_PRIORITY : return "PRIORITY";
204 case H2_FT_RST_STREAM : return "RST_STREAM";
205 case H2_FT_SETTINGS : return "SETTINGS";
206 case H2_FT_PUSH_PROMISE : return "PUSH_PROMISE";
207 case H2_FT_PING : return "PING";
208 case H2_FT_GOAWAY : return "GOAWAY";
209 case H2_FT_WINDOW_UPDATE : return "WINDOW_UPDATE";
210 default : return "_UNKNOWN_";
211 }
212}
213
Willy Tarreauf24ea8e2017-11-21 19:55:27 +0100214/* returns the pseudo-header <str> corresponds to among H2_PHDR_IDX_*, 0 if not a
215 * pseudo-header, or -1 if not a valid pseudo-header.
216 */
217static inline int h2_str_to_phdr(const struct ist str)
218{
219 if (*str.ptr == ':') {
220 if (isteq(str, ist(":path"))) return H2_PHDR_IDX_PATH;
221 else if (isteq(str, ist(":method"))) return H2_PHDR_IDX_METH;
222 else if (isteq(str, ist(":scheme"))) return H2_PHDR_IDX_SCHM;
223 else if (isteq(str, ist(":status"))) return H2_PHDR_IDX_STAT;
224 else if (isteq(str, ist(":authority"))) return H2_PHDR_IDX_AUTH;
225
226 /* all other names starting with ':' */
227 return -1;
228 }
229
230 /* not a pseudo header */
231 return 0;
232}
233
Willy Tarreau30832762017-12-30 14:39:09 +0100234/* returns the pseudo-header name <num> as a string, or ":UNKNOWN" if unknown */
235static inline const char *h2_phdr_to_str(int phdr)
236{
237 switch (phdr) {
238 case H2_PHDR_IDX_NONE: return ":NONE";
239 case H2_PHDR_IDX_AUTH: return ":authority";
240 case H2_PHDR_IDX_METH: return ":method";
241 case H2_PHDR_IDX_PATH: return ":path";
242 case H2_PHDR_IDX_SCHM: return ":scheme";
243 case H2_PHDR_IDX_STAT: return ":status";
244 case H2_PHDR_IDX_HOST: return "Host";
245 default: return ":UNKNOWN";
246 }
247}
Willy Tarreauf24ea8e2017-11-21 19:55:27 +0100248
Willy Tarreauffca7362016-12-13 18:25:15 +0100249#endif /* _COMMON_H2_H */
250
251/*
252 * Local variables:
253 * c-indent-level: 8
254 * c-basic-offset: 8
255 * End:
256 */