glm_vault - v2.5.0

glm_vault/vault

Types

Vault

opaque </>

A vault is an opaque datatype that contains the secrets.

pub opaque type Vault

VaultError

</>

Vault Errors

pub type VaultError {
  UnableToSerializeUnsupportedType(tom.Toml)
  UnableToGetFromVault(tom.GetError)
  UnableToDecryptFile(openssl.OpenSslError, String, String)
  UnableToEncryptFile(simplifile.FileError)
  UnableToGetFromDict(String)
  UnableToParseDecryptedPlaintext(String, tom.ParseError)
}

Constructors

Values

decrypt

</> 
pub fn decrypt(
  encrypted_file: String,
  password_file: String,
) -> Result(Vault, VaultError)

Decrypt an encrypted file and return a vault instance.

default_dummy_bool

</> 
pub const default_dummy_bool: Bool

default_dummy_float

</> 
pub const default_dummy_float: Float

default_dummy_int

</> 
pub const default_dummy_int: Int

default_dummy_string

</> 
pub const default_dummy_string: String

encrypt

</> 
pub fn encrypt(
  vault: Vault,
  encrypted_file: String,
  password_file: String,
) -> Result(Nil, VaultError)

Serialize a vault instance to a temporary file, then encrypt that file and delete the temporary file. Upon success, an encrypted file is created that contains the serialized contents of the vault.

get_bool

</> 
pub fn get_bool(
  v: Vault,
  key: String,
) -> Result(Bool, VaultError)

get_float

</> 
pub fn get_float(
  v: Vault,
  key: String,
) -> Result(Float, VaultError)

get_int

</> 
pub fn get_int(v: Vault, key: String) -> Result(Int, VaultError)

get_keys

</> 
pub fn get_keys(v: Vault) -> Result(List(String), VaultError)

get_string

</> 
pub fn get_string(
  v: Vault,
  key: String,
) -> Result(String, VaultError)

new_dummy_vault

</> 
pub fn new_dummy_vault() -> Vault

Create a new dummy vault. This vault has no secrets, silently allows values to be set (but does not actually set them, as it has no secrets), and returns default values for all get operations, see ‘default_dummy_*’ above.

new_elided_vault

</> 
pub fn new_elided_vault(
  secrets: dict.Dict(String, tom.Toml),
) -> Vault

Create an elided vault, one that does not reveal it’s secrets. The Elided vault can have secrets set, and will behave like a regular vault in all ways EXCEPT that get operations will allways return a default value, see ‘default_dummy_*’ above.

This means that if you try to access a key that does not exist in an elided vault, you will get an access error.

new_vault

</> 
pub fn new_vault(secrets: dict.Dict(String, tom.Toml)) -> Vault

Create a new vault.

set_bool

</> 
pub fn set_bool(v: Vault, key: String, value: Bool) -> Vault

set_float

</> 
pub fn set_float(v: Vault, key: String, value: Float) -> Vault

set_int

</> 
pub fn set_int(v: Vault, key: String, value: Int) -> Vault

set_string

</> 
pub fn set_string(v: Vault, key: String, value: String) -> Vault

to_elided_vault

</> 
pub fn to_elided_vault(v: Vault) -> Vault

Convert a vault to an elided vault. Useful for code that sometimes needs a regular vault, but sometimes needs to cast to an elided vault.

✨ Search Document