com.couchbase.lite.store

Interface EncryptableStore

All Known Implementing Classes:

SQLiteStore

public interface EncryptableStore

Method Summary

Modifier and Type	Method and Description
Action	actionToChangeEncryptionKey(SymmetricKey newKey) Action for changing the encryption key of the storage.
byte[]	derivePBKDF2SHA256Key(java.lang.String password, byte[] salt, int rounds) A utility method for deriving PBKDF2-SHA256 based key from the password.
SymmetricKey	getEncryptionKey() Return current encryption key
void	setEncryptionKey(SymmetricKey key) Set encryption key for opening the storage.

Method Detail

setEncryptionKey

void setEncryptionKey(SymmetricKey key)

Set encryption key for opening the storage.

Parameters:

key - a SymmetricKey object

getEncryptionKey

SymmetricKey getEncryptionKey()

Return current encryption key

Returns:

a SymmetricKey object

actionToChangeEncryptionKey

Action actionToChangeEncryptionKey(SymmetricKey newKey)

Action for changing the encryption key of the storage.

Parameters:

newKey - a new SymmetricKey object

Returns:

an Action object

derivePBKDF2SHA256Key

byte[] derivePBKDF2SHA256Key(java.lang.String password,
                             byte[] salt,
                             int rounds)
                      throws CouchbaseLiteException

A utility method for deriving PBKDF2-SHA256 based key from the password.

Parameters:

password - password

salt - salt

rounds - number of rounds

Returns:

a derived PBKDF2-SHA256 key

Throws:

CouchbaseLiteException