Skip to content

minor SOCKS proxying docs fixes #246

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 1 commit into from
Nov 19, 2025
+7 −6
Merged

minor SOCKS proxying docs fixes #246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 1 addition & 1 deletion 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 @@ -18,7 +18,7 @@ use super::{Handshaking, SocksError};
/// Tunnel Proxy via SOCKSv4
///
/// This is a connector that can be used by the `legacy::Client`. It wraps
/// another connector, and after getting an underlying connection, it established
/// another connector, and after getting an underlying connection, it establishes
/// a TCP tunnel over it using SOCKSv4.
#[derive(Debug, Clone)]
pub struct SocksV4<C> {
Expand Down
11 changes: 6 additions & 5 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 @@ -18,7 +18,7 @@ use super::{Handshaking, SocksError};
/// Tunnel Proxy via SOCKSv5
///
/// This is a connector that can be used by the `legacy::Client`. It wraps
/// another connector, and after getting an underlying connection, it established
/// another connector, and after getting an underlying connection, it establishes
/// a TCP tunnel over it using SOCKSv5.
#[derive(Debug, Clone)]
pub struct SocksV5<C> {
Expand Down Expand Up @@ -64,8 +64,9 @@ impl<C> SocksV5<C> {
/// Use User/Pass authentication method during handshake.
///
/// Username and Password must be maximum of 255 characters each.
/// 0 length strings are allowed despite RFC prohibiting it. This is done so that
/// for compatablity with server implementations that require it for IP authentication.
/// 0 length strings are allowed despite RFC prohibiting it. This is done for
/// compatablity with server implementations that use empty credentials
/// to allow returning error codes during IP authentication.
pub fn with_auth(mut self, user: String, pass: String) -> Self {
self.config.proxy_auth = Some((user, pass));
self
Expand All @@ -82,10 +83,10 @@ impl<C> SocksV5<C> {

/// Send all messages of the handshake optmistically (without waiting for server response).
///
/// Typical SOCKS handshake with auithentication takes 3 round trips. Optimistic sending
/// A typical SOCKS handshake with user/pass authentication takes 3 round trips Optimistic sending
/// can reduce round trip times and dramatically increase speed of handshake at the cost of
/// reduced portability; many server implementations do not support optimistic sending as it
/// is not defined in the RFC (RFC 1928).
/// is not defined in the RFC.
///
/// Recommended to ensure connector works correctly without optimistic sending before trying
/// with optimistic sending.
Expand Down
Loading