@unwanted/matrix-sdk-mini 34.12.0 → 36.0.0

package/src/rust-crypto/constants.ts

@@ -1,18 +0,0 @@
-/*
-Copyright 2022 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.
-*/
-
-/** The prefix used on indexeddbs created by rust-crypto */
-export const RUST_SDK_STORE_PREFIX = "matrix-js-sdk";

package/src/rust-crypto/device-converter.ts

@@ -1,128 +0,0 @@
-/*
-Copyright 2023 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 * as RustSdkCryptoJs from "@matrix-org/matrix-sdk-crypto-wasm";
-
-import { Device, DeviceVerification } from "../models/device.ts";
-import { DeviceKeys } from "../client.ts";
-
-/**
- * Convert a {@link RustSdkCryptoJs.Device} to a {@link Device}
- * @param device - Rust Sdk device
- * @param userId - owner of the device
- *
- * @internal
- */
-export function rustDeviceToJsDevice(device: RustSdkCryptoJs.Device, userId: RustSdkCryptoJs.UserId): Device {
-    // Copy rust device keys to Device.keys
-    const keys = new Map<string, string>();
-    for (const [keyId, key] of device.keys.entries()) {
-        keys.set(keyId.toString(), key.toBase64());
-    }
-
-    // Compute verified from device state
-    let verified: DeviceVerification = DeviceVerification.Unverified;
-    if (device.isBlacklisted()) {
-        verified = DeviceVerification.Blocked;
-    } else if (device.isVerified()) {
-        verified = DeviceVerification.Verified;
-    }
-
-    // Convert rust signatures to Device.signatures
-    const signatures = new Map<string, Map<string, string>>();
-    const mayBeSignatureMap: Map<string, RustSdkCryptoJs.MaybeSignature> | undefined = device.signatures.get(userId);
-    if (mayBeSignatureMap) {
-        const convertedSignatures = new Map<string, string>();
-        // Convert maybeSignatures map to a Map<string, string>
-        for (const [key, value] of mayBeSignatureMap.entries()) {
-            if (value.isValid() && value.signature) {
-                convertedSignatures.set(key, value.signature.toBase64());
-            }
-        }
-
-        signatures.set(userId.toString(), convertedSignatures);
-    }
-
-    // Convert rust algorithms to algorithms
-    const rustAlgorithms: RustSdkCryptoJs.EncryptionAlgorithm[] = device.algorithms;
-    // Use set to ensure that algorithms are not duplicated
-    const algorithms = new Set<string>();
-    rustAlgorithms.forEach((algorithm) => {
-        switch (algorithm) {
-            case RustSdkCryptoJs.EncryptionAlgorithm.MegolmV1AesSha2:
-                algorithms.add("m.megolm.v1.aes-sha2");
-                break;
-            case RustSdkCryptoJs.EncryptionAlgorithm.OlmV1Curve25519AesSha2:
-            default:
-                algorithms.add("m.olm.v1.curve25519-aes-sha2");
-                break;
-        }
-    });
-
-    return new Device({
-        deviceId: device.deviceId.toString(),
-        userId: userId.toString(),
-        keys,
-        algorithms: Array.from(algorithms),
-        verified,
-        signatures,
-        displayName: device.displayName,
-        dehydrated: device.isDehydrated,
-    });
-}
-
-/**
- * Convert {@link DeviceKeys}  from `/keys/query` request to a `Map<string, Device>`
- * @param deviceKeys - Device keys object to convert
- *
- * @internal
- */
-export function deviceKeysToDeviceMap(deviceKeys: DeviceKeys): Map<string, Device> {
-    return new Map(
-        Object.entries(deviceKeys).map(([deviceId, device]) => [deviceId, downloadDeviceToJsDevice(device)]),
-    );
-}
-
-// Device from `/keys/query` request
-type QueryDevice = DeviceKeys[keyof DeviceKeys];
-
-/**
- * Convert `/keys/query` {@link QueryDevice} device to {@link Device}
- * @param device - Device from `/keys/query` request
- *
- * @internal
- */
-export function downloadDeviceToJsDevice(device: QueryDevice): Device {
-    const keys = new Map(Object.entries(device.keys));
-    const displayName = device.unsigned?.device_display_name;
-
-    const signatures = new Map<string, Map<string, string>>();
-    if (device.signatures) {
-        for (const userId in device.signatures) {
-            signatures.set(userId, new Map(Object.entries(device.signatures[userId])));
-        }
-    }
-
-    return new Device({
-        deviceId: device.device_id,
-        userId: device.user_id,
-        keys,
-        algorithms: device.algorithms,
-        verified: DeviceVerification.Unverified,
-        signatures,
-        displayName,
-    });
-}

package/src/rust-crypto/index.ts

