de.larssh.utils.net

Class SecureConnections

java.lang.Object

de.larssh.utils.net.SecureConnections

public final class SecureConnections
extends Object

Utility class to simplify the handling of connection certificates.

Method getSocketFactoryTrusting(Path, String) highly simplifies trusting custom certificates by creating a SSLSocketFactory directly from a JKS (Java Key Store) file. Those key stores can be created and maintained using e.g. the KeyStore Explorer.

 Path jksFilePath = ...;
 String password = ...;
 SSLSocketFactory socketFactory = SecureConnections.getSocketFactoryTrusting(jksFilePath, password);

 URL url = ...;
 URLConnection urlConnection = url.openConnection();

 SecureConnections.getHttpsUrlConnection(urlConnection)
   .ifPresent(httpsUrlConnection -> httpsUrlConnection.setSSLSocketFactory(socketFactory));
 

Method Summary

Modifier and Type	Method and Description
static Optional<HttpsURLConnection>	getHttpsUrlConnection(URLConnection connection) Returns connection if it is of type HttpsURLConnection or Optional.empty().
static KeyManager[]	getKeyManagers(KeyStore keyStore, String password) Returns an array of KeyManagers for a given key store and password.
static SSLSocketFactory	getSocketFactory(KeyManager[] keyManagers) Creates a SSLSocketFactory based on key managers.
static SSLSocketFactory	getSocketFactory(KeyManager[] keyManagers, TrustManager[] trustManagers) Creates a SSLSocketFactory based on key managers and trust managers.
static SSLSocketFactory	getSocketFactory(TrustManager[] trustManagers) Creates a SSLSocketFactory based on trust managers.
static SSLSocketFactory	getSocketFactoryTrusting(Path jksFilePath, String password) Creates a SSLSocketFactory trusting the certificates inside JKS (Java Key Store) file.
static TrustManager[]	getTrustManagers(KeyStore keyStore) Returns an array of TrustManagers for a given key store and password.
static KeyStore	loadKeyStore(Path jksFilePath, String password) Loads a JKS (Java Key Store) file.

Methods inherited from class java.lang.Object

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

Method Detail

getHttpsUrlConnection

public static Optional<HttpsURLConnection> getHttpsUrlConnection(URLConnection connection)

Returns connection if it is of type HttpsURLConnection or Optional.empty().

Parameters:

connection - the connection to handle

Returns:

connection if it is of type HttpsURLConnection or Optional.empty()

getKeyManagers

public static KeyManager[] getKeyManagers(KeyStore keyStore,
                                          String password)
                                   throws UnrecoverableKeyException

Returns an array of KeyManagers for a given key store and password.

Parameters:

keyStore - key store

password - key store password

Returns:

array of KeyManagers

Throws:

UnrecoverableKeyException - if the key cannot be recovered (e.g. the given password is wrong).

getSocketFactory

public static SSLSocketFactory getSocketFactory(KeyManager[] keyManagers)

Creates a SSLSocketFactory based on key managers.

Parameters:

keyManagers - key manager

Returns:

SSL socket factory

getSocketFactory

public static SSLSocketFactory getSocketFactory(TrustManager[] trustManagers)

Creates a SSLSocketFactory based on trust managers.

Parameters:

trustManagers - trust manager

Returns:

SSL socket factory

getSocketFactory

public static SSLSocketFactory getSocketFactory(@Nullable
                                                KeyManager[] keyManagers,
                                                @Nullable
                                                TrustManager[] trustManagers)

Creates a SSLSocketFactory based on key managers and trust managers.

Parameters:

keyManagers - key manager

trustManagers - trust manager

Returns:

SSL socket factory

getSocketFactoryTrusting

public static SSLSocketFactory getSocketFactoryTrusting(Path jksFilePath,
                                                        String password)
                                                 throws CertificateException,
                                                        IOException

Creates a SSLSocketFactory trusting the certificates inside JKS (Java Key Store) file.

Parameters:

jksFilePath - path to the key store

password - key store password

Returns:

SSL socket factory

Throws:

CertificateException - if any of the certificates in the key store could not be loaded

IOException - if an I/O error occurs

getTrustManagers

public static TrustManager[] getTrustManagers(KeyStore keyStore)

Returns an array of TrustManagers for a given key store and password.

Parameters:

keyStore - key store

Returns:

array of TrustManagers

loadKeyStore

public static KeyStore loadKeyStore(Path jksFilePath,
                                    String password)
                             throws CertificateException,
                                    IOException

Loads a JKS (Java Key Store) file.

Parameters:

jksFilePath - path to the key store

password - key store password

Returns:

key store

Throws:

CertificateException - if any of the certificates in the key store could not be loaded

IOException - if an I/O error occurs