info.guardianproject.netcipher

Class NetCipher

java.lang.Object

info.guardianproject.netcipher.NetCipher

public class NetCipher
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.net.Proxy	ORBOT_HTTP_PROXY
static java.net.Proxy	ORBOT_SOCKS_PROXY

Method Summary

Modifier and Type	Method and Description
static void	clearProxy() Clear the global HTTP proxy for all new HttpURLConnections and HttpsURLConnections that are created after this is called.
static javax.net.ssl.HttpsURLConnection	getCompatibleHttpsURLConnection(java.net.URL url) Get a HttpsURLConnection from a URL using a more compatible, but less strong, suite of ciphers.
static java.net.HttpURLConnection	getCompatibleHttpURLConnection(java.net.URL url) Get a HttpURLConnection from a URL.
static javax.net.ssl.HttpsURLConnection	getHttpsURLConnection(java.lang.String urlString) Get a HttpsURLConnection from a URL String using the best TLS configuration available on the device.
static javax.net.ssl.HttpsURLConnection	getHttpsURLConnection(android.net.Uri uri) Get a HttpsURLConnection from a Uri using the best TLS configuration available on the device.
static javax.net.ssl.HttpsURLConnection	getHttpsURLConnection(java.net.URI uri) Get a HttpsURLConnection from a URI using the best TLS configuration available on the device.
static javax.net.ssl.HttpsURLConnection	getHttpsURLConnection(java.net.URL url) Get a HttpsURLConnection from a URL using the best TLS configuration available on the device.
static javax.net.ssl.HttpsURLConnection	getHttpsURLConnection(java.net.URL url, boolean compatible) Get a HttpsURLConnection from a URL, and specify whether it should use a more compatible, but less strong, suite of ciphers.
static java.net.HttpURLConnection	getHttpURLConnection(java.lang.String urlString) Get a HttpURLConnection from a URL String.
static java.net.HttpURLConnection	getHttpURLConnection(android.net.Uri uri) Get a HttpURLConnection from a Uri.
static java.net.HttpURLConnection	getHttpURLConnection(java.net.URI uri) Get a HttpURLConnection from a URI.
static java.net.HttpURLConnection	getHttpURLConnection(java.net.URL url) Get a HttpURLConnection from a URL.
static java.net.HttpURLConnection	getHttpURLConnection(java.net.URL url, boolean compatible) Get a HttpURLConnection from a URL, and specify whether it should use a more compatible, but less strong, suite of ciphers.
static java.net.Proxy	getProxy() Get the currently active global HTTP Proxy.
static TlsOnlySocketFactory	getTlsOnlySocketFactory() Get a TlsOnlySocketFactory from NetCipher.
static TlsOnlySocketFactory	getTlsOnlySocketFactory(boolean compatible) Get a TlsOnlySocketFactory from NetCipher, and specify whether it should use a more compatible, but less strong, suite of ciphers.
static boolean	isNetCipherGetHttpURLConnectionUsingTor()
static boolean	isURLConnectionUsingTor() Makes a connection to check.torproject.org to read its results of whether the connection came via Tor or not.
static void	setProxy(java.net.Proxy proxy) Set the global HTTP proxy for all new HttpURLConnections and HttpsURLConnections that are created after this is called.
static void	setProxy(java.lang.String host, int port) Set the global HTTP proxy for all new HttpURLConnections and HttpsURLConnections that are created after this is called.
static void	useGlobalProxy() Call this method in Application.onCreate() to enable NetCipher to control the proxying.
static void	useGlobalProxyWithDNSLeaksOnAndroid7x() Deprecated.
static void	useTor() Set Orbot as the global HTTP proxy for all new HttpURLConnection s and HttpsURLConnections that are created after this is called.

Methods inherited from class java.lang.Object

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

Field Detail

ORBOT_HTTP_PROXY

public static final java.net.Proxy ORBOT_HTTP_PROXY

ORBOT_SOCKS_PROXY

public static final java.net.Proxy ORBOT_SOCKS_PROXY

Method Detail

setProxy

public static void setProxy(java.lang.String host,
                            int port)

Set the global HTTP proxy for all new HttpURLConnections and HttpsURLConnections that are created after this is called.

useTor() will override this setting. Traffic must be directed to Tor using the proxy settings, and Orbot has its own proxy settings for connections that need proxies to work. So if "use Tor" is enabled, as tested by looking for the static instance of Proxy, then no other proxy settings are allowed to override the current Tor proxy.

Parameters:

host - the IP address for the HTTP proxy to use globally

port - the port number for the HTTP proxy to use globally

See Also:

setProxy(Proxy), clearProxy()

setProxy

public static void setProxy(java.net.Proxy proxy)

Set the global HTTP proxy for all new HttpURLConnections and HttpsURLConnections that are created after this is called.

