dswd
/
vpncloud
mirror of https://github.com/dswd/vpncloud.git
1
0
Fork 0
Code Issues Releases Wiki Activity
182 Commits 11 Branches 27 Tags 8.1 MiB
Rust 94%
Python 5.8%
Dockerfile 0.1%
Go to file
Dennis Schwerdel 6d38130146 Covering missing error case 2016-07-06 21:29:42 +02:00
.cargo Building for ARMv6, silenced unknown lints 2016-06-21 11:37:26 +02:00
deb Ready to release 0.6.0 2016-06-02 09:36:45 +02:00
libsodium@fce6852d64 Updated libsodium, updated depdendencies 2016-04-05 15:27:47 +02:00
src Covering missing error case 2016-07-06 21:29:42 +02:00
.gitignore Cross-compiling for ARMv7, updated dependencies, silenced clippy warnings 2016-06-21 08:57:20 +02:00
.gitmodules Updated dependencies and docs 2015-12-08 22:03:49 +01:00
.travis.yml Trying to fix travis coverage 2016-05-25 14:53:07 +02:00
CHANGELOG.md More tests, bugfixes and code cleanup 2016-07-06 21:14:09 +02:00
Cargo.lock Added pluggable polling system 2016-06-30 10:06:34 +02:00
Cargo.toml Added pluggable polling system 2016-06-30 10:06:34 +02:00
LICENSE.md Added reference to full license text 2016-06-01 21:57:53 +02:00
Makefile Makefile, updated readme 2016-07-02 11:26:40 +02:00
README.md Added support for strange BSD tun header 2016-07-02 14:05:24 +02:00
build.rs Makefile, updated readme 2016-07-02 11:26:40 +02:00
gpl-3.txt Added license and copyright information 2016-02-05 16:58:32 +01:00
perf.sh New measurements 2016-02-02 22:05:54 +01:00
vpncloud.md Some documentation and code cleanup 2016-06-27 15:43:30 +02:00

README.md

VpnCloud - Peer-to-Peer VPN

Build Status Coverage Status Latest Version

VpnCloud is a simple VPN over UDP. It creates a virtual network interface on the host and forwards all received data via UDP to the destination. VpnCloud establishes a fully-meshed VPN network in a peer-to-peer manner. It can work on TUN devices (IP based) and TAP devices (Ethernet based). Tunneling traffic between two nodes can be as easy as:

vpncloud -c REMOTE_HOST:PORT --ifup 'ifconfig $IFNAME 10.0.0.1/24 mtu 1400 up'

For more information, please see the Wiki.

Project Status

This project is still under development but has reached a somewhat stable state. VpnCloud features the following functionality:

  • Setting up tunnels between two networks via Ethernet (TAP) and IP (TUN)
  • Connecting multiple networks with multiple forwarding behaviors (Hub, Switch, Router)
  • Encrypted connections using libsodium
  • Automatic peer-to-peer meshing, no central servers
  • NAT and (limited) firewall traversal using hole punching
  • Automatic reconnecting when connections are lost
  • Non-native forwarding modes, e.g. IP based learning switch and prefix routed Ethernet networks.
  • High throughput and low additional latency (see performance page)
  • Support for tunneled VLans (TAP device)

Installing

Compiling from source

Prerequisites: Git, Cargo, Full C build environment including autotools (for building libsodium)

The checked-out code can be compiled with make. The binary could then be found in target/release/vpncloud. The tests can be run via cargo test.

Debian / Ubuntu

Deb packages for each release can be found in the releases section. Currently only packages for amd64 are available (I am accepting help on building and packaging for other platforms).

Arch Linux (AUR)

There is a VpnCloud package for Arch Linux thanks to Oscar Rainford (fourbytes).

Contributions welcome

There are several areas in which still some work has to be done and where contributions are very welcome:

  • Linux packages: VpnCloud is stable enough to be packaged for Linux distributions. Maintainers who want to package VpnCloud are very welcome.
  • Security review: The security has been implemented with strong security primitives but it would great if a cryptography expert could verify the system.
  • Feedback on use cases: Some feedback on how VpnCloud is being used and maybe some tutorials covering common use cases would be nice.

Semantic Versioning

This project uses semantic versioning. Currently that means that everything can change between versions before 1.0 is finally released. However I am considering to release 1.0 soon.