feat(sdk): Rename OlmMachine.import_keys to .import_room_keys.

Because that's what it does :-).
This commit is contained in:
Ivan Enderlin
2022-09-21 13:12:07 +02:00
parent b442247946
commit 0222a8fec2
5 changed files with 21 additions and 20 deletions

View File

@@ -671,7 +671,7 @@ impl OlmMachine {
Ok(encrypted)
}
fn import_keys_helper(
fn import_room_keys_helper(
&self,
keys: Vec<ExportedRoomKey>,
from_backup: bool,
@@ -681,7 +681,8 @@ impl OlmMachine {
progress_listener.on_progress(progress as i32, total as i32)
};
let result = self.runtime.block_on(self.inner.import_keys(keys, from_backup, listener))?;
let result =
self.runtime.block_on(self.inner.import_room_keys(keys, from_backup, listener))?;
Ok(KeysImportResult {
imported: result.imported_count as i64,
@@ -709,7 +710,7 @@ impl OlmMachine {
///
/// * `progress_listener` - A callback that can be used to introspect the
/// progress of the key import.
pub fn import_keys(
pub fn import_room_keys(
&self,
keys: &str,
passphrase: &str,
@@ -717,12 +718,12 @@ impl OlmMachine {
) -> Result<KeysImportResult, KeyImportError> {
let keys = Cursor::new(keys);
let keys = decrypt_key_export(keys, passphrase)?;
self.import_keys_helper(keys, false, progress_listener)
self.import_room_keys_helper(keys, false, progress_listener)
}
/// Import room keys from the given serialized unencrypted key export.
///
/// This method is the same as [`OlmMachine::import_keys`] but the
/// This method is the same as [`OlmMachine::import_room_keys`] but the
/// decryption step is skipped and should be performed by the caller. This
/// should be used if the room keys are coming from the server-side backup,
/// the method will mark all imported room keys as backed up.
@@ -733,7 +734,7 @@ impl OlmMachine {
///
/// * `progress_listener` - A callback that can be used to introspect the
/// progress of the key import.
pub fn import_decrypted_keys(
pub fn import_decrypted_room_keys(
&self,
keys: &str,
progress_listener: Box<dyn ProgressListener>,
@@ -742,7 +743,7 @@ impl OlmMachine {
let keys = keys.into_iter().map(serde_json::from_value).filter_map(|k| k.ok()).collect();
self.import_keys_helper(keys, true, progress_listener)
self.import_room_keys_helper(keys, true, progress_listener)
}
/// Discard the currently active room key for the given room if there is

View File

@@ -360,7 +360,7 @@ interface OlmMachine {
[Throws=CryptoStoreError]
string export_room_keys([ByRef] string passphrase, i32 rounds);
[Throws=KeyImportError]
KeysImportResult import_keys(
KeysImportResult import_room_keys(
[ByRef] string keys,
[ByRef] string passphrase,
ProgressListener progress_listener

View File

@@ -86,7 +86,7 @@ pub enum KeyExportError {
/// # let machine = OlmMachine::new(&alice, device_id!("DEVICEID")).await;
/// # let export = Cursor::new("".to_owned());
/// let exported_keys = decrypt_key_export(export, "1234").unwrap();
/// machine.import_keys(exported_keys, false, |_, _| {}).await.unwrap();
/// machine.import_room_keys(exported_keys, false, |_, _| {}).await.unwrap();
/// # });
/// ```
pub fn decrypt_key_export(
@@ -332,7 +332,7 @@ mod tests {
let room_id = room_id!("!test:localhost");
machine.create_outbound_group_session_with_defaults(room_id).await.unwrap();
let export = machine.export_room_keys(|s| s.room_id() == room_id).await.unwrap();
let export = machine.export_keys(|s| s.room_id() == room_id).await.unwrap();
assert!(!export.is_empty());
@@ -344,7 +344,7 @@ mod tests {
}
assert_eq!(
machine.import_keys(decrypted, false, |_, _| {}).await.unwrap(),
machine.import_room_keys(decrypted, false, |_, _| {}).await.unwrap(),
RoomKeyImportResult::new(0, 1, BTreeMap::new())
);
}
@@ -369,17 +369,17 @@ mod tests {
)]),
);
assert_eq!(machine.import_keys(export, false, |_, _| {}).await?, keys);
assert_eq!(machine.import_room_keys(export, false, |_, _| {}).await?, keys);
let export = vec![session.export_at_index(10).await];
assert_eq!(
machine.import_keys(export, false, |_, _| {}).await?,
machine.import_room_keys(export, false, |_, _| {}).await?,
RoomKeyImportResult::new(0, 1, BTreeMap::new())
);
let better_export = vec![session.export().await];
assert_eq!(machine.import_keys(better_export, false, |_, _| {}).await?, keys);
assert_eq!(machine.import_room_keys(better_export, false, |_, _| {}).await?, keys);
let another_session = machine.create_inbound_session(room_id).await?;
let export = vec![another_session.export_at_index(10).await];
@@ -396,7 +396,7 @@ mod tests {
)]),
);
assert_eq!(machine.import_keys(export, false, |_, _| {}).await?, keys);
assert_eq!(machine.import_room_keys(export, false, |_, _| {}).await?, keys);
Ok(())
}

View File

@@ -1338,10 +1338,10 @@ impl OlmMachine {
/// # let machine = OlmMachine::new(&alice, device_id!("DEVICEID")).await;
/// # let export = Cursor::new("".to_owned());
/// let exported_keys = decrypt_key_export(export, "1234").unwrap();
/// machine.import_keys(exported_keys, false, |_, _| {}).await.unwrap();
/// machine.import_room_keys(exported_keys, false, |_, _| {}).await.unwrap();
/// # });
/// ```
pub async fn import_keys(
pub async fn import_room_keys(
&self,
exported_keys: Vec<ExportedRoomKey>,
#[allow(unused_variables)] from_backup: bool,

View File

@@ -783,7 +783,7 @@ impl Encryption {
/// # let mut client = Client::new(homeserver).await?;
/// let path = PathBuf::from("/home/example/e2e-keys.txt");
/// let result =
/// client.encryption().import_keys(path, "secret-passphrase").await?;
/// client.encryption().import_room_keys(path, "secret-passphrase").await?;
///
/// println!(
/// "Imported {} room keys out of {}",
@@ -792,7 +792,7 @@ impl Encryption {
/// # anyhow::Ok(()) });
/// ```
#[cfg(not(target_arch = "wasm32"))]
pub async fn import_keys(
pub async fn import_room_keys(
&self,
path: PathBuf,
passphrase: &str,
@@ -808,7 +808,7 @@ impl Encryption {
let task = tokio::task::spawn_blocking(decrypt);
let import = task.await.expect("Task join error")?;
Ok(olm.import_keys(import, false, |_, _| {}).await?)
Ok(olm.import_room_keys(import, false, |_, _| {}).await?)
}
}