Package com.amilesend.client.crypto

Class CryptoHelper

java.lang.Object

com.amilesend.client.crypto.CryptoHelper

public class CryptoHelper
extends Object

Helper that encrypts and decrypts content for the configured cipher algorithm and key.

Note: See Java Security Standard Algorithm Names for a list of available ciphers and be aware of which are applicable to comply with your local geographic laws and/or policies.

See Also:

• EncryptedEnvelope

Constructor Summary

Constructors

Constructor	Description
CryptoHelper(String cipherAlgorithm, @NonNull SecretKey key)	Creates a new CryptoHelper instance.

Method Summary

Modifier and Type	Method	Description
byte[]	decrypt(@NonNull EncryptedEnvelope envelope)	Decrypts the given EncryptedEnvelope and returns the contents as a byte array.
EncryptedEnvelope	encrypt(@lombok.NonNull byte[] content, String description)	Encrypts the given bytes and returns an EncryptedEnvelope.

Methods inherited from class java.lang.Object

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

Constructor Details

CryptoHelper

public CryptoHelper(String cipherAlgorithm,
 @NonNull
 @NonNull SecretKey key)

Creates a new CryptoHelper instance.

Parameters:

cipherAlgorithm - the cipher algorithm to use

key - the key used to encrypt/decrypt content

Method Details

encrypt

public EncryptedEnvelope encrypt(@NonNull
 @lombok.NonNull byte[] content,
 String description)
                          throws CryptoHelperException

Encrypts the given bytes and returns an EncryptedEnvelope.

Parameters:

content - the content to encrypt

description - a description of the content

Returns:

the EncryptedEnvelope containing the encrypted bytes

Throws:

CryptoHelperException - if an error occurred while encrypting the contents

decrypt

public byte[] decrypt(@NonNull
 @NonNull EncryptedEnvelope envelope)
               throws CryptoHelperException

Decrypts the given EncryptedEnvelope and returns the contents as a byte array.

Parameters:

envelope - the envelope to decrypt

Returns:

the decrypted contents

Throws:

CryptoHelperException - if an error occurred while decrypting the envelope's contents