@jeongsu816/matrix-bot-sdk 0.0.0-stage → 0.8.1

package/lib/e2ee/CryptoClient.d.ts

@@ -0,0 +1,163 @@
+import { MatrixClient } from "../MatrixClient";
+import { IMegolmEncrypted, IOlmEncrypted, IToDeviceMessage, OTKAlgorithm, OTKCounts, Signatures } from "../models/Crypto";
+import { EncryptedRoomEvent } from "../models/events/EncryptedRoomEvent";
+import { RoomEvent } from "../models/events/RoomEvent";
+import { EncryptedFile } from "../models/events/MessageEvent";
+import { UIACallback } from "./RustEngine";
+import { EnsureCrossSigningOptions, EnsureCrossSigningResult, EnsureSecretStorageResult } from "./CrossSigningBootstrap";
+/**
+ * Manages encryption for a MatrixClient. Get an instance from a MatrixClient directly
+ * rather than creating one manually.
+ * @category Encryption
+ */
+export declare class CryptoClient {
+    private client;
+    private ready;
+    private deviceId;
+    private deviceEd25519;
+    private deviceCurve25519;
+    private roomTracker;
+    private engine;
+    constructor(client: MatrixClient);
+    private get storage();
+    /**
+     * The device ID for the MatrixClient.
+     */
+    get clientDeviceId(): string;
+    /**
+     * The device's Ed25519 identity
+     */
+    get clientDeviceEd25519(): string;
+    /**
+     * Whether or not the crypto client is ready to be used. If not ready, prepare() should be called.
+     * @see prepare
+     */
+    get isReady(): boolean;
+    /**
+     * Prepares the crypto client for usage.
+     * @param {string[]} roomIds The room IDs the MatrixClient is joined to.
+     */
+    prepare(roomIds: string[]): Promise<void>;
+    /**
+     * Handles a room event.
+     * @internal
+     * @param roomId The room ID.
+     * @param event The event.
+     */
+    onRoomEvent(roomId: string, event: any): Promise<void>;
+    /**
+     * Handles a room join.
+     * @internal
+     * @param roomId The room ID.
+     */
+    onRoomJoin(roomId: string): Promise<void>;
+    /**
+     * Checks if a room is encrypted.
+     * @param {string} roomId The room ID to check.
+     * @returns {Promise<boolean>} Resolves to true if encrypted, false otherwise.
+     */
+    isRoomEncrypted(roomId: string): Promise<boolean>;
+    /**
+     * Updates the client's sync-related data.
+     * @param {Array.<IToDeviceMessage<IOlmEncrypted>>} toDeviceMessages The to-device messages received.
+     * @param {OTKCounts} otkCounts The current OTK counts.
+     * @param {OTKAlgorithm[]} unusedFallbackKeyAlgs The unused fallback key algorithms.
+     * @param {string[]} changedDeviceLists The user IDs which had device list changes.
+     * @param {string[]} leftDeviceLists The user IDs which the server believes we no longer need to track.
+     * @returns {Promise<void>} Resolves when complete.
+     */
+    updateSyncData(toDeviceMessages: IToDeviceMessage<IOlmEncrypted>[], otkCounts: OTKCounts, unusedFallbackKeyAlgs: OTKAlgorithm[], changedDeviceLists: string[], leftDeviceLists: string[]): Promise<void>;
+    /**
+     * Signs an object using the device keys.
+     * @param {object} obj The object to sign.
+     * @returns {Promise<Signatures>} The signatures for the object.
+     */
+    sign(obj: object): Promise<Signatures>;
+    /**
+     * Encrypts the details of a room event, returning an encrypted payload to be sent in an
+     * `m.room.encrypted` event to the room. If needed, this function will send decryption keys
+     * to the appropriate devices in the room (this happens when the Megolm session rotates or
+     * gets created).
+     * @param {string} roomId The room ID to encrypt within. If the room is not encrypted, an
+     * error is thrown.
+     * @param {string} eventType The event type being encrypted.
+     * @param {any} content The event content being encrypted.
+     * @returns {Promise<IMegolmEncrypted>} Resolves to the encrypted content for an `m.room.encrypted` event.
+     */
+    encryptRoomEvent(roomId: string, eventType: string, content: any): Promise<IMegolmEncrypted>;
+    /**
+     * Decrypts a room event. Currently only supports Megolm-encrypted events (default for this SDK).
+     * @param {EncryptedRoomEvent} event The encrypted event.
+     * @param {string} roomId The room ID where the event was sent.
+     * @returns {Promise<RoomEvent<unknown>>} Resolves to a decrypted room event, or rejects/throws with
+     * an error if the event is undecryptable.
+     */
+    decryptRoomEvent(event: EncryptedRoomEvent, roomId: string): Promise<RoomEvent<unknown>>;
+    /**
+     * Encrypts a file for uploading in a room, returning the encrypted data and information
+     * to include in a message event (except media URL) for sending.
+     * @param {Buffer} file The file to encrypt.
+     * @returns {{buffer: Buffer, file: Omit<EncryptedFile, "url">}} Resolves to the encrypted
+     * contents and file information.
+     */
+    encryptMedia(file: Buffer): Promise<{
+        buffer: Buffer;
+        file: Omit<EncryptedFile, "url">;
+    }>;
+    /**
+     * Decrypts a previously-uploaded encrypted file, validating the fields along the way.
+     * @param {EncryptedFile} file The file to decrypt.
+     * @returns {Promise<Buffer>} Resolves to the decrypted file contents.
+     */
+    decryptMedia(file: EncryptedFile): Promise<Buffer>;
+    /**
+     * Creates and uploads a cross-signing identity, then signs this device with it.
+     * @param {UIACallback} uiaCallback Answers the UIA challenge for the key upload.
+     * @param {boolean} reset Whether to replace an existing local identity.
+     */
+    bootstrapCrossSigning(uiaCallback: UIACallback, reset?: boolean): Promise<void>;
+    /**
+     * Sets up secret storage (4S) from a passphrase and stores the cross-signing
+     * keys in it. Requires the cross-signing private keys to be available locally.
+     * @param {string} passphrase The secret storage passphrase.
+     * @param opts Whether to also set up server-side key backup, and whether to reset.
+     */
+    bootstrapSecretStorageFromPassphrase(passphrase: string, opts?: {
+        withKeyBackup?: boolean;
+        reset?: boolean;
+    }): Promise<void>;
+    /**
+     * Restores the cross-signing keys from secret storage, e.g. after losing the
+     * crypto store, without invalidating other devices' trust.
+     * @param {string} passphrase The secret storage passphrase.
+     */
+    restoreSecretsFromSecretStorage(passphrase: string): Promise<void>;
+    /**
+     * Whether this device is signed by the account's self-signing key.
+     */
+    isOwnDeviceCrossSigned(): Promise<boolean>;
+    /**
+     * Whether the account has a default secret storage key.
+     */
+    hasSecretStorage(): Promise<boolean>;
+    /**
+     * Makes sure this device is cross-signed. In order: does nothing if it already
+     * is; restores the keys from secret storage if a passphrase is given and the
+     * account has secret storage; otherwise creates a new identity (replacing the
+     * account's existing one) if a UIA callback is given. Errors are thrown.
+     * @param {EnsureCrossSigningOptions} opts Credentials for restoring or bootstrapping.
+     * @returns {Promise<EnsureCrossSigningResult>} What was done.
+     */
+    ensureCrossSigning(opts?: EnsureCrossSigningOptions): Promise<EnsureCrossSigningResult>;
+    /**
+     * Sets up secret storage from a passphrase unless the account already has it.
+     * Call after {@link ensureCrossSigning}, since the cross-signing private keys
+     * must be available locally to be stored.
+     * @param {string} passphrase The secret storage passphrase.
+     * @param opts Whether to also set up server-side key backup (default true).
+     * @returns {Promise<EnsureSecretStorageResult>} What was done.
+     */
+    ensureSecretStorage(passphrase: string, opts?: {
+        withKeyBackup?: boolean;
+    }): Promise<EnsureSecretStorageResult>;
+}

