org.bouncycastle.mail.smime

Class SMIMESignedGenerator

java.lang.Object

org.bouncycastle.mail.smime.SMIMEGenerator

org.bouncycastle.mail.smime.SMIMESignedGenerator

public class SMIMESignedGenerator
extends SMIMEGenerator

general class for generating a pkcs7-signature message.

A simple example of usage.

      X509Certificate signCert = ...
      KeyPair         signKP = ...

      List certList = new ArrayList();

      certList.add(signCert);

      Store certs = new JcaCertStore(certList);

      SMIMESignedGenerator gen = new SMIMESignedGenerator();

      gen.addSignerInfoGenerator(new JcaSimpleSignerInfoGeneratorBuilder().setProvider("BC").build("SHA1withRSA", signKP.getPrivate(), signCert));

      gen.addCertificates(certs);

      MimeMultipart       smime = fact.generate(content);
 

Note: if you are using this class with AS2 or some other protocol that does not use "7bit" as the default content transfer encoding you will need to use the constructor that allows you to specify the default content transfer encoding, such as "binary".

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIGEST_GOST3411
static String	DIGEST_MD5
static String	DIGEST_RIPEMD128
static String	DIGEST_RIPEMD160
static String	DIGEST_RIPEMD256
static String	DIGEST_SHA1
static String	DIGEST_SHA224
static String	DIGEST_SHA256
static String	DIGEST_SHA384
static String	DIGEST_SHA512
static String	ENCRYPTION_DSA
static String	ENCRYPTION_ECDSA
static String	ENCRYPTION_ECGOST3410
static String	ENCRYPTION_GOST3410
static String	ENCRYPTION_RSA
static String	ENCRYPTION_RSA_PSS

Fields inherited from class org.bouncycastle.mail.smime.SMIMEGenerator

encoding, useBase64

Constructor Summary

Constructors

Constructor and Description
SMIMESignedGenerator() base constructor - default content transfer encoding 7bit
SMIMESignedGenerator(String defaultContentTransferEncoding) base constructor - default content transfer encoding explicitly set

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttributeCertificates(org.bouncycastle.util.Store certStore)
void	addAttributeCertificates(org.bouncycastle.x509.X509Store store) Deprecated. use addAttributeCertificates(Store)
void	addCertificates(org.bouncycastle.util.Store certStore)
void	addCertificatesAndCRLs(CertStore certStore) Deprecated. use addCertificates(Store) and addCRLs(Store)
void	addCRLs(org.bouncycastle.util.Store crlStore)
void	addSigner(PrivateKey key, X509Certificate cert, String digestOID) Deprecated. use addSignerInfoGenerator()
void	addSigner(PrivateKey key, X509Certificate cert, String digestOID, org.bouncycastle.asn1.cms.AttributeTable signedAttr, org.bouncycastle.asn1.cms.AttributeTable unsignedAttr) Deprecated. use addSignerInfoGenerator()
void	addSigner(PrivateKey key, X509Certificate cert, String encryptionOID, String digestOID) Deprecated. use addSignerInfoGenerator()
void	addSigner(PrivateKey key, X509Certificate cert, String encryptionOID, String digestOID, org.bouncycastle.asn1.cms.AttributeTable signedAttr, org.bouncycastle.asn1.cms.AttributeTable unsignedAttr) Deprecated. use addSignerInfoGenerator()
void	addSignerInfoGenerator(SignerInfoGenerator sigInfoGen)
void	addSigners(SignerInformationStore signerStore) Add a store of precalculated signers to the generator.
javax.mail.internet.MimeMultipart	generate(javax.mail.internet.MimeBodyPart content)
javax.mail.internet.MimeMultipart	generate(javax.mail.internet.MimeBodyPart content, Provider sigProvider) generate a signed object that contains an SMIME Signed Multipart object using the given provider.
javax.mail.internet.MimeMultipart	generate(javax.mail.internet.MimeBodyPart content, String sigProvider) Deprecated. use generate(MimeBodyPart)
javax.mail.internet.MimeMultipart	generate(javax.mail.internet.MimeMessage message, Provider sigProvider) generate a signed object that contains an SMIME Signed Multipart object using the given provider from the given MimeMessage
javax.mail.internet.MimeMultipart	generate(javax.mail.internet.MimeMessage message, String sigProvider) generate a signed object that contains an SMIME Signed Multipart object using the given provider from the given MimeMessage
javax.mail.internet.MimeBodyPart	generateCertificateManagement(Provider provider) Creates a certificate management message which is like a signed message with no content or signers but that still carries certificates and CRLs.
javax.mail.internet.MimeBodyPart	generateCertificateManagement(String provider) Creates a certificate management message which is like a signed message with no content or signers but that still carries certificates and CRLs.
javax.mail.internet.MimeBodyPart	generateEncapsulated(javax.mail.internet.MimeBodyPart content) generate a signed message with encapsulated content Note: doing this is strongly not recommended as it means a recipient of the message will have to be able to read the signature to read the message.
javax.mail.internet.MimeBodyPart	generateEncapsulated(javax.mail.internet.MimeBodyPart content, Provider sigProvider) Deprecated. use generateEncapsulated(content)
javax.mail.internet.MimeBodyPart	generateEncapsulated(javax.mail.internet.MimeBodyPart content, String sigProvider) Deprecated. use generateEncapsulated(content)
javax.mail.internet.MimeBodyPart	generateEncapsulated(javax.mail.internet.MimeMessage message, Provider sigProvider) Deprecated. use generateEncapsulated(content)
javax.mail.internet.MimeBodyPart	generateEncapsulated(javax.mail.internet.MimeMessage message, String sigProvider) Deprecated. use generateEncapsulated(content)
Map	getGeneratedDigests() Return a map of oids and byte arrays representing the digests calculated on the content during the last generate.

