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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
use std::convert::TryFrom;
use crate::proto::{frame, varint::VarInt};
pub(crate) const DEFAULT_QPACK_DECODE_BUFFER_SIZE: usize = 16 * 1024 * 1024;
/// Configures the HTTP/3 connection
#[derive(Debug, Clone)]
#[non_exhaustive]
pub struct Config {
/// Just like in HTTP/2, HTTP/3 also uses the concept of "grease"
/// to prevent potential interoperability issues in the future.
/// In HTTP/3, the concept of grease is used to ensure that the protocol can evolve
/// and accommodate future changes without breaking existing implementations.
pub(crate) send_grease: bool,
#[cfg(test)]
pub(crate) send_settings: bool,
/// When set, controls the exact order of settings in the SETTINGS frame.
/// Each entry in the list specifies a SettingId whose value will be resolved
/// from known settings fields or `extra_settings`. When `None`, the default
/// insertion order is used.
pub(crate) settings_order: Option<Vec<frame::SettingId>>,
/// Arbitrary (id, value) setting entries for browser-specific unknown settings
/// or controlled GREASE. These are used when `settings_order` references IDs
/// not covered by the known `Settings` fields, or appended at the end in
/// default mode.
pub(crate) extra_settings: Vec<(frame::SettingId, u64)>,
/// Maximum compressed QPACK input retained while decoding one field
/// section or encoder-stream string.
pub(crate) qpack_decode_buffer_size: usize,
/// Maximum dynamic-table capacity this endpoint's QPACK encoder may use.
///
/// This is a local memory and compression policy. The effective capacity is
/// also limited by the peer's `SETTINGS_QPACK_MAX_TABLE_CAPACITY` value.
pub(crate) qpack_encoder_table_capacity: usize,
/// HTTP/3 Settings
pub settings: Settings,
}
/// HTTP/3 Settings
#[derive(Debug, Clone, Copy)]
pub struct Settings {
/// Largest uncompressed field section this endpoint is willing to accept.
///
/// Each field contributes its name and value lengths plus 32 bytes. The
/// value is advertised as `SETTINGS_MAX_FIELD_SECTION_SIZE`. Omitting the
/// setting means unlimited; this implementation advertises the largest
/// QUIC variable-length integer by default.
///
/// See [RFC 9114 Section 4.2.2](https://www.rfc-editor.org/rfc/rfc9114.html#section-4.2.2)
/// and [Section 7.2.4.1](https://www.rfc-editor.org/rfc/rfc9114.html#section-7.2.4.1).
pub(crate) max_field_section_size: u64,
/// <https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/#section-3.1>
/// Sets `SETTINGS_ENABLE_WEBTRANSPORT` if enabled
pub(crate) enable_webtransport: bool,
/// <https://www.rfc-editor.org/info/rfc8441> defines an extended CONNECT method in Section 4,
/// enabled by the SETTINGS_ENABLE_CONNECT_PROTOCOL parameter.
/// That parameter is only defined for HTTP/2.
/// for extended CONNECT in HTTP/3; instead, the SETTINGS_ENABLE_WEBTRANSPORT setting implies
/// that an endpoint supports extended CONNECT.
pub(crate) enable_extended_connect: bool,
/// Enable HTTP Datagrams, see <https://datatracker.ietf.org/doc/rfc9297/> for details
pub(crate) enable_datagram: bool,
/// The maximum number of concurrent streams that can be opened by the peer.
pub(crate) max_webtransport_sessions: u64,
/// QPACK dynamic table capacity the encoder is permitted to use, in bytes.
/// Sent as SETTINGS_QPACK_MAX_TABLE_CAPACITY (0x1).
/// When unset, the setting is omitted and the protocol default of 0 applies.
///
/// See [RFC 9204 Section 5](https://www.rfc-editor.org/rfc/rfc9204.html#section-5).
pub(crate) qpack_max_table_capacity: Option<u64>,
/// Maximum number of blocked streams the decoder is willing to tolerate.
/// Sent as SETTINGS_QPACK_BLOCKED_STREAMS (0x7).
///
/// See [RFC 9204 Section 5](https://www.rfc-editor.org/rfc/rfc9204.html#section-5).
/// When unset, the setting is omitted and the protocol default of 0 applies.
pub(crate) qpack_blocked_streams: Option<u64>,
}
impl From<&frame::Settings> for Settings {
fn from(settings: &frame::Settings) -> Self {
let defaults: Self = Default::default();
Self {
max_field_section_size: settings
.get(frame::SettingId::MAX_HEADER_LIST_SIZE)
.unwrap_or(defaults.max_field_section_size),
enable_webtransport: settings
.get(frame::SettingId::ENABLE_WEBTRANSPORT)
.map(|value| value != 0)
.unwrap_or(defaults.enable_webtransport),
max_webtransport_sessions: settings
.get(frame::SettingId::WEBTRANSPORT_MAX_SESSIONS)
.unwrap_or(defaults.max_webtransport_sessions),
enable_datagram: settings
.get(frame::SettingId::H3_DATAGRAM)
.map(|value| value != 0)
.unwrap_or(defaults.enable_datagram),
enable_extended_connect: settings
.get(frame::SettingId::ENABLE_CONNECT_PROTOCOL)
.map(|value| value != 0)
.unwrap_or(defaults.enable_extended_connect),
qpack_max_table_capacity: settings.get(frame::SettingId::QPACK_MAX_TABLE_CAPACITY),
qpack_blocked_streams: settings.get(frame::SettingId::QPACK_MAX_BLOCKED_STREAMS),
}
}
}
impl Config {
/// Resolve the value for a given setting ID from known settings fields
/// or extra_settings.
fn resolve_setting_value(&self, id: &frame::SettingId) -> Option<u64> {
match *id {
frame::SettingId::MAX_HEADER_LIST_SIZE => Some(self.settings.max_field_section_size),
frame::SettingId::ENABLE_CONNECT_PROTOCOL => {
Some(self.settings.enable_extended_connect as u64)
}
frame::SettingId::ENABLE_WEBTRANSPORT => Some(self.settings.enable_webtransport as u64),
frame::SettingId::H3_DATAGRAM => Some(self.settings.enable_datagram as u64),
frame::SettingId::WEBTRANSPORT_MAX_SESSIONS => {
Some(self.settings.max_webtransport_sessions)
}
frame::SettingId::QPACK_MAX_TABLE_CAPACITY => self.settings.qpack_max_table_capacity,
frame::SettingId::QPACK_MAX_BLOCKED_STREAMS => self.settings.qpack_blocked_streams,
_ => self
.extra_settings
.iter()
.find(|(sid, _)| sid == id)
.map(|(_, v)| *v),
}
}
}
impl TryFrom<Config> for frame::Settings {
type Error = frame::SettingsError;
fn try_from(value: Config) -> Result<Self, Self::Error> {
let mut settings = frame::Settings::default();
if let Some(ref order) = value.settings_order {
// Impersonation mode: insert settings in the exact specified order.
for id in order {
if let Some(val) = value.resolve_setting_value(id) {
settings.insert(*id, val)?;
}
}
} else {
// Default mode: existing behavior.
settings.insert(
frame::SettingId::MAX_HEADER_LIST_SIZE,
value.settings.max_field_section_size,
)?;
settings.insert(
frame::SettingId::ENABLE_CONNECT_PROTOCOL,
value.settings.enable_extended_connect as u64,
)?;
settings.insert(
frame::SettingId::ENABLE_WEBTRANSPORT,
value.settings.enable_webtransport as u64,
)?;
settings.insert(
frame::SettingId::H3_DATAGRAM,
value.settings.enable_datagram as u64,
)?;
settings.insert(
frame::SettingId::WEBTRANSPORT_MAX_SESSIONS,
value.settings.max_webtransport_sessions,
)?;
if let Some(value) = value.settings.qpack_max_table_capacity {
settings.insert(frame::SettingId::QPACK_MAX_TABLE_CAPACITY, value)?;
}
if let Some(value) = value.settings.qpack_blocked_streams {
settings.insert(frame::SettingId::QPACK_MAX_BLOCKED_STREAMS, value)?;
}
// Append extra settings at the end in default mode
for (id, val) in &value.extra_settings {
settings.insert(*id, *val)?;
}
}
// GREASE settings are reserved by RFC 9114 Section 7.2.4.1.
// https://www.rfc-editor.org/rfc/rfc9114.html#section-7.2.4.1
//= https://www.rfc-editor.org/rfc/rfc9114#section-7.2.4.1
//# Setting identifiers of the format 0x1f * N + 0x21 for non-negative
//# integer values of N are reserved to exercise the requirement that
//# unknown identifiers be ignored. Such settings have no defined
//# meaning. Endpoints SHOULD include at least one such setting in their
//# SETTINGS frame.
//= https://www.rfc-editor.org/rfc/rfc9114#section-7.2.4.1
//# Setting identifiers that were defined in [HTTP/2] where there is no
//# corresponding HTTP/3 setting have also been reserved
//# (Section 11.2.2). These reserved settings MUST NOT be sent, and
//# their receipt MUST be treated as a connection error of type
//# H3_SETTINGS_ERROR.
// GREASE is always appended last, matching Chromium's behavior.
// The value is a random u32, matching Chromium's implementation:
// uint32_t result;
// QuicRandom::GetInstance()->RandBytes(&result, sizeof(result));
// settings.values[setting_id] = result;
if value.send_grease {
match settings.insert(frame::SettingId::grease(), fastrand::u32(..) as u64) {
Ok(_) => (),
Err(_err) => {
#[cfg(feature = "tracing")]
tracing::warn!("Error when adding the grease Setting. Reason {}", _err);
}
}
}
Ok(settings)
}
}
impl Default for Settings {
fn default() -> Self {
Self {
max_field_section_size: VarInt::MAX.0,
enable_webtransport: false,
enable_extended_connect: false,
enable_datagram: false,
max_webtransport_sessions: 0,
qpack_max_table_capacity: None,
qpack_blocked_streams: None,
}
}
}
impl Settings {
/// <https://datatracker.ietf.org/doc/html/draft-ietf-webtrans-http3/#section-3.1>
/// Sets `SETTINGS_ENABLE_WEBTRANSPORT` if enabled
pub fn enable_webtransport(&self) -> bool {
self.enable_webtransport
}
/// Enable HTTP Datagrams, see <https://datatracker.ietf.org/doc/rfc9297/> for details
pub fn enable_datagram(&self) -> bool {
self.enable_datagram
}
/// <https://www.rfc-editor.org/info/rfc8441> defines an extended CONNECT method in Section 4,
/// enabled by the SETTINGS_ENABLE_CONNECT_PROTOCOL parameter.
/// That parameter is only defined for HTTP/2.
/// for extended CONNECT in HTTP/3; instead, the SETTINGS_ENABLE_WEBTRANSPORT setting implies
/// that an endpoint supports extended CONNECT.
pub fn enable_extended_connect(&self) -> bool {
self.enable_extended_connect
}
}
impl Default for Config {
fn default() -> Self {
Self {
send_grease: true,
#[cfg(test)]
send_settings: true,
settings_order: None,
extra_settings: Vec::new(),
qpack_decode_buffer_size: DEFAULT_QPACK_DECODE_BUFFER_SIZE,
qpack_encoder_table_capacity: 0,
settings: Default::default(),
}
}
}