com.mulesoft.modules.cryptography.internal.jce

Class JceOperations

java.lang.Object

com.mulesoft.modules.cryptography.internal.jce.JceOperations

public class JceOperations
extends Object

JCE operations.

Since:

1.0

Constructor Summary

Constructors

Constructor and Description
JceOperations()

Method Summary

Modifier and Type	Method and Description
InputStream	jceDecrypt(JceConfiguration config, InputStream content, JceEncryptionKeyAlgorithmSelection algorithmSelection, JceKeySelection keySelection) Decrypt a stream using JCE, with a key.
InputStream	jceDecryptPbe(InputStream content, String algorithm, String password, String passwordSalt, Integer iterationCount) Decrypt a stream using JCE, with a password.
InputStream	jceEncrypt(JceConfiguration config, InputStream content, JceEncryptionKeyAlgorithmSelection algorithmSelection, JceKeySelection keySelection) Encrypt a stream using JCE, with a key.
InputStream	jceEncryptPbe(InputStream content, String algorithm, String password, String passwordSalt, Integer iterationCount) Encrypt a stream using JCE, with a password.
String	jceSign(JceConfiguration config, InputStream content, JceSignatureKeyAlgorithm algorithm, JceKeySelection keySelection) Sign a stream using JCE, with a key.
String	jceSignPbe(InputStream content, String algorithm, String password, String passwordSalt, Integer iterationCount) Sign a stream using JCE, with a key.
void	jceValidate(JceConfiguration config, InputStream value, String expected, JceSignatureKeyAlgorithm algorithm, JceKeySelection keySelection) Validate a stream against a signature, using a key.
void	jceValidatePbe(InputStream value, String expected, String algorithm, String password, String passwordSalt, Integer iterationCount) Validate a stream against a signature, using a key.

Methods inherited from class java.lang.Object

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

Constructor Detail

JceOperations

public JceOperations()

Method Detail

jceEncrypt

@MediaType(value="application/octet-stream",
           strict=false)
 @Throws(value={EncryptionErrorTypeProvider.class,ParametersErrorTypeProvider.class})
 @Execution(value=CPU_INTENSIVE)
public InputStream jceEncrypt(@Config
                                                                                                                                                                                                                           JceConfiguration config,
                                                                                                                                                                                                                           @Content
                                                                                                                                                                                                                           InputStream content,
                                                                                                                                                                                                                           @ParameterGroup(name="Algorithm selection")
                                                                                                                                                                                                                           JceEncryptionKeyAlgorithmSelection algorithmSelection,
                                                                                                                                                                                                                           @ParameterGroup(name="Key selection")
                                                                                                                                                                                                                           JceKeySelection keySelection)

Encrypt a stream using JCE, with a key.

Parameters:

config - the JCE configuration

content - the content to encrypt

algorithmSelection - the algorithm, either from a predefined enumeration or custom cipher string

keySelection - the key used to encrypt

Returns:

the encrypted data in binary form

jceDecrypt

@MediaType(value="application/octet-stream",
           strict=false)
 @Throws(value={DecryptionErrorTypeProvider.class,ParametersErrorTypeProvider.class})
 @Execution(value=CPU_INTENSIVE)
public InputStream jceDecrypt(@Config
                                                                                                                                                                                                                           JceConfiguration config,
                                                                                                                                                                                                                           @Content
                                                                                                                                                                                                                           InputStream content,
                                                                                                                                                                                                                           @ParameterGroup(name="Algorithm selection")
                                                                                                                                                                                                                           JceEncryptionKeyAlgorithmSelection algorithmSelection,
                                                                                                                                                                                                                           @ParameterGroup(name="Key selection")
                                                                                                                                                                                                                           JceKeySelection keySelection)

Decrypt a stream using JCE, with a key.

Parameters:

config - the JCE configuration

content - the content to decrypt

algorithmSelection - the algorithm, either from a predefined enumeration or custom cipher string

keySelection - the key used to decrypt

Returns:

the original unencrypted data

jceSign

