https://github.com/dizda/fast-socks5
Fast SOCKS5 TCP and UDP client/server implementation written in Rust async (with tokio)
https://github.com/dizda/fast-socks5
async async-std rust socks5 socks5-proxy
Last synced: 16 days ago
JSON representation
Fast SOCKS5 TCP and UDP client/server implementation written in Rust async (with tokio)
- Host: GitHub
- URL: https://github.com/dizda/fast-socks5
- Owner: dizda
- License: mit
- Created: 2020-01-13T09:07:49.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2025-07-24T03:58:04.000Z (7 months ago)
- Last Synced: 2025-08-12T01:39:13.565Z (6 months ago)
- Topics: async, async-std, rust, socks5, socks5-proxy
- Language: Rust
- Homepage: https://anyip.io/
- Size: 183 KB
- Stars: 515
- Watchers: 9
- Forks: 87
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/dizda/fast-socks5)
[](https://crates.io/crates/fast-socks5)
[](https://deps.rs/repo/github/dizda/fast-socks5)
[](https://github.com/dizda/fast-socks5/releases)
Fast SOCKS5 TCP and UDP client/server library for Rust async (Tokio)
---
## Features
- An `async`/`.await` [SOCKS5](https://tools.ietf.org/html/rfc1928) implementation.
- An `async`/`.await` [SOCKS4 Client](https://www.openssh.com/txt/socks4.protocol) implementation.
- An `async`/`.await` [SOCKS4a Client](https://www.openssh.com/txt/socks4a.protocol) implementation.
- No **unsafe** code
- Built on top of the [Tokio](https://tokio.rs/) 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)
- UDP is supported
- All SOCKS5 RFC errors (replies) should be mapped
- `IPv4`, `IPv6`, and `Domains` types are supported
- Exhaustive [`examples`](https://github.com/dizda/fast-socks5/tree/master/examples) are provided that can be run immediately:
- client
- server
- custom_auth_server
- router
- udp_client
This library is maintained by [anyip.io](https://anyip.io/) a residential and mobile socks5 proxy provider.
## Install
Open in [crates.io](https://crates.io/crates/fast-socks5).
## Examples
Please check [`examples`](https://github.com/dizda/fast-socks5/tree/master/examples) directory.
```bash
# 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/
```
## 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 Considerations
- Implementation made with Tokio-codec https://github.com/yfaming/yimu-rs/blob/master/src/socks5.rs