12 releases (breaking)

0.9.1 Mar 27, 2021
0.8.0 Sep 26, 2020
0.7.0 May 16, 2020
0.6.0 Dec 19, 2019
0.4.0 Dec 21, 2017

#180 in HTTP client

Download history 34254/week @ 2024-07-22 31810/week @ 2024-07-29 32872/week @ 2024-08-05 31448/week @ 2024-08-12 30972/week @ 2024-08-19 33990/week @ 2024-08-26 29543/week @ 2024-09-02 29566/week @ 2024-09-09 19211/week @ 2024-09-16 27244/week @ 2024-09-23 28033/week @ 2024-09-30 28496/week @ 2024-10-07 33482/week @ 2024-10-14 33460/week @ 2024-10-21 34594/week @ 2024-10-28 34670/week @ 2024-11-04

137,472 downloads per month
Used in 136 crates (25 directly)

MIT license

35KB
656 lines

hyper-proxy

Travis Build Status MIT licensed

A proxy connector for hyper based applications.

Documentation

Example

use hyper::{Client, Request, Uri};
use hyper::client::HttpConnector;
use futures::{TryFutureExt, TryStreamExt};
use hyper_proxy::{Proxy, ProxyConnector, Intercept};
use headers::Authorization;
use std::error::Error;

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
    let proxy = {
        let proxy_uri = "http://my-proxy:8080".parse().unwrap();
        let mut proxy = Proxy::new(Intercept::All, proxy_uri);
        proxy.set_authorization(Authorization::basic("John Doe", "Agent1234"));
        let connector = HttpConnector::new();
        let proxy_connector = ProxyConnector::from_proxy(connector, proxy).unwrap();
        proxy_connector
    };

    // Connecting to http will trigger regular GETs and POSTs.
    // We need to manually append the relevant headers to the request
    let uri: Uri = "http://my-remote-website.com".parse().unwrap();
    let mut req = Request::get(uri.clone()).body(hyper::Body::empty()).unwrap();

    if let Some(headers) = proxy.http_headers(&uri) {
        req.headers_mut().extend(headers.clone().into_iter());
    }

    let client = Client::builder().build(proxy);
    let fut_http = client.request(req)
        .and_then(|res| res.into_body().map_ok(|x|x.to_vec()).try_concat())
        .map_ok(move |body| ::std::str::from_utf8(&body).unwrap().to_string());

    // Connecting to an https uri is straightforward (uses 'CONNECT' method underneath)
    let uri = "https://my-remote-websitei-secured.com".parse().unwrap();
    let fut_https = client.get(uri)
        .and_then(|res| res.into_body().map_ok(|x|x.to_vec()).try_concat())
        .map_ok(move |body| ::std::str::from_utf8(&body).unwrap().to_string());

    let (http_res, https_res) = futures::future::join(fut_http, fut_https).await;
    let (_, _) = (http_res?, https_res?);

    Ok(())
}

Features

hyper-proxy exposes three main Cargo features, to configure which TLS implementation it uses to connect to a proxy. It can also be configured without TLS support, by compiling without default features entirely. The supported list of configurations is:

  1. No TLS support (default-features = false)
  2. TLS support via native-tls to link against the operating system's native TLS implementation (default)
  3. TLS support via rustls (default-features = false, features = ["rustls"])
  4. TLS support via rustls, using a statically-compiled set of CA certificates to bypass the operating system's default store (default-features = false, features = ["rustls-webpki"])

Credits

Large part of the code comes from reqwest. The core part as just been extracted and slightly enhanced.

Main changes are:

  • support for authentication
  • add non secured tunneling
  • add the possibility to add additional headers when connecting to the proxy

Dependencies

~5–19MB
~271K SLoC