Files
libsignal/node/ts/test/MessageBackupTest.ts

680 lines
20 KiB
TypeScript

//
// Copyright 2024 Signal Messenger, LLC.
// SPDX-License-Identifier: AGPL-3.0-only
//
import { assert } from 'chai';
import { Buffer } from 'node:buffer';
import * as fs from 'node:fs';
import * as path from 'node:path';
import { Readable } from 'node:stream';
import protobuf from 'protobufjs/minimal.js';
const { Reader } = protobuf;
import * as MessageBackup from '../MessageBackup.js';
import * as util from './util.js';
import { Aci } from '../Address.js';
import { Uint8ArrayInputStream, ErrorInputStream } from './ioutil.js';
import { hkdf, LogLevel } from '../index.js';
import {
AccountEntropyPool,
BackupForwardSecrecyToken,
BackupKey,
} from '../AccountKeys.js';
import { InputStream } from '../io.js';
import { assertArrayNotEquals } from './util.js';
util.initLogger(LogLevel.Trace);
describe('AccountEntropyPool', () => {
describe('isValid', () => {
assert.isFalse(AccountEntropyPool.isValid('invalid key'));
assert.isTrue(
AccountEntropyPool.isValid(
'0123456789abcdefghijklmnopqrstuvwxyz0123456789abcdefghijklmnopqr'
)
);
});
});
describe('MessageBackup', () => {
const accountEntropy = 'm'.repeat(64);
const aci = Aci.fromUuidBytes(new Uint8Array(16).fill(0x11));
const testKey = new MessageBackup.MessageBackupKey({ accountEntropy, aci });
const purpose = MessageBackup.Purpose.RemoteBackup;
describe('MessageBackupKey', () => {
it('provides its HMAC and AES keys', () => {
// Just check some basic expectations.
assert.equal(32, testKey.hmacKey.length);
assert.equal(32, testKey.aesKey.length);
assertArrayNotEquals(testKey.hmacKey, testKey.aesKey);
});
it('can derive from a forward secrecy token', () => {
const forwardSecrecyToken = new BackupForwardSecrecyToken(
new Uint8Array(32).fill(0xbf)
);
const keyFromAep = new MessageBackup.MessageBackupKey({
accountEntropy,
aci,
forwardSecrecyToken,
});
assertArrayNotEquals(keyFromAep.aesKey, testKey.aesKey);
const backupKey = new BackupKey(new Uint8Array(32).fill(0xba));
const backupId = new Uint8Array(16).fill(0x1d);
const keyFromBackupInfo = new MessageBackup.MessageBackupKey({
backupKey,
backupId,
forwardSecrecyToken,
});
assertArrayNotEquals(
keyFromBackupInfo.aesKey,
new MessageBackup.MessageBackupKey({ backupKey, backupId }).aesKey
);
});
});
describe('validate', () => {
it('successfully validates a minimal backup', async () => {
const input = fs.readFileSync(
path.join(
import.meta.dirname,
'../../ts/test/new_account.binproto.encrypted'
)
);
const outcome = await MessageBackup.validate(
testKey,
purpose,
() => new Uint8ArrayInputStream(input),
BigInt(input.length)
);
assert.equal(outcome.errorMessage, null);
// If we manually derive the test key's backup key and ID, we should get the same outcome.
const backupKey = hkdf(
32,
Buffer.from(accountEntropy, 'utf8'),
Buffer.from('20240801_SIGNAL_BACKUP_KEY', 'utf8'),
null
);
const backupId = hkdf(
16,
backupKey,
Buffer.concat([
Buffer.from('20241024_SIGNAL_BACKUP_ID:', 'utf8'),
aci.getServiceIdBinary(),
]),
null
);
const testKeyFromBackupId = new MessageBackup.MessageBackupKey({
backupKey: new BackupKey(backupKey),
backupId,
});
const outcome2 = await MessageBackup.validate(
testKeyFromBackupId,
purpose,
() => new Uint8ArrayInputStream(input),
BigInt(input.length)
);
assert.equal(outcome2.errorMessage, null);
});
it('throws on empty input', async () => {
try {
await MessageBackup.validate(
testKey,
purpose,
() => new Uint8ArrayInputStream(new Uint8Array()),
0n
);
assert.fail('did not throw');
} catch (e) {
assert.instanceOf(e, Error);
assert.equal(e.message, 'unexpected end of file');
}
});
it('throws a raised IO error', async () => {
try {
await MessageBackup.validate(
testKey,
purpose,
() => new ErrorInputStream(),
234n
);
assert.fail('did not throw');
} catch (e) {
assert.instanceOf(e, ErrorInputStream.Error);
}
});
it('closes the streams it creates', async () => {
let openCount = 0;
let closeCount = 0;
class CloseCountingInputStream extends InputStream {
/* eslint-disable @typescript-eslint/require-await */
async close(): Promise<void> {
closeCount += 1;
}
async read(_amount: number): Promise<Uint8Array> {
return Uint8Array.of();
}
async skip(amount: number): Promise<void> {
if (amount > 0) {
throw Error("can't skip in an empty stream");
}
}
/* eslint-enable @typescript-eslint/require-await */
}
await assert.isRejected(
MessageBackup.validate(
testKey,
purpose,
() => {
openCount += 1;
return new CloseCountingInputStream();
},
0n
)
);
assert.isAbove(openCount, 0, 'never opened?');
assert.equal(openCount, closeCount, 'failed to close all streams');
});
});
});
const exampleBackup = fs.readFileSync(
path.join(import.meta.dirname, '../../ts/test/canonical-backup.binproto')
);
function chunkLengthDelimited(binproto: Uint8Array): Uint8Array[] {
const r = Reader.create(binproto);
const chunks: Uint8Array[] = [];
while (r.pos < r.len) {
const headerStart = r.pos; // start of the varint length prefix
const length = r.uint32(); // implicitly advances to the start of the body
const bodyStart = r.pos; // now points to the start of the proto message
const end = bodyStart + length;
if (end > r.len) {
throw new Error('truncated length-delimited chunk');
}
// Include the varint header + body
chunks.push(binproto.subarray(headerStart, end));
r.pos = end;
}
return chunks;
}
function stripLengthPrefix(chunk: Uint8Array): Uint8Array {
const reader = Reader.create(chunk);
const length = reader.uint32();
const bodyStart = reader.pos;
const bodyEnd = bodyStart + length;
if (bodyEnd > reader.len) {
throw new Error('truncated length-delimited chunk');
}
if (bodyEnd !== reader.len) {
throw new Error('unexpected trailing data after chunk body');
}
return chunk.subarray(bodyStart, bodyEnd);
}
function insertLengthPrefix(chunk: Uint8Array): Uint8Array {
if (chunk.byteLength > 0x7f) {
throw new Error(
'not implemented: chunks with more than one varint byte of length'
);
}
return concatFrames([Uint8Array.of(chunk.byteLength), chunk]);
}
const exampleBackupChunks = chunkLengthDelimited(exampleBackup);
if (exampleBackupChunks.length === 0) {
throw new Error('expected at least one length-delimited chunk');
}
const [exampleBackupInfoChunk, ...exampleFrameChunks] = exampleBackupChunks;
const exampleBackupInfo = stripLengthPrefix(exampleBackupInfoChunk);
const exampleFrames = exampleFrameChunks;
function concatFrames(chunks: ReadonlyArray<Uint8Array>): Uint8Array {
if (chunks.length === 0) {
return new Uint8Array();
}
if (chunks.length === 1) {
return new Uint8Array(chunks[0]);
}
return Buffer.concat(chunks.map((chunk) => Buffer.from(chunk)));
}
// The following frame encodes a disappearing chat item. Regenerate with:
// % protoc rust/message-backup/src/proto/backup.proto \
// --encode signal.backup.Frame <<'PROTO' | base64
// chatItem: {
// chatId: 1
// authorId: 2
// dateSent: 3
// expiresInMs: 1
// }
// PROTO
const DISAPPEARING_CHAT_ITEM_FRAME = Uint8Array.from(
Buffer.from('IggIARACGAMoAQ==', 'base64')
);
// The following frame encodes a view-once chat item with revisions (not something that's normally
// allowed, but we want to test the recursive sanitization). Regenerate with:
// % protoc rust/message-backup/src/proto/backup.proto \
// --encode signal.backup.Frame <<'PROTO' | base64
// chatItem: {
// chatId: 10
// authorId: 11
// dateSent: 12
// viewOnceMessage: {
// attachment: {
// wasDownloaded: true
// }
// }
// revisions: [{
// chatId: 10
// authorId: 11
// dateSent: 9
// viewOnceMessage: {
// attachment: {
// wasDownloaded: true
// }
// }
// }]
// }
// PROTO
const VIEW_ONCE_CHAT_ITEM_FRAME = Uint8Array.from(
Buffer.from('IhwIChALGAwyDQgKEAsYCZIBBAoCGAGSAQQKAhgB', 'base64')
);
function createDisappearingChatItemFrame(): Uint8Array {
return insertLengthPrefix(DISAPPEARING_CHAT_ITEM_FRAME);
}
function createViewOnceChatItemFrame(): Uint8Array {
return insertLengthPrefix(VIEW_ONCE_CHAT_ITEM_FRAME);
}
describe('ComparableBackup', () => {
describe('exampleBackup', () => {
it('stringifies to the expected value', async () => {
const comparable = await MessageBackup.ComparableBackup.fromUnencrypted(
MessageBackup.Purpose.RemoteBackup,
new Uint8ArrayInputStream(exampleBackup),
BigInt(exampleBackup.length)
);
const expectedOutput = fs.readFileSync(
path.join(
import.meta.dirname,
'../../ts/test/canonical-backup.expected.json'
)
);
const output = comparable.comparableString();
assert.equal(output, new String(expectedOutput));
});
});
});
describe('BackupJsonExporter', () => {
it('streams JSON lines for a canonical backup', () => {
const backupInfo = exampleBackupInfo;
const frames = exampleFrames.slice();
const { exporter, chunk: initialChunk } =
MessageBackup.BackupJsonExporter.start(backupInfo);
// Stream the frames across multiple chunks to mirror the real exporter usage.
const chunkGroups = [frames.slice(0, 2), frames.slice(2)].filter(
(group) => group.length > 0
);
const exportedFrameResults = chunkGroups.flatMap((group) =>
exporter.exportFrames(concatFrames(group))
);
const exportedFrameLines = exportedFrameResults.map((result) => {
assert.isDefined(result.line, 'canonical backup should validate');
assert.isUndefined(
result.errorMessage,
'canonical backup should validate'
);
return result.line;
});
const finishResult = exporter.finish();
assert.isUndefined(
finishResult.errorMessage,
'canonical backup should validate'
);
const allLines = [initialChunk, ...exportedFrameLines];
assert.lengthOf(allLines, frames.length + 1);
for (const line of allLines) {
assert.isFalse(line.includes('\n'));
}
const parsedLines = allLines.map(
(line) => JSON.parse(line) as Record<string, unknown>
);
const [backupInfoJson, firstFrame, ...rest] = parsedLines;
assert.containsAllKeys(backupInfoJson, ['version', 'mediaRootBackupKey']);
assert.property(firstFrame, 'account');
const accountValue = firstFrame.account;
assert.isObject(accountValue);
const accountRecord = accountValue as Record<string, unknown>;
assert.containsAllKeys(accountRecord, [
'profileKey',
'username',
'accountSettings',
]);
assert.lengthOf(rest, frames.length - 1);
});
it('returns an empty chunk when no frames are provided', () => {
const backupInfo = exampleBackupInfo;
const { exporter } = MessageBackup.BackupJsonExporter.start(backupInfo, {
validate: false,
});
assert.deepEqual(exporter.exportFrames(new Uint8Array()), []);
const finishResult = exporter.finish();
assert.isUndefined(finishResult.errorMessage, 'ok');
});
it('filters disappearing messages from the output', () => {
const backupInfo = exampleBackupInfo;
const { exporter } = MessageBackup.BackupJsonExporter.start(backupInfo, {
validate: false,
});
const frame = createDisappearingChatItemFrame();
const results = exporter.exportFrames(frame);
assert.deepEqual(results, [{}]);
const finishResult = exporter.finish();
assert.isUndefined(finishResult.errorMessage, 'ok');
});
it('includes results without errors for otherwise legal filtered frames', () => {
const backupInfo = exampleBackupInfo;
const { exporter } = MessageBackup.BackupJsonExporter.start(backupInfo, {
validate: true,
});
const frame = createDisappearingChatItemFrame();
const results = exporter.exportFrames(frame);
assert.lengthOf(results, 1);
const [result] = results;
assert.isUndefined(result.line);
assert.isUndefined(result.errorMessage);
const finishResult = exporter.finish();
// We should see an error here because we don't include an AccountData frame.
assert.isNotEmpty(finishResult.errorMessage);
});
it('strips attachments from view-once messages', () => {
const backupInfo = exampleBackupInfo;
const { exporter } = MessageBackup.BackupJsonExporter.start(backupInfo, {
validate: false,
});
const frame = createViewOnceChatItemFrame();
const results = exporter.exportFrames(frame);
assert.lengthOf(results, 1);
const [result] = results;
assert.isDefined(result.line);
assert.isUndefined(result.errorMessage);
const json = JSON.parse(result.line) as Record<string, unknown>;
assert.deepStrictEqual(json, {
chatItem: {
chatId: '10',
authorId: '11',
dateSent: '12',
viewOnceMessage: {
// no "attachment"
},
revisions: [
{
chatId: '10',
authorId: '11',
dateSent: '9',
viewOnceMessage: {
// no "attachment"
},
},
],
},
});
const finishResult = exporter.finish();
assert.isUndefined(finishResult.errorMessage, 'ok');
});
it('filters disappearing messages from the output', () => {
const backupInfo = exampleBackupInfo;
const { exporter } = MessageBackup.BackupJsonExporter.start(backupInfo, {
validate: false,
});
const frame = createDisappearingChatItemFrame();
const results = exporter.exportFrames(frame);
assert.deepEqual(results, [{}]);
const finishResult = exporter.finish();
assert.isUndefined(finishResult.errorMessage, 'ok');
});
it('sanitizes frames before validation to avoid validation errors', () => {
const backupInfo = exampleBackupInfo;
const { exporter } = MessageBackup.BackupJsonExporter.start(backupInfo, {
validate: true,
});
const frame = createDisappearingChatItemFrame();
const results = exporter.exportFrames(frame);
assert.lengthOf(results, 1);
const [result] = results;
assert.isUndefined(result.line);
assert.isUndefined(result.errorMessage);
const finishResult = exporter.finish();
assert.isDefined(finishResult.errorMessage);
});
it('strips attachments from view-once messages', () => {
const backupInfo = exampleBackupInfo;
const { exporter } = MessageBackup.BackupJsonExporter.start(backupInfo, {
validate: false,
});
const frame = createViewOnceChatItemFrame();
const results = exporter.exportFrames(frame);
assert.lengthOf(results, 1);
const [result] = results;
assert.isDefined(result.line);
assert.isUndefined(result.errorMessage);
const json = JSON.parse(result.line) as Record<string, unknown>;
assert.deepStrictEqual(json, {
chatItem: {
chatId: '10',
authorId: '11',
dateSent: '12',
viewOnceMessage: {
// no "attachment"
},
revisions: [
{
chatId: '10',
authorId: '11',
dateSent: '9',
viewOnceMessage: {
// no "attachment"
},
},
],
},
});
const finishResult = exporter.finish();
assert.isUndefined(finishResult.errorMessage, 'ok');
});
it('validates frames when requested', () => {
const backupInfo = exampleBackupInfo;
const frames = exampleFrames.slice();
const { exporter } = MessageBackup.BackupJsonExporter.start(backupInfo, {
validate: true,
});
const groupedFrames = [frames.slice(0, 1), frames.slice(1)];
for (const group of groupedFrames) {
if (group.length === 0) {
continue;
}
const results = exporter.exportFrames(concatFrames(group));
for (const result of results) {
assert.isDefined(result.line);
assert.isUndefined(result.errorMessage);
}
}
const finishResult = exporter.finish();
assert.isUndefined(finishResult.errorMessage);
});
it('throws when validation fails', () => {
const backupInfo = exampleBackupInfo;
const frames = exampleFrames.slice();
const { exporter, chunk } = MessageBackup.BackupJsonExporter.start(
backupInfo,
{
validate: true,
}
);
// baseline chunk should still be produced
assert.isAbove(chunk.length, 0);
assert.isTrue(chunk[0].startsWith('{'));
const missingAccountChunk = concatFrames(frames.slice(1));
exporter.exportFrames(missingAccountChunk);
const finishResult = exporter.finish();
assert.isNotEmpty(finishResult.errorMessage);
});
it('can skip validation when explicitly disabled', () => {
const backupInfo = exampleBackupInfo;
const frames = exampleFrames.slice();
const { exporter } = MessageBackup.BackupJsonExporter.start(backupInfo, {
validate: false,
});
const missingAccountChunk = concatFrames(frames.slice(1));
const results = exporter.exportFrames(missingAccountChunk);
for (const result of results) {
assert.isUndefined(result.errorMessage);
}
const finishResult = exporter.finish();
assert.isUndefined(finishResult.errorMessage);
});
it('still rejects malformed data even when validation is disabled', () => {
const backupInfo = exampleBackupInfo;
const { exporter } = MessageBackup.BackupJsonExporter.start(backupInfo, {
validate: false,
});
assert.throws(() => exporter.exportFrames(Uint8Array.of(0x02, 0x01)));
});
});
describe('OnlineBackupValidator', () => {
it('can read frames from a valid file', () => {
// `Readable.read` normally returns `any`, because it supports settable encodings.
// Here we override that `read` member with one that always produces a Uint8Array,
// for more convenient use in the test. Note that this is unchecked.
type ReadableUsingUint8Array = Omit<Readable, 'read'> & {
read: (size: number) => Uint8Array;
};
const input: ReadableUsingUint8Array = new Readable();
input.push(exampleBackup);
input.push(null);
const backupInfoLength = input.read(1)[0];
assert.isBelow(backupInfoLength, 0x80, 'single-byte varint');
const backupInfo = input.read(backupInfoLength);
assert.equal(backupInfo.length, backupInfoLength, 'unexpected EOF');
const backup = new MessageBackup.OnlineBackupValidator(
backupInfo,
MessageBackup.Purpose.RemoteBackup
);
let frameLengthBuf;
while ((frameLengthBuf = input.read(1))) {
let frameLength = frameLengthBuf[0];
// Tiny varint parser, only supports two bytes.
if (frameLength >= 0x80) {
const secondByte = input.read(1)[0];
assert.isBelow(secondByte, 0x80, 'at most a two-byte varint');
frameLength -= 0x80;
frameLength |= secondByte << 7;
}
const frame = input.read(frameLength);
assert.equal(frame.length, frameLength, 'unexpected EOF');
backup.addFrame(frame);
}
backup.finalize();
});
it('rejects invalid BackupInfo', () => {
assert.throws(
() =>
new MessageBackup.OnlineBackupValidator(
Uint8Array.of(),
MessageBackup.Purpose.RemoteBackup
)
);
});
// The following payload was generated via protoscope.
// % protoscope -s | base64
// The fields are described by Backup.proto.
//
// 1: 1
// 2: 1731715200000
// 3: {`00112233445566778899aabbccddeeff00112233445566778899aabbccddeeff`}
const VALID_BACKUP_INFO: Buffer = Buffer.from(
'CAEQgOiTkrMyGiAAESIzRFVmd4iZqrvM3e7/ABEiM0RVZneImaq7zN3u/w==',
'base64'
);
it('rejects invalid Frames', () => {
const backup = new MessageBackup.OnlineBackupValidator(
VALID_BACKUP_INFO,
MessageBackup.Purpose.RemoteBackup
);
assert.throws(() => backup.addFrame(Uint8Array.of()));
});
it('rejects invalid backups on finalize', () => {
const backup = new MessageBackup.OnlineBackupValidator(
VALID_BACKUP_INFO,
MessageBackup.Purpose.RemoteBackup
);
assert.throws(() => backup.finalize());
});
});