Belnet is the reference implementation of LLARP (low latency anonymous routing protocol), a layer 3 onion routing protocol.
You can learn more about the high level design of LLARP here
And you can read the LLARP protocol specification here
You can view documentation on how to get started here .
A simple demo application that is belnet "aware" can be found here
Build requirements:
- Git
- CMake
- C++ 17 capable C++ compiler
- libuv >= 1.27.0
- libsodium >= 1.0.18
- libcurl (for belnet-bootstrap)
- libunbound
- libzmq
- sqlite3
You do not have to build from source if you are on debian or ubuntu as we have apt repositories with pre-built belnet packages on deb.beldex.io
.
You can install these using:
$ sudo curl -so /etc/apt/trusted.gpg.d/beldex.gpg https://deb.beldex.io/pub.gpg
$ echo "deb https://deb.beldex.io $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/beldex.list
$ sudo apt update
$ sudo apt install belnet
If you are not on a platform supported by the debian packages or if you want to build a dev build, this is the most "portable" way to do it:
$ sudo apt install build-essential cmake git libcap-dev pkg-config automake libtool
$ git clone --recursive https://github.com/beldex-coin/belnet
$ cd belnet
$ mkdir build
$ cd build
$ cmake .. -DBUILD_STATIC_DEPS=ON -DBUILD_SHARED_LIBS=OFF -DSTATIC_LINK=ON
$ make -j$(nproc)
install:
$ sudo make install
You can get the latest stable macos relase from https://belnet.org/ or check the releases page on github.
alternatively you can build from source, make sure you have cmake, libuv and xcode command line tools installed:
$ git clone --recursive https://github.com/beldex-coin/belnet
$ cd belnet
$ mkdir build
$ cd build
$ cmake .. -DBUILD_STATIC_DEPS=ON -DBUILD_SHARED_LIBS=OFF -DSTATIC_LINK=ON
$ make -j$(sysctl -n hw.ncpu)
install:
$ sudo make install
You can get the latest stable windows release from https://belnet.org/ or check the releases page on github.
windows builds are cross compiled from debian/ubuntu linux
additional build requirements:
- nsis
- cpack
setup:
$ sudo apt install build-essential cmake git pkg-config mingw-w64 nsis ninja-build
building:
$ git clone --recursive https://github.com/beldex-coin/belnet
$ cd belnet
$ ./contrib/windows.sh
NOTE: Oracle Solaris users need to download/compile the TAP driver from http://www.whiteboard.ne.jp/~admin2/tuntap/
The generated binaries may work on Solaris 2.10 or earlier, you're on your own. (Recommended: -static-libstdc++ -static-libgcc
, and the TAP driver if not already installed on the target system.)
Building on a v2.10 or earlier system is unsupported, and may not even work; recent GCC releases have progressively dropped support for older system releases.
build:
$ sudo pkg install build-essential gcc8 wget tuntap cmake (optional: ninja ccache - from omnios extra) (OmniOS CE)
$ sudo pkg install base-developer-utilities developer-gnu developer-studio-utilities gcc-7 wget cmake (Oracle Solaris, see note)
$ sudo pkg install build-essential wget gcc-8 documentation/tuntap header-tun tun (optional: ninja ccache) (all other SunOS)
$ git clone --recursive https://github.com/beldex-coin/belnet
$ cd belnet
$ mkdir build
$ cd build
$ cmake ..
$ make -j$(nproc)
install:
$ sudo make install
build:
$ pkg install cmake git pkgconf
$ git clone --recursive https://github.com/beldex-coin/belnet
$ cd belnet
$ mkdir build
$ cd build
$ cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIBS=OFF -DSTATIC_LINK=ON -DBUILD_SHARED_DEPS=ON ..
$ make
install (root):
# make install
When running from debian package the following steps are not needed as it is already ready to use.
to configure as client:
$ belnet -g
$ belnet-bootstrap
to configure as relay:
$ belnet -r -g
$ belnet-bootstrap
DO NOT RUN AS ROOT, run as normal user. This requires the binary to have the proper setcaps set by make install
on the binary.
to run, after you create default config:
$ belnet
YOU HAVE TO RUN AS ROOT, run using sudo. Elevated privileges are needed to create the virtual tunnel interface.
The macOS installer places the normal binaries (belnet
and belnet-bootstrap
) in /usr/local/bin
which should be in your path, so you can easily use the binaries from your terminal. The installer also nukes your previous config and keys and sets up a fresh config and downloads the latest bootstrap seed.
to run, after you create default config:
$ sudo belnet