com.entrust.toolkit.credentials

Class EntrustKeyStore

java.lang.Object

java.security.KeyStore

com.entrust.toolkit.credentials.EntrustKeyStore

public class EntrustKeyStore
extends java.security.KeyStore

The EntrustKeyStore class wraps the Java Security KeyStore model around an instance of the Entrust User class.

Do not instantiate this class using the KeyStore.getInstance because the method provides no means of passing a User object into the KeyStore. Always instantiate an EntrustKeyStore using its constructor.

Nested Class Summary

Nested classes/interfaces inherited from class java.security.KeyStore

java.security.KeyStore.Builder, java.security.KeyStore.CallbackHandlerProtection, java.security.KeyStore.Entry, java.security.KeyStore.LoadStoreParameter, java.security.KeyStore.PasswordProtection, java.security.KeyStore.PrivateKeyEntry, java.security.KeyStore.ProtectionParameter, java.security.KeyStore.SecretKeyEntry, java.security.KeyStore.TrustedCertificateEntry

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CA_CERTIFICATE
static java.lang.String	DECRYPTION_KEY
static java.lang.String	ENCRYPTION_CERTIFICATE
static java.lang.String	ENCRYPTION_KEY_PAIR_JTK_VERSION_6
static java.lang.String	ROOT_CA_CERTIFICATE
static java.lang.String	SIGNING_KEY
static java.lang.String	SIGNING_KEY_PAIR_JTK_VERSION_6
static java.lang.String	SUBCA
static java.lang.String	VERIFICATION_CERTIFICATE

Constructor Summary

Constructors

Constructor and Description
EntrustKeyStore(User user, boolean clientMode) Creates a new instance of the EntrustKeyStore, given a User object and the mode in which it should operate.

Method Summary

Methods

Modifier and Type	Method and Description
CollectionCS	getCertStore() Retrieves the user's certificate store.
User	getUser() Gets the Entrust user this Entrust key store is attached to.

Methods inherited from class java.security.KeyStore

aliases, containsAlias, deleteEntry, entryInstanceOf, getCertificate, getCertificateAlias, getCertificateChain, getCreationDate, getDefaultType, getEntry, getInstance, getInstance, getInstance, getKey, getProvider, getType, isCertificateEntry, isKeyEntry, load, load, setCertificateEntry, setEntry, setKeyEntry, setKeyEntry, size, store, store

Methods inherited from class java.lang.Object

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

Field Detail

SIGNING_KEY

public static final java.lang.String SIGNING_KEY

See Also:

Constant Field Values

DECRYPTION_KEY

public static final java.lang.String DECRYPTION_KEY

See Also:

Constant Field Values

VERIFICATION_CERTIFICATE

public static final java.lang.String VERIFICATION_CERTIFICATE

See Also:

Constant Field Values

ENCRYPTION_CERTIFICATE

public static final java.lang.String ENCRYPTION_CERTIFICATE

See Also:

Constant Field Values

CA_CERTIFICATE

public static final java.lang.String CA_CERTIFICATE

See Also:

Constant Field Values

SUBCA

public static final java.lang.String SUBCA

See Also:

Constant Field Values

ROOT_CA_CERTIFICATE

public static final java.lang.String ROOT_CA_CERTIFICATE

See Also:

Constant Field Values

SIGNING_KEY_PAIR_JTK_VERSION_6

public static final java.lang.String SIGNING_KEY_PAIR_JTK_VERSION_6

See Also:

Constant Field Values

ENCRYPTION_KEY_PAIR_JTK_VERSION_6

public static final java.lang.String ENCRYPTION_KEY_PAIR_JTK_VERSION_6

See Also:

Constant Field Values

Constructor Detail

EntrustKeyStore

public EntrustKeyStore(User user,
               boolean clientMode)

Creates a new instance of the EntrustKeyStore, given a User object and the mode in which it should operate.

The User must already be logged in. If the KeyStore is to be used as the source of keys and verification for an SSL server, then clientMode must be set to false. If it is to be used as the source of keys and verification for an SSL client, clientMode must be set to true.

Parameters:

user - an Entrust User (already logged in)

clientMode - false if keys are for SSL server, true if keys are for SSL client

Method Detail

getCertStore

public CollectionCS getCertStore()
                          throws UserNotLoggedInException

Retrieves the user's certificate store.

The certificate store is used by the Entrust trust verifier.

Returns:

The user's certificate store.

Throws:

UserNotLoggedInException

getUser

public User getUser()

Gets the Entrust user this Entrust key store is attached to.

Returns:

the Entrust user

Since:

7.2