Struct MlsClientConfiguration

#[non_exhaustive]
pub struct MlsClientConfiguration {
    pub store_path: String,
    pub database_key: DatabaseKey,
    pub client_id: Option<ClientId>,
    pub external_entropy: Option<EntropySeed>,
    pub ciphersuites: Vec<MlsCiphersuite>,
    pub nb_init_key_packages: Option<usize>,
}

Configuration parameters for [Client].

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

store_path: String

Location where the SQLite/IndexedDB database will be stored

database_key: DatabaseKey

Database key to be used to instantiate the MlsCryptoProvider

client_id: Option<ClientId>

Identifier for the client to be used by [MlsCentral]

external_entropy: Option<EntropySeed>

Entropy pool seed for the internal PRNG

ciphersuites: Vec<MlsCiphersuite>

All supported ciphersuites

nb_init_key_packages: Option<usize>

Number of openmls::prelude::KeyPackage to create when creating a MLS client. Default to INITIAL_KEYING_MATERIAL_COUNT

Implementations

impl MlsClientConfiguration

pub fn try_new( store_path: String, database_key: DatabaseKey, client_id: Option<ClientId>, ciphersuites: Vec<MlsCiphersuite>, entropy: Option<Vec<u8>>, nb_init_key_packages: Option<usize>, ) -> Result<Self>

Creates a new instance of the configuration.

Arguments

• store_path - location where the SQLite/IndexedDB database will be stored
• database_key - key to be used to instantiate the MlsCryptoProvider
• client_id - identifier for the client to be used by [MlsCentral]
• ciphersuites - Ciphersuites supported by this device
• entropy - External source of entropy for platforms where default source insufficient

Errors

Any empty string parameter will result in a Error::MalformedIdentifier error.

Examples

use core_crypto::prelude::{MlsClientConfiguration, MlsCiphersuite};
use core_crypto::DatabaseKey;

let result = MlsClientConfiguration::try_new(
    "/tmp/crypto".to_string(),
    DatabaseKey::generate(),
    Some(b"MY_CLIENT_ID".to_vec().into()),
    vec![MlsCiphersuite::default()],
    None,
    Some(100),
);
assert!(result.is_ok());

pub fn set_entropy(&mut self, entropy: EntropySeed)

Sets the entropy seed

Trait Implementations

impl Clone for MlsClientConfiguration

fn clone(&self) -> MlsClientConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MlsClientConfiguration

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

Formats the value using the given formatter.