Skip to main content

Session

Struct Session 

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

Handshake + rekey state machine for Foctet Core.

Implementations§

Source§

impl Session

Source

pub fn new_initiator(thresholds: RekeyThresholds) -> (Self, ControlMessage)

Creates an initiator session and returns the initial ClientHello.

Source

pub fn new_initiator_with_auth( thresholds: RekeyThresholds, auth: SessionAuthConfig, ) -> (Self, ControlMessage)

Creates an initiator session with explicit authentication configuration.

Source

pub fn new_responder(thresholds: RekeyThresholds) -> Self

Creates a responder session waiting for a peer ClientHello.

Source

pub fn new_responder_with_auth( thresholds: RekeyThresholds, auth: SessionAuthConfig, ) -> Self

Creates a responder session with explicit authentication configuration.

Source

pub fn state(&self) -> SessionState

Returns current session state.

Source

pub fn role(&self) -> HandshakeRole

Returns configured handshake role.

Source

pub fn peer_authenticated(&self) -> bool

Returns whether the peer presented and passed handshake authentication.

Source

pub fn outbound_direction(&self) -> Direction

Returns outbound traffic direction for this role.

Source

pub fn inbound_direction(&self) -> Direction

Returns inbound traffic direction for this role.

Source

pub fn handle_control( &mut self, msg: &ControlMessage, ) -> Result<Option<ControlMessage>, CoreError>

Applies an incoming control message and optionally returns a response.

Source

pub fn active_keys(&self) -> Option<TrafficKeys>

Returns the currently active traffic keys, if session is active.

Source

pub fn active_and_previous_keys(&self) -> Option<Vec<TrafficKeys>>

Returns active key followed by retained previous keys.

Source

pub fn key_ring(&self) -> Result<Vec<TrafficKeys>, CoreError>

Returns current key ring as transport-ready list.

Source

pub fn on_outbound_payload( &mut self, plaintext_len: usize, ) -> Result<Option<ControlMessage>, CoreError>

Records outbound payload usage and emits rekey control when needed.

Source

pub fn force_rekey(&mut self) -> Result<ControlMessage, CoreError>

Forces immediate rekey and returns the Rekey control message.

Trait Implementations§

Source§

impl Clone for Session

Source§

fn clone(&self) -> Session

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 Session

Source§

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

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

impl Drop for Session

Source§

fn drop(&mut self)

Executes the destructor for this type. 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<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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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.