@unwanted/matrix-sdk-mini 34.12.0 → 36.0.0

package/src/crypto/EncryptionSetup.ts

@@ -1,351 +0,0 @@
-/*
-Copyright 2021 The Matrix.org Foundation C.I.C.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-import { logger } from "../logger.ts";
-import { MatrixEvent } from "../models/event.ts";
-import { createCryptoStoreCacheCallbacks, ICacheCallbacks } from "./CrossSigning.ts";
-import { IndexedDBCryptoStore } from "./store/indexeddb-crypto-store.ts";
-import { Method, ClientPrefix } from "../http-api/index.ts";
-import { Crypto, ICryptoCallbacks } from "./index.ts";
-import { ClientEvent, ClientEventHandlerMap, CrossSigningKeys, ISignedKey, KeySignatures } from "../client.ts";
-import { IKeyBackupInfo } from "./keybackup.ts";
-import { TypedEventEmitter } from "../models/typed-event-emitter.ts";
-import { AccountDataClient, SecretStorageKeyDescription } from "../secret-storage.ts";
-import { BootstrapCrossSigningOpts, CrossSigningKeyInfo } from "../crypto-api/index.ts";
-
-interface ICrossSigningKeys {
-    authUpload: BootstrapCrossSigningOpts["authUploadDeviceSigningKeys"];
-    keys: Record<"master" | "self_signing" | "user_signing", CrossSigningKeyInfo>;
-}
-
-/**
- * Builds an EncryptionSetupOperation by calling any of the add.. methods.
- * Once done, `buildOperation()` can be called which allows to apply to operation.
- *
- * This is used as a helper by Crypto to keep track of all the network requests
- * and other side-effects of bootstrapping, so it can be applied in one go (and retried in the future)
- * Also keeps track of all the private keys created during bootstrapping, so we don't need to prompt for them
- * more than once.
- */
-export class EncryptionSetupBuilder {
-    public readonly accountDataClientAdapter: AccountDataClientAdapter;
-    public readonly crossSigningCallbacks: CrossSigningCallbacks;
-    public readonly ssssCryptoCallbacks: SSSSCryptoCallbacks;
-
-    private crossSigningKeys?: ICrossSigningKeys;
-    private keySignatures?: KeySignatures;
-    private keyBackupInfo?: IKeyBackupInfo;
-    private sessionBackupPrivateKey?: Uint8Array;
-
-    /**
-     * @param accountData - pre-existing account data, will only be read, not written.
-     * @param delegateCryptoCallbacks - crypto callbacks to delegate to if the key isn't in cache yet
-     */
-    public constructor(accountData: Map<string, MatrixEvent>, delegateCryptoCallbacks?: ICryptoCallbacks) {
-        this.accountDataClientAdapter = new AccountDataClientAdapter(accountData);
-        this.crossSigningCallbacks = new CrossSigningCallbacks();
-        this.ssssCryptoCallbacks = new SSSSCryptoCallbacks(delegateCryptoCallbacks);
-    }
-
-    /**
-     * Adds new cross-signing public keys
-     *
-     * @param authUpload - Function called to await an interactive auth
-     * flow when uploading device signing keys.
-     * Args:
-     *     A function that makes the request requiring auth. Receives
-     *     the auth data as an object. Can be called multiple times, first with
-     *     an empty authDict, to obtain the flows.
-     * @param keys - the new keys
-     */
-    public addCrossSigningKeys(authUpload: ICrossSigningKeys["authUpload"], keys: ICrossSigningKeys["keys"]): void {
-        this.crossSigningKeys = { authUpload, keys };
-    }
-
-    /**
-     * Adds the key backup info to be updated on the server
-     *
-     * Used either to create a new key backup, or add signatures
-     * from the new MSK.
-     *
-     * @param keyBackupInfo - as received from/sent to the server
-     */
-    public addSessionBackup(keyBackupInfo: IKeyBackupInfo): void {
-        this.keyBackupInfo = keyBackupInfo;
-    }
-
-    /**
-     * Adds the session backup private key to be updated in the local cache
-     *
-     * Used after fixing the format of the key
-     *
-     */
-    public addSessionBackupPrivateKeyToCache(privateKey: Uint8Array): void {
-        this.sessionBackupPrivateKey = privateKey;
-    }
-
-    /**
-     * Add signatures from a given user and device/x-sign key
-     * Used to sign the new cross-signing key with the device key
-     *
-     */
-    public addKeySignature(userId: string, deviceId: string, signature: ISignedKey): void {
-        if (!this.keySignatures) {
-            this.keySignatures = {};
-        }
-        const userSignatures = this.keySignatures[userId] || {};
-        this.keySignatures[userId] = userSignatures;
-        userSignatures[deviceId] = signature;
-    }
-
-    public async setAccountData(type: string, content: object): Promise<void> {
-        await this.accountDataClientAdapter.setAccountData(type, content);
-    }
-
-    /**
-     * builds the operation containing all the parts that have been added to the builder
-     */
-    public buildOperation(): EncryptionSetupOperation {
-        const accountData = this.accountDataClientAdapter.values;
-        return new EncryptionSetupOperation(accountData, this.crossSigningKeys, this.keyBackupInfo, this.keySignatures);
-    }
-
-    /**
-     * Stores the created keys locally.
-     *
-     * This does not yet store the operation in a way that it can be restored,
-     * but that is the idea in the future.
-     */
-    public async persist(crypto: Crypto): Promise<void> {
-        // store private keys in cache
-        if (this.crossSigningKeys) {
-            const cacheCallbacks = createCryptoStoreCacheCallbacks(crypto.cryptoStore, crypto.olmDevice);
-            for (const type of ["master", "self_signing", "user_signing"]) {
-                logger.log(`Cache ${type} cross-signing private key locally`);
-                const privateKey = this.crossSigningCallbacks.privateKeys.get(type);
-                await cacheCallbacks.storeCrossSigningKeyCache?.(type, privateKey);
-            }
-            // store own cross-sign pubkeys as trusted
-            await crypto.cryptoStore.doTxn("readwrite", [IndexedDBCryptoStore.STORE_ACCOUNT], (txn) => {
-                crypto.cryptoStore.storeCrossSigningKeys(txn, this.crossSigningKeys!.keys);
-            });
-        }
-        // store session backup key in cache
-        if (this.sessionBackupPrivateKey) {
-            await crypto.storeSessionBackupPrivateKey(this.sessionBackupPrivateKey);
-        }
-    }
-}
-
-/**
- * Can be created from EncryptionSetupBuilder, or
- * (in a follow-up PR, not implemented yet) restored from storage, to retry.
- *
- * It does not have knowledge of any private keys, unlike the builder.
- */
-export class EncryptionSetupOperation {
-    /**
-     */
-    public constructor(
-        private readonly accountData: Map<string, object>,
-        private readonly crossSigningKeys?: ICrossSigningKeys,
-        private readonly keyBackupInfo?: IKeyBackupInfo,
-        private readonly keySignatures?: KeySignatures,
-    ) {}
-
-    /**
-     * Runs the (remaining part of, in the future) operation by sending requests to the server.
-     */
-    public async apply(crypto: Crypto): Promise<void> {
-        const baseApis = crypto.baseApis;
-        // upload cross-signing keys
-        if (this.crossSigningKeys) {
-            const keys: Partial<CrossSigningKeys> = {};
-            for (const [name, key] of Object.entries(this.crossSigningKeys.keys)) {
-                keys[((name as keyof ICrossSigningKeys["keys"]) + "_key") as keyof CrossSigningKeys] = key;
-            }
-
-            // We must only call `uploadDeviceSigningKeys` from inside this auth
-            // helper to ensure we properly handle auth errors.
-            await this.crossSigningKeys.authUpload?.((authDict) => {
-                return baseApis.uploadDeviceSigningKeys(authDict ?? undefined, keys as CrossSigningKeys);
-            });
-
-            // pass the new keys to the main instance of our own CrossSigningInfo.
-            crypto.crossSigningInfo.setKeys(this.crossSigningKeys.keys);
-        }
-        // set account data
-        if (this.accountData) {
-            for (const [type, content] of this.accountData) {
-                await baseApis.setAccountData(type, content);
-            }
-        }
-        // upload first cross-signing signatures with the new key
-        // (e.g. signing our own device)
-        if (this.keySignatures) {
-            await baseApis.uploadKeySignatures(this.keySignatures);
-        }
-        // need to create/update key backup info
-        if (this.keyBackupInfo) {
-            if (this.keyBackupInfo.version) {
-                // session backup signature
-                // The backup is trusted because the user provided the private key.
-                // Sign the backup with the cross signing key so the key backup can
-                // be trusted via cross-signing.
-                await baseApis.http.authedRequest(
-                    Method.Put,
-                    "/room_keys/version/" + this.keyBackupInfo.version,
-                    undefined,
-                    {
-                        algorithm: this.keyBackupInfo.algorithm,
-                        auth_data: this.keyBackupInfo.auth_data,
-                    },
-                    { prefix: ClientPrefix.V3 },
-                );
-            } else {
-                // add new key backup
-                await baseApis.http.authedRequest(Method.Post, "/room_keys/version", undefined, this.keyBackupInfo, {
-                    prefix: ClientPrefix.V3,
-                });
-            }
-            // tell the backup manager to re-check the keys now that they have been (maybe) updated
-            await crypto.backupManager.checkKeyBackup();
-        }
-    }
-}
-
-/**
- * Catches account data set by SecretStorage during bootstrapping by
- * implementing the methods related to account data in MatrixClient
- */
-class AccountDataClientAdapter
-    extends TypedEventEmitter<ClientEvent.AccountData, ClientEventHandlerMap>
-    implements AccountDataClient
-{
-    //
-    public readonly values = new Map<string, MatrixEvent>();
-
-    /**
-     * @param existingValues - existing account data
-     */
-    public constructor(private readonly existingValues: Map<string, MatrixEvent>) {
-        super();
-    }
-
-    /**
-     * @returns the content of the account data
-     */
-    public getAccountDataFromServer<T extends { [k: string]: any }>(type: string): Promise<T | null> {
-        return Promise.resolve(this.getAccountData(type));
-    }
-
-    /**
-     * @returns the content of the account data
-     */
-    public getAccountData<T extends { [k: string]: any }>(type: string): T | null {
-        const modifiedValue = this.values.get(type);
-        if (modifiedValue) {
-            return modifiedValue as unknown as T;
-        }
-        const existingValue = this.existingValues.get(type);
-        if (existingValue) {
-            return existingValue.getContent<T>();
-        }
-        return null;
-    }
-
-    public setAccountData(type: string, content: any): Promise<{}> {
-        const lastEvent = this.values.get(type);
-        this.values.set(type, content);
-        // ensure accountData is emitted on the next tick,
-        // as SecretStorage listens for it while calling this method
-        // and it seems to rely on this.
-        return Promise.resolve().then(() => {
-            const event = new MatrixEvent({ type, content });
-            this.emit(ClientEvent.AccountData, event, lastEvent);
-            return {};
-        });
-    }
-}
-
-/**
- * Catches the private cross-signing keys set during bootstrapping
- * by both cache callbacks (see createCryptoStoreCacheCallbacks) as non-cache callbacks.
- * See CrossSigningInfo constructor
- */
-class CrossSigningCallbacks implements ICryptoCallbacks, ICacheCallbacks {
-    public readonly privateKeys = new Map<string, Uint8Array>();
-
-    // cache callbacks
-    public getCrossSigningKeyCache(type: string, expectedPublicKey: string): Promise<Uint8Array | null> {
-        return this.getCrossSigningKey(type, expectedPublicKey);
-    }
-
-    public storeCrossSigningKeyCache(type: string, key: Uint8Array): Promise<void> {
-        this.privateKeys.set(type, key);
-        return Promise.resolve();
-    }
-
-    // non-cache callbacks
-    public getCrossSigningKey(type: string, expectedPubkey: string): Promise<Uint8Array | null> {
-        return Promise.resolve(this.privateKeys.get(type) ?? null);
-    }
-
-    public saveCrossSigningKeys(privateKeys: Record<string, Uint8Array>): void {
-        for (const [type, privateKey] of Object.entries(privateKeys)) {
-            this.privateKeys.set(type, privateKey);
-        }
-    }
-}
-
-/**
- * Catches the 4S private key set during bootstrapping by implementing
- * the SecretStorage crypto callbacks
- */
-class SSSSCryptoCallbacks {
-    private readonly privateKeys = new Map<string, Uint8Array>();
-
-    public constructor(private readonly delegateCryptoCallbacks?: ICryptoCallbacks) {}
-
-    public async getSecretStorageKey(
-        { keys }: { keys: Record<string, SecretStorageKeyDescription> },
-        name: string,
-    ): Promise<[string, Uint8Array] | null> {
-        for (const keyId of Object.keys(keys)) {
-            const privateKey = this.privateKeys.get(keyId);
-            if (privateKey) {
-                return [keyId, privateKey];
-            }
-        }
-        // if we don't have the key cached yet, ask
-        // for it to the general crypto callbacks and cache it
-        if (this?.delegateCryptoCallbacks?.getSecretStorageKey) {
-            const result = await this.delegateCryptoCallbacks.getSecretStorageKey({ keys }, name);
-            if (result) {
-                const [keyId, privateKey] = result;
-                this.privateKeys.set(keyId, privateKey);
-            }
-            return result;
-        }
-        return null;
-    }
-
-    public addPrivateKey(keyId: string, keyInfo: SecretStorageKeyDescription, privKey: Uint8Array): void {
-        this.privateKeys.set(keyId, privKey);
-        // Also pass along to application to cache if it wishes
-        this.delegateCryptoCallbacks?.cacheSecretStorageKey?.(keyId, keyInfo, privKey);
-    }
-}