Skip to main content

UnwrapOptions

Struct UnwrapOptions 

Source
pub struct UnwrapOptions<'a> {
    pub verification: EnvelopeVerification<'a>,
    pub nonce_cache: &'a dyn NonceCache,
    pub decryption_key: Option<&'a SigningKey>,
    pub require_encrypted: bool,
    pub pq_store: Option<&'a dyn PqTrustStore>,
    pub verify_policy: CryptoPolicy,
}
Expand description

Options controlling envelope unwrap, verification, and optional decryption.

§Crypto policy (fail-closed default)

verify_policy defaults to [CryptoPolicy::default()] which is Hybrid ENFORCED. Under Hybrid the verifier REQUIRES the outer ML-DSA-65 SNS layer anchored to a PqTrustStore entry — stripping the outer layer or signing classical-only is rejected. To verify against a kid-anchored PQ key, callers MUST supply pq_store; under Hybrid with no resolvable anchor the envelope is rejected (fail-closed), never accepted as classical.

Fields§

§verification: EnvelopeVerification<'a>

How to verify the envelope signer.

§nonce_cache: &'a dyn NonceCache

Nonce cache for replay protection.

§decryption_key: Option<&'a SigningKey>

Server signing key for decrypting encrypted envelopes. When present and the envelope has encrypted_envelope, the server’s Ed25519 key is converted to X25519 for DH decryption.

§require_encrypted: bool

Require the verified wire envelope to carry a non-empty encrypted envelope. Enforced after signature verification and before decryption, the final replay commit, or any claims/application processing.

§pq_store: Option<&'a dyn PqTrustStore>

kid-anchored ML-DSA-65 trust store used to resolve the PQ verifying key for the envelope’s EdDSA signer. Required under Hybrid policy.

§verify_policy: CryptoPolicy

Verification policy enforced at this site. Defaults to Hybrid (enforced).

Implementations§

Source§

impl<'a> UnwrapOptions<'a>

Source

pub fn fixed_signer( pubkey: &'a VerifyingKey, nonce_cache: &'a dyn NonceCache, ) -> Self

Fixed-signer verification under the default (Hybrid-enforced) policy.

Source

pub fn any_signer(nonce_cache: &'a dyn NonceCache) -> Self

Any-signer verification under the default (Hybrid-enforced) policy.

Source

pub fn with_decryption_key(self, key: &'a SigningKey) -> Self

Source

pub fn require_encrypted(self, required: bool) -> Self

Require request encryption after authenticating the wire envelope.

Source

pub fn with_pq_store(self, store: &'a dyn PqTrustStore) -> Self

Attach a kid-anchored ML-DSA-65 trust store (required under Hybrid).

Source

pub fn with_verify_policy(self, policy: CryptoPolicy) -> Self

Set the verification policy explicitly.

Auto Trait Implementations§

§

impl<'a> Freeze for UnwrapOptions<'a>

§

impl<'a> !RefUnwindSafe for UnwrapOptions<'a>

§

impl<'a> Send for UnwrapOptions<'a>

§

impl<'a> Sync for UnwrapOptions<'a>

§

impl<'a> Unpin for UnwrapOptions<'a>

§

impl<'a> UnsafeUnpin for UnwrapOptions<'a>

§

impl<'a> !UnwindSafe for UnwrapOptions<'a>

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T> ServiceExt for T

§

fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>
where Self: Sized,

Apply a transformation to the response body. Read more
§

fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using HTTP status codes. Read more
§

fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>
where Self: Sized,

High level tracing that classifies responses using gRPC headers. Read more
§

fn follow_redirects(self) -> FollowRedirect<Self>
where Self: Sized,

Follow redirect resposes using the Standard policy. 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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSync for T
where T: Sync,

§

impl<T> MaybeSync for T
where T: Sync,