org.springframework.vault.support

Class CertificateBundle

java.lang.Object

org.springframework.vault.support.Certificate

org.springframework.vault.support.CertificateBundle

public class CertificateBundle
extends Certificate

Value object representing a certificate bundle consisting of a private key, the certificate and the issuer certificate. Certificate and keys can be either DER or PEM encoded. DER-encoded certificates can be converted to a KeySpec and X509Certificate.

Author:

Mark Paluch

See Also:

getPrivateKeySpec(), Certificate.getX509Certificate(), Certificate.getIssuingCaCertificate()

Method Summary

Modifier and Type	Method and Description
KeyStore	createKeyStore(String keyAlias) Create a KeyStore from this CertificateBundle containing the private key and certificate chain.
KeyStore	createKeyStore(String keyAlias, boolean includeCaChain) Create a KeyStore from this CertificateBundle containing the private key and certificate chain.
String	getPrivateKey()
KeySpec	getPrivateKeySpec() Retrieve the private key as KeySpec.
List<X509Certificate>	getX509IssuerCertificates() Retrieve the issuing CA certificates as list of X509Certificate.
static CertificateBundle	of(String serialNumber, String certificate, String issuingCaCertificate, String privateKey) Create a CertificateBundle given a private key with certificates and the serial number.

Methods inherited from class org.springframework.vault.support.Certificate

createTrustStore, getCertificate, getIssuingCaCertificate, getSerialNumber, getX509Certificate, getX509IssuerCertificate, of

Methods inherited from class java.lang.Object

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

Method Detail

of

public static CertificateBundle of(String serialNumber,
                                   String certificate,
                                   String issuingCaCertificate,
                                   String privateKey)

Create a CertificateBundle given a private key with certificates and the serial number.

Parameters:

serialNumber - must not be empty or null.

certificate - must not be empty or null.

issuingCaCertificate - must not be empty or null.

privateKey - must not be empty or null.

Returns:

the CertificateBundle

getPrivateKey

public String getPrivateKey()

Returns:

the private key (decrypted form, PEM or DER-encoded)

getPrivateKeySpec

public KeySpec getPrivateKeySpec()

Retrieve the private key as KeySpec. Only supported if private key is DER-encoded.

Returns:

the private KeySpec. KeyFactory can generate a PrivateKey from this KeySpec.

createKeyStore

public KeyStore createKeyStore(String keyAlias)

Create a KeyStore from this CertificateBundle containing the private key and certificate chain. Only supported if certificate and private key are DER-encoded.

Parameters:

keyAlias - the key alias to use.

Returns:

the KeyStore containing the private key and certificate chain.

createKeyStore

public KeyStore createKeyStore(String keyAlias,
                               boolean includeCaChain)

Create a KeyStore from this CertificateBundle containing the private key and certificate chain. Only supported if certificate and private key are DER-encoded.

Parameters:

keyAlias - the key alias to use.

includeCaChain - whether to include the certificate authority chain instead of just the issuer certificate.

Returns:

the KeyStore containing the private key and certificate chain.

Since:

2.3.3

getX509IssuerCertificates

public List<X509Certificate> getX509IssuerCertificates()

Retrieve the issuing CA certificates as list of X509Certificate. Only supported if certificates are DER-encoded.

Returns:

the issuing CA X509Certificate.

Since:

2.3.3