info.guardianproject.netcipher.client

Interface StrongBuilder<T extends StrongBuilder,C>

All Known Implementing Classes:

StrongBuilderBase, StrongConnectionBuilder

public interface StrongBuilder<T extends StrongBuilder,C>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	StrongBuilder.Callback<C> Callback to get a connection handed to you for use, already set up for NetCipher.

Method Summary

Modifier and Type	Method and Description
C	build(android.content.Intent status) Builds a connection, applying the configuration already specified in the builder.
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).
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.

Method Detail

withBestProxy

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)

Returns:

the builder

supportsHttpProxy

boolean supportsHttpProxy()

Returns:

true if this builder supports HTTP proxies, false otherwise

withHttpProxy

T withHttpProxy()

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

Returns:

the builder

supportsSocksProxy

boolean supportsSocksProxy()

Returns:

true if this builder supports SOCKS proxies, false otherwise

withSocksProxy

T withSocksProxy()

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

Returns:

the builder

withTrustManagers

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.

Parameters:

trustManagers - the TrustManagers to use

Returns:

the builder

Throws:

java.security.NoSuchAlgorithmException

java.security.KeyManagementException

withWeakCiphers

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.

Returns:

the builder

withTorValidation

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).

Returns:

the builder

build

C build(android.content.Intent status)
 throws java.lang.Exception

Builds a connection, applying the configuration already specified in the builder.

Parameters:

status - status Intent from OrbotInitializer

Returns:

the connection

Throws:

java.io.IOException

java.lang.Exception

build

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). Note that your callback methods may be invoked on any thread; do not assume that they will be called on any particular thread.

Parameters:

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