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 NonceCacheNonce 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: boolRequire 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: CryptoPolicyVerification policy enforced at this site. Defaults to Hybrid (enforced).
Implementations§
Source§impl<'a> UnwrapOptions<'a>
impl<'a> UnwrapOptions<'a>
Sourcepub fn fixed_signer(
pubkey: &'a VerifyingKey,
nonce_cache: &'a dyn NonceCache,
) -> Self
pub fn fixed_signer( pubkey: &'a VerifyingKey, nonce_cache: &'a dyn NonceCache, ) -> Self
Fixed-signer verification under the default (Hybrid-enforced) policy.
Sourcepub fn any_signer(nonce_cache: &'a dyn NonceCache) -> Self
pub fn any_signer(nonce_cache: &'a dyn NonceCache) -> Self
Any-signer verification under the default (Hybrid-enforced) policy.
pub fn with_decryption_key(self, key: &'a SigningKey) -> Self
Sourcepub fn require_encrypted(self, required: bool) -> Self
pub fn require_encrypted(self, required: bool) -> Self
Require request encryption after authenticating the wire envelope.
Sourcepub fn with_pq_store(self, store: &'a dyn PqTrustStore) -> Self
pub fn with_pq_store(self, store: &'a dyn PqTrustStore) -> Self
Attach a kid-anchored ML-DSA-65 trust store (required under Hybrid).
Sourcepub fn with_verify_policy(self, policy: CryptoPolicy) -> Self
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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