Methods inherited from class org.bouncycastle.mail.smime.SMIMEGenerator

createSymmetricKeyGenerator, makeContentBodyPart, makeContentBodyPart, setContentTransferEncoding

Methods inherited from class java.lang.Object

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

Field Detail

DIGEST_SHA1

public static final String DIGEST_SHA1

DIGEST_MD5

public static final String DIGEST_MD5

DIGEST_SHA224

public static final String DIGEST_SHA224

DIGEST_SHA256

public static final String DIGEST_SHA256

DIGEST_SHA384

public static final String DIGEST_SHA384

DIGEST_SHA512

public static final String DIGEST_SHA512

DIGEST_GOST3411

public static final String DIGEST_GOST3411

DIGEST_RIPEMD128

public static final String DIGEST_RIPEMD128

DIGEST_RIPEMD160

public static final String DIGEST_RIPEMD160

DIGEST_RIPEMD256

public static final String DIGEST_RIPEMD256

ENCRYPTION_RSA

public static final String ENCRYPTION_RSA

ENCRYPTION_DSA

public static final String ENCRYPTION_DSA

ENCRYPTION_ECDSA

public static final String ENCRYPTION_ECDSA

ENCRYPTION_RSA_PSS

public static final String ENCRYPTION_RSA_PSS

ENCRYPTION_GOST3410

public static final String ENCRYPTION_GOST3410

ENCRYPTION_ECGOST3410

public static final String ENCRYPTION_ECGOST3410

Constructor Detail

SMIMESignedGenerator

public SMIMESignedGenerator()

base constructor - default content transfer encoding 7bit

SMIMESignedGenerator

public SMIMESignedGenerator(String defaultContentTransferEncoding)

base constructor - default content transfer encoding explicitly set

Parameters:

defaultContentTransferEncoding - new default to use.

Method Detail

addSigner

public void addSigner(PrivateKey key,
             X509Certificate cert,
             String digestOID)
               throws IllegalArgumentException

Deprecated. use addSignerInfoGenerator()

add a signer - no attributes other than the default ones will be provided here.

Parameters:

key - key to use to generate the signature

cert - the public key certificate associated with the signer's key.

digestOID - object ID of the digest algorithm to use.

Throws:

IllegalArgumentException - any of the arguments are inappropriate

addSigner

public void addSigner(PrivateKey key,
             X509Certificate cert,
             String encryptionOID,
             String digestOID)
               throws IllegalArgumentException

Deprecated. use addSignerInfoGenerator()

add a signer - no attributes other than the default ones will be provided here.

Parameters:

key - key to use to generate the signature

cert - the public key certificate associated with the signer's key.

encryptionOID - object ID of the digest ecnryption algorithm to use.

digestOID - object ID of the digest algorithm to use.

Throws:

IllegalArgumentException - any of the arguments are inappropriate

addSigner

public void addSigner(PrivateKey key,
             X509Certificate cert,
             String digestOID,
             org.bouncycastle.asn1.cms.AttributeTable signedAttr,
             org.bouncycastle.asn1.cms.AttributeTable unsignedAttr)
               throws IllegalArgumentException

