...
The Crypto Data Format integrates the Java Cryptographic Extension into Camel, allowing simple and flexible encryption and decryption of messages using Camel's familiar marshall and unmarshal formatting mechanism. It assumes marshalling to mean encryption to cyphertext and unmarshalling to mean decryption back to the original plaintext. This data format implements only symmetric (shared-key) encryption and decyption.
Options
...
Name | Type | Default | Description |
---|---|---|---|
|
|
|
...
The |
...
JCE |
...
algorithm |
...
name |
...
indicating |
...
the |
...
cryptographic |
...
algorithm |
...
that |
...
will |
...
be |
...
used. |
...
|
|
...
| A JCE AlgorithmParameterSpec used to initialize the Cipher. | ||
|
|
| the size of the buffer used in the signature process. |
|
|
| The name of the JCE Security Provider that should be used. |
|
|
| A byte array containing the Initialization Vector that will be used to initialize the Cipher. |
|
|
| Flag indicating that the configured IV should be inlined into the encrypted data stream. |
|
|
| The JCE algorithm name indicating the Message Authentication algorithm. |
|
|
| Flag indicating that a Message Authentication Code should be calculated and appended to the encrypted data. |
Basic Usage
At its most basic all that is required to encrypt/decrypt an exchange is a shared secret key. If one or more instances of the Crypto data format are configured with this key the format can be used to encrypt the payload in one route (or part of one) and decrypted in another. For example, using the Java DSL as follows:
...
...
In Spring the dataformat is configured first and then used in routes
...
Specifying the Encryption Algorithm
Changing the algorithm is a matter of supplying the JCE algorithm name. If you change the algorithm you will need to use a compatible key.
...
...
A list of the available algorithms in Java 7 is available via the Java Cryptography Architecture Standard Algorithm Name Documentation.
...
Some crypto algorithms, particularly block algorithms, require configuration with an initial block of data known as an Initialization Vector. In the JCE this is passed as an AlgorithmParameterSpec when the Cipher is initialized. To use such a vector with the CryptoDataFormat you can configure it with a byte[] containing the required data e.g.
...
...
or with spring, suppling a reference to a byte[]
...
...
The same vector is required in both the encryption and decryption phases. As it is not necessary to keep the IV a secret, the DataFormat allows for it to be inlined into the encrypted data and subsequently read out in the decryption phase to initialize the Cipher. To inline the IV set the /oinline flag.
...
...
or with spring.
...
...
For more information of the use of Initialization Vectors, consult
...
To avoid attacks against the encrypted data while it is in transit the CryptoDataFormat can also calculate a Message Authentication Code for the encrypted exchange contents based on a configurable MAC algorithm. The calculated HMAC is appended to the stream after encryption. It is separated from the stream in the decryption phase. The MAC is recalculated and verified against the transmitted version to insure nothing was tampered with in transit.For more information on Message Authentication Codes see http://en.wikipedia.org/wiki/HMAC
...
...
or with spring.
...
...
By default the HMAC is calculated using the HmacSHA1 mac algorithm though this can be easily changed by supplying a different algorithm name. See here for how to check what algorithms are available through the configured security providers
...
...
or with spring.
...
Supplying Keys Dynamically
...
CryptoDataFormat.KEY
"CamelCryptoKey"
...
...
or with spring.
...
PGPDataFormat Options
...
PGP Message
The PGP Data Formater can create and decrypt/verify PGP Messages of the following PGP packet structure (entries in brackets are optional and ellipses indicate repetition, comma represents sequential composition, and vertical bar separates alternatives):
Public Key Encrypted Session Key ..., Symmetrically Encrypted Data | Sym. Encrypted and Integrity Protected Data, (Compressed Data,) (One Pass Signature ...,) Literal Data, (Signature ...,)
Since Camel 2.16.0 the Compressed Data packet is optional, before it was mandatory.
PGPDataFormat Options
Name | Type | Default | Description |
---|---|---|---|
|
|
| The user ID of the key in the PGP keyring used during encryption. See also option |
|
|
| Since camel 2.12.2: PGP allows to encrypt the symmetric key by several asymmetric public receiver keys. You can specify here the User IDs or parts of User IDs of several public keys contained in the PGP keyring. If you just have one User ID, then you can also use the option |
|
|
| Password used when opening the private key (not used for encryption). |
|
|
| Filename of the keyring; must be accessible as a classpath resource (but you can specify a location in the file system by using the "file:" prefix). |
|
|
| Since camel 2.12.1: encryption keyring; you can not set the keyFileName and encryptionKeyRing at the same time. |
|
|
| Since Camel 2.11.0; optional User ID of the key in the PGP keyring used for signing (during encryption) or signature verification (during decryption). During the signature verification process the specified User ID restricts the public keys from the public keyring which can be used for the verification. If no User ID is specified for the signature verficiation then any public key in the public keyring can be used for the verification. Can also be only a part of a user ID. For example, if the user ID is "Test User <test@camel.com>" then you can use the part "Test User" or "<test@camel.com>" to address the User ID. |
|
|
| Since Camel 2.12.3: optional list of User IDs of the key in the PGP keyring used for signing (during encryption) or signature verification (during decryption). You can specify here the User IDs or parts of User IDs of several keys contained in the PGP keyring. If you just have one User ID, then you can also use the option |
|
|
| Since Camel 2.11.0: optional password used when opening the private key used for signing (during encryption). |
|
|
| Since Camel 2.11.0: optional filename of the keyring to use for signing (during encryption) or for signature verification (during decryption); must be accessible as a classpath resource (but you can specify a location in the file system by using the "file:" prefix). |
|
|
| Since camel 2.12.1: signature keyring; you can not set the signatureKeyFileName and signatureKeyRing at the same time. |
|
|
| Since camel 2.12.2: symmetric key encryption algorithm; possible values are defined in |
|
|
| Since camel 2.12.2: compression algorithm; possible values are defined in |
|
|
| Since camel 2.12.2: signature hash algorithm; possible values are defined in |
|
|
| This option will cause PGP to base64 encode the encrypted text, making it available for copy/paste, etc. |
|
|
| Adds an integrity check/sign into the encryption file. |
|
| Since Camel 2.12.2: provides passphrases corresponding to user Ids. If no passpharase can be found from the option | |
|
|
| Since Camel 2.13.0: controls the behavior for verifying the signature during unmarshaling. There are three values possible:
|
| String | "_CONSOLE" | Since camel 2.15.0: Sets the file name for the literal data packet. Can be overwritten by the header {@link Exchange#FILE_NAME}. " |
| boolean |
| Since Camel 2.16.0: Indicator whether the PGP Message shall be created with or without a Compressed Data packet. If the value is set to false, then no Compressed Data packet is added and the compressionAlgorithm value is ignored. Only used for marshaling. |
PGPDataFormat Message Headers
You can override the PGPDataFormat options by applying below headers into message dynamically.
...
.
Name | Type | Description |
---|---|---|
|
| Since Camel 2.11.0; filename of the keyring; will override existing setting directly on the PGPDataFormat. |
|
| Since Camel 2.12.1; the encryption keyring; will override existing setting directly on the PGPDataFormat. |
|
| Since Camel 2.11.0; the User ID of the key in the PGP keyring; will override existing setting directly on the PGPDataFormat. |
|
| Since camel 2.12.2: the User IDs of the key in the PGP keyring; will override existing setting directly on the PGPDataFormat. |
|
| Since Camel 2.11.0; password used when opening the private key; will override existing setting directly on the PGPDataFormat. |
|
| Since Camel 2.11.0; filename of the signature keyring; will override existing setting directly on the PGPDataFormat. |
|
| Since Camel 2.12.1; the signature keyring; will override existing setting directly on the PGPDataFormat. |
|
| Since Camel 2.11.0; the User ID of the signature key in the PGP keyring; will override existing setting directly on the PGPDataFormat. |
CamelPGPDataFormatSignatureKeyUserids | List<String> | Since Camel 2.12.3; the User IDs of the signature keys in the PGP keyring; will override existing setting directly on the PGPDataFormat. |
|
| Since Camel 2.11.0; password used when opening the signature private key; will override existing setting directly on the PGPDataFormat. |
|
| Since Camel 2.12.2; symmetric key encryption algorithm; will override existing setting directly on the PGPDataFormat. |
|
| Since Camel 2.12.2; signature hash algorithm; will override existing setting directly on the PGPDataFormat. |
|
| Since Camel 2.12.2; compression algorithm; will override existing setting directly on the PGPDataFormat. |
| Integer | Since Camel 2.12.3; number of public keys used for encrypting the symmectric key, set by PGPDataFormat during encryptiion process |
| Integer | Since Camel 2.12.3; number of private keys used for creating signatures, set by PGPDataFormat during signing process |
...
The following sample uses the popular PGP format for encrypting/decrypting files using the Bouncy Castle Java libraries:
...
...
The following sample performs signing + encryption, and then signature verification + decryption. It uses the same keyring for both signing and encryption, but you can obviously use different keys:
...
...
Or using Spring:
...
To work with the previous example you need the following
...
Install the command line utilities on linux
Code Block apt-get install gnupg Create your keyring, entering a secure password
Code Block gpg --gen-key If you need to import someone elses public key so that you can encrypt a file for them.
Code Block gpg --import <filename.key The following files should now exist and can be used to run the example
codels -l ~/.gnupg/pubring.gpg ~/.gnupg/secring.gpg
PGP Decrypting/Verifying of Messages Encrypted/Signed by Different Private/Public Keys
...
A PGP Data Formater can decrypt/verify messages which have been encrypted by different public keys or signed by different private keys. Just, provide the corresponding private keys in the secret keyring, the corresponding public keys in the public keyring, and the passphrases in the passphrase accessor.
...
...
- The functionality is especially useful to support the key exchange. If you want to exchange the private key for decrypting you can accept for a period of time messages which are either encrypted with the old or new corresponding public key. Or if the sender wants to exchange his signer private key, you can accept for a period of time, the old or new signer key.
- Technical background: The PGP encrypted data contains a Key ID of the public key which was used to encrypt the data. This Key ID can be used to locate the private key in the secret keyring to decrypt the data. The same mechanism is also used to locate the public key for verifying a signature. Therefore you no longer must specify User IDs for the unmarshaling.
...
If you verify a signature you not only want to verify the correctness of the signature but you also want check that the signature comes from a certain identity or a specific set of identities. Therefore it is possible to restrict the number of public keys from the public keyring which can be used for the verification of a signature.
...
- If the PGP content has several signatures the verification is successful as soon as one signature can be verified.
- If you do not want to restrict the signer identities for verification then do not specify the signature key User IDs. In this case all public keys in the public keyring are taken into account.
...
The PGP specification allows that one PGP data format can contain several signatures from different keys. Since Camel 2.13.3 it is possible to create such kind of PGP content via specifying signature User IDs which relate to several private keys in the secret keyring.
...
...
Support of Sub-Keys and Key Flags in PGP Data Format Marshaler
...
To use the Crypto dataformat in your camel routes you need to add the following dependency to your pom.
...
...