com.couchbase.lite.support.security

Class SymmetricKey

java.lang.Object

com.couchbase.lite.support.security.SymmetricKey

public class SymmetricKey
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	SymmetricKey.Encryptor An Encryptor class used for incrementally encrypting data.

Field Summary

Fields

Modifier and Type	Field and Description
static int	KEY_SIZE

Constructor Summary

Constructors

Constructor and Description
SymmetricKey() Create an instance with a secure random generated key.
SymmetricKey(byte[] key) Create an instance with a raw key.

Method Summary

Modifier and Type	Method and Description
SymmetricKey.Encryptor	createEncryptor() Create an Encryptor object.
byte[]	decryptData(byte[] data) Decrypt the encrypted byte array data.
java.io.InputStream	decryptStream(java.io.InputStream input) Decrypt the input stream.
byte[]	encryptData(byte[] data) Encrypt the byte array data
java.lang.String	getHexData() Get the hex representation of the key data.
byte[]	getKey() Get the raw key data derived from a password or the raw key given to SymmetricKey(byte[] key) constructor.
java.lang.String	toString() String representation of the object

Methods inherited from class java.lang.Object

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

Field Detail

KEY_SIZE

public static final int KEY_SIZE

See Also:

Constant Field Values

Constructor Detail

SymmetricKey

public SymmetricKey()
             throws SymmetricKeyException

Create an instance with a secure random generated key.

Throws:

SymmetricKeyException

SymmetricKey

public SymmetricKey(byte[] key)
             throws SymmetricKeyException

Create an instance with a raw key. The size of the key needs to be 32 bytes.

Parameters:

key -

Throws:

SymmetricKeyException

Method Detail

getKey

public byte[] getKey()

Get the raw key data derived from a password or the raw key given to SymmetricKey(byte[] key) constructor.

Returns:

raw key data

getHexData

public java.lang.String getHexData()

Get the hex representation of the key data.

Returns:

hex string of the key data

toString

public java.lang.String toString()

String representation of the object

Overrides:

toString in class java.lang.Object

Returns:

String representation of the object

encryptData

public byte[] encryptData(byte[] data)
                   throws SymmetricKeyException

Encrypt the byte array data

Parameters:

data - Input data

Returns:

Encrypted data

Throws:

SymmetricKeyException

decryptData

public byte[] decryptData(byte[] data)
                   throws SymmetricKeyException

Decrypt the encrypted byte array data. The encrypted data must be prefixed with the IV header (16 bytes) used when encrypting the data.

Parameters:

data - Encrypted data

Returns:

Decrypted data

Throws:

SymmetricKeyException

decryptStream

public java.io.InputStream decryptStream(java.io.InputStream input)
                                  throws SymmetricKeyException

Decrypt the input stream. The encrypted stream must be prefixed with the IV header (16 bytes) use when encrypting the data of the given input stream.

Parameters:

input - InputStream of the data to be decrypted

Returns:

InputStream of the decrypted data

Throws:

SymmetricKeyException

createEncryptor

public SymmetricKey.Encryptor createEncryptor()
                                       throws SymmetricKeyException

Create an Encryptor object. The created encryptor object with use a Cipher object generated with a secure random IV header.

Returns:

An Encryptor object

Throws:

SymmetricKeyException