Deprecated. use addSignerInfoGenerator()

Add a signer with extra signed/unsigned attributes or overrides for the standard attributes. For example this method can be used to explictly set default attributes such as the signing time.

Parameters:

key - key to use to generate the signature

cert - the public key certificate associated with the signer's key.

digestOID - object ID of the digest algorithm to use.

signedAttr - signed attributes to be included in the signature.

unsignedAttr - unsigned attribitues to be included.

Throws:

IllegalArgumentException - any of the arguments are inappropriate

addSigner

public void addSigner(PrivateKey key,
             X509Certificate cert,
             String encryptionOID,
             String digestOID,
             org.bouncycastle.asn1.cms.AttributeTable signedAttr,
             org.bouncycastle.asn1.cms.AttributeTable unsignedAttr)
               throws IllegalArgumentException

Deprecated. use addSignerInfoGenerator()

Add a signer with extra signed/unsigned attributes or overrides for the standard attributes and a digest encryption algorithm. For example this method can be used to explictly set default attributes such as the signing time.

Parameters:

key - key to use to generate the signature

cert - the public key certificate associated with the signer's key.

encryptionOID - the digest encryption algorithm OID.

digestOID - object ID of the digest algorithm to use.

signedAttr - signed attributes to be included in the signature.

unsignedAttr - unsigned attribitues to be included.

Throws:

IllegalArgumentException - any of the arguments are inappropriate

addSigners

public void addSigners(SignerInformationStore signerStore)

Add a store of precalculated signers to the generator.

Parameters:

signerStore - store of signers

addSignerInfoGenerator

public void addSignerInfoGenerator(SignerInfoGenerator sigInfoGen)

addCertificatesAndCRLs

public void addCertificatesAndCRLs(CertStore certStore)
                            throws CertStoreException,
                                   SMIMEException

Deprecated. use addCertificates(Store) and addCRLs(Store)

add the certificates and CRLs contained in the given CertStore to the pool that will be included in the encoded signature block.

Note: this assumes the CertStore will support null in the get methods.

Parameters:

certStore - CertStore containing the certificates and CRLs to be added.

Throws:

CertStoreException

SMIMEException

addCertificates

public void addCertificates(org.bouncycastle.util.Store certStore)

addCRLs

public void addCRLs(org.bouncycastle.util.Store crlStore)

addAttributeCertificates

public void addAttributeCertificates(org.bouncycastle.util.Store certStore)

addAttributeCertificates

public void addAttributeCertificates(org.bouncycastle.x509.X509Store store)
                              throws CMSException

Deprecated. use addAttributeCertificates(Store)

Add the attribute certificates contained in the passed in store to the generator.

Parameters:

store - a store of Version 2 attribute certificates

Throws:

CMSException - if an error occurse processing the store.

getGeneratedDigests

public Map getGeneratedDigests()

Return a map of oids and byte arrays representing the digests calculated on the content during the last generate.

Returns:

a map of oids (as String objects) and byte[] representing digests.

generate

public javax.mail.internet.MimeMultipart generate(javax.mail.internet.MimeBodyPart content,
                                         String sigProvider)
                                           throws NoSuchAlgorithmException,
                                                  NoSuchProviderException,
                                                  SMIMEException

Deprecated. use generate(MimeBodyPart)

generate a signed object that contains an SMIME Signed Multipart object using the given provider.

Parameters:

content - the MimeBodyPart to be signed.

sigProvider - the provider to be used for the signature.

Returns:

a Multipart containing the content and signature.

Throws:

NoSuchAlgorithmException - if the required algorithms for the signature cannot be found.

NoSuchProviderException - if no provider can be found.

SMIMEException - if an exception occurs in processing the signature.

generate

public javax.mail.internet.MimeMultipart generate(javax.mail.internet.MimeBodyPart content,
                                         Provider sigProvider)
                                           throws NoSuchAlgorithmException,
                                                  SMIMEException

generate a signed object that contains an SMIME Signed Multipart object using the given provider.

Parameters:

content - the MimeBodyPart to be signed.

sigProvider - the provider to be used for the signature.

Returns:

a Multipart containing the content and signature.

Throws:

NoSuchAlgorithmException - if the required algorithms for the signature cannot be found.

SMIMEException - if an exception occurs in processing the signature.

generate

