Struct KeyPackageBuilder 

pub struct KeyPackageBuilder { /* private fields */ }

Available on 32-bit or 64-bit only.

Builder that helps creating (and configuring) a KeyPackage.

Implementations

impl KeyPackageBuilder

pub fn new() -> Self

Create a key package builder.

pub fn key_package_lifetime(self, lifetime: Lifetime) -> Self

Set the key package lifetime.

pub fn key_package_extensions(self, extensions: Extensions<KeyPackage>) -> Self

Set the key package extensions.

pub fn mark_as_last_resort(self) -> Self

Mark the key package as a last-resort key package via a LastResortExtension.

pub fn leaf_node_capabilities(self, capabilities: Capabilities) -> Self

Set the leaf node capabilities.

pub fn leaf_node_extensions(self, extensions: Extensions<LeafNode>) -> Self

Set the leaf node extensions.

Returns an error if one or more of the extensions is invalid in leaf nodes.

pub fn build( self, ciphersuite: Ciphersuite, provider: &impl OpenMlsProvider, signer: &impl Signer, credential_with_key: CredentialWithKey, ) -> Result<KeyPackageBundle, KeyPackageNewError>

Finalize and build the key package.

pub fn build_vc_batch( self, ciphersuite: Ciphersuite, provider: &impl OpenMlsProvider, signer: &impl Signer, credential_with_key: CredentialWithKey, epoch_id: EpochId, count: usize, ) -> Result<VcKeyPackageBatch, KeyPackageNewError>

Available on crate feature virtual-clients-draft only.

Build a batch of virtual-client KeyPackages a sibling can reproduce.

Allocates a single generation of the key_package operation ratchet for the emulation epoch identified by epoch_id. For each key_package_index in 0..count it derives a per-KeyPackage seed secret from that one operation secret and derives the KeyPackage’s init key and leaf encryption key from the seed. Each leaf carries an encrypted DerivationInfo under VC_COMPONENT_ID so a sibling can recover the emulation leaf index, generation, and index.

The operation secret and the seeds are derived under the emulation epoch’s ciphersuite (the operation tree’s ciphersuite). The init and leaf-encryption keys are derived from each seed under the KeyPackage’s own ciphersuite.

Each leaf must declare AppDataDictionary support and list VC_COMPONENT_ID in its AppComponents entry, otherwise this returns VirtualClientsError::AppDataDictionaryNotSupported or VirtualClientsError::VcComponentNotListed.

Returns a VcKeyPackageBatch holding the batch’s generation and one (KeyPackageBundle, KeyPackageInfo) per KeyPackage. Each bundle is also written to storage so the creating client can process its own Welcomes, and each KeyPackageInfo carries the index the client hands to its sibling.

Returns KeyPackageNewError::EmptyBatch when count is 0, before loading any state or consuming a generation.

Trait Implementations

impl Clone for KeyPackageBuilder

fn clone(&self) -> KeyPackageBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyPackageBuilder

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

Formats the value using the given formatter.

impl Default for KeyPackageBuilder

fn default() -> KeyPackageBuilder

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KeyPackageBuilder

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for KeyPackageBuilder

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

where __S: Serializer,

Serialize this value into the given Serde serializer.