Struct SecretConfig

pub struct SecretConfig {
    pub name: String,
    pub backend: String,
    pub key: String,
    pub field: Option<String>,
    pub version: Option<String>,
    pub policy: Policy,
    pub secret_type: String,
}

The representation of a secret reference in the config store.

Fields

name: String

The name of the secret when referred to by a component or provider.

backend: String

The backend to use for retrieving the secret.

key: String

The key to use for retrieving the secret from the backend.

field: Option<String>

The field to retrieve from the secret. If not supplied, the entire secret will be returned.

version: Option<String>

The version of the secret to retrieve. If not supplied, the latest version will be used.

policy: Policy

The policy that defines configuration options for the backend. This is a serialized JSON object that will be passed to the backend as a string for policy evaluation.

secret_type: String

The type of secret. This is used to inform wadm or anything else that is consuming the secret about how to deserialize the payload.

Implementations

impl SecretConfig

pub fn new( name: String, backend: String, key: String, field: Option<String>, version: Option<String>, policy_properties: HashMap<String, Value>, ) -> Self

pub fn try_into_request( self, entity_jwt: &str, host_jwt: &str, application_name: Option<&String>, ) -> Result<SecretRequest, Error>

Given an entity JWT, host JWT, and optional application name, convert this SecretConfig into a SecretRequest that can be used to fetch the secret from a secrets backend.

This is not a true TryInto implementation as we need additional information to create the SecretRequest. This returns an error if the policy field cannot be serialized to a JSON string.

Trait Implementations

impl Clone for SecretConfig

fn clone(&self) -> SecretConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SecretConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecretConfig

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SecretConfig

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SecretConfig

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryInto<HashMap<String, String>> for SecretConfig

Helper function to convert a SecretConfig into a HashMap. This is only intended to be used by wash or anything else that needs to interact directly with the config KV bucket to manipulate secrets.

fn try_into(self) -> Result<HashMap<String, String>, Self::Error>

Convert this SecretConfig into a HashMap of the form:

{
  "name": "secret-name",
  "type": "secret.wasmcloud.dev/v1alpha1",
  "backend": "baobun",
  "key": "/path/to/secret",
  "version": "vX.Y.Z",
  "policy": "{\"type\":\"properties.secret.wasmcloud.dev/v1alpha1\",\"properties\":{\"key\":\"value\"}}"
}

type Error = Error

The type returned in the event of a conversion error.

impl Eq for SecretConfig

impl StructuralPartialEq for SecretConfig