1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138
use std::collections::HashMap;
use openmls::prelude::{KeyPackage, KeyPackageRef, MlsCredentialType as OpenMlsCredential};
use openmls_traits::OpenMlsCryptoProvider;
use core_crypto_keystore::{entities::MlsKeyPackage, CryptoKeystoreMls};
use mls_crypto_provider::MlsCryptoProvider;
use crate::e2e_identity::init_certificates::NewCrlDistributionPoint;
use crate::{
mls::credential::{ext::CredentialExt, x509::CertificatePrivateKey, CredentialBundle},
prelude::{
CertificateBundle, Client, ConversationId, CryptoError, CryptoResult, E2eIdentityError, E2eiEnrollment,
MlsCentral, MlsCiphersuite, MlsCommitBundle, MlsConversation, MlsCredentialType,
},
MlsError,
};
impl MlsCentral {
/// Generates an E2EI enrollment instance for a "regular" client (with a Basic credential)
/// willing to migrate to E2EI. As a consequence, this method does not support changing the
/// ClientId which should remain the same as the Basic one.
/// Once the enrollment is finished, use the instance in [MlsCentral::e2ei_rotate_all] to do
/// the rotation.
pub fn e2ei_new_activation_enrollment(
&self,
display_name: String,
handle: String,
team: Option<String>,
expiry_sec: u32,
ciphersuite: MlsCiphersuite,
) -> CryptoResult<E2eiEnrollment> {
let client = self.mls_client()?;
// look for existing credential of type basic. If there isn't, then this method has been misused
let cb = client
.find_most_recent_credential_bundle(ciphersuite.signature_algorithm(), MlsCredentialType::Basic)
.ok_or(E2eIdentityError::MissingExistingClient(MlsCredentialType::Basic))?;
let client_id = cb.credential().identity().into();
let sign_keypair = Some((&cb.signature_key).try_into()?);
E2eiEnrollment::try_new(
client_id,
display_name,
handle,
team,
expiry_sec,
&self.mls_backend,
ciphersuite,
sign_keypair,
#[cfg(not(target_family = "wasm"))]
None, // no x509 credential yet at this point so no OIDC authn yet so no refresh token to restore
)
}
/// Generates an E2EI enrollment instance for a E2EI client (with a X509 certificate credential)
/// having to change/rotate their credential, either because the former one is expired or it
/// has been revoked. As a consequence, this method does not support changing neither ClientId which
/// should remain the same as the previous one. It lets you change the DisplayName or the handle
/// if you need to. Once the enrollment is finished, use the instance in [MlsCentral::e2ei_rotate_all] to do the rotation.
pub async fn e2ei_new_rotate_enrollment(
&self,
display_name: Option<String>,
handle: Option<String>,
team: Option<String>,
expiry_sec: u32,
ciphersuite: MlsCiphersuite,
) -> CryptoResult<E2eiEnrollment> {
let client = self.mls_client()?;
// look for existing credential of type x509. If there isn't, then this method has been misused
let cb = client
.find_most_recent_credential_bundle(ciphersuite.signature_algorithm(), MlsCredentialType::X509)
.ok_or(E2eIdentityError::MissingExistingClient(MlsCredentialType::X509))?;
let client_id = cb.credential().identity().into();
let sign_keypair = Some((&cb.signature_key).try_into()?);
let existing_identity = cb
.to_mls_credential_with_key()
.extract_identity(ciphersuite, None)?
.x509_identity
.ok_or(E2eIdentityError::ImplementationError)?;
let display_name = display_name.unwrap_or(existing_identity.display_name);
let handle = handle.unwrap_or(existing_identity.handle);
E2eiEnrollment::try_new(
client_id,
display_name,
handle,
team,
expiry_sec,
&self.mls_backend,
ciphersuite,
sign_keypair,
#[cfg(not(target_family = "wasm"))]
Some(self.find_refresh_token().await?), // Since we are renewing an e2ei certificate we MUST have already generated one hence we MUST already have done an OIDC authn and gotten a refresh token from it we also MUST have stored in CoreCrypto
)
}
/// Creates a commit in all local conversations for changing the credential. Requires first
/// having enrolled a new X509 certificate with either [MlsCentral::e2ei_new_activation_enrollment]
/// or [MlsCentral::e2ei_new_rotate_enrollment]
pub async fn e2ei_rotate_all(
&mut self,
enrollment: &mut E2eiEnrollment,
certificate_chain: String,
new_key_packages_count: usize,
) -> CryptoResult<MlsRotateBundle> {
let sk = enrollment.get_sign_key_for_mls()?;
let cs = enrollment.ciphersuite;
let certificate_chain = enrollment
.certificate_response(
certificate_chain,
self.mls_backend
.authentication_service()
.borrow()
.await
.as_ref()
.ok_or(CryptoError::ConsumerError)?,
)
.await?;
let private_key = CertificatePrivateKey {
value: sk,
signature_scheme: cs.signature_algorithm(),
};
let crl_new_distribution_points = self.extract_dp_on_init(&certificate_chain[..]).await?;
let cert_bundle = CertificateBundle {
certificate_chain,
private_key,
};
let new_cb = self
.mls_client
.as_mut()
.ok_or(CryptoError::MlsNotInitialized)?
.save_new_x509_credential_bundle(&self.mls_backend, cs.signature_algorithm(), cert_bundle)
.await?;
let commits = self.e2ei_update_all(&new_cb).await?;
let key_package_refs_to_remove = self.find_key_packages_to_remove(&new_cb).await?;
let new_key_packages = self
.mls_client()?
.generate_new_keypackages(&self.mls_backend, cs, &new_cb, new_key_packages_count)
.await?;
Ok(MlsRotateBundle {
commits,
new_key_packages,
key_package_refs_to_remove,
crl_new_distribution_points,
})
}
async fn find_key_packages_to_remove(&self, cb: &CredentialBundle) -> CryptoResult<Vec<KeyPackageRef>> {
let nb_kp = self.mls_backend.key_store().count::<MlsKeyPackage>().await?;
let kps: Vec<KeyPackage> = self.mls_backend.key_store().mls_fetch_keypackages(nb_kp as u32).await?;
let mut kp_refs = vec![];
for kp in kps {
let kp_cred = kp.leaf_node().credential().mls_credential();
let local_cred = cb.credential().mls_credential();
let mut push_kpr = || {
let kpr = kp.hash_ref(self.mls_backend.crypto()).map_err(MlsError::from)?;
kp_refs.push(kpr);
CryptoResult::Ok(())
};
match (kp_cred, local_cred) {
(_, OpenMlsCredential::Basic(_)) => return Err(CryptoError::ImplementationError),
(OpenMlsCredential::X509(kp_cert), OpenMlsCredential::X509(local_cert)) if kp_cert != local_cert => {
push_kpr()?
}
(OpenMlsCredential::Basic(_), _) => push_kpr()?,
_ => {}
}
}
Ok(kp_refs)
}
async fn e2ei_update_all(
&mut self,
cb: &CredentialBundle,
) -> CryptoResult<HashMap<ConversationId, MlsCommitBundle>> {
let all_conversations = self.get_all_conversations().await?;
let mut commits = HashMap::with_capacity(all_conversations.len());
for conv in all_conversations {
let mut conv = conv.write().await;
let id = conv.id().clone();
let commit = conv
.e2ei_rotate(&self.mls_backend, self.mls_client()?, Some(cb))
.await?;
let _ = commits.insert(id, commit);
}
Ok(commits)
}
/// Creates a commit in a conversation for changing the credential. Requires first
/// having enrolled a new X509 certificate with either [MlsCentral::e2ei_new_activation_enrollment]
/// or [MlsCentral::e2ei_new_rotate_enrollment]
pub async fn e2ei_rotate(
&mut self,
id: &crate::prelude::ConversationId,
cb: Option<&CredentialBundle>,
) -> CryptoResult<MlsCommitBundle> {
self.get_conversation(id)
.await?
.write()
.await
.e2ei_rotate(&self.mls_backend, self.mls_client()?, cb)
.await
}
}
impl MlsConversation {
#[cfg_attr(test, crate::durable)]
pub(crate) async fn e2ei_rotate(
&mut self,
backend: &MlsCryptoProvider,
client: &Client,
cb: Option<&CredentialBundle>,
) -> CryptoResult<MlsCommitBundle> {
let cb = cb
.or_else(|| {
client.find_most_recent_credential_bundle(
self.ciphersuite().signature_algorithm(),
MlsCredentialType::X509,
)
})
.ok_or(E2eIdentityError::MissingExistingClient(MlsCredentialType::X509))?;
let mut leaf_node = self.group.own_leaf().ok_or(CryptoError::InternalMlsError)?.clone();
leaf_node.set_credential_with_key(cb.to_mls_credential_with_key());
self.update_keying_material(client, backend, Some(cb), Some(leaf_node))
.await
}
}
/// Result returned after rotating the Credential of the current client in all the local conversations
#[derive(Debug, Clone)]
pub struct MlsRotateBundle {
/// An Update commit for each conversation
pub commits: HashMap<ConversationId, MlsCommitBundle>,
/// Fresh KeyPackages with the new Credential
pub new_key_packages: Vec<KeyPackage>,
/// All the now deprecated KeyPackages. Once deleted remotely, delete them locally with [MlsCentral::delete_keypackages]
pub key_package_refs_to_remove: Vec<KeyPackageRef>,
/// New CRL distribution points that appeared by the introduction of a new credential
pub crl_new_distribution_points: NewCrlDistributionPoint,
}
impl MlsRotateBundle {
/// Lower through the FFI
#[allow(clippy::type_complexity)]
pub fn to_bytes(
self,
) -> CryptoResult<(
HashMap<String, MlsCommitBundle>,
Vec<Vec<u8>>,
Vec<Vec<u8>>,
NewCrlDistributionPoint,
)> {
use openmls::prelude::TlsSerializeTrait as _;
let commits_size = self.commits.len();
let commits = self
.commits
.into_iter()
.try_fold(HashMap::with_capacity(commits_size), |mut acc, (id, c)| {
// because uniffi ONLY supports HashMap<String, T>
let id = hex::encode(id);
let _ = acc.insert(id, c);
CryptoResult::Ok(acc)
})?;
let kp_size = self.new_key_packages.len();
let new_key_packages =
self.new_key_packages
.into_iter()
.try_fold(Vec::with_capacity(kp_size), |mut acc, kp| {
acc.push(kp.tls_serialize_detached().map_err(MlsError::from)?);
CryptoResult::Ok(acc)
})?;
let key_package_refs_to_remove = self
.key_package_refs_to_remove
.into_iter()
// TODO: add a method for taking ownership in HashReference. Tracking issue: WPB-9593
.map(|r| r.as_slice().to_vec())
.collect::<Vec<_>>();
Ok((
commits,
new_key_packages,
key_package_refs_to_remove,
self.crl_new_distribution_points,
))
}
}
#[cfg(test)]
// This is pub(crate) because failsafe_ctx() is used in other modules
pub(crate) mod tests {
use std::collections::HashSet;
use openmls::prelude::SignaturePublicKey;
use tls_codec::Deserialize;
use wasm_bindgen_test::*;
use core_crypto_keystore::entities::{EntityFindParams, MlsCredential};
use crate::{
e2e_identity::tests::*,
mls::credential::ext::CredentialExt,
prelude::key_package::INITIAL_KEYING_MATERIAL_COUNT,
test_utils::{x509::X509TestChain, *},
};
use super::*;
wasm_bindgen_test_configure!(run_in_browser);
pub(crate) mod all {
use openmls_traits::types::SignatureScheme;
use crate::test_utils::central::TEAM;
use super::*;
pub(crate) async fn failsafe_ctx(
ctxs: &mut [&mut ClientContext],
sc: SignatureScheme,
) -> std::sync::Arc<Option<X509TestChain>> {
let mut found_test_chain = None;
for ctx in ctxs.iter() {
if ctx.x509_test_chain.is_some() {
found_test_chain.replace(ctx.x509_test_chain.clone());
break;
}
}
let found_test_chain = found_test_chain.unwrap_or_else(|| Some(X509TestChain::init_empty(sc)).into());
// Propagate the chain
for ctx in ctxs.iter_mut() {
if ctx.x509_test_chain.is_none() {
ctx.replace_x509_chain(found_test_chain.clone());
}
}
let x509_test_chain = found_test_chain.as_ref().as_ref().unwrap();
for ctx in ctxs {
let _ = x509_test_chain.register_with_central(&ctx.mls_central).await;
}
found_test_chain
}
#[apply(all_cred_cipher)]
#[wasm_bindgen_test]
async fn enrollment_should_rotate_all(case: TestCase) {
run_test_with_client_ids(
case.clone(),
["alice", "bob", "charlie"],
move |[mut alice_central, mut bob_central, mut charlie_central]| {
Box::pin(async move {
const N: usize = 50;
const NB_KEY_PACKAGE: usize = 50;
let mut ids = vec![];
let x509_test_chain_arc = failsafe_ctx(
&mut [&mut alice_central, &mut bob_central, &mut charlie_central],
case.signature_scheme(),
)
.await;
let x509_test_chain = x509_test_chain_arc.as_ref().as_ref().unwrap();
for _ in 0..N {
let id = conversation_id();
alice_central
.mls_central
.new_conversation(&id, case.credential_type, case.cfg.clone())
.await
.unwrap();
alice_central
.mls_central
.invite_all(&case, &id, [&mut bob_central.mls_central])
.await
.unwrap();
ids.push(id)
}
// Count the key material before the rotation to compare it later
let before_rotate = alice_central.mls_central.count_entities().await;
assert_eq!(before_rotate.key_package, INITIAL_KEYING_MATERIAL_COUNT);
assert_eq!(before_rotate.hpke_private_key, INITIAL_KEYING_MATERIAL_COUNT);
// 1 is created per new KeyPackage
assert_eq!(before_rotate.encryption_keypair, INITIAL_KEYING_MATERIAL_COUNT);
assert_eq!(before_rotate.credential, 1);
let old_credential = alice_central
.mls_central
.find_most_recent_credential_bundle(case.signature_scheme(), case.credential_type)
.await
.unwrap()
.clone();
let is_renewal = case.credential_type == MlsCredentialType::X509;
let (mut enrollment, cert) = e2ei_enrollment(
&mut alice_central,
&case,
x509_test_chain,
None,
is_renewal,
init_activation_or_rotation,
noop_restore,
)
.await
.unwrap();
let rotate_bundle = alice_central
.mls_central
.e2ei_rotate_all(&mut enrollment, cert, NB_KEY_PACKAGE)
.await
.unwrap();
let after_rotate = alice_central.mls_central.count_entities().await;
// verify we have indeed created the right amount of new X509 KeyPackages
assert_eq!(after_rotate.key_package - before_rotate.key_package, NB_KEY_PACKAGE);
// and a new Credential has been persisted in the keystore
assert_eq!(after_rotate.credential - before_rotate.credential, 1);
for (id, commit) in rotate_bundle.commits.into_iter() {
let decrypted = bob_central
.mls_central
.decrypt_message(&id, commit.commit.to_bytes().unwrap())
.await
.unwrap();
alice_central.mls_central.verify_sender_identity(&case, &decrypted);
alice_central.mls_central.commit_accepted(&id).await.unwrap();
alice_central
.mls_central
.verify_local_credential_rotated(&id, NEW_HANDLE, NEW_DISPLAY_NAME)
.await;
}
// Verify that all the new KeyPackages contain the new identity
let new_credentials = rotate_bundle
.new_key_packages
.iter()
.map(|kp| kp.leaf_node().to_credential_with_key());
for c in new_credentials {
assert_eq!(c.credential.credential_type(), openmls::prelude::CredentialType::X509);
let identity = c.extract_identity(case.ciphersuite(), None).unwrap();
assert_eq!(identity.x509_identity.as_ref().unwrap().display_name, NEW_DISPLAY_NAME);
assert_eq!(
identity.x509_identity.as_ref().unwrap().handle,
format!("wireapp://%40{NEW_HANDLE}@world.com")
);
}
// Alice has to delete her old KeyPackages
// But first let's verify the previous credential material is present
assert!(alice_central
.mls_central
.find_credential_bundle(
case.signature_scheme(),
case.credential_type,
&old_credential.signature_key.public().into()
)
.await
.is_some());
// we also have generated the right amount of private encryption keys
let before_delete = alice_central.mls_central.count_entities().await;
assert_eq!(
before_delete.hpke_private_key - before_rotate.hpke_private_key,
NB_KEY_PACKAGE
);
// 1 has been created per new KeyPackage created in the rotation
assert_eq!(before_delete.key_package - before_rotate.key_package, NB_KEY_PACKAGE);
// and the signature keypair is still present
assert!(alice_central
.mls_central
.find_signature_keypair_from_keystore(old_credential.signature_key.public())
.await
.is_some());
// Checks are done, now let's delete ALL the deprecated KeyPackages.
// This should have the consequence to purge the previous credential material as well.
alice_central
.mls_central
.delete_keypackages(&rotate_bundle.key_package_refs_to_remove[..])
.await
.unwrap();
// Alice should just have the number of X509 KeyPackages she requested
let nb_x509_kp = alice_central
.mls_central
.count_key_package(case.ciphersuite(), Some(MlsCredentialType::X509))
.await;
assert_eq!(nb_x509_kp, NB_KEY_PACKAGE);
// in both cases, Alice should not anymore have any Basic KeyPackage
let nb_basic_kp = alice_central
.mls_central
.count_key_package(case.ciphersuite(), Some(MlsCredentialType::Basic))
.await;
assert_eq!(nb_basic_kp, 0);
// and since all of Alice's unclaimed KeyPackages have been purged, so should be her old Credential
// Also the old Credential has been removed from the keystore
let after_delete = alice_central.mls_central.count_entities().await;
assert_eq!(after_delete.credential, 1);
assert!(alice_central
.mls_central
.find_credential_from_keystore(&old_credential)
.await
.is_none());
// and all her Private HPKE keys...
assert_eq!(after_delete.hpke_private_key, NB_KEY_PACKAGE);
// ...and encryption keypairs
assert_eq!(
after_rotate.encryption_keypair - after_delete.encryption_keypair,
INITIAL_KEYING_MATERIAL_COUNT
);
// Now charlie tries to add Alice to a conversation with her new KeyPackages
let id = conversation_id();
charlie_central
.mls_central
.new_conversation(&id, case.credential_type, case.cfg.clone())
.await
.unwrap();
// required because now Alice does not anymore have a Basic credential
let alice = alice_central
.mls_central
.rand_key_package_of_type(&case, MlsCredentialType::X509)
.await;
charlie_central
.mls_central
.invite_all_members(&case, &id, [(&mut alice_central.mls_central, alice)])
.await
.unwrap();
})
},
)
.await
}
#[apply(all_cred_cipher)]
#[wasm_bindgen_test]
async fn should_restore_credentials_in_order(case: TestCase) {
run_test_with_client_ids(case.clone(), ["alice"], move |[mut alice_central]| {
Box::pin(async move {
let x509_test_chain_arc = failsafe_ctx(&mut [&mut alice_central], case.signature_scheme()).await;
let x509_test_chain = x509_test_chain_arc.as_ref().as_ref().unwrap();
let id = conversation_id();
alice_central
.mls_central
.new_conversation(&id, case.credential_type, case.cfg.clone())
.await
.unwrap();
let old_cb = alice_central
.mls_central
.find_most_recent_credential_bundle(case.signature_scheme(), case.credential_type)
.await
.unwrap()
.clone();
// simulate a real rotation where both credential are not created within the same second
// we only have a precision of 1 second for the `created_at` field of the Credential
async_std::task::sleep(core::time::Duration::from_secs(1)).await;
let is_renewal = case.credential_type == MlsCredentialType::X509;
let (mut enrollment, cert) = e2ei_enrollment(
&mut alice_central,
&case,
x509_test_chain,
None,
is_renewal,
init_activation_or_rotation,
noop_restore,
)
.await
.unwrap();
alice_central
.mls_central
.e2ei_rotate_all(&mut enrollment, cert, 10)
.await
.unwrap();
alice_central.mls_central.commit_accepted(&id).await.unwrap();
// So alice has a new Credential as expected
let cb = alice_central
.mls_central
.find_most_recent_credential_bundle(case.signature_scheme(), MlsCredentialType::X509)
.await
.unwrap();
let identity = cb
.to_mls_credential_with_key()
.extract_identity(case.ciphersuite(), None)
.unwrap();
assert_eq!(identity.x509_identity.as_ref().unwrap().display_name, NEW_DISPLAY_NAME);
assert_eq!(
identity.x509_identity.as_ref().unwrap().handle,
format!("wireapp://%40{NEW_HANDLE}@world.com")
);
// but keeps her old one since it's referenced from some KeyPackages
let old_spk = SignaturePublicKey::from(old_cb.signature_key.public());
let old_cb_found = alice_central
.mls_central
.find_credential_bundle(case.signature_scheme(), case.credential_type, &old_spk)
.await
.unwrap();
assert_eq!(&old_cb, old_cb_found);
let old_nb_identities = alice_central
.mls_central
.mls_client
.as_ref()
.unwrap()
.identities
.iter()
.count();
// Let's simulate an app crash, client gets deleted and restored from keystore
let cid = alice_central.mls_central.client_id().unwrap();
let scs = HashSet::from([case.signature_scheme()]);
let all_credentials = alice_central
.mls_central
.mls_backend
.key_store()
.find_all::<MlsCredential>(EntityFindParams::default())
.await
.unwrap()
.into_iter()
.map(|c| {
let credential =
openmls::prelude::Credential::tls_deserialize(&mut c.credential.as_slice()).unwrap();
(credential, c.created_at)
})
.collect::<Vec<_>>();
assert_eq!(all_credentials.len(), 2);
let client = Client::load(&alice_central.mls_central.mls_backend, &cid, all_credentials, scs)
.await
.unwrap();
alice_central.mls_central.mls_client = Some(client);
// Verify that Alice has the same credentials
let cb = alice_central
.mls_central
.find_most_recent_credential_bundle(case.signature_scheme(), MlsCredentialType::X509)
.await
.unwrap();
let identity = cb
.to_mls_credential_with_key()
.extract_identity(case.ciphersuite(), None)
.unwrap();
assert_eq!(identity.x509_identity.as_ref().unwrap().display_name, NEW_DISPLAY_NAME);
assert_eq!(
identity.x509_identity.as_ref().unwrap().handle,
format!("wireapp://%40{NEW_HANDLE}@world.com")
);
assert_eq!(
alice_central
.mls_central
.mls_client()
.unwrap()
.identities
.iter()
.count(),
old_nb_identities
);
})
})
.await
}
#[apply(all_cred_cipher)]
#[wasm_bindgen_test]
async fn rotate_should_roundtrip(case: TestCase) {
run_test_with_client_ids(
case.clone(),
["alice", "bob"],
move |[mut alice_central, mut bob_central]| {
Box::pin(async move {
let x509_test_chain_arc =
failsafe_ctx(&mut [&mut alice_central, &mut bob_central], case.signature_scheme()).await;
let x509_test_chain = x509_test_chain_arc.as_ref().as_ref().unwrap();
let id = conversation_id();
alice_central
.mls_central
.new_conversation(&id, case.credential_type, case.cfg.clone())
.await
.unwrap();
alice_central
.mls_central
.invite_all(&case, &id, [&mut bob_central.mls_central])
.await
.unwrap();
// Alice's turn
const ALICE_NEW_HANDLE: &str = "new_alice_wire";
const ALICE_NEW_DISPLAY_NAME: &str = "New Alice Smith";
fn init_alice(wrapper: E2eiInitWrapper) -> InitFnReturn<'_> {
Box::pin(async move {
let E2eiInitWrapper { cc, case } = wrapper;
let cs = case.ciphersuite();
match case.credential_type {
MlsCredentialType::Basic => cc.e2ei_new_activation_enrollment(
ALICE_NEW_DISPLAY_NAME.to_string(),
ALICE_NEW_HANDLE.to_string(),
Some(TEAM.to_string()),
E2EI_EXPIRY,
cs,
),
MlsCredentialType::X509 => {
cc.e2ei_new_rotate_enrollment(
Some(ALICE_NEW_DISPLAY_NAME.to_string()),
Some(ALICE_NEW_HANDLE.to_string()),
Some(TEAM.to_string()),
E2EI_EXPIRY,
cs,
)
.await
}
}
})
}
let is_renewal = case.credential_type == MlsCredentialType::X509;
let (mut enrollment, cert) = e2ei_enrollment(
&mut alice_central,
&case,
x509_test_chain,
None,
is_renewal,
init_alice,
noop_restore,
)
.await
.unwrap();
let rotate_bundle = alice_central
.mls_central
.e2ei_rotate_all(&mut enrollment, cert, 10)
.await
.unwrap();
let commit = &rotate_bundle.commits.get(&id).unwrap().commit;
let decrypted = bob_central
.mls_central
.decrypt_message(&id, commit.to_bytes().unwrap())
.await
.unwrap();
alice_central.mls_central.verify_sender_identity(&case, &decrypted);
alice_central.mls_central.commit_accepted(&id).await.unwrap();
alice_central
.mls_central
.verify_local_credential_rotated(&id, ALICE_NEW_HANDLE, ALICE_NEW_DISPLAY_NAME)
.await;
// Bob's turn
const BOB_NEW_HANDLE: &str = "new_bob_wire";
const BOB_NEW_DISPLAY_NAME: &str = "New Bob Smith";
fn init_bob(wrapper: E2eiInitWrapper) -> InitFnReturn<'_> {
Box::pin(async move {
let E2eiInitWrapper { cc, case } = wrapper;
let cs = case.ciphersuite();
match case.credential_type {
MlsCredentialType::Basic => cc.e2ei_new_activation_enrollment(
BOB_NEW_DISPLAY_NAME.to_string(),
BOB_NEW_HANDLE.to_string(),
Some(TEAM.to_string()),
E2EI_EXPIRY,
cs,
),
MlsCredentialType::X509 => {
cc.e2ei_new_rotate_enrollment(
Some(BOB_NEW_DISPLAY_NAME.to_string()),
Some(BOB_NEW_HANDLE.to_string()),
Some(TEAM.to_string()),
E2EI_EXPIRY,
cs,
)
.await
}
}
})
}
let is_renewal = case.credential_type == MlsCredentialType::X509;
let (mut enrollment, cert) = e2ei_enrollment(
&mut bob_central,
&case,
x509_test_chain,
None,
is_renewal,
init_bob,
noop_restore,
)
.await
.unwrap();
let rotate_bundle = bob_central
.mls_central
.e2ei_rotate_all(&mut enrollment, cert, 10)
.await
.unwrap();
let commit = &rotate_bundle.commits.get(&id).unwrap().commit;
let decrypted = alice_central
.mls_central
.decrypt_message(&id, commit.to_bytes().unwrap())
.await
.unwrap();
bob_central.mls_central.verify_sender_identity(&case, &decrypted);
bob_central.mls_central.commit_accepted(&id).await.unwrap();
bob_central
.mls_central
.verify_local_credential_rotated(&id, BOB_NEW_HANDLE, BOB_NEW_DISPLAY_NAME)
.await;
})
},
)
.await
}
}
mod one {
use super::*;
#[apply(all_cred_cipher)]
#[wasm_bindgen_test]
pub async fn should_rotate_one_conversations_credential(case: TestCase) {
if case.is_x509() {
run_test_with_client_ids(
case.clone(),
["alice", "bob"],
move |[mut alice_central, mut bob_central]| {
Box::pin(async move {
let id = conversation_id();
alice_central
.mls_central
.new_conversation(&id, case.credential_type, case.cfg.clone())
.await
.unwrap();
alice_central
.mls_central
.invite_all(&case, &id, [&mut bob_central.mls_central])
.await
.unwrap();
let init_count = alice_central.mls_central.count_entities().await;
let x509_test_chain = alice_central.x509_test_chain.as_ref().as_ref().unwrap();
let intermediate_ca = x509_test_chain.find_local_intermediate_ca();
let alice_og_cert = &x509_test_chain
.actors
.iter()
.find(|actor| actor.name == "alice")
.unwrap()
.certificate;
// Alice creates a new Credential, updating her handle/display_name
let alice_cid = alice_central.mls_central.get_client_id();
let (new_handle, new_display_name) = ("new_alice_wire", "New Alice Smith");
let cb = alice_central
.mls_central
.rotate_credential(&case, new_handle, new_display_name, alice_og_cert, intermediate_ca)
.await;
// Verify old identity is still there in the MLS group
let alice_old_identities = alice_central
.mls_central
.get_device_identities(&id, &[alice_cid])
.await
.unwrap();
let alice_old_identity = alice_old_identities.first().unwrap();
assert_ne!(
alice_old_identity.x509_identity.as_ref().unwrap().display_name,
new_display_name
);
assert_ne!(
alice_old_identity.x509_identity.as_ref().unwrap().handle,
format!("{new_handle}@world.com")
);
// Alice issues an Update commit to replace her current identity
let commit = alice_central.mls_central.e2ei_rotate(&id, Some(&cb)).await.unwrap();
// Bob decrypts the commit...
let decrypted = bob_central
.mls_central
.decrypt_message(&id, commit.commit.to_bytes().unwrap())
.await
.unwrap();
// ...and verifies that now Alice is represented with her new identity
alice_central.mls_central.verify_sender_identity(&case, &decrypted);
// Finally, Alice merges her commit and verifies her new identity gets applied
alice_central.mls_central.commit_accepted(&id).await.unwrap();
alice_central
.mls_central
.verify_local_credential_rotated(&id, new_handle, new_display_name)
.await;
let final_count = alice_central.mls_central.count_entities().await;
assert_eq!(init_count.encryption_keypair, final_count.encryption_keypair);
assert_eq!(
init_count.epoch_encryption_keypair,
final_count.epoch_encryption_keypair
);
assert_eq!(init_count.key_package, final_count.key_package);
})
},
)
.await
}
}
#[apply(all_cred_cipher)]
#[wasm_bindgen_test]
pub async fn rotate_should_be_renewable_when_commit_denied(case: TestCase) {
if case.is_x509() {
run_test_with_client_ids(
case.clone(),
["alice", "bob"],
move |[mut alice_central, mut bob_central]| {
Box::pin(async move {
let id = conversation_id();
alice_central
.mls_central
.new_conversation(&id, case.credential_type, case.cfg.clone())
.await
.unwrap();
alice_central
.mls_central
.invite_all(&case, &id, [&mut bob_central.mls_central])
.await
.unwrap();
let init_count = alice_central.mls_central.count_entities().await;
let x509_test_chain = alice_central.x509_test_chain.as_ref().as_ref().unwrap();
let intermediate_ca = x509_test_chain.find_local_intermediate_ca();
// In this case Alice will try to rotate her credential but her commit will be denied
// by the backend (because another commit from Bob had precedence)
// Alice creates a new Credential, updating her handle/display_name
let (new_handle, new_display_name) = ("new_alice_wire", "New Alice Smith");
let cb = alice_central
.mls_central
.rotate_credential(
&case,
new_handle,
new_display_name,
x509_test_chain.find_certificate_for_actor("alice").unwrap(),
intermediate_ca,
)
.await;
// Alice issues an Update commit to replace her current identity
let _rotate_commit = alice_central.mls_central.e2ei_rotate(&id, Some(&cb)).await.unwrap();
// Meanwhile, Bob creates a simple commit
let bob_commit = bob_central.mls_central.update_keying_material(&id).await.unwrap();
// accepted by the backend
bob_central.mls_central.commit_accepted(&id).await.unwrap();
// Alice decrypts the commit...
let decrypted = alice_central
.mls_central
.decrypt_message(&id, bob_commit.commit.to_bytes().unwrap())
.await
.unwrap();
// Alice's previous rotate commit should have been renewed so that she can re-commit it
assert_eq!(decrypted.proposals.len(), 1);
let renewed_proposal = decrypted.proposals.first().unwrap();
bob_central
.mls_central
.decrypt_message(&id, renewed_proposal.proposal.to_bytes().unwrap())
.await
.unwrap();
let rotate_commit = alice_central
.mls_central
.commit_pending_proposals(&id)
.await
.unwrap()
.unwrap();
// Finally, Alice merges her commit and verifies her new identity gets applied
alice_central.mls_central.commit_accepted(&id).await.unwrap();
alice_central
.mls_central
.verify_local_credential_rotated(&id, new_handle, new_display_name)
.await;
// Bob verifies that now Alice is represented with her new identity
let decrypted = bob_central
.mls_central
.decrypt_message(&id, rotate_commit.commit.to_bytes().unwrap())
.await
.unwrap();
alice_central.mls_central.verify_sender_identity(&case, &decrypted);
let final_count = alice_central.mls_central.count_entities().await;
assert_eq!(init_count.encryption_keypair, final_count.encryption_keypair);
// TODO: there is no efficient way to clean a credential when alice merges her pending commit. Tracking issue: WPB-9594
// One option would be to fetch all conversations and see if Alice is never represented with the said Credential
// but let's be honest this is not very efficient.
// The other option would be to get rid of having an implicit KeyPackage for the creator of a conversation
// assert_eq!(init_count.credential, final_count.credential);
})
},
)
.await
}
}
#[apply(all_cred_cipher)]
#[wasm_bindgen_test]
pub async fn rotate_should_replace_existing_basic_credentials(case: TestCase) {
if case.is_x509() {
run_test_with_client_ids(
case.clone(),
["alice", "bob"],
move |[mut alice_central, mut bob_central]| {
Box::pin(async move {
let id = conversation_id();
alice_central
.mls_central
.new_conversation(&id, MlsCredentialType::Basic, case.cfg.clone())
.await
.unwrap();
alice_central
.mls_central
.invite_all(&case, &id, [&mut bob_central.mls_central])
.await
.unwrap();
let x509_test_chain = alice_central.x509_test_chain.as_ref().as_ref().unwrap();
let intermediate_ca = x509_test_chain.find_local_intermediate_ca();
let alice_og_cert = &x509_test_chain
.actors
.iter()
.find(|actor| actor.name == "alice")
.unwrap()
.certificate;
// Alice creates a new Credential, updating her handle/display_name
let alice_cid = alice_central.mls_central.get_client_id();
let (new_handle, new_display_name) = ("new_alice_wire", "New Alice Smith");
alice_central
.mls_central
.rotate_credential(&case, new_handle, new_display_name, alice_og_cert, intermediate_ca)
.await;
// Verify old identity is a basic identity in the MLS group
let alice_old_identities = alice_central
.mls_central
.get_device_identities(&id, &[alice_cid])
.await
.unwrap();
let alice_old_identity = alice_old_identities.first().unwrap();
assert_eq!(alice_old_identity.credential_type, MlsCredentialType::Basic);
assert_eq!(alice_old_identity.x509_identity, None);
// Alice issues an Update commit to replace her current identity
let commit = alice_central.mls_central.e2ei_rotate(&id, None).await.unwrap();
// Bob decrypts the commit...
let decrypted = bob_central
.mls_central
.decrypt_message(&id, commit.commit.to_bytes().unwrap())
.await
.unwrap();
// ...and verifies that now Alice is represented with her new identity
alice_central.mls_central.verify_sender_identity(&case, &decrypted);
// Finally, Alice merges her commit and verifies her new identity gets applied
alice_central.mls_central.commit_accepted(&id).await.unwrap();
alice_central
.mls_central
.verify_local_credential_rotated(&id, new_handle, new_display_name)
.await;
})
},
)
.await
}
}
}
}