Skip to content

Commit

Permalink
Add https_only() for ClientBuilder (#1102)
Browse files Browse the repository at this point in the history
Closes #980
  • Loading branch information
Martichou authored Dec 9, 2020
1 parent 474d9ef commit 541d0c2
Show file tree
Hide file tree
Showing 4 changed files with 70 additions and 0 deletions.
17 changes: 17 additions & 0 deletions src/async_impl/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ struct Config {
cookie_store: Option<cookie::CookieStore>,
trust_dns: bool,
error: Option<crate::Error>,
https_only: bool,
}

impl Default for ClientBuilder {
Expand Down Expand Up @@ -157,6 +158,7 @@ impl ClientBuilder {
trust_dns: cfg!(feature = "trust-dns"),
#[cfg(feature = "cookies")]
cookie_store: None,
https_only: false,
},
}
}
Expand Down Expand Up @@ -349,6 +351,7 @@ impl ClientBuilder {
request_timeout: config.timeout,
proxies,
proxies_maybe_http_auth,
https_only: config.https_only,
}),
})
}
Expand Down Expand Up @@ -917,6 +920,14 @@ impl ClientBuilder {
self
}
}

/// Restrict the Client to be used with HTTPS only requests.
///
/// Defaults to false.
pub fn https_only(mut self, enabled: bool) -> ClientBuilder {
self.config.https_only = enabled;
self
}
}

type HyperClient = hyper::Client<Connector, super::body::ImplStream>;
Expand Down Expand Up @@ -1040,6 +1051,11 @@ impl Client {
return Pending::new_err(error::url_bad_scheme(url));
}

// check if we're in https_only mode and check the scheme of the current URL
if self.inner.https_only && url.scheme() != "https" {
return Pending::new_err(error::url_bad_scheme(url));
}

// insert default headers in the request headers
// without overwriting already appended headers.
for (key, value) in &self.inner.headers {
Expand Down Expand Up @@ -1238,6 +1254,7 @@ struct ClientRef {
request_timeout: Option<Duration>,
proxies: Arc<Vec<Proxy>>,
proxies_maybe_http_auth: bool,
https_only: bool,
}

impl ClientRef {
Expand Down
7 changes: 7 additions & 0 deletions src/blocking/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -573,6 +573,13 @@ impl ClientBuilder {
self.with_inner(|inner| inner.no_trust_dns())
}

/// Restrict the Client to be used with HTTPS only requests.
///
/// Defaults to false.
pub fn https_only(self, enabled: bool) -> ClientBuilder {
self.with_inner(|inner| inner.https_only(enabled))
}

// private

fn with_inner<F>(mut self, func: F) -> ClientBuilder
Expand Down
22 changes: 22 additions & 0 deletions tests/blocking.rs
Original file line number Diff line number Diff line change
Expand Up @@ -288,3 +288,25 @@ fn test_blocking_inside_a_runtime() {
let _should_panic = reqwest::blocking::get(&url);
});
}

#[cfg(feature = "default-tls")]
#[test]
fn test_allowed_methods_blocking() {
let resp = reqwest::blocking::Client::builder()
.https_only(true)
.build()
.expect("client builder")
.get("https://google.com")
.send();

assert_eq!(resp.is_err(), false);

let resp = reqwest::blocking::Client::builder()
.https_only(true)
.build()
.expect("client builder")
.get("http://google.com")
.send();

assert_eq!(resp.is_err(), true);
}
24 changes: 24 additions & 0 deletions tests/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -199,3 +199,27 @@ fn use_preconfigured_rustls_default() {
.build()
.expect("preconfigured rustls tls");
}

#[cfg(feature = "default-tls")]
#[tokio::test]
async fn test_allowed_methods() {
let resp = reqwest::Client::builder()
.https_only(true)
.build()
.expect("client builder")
.get("https://google.com")
.send()
.await;

assert_eq!(resp.is_err(), false);

let resp = reqwest::Client::builder()
.https_only(true)
.build()
.expect("client builder")
.get("http://google.com")
.send()
.await;

assert_eq!(resp.is_err(), true);
}

0 comments on commit 541d0c2

Please sign in to comment.