feat: Proxy Support

Add support to specify an https or socks5 proxy for the network
requests.

Author: LeanderBB

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "proton-api-rs"
 authors = ["Leander Beernaert <lbb-dev@pm.me>"]
-version = "0.1.4"
+version = "0.2.0"
 edition = "2021"
 license = "AGPL-3.0-only"
 description = "Unofficial implemention of proton REST API in rust"
@@ -28,7 +28,7 @@ log = "0.4"
 [dependencies.reqwest]
 version = "0.11"
 default-features = false
-features = ["json", "deflate", "stream", "cookies", "multipart", "rustls","rustls-tls"]
+features = ["json", "deflate", "stream", "cookies", "multipart", "rustls","rustls-tls", "socks"]
 
 [target.'cfg(not(any(target_arch = "wasm32", target_arch = "wasm64")))'.dependencies]
 tokio = {version ="1", features = ["full"]}

src/client/client_builder.rs

@@ -3,9 +3,10 @@ use crate::client::types::{
     FIDO2Auth, TFAAuth, TFAStatus, UserAuth,
 };
 use crate::client::{HttpClientBuilder, X_PM_UID_HEADER};
-use crate::domain::UserUid;
+use crate::domain::{SecretString, UserUid};
 use crate::{impl_error_conversion, Client, RequestError};
 use go_srp::SRPAuth;
+use secrecy::ExposeSecret;
 use std::time::Duration;
 use thiserror::Error;
 
@@ -47,6 +48,43 @@ impl Default for ClientBuilder {
     }
 }
 
+#[derive(Debug, Copy, Clone, Eq, PartialEq)]
+pub enum ProxyProtocol {
+    Https,
+    Socks5,
+}
+
+#[derive(Debug, Clone)]
+pub struct ProxyAuth {
+    pub username: String,
+    pub password: SecretString,
+}
+
+#[derive(Debug, Clone)]
+pub struct Proxy {
+    pub protocol: ProxyProtocol,
+    pub auth: Option<ProxyAuth>,
+    pub url: String,
+    pub port: u16,
+}
+
+impl Proxy {
+    pub fn as_url(&self) -> String {
+        let protocol = match self.protocol {
+            ProxyProtocol::Https => "https",
+            ProxyProtocol::Socks5 => "socks5",
+        };
+
+        let auth = if let Some(auth) = &self.auth {
+            format!("{}:{}", auth.username, auth.password.expose_secret())
+        } else {
+            String::new()
+        };
+
+        format!("{protocol}://{auth}@{}:{}", self.url, self.port)
+    }
+}
+
 impl ClientBuilder {
     pub fn new() -> Self {
         Self(Default::default())
@@ -77,6 +115,12 @@ impl ClientBuilder {
         self
     }
 
+    /// Set the proxy for this client. By default no proxy is used
+    pub fn with_proxy(mut self, proxy: Proxy) -> Self {
+        self.0 = self.0.with_proxy(proxy);
+        self
+    }
+
     /// Login into a proton account and start a new session.
     /// Note: At the moment we only support TOTP 2FA, `LoginError::Unsupported2FA` will returned
     /// if anther 2FA method is enabled.

src/client/http_client/reqwest_client.rs

@@ -1,5 +1,5 @@
 use crate::client::{DEFAULT_APP_VERSION, DEFAULT_HOST_URL, X_PM_APP_VERSION_HEADER};
-use crate::{APIError, HttpClientError, RequestError};
+use crate::{APIError, HttpClientError, Proxy, RequestError};
 use serde::de::DeserializeOwned;
 use serde::{Deserialize, Serialize};
 use std::time::Duration;
@@ -18,6 +18,7 @@ pub struct HttpClientBuilder {
     base_url: String,
     request_timeout: Duration,
     user_agent: String,
+    proxy_url: Option<Proxy>,
 }
 
 impl Default for HttpClientBuilder {
@@ -33,6 +34,7 @@ impl HttpClientBuilder {
             user_agent: "NoClient/0.1.0".to_string(),
             base_url: DEFAULT_HOST_URL.to_string(),
             request_timeout: Duration::from_secs(5),
+            proxy_url: None,
         }
     }
 
@@ -61,6 +63,12 @@ impl HttpClientBuilder {
         self
     }
 
+    /// Specify proxy URL for the builder.
+    pub fn with_proxy(mut self, proxy: Proxy) -> Self {
+        self.proxy_url = Some(proxy);
+        self
+    }
+
     /// Constructs the http client
     pub fn build(self) -> Result<HttpClient, HttpClientError> {
         HttpClient::new(self)
@@ -76,10 +84,16 @@ impl HttpClient {
                 .map_err(|e| HttpClientError::Other(anyhow::format_err!(e)))?,
         );
 
-        let builder = reqwest::ClientBuilder::new();
+        let mut builder = reqwest::ClientBuilder::new();
         #[cfg(not(target_arch = "wasm32"))]
         let builder = {
             use reqwest::tls::Version;
+
+            if let Some(proxy) = http_builder.proxy_url {
+                let proxy = reqwest::Proxy::all(proxy.as_url())?;
+                builder = builder.proxy(proxy);
+            }
+
             builder
                 .min_tls_version(Version::TLS_1_2)
                 .https_only(true)