Skip to main content

PayloadAad

Struct PayloadAad 

Source
pub struct PayloadAad { /* private fields */ }
Expand description

The associated data bound into a payload seal.

Binding the payload to its location — (execution_id, step_id, entry_kind, idem_key) — is what makes a sealed blob un-relocatable. Moving a StepResult blob to a different step_id, or replaying it under a different execution_id, changes the AAD and makes PayloadCipher::open fail authentication (fail-closed). The fields are private; construct via PayloadAad::new and read the bound encoding via PayloadAad::canonical_bytes.

§Security

The bound idem_key and the plaintext payload MUST be derived from non-secret descriptors only (INV-6): resolved secret material is referenced by vault key name, never embedded here or in the IdempotencyKey fingerprint. The AAD is authenticated but not encrypted, so it must never carry a secret value.

§Examples

use zeph_durable::{ExecutionId, IdempotencyKey, StepId};
use zeph_durable::cipher::{EntryKindTag, PayloadAad};

let exec = ExecutionId::new();
let key = IdempotencyKey::derive(exec, StepId::new(0), b"tool:transfer");
let with_key = PayloadAad::new(exec, StepId::new(0), EntryKindTag::StepResult, Some(key));
let without_key = PayloadAad::new(exec, StepId::new(0), EntryKindTag::StepResult, None);

// The optional idempotency key is part of the binding.
assert_ne!(with_key.canonical_bytes(), without_key.canonical_bytes());

Implementations§

Source§

impl PayloadAad

Source

pub fn new( execution_id: ExecutionId, step_id: StepId, entry_kind: EntryKindTag, idem_key: Option<IdempotencyKey>, ) -> Self

Construct the associated data for a payload at a known journal location.

Source

pub fn canonical_bytes(&self) -> Vec<u8>

Encode the AAD as deterministic, injective bytes for the AEAD associated-data channel.

Layout (fixed positions, so the encoding is injective without per-field length prefixes): version(1) || execution_id(16) || step_id_le(4) || entry_kind(1) || idem_present(1) || [idem_key(32) when present]. Every concrete PayloadCipher feeds these exact bytes to its AEAD so seal and open agree on the binding.

§Examples
use zeph_durable::{ExecutionId, StepId};
use zeph_durable::cipher::{EntryKindTag, PayloadAad};

let aad = PayloadAad::new(ExecutionId::new(), StepId::new(1), EntryKindTag::Checkpoint, None);
// version + 16 + 4 + 1 + 1 = 23 bytes when no idempotency key is bound.
assert_eq!(aad.canonical_bytes().len(), 23);

Trait Implementations§

Source§

impl Clone for PayloadAad

Source§

fn clone(&self) -> PayloadAad

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PayloadAad

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for PayloadAad

Source§

impl PartialEq for PayloadAad

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PayloadAad

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more