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 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597
use std::{
convert::TryFrom,
fmt,
iter::{IntoIterator, Iterator},
str::FromStr,
};
use http::{
header::{self, HeaderName, HeaderValue},
uri::{self, Authority, Parts, PathAndQuery, Scheme, Uri},
Extensions, HeaderMap, Method, StatusCode,
};
use crate::{ext::Protocol, qpack::HeaderField};
#[derive(Debug)]
#[cfg_attr(test, derive(PartialEq, Clone))]
pub struct Header {
pseudo: Pseudo,
fields: HeaderMap,
}
#[allow(clippy::len_without_is_empty)]
impl Header {
/// Creates a new `Header` frame data suitable for sending a request
pub fn request(
method: Method,
uri: Uri,
fields: HeaderMap,
ext: Extensions,
) -> Result<Self, HeaderError> {
match (uri.authority(), fields.get("host")) {
(None, None) => Err(HeaderError::MissingAuthority),
(Some(a), Some(h)) if a.as_str() != h => Err(HeaderError::ContradictedAuthority),
_ => Ok(Self {
pseudo: Pseudo::request(method, uri, ext),
fields,
}),
}
}
pub fn response(status: StatusCode, fields: HeaderMap) -> Self {
Self {
pseudo: Pseudo::response(status),
fields,
}
}
pub fn trailer(fields: HeaderMap) -> Self {
Self {
//= https://www.rfc-editor.org/rfc/rfc9114#section-4.3
//# Pseudo-header fields MUST NOT appear in trailer
//# sections.
pseudo: Pseudo::default(),
fields,
}
}
pub fn into_request_parts(
self,
) -> Result<(Method, Uri, Option<Protocol>, HeaderMap), HeaderError> {
let mut uri = Uri::builder();
if let Some(path) = self.pseudo.path {
uri = uri.path_and_query(path.as_str().as_bytes());
}
if let Some(scheme) = self.pseudo.scheme {
uri = uri.scheme(scheme.as_str().as_bytes());
}
//= https://www.rfc-editor.org/rfc/rfc9114#section-4.3.1
//# If the :scheme pseudo-header field identifies a scheme that has a
//# mandatory authority component (including "http" and "https"), the
//# request MUST contain either an :authority pseudo-header field or a
//# Host header field.
//= https://www.rfc-editor.org/rfc/rfc9114#section-4.3.1
//= type=TODO
//# If these fields are present, they MUST NOT be
//# empty.
//= https://www.rfc-editor.org/rfc/rfc9114#section-4.3.1
//= type=TODO
//# If the scheme does not have a mandatory authority component and none
//# is provided in the request target, the request MUST NOT contain the
//# :authority pseudo-header or Host header fields.
match (self.pseudo.authority, self.fields.get("host")) {
(None, None) => return Err(HeaderError::MissingAuthority),
(Some(a), None) => uri = uri.authority(a.as_str().as_bytes()),
(None, Some(h)) => uri = uri.authority(h.as_bytes()),
//= https://www.rfc-editor.org/rfc/rfc9114#section-4.3.1
//# If both fields are present, they MUST contain the same value.
(Some(a), Some(h)) if a.as_str() != h => {
return Err(HeaderError::ContradictedAuthority)
}
(Some(_), Some(h)) => uri = uri.authority(h.as_bytes()),
}
Ok((
self.pseudo.method.ok_or(HeaderError::MissingMethod)?,
uri.build().map_err(HeaderError::InvalidRequest)?,
self.pseudo.protocol,
self.fields,
))
}
pub fn into_response_parts(self) -> Result<(StatusCode, HeaderMap), HeaderError> {
//= https://www.rfc-editor.org/rfc/rfc9114#section-4.3.2
//= type=implication
//# For responses, a single ":status" pseudo-header field is defined that
//# carries the HTTP status code; see Section 15 of [HTTP]. This pseudo-
//# header field MUST be included in all responses; otherwise, the
//# response is malformed (see Section 4.1.2).
Ok((
self.pseudo.status.ok_or(HeaderError::MissingStatus)?,
self.fields,
))
}
pub fn into_fields(self) -> HeaderMap {
self.fields
}
pub fn len(&self) -> usize {
self.pseudo.len() + self.fields.len()
}
pub fn size(&self) -> usize {
self.pseudo.len() + self.fields.len()
}
#[cfg(test)]
pub(crate) fn authory_mut(&mut self) -> &mut Option<Authority> {
&mut self.pseudo.authority
}
}
impl IntoIterator for Header {
type Item = HeaderField;
type IntoIter = HeaderIter;
fn into_iter(self) -> Self::IntoIter {
HeaderIter {
pseudo: Some(self.pseudo),
last_header_name: None,
fields: self.fields.into_iter(),
}
}
}
pub struct HeaderIter {
pseudo: Option<Pseudo>,
last_header_name: Option<HeaderName>,
fields: header::IntoIter<HeaderValue>,
}
impl Iterator for HeaderIter {
type Item = HeaderField;
fn next(&mut self) -> Option<Self::Item> {
//= https://www.rfc-editor.org/rfc/rfc9114#section-4.3
//# All pseudo-header fields MUST appear in the header section before
//# regular header fields.
if let Some(ref mut pseudo) = self.pseudo {
if let Some(method) = pseudo.method.take() {
return Some((":method", method.as_str()).into());
}
if let Some(scheme) = pseudo.scheme.take() {
return Some((":scheme", scheme.as_str().as_bytes()).into());
}
if let Some(authority) = pseudo.authority.take() {
return Some((":authority", authority.as_str().as_bytes()).into());
}
if let Some(path) = pseudo.path.take() {
return Some((":path", path.as_str().as_bytes()).into());
}
if let Some(status) = pseudo.status.take() {
return Some((":status", status.as_str()).into());
}
if let Some(protocol) = pseudo.protocol.take() {
return Some((":protocol", protocol.as_str().as_bytes()).into());
}
}
self.pseudo = None;
for (new_header_name, header_value) in self.fields.by_ref() {
if let Some(new) = new_header_name {
self.last_header_name = Some(new);
}
if let (Some(ref n), v) = (&self.last_header_name, header_value) {
return Some((n.as_str(), v.as_bytes()).into());
}
}
None
}
}
impl TryFrom<Vec<HeaderField>> for Header {
type Error = HeaderError;
fn try_from(headers: Vec<HeaderField>) -> Result<Self, Self::Error> {
let mut fields = HeaderMap::with_capacity(headers.len());
let mut pseudo = Pseudo::default();
for field in headers.into_iter() {
let (name, value) = field.into_inner();
match Field::parse(name, value)? {
Field::Method(m) => {
pseudo.method = Some(m);
pseudo.len += 1;
}
Field::Scheme(s) => {
pseudo.scheme = Some(s);
pseudo.len += 1;
}
Field::Authority(a) => {
pseudo.authority = Some(a);
pseudo.len += 1;
}
Field::Path(p) => {
pseudo.path = Some(p);
pseudo.len += 1;
}
Field::Status(s) => {
pseudo.status = Some(s);
pseudo.len += 1;
}
Field::Header((n, v)) => {
fields.append(n, v);
}
Field::Protocol(p) => {
pseudo.protocol = Some(p);
pseudo.len += 1;
}
}
}
Ok(Header { pseudo, fields })
}
}
enum Field {
Method(Method),
Scheme(Scheme),
Authority(Authority),
Path(PathAndQuery),
Status(StatusCode),
Protocol(Protocol),
Header((HeaderName, HeaderValue)),
}
impl Field {
fn parse<N, V>(name: N, value: V) -> Result<Self, HeaderError>
where
N: AsRef<[u8]>,
V: AsRef<[u8]>,
{
let name = name.as_ref();
if name.is_empty() {
return Err(HeaderError::InvalidHeaderName("name is empty".into()));
}
//= https://www.rfc-editor.org/rfc/rfc9114#section-10.3
//# Requests or responses containing invalid field names MUST be treated
//# as malformed.
//= https://www.rfc-editor.org/rfc/rfc9114#section-10.3
//# Any request or response that contains a
//# character not permitted in a field value MUST be treated as
//# malformed.
if name[0] != b':' {
return Ok(Field::Header((
HeaderName::from_bytes(name).map_err(|_| HeaderError::invalid_name(name))?,
HeaderValue::from_bytes(value.as_ref())
.map_err(|_| HeaderError::invalid_value(name, value))?,
)));
}
Ok(match name {
b":scheme" => Field::Scheme(try_value(name, value)?),
b":authority" => Field::Authority(try_value(name, value)?),
b":path" => Field::Path(try_value(name, value)?),
b":method" => Field::Method(
Method::from_bytes(value.as_ref())
.map_err(|_| HeaderError::invalid_value(name, value))?,
),
b":status" => Field::Status(
StatusCode::from_bytes(value.as_ref())
.map_err(|_| HeaderError::invalid_value(name, value))?,
),
b":protocol" => Field::Protocol(try_value(name, value)?),
_ => return Err(HeaderError::invalid_name(name)),
})
}
}
fn try_value<N, V, R>(name: N, value: V) -> Result<R, HeaderError>
where
N: AsRef<[u8]>,
V: AsRef<[u8]>,
R: FromStr,
{
let (name, value) = (name.as_ref(), value.as_ref());
let s = std::str::from_utf8(value).map_err(|_| HeaderError::invalid_value(name, value))?;
R::from_str(s).map_err(|_| HeaderError::invalid_value(name, value))
}
/// Pseudo-header fields have the same purpose as data from the first line of HTTP/1.X,
/// but are conveyed along with other headers. For example ':method' and ':path' in a
/// request, and ':status' in a response. They must be placed before all other fields,
/// start with ':', and be lowercase.
/// See RFC7540 section 8.1.2.1. for more details.
#[derive(Debug, Default)]
#[cfg_attr(test, derive(PartialEq, Clone))]
struct Pseudo {
//= https://www.rfc-editor.org/rfc/rfc9114#section-4.3
//= type=implication
//# Endpoints MUST NOT
//# generate pseudo-header fields other than those defined in this
//# document.
// Request
method: Option<Method>,
scheme: Option<Scheme>,
authority: Option<Authority>,
path: Option<PathAndQuery>,
// Response
status: Option<StatusCode>,
protocol: Option<Protocol>,
len: usize,
}
#[allow(clippy::len_without_is_empty)]
impl Pseudo {
fn request(method: Method, uri: Uri, ext: Extensions) -> Self {
let Parts {
scheme,
authority,
path_and_query,
..
} = uri::Parts::from(uri);
//= https://www.rfc-editor.org/rfc/rfc9114#section-4.3.1
//= type=implication
//# This pseudo-header field MUST NOT be empty for "http" or "https"
//# URIs; "http" or "https" URIs that do not contain a path component
//# MUST include a value of / (ASCII 0x2f).
let path = path_and_query.map_or_else(
|| PathAndQuery::from_static("/"),
|path| {
if path.path().is_empty() && method != Method::OPTIONS {
PathAndQuery::from_static("/")
} else {
path
}
},
);
// If the method is connect, the `:protocol` pseudo-header MAY be defined
//
// See: [https://www.rfc-editor.org/rfc/rfc8441#section-4]
let protocol = if method == Method::CONNECT {
ext.get::<Protocol>().copied()
} else {
None
};
let len = 3 + authority.is_some() as usize + protocol.is_some() as usize;
//= https://www.rfc-editor.org/rfc/rfc9114#section-4.3
//= type=implication
//# Pseudo-header fields defined for requests MUST NOT appear
//# in responses; pseudo-header fields defined for responses MUST NOT
//# appear in requests.
//= https://www.rfc-editor.org/rfc/rfc9114#section-4.3.1
//= type=implication
//# All HTTP/3 requests MUST include exactly one value for the :method,
//# :scheme, and :path pseudo-header fields, unless the request is a
//# CONNECT request; see Section 4.4.
Self {
method: Some(method),
scheme: scheme.or(Some(Scheme::HTTPS)),
authority,
path: Some(path),
status: None,
protocol,
len,
}
}
fn response(status: StatusCode) -> Self {
//= https://www.rfc-editor.org/rfc/rfc9114#section-4.3
//= type=implication
//# Pseudo-header fields defined for requests MUST NOT appear
//# in responses; pseudo-header fields defined for responses MUST NOT
//# appear in requests.
Pseudo {
method: None,
scheme: None,
authority: None,
path: None,
status: Some(status),
len: 1,
protocol: None,
}
}
fn len(&self) -> usize {
self.len
}
}
#[derive(Debug)]
pub enum HeaderError {
InvalidHeaderName(String),
InvalidHeaderValue(String),
InvalidRequest(http::Error),
MissingMethod,
MissingStatus,
MissingAuthority,
ContradictedAuthority,
}
impl HeaderError {
fn invalid_name<N>(name: N) -> Self
where
N: AsRef<[u8]>,
{
HeaderError::InvalidHeaderName(format!("{:?}", name.as_ref()))
}
fn invalid_value<N, V>(name: N, value: V) -> Self
where
N: AsRef<[u8]>,
V: AsRef<[u8]>,
{
HeaderError::InvalidHeaderValue(format!(
"{:?} {:?}",
String::from_utf8_lossy(name.as_ref()),
value.as_ref()
))
}
}
impl std::error::Error for HeaderError {}
impl fmt::Display for HeaderError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
HeaderError::InvalidHeaderName(h) => write!(f, "invalid header name: {}", h),
HeaderError::InvalidHeaderValue(v) => write!(f, "invalid header value: {}", v),
HeaderError::InvalidRequest(r) => write!(f, "invalid request: {}", r),
HeaderError::MissingMethod => write!(f, "missing method in request headers"),
HeaderError::MissingStatus => write!(f, "missing status in response headers"),
HeaderError::MissingAuthority => write!(f, "missing authority"),
HeaderError::ContradictedAuthority => {
write!(f, "uri and authority field are in contradiction")
}
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use assert_matches::assert_matches;
#[test]
fn request_has_no_authority_nor_host() {
//= https://www.rfc-editor.org/rfc/rfc9114#section-4.3.1
//= type=test
//# If the :scheme pseudo-header field identifies a scheme that has a
//# mandatory authority component (including "http" and "https"), the
//# request MUST contain either an :authority pseudo-header field or a
//# Host header field.
let headers = Header::try_from(vec![(b":method", Method::GET.as_str()).into()]).unwrap();
assert!(headers.pseudo.authority.is_none());
assert_matches!(
headers.into_request_parts(),
Err(HeaderError::MissingAuthority)
);
}
#[test]
fn request_has_authority() {
//= https://www.rfc-editor.org/rfc/rfc9114#section-4.3.1
//= type=test
//# If the :scheme pseudo-header field identifies a scheme that has a
//# mandatory authority component (including "http" and "https"), the
//# request MUST contain either an :authority pseudo-header field or a
//# Host header field.
let headers = Header::try_from(vec![
(b":method", Method::GET.as_str()).into(),
(b":authority", b"test.com").into(),
])
.unwrap();
assert_matches!(headers.into_request_parts(), Ok(_));
}
#[test]
fn request_has_host() {
//= https://www.rfc-editor.org/rfc/rfc9114#section-4.3.1
//= type=test
//# If the :scheme pseudo-header field identifies a scheme that has a
//# mandatory authority component (including "http" and "https"), the
//# request MUST contain either an :authority pseudo-header field or a
//# Host header field.
let headers = Header::try_from(vec![
(b":method", Method::GET.as_str()).into(),
(b"host", b"test.com").into(),
])
.unwrap();
assert!(headers.pseudo.authority.is_none());
assert_matches!(headers.into_request_parts(), Ok(_));
}
#[test]
fn request_has_same_host_and_authority() {
//= https://www.rfc-editor.org/rfc/rfc9114#section-4.3.1
//= type=test
//# If both fields are present, they MUST contain the same value.
let headers = Header::try_from(vec![
(b":method", Method::GET.as_str()).into(),
(b":authority", b"test.com").into(),
(b"host", b"test.com").into(),
])
.unwrap();
assert_matches!(headers.into_request_parts(), Ok(_));
}
#[test]
fn request_has_different_host_and_authority() {
//= https://www.rfc-editor.org/rfc/rfc9114#section-4.3.1
//= type=test
//# If both fields are present, they MUST contain the same value.
let headers = Header::try_from(vec![
(b":method", Method::GET.as_str()).into(),
(b":authority", b"authority.com").into(),
(b"host", b"host.com").into(),
])
.unwrap();
assert_matches!(
headers.into_request_parts(),
Err(HeaderError::ContradictedAuthority)
);
}
#[test]
fn preserves_duplicate_headers() {
let headers = Header::try_from(vec![
(b":method", Method::GET.as_str()).into(),
(b":authority", b"test.com").into(),
(b"set-cookie", b"foo=foo").into(),
(b"set-cookie", b"bar=bar").into(),
(b"other-header", b"other-header-value").into(),
])
.unwrap();
assert_eq!(
headers
.clone()
.into_iter()
.filter(|h| h.name.as_ref() == b"set-cookie")
.collect::<Vec<_>>(),
vec![
HeaderField {
name: std::borrow::Cow::Borrowed(b"set-cookie"),
value: std::borrow::Cow::Borrowed(b"foo=foo")
},
HeaderField {
name: std::borrow::Cow::Borrowed(b"set-cookie"),
value: std::borrow::Cow::Borrowed(b"bar=bar")
}
]
);
assert_eq!(
headers
.into_iter()
.filter(|h| h.name.as_ref() == b"other-header")
.collect::<Vec<_>>(),
vec![HeaderField {
name: std::borrow::Cow::Borrowed(b"other-header"),
value: std::borrow::Cow::Borrowed(b"other-header-value")
},]
);
}
}