useTor() will override this setting. Traffic must be directed to Tor using the proxy settings, and Orbot has its own proxy settings for connections that need proxies to work. So if "use Tor" is enabled, as tested by looking for the static instance of Proxy, then no other proxy settings are allowed to override the current Tor proxy.

Parameters:

proxy - the HTTP proxy to use globally

See Also:

setProxy(String, int), clearProxy()

getProxy

public static java.net.Proxy getProxy()

Get the currently active global HTTP Proxy.

Returns:

the active HTTP Proxy

clearProxy

public static void clearProxy()

Clear the global HTTP proxy for all new HttpURLConnections and HttpsURLConnections that are created after this is called. This returns things to the default, proxy-less state.

useTor

public static void useTor()

Set Orbot as the global HTTP proxy for all new HttpURLConnection s and HttpsURLConnections that are created after this is called. This overrides all future calls to setProxy(Proxy), except to clear the proxy, e.g. #setProxy(null) or clearProxy().

Traffic must be directed to Tor using the proxy settings, and Orbot has its own proxy settings for connections that need proxies to work. So if "use Tor" is enabled, as tested by looking for the static instance of Proxy, then no other proxy settings are allowed to override the current Tor proxy.

See Also:

clearProxy(), useGlobalProxy()

isURLConnectionUsingTor

public static boolean isURLConnectionUsingTor()

Makes a connection to check.torproject.org to read its results of whether the connection came via Tor or not.

Returns:

true if check.torproject.org says connection is via Tor, false if not or on error

See Also:

check.torproject.org

isNetCipherGetHttpURLConnectionUsingTor

public static boolean isNetCipherGetHttpURLConnectionUsingTor()

useGlobalProxy

public static void useGlobalProxy()

Call this method in Application.onCreate() to enable NetCipher to control the proxying. This only works on Android 8.0 Oreo or newer. There needs to be a separate call to setProxy(Proxy) or useTor() for proxying to actually be enabled. clearProxy() will then remove the proxying when the global proxy control is in place, but the URLStreamHandlerFactory will stay in place until app restart.

See Also:

useTor(), setProxy(Proxy), setProxy(String, int), clearProxy(), URL.setURLStreamHandlerFactory(URLStreamHandlerFactory)

useGlobalProxyWithDNSLeaksOnAndroid7x

@Deprecated
public static void useGlobalProxyWithDNSLeaksOnAndroid7x()

Deprecated.

This is the same as useGlobalProxy() except that it can run on Android 7.x (SDK 24 and 25). The global proxying leaks DNS on Android 7.x, so this is not suitable for a privacy proxy. It will make access proxying work. It can also be used as a failsafe to help prevent leaks when the proxying is configured per-connection.

See Also:

useGlobalProxy(), useTor(), setProxy(Proxy), setProxy(String, int), clearProxy(), URL.setURLStreamHandlerFactory(URLStreamHandlerFactory)

getTlsOnlySocketFactory

public static TlsOnlySocketFactory getTlsOnlySocketFactory()

Get a TlsOnlySocketFactory from NetCipher.

See Also:

HttpsURLConnection.setDefaultSSLSocketFactory(SSLSocketFactory)

getTlsOnlySocketFactory

public static TlsOnlySocketFactory getTlsOnlySocketFactory(boolean compatible)

Get a TlsOnlySocketFactory from NetCipher, and specify whether it should use a more compatible, but less strong, suite of ciphers.

See Also:

HttpsURLConnection.setDefaultSSLSocketFactory(SSLSocketFactory)

getHttpURLConnection

public static java.net.HttpURLConnection getHttpURLConnection(java.net.URL url,
                                                              boolean compatible)
                                                       throws java.io.IOException

Get a HttpURLConnection from a URL, and specify whether it should use a more compatible, but less strong, suite of ciphers.

If useGlobalProxy() is called, this method will use the global proxy settings. For .onion addresses, this will still directly configure the proxy, but that should be the same exact settings.

Parameters:

url -

compatible -

Returns:

the url in an instance of HttpURLConnection

Throws:

java.io.IOException

java.lang.IllegalArgumentException - if the proxy or TLS setup is incorrect

getHttpsURLConnection

public static javax.net.ssl.HttpsURLConnection getHttpsURLConnection(java.lang.String urlString)
                                                              throws java.io.IOException

Get a HttpsURLConnection from a URL String using the best TLS configuration available on the device.

Parameters:

urlString -

Returns:

the URL in an instance of HttpsURLConnection

Throws:

java.io.IOException

java.lang.IllegalArgumentException - if the proxy or TLS setup is incorrect, or if an HTTP URL is given that does not support HTTPS

getHttpsURLConnection

