com.entrust.toolkit

Interface KeyAndCertContainer

All Known Implementing Classes:

KeyAndCertificateSource, User

public interface KeyAndCertContainer

Interface used to returned data from classes which contain Key and Certificate information.

Since:

7.2

See Also:

User, KeyAndCertificateSource

Method Summary

Modifier and Type	Method and Description
X509Certificate[]	getCaCertificateChain() Returns an array of CA certificates forming a chain to the user's root CA.
CollectionCS	getCertificateStore() Returns the main certificate store used for certificate validation.
java.security.PrivateKey	getDecryptionKey(Name issuer, java.lang.String serialNumber) Returns the decryption private key and serial number for the given issuer.
X509Certificate	getEncryptionCertificate() Returns the encryption certificate.
java.security.PrivateKey	getSigningKey() Returns the signing key stored in the KeyAndCertContainer
X509Certificate	getVerificationCertificate() Returns the verification certificate.

Method Detail

getSigningKey

java.security.PrivateKey getSigningKey()
                                throws UserNotLoggedInException

Returns the signing key stored in the KeyAndCertContainer

Returns:

The signing key as a PrivateKey object, or null if the user does not have a signing key.

Throws:

UserNotLoggedInException - if the user is not logged in.

getDecryptionKey

java.security.PrivateKey getDecryptionKey(Name issuer,
                                          java.lang.String serialNumber)
                                   throws UserNotLoggedInException

Returns the decryption private key and serial number for the given issuer.

Parameters:

issuer - the issuer of the certificate

serialNumber - the serial number of the certificate

Returns:

The decryption key as a PrivateKey object.

Throws:

UserNotLoggedInException - if the user is not logged in.

getCaCertificateChain

X509Certificate[] getCaCertificateChain()
                                 throws UserFatalException,
                                        UserNotLoggedInException

Returns an array of CA certificates forming a chain to the user's root CA.

The first element of the array is the immediate CA certificate and the last element is the top level trusted root certificate.

Returns:

The chain of CA certificates up to the top-level root CA.

Throws:

UserFatalException - thrown if the chain cannot be built.

UserNotLoggedInException - thrown if the user is not logged in.

getVerificationCertificate

X509Certificate getVerificationCertificate()
                                    throws UserNotLoggedInException

Returns the verification certificate.

The verification certificate is used to verify signatures that are created with the user's private signing key. This key/certificate pair can be used together to provide data integrity (assurance that data has not changed over time).

Returns:

the user's verification certificate

Throws:

UserNotLoggedInException - thrown if the user has not yet been logged in

getEncryptionCertificate

X509Certificate getEncryptionCertificate()
                                  throws UserNotLoggedInException

Returns the encryption certificate.

The encryption certificate is used to protect information that can only be unprotected with the user's private decryption key. This key/certificate pair can be used together to provide data protection (assurance that protected data cannot be read by anyone other than the user).

Returns:

the user's encryption certificate

Throws:

UserNotLoggedInException - thrown if the user has not yet been logged in

getCertificateStore

CollectionCS getCertificateStore()
                          throws UserNotLoggedInException

Returns the main certificate store used for certificate validation.

Returns:

The main certificate store.

Throws:

UserNotLoggedInException - thrown if the user is not logged in.