Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/0x676e67/vproxy

An easy and powerful Rust HTTP/Socks5 Proxy
https://github.com/0x676e67/vproxy

cidr cidr-subnet http http-server hyper ipv4 ipv6 network proxy rust server socks5 socks5-server

Last synced: 6 days ago
JSON representation

An easy and powerful Rust HTTP/Socks5 Proxy

Host: GitHub
URL: https://github.com/0x676e67/vproxy
Owner: 0x676e67
License: gpl-3.0
Created: 2023-11-28T04:41:03.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-05-20T12:59:25.000Z (8 months ago)
Last Synced: 2024-05-20T21:13:23.634Z (8 months ago)
Topics: cidr, cidr-subnet, http, http-server, hyper, ipv4, ipv6, network, proxy, rust, server, socks5, socks5-server
Language: Rust
Homepage:
Size: 157 KB
Stars: 86
Watchers: 4
Forks: 17
Open Issues: 1
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

fucking-awesome-rust - vproxy/0x676e67 - An fast asynchronous Rust HTTP/Socks5 Proxy (Applications / Web Servers)
awesome-rust - vproxy/0x676e67 - An fast asynchronous Rust HTTP/Socks5 Proxy (Applications / Web Servers)

README

[![Email Badge](https://img.shields.io/badge/Gmail-Contact_Me-green?logo=gmail)](mailto:[email protected])
[![Crates.io License](https://img.shields.io/crates/l/vproxy)](./LICENSE)
[![crates.io](https://img.shields.io/crates/v/vproxy.svg)](https://crates.io/crates/vproxy)
[![Crates.io Total Downloads](https://img.shields.io/crates/d/vproxy)](https://crates.io/crates/vproxy)

# vproxy

> 🚀 Help me work seamlessly with open source sharing by [sponsoring me on GitHub](https://github.com/penumbra-x/.github/blob/main/profile/SPONSOR.md)

An fast asynchronous Rust `HTTP`/`Socks5` proxy

## Features

- IPv4/IPv6 priority
- Configurable concurrency limits
- Service binding `CIDR` address
- Specify a `CIDR` subnet range
- Basic authentication
- Proxy extensions

## Manual

```shell
$ vproxy -h
An easy and powerful Rust HTTP/Socks5 Proxy

Usage: vproxy
vproxy

Commands:
run Run server
start Start server daemon
restart Restart server daemon
stop Stop server daemon
ps Show the server daemon process
log Show the server daemon log
update Update the application
help Print this message or the help of the given subcommand(s)

Options:
-h, --help Print help
-V, --version Print version

$ vproxy run -h
Run server

Usage: vproxy run [OPTIONS]

Commands:
http Http server
socks5 Socks5 server
help Print this message or the help of the given subcommand(s)

Options:
--debug Debug mode [env: VPROXY_DEBUG=]
-b, --bind Bind address [default: 0.0.0.0:1080]
-T, --connect-timeout Connection timeout in seconds [default: 10]
-c, --concurrent Concurrent connections [default: 1024]
-u, --ulimit Ulimit soft limit
-w, --whitelist IP addresses whitelist, e.g. 47.253.53.46,47.253.81.245
-i, --cidr IP-CIDR, e.g. 2001:db8::/32
-r, --cidr-range IP-CIDR-Range, e.g. 64
-f, --fallback Fallback address
-h, --help Print help
```

## Installation

If you need more detailed installation and usage information, please check here

1. Install

- curl

```bash
curl -s -o /tmp/install.sh https://raw.githubusercontent.com/0x676e67/vproxy/main/.github/install.sh && bash /tmp/install.sh
```

- cargo

```bash
cargo install vproxy
```

- Dokcer

```bash
docker run --rm -it ghcr.io/0x676e67/vproxy:latest run http
```

2. Note

You run the program with sudo, it will automatically configure `sysctl net.ipv6.ip_nonlocal_bind=1` and `ip route add local 2001:470:e953::/48` dev lo for you. If you do not run it with sudo, you will need to configure these manually.

If no subnet is configured, the local default network proxy request will be used. When the local machine sets the priority `Ipv4`/`Ipv6` and the priority is `Ipv4`, it will always use `Ipv4` to make requests (if any).

```shell
# Enable binding to non-local IPv6 addresses
sudo sysctl net.ipv6.ip_nonlocal_bind=1

# Replace with your IPv6 subnet
sudo ip route add local 2001:470:e953::/48 dev lo

# Run the server http/socks5
vproxy run -i 2001:470:e953::/48 http

# Start the daemon (runs in the background), requires sudo
sudo vproxy start -i 2001:470:e953::/48 http

# Restart the daemon, requires sudo
sudo vproxy restart

# Stop the daemon, requires sudo
sudo vproxy stop

# Show daemon log
vproxy log

# Show daemon status
vproxy status

# Online update
vproxy update

# Test loop request
while true; do curl -x http://127.0.0.1:8100 -s https://api.ip.sb/ip -A Mozilla; done
...
2001:470:e953:5b75:c862:3328:3e8f:f4d1
2001:470:e953:b84d:ad7d:7399:ade5:4c1c
2001:470:e953:4f88:d5ca:84:83fd:6faa
2001:470:e953:29f3:41e2:d3f2:4a49:1f22
2001:470:e953:98f6:cb40:9dfd:c7ab:18c4
2001:470:e953:f1d7:eb68:cc59:b2d0:2c6f

```

- Whitelist extension

When using passwordless authorization, if an IP whitelist exists, only authorized IPs can pass the request.

- TTL Extension

Append `-ttl-` to the username, where TTL is a fixed value (e.g., `username-ttl-2`). The TTL value is the number of requests that can be made with the same IP. When the TTL value is reached, the IP will be changed. For HTTP users who are using passwordless authorization and need a fixed IP address, you can add the `ttl` header to the request (e.g., `ttl: 2`). By keeping the TTL value unchanged, you can use a fixed IP. Keep in mind Chrome and Firefox can't set `--proxy-header` like curl.

- Session Extension

Append `-session-id` to the username, where session is a fixed value and ID is an arbitrary random value (e.g., `username-session-123456`). Keep the Session ID unchanged to use a fixed IP.For HTTP users who are using password-less authorization and need a fixed IP address, you can add the `session` header to the request (e.g., `session: 123456`). By keeping the Session ID unchanged, you can use a fixed IP. Keep in mind Chrome and Firefox can't set `--proxy-header` like curl.

- Range Extension

Append `-range-id` to the username, where range is a fixed value and ID is any random value (e.g. `username-range-123456`). Keep the Range ID unchanged to use a fixed IP. For HTTP users that use passwordless authorization and require a fixed IP address, you can add a `range` header to the request (e.g. `range: 123456`). By keeping the Range ID unchanged, you can use a fixed CIDR range in a fixed range. Keep in mind that Chrome and Firefox cannot set `--proxy-header` like curl does, in addition, you must set the startup parameter `--cidr-range`, and the length is within a valid range.

3. Examples

- Http proxy session with username and password:

```shell
vproxy run --bind 127.0.0.1:8101 -i 2001:470:70c6::/48 http -u test -p test

$ for i in `seq 1 10`; do curl -x "http://test-session-123456789:[email protected]:8101" https://api6.ipify.org; done
2001:470:70c6:93ee:9b7c:b4f9:4913:22f5
2001:470:70c6:93ee:9b7c:b4f9:4913:22f5
2001:470:70c6:93ee:9b7c:b4f9:4913:22f5
$ for i in `seq 1 10`; do curl -x "http://test-session-987654321:[email protected]:8101" https://api6.ipify.org; done
2001:470:70c6:41d0:14fd:d025:835a:d102
2001:470:70c6:41d0:14fd:d025:835a:d102
2001:470:70c6:41d0:14fd:d025:835a:d102
```

- Http proxy session with passwordless authorization:

```shell
vproxy run --bind 127.0.0.1:8101 -w 127.0.0.1 -i 2001:470:70c6::/48 http

$ for i in `seq 1 3`; do curl --proxy-header "session-id: 123456789" -x "http://159.223.22.161:8101" https://api6.ipify.org; done
2001:470:70c6:93ee:9b7c:b4f9:4913:22f5
2001:470:70c6:93ee:9b7c:b4f9:4913:22f5
2001:470:70c6:93ee:9b7c:b4f9:4913:22f5
for i in `seq 1 3`; do curl --proxy-header "session-id: 987654321" -x "http://159.223.22.161:8101" https://api6.ipify.org; done
2001:470:70c6:41d0:14fd:d025:835a:d102
2001:470:70c6:41d0:14fd:d025:835a:d102
2001:470:70c6:41d0:14fd:d025:835a:d102
```

- Socks5 proxy session with username and password

```shell
vproxy run --bind 127.0.0.1:8101 -i 2001:470:70c6::/48 socks5 -u test -p test

$ for i in `seq 1 3`; do curl -x "socks5h://test-session-123456789:[email protected]:8101" https://api6.ipify.org; done
2001:470:70c6:93ee:9b7c:b4f9:4913:22f5
2001:470:70c6:93ee:9b7c:b4f9:4913:22f5
2001:470:70c6:93ee:9b7c:b4f9:4913:22f5
$ for i in `seq 1 3`; do curl -x "socks5h://test-session-987654321:[email protected]:8101" https://api6.ipify.org; done
2001:470:70c6:41d0:14fd:d025:835a:d102
2001:470:70c6:41d0:14fd:d025:835a:d102
2001:470:70c6:41d0:14fd:d025:835a:d102

```

- TTL proxy session with username and password

```shell
vproxy run --bind 127.0.0.1:8101 -i 2001:470:70c6::/48 socks5 -u test -p test

$ for i in `seq 1 3`; do curl -x "socks5h://test-ttl-2:[email protected]:8101" https://api6.ipify.org; done
2001:470:70c6:93ee:9b7c:b4f9:4913:22f5
2001:470:70c6:93ee:9b7c:b4f9:4913:22f5
2001:470:70c6:93ee:9b7c:b4f9:4913:22f6
$ for i in `seq 1 3`; do curl -x "socks5h://test-ttl-2:[email protected]:8101" https://api6.ipify.org; done
2001:470:70c6:41d0:14fd:d025:835a:d102
2001:470:70c6:41d0:14fd:d025:835a:d102
2001:470:70c6:41d0:14fd:d025:835a:d105
```

## Contributing

If you would like to submit your contribution, please open a [Pull Request](https://github.com/0x676e67/vproxy/pulls).

## Getting help

Your question might already be answered on the [issues](https://github.com/0x676e67/vproxy/issues)

## Sponsor

If you find this project helpful, please consider sponsoring me to support ongoing development:

**USDT-TRC20**: TCwD8HfHnJ7236Hdj3HF5uZKR2keeWeqZe

## License