Enum SecretSource 

pub enum SecretSource {
    Env {
        env: String,
    },
    File {
        file: String,
    },
    Vault {
        vault: String,
    },
    Sops {
        sops: String,
    },
    Input {
        input: String,
    },
}

Where the runner (isothrum up) reads a secret’s value: one store, written as a map with one key ({ env: DB_PASSWORD }). Another store is a new variant here and a reader of its own in the runtime.

Variants

Env

An environment variable of the runner (or the profile’s inputs).

Fields

env: String

The name of the runner’s environment variable holding the value, e.g. DB_PASSWORD.

File

A file on the runner. Keep it out of version control.

Fields

file: String

Its path: absolute, ~/..., or relative to the project folder.

Vault

A HashiCorp Vault key/value secret, read with the vault command and its usual settings (VAULT_ADDR, VAULT_TOKEN).

Fields

vault: String

The secret’s path in Vault and the field holding the value, as <path>#<field>, e.g. secret/app#db_password.

Sops

A value in a SOPS-encrypted file, decrypted with the sops command.

Fields

sops: String

<file>#<key>, dotted keys for nesting, e.g. secrets.enc.yaml#db.password.

Input

An input’s value, given at each start: the secret lowering makes of a file whose source is an input (files: [{ path, input }]). Never written in a spec.

Fields

input: String

The input’s name (CTF_FLAG_MAIN): the runner’s variable holding the value.

Implementations

impl SecretSource

pub fn store(&self) -> &'static str

The store’s name, as the spec writes it (env, file, vault, sops).

pub fn reference(&self) -> &str

What the store is asked for: a variable, a path, a <path>#<field> reference.

Trait Implementations

impl Clone for SecretSource

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SecretSource

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecretSource

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SecretSource

impl JsonSchema for SecretSource

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for SecretSource

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for SecretSource

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SecretSource