Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test(sas): Add mutation tests #140

Merged
merged 1 commit into from
Apr 2, 2024
+61 −32
Merged

test(sas): Add mutation tests #140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .cargo/mutants.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ exclude_re = [
"impl Display",
# Replacing + with * makes no logical difference here
"src/olm/messages/message\\.rs.*replace \\+ with \\* in <impl TryFrom for Message>::try_from",
# Due to the bit shifting | and ^ are equivalent here
"replace \\| with \\^ in SasBytes::bytes_to_decimal",
# Drop implementations perform zeroisation which cannot be tested in Rust
"impl Drop",
]
91 changes: 59 additions & 32 deletions src/sas.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,6 @@ impl EstablishedSas {

#[cfg(test)]
mod test {
use anyhow::Result;
use olm_rs::sas::OlmSas;
use proptest::prelude::*;

Expand All @@ -431,6 +430,12 @@ mod test {
const BOB_MXID: &str = "@bob:example.com";
const BOB_DEVICE_ID: &str = "BBBBBBBBBB";

#[test]
fn as_bytes_is_identity() {
let bytes = [0u8, 1, 2, 3, 4, 5];
assert_eq!(SasBytes { bytes }.as_bytes(), &bytes);
}

#[test]
fn mac_from_slice_as_bytes_is_identity() {
let bytes = "ABCDEFGH".as_bytes();
Expand All @@ -442,24 +447,24 @@ mod test {
}

#[test]
fn libolm_and_vodozemac_generate_same_bytes() -> Result<()> {
fn libolm_and_vodozemac_generate_same_bytes() {
let mut olm = OlmSas::new();
let dalek = Sas::new();

olm.set_their_public_key(dalek.public_key().to_base64())
.expect("Couldn't set the public key for libolm");
let established = dalek.diffie_hellman_with_raw(&olm.public_key())?;
let established = dalek
.diffie_hellman_with_raw(&olm.public_key())
.expect("Couldn't establish SAS secret");

assert_eq!(
olm.generate_bytes("TEST", 10).expect("libolm couldn't generate SAS bytes"),
established.bytes_raw("TEST", 10)?
established.bytes_raw("TEST", 10).expect("vodozemac couldn't generate SAS bytes")
);

Ok(())
}

#[test]
fn vodozemac_and_vodozemac_generate_same_bytes() -> Result<()> {
fn vodozemac_and_vodozemac_generate_same_bytes() {
let alice = Sas::default();
let bob = Sas::default();

Expand All @@ -468,8 +473,12 @@ mod test {
let bob_public_key_encoded = bob.public_key().to_base64();
let bob_public_key = bob.public_key();

let alice_established = alice.diffie_hellman_with_raw(&bob_public_key_encoded)?;
let bob_established = bob.diffie_hellman_with_raw(&alice_public_key_encoded)?;
let alice_established = alice
.diffie_hellman_with_raw(&bob_public_key_encoded)
.expect("Couldn't establish SAS secret for Alice");
let bob_established = bob
.diffie_hellman_with_raw(&alice_public_key_encoded)
.expect("Couldn't establish SAS secret for Bob");

assert_eq!(alice_established.our_public_key(), alice_public_key);
assert_eq!(alice_established.their_public_key(), bob_public_key);
Expand All @@ -491,12 +500,10 @@ mod test {
"The two sides calculated different decimals."
);
assert_eq!(alice_bytes.as_bytes(), bob_bytes.as_bytes());

Ok(())
}

#[test]
fn calculate_mac_vodozemac_vodozemac() -> Result<()> {
fn calculate_mac_vodozemac_vodozemac() {
let alice = Sas::new();
let bob = Sas::new();

Expand All @@ -512,8 +519,12 @@ mod test {
KEY_IDS",
);

let alice_established = alice.diffie_hellman_with_raw(&bob_public_key)?;
let bob_established = bob.diffie_hellman_with_raw(&alice_public_key)?;
let alice_established = alice
.diffie_hellman_with_raw(&bob_public_key)
.expect("Couldn't establish SAS secret for Alice");
let bob_established = bob
.diffie_hellman_with_raw(&alice_public_key)
.expect("Couldn't establish SAS secret for Bob");

let alice_mac = alice_established.calculate_mac(&message, &extra_info);
let bob_mac = bob_established.calculate_mac(&message, &extra_info);
Expand All @@ -524,14 +535,27 @@ mod test {
"Two vodozemac devices calculated different SAS MACs."
);

alice_established.verify_mac(&message, &extra_info, &bob_mac)?;
bob_established.verify_mac(&message, &extra_info, &alice_mac)?;

Ok(())
alice_established
.verify_mac(&message, &extra_info, &bob_mac)
.expect("Alice couldn't verify Bob's MAC");
bob_established
.verify_mac(&message, &extra_info, &alice_mac)
.expect("Bob couldn't verify Alice's MAC");

let invalid_mac = Mac::from_slice(&[
0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 0,
1, 0, 1,
]);
alice_established
.verify_mac(&message, &extra_info, &invalid_mac)
.expect_err("Alice verified an invalid MAC");
bob_established
.verify_mac(&message, &extra_info, &invalid_mac)
.expect_err("Bob verified an invalid MAC");
}

#[test]
fn calculate_mac_vodozemac_libolm() -> Result<()> {
fn calculate_mac_vodozemac_libolm() {
let alice_on_dalek = Sas::new();
let mut bob_on_libolm = OlmSas::new();

Expand All @@ -550,7 +574,9 @@ mod test {
bob_on_libolm
.set_their_public_key(alice_public_key)
.expect("Couldn't set the public key for libolm");
let established = alice_on_dalek.diffie_hellman_with_raw(&bob_public_key)?;
let established = alice_on_dalek
.diffie_hellman_with_raw(&bob_public_key)
.expect("Couldn't establish SAS secret");

let olm_mac = bob_on_libolm
.calculate_mac_fixed_base64(&message, &extra_info)
Expand All @@ -560,47 +586,48 @@ mod test {
let olm_mac =
Mac::from_base64(&olm_mac).expect("SAS MAC generated by libolm wasn't valid base64.");

established.verify_mac(&message, &extra_info, &olm_mac)?;

Ok(())
established.verify_mac(&message, &extra_info, &olm_mac).expect("Couldn't verify MAC");
}

#[test]
fn calculate_mac_invalid_base64() -> Result<()> {
fn calculate_mac_invalid_base64() {
let mut olm = OlmSas::new();
let dalek = Sas::new();

olm.set_their_public_key(dalek.public_key().to_base64())
.expect("Couldn't set the public key for libolm");
let established = dalek.diffie_hellman_with_raw(&olm.public_key())?;
let established = dalek
.diffie_hellman_with_raw(&olm.public_key())
.expect("Couldn't establish SAS secret");

let olm_mac = olm.calculate_mac("", "").expect("libolm couldn't calculate a MAC");
assert_eq!(olm_mac, established.calculate_mac_invalid_base64("", ""));

Ok(())
}

#[test]
fn emoji_generation() {
let bytes: [u8; 6] = [0, 0, 0, 0, 0, 0];
let index: [u8; 7] = [0, 0, 0, 0, 0, 0, 0];
assert_eq!(SasBytes::bytes_to_emoji_index(&bytes), index.as_ref());
assert_eq!(SasBytes { bytes }.emoji_indices(), index.as_ref());

let bytes: [u8; 6] = [0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF];
let index: [u8; 7] = [63, 63, 63, 63, 63, 63, 63];
assert_eq!(SasBytes::bytes_to_emoji_index(&bytes), index.as_ref());
assert_eq!(SasBytes { bytes }.emoji_indices(), index.as_ref());
}

#[test]
fn decimal_generation() {
let bytes: [u8; 6] = [0, 0, 0, 0, 0, 0];
let result = SasBytes::bytes_to_decimal(&bytes);

assert_eq!(result, (1000, 1000, 1000));
let decimal: (u16, u16, u16) = (1000, 1000, 1000);
assert_eq!(SasBytes::bytes_to_decimal(&bytes), decimal);
assert_eq!(SasBytes { bytes }.decimals(), decimal);

let bytes: [u8; 6] = [0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF];
let result = SasBytes::bytes_to_decimal(&bytes);
assert_eq!(result, (9191, 9191, 9191));
let decimal: (u16, u16, u16) = (9191, 9191, 9191);
assert_eq!(SasBytes::bytes_to_decimal(&bytes), decimal);
assert_eq!(SasBytes { bytes }.decimals(), decimal);
}

proptest! {
Expand Down
Loading