org.bouncycastle.cms

Class CMSEnvelopedGenerator

java.lang.Object

org.bouncycastle.cms.CMSEnvelopedGenerator

Direct Known Subclasses:

CMSAuthenticatedGenerator, CMSEnvelopedDataGenerator, CMSEnvelopedDataStreamGenerator

public class CMSEnvelopedGenerator
extends Object

General class for generating a CMS enveloped-data message.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AES128_CBC
static String	AES128_WRAP
static String	AES192_CBC
static String	AES192_WRAP
static String	AES256_CBC
static String	AES256_WRAP
static String	CAMELLIA128_CBC
static String	CAMELLIA128_WRAP
static String	CAMELLIA192_CBC
static String	CAMELLIA192_WRAP
static String	CAMELLIA256_CBC
static String	CAMELLIA256_WRAP
static String	CAST5_CBC
static String	DES_EDE3_CBC
static String	DES_EDE3_WRAP
static String	ECDH_SHA1KDF
static String	ECMQV_SHA1KDF
static String	IDEA_CBC
static String	RC2_CBC
static String	SEED_CBC
static String	SEED_WRAP
protected CMSAttributeTableGenerator	unprotectedAttributeGenerator

Constructor Summary

Constructors

Constructor and Description
CMSEnvelopedGenerator() base constructor
CMSEnvelopedGenerator(SecureRandom rand) constructor allowing specific source of randomness

Method Summary

Methods

Modifier and Type	Method and Description
void	addKEKRecipient(SecretKey key, byte[] keyIdentifier) Deprecated. use the addRecipientGenerator and JceKEKRecipientInfoGenerator
void	addKEKRecipient(SecretKey key, org.bouncycastle.asn1.cms.KEKIdentifier kekIdentifier) Deprecated. use the addRecipientGenerator and JceKEKRecipientInfoGenerator
void	addKeyAgreementRecipient(String agreementAlgorithm, PrivateKey senderPrivateKey, PublicKey senderPublicKey, X509Certificate recipientCert, String cekWrapAlgorithm, Provider provider) Deprecated. use the addRecipientGenerator and JceKeyAgreeRecipientInfoGenerator
void	addKeyAgreementRecipient(String agreementAlgorithm, PrivateKey senderPrivateKey, PublicKey senderPublicKey, X509Certificate recipientCert, String cekWrapAlgorithm, String provider) Deprecated. use the addRecipientGenerator and JceKeyAgreeRecipientInfoGenerator
void	addKeyAgreementRecipients(String agreementAlgorithm, PrivateKey senderPrivateKey, PublicKey senderPublicKey, Collection recipientCerts, String cekWrapAlgorithm, Provider provider) Deprecated. use the addRecipientGenerator and JceKeyAgreeRecipientInfoGenerator
void	addKeyAgreementRecipients(String agreementAlgorithm, PrivateKey senderPrivateKey, PublicKey senderPublicKey, Collection recipientCerts, String cekWrapAlgorithm, String provider) Deprecated. use the addRecipientGenerator and JceKeyAgreeRecipientInfoGenerator
void	addKeyTransRecipient(PublicKey key, byte[] subKeyId) Deprecated. use the addRecipientGenerator and JceKeyTransRecipientInfoGenerator
void	addKeyTransRecipient(X509Certificate cert) Deprecated. use the addRecipientGenerator and JceKeyTransRecipientInfoGenerator
void	addPasswordRecipient(CMSPBEKey pbeKey, String kekAlgorithmOid) Deprecated. use addRecipientGenerator and JcePasswordRecipientInfoGenerator
void	addRecipientInfoGenerator(RecipientInfoGenerator recipientGenerator) Add a generator to produce the recipient info required.
protected AlgorithmParameters	generateParameters(String encryptionOID, SecretKey encKey, Provider encProvider)
protected org.bouncycastle.asn1.x509.AlgorithmIdentifier	getAlgorithmIdentifier(String encryptionOID, AlgorithmParameters params)
void	setUnprotectedAttributeGenerator(CMSAttributeTableGenerator unprotectedAttributeGenerator)

Methods inherited from class java.lang.Object

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

Field Detail

DES_EDE3_CBC

public static final String DES_EDE3_CBC

RC2_CBC

public static final String RC2_CBC

