Package org.kiwiproject.security

Class KiwiSecurity

java.lang.Object

org.kiwiproject.security.KiwiSecurity

public class KiwiSecurity
extends Object

Static utilities to create various security objects, such as SSLContext, KeyStore, KeyManager, and TrustManager.

WARNING: This is a low-level utility class. As such, many of its methods have a large number of arguments. This is simply a byproduct of the many different objects that are required by the JDK classes to create objects such as SSLContext. It is intended that this class will be used by other, higher-level, utilities at higher levels of abstraction.

Constructor Summary

Constructors

Constructor	Description
KiwiSecurity()

Method Summary

Modifier and Type	Method	Description
static SSLContext	createSslContext(String keyStorePath, String keyStorePassword, String trustStorePath, String trustStorePassword, String protocol)	Create a new SSLContext instance for the given paths, passwords, and protocol, assuming that the key and trust store types are KeyStoreType.JKS.
static SSLContext	createSslContext(String keyStorePath, String keyStorePassword, String keyStoreType, String trustStorePath, String trustStorePassword, String trustStoreType, String protocol)	Create a new SSLContext instance for the given paths, passwords, key and trust store types, and protocol.
static SSLContext	createSslContext(String keyStorePath, String keyStorePassword, String keyStoreType, String keyManagerAlgorithm, String trustStorePath, String trustStorePassword, String trustStoreType, String trustManagerAlgorithm, String protocol)	Create a new SSLContext instance for the given paths, passwords, key and trust store types, key and trust manager algorithms, and protocol.
static SSLContext	createSslContext(String keyStorePath, String keyStorePassword, String keyStoreType, String trustStorePath, String trustStorePassword, String trustStoreType, SSLContextProtocol protocol)	Create a new SSLContext instance for the given paths, passwords, and protocol, assuming that the key and trust store types are KeyStoreType.JKS.
static SSLContext	createSslContext(String keyStorePath, String keyStorePassword, String trustStorePath, String trustStorePassword, SSLContextProtocol protocol)	Create a new SSLContext instance for the given paths, passwords, and protocol, assuming that the key and trust store types are KeyStoreType.JKS.
static KeyManager[]	getKeyManagers(KeyStore keyStore, String keyStorePassword)	Get the key managers for the given KeyStore and key store password using the default algorithm.
static KeyManager[]	getKeyManagers(KeyStore keyStore, String keyStorePassword, String algorithm)	Get the key managers for the given KeyStore, key store password, and algorithm.
static Optional<KeyStore>	getKeyStore(String keyStoreType, String path, String password)	Return an Optional containing a KeyStore for the given KeyStoreType, path, and password, or an empty Optional if the arguments are (both) null.
static Optional<KeyStore>	getKeyStore(KeyStoreType keyStoreType, String path, String password)	Return an Optional containing a KeyStore for the given KeyStoreType, path, and password, or an empty Optional if the arguments are (both) null.
static TrustManager[]	getTrustManagers(KeyStore trustStore)	Get the trust managers for the given trust store using the default algorithm.
static TrustManager[]	getTrustManagers(KeyStore trustStore, String algorithm)	Get the trust managers for the given trust store and algorithm.

Methods inherited from class java.lang.Object

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

Constructor Detail

KiwiSecurity

public KiwiSecurity()

Method Detail

createSslContext

public static SSLContext createSslContext(@Nullable
                                          String keyStorePath,
                                          @Nullable
                                          String keyStorePassword,
                                          String trustStorePath,
                                          String trustStorePassword,
                                          SSLContextProtocol protocol)

Create a new SSLContext instance for the given paths, passwords, and protocol, assuming that the key and trust store types are KeyStoreType.JKS. Uses the default key and trust manager algorithms as defined by KeyManagerFactory and TrustManagerFactory.

If only the trust store is needed, supply null values for the keyStorePath and keyStorePassword.

Parameters:

keyStorePath - path to the key store

keyStorePassword - password of the key store

trustStorePath - path to the trust store

trustStorePassword - password of the trust store

protocol - the protocol to use

Returns:

a new SSLContext instance

Throws:

SSLContextException - if unable to create the SSLContext

See Also:

