https://github.com/my-network/ipvpn

[WIP] Easy-to-use decentralized secure overlay private network (for any device)
https://github.com/my-network/ipvpn

android autodiscovery automation decentralized dht easy-to-use golang ipfs kademlia linux macos mesh nat p2p secure vpn windows wireguard

Last synced: about 2 months ago
JSON representation

[WIP] Easy-to-use decentralized secure overlay private network (for any device)

• Host: GitHub
• URL: https://github.com/my-network/ipvpn
• Owner: my-network
• License: gpl-3.0
• Created: 2019-06-23T12:27:07.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T21:51:30.000Z (about 2 years ago)
• Last Synced: 2024-08-01T22:42:03.135Z (5 months ago)
• Topics: android, autodiscovery, automation, decentralized, dht, easy-to-use, golang, ipfs, kademlia, linux, macos, mesh, nat, p2p, secure, vpn, windows, wireguard
• Language: Go
• Homepage:
• Size: 604 KB
• Stars: 35
• Watchers: 8
• Forks: 11
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Intro

The parent project is [mynet](https://github.com/my-network/mynet). This module is responsible for creating a VPN

through all required devices. It could be used as a separate solution (on a server, for example), but it was

supposed to use [mynet](https://github.com/my-network/mynet) on desktops

# Architecture

We use:

* [IPFS](https://ipfs.io/). It's used as:

  - Node discovery (using their DHT).

  - Fallback connector (when it's impossible to connect nodes directly).

  - STUN-replacement (tools to pass-trough a NAT).

  - Messenger (to send notification among nodes). 

* [WireGuard](https://www.wireguard.com/). It's used as the VPN implementation. If OS doesn't support WireGuard then we

  detect it and use an userspace implementation.

An `ipvpn` node is also a full `ipfs` node, so it consumes some traffic background.

# NAT traversal

Used techniques:

 * [UDP hole punching](https://en.wikipedia.org/wiki/UDP_hole_punching)

 * Planned: [UPnP IGD](https://en.wikipedia.org/wiki/Internet_Gateway_Device_Protocol)

 * Planned: Relaying

# Requirements

## Run:

* Linux or MacOS only, yet

## Build:

* Linux or MacOS only, yet

* Go>=1.13

# Quick start

Just run on *all* your nodes (the sample commands):

```sh

# install

GO111MODULE=on go get github.com/my-network/ipvpn/cmd/ipvpnd

sudo mkdir /var/run/wireguard

sudo chown $UID /var/run/wireguard

sudo setcap cap_net_raw,cap_net_admin+ep `go env GOPATH`/bin/ipvpnd

# configure

mkdir -p "$HOME/.ipvpn"

echo "my_unique_network_name_here" > "$HOME/.ipvpn/network_id.txt"

echo "my_password_here" > "$HOME/.ipvpn/password_new.txt"

# run

`go env GOPATH`/bin/ipvpnd

# in other terminal, check:

ip a show dev ipvpn_direct

ip a show dev ipvpn_tunnel

ping -c 5 10.197.202.1

ping -c 5 10.197.203.1

```

* `my_unique_network_here` should be replaced by a name of you virtual private network

* `my_password_here` should be replaced by some secret string

That's it. If `my_unique_network_here` and `my_password_here` will match through all of your nodes then they will build an overlay

network automatically. 

# Similar projects

* [https://github.com/Gawen/WireHub](https://github.com/Gawen/WireHub)