Package jenkins.test.https

Class KeyStoreManager

java.lang.Object

jenkins.test.https.KeyStoreManager

public final class KeyStoreManager
extends Object

Manages a Java keystore file.

Constructor Summary

Constructors

Constructor	Description
KeyStoreManager(Path path)	Creates a new instance using the default keystore type.
KeyStoreManager(Path path, String password)	Creates a new instance using the default keystore type.
KeyStoreManager(Path path, String password, String type)	Creates a new instance using the specified keystore type.

Method Summary

Modifier and Type	Method	Description
SSLContext	buildClientSSLContext()	Build a custom SSL context that trusts the default certificates as well as those in the current keystore.
SSLContext	buildServerSSLContext()	Build server context for server usage.
void	configureWebClient(org.htmlunit.WebClient wc)
String	getPassword()
Path	getPath()
String[]	getTruststoreJavaOptions()
String	getType()
URL	getURL()
void	save()	Persists the current keystore to disk.
void	setCertificateEntry(String alias, X509Certificate certificate)
void	setKeyEntry(String host, PrivateKey privateKey, Certificate[] certificates)

Methods inherited from class java.lang.Object

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

Constructor Details

KeyStoreManager

public KeyStoreManager(@NonNull
 Path path)
                throws CertificateException,
KeyStoreException,
IOException,
NoSuchAlgorithmException

Creates a new instance using the default keystore type.

Parameters:

path - path of the keystore file. If it exists, it will be loaded automatically.

Throws:

CertificateException

KeyStoreException

IOException

NoSuchAlgorithmException

KeyStoreManager

public KeyStoreManager(@NonNull
 Path path,
 @CheckForNull
 String password)
                throws CertificateException,
KeyStoreException,
IOException,
NoSuchAlgorithmException

Creates a new instance using the default keystore type.

Parameters:

path - path of the keystore file. If it exists, it will be loaded automatically.

password - password for the keystore file.

Throws:

CertificateException

KeyStoreException

IOException

NoSuchAlgorithmException

KeyStoreManager

public KeyStoreManager(@NonNull
 Path path,
 @CheckForNull
 String password,
 @NonNull
 String type)
                throws CertificateException,
KeyStoreException,
IOException,
NoSuchAlgorithmException

Creates a new instance using the specified keystore type.

Parameters:

path - path of the keystore file. If it exists, it will be loaded automatically.

password - password for the keystore file.

type - type of the keystore file.

Throws:

CertificateException

KeyStoreException

IOException

NoSuchAlgorithmException

Method Details

getPassword

public String getPassword()

Returns:

the password for the managed keystore

getPath

public Path getPath()

Returns:

the path where the managed keystore is persisted to. Make sure save() has been called before using the path.

getType

public String getType()

Returns:

the type of the managed keystore.

getURL

public URL getURL()

Returns:

returns the URL representation of the keystore file.

Make sure save() has been called before using the path.

save

public void save()
          throws IOException,
KeyStoreException,
NoSuchAlgorithmException,
CertificateException

Persists the current keystore to disk.

Throws:

IOException

KeyStoreException

NoSuchAlgorithmException

CertificateException

buildClientSSLContext

@NonNull
public SSLContext buildClientSSLContext()
                                 throws NoSuchAlgorithmException,
KeyStoreException,
IOException,
CertificateException,
KeyManagementException

Build a custom SSL context that trusts the default certificates as well as those in the current keystore.

Throws:

NoSuchAlgorithmException

KeyStoreException

IOException

CertificateException

KeyManagementException

buildServerSSLContext

public SSLContext buildServerSSLContext()

Build server context for server usage.

Returns:

a SSLContext instance configured with the key store.

setCertificateEntry

public void setCertificateEntry(String alias,
 X509Certificate certificate)
                         throws KeyStoreException

Throws:

KeyStoreException

See Also:

• KeyStore.setCertificateEntry(String, Certificate)

setKeyEntry

public void setKeyEntry(String host,
 PrivateKey privateKey,
 Certificate[] certificates)
                 throws KeyStoreException

Throws:

KeyStoreException

See Also:

• KeyStore.setKeyEntry(String, byte[], Certificate[])

getTruststoreJavaOptions

public String[] getTruststoreJavaOptions()

configureWebClient

public void configureWebClient(org.htmlunit.WebClient wc)