Struct EncryptionSpec 

pub struct EncryptionSpec {
    pub key: String,
    pub previous_keys: Vec<String>,
    pub algorithm: EncryptionAlgorithm,
}

Available on crate feature encryption only.

The user-facing encryption: config block (state store / jsonl sink).

encryption:
  key: ${vault:secret/faucet#state-key}
  # previous_keys: ["${env:OLD_STATE_KEY}"]   # rotation: read-only
  # algorithm: aes-256-gcm                     # default

Fields

key: String

Key material used to seal new writes (and tried first on reads). Should come from a secrets manager; derived to a 32-byte AES key via SHA-256.

previous_keys: Vec<String>

Older keys tried (in order) when decrypting, for rotation. Never used to seal new writes.

algorithm: EncryptionAlgorithm

AEAD algorithm. Only aes-256-gcm today.

Trait Implementations

impl Clone for EncryptionSpec

fn clone(&self) -> EncryptionSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EncryptionSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EncryptionSpec

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for EncryptionSpec

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 Serialize for EncryptionSpec

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

where __S: Serializer,

Serialize this value into the given Serde serializer.