lokinet/readme.md

Lokinet

Español

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

Usage

See the documentation on how to get started.

Also read the Public Testing Guide for installation and other helpful information.

Running on Linux

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 as client:

$ lokinet -g
$ lokinet-bootstrap
$ lokinet

to run as relay:

$ lokinet -r -g
$ lokinet-bootstrap
$ lokinet

Running on MacOS/UNIX/BSD

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 (lokinet and lokinet-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 as client:

$ lokinet -g
$ lokinet-bootstrap
$ sudo lokinet

to run as relay:

$ lokinet -r -g
$ lokinet-bootstrap
$ sudo lokinet

Running on Windows

DO NOT RUN AS ELEVATED USER, run as normal user.

Building

Build requirements:

• CMake
• C++ 17 capable C++ compiler
• gcovr (if generating test coverage with gcc)
• libuv >= 1.27.0
• libsodium >= 1.0.18

Linux

build:

$ sudo apt install build-essential cmake git libcap-dev curl libuv1-dev libsodium-dev libcurl4-openssl-dev pkg-config
$ git clone --recursive https://github.com/loki-project/loki-network
$ cd loki-network
$ mkdir build 
$ cd build
$ cmake .. 
$ make -j$(nproc)

install:

$ sudo make install

MacOS

build: make sure you have cmake, libuv and xcode command line tools installed

$ git clone --recursive https://github.com/loki-project/loki-network
$ cd loki-network
$ mkdir build 
$ cd build
$ cmake .. 
$ make -j$(nproc)

install:

$ sudo make install

Windows

windows builds are cross compiled from ubuntu linux

build requirements:

• CMake
• C++ 17 capable C++ compiler
• gcovr (if generating test coverage with gcc)
• libuv >= 1.27.0
• libsodium >= 1.0.18
• libcurl
• nsis
• cpack

setup:

$ sudo apt install build-essential cmake git pkg-config mingw-w64 nsis

building:

$ git clone --recursive https://github.com/loki-project/loki-network
$ cd loki-network
$ mkdir build-windows
$ cd build-windows
$ cmake -DNATIVE_BUILD=OFF -DCMAKE_BUILD_TYPE=Release -DBUILD_PACKAGE=ON -DCMAKE_TOOLCHAIN_FILE='../contrib/cross/mingw64.cmake' -DWITH_TESTS=OFF -DCMAKE_CROSSCOMPILING=ON ..
$ cpack -D CPACK_MONOLITHIC_INSTALL=1 -G NSIS ..

Solaris 2.10+

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 https://github.com/loki-project/loki-network
$ cd loki-network
$ mkdir build
$ cd build
$ cmake ..
$ make -j8

install:

$ sudo make install

FreeBSD

build:

$ pkg install cmake git curl libuv libsodium pkgconf
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ mkdir build
$ cmake -DCMAKE_BUILD_TYPE=Release ..
$ make

install (root):

# make install