info.guardianproject.netcipher.client

Class StrongBuilderBase<T extends StrongBuilderBase,C>

java.lang.Object

info.guardianproject.netcipher.client.StrongBuilderBase<T,C>

All Implemented Interfaces:

StrongBuilder<T,C>

Direct Known Subclasses:

StrongConnectionBuilder

public abstract class StrongBuilderBase<T extends StrongBuilderBase,C>
extends java.lang.Object
implements StrongBuilder<T,C>

Builds an HttpUrlConnection that connects via Tor through Orbot.

Nested Class Summary

Nested classes/interfaces inherited from interface info.guardianproject.netcipher.client.StrongBuilder

StrongBuilder.Callback<C>

Field Summary

Fields

Modifier and Type	Field and Description
protected android.content.Context	context
protected java.net.Proxy.Type	proxyType
protected javax.net.ssl.SSLContext	sslContext
static java.lang.String	TOR_CHECK_URL
protected boolean	useWeakCiphers
protected boolean	validateTor

Constructor Summary

Constructors

Constructor and Description
StrongBuilderBase(android.content.Context context) Standard constructor.
StrongBuilderBase(StrongBuilderBase original) Copy constructor.

Method Summary

Modifier and Type	Method and Description
void	build(StrongBuilder.Callback<C> callback) Asynchronous version of build(), one that uses OrbotInitializer internally to get the status and checks the validity of the Tor connection (if requested).
java.net.Proxy	buildProxy(android.content.Intent status)
protected javax.net.ssl.SSLSocketFactory	buildSocketFactory()
protected void	checkTor(StrongBuilder.Callback<C> callback, android.content.Intent status, C connection)
protected abstract java.lang.String	get(android.content.Intent status, C connection, java.lang.String url) Performs an HTTP GET request using the supplied connection to a supplied URL, returning the String response or throws an Exception (e.g., cannot reach the server).
int	getHttpPort(android.content.Intent status)
int	getSocksPort(android.content.Intent status)
javax.net.ssl.SSLContext	getSSLContext()
boolean	supportsHttpProxy()
boolean	supportsSocksProxy()
T	withBestProxy() Call this to configure the Tor proxy from the results returned by Orbot, using the best available proxy (SOCKS if possible, else HTTP)
T	withHttpProxy() Call this to configure the Tor proxy from the results returned by Orbot, using the HTTP proxy.
T	withSocksProxy() Call this to configure the Tor proxy from the results returned by Orbot, using the SOCKS proxy.
T	withTorValidation() Call this if you want the builder to confirm that we are communicating over Tor, by reaching out to a Tor test server and confirming our connection status.
T	withTrustManagers(javax.net.ssl.TrustManager[] trustManagers) Applies your own custom TrustManagers, such as for replacing the stock keystore support with a custom keystore.
T	withWeakCiphers() Call this if you want a weaker set of supported ciphers, because you are running into compatibility problems with some server due to a cipher mismatch.

Methods inherited from class java.lang.Object

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

Methods inherited from interface info.guardianproject.netcipher.client.StrongBuilder

build

Field Detail

TOR_CHECK_URL

public static final java.lang.String TOR_CHECK_URL

See Also:

Constant Field Values

context

protected final android.content.Context context

proxyType

protected java.net.Proxy.Type proxyType

sslContext

@Nullable
protected javax.net.ssl.SSLContext sslContext

useWeakCiphers

protected boolean useWeakCiphers

validateTor

protected boolean validateTor

Constructor Detail

StrongBuilderBase

public StrongBuilderBase(android.content.Context context)

Standard constructor.

Parameters:

context - any Context will do; the StrongBuilderBase will hold onto the Application singleton

StrongBuilderBase

public StrongBuilderBase(StrongBuilderBase original)

Copy constructor.

Parameters:

original - builder to clone

Method Detail

get

protected abstract java.lang.String get(android.content.Intent status,
                                        C connection,
                                        java.lang.String url)
                                 throws java.lang.Exception

Performs an HTTP GET request using the supplied connection to a supplied URL, returning the String response or throws an Exception (e.g., cannot reach the server). This is used as part of validating the Tor connection.

Parameters:

status - the status Intent we got back from Orbot

connection - a connection of the type for the builder

url - an public Web page

Returns:

the String response from the GET request

Throws:

java.lang.Exception

withBestProxy

public T withBestProxy()

Call this to configure the Tor proxy from the results returned by Orbot, using the best available proxy (SOCKS if possible, else HTTP)

Specified by:

withBestProxy in interface StrongBuilder<T extends StrongBuilderBase,C>

Returns:

the builder

supportsHttpProxy

public boolean supportsHttpProxy()

Specified by:

supportsHttpProxy in interface StrongBuilder<T extends StrongBuilderBase,C>

Returns:

true if this builder supports HTTP proxies, false otherwise

withHttpProxy

public T withHttpProxy()

Call this to configure the Tor proxy from the results returned by Orbot, using the HTTP proxy.

Specified by:

withHttpProxy in interface StrongBuilder<T extends StrongBuilderBase,C>

Returns:

the builder

supportsSocksProxy

public boolean supportsSocksProxy()

Specified by:

supportsSocksProxy in interface StrongBuilder<T extends StrongBuilderBase,C>

Returns:

true if this builder supports SOCKS proxies, false otherwise

withSocksProxy

public T withSocksProxy()

Call this to configure the Tor proxy from the results returned by Orbot, using the SOCKS proxy.

Specified by:

withSocksProxy in interface StrongBuilder<T extends StrongBuilderBase,C>

Returns:

the builder

withTrustManagers

public T withTrustManagers(javax.net.ssl.TrustManager[] trustManagers)
                    throws java.security.NoSuchAlgorithmException,
                           java.security.KeyManagementException

Applies your own custom TrustManagers, such as for replacing the stock keystore support with a custom keystore.

Specified by:

withTrustManagers in interface StrongBuilder<T extends StrongBuilderBase,C>

Parameters:

trustManagers - the TrustManagers to use

Returns:

the builder

Throws:

java.security.NoSuchAlgorithmException

java.security.KeyManagementException

withWeakCiphers

public T withWeakCiphers()

Call this if you want a weaker set of supported ciphers, because you are running into compatibility problems with some server due to a cipher mismatch. The better solution is to fix the server.

Specified by:

withWeakCiphers in interface StrongBuilder<T extends StrongBuilderBase,C>

Returns:

the builder

withTorValidation

public T withTorValidation()

Call this if you want the builder to confirm that we are communicating over Tor, by reaching out to a Tor test server and confirming our connection status. By default, this is skipped. Adding this check adds security, but it has the chance of false negatives (e.g., we cannot reach that Tor server for some reason).

Specified by:

withTorValidation in interface StrongBuilder<T extends StrongBuilderBase,C>

Returns:

the builder

getSSLContext

@Nullable
public javax.net.ssl.SSLContext getSSLContext()

getSocksPort

public int getSocksPort(android.content.Intent status)

getHttpPort

public int getHttpPort(android.content.Intent status)

buildSocketFactory

@Nullable
protected javax.net.ssl.SSLSocketFactory buildSocketFactory()

buildProxy

@Nullable
public java.net.Proxy buildProxy(android.content.Intent status)

build

public void build(StrongBuilder.Callback<C> callback)

Description copied from interface: StrongBuilder

Asynchronous version of build(), one that uses OrbotInitializer internally to get the status and checks the validity of the Tor connection (if requested). Note that your callback methods may be invoked on any thread; do not assume that they will be called on any particular thread.

Specified by:

build in interface StrongBuilder<T extends StrongBuilderBase,C>

Parameters:

callback - Callback to get a connection handed to you for use, already set up for NetCipher

checkTor

protected void checkTor(StrongBuilder.Callback<C> callback,
                        android.content.Intent status,
                        C connection)