Lokinet is an anonymous, decentralized and IP based overlay network for the internet.
Go to file
2019-03-29 16:00:12 +00:00
.github add contributing template 2018-09-28 10:34:37 -04:00
android add initial jni stuff for lokinet android. i fucking hate android so god damn much. 2018-11-26 17:46:22 -05:00
client Enable -Wextra 2018-11-07 15:31:13 +00:00
contrib add service manifest for systems that have dtrace :^p 2019-03-25 12:03:55 -05:00
crypto fix typo 2019-02-18 05:12:13 -08:00
daemon Integrate metrics into router 2019-03-25 20:36:23 +00:00
debian update debian parts 2019-02-28 08:49:04 -05:00
docker add router docker file 2019-03-11 19:54:01 -07:00
docs more 2019-03-27 08:36:27 -04:00
include that _should_ be just enough to implement TUN on Solaris 2.x 2019-03-25 12:03:55 -05:00
jni Replace usage of new/delete with unique_ptr/stack allocation 2019-02-11 16:24:05 +00:00
libabyss more 2019-03-25 11:41:37 -04:00
libutp Fixup one ASAN warning 2019-03-29 01:02:41 +00:00
llarp Refactor iwp into multiple files 2019-03-29 16:00:12 +00:00
test Move UTP code to its own directory 2019-03-29 16:00:12 +00:00
ui-win32 improve windows select loop 2019-03-26 19:56:34 -05:00
vendor that _should_ be just enough to implement TUN on Solaris 2.x 2019-03-25 12:03:55 -05:00
win32-setup nits 2019-03-20 20:55:58 -05:00
.clang-format more netns code 2018-08-26 08:51:22 -04:00
.dir-locals.el add emacs dir-locals 2018-05-21 10:52:30 -04:00
.dockerignore Add initial dockerfile support 2018-11-02 18:06:01 -04:00
.gitignore add revision to installer data 2019-03-20 05:12:40 -05:00
.gitlab-ci.yml Remove mention of rapidjson from readme/docker files etc 2019-03-02 02:32:18 +00:00
CMakeLists.txt only pick one event loop on sol2 2019-03-26 21:20:58 -05:00
CONTRIBUTING.md Rename CODE_OF_CONDUCT.md to CONTRIBUTING.md 2018-12-12 10:38:15 +10:00
doc place protocol spec into public domain with CC0 2018-10-08 08:15:08 -04:00
Doxyfile basic doxygen configuration 2018-12-17 03:24:11 +10:00
LICENSE more branding 2019-03-20 05:38:00 -05:00
lokinet-bootstrap add link to where we got the color info incase we need to change it 2019-01-16 13:02:54 -08:00
lokinet-bootstrap-testnet.exe fix internal testnet bootstrap 2019-03-20 19:46:37 -05:00
lokinet-bootstrap.exe fix installer bootstrap 2019-03-20 19:37:39 -05:00
Makefile gnu tools are prefixed with g 2019-03-25 12:07:04 -05:00
module.modulemap Initial swift module.modulemap file for LLARP 2018-12-15 01:23:06 +10:00
motto.txt update motto for release 2019-03-18 08:28:47 -04:00
readme.md add link to #400, also update windows build instructions 2019-03-25 12:03:54 -05:00
run-lokinet.bat add run-lokinet.bat super duper simple wrapper thingydoo for windows 2018-12-21 08:11:59 -05:00
testnet_readme.md update testnet docs and add more tuneable paramters 2019-02-07 08:20:03 -05:00

LokiNet

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

build status

Building

Build requirements:

  • GNU Make
  • CMake
  • C++ 17 capable C++ compiler
  • gcovr (if generating test coverage with gcc)
  • IMPORTANT NOTE: To use the optimiser, make sure the default -DNDEBUG macro is removed before generating (see #400)

Linux

build:

$ sudo apt install build-essential cmake git libcap-dev wget
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ make -j8

install:

$ sudo make install

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
$ gmake -j8

install:

$ sudo make install

NetBSD (and other platforms where pkgsrc is the native package mgr)

TODO: add pkgsrc instructions

OpenBSD (uses legacy netbsd pkg manager)

build:

# pkg_add wget cmake git (optional: ninja ccache)
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ gmake -j8

install (root):

# gmake install

FreeBSD

build:

$ pkg install wget cmake git
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ gmake -j8

install (root):

# gmake install

Windows

build (where $ARCH is your platform - i686 or x86_64):

$ pacman -Sy base-devel mingw-w64-$ARCH-toolchain git libtool autoconf mingw-w64-$ARCH-cmake
$ git clone https://github.com/loki-project/loki-network.git
$ cd loki-network
$ mkdir -p build; cd build
$ cmake .. -DCMAKE_BUILD_TYPE=[Debug|Release] -DSTATIC_LINK_RUNTIME=ON -DCMAKE_C_COMPILER=gcc -DCMAKE_CXX_COMPILER=g++ -G 'Unix Makefiles'

install (elevated) to $PROGRAMFILES/lokinet or $ProgramFiles(x86)/lokinet:

$ make install

if cross-compiling, install mingw-w64 from your distro's package manager, or build from source, then:

$ mkdir -p build; cd build
$ export COMPILER=clang # if using clang for windows
$ cmake .. -DCMAKE_BUILD_TYPE=[Debug|Release] -DSTATIC_LINK_RUNTIME=ON -DCMAKE_CROSSCOMPILING=ON -DCMAKE_TOOLCHAIN_FILE=../contrib/cross/mingw[32].cmake

this will create a static binary that can be installed anywhere, with no other dependency other than libc (minimum v6.1)

Running on Linux/UNIX/BSD

DO NOT RUN AS ROOT, run as normal user.

to run as client:

$ lokinet -g
$ lokinet-bootstrap
$ lokinet

to run as relay:

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

Running on Windows

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

to run as client, run the run-lokinet.bat batch file as your normal user.

Usage

see the documentation on how to get started.