Struct core_crypto::mls::MlsCentral

pub struct MlsCentral { /* private fields */ }

The entry point for the MLS CoreCrypto library. This struct provides all functionality to create and manage groups, make proposals and commits.

Implementations

impl MlsCentral

pub async fn export_secret_key( &self, conversation_id: &ConversationId, key_length: usize, ) -> CryptoResult<Vec<u8>>

Derives a new key from the one in the group, allowing it to be use elsewehere.

Arguments

• conversation_id - the group/conversation id
• key_length - the length of the key to be derived. If the value is higher than the bounds of u16 or the context hash * 255, an error will be returned

Errors

OpenMls secret generation error or conversation not found

pub async fn get_client_ids( &self, conversation_id: &ConversationId, ) -> CryptoResult<Vec<ClientId>>

Exports the clients from a conversation

Arguments

• conversation_id - the group/conversation id

Errors

if the conversation can’t be found

impl MlsCentral

pub async fn get_external_sender( &self, id: &ConversationId, ) -> CryptoResult<Vec<u8>>

Returns the raw public key of the single external sender present in this group. This should be used to initialize a subconversation

impl MlsCentral

pub async fn try_new( configuration: MlsCentralConfiguration, ) -> CryptoResult<Self>

Tries to initialize the MLS Central object. Takes a store path (i.e. Disk location of the embedded database, should be consistent between messaging sessions) And a root identity key (i.e. enclaved encryption key for this device)

Arguments

• configuration - the configuration for the MlsCentral

Errors

Failures in the initialization of the KeyStore can cause errors, such as IO, the same kind of errors can happen when the groups are being restored from the KeyStore or even during the client initialization (to fetch the identity signature). Other than that, MlsError can be caused by group deserialization or during the initialization of the credentials:

• for x509 Credentials if the cetificate chain length is lower than 2
• for Basic Credentials if the signature key cannot be generated either by not supported scheme or the key generation fails

pub async fn try_new_in_memory( configuration: MlsCentralConfiguration, ) -> CryptoResult<Self>

Same as the MlsCentral::try_new but instead, it uses an in memory KeyStore. Although required, the store_path parameter from the MlsCentralConfiguration won’t be used here.

pub async fn callbacks(&self, callbacks: Arc<dyn CoreCryptoCallbacks>)

Sets the consumer callbacks (i.e authorization callbacks for CoreCrypto to perform authorization calls when needed)

Arguments

• callbacks - a callback to be called to perform authorization

pub async fn client_public_key( &self, ciphersuite: MlsCiphersuite, credential_type: MlsCredentialType, ) -> CryptoResult<Vec<u8>>

Returns the client’s most recent public signature key as a buffer. Used to upload a public key to the server in order to verify client’s messages signature.

Arguments

• ciphersuite - a callback to be called to perform authorization
• credential_type - of the credential to look for

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

Returns the client’s id as a buffer

pub async fn conversation_exists( &self, id: &ConversationId, ) -> CryptoResult<bool>

Checks if a given conversation id exists locally

pub async fn conversation_epoch(&self, id: &ConversationId) -> CryptoResult<u64>

Returns the epoch of a given conversation

Errors

If the conversation can’t be found

pub async fn conversation_ciphersuite( &self, id: &ConversationId, ) -> CryptoResult<MlsCiphersuite>

Returns the ciphersuite of a given conversation

Errors

If the conversation can’t be found

pub fn random_bytes(&self, len: usize) -> CryptoResult<Vec<u8>>

Generates a random byte array of the specified size

pub async fn close(self) -> CryptoResult<()>

Closes the connection with the local KeyStore

Errors

KeyStore errors, such as IO

pub async fn wipe(self) -> CryptoResult<()>

Destroys everything we have, in-memory and on disk.

Errors

KeyStore errors, such as IO

pub async fn reseed(&self, seed: Option<EntropySeed>) -> CryptoResult<()>

see mls_crypto_provider::MlsCryptoProvider::reseed

impl MlsCentral

pub async fn e2ei_verify_group_state( &self, group_info: VerifiableGroupInfo, ) -> CryptoResult<E2eiConversationState>

Verifies a Group state before joining it

pub async fn get_credential_in_use( &self, group_info: VerifiableGroupInfo, credential_type: MlsCredentialType, ) -> CryptoResult<E2eiConversationState>

Gets the e2ei conversation state from a GroupInfo. Useful to check if the group has e2ei turned on or not before joining it.

impl MlsCentral

pub async fn e2ei_is_enabled( &self, signature_scheme: SignatureScheme, ) -> CryptoResult<bool>

Returns true when end-to-end-identity is enabled for the given SignatureScheme

impl MlsCentral

pub async fn get_device_identities( &self, conversation_id: &ConversationId, client_ids: &[ClientId], ) -> CryptoResult<Vec<WireIdentity>>

From a given conversation, get the identity of the members supplied. Identity is only present for members with a Certificate Credential (after turning on end-to-end identity). If no member has a x509 certificate, it will return an empty Vec

pub async fn get_user_identities( &self, conversation_id: &ConversationId, user_ids: &[String], ) -> CryptoResult<HashMap<String, Vec<WireIdentity>>>

From a given conversation, get the identity of the users (device holders) supplied. Identity is only present for devices with a Certificate Credential (after turning on end-to-end identity). If no member has a x509 certificate, it will return an empty Vec.

Returns a Map with all the identities for a given users. Consumers are then recommended to reduce those identities to determine the actual status of a user.

impl MlsCentral

pub async fn e2ei_is_pki_env_setup(&self) -> bool

Returns whether the E2EI PKI environment is setup (i.e. Root CA, Intermediates, CRLs)

pub async fn e2ei_dump_pki_env(&self) -> CryptoResult<Option<E2eiDumpedPkiEnv>>

Dumps the PKI environment as PEM

Trait Implementations

impl Clone for MlsCentral

fn clone(&self) -> MlsCentral

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MlsCentral

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

Formats the value using the given formatter.

impl From<MlsCentral> for CoreCrypto

fn from(mls: MlsCentral) -> Self

Converts to this type from the input type.