View Source SecretVault.Cipher behaviour (SecretVault v1.2.2)

Provides an interface to implement encryption methods.

See SecretVault.Cipher.ErlangCrypto implementation for more details.

Summary

Types

cypher_text()

Binary blob that contains encrypted data.

key()

A key for symetric encryption algorithm as a binary.

plain_text()

Binary blob that contains decrypted data.

Callbacks

decrypt(key, cypher_text, opts)

Decrypt the cypher_text with the key used to get it.

encrypt(key, plain_text, opts)

Encrypt the plain_text with the key.

Functions

pack(cipher, algorithm, properties)

Serialize encryption metadata end a ciphertext into a single binary.

unpack!(cipher, binary)

Deserialize pack/3'ed data.

Types

cypher_text()

@type cypher_text() :: binary()

Binary blob that contains encrypted data.

key()

@type key() :: binary()

A key for symetric encryption algorithm as a binary.

plain_text()

@type plain_text() :: binary()

Binary blob that contains decrypted data.

Callbacks

decrypt(key, cypher_text, opts)

@callback decrypt(key(), cypher_text(), opts) ::
  {:ok, plain_text()} | {:error, :invalid_encryption_key}
when opts: Keyword.t()

Decrypt the cypher_text with the key used to get it.

If key is invalid, :invalid_key error is returned. If inappropriate text is passed as cypher_text, Cipher.Error is raised.

encrypt(key, plain_text, opts)

@callback encrypt(key(), plain_text(), opts) :: cypher_text() when opts: Keyword.t()

Encrypt the plain_text with the key.

Functions

pack(cipher, algorithm, properties)

@spec pack(cipher, algorithm, [property]) :: binary()
when cipher: String.t(), algorithm: String.t(), property: binary()

Serialize encryption metadata end a ciphertext into a single binary.

This is a helper function to prepare the data to be written on the disk.

Example

iex> cipher = "MyNewCipher"
...> algorithm = "default"
...> ciphertext = "testtest"
...> pack(cipher, algorithm, [ciphertext])
"MyNewCipher;default;7465737474657374"

unpack!(cipher, binary)

@spec unpack!(cipher, binary()) :: [property]
when cipher: String.t(), property: binary()

Deserialize pack/3'ed data.

Example

iex> cipher = "MyNewCipher"
iex> serialized = "MyNewCipher;default;7465737474657374"
iex> unpack!(cipher, serialized)
["default", "testtest"]