Package org.briarproject.onionwrapper

Class AndroidTorWrapper

java.lang.Object

org.briarproject.onionwrapper.AndroidTorWrapper

All Implemented Interfaces:

net.freehaven.tor.control.EventHandler, org.briarproject.onionwrapper.TorWrapper

@NotNullByDefault
public class AndroidTorWrapper
extends Object

A Tor wrapper for the Android operating system.

Nested Class Summary

Nested classes/interfaces inherited from interface org.briarproject.onionwrapper.TorWrapper

org.briarproject.onionwrapper.TorWrapper.HiddenServiceProperties, org.briarproject.onionwrapper.TorWrapper.Observer, org.briarproject.onionwrapper.TorWrapper.TorState

Field Summary

Fields

Modifier and Type	Field	Description
protected Executor	eventExecutor
protected Executor	ioExecutor
protected org.briarproject.onionwrapper.AbstractTorWrapper.NetworkState	state

Constructor Summary

Constructors

Constructor	Description
AndroidTorWrapper(Application app, org.briarproject.android.dontkillmelib.wakelock.AndroidWakeLockManager wakeLockManager, Executor ioExecutor, Executor eventExecutor, String architecture, File torDirectory, int torSocksPort, int torControlPort)

Method Summary

Modifier and Type	Method	Description
void	bandwidthUsed(long arg0, long arg1)
void	circuitStatus(String arg0, String arg1, String arg2)
void	controlConnectionClosed()
void	disableBridges()
void	enableBridges(List<String> arg0)
void	enableConnectionPadding(boolean arg0)
void	enableIpv6(boolean arg0)
void	enableNetwork(boolean enable)
protected void	extract(InputStream arg0, File arg1)
protected String	getExecutableExtension()
protected long	getLastUpdateTime()
File	getObfs4ExecutableFile()
protected int	getProcessId()
InputStream	getResourceInputStream(String name, String extension)
protected File	getSnowflakeExecutableFile()
protected File	getTorExecutableFile()
org.briarproject.onionwrapper.TorWrapper.TorState	getTorState()
protected void	installObfs4Executable()
protected void	installSnowflakeExecutable()
protected void	installTorExecutable()
boolean	isTorRunning()
void	message(String arg0, String arg1)
void	newDescriptors(List<String> arg0)
void	orConnStatus(String arg0, String arg1)
org.briarproject.onionwrapper.TorWrapper.HiddenServiceProperties	publishHiddenService(int arg0, int arg1, String arg2)
void	removeHiddenService(String arg0)
void	setObserver(org.briarproject.onionwrapper.TorWrapper.Observer arg0)
void	start()
void	stop()
void	streamStatus(String arg0, String arg1, String arg2)
void	unrecognized(String arg0, String arg1)
protected void	waitForTorToStart(Process arg0)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ioExecutor

protected final Executor ioExecutor

eventExecutor

protected final Executor eventExecutor

state

protected final org.briarproject.onionwrapper.AbstractTorWrapper.NetworkState state

Constructor Detail

AndroidTorWrapper

public AndroidTorWrapper(Application app,
                         org.briarproject.android.dontkillmelib.wakelock.AndroidWakeLockManager wakeLockManager,
                         Executor ioExecutor,
                         Executor eventExecutor,
                         String architecture,
                         File torDirectory,
                         int torSocksPort,
                         int torControlPort)

Parameters:

app - The application instance.

wakeLockManager - The interface for managing a shared wake lock.

ioExecutor - The wrapper will use this executor to run IO tasks, some of which may run for the lifetime of the wrapper, so the executor should have an unlimited thread pool.

