@unwanted/matrix-sdk-mini 34.12.0-2 → 34.12.0-3

package/src/crypto-api/key-passphrase.ts

@@ -1,58 +0,0 @@
-/*
- * Copyright 2024 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.
- */
-
-const DEFAULT_BIT_SIZE = 256;
-
-/**
- * Derive a recovery key from a passphrase and salt using PBKDF2.
- * @see https://spec.matrix.org/v1.11/client-server-api/#deriving-keys-from-passphrases
- *
- * @param passphrase - The passphrase to derive the key from
- * @param salt - The salt to use in the derivation
- * @param iterations - The number of iterations to use in the derivation
- * @param numBits - The number of bits to derive
- */
-export async function deriveRecoveryKeyFromPassphrase(
-    passphrase: string,
-    salt: string,
-    iterations: number,
-    numBits = DEFAULT_BIT_SIZE,
-): Promise<Uint8Array> {
-    if (!globalThis.crypto.subtle || !TextEncoder) {
-        throw new Error("Password-based backup is not available on this platform");
-    }
-
-    const key = await globalThis.crypto.subtle.importKey(
-        "raw",
-        new TextEncoder().encode(passphrase),
-        { name: "PBKDF2" },
-        false,
-        ["deriveBits"],
-    );
-
-    const keybits = await globalThis.crypto.subtle.deriveBits(
-        {
-            name: "PBKDF2",
-            salt: new TextEncoder().encode(salt),
-            iterations: iterations,
-            hash: "SHA-512",
-        },
-        key,
-        numBits,
-    );
-
-    return new Uint8Array(keybits);
-}

package/src/crypto-api/keybackup.ts

@@ -1,115 +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 { ISigned } from "../@types/signed.ts";
-import { AESEncryptedSecretStoragePayload } from "../@types/AESEncryptedSecretStoragePayload.ts";
-import { ImportRoomKeyProgressData } from "./index.ts";
-
-export interface Curve25519AuthData {
-    public_key: string;
-    private_key_salt?: string;
-    private_key_iterations?: number;
-    private_key_bits?: number;
-}
-
-export interface Aes256AuthData {
-    iv: string;
-    mac: string;
-    private_key_salt?: string;
-    private_key_iterations?: number;
-}
-
-/**
- * Information about a server-side key backup.
- *
- * Returned by [`GET /_matrix/client/v3/room_keys/version`](https://spec.matrix.org/v1.7/client-server-api/#get_matrixclientv3room_keysversion)
- * and hence {@link matrix.MatrixClient.getKeyBackupVersion}.
- */
-export interface KeyBackupInfo {
-    algorithm: string;
-    auth_data: ISigned & (Curve25519AuthData | Aes256AuthData);
-    count?: number;
-    etag?: string;
-    version?: string; // number contained within
-}
-
-/**
- * Information on whether a given server-side backup is trusted.
- */
-export interface BackupTrustInfo {
-    /**
-     * Is this backup trusted?
-     *
-     * True if, and only if, there is a valid signature on the backup from a trusted device.
-     */
-    readonly trusted: boolean;
-
-    /**
-     * True if this backup matches the stored decryption key.
-     */
-    readonly matchesDecryptionKey: boolean;
-}
-
-/**
- * The result of {@link CryptoApi.checkKeyBackupAndEnable}.
- */
-export interface KeyBackupCheck {
-    backupInfo: KeyBackupInfo;
-    trustInfo: BackupTrustInfo;
-}
-
-export interface Curve25519SessionData {
-    ciphertext: string;
-    ephemeral: string;
-    mac: string;
-}
-
-/* eslint-disable camelcase */
-export interface KeyBackupSession<T = Curve25519SessionData | AESEncryptedSecretStoragePayload> {
-    first_message_index: number;
-    forwarded_count: number;
-    is_verified: boolean;
-    session_data: T;
-}
-
-export interface KeyBackupRoomSessions {
-    [sessionId: string]: KeyBackupSession;
-}
-
-/**
- * Extra parameters for {@link CryptoApi.restoreKeyBackup} and {@link CryptoApi.restoreKeyBackupWithPassphrase}.
- */
-export interface KeyBackupRestoreOpts {
-    /**
-     * A callback which, if defined, will be called periodically to report ongoing progress of the backup restore process.
-     * @param progress
-     */
-    progressCallback?: (progress: ImportRoomKeyProgressData) => void;
-}
-
-/**
- * The result of {@link CryptoApi.restoreKeyBackup}.
- */
-export interface KeyBackupRestoreResult {
-    /**
-     * The total number of keys that were found in the backup.
-     */
-    total: number;
-    /**
-     * The number of keys that were imported.
-     */
-    imported: number;
-}

