Lokinet is an anonymous, decentralized and IP based overlay network for the internet.
Go to file
Jason Rhinelander ab4ee954b9 Remove DEBIAN option
This hasn't been used in a long time; the debian packaging lives in
separate branches instead.
2020-05-17 21:29:05 -03:00
.github Update issue templates 2019-04-17 13:33:37 +10:00
android pull in libsodium if local version sucks 2019-10-31 15:30:02 -04:00
cmake track libcurl and libuv with cmake, add libuv submodule 2020-05-17 14:53:28 -03:00
contrib track libcurl and libuv with cmake, add libuv submodule 2020-05-17 14:53:28 -03:00
crypto DOWNLOAD_SODIUM=FORCE to always download libsodium 2020-02-06 16:28:35 -04:00
daemon Re-apply clang-format rules after rebasing 2020-04-07 14:41:11 -06:00
debian update debian stuff 2019-05-11 10:46:06 -04:00
docker DOWNLOAD_SODIUM in docker travis builds 2020-02-07 00:17:36 -04:00
docs Notarize has an "a" in it 2020-04-20 00:28:32 -03:00
external track libcurl and libuv with cmake, add libuv submodule 2020-05-17 14:53:28 -03:00
include C++17 2020-05-01 17:43:27 -03:00
jni The Great Wall of Blame 2020-04-07 12:38:56 -06:00
libabyss Refactor Addr -> IpAddress/SockAddr 2020-05-06 14:38:44 -06:00
llarp Remove DEBIAN option 2020-05-17 21:29:05 -03:00
pybind format 2020-05-06 11:37:15 -04:00
test Silence various warnings 2020-05-17 21:28:17 -03:00
vendor/libtuntap-master try extracting dns bind addr from INI on windows 2020-03-05 12:47:45 -06:00
win32-setup remove unit tests 2020-03-05 12:49:12 -06:00
.clang-format Clang-format changes to pointer/reference positioning 2020-04-07 12:36:43 -06:00
.clang-tidy clang-tidy modernize pass 2019-08-12 16:52:58 +01:00
.dir-locals.el add emacs dir-locals 2018-05-21 10:52:30 -04:00
.dockerignore Add fail-able docker build for gcc trunk 2019-08-02 10:28:09 +01:00
.gitattributes add gitattributes for git-archive-all 2020-03-03 06:54:21 -05:00
.gitignore hive pytest framework in place (and path build test works)! 2020-03-03 19:57:09 -05:00
.gitlab-ci.yml track libcurl and libuv with cmake, add libuv submodule 2020-05-17 14:53:28 -03:00
.gitmodules track libcurl and libuv with cmake, add libuv submodule 2020-05-17 14:53:28 -03:00
.travis.yml revert makefile and travis 2020-05-17 14:54:27 -03:00
CMakeLists.txt Remove DEBIAN option 2020-05-17 21:29:05 -03:00
CMakeSettings.json Fixup MSVC build 2019-05-15 23:03:24 +01:00
CONTRIBUTING_es.md Create CONTRIBUTING_es.md 2019-07-19 22:04:50 -05:00
CONTRIBUTING.md Update CONTRIBUTING.md 2019-07-19 22:08:47 -05:00
CROSSCOMPILE.md update cross compiler docs 2019-07-16 10:11:05 -04:00
LICENSE.txt update license preamble 2020-05-17 11:27:41 -04:00
lokinet-bootstrap Fix for macos's decrepit old bash 3.x 2019-12-29 21:12:54 -04:00
lokinet-bootstrap.ps1 update lokinet-bootstrap 2020-04-02 11:08:08 -04:00
lokinet-docker.ini got router working in docker 2019-04-24 02:10:21 +00:00
Makefile Regex fix 2020-05-17 17:08:11 -03:00
module.modulemap Initial swift module.modulemap file for LLARP 2018-12-15 01:23:06 +10:00
readme_es.md Bump libsodium required version to 1.0.18 2020-02-02 16:38:48 -04:00
readme.md cpack win32 2020-04-02 11:08:07 -04:00
release_es.md Create release_es.md 2019-07-19 21:44:17 -05:00
release.md add release key files 2019-06-12 19:31:12 -04: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

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 .

build status travis-ci

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.

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

Building

Build requirements:

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

Linux

build:

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

install:

$ sudo make install

alternatively make a debian package with:

$ debuild -uc -us -b

this puts the built packages in ../

Static Linux

static native optimized:

$ make static STATIC_LINK=ON

cross compile fully static armhf (rpi 2 and up)

$ make static STATIC_LINK=ON DOWNLOAD_SODIUM=ON TOOLCHAIN=contrib/cross/armhf.toolchain.cmake

MacOS

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

$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ make -j8

install:

$ sudo make install

Windows

windows builds are cross compiled from ubuntu linux

build requirements:

  • GNU Make
  • CMake
  • C++ 14 capable C++ compiler
  • gcovr (if generating test coverage with gcc)
  • libuv >= 1.27.0
  • libsodium >= 1.0.17
  • libcurl
  • nsis
  • cpack

setup:

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

building:

$ make windows-release DOWNLOAD_SODIUM=ON STATIC_LINK=ON

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 curl 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 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