github/vtun
5
0
Fork 0
mirror of https://github.com/net-byte/vtun synced 2024-03-14 10:50:03 +08:00
Code Issues Packages Projects Releases Wiki Activity
A simple VPN written in Go.
190 Commits 2 Branches 53 Tags 757 KiB
Go 97.9%
Shell 1%
Makefile 0.6%
Batchfile 0.4%
f7020a85d2
Go to file
netbyte f7020a85d2 add certs
2022-05-17 19:54:28 +08:00
certs add certs 2022-05-17 19:54:28 +08:00
common rename 2022-05-17 10:54:31 +08:00
quic add quic support 2022-05-17 19:43:57 +08:00
register fix 2021-05-14 18:20:54 +08:00
scripts add certs 2022-05-17 19:54:28 +08:00
tcp remove counter 2022-05-14 01:46:04 +08:00
tls rename 2022-05-17 10:54:31 +08:00
tun add dns server ip 2022-05-17 09:40:26 +08:00
udp update code style 2022-05-14 01:34:07 +08:00
ws add tls for wsserver 2022-05-16 22:15:09 +08:00
.gitignore update 2021-04-26 13:02:59 +08:00
.travis.yml code refactor 2022-03-20 21:36:07 +08:00
Dockerfile update dockerfile 2022-04-13 22:25:12 +08:00
go.mod add quic support 2022-05-17 19:43:57 +08:00
go.sum add quic support 2022-05-17 19:43:57 +08:00
LICENSE Add vtun 2020-10-27 22:17:50 +08:00
main.go add quic support 2022-05-17 19:43:57 +08:00
README_CN.md add quic support 2022-05-17 19:43:57 +08:00
README.md add quic support 2022-05-17 19:43:57 +08:00

README.md

vtun

A simple VPN written in golang.

EN | 中文

Travis Go Report Card image image

Features

  • VPN over tcp
  • VPN over udp
  • VPN over websocket
  • VPN over tls
  • VPN over quic

Usage

Usage of ./vtun:
  -S    server mode
  -c string
        tun interface cidr (default "172.16.0.10/24")
  -c6 string
        tun interface ipv6 cidr (default "fced:9999::9999/64")
  -certificate string
        tls certificate file path
  -privatekey string
        tls certificate key file path
  -sni string
        tls handshake sni
  -isv
        tls insecure skip verify
  -dn string
        device name
  -g    client global mode
  -k string
        key (default "freedom@2022")
  -l string
        local address (default ":3000")
  -mtu int
        tun mtu (default 1500)
  -obfs
        enable data obfuscation
  -p string
        protocol tcp/udp/tls/quic/ws/wss (default "wss")
  -path string
        websocket path (default "/freedom")
  -s string
        server address (default ":3001")
  -sip string
        intranet server ip (default "172.16.0.1")
  -sip6 string
        intranet server ipv6 (default "fced:9999::1")
  -dip string
        dns server ip (default "8.8.8.8")
  -t int
        dial timeout in seconds (default 30)

Build

sh scripts/build.sh

Client on Linux

sudo ./vtun-linux-amd64 -l :3000 -s server-addr:3001 -c 172.16.0.10/24 -k 123456

Client on Linux with global mode(routing all your traffic to server)

sudo ./vtun-linux-amd64 -l :3000 -s server-addr:3001 -c 172.16.0.10/24 -k 123456 -g

Client on MacOS

sudo ./vtun-darwin-amd64 -l :3000 -s server-addr:3001 -c 172.16.0.10/24 -k 123456 -g -sip 172.16.0.1

Server on Linux

sudo ./vtun-linux-amd64 -S -l :3001 -c 172.16.0.1/24 -k 123456

Server setup on Linux

  1. Add TLS for websocket,reverse proxy server(3001) via nginx/caddy(443)

  2. Enable IP forwarding on server

  sysctl -w net.core.rmem_max=2500000
  echo 1 > /proc/sys/net/ipv4/ip_forward
  sysctl -p
  # Masquerade outgoing traffic
  iptables -t nat -A POSTROUTING -o eth0 -j MASQUERADE
  iptables -t nat -A POSTROUTING -o tun0 -j MASQUERADE
  # Allow return traffic
  iptables -A INPUT -i eth0 -m state --state RELATED,ESTABLISHED -j ACCEPT
  iptables -A INPUT -i tun0 -m state --state RELATED,ESTABLISHED -j ACCEPT
  # Forward everything
  iptables -A FORWARD -j ACCEPT

Docker

docker image

Run client

docker run  -d --privileged --restart=always --net=host --name vtun-client \
netbyte/vtun -l :3000 -s server-addr:3001 -c 172.16.0.10/24 -k 123456

Run client with global mode

docker run  -d --privileged --restart=always --net=host --name vtun-client \
netbyte/vtun -l :3000 -s server-addr:3001 -c 172.16.0.10/24 -k 123456 -g

Run server

docker run  -d --privileged --restart=always --net=host --name vtun-server \
netbyte/vtun -S -l :3001 -c 172.16.0.1/24 -k 123456

Mobile client

Android

TODO (help wanted)

  1. Support windows
  2. Develop iOS app

License

The MIT License (MIT)