Skip to content

refactor(socks): deduplicate and reuse shared logic #205

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jun 10, 2025
Merged

refactor(socks): deduplicate and reuse shared logic #205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9850cb0
style(client): Fix some clippy lints
0x676e67 Jun 2, 2025
0fef4a6
Merge branch 'hyperium:master' into master
0x676e67 Jun 10, 2025
a395256
refactor(socks): deduplicate and reuse shared logic
0x676e67 Jun 10, 2025
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
33 changes: 33 additions & 0 deletions src/client/legacy/connect/proxy/socks/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ pub use v5::{SocksV5, SocksV5Error};
mod v4;
pub use v4::{SocksV4, SocksV4Error};

use pin_project_lite::pin_project;
use std::future::Future;
use std::pin::Pin;
use std::task::{Context, Poll};

use bytes::BytesMut;

use hyper::rt::Read;
Expand Down Expand Up @@ -119,3 +124,31 @@ impl<C> From<SocksV5Error> for SocksError<C> {
Self::V5(err)
}
}

pin_project! {
// Not publicly exported (so missing_docs doesn't trigger).
//
// We return this `Future` instead of the `Pin<Box<dyn Future>>` directly
// so that users don't rely on it fitting in a `Pin<Box<dyn Future>>` slot
// (and thus we can change the type in the future).
#[must_use = "futures do nothing unless polled"]
#[allow(missing_debug_implementations)]
pub struct Handshaking<F, T, E> {
#[pin]
fut: BoxHandshaking<T, E>,
_marker: std::marker::PhantomData<F>
}
}

type BoxHandshaking<T, E> = Pin<Box<dyn Future<Output = Result<T, SocksError<E>>> + Send>>;

impl<F, T, E> Future for Handshaking<F, T, E>
where
F: Future<Output = Result<T, E>>,
{
type Output = Result<T, SocksError<E>>;

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
self.project().fut.poll(cx)
}
}
55 changes: 8 additions & 47 deletions src/client/legacy/connect/proxy/socks/v4/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,16 @@ pub use errors::*;
mod messages;
use messages::*;

use std::future::Future;
use std::pin::Pin;
use std::task::{Context, Poll};

use std::net::{IpAddr, SocketAddr, SocketAddrV4, ToSocketAddrs};
use std::task::{Context, Poll};

use http::Uri;
use hyper::rt::{Read, Write};
use tower_service::Service;

use bytes::BytesMut;

use pin_project_lite::pin_project;
use super::{Handshaking, SocksError};

/// Tunnel Proxy via SOCKSv4
///
Expand All @@ -35,23 +32,6 @@ struct SocksConfig {
local_dns: bool,
}

pin_project! {
// Not publicly exported (so missing_docs doesn't trigger).
//
// We return this `Future` instead of the `Pin<Box<dyn Future>>` directly
// so that users don't rely on it fitting in a `Pin<Box<dyn Future>>` slot
// (and thus we can change the type in the future).
#[must_use = "futures do nothing unless polled"]
#[allow(missing_debug_implementations)]
pub struct Handshaking<F, T, E> {
#[pin]
fut: BoxHandshaking<T, E>,
_marker: std::marker::PhantomData<F>
}
}

type BoxHandshaking<T, E> = Pin<Box<dyn Future<Output = Result<T, super::SocksError<E>>> + Send>>;

impl<C> SocksV4<C> {
/// Create a new SOCKSv4 handshake service
///
Expand Down Expand Up @@ -86,12 +66,7 @@ impl SocksConfig {
}
}

async fn execute<T, E>(
self,
mut conn: T,
host: String,
port: u16,
) -> Result<T, super::SocksError<E>>
async fn execute<T, E>(self, mut conn: T, host: String, port: u16) -> Result<T, SocksError<E>>
where
T: Read + Write + Unpin,
{
Expand All @@ -109,7 +84,7 @@ impl SocksConfig {
None
}
})
.ok_or(super::SocksError::DnsFailure)?
.ok_or(SocksError::DnsFailure)?
} else {
Address::Domain(host, port)
}
Expand Down Expand Up @@ -142,11 +117,11 @@ where
C::Error: Send + 'static,
{
type Response = C::Response;
type Error = super::SocksError<C::Error>;
type Error = SocksError<C::Error>;
type Future = Handshaking<C::Future, C::Response, C::Error>;

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
self.inner.poll_ready(cx).map_err(super::SocksError::Inner)
self.inner.poll_ready(cx).map_err(SocksError::Inner)
}

