Skip to content
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

Avoid exposure of type names by QueryRejection #1171

Merged
merged 6 commits into from Jul 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions axum-extra/src/extract/form.rs
Expand Up @@ -67,7 +67,7 @@ where
if req.method() == Method::GET {
let query = req.uri().query().unwrap_or_default();
let value = serde_html_form::from_str(query)
.map_err(FailedToDeserializeQueryString::__private_new::<T, _>)?;
.map_err(FailedToDeserializeQueryString::__private_new)?;
Ok(Form(value))
} else {
if !has_content_type(req, &mime::APPLICATION_WWW_FORM_URLENCODED) {
Expand All @@ -76,7 +76,7 @@ where

let bytes = Bytes::from_request(req).await?;
let value = serde_html_form::from_bytes(&bytes)
.map_err(FailedToDeserializeQueryString::__private_new::<T, _>)?;
.map_err(FailedToDeserializeQueryString::__private_new)?;

Ok(Form(value))
}
Expand Down
2 changes: 1 addition & 1 deletion axum-extra/src/extract/query.rs
Expand Up @@ -68,7 +68,7 @@ where
async fn from_request(req: &mut RequestParts<B>) -> Result<Self, Self::Rejection> {
let query = req.uri().query().unwrap_or_default();
let value = serde_html_form::from_str(query)
.map_err(FailedToDeserializeQueryString::__private_new::<T, _>)?;
.map_err(FailedToDeserializeQueryString::__private_new)?;
Ok(Query(value))
}
}
Expand Down
2 changes: 2 additions & 0 deletions axum/CHANGELOG.md
Expand Up @@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

# Unreleased

- **fixed:** Don't expose internal type names in `QueryRejection` response. ([#1171])
- **breaking:** Remove `extractor_middleware` which was previously deprecated.
Use `axum::middleware::from_extractor` instead ([#1077])
- **breaking:** Allow `Error: Into<Infallible>` for `Route::{layer, route_layer}` ([#924])
Expand All @@ -29,6 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- **breaking:** Require middleware added with `Handler::layer` to have
`Infallible` as the error type ([#1152])

[#1171]: https://github.com/tokio-rs/axum/pull/1171
[#1077]: https://github.com/tokio-rs/axum/pull/1077
[#1088]: https://github.com/tokio-rs/axum/pull/1088
[#1102]: https://github.com/tokio-rs/axum/pull/1102
Expand Down
2 changes: 1 addition & 1 deletion axum/src/extract/query.rs
Expand Up @@ -59,7 +59,7 @@ where
async fn from_request(req: &mut RequestParts<B>) -> Result<Self, Self::Rejection> {
let query = req.uri().query().unwrap_or_default();
let value = serde_urlencoded::from_str(query)
.map_err(FailedToDeserializeQueryString::__private_new::<T, _>)?;
.map_err(FailedToDeserializeQueryString::__private_new)?;
Ok(Query(value))
}
}
Expand Down
10 changes: 2 additions & 8 deletions axum/src/extract/rejection.rs
Expand Up @@ -100,18 +100,16 @@ define_rejection! {
#[derive(Debug)]
pub struct FailedToDeserializeQueryString {
error: Error,
type_name: &'static str,
}

impl FailedToDeserializeQueryString {
#[doc(hidden)]
pub fn __private_new<T, E>(error: E) -> Self
pub fn __private_new<E>(error: E) -> Self
where
E: Into<BoxError>,
{
FailedToDeserializeQueryString {
error: Error::new(error),
type_name: std::any::type_name::<T>(),
davidpdrsn marked this conversation as resolved.
Show resolved Hide resolved
}
}
}
Expand All @@ -124,11 +122,7 @@ impl IntoResponse for FailedToDeserializeQueryString {

impl std::fmt::Display for FailedToDeserializeQueryString {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(
f,
"Failed to deserialize query string. Expected something of type `{}`. Error: {}",
self.type_name, self.error,
)
write!(f, "Failed to deserialize query string: {}", self.error,)
}
}

Expand Down
4 changes: 2 additions & 2 deletions axum/src/form.rs
Expand Up @@ -69,7 +69,7 @@ where
if req.method() == Method::GET {
let query = req.uri().query().unwrap_or_default();
let value = serde_urlencoded::from_str(query)
.map_err(FailedToDeserializeQueryString::__private_new::<T, _>)?;
.map_err(FailedToDeserializeQueryString::__private_new)?;
Ok(Form(value))
} else {
if !has_content_type(req, &mime::APPLICATION_WWW_FORM_URLENCODED) {
Expand All @@ -78,7 +78,7 @@ where

let bytes = Bytes::from_request(req).await?;
let value = serde_urlencoded::from_bytes(&bytes)
.map_err(FailedToDeserializeQueryString::__private_new::<T, _>)?;
.map_err(FailedToDeserializeQueryString::__private_new)?;

Ok(Form(value))
}
Expand Down