com.salesforce.androidsdk.analytics.security

Class Encryptor

java.lang.Object

com.salesforce.androidsdk.analytics.security.Encryptor

public class Encryptor
extends java.lang.Object

Helper class for encryption/decryption/hash computations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Encryptor.CipherMode

Constructor Summary

Constructors

Constructor and Description
Encryptor()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	decrypt(byte[] data, java.lang.String key) Decrypts data with key using AES/GCM/NoPadding.
static java.lang.String	decrypt(byte[] data, java.lang.String key, byte[] iv) Decrypts data with key using using AES/GCM/NoPadding.
static java.lang.String	decrypt(java.lang.String data, java.lang.String key) Decrypts data with key using AES/GCM/NoPadding.
static java.lang.String	decrypt(java.lang.String data, java.lang.String key, byte[] iv) Decrypts data with key using AES/GCM/NoPadding.
static java.lang.String	decryptBytes(byte[] data, byte[] key, byte[] iv) Decrypts the given bytes using key and IV.
static byte[]	decryptWithoutBase64Encoding(byte[] data, java.lang.String key) Decrypts data with key using using AES/GCM/NoPadding.
static java.lang.String	decryptWithRSA(java.security.PrivateKey privateKey, java.lang.String data, Encryptor.CipherMode cipherMode) Returns data decrypted with an RSA private key.
static byte[]	decryptWithRSABytes(java.security.PrivateKey privateKey, java.lang.String data, Encryptor.CipherMode cipherMode) Returns data decrypted with an RSA private key.
static byte[]	decryptWithRSAMultiCipherNodes(java.security.PrivateKey privateKey, java.lang.String data) Attempt to decrypt with a RSA private key using different cipher modes: - RSA_OAEP_SHA256 - then RSA_PKCS1 (legacy) TODO retire this method when the server only supports RSA_OAEP_SHA256
static java.lang.String	encrypt(java.lang.String data, java.lang.String key) Encrypts data with key using AES/GCM/NoPadding.
static java.lang.String	encrypt(java.lang.String data, java.lang.String key, byte[] iv) Encrypts data with key using AES/GCM/NoPadding.
static byte[]	encryptBytes(java.lang.String data, java.lang.String key) Encrypts data with key using AES/GCM/NoPadding.
static byte[]	encryptBytes(java.lang.String data, java.lang.String key, byte[] iv) Encrypts data with key using AES/GCM/NoPadding.
static byte[]	encryptWithoutBase64Encoding(byte[] data, java.lang.String key) Encrypts data with key using AES/GCM/NoPadding.
static byte[]	encryptWithPublicKey(java.security.PublicKey publicKey, java.lang.String data, Encryptor.CipherMode cipherMode)
static java.lang.String	encryptWithRSA(java.security.PublicKey publicKey, java.lang.String data, Encryptor.CipherMode cipherMode) Returns data encrypted with an RSA public key.
static byte[]	encryptWithRSABytes(java.security.PublicKey publicKey, java.lang.String data, Encryptor.CipherMode cipherMode) Returns data encrypted with an RSA public key.
static java.io.ByteArrayOutputStream	getByteArrayStreamFromStream(java.io.InputStream stream) Retrieves data from an InputStream.
static javax.crypto.Cipher	getDecryptingCipher(java.lang.String encryptionKey, byte[] iv) Returns initialized cipher for decryption.
static javax.crypto.Cipher	getEncryptingCipher(java.lang.String encryptionKey) Returns initialized cipher for encryption with an IV automatically generated.
static java.lang.String	getStringFromFile(java.io.File file) Retrieves data from a File.
static java.lang.String	getStringFromStream(java.io.InputStream stream) Retrieves data from an InputStream.
static java.lang.String	hash(java.lang.String data, java.lang.String key) Return HMAC SHA-256 hash of data using key.
static boolean	isBase64Encoded(java.lang.String key) Checks if the string is Base64 encoded.

Methods inherited from class java.lang.Object

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

Constructor Detail

Encryptor

