Skip to main content

SFrameSession

Struct SFrameSession 

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

An SFrame session bound to one MLS epoch.

A new session must be created whenever the MLS group commits (epoch changes) — the old base key becomes unreachable and all per-sender keys are rotated automatically.

Implementations§

Source§

impl SFrameSession

Source

pub fn new(base_key: [u8; 32], epoch: u64, suite: CipherSuite) -> Self

Creates a session from a raw 32-byte base key.

Prefer from_mls when an MlsContext is available; this constructor is mainly for testing.

Source

pub fn from_mls( mls: &MlsContext, label: &str, suite: CipherSuite, ) -> Result<Self, SFrameError>

Derives a session from the current MLS group state.

Calls MLS.ExportSecret(label, context=epoch_be8, length=32) to obtain the base key, then stores it alongside the current epoch and ciphersuite.

label is application-defined (e.g. "gbp/sframe v1").

Source

pub fn epoch(&self) -> u64

Returns the MLS epoch this session was created for.

Source

pub fn suite(&self) -> CipherSuite

Returns the active ciphersuite.

Source

pub fn encryptor(&self, leaf_index: u32) -> SFrameEncryptor

Creates a sender-side encryptor for leaf_index.

The returned SFrameEncryptor owns the derived key+salt for this sender and maintains an internal counter. Create one per sender; do not share an encryptor across multiple goroutines/threads.

Source

pub fn decryptor(&self) -> SFrameDecryptor

Creates a receiver-side decryptor for this epoch.

The SFrameDecryptor lazily derives per-sender keys as new KIDs arrive, and maintains an independent 1024-entry replay window per sender.

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

Source§

type Classified = T

Source§

fn classify(self) -> T

Source§

impl<T> Declassify for T

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

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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