@MediaType(value="text/plain",
           strict=false)
 @Throws(value=SignatureErrorTypeProvider.class)
 @Execution(value=CPU_INTENSIVE)
public String jceSign(@Config
                                                                                                                                                                JceConfiguration config,
                                                                                                                                                                @Content
                                                                                                                                                                InputStream content,
                                                                                                                                                                @Optional(defaultValue="HmacSHA256")
                                                                                                                                                                JceSignatureKeyAlgorithm algorithm,
                                                                                                                                                                @ParameterGroup(name="Key selection")
                                                                                                                                                                JceKeySelection keySelection)

Sign a stream using JCE, with a key.

Parameters:

config - the JCE configuration

content - the content to sign

algorithm - the algorithm used for signing

keySelection - the key used to sign

Returns:

the standalone signature (does not include the original data)

jceValidate

@Validator
 @Throws(value=ValidationErrorTypeProvider.class)
 @Execution(value=CPU_INTENSIVE)
public void jceValidate(@Config
                                                                                                                      JceConfiguration config,
                                                                                                                      @Optional(defaultValue="#[payload]")
                                                                                                                      InputStream value,
                                                                                                                      String expected,
                                                                                                                      @Optional(defaultValue="HmacSHA256")
                                                                                                                      JceSignatureKeyAlgorithm algorithm,
                                                                                                                      @ParameterGroup(name="Key selection")
                                                                                                                      JceKeySelection keySelection)

Validate a stream against a signature, using a key.

Parameters:

config - the JCE configuration

value - the message to authenticate

expected - the signature to validate

algorithm - the algorithm used for signing

keySelection - the key used for signing

jceEncryptPbe

@MediaType(value="application/octet-stream",
           strict=false)
 @Throws(value={EncryptionErrorTypeProvider.class,ParametersErrorTypeProvider.class})
 @Execution(value=CPU_INTENSIVE)
public InputStream jceEncryptPbe(@Content
                                                                                                                                                                                                                              InputStream content,
                                                                                                                                                                                                                              @OfValues(value=PbeEncryptionAlgorithmValueProvider.class) @Optional(defaultValue="PBKDF2withHmacSHA512__AES256__CBC__PKCS5Padding")
                                                                                                                                                                                                                              String algorithm,
                                                                                                                                                                                                                              @Password
                                                                                                                                                                                                                              String password,
                                                                                                                                                                                                                              @Summary(value="Recommended minimum: 16 bytes of random data to ensure uniqueness and prevent rainbow table attacks. The salt must be encoded in UTF-8 and cannot be modified after creation.")
                                                                                                                                                                                                                              String passwordSalt,
                                                                                                                                                                                                                              @Summary(value="Recommended minimum: 100,000 iterations to slow down brute-force attacks in modern hardware.")
                                                                                                                                                                                                                              Integer iterationCount)

Encrypt a stream using JCE, with a password.

Parameters:

content - the content to encrypt

algorithm - the algorithm for generating a key from the password

password - the password for encryption

passwordSalt - the password salt used to sign. Recommended minimum: 16 bytes of random data to ensure uniqueness and prevent rainbow table attacks. The salt is encoded in UTF-8 and cannot be modified after creation.

iterationCount - the iteration count used to sign. Recommended minimum: 100,000 iterations to slow down brute-force attacks in modern hardware.

Returns:

the encrypted data in binary form

jceDecryptPbe

@MediaType(value="application/octet-stream",
           strict=false)
 @Throws(value={DecryptionErrorTypeProvider.class,ParametersErrorTypeProvider.class})
 @Execution(value=CPU_INTENSIVE)
public InputStream jceDecryptPbe(@Content
                                                                                                                                                                                                                              InputStream content,
                                                                                                                                                                                                                              @OfValues(value=PbeEncryptionAlgorithmValueProvider.class) @Optional(defaultValue="PBKDF2withHmacSHA512__AES256__CBC__PKCS5Padding")
                                                                                                                                                                                                                              String algorithm,
                                                                                                                                                                                                                              @Password
                                                                                                                                                                                                                              String password,
                                                                                                                                                                                                                              @Summary(value="Recommended minimum: 16 bytes of random data to ensure uniqueness and prevent rainbow table attacks. The salt must be encoded in UTF-8 and cannot be modified after creation.") @Optional
                                                                                                                                                                                                                              String passwordSalt,
                                                                                                                                                                                                                              @Summary(value="Recommended minimum: 100,000 iterations to slow down brute-force attacks in modern hardware.") @Optional(defaultValue="0")
                                                                                                                                                                                                                              Integer iterationCount)

