RiV-mesh

README

RiV-mesh

Why fork?

RiV-mesh is fork of Yggdrasil which is great project. Starting from Yggdrasil 0.4 dev team removed CKR feature which is a core for secure tunneling like VPN does. RiV-mesh gets back CKR feature. Second reason: Yggdrasil uses deprecated 200::/7 IPv6 address pool which can be assigned for some network in future, unlike this fc00::/7 is safe and has been taken for RiV-mesh.

Introduction

RiV-mesh is an implementation of a fully end-to-end encrypted IPv6 network, created in the scope to produce the Transport Layer for RiV Chain Blockchain, also to facilitate secure conectivity between a wide spectrum of endpoint devices like IoT devices, desktop computers or even routers. It is lightweight, self-arranging, supported on multiple platforms and allows pretty much any IPv6-capable application to communicate securely with other RiV-mesh nodes. RiV-mesh does not require you to have IPv6 Internet connectivity - it also works over IPv4.

Supported Platforms

RiV-mesh works on a number of platforms, including Linux, macOS, Ubiquiti EdgeRouter, VyOS, Windows, FreeBSD, OpenBSD and OpenWrt.

Please see our Installation page for more information. You may also find other platform-specific wrappers, scripts or tools in the contrib folder.

Building

If you want to build from source, as opposed to installing one of the pre-built packages:

1. Install Go (requires Go 1.17 or later)
2. Clone this repository
3. Run ./build

Note that you can cross-compile for other platforms and architectures by specifying the GOOS and GOARCH environment variables, e.g. GOOS=windows ./build or GOOS=linux GOARCH=mipsle ./build.

Running

Generate configuration

To generate static configuration, either generate a HJSON file (human-friendly, complete with comments):

./mesh -genconf > /path/to/mesh.conf

... or generate a plain JSON file (which is easy to manipulate programmatically):

./mesh -genconf -json > /path/to/mesh.conf

You will need to edit the mesh.conf file to add or remove peers, modify other configuration such as listen addresses or multicast addresses, etc.

Run RiV-mesh

To run with the generated static configuration:

./mesh -useconffile /path/to/mesh.conf

To run in auto-configuration mode (which will use sane defaults and random keys at each startup, instead of using a static configuration file):

./mesh -autoconf

You will likely need to run RiV-mesh as a privileged user or under sudo, unless you have permission to create TUN/TAP adapters. On Linux this can be done by giving the RiV-mesh binary the CAP_NET_ADMIN capability.

Documentation

Documentation is available on our website.

• Installing RiV-mesh
• Configuring RiV-mesh
• Frequently asked questions
• Version changelog

Community

Feel free to join us on our Telegram channel.

Public peers

If you are operating RiV-mesh peer and may create your pool request with your new per or use existing one https://github.com/RiV-chain/public-peers

Known issues

1. Log message:

An error occurred starting multicast: listen udp6 [::]:9001: socket: address family not supported by protocol

and

An error occurred starting TUN/TAP: operation not supported

Caused by:

The device has no IPv6 support

1. Log message:

An error occurred starting TUN/TAP: permission denied

Caused by:

IPv6 support is not enabled. See the solution: https://github.com/yggdrasil-network/yggdrasil-go/issues/479#issuecomment-519512395

License

This code is released under the terms of the LGPLv3, but with an added exception that was shamelessly taken from godeb. Under certain circumstances, this exception permits distribution of binaries that are (statically or dynamically) linked with this code, without requiring the distribution of Minimal Corresponding Source or Minimal Application Code. For more details, see: LICENSE.