@@ -1,237 +0,0 @@
-/*
-Copyright 2022 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 * as RustSdkCryptoJs from "@matrix-org/matrix-sdk-crypto-wasm";
-import { StoreHandle } from "@matrix-org/matrix-sdk-crypto-wasm";
-
-import { RustCrypto } from "./rust-crypto.ts";
-import { IHttpOpts, MatrixHttpApi } from "../http-api/index.ts";
-import { ServerSideSecretStorage } from "../secret-storage.ts";
-import { Logger } from "../logger.ts";
-import { CryptoStore, MigrationState } from "../crypto/store/base.ts";
-import {
-    migrateFromLegacyCrypto,
-    migrateLegacyLocalTrustIfNeeded,
-    migrateRoomSettingsFromLegacyCrypto,
-} from "./libolm_migration.ts";
-import { CryptoCallbacks } from "../crypto-api/index.ts";
-
-/**
- * Create a new `RustCrypto` implementation
- *
- * @param args - Parameter object
- * @internal
- */
-export async function initRustCrypto(args: {
-    /** A `Logger` instance that will be used for debug output. */
-    logger: Logger;
-
-    /**
-     * Low-level HTTP interface: used to make outgoing requests required by the rust SDK.
-     * We expect it to set the access token, etc.
-     */
-    http: MatrixHttpApi<IHttpOpts & { onlyData: true }>;
-
-    /** The local user's User ID. */
-    userId: string;
-
-    /** The local user's Device ID. */
-    deviceId: string;
-
-    /** Interface to server-side secret storage. */
-    secretStorage: ServerSideSecretStorage;
-
-    /** Crypto callbacks provided by the application. */
-    cryptoCallbacks: CryptoCallbacks;
-
-    /**
-     * The prefix to use on the indexeddbs created by rust-crypto.
-     * If `null`, a memory store will be used.
-     */
-    storePrefix: string | null;
-
-    /**
-     * A passphrase to use to encrypt the indexeddb created by rust-crypto.
-     *
-     * Ignored if `storePrefix` is null, or `storeKey` is set.  If neither this nor `storeKey` is set
-     * (and `storePrefix` is not null), the indexeddb will be unencrypted.
-     */
-    storePassphrase?: string;
-
-    /**
-     * A key to use to encrypt the indexeddb created by rust-crypto.
-     *
-     * Ignored if `storePrefix` is null. Otherwise, if it is set, it must be a 32-byte cryptographic key, which
-     * will be used to encrypt the indexeddb. See also `storePassphrase`.
-     */
-    storeKey?: Uint8Array;
-
-    /** If defined, we will check if any data needs migrating from this store to the rust store. */
-    legacyCryptoStore?: CryptoStore;
-
-    /** The pickle key for `legacyCryptoStore` */
-    legacyPickleKey?: string;
-
-    /**
-     * A callback which will receive progress updates on migration from `legacyCryptoStore`.
-     *
-     * Called with (-1, -1) to mark the end of migration.
-     */
-    legacyMigrationProgressListener?: (progress: number, total: number) => void;
-}): Promise<RustCrypto> {
-    const { logger } = args;
-
-    // initialise the rust matrix-sdk-crypto-wasm, if it hasn't already been done
-    logger.debug("Initialising Rust crypto-sdk WASM artifact");
-    await RustSdkCryptoJs.initAsync();
-
-    // enable tracing in the rust-sdk
-    new RustSdkCryptoJs.Tracing(RustSdkCryptoJs.LoggerLevel.Debug).turnOn();
-
-    logger.debug("Opening Rust CryptoStore");
-    let storeHandle;
-    if (args.storePrefix) {
-        if (args.storeKey) {
-            storeHandle = await StoreHandle.openWithKey(args.storePrefix, args.storeKey);
-        } else {
-            storeHandle = await StoreHandle.open(args.storePrefix, args.storePassphrase);
-        }
-    } else {
-        storeHandle = await StoreHandle.open();
-    }
-
-    if (args.legacyCryptoStore) {
-        // We have a legacy crypto store, which we may need to migrate from.
-        await migrateFromLegacyCrypto({
-            legacyStore: args.legacyCryptoStore,
-            storeHandle,
-            ...args,
-        });
-    }
-
-    const rustCrypto = await initOlmMachine(
-        logger,
-        args.http,
-        args.userId,
-        args.deviceId,
-        args.secretStorage,
-        args.cryptoCallbacks,
-        storeHandle,
-        args.legacyCryptoStore,
-    );
-
-    storeHandle.free();
-
-    logger.debug("Completed rust crypto-sdk setup");
-    return rustCrypto;
-}
-
-async function initOlmMachine(
-    logger: Logger,
-    http: MatrixHttpApi<IHttpOpts & { onlyData: true }>,
-    userId: string,
-    deviceId: string,
-    secretStorage: ServerSideSecretStorage,
-    cryptoCallbacks: CryptoCallbacks,
-    storeHandle: StoreHandle,
-    legacyCryptoStore?: CryptoStore,
-): Promise<RustCrypto> {
-    logger.debug("Init OlmMachine");
-
-    const olmMachine = await RustSdkCryptoJs.OlmMachine.initFromStore(
-        new RustSdkCryptoJs.UserId(userId),
-        new RustSdkCryptoJs.DeviceId(deviceId),
-        storeHandle,
-    );
-
-    // A final migration step, now that we have an OlmMachine.
-    if (legacyCryptoStore) {
-        await migrateRoomSettingsFromLegacyCrypto({
-            logger,
-            legacyStore: legacyCryptoStore,
-            olmMachine,
-        });
-    }
-
-    // Disable room key requests, per https://github.com/vector-im/element-web/issues/26524.
-    olmMachine.roomKeyRequestsEnabled = false;
-
-    const rustCrypto = new RustCrypto(logger, olmMachine, http, userId, deviceId, secretStorage, cryptoCallbacks);
-
-    await olmMachine.registerRoomKeyUpdatedCallback((sessions: RustSdkCryptoJs.RoomKeyInfo[]) =>
-        rustCrypto.onRoomKeysUpdated(sessions),
-    );
-    await olmMachine.registerRoomKeysWithheldCallback((withheld: RustSdkCryptoJs.RoomKeyWithheldInfo[]) =>
-        rustCrypto.onRoomKeysWithheld(withheld),
-    );
-    await olmMachine.registerUserIdentityUpdatedCallback((userId: RustSdkCryptoJs.UserId) =>
-        rustCrypto.onUserIdentityUpdated(userId),
-    );
-    await olmMachine.registerDevicesUpdatedCallback((userIds: string[]) => rustCrypto.onDevicesUpdated(userIds));
-
-    // Check if there are any key backup secrets pending processing. There may be multiple secrets to process if several devices have gossiped them.
-    // The `registerReceiveSecretCallback` function will only be triggered for new secrets. If the client is restarted before processing them, the secrets will need to be manually handled.
-    rustCrypto.checkSecrets("m.megolm_backup.v1");
-
-    // Register a callback to be notified when a new secret is received, as for now only the key backup secret is supported (the cross signing secrets are handled automatically by the OlmMachine)
-    await olmMachine.registerReceiveSecretCallback((name: string, _value: string) =>
-        // Instead of directly checking the secret value, we poll the inbox to get all values for that secret type.
-        // Once we have all the values, we can safely clear the secret inbox.
-        rustCrypto.checkSecrets(name),
-    );
-
-    // Tell the OlmMachine to think about its outgoing requests before we hand control back to the application.
-    //
-    // This is primarily a fudge to get it to correctly populate the `users_for_key_query` list, so that future
-    // calls to getIdentity (etc) block until the key queries are performed.
-    //
-    // Note that we don't actually need to *make* any requests here; it is sufficient to tell the Rust side to think
-    // about them.
-    //
-    // XXX: find a less hacky way to do this.
-    await olmMachine.outgoingRequests();
-
-    if (legacyCryptoStore && (await legacyCryptoStore.containsData())) {
-        const migrationState = await legacyCryptoStore.getMigrationState();
-        if (migrationState < MigrationState.INITIAL_OWN_KEY_QUERY_DONE) {
-            logger.debug(`Performing initial key query after migration`);
-            // We need to do an initial keys query so that the rust stack can properly update trust of
-            // the user device and identity from the migrated private keys.
-            // If not done, there is a short period where the own device/identity trust will be undefined after migration.
-            let initialKeyQueryDone = false;
-            while (!initialKeyQueryDone) {
-                try {
-                    await rustCrypto.userHasCrossSigningKeys(userId);
-                    initialKeyQueryDone = true;
-                } catch (e) {
-                    // If the initial key query fails, we retry until it succeeds.
-                    logger.error("Failed to check for cross-signing keys after migration, retrying", e);
-                }
-            }
-
-            // If the private master cross-signing key was not cached in the legacy store, the rust session
-            // will not be able to establish the trust of the user identity.
-            // That means that after migration the session could revert to unverified.
-            // In order to avoid asking the users to re-verify their sessions, we need to migrate the legacy local trust
-            // (if the legacy session was already verified) to the new session.
-            await migrateLegacyLocalTrustIfNeeded({ legacyCryptoStore, rustCrypto, logger });
-
-            await legacyCryptoStore.setMigrationState(MigrationState.INITIAL_OWN_KEY_QUERY_DONE);
-        }
-    }
-
-    return rustCrypto;
-}