Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/heiher/hev-socks5-server
A high-performance socks5 server for Unix (Linux/Android/BSD/macOS/iOS)
https://github.com/heiher/hev-socks5-server
android dns freebsd high-performance ipv4 ipv6 linux macos socks5 socks5-proxy socks5-server tcp udp
Last synced: 2 days ago
JSON representation
A high-performance socks5 server for Unix (Linux/Android/BSD/macOS/iOS)
- Host: GitHub
- URL: https://github.com/heiher/hev-socks5-server
- Owner: heiher
- License: mit
- Created: 2013-12-05T14:45:24.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2024-11-08T11:04:51.000Z (6 days ago)
- Last Synced: 2024-11-08T12:18:45.404Z (6 days ago)
- Topics: android, dns, freebsd, high-performance, ipv4, ipv6, linux, macos, socks5, socks5-proxy, socks5-server, tcp, udp
- Language: C
- Homepage:
- Size: 346 KB
- Stars: 269
- Watchers: 13
- Forks: 40
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: License
Awesome Lists containing this project
README
# HevSocks5Server
[](https://github.com/heiher/hev-socks5-server)
HevSocks5Server is a simple, lightweight socks5 server for Unix.
## Features
* IPv4/IPv6. (dual stack)
* Standard `CONNECT` command.
* Standard `UDP ASSOCIATE` command.
* Extended `FWD UDP` command. (UDP in TCP) [^1]
* Multiple username/password authentication.
## Benchmarks
See [here](https://github.com/heiher/hev-socks5-server/wiki/Benchmarks) for more details.
### Speed
### CPU usage
### Memory usage
## How to Build
### Unix
```bash
git clone --recursive https://github.com/heiher/hev-socks5-server
cd hev-socks5-server
make
# statically link
make ENABLE_STATIC=1
```
### Android
```bash
mkdir hev-socks5-server
cd hev-socks5-server
git clone --recursive https://github.com/heiher/hev-socks5-server jni
cd jni
ndk-build
```
### iOS and MacOS
```bash
git clone --recursive https://github.com/heiher/hev-socks5-server
cd hev-socks5-server
# will generate HevSocks5Server.xcframework
./build-apple.sh
```
## How to Use
### Config
```yaml
main:
# Worker threads
workers: 4
# Listen port
port: 1080
# Listen address (ipv4|ipv6)
listen-address: '::'
# UDP listen port
udp-port: 1080
# UDP listen address (ipv4|ipv6)
# udp-listen-address: '::1'
# Listen ipv6 only
listen-ipv6-only: false
# Bind source address (ipv4|ipv6)
# It is overridden by bind-address-v{4,6} if specified
bind-address: ''
# Bind source address (ipv4)
bind-address-v4: ''
# Bind source address (ipv6)
bind-address-v6: ''
# Bind source network interface
bind-interface: ''
# Domain address type (ipv4|ipv6|unspec)
domain-address-type: unspec
# Socket mark (hex: 0x1, dec: 1, oct: 01)
mark: 0
#auth:
# file: conf/auth.txt
# username:
# password:
#misc:
# task stack size (bytes)
# task-stack-size: 8192
# connect timeout (ms)
# connect-timeout: 5000
# read-write timeout (ms)
# read-write-timeout: 60000
# stdout, stderr or file-path
# log-file: stderr
# debug, info, warn or error
# log-level: warn
# If present, run as a daemon with this pid file
# pid-file: /run/hev-socks5-server.pid
# If present, set rlimit nofile; else use default value
# limit-nofile: 65535
```
### Authentication file
```
```
- USERNAME: A string of up to 255 characters
- PASSWORD: A string of up to 255 characters
- MARK: Hexadecimal
### Run
```bash
bin/hev-socks5-server conf/main.yml
```
### Live updating authentication file
Send signal `SIGUSR1` to socks5 server process after the authentication file is updated.
```bash
killall -SIGUSR1 hev-socks5-server
```
### Limit number of connections
For example, limit the number of connections for `jerry` up to `2`:
#### Config
```yaml
auth:
file: conf/auth.txt
```
#### Auth file
```
jerry pass 1a
```
#### IPtables
```bash
iptables -A OUTPUT -p tcp --syn -m mark --mark 0x1a -m connlimit --connlimit-above 2 -j REJECT
```
## API
```c
/**
* hev_socks5_server_main_from_file:
* @config_path: config file path
*
* Start and run the socks5 server, this function will blocks until the
* hev_socks5_server_quit is called or an error occurs.
*
* Returns: returns zero on successful, otherwise returns -1.
*
* Since: 2.6.7
*/
int hev_socks5_server_main_from_file (const char *config_path);
/**
* hev_socks5_server_main_from_str:
* @config_str: string config
* @config_len: the byte length of string config
*
* Start and run the socks5 server, this function will blocks until the
* hev_socks5_server_quit is called or an error occurs.
*
* Returns: returns zero on successful, otherwise returns -1.
*
* Since: 2.6.7
*/
int hev_socks5_server_main_from_str (const unsigned char *config_str,
unsigned int config_len);
/**
* hev_socks5_server_quit:
*
* Stop the socks5 server.
*
* Since: 2.6.7
*/
void hev_socks5_server_quit (void);
```
## Use Cases
### Android App
* [Socks5](https://github.com/heiher/socks5)
### iOS App
* [Socks5](https://github.com/heiher/socks5-ios)
## Contributors
* **Ammar Faizi** - https://github.com/ammarfaizi2
* **hev** - https://hev.cc
* **pexcn** -
## License
MIT
[^1]: The [hev-socks5-tunnel](https://github.com/heiher/hev-socks5-tunnel) and [hev-socks5-tproxy](https://github.com/heiher/hev-socks5-tproxy) clients support UDP relay over TCP.