Factor out Tor wrapper from plugin

2026-02-11 18:29:05 +01:00 · 2022-05-10 14:25:21 +01:00
parent b7003a3587
commit 01b1741e83
16 changed files with 1177 additions and 868 deletions
--- a/bramble-android/src/main/java/org/briarproject/bramble/plugin/tor/AndroidTorPluginFactory.java
+++ b/bramble-android/src/main/java/org/briarproject/bramble/plugin/tor/AndroidTorPluginFactory.java
@@ -5,6 +5,7 @@ import android.app.Application;
 import org.briarproject.bramble.api.battery.BatteryManager;
 import org.briarproject.bramble.api.crypto.CryptoComponent;
 import org.briarproject.bramble.api.event.EventBus;
+import org.briarproject.bramble.api.event.EventExecutor;
 import org.briarproject.bramble.api.lifecycle.IoExecutor;
 import org.briarproject.bramble.api.network.NetworkManager;
 import org.briarproject.bramble.api.plugin.Backoff;
@@ -16,8 +17,9 @@ import org.briarproject.bramble.api.plugin.TorSocksPort;
 import org.briarproject.bramble.api.system.AndroidWakeLockManager;
 import org.briarproject.bramble.api.system.Clock;
 import org.briarproject.bramble.api.system.LocationUtils;
-import org.briarproject.bramble.api.system.ResourceProvider;
 import org.briarproject.bramble.api.system.WakefulIoExecutor;
+import org.briarproject.bramble.plugin.tor.wrapper.AndroidTorWrapper;
+import org.briarproject.bramble.plugin.tor.wrapper.TorWrapper;
 import org.briarproject.nullsafety.NotNullByDefault;

 import java.io.File;
@@ -28,6 +30,7 @@ import javax.annotation.concurrent.Immutable;
 import javax.inject.Inject;
 import javax.net.SocketFactory;

+import static android.os.Build.VERSION.SDK_INT;
 import static org.briarproject.bramble.util.AndroidUtils.getSupportedArchitectures;