IDEA_CBC

public static final String IDEA_CBC

See Also:

Constant Field Values

CAST5_CBC

public static final String CAST5_CBC

See Also:

Constant Field Values

AES128_CBC

public static final String AES128_CBC

AES192_CBC

public static final String AES192_CBC

AES256_CBC

public static final String AES256_CBC

CAMELLIA128_CBC

public static final String CAMELLIA128_CBC

CAMELLIA192_CBC

public static final String CAMELLIA192_CBC

CAMELLIA256_CBC

public static final String CAMELLIA256_CBC

SEED_CBC

public static final String SEED_CBC

DES_EDE3_WRAP

public static final String DES_EDE3_WRAP

AES128_WRAP

public static final String AES128_WRAP

AES192_WRAP

public static final String AES192_WRAP

AES256_WRAP

public static final String AES256_WRAP

CAMELLIA128_WRAP

public static final String CAMELLIA128_WRAP

CAMELLIA192_WRAP

public static final String CAMELLIA192_WRAP

CAMELLIA256_WRAP

public static final String CAMELLIA256_WRAP

SEED_WRAP

public static final String SEED_WRAP

ECDH_SHA1KDF

public static final String ECDH_SHA1KDF

ECMQV_SHA1KDF

public static final String ECMQV_SHA1KDF

unprotectedAttributeGenerator

protected CMSAttributeTableGenerator unprotectedAttributeGenerator

Constructor Detail

CMSEnvelopedGenerator

public CMSEnvelopedGenerator()

base constructor

CMSEnvelopedGenerator

public CMSEnvelopedGenerator(SecureRandom rand)

constructor allowing specific source of randomness

Parameters:

rand - instance of SecureRandom to use

Method Detail

setUnprotectedAttributeGenerator

public void setUnprotectedAttributeGenerator(CMSAttributeTableGenerator unprotectedAttributeGenerator)

addKeyTransRecipient

public void addKeyTransRecipient(X509Certificate cert)
                          throws IllegalArgumentException

Deprecated. use the addRecipientGenerator and JceKeyTransRecipientInfoGenerator

add a recipient.

Parameters:

cert - recipient's public key certificate

Throws:

IllegalArgumentException - if there is a problem with the certificate

addKeyTransRecipient

public void addKeyTransRecipient(PublicKey key,
                        byte[] subKeyId)
                          throws IllegalArgumentException

Deprecated. use the addRecipientGenerator and JceKeyTransRecipientInfoGenerator

add a recipient

Parameters:

key - the public key used by the recipient

subKeyId - the identifier for the recipient's public key

Throws:

IllegalArgumentException - if there is a problem with the key

addKEKRecipient

public void addKEKRecipient(SecretKey key,
                   byte[] keyIdentifier)

Deprecated. use the addRecipientGenerator and JceKEKRecipientInfoGenerator

add a KEK recipient.

Parameters:

key - the secret key to use for wrapping

keyIdentifier - the byte string that identifies the key

addKEKRecipient

public void addKEKRecipient(SecretKey key,
                   org.bouncycastle.asn1.cms.KEKIdentifier kekIdentifier)

Deprecated. use the addRecipientGenerator and JceKEKRecipientInfoGenerator

add a KEK recipient.

Parameters:

key - the secret key to use for wrapping

kekIdentifier - a KEKIdentifier structure (identifies the key)

addPasswordRecipient

public void addPasswordRecipient(CMSPBEKey pbeKey,
                        String kekAlgorithmOid)

Deprecated. use addRecipientGenerator and JcePasswordRecipientInfoGenerator

Parameters:

pbeKey - PBE key

kekAlgorithmOid - key encryption algorithm to use.

addKeyAgreementRecipient

public void addKeyAgreementRecipient(String agreementAlgorithm,
                            PrivateKey senderPrivateKey,
                            PublicKey senderPublicKey,
                            X509Certificate recipientCert,
                            String cekWrapAlgorithm,
                            String provider)
                              throws NoSuchProviderException,
                                     NoSuchAlgorithmException,
                                     InvalidKeyException

Deprecated. use the addRecipientGenerator and JceKeyAgreeRecipientInfoGenerator

Add a key agreement based recipient.

Parameters:

agreementAlgorithm - key agreement algorithm to use.