eventExecutor - The wrapper will use this executor to call the observer (if any). To ensure that events are observed in the order they occur, this executor should have a single thread (eg the app's main thread).

architecture - The processor architecture of the Tor and pluggable transport binaries.

torDirectory - The directory where the Tor process should keep its state.

torSocksPort - The port number to use for Tor's SOCKS port.

torControlPort - The port number to use for Tor's control port.

Method Detail

getProcessId

protected int getProcessId()

getLastUpdateTime

protected long getLastUpdateTime()

getResourceInputStream

public InputStream getResourceInputStream(String name,
                                          String extension)

enableNetwork

public void enableNetwork(boolean enable)
                   throws IOException

Specified by:

enableNetwork in interface org.briarproject.onionwrapper.TorWrapper

Throws:

IOException

stop

public void stop()
          throws IOException,
                 InterruptedException

Specified by:

stop in interface org.briarproject.onionwrapper.TorWrapper

Throws:

IOException

InterruptedException

getTorExecutableFile

protected File getTorExecutableFile()

getObfs4ExecutableFile

public File getObfs4ExecutableFile()

Specified by:

getObfs4ExecutableFile in interface org.briarproject.onionwrapper.TorWrapper

getSnowflakeExecutableFile

protected File getSnowflakeExecutableFile()

installTorExecutable

protected void installTorExecutable()
                             throws IOException

Throws:

IOException

installObfs4Executable

protected void installObfs4Executable()
                               throws IOException

Throws:

IOException

installSnowflakeExecutable

protected void installSnowflakeExecutable()
                                   throws IOException

Throws:

IOException

setObserver

public void setObserver(@Nullable
                        org.briarproject.onionwrapper.TorWrapper.Observer arg0)

Specified by:

setObserver in interface org.briarproject.onionwrapper.TorWrapper

start

public void start()
           throws IOException,
                  InterruptedException

Specified by:

start in interface org.briarproject.onionwrapper.TorWrapper

Throws:

IOException

InterruptedException

extract

protected void extract(InputStream arg0,
                       File arg1)
                throws IOException

Throws:

IOException

getExecutableExtension

protected String getExecutableExtension()

waitForTorToStart

protected void waitForTorToStart(Process arg0)
                          throws InterruptedException,
                                 IOException

Throws:

InterruptedException

IOException

publishHiddenService

public org.briarproject.onionwrapper.TorWrapper.HiddenServiceProperties publishHiddenService(int arg0,
                                                                                             int arg1,
                                                                                             @Nullable
                                                                                             String arg2)
                                                                                      throws IOException

Specified by:

publishHiddenService in interface org.briarproject.onionwrapper.TorWrapper

Throws:

IOException

removeHiddenService

public void removeHiddenService(String arg0)
                         throws IOException

Specified by:

removeHiddenService in interface org.briarproject.onionwrapper.TorWrapper

Throws:

IOException

enableBridges

public void enableBridges(List<String> arg0)
                   throws IOException

Specified by:

enableBridges in interface org.briarproject.onionwrapper.TorWrapper

Throws:

IOException

disableBridges

public void disableBridges()
                    throws IOException

Specified by:

disableBridges in interface org.briarproject.onionwrapper.TorWrapper

Throws:

IOException

circuitStatus

public void circuitStatus(String arg0,
                          String arg1,
                          String arg2)

Specified by:

circuitStatus in interface net.freehaven.tor.control.EventHandler

streamStatus

public void streamStatus(String arg0,
                         String arg1,
                         String arg2)

Specified by:

streamStatus in interface net.freehaven.tor.control.EventHandler

orConnStatus

public void orConnStatus(String arg0,
                         String arg1)

Specified by:

orConnStatus in interface net.freehaven.tor.control.EventHandler

bandwidthUsed

public void bandwidthUsed(long arg0,
                          long arg1)

Specified by:

bandwidthUsed in interface net.freehaven.tor.control.EventHandler

newDescriptors

public void newDescriptors(List<String> arg0)

Specified by:

newDescriptors in interface net.freehaven.tor.control.EventHandler

message

public void message(String arg0,
                    String arg1)

Specified by:

message in interface net.freehaven.tor.control.EventHandler

unrecognized

public void unrecognized(String arg0,
                         String arg1)

Specified by:

unrecognized in interface net.freehaven.tor.control.EventHandler

controlConnectionClosed

public void controlConnectionClosed()

Specified by:

controlConnectionClosed in interface net.freehaven.tor.control.EventHandler

enableConnectionPadding

public void enableConnectionPadding(boolean arg0)
                             throws IOException

Specified by:

enableConnectionPadding in interface org.briarproject.onionwrapper.TorWrapper

Throws:

IOException

enableIpv6

public void enableIpv6(boolean arg0)
                throws IOException

Specified by:

enableIpv6 in interface org.briarproject.onionwrapper.TorWrapper

Throws:

IOException

getTorState

public org.briarproject.onionwrapper.TorWrapper.TorState getTorState()

Specified by:

getTorState in interface org.briarproject.onionwrapper.TorWrapper

isTorRunning

public boolean isTorRunning()

Specified by:

isTorRunning in interface org.briarproject.onionwrapper.TorWrapper