mirror/matrix-rust-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-rust-sdk.git synced 2026-05-18 21:52:30 -04:00
Code Issues Packages Projects Releases Wiki Activity

Remove all passphrase mention

Browse Source
This commit is contained in:
multi prise
2025-07-31 19:19:30 +02:00
committed by Damir Jelić
parent c17dbf9ebe
commit 72bb452b5b
4 changed files with 22 additions and 37 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
crates/matrix-sdk-sqlite/src/crypto_store.rs
View File

@@ -84,7 +84,7 @@ impl EncryptableStore for SqliteCryptoStore {
impl SqliteCryptoStore {
/// Open the SQLite-based crypto store at the given path using the given
/// passphrase to encrypt private data.
/// key to encrypt private data.
pub async fn open(
path: impl AsRef<Path>,
key: Option<&[u8; 32]>,
@@ -94,7 +94,7 @@ impl SqliteCryptoStore {
/// Open the SQLite-based crypto store with the config open config.
pub async fn open_with_config(config: SqliteStoreConfig) -> Result<Self, OpenStoreError> {
let SqliteStoreConfig { path, _passphrase, key, pool_config, runtime_config } = config;
let SqliteStoreConfig { path, key, pool_config, runtime_config } = config;
fs::create_dir_all(&path).await.map_err(OpenStoreError::CreateDir)?;
@@ -110,7 +110,7 @@ impl SqliteCryptoStore {
}
/// Create an SQLite-based crypto store using the given SQLite database
/// pool. The given passphrase will be used to encrypt private data.
/// pool. The given key will be used to encrypt private data.
async fn open_with_pool(
pool: SqlitePool,
key: Option<&[u8; 32]>,
@@ -1534,12 +1534,11 @@ mod tests {
tmpdir
}
async fn get_test_db(data_path: &str, passphrase: Option<&str>) -> TestDb {
async fn get_test_db(data_path: &str, key: Option<&[u8; 32]>) -> TestDb {
let tmpdir = copy_db(data_path);
let database = SqliteCryptoStore::open(tmpdir.path(), passphrase)
.await
.expect("Can't open the test store");
let database =
SqliteCryptoStore::open(tmpdir.path(), key).await.expect("Can't open the test store");
TestDb { _dir: tmpdir, database }
}
@@ -1892,20 +1891,16 @@ mod tests {
assert!(backup_keys.decryption_key.is_some());
}
async fn get_store(
name: &str,
passphrase: Option<&str>,
clear_data: bool,
) -> SqliteCryptoStore {
async fn get_store(name: &str, key: Option<&[u8; 32]>, clear_data: bool) -> SqliteCryptoStore {
let tmpdir_path = TMP_DIR.path().join(name);
if clear_data {
let _ = fs::remove_dir_all(&tmpdir_path).await;
}
SqliteCryptoStore::open(tmpdir_path.to_str().unwrap(), passphrase)
SqliteCryptoStore::open(tmpdir_path.to_str().unwrap(), key)
.await
.expect("Can't create a passphrase protected store")
.expect("Can't create a key protected store")
}
cryptostore_integration_tests!();
@@ -1923,21 +1918,20 @@ mod encrypted_tests {
static TMP_DIR: Lazy<TempDir> = Lazy::new(|| tempdir().unwrap());
async fn get_store(
name: &str,
passphrase: Option<&str>,
clear_data: bool,
) -> SqliteCryptoStore {
async fn get_store(name: &str, key: Option<&[u8; 32]>, clear_data: bool) -> SqliteCryptoStore {
let tmpdir_path = TMP_DIR.path().join(name);
let pass = passphrase.unwrap_or("default_test_password");
let pass = key.unwrap_or(&[
74, 156, 222, 8, 61, 113, 145, 197, 29, 84, 179, 240, 6, 38, 126, 253, 92, 203, 173,
47, 134, 13, 251, 100, 196, 42, 109, 159, 221, 73, 10, 187,
]);
if clear_data {
let _ = fs::remove_dir_all(&tmpdir_path).await;
}
SqliteCryptoStore::open(tmpdir_path.to_str().unwrap(), Some(pass))
SqliteCryptoStore::open(tmpdir_path.to_str().unwrap(), Some(key))
.await
.expect("Can't create a passphrase protected store")
.expect("Can't create a key protected store")
}
cryptostore_integration_tests!();

6
crates/matrix-sdk-sqlite/src/event_cache_store.rs
View File

@@ -102,7 +102,7 @@ impl EncryptableStore for SqliteEventCacheStore {
impl SqliteEventCacheStore {
/// Open the SQLite-based event cache store at the given path using the
/// given passphrase to encrypt private data.
/// given key to encrypt private data.
pub async fn open(
path: impl AsRef<Path>,
key: Option<&[u8; 32]>,
@@ -117,7 +117,7 @@ impl SqliteEventCacheStore {
let _timer = timer!("open_with_config");
let SqliteStoreConfig { path, key, passphrase, pool_config, runtime_config } = config;
let SqliteStoreConfig { path, key, pool_config, runtime_config } = config;
fs::create_dir_all(&path).await.map_err(OpenStoreError::CreateDir)?;
@@ -133,7 +133,7 @@ impl SqliteEventCacheStore {
}
/// Open an SQLite-based event cache store using the given SQLite database
/// pool. The given passphrase will be used to encrypt private data.
/// pool. The given key will be used to encrypt private data.
async fn open_with_pool(
pool: SqlitePool,
key: Option<&[u8; 32]>,

9
crates/matrix-sdk-sqlite/src/lib.rs
View File

@@ -52,8 +52,6 @@ matrix_sdk_test_utils::init_tracing_for_tests!();
pub struct SqliteStoreConfig {
/// Path to the database, without the file name.
path: PathBuf,
/// Passphrase to open the store, if any.
passphrase: Option<String>,
/// Key to open the store, if any
key: Option<[u8; 32]>,
/// The pool configuration for [`deadpool_sqlite`].
@@ -88,7 +86,6 @@ impl SqliteStoreConfig {
{
Self {
path: path.as_ref().to_path_buf(),
passphrase: None,
key: None,
pool_config: PoolConfig::new(max(POOL_MINIMUM_SIZE, num_cpus::get_physical() * 4)),
runtime_config: RuntimeConfig::default(),
@@ -126,12 +123,6 @@ impl SqliteStoreConfig {
self
}
/// Define the passphrase if the store is encoded.
pub fn passphrase(mut self, passphrase: Option<&str>) -> Self {
self.passphrase = passphrase.map(|passphrase| passphrase.to_owned());
self
}
/// Define the key if the store is encoded.
pub fn key(mut self, key: Option<&[u8; 32]>) -> Self {
self.key = key.map(|key| key.to_owned());

6
crates/matrix-sdk-sqlite/src/state_store.rs
View File

@@ -93,7 +93,7 @@ impl fmt::Debug for SqliteStateStore {
impl SqliteStateStore {
/// Open the SQLite-based state store at the given path using the given
/// passphrase to encrypt private data.
/// key to encrypt private data.
pub async fn open(
path: impl AsRef<Path>,
key: Option<&[u8; 32]>,
@@ -103,7 +103,7 @@ impl SqliteStateStore {
/// Open the SQLite-based state store with the config open config.
pub async fn open_with_config(config: SqliteStoreConfig) -> Result<Self, OpenStoreError> {
let SqliteStoreConfig { path, passphrase, key, pool_config, runtime_config } = config;
let SqliteStoreConfig { path, key, pool_config, runtime_config } = config;
fs::create_dir_all(&path).await.map_err(OpenStoreError::CreateDir)?;
@@ -119,7 +119,7 @@ impl SqliteStateStore {
}
/// Create an SQLite-based state store using the given SQLite database pool.
/// The given passphrase will be used to encrypt private data.
/// The given key will be used to encrypt private data.
pub async fn open_with_pool(
pool: SqlitePool,
key: Option<&[u8; 32]>,