vtun

command module
v1.4.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 15, 2021 License: MIT Imports: 6 Imported by: 0

README

vtun

A simple VPN written in golang.

Travis Go Report Card image image

Features

  • VPN over udp
  • VPN over websocket

Usage

Usage of ./vtun:
  -c string
        tun interface CIDR (default "172.16.0.10/24")
  -k string
        key (default "6w9z$C&F)J@NcRfWjXn3r4u7x!A%D*G-")
  -l string
        local address (default ":3000")
  -p string
        protocol ws/wss/udp (default "wss")
  -s string
        server address (default ":3001")
  -d string
        dns address (default "8.8.8.8:53")
  -P    enable pporf server on :6060
  -S    server mode
  -g    client global mode
  -o    enable data obfuscation

Build

sh scripts/build.sh

Client

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

Client 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

Server

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

  sudo echo 1 > /proc/sys/net/ipv4/ip_forward
  sudo sysctl -p
  sudo iptables -t nat -A POSTROUTING -s 172.16.0.0/24 -o ens3 -j MASQUERADE

Docker

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 (need help)

  1. Support windows
  2. Support IPv6
  3. Develop iOS app

License

The MIT License (MIT)

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
common

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL