Struct DataKey 

pub struct DataKey(/* private fields */);

The 32-byte symmetric key every leaf in one file is encrypted under.

Wrapped per recipient (age, PGP, KMS, …) into the sops.<provider>[].enc fields; this type is the unwrapped form and is zeroed on drop. No Display, no Debug of contents.

Implementations

impl DataKey

pub const LEN: usize = 32

Length in bytes of a data key. Not configurable — GenerateDataKey uses make([]byte, 32).

pub fn generate() -> Result<Self, WireError>

A fresh data key from the OS CSPRNG.

pub fn from_bytes(bytes: &[u8]) -> Result<Self, WireError>

Adopt bytes recovered from a key provider.

The length check is here rather than at the call site because a short key from a misbehaving provider would otherwise surface as an AEAD failure far from its cause.

pub fn expose(&self) -> &[u8; 32]

The raw key, for handing to a key provider that must wrap it.

Named to be greppable, like Plaintext::expose.

Trait Implementations

impl Clone for DataKey

fn clone(&self) -> DataKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataKey

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

Formats the value using the given formatter.