public javax.mail.internet.MimeMultipart generate(javax.mail.internet.MimeMessage message,
                                         String sigProvider)
                                           throws NoSuchAlgorithmException,
                                                  NoSuchProviderException,
                                                  SMIMEException

generate a signed object that contains an SMIME Signed Multipart object using the given provider from the given MimeMessage

Throws:

NoSuchAlgorithmException - if the required algorithms for the signature cannot be found.

NoSuchProviderException - if no provider can be found.

SMIMEException - if an exception occurs in processing the signature.

generate

public javax.mail.internet.MimeMultipart generate(javax.mail.internet.MimeMessage message,
                                         Provider sigProvider)
                                           throws NoSuchAlgorithmException,
                                                  SMIMEException

generate a signed object that contains an SMIME Signed Multipart object using the given provider from the given MimeMessage

Throws:

NoSuchAlgorithmException - if the required algorithms for the signature cannot be found.

NoSuchProviderException - if no provider can be found.

SMIMEException - if an exception occurs in processing the signature.

generate

public javax.mail.internet.MimeMultipart generate(javax.mail.internet.MimeBodyPart content)
                                           throws SMIMEException

Throws:

SMIMEException

generateEncapsulated

public javax.mail.internet.MimeBodyPart generateEncapsulated(javax.mail.internet.MimeBodyPart content)
                                                      throws SMIMEException

generate a signed message with encapsulated content

Note: doing this is strongly not recommended as it means a recipient of the message will have to be able to read the signature to read the message.

Throws:

SMIMEException

generateEncapsulated

public javax.mail.internet.MimeBodyPart generateEncapsulated(javax.mail.internet.MimeBodyPart content,
                                                    String sigProvider)
                                                      throws NoSuchAlgorithmException,
                                                             NoSuchProviderException,
                                                             SMIMEException

Deprecated. use generateEncapsulated(content)

generate a signed message with encapsulated content

Note: doing this is strongly not recommended as it means a recipient of the message will have to be able to read the signature to read the message.

Throws:

NoSuchAlgorithmException

NoSuchProviderException

SMIMEException

generateEncapsulated

public javax.mail.internet.MimeBodyPart generateEncapsulated(javax.mail.internet.MimeBodyPart content,
                                                    Provider sigProvider)
                                                      throws NoSuchAlgorithmException,
                                                             NoSuchProviderException,
                                                             SMIMEException

Deprecated. use generateEncapsulated(content)

generate a signed message with encapsulated content

Note: doing this is strongly not recommended as it means a recipient of the message will have to be able to read the signature to read the message.

Throws:

NoSuchAlgorithmException

NoSuchProviderException

SMIMEException

generateEncapsulated

public javax.mail.internet.MimeBodyPart generateEncapsulated(javax.mail.internet.MimeMessage message,
                                                    String sigProvider)
                                                      throws NoSuchAlgorithmException,
                                                             NoSuchProviderException,
                                                             SMIMEException

Deprecated. use generateEncapsulated(content)

generate a signed object that contains an SMIME Signed Multipart object using the given provider from the given MimeMessage.

Note: doing this is strongly not recommended as it means a recipient of the message will have to be able to read the signature to read the message.

Throws:

NoSuchAlgorithmException

NoSuchProviderException

SMIMEException

generateEncapsulated

public javax.mail.internet.MimeBodyPart generateEncapsulated(javax.mail.internet.MimeMessage message,
                                                    Provider sigProvider)
                                                      throws NoSuchAlgorithmException,
                                                             SMIMEException

Deprecated. use generateEncapsulated(content)

generate a signed object that contains an SMIME Signed Multipart object using the given provider from the given MimeMessage.

Note: doing this is strongly not recommended as it means a recipient of the message will have to be able to read the signature to read the message.

Throws:

NoSuchAlgorithmException

SMIMEException

generateCertificateManagement

public javax.mail.internet.MimeBodyPart generateCertificateManagement(String provider)
                                                               throws SMIMEException,
                                                                      NoSuchProviderException

Creates a certificate management message which is like a signed message with no content or signers but that still carries certificates and CRLs.

Returns:

a MimeBodyPart containing the certs and CRLs.

Throws:

SMIMEException

NoSuchProviderException

generateCertificateManagement

public javax.mail.internet.MimeBodyPart generateCertificateManagement(Provider provider)
                                                               throws SMIMEException

Creates a certificate management message which is like a signed message with no content or signers but that still carries certificates and CRLs.

Returns:

a MimeBodyPart containing the certs and CRLs.

Throws:

SMIMEException