public static javax.net.ssl.HttpsURLConnection getHttpsURLConnection(android.net.Uri uri)
                                                              throws java.io.IOException

Get a HttpsURLConnection from a Uri using the best TLS configuration available on the device.

Parameters:

uri -

Returns:

the uri in an instance of HttpsURLConnection

Throws:

java.io.IOException

java.lang.IllegalArgumentException - if the proxy or TLS setup is incorrect, or if an HTTP URL is given that does not support HTTPS

getHttpsURLConnection

public static javax.net.ssl.HttpsURLConnection getHttpsURLConnection(java.net.URI uri)
                                                              throws java.io.IOException

Get a HttpsURLConnection from a URI using the best TLS configuration available on the device.

Parameters:

uri -

Returns:

the uri in an instance of HttpsURLConnection

Throws:

java.io.IOException

java.lang.IllegalArgumentException - if the proxy or TLS setup is incorrect, or if an HTTP URL is given that does not support HTTPS

getHttpsURLConnection

public static javax.net.ssl.HttpsURLConnection getHttpsURLConnection(java.net.URL url)
                                                              throws java.io.IOException

Get a HttpsURLConnection from a URL using the best TLS configuration available on the device.

Parameters:

url -

Returns:

the url in an instance of HttpsURLConnection

Throws:

java.io.IOException

java.lang.IllegalArgumentException - if the proxy or TLS setup is incorrect, or if an HTTP URL is given that does not support HTTPS

getCompatibleHttpsURLConnection

public static javax.net.ssl.HttpsURLConnection getCompatibleHttpsURLConnection(java.net.URL url)
                                                                        throws java.io.IOException

Get a HttpsURLConnection from a URL using a more compatible, but less strong, suite of ciphers.

Parameters:

url -

Returns:

the url in an instance of HttpsURLConnection

Throws:

java.io.IOException

java.lang.IllegalArgumentException - if the proxy or TLS setup is incorrect, or if an HTTP URL is given that does not support HTTPS

getHttpsURLConnection

public static javax.net.ssl.HttpsURLConnection getHttpsURLConnection(java.net.URL url,
                                                                     boolean compatible)
                                                              throws java.io.IOException

Get a HttpsURLConnection from a URL, and specify whether it should use a more compatible, but less strong, suite of ciphers.

Parameters:

url -

compatible -

Returns:

the url in an instance of HttpsURLConnection

Throws:

java.io.IOException

java.lang.IllegalArgumentException - if the proxy or TLS setup is incorrect, or if an HTTP URL is given that does not support HTTPS

getCompatibleHttpURLConnection

public static java.net.HttpURLConnection getCompatibleHttpURLConnection(java.net.URL url)
                                                                 throws java.io.IOException

Get a HttpURLConnection from a URL. If the connection is https://, it will use a more compatible, but less strong, TLS configuration.

Parameters:

url -

Returns:

the url in an instance of HttpsURLConnection

Throws:

java.io.IOException

java.lang.IllegalArgumentException - if the proxy or TLS setup is incorrect

getHttpURLConnection

public static java.net.HttpURLConnection getHttpURLConnection(java.lang.String urlString)
                                                       throws java.io.IOException

Get a HttpURLConnection from a URL String. If it is an https:// link, then this will use the best TLS configuration available on the device.

Parameters:

urlString -

Returns:

the URL in an instance of HttpURLConnection

Throws:

java.io.IOException

java.lang.IllegalArgumentException - if the proxy or TLS setup is incorrect

getHttpURLConnection

public static java.net.HttpURLConnection getHttpURLConnection(android.net.Uri uri)
                                                       throws java.io.IOException

Get a HttpURLConnection from a Uri. If it is an https:// link, then this will use the best TLS configuration available on the device.

Parameters:

uri -

Returns:

the uri in an instance of HttpURLConnection

Throws:

java.io.IOException

java.lang.IllegalArgumentException - if the proxy or TLS setup is incorrect

getHttpURLConnection

public static java.net.HttpURLConnection getHttpURLConnection(java.net.URI uri)
                                                       throws java.io.IOException

Get a HttpURLConnection from a URI. If it is an https:// link, then this will use the best TLS configuration available on the device.

Parameters:

uri -

Returns:

the uri in an instance of HttpURLConnection

Throws:

java.io.IOException

java.lang.IllegalArgumentException - if the proxy or TLS setup is incorrect

getHttpURLConnection

public static java.net.HttpURLConnection getHttpURLConnection(java.net.URL url)
                                                       throws java.io.IOException

Get a HttpURLConnection from a URL. If it is an https:// link, then this will use the best TLS configuration available on the device.

Parameters:

url -

Returns:

the url in an instance of HttpURLConnection

Throws:

java.io.IOException

java.lang.IllegalArgumentException - if the proxy or TLS setup is incorrect