Skip to main content

KmRefreshDriver

Struct KmRefreshDriver 

Source
pub struct KmRefreshDriver { /* private fields */ }
Available on crate feature crypto only.
Expand description

Sans-IO SEK-rotation state machine (draft-sharabayko-srt-01 §6.1.6).

Tracks which KeyParity is currently active and fires KmRefreshEvents as the packet count crosses the configured KmRefreshThresholds. Does not hold key material itself — see the module doc. Rotates indefinitely: once a cycle’s KmRefreshEvent::Decommission fires, the next cycle’s thresholds are armed again against the new active key’s epoch.

Implementations§

Source§

impl KmRefreshDriver

Source

pub fn new(thresholds: KmRefreshThresholds, initial_parity: KeyParity) -> Self

A fresh driver. initial_parity is the SEK negotiated at handshake time (this crate’s handshake convention is KeyParity::Even — see crate::handshake_sm::build_key_material_extension, crypto feature only).

Source

pub fn active_parity(&self) -> KeyParity

The currently-active parity for new outgoing packets.

Source

pub fn total_sent(&self) -> u64

Total packets recorded via Self::on_packet_sent/Self::tick.

Source

pub fn is_key_valid(&self, parity: KeyParity) -> bool

Whether parity’s key should still be considered held/valid. The active key always is; the just-retired key is too, from switchover until decommission (§6.1.6’s “both keys valid in parallel” transition window) — a data packet under either may legitimately arrive during that window (in-flight or retransmitted).

Source

pub fn on_packet_sent(&mut self, n: u64) -> Vec<KmRefreshEvent>

Record n more packets sent under the active key and return any KmRefreshEvents newly crossed, in spec order (PreAnnounce, Switchover, Decommission). A single call can fire more than one event if n is large enough to cross multiple thresholds at once.

Source

pub fn tick(&mut self) -> Vec<KmRefreshEvent>

Record exactly one packet sent — convenience wrapper over Self::on_packet_sent.

Trait Implementations§

Source§

impl Clone for KmRefreshDriver

Source§

fn clone(&self) -> KmRefreshDriver

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for KmRefreshDriver

Source§

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

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

impl PartialEq for KmRefreshDriver

Source§

fn eq(&self, other: &KmRefreshDriver) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for KmRefreshDriver

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.