1
1
Fork 0
mirror of https://github.com/oxen-io/lokinet synced 2023-12-14 06:53:00 +01:00
Lokinet is an anonymous, decentralized and IP based overlay network for the internet.
Find a file
2019-07-02 20:13:19 -04:00
.github Update issue templates 2019-04-17 13:33:37 +10:00
android make android compile 2019-04-08 11:54:19 -04:00
client Enable -Wextra 2018-11-07 15:31:13 +00:00
cmake Reverts #678 #677 and #669 with hashes: 2019-07-02 11:02:20 -04:00
contrib Update README.md 2019-06-19 15:29:23 -07:00
crypto More work on router docker image 2019-04-28 17:04:52 +01:00
daemon Reverts #678 #677 and #669 with hashes: 2019-07-02 11:02:20 -04:00
debian update debian stuff 2019-05-11 10:46:06 -04:00
docker Add in-source version of std::filesystem::permissions 2019-07-02 00:01:25 +01:00
docs Update api_v0.txt 2019-07-02 14:51:17 -04:00
include Reverts #678 #677 and #669 with hashes: 2019-07-02 11:02:20 -04:00
jni make android compile 2019-04-08 11:54:19 -04:00
libabyss make format 2019-06-17 23:29:54 -05:00
libhttp build fixes: using -s on Sun strips the ELF export symbol table, which leads to Bad Things if yer using the GNU linker for some godforsaken reason 2019-04-11 10:13:26 -05:00
libutp revert modification to libutp 2019-05-30 07:08:20 -04:00
llarp remove threadpool.hpp 2019-07-02 15:01:14 -04:00
osx-setup osx pkg updates 2019-05-21 14:59:30 -07:00
test Reverts #678 #677 and #669 with hashes: 2019-07-02 11:02:20 -04:00
ui-win32 Merge pull request #617 from majestrate/master 2019-05-22 08:06:26 -04:00
vendor Revert "Merge pull request #668 from michael-loki/remove_cppbackport" 2019-07-01 10:33:03 +01:00
win32-setup bump version 2019-05-22 05:13:53 -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 Move IWP code to its own directory 2019-03-29 16:00:12 +00:00
.gitignore Allow builds on MSVC (#518) 2019-04-19 13:24:33 -05:00
.gitlab-ci.yml gitlabci: actually install the package 2019-06-25 19:49:19 -07:00
.travis.yml Merge branch 'fix-big-ooooofff' 2019-06-06 06:53:54 -04:00
CMakeLists.txt Add in-source version of std::filesystem::permissions 2019-07-02 00:01:25 +01:00
CMakeSettings.json Fixup MSVC build 2019-05-15 23:03:24 +01: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 More work on router docker image 2019-04-28 17:04:52 +01: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
lokinet-docker.ini got router working in docker 2019-04-24 02:10:21 +00:00
Makefile remove libuv variable from makefile 2019-06-17 10:01:18 -04:00
module.modulemap Initial swift module.modulemap file for LLARP 2018-12-15 01:23:06 +10:00
motto.txt jeff forgot to bump 2019-05-22 05:14:16 -05:00
readme.md Update readme.md 2019-07-02 11:29:28 -04: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

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++ 17 capable C++ compiler
  • gcovr (if generating test coverage with gcc)
  • libuv >= 1.27.0

Linux

build:

$ sudo apt install build-essential cmake git libcap-dev curl libuv1-dev
$ 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 ../

MacOS

build: make sure you have cmake 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

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)

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-1.27.0
$ git clone https://github.com/loki-project/loki-network
$ cd loki-network
$ gmake -j8

install (root):

# gmake install