Struct ProtectedState 

pub struct ProtectedState {
    pub secrets: BTreeMap<String, SecretValue>,
    pub authenticators: AuthenticatorMap,
    pub aux: Value,
}

M: the decrypted protected state, accessible only inside T’s trusted boundary.

Fields

secrets: BTreeMap<String, SecretValue>

M[target] = s_o. Keys are target identifiers, values are raw secret bytes (e.g. an API key or signing key).

authenticators: AuthenticatorMap

{cid → W_c}, used by Phase III.3 for multi-credential rewrap.

aux: Value

Deployment-specific auxiliary state (vault metadata, deployment hints, …). Out-of-scope of the protocol; the crate just preserves it.

Implementations

impl ProtectedState

pub fn new() -> Self

New empty state. Used at Phase I.2 setup before any secrets are added.

pub fn secret(&self, name: &str) -> Result<&[u8]>

Look up s_o := M[target]. Returns an error if the target is absent.

pub fn put_secret(&mut self, name: impl Into<String>, value: impl Into<Vec<u8>>)

Insert or replace the secret for a target.

pub fn remove_secret(&mut self, name: &str) -> Option<SecretValue>

Remove the secret for a target.

pub fn to_canonical(&self) -> Result<Zeroizing<Vec<u8>>>

Serialise to canonical JCS-style JSON bytes for sealing under K.

Returns a Zeroizing<Vec<u8>> so the canonical bytes (which contain base64-encoded secret plaintexts and authenticator wrapping keys) are wiped on drop. The encoder writes directly into the zeroizing buffer without constructing an intermediate serde_json::Value tree — this avoids the prior leak path where secret bytes’ base64 form lived in a non-zeroizing String inside Value.

The structurally fixed shape is {"authenticators":{…},"aux":…?,"secrets":{…}} (keys sorted lexicographically per JCS: authenticators < aux < secrets). The optional aux field goes through crate::canonical::canonicalize which still uses serde_json::Value; deployments that put sensitive data in aux trade some zeroize guarantees and should encrypt-before-stuffing.

pub fn from_canonical(bytes: &[u8]) -> Result<Self>

Parse from canonical bytes (after Phase III.0 decryption of C).

Goes directly from bytes to ProtectedState via the serde visitor pattern (no intermediate serde_json::Value). Secret plaintexts and wrapping keys land in [SecretValue] / WrappingKey which both Zeroize on drop, so the deserialize path is already leak-free.

Trait Implementations

impl Clone for ProtectedState

fn clone(&self) -> ProtectedState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProtectedState

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

Formats the value using the given formatter.

impl Default for ProtectedState

fn default() -> ProtectedState

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ProtectedState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ProtectedState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.