package/lib/e2ee/CryptoClient.js

@@ -0,0 +1,382 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CryptoClient = void 0;
+const matrix_sdk_crypto_nodejs_1 = require("@matrix-org/matrix-sdk-crypto-nodejs");
+const LogService_1 = require("../logging/LogService");
+const decorators_1 = require("./decorators");
+const RoomTracker_1 = require("./RoomTracker");
+const EncryptedRoomEvent_1 = require("../models/events/EncryptedRoomEvent");
+const RoomEvent_1 = require("../models/events/RoomEvent");
+const RustEngine_1 = require("./RustEngine");
+const CrossSigningBootstrap_1 = require("./CrossSigningBootstrap");
+const MembershipEvent_1 = require("../models/events/MembershipEvent");
+/**
+ * Manages encryption for a MatrixClient. Get an instance from a MatrixClient directly
+ * rather than creating one manually.
+ * @category Encryption
+ */
+class CryptoClient {
+    constructor(client) {
+        this.client = client;
+        this.ready = false;
+        this.roomTracker = new RoomTracker_1.RoomTracker(this.client);
+    }
+    get storage() {
+        return this.client.cryptoStore;
+    }
+    /**
+     * The device ID for the MatrixClient.
+     */
+    get clientDeviceId() {
+        return this.deviceId;
+    }
+    /**
+     * The device's Ed25519 identity
+     */
+    get clientDeviceEd25519() {
+        return this.deviceEd25519;
+    }
+    /**
+     * Whether or not the crypto client is ready to be used. If not ready, prepare() should be called.
+     * @see prepare
+     */
+    get isReady() {
+        return this.ready;
+    }
+    /**
+     * Prepares the crypto client for usage.
+     * @param {string[]} roomIds The room IDs the MatrixClient is joined to.
+     */
+    async prepare(roomIds) {
+        await this.roomTracker.prepare(roomIds);
+        if (this.ready)
+            return; // stop re-preparing here
+        const storedDeviceId = await this.client.cryptoStore.getDeviceId();
+        if (storedDeviceId) {
+            this.deviceId = storedDeviceId;
+        }
+        else {
+            const deviceId = (await this.client.getWhoAmI())['device_id'];
+            if (!deviceId) {
+                throw new Error("Encryption not possible: server not revealing device ID");
+            }
+            this.deviceId = deviceId;
+            await this.client.cryptoStore.setDeviceId(this.deviceId);
+        }
+        LogService_1.LogService.info("CryptoClient", "Starting with device ID:", this.deviceId); // info so all bots know for debugging
+        const machine = await matrix_sdk_crypto_nodejs_1.OlmMachine.initialize(new matrix_sdk_crypto_nodejs_1.UserId(await this.client.getUserId()), new matrix_sdk_crypto_nodejs_1.DeviceId(this.deviceId), this.storage.storagePath, "", this.storage.storageType);
+        this.engine = new RustEngine_1.RustEngine(machine, this.client);
+        await this.engine.run();
+        const identity = this.engine.machine.identityKeys;
+        this.deviceCurve25519 = identity.curve25519.toBase64();
+        this.deviceEd25519 = identity.ed25519.toBase64();
+        LogService_1.LogService.debug("CryptoClient", "Running with device Ed25519 identity:", this.deviceEd25519); // info so all bots know for debugging
+        this.ready = true;
+    }
+    /**
+     * Handles a room event.
+     * @internal
+     * @param roomId The room ID.
+     * @param event The event.
+     */
+    async onRoomEvent(roomId, event) {
+        await this.roomTracker.onRoomEvent(roomId, event);
+        if (typeof event['state_key'] !== 'string')
+            return;
+        if (event['type'] === 'm.room.member') {
+            const membership = new MembershipEvent_1.MembershipEvent(event);
+            if (membership.effectiveMembership !== 'join' && membership.effectiveMembership !== 'invite')
+                return;
+            await this.engine.addTrackedUsers([membership.membershipFor]);
+        }
+        else if (event['type'] === 'm.room.encryption') {
+            const members = await this.client.getRoomMembers(roomId, null, ['join', 'invite']);
+            await this.engine.addTrackedUsers(members.map(e => e.membershipFor));
+        }
+    }
+    /**
+     * Handles a room join.
+     * @internal
+     * @param roomId The room ID.
+     */
+    async onRoomJoin(roomId) {
+        await this.roomTracker.onRoomJoin(roomId);
+        if (await this.isRoomEncrypted(roomId)) {
+            const members = await this.client.getRoomMembers(roomId, null, ['join', 'invite']);
+            await this.engine.addTrackedUsers(members.map(e => e.membershipFor));
+        }
+    }
+    /**
+     * Checks if a room is encrypted.
+     * @param {string} roomId The room ID to check.
+     * @returns {Promise<boolean>} Resolves to true if encrypted, false otherwise.
+     */
+    async isRoomEncrypted(roomId) {
+        const config = await this.roomTracker.getRoomCryptoConfig(roomId);
+        return !!config?.algorithm;
+    }
+    /**
+     * Updates the client's sync-related data.
+     * @param {Array.<IToDeviceMessage<IOlmEncrypted>>} toDeviceMessages The to-device messages received.
+     * @param {OTKCounts} otkCounts The current OTK counts.
+     * @param {OTKAlgorithm[]} unusedFallbackKeyAlgs The unused fallback key algorithms.
+     * @param {string[]} changedDeviceLists The user IDs which had device list changes.
+     * @param {string[]} leftDeviceLists The user IDs which the server believes we no longer need to track.
+     * @returns {Promise<void>} Resolves when complete.
+     */
+    async updateSyncData(toDeviceMessages, otkCounts, unusedFallbackKeyAlgs, changedDeviceLists, leftDeviceLists) {
+        const deviceMessages = JSON.stringify(toDeviceMessages);
+        const deviceLists = new matrix_sdk_crypto_nodejs_1.DeviceLists(changedDeviceLists.map(u => new matrix_sdk_crypto_nodejs_1.UserId(u)), leftDeviceLists.map(u => new matrix_sdk_crypto_nodejs_1.UserId(u)));
+        await this.engine.lock.acquire(RustEngine_1.SYNC_LOCK_NAME, async () => {
+            const syncResp = await this.engine.machine.receiveSyncChanges(deviceMessages, deviceLists, otkCounts, unusedFallbackKeyAlgs);
+            const decryptedToDeviceMessages = JSON.parse(syncResp);
+            if (Array.isArray(decryptedToDeviceMessages)) {
+                for (const msg of decryptedToDeviceMessages) {
+                    this.client.emit("to_device.decrypted", msg);
+                }
+            }
+            await this.engine.run();
+        });
+    }
+    /**
+     * Signs an object using the device keys.
+     * @param {object} obj The object to sign.
+     * @returns {Promise<Signatures>} The signatures for the object.
+     */
+    async sign(obj) {
+        obj = JSON.parse(JSON.stringify(obj));
+        const existingSignatures = obj['signatures'] || {};
+        delete obj['signatures'];
+        delete obj['unsigned'];
+        const container = await this.engine.machine.sign(JSON.stringify(obj));
+        const userSignature = container.get(new matrix_sdk_crypto_nodejs_1.UserId(await this.client.getUserId()));
+        const sig = {
+            [await this.client.getUserId()]: {},
+        };
+        for (const [key, maybeSignature] of Object.entries(userSignature)) {
+            if (maybeSignature.isValid) {
+                sig[await this.client.getUserId()][key] = maybeSignature.signature.toBase64();
+            }
+        }
+        return {
+            ...sig,
+            ...existingSignatures,
+        };
+    }
+    /**
+     * Encrypts the details of a room event, returning an encrypted payload to be sent in an
+     * `m.room.encrypted` event to the room. If needed, this function will send decryption keys
+     * to the appropriate devices in the room (this happens when the Megolm session rotates or
+     * gets created).
+     * @param {string} roomId The room ID to encrypt within. If the room is not encrypted, an
+     * error is thrown.
+     * @param {string} eventType The event type being encrypted.
+     * @param {any} content The event content being encrypted.
+     * @returns {Promise<IMegolmEncrypted>} Resolves to the encrypted content for an `m.room.encrypted` event.
+     */
+    async encryptRoomEvent(roomId, eventType, content) {
+        if (!(await this.isRoomEncrypted(roomId))) {
+            throw new Error("Room is not encrypted");
+        }
+        await this.engine.prepareEncrypt(roomId, await this.roomTracker.getRoomCryptoConfig(roomId));
+        const encrypted = JSON.parse(await this.engine.machine.encryptRoomEvent(new matrix_sdk_crypto_nodejs_1.RoomId(roomId), eventType, JSON.stringify(content)));
+        await this.engine.run();
+        return encrypted;
+    }
+    /**
+     * Decrypts a room event. Currently only supports Megolm-encrypted events (default for this SDK).
+     * @param {EncryptedRoomEvent} event The encrypted event.
+     * @param {string} roomId The room ID where the event was sent.
+     * @returns {Promise<RoomEvent<unknown>>} Resolves to a decrypted room event, or rejects/throws with
+     * an error if the event is undecryptable.
+     */
+    async decryptRoomEvent(event, roomId) {
+        const decrypted = await this.engine.machine.decryptRoomEvent(JSON.stringify(event.raw), new matrix_sdk_crypto_nodejs_1.RoomId(roomId));
+        const clearEvent = JSON.parse(decrypted.event);
+        return new RoomEvent_1.RoomEvent({
+            ...event.raw,
+            type: clearEvent.type || "io.t2bot.unknown",
+            content: (typeof (clearEvent.content) === 'object') ? clearEvent.content : {},
+        });
+    }
+    /**
+     * Encrypts a file for uploading in a room, returning the encrypted data and information
+     * to include in a message event (except media URL) for sending.
+     * @param {Buffer} file The file to encrypt.
+     * @returns {{buffer: Buffer, file: Omit<EncryptedFile, "url">}} Resolves to the encrypted
+     * contents and file information.
+     */
+    async encryptMedia(file) {
+        const encrypted = matrix_sdk_crypto_nodejs_1.Attachment.encrypt(file);
+        const info = JSON.parse(encrypted.mediaEncryptionInfo);
+        return {
+            buffer: Buffer.from(encrypted.encryptedData),
+            file: info,
+        };
+    }
+    /**
+     * Decrypts a previously-uploaded encrypted file, validating the fields along the way.
+     * @param {EncryptedFile} file The file to decrypt.
+     * @returns {Promise<Buffer>} Resolves to the decrypted file contents.
+     */
+    async decryptMedia(file) {
+        const contents = (await this.client.downloadContent(file.url)).data;
+        const encrypted = new matrix_sdk_crypto_nodejs_1.EncryptedAttachment(contents, JSON.stringify(file));
+        const decrypted = matrix_sdk_crypto_nodejs_1.Attachment.decrypt(encrypted);
+        return Buffer.from(decrypted);
+    }
+    /**
+     * Creates and uploads a cross-signing identity, then signs this device with it.
+     * @param {UIACallback} uiaCallback Answers the UIA challenge for the key upload.
+     * @param {boolean} reset Whether to replace an existing local identity.
+     */
+    async bootstrapCrossSigning(uiaCallback, reset = false) {
+        return this.engine.bootstrapCrossSigning(uiaCallback, reset);
+    }
+    /**
+     * Sets up secret storage (4S) from a passphrase and stores the cross-signing
+     * keys in it. Requires the cross-signing private keys to be available locally.
+     * @param {string} passphrase The secret storage passphrase.
+     * @param opts Whether to also set up server-side key backup, and whether to reset.
+     */
+    async bootstrapSecretStorageFromPassphrase(passphrase, opts = {}) {
+        return this.engine.bootstrapSecretStorageFromPassphrase(passphrase, opts);
+    }
+    /**
+     * Restores the cross-signing keys from secret storage, e.g. after losing the
+     * crypto store, without invalidating other devices' trust.
+     * @param {string} passphrase The secret storage passphrase.
+     */
+    async restoreSecretsFromSecretStorage(passphrase) {
+        return this.engine.restoreSecretsFromSecretStorage(passphrase);
+    }
+    /**
+     * Whether this device is signed by the account's self-signing key.
+     */
+    async isOwnDeviceCrossSigned() {
+        return (0, CrossSigningBootstrap_1.isOwnDeviceCrossSigned)(this.client, this.deviceId);
+    }
+    /**
+     * Whether the account has a default secret storage key.
+     */
+    async hasSecretStorage() {
+        return (0, CrossSigningBootstrap_1.hasSecretStorage)(this.client);
+    }
+    /**
+     * Makes sure this device is cross-signed. In order: does nothing if it already
+     * is; restores the keys from secret storage if a passphrase is given and the
+     * account has secret storage; otherwise creates a new identity (replacing the
+     * account's existing one) if a UIA callback is given. Errors are thrown.
+     * @param {EnsureCrossSigningOptions} opts Credentials for restoring or bootstrapping.
+     * @returns {Promise<EnsureCrossSigningResult>} What was done.
+     */
+    async ensureCrossSigning(opts = {}) {
+        return (0, CrossSigningBootstrap_1.ensureCrossSigning)(this.client, this.engine, this.deviceId, opts);
+    }
+    /**
+     * Sets up secret storage from a passphrase unless the account already has it.
+     * Call after {@link ensureCrossSigning}, since the cross-signing private keys
+     * must be available locally to be stored.
+     * @param {string} passphrase The secret storage passphrase.
+     * @param opts Whether to also set up server-side key backup (default true).
+     * @returns {Promise<EnsureSecretStorageResult>} What was done.
+     */
+    async ensureSecretStorage(passphrase, opts = {}) {
+        return (0, CrossSigningBootstrap_1.ensureSecretStorage)(this.client, this.engine, passphrase, opts);
+    }
+}
+exports.CryptoClient = CryptoClient;
+__decorate([
+    (0, decorators_1.requiresReady)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", Promise)
+], CryptoClient.prototype, "isRoomEncrypted", null);
+__decorate([
+    (0, decorators_1.requiresReady)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Array, Object, Array, Array, Array]),
+    __metadata("design:returntype", Promise)
+], CryptoClient.prototype, "updateSyncData", null);
+__decorate([
+    (0, decorators_1.requiresReady)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], CryptoClient.prototype, "sign", null);
+__decorate([
+    (0, decorators_1.requiresReady)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, String, Object]),
+    __metadata("design:returntype", Promise)
+], CryptoClient.prototype, "encryptRoomEvent", null);
+__decorate([
+    (0, decorators_1.requiresReady)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [EncryptedRoomEvent_1.EncryptedRoomEvent, String]),
+    __metadata("design:returntype", Promise)
+], CryptoClient.prototype, "decryptRoomEvent", null);
+__decorate([
+    (0, decorators_1.requiresReady)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Buffer]),
+    __metadata("design:returntype", Promise)
+], CryptoClient.prototype, "encryptMedia", null);
+__decorate([
+    (0, decorators_1.requiresReady)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], CryptoClient.prototype, "decryptMedia", null);
+__decorate([
+    (0, decorators_1.requiresReady)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Function, Object]),
+    __metadata("design:returntype", Promise)
+], CryptoClient.prototype, "bootstrapCrossSigning", null);
+__decorate([
+    (0, decorators_1.requiresReady)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object]),
+    __metadata("design:returntype", Promise)
+], CryptoClient.prototype, "bootstrapSecretStorageFromPassphrase", null);
+__decorate([
+    (0, decorators_1.requiresReady)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String]),
+    __metadata("design:returntype", Promise)
+], CryptoClient.prototype, "restoreSecretsFromSecretStorage", null);
+__decorate([
+    (0, decorators_1.requiresReady)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], CryptoClient.prototype, "isOwnDeviceCrossSigned", null);
+__decorate([
+    (0, decorators_1.requiresReady)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", []),
+    __metadata("design:returntype", Promise)
+], CryptoClient.prototype, "hasSecretStorage", null);
+__decorate([
+    (0, decorators_1.requiresReady)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [Object]),
+    __metadata("design:returntype", Promise)
+], CryptoClient.prototype, "ensureCrossSigning", null);
+__decorate([
+    (0, decorators_1.requiresReady)(),
+    __metadata("design:type", Function),
+    __metadata("design:paramtypes", [String, Object]),
+    __metadata("design:returntype", Promise)
+], CryptoClient.prototype, "ensureSecretStorage", null);
+//# sourceMappingURL=CryptoClient.js.map

