Obscura.Vault (obscura v0.1.0)

Copy Markdown View Source

Facade for reversible pseudonymization vault backends.

Summary

Types

vault_ref()

Functions

clear(vault, opts \\ [])

Clears all mappings from a vault.

get_or_create(vault, entity, value, opts \\ [])

Gets or creates a token for an entity/value pair.

info(vault)

Returns backend metadata for a vault.

lookup_token(vault, token, opts \\ [])

Looks up an entry by token.

lookup_value(vault, entity, value, opts \\ [])

Looks up an entry by entity and original value.

rehydrate(vault, text, opts \\ [])

Rehydrates all known tokens in a string through a vault.

Types

vault_ref()

@type vault_ref() :: GenServer.server()

Functions

clear(vault, opts \\ [])

@spec clear(
  vault_ref() | nil,
  keyword()
) :: :ok | {:error, term()}

Clears all mappings from a vault.

get_or_create(vault, entity, value, opts \\ [])

@spec get_or_create(vault_ref() | nil, atom(), String.t(), keyword()) ::
  {:ok, String.t()} | {:error, term()}

Gets or creates a token for an entity/value pair.

info(vault)

@spec info(vault_ref() | nil) :: {:ok, map()} | {:error, term()}

Returns backend metadata for a vault.

lookup_token(vault, token, opts \\ [])

@spec lookup_token(vault_ref() | nil, String.t(), keyword()) ::
  {:ok, Obscura.Vault.Entry.t()} | {:error, term()}

Looks up an entry by token.

lookup_value(vault, entity, value, opts \\ [])

@spec lookup_value(vault_ref() | nil, atom(), String.t(), keyword()) ::
  {:ok, Obscura.Vault.Entry.t()} | {:error, term()}

Looks up an entry by entity and original value.

rehydrate(vault, text, opts \\ [])

@spec rehydrate(vault_ref() | nil, String.t(), keyword()) ::
  {:ok, String.t()} | {:error, term()}

Rehydrates all known tokens in a string through a vault.