Go to file
Dennis Schwerdel ed3587d423 Ready to release 0.4.2 2016-01-19 21:58:39 +01:00
deb Ready to release 0.4.2 2016-01-19 21:58:39 +01:00
libsodium@a84ae0170c Updated dependencies and docs 2015-12-08 22:03:49 +01:00
src Using copy trait more often 2016-01-19 21:52:44 +01:00
.gitignore Updated dependencies and docs 2015-12-08 22:03:49 +01:00
.gitmodules Updated dependencies and docs 2015-12-08 22:03:49 +01:00
.travis.yml Include libsodium in builds 2015-11-30 17:27:50 +01:00
CHANGELOG.md Ready to release 0.4.2 2016-01-19 21:58:39 +01:00
Cargo.lock Ready to release 0.4.2 2016-01-19 21:58:39 +01:00
Cargo.toml Ready to release 0.4.2 2016-01-19 21:58:39 +01:00
README.md Changelog 2015-12-10 09:53:14 +01:00
build.rs Include libsodium in builds 2015-11-30 17:27:50 +01:00
performance.md New measurements 2016-01-19 21:53:00 +01:00
vpncloud.md Updated dependencies and docs 2015-12-08 22:03:49 +01: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. 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'

More details can be found in the manpage. Some performance measurements can be found here.

Current Status

This project is still under development and has yet to reach a stable state. However, the main functionality should work and you are invited to test it. This is what works:

  • 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
  • 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)

However there are some open issues:

  • Encryption has not been thoroughly reviewed, use with care.
  • The software is not very well tested and the protocol can change.

Please feel free to help and contribute code.

Semantic Versioning

This project uses semantic versioning. Currently that means that everything can change between versions before 1.0 is finally released.