upstream-rocketchat/apps/meteor/tests/e2e/e2e-encryption/e2ee-file-encryption.spec.ts

import { Users } from '../fixtures/userStates';
import { HomeChannel } from '../page-objects';
import { createTargetGroupAndReturnFullRoom } from '../utils';
import { preserveSettings } from '../utils/preserveSettings';
import { test, expect } from '../utils/test';

const settingsList = [
	'E2E_Enable',
	'E2E_Allow_Unencrypted_Messages',
	'E2E_Enable_Encrypt_Files',
	'E2E_Enabled_Default_DirectRooms',
	'E2E_Enabled_Default_PrivateRooms',
];

const originalSettings = preserveSettings(settingsList);

const TEST_FILE_TXT = 'any_file.txt';

test.use({ storageState: Users.userE2EE.state });

test.describe('E2EE File Encryption', () => {
	let poHomeChannel: HomeChannel;
	let encryptedRoomId: string;

	test.beforeAll(async ({ api }) => {
		await api.post('/settings/E2E_Enable', { value: true });
		await api.post('/settings/E2E_Allow_Unencrypted_Messages', { value: true });
		await api.post('/settings/E2E_Enabled_Default_DirectRooms', { value: false });
		await api.post('/settings/E2E_Enabled_Default_PrivateRooms', { value: false });
		await api.post('/im.delete', { username: 'user2' });
	});

	test.afterAll(async ({ api }) => {
		await api.post('/settings/FileUpload_MediaTypeWhiteList', { value: '' });
		await api.post('/settings/FileUpload_MediaTypeBlackList', { value: 'image/svg+xml' });
	});

	test.beforeEach(async ({ api, page }) => {
		poHomeChannel = new HomeChannel(page);
		const { group } = await createTargetGroupAndReturnFullRoom(api, {
			extraData: {
				broadcast: false,
				encrypted: true,
			},
			members: [Users.userE2EE.data._id],
		});

		encryptedRoomId = group._id;

		await poHomeChannel.gotoGroup(group.name as string);
		await expect(poHomeChannel.content.encryptedRoomHeaderIcon).toBeVisible();
		await expect
			.poll(
				() =>
					page.evaluate(async (rid) => {
						// eslint-disable-next-line import-x/no-absolute-path
						const { e2e } = require('/client/lib/e2ee/rocketchat.e2e.ts') as typeof import('../../../client/lib/e2ee/rocketchat.e2e');
						const room = await e2e.getInstanceByRoomId(rid);
						return room?.getState();
					}, group._id),
				{ message: 'expect room encryption key to be ready before sending messages' },
			)
			.toBe('READY');
	});

	test.afterEach(async ({ api }) => {
		expect((await api.post('/groups.delete', { roomId: encryptedRoomId })).status()).toBe(200);
	});

	test('should edit encrypted message with file', async ({ page }) => {
		const updatedFileName = `edited_${TEST_FILE_TXT}`;

		await test.step('send a file in channel and edit it', async () => {
			await poHomeChannel.content.dragAndDropTxtFile();
			await poHomeChannel.composer.getFileByName(TEST_FILE_TXT).click();
			await poHomeChannel.content.inputFileUploadName.fill(updatedFileName);
			await poHomeChannel.content.btnUpdateFileUpload.click();
			await expect(poHomeChannel.composer.getFileByName(updatedFileName)).toBeVisible();

			await poHomeChannel.composer.inputMessage.fill('any_description');
			await poHomeChannel.composer.btnSend.click();
			await expect(poHomeChannel.content.lastUserMessage.locator('.rcx-icon--name-key')).toBeVisible();
			await expect(poHomeChannel.content.getFileDescription).toHaveText('any_description');
			await expect(poHomeChannel.content.getLastMessageByFileName(updatedFileName)).toContainText(updatedFileName);
		});

		await test.step('edit the description', async () => {
			await poHomeChannel.content.openLastMessageMenu();
			await poHomeChannel.content.btnOptionEditMessage.click();

			await expect(poHomeChannel.composer.inputMessage).toHaveValue('any_description');

			await poHomeChannel.composer.inputMessage.fill('edited any_description');
			await page.keyboard.press('Enter');

			await expect(poHomeChannel.content.getFileDescription).toHaveText('edited any_description');
			await expect(poHomeChannel.content.lastUserMessage.getByRole('link').getByText(updatedFileName)).toBeVisible();
		});

		await test.step('delete the file from files list', async () => {
			await poHomeChannel.roomToolbar.openMoreOptions();
			await poHomeChannel.roomToolbar.menuItemFiles.click();
			await poHomeChannel.tabs.files.deleteFile(updatedFileName);

			await expect(poHomeChannel.tabs.files.getFileByName(updatedFileName)).toHaveCount(0);
			await expect(poHomeChannel.content.lastUserMessage.getByRole('link').getByText(updatedFileName)).not.toBeVisible();
		});
	});

	test('File with Unicode filename uploads and downloads correctly', async ({ page }) => {
		const UNICODE_FILE_NAME = 'Новый текстовый документ.txt';

		await test.step('upload file with Unicode filename', async () => {
			await poHomeChannel.content.sendFileMessage(TEST_FILE_TXT);
			await poHomeChannel.composer.getFileByName(TEST_FILE_TXT).click();
			await poHomeChannel.content.inputFileUploadName.fill(UNICODE_FILE_NAME);
			await poHomeChannel.content.btnUpdateFileUpload.click();
			await poHomeChannel.composer.btnSend.click();

			await expect(poHomeChannel.content.lastUserMessage.locator('.rcx-icon--name-key')).toBeVisible();
			await expect(poHomeChannel.content.getLastMessageByFileName(UNICODE_FILE_NAME)).toBeVisible();
		});

		await test.step('download the file and verify the Unicode filename is preserved', async () => {
			await poHomeChannel.roomToolbar.openMoreOptions();
			await poHomeChannel.roomToolbar.menuItemFiles.click();

			await expect(poHomeChannel.tabs.files.getFileByName(UNICODE_FILE_NAME)).toBeVisible();

			const [download] = await Promise.all([
				page.waitForEvent('download'),
				poHomeChannel.tabs.files.getFileByName(UNICODE_FILE_NAME).click(),
			]);

			expect(download.suggestedFilename()).toBe(UNICODE_FILE_NAME);
		});
	});

	test('File encryption with whitelisted and blacklisted media types', async ({ api }) => {
		await test.step('send a text file in channel', async () => {
			const updatedFileName = `edited_${TEST_FILE_TXT}`;
			await poHomeChannel.content.dragAndDropTxtFile();
			await poHomeChannel.composer.getFileByName(TEST_FILE_TXT).click();
			await poHomeChannel.content.inputFileUploadName.fill(updatedFileName);
			await poHomeChannel.content.btnUpdateFileUpload.click();
			await poHomeChannel.composer.btnSend.click();

			await expect(poHomeChannel.content.lastUserMessage.locator('.rcx-icon--name-key')).toBeVisible();
			await expect(poHomeChannel.content.getFileDescription).not.toBeVisible();
			await expect(poHomeChannel.content.getLastMessageByFileName(updatedFileName)).toContainText(updatedFileName);
		});

		await test.step('set whitelisted media type setting', async () => {
			await api.post('/settings/FileUpload_MediaTypeWhiteList', { value: 'text/plain' });
		});

		await test.step('send text file again with whitelist setting set', async () => {
			await poHomeChannel.content.dragAndDropTxtFile();
			await poHomeChannel.composer.inputMessage.fill('message 2');
			await poHomeChannel.composer.getFileByName(TEST_FILE_TXT).click();
			await poHomeChannel.content.inputFileUploadName.fill('any_file2.txt');
			await poHomeChannel.content.btnUpdateFileUpload.click();
			await poHomeChannel.composer.btnSend.click();

			await expect(poHomeChannel.content.lastUserMessage.locator('.rcx-icon--name-key')).toBeVisible();
			await expect(poHomeChannel.content.getFileDescription).toHaveText('message 2');
			await expect(poHomeChannel.content.getLastMessageByFileName('any_file2.txt')).toBeVisible();
		});

		await test.step('set blacklisted media type setting to not accept application/octet-stream media type', async () => {
			await api.post('/settings/FileUpload_MediaTypeBlackList', { value: 'application/octet-stream' });
		});

		await test.step('send text file again with blacklisted setting set, file upload should fail', async () => {
			await poHomeChannel.content.dragAndDropTxtFile();
			const composerFiles = await poHomeChannel.composer.getFileByName(TEST_FILE_TXT).all();

			await Promise.all(composerFiles.map((file) => expect(file).toHaveAttribute('readonly')));
			await expect(poHomeChannel.content.lastUserMessage.locator('.rcx-icon--name-key')).toBeVisible();
		});
	});

	test.describe('File encryption setting disabled', () => {
		test.beforeAll(async ({ api }) => {
			await api.post('/settings/E2E_Enable_Encrypt_Files', { value: false });
			await api.post('/settings/FileUpload_MediaTypeBlackList', { value: 'application/octet-stream' });
		});

		test.afterAll(async ({ api }) => {
			await api.post('/settings/E2E_Enable_Encrypt_Files', { value: originalSettings.E2E_Enable_Encrypt_Files });
			await api.post('/settings/FileUpload_MediaTypeBlackList', { value: 'image/svg+xml' });
		});

		test('Upload file without encryption in e2ee room', async () => {
			await test.step('send a test encrypted message to check e2ee is working', async () => {
				await poHomeChannel.content.sendMessage('This is an encrypted message.');

				await expect(poHomeChannel.content.lastUserMessageBody).toHaveText('This is an encrypted message.');
				await expect(poHomeChannel.content.lastUserMessage.locator('.rcx-icon--name-key')).toBeVisible();
			});

			await test.step('send a text file in channel, file should not be encrypted', async () => {
				await poHomeChannel.content.dragAndDropTxtFile();
				await poHomeChannel.composer.inputMessage.fill('any_description');
				await poHomeChannel.composer.getFileByName(TEST_FILE_TXT).click();
				await poHomeChannel.content.inputFileUploadName.fill('any_file1.txt');
				await poHomeChannel.content.btnUpdateFileUpload.click();
				await poHomeChannel.composer.btnSend.click();

				await expect(poHomeChannel.content.lastUserMessage.locator('.rcx-icon--name-key')).not.toBeVisible();
				await expect(poHomeChannel.content.getFileDescription).toHaveText('any_description');
				await expect(poHomeChannel.content.getLastMessageByFileName('any_file1.txt')).toContainText('any_file1.txt');
			});
		});
	});
});