Skip to main content

HandshakeClient

Struct HandshakeClient 

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

Handshake Client State Machine

kem_secret and signing_key are already ZeroizeOnDrop in their own types. The remaining sensitive field is nonce, which is zeroed via the derived ZeroizeOnDrop. early_data is application plaintext queued before the secure channel is up — it lives in user-controlled storage and is moved out by take_early_data.

Implementations§

Source§

impl HandshakeClient

Source

pub fn new() -> Result<Self, HandshakeError>

Construct a client handshake state. Allocates an ephemeral hybrid KEM keypair, an ephemeral hybrid signing keypair, and a 32-byte client nonce. Returns Err if the OS RNG cannot be read.

Source

pub fn create_client_hello(&self) -> ClientHello

Build the default ClientHello — pinned PROTOCOL_VERSION, no resumption, no 0-RTT early-data. Downgrade resistance comes from the transcript signature, which binds both version and the build-side PROTOCOL_VARIANT; a network rewrite of either aborts the handshake at the client-side signature check.

Source

pub fn create_client_hello_with_resume( &self, resume_session_id: [u8; 32], resumption_secret: &[u8; 32], early_data: Option<&[u8]>, ) -> ClientHello

Build a ClientHello that resumes a prior session, optionally carrying 0-RTT early_data.

resume_session_id and resumption_secret are the two halves of a prior session’s Session::resumption_hint(). The server checks its session cache; a known, still-valid ticket bypasses the cookie/PoW DoS gate. When early_data is Some, it is sealed (AES-256-GCM) under a key derived from (resumption_secret, self.nonce) and placed in ClientHello.early_data; the server decrypts it with the matching key (best-effort — see HandshakeServer::process_client_hello). The whole hello, early-data included, is transcript-bound (Invariant 7).

The caller MUST ensure early_data.len() <= EARLY_DATA_MAX_LEN; PhantomSession::connect_with_resumption enforces this and returns an error for oversized payloads.

Source

pub fn process_server_hello( &self, client_hello: &ClientHello, server_hello: &ServerHello, expected_server_key: Option<&HybridVerifyingKey>, ) -> Result<(Session, Option<bool>), HandshakeError>

Verify a ServerHello against the ClientHello we sent and establish the client-side Session.

Pinning is mandatory in production — expected_server_key is Some(&key) (Invariant 1). The signature is checked over the whole transcript, which embeds the entire ClientHello (early-data ciphertext included) and the build-side PROTOCOL_VARIANT (Invariants 7, 10). Returns the established Session and the 0-RTT verdict: Some(true/false) when the client sent early-data (accepted / rejected per server_hello.early_data_accepted), None when it sent none.

Source

pub fn queue_early_data(&self, data: Vec<u8>)

Queue a plaintext payload to be sent as early-data once the secure channel is up.

NOTE: Early-data is currently queued at the API layer (see PhantomSession::send_queue) and the data-pump flushes it through the regular AEAD path after the handshake completes. This per-handshake buffer is reserved for the future 0-RTT path (Phase 4.1).

Source

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

Drain the queued early-data buffer. See Self::queue_early_data — the production send_queue path is currently used instead; this hook is reserved for 0-RTT.

Source

pub fn stage(&self) -> HandshakeStage

Trait Implementations§

Source§

impl Drop for HandshakeClient

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. 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
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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CompatExt for T

Source§

fn compat(self) -> Compat<T>
where T: Sized,

Applies the Compat adapter by value. Read more
Source§

fn compat_ref(&self) -> Compat<&T>

Applies the Compat adapter by shared reference. Read more
Source§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the Compat adapter by mutable reference. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

Source§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
Source§

unsafe fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
Source§

unsafe fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<> Read more
Source§

unsafe fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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