package/lib/e2ee/CryptoClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CryptoClient.js","sourceRoot":"","sources":["../../src/e2ee/CryptoClient.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mFAQ8C;AAG9C,sDAAmD;AASnD,6CAA6C;AAC7C,+CAA4C;AAC5C,4EAAyE;AACzE,0DAAuD;AAGvD,6CAAuE;AACvE,mEAQiC;AACjC,sEAAmE;AAEnE;;;;GAIG;AACH,MAAa,YAAY;IAQrB,YAA2B,MAAoB;QAApB,WAAM,GAAN,MAAM,CAAc;QAPvC,UAAK,GAAG,KAAK,CAAC;QAQlB,IAAI,CAAC,WAAW,GAAG,IAAI,yBAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACpD,CAAC;IAED,IAAY,OAAO;QACf,OAAsC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC;IAClE,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACrB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACzB,CAAC;IAED;;OAEG;IACH,IAAW,mBAAmB;QAC1B,OAAO,IAAI,CAAC,aAAa,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,IAAW,OAAO;QACd,OAAO,IAAI,CAAC,KAAK,CAAC;IACtB,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,OAAO,CAAC,OAAiB;QAClC,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QAExC,IAAI,IAAI,CAAC,KAAK;YAAE,OAAO,CAAC,yBAAyB;QAEjD,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,EAAE,CAAC;QACnE,IAAI,cAAc,EAAE,CAAC;YACjB,IAAI,CAAC,QAAQ,GAAG,cAAc,CAAC;QACnC,CAAC;aAAM,CAAC;YACJ,MAAM,QAAQ,GAAG,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC;YAC9D,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;YAC/E,CAAC;YACD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;YACzB,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC7D,CAAC;QAED,uBAAU,CAAC,IAAI,CAAC,cAAc,EAAE,0BAA0B,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,sCAAsC;QAElH,MAAM,OAAO,GAAG,MAAM,qCAAU,CAAC,UAAU,CACvC,IAAI,iCAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,EACzC,IAAI,mCAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EAC3B,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,EAC5B,IAAI,CAAC,OAAO,CAAC,WAAW,CAC3B,CAAC;QACF,IAAI,CAAC,MAAM,GAAG,IAAI,uBAAU,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QACnD,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;QAExB,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC;QAClD,IAAI,CAAC,gBAAgB,GAAG,QAAQ,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;QACvD,IAAI,CAAC,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC;QAEjD,uBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,uCAAuC,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,sCAAsC;QAErI,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,WAAW,CAAC,MAAc,EAAE,KAAU;QAC/C,MAAM,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAClD,IAAI,OAAO,KAAK,CAAC,WAAW,CAAC,KAAK,QAAQ;YAAE,OAAO;QACnD,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,eAAe,EAAE,CAAC;YACpC,MAAM,UAAU,GAAG,IAAI,iCAAe,CAAC,KAAK,CAAC,CAAC;YAC9C,IAAI,UAAU,CAAC,mBAAmB,KAAK,MAAM,IAAI,UAAU,CAAC,mBAAmB,KAAK,QAAQ;gBAAE,OAAO;YACrG,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC;QAClE,CAAC;aAAM,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,mBAAmB,EAAE,CAAC;YAC/C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;YACnF,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;QACzE,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,UAAU,CAAC,MAAc;QAClC,MAAM,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QAC1C,IAAI,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;YACrC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;YACnF,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC;QACzE,CAAC;IACL,CAAC;IAED;;;;OAIG;IAEU,AAAN,KAAK,CAAC,eAAe,CAAC,MAAc;QACvC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;QAClE,OAAO,CAAC,CAAC,MAAM,EAAE,SAAS,CAAC;IAC/B,CAAC;IAED;;;;;;;;OAQG;IAEU,AAAN,KAAK,CAAC,cAAc,CACvB,gBAAmD,EACnD,SAAoB,EACpB,qBAAqC,EACrC,kBAA4B,EAC5B,eAAyB;QAEzB,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;QACxD,MAAM,WAAW,GAAG,IAAI,sCAAW,CAC/B,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,iCAAM,CAAC,CAAC,CAAC,CAAC,EAC1C,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,iCAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAE7C,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,2BAAc,EAAE,KAAK,IAAI,EAAE;YACtD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,kBAAkB,CAAC,cAAc,EAAE,WAAW,EAAE,SAAS,EAAE,qBAAqB,CAAC,CAAC;YAC7H,MAAM,yBAAyB,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACvD,IAAI,KAAK,CAAC,OAAO,CAAC,yBAAyB,CAAC,EAAE,CAAC;gBAC3C,KAAK,MAAM,GAAG,IAAI,yBAAyB,EAAE,CAAC;oBAC1C,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,qBAAqB,EAAE,GAAG,CAAC,CAAC;gBACjD,CAAC;YACL,CAAC;YAED,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;QAC5B,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IAEU,AAAN,KAAK,CAAC,IAAI,CAAC,GAAW;QACzB,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;QACtC,MAAM,kBAAkB,GAAG,GAAG,CAAC,YAAY,CAAC,IAAI,EAAE,CAAC;QAEnD,OAAO,GAAG,CAAC,YAAY,CAAC,CAAC;QACzB,OAAO,GAAG,CAAC,UAAU,CAAC,CAAC;QAEvB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;QACtE,MAAM,aAAa,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,iCAAM,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC;QAC/E,MAAM,GAAG,GAAe;YACpB,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,EAAE,EAAE;SACtC,CAAC;QACF,KAAK,MAAM,CAAC,GAAG,EAAE,cAAc,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,CAAC;YAChE,IAAI,cAAc,CAAC,OAAO,EAAE,CAAC;gBACzB,GAAG,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC;YAClF,CAAC;QACL,CAAC;QACD,OAAO;YACH,GAAG,GAAG;YACN,GAAG,kBAAkB;SACxB,CAAC;IACN,CAAC;IAED;;;;;;;;;;OAUG;IAEU,AAAN,KAAK,CAAC,gBAAgB,CAAC,MAAc,EAAE,SAAiB,EAAE,OAAY;QACzE,IAAI,CAAC,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;QAC7C,CAAC;QAED,MAAM,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,MAAM,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;QAE7F,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,iCAAM,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;QACjI,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;QACxB,OAAO,SAA6B,CAAC;IACzC,CAAC;IAED;;;;;;OAMG;IAEU,AAAN,KAAK,CAAC,gBAAgB,CAAC,KAAyB,EAAE,MAAc;QACnE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,IAAI,iCAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAC5G,MAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAE/C,OAAO,IAAI,qBAAS,CAAU;YAC1B,GAAG,KAAK,CAAC,GAAG;YACZ,IAAI,EAAE,UAAU,CAAC,IAAI,IAAI,kBAAkB;YAC3C,OAAO,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE;SAChF,CAAC,CAAC;IACP,CAAC;IAED;;;;;;OAMG;IAEU,AAAN,KAAK,CAAC,YAAY,CAAC,IAAY;QAClC,MAAM,SAAS,GAAG,qCAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC3C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;QACvD,OAAO;YACH,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC;YAC5C,IAAI,EAAE,IAAI;SACb,CAAC;IACN,CAAC;IAED;;;;OAIG;IAEU,AAAN,KAAK,CAAC,YAAY,CAAC,IAAmB;QACzC,MAAM,QAAQ,GAAG,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;QACpE,MAAM,SAAS,GAAG,IAAI,8CAAmB,CACrC,QAAQ,EACR,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CACvB,CAAC;QACF,MAAM,SAAS,GAAG,qCAAU,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAChD,OAAO,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAClC,CAAC;IAED;;;;OAIG;IAEU,AAAN,KAAK,CAAC,qBAAqB,CAAC,WAAwB,EAAE,KAAK,GAAG,KAAK;QACtE,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;IACjE,CAAC;IAED;;;;;OAKG;IAEU,AAAN,KAAK,CAAC,oCAAoC,CAAC,UAAkB,EAAE,OAAqD,EAAE;QACzH,OAAO,IAAI,CAAC,MAAM,CAAC,oCAAoC,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;IAC9E,CAAC;IAED;;;;OAIG;IAEU,AAAN,KAAK,CAAC,+BAA+B,CAAC,UAAkB;QAC3D,OAAO,IAAI,CAAC,MAAM,CAAC,+BAA+B,CAAC,UAAU,CAAC,CAAC;IACnE,CAAC;IAED;;OAEG;IAEU,AAAN,KAAK,CAAC,sBAAsB;QAC/B,OAAO,IAAA,8CAAsB,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IAEU,AAAN,KAAK,CAAC,gBAAgB;QACzB,OAAO,IAAA,wCAAgB,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAED;;;;;;;OAOG;IAEU,AAAN,KAAK,CAAC,kBAAkB,CAAC,OAAkC,EAAE;QAChE,OAAO,IAAA,0CAAkB,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC7E,CAAC;IAED;;;;;;;OAOG;IAEU,AAAN,KAAK,CAAC,mBAAmB,CAAC,UAAkB,EAAE,OAAoC,EAAE;QACvF,OAAO,IAAA,2CAAmB,EAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;IAC3E,CAAC;CACJ;AA9UD,oCA8UC;AAzNgB;IADZ,IAAA,0BAAa,GAAE;;;;mDAIf;AAYY;IADZ,IAAA,0BAAa,GAAE;;;;kDAwBf;AAQY;IADZ,IAAA,0BAAa,GAAE;;;;wCAsBf;AAcY;IADZ,IAAA,0BAAa,GAAE;;;;oDAWf;AAUY;IADZ,IAAA,0BAAa,GAAE;;qCACqB,uCAAkB;;oDAStD;AAUY;IADZ,IAAA,0BAAa,GAAE;;qCACgB,MAAM;;gDAOrC;AAQY;IADZ,IAAA,0BAAa,GAAE;;;;gDASf;AAQY;IADZ,IAAA,0BAAa,GAAE;;;;yDAGf;AASY;IADZ,IAAA,0BAAa,GAAE;;;;wEAGf;AAQY;IADZ,IAAA,0BAAa,GAAE;;;;mEAGf;AAMY;IADZ,IAAA,0BAAa,GAAE;;;;0DAGf;AAMY;IADZ,IAAA,0BAAa,GAAE;;;;oDAGf;AAWY;IADZ,IAAA,0BAAa,GAAE;;;;sDAGf;AAWY;IADZ,IAAA,0BAAa,GAAE;;;;uDAGf"}

