ej.net.util.ssl

Class SslContextBuilder

java.lang.Object

ej.net.util.ssl.SslContextBuilder

public class SslContextBuilder
extends Object

Helps to create an SSL context.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TLS_VERSION_1_2 TLS version 1.2.
static String	TLS_VERSION_1_3 TLS version 1.3.

Constructor Summary

Constructors

Constructor and Description
SslContextBuilder() Creates an SSL context builder.
SslContextBuilder(String protocol) Creates an SSL context builder for the given TLS protocol version.

Method Summary

Modifier and Type	Method and Description
void	addClientKey(byte[] privateKey, InputStream certificate) Adds the given client key and the associated self-signed certificate.
void	addClientKey(byte[] privateKey, InputStream certificate, InputStream... certificationChain) Adds the given client key and the associated certificate and certification chain to the key store.
void	addClientKey(InputStream privateKey, InputStream certificate) Adds the given client key and the associated self-signed certificate.
void	addClientKey(InputStream privateKey, InputStream certificate, InputStream... certificationChain) Adds the given client key and the associated certificate and certification chain to the key store.
void	addClientKey(String privateKeyPath, String certificatePath, String... certificationChainPaths) Adds the given client key and the associated certificate and certification chain to the key store.
void	addServerCertificate(InputStream certificate) Adds the given server certificate to the trust store.
void	addServerCertificate(String certificatePath) Adds the given server certificate to the trust store.
SSLContext	build() Creates an SSL context using the populated trust store and an empty key store.
SSLContext	build(String keyStorePassword) Creates an SSL context using the populated trust store and an the populated key store, using the given key store password.

Methods inherited from class java.lang.Object

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

Field Detail

TLS_VERSION_1_2

public static final String TLS_VERSION_1_2

TLS version 1.2.

See Also:

Constant Field Values

TLS_VERSION_1_3

public static final String TLS_VERSION_1_3

TLS version 1.3.

See Also:

Constant Field Values

Constructor Detail

SslContextBuilder

public SslContextBuilder()
                  throws GeneralSecurityException

Creates an SSL context builder.

Throws:

GeneralSecurityException - if an exception occurs while initializing the trust store or the key store.

SslContextBuilder

public SslContextBuilder(String protocol)
                  throws GeneralSecurityException

Creates an SSL context builder for the given TLS protocol version.

Parameters:

protocol - the TLS protocol version string.

Throws:

GeneralSecurityException - if an exception occurs while initializing the trust store or the key store.

See Also:

SSLContext.getInstance(String)

Method Detail

addClientKey

public void addClientKey(byte[] privateKey,
                         InputStream certificate)
                  throws GeneralSecurityException

Adds the given client key and the associated self-signed certificate.

Parameters:

privateKey - the private key to add.

certificate - the associated certificate.

Throws:

GeneralSecurityException - if the certificates could not be loaded or the private key could not be added.

addClientKey

public void addClientKey(byte[] privateKey,
                         InputStream certificate,
                         InputStream... certificationChain)
                  throws GeneralSecurityException

Adds the given client key and the associated certificate and certification chain to the key store.

Parameters:

privateKey - the private key to add.

certificate - the associated certificate.

certificationChain - the certification chain, ordered, the root certificate at the end.

Throws:

GeneralSecurityException - if the certificates could not be loaded or the private key could not be added.

addClientKey

public void addClientKey(InputStream privateKey,
                         InputStream certificate)
                  throws IOException,
                         GeneralSecurityException

Adds the given client key and the associated self-signed certificate.

Parameters:

privateKey - the private key to add.

certificate - the associated certificate.

Throws:

GeneralSecurityException - if the certificate could not be loaded or the private key could not be added.

IOException - if the given privateKey could not be read.

addClientKey

public void addClientKey(InputStream privateKey,
                         InputStream certificate,
                         InputStream... certificationChain)
                  throws IOException,
                         GeneralSecurityException

Adds the given client key and the associated certificate and certification chain to the key store.

Parameters:

privateKey - the private key to add.

certificate - the associated certificate.

certificationChain - the certification chain, ordered, the root certificate at the end.

Throws:

GeneralSecurityException - if the certificate could not be loaded or the private key could not be added.

IOException - if the given privateKey could not be read.

addClientKey

public void addClientKey(String privateKeyPath,
                         String certificatePath,
                         String... certificationChainPaths)
                  throws IOException,
                         GeneralSecurityException

Adds the given client key and the associated certificate and certification chain to the key store. Tries to find the resource in the application's classpath (using Class.getResourceAsStream(String)).

Parameters:

privateKeyPath - the path to the private key to add.

certificatePath - the path to the associated certificate.

certificationChainPaths - the paths to the certification chain, ordered, the root certificate at the end.

Throws:

GeneralSecurityException - if the certificate could not be loaded or the private key could not be added.

IOException - if the given privateKey could not be read.

addServerCertificate

public void addServerCertificate(InputStream certificate)
                          throws GeneralSecurityException

Adds the given server certificate to the trust store.

Parameters:

certificate - the certificate to add.

Throws:

GeneralSecurityException - if the certificate could not be loaded or added.

addServerCertificate

public void addServerCertificate(String certificatePath)
                          throws GeneralSecurityException,
                                 IOException

Adds the given server certificate to the trust store. Tries to find the resource in the application's classpath (using Class.getResourceAsStream(String)).

Parameters:

certificatePath - the path to the certificate to add.

Throws:

GeneralSecurityException - if the certificate could not be loaded or added.

IOException - if an I/O occurs when loading the resource.

build

public SSLContext build()
                 throws GeneralSecurityException

Creates an SSL context using the populated trust store and an empty key store.

Returns:

the created SSL context.

Throws:

GeneralSecurityException - if an exception occurred while creating the SSL context.

build

public SSLContext build(String keyStorePassword)
                 throws GeneralSecurityException

Creates an SSL context using the populated trust store and an the populated key store, using the given key store password.

Parameters:

keyStorePassword - the password of the key store.

Returns:

the created SSL context.

Throws:

GeneralSecurityException - if an exception occurred while creating the SSL context.