Struct SqliteCryptoStore

pub struct SqliteCryptoStore { /* private fields */ }

A sqlite based cryptostore.

Implementations

impl SqliteCryptoStore

pub async fn open( path: impl AsRef<Path>, passphrase: Option<&str>, ) -> Result<SqliteCryptoStore, OpenStoreError>

Open the sqlite-based crypto store at the given path using the given passphrase to encrypt private data.

pub async fn open_with_pool( pool: Pool<Manager>, passphrase: Option<&str>, ) -> Result<SqliteCryptoStore, OpenStoreError>

Create a sqlite-based crypto store using the given sqlite database pool. The given passphrase will be used to encrypt private data.

Trait Implementations

impl Clone for SqliteCryptoStore

fn clone(&self) -> SqliteCryptoStore

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CryptoStore for SqliteCryptoStore

type Error = Error

The error type used by this crypto store.

fn load_account<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Option<Account>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

Load an account that was previously stored.

fn load_identity<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Option<PrivateCrossSigningIdentity>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

Try to load a private cross signing identity, if one is stored.

fn save_pending_changes<'life0, 'async_trait>( &'life0 self, changes: PendingChanges, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

Save the set of changes to the store.

fn save_changes<'life0, 'async_trait>( &'life0 self, changes: Changes, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

Save the set of changes to the store.

fn save_inbound_group_sessions<'life0, 'life1, 'async_trait>( &'life0 self, sessions: Vec<InboundGroupSession>, backed_up_to_version: Option<&'life1 str>, ) -> Pin<Box<dyn Future<Output = Result<(), <SqliteCryptoStore as CryptoStore>::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Save a list of inbound group sessions to the store.

fn get_sessions<'life0, 'life1, 'async_trait>( &'life0 self, sender_key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<Session>>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Get all the sessions that belong to the given sender key.

fn get_inbound_group_session<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, session_id: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<Option<InboundGroupSession>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, SqliteCryptoStore: 'async_trait,

Get the inbound group session from our store.

fn get_inbound_group_sessions<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<InboundGroupSession>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

Get all the inbound group sessions we have stored.

fn get_inbound_group_sessions_for_device_batch<'life0, 'async_trait>( &'life0 self, sender_key: Curve25519PublicKey, sender_data_type: SenderDataType, after_session_id: Option<String>, limit: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<InboundGroupSession>, <SqliteCryptoStore as CryptoStore>::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

Get a batch of inbound group sessions for the device with the supplied curve key, whose sender data is of the supplied type.

fn inbound_group_session_counts<'life0, 'life1, 'async_trait>( &'life0 self, backup_version: Option<&'life1 str>, ) -> Pin<Box<dyn Future<Output = Result<RoomKeyCounts, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Get the number inbound group sessions we have and how many of them are backed up.

fn inbound_group_sessions_for_backup<'life0, 'life1, 'async_trait>( &'life0 self, _backup_version: &'life1 str, limit: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<InboundGroupSession>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Return a batch of [‘InboundGroupSession’] (“room keys”) that have not yet been backed up in the supplied backup version.

fn mark_inbound_group_sessions_as_backed_up<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, _backup_version: &'life1 str, session_ids: &'life2 [(&'life3 RoomId, &'life4 str)], ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait, SqliteCryptoStore: 'async_trait,

Store the fact that the supplied sessions were backed up into the backup with version backup_version.

fn reset_backup_state<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

Reset the backup state of all the stored inbound group sessions.

fn load_backup_keys<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<BackupKeys, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

Get the backup keys we have stored.

fn get_outbound_group_session<'life0, 'life1, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, ) -> Pin<Box<dyn Future<Output = Result<Option<OutboundGroupSession>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Get the outbound group session we have stored that is used for the given room.

fn load_tracked_users<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<TrackedUser>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

Provide the list of users whose devices we are keeping track of, and whether they are considered dirty/outdated.

fn save_tracked_users<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, tracked_users: &'life1 [(&'life2 UserId, bool)], ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, SqliteCryptoStore: 'async_trait,