package/lib/e2ee/ICryptoRoomInformation.d.ts

@@ -0,0 +1,8 @@
+import { EncryptionEventContent } from "../models/events/EncryptionEvent";
+/**
+ * Information about a room for the purposes of crypto.
+ * @category Encryption
+ */
+export interface ICryptoRoomInformation extends Partial<EncryptionEventContent> {
+    historyVisibility?: string;
+}

package/lib/e2ee/ICryptoRoomInformation.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ICryptoRoomInformation.js.map

package/lib/e2ee/ICryptoRoomInformation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ICryptoRoomInformation.js","sourceRoot":"","sources":["../../src/e2ee/ICryptoRoomInformation.ts"],"names":[],"mappings":""}

package/lib/e2ee/RoomTracker.d.ts

@@ -0,0 +1,41 @@
+import { MatrixClient } from "../MatrixClient";
+import { ICryptoRoomInformation } from "./ICryptoRoomInformation";
+/**
+ * Tracks room encryption status for a MatrixClient.
+ * @category Encryption
+ */
+export declare class RoomTracker {
+    private client;
+    constructor(client: MatrixClient);
+    /**
+     * Handles a room join
+     * @internal
+     * @param roomId The room ID.
+     */
+    onRoomJoin(roomId: string): Promise<void>;
+    /**
+     * Handles a room event.
+     * @internal
+     * @param roomId The room ID.
+     * @param event The event.
+     */
+    onRoomEvent(roomId: string, event: any): Promise<void>;
+    /**
+     * Prepares the room tracker to track the given rooms.
+     * @param {string[]} roomIds The room IDs to track. This should be the joined rooms set.
+     */
+    prepare(roomIds: string[]): Promise<void>;
+    /**
+     * Queues a room check for the tracker. If the room needs an update to the store, an
+     * update will be made.
+     * @param {string} roomId The room ID to check.
+     */
+    queueRoomCheck(roomId: string): Promise<void>;
+    /**
+     * Gets the room's crypto configuration, as known by the underlying store. If the room is
+     * not encrypted then this will return an empty object.
+     * @param {string} roomId The room ID to get the config for.
+     * @returns {Promise<ICryptoRoomInformation>} Resolves to the encryption config.
+     */
+    getRoomCryptoConfig(roomId: string): Promise<ICryptoRoomInformation>;
+}