Struct Database 

pub struct Database { /* private fields */ }

Implementations

impl Database

pub async fn child_groups( &self, entity: PersistedMlsGroup, ) -> CryptoKeystoreResult<Vec<PersistedMlsGroup>>

pub async fn find_pending_messages_by_conversation_id( &self, conversation_id: &[u8], ) -> CryptoKeystoreResult<Vec<MlsPendingMessage>>

pub async fn remove_pending_messages_by_conversation_id( &self, conversation_id: impl AsRef<[u8]> + Send, ) -> CryptoKeystoreResult<()>

impl Database

These impls control the keystore transaction lifecycle.

pub async fn new_transaction(&self) -> CryptoKeystoreResult<()>

Waits for the current transaction to be committed or rolled back, then starts a new one.

pub async fn try_new_immediate_transaction(&self) -> CryptoKeystoreResult<()>

Start a new transaction if no other transaction is currently in progress.

If a transaction is currently in progress, this will produce a TransactionInProgress error.

pub async fn commit_transaction(&self) -> CryptoKeystoreResult<()>

pub async fn rollback_transaction(&self) -> CryptoKeystoreResult<()>

pub async fn transactionally<R>( &self, operation: impl AsyncFnOnce(&KeystoreTransaction) -> CryptoKeystoreResult<R>, ) -> CryptoKeystoreResult<R>

Do an operation on a keystore transaction on this database.

This is a convenience method abstracting over Self::new_transaction, Self::commit_transaction, and Self::rollback_transaction.

If the operation succeeds, the transaction is committed. Otherwise, it is rolled back.

impl Database

These impls are convenience methods to modify the keystore transaction.

Be aware that we are likely to remove these in the future: WPB-23951

pub async fn save<E>( &self, entity: E, ) -> CryptoKeystoreResult<E::AutoGeneratedFields>

where E: Entity + EntityDatabaseMutation + Send + Sync,

pub async fn remove<E>(&self, id: &E::PrimaryKey) -> CryptoKeystoreResult<()>

where E: Entity + EntityDatabaseMutation,

pub async fn remove_borrowed<E>( &self, id: &E::BorrowedPrimaryKey, ) -> CryptoKeystoreResult<()>

where E: Entity + EntityDatabaseMutation + BorrowPrimaryKey + EntityDeleteBorrowed,

pub async fn restore<E>( &self, id: &E::BorrowedPrimaryKey, ) -> CryptoKeystoreResult<()>

where E: Entity + EntityDatabaseMutation + BorrowPrimaryKey + EntityDeleteBorrowed,

Restore an entity that was deleted in this transaction by removing it from the deleted list. This is idempotent: if the entity doesn’t exist in the deleted list, do nothing.

NOTE: This will only work if the entity has been added in an earlier transaction, because otherwise, removing its id from the deleted list wouldn’t suffice: we’d need to replay its insertion.

impl Database

pub async fn open( path: &str, database_key: &DatabaseKey, ) -> CryptoKeystoreResult<Arc<Self>>

Open an encrypted Database at the provided location.

When compiled with target_os = "unknown", this opens a database encrypted via sqlite3-multiple-ciphers using its default encryption mechanism, stored in IndexedDB via the relaxed-idb shim.

When compiled normally, this opens a database encrypted via sqlcipher at a path in the local filesystem.

pub fn open_in_memory() -> CryptoKeystoreResult<Arc<Self>>

Open an in-memory Database.

In-memory databases are never encrypted.

pub async fn update_key( &self, new_key: &DatabaseKey, ) -> CryptoKeystoreResult<()>

Change the encryption key for this database.

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

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

Close and remove this database.

This deletes the database, including its encryption key. Future opens will always succeed with any arbitrary encryption key; they will simply open an empty database.

pub async fn location(&self) -> Option<String>

Get the location of the database.

Returns None if the database is in-memory.

pub async fn export_copy( &self, destination_path: &str, ) -> CryptoKeystoreResult<()>

Export a copy of the database to the specified path using VACUUM INTO.

