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 1: 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".

Note 2: between RFC 3851 and RFC 5751 the values used in the micalg parameter for signed messages changed. We will accept both, but the default is now to use RFC 5751. In the event you are dealing with an older style system you will also need to use a constructor that sets the micalgs table and call it with RFC3851_MICALGS.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	SMIMESignedGenerator.ContentSigner

Field Summary

Modifier and Type	Field and Description
private List<E>	_attributeCerts
private List<E>	_certStores
private Map<K, V>	_digests
private List<E>	_oldSigners
private List<E>	_signers
private List<E>	attrCertStores
private static final String	CERTIFICATE_MANAGEMENT_CONTENT
private List<E>	certStores
private List<E>	crlStores
private final String	defaultContentTransferEncoding
private static final String	DETACHED_SIGNATURE_TYPE
public static final String	DIGEST_GOST3411
public static final String	DIGEST_MD5
public static final String	DIGEST_RIPEMD128
public static final String	DIGEST_RIPEMD160
public static final String	DIGEST_RIPEMD256
public static final String	DIGEST_SHA1
public static final String	DIGEST_SHA224
public static final String	DIGEST_SHA256
public static final String	DIGEST_SHA384
public static final String	DIGEST_SHA512
private static final String	ENCAPSULATED_SIGNED_CONTENT_TYPE
public static final String	ENCRYPTION_DSA
public static final String	ENCRYPTION_ECDSA
public static final String	ENCRYPTION_ECGOST3410
public static final String	ENCRYPTION_GOST3410
public static final String	ENCRYPTION_RSA
public static final String	ENCRYPTION_RSA_PSS
private final Map<K, V>	micAlgs
public static final Map<K, V>	RFC3851_MICALGS
public static final Map<K, V>	RFC5751_MICALGS
private List<E>	signerInfoGens
public static final Map<K, V>	STANDARD_MICALGS

Inherited from org.bouncycastle.mail.smime.SMIMEGenerator:: encoding useBase64

Constructor Summary

Access	Constructor and Description
public	SMIMESignedGenerator() base constructor - default content transfer encoding 7bit
public	SMIMESignedGenerator(String new default to use. defaultContentTransferEncoding) base constructor - default content transfer encoding explicitly set
public	SMIMESignedGenerator(Map<K, V> a map of ANS1ObjectIdentifiers to strings hash algorithm names. micAlgs) base constructor - default content transfer encoding explicitly set
public	SMIMESignedGenerator(String new default to use. defaultContentTransferEncoding, Map<K, V> a map of ANS1ObjectIdentifiers to strings hash algorithm names. micAlgs) base constructor - default content transfer encoding explicitly set

Method Summary

