Struct CoreCrypto

pub struct CoreCrypto { /* private fields */ }

Implementations

impl CoreCrypto

pub async fn transaction( &self, command: Arc<dyn CoreCryptoCommand>, ) -> Result<(), CoreCryptoError>

Starts a new transaction in Core Crypto. If the callback succeeds, it will be committed, otherwise, every operation performed with the context will be discarded.

When calling this function from within Rust, async functions accepting a context implement CoreCryptoCommand, so operations can be defined inline as follows:

core_crypto.transaction(Arc::new(|context| async {
    // your implementation here
    Ok(())
}))?;

impl CoreCrypto

pub async fn register_epoch_observer( &self, epoch_observer: Arc<dyn EpochObserver>, ) -> Result<(), CoreCryptoError>

Add an epoch observer to this client.

This function should be called 0 or 1 times in a client’s lifetime. If called when an epoch observer already exists, this will return an error.

impl CoreCrypto

pub async fn new( path: String, key: String, client_id: Option<ClientId>, ciphersuites: Option<Ciphersuites>, nb_key_package: Option<u32>, ) -> Result<Self, CoreCryptoError>

pub async fn provide_transport( &self, callbacks: Arc<dyn MlsTransport>, ) -> Result<(), CoreCryptoError>

See core_crypto::mls::MlsCentral::provide_transport

pub async fn client_public_key( &self, ciphersuite: Ciphersuite, credential_type: MlsCredentialType, ) -> Result<Vec<u8>, CoreCryptoError>

See core_crypto::mls::MlsCentral::client_public_key

pub async fn conversation_epoch( &self, conversation_id: Vec<u8>, ) -> Result<u64, CoreCryptoError>

See [core_crypto::mls::conversation::ImmutableConversation::epoch]

pub async fn conversation_ciphersuite( &self, conversation_id: &ConversationId, ) -> Result<Ciphersuite, CoreCryptoError>

See [core_crypto::mls::conversation::ImmutableConversation::ciphersuite]

pub async fn conversation_exists( &self, conversation_id: Vec<u8>, ) -> Result<bool, CoreCryptoError>

See core_crypto::mls::MlsCentral::conversation_exists

pub async fn random_bytes(&self, len: u32) -> Result<Vec<u8>, CoreCryptoError>

See core_crypto::mls::MlsCentral::random_bytes

pub async fn reseed_rng(&self, seed: Vec<u8>) -> Result<(), CoreCryptoError>

see core_crypto::prelude::MlsCryptoProvider::reseed

pub async fn get_client_ids( &self, conversation_id: Vec<u8>, ) -> Result<Vec<ClientId>, CoreCryptoError>

See [core_crypto::mls::conversation::ImmutableConversation::get_client_ids]

pub async fn export_secret_key( &self, conversation_id: Vec<u8>, key_length: u32, ) -> Result<Vec<u8>, CoreCryptoError>

See [core_crypto::mls::conversation::ImmutableConversation::export_secret_key]

pub async fn get_external_sender( &self, conversation_id: Vec<u8>, ) -> Result<Vec<u8>, CoreCryptoError>

See [core_crypto::mls::conversation::ImmutableConversation::get_external_sender]

impl CoreCrypto

pub async fn proteus_session_exists( &self, session_id: String, ) -> Result<bool, CoreCryptoError>

See core_crypto::proteus::ProteusCentral::session_exists

pub fn proteus_last_resort_prekey_id(&self) -> Result<u16, CoreCryptoError>

See core_crypto::proteus::ProteusCentral::last_resort_prekey_id

pub async fn proteus_fingerprint(&self) -> Result<String, CoreCryptoError>

See core_crypto::proteus::ProteusCentral::fingerprint

pub async fn proteus_fingerprint_local( &self, session_id: String, ) -> Result<String, CoreCryptoError>

See core_crypto::proteus::ProteusCentral::fingerprint_local

pub async fn proteus_fingerprint_remote( &self, session_id: String, ) -> Result<String, CoreCryptoError>

See core_crypto::proteus::ProteusCentral::fingerprint_remote

pub fn proteus_fingerprint_prekeybundle( &self, prekey: Vec<u8>, ) -> Result<String, CoreCryptoError>

See core_crypto::proteus::ProteusCentral::fingerprint_prekeybundle NOTE: uniffi doesn’t support associated functions, so we have to have the self here

impl CoreCrypto

pub async fn e2ei_dump_pki_env( &self, ) -> Result<Option<E2eiDumpedPkiEnv>, CoreCryptoError>

pub async fn e2ei_is_pki_env_setup(&self) -> bool

See core_crypto::mls::MlsCentral::e2ei_is_pki_env_setup

pub async fn e2ei_is_enabled( &self, ciphersuite: Ciphersuite, ) -> Result<bool, CoreCryptoError>

See core_crypto::mls::MlsCentral::e2ei_is_enabled

pub async fn get_device_identities( &self, conversation_id: Vec<u8>, device_ids: Vec<ClientId>, ) -> Result<Vec<WireIdentity>, CoreCryptoError>

See [core_crypto::mls::conversation::ConversationGuard::get_device_identities]

pub async fn get_user_identities( &self, conversation_id: Vec<u8>, user_ids: Vec<String>, ) -> Result<HashMap<String, Vec<WireIdentity>>, CoreCryptoError>

See [core_crypto::mls::conversation::ConversationGuard::get_user_identities]

pub async fn get_credential_in_use( &self, group_info: Vec<u8>, credential_type: MlsCredentialType, ) -> Result<E2eiConversationState, CoreCryptoError>

See core_crypto::mls::MlsCentral::get_credential_in_use

Trait Implementations

impl Debug for CoreCrypto

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

Formats the value using the given formatter.

impl<UT> LiftRef<UT> for CoreCrypto

type LiftType = Arc<CoreCrypto>

impl<UT> LowerError<UT> for CoreCrypto

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for CoreCrypto

type ReturnType = <Arc<CoreCrypto> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type.

fn lower_return(obj: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl<UT> TypeId<UT> for CoreCrypto

const TYPE_ID_META: MetadataBuffer