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
//! HTTP/3 Error types
use std::{fmt, sync::Arc};
use crate::{frame, proto, qpack, quic};
/// Cause of an error thrown by our own h3 layer
type Cause = Box<dyn std::error::Error + Send + Sync>;
/// Error thrown by the underlying QUIC impl
pub(crate) type TransportError = Box<dyn quic::Error>;
/// A general error that can occur when handling the HTTP/3 protocol.
#[derive(Clone)]
pub struct Error {
/// The error kind.
pub(crate) inner: Box<ErrorImpl>,
}
/// An HTTP/3 "application error code".
#[derive(PartialEq, Eq, Hash, Clone, Copy)]
pub struct Code {
code: u64,
}
impl Code {
/// Numerical error code
///
/// See <https://www.rfc-editor.org/rfc/rfc9114.html#errors>
/// and <https://www.rfc-editor.org/rfc/rfc9000.html#error-codes>
pub fn value(&self) -> u64 {
self.code
}
}
impl PartialEq<u64> for Code {
fn eq(&self, other: &u64) -> bool {
*other == self.code
}
}
/// The error kind.
#[derive(Clone)]
pub(crate) struct ErrorImpl {
pub(crate) kind: Kind,
cause: Option<Arc<Cause>>,
}
/// Some errors affect the whole connection, others only one Request or Stream.
/// See [errors](https://www.rfc-editor.org/rfc/rfc9114.html#errors) for mor details.
#[derive(PartialEq, Eq, Hash, Clone, Copy, Debug)]
pub enum ErrorLevel {
/// Error that will close the whole connection
ConnectionError,
/// Error scoped to a single stream
StreamError,
}
// Warning: this enum is public only for testing purposes. Do not use it in
// downstream code or be prepared to refactor as changes happen.
#[doc(hidden)]
#[non_exhaustive]
#[derive(Clone, Debug)]
pub enum Kind {
#[non_exhaustive]
Application {
code: Code,
reason: Option<Box<str>>,
level: ErrorLevel,
},
#[non_exhaustive]
HeaderTooBig {
actual_size: u64,
max_size: u64,
},
// Error from QUIC layer
#[non_exhaustive]
Transport(Arc<TransportError>),
// Connection has been closed with `Code::NO_ERROR`
Closed,
// Currently in a graceful shutdown procedure
Closing,
Timeout,
}
// ===== impl Code =====
macro_rules! codes {
(
$(
$(#[$docs:meta])*
($num:expr, $name:ident);
)+
) => {
impl Code {
$(
$(#[$docs])*
pub const $name: Code = Code{code: $num};
)+
}
impl fmt::Debug for Code {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self.code {
$(
$num => f.write_str(stringify!($name)),
)+
other => write!(f, "{:#x}", other),
}
}
}
}
}
codes! {
/// Datagram or capsule parse error
/// See: <https://www.rfc-editor.org/rfc/rfc9297#section-5.2>
(0x33, H3_DATAGRAM_ERROR);
/// No error. This is used when the connection or stream needs to be
/// closed, but there is no error to signal.
(0x100, H3_NO_ERROR);
/// Peer violated protocol requirements in a way that does not match a more
/// specific error code, or endpoint declines to use the more specific
/// error code.
(0x101, H3_GENERAL_PROTOCOL_ERROR);
/// An internal error has occurred in the HTTP stack.
(0x102, H3_INTERNAL_ERROR);
/// The endpoint detected that its peer created a stream that it will not
/// accept.
(0x103, H3_STREAM_CREATION_ERROR);
/// A stream required by the HTTP/3 connection was closed or reset.
(0x104, H3_CLOSED_CRITICAL_STREAM);
/// A frame was received that was not permitted in the current state or on
/// the current stream.
(0x105, H3_FRAME_UNEXPECTED);
/// A frame that fails to satisfy layout requirements or with an invalid
/// size was received.
(0x106, H3_FRAME_ERROR);
/// The endpoint detected that its peer is exhibiting a behavior that might
/// be generating excessive load.
(0x107, H3_EXCESSIVE_LOAD);
/// A Stream ID or Push ID was used incorrectly, such as exceeding a limit,
/// reducing a limit, or being reused.
(0x108, H3_ID_ERROR);
/// An endpoint detected an error in the payload of a SETTINGS frame.
(0x109, H3_SETTINGS_ERROR);
/// No SETTINGS frame was received at the beginning of the control stream.
(0x10a, H3_MISSING_SETTINGS);
/// A server rejected a request without performing any application
/// processing.
(0x10b, H3_REQUEST_REJECTED);
/// The request or its response (including pushed response) is cancelled.
(0x10c, H3_REQUEST_CANCELLED);
/// The client's stream terminated without containing a fully-formed
/// request.
(0x10d, H3_REQUEST_INCOMPLETE);
/// An HTTP message was malformed and cannot be processed.
(0x10e, H3_MESSAGE_ERROR);
/// The TCP connection established in response to a CONNECT request was
/// reset or abnormally closed.
(0x10f, H3_CONNECT_ERROR);
/// The requested operation cannot be served over HTTP/3. The peer should
/// retry over HTTP/1.1.
(0x110, H3_VERSION_FALLBACK);
/// The decoder failed to interpret an encoded field section and is not
/// able to continue decoding that field section.
(0x200, QPACK_DECOMPRESSION_FAILED);
/// The decoder failed to interpret an encoder instruction received on the
/// encoder stream.
(0x201, QPACK_ENCODER_STREAM_ERROR);
/// The encoder failed to interpret a decoder instruction received on the
/// decoder stream.
(0x202, QPACK_DECODER_STREAM_ERROR);
}
impl Code {
pub(crate) fn with_reason<S: Into<Box<str>>>(self, reason: S, level: ErrorLevel) -> Error {
Error::new(Kind::Application {
code: self,
reason: Some(reason.into()),
level,
})
}
pub(crate) fn with_cause<E: Into<Cause>>(self, cause: E) -> Error {
Error::from(self).with_cause(cause)
}
pub(crate) fn with_transport<E: Into<Box<dyn quic::Error>>>(self, err: E) -> Error {
Error::new(Kind::Transport(Arc::new(err.into())))
}
}
impl From<Code> for u64 {
fn from(code: Code) -> u64 {
code.code
}
}
// ===== impl Error =====
impl Error {
fn new(kind: Kind) -> Self {
Error {
inner: Box::new(ErrorImpl { kind, cause: None }),
}
}
/// Returns the error code from the error if available
pub fn try_get_code(&self) -> Option<Code> {
match self.inner.kind {
Kind::Application { code, .. } => Some(code),
_ => None,
}
}
/// returns the [`ErrorLevel`] of an [`Error`]
/// This indicates weather a accept loop should continue.
pub fn get_error_level(&self) -> ErrorLevel {
match self.inner.kind {
Kind::Application {
code: _,
reason: _,
level,
} => level,
// return Connection error on other kinds
_ => ErrorLevel::ConnectionError,
}
}
pub(crate) fn header_too_big(actual_size: u64, max_size: u64) -> Self {
Error::new(Kind::HeaderTooBig {
actual_size,
max_size,
})
}
pub(crate) fn with_cause<E: Into<Cause>>(mut self, cause: E) -> Self {
self.inner.cause = Some(Arc::new(cause.into()));
self
}
pub(crate) fn closing() -> Self {
Self::new(Kind::Closing)
}
pub(crate) fn closed() -> Self {
Self::new(Kind::Closed)
}
pub(crate) fn is_closed(&self) -> bool {
if let Kind::Closed = self.inner.kind {
return true;
}
false
}
pub(crate) fn is_header_too_big(&self) -> bool {
matches!(&self.inner.kind, Kind::HeaderTooBig { .. })
}
#[doc(hidden)]
pub fn kind(&self) -> Kind {
self.inner.kind.clone()
}
}
impl fmt::Debug for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let mut builder = f.debug_struct("h3::Error");
match self.inner.kind {
Kind::Closed => {
builder.field("connection closed", &true);
}
Kind::Closing => {
builder.field("closing", &true);
}
Kind::Timeout => {
builder.field("timeout", &true);
}
Kind::Application {
code, ref reason, ..
} => {
builder.field("code", &code);
if let Some(reason) = reason {
builder.field("reason", reason);
}
}
Kind::Transport(ref e) => {
builder.field("kind", &e);
builder.field("code: ", &e.err_code());
}
Kind::HeaderTooBig {
actual_size,
max_size,
} => {
builder.field("header_size", &actual_size);
builder.field("max_size", &max_size);
}
}
if let Some(ref cause) = self.inner.cause {
builder.field("cause", cause);
}
builder.finish()
}
}
impl fmt::Display for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self.inner.kind {
Kind::Closed => write!(f, "connection is closed")?,
Kind::Closing => write!(f, "connection is gracefully closing")?,
Kind::Transport(ref e) => write!(f, "quic transport error: {}", e)?,
Kind::Timeout => write!(f, "timeout",)?,
Kind::Application {
code, ref reason, ..
} => {
if let Some(reason) = reason {
write!(f, "application error: {}", reason)?
} else {
write!(f, "application error {:?}", code)?
}
}
Kind::HeaderTooBig {
actual_size,
max_size,
} => write!(
f,
"issued header size {} o is beyond peer's limit {} o",
actual_size, max_size
)?,
};
if let Some(ref cause) = self.inner.cause {
write!(f, "cause: {}", cause)?
}
Ok(())
}
}
impl std::error::Error for Error {
fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
self.inner.cause.as_ref().map(|e| &***e as _)
}
}
impl From<Code> for Error {
fn from(code: Code) -> Error {
Error::new(Kind::Application {
code,
reason: None,
level: ErrorLevel::ConnectionError,
})
}
}
impl From<qpack::EncoderError> for Error {
fn from(e: qpack::EncoderError) -> Self {
Self::from(Code::QPACK_ENCODER_STREAM_ERROR).with_cause(e)
}
}
impl From<qpack::DecoderError> for Error {
fn from(e: qpack::DecoderError) -> Self {
match e {
qpack::DecoderError::InvalidStaticIndex(_) => {
Self::from(Code::QPACK_DECOMPRESSION_FAILED).with_cause(e)
}
_ => Self::from(Code::QPACK_DECODER_STREAM_ERROR).with_cause(e),
}
}
}
impl From<proto::headers::HeaderError> for Error {
fn from(e: proto::headers::HeaderError) -> Self {
Error::new(Kind::Application {
code: Code::H3_MESSAGE_ERROR,
reason: None,
level: ErrorLevel::StreamError,
})
.with_cause(e)
}
}
impl From<frame::FrameStreamError> for Error {
fn from(e: frame::FrameStreamError) -> Self {
match e {
frame::FrameStreamError::Quic(e) => e.into(),
//= https://www.rfc-editor.org/rfc/rfc9114#section-7.1
//# When a stream terminates cleanly, if the last frame on the stream was
//# truncated, this MUST be treated as a connection error of type
//# H3_FRAME_ERROR.
frame::FrameStreamError::UnexpectedEnd => Code::H3_FRAME_ERROR
.with_reason("received incomplete frame", ErrorLevel::ConnectionError),
frame::FrameStreamError::Proto(e) => match e {
proto::frame::FrameError::InvalidStreamId(_)
| proto::frame::FrameError::InvalidPushId(_) => Code::H3_ID_ERROR,
proto::frame::FrameError::Settings(_) => Code::H3_SETTINGS_ERROR,
proto::frame::FrameError::UnsupportedFrame(_)
| proto::frame::FrameError::UnknownFrame(_) => Code::H3_FRAME_UNEXPECTED,
//= https://www.rfc-editor.org/rfc/rfc9114#section-7.1
//# A frame payload that contains additional bytes
//# after the identified fields or a frame payload that terminates before
//# the end of the identified fields MUST be treated as a connection
//# error of type H3_FRAME_ERROR.
//= https://www.rfc-editor.org/rfc/rfc9114#section-7.1
//# In particular, redundant length
//# encodings MUST be verified to be self-consistent; see Section 10.8.
proto::frame::FrameError::Incomplete(_)
| proto::frame::FrameError::InvalidFrameValue
| proto::frame::FrameError::Malformed => Code::H3_FRAME_ERROR,
}
.with_cause(e),
}
}
}
impl From<Error> for Box<dyn std::error::Error + std::marker::Send> {
fn from(e: Error) -> Self {
Box::new(e)
}
}
impl<T> From<T> for Error
where
T: Into<TransportError>,
{
fn from(e: T) -> Self {
let quic_error: TransportError = e.into();
if quic_error.is_timeout() {
return Error::new(Kind::Timeout);
}
match quic_error.err_code() {
Some(c) if Code::H3_NO_ERROR == c => Error::new(Kind::Closed),
Some(c) => Error::new(Kind::Application {
code: Code { code: c },
reason: None,
level: ErrorLevel::ConnectionError,
}),
None => Error::new(Kind::Transport(Arc::new(quic_error))),
}
}
}
impl From<proto::stream::InvalidStreamId> for Error {
fn from(e: proto::stream::InvalidStreamId) -> Self {
Self::from(Code::H3_ID_ERROR).with_cause(format!("{}", e))
}
}
#[cfg(test)]
mod tests {
use super::Error;
use std::mem;
#[test]
fn test_size_of() {
assert_eq!(mem::size_of::<Error>(), mem::size_of::<usize>());
}
}