IPtProxy

Lyrebird/Obfs4proxy and Snowflake Pluggable Transports for iOS, MacOS and Android

Transport	Version
Lyrebird	0.5.0
Snowflake	2.10.1

Both Lyrebird/Obfs4proxy and Snowflake Pluggable Transports are written in Go, which is a little annoying to use on iOS and Android. This project encapsulates all the machinations to make it work and provides an easy to install binary including a wrapper around both.

Problems solved in particular are:

One cannot compile main packages with gomobile. For both PTs, IPtProxy provides wrapper code to use them as libraries.
Both PTs are gathered under one roof here, since you cannot have two gomobile frameworks as dependencies. There are some common Go runtime functions exported, which would create a name clash.
Free ports to be used are automatically found by this library and can be fetched
by the consuming app after start.

Caveat

IPtProxy is now provided with classes. You should not instantiate multiple objects of these classes!

Instead, instantiate Controller and/or SnowflakeProxy once, if you need them and keep a reference around.

It's good practice, to have all the IPtProxy handling contained in one place, so you can just store your references there. If that is not feasible within your project, Swift provides the possibility to keep singleton references in an extension to their respective objects like so:

import IPtProxy

extension IPtProxyController {

    // See below how to get `ptDir`!
    var ptDir = ""

    // Set `ptDir` first, before accessing this the first time! 
    static let shared = {
		return IPtProxyController(ptDir, enableLogging: true, unsafeLogging: false, logLevel: "INFO", transportStopped: nil)
    }()
}

extension IPtProxySnowflakeProxy {

    static let shared = {
        let sp = IPtProxySnowflakeProxy()
        sp.capacity = 0
        sp.brokerUrl = "..."
        sp.relayUrl = "..."
        sp.stunServer = "..."
        sp.natProbeUrl = "..."
        sp.pollInterval = 60
        
        return sp
    }()
}

On Android, you might resort to a subclassed Application object, if you already use one, or just any holder object:

import IPtProxy

object Transports {

    // See below how to get `ptDir`!
    var ptDir = ""

    // Set `ptDir` first, before accessing this the first time! 
    val controller: Controller by lazy {
        Controller(ptDir, true, false, "INFO", null)
    }
    
    val snowflakeProxy: SnowflakeProxy by lazy {
        val sp = SnowflakeProxy()
        sp.capacity = 0
        sp.brokerUrl = "..."
        sp.relayUrl = "..."
        sp.stunServer = "..."
        sp.natProbeUrl = "..."
        sp.pollInterval = 60
        
        sp
    }
}

iOS/macOS

Installation

IPtProxy is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'IPtProxy', '~> 4.0'

Getting Started

Before using IPtProxy you need to specify a place on disk for the transports to store their state information and log files.

From version 2.0.0 onwards, there's no default anymore! This is out of security concerns, esp. on Android.

You will need to provide stateDir before use of any transport:

let fm = FileManager.default

// Good choice for apps where IPtProxy runs inside an extension:

guard let ptDir = fm
    .containerURL(forSecurityApplicationGroupIdentifier: "group.com.example.app")? 
    .appendingPathComponent("pt_state")?
    .path
else {
    return
}

let ptc = IPtProxyController(ptDir, enableLogging: true, unsafeLogging: false, logLevel: "INFO", transportStopped: nil)

// For normal apps which run IPtProxy inline:

guard let ptDir = fm.urls(for: .documentDirectory, in: .userDomainMask)
    .first?
    .appendingPathComponent("pt_state")
    .path 
else {
    return
}

let ptc = IPtProxyController(ptDir, enableLogging: true, unsafeLogging: false, logLevel: "INFO", transportStopped: nil)

There's a companion library IPtProxyUI which explains the use of IPtProxy and provides all the necessary UI and additional information to use this library in a Tor context. (Also for macOS, despite the name!)

For a headache-free start into the world of Tor on iOS and macOS, check out the new TorManager project.

Android

Installation

From version 1.9.0 onward, IPtProxy is available through Maven Central. To install it, simply add the following line to your build.gradle file:

implementation 'com.netzarchitekten:IPtProxy:4.0.1'

Security Concerns:

Since it is relatively easy in the Java/Android ecosystem to inject malicious packages into projects by leveraging the order of repositories and release malicious versions of packages on repositories which come before the original one in the search order, the only way to keep yourself safe is to explicitly define, which packages should be loaded from which repository, when you use multiple repositories:

https://docs.gradle.org/5.1/userguide/declaring_repositories.html#sec::matching_repositories_to_dependencies

Getting Started

If you are building a new Android application be sure to declare that it uses the INTERNET permission in your Android Manifest:

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="my.test.app">

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