KeyStore, KeyManager, TrustManager, SSLContextProtocol, KeyManagerFactory.getDefaultAlgorithm(), TrustManagerFactory.getDefaultAlgorithm()

createSslContext

public static SSLContext createSslContext(@Nullable
                                          String keyStorePath,
                                          @Nullable
                                          String keyStorePassword,
                                          String trustStorePath,
                                          String trustStorePassword,
                                          String protocol)

Create a new SSLContext instance for the given paths, passwords, and protocol, assuming that the key and trust store types are KeyStoreType.JKS. Uses the default key and trust manager algorithms as defined by KeyManagerFactory and TrustManagerFactory.

If only the trust store is needed, supply null values for the keyStorePath and keyStorePassword.

Parameters:

keyStorePath - path to the key store

keyStorePassword - password of the key store

trustStorePath - path to the trust store

trustStorePassword - password of the trust store

protocol - the protocol to use

Returns:

a new SSLContext instance

Throws:

SSLContextException - if unable to create the SSLContext

See Also:

KeyStore, KeyManager, TrustManager, SSLContextProtocol, KeyManagerFactory.getDefaultAlgorithm(), TrustManagerFactory.getDefaultAlgorithm()

createSslContext

public static SSLContext createSslContext(@Nullable
                                          String keyStorePath,
                                          @Nullable
                                          String keyStorePassword,
                                          String keyStoreType,
                                          String trustStorePath,
                                          String trustStorePassword,
                                          String trustStoreType,
                                          SSLContextProtocol protocol)

Create a new SSLContext instance for the given paths, passwords, and protocol, assuming that the key and trust store types are KeyStoreType.JKS. Uses the default key and trust manager algorithms as defined by KeyManagerFactory and TrustManagerFactory. The key and trust store types should be one of the algorithms defined in KeyStoreType.

If only the trust store is needed, supply null values for the keyStorePath and keyStorePassword.

WARNING: While public, this is very low-level and not generally intended for client code to call directly. We recommend using createSslContext(String, String, String, String, SSLContextProtocol) or createSslContext(String, String, String, String, String). Kiwi also provides higher-level constructs in the org.kiwiproject.security package.

Parameters:

keyStorePath - path to the key store

keyStorePassword - password of the key store

keyStoreType - the key store type

trustStorePath - path to the trust store

trustStorePassword - password of the trust store

trustStoreType - the trust store type

protocol - the protocol to use

Returns:

a new SSLContext instance

Throws:

SSLContextException - if unable to create the SSLContext

See Also:

KeyStore, KeyManager, KeyManagerFactory.getDefaultAlgorithm(), TrustManager, TrustManagerFactory.getDefaultAlgorithm(), SSLContextProtocol, KeyStoreType

createSslContext

public static SSLContext createSslContext(@Nullable
                                          String keyStorePath,
                                          @Nullable
                                          String keyStorePassword,
                                          String keyStoreType,
                                          String trustStorePath,
                                          String trustStorePassword,
                                          String trustStoreType,
                                          String protocol)

Create a new SSLContext instance for the given paths, passwords, key and trust store types, and protocol. Uses the default key and trust manager algorithms as defined by KeyManagerFactory and TrustManagerFactory. The key and trust store types should be one of the algorithms defined in KeyStoreType.

If only the trust store is needed, supply null values for the keyStorePath and keyStorePassword.

WARNING: While public, this is very low-level and not generally intended for client code to call directly. We recommend using createSslContext(String, String, String, String, SSLContextProtocol) or createSslContext(String, String, String, String, String). Kiwi also provides higher-level constructs in the org.kiwiproject.security package.

Parameters:

keyStorePath - path to the key store

keyStorePassword - password of the key store

keyStoreType - the key store type

trustStorePath - path to the trust store

trustStorePassword - password of the trust store

trustStoreType - the trust store type

protocol - the protocol to use

Returns:

a new SSLContext instance

Throws:

SSLContextException - if unable to create the SSLContext

See Also:

KeyStore, KeyManager, KeyManagerFactory.getDefaultAlgorithm(), TrustManager, TrustManagerFactory.getDefaultAlgorithm(), SSLContextProtocol, KeyStoreType

createSslContext

