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.
285 Commits 2 Branches 53 Tags 757 KiB
Go 97.9%
Shell 1%
Makefile 0.6%
Batchfile 0.4%
e8d00196df
Go to file
Junqin WANG e8d00196df fix windows command
2023-03-22 18:33:41 +08:00
app add kcp support 2022-12-13 07:28:04 +08:00
certs add default cert 2022-05-17 19:59:44 +08:00
common fix dns 2023-03-08 00:10:45 +08:00
grpc add quic support 2022-12-10 05:11:42 +08:00
kcp fix windows command 2023-03-22 18:33:41 +08:00
quic refactor 2023-03-08 13:37:00 +08:00
register add comments 2022-06-14 00:14:21 +08:00
scripts add build.bat for win 2022-12-13 22:18:20 +08:00
tls refactor 2023-03-08 13:37:00 +08:00
tun fix dns 2023-03-08 00:10:45 +08:00
udp fix udp client 2022-12-22 23:11:28 +08:00
ws remove deadline 2023-01-06 23:50:41 +08:00
.gitignore ignore idea 2022-08-23 23:08:25 +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 fix dns 2023-03-08 00:10:45 +08:00
go.sum fix dns 2023-03-08 00:10:45 +08:00
LICENSE Add vtun 2020-10-27 22:17:50 +08:00
main.go fix dns 2023-03-08 00:10:45 +08:00
README_CN.md update readme 2023-03-08 00:15:00 +08:00
README.md update readme 2023-03-08 00:15:00 +08:00

README.md

vtun

A simple VPN written in Go.

EN | 中文

Travis Go Report Card image image image

Features

  • VPN over udp
  • VPN over websocket
  • VPN over tls
  • VPN over grpc
  • VPN over quic
  • VPN over kcp

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 (default "./certs/server.pem")
  -privatekey string
        tls certificate key file path (default "./certs/server.key")
  -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
  -compress
        enable data compression
  -p string
        protocol udp/tls/grpc/quic/kcp/ws/wss (default "udp")
  -path string
        websocket path (default "/freedom")
  -s string
        server address (default ":3001")
  -sip string
        server ip (default "172.16.0.1")
  -sip6 string
        server ipv6 (default "fced:9999::1")
  -t int
        dial timeout in seconds (default 30)
  -v    enable verbose output

Build

scripts/build.sh

Client on Linux

sudo ./vtun-linux-amd64 -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 -s server-addr:3001 -c 172.16.0.10/24 -k 123456 -g

Client on MacOS

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

Client on Windows

To use it with windows, you will need to download a wintun.dll file in the app directory.
Open powershell as administrator and run cmd:

.\vtun-win-amd64.exe  -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

Iptables setup on Linux server

  # Enable ipv4 and ipv6 forward
  vi /etc/sysctl.conf
  net.ipv4.ip_forward = 1
  net.ipv6.conf.all.forwarding=1
  sysctl -p /etc/sysctl.conf
  # 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 -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 -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

License

The MIT License (MIT)

Acknowledgments

Thanks JetBrains for providing licenses.

JetBrains Logo (Main) logo.