fn call(&mut self, dst: Uri) -> Self::Future {
Expand All @@ -155,12 +130,9 @@ where

let fut = async move {
let port = dst.port().map(|p| p.as_u16()).unwrap_or(443);
let host = dst
.host()
.ok_or(super::SocksError::MissingHost)?
.to_string();
let host = dst.host().ok_or(SocksError::MissingHost)?.to_string();

let conn = connecting.await.map_err(super::SocksError::Inner)?;
let conn = connecting.await.map_err(SocksError::Inner)?;
config.execute(conn, host, port).await
};

Expand All @@ -170,14 +142,3 @@ where
}
}
}

impl<F, T, E> Future for Handshaking<F, T, E>
where
F: Future<Output = Result<T, E>>,
{
type Output = Result<T, super::SocksError<E>>;

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
self.project().fut.poll(cx)
}
}
55 changes: 8 additions & 47 deletions src/client/legacy/connect/proxy/socks/v5/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,16 @@ pub use errors::*;
mod messages;
use messages::*;

use std::future::Future;
use std::pin::Pin;
use std::task::{Context, Poll};

use std::net::{IpAddr, SocketAddr, ToSocketAddrs};
use std::task::{Context, Poll};

use http::Uri;
use hyper::rt::{Read, Write};
use tower_service::Service;

use bytes::BytesMut;

use pin_project_lite::pin_project;
use super::{Handshaking, SocksError};

/// Tunnel Proxy via SOCKSv5
///
Expand Down Expand Up @@ -48,23 +45,6 @@ enum State {
ReadingProxyRes,
}

pin_project! {
// Not publicly exported (so missing_docs doesn't trigger).
//
// We return this `Future` instead of the `Pin<Box<dyn Future>>` directly
// so that users don't rely on it fitting in a `Pin<Box<dyn Future>>` slot
// (and thus we can change the type in the future).
#[must_use = "futures do nothing unless polled"]
#[allow(missing_debug_implementations)]
pub struct Handshaking<F, T, E> {
#[pin]
fut: BoxHandshaking<T, E>,
_marker: std::marker::PhantomData<F>
}
}

type BoxHandshaking<T, E> = Pin<Box<dyn Future<Output = Result<T, super::SocksError<E>>> + Send>>;

impl<C> SocksV5<C> {
/// Create a new SOCKSv5 handshake service.
///
Expand Down Expand Up @@ -126,12 +106,7 @@ impl SocksConfig {
}
}

async fn execute<T, E>(
self,
mut conn: T,
host: String,
port: u16,
) -> Result<T, super::SocksError<E>>
async fn execute<T, E>(self, mut conn: T, host: String, port: u16) -> Result<T, SocksError<E>>
where
T: Read + Write + Unpin,
{
Expand All @@ -142,7 +117,7 @@ impl SocksConfig {
let socket = (host, port)
.to_socket_addrs()?
.next()
.ok_or(super::SocksError::DnsFailure)?;
.ok_or(SocksError::DnsFailure)?;

Address::Socket(socket)
} else {
Expand Down Expand Up @@ -272,11 +247,11 @@ where
C::Error: Send + 'static,
{
type Response = C::Response;
type Error = super::SocksError<C::Error>;
type Error = SocksError<C::Error>;
type Future = Handshaking<C::Future, C::Response, C::Error>;

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>> {
self.inner.poll_ready(cx).map_err(super::SocksError::Inner)
self.inner.poll_ready(cx).map_err(SocksError::Inner)
}

fn call(&mut self, dst: Uri) -> Self::Future {
Expand All @@ -285,12 +260,9 @@ where

let fut = async move {
let port = dst.port().map(|p| p.as_u16()).unwrap_or(443);
let host = dst
.host()
.ok_or(super::SocksError::MissingHost)?
.to_string();
let host = dst.host().ok_or(SocksError::MissingHost)?.to_string();

let conn = connecting.await.map_err(super::SocksError::Inner)?;
let conn = connecting.await.map_err(SocksError::Inner)?;
config.execute(conn, host, port).await
};

Expand All @@ -300,14 +272,3 @@ where
}
}
}

impl<F, T, E> Future for Handshaking<F, T, E>
where
F: Future<Output = Result<T, E>>,
{
type Output = Result<T, super::SocksError<E>>;

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
self.project().fut.poll(cx)
}
}