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
use crate::{copy, http_config::DEFAULT_CONFIG, Body, Buffer, HttpConfig, MutCow};
use encoding_rs::Encoding;
use futures_lite::{ready, AsyncRead, AsyncReadExt, AsyncWrite, Stream};
use httparse::{InvalidChunkSize, Status};
use std::{
fmt::{self, Debug, Formatter},
future::{Future, IntoFuture},
io::{self, ErrorKind},
iter,
pin::Pin,
task::{Context, Poll},
};
use Poll::{Pending, Ready};
use ReceivedBodyState::{Chunked, End, FixedLength, PartialChunkSize, Start};
mod chunked;
mod fixed_length;
/** A received http body
This type represents a body that will be read from the underlying
transport, which it may either borrow from a [`Conn`](crate::Conn) or
own.
```rust
# trillium_testing::block_on(async {
# use trillium_http::{Method, Conn};
let mut conn = Conn::new_synthetic(Method::Get, "/", "hello");
let body = conn.request_body().await;
assert_eq!(body.read_string().await?, "hello");
# trillium_http::Result::Ok(()) }).unwrap();
```
## Bounds checking
Every `ReceivedBody` has a maximum length beyond which it will return an error, expressed as a
u64. To override this on the specific `ReceivedBody`, use [`ReceivedBody::with_max_len`] or
[`ReceivedBody::set_max_len`]
The default maximum length is currently set to 500mb. In the next semver-minor release, this value
will decrease substantially.
## Large chunks, small read buffers
Attempting to read a chunked body with a buffer that is shorter than the chunk size in hex will
result in an error. This limitation is temporary.
*/
pub struct ReceivedBody<'conn, Transport> {
content_length: Option<u64>,
buffer: MutCow<'conn, Buffer>,
transport: Option<MutCow<'conn, Transport>>,
state: MutCow<'conn, ReceivedBodyState>,
on_completion: Option<Box<dyn Fn(Transport) + Send + Sync + 'static>>,
encoding: &'static Encoding,
max_len: u64,
initial_len: usize,
copy_loops_per_yield: usize,
max_preallocate: usize,
}
fn slice_from(min: u64, buf: &[u8]) -> Option<&[u8]> {
buf.get(usize::try_from(min).unwrap_or(usize::MAX)..)
.filter(|buf| !buf.is_empty())
}
impl<'conn, Transport> ReceivedBody<'conn, Transport>
where
Transport: AsyncRead + Unpin + Send + Sync + 'static,
{
#[allow(missing_docs)]
#[doc(hidden)]
pub fn new(
content_length: Option<u64>,
buffer: impl Into<MutCow<'conn, Buffer>>,
transport: impl Into<MutCow<'conn, Transport>>,
state: impl Into<MutCow<'conn, ReceivedBodyState>>,
on_completion: Option<Box<dyn Fn(Transport) + Send + Sync + 'static>>,
encoding: &'static Encoding,
) -> Self {
Self::new_with_config(
content_length,
buffer,
transport,
state,
on_completion,
encoding,
&DEFAULT_CONFIG,
)
}
#[allow(missing_docs)]
#[doc(hidden)]
pub(crate) fn new_with_config(
content_length: Option<u64>,
buffer: impl Into<MutCow<'conn, Buffer>>,
transport: impl Into<MutCow<'conn, Transport>>,
state: impl Into<MutCow<'conn, ReceivedBodyState>>,
on_completion: Option<Box<dyn Fn(Transport) + Send + Sync + 'static>>,
encoding: &'static Encoding,
config: &HttpConfig,
) -> Self {
Self {
content_length,
buffer: buffer.into(),
transport: Some(transport.into()),
state: state.into(),
on_completion,
encoding,
max_len: config.received_body_max_len,
initial_len: config.received_body_initial_len,
copy_loops_per_yield: config.copy_loops_per_yield,
max_preallocate: config.received_body_max_preallocate,
}
}
/**
Returns the content-length of this body, if available. This
usually is derived from the content-length header. If the http
request or response that this body is attached to uses
transfer-encoding chunked, this will be None.
```rust
# trillium_testing::block_on(async {
# use trillium_http::{Method, Conn};
let mut conn = Conn::new_synthetic(Method::Get, "/", "hello");
let body = conn.request_body().await;
assert_eq!(body.content_length(), Some(5));
# trillium_http::Result::Ok(()) }).unwrap();
```
*/
pub fn content_length(&self) -> Option<u64> {
self.content_length
}
/// # Reads entire body to String.
///
/// This uses the encoding determined by the content-type (mime)
/// charset. If an encoding problem is encountered, the String
/// returned by [`ReceivedBody::read_string`] will contain utf8
/// replacement characters.
///
/// Note that this can only be performed once per Conn, as the
/// underlying data is not cached anywhere. This is the only copy of
/// the body contents.
///
/// # Errors
///
/// This will return an error if there is an IO error on the
/// underlying transport such as a disconnect
///
/// This will also return an error if the length exceeds the maximum length. To override this
/// value on this specific body, use [`ReceivedBody::with_max_len`] or
/// [`ReceivedBody::set_max_len`]
pub async fn read_string(self) -> crate::Result<String> {
let encoding = self.encoding();
let bytes = self.read_bytes().await?;
let (s, _, _) = encoding.decode(&bytes);
Ok(s.to_string())
}
fn owns_transport(&self) -> bool {
self.transport.as_ref().is_some_and(MutCow::is_owned)
}
/// Set the maximum length that can be read from this body before error
///
/// See also [`HttpConfig::received_body_max_len`][HttpConfig#received_body_max_len]
pub fn set_max_len(&mut self, max_len: u64) {
self.max_len = max_len;
}
/// chainable setter for the maximum length that can be read from this body before error
///
/// See also [`HttpConfig::received_body_max_len`][HttpConfig#received_body_max_len]
#[must_use]
pub fn with_max_len(mut self, max_len: u64) -> Self {
self.set_max_len(max_len);
self
}
/// Similar to [`ReceivedBody::read_string`], but returns the raw bytes. This is useful for
/// bodies that are not text.
///
/// You can use this in conjunction with `encoding` if you need different handling of malformed
/// character encoding than the lossy conversion provided by [`ReceivedBody::read_string`].
///
/// # Errors
///
/// This will return an error if there is an IO error on the underlying transport such as a
/// disconnect
///
/// This will also return an error if the length exceeds
/// [`received_body_max_len`][HttpConfig::with_received_body_max_len]. To override this value on
/// this specific body, use [`ReceivedBody::with_max_len`] or [`ReceivedBody::set_max_len`]
pub async fn read_bytes(mut self) -> crate::Result<Vec<u8>> {
let mut vec = if let Some(len) = self.content_length {
if len > self.max_len {
return Err(crate::Error::ReceivedBodyTooLong(self.max_len));
}
let len = usize::try_from(len)
.map_err(|_| crate::Error::ReceivedBodyTooLong(self.max_len))?;
Vec::with_capacity(len.min(self.max_preallocate))
} else {
Vec::with_capacity(self.initial_len)
};
self.read_to_end(&mut vec).await?;
Ok(vec)
}
/**
returns the character encoding of this body, usually determined from the content type
(mime-type) of the associated Conn.
*/
pub fn encoding(&self) -> &'static Encoding {
self.encoding
}
fn read_raw(&mut self, cx: &mut Context<'_>, buf: &mut [u8]) -> Poll<io::Result<usize>> {
if let Some(transport) = self.transport.as_deref_mut() {
read_raw(&mut self.buffer, transport, cx, buf)
} else {
Ready(Err(ErrorKind::NotConnected.into()))
}
}
/**
Consumes the remainder of this body from the underlying transport by reading it to the end and
discarding the contents. This is important for http1.1 keepalive, but most of the time you do
not need to directly call this. It returns the number of bytes consumed.
# Errors
This will return an [`std::io::Result::Err`] if there is an io error on the underlying
transport, such as a disconnect
*/
#[allow(clippy::missing_errors_doc)] // false positive
pub async fn drain(self) -> io::Result<u64> {
let copy_loops_per_yield = self.copy_loops_per_yield;
copy(self, futures_lite::io::sink(), copy_loops_per_yield).await
}
}
impl<'a, Transport> IntoFuture for ReceivedBody<'a, Transport>
where
Transport: AsyncRead + Unpin + Send + Sync + 'static,
{
type Output = crate::Result<String>;
type IntoFuture = Pin<Box<dyn Future<Output = Self::Output> + Send + 'a>>;
fn into_future(self) -> Self::IntoFuture {
Box::pin(async move { self.read_string().await })
}
}
impl<T> ReceivedBody<'static, T> {
/// takes the static transport from this received body
pub fn take_transport(&mut self) -> Option<T> {
self.transport.take().map(MutCow::unwrap_owned)
}
}
fn read_raw<Transport>(
self_buffer: &mut Buffer,
transport: &mut Transport,
cx: &mut Context<'_>,
buf: &mut [u8],
) -> Poll<io::Result<usize>>
where
Transport: AsyncRead + Unpin + Send + Sync + 'static,
{
if self_buffer.is_empty() {
Pin::new(transport).poll_read(cx, buf)
} else if self_buffer.len() >= buf.len() {
let len = buf.len();
buf.copy_from_slice(&self_buffer[..len]);
self_buffer.ignore_front(len);
Ready(Ok(len))
} else {
let self_buffer_len = self_buffer.len();
buf[..self_buffer_len].copy_from_slice(self_buffer);
self_buffer.truncate(0);
match Pin::new(transport).poll_read(cx, &mut buf[self_buffer_len..]) {
Ready(Ok(additional)) => Ready(Ok(additional + self_buffer_len)),
Pending => Ready(Ok(self_buffer_len)),
other @ Ready(_) => other,
}
}
}
const STREAM_READ_BUF_LENGTH: usize = 128;
impl<'conn, Transport> Stream for ReceivedBody<'conn, Transport>
where
Transport: AsyncRead + Unpin + Send + Sync + 'static,
{
type Item = Vec<u8>;
fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
let mut bytes = 0;
let mut vec = vec![0; STREAM_READ_BUF_LENGTH];
loop {
match Pin::new(&mut *self).poll_read(cx, &mut vec[bytes..]) {
Pending if bytes == 0 => return Pending,
Ready(Ok(0)) if bytes == 0 => return Ready(None),
Pending | Ready(Ok(0)) => {
vec.truncate(bytes);
return Ready(Some(vec));
}
Ready(Ok(new_bytes)) => {
bytes += new_bytes;
vec.extend(iter::repeat(0).take(bytes + STREAM_READ_BUF_LENGTH - vec.len()));
}
Ready(Err(error)) => {
log::error!("got {error:?} in ReceivedBody stream");
return Ready(None);
}
}
}
}
}
type StateOutput = Poll<io::Result<(ReceivedBodyState, usize)>>;
impl<'conn, Transport> ReceivedBody<'conn, Transport>
where
Transport: AsyncRead + Unpin + Send + Sync + 'static,
{
#[inline]
fn handle_start(&mut self) -> StateOutput {
Ready(Ok((
match self.content_length {
Some(0) => End,
Some(total_length) if total_length < self.max_len => FixedLength {
current_index: 0,
total: total_length,
},
Some(_) => {
return Ready(Err(io::Error::new(
ErrorKind::Unsupported,
"content too long",
)))
}
None => Chunked {
remaining: 0,
total: 0,
},
},
0,
)))
}
}
impl<'conn, Transport> AsyncRead for ReceivedBody<'conn, Transport>
where
Transport: AsyncRead + Unpin + Send + Sync + 'static,
{
fn poll_read(
mut self: Pin<&mut Self>,
cx: &mut Context<'_>,
buf: &mut [u8],
) -> Poll<io::Result<usize>> {
for _ in 0..self.copy_loops_per_yield {
let (new_body_state, bytes) = ready!(match *self.state {
Start => self.handle_start(),
Chunked { remaining, total } => self.handle_chunked(cx, buf, remaining, total),
PartialChunkSize { total } => self.handle_partial(cx, buf, total),
FixedLength {
current_index,
total,
} => self.handle_fixed_length(cx, buf, current_index, total),
End => Ready(Ok((End, 0))),
})?;
*self.state = new_body_state;
if *self.state == End {
if self.on_completion.is_some() && self.owns_transport() {
let transport = self.transport.take().unwrap().unwrap_owned();
let on_completion = self.on_completion.take().unwrap();
on_completion(transport);
}
return Ready(Ok(bytes));
} else if bytes != 0 {
return Ready(Ok(bytes));
}
}
cx.waker().wake_by_ref();
Pending
}
}
impl<'conn, Transport> Debug for ReceivedBody<'conn, Transport> {
fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
f.debug_struct("RequestBody")
.field("state", &*self.state)
.field("content_length", &self.content_length)
.field("buffer", &"..")
.field("on_completion", &self.on_completion.is_some())
.finish()
}
}
#[derive(Debug, Clone, Copy, Eq, PartialEq, Default)]
#[allow(missing_docs)]
#[doc(hidden)]
pub enum ReceivedBodyState {
/// initial state
#[default]
Start,
/// read state for a chunked-encoded body. the number of bytes that have been read from the
/// current chunk is the difference between remaining and total.
Chunked {
/// remaining indicates the bytes left _in the current
/// chunk_. initial state is zero.
remaining: u64,
/// total indicates the absolute number of bytes read from all chunks
total: u64,
},
PartialChunkSize {
total: u64,
},
/// read state for a fixed-length body.
FixedLength {
/// current index represents the bytes that have already been
/// read. initial state is zero
current_index: u64,
/// total length indicates the claimed length, usually
/// determined by the content-length header
total: u64,
},
/// the terminal read state
End,
}
impl<Transport> From<ReceivedBody<'static, Transport>> for Body
where
Transport: AsyncRead + AsyncWrite + Send + Sync + Unpin + 'static,
{
fn from(rb: ReceivedBody<'static, Transport>) -> Self {
let len = rb.content_length;
Body::new_streaming(rb, len)
}
}