public Encryptor()

Method Detail

getEncryptingCipher

public static javax.crypto.Cipher getEncryptingCipher(java.lang.String encryptionKey)
                                               throws java.security.InvalidAlgorithmParameterException,
                                                      java.security.InvalidKeyException

Returns initialized cipher for encryption with an IV automatically generated.

Parameters:

encryptionKey - Encryption key.

Returns:

Initialized cipher.

Throws:

java.security.InvalidAlgorithmParameterException

java.security.InvalidKeyException

getDecryptingCipher

public static javax.crypto.Cipher getDecryptingCipher(java.lang.String encryptionKey,
                                                      byte[] iv)
                                               throws java.security.InvalidAlgorithmParameterException,
                                                      java.security.InvalidKeyException

Returns initialized cipher for decryption.

Parameters:

encryptionKey - Encryption key.

iv - Initialization vector.

Returns:

Initialized cipher.

Throws:

java.security.InvalidAlgorithmParameterException

java.security.InvalidKeyException

decrypt

public static java.lang.String decrypt(java.lang.String data,
                                       java.lang.String key)

Decrypts data with key using AES/GCM/NoPadding.

Parameters:

data - Data.

key - Base64 encoded 256 bit key or null (to leave data unchanged).

Returns:

Decrypted data.

decrypt

public static java.lang.String decrypt(byte[] data,
                                       java.lang.String key)

Decrypts data with key using AES/GCM/NoPadding.

Parameters:

data - Data.

key - Key.

Returns:

Decrypted data.

decrypt

public static java.lang.String decrypt(java.lang.String data,
                                       java.lang.String key,
                                       byte[] iv)

Decrypts data with key using AES/GCM/NoPadding.

Parameters:

data - Data.

key - Base64 encoded 256 bit key or null (to leave data unchanged).

iv - Initialization vector.

Returns:

Decrypted data.

decrypt

public static java.lang.String decrypt(byte[] data,
                                       java.lang.String key,
                                       byte[] iv)

Decrypts data with key using using AES/GCM/NoPadding.

Parameters:

data - Data.

key - Key.

iv - Initialization vector.

Returns:

Decrypted data.

decryptWithoutBase64Encoding

public static byte[] decryptWithoutBase64Encoding(byte[] data,
                                                  java.lang.String key)

Decrypts data with key using using AES/GCM/NoPadding. The data is not Base64 encoded.

Parameters:

data - Data.

key - Key.

Returns:

Decrypted data.

encrypt

public static java.lang.String encrypt(java.lang.String data,
                                       java.lang.String key)

Encrypts data with key using AES/GCM/NoPadding.

Parameters:

data - Data.

key - Base64 encoded 256 bit key or null (to leave data unchanged).

Returns:

Encrypted data.

encrypt

public static java.lang.String encrypt(java.lang.String data,
                                       java.lang.String key,
                                       byte[] iv)

Encrypts data with key using AES/GCM/NoPadding.

Parameters:

data - Data.

key - Base64 encoded 256 bit key or null (to leave data unchanged).

iv - Initialization vector.

Returns:

Encrypted data.

encryptBytes

public static byte[] encryptBytes(java.lang.String data,
                                  java.lang.String key)

Encrypts data with key using AES/GCM/NoPadding.

Parameters:

data - Data.

key - Key.

Returns:

Encrypted data.

encryptBytes

public static byte[] encryptBytes(java.lang.String data,
                                  java.lang.String key,
                                  byte[] iv)

Encrypts data with key using AES/GCM/NoPadding.

Parameters:

data - Data.

key - Key.

iv - Initialization vector.

Returns:

Encrypted data.

encryptWithoutBase64Encoding

public static byte[] encryptWithoutBase64Encoding(byte[] data,
                                                  java.lang.String key)

Encrypts data with key using AES/GCM/NoPadding. The data is not Base64 encoded.

Parameters:

data - Data.

key - Key.

Returns:

Encrypted data.

isBase64Encoded

public static boolean isBase64Encoded(java.lang.String key)

