25 releases
1.0.0-beta.2 | Feb 6, 2025 |
---|---|
0.10.0 | Dec 18, 2024 |
0.9.6 | Mar 25, 2024 |
0.9.2 | Nov 30, 2023 |
0.3.0 | Jan 19, 2020 |
#101 in Network programming
37,482 downloads per month
Used in 15 crates
(8 directly)
120KB
2.5K
SLoC
SOCKS5 client/server library using async/.await
This library is maintained by anyip.io a residential and mobile socks5 proxy provider.
Features
- An
async
/.await
SOCKS5 implementation. - An
async
/.await
SOCKS4 Client implementation. - An
async
/.await
SOCKS4a Client implementation. - No unsafe code
- Built on top of the Tokio runtime
- Ultra lightweight and scalable
- No system dependencies
- Cross-platform
- Infinitely extensible, explicit server API based on typestates for safety
- You control the request handling, the library only ensures you follow the proper protocol flow
- Can skip DNS resolution
- Can skip the authentication/handshake process (not RFC-compliant, for private use, to save on useless round-trips)
- Instead of proxying in-process, swap out
run_tcp_proxy
for custom handling to build a router or to use a custom accelerated proxying method
- Authentication methods:
- No-Auth method (
0x00
) - Username/Password auth method (
0x02
) - Custom auth methods can be implemented on the server side via the
AuthMethod
Trait- Multiple auth methods with runtime negotiation can be supported, with fast static dispatch (enums can be generated with the
auth_method_enums
macro)
- Multiple auth methods with runtime negotiation can be supported, with fast static dispatch (enums can be generated with the
- No-Auth method (
- UDP is supported
- All SOCKS5 RFC errors (replies) should be mapped
IPv4
,IPv6
, andDomains
types are supported
Install
Open in crates.io.
Examples
Please check examples
directory.
# Run client
RUST_LOG=debug cargo run --example client -- --socks-server 127.0.0.1:1337 --username admin --password password -a perdu.com -p 80
# Run server
RUST_LOG=debug cargo run --example server -- --listen-addr 127.0.0.1:1337 password -u admin -p password
# Test it with cURL
curl -v --proxy socks5://admin:password@127.0.0.1:1337 https://ipapi.co/json/
TODO
- Tests have to be implemented
- Better Rust doc
Inspired by
Thanks to all these SOCKS5 projects
- https://github.com/sfackler/rust-socks/blob/master/src/v5.rs
- https://github.com/shadowsocks/shadowsocks-rust/blob/master/src/relay/socks5.rs
- https://github.com/ylxdzsw/v2socks/blob/master/src/socks.rs
Further consideration
- Implementation made with Tokio-codec https://github.com/yfaming/yimu-rs/blob/master/src/socks5.rs
Dependencies
~3–11MB
~119K SLoC