KeyResult

Enum KeyResult 

Source
pub enum KeyResult {
    AllValid,
    PartialFailure {
        failed_indices: Vec<usize>,
    },
    AllFailed,
}
Expand description

Result of ML-DSA multi-key challenge verification

After verifying all key proofs in a response, the server sends back this result indicating which proofs succeeded or failed. This allows the client to understand their verification status.

§Success Criteria

The handshake is considered successful if at least one key proof is valid. Even if some proofs fail, the connection can continue with the successfully verified keys.

§Error Handling

If all proofs fail, the server should close the connection. Clients can use the failure information to:

  • Log which specific keys were rejected
  • Retry the connection with different keys
  • Debug key or signature generation issues

Variants§

§

AllValid

All key proofs were successfully verified

This is the ideal case where every key the client attempted to prove was successfully verified. All provided keys are now available for use in message authentication on this connection.

§

PartialFailure

Some key proofs failed verification

Contains the indices (into the original key_proofs vector) of proofs that failed verification. The connection continues with the successfully verified keys.

Common failure reasons:

  • Invalid signature (wrong private key used)
  • Malformed public key encoding
  • Signature over wrong data (incorrect nonce/server key)
  • Expired challenge (client took too long to respond)

Fields

§failed_indices: Vec<usize>

Zero-based indices of failed key proofs

These indices correspond to positions in the original KeyResponse.key_proofs vector that failed verification.

§

AllFailed

All key proofs failed verification

No keys were successfully verified. The server will typically close the connection after sending this result. Clients should not attempt to establish service streams after receiving this result.

Implementations§

Source§

impl KeyResult

Source

pub fn is_successful(&self) -> bool

Check if the handshake was successful (at least one key verified)

Returns true if at least one key was successfully verified, false if all keys failed verification.

§Example
use zoe_wire_protocol::KeyResult;

let result = KeyResult::PartialFailure {
    failed_indices: vec![1, 3]
};
assert!(result.is_successful());

let result = KeyResult::AllFailed;
assert!(!result.is_successful());
Source

pub fn failed_count(&self, total_keys: usize) -> usize

Get the number of failed key proofs

Returns the count of key proofs that failed verification. For AllValid, returns 0. For AllFailed, the count depends on how many keys were originally submitted.

§Parameters
  • total_keys - Total number of keys that were submitted (needed for AllFailed case)
§Example
use zoe_wire_protocol::KeyResult;

let result = KeyResult::PartialFailure {
    failed_indices: vec![1, 3]
};
assert_eq!(result.failed_count(5), 2);

let result = KeyResult::AllFailed;
assert_eq!(result.failed_count(3), 3);
Source

pub fn success_count(&self, total_keys: usize) -> usize

Get the number of successfully verified keys

Returns the count of key proofs that passed verification.

§Parameters
  • total_keys - Total number of keys that were submitted
§Example
use zoe_wire_protocol::KeyResult;

let result = KeyResult::PartialFailure {
    failed_indices: vec![1]
};
assert_eq!(result.success_count(3), 2);

let result = KeyResult::AllValid;
assert_eq!(result.success_count(5), 5);

Trait Implementations§

Source§

impl Clone for KeyResult

Source§

fn clone(&self) -> KeyResult

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KeyResult

Source§

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

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

impl<'de> Deserialize<'de> for KeyResult

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for KeyResult

Source§

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

Serialize this value into the given Serde serializer. Read more

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
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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
§

impl<T> Classify for T

§

type Classified = T

§

fn classify(self) -> T

§

impl<T> Classify for T

§

type Classified = T

§

fn classify(self) -> T

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
§

impl<T> Declassify for T

§

type Declassified = T

§

fn declassify(self) -> T

§

impl<T> Declassify for T

§

type Declassified = T

§

fn declassify(self) -> T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

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> 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.
§

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

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

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