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
|
// Copyright (c) 2024 Mozilla Corporation and contributors.
// SPDX-License-Identifier: (Apache-2.0 OR MIT)
use mls_platform_api::mls_group_propose_remove;
use mls_platform_api::ClientConfig;
use mls_platform_api::MessageOrAck;
use mls_platform_api::PlatformError;
use mls_platform_api::Received;
//
// Scenario
//
// * Alice, Bob, Charlie and Diana create signing identity (generate_signature_keypair)
// * Alice, Bob, Charlie and Diana create credentials (generate_credential_basic)
// * Bob and Charlie create key packages (generate_key_package)
// * Alice creates a group (group_create)
// * Alice adds Bob to the group (group_add)
// - Alice receives her add commit (receive for commit)
// - Bob joins the group (group_join)
// * Bob sends an application message (send)
// - Alice receives the application message (receive for application message)
// * Bob adds Charlie to the group
// - Bob receives the add commit
// - Alice receives the add commit
// - Charlie joins the group
// * Charlie removes Alice from the group (group_remove)
// - Charlie receives her remove commit
// - Alice receives the remove commit
// - Bob receives the remove commit
// * Bob produces group update with group info (group_update with external join)
// - Bob receives his update commit
// - Charlie receives the commit
// * Diana sends a commit to do an external join (group_update for external join)
// * Diana sends an application message
// - Bob receives the commit
// - Bob receives Diana's application message
// - Charlie receives the commit
// - Charlie receives Diana's application message
// * Bob sends a self remove proposal to the group (group_propose_remove)
// - Diana receives the proposal (receive for proposal)
// * Diana produces the commit for the remove proposal
// - Diana receives her remove commit
// - Charlie receives her remove commit
// - Bob receives her remove commit
// * Charlie decides that it's enough and closes the group (group_close)
// - Diana processes the close commit
// - Charlie processes the close commit
// * Charlie removes her state for the group (state_delete_group)
#[test]
fn main() -> Result<(), PlatformError> {
// Default group configuration
let group_config = mls_platform_api::GroupConfig::default();
// Storage states
let mut state_global = mls_platform_api::state_access("global.db", &[0u8; 32])?;
// Credentials
let alice_cred = mls_platform_api::mls_generate_credential_basic("alice".as_bytes())?;
let bob_cred = mls_platform_api::mls_generate_credential_basic("bob".as_bytes())?;
let charlie_cred = mls_platform_api::mls_generate_credential_basic("charlie".as_bytes())?;
let diana_cred = mls_platform_api::mls_generate_credential_basic("diana".as_bytes())?;
println!("\nAlice credential: {}", hex::encode(&alice_cred));
println!("Bob credential: {}", hex::encode(&bob_cred));
println!("Charlie credential: {}", hex::encode(&charlie_cred));
println!("Diana credential: {}", hex::encode(&diana_cred));
// Create signature keypairs and store them in the state
let alice_id =
mls_platform_api::mls_generate_identity(&state_global, group_config.ciphersuite)?;
let bob_id = mls_platform_api::mls_generate_identity(&state_global, group_config.ciphersuite)?;
let charlie_id =
mls_platform_api::mls_generate_identity(&state_global, group_config.ciphersuite)?;
let diana_id =
mls_platform_api::mls_generate_identity(&state_global, group_config.ciphersuite)?;
println!("\nAlice identifier: {}", hex::encode(&alice_id));
println!("Bob identifier: {}", hex::encode(&bob_id));
println!("Charlie identifier: {}", hex::encode(&charlie_id));
println!("Diana identifier: {}", hex::encode(&diana_id));
// Create Key Package for Bob
let bob_kp = mls_platform_api::mls_generate_key_package(
&state_global,
&bob_id,
&bob_cred,
&Default::default(),
)?;
// Create Key Package for Charlie
let charlie_kp = mls_platform_api::mls_generate_key_package(
&state_global,
&charlie_id,
&charlie_cred,
&Default::default(),
)?;
// Create a group with Alice
let gide = mls_platform_api::mls_group_create(
&mut state_global,
&alice_id,
&alice_cred,
None,
None,
&Default::default(),
)?;
println!("\nGroup created by Alice: {}", hex::encode(&gide.group_id));
// List the members of the group
let members = mls_platform_api::mls_group_details(&state_global, &gide.group_id, &alice_id)?;
println!("Members (alice, before adding bob): {members:?}");
//
// Alice adds Bob to a group
//
println!("\nAlice adds Bob to the Group");
let commit_output = mls_platform_api::mls_group_add(
&mut state_global,
&gide.group_id,
&alice_id,
vec![bob_kp],
)?;
let welcome = commit_output
.welcome
.first()
.expect("No welcome messages found")
.clone();
// Alice process her own commit
println!("\nAlice process her commit to add Bob to the Group");
mls_platform_api::mls_receive(
&state_global,
&alice_id,
&MessageOrAck::MlsMessage(commit_output.commit.clone()),
)?;
// List the members of the group
let members = mls_platform_api::mls_group_details(&state_global, &gide.group_id, &alice_id)?;
println!("Members (alice, after adding bob): {members:?}");
// Bob joins
println!("\nBob joins the group created by Alice");
mls_platform_api::mls_group_join(&state_global, &bob_id, &welcome, None)?;
// List the members of the group
let members = mls_platform_api::mls_group_details(&state_global, &gide.group_id, &bob_id)?;
println!("Members (bob, after joining the group): {members:?}");
//
// Bob sends message to alice
//
println!("\nBob sends a message to Alice");
let ciphertext = mls_platform_api::mls_send(&state_global, &gide.group_id, &bob_id, b"hello")?;
// Alice receives the message
let message = mls_platform_api::mls_receive(
&state_global,
&alice_id,
&MessageOrAck::MlsMessage(ciphertext),
)?;
let (_, Received::ApplicationMessage(app_msg)) = message else {
panic!("Expected an application message, but received a different type.");
};
println!(
"\nAlice receives the message from Bob: {:?}",
String::from_utf8(app_msg).unwrap()
);
//
// Bob adds Charlie
//
println!("\nBob adds Charlie to the Group");
let commit_2_output = mls_platform_api::mls_group_add(
&mut state_global,
&gide.group_id,
&bob_id,
vec![charlie_kp],
)?;
let commit_2 = commit_2_output.commit;
let welcome_2 = commit_2_output
.welcome
.first()
.expect("No welcome messages found")
.clone();
// Bobs process its commit
println!("\nBob process their Commit");
mls_platform_api::mls_receive(
&state_global,
&bob_id,
&MessageOrAck::MlsMessage(commit_2.clone()),
)?;
// List the members of the group
let members = mls_platform_api::mls_group_details(&state_global, &gide.group_id, &bob_id)?;
println!("Members (bob, after adding charlie): {members:?}");
// Alice receives the commit
println!("\nAlice receives the commit from Bob to add Charlie");
mls_platform_api::mls_receive(
&state_global,
&alice_id,
&MessageOrAck::MlsMessage(commit_2),
)?;
// Charlie joins
println!("\nCharlie joins the group");
mls_platform_api::mls_group_join(&state_global, &charlie_id, &welcome_2, None)?;
// List the members of the group
let members = mls_platform_api::mls_group_details(&state_global, &gide.group_id, &charlie_id)?;
println!("Members (charlie, after joining the group): {members:?}");
//
// Charlie removes Alice from the group
//
println!("\nCharlie removes Alice from the Group");
let commit_3_output =
mls_platform_api::mls_group_remove(&state_global, &gide.group_id, &charlie_id, &alice_id)?;
let commit_3 = commit_3_output.commit;
// Charlie receives the commit
mls_platform_api::mls_receive(
&state_global,
&charlie_id,
&MessageOrAck::Ack(gide.group_id.to_vec()),
)?;
let members = mls_platform_api::mls_group_details(&state_global, &gide.group_id, &charlie_id)?;
println!("Members (charlie, after removing alice): {members:?}");
// Alice receives the commit from Charlie
println!("\nAlice receives the remove commit from Charlie");
let _ = mls_platform_api::mls_receive(
&state_global,
&alice_id,
&MessageOrAck::MlsMessage(commit_3.clone()),
)?;
println!("Members (alice, after receiving alice's removal the group): {members:?}");
println!("Alice's state for the group has been removed");
// Bob receives the commit from Charlie
println!("\nBob receives the remove commit from Charlie");
let _ = mls_platform_api::mls_receive(
&state_global,
&bob_id,
&MessageOrAck::MlsMessage(commit_3.clone()),
)?;
let members = mls_platform_api::mls_group_details(&state_global, &gide.group_id, &bob_id)?;
println!("Members (bob, after receiving alice's removal the group): {members:?}");
//
// Bob produces group info to allow an external join from Diana
//
let client_config = ClientConfig {
allow_external_commits: true,
..Default::default()
};
println!("\nBob produce a group info so that someone can do an External join");
let commit_4_output = mls_platform_api::mls_group_update(
&mut state_global,
&gide.group_id,
&bob_id,
None,
None,
None,
&client_config,
)?;
// Bob receives own commit
mls_platform_api::mls_receive(
&state_global,
&bob_id,
&MessageOrAck::MlsMessage(commit_4_output.commit.clone()),
)?;
let members = mls_platform_api::mls_group_details(&state_global, &gide.group_id, &bob_id)?;
println!("Members (bob, after commit allowing external join): {members:?}");
// Charlie receives Bob's commit with GroupInfo for External Join
mls_platform_api::mls_receive(
&state_global,
&charlie_id,
&MessageOrAck::MlsMessage(commit_4_output.commit),
)?;
let members = mls_platform_api::mls_group_details(&state_global, &gide.group_id, &charlie_id)?;
println!("Members (charlie, after bob's commit allowing external join): {members:?}");
//
// Diana joins the group with an external commit
//
println!("\nDiana uses the group info created by Bob to do an External join");
let external_commit_output = mls_platform_api::mls_group_external_commit(
&state_global,
&diana_id,
&diana_cred,
&commit_4_output
.group_info
.expect("alice should produce group info"),
// use tree in extension for now
None,
)?;
println!("Externally joined group {:?}", &external_commit_output.gid);
let members = mls_platform_api::mls_group_details(&state_global, &gide.group_id, &diana_id)?;
println!("Members (diane, after joining): {members:?}");
//
// Diana sends a message to the group
//
println!("\nDiana sends a message to the group");
let ctx = mls_platform_api::mls_send(
&state_global,
&gide.group_id,
&diana_id,
b"hello from diana",
)?;
// Bob receives Diana's commit
println!("\nBob receives the External Join from Diana");
mls_platform_api::mls_receive(
&state_global,
&bob_id,
&MessageOrAck::MlsMessage(external_commit_output.external_commit.clone()),
)?;
let members = mls_platform_api::mls_group_details(&state_global, &gide.group_id, &diana_id)?;
println!("Members (bob, after diane joined externally): {members:?}");
// Bob receives Diana's application message
let ptx = mls_platform_api::mls_receive(
&state_global,
&bob_id,
&MessageOrAck::MlsMessage(ctx.clone()),
)?;
let (_, Received::ApplicationMessage(app_msg)) = ptx else {
panic!("Expected an application message, but received a different type.");
};
println!(
"\nBob receives Diana's message {:?}",
String::from_utf8(app_msg).unwrap()
);
// Charlie receives Diana's commit
println!("\nCharlie receives the External Join from Diana");
mls_platform_api::mls_receive(
&state_global,
&charlie_id,
&MessageOrAck::MlsMessage(external_commit_output.external_commit),
)?;
let members = mls_platform_api::mls_group_details(&state_global, &gide.group_id, &charlie_id)?;
println!("Members (charlie, after diane joined externally): {members:?}");
// Charlie receives Diana's application message
let ptx =
mls_platform_api::mls_receive(&state_global, &charlie_id, &MessageOrAck::MlsMessage(ctx))?;
let (_, Received::ApplicationMessage(app_msg)) = ptx else {
panic!("Expected an application message, but received a different type.");
};
println!(
"\nCharlie receives Diana's message {:?}",
String::from_utf8(app_msg).unwrap()
);
//
// Bob proposes to remove itself
//
println!("\nBob proposes a self remove");
let self_remove_proposal =
mls_group_propose_remove(&state_global, &gide.group_id, &bob_id, &bob_id)?;
//
// Diana receives the proposal from Bob
//
println!("\nDiana commits to the remove");
let received_5_output = mls_platform_api::mls_receive(
&state_global,
&diana_id,
&MessageOrAck::MlsMessage(self_remove_proposal.clone()),
)?;
let (_, Received::CommitOutput(commit_5_output)) = received_5_output else {
panic!("Expected an application message, but received a different type.");
};
let commit_5_msg = MessageOrAck::MlsMessage(commit_5_output.commit);
// Diana processes the remove commit
println!("\nDiana processes the remove commit");
mls_platform_api::mls_receive(&state_global, &diana_id, &commit_5_msg)?;
let members = mls_platform_api::mls_group_details(&state_global, &gide.group_id, &diana_id)?;
println!("Members (diana, after removing bob): {members:?}");
// Charlie processes the remove commit
println!("\nCharlie processes the remove commit");
mls_platform_api::mls_receive(
&state_global,
&charlie_id,
&MessageOrAck::MlsMessage(self_remove_proposal),
)?;
mls_platform_api::mls_receive(&state_global, &charlie_id, &commit_5_msg)?;
let members = mls_platform_api::mls_group_details(&state_global, &gide.group_id, &charlie_id)?;
println!("Members (charlie, after removing bob): {members:?}");
// Bob processes the remove commit
println!("\nBob processes the remove commit");
let received_5_bob = mls_platform_api::mls_receive(&state_global, &bob_id, &commit_5_msg)?;
let (_, Received::GroupIdEpoch(out_commit_5_bob)) = received_5_bob else {
panic!("Expected a different type.");
};
println!("Bob, out_commit_5 {out_commit_5_bob:?}");
println!("Bob's state for the group has been removed");
// Note: Bob cannot look at its own group state because it was already removed
// let members = mls_platform_api::mls_group_details(&state_global, &gide.group_id, &bob_id)?;
// let members_str = mls_platform_api::utils_json_bytes_to_string_custom(&members)?;
// println!("Members (bob, after its removal): {members_str:?}");
//
// Charlie decides that it's enough and closes the group
//
println!("\nCharlie decides that it's enough and closes the group");
let commit_output_6_bytes =
mls_platform_api::mls_group_close(&state_global, &gide.group_id, &charlie_id)?;
let commit_6_msg = MessageOrAck::MlsMessage(commit_output_6_bytes.commit);
// Diana processes the close commit
println!("\nDiana processes the close commit");
let received_6_diana = mls_platform_api::mls_receive(&state_global, &diana_id, &commit_6_msg)?;
let (_, Received::GroupIdEpoch(out_commit_6_diana)) = received_6_diana else {
panic!("Expected a different type.");
};
println!("Diana, out_commit_6 {out_commit_6_diana:?}");
println!("Diana's state for the group has been removed");
// Note: Diana cannot look at its own group state because it was already removed
// Charlie processes the close commit
println!("\nCharlie processes the close commit");
mls_platform_api::mls_receive(&state_global, &charlie_id, &commit_6_msg)?;
let members = mls_platform_api::mls_group_details(&state_global, &gide.group_id, &charlie_id)?;
println!("Members (charlie, after processing their group_close commit): {members:?}");
// Charlie deletes her state for the group
println!("\nCharlie deletes her state");
let out = mls_platform_api::state_delete_group(&state_global, &gide.group_id, &charlie_id)?;
println!("Charlie, group deletion confirmation {out:?}");
Ok(())
}
|