@Immutable
@@ -39,13 +42,13 @@ public class AndroidTorPluginFactory extends TorPluginFactory {

 	@Inject
 	AndroidTorPluginFactory(@IoExecutor Executor ioExecutor,
+			@EventExecutor Executor eventExecutor,
 			@WakefulIoExecutor Executor wakefulIoExecutor,
 			NetworkManager networkManager,
 			LocationUtils locationUtils,
 			EventBus eventBus,
 			SocketFactory torSocketFactory,
 			BackoffFactory backoffFactory,
-			ResourceProvider resourceProvider,
 			CircumventionProvider circumventionProvider,
 			BatteryManager batteryManager,
 			Clock clock,
@@ -55,8 +58,8 @@ public class AndroidTorPluginFactory extends TorPluginFactory {
 			@TorControlPort int torControlPort,
 			Application app,
 			AndroidWakeLockManager wakeLockManager) {
-		super(ioExecutor, wakefulIoExecutor, networkManager, locationUtils,
-				eventBus, torSocketFactory, backoffFactory, resourceProvider,
+		super(ioExecutor, eventExecutor, wakefulIoExecutor, networkManager,
+				locationUtils, eventBus, torSocketFactory, backoffFactory,
 				circumventionProvider, batteryManager, clock, crypto,
 				torDirectory, torSocksPort, torControlPort);
 		this.app = app;
@@ -79,12 +82,18 @@ public class AndroidTorPluginFactory extends TorPluginFactory {
 	TorPlugin createPluginInstance(Backoff backoff,
 			TorRendezvousCrypto torRendezvousCrypto, PluginCallback callback,
 			String architecture) {
-		return new AndroidTorPlugin(ioExecutor,
-				wakefulIoExecutor, app, networkManager, locationUtils,
-				torSocketFactory, clock, resourceProvider,
-				circumventionProvider, batteryManager, wakeLockManager,
-				backoff, torRendezvousCrypto, callback, architecture,
-				MAX_LATENCY, MAX_IDLE_TIME, torDirectory, torSocksPort,
-				torControlPort);
+		TorWrapper tor = new AndroidTorWrapper(app, wakeLockManager,
+				ioExecutor, eventExecutor, architecture, torDirectory,
+				torSocksPort, torControlPort);
+		// Android versions 7.1 and newer can verify Let's Encrypt TLS certs
+		// signed with the IdentTrust DST Root X3 certificate. Older versions
+		// of Android consider the certificate to have expired at the end of
+		// September 2021.
+		boolean canVerifyLetsEncryptCerts = SDK_INT >= 25;
+		return new TorPlugin(ioExecutor, wakefulIoExecutor,
+				networkManager, locationUtils, torSocketFactory,
+				circumventionProvider, batteryManager, backoff,
+				torRendezvousCrypto, tor, callback, MAX_LATENCY,
+				MAX_IDLE_TIME, canVerifyLetsEncryptCerts);
 	}
 }
--- a/bramble-android/src/main/java/org/briarproject/bramble/plugin/tor/wrapper/AndroidTorWrapper.java
+++ b/bramble-android/src/main/java/org/briarproject/bramble/plugin/tor/wrapper/AndroidTorWrapper.java
@@ -1,46 +1,36 @@
-package org.briarproject.bramble.plugin.tor;
+package org.briarproject.bramble.plugin.tor.wrapper;

 import android.app.Application;
 import android.content.pm.PackageInfo;
 import android.content.pm.PackageManager;
 import android.content.pm.PackageManager.NameNotFoundException;
+import android.content.res.Resources;
+import android.os.Build;

-import org.briarproject.bramble.api.battery.BatteryManager;
-import org.briarproject.bramble.api.network.NetworkManager;
-import org.briarproject.bramble.api.plugin.Backoff;
-import org.briarproject.bramble.api.plugin.PluginCallback;
 import org.briarproject.bramble.api.system.AndroidWakeLock;
 import org.briarproject.bramble.api.system.AndroidWakeLockManager;
-import org.briarproject.bramble.api.system.Clock;
-import org.briarproject.bramble.api.system.LocationUtils;
-import org.briarproject.bramble.api.system.ResourceProvider;
-import org.briarproject.bramble.util.AndroidUtils;
-import org.briarproject.nullsafety.MethodsNotNullByDefault;
-import org.briarproject.nullsafety.ParametersNotNullByDefault;
+import org.briarproject.nullsafety.NotNullByDefault;

 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.IOException;
+import java.io.InputStream;
 import java.util.ArrayList;
+import java.util.Collection;
 import java.util.List;
 import java.util.concurrent.Executor;
 import java.util.logging.Logger;
 import java.util.zip.ZipEntry;
 import java.util.zip.ZipInputStream;

-import javax.net.SocketFactory;
-
-import androidx.annotation.ChecksSdkIntAtLeast;
-
 import static android.os.Build.VERSION.SDK_INT;
 import static java.util.Arrays.asList;
 import static java.util.logging.Level.INFO;
 import static java.util.logging.Logger.getLogger;

-@MethodsNotNullByDefault
-@ParametersNotNullByDefault
-class AndroidTorPlugin extends TorPlugin {
+@NotNullByDefault
+public class AndroidTorWrapper extends AbstractTorWrapper {

 	private static final List<String> LIBRARY_ARCHITECTURES =
 			asList("armeabi-v7a", "arm64-v8a", "x86", "x86_64");
@@ -50,37 +40,22 @@ class AndroidTorPlugin extends TorPlugin {
 	private static final String SNOWFLAKE_LIB_NAME = "libsnowflake.so";

 	private static final Logger LOG =
-			getLogger(AndroidTorPlugin.class.getName());
+			getLogger(AndroidTorWrapper.class.getName());

 	private final Application app;
 	private final AndroidWakeLock wakeLock;
 	private final File torLib, obfs4Lib, snowflakeLib;

-	AndroidTorPlugin(Executor ioExecutor,
-			Executor wakefulIoExecutor,
-			Application app,
-			NetworkManager networkManager,
-			LocationUtils locationUtils,
-			SocketFactory torSocketFactory,
-			Clock clock,
-			ResourceProvider resourceProvider,
-			CircumventionProvider circumventionProvider,
-			BatteryManager batteryManager,
+	public AndroidTorWrapper(Application app,
 			AndroidWakeLockManager wakeLockManager,
-			Backoff backoff,
-			TorRendezvousCrypto torRendezvousCrypto,
-			PluginCallback callback,
+			Executor ioExecutor,
+			Executor eventExecutor,
 			String architecture,
-			long maxLatency,
-			int maxIdleTime,
 			File torDirectory,
 			int torSocksPort,
 			int torControlPort) {
-		super(ioExecutor, wakefulIoExecutor, networkManager, locationUtils,
-				torSocketFactory, clock, resourceProvider,
-				circumventionProvider, batteryManager, backoff,
-				torRendezvousCrypto, callback, architecture, maxLatency,
-				maxIdleTime, torDirectory, torSocksPort, torControlPort);
+		super(ioExecutor, eventExecutor, architecture, torDirectory,
+				torSocksPort, torControlPort);
 		this.app = app;
 		wakeLock = wakeLockManager.createWakeLock("TorPlugin");
 		String nativeLibDir = app.getApplicationInfo().nativeLibraryDir;
@@ -106,22 +81,30 @@ class AndroidTorPlugin extends TorPlugin {
 	}

 	@Override
-	protected void enableNetwork(boolean enable) throws IOException {
+	public InputStream getResourceInputStream(String name, String extension) {
+		Resources res = app.getResources();
+		// Extension is ignored on Android, resources are retrieved without it
+		int resId = res.getIdentifier(name, "raw", app.getPackageName());
+		return res.openRawResource(resId);
+	}
+
+	@Override
+	public void enableNetwork(boolean enable) throws IOException {
 		if (enable) wakeLock.acquire();
-		super.enableNetwork(enable);
-		if (!enable) wakeLock.release();
+		try {
+			super.enableNetwork(enable);
+		} finally {
+			if (!enable) wakeLock.release();
+		}
 	}

 	@Override
-	@ChecksSdkIntAtLeast(api = 25)
-	protected boolean canVerifyLetsEncryptCerts() {
-		return SDK_INT >= 25;
-	}
-
-	@Override
-	public void stop() {
-		super.stop();
-		wakeLock.release();
+	public void stop() throws IOException {
+		try {
+			super.stop();
+		} finally {
+			wakeLock.release();
+		}
 	}

 	@Override
@@ -136,8 +119,8 @@ class AndroidTorPlugin extends TorPlugin {

 	@Override
 	protected File getSnowflakeExecutableFile() {
-		return snowflakeLib.exists()
-				? snowflakeLib : super.getSnowflakeExecutableFile();
+		return snowflakeLib.exists() ? snowflakeLib
+				: super.getSnowflakeExecutableFile();
 	}

 	@Override
@@ -184,6 +167,7 @@ class AndroidTorPlugin extends TorPlugin {
 		}
 		List<String> libPaths = getSupportedLibraryPaths(libName);
 		for (File apk : findApkFiles(sourceDir)) {
+			@SuppressWarnings("IOStreamConstructor")
 			ZipInputStream zin = new ZipInputStream(new FileInputStream(apk));
 			for (ZipEntry e = zin.getNextEntry(); e != null;
 					e = zin.getNextEntry()) {
@@ -228,11 +212,22 @@ class AndroidTorPlugin extends TorPlugin {
 	 */
 	private List<String> getSupportedLibraryPaths(String libName) {
 		List<String> architectures = new ArrayList<>();
-		for (String abi : AndroidUtils.getSupportedArchitectures()) {
+		for (String abi : getSupportedArchitectures()) {
 			if (LIBRARY_ARCHITECTURES.contains(abi)) {
 				architectures.add("lib/" + abi + "/" + libName);
 			}
 		}
 		return architectures;
 	}
+
+	private Collection<String> getSupportedArchitectures() {
+		List<String> abis = new ArrayList<>();
+		if (SDK_INT >= 21) {
+			abis.addAll(asList(Build.SUPPORTED_ABIS));
+		} else {
+			abis.add(Build.CPU_ABI);
+			if (Build.CPU_ABI2 != null) abis.add(Build.CPU_ABI2);
+		}
+		return abis;
+	}
 }