package/src/crypto-api/recovery-key.ts

@@ -1,69 +0,0 @@
-/*
- * Copyright 2024 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 bs58 from "bs58";
-
-// picked arbitrarily but to try & avoid clashing with any bitcoin ones
-// (which are also base58 encoded, but bitcoin's involve a lot more hashing)
-const OLM_RECOVERY_KEY_PREFIX = [0x8b, 0x01];
-const KEY_SIZE = 32;
-
-/**
- * Encode a recovery key using the Matrix {@link https://spec.matrix.org/v1.11/appendices/#cryptographic-key-representation | Cryptographic key representation}
- * @param key
- */
-export function encodeRecoveryKey(key: ArrayLike<number>): string | undefined {
-    const buf = Buffer.alloc(OLM_RECOVERY_KEY_PREFIX.length + key.length + 1);
-    buf.set(OLM_RECOVERY_KEY_PREFIX, 0);
-    buf.set(key, OLM_RECOVERY_KEY_PREFIX.length);
-
-    let parity = 0;
-    for (let i = 0; i < buf.length - 1; ++i) {
-        parity ^= buf[i];
-    }
-    buf[buf.length - 1] = parity;
-    const base58key = bs58.encode(buf);
-
-    return base58key.match(/.{1,4}/g)?.join(" ");
-}
-
-/**
- * Decode a recovery key encoded with the Matrix {@link https://spec.matrix.org/v1.11/appendices/#cryptographic-key-representation | Cryptographic key representation} encoding.
- * @param recoveryKey
- */
-export function decodeRecoveryKey(recoveryKey: string): Uint8Array {
-    const result = bs58.decode(recoveryKey.replace(/ /g, ""));
-
-    let parity = 0;
-    for (const b of result) {
-        parity ^= b;
-    }
-    if (parity !== 0) {
-        throw new Error("Incorrect parity");
-    }
-
-    for (let i = 0; i < OLM_RECOVERY_KEY_PREFIX.length; ++i) {
-        if (result[i] !== OLM_RECOVERY_KEY_PREFIX[i]) {
-            throw new Error("Incorrect prefix");
-        }
-    }
-
-    if (result.length !== OLM_RECOVERY_KEY_PREFIX.length + KEY_SIZE + 1) {
-        throw new Error("Incorrect length");
-    }
-
-    return Uint8Array.from(result.slice(OLM_RECOVERY_KEY_PREFIX.length, OLM_RECOVERY_KEY_PREFIX.length + KEY_SIZE));
-}

package/src/crypto-api/verification.ts

