329da951b7
- Add a C callback interface (context_wrapper.h) between lokinet and the objective-C code so that: - we can use objective-C (rather than objective-C++), which seems more likely to be supported by Apple into the future; - we minimize the amount of code that needs to be aware of the Apple APIs. - this replaces apple logger objective c++ implementation with a plain c++ implementation that takes a very simple C callback (provided from the obj-c code) to actually make the call to NSLog. - Add various documentation to the code of what is going on. - Send all DNS traffic to the primary IP on the tun interface. The match prefixes simply don't work as advertised, and have weird shit (like even if you get it working for some domains, "instagram.com" still doesn't because of god-knows-what Apple internal politics). - Drop the dns proxy code as we don't need it anymore. - Don't use 9.9.9.9 for default DNS. (We might consider the unfiltered 9.9.9.10 as an alternative default, but if we do it should be a global lokinet change rather than a Mac-specific change). - Parse a lokinet.ini in the data directory, if it exists. (Since we are sandboxed, it is an app-specific "home" directory so is probably buried god knows where, but at least the GUI ought to be able to get it to let users add things to it). - This commit also adds a swift version of the PacketTunnelProvider glue, which ought to work in theory, but the *tooling* for cmake is so underdeveloped that I couldn't find any way to actually get the damn thing working. So I'm committing it here anyway (and will revert it away in the next commit) in case we someday want to switch to it. - |
3 years ago | |
---|---|---|
.github | 5 years ago | |
cmake | 3 years ago | |
contrib | 3 years ago | |
crypto | 3 years ago | |
daemon | 3 years ago | |
docs | 3 years ago | |
external | 3 years ago | |
include | 3 years ago | |
jni | 3 years ago | |
llarp | 3 years ago | |
pybind | 3 years ago | |
test | 3 years ago | |
win32-setup | 3 years ago | |
.clang-format | 4 years ago | |
.clang-tidy | 3 years ago | |
.dir-locals.el | 6 years ago | |
.dockerignore | 5 years ago | |
.drone.jsonnet | 3 years ago | |
.gitattributes | 4 years ago | |
.gitignore | 3 years ago | |
.gitmodules | 3 years ago | |
.swift-version | 3 years ago | |
CMakeLists.txt | 3 years ago | |
CMakeSettings.json | 5 years ago | |
CONTRIBUTING.md | 5 years ago | |
CONTRIBUTING_es.md | 5 years ago | |
LICENSE.txt | 4 years ago | |
lokinet-docker.ini | 5 years ago | |
readme.md | 3 years ago | |
readme_es.md | 3 years ago | |
readme_ru.md | 3 years ago | |
release.md | 5 years ago | |
release_es.md | 5 years ago | |
release_ru.md | 4 years ago |
readme.md
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 .
A simple demo application that is lokinet "aware" can be found here
Building
Build requirements:
- Git
- CMake
- C++ 17 capable C++ compiler
- libuv >= 1.27.0
- libsodium >= 1.0.18
- libcurl (for lokinet-bootstrap)
- libunbound
- libzmq
- sqlite3
Linux
You do not have to build from source if you are on debian or ubuntu as we have apt repositories with pre-built lokinet packages on deb.oxen.io
.
You can install these using:
$ sudo curl -so /etc/apt/trusted.gpg.d/oxen.gpg https://deb.oxen.io/pub.gpg
$ echo "deb https://deb.oxen.io $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/oxen.list
$ sudo apt update
$ sudo apt install lokinet
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/oxen-io/lokinet
$ cd lokinet
$ mkdir build
$ cd build
$ cmake .. -DBUILD_STATIC_DEPS=ON -DBUILD_SHARED_LIBS=OFF -DSTATIC_LINK=ON
$ make -j$(nproc)
install:
$ sudo make install
macOS
You can get the latest stable macos relase from https://lokinet.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/oxen-io/lokinet
$ cd lokinet
$ ./contrib/mac.sh -DCODESIGN_KEY='insert your key identity here' -DCODESIGN_TEAM_ID='team id here'
Windows
You can get the latest stable windows release from https://lokinet.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/oxen-io/lokinet
$ cd lokinet
$ ./contrib/windows.sh
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 --recursive https://github.com/oxen-io/lokinet
$ cd lokinet
$ mkdir build
$ cd build
$ cmake ..
$ make -j$(nproc)
install:
$ sudo make install
FreeBSD
build:
$ pkg install cmake git pkgconf
$ git clone --recursive https://github.com/oxen-io/lokinet
$ cd lokinet
$ 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
Usage
Debian / Ubuntu packages
When running from debian package the following steps are not needed as it is already ready to use.
Create default config
to configure as client:
$ lokinet -g
$ lokinet-bootstrap
to configure as relay:
$ lokinet -r -g
$ lokinet-bootstrap
Running on Linux
DO NOT RUN AS ROOT, run as normal user.
to run, after you create default config:
$ lokinet
This requires the binary to have the proper capabilities which is usually set by make install
on the binary. If you have errors regarding permissions to open a new interface this can be resolved using:
$ sudo setcap cap_net_admin,cap_net_bind_service=+eip /usr/local/bin/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, after you create default config:
$ sudo lokinet