tun2socks/README.md

tun2socks

A tun2socks implementation written in Go.

Features

• ICMP echoing
• IPv6 support
• Optimized UDP transmission for game acceleration
• Pure Go implementation, no more CGO required
• Router mode, routing all the traffic in LAN
• Socks5, Shadowsocks protocol support for remote connections
• TCP/IP stack powered by gVisor
• Up to 2.5Gbps throughput (10x faster than v1)

Requirements

Target	Minimum	Recommended
System	linux darwin	linux
Memory	>20MB	>128MB
CPU	amd64 arm64	amd64

Performance

iPerf3 tested on Debian 10 with i5-10500, 8G RAM

How to Build

build from source code

Go compiler version >= 1.15 is required

$ git clone https://github.com/xjasonlyu/tun2socks.git
$ cd tun2socks
$ make

build docker image

$ docker build -t tun2socks .

or

$ docker build -t tun2socks -f ./docker/Dockerfile.aarch64 .

QuickStart

Download from precompiled Releases.

With Docker

Since Go 1.12, the runtime now uses MADV_FREE to release unused memory on linux. This is more efficient but may result in higher reported RSS. The kernel will reclaim the unused data when it is needed. To revert to the Go 1.11 behavior (MADV_DONTNEED), set the environment variable GODEBUG=madvdontneed=1.

create docker network (macvlan mode)

docker network create -d macvlan \
  --subnet=172.20.1.0/25 \
  --gateway=172.20.1.1 \
  -o parent=eth0 \
  switch

pull tun2socks docker image

docker pull xjasonlyu/tun2socks:latest

run as gateway (DNS configuration required)

docker run -d \
  --network switch \
  --name tun2socks \
  --ip 172.20.1.2 \
  --privileged \
  --restart always \
  --sysctl net.ipv4.ip_forward=1 \
  -e PROXY=socks5://server:port \
  -e KEY=VALUE... \
  xjasonlyu/tun2socks:latest

or use docker-compose (recommended)

version: '2.4'

services:
  tun2socks:
    image: xjasonlyu/tun2socks:latest
    cap_add:
      - NET_ADMIN
    devices:
        - '/dev/net/tun:/dev/net/tun'
    environment:
      # - GODEBUG=madvdontneed=1
      - PROXY=socks5://server:port
      - LOGLEVEL=warning
      - API=api://:8080
      - DNS=dns://:53
      - HOSTS=localhost=127.0.0.1,router.local=172.20.1.1
      - EXCLUDED=1.1.1.1,1.0.0.1
      - EXTRACMD=
    networks:
      switch:
        ipv4_address: 172.20.1.2
    restart: always
    container_name: tun2socks

networks:
  switch:
    name: switch
    ipam:
      driver: default
      config:
        - subnet: '172.20.1.0/25'
          gateway: 172.20.1.1
    driver: macvlan
    driver_opts:
      parent: eth0

With Linux

create tun

ip tuntap add mode tun dev tun0
ip addr add 198.18.0.1/15 dev tun0
ip link set dev tun0 up

add route table

ip route del default
ip route add default via 198.18.0.1 dev tun0

run

./tun2socks --loglevel WARN --device tun://tun0 --proxy socks5://server:port --interface eth0

With Script

PROXY=socks5://server:port LOGLEVEL=WARN sh ./scripts/entrypoint.sh

Details

API Reference

Path	Methods	Parameters	Description
/logs	GET	level	Get real-time logs
/traffic	GET		Get real-time traffic data
/version	GET		Get current version
/connections	GET	interval	Get all connections
/connections	DELETE		Close all connections
/connections/{id}	DELETE		Close connection by id

Help Text

NAME:
   tun2socks - A tun2socks implementation written in Go.

USAGE:
   tun2socks [global options] [arguments...]

GLOBAL OPTIONS:
   --api value                  URL of external API to listen
   --device value, -d value     URL of device to open
   --dns value                  URL of fake DNS to listen
   --hosts value                Extra hosts mapping
   --interface value, -i value  Bind interface to dial
   --loglevel value, -l value   Set logging level (default: "INFO")
   --proxy value, -p value      URL of proxy to dial
   --version, -v                Print current version (default: false)
   --help, -h                   show help (default: false)

Credits

• Dreamacro/clash
• google/gvisor
• majek/slirpnetstack

Known Issues

Due to the implementation of pure Go, the memory usage is higher than the previous version. If you are sensitive to memory, please go back to v1.

TODO

• Windows support