Package-level declarations

Types

Link copied to clipboard

Reads and writes SQLite Multiple Ciphers configuration.

Link copied to clipboard
interface CipherData

Reads per-connection cipher data.

Link copied to clipboard
interface CipherManager

Registers and looks up SQLite Multiple Ciphers dynamic ciphers, on top of the ciphers SQLite Multiple Ciphers already provides.

Link copied to clipboard

Reads and writes the parameter values of a Cipher. See CipherConfiguration for how prefix affects whether a read or write is transient or permanent.

Link copied to clipboard

Creates and destroys the virtual file systems SQLite Multiple Ciphers wraps around an existing one to transparently encrypt and decrypt the files it manages.

Link copied to clipboard

A user-implemented dynamic cipher scheme, registered through CipherManager.register.

Link copied to clipboard

Scope available while DynamicCipher.Factory.create runs.

Link copied to clipboard
Link copied to clipboard

Registers the parameters a DynamicCipher accepts, used from DynamicCipher.Factory.registerParameters.

Properties

Link copied to clipboard

Cipher used to encrypt the database for the current connection only.

Link copied to clipboard

Whether the HMAC is validated on read operations for the current connection only, for cipher schemes that use one.

Link copied to clipboard

Whether the legacy mode for WAL journal encryption is used for the current connection only.

Functions

Link copied to clipboard
fun CipherParameters<SqliteMcCipher.Dynamic>.get(param: String, prefix: SqliteMcConfigParamPrefix.ReadWrite = SqliteMcConfigParamPrefix.None): Int

Returns the transient value of the dynamic cipher parameter named param.

Link copied to clipboard

Returns the 1-based index of the dynamic cipher named name among the registered ciphers.

Link copied to clipboard

Returns the readable and writable parameters for the dynamic cipher named after name.

Link copied to clipboard
fun CipherParameters<SqliteMcCipher.Dynamic>.set(param: String, value: Int, prefix: SqliteMcConfigParamPrefix.ReadWrite = SqliteMcConfigParamPrefix.Default)

Sets the dynamic cipher parameter named param to value, permanently.

Link copied to clipboard

Sets the dynamic cipher to be used for encrypting the database, using its name.