Crypto (JCE)

Crypto (JCE)

Scheme: crypto
Syntax: crypto:cryptoOperation:name
Description: The crypto component is used for signing and verifying exchanges using the Signature Service of the Java Cryptographic Extension (JCE).
Deprecated:false
Maven: org.apache.camel/camel-crypto/2.17.0.redhat-630377

The crypto component is used for signing and verifying exchanges using the Signature Service of the Java Cryptographic Extension (JCE).

Name Kind Group Required Default Type Enum Description
cryptoOperation path producer true org.apache.camel.component.crypto.CryptoOperation sign
verify
Set the Crypto operation from that supplied after the crypto scheme in the endpoint uri e.g. crypto:sign sets sign as the operation. @param operation the operation supplied after the crypto scheme
name path producer true java.lang.String The logical name of this operation.
bridgeErrorHandler parameter consumer boolean Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN/ERROR level and ignored.
exceptionHandler parameter consumer (advanced) org.apache.camel.spi.ExceptionHandler To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored.
algorithm parameter producer SHA1WithDSA java.lang.String Sets the JCE name of the Algorithm that should be used for the signer.
alias parameter producer java.lang.String Sets the alias used to query the KeyStore for keys and {@link java.security.cert.Certificate Certificates} to be used in signing and verifying exchanges. This value can be provided at runtime via the message header {@link org.apache.camel.component.crypto.DigitalSignatureConstants#KEYSTORE_ALIAS}
bufferSize parameter producer 2048 java.lang.Integer Set the size of the buffer used to read in the Exchange payload data.
certificate parameter producer java.security.cert.Certificate Set the Certificate that should be used to verify the signature in the exchange based on its payload.
certificateName parameter producer java.lang.String Sets the reference name for a PrivateKey that can be fond in the registry.
clearHeaders parameter producer true boolean Determines if the Signature specific headers be cleared after signing and verification. Defaults to true, and should only be made otherwise at your extreme peril as vital private information such as Keys and passwords may escape if unset.
keystore parameter producer java.security.KeyStore Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges. A {@link KeyStore} is typically used with an alias, either one supplied in the Route definition or dynamically via the message header "CamelSignatureKeyStoreAlias". If no alias is supplied and there is only a single entry in the Keystore, then this single entry will be used.
keystoreName parameter producer java.lang.String Sets the reference name for a Keystore that can be fond in the registry.
keyStoreParameters parameter producer org.apache.camel.util.jsse.KeyStoreParameters Sets the KeyStore that can contain keys and Certficates for use in signing and verifying exchanges based on the given KeyStoreParameters. A {@link KeyStore} is typically used with an alias, either one supplied in the Route definition or dynamically via the message header "CamelSignatureKeyStoreAlias". If no alias is supplied and there is only a single entry in the Keystore, then this single entry will be used.
password parameter producer java.lang.String Sets the password used to access an aliased {@link PrivateKey} in the KeyStore.
privateKey parameter producer java.security.PrivateKey Set the PrivateKey that should be used to sign the exchange @param privateKey the key with with to sign the exchange.
privateKeyName parameter producer java.lang.String Sets the reference name for a PrivateKey that can be fond in the registry.
provider parameter producer java.lang.String Set the id of the security provider that provides the configured {@link Signature} algorithm. @param provider the id of the security provider
publicKey parameter producer java.security.PublicKey Set the PublicKey that should be used to verify the signature in the exchange.
publicKeyName parameter producer java.lang.String references that should be resolved when the context changes
secureRandom parameter producer java.security.SecureRandom Set the SecureRandom used to initialize the Signature service @param secureRandom the random used to init the Signature service
secureRandomName parameter producer java.lang.String Sets the reference name for a SecureRandom that can be fond in the registry.
signatureHeaderName parameter producer java.lang.String Set the name of the message header that should be used to store the base64 encoded signature. This defaults to 'CamelDigitalSignature'
exchangePattern parameter advanced InOnly org.apache.camel.ExchangePattern InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the default exchange pattern when creating an exchange
synchronous parameter advanced false boolean Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).