-
Notifications
You must be signed in to change notification settings - Fork 1.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Limit size of request bodies in Bytes
extractor
#1346
Merged
+225
−18
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
use self::private::DefaultBodyLimitService; | ||
use tower_layer::Layer; | ||
|
||
/// Layer for configuring the default request body limit. | ||
/// | ||
/// For security reasons, [`Bytes`] will, by default, not accept bodies larger than 2MB. This also | ||
/// applies to extractors that uses [`Bytes`] internally such as `String`, [`Json`], and [`Form`]. | ||
/// | ||
/// This middleware provides ways to configure that. | ||
/// | ||
/// Note that if an extractor consumes the body directly with [`Body::data`], or similar, the | ||
/// default limit is _not_ applied. | ||
/// | ||
/// [`Body::data`]: http_body::Body::data | ||
/// [`Bytes`]: bytes::Bytes | ||
/// [`Json`]: https://docs.rs/axum/0.6.0-rc.1/axum/struct.Json.html | ||
/// [`Form`]: https://docs.rs/axum/0.6.0-rc.1/axum/struct.Form.html | ||
#[derive(Debug, Clone)] | ||
#[non_exhaustive] | ||
pub struct DefaultBodyLimit; | ||
|
||
impl DefaultBodyLimit { | ||
/// Disable the default request body limit. | ||
/// | ||
/// This must be used to receive bodies larger than the default limit of 2MB using [`Bytes`] or | ||
/// an extractor built on it such as `String`, [`Json`], [`Form`]. | ||
/// | ||
/// Note that if you're accepting data from untrusted remotes it is recommend to add your own | ||
/// limit such as [`tower_http::limit`]. | ||
/// | ||
/// # Example | ||
/// | ||
/// ``` | ||
/// use axum::{ | ||
/// Router, | ||
/// routing::get, | ||
/// body::{Bytes, Body}, | ||
/// extract::DefaultBodyLimit, | ||
/// }; | ||
/// use tower_http::limit::RequestBodyLimitLayer; | ||
/// use http_body::Limited; | ||
/// | ||
/// let app: Router<_, Limited<Body>> = Router::new() | ||
/// .route("/", get(|body: Bytes| async {})) | ||
/// // Disable the default limit | ||
/// .layer(DefaultBodyLimit::disable()) | ||
/// // Set a different limit | ||
/// .layer(RequestBodyLimitLayer::new(10 * 1000 * 1000)); | ||
/// ``` | ||
/// | ||
/// [`tower_http::limit`]: https://docs.rs/tower-http/0.3.4/tower_http/limit/index.html | ||
/// [`Bytes`]: bytes::Bytes | ||
/// [`Json`]: https://docs.rs/axum/0.6.0-rc.1/axum/struct.Json.html | ||
/// [`Form`]: https://docs.rs/axum/0.6.0-rc.1/axum/struct.Form.html | ||
pub fn disable() -> Self { | ||
Self | ||
} | ||
} | ||
|
||
impl<S> Layer<S> for DefaultBodyLimit { | ||
type Service = DefaultBodyLimitService<S>; | ||
|
||
fn layer(&self, inner: S) -> Self::Service { | ||
DefaultBodyLimitService { inner } | ||
} | ||
} | ||
|
||
#[derive(Copy, Clone, Debug)] | ||
pub(crate) struct DefaultBodyLimitDisabled; | ||
|
||
mod private { | ||
use super::DefaultBodyLimitDisabled; | ||
use http::Request; | ||
use std::task::Context; | ||
use tower_service::Service; | ||
|
||
#[derive(Debug, Clone, Copy)] | ||
pub struct DefaultBodyLimitService<S> { | ||
pub(super) inner: S, | ||
} | ||
|
||
impl<B, S> Service<Request<B>> for DefaultBodyLimitService<S> | ||
where | ||
S: Service<Request<B>>, | ||
{ | ||
type Response = S::Response; | ||
type Error = S::Error; | ||
type Future = S::Future; | ||
|
||
#[inline] | ||
fn poll_ready(&mut self, cx: &mut Context<'_>) -> std::task::Poll<Result<(), Self::Error>> { | ||
self.inner.poll_ready(cx) | ||
} | ||
|
||
#[inline] | ||
fn call(&mut self, mut req: Request<B>) -> Self::Future { | ||
req.extensions_mut().insert(DefaultBodyLimitDisabled); | ||
self.inner.call(req) | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I picked 2mb because thats what actix-web uses for their
Json
extractor.