Add support for SOCKS5 proxies, and parsing proxy authorizations from URLs

This commit is contained in:
Diggory Blake
2019-04-05 15:59:18 -07:00
committed by Sean McArthur
parent 871ec6f989
commit c45ff29bfb
8 changed files with 486 additions and 103 deletions

View File

@@ -23,6 +23,10 @@ matrix:
- rust: stable - rust: stable
env: FEATURES="--features rustls-tls" env: FEATURES="--features rustls-tls"
# default-tls, rustls, and socks!
- rust: stable
env: FEATURES="--features rustls-tls,socks"
- rust: stable - rust: stable
env: FEATURES="--features hyper-011" env: FEATURES="--features hyper-011"

View File

@@ -17,28 +17,32 @@ encoding_rs = "0.8"
futures = "0.1.23" futures = "0.1.23"
http = "0.1.15" http = "0.1.15"
hyper = "0.12.22" hyper = "0.12.22"
hyper-old-types = { version = "0.11", optional = true, features = ["compat"] }
flate2 = { version = "^1.0.7", default-features = false, features = ["rust_backend"] } flate2 = { version = "^1.0.7", default-features = false, features = ["rust_backend"] }
hyper-tls = { version = "0.3.2", optional = true }
log = "0.4" log = "0.4"
mime = "0.3.7" mime = "0.3.7"
mime_guess = "2.0.0-alpha.6" mime_guess = "2.0.0-alpha.6"
native-tls = { version = "0.2", optional = true }
serde = "1.0" serde = "1.0"
serde_json = "1.0" serde_json = "1.0"
serde_urlencoded = "0.5" serde_urlencoded = "0.5"
tokio = { version = "0.1.7", default-features = false, features = ["rt-full"] } tokio = { version = "0.1.7", default-features = false, features = ["rt-full", "tcp"] }
tokio-executor = "0.1.4" # a minimum version so trust-dns-resolver compiles tokio-executor = "0.1.4" # a minimum version so trust-dns-resolver compiles
tokio-io = "0.1" tokio-io = "0.1"
tokio-threadpool = "0.1.8" # a minimum version so tokio compiles tokio-threadpool = "0.1.8" # a minimum version so tokio compiles
tokio-timer = "0.2.6" # a minimum version so trust-dns-resolver compiles tokio-timer = "0.2.6" # a minimum version so trust-dns-resolver compiles
trust-dns-resolver = { version = "0.10", optional = true }
url = "1.2" url = "1.2"
uuid = { version = "0.7", features = ["v4"] } uuid = { version = "0.7", features = ["v4"] }
# Optional deps...
hyper-old-types = { version = "0.11", optional = true, features = ["compat"] }
hyper-rustls = { version = "0.16", optional = true } hyper-rustls = { version = "0.16", optional = true }
tokio-rustls = { version = "0.9", optional = true } hyper-tls = { version = "0.3.2", optional = true }
webpki-roots = { version = "0.16", optional = true } native-tls = { version = "0.2", optional = true }
rustls = { version = "0.15", features = ["dangerous_configuration"], optional = true } rustls = { version = "0.15", features = ["dangerous_configuration"], optional = true }
socks = { version = "0.3.2", optional = true }
tokio-rustls = { version = "0.9", optional = true }
trust-dns-resolver = { version = "0.10", optional = true }
webpki-roots = { version = "0.16", optional = true }
[dev-dependencies] [dev-dependencies]
env_logger = "0.6" env_logger = "0.6"

View File

@@ -579,11 +579,11 @@ impl Client {
for proxy in self.inner.proxies.iter() { for proxy in self.inner.proxies.iter() {
if proxy.is_match(dst) { if proxy.is_match(dst) {
match proxy.auth() { match proxy.http_basic_auth(dst) {
Some(::proxy::Auth::Basic(ref header)) => { Some(header) => {
headers.insert( headers.insert(
PROXY_AUTHORIZATION, PROXY_AUTHORIZATION,
header.clone() header,
); );
}, },
None => (), None => (),

View File

@@ -19,7 +19,7 @@ use std::time::Duration;
#[cfg(feature = "trust-dns")] #[cfg(feature = "trust-dns")]
use dns::TrustDnsResolver; use dns::TrustDnsResolver;
use Proxy; use proxy::{Proxy, ProxyScheme};
#[cfg(feature = "trust-dns")] #[cfg(feature = "trust-dns")]
type HttpConnector = ::hyper::client::HttpConnector<TrustDnsResolver>; type HttpConnector = ::hyper::client::HttpConnector<TrustDnsResolver>;
@@ -121,6 +121,79 @@ impl Connector {
pub(crate) fn set_timeout(&mut self, timeout: Option<Duration>) { pub(crate) fn set_timeout(&mut self, timeout: Option<Duration>) {
self.timeout = timeout; self.timeout = timeout;
} }
#[cfg(feature = "socks")]
fn connect_socks(&self, dst: Destination, proxy: ProxyScheme) -> Connecting {
macro_rules! timeout {
($future:expr) => {
if let Some(dur) = self.timeout {
Box::new(Timeout::new($future, dur).map_err(|err| {
if err.is_inner() {
err.into_inner().expect("is_inner")
} else if err.is_elapsed() {
io::Error::new(io::ErrorKind::TimedOut, "connect timed out")
} else {
io::Error::new(io::ErrorKind::Other, err)
}
}))
} else {
Box::new($future)
}
}
}
let dns = match proxy {
ProxyScheme::Socks5 { remote_dns: false, .. } => socks::DnsResolve::Local,
ProxyScheme::Socks5 { remote_dns: true, .. } => socks::DnsResolve::Proxy,
ProxyScheme::Http { .. } => {
unreachable!("connect_socks is only called for socks proxies");
},
};
match &self.inner {
#[cfg(feature = "default-tls")]
Inner::DefaultTls(_http, tls) => if dst.scheme() == "https" {
use self::native_tls_async::TlsConnectorExt;
let tls = tls.clone();
let host = dst.host().to_owned();
let socks_connecting = socks::connect(proxy, dst, dns);
return timeout!(socks_connecting.and_then(move |(conn, connected)| {
tls.connect_async(&host, conn)
.map_err(|e| io::Error::new(io::ErrorKind::Other, e))
.map(move |io| (Box::new(io) as Conn, connected))
}));
},
#[cfg(feature = "rustls-tls")]
Inner::RustlsTls { tls_proxy, .. } => if dst.scheme() == "https" {
use tokio_rustls::TlsConnector as RustlsConnector;
use tokio_rustls::webpki::DNSNameRef;
let tls = tls_proxy.clone();
let host = dst.host().to_owned();
let socks_connecting = socks::connect(proxy, dst, dns);
return timeout!(socks_connecting.and_then(move |(conn, connected)| {
let maybe_dnsname = DNSNameRef::try_from_ascii_str(&host)
.map(|dnsname| dnsname.to_owned())
.map_err(|_| io::Error::new(io::ErrorKind::Other, "Invalid DNS Name"));
futures::future::result(maybe_dnsname)
.and_then(move |dnsname| {
RustlsConnector::from(tls).connect(dnsname.as_ref(), conn)
.map_err(|e| io::Error::new(io::ErrorKind::Other, e))
})
.map(move |io| {
(Box::new(io) as Conn, connected)
})
}));
},
#[cfg(not(feature = "tls"))]
Inner::Http(_) => ()
}
// else no TLS
socks::connect(proxy, dst, dns)
}
} }
#[cfg(feature = "trust-dns")] #[cfg(feature = "trust-dns")]
@@ -216,9 +289,17 @@ impl Connect for Connector {
} }
for prox in self.proxies.iter() { for prox in self.proxies.iter() {
if let Some(puri) = prox.intercept(&dst) { if let Some(proxy_scheme) = prox.intercept(&dst) {
trace!("proxy({:?}) intercepts {:?}", puri, dst); trace!("proxy({:?}) intercepts {:?}", proxy_scheme, dst);
let (puri, _auth) = match proxy_scheme {
ProxyScheme::Http { uri, auth, .. } => (uri, auth),
#[cfg(feature = "socks")]
ProxyScheme::Socks5 { .. } => return self.connect_socks(dst, proxy_scheme),
};
let mut ndst = dst.clone(); let mut ndst = dst.clone();
let new_scheme = puri let new_scheme = puri
.scheme_part() .scheme_part()
.map(Scheme::as_str) .map(Scheme::as_str)
@@ -232,7 +313,7 @@ impl Connect for Connector {
ndst.set_port(puri.port_part().map(|port| port.as_u16())); ndst.set_port(puri.port_part().map(|port| port.as_u16()));
#[cfg(feature = "tls")] #[cfg(feature = "tls")]
let auth = prox.auth().cloned(); let auth = _auth;
match &self.inner { match &self.inner {
#[cfg(feature = "default-tls")] #[cfg(feature = "default-tls")]
@@ -307,14 +388,14 @@ pub(crate) type Conn = Box<dyn AsyncConn + Send + Sync + 'static>;
pub(crate) type Connecting = Box<Future<Item=(Conn, Connected), Error=io::Error> + Send>; pub(crate) type Connecting = Box<Future<Item=(Conn, Connected), Error=io::Error> + Send>;
#[cfg(feature = "tls")] #[cfg(feature = "tls")]
fn tunnel<T>(conn: T, host: String, port: u16, auth: Option<::proxy::Auth>) -> Tunnel<T> { fn tunnel<T>(conn: T, host: String, port: u16, auth: Option<::http::header::HeaderValue>) -> Tunnel<T> {
let mut buf = format!("\ let mut buf = format!("\
CONNECT {0}:{1} HTTP/1.1\r\n\ CONNECT {0}:{1} HTTP/1.1\r\n\
Host: {0}:{1}\r\n\ Host: {0}:{1}\r\n\
", host, port).into_bytes(); ", host, port).into_bytes();
match auth { match auth {
Some(::proxy::Auth::Basic(value)) => { Some(value) => {
debug!("tunnel to {}:{} using basic auth", host, port); debug!("tunnel to {}:{} using basic auth", host, port);
buf.extend_from_slice(b"Proxy-Authorization: "); buf.extend_from_slice(b"Proxy-Authorization: ");
buf.extend_from_slice(value.as_bytes()); buf.extend_from_slice(value.as_bytes());
@@ -348,7 +429,9 @@ enum TunnelState {
#[cfg(feature = "tls")] #[cfg(feature = "tls")]
impl<T> Future for Tunnel<T> impl<T> Future for Tunnel<T>
where T: AsyncRead + AsyncWrite { where
T: AsyncRead + AsyncWrite,
{
type Item = T; type Item = T;
type Error = io::Error; type Error = io::Error;
@@ -527,6 +610,72 @@ mod native_tls_async {
} }
} }
#[cfg(feature = "socks")]
mod socks {
use std::io;
use futures::{Future, future};
use hyper::client::connect::{Connected, Destination};
use socks::Socks5Stream;
use std::net::ToSocketAddrs;
use tokio::{net::TcpStream, reactor};
use super::{Connecting};
use proxy::{ProxyScheme};
pub(super) enum DnsResolve {
Local,
Proxy,
}
pub(super) fn connect(
proxy: ProxyScheme,
dst: Destination,
dns: DnsResolve,
) -> Connecting {
let https = dst.scheme() == "https";
let original_host = dst.host().to_owned();
let mut host = original_host.clone();
let port = dst.port().unwrap_or_else(|| {
if https { 443 } else { 80 }
});
if let DnsResolve::Local = dns {
let maybe_new_target = match (host.as_str(), port).to_socket_addrs() {
Ok(mut iter) => iter.next(),
Err(err) => {
return Box::new(future::err(err));
}
};
if let Some(new_target) = maybe_new_target {
host = new_target.ip().to_string();
}
}
let (socket_addr, auth) = match proxy {
ProxyScheme::Socks5 { addr, auth, .. } => (addr, auth),
_ => unreachable!(),
};
// Get a Tokio TcpStream
let stream = future::result(if let Some((username, password)) = auth {
Socks5Stream::connect_with_password(
socket_addr, (host.as_str(), port), &username, &password
)
} else {
Socks5Stream::connect(socket_addr, (host.as_str(), port))
}.and_then(|s| {
TcpStream::from_std(s.into_inner(), &reactor::Handle::default())
.map_err(|e| io::Error::new(io::ErrorKind::Other, e))
}));
Box::new(
stream.map(|s| (Box::new(s) as super::Conn, Connected::new()))
)
}
}
#[cfg(feature = "tls")] #[cfg(feature = "tls")]
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
@@ -652,7 +801,7 @@ mod tests {
let host = addr.ip().to_string(); let host = addr.ip().to_string();
let port = addr.port(); let port = addr.port();
let work = work.and_then(|tcp| { let work = work.and_then(|tcp| {
tunnel(tcp, host, port, Some(proxy::Auth::basic("Aladdin", "open sesame"))) tunnel(tcp, host, port, Some(proxy::encode_basic_auth("Aladdin", "open sesame")))
}); });
rt.block_on(work).unwrap(); rt.block_on(work).unwrap();

View File

@@ -149,7 +149,8 @@ impl Error {
Kind::TooManyRedirects | Kind::TooManyRedirects |
Kind::RedirectLoop | Kind::RedirectLoop |
Kind::ClientError(_) | Kind::ClientError(_) |
Kind::ServerError(_) => None, Kind::ServerError(_) |
Kind::UnknownProxyScheme => None,
} }
} }
@@ -273,6 +274,7 @@ impl fmt::Display for Error {
f.write_str("Server Error: ")?; f.write_str("Server Error: ")?;
fmt::Display::fmt(code, f) fmt::Display::fmt(code, f)
} }
Kind::UnknownProxyScheme => f.write_str("Unknown proxy scheme"),
} }
} }
} }
@@ -300,6 +302,7 @@ impl StdError for Error {
Kind::RedirectLoop => "Infinite redirect loop", Kind::RedirectLoop => "Infinite redirect loop",
Kind::ClientError(_) => "Client Error", Kind::ClientError(_) => "Client Error",
Kind::ServerError(_) => "Server Error", Kind::ServerError(_) => "Server Error",
Kind::UnknownProxyScheme => "Unknown proxy scheme",
} }
} }
@@ -325,7 +328,8 @@ impl StdError for Error {
Kind::TooManyRedirects | Kind::TooManyRedirects |
Kind::RedirectLoop | Kind::RedirectLoop |
Kind::ClientError(_) | Kind::ClientError(_) |
Kind::ServerError(_) => None, Kind::ServerError(_) |
Kind::UnknownProxyScheme => None,
} }
} }
} }
@@ -352,6 +356,7 @@ pub(crate) enum Kind {
RedirectLoop, RedirectLoop,
ClientError(StatusCode), ClientError(StatusCode),
ServerError(StatusCode), ServerError(StatusCode),
UnknownProxyScheme,
} }
@@ -517,6 +522,10 @@ pub(crate) fn dns_system_conf(io: io::Error) -> Error {
Error::new(Kind::DnsSystemConf(io), None) Error::new(Kind::DnsSystemConf(io), None)
} }
pub(crate) fn unknown_proxy_scheme() -> Error {
Error::new(Kind::UnknownProxyScheme, None)
}
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;