senderPrivateKey - private key to initialise sender side of agreement with.

senderPublicKey - sender public key to include with message.

recipientCert - recipient's public key certificate.

cekWrapAlgorithm - OID for key wrapping algorithm to use.

provider - provider to use for the agreement calculation.

Throws:

NoSuchProviderException - if the specified provider cannot be found

NoSuchAlgorithmException - if the algorithm requested cannot be found

InvalidKeyException - if the keys are inappropriate for the algorithm specified

addKeyAgreementRecipient

public void addKeyAgreementRecipient(String agreementAlgorithm,
                            PrivateKey senderPrivateKey,
                            PublicKey senderPublicKey,
                            X509Certificate recipientCert,
                            String cekWrapAlgorithm,
                            Provider provider)
                              throws NoSuchAlgorithmException,
                                     InvalidKeyException

Deprecated. use the addRecipientGenerator and JceKeyAgreeRecipientInfoGenerator

Add a key agreement based recipient.

Parameters:

agreementAlgorithm - key agreement algorithm to use.

senderPrivateKey - private key to initialise sender side of agreement with.

senderPublicKey - sender public key to include with message.

recipientCert - recipient's public key certificate.

cekWrapAlgorithm - OID for key wrapping algorithm to use.

provider - provider to use for the agreement calculation.

Throws:

NoSuchAlgorithmException - if the algorithm requested cannot be found

InvalidKeyException - if the keys are inappropriate for the algorithm specified

addKeyAgreementRecipients

public void addKeyAgreementRecipients(String agreementAlgorithm,
                             PrivateKey senderPrivateKey,
                             PublicKey senderPublicKey,
                             Collection recipientCerts,
                             String cekWrapAlgorithm,
                             String provider)
                               throws NoSuchProviderException,
                                      NoSuchAlgorithmException,
                                      InvalidKeyException

Deprecated. use the addRecipientGenerator and JceKeyAgreeRecipientInfoGenerator

Add multiple key agreement based recipients (sharing a single KeyAgreeRecipientInfo structure).

Parameters:

agreementAlgorithm - key agreement algorithm to use.

senderPrivateKey - private key to initialise sender side of agreement with.

senderPublicKey - sender public key to include with message.

recipientCerts - recipients' public key certificates.

cekWrapAlgorithm - OID for key wrapping algorithm to use.

provider - provider to use for the agreement calculation.

Throws:

NoSuchAlgorithmException - if the algorithm requested cannot be found

InvalidKeyException - if the keys are inappropriate for the algorithm specified

NoSuchProviderException

addKeyAgreementRecipients

public void addKeyAgreementRecipients(String agreementAlgorithm,
                             PrivateKey senderPrivateKey,
                             PublicKey senderPublicKey,
                             Collection recipientCerts,
                             String cekWrapAlgorithm,
                             Provider provider)
                               throws NoSuchAlgorithmException,
                                      InvalidKeyException

Deprecated. use the addRecipientGenerator and JceKeyAgreeRecipientInfoGenerator

Add multiple key agreement based recipients (sharing a single KeyAgreeRecipientInfo structure).

Parameters:

agreementAlgorithm - key agreement algorithm to use.

senderPrivateKey - private key to initialise sender side of agreement with.

senderPublicKey - sender public key to include with message.

recipientCerts - recipients' public key certificates.

cekWrapAlgorithm - OID for key wrapping algorithm to use.

provider - provider to use for the agreement calculation.

Throws:

NoSuchAlgorithmException - if the algorithm requested cannot be found

InvalidKeyException - if the keys are inappropriate for the algorithm specified

addRecipientInfoGenerator

public void addRecipientInfoGenerator(RecipientInfoGenerator recipientGenerator)

Add a generator to produce the recipient info required.

Parameters:

recipientGenerator - a generator of a recipient info object.

getAlgorithmIdentifier

protected org.bouncycastle.asn1.x509.AlgorithmIdentifier getAlgorithmIdentifier(String encryptionOID,
                                                                    AlgorithmParameters params)
                                                                         throws IOException

Throws:

IOException

generateParameters

protected AlgorithmParameters generateParameters(String encryptionOID,
                                     SecretKey encKey,
                                     Provider encProvider)
                                          throws CMSException

Throws:

CMSException