io.ably.lib.util

Class Crypto

java.lang.Object

io.ably.lib.util.Crypto

public class Crypto
extends java.lang.Object

Utility classes and interfaces for message payload encryption. This class supports AES/CBC/PKCS5 with a default key length of 256 bits but supporting other key lengths. Other algorithms and chaining modes are not supported directly, but supportable by extending/implementing the base classes and interfaces here. Secure random data for creation of Initialisation Vectors (IVs) and keys is obtained from the default system SecureRandom. Future extensions of this class might make the SecureRandom pluggable or at least seedable with client-provided entropy. Each message payload is encrypted with an IV in CBC mode, and the IV is concatenated with the resulting raw ciphertext to construct the "ciphertext" data passed to the recipient.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Crypto.ChannelCipher Deprecated. Since version 1.2.11, this interface (which was only ever intended for internal use within this library) has been replaced by Crypto.ChannelCipherSet. It will be removed in the future.
static interface	Crypto.ChannelCipherSet Internal; a matching encipher and decipher pair, where both are guaranteed to have been configured with the same Crypto.CipherParams as each other.
static class	Crypto.CipherParams A class encapsulating the client-specifiable parameters for the cipher.
static interface	Crypto.DecryptingChannelCipher Internal; a cipher used to decrypt plaintext from ciphertext, for a channel.
static interface	Crypto.EncryptingChannelCipher Internal; a cipher used to encrypt plaintext to ciphertext, for a channel.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_ALGORITHM
static int	DEFAULT_BLOCKLENGTH
static int	DEFAULT_KEYLENGTH

Constructor Summary

Constructors

Constructor and Description
Crypto()

Method Summary

Modifier and Type	Method and Description
static Crypto.ChannelCipherSet	createChannelCipherSet(java.lang.Object cipherParams) Internal; get an encrypting cipher instance based on the given channel options.
static byte[]	generateRandomKey()
static byte[]	generateRandomKey(int keyLength)
static Param	generateRandomRequestId() Returns a "request_id" query param, based on a sequence of 9 random bytes which have been base64 encoded.
static Crypto.CipherParams	getDefaultParams() Obtain a default CipherParams.
static Crypto.CipherParams	getDefaultParams(byte[] key) Obtain a default CipherParams.
static Crypto.CipherParams	getDefaultParams(java.lang.String base64Key) Obtain a default CipherParams using Base64-encoded key.
static Crypto.CipherParams	getParams(java.lang.String algorithm, byte[] key)
static Crypto.CipherParams	getParams(java.lang.String algorithm, byte[] key, byte[] iv)
static Crypto.CipherParams	getParams(java.lang.String algorithm, int keyLength)
static java.lang.String	getRandomId()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_ALGORITHM

public static final java.lang.String DEFAULT_ALGORITHM

See Also:

Constant Field Values

DEFAULT_KEYLENGTH

public static final int DEFAULT_KEYLENGTH

DEFAULT_BLOCKLENGTH

public static final int DEFAULT_BLOCKLENGTH

See Also:

Constant Field Values

Constructor Detail

Crypto

public Crypto()

Method Detail

getDefaultParams

public static Crypto.CipherParams getDefaultParams()

Obtain a default CipherParams. This uses default algorithm, mode and padding and key length. A key and IV are generated using the default system SecureRandom; the key may be obtained from the returned CipherParams for out-of-band distribution to other clients.

Returns:

the CipherParams

getDefaultParams

public static Crypto.CipherParams getDefaultParams(byte[] key)

Obtain a default CipherParams. This uses default algorithm, mode and padding and initialises a key based on the given key data. The cipher key length is derived from the length of the given key data. An IV is generated using the default system SecureRandom. Use this method of constructing CipherParams if initialising a Channel with a client-provided key, or to obtain a system-generated key of a non-default key length.

Returns:

the CipherParams

getDefaultParams

public static Crypto.CipherParams getDefaultParams(java.lang.String base64Key)

Obtain a default CipherParams using Base64-encoded key. Same as above, throws IllegalArgumentException if base64Key is invalid

Parameters:

base64Key -

Returns:

getParams

public static Crypto.CipherParams getParams(java.lang.String algorithm,
                                            int keyLength)

getParams

public static Crypto.CipherParams getParams(java.lang.String algorithm,
                                            byte[] key)
                                     throws java.security.NoSuchAlgorithmException

Throws:

java.security.NoSuchAlgorithmException

getParams

public static Crypto.CipherParams getParams(java.lang.String algorithm,
                                            byte[] key,
                                            byte[] iv)
                                     throws java.security.NoSuchAlgorithmException

Throws:

java.security.NoSuchAlgorithmException

generateRandomKey

public static byte[] generateRandomKey(int keyLength)

generateRandomKey

public static byte[] generateRandomKey()

createChannelCipherSet

public static Crypto.ChannelCipherSet createChannelCipherSet(java.lang.Object cipherParams)
                                                      throws AblyException

Internal; get an encrypting cipher instance based on the given channel options.

Throws:

AblyException

getRandomId

public static java.lang.String getRandomId()

generateRandomRequestId

public static Param generateRandomRequestId()

Returns a "request_id" query param, based on a sequence of 9 random bytes which have been base64 encoded. Spec: RSC7c