Skip to content

guardianproject/tor-android

Repository files navigation

Tor Android

This is native Android TorService built on the Tor shared library built for Android. The included libtor.so binaries can also be used directly as a tor daemon.

Currently, Tor Android is built with the following versions of tor, libevent, openssl, zlib and zstd:

Component Version
tor 0.4.8.17
libevent 2.1.12
OpenSSL 3.5.2
zlib 1.3.1
zstd 1.5.7

Tor Android binaries are available on the Guardian Project Maven Repo:

First add the repo to your top level build.gradle project:

allprojects {
    repositories {
        // ...
        maven { url "https://raw.githubusercontent.com/guardianproject/gpmaven/master" }
    }
}

Then add the tor-android and jtorctl dependencies to your project:

dependencies {
    implementation 'info.guardianproject:tor-android:0.4.8.16.2'
    implementation 'info.guardianproject:jtorctl:0.4.5.7'
}

Apps using tor-android need to declare the INTERNET permission in their Android Manifest file:

    <uses-permission android:name="android.permission.INTERNET"/>

Tor protects your privacy on the internet by hiding the connection between your Internet address and the services you use. We believe Tor is reasonably secure, but please ensure you read the instructions and configure it properly. Learn more at https://torproject.org/

Minimum Requirements

In order to use tor-android you need to target Android API 24 or higher.

It runs on the following hardware architectures:

  • arm64-v8a
  • armeabi-v7a
  • x86
  • x86_64

Tor Frequently Asked Questions:

How to Build

Please see: https://raw.githubusercontent.com/guardianproject/tor-android/master/BUILD.md

This can be built reproducibly using the included Vagrant VM setup. That will run with either libvirt or VirtualBox. The provisioning is based on the "release" job in .gitlab-ci.yml.

Publishing

Once you build the binaries, you can use gradle tasks to publish this in various ways, if you have the right credentials

Publish to your local Maven repository: ./gradlew publishToMavenLocal

Publish to Github packages: ./gradlew publishReleasePublicationToGitHubPackagesRepository

Publish to Gradle Central: ./gradlew publishAggregationToCentralPortal