@@ -1,408 +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 { MatrixEvent } from "../models/event.ts";
-import { TypedEventEmitter } from "../models/typed-event-emitter.ts";
-
-/**
- * An incoming, or outgoing, request to verify a user or a device via cross-signing.
- */
-export interface VerificationRequest
-    extends TypedEventEmitter<VerificationRequestEvent, VerificationRequestEventHandlerMap> {
-    /**
-     * Unique ID for this verification request.
-     *
-     * An ID isn't assigned until the first message is sent, so this may be `undefined` in the early phases.
-     */
-    get transactionId(): string | undefined;
-
-    /**
-     * For an in-room verification, the ID of the room.
-     *
-     * For to-device verifictions, `undefined`.
-     */
-    get roomId(): string | undefined;
-
-    /**
-     * True if this request was initiated by the local client.
-     *
-     * For in-room verifications, the initiator is who sent the `m.key.verification.request` event.
-     * For to-device verifications, the initiator is who sent the `m.key.verification.start` event.
-     */
-    get initiatedByMe(): boolean;
-
-    /** The user id of the other party in this request */
-    get otherUserId(): string;
-
-    /** For verifications via to-device messages: the ID of the other device. Otherwise, undefined. */
-    get otherDeviceId(): string | undefined;
-
-    /** True if the other party in this request is one of this user's own devices. */
-    get isSelfVerification(): boolean;
-
-    /** current phase of the request. */
-    get phase(): VerificationPhase;
-
-    /** True if the request has sent its initial event and needs more events to complete
-     * (ie it is in phase `Requested`, `Ready` or `Started`).
-     */
-    get pending(): boolean;
-
-    /**
-     * True if we have started the process of sending an `m.key.verification.ready` (but have not necessarily received
-     * the remote echo which causes a transition to {@link VerificationPhase.Ready}.
-     */
-    get accepting(): boolean;
-
-    /**
-     * True if we have started the process of sending an `m.key.verification.cancel` (but have not necessarily received
-     * the remote echo which causes a transition to {@link VerificationPhase.Cancelled}).
-     */
-    get declining(): boolean;
-
-    /**
-     * The remaining number of ms before the request will be automatically cancelled.
-     *
-     * `null` indicates that there is no timeout
-     */
-    get timeout(): number | null;
-
-    /** once the phase is Started (and !initiatedByMe) or Ready: common methods supported by both sides */
-    get methods(): string[];
-
-    /** the method picked in the .start event */
-    get chosenMethod(): string | null;
-
-    /**
-     * Checks whether the other party supports a given verification method.
-     * This is useful when setting up the QR code UI, as it is somewhat asymmetrical:
-     * if the other party supports SCAN_QR, we should show a QR code in the UI, and vice versa.
-     * For methods that need to be supported by both ends, use the `methods` property.
-     *
-     * @param method - the method to check
-     * @returns true if the other party said they supported the method
-     */
-    otherPartySupportsMethod(method: string): boolean;
-
-    /**
-     * Accepts the request, sending a .ready event to the other party
-     *
-     * @returns Promise which resolves when the event has been sent.
-     */
-    accept(): Promise<void>;
-
-    /**
-     * Cancels the request, sending a cancellation to the other party
-     *
-     * @param params - Details for the cancellation, including `reason` (defaults to "User declined"), and `code`
-     *    (defaults to `m.user`). **Deprecated**: this parameter is ignored by the Rust cryptography implementation.
-     *
-     * @returns Promise which resolves when the event has been sent.
-     */
-    cancel(params?: { reason?: string; code?: string }): Promise<void>;
-
-    /**
-     * Create a {@link Verifier} to do this verification via a particular method.
-     *
-     * If a verifier has already been created for this request, returns that verifier.
-     *
-     * This does *not* send the `m.key.verification.start` event - to do so, call {@link Verifier.verify} on the
-     * returned verifier.
-     *
-     * If no previous events have been sent, pass in `targetDevice` to set who to direct this request to.
-     *
-     * @param method - the name of the verification method to use.
-     * @param targetDevice - details of where to send the request to.
-     *
-     * @returns The verifier which will do the actual verification.
-     *
-     * @deprecated Use {@link VerificationRequest#startVerification} instead.
-     */
-    beginKeyVerification(method: string, targetDevice?: { userId?: string; deviceId?: string }): Verifier;
-
-    /**
-     * Send an `m.key.verification.start` event to start verification via a particular method.
-     *
-     * This is normally used when starting a verification via emojis (ie, `method` is set to `m.sas.v1`).
-     *
-     * @param method - the name of the verification method to use.
-     *
-     * @returns The verifier which will do the actual verification.
-     */
-    startVerification(method: string): Promise<Verifier>;
-
-    /**
-     * Start a QR code verification by providing a scanned QR code for this verification flow.
-     *
-     * Validates the QR code, and if it is ok, sends an `m.key.verification.start` event with `method` set to
-     * `m.reciprocate.v1`, to tell the other side the scan was successful.
-     *
-     * See also {@link VerificationRequest#startVerification} which can be used to start other verification methods.
-     *
-     * @param qrCodeData - the decoded QR code.
-     * @returns A verifier; call `.verify()` on it to wait for the other side to complete the verification flow.
-     */
-    scanQRCode(qrCodeData: Uint8Array): Promise<Verifier>;
-
-    /**
-     * The verifier which is doing the actual verification, once the method has been established.
-     * Only defined when the `phase` is Started.
-     */
-    get verifier(): Verifier | undefined;
-
-    /**
-     * Get the data for a QR code allowing the other device to verify this one, if it supports it.
-     *
-     * Only set after a .ready if the other party can scan a QR code, otherwise undefined.
-     *
-     * @deprecated Not supported in Rust Crypto. Use {@link VerificationRequest#generateQRCode} instead.
-     */
-    getQRCodeBytes(): Buffer | undefined;
-
-    /**
-     * Generate the data for a QR code allowing the other device to verify this one, if it supports it.
-     *
-     * Only returns data once `phase` is {@link VerificationPhase.Ready} and the other party can scan a QR code;
-     * otherwise returns `undefined`.
-     */
-    generateQRCode(): Promise<Buffer | undefined>;
-
-    /**
-     * If this request has been cancelled, the cancellation code (e.g `m.user`) which is responsible for cancelling
-     * this verification.
-     */
-    get cancellationCode(): string | null;
-
-    /**
-     * The id of the user that cancelled the request.
-     *
-     * Only defined when phase is Cancelled
-     */
-    get cancellingUserId(): string | undefined;
-}
-
-/** Events emitted by {@link VerificationRequest}. */
-export enum VerificationRequestEvent {
-    /**
-     * Fires whenever the state of the request object has changed.
-     *
-     * There is no payload to the event.
-     */
-    Change = "change",
-}
-
-/**
- * Listener type map for {@link VerificationRequestEvent}s.
- *
- * @internal
- */
-export type VerificationRequestEventHandlerMap = {
-    [VerificationRequestEvent.Change]: () => void;
-};
-
-/** The current phase of a verification request. */
-export enum VerificationPhase {
-    /** Initial state: no event yet exchanged */
-    Unsent = 1,
-
-    /** An `m.key.verification.request` event has been sent or received */
-    Requested,
-
-    /** An `m.key.verification.ready` event has been sent or received, indicating the verification request is accepted. */
-    Ready,
-
-    /**
-     * The verification is in flight.
-     *
-     * This means that an `m.key.verification.start` event has been sent or received, choosing a verification method;
-     * however the verification has not yet completed or been cancelled.
-     */
-    Started,
-
-    /**
-     * An `m.key.verification.cancel` event has been sent or received at any time before the `done` event, cancelling
-     * the verification request
-     */
-    Cancelled,
-
-    /**
-     * The verification request is complete.
-     *
-     * Normally this means that `m.key.verification.done` events have been sent and received.
-     */
-    Done,
-}
-
-/**
- * A `Verifier` is responsible for performing the verification using a particular method, such as via QR code or SAS
- * (emojis).
- *
- * A verifier object can be created by calling `VerificationRequest.beginVerification`; one is also created
- * automatically when a `m.key.verification.start` event is received for an existing VerificationRequest.
- *
- * Once a verifier object is created, the verification can be started by calling the {@link Verifier#verify} method.
- */
-export interface Verifier extends TypedEventEmitter<VerifierEvent, VerifierEventHandlerMap> {
-    /**
-     * Returns true if the verification has been cancelled, either by us or the other side.
-     */
-    get hasBeenCancelled(): boolean;
-
-    /**
-     * The ID of the other user in the verification process.
-     */
-    get userId(): string;
-
-    /**
-     * Start the key verification, if it has not already been started.
-     *
-     * This means sending a `m.key.verification.start` if we are the first responder, or a `m.key.verification.accept`
-     * if the other side has already sent a start event.
-     *
-     * @returns Promise which resolves when the verification has completed, or rejects if the verification is cancelled
-     *    or times out.
-     */
-    verify(): Promise<void>;
-
-    /**
-     * Cancel a verification.
-     *
-     * We will send an `m.key.verification.cancel` if the verification is still in flight. The verification promise
-     * will reject, and a {@link crypto-api.VerifierEvent.Cancel | VerifierEvent.Cancel} will be emitted.
-     *
-     * @param e - the reason for the cancellation.
-     */
-    cancel(e: Error): void;
-
-    /**
-     * Get the details for an SAS verification, if one is in progress
-     *
-     * Returns `null`, unless this verifier is for a SAS-based verification and we are waiting for the user to confirm
-     * the SAS matches.
-     */
-    getShowSasCallbacks(): ShowSasCallbacks | null;
-
-    /**
-     * Get the details for reciprocating QR code verification, if one is in progress
-     *
-     * Returns `null`, unless this verifier is for reciprocating a QR-code-based verification (ie, the other user has
-     * already scanned our QR code), and we are waiting for the user to confirm.
-     */
-    getReciprocateQrCodeCallbacks(): ShowQrCodeCallbacks | null;
-}
-
-/** Events emitted by {@link Verifier} */
-export enum VerifierEvent {
-    /**
-     * The verification has been cancelled, by us or the other side.
-     *
-     * The payload is either an {@link Error}, or an (incoming or outgoing) {@link MatrixEvent}, depending on
-     * unspecified reasons.
-     */
-    Cancel = "cancel",
-
-    /**
-     * SAS data has been exchanged and should be displayed to the user.
-     *
-     * The payload is the {@link ShowSasCallbacks} object.
-     */
-    ShowSas = "show_sas",
-
-    /**
-     * The user should confirm if the other side has scanned our QR code.
-     *
-     * The payload is the {@link ShowQrCodeCallbacks} object.
-     */
-    ShowReciprocateQr = "show_reciprocate_qr",
-}
-
-/** Listener type map for {@link VerifierEvent}s. */
-export type VerifierEventHandlerMap = {
-    [VerifierEvent.Cancel]: (e: Error | MatrixEvent) => void;
-    [VerifierEvent.ShowSas]: (sas: ShowSasCallbacks) => void;
-    [VerifierEvent.ShowReciprocateQr]: (qr: ShowQrCodeCallbacks) => void;
-};
-
-/**
- * Callbacks for user actions to confirm that the other side has scanned our QR code.
- *
- * This is exposed as the payload of a `VerifierEvent.ShowReciprocateQr` event, or can be retrieved directly from the
- * verifier as `reciprocateQREvent`.
- */
-export interface ShowQrCodeCallbacks {
-    /** The user confirms that the verification data matches */
-    confirm(): void;
-
-    /** Cancel the verification flow */
-    cancel(): void;
-}
-
-/**
- * Callbacks for user actions while a SAS is displayed.
- *
- * This is exposed as the payload of a `VerifierEvent.ShowSas` event, or directly from the verifier as `sasEvent`.
- */
-export interface ShowSasCallbacks {
-    /** The generated SAS to be shown to the user */
-    sas: GeneratedSas;
-
-    /** Function to call if the user confirms that the SAS matches.
-     *
-     * @returns A Promise that completes once the m.key.verification.mac is queued.
-     */
-    confirm(): Promise<void>;
-
-    /**
-     * Function to call if the user finds the SAS does not match.
-     *
-     * Sends an `m.key.verification.cancel` event with a `m.mismatched_sas` error code.
-     */
-    mismatch(): void;
-
-    /** Cancel the verification flow */
-    cancel(): void;
-}
-
-/** A generated SAS to be shown to the user, in alternative formats */
-export interface GeneratedSas {
-    /**
-     * The SAS as three numbers between 0 and 8191.
-     *
-     * Only populated if the `decimal` SAS method was negotiated.
-     */
-    decimal?: [number, number, number];
-
-    /**
-     * The SAS as seven emojis.
-     *
-     * Only populated if the `emoji` SAS method was negotiated.
-     */
-    emoji?: EmojiMapping[];
-}
-
-/**
- * An emoji for the generated SAS. A tuple `[emoji, name]` where `emoji` is the emoji itself and `name` is the
- * English name.
- */
-export type EmojiMapping = [emoji: string, name: string];
-
-/**
- * True if the request is in a state where it can be accepted (ie, that we're in phases {@link VerificationPhase.Unsent}
- * or {@link VerificationPhase.Requested}, and that we're not in the process of sending a `ready` or `cancel`).
- */
-export function canAcceptVerificationRequest(req: VerificationRequest): boolean {
-    return req.phase < VerificationPhase.Ready && !req.accepting && !req.declining;
-}