Struct core_crypto::prelude::Client

pub struct Client { /* private fields */ }

Represents a MLS client which in our case is the equivalent of a device.

It can be the Android, iOS, web or desktop application which the authenticated user is using. A user has many client, a client has only one user. A client can belong to many MLS groups

It is cheap to clone a Client because everything heavy is wrapped inside an Arc.

Implementations

impl Client

pub async fn generate_one_keypackage_from_credential_bundle( &self, backend: &MlsCryptoProvider, cs: MlsCiphersuite, cb: &CredentialBundle, ) -> CryptoResult<KeyPackage>

Generates a single new keypackage

Arguments

• backend - the KeyStorage to load the keypackages from

Errors

KeyStore and OpenMls errors

pub async fn request_key_packages( &self, count: usize, ciphersuite: MlsCiphersuite, credential_type: MlsCredentialType, backend: &MlsCryptoProvider, ) -> CryptoResult<Vec<KeyPackage>>

Requests count keying material to be present and returns a reference to it for the consumer to copy/clone.

Arguments

• count - number of openmls::key_packages::KeyPackage to generate
• ciphersuite - of openmls::key_packages::KeyPackage to generate
• backend - the KeyStorage to load the keypackages from

Errors

KeyStore and OpenMls errors

pub async fn valid_keypackages_count( &self, backend: &MlsCryptoProvider, ciphersuite: MlsCiphersuite, credential_type: MlsCredentialType, ) -> CryptoResult<usize>

Returns the count of valid, non-expired, unclaimed keypackages in store

pub async fn prune_keypackages( &self, backend: &MlsCryptoProvider, refs: &[KeyPackageRef], ) -> CryptoResult<()>

Prune the provided KeyPackageRefs from the keystore

Warning: Despite this API being public, the caller should know what they’re doing. Provided KeypackageRefs will be purged regardless of their expiration state, so please be wary of what you are doing if you directly call this API. This could result in still valid, uploaded keypackages being pruned from the system and thus being impossible to find when referenced in a future Welcome message.

impl Client

pub async fn init( &self, identifier: ClientIdentifier, ciphersuites: &[MlsCiphersuite], backend: &MlsCryptoProvider, nb_key_package: usize, ) -> CryptoResult<()>

Initializes the client. If the client’s cryptographic material is already stored in the keystore, it loads it Otherwise, it is being created.

Arguments

• identifier - client identifier ; either a ClientId or a x509 certificate chain
• ciphersuites - all ciphersuites this client is supposed to support
• backend - the KeyStore and crypto provider to read identities from

Errors

KeyStore and OpenMls errors can happen

pub async fn generate_raw_keypairs( &self, ciphersuites: &[MlsCiphersuite], backend: &MlsCryptoProvider, ) -> CryptoResult<Vec<ClientId>>

Initializes a raw MLS keypair without an associated client ID Returns a random ClientId to bind later in Client::init_with_external_client_id

Arguments

• ciphersuites - all ciphersuites this client is supposed to support
• backend - the KeyStore and crypto provider to read identities from

Errors

KeyStore and OpenMls errors can happen

pub async fn init_with_external_client_id( &self, client_id: ClientId, tmp_ids: Vec<ClientId>, ciphersuites: &[MlsCiphersuite], backend: &MlsCryptoProvider, ) -> CryptoResult<()>

Finalizes initialization using a 2-step process of uploading first a public key and then associating a new Client ID to that keypair

Arguments

• client_id - The client ID you have fetched from the MLS Authentication Service
• tmp_ids - The temporary random client ids generated in the previous step Client::generate_raw_keypairs
• ciphersuites - To initialize the Client with
• backend - the KeyStore and crypto provider to read identities from

WARNING: You have absolutely NO reason to call this if you didn’t call Client::generate_raw_keypairs first. You have been warned!

pub async fn id(&self) -> CryptoResult<ClientId>

Retrieves the client’s client id. This is free-form and not inspected.

pub async fn is_e2ei_capable(&self) -> bool

Returns whether this client is E2EI capable

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

impl Default for Client

fn default() -> Client

Returns the “default value” for a type.