Before using IPtProxy you need to specify a place on disk for the transports to store their state information and log files.

From version 2.0.0 onwards, there's no default anymore! This is out of security concerns, esp. on Android.

You will need to provide stateDir before use of any transport.

Context#getCacheDir(), Context#getFilesDir() or Context#getNoBackupFilesDir() are good choices for this.

Do not use a directory outside the app's private storage!

import IPtProxy

File ptDir = new File(getCacheDir(), "pt_state");

Controller ptc = Controller(ptDir.getPath(), true, false, "INFO", null);

Build

Requirements

This repository contains a precompiled iOS and macOS version of IPtProxy. If you want to compile it yourself, you'll need Go 1.21 as a prerequisite.

You will also need Xcode installed when compiling for iOS and an Android NDK when compiling for Android.

The build script needs the gomobile binary and will install it, if not available, yet. However, you'll still need to make it accessible in your $PATH.

So, if it's not already, add $GOPATH/bin to $PATH. The default location for $GOPATH is $HOME/go:

export PATH=$HOME/go/bin/:$PATH`

iOS/macOS

Make sure Xcode and Xcode's command line tools are installed. Then run

rm -rf IPtProxy.xcframework && ./build.sh

This will create an IPtProxy.xcframework, which you can directly drop in your app, if you don't want to rely on CocoaPods.

Android

Make sure that javac is in your $PATH. If you do not have a JDK instance, on Debian systems you can install it with:

apt install default-jdk

If they aren't already, make sure the $ANDROID_HOME and $ANDROID_NDK_HOME environment variables are set:

export ANDROID_HOME=~/Android/Sdk
export ANDROID_NDK_HOME=$ANDROID_HOME/ndk/$NDK_VERSION

rm -rf IPtProxy.aar IPtProxy-sources.jar && ./build.sh android

This will create an IPtProxy.aar file, which you can directly drop in your app, if you don't want to rely on Maven Central or JitPack.

On certain CPU architectures gobind might fail with this error due to setting a flag that is no longer supported by Go since version 1.16:

go tool compile: exit status 1
unsupported setting GO386=387. Consider using GO386=softfloat instead.
gomobile: go build -v -buildmode=c-shared -o=/tmp/gomobile-work-855414073/android/src/main/jniLibs/x86/libgojni.so ./gobind failed: exit status 1

If this is the case, you will need to set this flag to build IPtProxy:

export GO386=sse2

Release

Update go.mod

If Lyrebird or Snowflake was updated, you might need to update the dependencies:

Check, that go.mod mentions the right versions of Lyrebird and Snowflake.
Then, do the following:

cd IPtProxy.go
go mod tidy
go get golang.org/x/mobile/cmd/gomobile@latest

A release commit needs the following:

Append CHANGELOG.

Update IPtProxy and dependencies' version numbers in

Podspec
README

Do fresh builds

rm -rf IPtProxy.xcframework && ./build.sh
rm -f IPtProxy.aar IPtProxy-sources.jar && ./build-android.sh

Tag and push changes

git add .
git commit -m Release version <tag>.
git tag <tag>
git push
git push --tags

CocoaPods

pod trunk push --skip-import-validation

Maven Central

Run bundle.sh like this:

./bundle.sh <version> [<GPG signing key ID>]

If you don't define your signing key, the first available will be used. If no keys, no signing will be done. Maven Central will reject unsigned artifacts.

To see your available keys, run this:

gpg --list-secret-keys

Go to https://central.sonatype.com/publishing/namespaces.
Push "Publish Component".
Enter "com.netzarchitekten:IPtProxy:" as the "Deployment Name".
Choose bundle file and hit "Publish Component".

Authors

Benjamin Erhart, berhart@netzarchitekten.com
Nathan Freitas
Bim
cohosh

for the Guardian Project https://guardianproject.info

License

IPtProxy is available under the MIT license. See the LICENSE file for more info.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

IPtProxy

Caveat

iOS/macOS

Installation

Getting Started

Android

Installation

Security Concerns:

Getting Started

Build

Requirements

iOS/macOS

Android

Release

Update go.mod

Append CHANGELOG.

Update IPtProxy and dependencies' version numbers in

Do fresh builds

Tag and push changes

CocoaPods

Maven Central

Further reading

Authors

License

Files

README.md

Latest commit

History

README.md

File metadata and controls

IPtProxy

Caveat

iOS/macOS

Installation

Getting Started

Android

Installation

Security Concerns:

Getting Started

Build

Requirements

iOS/macOS

Android

Release

Update go.mod

Append CHANGELOG.

Update IPtProxy and dependencies' version numbers in

Do fresh builds

Tag and push changes

CocoaPods

Maven Central

Further reading

Authors

License