This creates a fully vacuumed and optimized copy of the database. The copy will be encrypted with the same key as the source database.

Arguments

• destination_path - The file path where the database copy should be created

impl Database

pub async fn mls_fetch_key_packages<V: MlsEntity>( &self, count: u32, ) -> CryptoKeystoreResult<Vec<V>>

Fetches Keypackages

Arguments

• count - amount of entries to be returned

Errors

Any common error that can happen during a database connection. IoError being a common error for example.

pub async fn mls_group_exists(&self, group_id: impl AsRef<[u8]> + Send) -> bool

Checks if the given MLS group id exists in the keystore Note: in case of any error, this will return false

Arguments

• group_id - group/conversation id

pub async fn mls_group_persist( &self, group_id: impl AsRef<[u8]> + Send, state: &[u8], parent_group_id: Option<&[u8]>, ) -> CryptoKeystoreResult<()>

Persists a MlsGroup

Arguments

• group_id - group/conversation id
• state - the group state

Errors

Any common error that can happen during a database connection. IoError being a common error for example.

pub async fn mls_groups_restore( &self, ) -> CryptoKeystoreResult<HashMap<Vec<u8>, (Option<Vec<u8>>, Vec<u8>)>>

Loads MlsGroups from the database. It will be returned as a HashMap where the key is the group/conversation id and the value the group state

Errors

Any common error that can happen during a database connection. IoError being a common error for example.

pub async fn mls_group_delete( &self, group_id: impl AsRef<[u8]> + Send, ) -> CryptoKeystoreResult<()>

Deletes MlsGroups from the database.

Errors

Any common error that can happen during a database connection. IoError being a common error for example.

pub async fn mls_pending_groups_save( &self, group_id: impl AsRef<[u8]> + Send, mls_group: &[u8], custom_configuration: &[u8], parent_group_id: Option<&[u8]>, ) -> CryptoKeystoreResult<()>

Saves a MlsGroup in a temporary table (typically used in scenarios where the group cannot be committed until the backend acknowledges it, like external commits)

Arguments

• group_id - group/conversation id
• mls_group - the group/conversation state
• custom_configuration - local group configuration

Errors

Any common error that can happen during a database connection. IoError being a common error for example.

pub async fn mls_pending_groups_load( &self, group_id: impl AsRef<[u8]> + Send, ) -> CryptoKeystoreResult<Option<(Vec<u8>, Vec<u8>)>>

Loads a temporary MlsGroup and its configuration from the database

Arguments

• id - group/conversation id

Errors

Any common error that can happen during a database connection. IoError being a common error for example.

pub async fn mls_pending_groups_delete( &self, group_id: impl AsRef<[u8]> + Send, ) -> CryptoKeystoreResult<()>

Deletes a temporary MlsGroup from the database

Arguments

• id - group/conversation id

Errors

Any common error that can happen during a database connection. IoError being a common error for example.

pub async fn save_e2ei_enrollment( &self, id: &[u8], content: &[u8], ) -> CryptoKeystoreResult<()>

Persists an enrollment instance

Arguments

• id - hash of the enrollment and unique identifier
• content - serialized enrollment

pub async fn pop_e2ei_enrollment( &self, id: &[u8], ) -> CryptoKeystoreResult<Option<Vec<u8>>>

Fetches and delete the enrollment instance

Arguments

• id - hash of the enrollment and unique identifier

impl Database

pub async fn proteus_store_prekey( &self, id: u16, prekey: &[u8], ) -> CryptoKeystoreResult<()>

Trait Implementations

impl Debug for Database

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

Formats the value using the given formatter.

impl FetchFromDatabase for Database

fn get<'life0, 'life1, 'async_trait, E>( &'life0 self, id: &'life1 E::PrimaryKey, ) -> Pin<Box<dyn Future<Output = CryptoKeystoreResult<Option<E>>> + Send + 'async_trait>>

where E: 'static + Entity + Clone + Send + Sync + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get an instance of E from the database by its primary key.

