signalapp/libsignal-protocol-rust
signalapp/libsignal-protocol-rust
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Remove some unused storage callbacks

Browse Source 
A lot of these functions are afaict just defined on the interface,
implemented in Signal-Android, and then never used anywhere at all. A
few are used within the Signal-Android client, but not in
libsignal-protocol-{java,rust}. Remove anything that we ourselves do
not need implemented, because every additional function on these
traits adds a few dozen lines in the JNI interop layer.

This doesn't negatively affect Signal-Android since we will retain the
various functions on the Java interface specs. They'll simply never be
invoked, which is mostly the status quo anyway with
libsignal-protocol-java.
This commit is contained in:
Jack Lloyd 2020-08-11 14:44:18 -04:00
parent 5101e38cae
commit 2a04176285
3 changed files with 10 additions and 103 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

80
src/storage/inmem.rs
View File

@ -103,10 +103,6 @@ impl traits::PreKeyStore for InMemPreKeyStore {
Ok(())
}
fn has_pre_key(&self, id: PreKeyId) -> Result<bool> {
Ok(self.pre_keys.get(&id).is_some())
}
fn remove_pre_key(&mut self, id: PreKeyId) -> Result<()> {
// If id does not exist this silently does nothing
self.pre_keys.remove(&id);
@ -142,14 +138,6 @@ impl traits::SignedPreKeyStore for InMemSignedPreKeyStore {
.clone())
}
fn get_all_signed_prekeys(&self) -> Result<Vec<SignedPreKeyRecord>> {
let mut result = Vec::with_capacity(self.signed_pre_keys.len());
for v in self.signed_pre_keys.values() {
result.push(v.clone());
}
Ok(result)
}
fn save_signed_pre_key(
&mut self,
id: SignedPreKeyId,
@ -159,16 +147,6 @@ impl traits::SignedPreKeyStore for InMemSignedPreKeyStore {
self.signed_pre_keys.insert(id, record.to_owned());
Ok(())
}
fn has_signed_pre_key(&self, id: SignedPreKeyId) -> Result<bool> {
Ok(self.signed_pre_keys.get(&id).is_some())
}
fn remove_pre_key(&mut self, id: SignedPreKeyId) -> Result<()> {
// If id does not exist this silently does nothing
self.signed_pre_keys.remove(&id);
Ok(())
}
}
#[derive(Clone)]
@ -198,36 +176,10 @@ impl traits::SessionStore for InMemSessionStore {
}
}
fn get_sub_device_sessions(&self, name: &str) -> Result<Vec<u32>> {
let mut result = vec![];
for address in self.sessions.keys() {
if address.name() == name && address.device_id() != 1 {
result.push(address.device_id());
}
}
Ok(result)
}
fn store_session(&mut self, address: &ProtocolAddress, record: &SessionRecord) -> Result<()> {
self.sessions.insert(address.clone(), record.clone());
Ok(())
}
fn contains_session(&self, address: &ProtocolAddress) -> Result<bool> {
Ok(self.sessions.get(address).is_some())
}
fn delete_session(&mut self, address: &ProtocolAddress) -> Result<()> {
self.sessions.remove(address);
Ok(())
}
fn delete_all_sessions(&mut self, name: &str) -> Result<()> {
self.sessions.retain(|a, _| a.name() != name);
Ok(())
}
}
#[derive(Clone)]
@ -325,10 +277,6 @@ impl traits::PreKeyStore for InMemSignalProtocolStore {
self.pre_key_store.save_pre_key(id, record)
}
fn has_pre_key(&self, id: PreKeyId) -> Result<bool> {
self.pre_key_store.has_pre_key(id)
}
fn remove_pre_key(&mut self, id: PreKeyId) -> Result<()> {
self.pre_key_store.remove_pre_key(id)
}
@ -339,10 +287,6 @@ impl traits::SignedPreKeyStore for InMemSignalProtocolStore {
self.signed_pre_key_store.get_signed_pre_key(id)
}
fn get_all_signed_prekeys(&self) -> Result<Vec<SignedPreKeyRecord>> {
self.signed_pre_key_store.get_all_signed_prekeys()
}
fn save_signed_pre_key(
&mut self,
id: SignedPreKeyId,
@ -350,14 +294,6 @@ impl traits::SignedPreKeyStore for InMemSignalProtocolStore {
) -> Result<()> {
self.signed_pre_key_store.save_signed_pre_key(id, record)
}
fn has_signed_pre_key(&self, id: SignedPreKeyId) -> Result<bool> {
self.signed_pre_key_store.has_signed_pre_key(id)
}
fn remove_pre_key(&mut self, id: SignedPreKeyId) -> Result<()> {
self.signed_pre_key_store.remove_pre_key(id)
}
}
impl traits::SessionStore for InMemSignalProtocolStore {
@ -365,25 +301,9 @@ impl traits::SessionStore for InMemSignalProtocolStore {
self.session_store.load_session(address)
}
fn get_sub_device_sessions(&self, name: &str) -> Result<Vec<u32>> {
self.session_store.get_sub_device_sessions(name)
}
fn store_session(&mut self, address: &ProtocolAddress, record: &SessionRecord) -> Result<()> {
self.session_store.store_session(address, record)
}
fn contains_session(&self, address: &ProtocolAddress) -> Result<bool> {
self.session_store.contains_session(address)
}
fn delete_session(&mut self, address: &ProtocolAddress) -> Result<()> {
self.session_store.delete_session(address)
}
fn delete_all_sessions(&mut self, name: &str) -> Result<()> {
self.session_store.delete_all_sessions(name)
}
}
impl traits::SenderKeyStore for InMemSignalProtocolStore {

16
src/storage/traits.rs
View File

@ -30,39 +30,23 @@ pub trait PreKeyStore {
fn save_pre_key(&mut self, prekey_id: PreKeyId, record: &PreKeyRecord) -> Result<()>;
fn has_pre_key(&self, prekey_id: PreKeyId) -> Result<bool>;
fn remove_pre_key(&mut self, prekey_id: PreKeyId) -> Result<()>;
}
pub trait SignedPreKeyStore {
fn get_signed_pre_key(&self, signed_prekey_id: SignedPreKeyId) -> Result<SignedPreKeyRecord>;
fn get_all_signed_prekeys(&self) -> Result<Vec<SignedPreKeyRecord>>;
fn save_signed_pre_key(
&mut self,
signed_prekey_id: SignedPreKeyId,
record: &SignedPreKeyRecord,
) -> Result<()>;
fn has_signed_pre_key(&self, signed_prekey_id: SignedPreKeyId) -> Result<bool>;
fn remove_pre_key(&mut self, signed_prekey_id: SignedPreKeyId) -> Result<()>;
}
pub trait SessionStore {
fn load_session(&self, address: &ProtocolAddress) -> Result<Option<SessionRecord>>;
fn store_session(&mut self, address: &ProtocolAddress, record: &SessionRecord) -> Result<()>;
fn contains_session(&self, address: &ProtocolAddress) -> Result<bool>;
fn delete_session(&mut self, address: &ProtocolAddress) -> Result<()>;
fn get_sub_device_sessions(&self, name: &str) -> Result<Vec<u32>>;
fn delete_all_sessions(&mut self, name: &str) -> Result<()>;
}
pub trait SenderKeyStore {

17
tests/session.rs
View File

@ -46,7 +46,7 @@ fn test_basic_prekey_v3() -> Result<(), SignalProtocolError> {
&mut csprng,
)?;
assert!(alice_store.contains_session(&bob_address)?);
assert!(alice_store.load_session(&bob_address)?.is_some());
assert_eq!(
alice_store
.load_session(&bob_address)?
@ -89,7 +89,7 @@ fn test_basic_prekey_v3() -> Result<(), SignalProtocolError> {
let bobs_response = "Who watches the watchers?";
assert!(bob_store.contains_session(&alice_address)?);
assert!(bob_store.load_session(&alice_address)?.is_some());
let bobs_session_with_alice = bob_store.load_session(&alice_address)?.unwrap();
assert_eq!(
bobs_session_with_alice.session_state()?.session_version()?,
@ -320,7 +320,7 @@ fn repeat_bundle_message_v3() -> Result<(), SignalProtocolError> {
&mut csprng,
)?;
assert!(alice_store.contains_session(&bob_address)?);
assert!(alice_store.load_session(&bob_address)?.is_some());
assert_eq!(
alice_store
.load_session(&bob_address)?
@ -441,7 +441,7 @@ fn bad_message_bundle() -> Result<(), SignalProtocolError> {
),
)?;
assert!(alice_store.contains_session(&bob_address)?);
assert!(alice_store.load_session(&bob_address)?.is_some());
assert_eq!(
alice_store
.load_session(&bob_address)?
@ -453,7 +453,7 @@ fn bad_message_bundle() -> Result<(), SignalProtocolError> {
let original_message = "L'homme est condamné à être libre";
assert!(bob_store.has_pre_key(pre_key_id)?);
assert!(bob_store.get_pre_key(pre_key_id).is_ok());
let outgoing_message = encrypt(&mut alice_store, &bob_address, original_message)?;
assert_eq!(
@ -471,7 +471,7 @@ fn bad_message_bundle() -> Result<(), SignalProtocolError> {
)?);
assert!(decrypt(&mut bob_store, &alice_address, &incoming_message).is_err());
assert!(bob_store.has_pre_key(pre_key_id)?);
assert!(bob_store.get_pre_key(pre_key_id).is_ok());
let incoming_message = CiphertextMessage::PreKeySignalMessage(PreKeySignalMessage::try_from(
outgoing_message.as_slice(),
@ -480,7 +480,10 @@ fn bad_message_bundle() -> Result<(), SignalProtocolError> {
let ptext = decrypt(&mut bob_store, &alice_address, &incoming_message)?;
assert_eq!(String::from_utf8(ptext).unwrap(), original_message);
assert_eq!(bob_store.has_pre_key(pre_key_id)?, false);
assert_eq!(
bob_store.get_pre_key(pre_key_id).unwrap_err(),
SignalProtocolError::InvalidPreKeyId
);
Ok(())
}