com.entrust.toolkit

Class CMSUtil

java.lang.Object

com.entrust.toolkit.CMSUtil

public final class CMSUtil
extends java.lang.Object

Contains various utility APIs related to CMS.

Since:

7.1

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.Object[]	getRecipientDecryptionKey(KeyAndCertificateSource keyAndCertificateSource, RecipientInfo[] recipients) Finds the user's decryption key that can be used to decrypt a message that contains the indicated recipient information.
static java.lang.Object[]	getRecipientDecryptionKey(User user, RecipientInfo[] recipients) Finds the user's decryption key that can be used to decrypt a message that contains the indicated recipient information.

Methods inherited from class java.lang.Object

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

Method Detail

getRecipientDecryptionKey

public static java.lang.Object[] getRecipientDecryptionKey(User user,
                                           RecipientInfo[] recipients)
                                                    throws NotARecipientException,
                                                           UserNotLoggedInException

Finds the user's decryption key that can be used to decrypt a message that contains the indicated recipient information.

The proper key is located based on the issuer DN and serial number in the recipient information; a key with a matching issuer DN and serial number is always searched for.

Note:

This method is only capable of searching recipient information that is in 'key transport' (KeyTransRecipientInfo) or 'key agreement' (KeyAgreeRecipientInfo) format and contains the key identifier in 'issuerAndSerialNumber' (IssuerAndSerialNumber format; all other formats of recipient information are ignored.

Parameters:

user - the user

recipients - the recipient information from the encrypted message

Returns:

contains the user's decryption key as a PrivateKey and the index of the matching recipient information as an Integer

Throws:

NotARecipientException - if the user is not included in the recipient information; not a valid recipient

UserNotLoggedInException - if the user is not logged in

getRecipientDecryptionKey

public static java.lang.Object[] getRecipientDecryptionKey(KeyAndCertificateSource keyAndCertificateSource,
                                           RecipientInfo[] recipients)
                                                    throws NotARecipientException

Finds the user's decryption key that can be used to decrypt a message that contains the indicated recipient information.

The proper key is located based on the issuer DN and serial number in the recipient information; a key with a matching issuer DN and serial number is always searched for.

Note:

This method is only capable of searching recipient information that is in 'key transport' (KeyTransRecipientInfo) or 'key agreement' (KeyAgreeRecipientInfo) format and contains the key identifier in 'issuerAndSerialNumber' (IssuerAndSerialNumber format; all other formats of recipient information are ignored.

Parameters:

keyAndCertificateSource - a user represented as a key and certificate source

recipients - the recipient information from the encrypted message

Returns:

contains the user's decryption key as a PrivateKey and the index of the matching recipient information as an Integer

Throws:

NotARecipientException - if the user is not included in the recipient information; not a valid recipient