org.apache.camel.component.crypto.cms.sig

Class DefaultSignerInfo

java.lang.Object

org.apache.camel.component.crypto.cms.common.DefaultCryptoCmsConfiguration

org.apache.camel.component.crypto.cms.sig.DefaultSignerInfo

All Implemented Interfaces:

SignerInfo

@UriParams
public class DefaultSignerInfo
extends DefaultCryptoCmsConfiguration
implements SignerInfo

Reads the signer information from a Java keystore. You have to specify an alias for the private key entry, the signature algorithm, and the keystore.

Constructor Summary

Constructors

Constructor and Description
DefaultSignerInfo()

Method Summary

Modifier and Type	Method and Description
X509Certificate	getCertificate(org.apache.camel.Exchange exchange)
Certificate[]	getCertificateChain(org.apache.camel.Exchange exchange) Certificates which should be added to the certificate list of the Signed Data instance which belong to the private key.
protected char[]	getPassword(org.apache.camel.Exchange exchange)
PrivateKey	getPrivateKey(org.apache.camel.Exchange exchange)
protected String	getPrivateKeyAlias(org.apache.camel.Exchange exchange)
String	getSignatureAlgorithm(org.apache.camel.Exchange exchange)
org.bouncycastle.cms.CMSAttributeTableGenerator	getSignedAttributeGenerator(org.apache.camel.Exchange exchange) Returns the generator for the signed attributes.
org.bouncycastle.cms.CMSAttributeTableGenerator	getUnsignedAttributeGenerator(org.apache.camel.Exchange exchange) Returns the generator for the unsigned attributes.
void	setIncludeCertificates(boolean includeCertificates) If true then the certificate chain corresponding to the alias of the private key is added to the certificate list of the Signed Data instance.
void	setPassword(char[] password) Password of the private key.
void	setPrivateKeyAlias(String privateKeyAlias) Alias of the private key entry in the keystore which is used for signing.
void	setSignatureAlgorithm(String signatureAlgorithm) Signature algorithm.
void	setSignedAttributeGenerator(org.bouncycastle.cms.CMSAttributeTableGenerator signedAttributeGenerator) Signed attributes of the Signed Data instance.
void	setUnsignedAttributeGenerator(org.bouncycastle.cms.CMSAttributeTableGenerator unsignedAttributeGenerator) Unsigned attributes of the Signed Data instance.
String	toString()

Methods inherited from class org.apache.camel.component.crypto.cms.common.DefaultCryptoCmsConfiguration

getKeyStore, getKeyStoreParameters, setKeyStore, setKeyStoreParameters

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultSignerInfo

public DefaultSignerInfo()

Method Detail

setPassword

public void setPassword(char[] password)

Password of the private key. If not set then the password set in the parameter 'keystoreParameters' is used.

getPassword

protected char[] getPassword(org.apache.camel.Exchange exchange)
                      throws CryptoCmsException

Throws:

CryptoCmsException

getPrivateKeyAlias

protected String getPrivateKeyAlias(org.apache.camel.Exchange exchange)
                             throws CryptoCmsException

Throws:

CryptoCmsException

setPrivateKeyAlias

public void setPrivateKeyAlias(String privateKeyAlias)

Alias of the private key entry in the keystore which is used for signing.

setSignatureAlgorithm

public void setSignatureAlgorithm(String signatureAlgorithm)

Signature algorithm. The default algorithm is "SHA256withRSA".

Attention, the signature algorithm must fit to the signer private key.

setIncludeCertificates

public void setIncludeCertificates(boolean includeCertificates)

If true then the certificate chain corresponding to the alias of the private key is added to the certificate list of the Signed Data instance.

getSignatureAlgorithm

public String getSignatureAlgorithm(org.apache.camel.Exchange exchange)
                             throws CryptoCmsException

Specified by:

getSignatureAlgorithm in interface SignerInfo

Throws:

CryptoCmsException

getPrivateKey

public PrivateKey getPrivateKey(org.apache.camel.Exchange exchange)
                         throws CryptoCmsException

Specified by:

getPrivateKey in interface SignerInfo

Throws:

CryptoCmsException

getCertificate

public X509Certificate getCertificate(org.apache.camel.Exchange exchange)
                               throws CryptoCmsException

Specified by:

getCertificate in interface SignerInfo

Throws:

CryptoCmsException

getCertificateChain

public Certificate[] getCertificateChain(org.apache.camel.Exchange exchange)
                                  throws CryptoCmsException

Description copied from interface: SignerInfo

Certificates which should be added to the certificate list of the Signed Data instance which belong to the private key. Return an empty array if you do not want that the certificate chain of the private key to be added to the signature certificates.

Specified by:

getCertificateChain in interface SignerInfo

Throws:

CryptoCmsException

setSignedAttributeGenerator

public void setSignedAttributeGenerator(org.bouncycastle.cms.CMSAttributeTableGenerator signedAttributeGenerator)

Signed attributes of the Signed Data instance. By default contentType, signingTime, messageDigest, and id-aa-CMSAlgorithmProtection are set.

setUnsignedAttributeGenerator

public void setUnsignedAttributeGenerator(org.bouncycastle.cms.CMSAttributeTableGenerator unsignedAttributeGenerator)

Unsigned attributes of the Signed Data instance. By default no unsigned attribute is set.

getSignedAttributeGenerator

public org.bouncycastle.cms.CMSAttributeTableGenerator getSignedAttributeGenerator(org.apache.camel.Exchange exchange)
                                                                            throws CryptoCmsException

Description copied from interface: SignerInfo

Returns the generator for the signed attributes.

Specified by:

getSignedAttributeGenerator in interface SignerInfo

Throws:

CryptoCmsException

getUnsignedAttributeGenerator

public org.bouncycastle.cms.CMSAttributeTableGenerator getUnsignedAttributeGenerator(org.apache.camel.Exchange exchange)
                                                                              throws CryptoCmsException

Description copied from interface: SignerInfo

Returns the generator for the unsigned attributes. Can be null, then no unsigned attribute is generated.

Specified by:

getUnsignedAttributeGenerator in interface SignerInfo

Throws:

CryptoCmsException

toString

public String toString()

Overrides:

toString in class Object