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

Proxy headers #688

Merged
merged 4 commits into from
Feb 9, 2025
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,8 @@ Options:
HTTP method [default: GET]
-H <HEADERS>
Custom HTTP header. Examples: -H "foo: bar"
--proxy-header <PROXY_HEADERS>
Custom Proxy HTTP header. Examples: --proxy-header "foo: bar"
-t <TIMEOUT>
Timeout for each request. Default to infinite.
-A <ACCEPT_HEADER>
Expand Down
53 changes: 37 additions & 16 deletions src/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,7 @@ pub struct Client {
pub url_generator: UrlGenerator,
pub method: http::Method,
pub headers: http::header::HeaderMap,
pub proxy_headers: http::header::HeaderMap,
pub body: Option<&'static [u8]>,
pub dns: Dns,
pub timeout: Option<std::time::Duration>,
Expand Down Expand Up @@ -494,14 +495,21 @@ impl Client {
let (dns_lookup, stream) = self.client(proxy_url, rng, self.is_proxy_http2()).await?;
if url.scheme() == "https" {
// Do CONNECT request to proxy
let req = http::Request::builder()
.method(Method::CONNECT)
.uri(format!(
"{}:{}",
url.host_str().unwrap(),
url.port_or_known_default().unwrap()
))
.body(http_body_util::Full::default())?;
let req = {
let mut builder =
http::Request::builder()
.method(Method::CONNECT)
.uri(format!(
"{}:{}",
url.host_str().unwrap(),
url.port_or_known_default().unwrap()
));
*builder
.headers_mut()
.ok_or(ClientError::GetHeaderFromBuilderError)? =
self.proxy_headers.clone();
builder.body(http_body_util::Full::default())?
};
let res = if self.proxy_http_version == http::Version::HTTP_2 {
let mut send_request = stream.handshake_http2().await?;
send_request.send_request(req).await?
Expand Down Expand Up @@ -557,6 +565,12 @@ impl Client {
aws_config.sign_request(self.method.as_str(), &mut headers, url, bytes)?
}

if use_proxy {
for (key, value) in self.proxy_headers.iter() {
headers.insert(key, value.clone());
}
}

*builder
.headers_mut()
.ok_or(ClientError::GetHeaderFromBuilderError)? = headers;
Expand Down Expand Up @@ -670,14 +684,21 @@ impl Client {
if let Some(proxy_url) = &self.proxy_url {
let (dns_lookup, stream) = self.client(proxy_url, rng, self.is_proxy_http2()).await?;
if url.scheme() == "https" {
let req = http::Request::builder()
.method(Method::CONNECT)
.uri(format!(
"{}:{}",
url.host_str().unwrap(),
url.port_or_known_default().unwrap()
))
.body(http_body_util::Full::default())?;
let req = {
let mut builder =
http::Request::builder()
.method(Method::CONNECT)
.uri(format!(
"{}:{}",
url.host_str().unwrap(),
url.port_or_known_default().unwrap()
));
*builder
.headers_mut()
.ok_or(ClientError::GetHeaderFromBuilderError)? =
self.proxy_headers.clone();
builder.body(http_body_util::Full::default())?
};
let res = if self.proxy_http_version == http::Version::HTTP_2 {
let mut send_request = stream.handshake_http2().await?;
send_request.send_request(req).await?
Expand Down
1 change: 1 addition & 0 deletions src/db.rs
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ mod test_db {
url_generator: UrlGenerator::new_static("http://example.com".parse().unwrap()),
method: Method::GET,
headers: HeaderMap::new(),
proxy_headers: HeaderMap::new(),
body: None,
dns: Dns {
resolver: hickory_resolver::AsyncResolver::tokio_from_system_conf().unwrap(),
Expand Down
38 changes: 28 additions & 10 deletions src/main.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@ use clap::Parser;
use crossterm::tty::IsTty;
use hickory_resolver::config::{ResolverConfig, ResolverOpts};
use humantime::Duration;
use hyper::http::{
self,
header::{HeaderName, HeaderValue},
use hyper::{
http::{
self,
header::{HeaderName, HeaderValue},
},
HeaderMap,
};
use printer::{PrintConfig, PrintMode};
use rand_regex::Regex;
Expand Down Expand Up @@ -143,6 +146,11 @@ Note: If qps is specified, burst will be ignored",
method: http::Method,
#[arg(help = "Custom HTTP header. Examples: -H \"foo: bar\"", short = 'H')]
headers: Vec<String>,
#[arg(
help = "Custom Proxy HTTP header. Examples: --proxy-header \"foo: bar\"",
long = "proxy-header"
)]
proxy_headers: Vec<String>,
#[arg(help = "Timeout for each request. Default to infinite.", short = 't')]
timeout: Option<humantime::Duration>,
#[arg(help = "HTTP Accept Header.", short = 'A')]
Expand Down Expand Up @@ -501,13 +509,7 @@ async fn run() -> anyhow::Result<()> {
for (k, v) in opts
.headers
.into_iter()
.map(|s| {
let header = s.splitn(2, ':').collect::<Vec<_>>();
anyhow::ensure!(header.len() == 2, anyhow::anyhow!("Parse header"));
let name = HeaderName::from_str(header[0])?;
let value = HeaderValue::from_str(header[1].trim_start_matches(' '))?;
Ok::<(HeaderName, HeaderValue), anyhow::Error>((name, value))
})
.map(|s| parse_header(s.as_str()))
.collect::<anyhow::Result<Vec<_>>>()?
{
headers.insert(k, v);
Expand All @@ -516,6 +518,13 @@ async fn run() -> anyhow::Result<()> {
headers
};

let proxy_headers = {
opts.proxy_headers
.into_iter()
.map(|s| parse_header(s.as_str()))
.collect::<anyhow::Result<HeaderMap<_>>>()?
};

let body: Option<&'static [u8]> = match (opts.body_string, opts.body_path) {
(Some(body), _) => Some(Box::leak(body.into_boxed_str().into_boxed_bytes())),
(_, Some(path)) => {
Expand Down Expand Up @@ -550,6 +559,7 @@ async fn run() -> anyhow::Result<()> {
url_generator,
method: opts.method,
headers,
proxy_headers,
body,
dns: client::Dns {
resolver,
Expand Down Expand Up @@ -946,3 +956,11 @@ impl Opts {
}
}
}

fn parse_header(s: &str) -> Result<(HeaderName, HeaderValue), anyhow::Error> {
let header = s.splitn(2, ':').collect::<Vec<_>>();
anyhow::ensure!(header.len() == 2, anyhow::anyhow!("Parse header"));
let name = HeaderName::from_str(header[0])?;
let value = HeaderValue::from_str(header[1].trim_start_matches(' '))?;
Ok::<(HeaderName, HeaderValue), anyhow::Error>((name, value))
}
47 changes: 28 additions & 19 deletions tests/tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -755,22 +755,31 @@ where

let proxy = proxy.clone();
let service = service.clone();

let outer = service_fn(move |req| {
// Test --proxy-header option
assert_eq!(
req.headers()
.get("proxy-authorization")
.unwrap()
.to_str()
.unwrap(),
"test"
);

MitmProxy::wrap_service(proxy.clone(), service.clone()).call(req)
});

tokio::spawn(async move {
if http2 {
let _ = hyper::server::conn::http2::Builder::new(TokioExecutor::new())
.serve_connection(
TokioIo::new(stream),
MitmProxy::wrap_service(proxy, service),
)
.serve_connection(TokioIo::new(stream), outer)
.await;
} else {
let _ = hyper::server::conn::http1::Builder::new()
.preserve_header_case(true)
.title_case_headers(true)
.serve_connection(
TokioIo::new(stream),
MitmProxy::wrap_service(proxy, service),
)
.serve_connection(TokioIo::new(stream), outer)
.with_upgrades()
.await;
}
Expand Down Expand Up @@ -800,6 +809,7 @@ async fn test_proxy_with_setting(https: bool, http2: bool, proxy_http2: bool) {
let scheme = if https { "https" } else { "http" };
proc.args(["--no-tui", "--debug", "--insecure", "-x"])
.arg(format!("http://127.0.0.1:{proxy_port}/"))
.args(["--proxy-header", "proxy-authorization: test"])
.arg(format!("{scheme}://example.com/"));
if http2 {
proc.arg("--http2");
Expand All @@ -808,18 +818,17 @@ async fn test_proxy_with_setting(https: bool, http2: bool, proxy_http2: bool) {
proc.arg("--proxy-http2");
}

// When std::process::Stdio::piped() is used, the wait_with_output() method will hang in Windows.
proc.stdin(std::process::Stdio::null())
.stdout(std::process::Stdio::piped())
.stderr(std::process::Stdio::null());
let stdout = proc
.spawn()
.unwrap()
.wait_with_output()
.await
.unwrap()
.stdout;

assert!(String::from_utf8(stdout).unwrap().contains("Hello World"),);
.stdout(std::process::Stdio::inherit())
.stderr(std::process::Stdio::inherit());
// So, we test status code only for now.
assert!(proc.status().await.unwrap().success());
/*
let outputs = proc.spawn().unwrap().wait_with_output().await.unwrap();
let stdout = String::from_utf8(outputs.stdout).unwrap();
assert!(stdout.contains("Hello World"),);
*/
}

#[tokio::test]
Expand Down