public static SSLContext createSslContext(@Nullable
                                          String keyStorePath,
                                          @Nullable
                                          String keyStorePassword,
                                          @Nullable
                                          String keyStoreType,
                                          @Nullable
                                          String keyManagerAlgorithm,
                                          String trustStorePath,
                                          String trustStorePassword,
                                          String trustStoreType,
                                          String trustManagerAlgorithm,
                                          String protocol)

Create a new SSLContext instance for the given paths, passwords, key and trust store types, key and trust manager algorithms, and protocol. The key and trust store types should be one of the algorithms defined in KeyStoreType.

If only the trust store is needed, supply null values for the keyStorePath and keyStorePassword.

WARNING: While public, this is very low-level and not generally intended for client code to call directly. We recommend using createSslContext(String, String, String, String, SSLContextProtocol) or createSslContext(String, String, String, String, String). Kiwi also provides higher-level constructs in the org.kiwiproject.security package.

Parameters:

keyStorePath - path to the key store

keyStorePassword - password of the key store

keyStoreType - the key store type

keyManagerAlgorithm - the key manager algorithm

trustStorePath - path to the trust store

trustStorePassword - password of the trust store

trustStoreType - the trust store type

trustManagerAlgorithm - the trust manager algorithm

protocol - the protocol to use

Returns:

a new SSLContext instance

Throws:

SSLContextException - if unable to create the SSLContext

See Also:

KeyStore, KeyManager, KeyManagerFactory.getInstance(String), TrustManager, TrustManagerFactory.getInstance(String), SSLContextProtocol, KeyStoreType

getKeyStore

public static Optional<KeyStore> getKeyStore(KeyStoreType keyStoreType,
                                             String path,
                                             String password)

Return an Optional containing a KeyStore for the given KeyStoreType, path, and password, or an empty Optional if the arguments are (both) null.

Parameters:

keyStoreType - the type of key store

path - the path to the key store

password - the key store password

Returns:

an optional with a KeyStore or an empty optional

Throws:

IllegalArgumentException - if keyStoreType is blank

SSLContextException - if unable to create a KeyStore

See Also:

KeyStore.getInstance(String)

getKeyStore

public static Optional<KeyStore> getKeyStore(String keyStoreType,
                                             String path,
                                             String password)

Return an Optional containing a KeyStore for the given KeyStoreType, path, and password, or an empty Optional if the arguments are (both) null.

Parameters:

keyStoreType - the type of key store

path - the path to the key store

password - the key store password

Returns:

an optional with a KeyStore or an empty optional

Throws:

IllegalArgumentException - if keyStoreType is blank

SSLContextException - if unable to create a KeyStore

See Also:

KeyStore.getInstance(String)

getKeyManagers

public static KeyManager[] getKeyManagers(KeyStore keyStore,
                                          String keyStorePassword)

Get the key managers for the given KeyStore and key store password using the default algorithm.

Parameters:

keyStore - the key store

keyStorePassword - the key store's password

Returns:

an array of KeyManager

Throws:

SSLContextException - if unable to get the KeyManager array

See Also:

KeyManagerFactory.getDefaultAlgorithm()

getKeyManagers

public static KeyManager[] getKeyManagers(KeyStore keyStore,
                                          String keyStorePassword,
                                          String algorithm)

Get the key managers for the given KeyStore, key store password, and algorithm.

Parameters:

keyStore - the key store

keyStorePassword - the key store's password

algorithm - the key manager algorithm

Returns:

an array of KeyManager

Throws:

SSLContextException - if unable to get the KeyManager array

See Also:

KeyManagerFactory.getInstance(String)

getTrustManagers

public static TrustManager[] getTrustManagers(KeyStore trustStore)

Get the trust managers for the given trust store using the default algorithm.

Parameters:

trustStore - the trust store

Returns:

an array of TrustManager

Throws:

SSLContextException - if unable to get the TrustManager array

See Also:

TrustManagerFactory.getDefaultAlgorithm()

getTrustManagers

public static TrustManager[] getTrustManagers(KeyStore trustStore,
                                              String algorithm)

Get the trust managers for the given trust store and algorithm.

Parameters:

trustStore - the trust store

algorithm - the trust manager algorithm

Returns:

an array of TrustManager

Throws:

SSLContextException - if unable to get the TrustManager array

See Also:

TrustManagerFactory.getInstance(String)