View File

@@ -203,6 +203,8 @@ extern crate tokio_timer;
extern crate trust_dns_resolver; extern crate trust_dns_resolver;
extern crate url; extern crate url;
extern crate uuid; extern crate uuid;
#[cfg(feature = "socks")]
extern crate socks;
#[cfg(feature = "rustls-tls")] #[cfg(feature = "rustls-tls")]
extern crate hyper_rustls; extern crate hyper_rustls;

View File

@@ -1,9 +1,12 @@
use std::fmt; use std::fmt;
use std::sync::Arc; use std::sync::Arc;
#[cfg(feature = "socks")]
use std::net::{SocketAddr, ToSocketAddrs};
use http::{header::HeaderValue, Uri}; use http::{header::HeaderValue, Uri};
use hyper::client::connect::Destination; use hyper::client::connect::Destination;
use {into_url, IntoUrl, Url}; use url::percent_encoding::percent_decode;
use {IntoUrl, Url};
/// Configuration of a proxy that a `Client` should pass requests to. /// Configuration of a proxy that a `Client` should pass requests to.
/// ///
@@ -31,13 +34,43 @@ use {into_url, IntoUrl, Url};
/// would prevent a `Proxy` later in the list from ever working, so take care. /// would prevent a `Proxy` later in the list from ever working, so take care.
#[derive(Clone, Debug)] #[derive(Clone, Debug)]
pub struct Proxy { pub struct Proxy {
auth: Option<Auth>,
intercept: Intercept, intercept: Intercept,
} }
/// A particular scheme used for proxying requests.
///
/// For example, HTTP vs SOCKS5
#[derive(Clone, Debug)] #[derive(Clone, Debug)]
pub(crate) enum Auth { pub enum ProxyScheme {
Basic(HeaderValue), Http {
auth: Option<HeaderValue>,
uri: ::hyper::Uri,
},
#[cfg(feature = "socks")]
Socks5 {
addr: SocketAddr,
auth: Option<(String, String)>,
remote_dns: bool,
},
}
/// Trait used for converting into a proxy scheme. This trait supports
/// parsing from a URL-like type, whilst also supporting proxy schemes
/// built directly using the factory methods.
pub trait IntoProxyScheme {
fn into_proxy_scheme(self) -> ::Result<ProxyScheme>;
}
impl<T: IntoUrl> IntoProxyScheme for T {
fn into_proxy_scheme(self) -> ::Result<ProxyScheme> {
ProxyScheme::parse(self.into_url()?)
}
}
impl IntoProxyScheme for ProxyScheme {
fn into_proxy_scheme(self) -> ::Result<ProxyScheme> {
Ok(self)
}
} }
impl Proxy { impl Proxy {
@@ -55,9 +88,10 @@ impl Proxy {
/// # } /// # }
/// # fn main() {} /// # fn main() {}
/// ``` /// ```
pub fn http<U: IntoUrl>(url: U) -> ::Result<Proxy> { pub fn http<U: IntoProxyScheme>(proxy_scheme: U) -> ::Result<Proxy> {
let uri = ::into_url::expect_uri(&url.into_url()?); Ok(Proxy::new(Intercept::Http(
Ok(Proxy::new(Intercept::Http(uri))) proxy_scheme.into_proxy_scheme()?
)))
} }
/// Proxy all HTTPS traffic to the passed URL. /// Proxy all HTTPS traffic to the passed URL.
@@ -74,9 +108,10 @@ impl Proxy {
/// # } /// # }
/// # fn main() {} /// # fn main() {}
/// ``` /// ```
pub fn https<U: IntoUrl>(url: U) -> ::Result<Proxy> { pub fn https<U: IntoProxyScheme>(proxy_scheme: U) -> ::Result<Proxy> {
let uri = ::into_url::expect_uri(&url.into_url()?); Ok(Proxy::new(Intercept::Https(
Ok(Proxy::new(Intercept::Https(uri))) proxy_scheme.into_proxy_scheme()?
)))
} }
/// Proxy **all** traffic to the passed URL. /// Proxy **all** traffic to the passed URL.
@@ -93,9 +128,10 @@ impl Proxy {
/// # } /// # }
/// # fn main() {} /// # fn main() {}
/// ``` /// ```
pub fn all<U: IntoUrl>(url: U) -> ::Result<Proxy> { pub fn all<U: IntoProxyScheme>(proxy_scheme: U) -> ::Result<Proxy> {
let uri = ::into_url::expect_uri(&url.into_url()?); Ok(Proxy::new(Intercept::All(
Ok(Proxy::new(Intercept::All(uri))) proxy_scheme.into_proxy_scheme()?
)))
} }
/// Provide a custom function to determine what traffix to proxy to where. /// Provide a custom function to determine what traffix to proxy to where.
@@ -118,9 +154,14 @@ impl Proxy {
/// # Ok(()) /// # Ok(())
/// # } /// # }
/// # fn main() {} /// # fn main() {}
pub fn custom<F>(fun: F) -> Proxy pub fn custom<F, U: IntoProxyScheme>(fun: F) -> Proxy
where F: Fn(&Url) -> Option<Url> + Send + Sync + 'static { where F: Fn(&Url) -> Option<U> + Send + Sync + 'static {
Proxy::new(Intercept::Custom(Custom(Arc::new(fun)))) Proxy::new(Intercept::Custom(Custom {
auth: None,
func: Arc::new(move |url| {
fun(url).map(IntoProxyScheme::into_proxy_scheme)
}),
}))
} }
/* /*
@@ -131,7 +172,6 @@ impl Proxy {
fn new(intercept: Intercept) -> Proxy { fn new(intercept: Intercept) -> Proxy {
Proxy { Proxy {
auth: None,
intercept, intercept,
} }
} }
@@ -150,28 +190,36 @@ impl Proxy {
/// # fn main() {} /// # fn main() {}
/// ``` /// ```
pub fn basic_auth(mut self, username: &str, password: &str) -> Proxy { pub fn basic_auth(mut self, username: &str, password: &str) -> Proxy {
self.auth = Some(Auth::basic(username, password)); self.intercept.set_basic_auth(username, password);
self self
} }
pub(crate) fn auth(&self) -> Option<&Auth> {
self.auth.as_ref()
}
pub(crate) fn maybe_has_http_auth(&self) -> bool { pub(crate) fn maybe_has_http_auth(&self) -> bool {
match self.auth { match self.intercept {
Some(Auth::Basic(_)) => match self.intercept { Intercept::All(ProxyScheme::Http { auth: Some(..), .. }) |
Intercept::All(_) | Intercept::Http(ProxyScheme::Http { auth: Some(..), .. }) |
Intercept::Http(_) |
// Custom *may* match 'http', so assume so. // Custom *may* match 'http', so assume so.
Intercept::Custom(_) => true, Intercept::Custom(_) => true,
Intercept::Https(_) => false, _ => false,
},
None => false,
} }
} }
pub(crate) fn intercept<D: Dst>(&self, uri: &D) -> Option<::hyper::Uri> { pub(crate) fn http_basic_auth<D: Dst>(&self, uri: &D) -> Option<HeaderValue> {
match self.intercept {
Intercept::All(ProxyScheme::Http { ref auth, .. }) |
Intercept::Http(ProxyScheme::Http { ref auth, .. }) => auth.clone(),
Intercept::Custom(ref custom) => {
custom.call(uri).and_then(|scheme| match scheme {
ProxyScheme::Http { auth, .. } => auth,
#[cfg(feature = "socks")]
_ => None,
})
}
_ => None,
}
}
pub(crate) fn intercept<D: Dst>(&self, uri: &D) -> Option<ProxyScheme> {
match self.intercept { match self.intercept {
Intercept::All(ref u) => Some(u.clone()), Intercept::All(ref u) => Some(u.clone()),
Intercept::Http(ref u) => { Intercept::Http(ref u) => {
@@ -188,20 +236,7 @@ impl Proxy {
None None
} }
}, },
Intercept::Custom(ref fun) => { Intercept::Custom(ref custom) => custom.call(uri),
(fun.0)(
&format!(
"{}://{}{}{}",
uri.scheme(),
uri.host(),
uri.port().map(|_| ":").unwrap_or(""),
uri.port().map(|p| p.to_string()).unwrap_or(String::new())
)
.parse()
.expect("should be valid Url")
)
.map(|u| into_url::expect_uri(&u) )
},
} }
} }
@@ -214,9 +249,142 @@ impl Proxy {
Intercept::Https(_) => { Intercept::Https(_) => {
uri.scheme() == "https" uri.scheme() == "https"
}, },
Intercept::Custom(ref fun) => { Intercept::Custom(ref custom) => custom.call(uri).is_some(),
(fun.0)( }
&format!( }
}
impl ProxyScheme {
// To start conservative, keep builders private for now.
/// Proxy traffic via the specified URL over HTTP
fn http<T: IntoUrl>(url: T) -> ::Result<Self> {
Ok(ProxyScheme::Http {
auth: None,
uri: ::into_url::expect_uri(&url.into_url()?),
})
}
/// Proxy traffic via the specified socket address over SOCKS5
///
/// # Note
///
/// Current SOCKS5 support is provided via blocking IO.
#[cfg(feature = "socks")]
fn socks5(addr: SocketAddr) -> ::Result<Self> {
Ok(ProxyScheme::Socks5 {
addr,
auth: None,
remote_dns: false,
})
}
/// Proxy traffic via the specified socket address over SOCKS5H
///
/// This differs from SOCKS5 in that DNS resolution is also performed via the proxy.
///
/// # Note
///
/// Current SOCKS5 support is provided via blocking IO.
#[cfg(feature = "socks")]
fn socks5h(addr: SocketAddr) -> ::Result<Self> {
Ok(ProxyScheme::Socks5 {
addr,
auth: None,
remote_dns: true,
})
}
/// Use a username and password when connecting to the proxy server
fn with_basic_auth<T: Into<String>, U: Into<String>>(mut self, username: T, password: U) -> Self {
self.set_basic_auth(username, password);
self
}
fn set_basic_auth<T: Into<String>, U: Into<String>>(&mut self, username: T, password: U) {
match *self {
ProxyScheme::Http { ref mut auth, .. } => {
let header = encode_basic_auth(&username.into(), &password.into());
*auth = Some(header);
},
#[cfg(feature = "socks")]
ProxyScheme::Socks5 { ref mut auth, .. } => {
*auth = Some((username.into(), password.into()));
}
}
}
/// Convert a URL into a proxy scheme
///
/// Supported schemes: HTTP, HTTPS, (SOCKS5, SOCKS5H if `socks` feature is enabled).
// Private for now...
fn parse(url: Url) -> ::Result<Self> {
// Resolve URL to a host and port
#[cfg(feature = "socks")]
let to_addr = || {
let host_and_port = try_!(url.with_default_port(|url| match url.scheme() {
"socks5" | "socks5h" => Ok(1080),
_ => Err(())
}));
let mut addr = try_!(host_and_port.to_socket_addrs());
addr
.next()
.ok_or_else(::error::unknown_proxy_scheme)
};
let mut scheme = match url.scheme() {
"http" | "https" => Self::http(url.clone())?,
#[cfg(feature = "socks")]
"socks5" => Self::socks5(to_addr()?)?,
#[cfg(feature = "socks")]
"socks5h" => Self::socks5h(to_addr()?)?,
_ => return Err(::error::unknown_proxy_scheme())
};
if let Some(pwd) = url.password() {
let decoded_username = percent_decode(url.username().as_bytes()).decode_utf8_lossy();
let decoded_password = percent_decode(pwd.as_bytes()).decode_utf8_lossy();
scheme = scheme.with_basic_auth(decoded_username, decoded_password);
}
Ok(scheme)
}
}
#[derive(Clone, Debug)]
enum Intercept {
All(ProxyScheme),
Http(ProxyScheme),
Https(ProxyScheme),
Custom(Custom),
}
impl Intercept {
fn set_basic_auth(&mut self, username: &str, password: &str) {
match self {
Intercept::All(ref mut s) |
Intercept::Http(ref mut s) |
Intercept::Https(ref mut s) => s.set_basic_auth(username, password),
Intercept::Custom(ref mut custom) => {
let header = encode_basic_auth(username, password);
custom.auth = Some(header);
}
}
}
}
#[derive(Clone)]
struct Custom {
// This auth only applies if the returned ProxyScheme doesn't have an auth...
auth: Option<HeaderValue>,
func: Arc<Fn(&Url) -> Option<::Result<ProxyScheme>> + Send + Sync + 'static>,
}
impl Custom {
fn call<D: Dst>(&self, uri: &D) -> Option<ProxyScheme> {
let url = format!(
"{}://{}{}{}", "{}://{}{}{}",
uri.scheme(), uri.scheme(),
uri.host(), uri.host(),
@@ -224,30 +392,42 @@ impl Proxy {
uri.port().map(|p| p.to_string()).unwrap_or(String::new()) uri.port().map(|p| p.to_string()).unwrap_or(String::new())
) )
.parse() .parse()
.expect("should be valid Url") .expect("should be valid Url");
).is_some()
(self.func)(&url)
.and_then(|result| result.ok())
.map(|scheme| match scheme {
ProxyScheme::Http { auth, uri } => {
if auth.is_some() {
ProxyScheme::Http { auth, uri }
} else {
ProxyScheme::Http {
auth: self.auth.clone(),
uri,
}
}
}, },
} #[cfg(feature = "socks")]
socks => socks,
})
} }
} }
#[derive(Clone, Debug)]
enum Intercept {
All(::hyper::Uri),
Http(::hyper::Uri),
Https(::hyper::Uri),
Custom(Custom),
}
#[derive(Clone)]
struct Custom(Arc<Fn(&Url) -> Option<Url> + Send + Sync + 'static>);
impl fmt::Debug for Custom { impl fmt::Debug for Custom {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("_") f.write_str("_")
} }
} }
pub(crate) fn encode_basic_auth(username: &str, password: &str) -> HeaderValue {
let val = format!("{}:{}", username, password);
let mut header = format!("Basic {}", base64::encode(&val))
.parse::<HeaderValue>()
.expect("base64 is always valid HeaderValue");
header.set_sensitive(true);
header
}
/// A helper trait to allow testing `Proxy::intercept` without having to /// A helper trait to allow testing `Proxy::intercept` without having to
/// construct `hyper::client::connect::Destination`s. /// construct `hyper::client::connect::Destination`s.
pub(crate) trait Dst { pub(crate) trait Dst {
@@ -289,17 +469,6 @@ impl Dst for Uri {
} }
} }
impl Auth {
pub(crate) fn basic(username: &str, password: &str) -> Auth {
let val = format!("{}:{}", username, password);
let mut header = format!("Basic {}", base64::encode(&val))
.parse::<HeaderValue>()
.expect("base64 is always valid HeaderValue");
header.set_sensitive(true);
Auth::Basic(header)
}
}
#[cfg(test)] #[cfg(test)]
mod tests { mod tests {
use super::*; use super::*;
@@ -323,6 +492,15 @@ mod tests {
s.parse().unwrap() s.parse().unwrap()
} }
fn intercepted_uri(p: &Proxy, s: &str) -> Uri {
match p.intercept(&url(s)).unwrap() {
ProxyScheme::Http { uri, .. } => uri,
#[cfg(feature = "socks")]
_ => panic!("intercepted as socks"),
}
}
#[test] #[test]
fn test_http() { fn test_http() {
let target = "http://example.domain/"; let target = "http://example.domain/";
@@ -331,7 +509,7 @@ mod tests {
let http = "http://hyper.rs"; let http = "http://hyper.rs";
let other = "https://hyper.rs"; let other = "https://hyper.rs";
assert_eq!(p.intercept(&url(http)).unwrap(), target); assert_eq!(intercepted_uri(&p, http), target);
assert!(p.intercept(&url(other)).is_none()); assert!(p.intercept(&url(other)).is_none());
} }
@@ -344,7 +522,7 @@ mod tests {
let other = "https://hyper.rs"; let other = "https://hyper.rs";
assert!(p.intercept(&url(http)).is_none()); assert!(p.intercept(&url(http)).is_none());
assert_eq!(p.intercept(&url(other)).unwrap(), target); assert_eq!(intercepted_uri(&p, other), target);
} }
#[test] #[test]
@@ -356,9 +534,9 @@ mod tests {
let https = "https://hyper.rs"; let https = "https://hyper.rs";
let other = "x-youve-never-heard-of-me-mr-proxy://hyper.rs"; let other = "x-youve-never-heard-of-me-mr-proxy://hyper.rs";
assert_eq!(p.intercept(&url(http)).unwrap(), target); assert_eq!(intercepted_uri(&p, http), target);
assert_eq!(p.intercept(&url(https)).unwrap(), target); assert_eq!(intercepted_uri(&p, https), target);
assert_eq!(p.intercept(&url(other)).unwrap(), target); assert_eq!(intercepted_uri(&p, other), target);
} }
@@ -372,7 +550,7 @@ mod tests {
} else if url.scheme() == "http" { } else if url.scheme() == "http" {
target2.parse().ok() target2.parse().ok()
} else { } else {
None None::<Url>
} }
}); });
@@ -380,9 +558,8 @@ mod tests {
let https = "https://hyper.rs"; let https = "https://hyper.rs";
let other = "x-youve-never-heard-of-me-mr-proxy://seanmonstar.com"; let other = "x-youve-never-heard-of-me-mr-proxy://seanmonstar.com";
assert_eq!(p.intercept(&url(http)).unwrap(), target2); assert_eq!(intercepted_uri(&p, http), target2);
assert_eq!(p.intercept(&url(https)).unwrap(), target1); assert_eq!(intercepted_uri(&p, https), target1);
assert!(p.intercept(&url(other)).is_none()); assert!(p.intercept(&url(other)).is_none());
} }
} }

View File

@@ -77,3 +77,41 @@ fn http_proxy_basic_auth() {
assert_eq!(res.status(), reqwest::StatusCode::OK); assert_eq!(res.status(), reqwest::StatusCode::OK);
assert_eq!(res.headers().get(reqwest::header::SERVER).unwrap(), &"proxied"); assert_eq!(res.headers().get(reqwest::header::SERVER).unwrap(), &"proxied");
} }
#[test]
fn http_proxy_basic_auth_parsed() {
let server = server! {
request: b"\
GET http://hyper.rs/prox HTTP/1.1\r\n\
user-agent: $USERAGENT\r\n\
accept: */*\r\n\
accept-encoding: gzip\r\n\
proxy-authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==\r\n\
host: hyper.rs\r\n\
\r\n\
",
response: b"\
HTTP/1.1 200 OK\r\n\
Server: proxied\r\n\
Content-Length: 0\r\n\
\r\n\
"
};
let proxy = format!("http://Aladdin:open sesame@{}", server.addr());
let url = "http://hyper.rs/prox";
let res = reqwest::Client::builder()
.proxy(
reqwest::Proxy::http(&proxy).unwrap()
)
.build()
.unwrap()
.get(url)
.send()
.unwrap();
assert_eq!(res.url().as_str(), url);
assert_eq!(res.status(), reqwest::StatusCode::OK);
assert_eq!(res.headers().get(reqwest::header::SERVER).unwrap(), &"proxied");
}