8 releases (5 stable)
Uses old Rust 2015
|43.6.0+0.4.3.6||Jul 20, 2020|
|43.5.1+0.4.3.5||May 24, 2020|
|42.7.1+0.4.2.7||May 24, 2020|
|42.7.0+0.4.2.7||Mar 21, 2020|
|4.2.6-5+0.4.2.6||Mar 8, 2020|
#74 in macOS APIs
80 downloads per month
Used in libtor
This library compiles Tor and a few dependencies (zlib, libevent and openssl) into a single Rust library that can be imported like any other Rust crate into existing projects. This provides a way to use Tor without having to ship/download extra binaries - on platforms that allows running them - while for some other platforms like iOS and newer Android versions this is the only way to run Tor since the OS straight up doesn't allow exec'ing binaries.
Keep in mind that the interface exposed here is very very "low-level" (literally just what's in
tor_api.h). Another crate wrapping all of these parts with a nice Rust interface will
be released separately.
The currently supported platforms are:
- Linux (tested on Fedora 30 and Ubuntu Xenial)
- Android through the NDK
Coming Soon ™️:
- MacOS (it might even work now, but I don't have a Mac to test it)
Building on a Linux pc shouldn't be too hard, a
cargo build should normally work. Keep in mind that you will need all the "usual" build tools, like a compiler, automake, autoconf, make, in your PATH.
If you get an
aclocal-1.15 not found or something similar, try to cd into
libevent-<version> and run
autoreconf --force --install. Repeat in
tor-tor-<version> if you get the
same issue there, and then re-
Cross-compiling for Android is a bit more complicated, there are a few things to adjust:
- Some libraries (zlib) are provided by the OS, but we need to link against them. So an extra environment variable
SYSROOTthat points to the sysroot shipped with NDK is required to let Rust know where to look for those libraries.
- Rust by default will look for a compiler named
<arch>-linux-android-clang, but that's not how they are called in the NDK. So a
CCenv variable should be provided, pointing to the right compiler for the specific architecture.
- Rust will also look for other compiling tools, like
ar. Usually the best thing is to have the NDK's bin folder in your PATH so that it can find everything it needs.
At the end, your command line will look something like this, assuming you are building for
aarch64 on a
linux-x86_64 pc, targeting
PATH="$PATH:$NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin" SYSROOT=$NDK_HOME/platforms/android-21/arch-arm64 CC="aarch64-linux-android21-clang" cargo build --target=aarch64-linux-android