Update the list of users whose devices we are keeping track of, and whether they are considered dirty/outdated.

fn get_device<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, user_id: &'life1 UserId, device_id: &'life2 DeviceId, ) -> Pin<Box<dyn Future<Output = Result<Option<DeviceData>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, SqliteCryptoStore: 'async_trait,

Get the device for the given user with the given device ID.

fn get_user_devices<'life0, 'life1, 'async_trait>( &'life0 self, user_id: &'life1 UserId, ) -> Pin<Box<dyn Future<Output = Result<HashMap<OwnedDeviceId, DeviceData>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Get all the devices of the given user.

fn get_own_device<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<DeviceData, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

Get the device for the current client.

fn get_user_identity<'life0, 'life1, 'async_trait>( &'life0 self, user_id: &'life1 UserId, ) -> Pin<Box<dyn Future<Output = Result<Option<UserIdentityData>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Get the user identity that is attached to the given user id.

fn is_message_known<'life0, 'life1, 'async_trait>( &'life0 self, message_hash: &'life1 OlmMessageHash, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Check if a hash for an Olm message stored in the database.

fn get_outgoing_secret_requests<'life0, 'life1, 'async_trait>( &'life0 self, request_id: &'life1 TransactionId, ) -> Pin<Box<dyn Future<Output = Result<Option<GossipRequest>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Get an outgoing secret request that we created that matches the given request id.

fn get_secret_request_by_info<'life0, 'life1, 'async_trait>( &'life0 self, key_info: &'life1 SecretInfo, ) -> Pin<Box<dyn Future<Output = Result<Option<GossipRequest>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Get an outgoing key request that we created that matches the given requested key info.

fn get_unsent_secret_requests<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<GossipRequest>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

Get all outgoing secret requests that we have in the store.

fn delete_outgoing_secret_requests<'life0, 'life1, 'async_trait>( &'life0 self, request_id: &'life1 TransactionId, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Delete an outgoing key request that we created that matches the given request id.

fn get_secrets_from_inbox<'life0, 'life1, 'async_trait>( &'life0 self, secret_name: &'life1 SecretName, ) -> Pin<Box<dyn Future<Output = Result<Vec<GossippedSecret>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Get all the secrets with the given SecretName we have currently stored.

fn delete_secrets_from_inbox<'life0, 'life1, 'async_trait>( &'life0 self, secret_name: &'life1 SecretName, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Delete all the secrets with the given SecretName we have currently stored.

fn get_withheld_info<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, session_id: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<Option<ToDeviceEvent<RoomKeyWithheldContent>>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, SqliteCryptoStore: 'async_trait,

Get withheld info for this key. Allows to know if the session was not sent on purpose. This only returns withheld info sent by the owner of the group session, not the one you can get from a response to a key request from another of your device.

fn get_room_settings<'life0, 'life1, 'async_trait>( &'life0 self, room_id: &'life1 RoomId, ) -> Pin<Box<dyn Future<Output = Result<Option<RoomSettings>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Get the room settings, such as the encryption algorithm or whether to encrypt only for trusted devices.

fn get_custom_value<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Get arbitrary data from the store

fn set_custom_value<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, value: Vec<u8>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Put arbitrary data into the store

fn remove_custom_value<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, SqliteCryptoStore: 'async_trait,

Remove arbitrary data into the store

fn try_take_leased_lock<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, lease_duration_ms: u32, key: &'life1 str, holder: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, SqliteCryptoStore: 'async_trait,

Try to take a leased lock.

fn next_batch_token<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Option<String>, <SqliteCryptoStore as CryptoStore>::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, SqliteCryptoStore: 'async_trait,

Load the next-batch token for a to-device query, if any.

impl Debug for SqliteCryptoStore

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

Formats the value using the given formatter.