Add an argument to tc.CreateNewEncryptedRoom for the content of the m…

….room.encryption event

tests/device_keys_test.go

@@ -42,7 +42,7 @@ func TestFailedDeviceKeyDownloadRetries(t *testing.T) {
 			},
 		}, func() {
 			// And Alice and Bob are in an encrypted room together
-			roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "private_chat", []string{tc.Bob.UserID})
+			roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "private_chat", []string{tc.Bob.UserID}, nil)
 			tc.Bob.MustJoinRoom(t, roomID, []string{"hs1"})
 
 			tc.WithAliceAndBobSyncing(t, func(alice, bob api.Client) {

tests/federation_connectivity_test.go

@@ -28,7 +28,7 @@ func TestNewUserCannotGetKeysForOfflineServer(t *testing.T) {
 		Lang: api.ClientTypeRust,
 		HS:   "hs1",
 	})
-	roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "private_chat", []string{tc.Bob.UserID})
+	roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "private_chat", []string{tc.Bob.UserID}, nil)
 	tc.Bob.MustJoinRoom(t, roomID, []string{"hs1"})
 
 	tc.WithAliceAndBobSyncing(t, func(alice, bob api.Client) {
@@ -107,8 +107,8 @@ func TestExistingSessionCannotGetKeysForOfflineServer(t *testing.T) {
 		Lang: api.ClientTypeRust,
 		HS:   "hs1",
 	})
-	roomIDbc := tc.CreateNewEncryptedRoom(t, tc.Charlie, "private_chat", []string{tc.Bob.UserID})
-	roomIDab := tc.CreateNewEncryptedRoom(t, tc.Alice, "private_chat", []string{tc.Bob.UserID})
+	roomIDbc := tc.CreateNewEncryptedRoom(t, tc.Charlie, "private_chat", []string{tc.Bob.UserID}, nil)
+	roomIDab := tc.CreateNewEncryptedRoom(t, tc.Alice, "private_chat", []string{tc.Bob.UserID}, nil)
 	tc.Bob.MustJoinRoom(t, roomIDab, []string{"hs1"})
 	tc.Bob.MustJoinRoom(t, roomIDbc, []string{"hs1"})
 

tests/main_test.go

@@ -239,11 +239,27 @@ func (c *TestContext) WithAliceBobAndCharlieSyncing(t *testing.T, callback func(
 }
 
 // CreateNewEncryptedRoom calls creator.MustCreateRoom with the correct m.room.encryption state event.
-func (c *TestContext) CreateNewEncryptedRoom(t *testing.T, creator *client.CSAPI, preset string, invite []string) (roomID string) {
+
+// m_room_encryptionContent specifies the content of the `m.room.encryption`
+// event. It may be nil, in which case the standard algorithm
+// ("m.megolm.v1.aes-sha2") is used, and the rotation periods are omitted,
+// meaning the defaults will be used.
+func (c *TestContext) CreateNewEncryptedRoom(
+	t *testing.T,
+	creator *client.CSAPI,
+	preset string,
+	invite []string,
+	m_room_encryptionContent map[string]interface{},
+) (roomID string) {
 	t.Helper()
 	if invite == nil {
 		invite = []string{} // else synapse 500s
 	}
+	if m_room_encryptionContent == nil {
+		m_room_encryptionContent = map[string]interface{}{
+			"algorithm": "m.megolm.v1.aes-sha2",
+		}
+	}
 	return creator.MustCreateRoom(t, map[string]interface{}{
 		"name":   t.Name(),
 		"preset": preset,
@@ -252,9 +268,7 @@ func (c *TestContext) CreateNewEncryptedRoom(t *testing.T, creator *client.CSAPI
 			{
 				"type":      "m.room.encryption",
 				"state_key": "",
-				"content": map[string]interface{}{
-					"algorithm": "m.megolm.v1.aes-sha2",
-				},
+				"content":   m_room_encryptionContent,
 			},
 		},
 	})

tests/membership_acls_test.go

@@ -23,7 +23,7 @@ func TestAliceBobEncryptionWorks(t *testing.T) {
 	ClientTypeMatrix(t, func(t *testing.T, clientTypeA, clientTypeB api.ClientType) {
 		tc := CreateTestContext(t, clientTypeA, clientTypeB)
 		// Alice invites Bob to the encrypted room
-		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "trusted_private_chat", []string{tc.Bob.UserID})
+		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "trusted_private_chat", []string{tc.Bob.UserID}, nil)
 		tc.Bob.MustJoinRoom(t, roomID, []string{clientTypeA.HS})
 
 		// SDK testing below
@@ -60,7 +60,7 @@ func TestCanDecryptMessagesAfterInviteButBeforeJoin(t *testing.T) {
 	ClientTypeMatrix(t, func(t *testing.T, clientTypeA, clientTypeB api.ClientType) {
 		tc := CreateTestContext(t, clientTypeA, clientTypeB)
 		// Alice invites Bob to the encrypted room
-		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "trusted_private_chat", []string{tc.Bob.UserID})
+		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "trusted_private_chat", []string{tc.Bob.UserID}, nil)
 
 		// SDK testing below
 		// -----------------
@@ -123,7 +123,7 @@ func TestBobCanSeeButNotDecryptHistoryInPublicRoom(t *testing.T) {
 	ClientTypeMatrix(t, func(t *testing.T, clientTypeA, clientTypeB api.ClientType) {
 		tc := CreateTestContext(t, clientTypeA, clientTypeB)
 		// shared history visibility
-		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "public_chat", nil)
+		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "public_chat", nil, nil)
 
 		// SDK testing below
 		// -----------------
@@ -157,7 +157,7 @@ func TestOnRejoinBobCanSeeButNotDecryptHistoryInPublicRoom(t *testing.T) {
 	ClientTypeMatrix(t, func(t *testing.T, clientTypeA, clientTypeB api.ClientType) {
 		tc := CreateTestContext(t, clientTypeA, clientTypeB)
 		// shared history visibility
-		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "public_chat", nil)
+		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "public_chat", nil, nil)
 		tc.Bob.MustJoinRoom(t, roomID, []string{clientTypeA.HS})
 
 		// SDK testing below
@@ -228,7 +228,7 @@ func TestOnNewDeviceBobCanSeeButNotDecryptHistoryInPublicRoom(t *testing.T) {
 	ClientTypeMatrix(t, func(t *testing.T, clientTypeA, clientTypeB api.ClientType) {
 		tc := CreateTestContext(t, clientTypeA, clientTypeB)
 		// shared history visibility
-		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "public_chat", nil)
+		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "public_chat", nil, nil)
 		tc.Bob.MustJoinRoom(t, roomID, []string{clientTypeA.HS})
 
 		// SDK testing below
@@ -314,7 +314,7 @@ func TestChangingDeviceAfterInviteReEncrypts(t *testing.T) {
 	ClientTypeMatrix(t, func(t *testing.T, clientTypeA, clientTypeB api.ClientType) {
 		tc := CreateTestContext(t, clientTypeA, clientTypeB)
 		// shared history visibility
-		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "public_chat", nil)
+		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "public_chat", nil, nil)
 
 		tc.WithAliceAndBobSyncing(t, func(alice, bob api.Client) {
 			// Alice invites Bob and then she sends an event

tests/one_time_keys_test.go

@@ -126,7 +126,7 @@ func TestFallbackKeyIsUsedIfOneTimeKeysRunOut(t *testing.T) {
 				fallbackKeyID, fallbackKey = mustClaimFallbackKey(t, otkGobbler, tc.Alice)
 
 				// now bob & charlie try to talk to alice, the fallback key should be used
-				roomID = tc.CreateNewEncryptedRoom(t, tc.Bob, "public_chat", []string{tc.Alice.UserID, tc.Charlie.UserID})
+				roomID = tc.CreateNewEncryptedRoom(t, tc.Bob, "public_chat", []string{tc.Alice.UserID, tc.Charlie.UserID}, nil)
 				tc.Charlie.MustJoinRoom(t, roomID, []string{keyConsumerClientType.HS})
 				tc.Alice.MustJoinRoom(t, roomID, []string{keyConsumerClientType.HS})
 				charlie.WaitUntilEventInRoom(t, roomID, api.CheckEventHasMembership(alice.UserID(), "join")).Wait(t, 5*time.Second)
@@ -252,7 +252,7 @@ func TestFailedKeysClaimRetries(t *testing.T) {
 			defer close()
 
 			// make a room which will link the 2 users together when
-			roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "public_chat", nil)
+			roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "public_chat", nil, nil)
 			// block /keys/claim and join the room, causing the Olm session to be created
 			tc.Deployment.WithMITMOptions(t, map[string]interface{}{
 				"statuscode": map[string]interface{}{

tests/room_keys_test.go

@@ -29,13 +29,13 @@ func sniffToDeviceEvent(t *testing.T, d complement.Deployment, ch chan deploy.Ca
 	return callbackURL, close
 }
 
-// This test ensure we change the m.room_key when a device leaves an E2EE room.
+// This test ensures we change the m.room_key when a device leaves an E2EE room.
 // If the key is not changed, the left device could potentially decrypt the encrypted
 // event if they could get access to it.
 func TestRoomKeyIsCycledOnDeviceLogout(t *testing.T) {
 	ClientTypeMatrix(t, func(t *testing.T, clientTypeA, clientTypeB api.ClientType) {
 		tc := CreateTestContext(t, clientTypeA, clientTypeB)
-		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "trusted_private_chat", []string{tc.Bob.UserID})
+		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "trusted_private_chat", []string{tc.Bob.UserID}, nil)
 		tc.Bob.MustJoinRoom(t, roomID, []string{clientTypeA.HS})
 
 		// Alice, Alice2 and Bob are in a room.
@@ -94,7 +94,7 @@ func TestRoomKeyIsCycledOnDeviceLogout(t *testing.T) {
 func TestRoomKeyIsCycledOnMemberLeaving(t *testing.T) {
 	ClientTypeMatrix(t, func(t *testing.T, clientTypeA, clientTypeB api.ClientType) {
 		tc := CreateTestContext(t, clientTypeA, clientTypeB, clientTypeB)
-		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "trusted_private_chat", []string{tc.Bob.UserID, tc.Charlie.UserID})
+		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "trusted_private_chat", []string{tc.Bob.UserID, tc.Charlie.UserID}, nil)
 		tc.Bob.MustJoinRoom(t, roomID, []string{clientTypeA.HS})
 		tc.Charlie.MustJoinRoom(t, roomID, []string{clientTypeA.HS})
 		// Alice, Bob and Charlie are in a room.
@@ -149,7 +149,7 @@ func TestRoomKeyIsCycledOnMemberLeaving(t *testing.T) {
 func TestRoomKeyIsNotCycled(t *testing.T) {
 	ClientTypeMatrix(t, func(t *testing.T, clientTypeA, clientTypeB api.ClientType) {
 		tc := CreateTestContext(t, clientTypeA, clientTypeB)
-		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "trusted_private_chat", []string{tc.Bob.UserID})
+		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "trusted_private_chat", []string{tc.Bob.UserID}, nil)
 		tc.Bob.MustJoinRoom(t, roomID, []string{clientTypeA.HS})
 
 		// Alice, Bob are in a room.
@@ -288,7 +288,7 @@ func TestRoomKeyIsNotCycledOnClientRestart(t *testing.T) {
 
 func testRoomKeyIsNotCycledOnClientRestartRust(t *testing.T, clientType api.ClientType) {
 	tc := CreateTestContext(t, clientType, clientType)
-	roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "trusted_private_chat", []string{tc.Bob.UserID})
+	roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "trusted_private_chat", []string{tc.Bob.UserID}, nil)
 	tc.Bob.MustJoinRoom(t, roomID, []string{clientType.HS})
 
 	tc.WithClientSyncing(t, clientType, tc.Bob, func(bob api.Client) {
@@ -368,7 +368,7 @@ func testRoomKeyIsNotCycledOnClientRestartRust(t *testing.T, clientType api.Clie
 
 func testRoomKeyIsNotCycledOnClientRestartJS(t *testing.T, clientType api.ClientType) {
 	tc := CreateTestContext(t, clientType, clientType)
-	roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "trusted_private_chat", []string{tc.Bob.UserID})
+	roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "trusted_private_chat", []string{tc.Bob.UserID}, nil)
 	tc.Bob.MustJoinRoom(t, roomID, []string{clientType.HS})
 
 	// Alice and Bob are in a room.

tests/to_device_test.go

@@ -19,7 +19,7 @@ import (
 func TestClientRetriesSendToDevice(t *testing.T) {
 	ClientTypeMatrix(t, func(t *testing.T, clientTypeA, clientTypeB api.ClientType) {
 		tc := CreateTestContext(t, clientTypeA, clientTypeB)
-		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "public_chat", nil)
+		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "public_chat", nil, nil)
 		tc.Bob.MustJoinRoom(t, roomID, []string{clientTypeA.HS})
 		tc.WithAliceAndBobSyncing(t, func(alice, bob api.Client) {
 			// lets device keys be exchanged
@@ -73,7 +73,7 @@ func TestUnprocessedToDeviceMessagesArentLostOnRestart(t *testing.T) {
 	ForEachClientType(t, func(t *testing.T, clientType api.ClientType) {
 		// prepare for the test: register all 3 clients and create the room
 		tc := CreateTestContext(t, clientType, clientType)
-		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "private_chat", []string{tc.Bob.UserID})
+		roomID := tc.CreateNewEncryptedRoom(t, tc.Alice, "private_chat", []string{tc.Bob.UserID}, nil)
 		tc.Bob.MustJoinRoom(t, roomID, []string{clientType.HS})
 		alice2 := tc.Deployment.Login(t, clientType.HS, tc.Alice, helpers.LoginOpts{
 			DeviceID: "ALICE_TWO",