tun2socks

A tun2socks implementation written in Go.

Features

IPv6 support
Optimized UDP transmission for game acceleration
Pure Go implementation, no CGO required
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

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.

docker-compose.yml

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=:8080
      - DNS=:53
      - HOSTS=
      - EXCLUDED=
      - 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

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

Build from source

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

Performance

Usage

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)

Known Issues

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

TODO

Windows support

4.0 KiB Raw Blame History