fn get_borrowed<'life0, 'life1, 'async_trait, E>( &'life0 self, id: &'life1 <E as BorrowPrimaryKey>::BorrowedPrimaryKey, ) -> Pin<Box<dyn Future<Output = CryptoKeystoreResult<Option<E>>> + Send + 'async_trait>>

where E: 'static + EntityGetBorrowed + Clone + Send + Sync + 'async_trait, E::PrimaryKey: Borrow<E::BorrowedPrimaryKey>, for<'a> &'a E::BorrowedPrimaryKey: KeyType, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get an instance of E from the database by the borrowed form of its primary key.

fn count<'life0, 'async_trait, E>( &'life0 self, ) -> Pin<Box<dyn Future<Output = CryptoKeystoreResult<u32>> + Send + 'async_trait>>

where E: 'static + Entity + Clone + Send + Sync + 'async_trait, Self: 'async_trait, 'life0: 'async_trait,

Count the number of Es in the database.

fn load_all<'life0, 'async_trait, E>( &'life0 self, ) -> Pin<Box<dyn Future<Output = CryptoKeystoreResult<Vec<E>>> + Send + 'async_trait>>

where E: 'static + Entity + Clone + Send + Sync + 'async_trait, Self: 'async_trait, 'life0: 'async_trait,

Load all Es from the database.

fn search<'life0, 'life1, 'async_trait, E, SearchKey>( &'life0 self, search_key: &'life1 SearchKey, ) -> Pin<Box<dyn Future<Output = CryptoKeystoreResult<Vec<E>>> + Send + 'async_trait>>

where E: 'static + Entity + SearchableEntity<SearchKey> + Clone + Send + Sync + 'async_trait, SearchKey: KeyType + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Search for relevant instances of E given a search key.

fn get_unique<'a, 'life0, 'async_trait, U>( &'life0 self, ) -> Pin<Box<dyn Future<Output = CryptoKeystoreResult<Option<U>>> + Send + 'async_trait>>

where U: 'static + UniqueEntityExt + Entity + Clone + Send + Sync + 'async_trait, Self: 'async_trait, 'a: 'async_trait, 'life0: 'async_trait,

Get the requested unique entity from the database.

fn exists<'a, 'life0, 'async_trait, U>( &'life0 self, ) -> Pin<Box<dyn Future<Output = CryptoKeystoreResult<bool>> + Send + 'async_trait>>

where U: 'static + UniqueEntityExt + Entity + Clone + Send + Sync + 'async_trait, Self: 'async_trait, 'a: 'async_trait, 'life0: 'async_trait,

Determine whether a unique entity is present in the database.

impl OpenMlsKeyStore for Database

type Error = CryptoKeystoreError

The error type returned by the [OpenMlsKeyStore].

fn store<'life0, 'life1, 'life2, 'async_trait, V>( &'life0 self, id: &'life1 [u8], value: &'life2 V, ) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>>

where Self: Sized + 'async_trait, V: 'async_trait + MlsEntity + Sync, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Store a value v that implements the [MlsEntity] trait for serialization for ID k.

fn read<'life0, 'life1, 'async_trait, V>( &'life0 self, id: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Option<V>> + Send + 'async_trait>>

where Self: Sized + 'async_trait, V: 'async_trait + MlsEntity, 'life0: 'async_trait, 'life1: 'async_trait,

Read and return a value stored for ID k that implements the [MlsEntity] trait for deserialization.

fn delete<'life0, 'life1, 'async_trait, V>( &'life0 self, id: &'life1 [u8], ) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>>

where V: 'async_trait + MlsEntity, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete a value stored for ID k.

impl PreKeyStore for Database

type Error = CryptoKeystoreError

fn prekey<'life0, 'async_trait>( &'life0 self, id: RawPreKeyId, ) -> Pin<Box<dyn Future<Output = Result<Option<RawPreKey>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Lookup prekey by ID.

fn remove<'life0, 'async_trait>( &'life0 self, id: RawPreKeyId, ) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Remove prekey by ID.