Modifier and Type	Method and Description
public void	addAttributeCertificates(Store<T> certStore)
public void	addCertificates(Store<T> certStore)
public void	addCRLs(Store<T> crlStore)
private void	addHashHeader(StringBuffer header, List<E> signers)
public void	addSignerInfoGenerator(SignerInfoGenerator sigInfoGen)
public void	addSigners(SignerInformationStore store of signers signerStore) Add a store of precalculated signers to the generator.
public MimeMultipart	generate(MimeBodyPart content)
public MimeMultipart	generate(MimeMessage message)
public MimeBodyPart	Returns: a MimeBodyPart containing the certs and CRLs. generateCertificateManagement() Creates a certificate management message which is like a signed message with no content or signers but that still carries certificates and CRLs.
public MimeBodyPart	generateEncapsulated(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.
public MimeBodyPart	generateEncapsulated(MimeMessage message)
public Map<K, V>	Returns: a map of oids (as String objects) and byte[] representing digests. getGeneratedDigests() Return a map of oids and byte arrays representing the digests calculated on the content during the last generate.
private MimeMultipart	make(MimeBodyPart content)
private MimeBodyPart	makeEncapsulated(MimeBodyPart content)

Inherited from org.bouncycastle.mail.smime.SMIMEGenerator:: createSymmetricKeyGenerator makeContentBodyPart makeContentBodyPart setContentTransferEncoding

Field Detail

_attributeCerts	back to summary
private List<E> _attributeCerts

_certStores	back to summary
private List<E> _certStores

_digests	back to summary
private Map<K, V> _digests

_oldSigners	back to summary
private List<E> _oldSigners

_signers	back to summary
private List<E> _signers

attrCertStores	back to summary
private List<E> attrCertStores

CERTIFICATE_MANAGEMENT_CONTENT	back to summary
private static final String CERTIFICATE_MANAGEMENT_CONTENT

certStores	back to summary
private List<E> certStores

crlStores	back to summary
private List<E> crlStores

defaultContentTransferEncoding	back to summary
private final String defaultContentTransferEncoding

DETACHED_SIGNATURE_TYPE	back to summary
private static final String DETACHED_SIGNATURE_TYPE

DIGEST_GOST3411	back to summary
public static final String DIGEST_GOST3411

DIGEST_MD5	back to summary
public static final String DIGEST_MD5

DIGEST_RIPEMD128	back to summary
public static final String DIGEST_RIPEMD128

DIGEST_RIPEMD160	back to summary
public static final String DIGEST_RIPEMD160

DIGEST_RIPEMD256	back to summary
public static final String DIGEST_RIPEMD256

DIGEST_SHA1	back to summary
public static final String DIGEST_SHA1

DIGEST_SHA224	back to summary
public static final String DIGEST_SHA224

DIGEST_SHA256	back to summary
public static final String DIGEST_SHA256

DIGEST_SHA384	back to summary
public static final String DIGEST_SHA384

DIGEST_SHA512	back to summary
public static final String DIGEST_SHA512

ENCAPSULATED_SIGNED_CONTENT_TYPE	back to summary
private static final String ENCAPSULATED_SIGNED_CONTENT_TYPE

ENCRYPTION_DSA	back to summary
public static final String ENCRYPTION_DSA

ENCRYPTION_ECDSA	back to summary
public static final String ENCRYPTION_ECDSA

ENCRYPTION_ECGOST3410	back to summary
public static final String ENCRYPTION_ECGOST3410

ENCRYPTION_GOST3410	back to summary
public static final String ENCRYPTION_GOST3410

ENCRYPTION_RSA	back to summary
public static final String ENCRYPTION_RSA

ENCRYPTION_RSA_PSS	back to summary
public static final String ENCRYPTION_RSA_PSS

micAlgs	back to summary
private final Map<K, V> micAlgs

RFC3851_MICALGS	back to summary
public static final Map<K, V> RFC3851_MICALGS

RFC5751_MICALGS	back to summary
public static final Map<K, V> RFC5751_MICALGS

signerInfoGens	back to summary
private List<E> signerInfoGens

STANDARD_MICALGS	back to summary
public static final Map<K, V> STANDARD_MICALGS

Constructor Detail

SMIMESignedGenerator	back to summary
public SMIMESignedGenerator() base constructor - default content transfer encoding 7bit

SMIMESignedGenerator	back to summary
public SMIMESignedGenerator(String defaultContentTransferEncoding) base constructor - default content transfer encoding explicitly set Parameters defaultContentTransferEncoding:String new default to use.

SMIMESignedGenerator

back to summary

public SMIMESignedGenerator(String defaultContentTransferEncoding)

base constructor - default content transfer encoding explicitly set

Parameters

defaultContentTransferEncoding:String: new default to use.

SMIMESignedGenerator	back to summary
public SMIMESignedGenerator(Map<K, V> micAlgs) base constructor - default content transfer encoding explicitly set Parameters micAlgs:Map<K, V> a map of ANS1ObjectIdentifiers to strings hash algorithm names.

SMIMESignedGenerator

back to summary

public SMIMESignedGenerator(Map<K, V> micAlgs)

base constructor - default content transfer encoding explicitly set

Parameters

micAlgs:Map<K, V>: a map of ANS1ObjectIdentifiers to strings hash algorithm names.

SMIMESignedGenerator	back to summary
public SMIMESignedGenerator(String defaultContentTransferEncoding, Map<K, V> micAlgs) base constructor - default content transfer encoding explicitly set Parameters defaultContentTransferEncoding:String new default to use. micAlgs:Map<K, V> a map of ANS1ObjectIdentifiers to strings hash algorithm names.

SMIMESignedGenerator

back to summary

public SMIMESignedGenerator(String defaultContentTransferEncoding, Map<K, V> micAlgs)

base constructor - default content transfer encoding explicitly set

Parameters

defaultContentTransferEncoding:String: new default to use.
micAlgs:Map<K, V>: a map of ANS1ObjectIdentifiers to strings hash algorithm names.

Method Detail

addAttributeCertificates	back to summary
public void addAttributeCertificates(Store<T> certStore)

addCertificates	back to summary
public void addCertificates(Store<T> certStore)

addCRLs	back to summary
public void addCRLs(Store<T> crlStore)

addHashHeader	back to summary
private void addHashHeader(StringBuffer header, List<E> signers)

addSignerInfoGenerator	back to summary
public void addSignerInfoGenerator(SignerInfoGenerator sigInfoGen)

addSigners	back to summary
public void addSigners(SignerInformationStore signerStore) Add a store of precalculated signers to the generator. Parameters signerStore:SignerInformationStore store of signers

addSigners

back to summary

public void addSigners(SignerInformationStore signerStore)

Add a store of precalculated signers to the generator.

Parameters

signerStore:SignerInformationStore: store of signers

generate	back to summary
public MimeMultipart generate(MimeBodyPart content) throws SMIMEException

generate	back to summary
public MimeMultipart generate(MimeMessage message) throws SMIMEException

generateCertificateManagement	back to summary
public MimeBodyPart generateCertificateManagement() 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:MimeBodyPart a MimeBodyPart containing the certs and CRLs.

generateCertificateManagement

back to summary

public MimeBodyPart generateCertificateManagement() 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:MimeBodyPart: a MimeBodyPart containing the certs and CRLs.

generateEncapsulated	back to summary
public MimeBodyPart generateEncapsulated(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.

generateEncapsulated	back to summary
public MimeBodyPart generateEncapsulated(MimeMessage message) throws SMIMEException

getGeneratedDigests

back to summary

public Map<K, V> getGeneratedDigests()

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

Returns:Map<K, V>: a map of oids (as String objects) and byte[] representing digests.

make	back to summary
private MimeMultipart make(MimeBodyPart content) throws SMIMEException

makeEncapsulated	back to summary
private MimeBodyPart makeEncapsulated(MimeBodyPart content) throws SMIMEException

org.bouncycastle.mail.smime back to summary

private Class SMIMESignedGenerator.ContentSigner

Class Inheritance

extends Object
implements SMIMEStreamingProcessor

java.lang.Object
org.bouncycastle.mail.smime.SMIMESignedGenerator.ContentSigner

All Implemented Interfaces

org.bouncycastle.mail.smime.SMIMEStreamingProcessor

Field Summary

Modifier and Type	Field and Description
private final MimeBodyPart	content
private final boolean	encapsulate
private final boolean	noProvider

Constructor Summary

Access	Constructor and Description
pack-priv	ContentSigner(MimeBodyPart content, boolean encapsulate)

Method Summary

Modifier and Type	Method and Description
protected CMSSignedDataStreamGenerator	getGenerator()
public void	write(OutputStream out) Implements org.bouncycastle.mail.smime.SMIMEStreamingProcessor.write.
private void	writeBodyPart(OutputStream out, MimeBodyPart bodyPart)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

content	back to summary
private final MimeBodyPart content

encapsulate	back to summary
private final boolean encapsulate

noProvider	back to summary
private final boolean noProvider

Constructor Detail

ContentSigner	back to summary
pack-priv ContentSigner(MimeBodyPart content, boolean encapsulate)

Method Detail

getGenerator	back to summary
protected CMSSignedDataStreamGenerator getGenerator() throws CMSException

write	back to summary
public void write(OutputStream out) throws IOException Implements org.bouncycastle.mail.smime.SMIMEStreamingProcessor.write.

writeBodyPart	back to summary
private void writeBodyPart(OutputStream out, MimeBodyPart bodyPart) throws IOException, MessagingException

public Class SMIMESignedGenerator

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class SMIMESignedGenerator.ContentSigner

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail