Struct openmls::key_packages::KeyPackageBundle

pub struct KeyPackageBundle { /* private fields */ }

A KeyPackageBundle contains a KeyPackage, the corresponding private key, and a leaf secret.

Implementations

impl KeyPackageBundle

pub fn new(
    ciphersuites: &[Ciphersuite],
    credential_bundle: &CredentialBundle,
    backend: &impl OpenMlsCryptoProvider,
    extensions: Vec<Extension>
) -> Result<Self, KeyPackageBundleNewError>

Create a new KeyPackageBundle with a fresh key pair. This key package will have the default MLS version. Use KeyPackageBundle::new_with_version to get a key package bundle for a specific MLS version.

Note that the capabilities extension gets added automatically, based on the configuration.

Returns a new KeyPackageBundle or a KeyPackageBundleNewError.

pub fn new_with_version(
    version: ProtocolVersion,
    ciphersuites: &[Ciphersuite],
    backend: &impl OpenMlsCryptoProvider,
    credential_bundle: &CredentialBundle,
    extensions: Vec<Extension>
) -> Result<Self, KeyPackageBundleNewError>

Create a new KeyPackageBundle with

• a fresh key pair
• the provided MLS version
• the first cipher suite in the ciphersuites slice
• the provided extensions

Note that the capabilities extension gets added automatically, based on the configuration.

Returns a new KeyPackageBundle or a KeyPackageBundleNewError.

pub fn key_package(&self) -> &KeyPackage

Get a reference to the public part of this bundle, i.e. the KeyPackage.

pub fn into_parts(self) -> (KeyPackage, (Vec<u8>, Vec<u8>))

Separates the bundle into the KeyPackage and the HPKE private key and leaf secret as raw byte vectors.

impl KeyPackageBundle

This impl block contains no items.

Crate visible KeyPackageBundle functions.

Trait Implementations

impl Clone for KeyPackageBundle

fn clone(&self) -> KeyPackageBundle

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyPackageBundle

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyPackageBundle

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl FromKeyStoreValue for KeyPackageBundle

type Error = &'static str

fn from_key_store_value(ksv: &[u8]) -> Result<Self, Self::Error>

impl Serialize for KeyPackageBundle

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

Serialize this value into the given Serde serializer.

impl ToKeyStoreValue for KeyPackageBundle

type Error = &'static str

fn to_key_store_value(&self) -> Result<Vec<u8>, Self::Error>