Checks if the string is Base64 encoded.

Parameters:

key - String.

Returns:

True - if encoded, False - otherwise.

hash

public static java.lang.String hash(java.lang.String data,
                                    java.lang.String key)

Return HMAC SHA-256 hash of data using key.

Parameters:

data - Data.

key - Key.

Returns:

Hash.

encryptWithRSA

public static java.lang.String encryptWithRSA(java.security.PublicKey publicKey,
                                              java.lang.String data,
                                              Encryptor.CipherMode cipherMode)

Returns data encrypted with an RSA public key.

Parameters:

publicKey - RSA public key.

data - Data to be encrypted.

cipherMode - Cipher mode.

Returns:

Encrypted data.

encryptWithRSABytes

public static byte[] encryptWithRSABytes(java.security.PublicKey publicKey,
                                         java.lang.String data,
                                         Encryptor.CipherMode cipherMode)

Returns data encrypted with an RSA public key.

Parameters:

publicKey - RSA public key.

data - Data to be encrypted.

cipherMode - Cipher mode.

Returns:

Encrypted data.

decryptWithRSA

public static java.lang.String decryptWithRSA(java.security.PrivateKey privateKey,
                                              java.lang.String data,
                                              Encryptor.CipherMode cipherMode)

Returns data decrypted with an RSA private key.

Parameters:

privateKey - RSA private key.

data - Data to be decrypted.

cipherMode - Cipher mode.

Returns:

Decrypted data.

decryptWithRSABytes

public static byte[] decryptWithRSABytes(java.security.PrivateKey privateKey,
                                         java.lang.String data,
                                         Encryptor.CipherMode cipherMode)

Returns data decrypted with an RSA private key.

Parameters:

privateKey - RSA private key.

data - Data to be decrypted.

cipherMode - Ciper mode.

Returns:

Decrypted data.

decryptWithRSAMultiCipherNodes

public static byte[] decryptWithRSAMultiCipherNodes(java.security.PrivateKey privateKey,
                                                    java.lang.String data)

Attempt to decrypt with a RSA private key using different cipher modes: - RSA_OAEP_SHA256 - then RSA_PKCS1 (legacy) TODO retire this method when the server only supports RSA_OAEP_SHA256

Parameters:

privateKey - RSA private key.

data - Data to be decrypted.

Returns:

Decrypted data.

decryptBytes

public static java.lang.String decryptBytes(byte[] data,
                                            byte[] key,
                                            byte[] iv)

Decrypts the given bytes using key and IV.

Parameters:

data - Data bytes.

key - Key bytes.

iv - Initialization vector bytes.

Returns:

Decrypted data.

getStringFromStream

public static java.lang.String getStringFromStream(java.io.InputStream stream)
                                            throws java.io.IOException

Retrieves data from an InputStream. Guaranteed to close the InputStream.

Parameters:

stream - InputStream data.

Returns:

Data from the InputStream as a String.

Throws:

java.io.IOException - Provide log details of this exception in a catch with specifics about the operation this method was called for.

getByteArrayStreamFromStream

public static java.io.ByteArrayOutputStream getByteArrayStreamFromStream(java.io.InputStream stream)
                                                                  throws java.io.IOException

Retrieves data from an InputStream. Guaranteed to close the InputStream.

Parameters:

stream - InputStream data.

Returns:

Data from the InputStream as a ByteArrayOutputStream

Throws:

java.io.IOException - Provide log details of this exception in a catch with specifics about the operation this method was called for.

getStringFromFile

public static java.lang.String getStringFromFile(java.io.File file)
                                          throws java.io.IOException

Retrieves data from a File.

Parameters:

file - File object.

Returns:

Data from the input File as a String.

Throws:

java.io.IOException - Provide log details of this exception in a catch with specifics about the operation this method was called for.

encryptWithPublicKey

public static byte[] encryptWithPublicKey(java.security.PublicKey publicKey,
                                          java.lang.String data,
                                          Encryptor.CipherMode cipherMode)