com.entrust.toolkit.credentials

Class MscapiKeyContainer

java.lang.Object

com.entrust.toolkit.credentials.MscapiKeyContainer

public final class MscapiKeyContainer
extends java.lang.Object

This class is a software representation of a Microsoft CryptoAPI (MS-CAPI) key container.

The purpose of this class is to provide a Card Management System (CardMS) with a representation of how the key/certificate of an Entrust user should be stored in MS-CAPI in order for Entrust MS-CAPI enabled applications to be able to use the digital identity they belong to. These objects are produced when the CardMS API is used to execute a key management operation for an Entrust user. It is the responsibility of the CardMS to write these structures to MS-CAPI following the key management operation.

An MS-CAPI key container consists of the following components, all of which must be stored in MS-CAPI by the CardMS:

• Key Container Name
• X.509 Certificate
• Private Key

In addition to these components, the software representation also provides the following (for informational purposes; these components are not stored in MS-CAPI):

• Entrust Certificate Type Identifier
• Entrust Certificate Definition Identifier

Since:

7.2

Method Summary

Modifier and Type	Method and Description
X509Certificate	getCert() Returns the user certificate that is to be stored in the MS-CAPI key container.
EntrustCertInfoId	getCertDefnId() Returns the Entrust certificate definition identifier associated with the key/certificate in this MS-CAPI key container.
EntrustCertInfoId	getCertTypeId() Returns the Entrust certificate type identifier associated with the key/certificate in this MS-CAPI key container.
EncryptedValue	getEncryptedPrivateKey() Returns the user private key in encrypted format that is to be stored in the MS-CAPI key container.
java.lang.String	getKeyContainerName() Returns the Entrust format MS-CAPI key container name.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getCertTypeId

public EntrustCertInfoId getCertTypeId()

Returns the Entrust certificate type identifier associated with the key/certificate in this MS-CAPI key container.

The certificate type identifier is not written to MS-CAPI; it is provided for informational purpose only.

Returns:

the certificate type identifier

getCertDefnId

public EntrustCertInfoId getCertDefnId()

Returns the Entrust certificate definition identifier associated with the key/certificate in this MS-CAPI key container.

The certificate definition identifier is not written to MS-CAPI; it is provided for informational purpose only.

Returns:

the certificate definition identifier

getKeyContainerName

public java.lang.String getKeyContainerName()

Returns the Entrust format MS-CAPI key container name.

Entrust application uses a special key container naming format to group key containers into a digital identity. In order for Entrust applications to be able to recognize this key/certificate as part of an Entrust digital identity, the specified key container name must be used.

Returns:

the MS-CAPI key container name

getCert

public X509Certificate getCert()

Returns the user certificate that is to be stored in the MS-CAPI key container.

Returns:

the certificate

getEncryptedPrivateKey

public EncryptedValue getEncryptedPrivateKey()

Returns the user private key in encrypted format that is to be stored in the MS-CAPI key container.

This component will only be set for keys that are server generated or being returned from backup. The private key will be encrypted with the client protocol encryption key that was provided during the CMP key management transaction. The private key must be decrypted by the CardMS prior to being stored in MS-CAPI.

For keys that are client generated, this private key will not be set. In this case, the key has already been generated by the CardMS. It is the responsibility of the CardMS to make sure the private key is stored in MS-CAPI as part of this key container.

Returns:

the private key in encrypted format if key was server generated or being returned from backup; null otherwise

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object