dswd
/
vpncloud
mirror of https://github.com/dswd/vpncloud.git
1
0
Fork 0
Code Issues Releases Wiki Activity
238 Commits 11 Branches 27 Tags 8.1 MiB
Rust 94%
Python 5.8%
Dockerfile 0.1%
Go to file
Dennis Schwerdel 416f903e39 Update README.md 2019-02-20 14:25:26 +01:00
.cargo Building for ARMv6, silenced unknown lints 2016-06-21 11:37:26 +02:00
deb New version 2019-01-03 21:14:00 +01:00
docs New version 2019-01-03 21:14:00 +01:00
libsodium@675149b9b8 Updated dependencies 2019-01-02 00:57:54 +01:00
src New version 2019-01-03 21:14:00 +01:00
.gitignore Some more lints 2016-08-29 13:12:50 +02:00
.gitmodules Updated dependencies and docs 2015-12-08 22:03:49 +01:00
.travis.yml New version 2019-01-03 21:14:00 +01:00
CHANGELOG.md New version 2019-01-03 21:14:00 +01:00
Cargo.lock New version 2019-01-03 21:14:00 +01:00
Cargo.toml New version 2019-01-03 21:14:00 +01:00
LICENSE.md Added reference to full license text 2016-06-01 21:57:53 +02:00
Makefile Release 0.7.0 2016-08-05 08:50:22 +02:00
README.md Update README.md 2019-02-20 14:25:26 +01:00
build.rs Updated dependencies 2019-01-02 00:57:54 +01: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 fix a little mistake in vpncloud.md 2017-01-27 13:30:55 +01:00

README.md

VpnCloud - Peer-to-Peer VPN

Build Status Coverage Status

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 Website.

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)
  • Option to hide protocol header
  • Automatic port forwarding via UPnP

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 be 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.