Decrypt a stream using JCE, with a password.

Parameters:

content - the content to decrypt

algorithm - the algorithm for generating a key from the password

password - the password for decryption

passwordSalt - the password salt used to sign. Recommended minimum: 16 bytes of random data to ensure uniqueness and prevent rainbow table attacks. The salt is encoded in UTF-8 and cannot be modified after creation.

iterationCount - the iteration count used to sign. Recommended minimum: 100,000 iterations to slow down brute-force attacks in modern hardware.

Returns:

the original unencrypted data

jceSignPbe

@MediaType(value="text/plain",
           strict=false)
 @Throws(value=SignatureErrorTypeProvider.class)
 @Execution(value=CPU_INTENSIVE)
public String jceSignPbe(@Content
                                                                                                                                                                   InputStream content,
                                                                                                                                                                   @OfValues(value=PbeSignatureAlgorithmValueProvider.class) @Optional(defaultValue="PBKDF2withHmacSHA512")
                                                                                                                                                                   String algorithm,
                                                                                                                                                                   @Password
                                                                                                                                                                   String password,
                                                                                                                                                                   @Summary(value="Recommended minimum: 16 bytes of random data to ensure uniqueness and prevent rainbow table attacks. The salt must be encoded in UTF-8 and cannot be modified after creation.")
                                                                                                                                                                   String passwordSalt,
                                                                                                                                                                   @Summary(value="Recommended minimum: 100,000 iterations to slow down brute-force attacks in modern hardware.")
                                                                                                                                                                   Integer iterationCount)

Sign a stream using JCE, with a key.

Parameters:

content - the content to sign

algorithm - the algorithm used for signing

password - the password used to sign

passwordSalt - the password salt used to sign. Recommended minimum: 16 bytes of random data to ensure uniqueness and prevent rainbow table attacks. The salt is encoded in UTF-8 and cannot be modified after creation.

iterationCount - the iteration count used to sign. Recommended minimum: 100,000 iterations to slow down brute-force attacks in modern hardware.

Returns:

the standalone signature (does not include the original data)

jceValidatePbe

@Validator
 @Throws(value=ValidationErrorTypeProvider.class)
 @Execution(value=CPU_INTENSIVE)
public void jceValidatePbe(@Optional(defaultValue="#[payload]")
                                                                                                                         InputStream value,
                                                                                                                         String expected,
                                                                                                                         @OfValues(value=PbeSignatureAlgorithmValueProvider.class) @Optional(defaultValue="PBKDF2withHmacSHA512")
                                                                                                                         String algorithm,
                                                                                                                         @Password
                                                                                                                         String password,
                                                                                                                         @Summary(value="Recommended minimum: 16 bytes of random data to ensure uniqueness and prevent rainbow table attacks. The salt must be encoded in UTF-8 and cannot be modified after creation.") @Optional
                                                                                                                         String passwordSalt,
                                                                                                                         @Summary(value="Recommended minimum: 100,000 iterations to slow down brute-force attacks in modern hardware.") @Optional(defaultValue="0")
                                                                                                                         Integer iterationCount)

Validate a stream against a signature, using a key.

Parameters:

value - the message to authenticate

expected - the signature to validate

algorithm - the algorithm used for signing

password - the password used to sign

passwordSalt - the password salt used to sign. Recommended minimum: 16 bytes of random data to ensure uniqueness and prevent rainbow table attacks. The salt is encoded in UTF-8 and cannot be modified after creation.

iterationCount - the iteration count used to sign. Recommended minimum: 100,000 iterations to slow down brute-force attacks in modern hardware.