;
-}
-
-export interface ICapability {
- enabled: boolean;
-}
-
-export interface IChangePasswordCapability extends ICapability {}
-
-export interface IThreadsCapability extends ICapability {}
-
-export interface IGetLoginTokenCapability extends ICapability {}
-
export const GET_LOGIN_TOKEN_CAPABILITY = new NamespacedValue(
"m.get_login_token",
"org.matrix.msc3882.get_login_token",
@@ -547,18 +542,7 @@ export const UNSTABLE_MSC2666_SHARED_ROOMS = "uk.half-shot.msc2666";
export const UNSTABLE_MSC2666_MUTUAL_ROOMS = "uk.half-shot.msc2666.mutual_rooms";
export const UNSTABLE_MSC2666_QUERY_MUTUAL_ROOMS = "uk.half-shot.msc2666.query_mutual_rooms";
-/**
- * A representation of the capabilities advertised by a homeserver as defined by
- * [Capabilities negotiation](https://spec.matrix.org/v1.6/client-server-api/#get_matrixclientv3capabilities).
- */
-export interface Capabilities {
- [key: string]: any;
- "m.change_password"?: IChangePasswordCapability;
- "m.room_versions"?: IRoomVersionsCapability;
- "io.element.thread"?: IThreadsCapability;
- "m.get_login_token"?: IGetLoginTokenCapability;
- "org.matrix.msc3882.get_login_token"?: IGetLoginTokenCapability;
-}
+export const UNSTABLE_MSC4140_DELAYED_EVENTS = "org.matrix.msc4140";
enum CrossSigningKeyType {
MasterKey = "master_key",
@@ -1108,7 +1092,7 @@ export type ClientEventHandlerMap = {
* });
* ```
*/
- [ClientEvent.Sync]: (state: SyncState, lastState: SyncState | null, data?: ISyncStateData) => void;
+ [ClientEvent.Sync]: (state: SyncState, prevState: SyncState | null, data?: ISyncStateData) => void;
/**
* Fires whenever the SDK receives a new event.
*
@@ -1293,10 +1277,6 @@ export class MatrixClient extends TypedEventEmitter;
- public cachedCapabilities?: {
- capabilities: Capabilities;
- expiration: number;
- };
protected clientWellKnown?: IClientWellKnown;
protected clientWellKnownPromise?: Promise;
protected turnServers: ITurnServer[] = [];
@@ -1325,6 +1305,8 @@ export class MatrixClient extends TypedEventEmitter {
- const now = new Date().getTime();
-
- if (this.cachedCapabilities && !fresh) {
- if (now < this.cachedCapabilities.expiration) {
- this.logger.debug("Returning cached capabilities");
- return Promise.resolve(this.cachedCapabilities.capabilities);
- }
- }
-
- type Response = {
- capabilities?: Capabilities;
- };
- return this.http
- .authedRequest(Method.Get, "/capabilities")
- .catch((e: Error): Response => {
- // We swallow errors because we need a default object anyhow
- this.logger.error(e);
- return {};
- })
- .then((r = {}) => {
- const capabilities = r["capabilities"] || {};
-
- // If the capabilities missed the cache, cache it for a shorter amount
- // of time to try and refresh them later.
- const cacheMs = Object.keys(capabilities).length ? CAPABILITIES_CACHE_MS : 60000 + Math.random() * 5000;
+ public async getCapabilities(): Promise {
+ const caps = this.serverCapabilitiesService.getCachedCapabilities();
+ if (caps) return caps;
+ return this.serverCapabilitiesService.fetchCapabilities();
+ }
- this.cachedCapabilities = {
- capabilities,
- expiration: now + cacheMs,
- };
+ /**
+ * Gets the cached capabilities of the homeserver. If none have been fetched yet,
+ * return undefined.
+ *
+ * @returns The capabilities of the homeserver
+ */
+ public getCachedCapabilities(): Capabilities | undefined {
+ return this.serverCapabilitiesService.getCachedCapabilities();
+ }
- this.logger.debug("Caching capabilities: ", capabilities);
- return capabilities;
- });
+ /**
+ * Fetches the latest capabilities from the homeserver, ignoring any cached
+ * versions. The newly returned version is cached.
+ *
+ * @returns A promise which resolves to the capabilities of the homeserver
+ */
+ public fetchCapabilities(): Promise {
+ return this.serverCapabilitiesService.fetchCapabilities();
}
/**
@@ -2274,9 +2249,7 @@ export class MatrixClient extends TypedEventEmitter(Method.Post, url);
}
- const queryString: Record = {};
+ let queryParams: QueryDict = {};
if (opts.viaServers) {
- queryString["server_name"] = opts.viaServers;
+ queryParams.server_name = opts.viaServers;
+ queryParams.via = opts.viaServers;
+ if (this.canSupport.get(Feature.MigrateServerNameToVia) === ServerSupport.Unstable) {
+ queryParams = replaceParam("via", "org.matrix.msc4156.via", queryParams);
+ }
}
const data: IJoinRequestBody = {};
@@ -4331,7 +4308,7 @@ export class MatrixClient extends TypedEventEmitter(Method.Post, path, queryString, data);
+ const res = await this.http.authedRequest<{ room_id: string }>(Method.Post, path, queryParams, data);
const roomId = res.room_id;
// In case we were originally given an alias, check the room cache again
@@ -4364,9 +4341,13 @@ export class MatrixClient extends TypedEventEmitter = {};
+ let queryParams: QueryDict = {};
if (opts.viaServers) {
queryParams.server_name = opts.viaServers;
+ queryParams.via = opts.viaServers;
+ if (this.canSupport.get(Feature.MigrateServerNameToVia) === ServerSupport.Unstable) {
+ queryParams = replaceParam("via", "org.matrix.msc4156.via", queryParams);
+ }
}
const body: Record = {};
@@ -4606,12 +4587,19 @@ export class MatrixClient extends TypedEventEmitter {
@@ -4629,8 +4617,6 @@ export class MatrixClient extends TypedEventEmitter,
txnId?: string,
- ): Promise {
+ ): Promise;
+ /**
+ * Sends a delayed event (MSC4140).
+ * @param eventObject - An object with the partial structure of an event, to which event_id, user_id, room_id and origin_server_ts will be added.
+ * @param delayOpts - Properties of the delay for this event.
+ * @param txnId - Optional.
+ * @returns Promise which resolves: to an empty object `{}`
+ * @returns Rejects: with an error response.
+ */
+ private sendCompleteEvent(
+ roomId: string,
+ threadId: string | null,
+ eventObject: Partial,
+ delayOpts: SendDelayedEventRequestOpts,
+ txnId?: string,
+ ): Promise;
+ private sendCompleteEvent(
+ roomId: string,
+ threadId: string | null,
+ eventObject: Partial,
+ delayOptsOrTxnId?: SendDelayedEventRequestOpts | string,
+ txnIdOrVoid?: string,
+ ): Promise {
+ let delayOpts: SendDelayedEventRequestOpts | undefined;
+ let txnId: string | undefined;
+ if (typeof delayOptsOrTxnId === "string") {
+ txnId = delayOptsOrTxnId;
+ } else {
+ delayOpts = delayOptsOrTxnId;
+ txnId = txnIdOrVoid;
+ }
+
if (!txnId) {
txnId = this.makeTxnId();
}
@@ -4667,9 +4684,11 @@ export class MatrixClient extends TypedEventEmitter {
+ protected async encryptAndSendEvent(room: Room | null, event: MatrixEvent): Promise;
+ /**
+ * Simply sends a delayed event without encrypting it.
+ * TODO: Allow encrypted delayed events, and encrypt them properly
+ * @param delayOpts - Properties of the delay for this event.
+ * @returns returns a promise which resolves with the result of the delayed send request
+ */
+ protected async encryptAndSendEvent(
+ room: Room | null,
+ event: MatrixEvent,
+ delayOpts: SendDelayedEventRequestOpts,
+ ): Promise;
+ protected async encryptAndSendEvent(
+ room: Room | null,
+ event: MatrixEvent,
+ delayOpts?: SendDelayedEventRequestOpts,
+ ): Promise {
+ if (delayOpts) {
+ return this.sendEventHttpRequest(event, delayOpts);
+ }
+
try {
let cancelled: boolean;
this.eventsBeingEncrypted.add(event.getId()!);
@@ -4857,7 +4903,15 @@ export class MatrixClient extends TypedEventEmitter {
+ private sendEventHttpRequest(event: MatrixEvent): Promise;
+ private sendEventHttpRequest(
+ event: MatrixEvent,
+ delayOpts: SendDelayedEventRequestOpts,
+ ): Promise;
+ private sendEventHttpRequest(
+ event: MatrixEvent,
+ delayOpts?: SendDelayedEventRequestOpts,
+ ): Promise {
let txnId = event.getTxnId();
if (!txnId) {
txnId = this.makeTxnId();
@@ -4889,12 +4943,20 @@ export class MatrixClient extends TypedEventEmitter(Method.Put, path, undefined, event.getWireContent())
- .then((res) => {
+ const content = event.getWireContent();
+ if (!delayOpts) {
+ return this.http.authedRequest(Method.Put, path, undefined, content).then((res) => {
this.logger.debug(`Event sent to ${event.getRoomId()} with event id ${res.event_id}`);
return res;
});
+ } else {
+ return this.http.authedRequest(
+ Method.Put,
+ path,
+ getUnstableDelayQueryOpts(delayOpts),
+ content,
+ );
+ }
}
/**
@@ -5224,6 +5286,101 @@ export class MatrixClient extends TypedEventEmitter(
+ roomId: string,
+ delayOpts: SendDelayedEventRequestOpts,
+ threadId: string | null,
+ eventType: K,
+ content: TimelineEvents[K],
+ txnId?: string,
+ ): Promise {
+ if (!(await this.doesServerSupportUnstableFeature(UNSTABLE_MSC4140_DELAYED_EVENTS))) {
+ throw Error("Server does not support the delayed events API");
+ }
+
+ this.addThreadRelationIfNeeded(content, threadId, roomId);
+ return this.sendCompleteEvent(roomId, threadId, { type: eventType, content }, delayOpts, txnId);
+ }
+
+ /**
+ * Send a delayed state event.
+ *
+ * Note: This endpoint is unstable, and can throw an `Error`.
+ * Check progress on [MSC4140](https://github.com/matrix-org/matrix-spec-proposals/pull/4140) for more details.
+ */
+ // eslint-disable-next-line
+ public async _unstable_sendDelayedStateEvent(
+ roomId: string,
+ delayOpts: SendDelayedEventRequestOpts,
+ eventType: K,
+ content: StateEvents[K],
+ stateKey = "",
+ opts: IRequestOpts = {},
+ ): Promise {
+ if (!(await this.doesServerSupportUnstableFeature(UNSTABLE_MSC4140_DELAYED_EVENTS))) {
+ throw Error("Server does not support the delayed events API");
+ }
+
+ const pathParams = {
+ $roomId: roomId,
+ $eventType: eventType,
+ $stateKey: stateKey,
+ };
+ let path = utils.encodeUri("/rooms/$roomId/state/$eventType", pathParams);
+ if (stateKey !== undefined) {
+ path = utils.encodeUri(path + "/$stateKey", pathParams);
+ }
+ return this.http.authedRequest(Method.Put, path, getUnstableDelayQueryOpts(delayOpts), content as Body, opts);
+ }
+
+ /**
+ * Get all pending delayed events for the calling user.
+ *
+ * Note: This endpoint is unstable, and can throw an `Error`.
+ * Check progress on [MSC4140](https://github.com/matrix-org/matrix-spec-proposals/pull/4140) for more details.
+ */
+ // eslint-disable-next-line
+ public async _unstable_getDelayedEvents(fromToken?: string): Promise {
+ if (!(await this.doesServerSupportUnstableFeature(UNSTABLE_MSC4140_DELAYED_EVENTS))) {
+ throw Error("Server does not support the delayed events API");
+ }
+
+ const queryDict = fromToken ? { from: fromToken } : undefined;
+ return await this.http.authedRequest(Method.Get, "/delayed_events", queryDict, undefined, {
+ prefix: `${ClientPrefix.Unstable}/${UNSTABLE_MSC4140_DELAYED_EVENTS}`,
+ });
+ }
+
+ /**
+ * Manage a delayed event associated with the given delay_id.
+ *
+ * Note: This endpoint is unstable, and can throw an `Error`.
+ * Check progress on [MSC4140](https://github.com/matrix-org/matrix-spec-proposals/pull/4140) for more details.
+ */
+ // eslint-disable-next-line
+ public async _unstable_updateDelayedEvent(delayId: string, action: UpdateDelayedEventAction): Promise<{}> {
+ if (!(await this.doesServerSupportUnstableFeature(UNSTABLE_MSC4140_DELAYED_EVENTS))) {
+ throw Error("Server does not support the delayed events API");
+ }
+
+ const path = utils.encodeUri("/delayed_events/$delayId", {
+ $delayId: delayId,
+ });
+ const data = {
+ action,
+ };
+ return await this.http.authedRequest(Method.Post, path, undefined, data, {
+ prefix: `${ClientPrefix.Unstable}/${UNSTABLE_MSC4140_DELAYED_EVENTS}`,
+ });
+ }
+
/**
* Send a receipt.
* @param event - The event being acknowledged
@@ -5437,10 +5594,15 @@ export class MatrixClient extends TypedEventEmitter([room.roomId]);
// Work backwards from newer to older rooms
let predecessorRoomId = room.findPredecessor(msc3946ProcessDynamicPredecessor)?.roomId;
while (predecessorRoomId !== null) {
+ if (predecessorRoomId) {
+ if (seenRoomIDs.has(predecessorRoomId)) break;
+ seenRoomIDs.add(predecessorRoomId);
+ }
const predecessorRoom = this.getRoom(predecessorRoomId);
if (predecessorRoom === null) {
break;
@@ -6639,13 +6801,14 @@ export class MatrixClient extends TypedEventEmitter {
+ public peekInRoom(roomId: string, limit: number = 20): Promise {
this.peekSync?.stopPeeking();
this.peekSync = new SyncApi(this, this.clientOpts, this.buildSyncApiOptions());
- return this.peekSync.peek(roomId);
+ return this.peekSync.peek(roomId, limit);
}
/**
@@ -7109,7 +7272,7 @@ export class MatrixClient extends TypedEventEmitter {
+ protected async fetchClientWellKnown(): Promise {
// `getRawClientConfig` does not throw or reject on network errors, instead
// it absorbs errors and returns `{}`.
this.clientWellKnownPromise = AutoDiscovery.getRawClientConfig(this.getDomain() ?? undefined);
@@ -9335,20 +9498,19 @@ export class MatrixClient extends TypedEventEmitter {
- const addr = p[0].toLowerCase(); // lowercase to get consistent hashes
- const med = p[1].toLowerCase();
- const hashed = olmutil
- .sha256(`${addr} ${med} ${params["pepper"]}`)
- .replace(/\+/g, "-")
- .replace(/\//g, "_"); // URL-safe base64
- // Map the hash to a known (case-sensitive) address. We use the case
- // sensitive version because the caller might be expecting that.
- localMapping[hashed] = p[0];
- return hashed;
- });
+ params["addresses"] = await Promise.all(
+ addressPairs.map(async (p) => {
+ const addr = p[0].toLowerCase(); // lowercase to get consistent hashes
+ const med = p[1].toLowerCase();
+ const hashBuffer = await sha256(`${addr} ${med} ${params["pepper"]}`);
+ const hashed = encodeUnpaddedBase64Url(hashBuffer);
+
+ // Map the hash to a known (case-sensitive) address. We use the case
+ // sensitive version because the caller might be expecting that.
+ localMapping[hashed] = p[0];
+ return hashed;
+ }),
+ );
params["algorithm"] = "sha256";
} else if (hashes["algorithms"].includes("none")) {
params["addresses"] = addressPairs.map((p) => {
@@ -9925,6 +10087,12 @@ export class MatrixClient extends TypedEventEmitter [`${UNSTABLE_MSC4140_DELAYED_EVENTS}.${k}`, v]),
+ );
+}
+
/**
* recalculates an accurate notifications count on event decryption.
* Servers do not have enough knowledge about encrypted events to calculate an
diff --git a/src/common-crypto/CryptoBackend.ts b/src/common-crypto/CryptoBackend.ts
index 7a36dc560e9..bbd6e5ec682 100644
--- a/src/common-crypto/CryptoBackend.ts
+++ b/src/common-crypto/CryptoBackend.ts
@@ -14,14 +14,14 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import type { IDeviceLists, IToDeviceEvent } from "../sync-accumulator";
-import { IClearEvent, MatrixEvent } from "../models/event";
-import { Room } from "../models/room";
-import { CryptoApi, DecryptionFailureCode, ImportRoomKeysOpts } from "../crypto-api";
-import { CrossSigningInfo, UserTrustLevel } from "../crypto/CrossSigning";
-import { IEncryptedEventInfo } from "../crypto/api";
-import { KeyBackupInfo, KeyBackupSession } from "../crypto-api/keybackup";
-import { IMegolmSessionData } from "../@types/crypto";
+import type { IDeviceLists, IToDeviceEvent } from "../sync-accumulator.ts";
+import { IClearEvent, MatrixEvent } from "../models/event.ts";
+import { Room } from "../models/room.ts";
+import { CryptoApi, DecryptionFailureCode, ImportRoomKeysOpts } from "../crypto-api/index.ts";
+import { CrossSigningInfo, UserTrustLevel } from "../crypto/CrossSigning.ts";
+import { IEncryptedEventInfo } from "../crypto/api.ts";
+import { KeyBackupInfo, KeyBackupSession } from "../crypto-api/keybackup.ts";
+import { IMegolmSessionData } from "../@types/crypto.ts";
/**
* Common interface for the crypto implementations
diff --git a/src/content-helpers.ts b/src/content-helpers.ts
index 3f611e36901..ce8b373d93e 100644
--- a/src/content-helpers.ts
+++ b/src/content-helpers.ts
@@ -14,10 +14,10 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { MBeaconEventContent, MBeaconInfoContent, MBeaconInfoEventContent } from "./@types/beacon";
-import { MsgType } from "./@types/event";
-import { M_TEXT, REFERENCE_RELATION } from "./@types/extensible_events";
-import { isProvided } from "./extensible_events_v1/utilities";
+import { MBeaconEventContent, MBeaconInfoContent, MBeaconInfoEventContent } from "./@types/beacon.ts";
+import { MsgType } from "./@types/event.ts";
+import { M_TEXT, REFERENCE_RELATION } from "./@types/extensible_events.ts";
+import { isProvided } from "./extensible_events_v1/utilities.ts";
import {
M_ASSET,
LocationAssetType,
@@ -28,9 +28,9 @@ import {
MLocationContent,
MAssetContent,
LegacyLocationEventContent,
-} from "./@types/location";
-import { MRoomTopicEventContent, MTopicContent, M_TOPIC } from "./@types/topic";
-import { RoomMessageEventContent } from "./@types/events";
+} from "./@types/location.ts";
+import { MRoomTopicEventContent, MTopicContent, M_TOPIC } from "./@types/topic.ts";
+import { RoomMessageEventContent } from "./@types/events.ts";
/**
* Generates the content for a HTML Message event
diff --git a/src/content-repo.ts b/src/content-repo.ts
index eaa119f97cd..b6174b6d8d9 100644
--- a/src/content-repo.ts
+++ b/src/content-repo.ts
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { encodeParams } from "./utils";
+import { encodeParams } from "./utils.ts";
/**
* Get the HTTP URL for an MXC URI.
@@ -62,7 +62,7 @@ export function getHttpUriForMxc(
if (useAuthentication) {
allowRedirects = true; // per docs (MSC3916 always expects redirects)
- // Dev note: MSC3916 (as of writing) removes `allow_redirect` entirely, but
+ // Dev note: MSC3916 removes `allow_redirect` entirely, but
// for explicitness we set it here. This makes it slightly more obvious to
// callers, hopefully.
}
@@ -70,8 +70,7 @@ export function getHttpUriForMxc(
let serverAndMediaId = mxc.slice(6); // strips mxc://
let prefix: string;
if (useAuthentication) {
- // TODO: Use stable once available (requires FCP on MSC3916).
- prefix = "/_matrix/client/unstable/org.matrix.msc3916/media/download/";
+ prefix = "/_matrix/client/v1/media/download/";
} else {
prefix = "/_matrix/media/v3/download/";
}
@@ -90,8 +89,7 @@ export function getHttpUriForMxc(
// these are thumbnailing params so they probably want the
// thumbnailing API...
if (useAuthentication) {
- // TODO: Use stable once available (requires FCP on MSC3916).
- prefix = "/_matrix/client/unstable/org.matrix.msc3916/media/thumbnail/";
+ prefix = "/_matrix/client/v1/media/thumbnail/";
} else {
prefix = "/_matrix/media/v3/thumbnail/";
}
diff --git a/src/crypto-api.ts b/src/crypto-api/index.ts
similarity index 94%
rename from src/crypto-api.ts
rename to src/crypto-api/index.ts
index 7dfdfbfcf08..6b9db3811dc 100644
--- a/src/crypto-api.ts
+++ b/src/crypto-api/index.ts
@@ -14,15 +14,16 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import type { IMegolmSessionData } from "./@types/crypto";
-import { Room } from "./models/room";
-import { DeviceMap } from "./models/device";
-import { UIAuthCallback } from "./interactive-auth";
-import { PassphraseInfo, SecretStorageCallbacks, SecretStorageKeyDescription } from "./secret-storage";
-import { VerificationRequest } from "./crypto-api/verification";
-import { BackupTrustInfo, KeyBackupCheck, KeyBackupInfo } from "./crypto-api/keybackup";
-import { ISignatures } from "./@types/signed";
-import { MatrixEvent } from "./models/event";
+import type { SecretsBundle } from "@matrix-org/matrix-sdk-crypto-wasm";
+import type { IMegolmSessionData } from "../@types/crypto.ts";
+import { Room } from "../models/room.ts";
+import { DeviceMap } from "../models/device.ts";
+import { UIAuthCallback } from "../interactive-auth.ts";
+import { PassphraseInfo, SecretStorageCallbacks, SecretStorageKeyDescription } from "../secret-storage.ts";
+import { VerificationRequest } from "./verification.ts";
+import { BackupTrustInfo, KeyBackupCheck, KeyBackupInfo } from "./keybackup.ts";
+import { ISignatures } from "../@types/signed.ts";
+import { MatrixEvent } from "../models/event.ts";
/**
* Public interface to the cryptography parts of the js-sdk
@@ -532,6 +533,23 @@ export interface CryptoApi {
* to false.
*/
startDehydration(createNewKey?: boolean): Promise;
+
+ ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+ //
+ // Import/export of secret keys
+ //
+ ///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+ /**
+ * Export secrets bundle for transmitting to another device as part of OIDC QR login
+ */
+ exportSecretsBundle?(): Promise>>;
+
+ /**
+ * Import secrets bundle transmitted from another device.
+ * @param secrets - The secrets bundle received from the other device
+ */
+ importSecretsBundle?(secrets: Awaited>): Promise;
}
/** A reason code for a failure to decrypt an event. */
@@ -539,6 +557,12 @@ export enum DecryptionFailureCode {
/** Message was encrypted with a Megolm session whose keys have not been shared with us. */
MEGOLM_UNKNOWN_INBOUND_SESSION_ID = "MEGOLM_UNKNOWN_INBOUND_SESSION_ID",
+ /** A special case of {@link MEGOLM_UNKNOWN_INBOUND_SESSION_ID}: the sender has told us it is withholding the key. */
+ MEGOLM_KEY_WITHHELD = "MEGOLM_KEY_WITHHELD",
+
+ /** A special case of {@link MEGOLM_KEY_WITHHELD}: the sender has told us it is withholding the key, because the current device is unverified. */
+ MEGOLM_KEY_WITHHELD_FOR_UNVERIFIED_DEVICE = "MEGOLM_KEY_WITHHELD_FOR_UNVERIFIED_DEVICE",
+
/** Message was encrypted with a Megolm session which has been shared with us, but in a later ratchet state. */
OLM_UNKNOWN_MESSAGE_INDEX = "OLM_UNKNOWN_MESSAGE_INDEX",
@@ -785,6 +809,8 @@ export interface CryptoCallbacks extends SecretStorageCallbacks {
* @param key - private key to store
*/
cacheSecretStorageKey?: (keyId: string, keyInfo: SecretStorageKeyDescription, key: Uint8Array) => void;
+
+ /** @deprecated: unused with the Rust crypto stack. */
onSecretRequested?: (
userId: string,
deviceId: string,
@@ -792,10 +818,13 @@ export interface CryptoCallbacks extends SecretStorageCallbacks {
secretName: string,
deviceTrust: DeviceVerificationStatus,
) => Promise;
+
+ /** @deprecated: unused with the Rust crypto stack. */
getDehydrationKey?: (
keyInfo: SecretStorageKeyDescription,
checkFunc: (key: Uint8Array) => void,
) => Promise;
+
getBackupKey?: () => Promise;
}
@@ -830,9 +859,14 @@ export interface CreateSecretStorageOpts {
setupNewSecretStorage?: boolean;
/**
- * Function called to get the user's
- * current key backup passphrase. Should return a promise that resolves with a Uint8Array
+ * Function called to get the user's current key backup passphrase.
+ *
+ * Should return a promise that resolves with a Uint8Array
* containing the key, or rejects if the key cannot be obtained.
+ *
+ * Only used when the client has existing key backup, but no secret storage.
+ *
+ * @deprecated Not used by the Rust crypto stack.
*/
getKeyBackupPassphrase?: () => Promise;
}
@@ -931,5 +965,5 @@ export interface OwnDeviceKeys {
curve25519: string;
}
-export * from "./crypto-api/verification";
-export * from "./crypto-api/keybackup";
+export * from "./verification.ts";
+export * from "./keybackup.ts";
diff --git a/src/crypto-api/keybackup.ts b/src/crypto-api/keybackup.ts
index 71c47d6834f..3209de6c320 100644
--- a/src/crypto-api/keybackup.ts
+++ b/src/crypto-api/keybackup.ts
@@ -14,8 +14,8 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { ISigned } from "../@types/signed";
-import { IEncryptedPayload } from "../crypto/aes";
+import { ISigned } from "../@types/signed.ts";
+import { IEncryptedPayload } from "../crypto/aes.ts";
export interface Curve25519AuthData {
public_key: string;
diff --git a/src/crypto-api/verification.ts b/src/crypto-api/verification.ts
index dd42dc35c9b..daa7bdbceed 100644
--- a/src/crypto-api/verification.ts
+++ b/src/crypto-api/verification.ts
@@ -14,8 +14,8 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { MatrixEvent } from "../models/event";
-import { TypedEventEmitter } from "../models/typed-event-emitter";
+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.
diff --git a/src/crypto/CrossSigning.ts b/src/crypto/CrossSigning.ts
index 95d20da052e..a4caf1c53a1 100644
--- a/src/crypto/CrossSigning.ts
+++ b/src/crypto/CrossSigning.ts
@@ -19,19 +19,23 @@ limitations under the License.
*/
import type { PkSigning } from "@matrix-org/olm";
-import { IObject, pkSign, pkVerify } from "./olmlib";
-import { logger } from "../logger";
-import { IndexedDBCryptoStore } from "../crypto/store/indexeddb-crypto-store";
-import { decryptAES, encryptAES } from "./aes";
-import { DeviceInfo } from "./deviceinfo";
-import { ISignedKey, MatrixClient } from "../client";
-import { OlmDevice } from "./OlmDevice";
-import { ICryptoCallbacks } from ".";
-import { ISignatures } from "../@types/signed";
-import { CryptoStore, SecretStorePrivateKeys } from "./store/base";
-import { ServerSideSecretStorage, SecretStorageKeyDescription } from "../secret-storage";
-import { CrossSigningKeyInfo, DeviceVerificationStatus, UserVerificationStatus as UserTrustLevel } from "../crypto-api";
-import { decodeBase64, encodeBase64 } from "../base64";
+import { IObject, pkSign, pkVerify } from "./olmlib.ts";
+import { logger } from "../logger.ts";
+import { IndexedDBCryptoStore } from "../crypto/store/indexeddb-crypto-store.ts";
+import { decryptAES, encryptAES } from "./aes.ts";
+import { DeviceInfo } from "./deviceinfo.ts";
+import { ISignedKey, MatrixClient } from "../client.ts";
+import { OlmDevice } from "./OlmDevice.ts";
+import { ICryptoCallbacks } from "./index.ts";
+import { ISignatures } from "../@types/signed.ts";
+import { CryptoStore, SecretStorePrivateKeys } from "./store/base.ts";
+import { ServerSideSecretStorage, SecretStorageKeyDescription } from "../secret-storage.ts";
+import {
+ CrossSigningKeyInfo,
+ DeviceVerificationStatus,
+ UserVerificationStatus as UserTrustLevel,
+} from "../crypto-api/index.ts";
+import { decodeBase64, encodeBase64 } from "../base64.ts";
// backwards-compatibility re-exports
export { UserTrustLevel };
diff --git a/src/crypto/DeviceList.ts b/src/crypto/DeviceList.ts
index 8ad3831893a..320ea6a2653 100644
--- a/src/crypto/DeviceList.ts
+++ b/src/crypto/DeviceList.ts
@@ -18,17 +18,17 @@ limitations under the License.
* Manages the list of other users' devices
*/
-import { logger } from "../logger";
-import { DeviceInfo, IDevice } from "./deviceinfo";
-import { CrossSigningInfo, ICrossSigningInfo } from "./CrossSigning";
-import * as olmlib from "./olmlib";
-import { IndexedDBCryptoStore } from "./store/indexeddb-crypto-store";
-import { chunkPromises, defer, IDeferred, sleep } from "../utils";
-import { DeviceKeys, IDownloadKeyResult, Keys, MatrixClient, SigningKeys } from "../client";
-import { OlmDevice } from "./OlmDevice";
-import { CryptoStore } from "./store/base";
-import { TypedEventEmitter } from "../models/typed-event-emitter";
-import { CryptoEvent, CryptoEventHandlerMap } from "./index";
+import { logger } from "../logger.ts";
+import { DeviceInfo, IDevice } from "./deviceinfo.ts";
+import { CrossSigningInfo, ICrossSigningInfo } from "./CrossSigning.ts";
+import * as olmlib from "./olmlib.ts";
+import { IndexedDBCryptoStore } from "./store/indexeddb-crypto-store.ts";
+import { chunkPromises, defer, IDeferred, sleep } from "../utils.ts";
+import { DeviceKeys, IDownloadKeyResult, Keys, MatrixClient, SigningKeys } from "../client.ts";
+import { OlmDevice } from "./OlmDevice.ts";
+import { CryptoStore } from "./store/base.ts";
+import { TypedEventEmitter } from "../models/typed-event-emitter.ts";
+import { CryptoEvent, CryptoEventHandlerMap } from "./index.ts";
/* State transition diagram for DeviceList.deviceTrackingStatus
*
diff --git a/src/crypto/EncryptionSetup.ts b/src/crypto/EncryptionSetup.ts
index b7015b5a0ba..dab5d560693 100644
--- a/src/crypto/EncryptionSetup.ts
+++ b/src/crypto/EncryptionSetup.ts
@@ -14,17 +14,17 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { logger } from "../logger";
-import { MatrixEvent } from "../models/event";
-import { createCryptoStoreCacheCallbacks, ICacheCallbacks } from "./CrossSigning";
-import { IndexedDBCryptoStore } from "./store/indexeddb-crypto-store";
-import { Method, ClientPrefix } from "../http-api";
-import { Crypto, ICryptoCallbacks } from "./index";
-import { ClientEvent, ClientEventHandlerMap, CrossSigningKeys, ISignedKey, KeySignatures } from "../client";
-import { IKeyBackupInfo } from "./keybackup";
-import { TypedEventEmitter } from "../models/typed-event-emitter";
-import { AccountDataClient, SecretStorageKeyDescription } from "../secret-storage";
-import { BootstrapCrossSigningOpts, CrossSigningKeyInfo } from "../crypto-api";
+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"];
diff --git a/src/crypto/OlmDevice.ts b/src/crypto/OlmDevice.ts
index 6e645b72b97..1006bf0de47 100644
--- a/src/crypto/OlmDevice.ts
+++ b/src/crypto/OlmDevice.ts
@@ -16,14 +16,14 @@ limitations under the License.
import { Account, InboundGroupSession, OutboundGroupSession, Session, Utility } from "@matrix-org/olm";
-import { logger, Logger } from "../logger";
-import { IndexedDBCryptoStore } from "./store/indexeddb-crypto-store";
-import { CryptoStore, IProblem, ISessionInfo, IWithheld } from "./store/base";
-import { IOlmDevice, IOutboundGroupSessionKey } from "./algorithms/megolm";
-import { IMegolmSessionData, OlmGroupSessionExtraData } from "../@types/crypto";
-import { IMessage } from "./algorithms/olm";
-import { DecryptionFailureCode } from "../crypto-api";
-import { DecryptionError } from "../common-crypto/CryptoBackend";
+import { logger, Logger } from "../logger.ts";
+import { IndexedDBCryptoStore } from "./store/indexeddb-crypto-store.ts";
+import { CryptoStore, IProblem, ISessionInfo, IWithheld } from "./store/base.ts";
+import { IOlmDevice, IOutboundGroupSessionKey } from "./algorithms/megolm.ts";
+import { IMegolmSessionData, OlmGroupSessionExtraData } from "../@types/crypto.ts";
+import { IMessage } from "./algorithms/olm.ts";
+import { DecryptionFailureCode } from "../crypto-api/index.ts";
+import { DecryptionError } from "../common-crypto/CryptoBackend.ts";
// The maximum size of an event is 65K, and we base64 the content, so this is a
// reasonable approximation to the biggest plaintext we can encrypt.
@@ -1221,13 +1221,13 @@ export class OlmDevice {
this.getInboundGroupSession(roomId, senderKey, sessionId, txn, (session, sessionData, withheld) => {
if (session === null || sessionData === null) {
if (withheld) {
- error = new DecryptionError(
- DecryptionFailureCode.MEGOLM_UNKNOWN_INBOUND_SESSION_ID,
- calculateWithheldMessage(withheld),
- {
- session: senderKey + "|" + sessionId,
- },
- );
+ const failureCode =
+ withheld.code === "m.unverified"
+ ? DecryptionFailureCode.MEGOLM_KEY_WITHHELD_FOR_UNVERIFIED_DEVICE
+ : DecryptionFailureCode.MEGOLM_KEY_WITHHELD;
+ error = new DecryptionError(failureCode, calculateWithheldMessage(withheld), {
+ session: senderKey + "|" + sessionId,
+ });
}
result = null;
return;
@@ -1237,13 +1237,13 @@ export class OlmDevice {
res = session.decrypt(body);
} catch (e) {
if ((e)?.message === "OLM.UNKNOWN_MESSAGE_INDEX" && withheld) {
- error = new DecryptionError(
- DecryptionFailureCode.MEGOLM_UNKNOWN_INBOUND_SESSION_ID,
- calculateWithheldMessage(withheld),
- {
- session: senderKey + "|" + sessionId,
- },
- );
+ const failureCode =
+ withheld.code === "m.unverified"
+ ? DecryptionFailureCode.MEGOLM_KEY_WITHHELD_FOR_UNVERIFIED_DEVICE
+ : DecryptionFailureCode.MEGOLM_KEY_WITHHELD;
+ error = new DecryptionError(failureCode, calculateWithheldMessage(withheld), {
+ session: senderKey + "|" + sessionId,
+ });
} else {
error = e;
}
diff --git a/src/crypto/OutgoingRoomKeyRequestManager.ts b/src/crypto/OutgoingRoomKeyRequestManager.ts
index 4628b3e8dd9..4f3cf2534ae 100644
--- a/src/crypto/OutgoingRoomKeyRequestManager.ts
+++ b/src/crypto/OutgoingRoomKeyRequestManager.ts
@@ -16,12 +16,12 @@ limitations under the License.
import { v4 as uuidv4 } from "uuid";
-import { logger } from "../logger";
-import { MatrixClient } from "../client";
-import { IRoomKeyRequestBody, IRoomKeyRequestRecipient } from "./index";
-import { CryptoStore, OutgoingRoomKeyRequest } from "./store/base";
-import { EventType, ToDeviceMessageId } from "../@types/event";
-import { MapWithDefault } from "../utils";
+import { logger } from "../logger.ts";
+import { MatrixClient } from "../client.ts";
+import { IRoomKeyRequestBody, IRoomKeyRequestRecipient } from "./index.ts";
+import { CryptoStore, OutgoingRoomKeyRequest } from "./store/base.ts";
+import { EventType, ToDeviceMessageId } from "../@types/event.ts";
+import { MapWithDefault } from "../utils.ts";
/**
* Internal module. Management of outgoing room key requests.
diff --git a/src/crypto/RoomList.ts b/src/crypto/RoomList.ts
index b100bd30218..75573d64022 100644
--- a/src/crypto/RoomList.ts
+++ b/src/crypto/RoomList.ts
@@ -18,8 +18,8 @@ limitations under the License.
* Manages the list of encrypted rooms
*/
-import { CryptoStore } from "./store/base";
-import { IndexedDBCryptoStore } from "./store/indexeddb-crypto-store";
+import { CryptoStore } from "./store/base.ts";
+import { IndexedDBCryptoStore } from "./store/indexeddb-crypto-store.ts";
/* eslint-disable camelcase */
export interface IRoomEncryption {
diff --git a/src/crypto/SecretSharing.ts b/src/crypto/SecretSharing.ts
index 5083a8c243b..11def73715e 100644
--- a/src/crypto/SecretSharing.ts
+++ b/src/crypto/SecretSharing.ts
@@ -15,13 +15,13 @@ limitations under the License.
*/
import { v4 as uuidv4 } from "uuid";
-import { MatrixClient } from "../client";
-import { ICryptoCallbacks, IEncryptedContent } from "./index";
-import { defer, IDeferred } from "../utils";
-import { ToDeviceMessageId } from "../@types/event";
-import { logger } from "../logger";
-import { MatrixEvent } from "../models/event";
-import * as olmlib from "./olmlib";
+import { MatrixClient } from "../client.ts";
+import { ICryptoCallbacks, IEncryptedContent } from "./index.ts";
+import { defer, IDeferred } from "../utils.ts";
+import { ToDeviceMessageId } from "../@types/event.ts";
+import { logger } from "../logger.ts";
+import { MatrixEvent } from "../models/event.ts";
+import * as olmlib from "./olmlib.ts";
export interface ISecretRequest {
requestId: string;
diff --git a/src/crypto/SecretStorage.ts b/src/crypto/SecretStorage.ts
index 452d1fde99f..6bd653dd0c0 100644
--- a/src/crypto/SecretStorage.ts
+++ b/src/crypto/SecretStorage.ts
@@ -14,9 +14,9 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { ICryptoCallbacks } from ".";
-import { MatrixEvent } from "../models/event";
-import { MatrixClient } from "../client";
+import { ICryptoCallbacks } from "./index.ts";
+import { MatrixEvent } from "../models/event.ts";
+import { MatrixClient } from "../client.ts";
import {
SecretStorageKeyDescription,
SecretStorageKeyTuple,
@@ -25,8 +25,8 @@ import {
AccountDataClient,
ServerSideSecretStorage,
ServerSideSecretStorageImpl,
-} from "../secret-storage";
-import { ISecretRequest, SecretSharing } from "./SecretSharing";
+} from "../secret-storage.ts";
+import { ISecretRequest, SecretSharing } from "./SecretSharing.ts";
/* re-exports for backwards compatibility */
export type {
@@ -34,9 +34,9 @@ export type {
SecretStorageKeyTuple,
SecretStorageKeyObject,
SECRET_STORAGE_ALGORITHM_V1_AES,
-} from "../secret-storage";
+} from "../secret-storage.ts";
-export type { ISecretRequest } from "./SecretSharing";
+export type { ISecretRequest } from "./SecretSharing.ts";
/**
* Implements Secure Secret Storage and Sharing (MSC1946)
diff --git a/src/crypto/aes.ts b/src/crypto/aes.ts
index 389e2ff6ac3..6c6779d0611 100644
--- a/src/crypto/aes.ts
+++ b/src/crypto/aes.ts
@@ -14,8 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { decodeBase64, encodeBase64 } from "../base64";
-import { subtleCrypto, crypto, TextEncoder } from "./crypto";
+import { decodeBase64, encodeBase64 } from "../base64.ts";
// salt for HKDF, with 8 bytes of zeros
const zeroSalt = new Uint8Array(8);
@@ -49,7 +48,7 @@ export async function encryptAES(
iv = decodeBase64(ivStr);
} else {
iv = new Uint8Array(16);
- crypto.getRandomValues(iv);
+ globalThis.crypto.getRandomValues(iv);
// clear bit 63 of the IV to stop us hitting the 64-bit counter boundary
// (which would mean we wouldn't be able to decrypt on Android). The loss
@@ -60,7 +59,7 @@ export async function encryptAES(
const [aesKey, hmacKey] = await deriveKeys(key, name);
const encodedData = new TextEncoder().encode(data);
- const ciphertext = await subtleCrypto.encrypt(
+ const ciphertext = await globalThis.crypto.subtle.encrypt(
{
name: "AES-CTR",
counter: iv,
@@ -70,7 +69,7 @@ export async function encryptAES(
encodedData,
);
- const hmac = await subtleCrypto.sign({ name: "HMAC" }, hmacKey, ciphertext);
+ const hmac = await globalThis.crypto.subtle.sign({ name: "HMAC" }, hmacKey, ciphertext);
return {
iv: encodeBase64(iv),
@@ -91,11 +90,11 @@ export async function decryptAES(data: IEncryptedPayload, key: Uint8Array, name:
const ciphertext = decodeBase64(data.ciphertext);
- if (!(await subtleCrypto.verify({ name: "HMAC" }, hmacKey, decodeBase64(data.mac), ciphertext))) {
+ if (!(await globalThis.crypto.subtle.verify({ name: "HMAC" }, hmacKey, decodeBase64(data.mac), ciphertext))) {
throw new Error(`Error decrypting secret ${name}: bad MAC`);
}
- const plaintext = await subtleCrypto.decrypt(
+ const plaintext = await globalThis.crypto.subtle.decrypt(
{
name: "AES-CTR",
counter: decodeBase64(data.iv),
@@ -109,8 +108,8 @@ export async function decryptAES(data: IEncryptedPayload, key: Uint8Array, name:
}
async function deriveKeys(key: Uint8Array, name: string): Promise<[CryptoKey, CryptoKey]> {
- const hkdfkey = await subtleCrypto.importKey("raw", key, { name: "HKDF" }, false, ["deriveBits"]);
- const keybits = await subtleCrypto.deriveBits(
+ const hkdfkey = await globalThis.crypto.subtle.importKey("raw", key, { name: "HKDF" }, false, ["deriveBits"]);
+ const keybits = await globalThis.crypto.subtle.deriveBits(
{
name: "HKDF",
salt: zeroSalt,
@@ -126,9 +125,12 @@ async function deriveKeys(key: Uint8Array, name: string): Promise<[CryptoKey, Cr
const aesKey = keybits.slice(0, 32);
const hmacKey = keybits.slice(32);
- const aesProm = subtleCrypto.importKey("raw", aesKey, { name: "AES-CTR" }, false, ["encrypt", "decrypt"]);
+ const aesProm = globalThis.crypto.subtle.importKey("raw", aesKey, { name: "AES-CTR" }, false, [
+ "encrypt",
+ "decrypt",
+ ]);
- const hmacProm = subtleCrypto.importKey(
+ const hmacProm = globalThis.crypto.subtle.importKey(
"raw",
hmacKey,
{
diff --git a/src/crypto/algorithms/base.ts b/src/crypto/algorithms/base.ts
index 37dae34bd77..9b038426147 100644
--- a/src/crypto/algorithms/base.ts
+++ b/src/crypto/algorithms/base.ts
@@ -18,15 +18,15 @@ limitations under the License.
* Internal module. Defines the base classes of the encryption implementations
*/
-import type { IMegolmSessionData } from "../../@types/crypto";
-import { MatrixClient } from "../../client";
-import { Room } from "../../models/room";
-import { OlmDevice } from "../OlmDevice";
-import { IContent, MatrixEvent, RoomMember } from "../../matrix";
-import { Crypto, IEncryptedContent, IEventDecryptionResult, IncomingRoomKeyRequest } from "..";
-import { DeviceInfo } from "../deviceinfo";
-import { IRoomEncryption } from "../RoomList";
-import { DeviceInfoMap } from "../DeviceList";
+import type { IMegolmSessionData } from "../../@types/crypto.ts";
+import { MatrixClient } from "../../client.ts";
+import { Room } from "../../models/room.ts";
+import { OlmDevice } from "../OlmDevice.ts";
+import { IContent, MatrixEvent, RoomMember } from "../../matrix.ts";
+import { Crypto, IEncryptedContent, IEventDecryptionResult, IncomingRoomKeyRequest } from "../index.ts";
+import { DeviceInfo } from "../deviceinfo.ts";
+import { IRoomEncryption } from "../RoomList.ts";
+import { DeviceInfoMap } from "../DeviceList.ts";
/**
* Map of registered encryption algorithm classes. A map from string to {@link EncryptionAlgorithm} class
@@ -66,7 +66,6 @@ export abstract class EncryptionAlgorithm {
protected readonly crypto: Crypto;
protected readonly olmDevice: OlmDevice;
protected readonly baseApis: MatrixClient;
- protected readonly roomId?: string;
/**
* @param params - parameters
@@ -77,7 +76,6 @@ export abstract class EncryptionAlgorithm {
this.crypto = params.crypto;
this.olmDevice = params.olmDevice;
this.baseApis = params.baseApis;
- this.roomId = params.roomId;
}
/**
@@ -127,14 +125,12 @@ export abstract class DecryptionAlgorithm {
protected readonly crypto: Crypto;
protected readonly olmDevice: OlmDevice;
protected readonly baseApis: MatrixClient;
- protected readonly roomId?: string;
public constructor(params: DecryptionClassParams) {
this.userId = params.userId;
this.crypto = params.crypto;
this.olmDevice = params.olmDevice;
this.baseApis = params.baseApis;
- this.roomId = params.roomId;
}
/**
@@ -237,4 +233,4 @@ export function registerAlgorithm(
}
/* Re-export for backwards compatibility. Deprecated: this is an internal class. */
-export { DecryptionError } from "../../common-crypto/CryptoBackend";
+export { DecryptionError } from "../../common-crypto/CryptoBackend.ts";
diff --git a/src/crypto/algorithms/index.ts b/src/crypto/algorithms/index.ts
index b3c5b0ede84..947c6e0ea2b 100644
--- a/src/crypto/algorithms/index.ts
+++ b/src/crypto/algorithms/index.ts
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import "./olm";
-import "./megolm";
+import "./olm.ts";
+import "./megolm.ts";
-export * from "./base";
+export * from "./base.ts";
diff --git a/src/crypto/algorithms/megolm.ts b/src/crypto/algorithms/megolm.ts
index 5fa4a1b757e..9fde8e5bc9c 100644
--- a/src/crypto/algorithms/megolm.ts
+++ b/src/crypto/algorithms/megolm.ts
@@ -20,9 +20,9 @@ limitations under the License.
import { v4 as uuidv4 } from "uuid";
-import type { IEventDecryptionResult, IMegolmSessionData } from "../../@types/crypto";
-import { logger, Logger } from "../../logger";
-import * as olmlib from "../olmlib";
+import type { IEventDecryptionResult, IMegolmSessionData } from "../../@types/crypto.ts";
+import { logger, Logger } from "../../logger.ts";
+import * as olmlib from "../olmlib.ts";
import {
DecryptionAlgorithm,
DecryptionClassParams,
@@ -30,22 +30,22 @@ import {
IParams,
registerAlgorithm,
UnknownDeviceError,
-} from "./base";
-import { IDecryptedGroupMessage, WITHHELD_MESSAGES } from "../OlmDevice";
-import { Room } from "../../models/room";
-import { DeviceInfo } from "../deviceinfo";
-import { IOlmSessionResult } from "../olmlib";
-import { DeviceInfoMap } from "../DeviceList";
-import { IContent, MatrixEvent } from "../../models/event";
-import { EventType, MsgType, ToDeviceMessageId } from "../../@types/event";
-import { IMegolmEncryptedContent, IncomingRoomKeyRequest, IEncryptedContent } from "../index";
-import { RoomKeyRequestState } from "../OutgoingRoomKeyRequestManager";
-import { OlmGroupSessionExtraData } from "../../@types/crypto";
-import { MatrixError } from "../../http-api";
-import { immediate, MapWithDefault } from "../../utils";
-import { KnownMembership } from "../../@types/membership";
-import { DecryptionFailureCode } from "../../crypto-api";
-import { DecryptionError } from "../../common-crypto/CryptoBackend";
+} from "./base.ts";
+import { IDecryptedGroupMessage, WITHHELD_MESSAGES } from "../OlmDevice.ts";
+import { Room } from "../../models/room.ts";
+import { DeviceInfo } from "../deviceinfo.ts";
+import { IOlmSessionResult } from "../olmlib.ts";
+import { DeviceInfoMap } from "../DeviceList.ts";
+import { IContent, MatrixEvent } from "../../models/event.ts";
+import { EventType, MsgType, ToDeviceMessageId } from "../../@types/event.ts";
+import { IMegolmEncryptedContent, IncomingRoomKeyRequest, IEncryptedContent } from "../index.ts";
+import { RoomKeyRequestState } from "../OutgoingRoomKeyRequestManager.ts";
+import { OlmGroupSessionExtraData } from "../../@types/crypto.ts";
+import { MatrixError } from "../../http-api/index.ts";
+import { immediate, MapWithDefault } from "../../utils.ts";
+import { KnownMembership } from "../../@types/membership.ts";
+import { DecryptionFailureCode } from "../../crypto-api/index.ts";
+import { DecryptionError } from "../../common-crypto/CryptoBackend.ts";
// determine whether the key can be shared with invitees
export function isRoomSharedHistory(room: Room): boolean {
diff --git a/src/crypto/algorithms/olm.ts b/src/crypto/algorithms/olm.ts
index 3bcff5872b0..eb93a06a171 100644
--- a/src/crypto/algorithms/olm.ts
+++ b/src/crypto/algorithms/olm.ts
@@ -18,17 +18,17 @@ limitations under the License.
* Defines m.olm encryption/decryption
*/
-import type { IEventDecryptionResult } from "../../@types/crypto";
-import { logger } from "../../logger";
-import * as olmlib from "../olmlib";
-import { DeviceInfo } from "../deviceinfo";
-import { DecryptionAlgorithm, EncryptionAlgorithm, registerAlgorithm } from "./base";
-import { Room } from "../../models/room";
-import { IContent, MatrixEvent } from "../../models/event";
-import { IEncryptedContent, IOlmEncryptedContent } from "../index";
-import { IInboundSession } from "../OlmDevice";
-import { DecryptionFailureCode } from "../../crypto-api";
-import { DecryptionError } from "../../common-crypto/CryptoBackend";
+import type { IEventDecryptionResult } from "../../@types/crypto.ts";
+import { logger } from "../../logger.ts";
+import * as olmlib from "../olmlib.ts";
+import { DeviceInfo } from "../deviceinfo.ts";
+import { DecryptionAlgorithm, EncryptionAlgorithm, registerAlgorithm } from "./base.ts";
+import { Room } from "../../models/room.ts";
+import { IContent, MatrixEvent } from "../../models/event.ts";
+import { IEncryptedContent, IOlmEncryptedContent } from "../index.ts";
+import { IInboundSession } from "../OlmDevice.ts";
+import { DecryptionFailureCode } from "../../crypto-api/index.ts";
+import { DecryptionError } from "../../common-crypto/CryptoBackend.ts";
const DeviceVerification = DeviceInfo.DeviceVerification;
diff --git a/src/crypto/api.ts b/src/crypto/api.ts
index a0e11a415be..0b520277772 100644
--- a/src/crypto/api.ts
+++ b/src/crypto/api.ts
@@ -14,26 +14,26 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { DeviceInfo } from "./deviceinfo";
+import { DeviceInfo } from "./deviceinfo.ts";
/* re-exports for backwards compatibility. */
// CrossSigningKey is used as a value in `client.ts`, we can't export it as a type
-export { CrossSigningKey } from "../crypto-api";
+export { CrossSigningKey } from "../crypto-api/index.ts";
export type {
GeneratedSecretStorageKey as IRecoveryKey,
CreateSecretStorageOpts as ICreateSecretStorageOpts,
-} from "../crypto-api";
+} from "../crypto-api/index.ts";
export type {
ImportRoomKeyProgressData as IImportOpts,
ImportRoomKeysOpts as IImportRoomKeysOpts,
-} from "../crypto-api";
+} from "../crypto-api/index.ts";
export type {
AddSecretStorageKeyOpts as IAddSecretStorageKeyOpts,
PassphraseInfo as IPassphraseInfo,
SecretStorageKeyDescription as ISecretStorageKeyInfo,
-} from "../secret-storage";
+} from "../secret-storage.ts";
// TODO: Merge this with crypto.js once converted
diff --git a/src/crypto/backup.ts b/src/crypto/backup.ts
index d51fa641c26..3ac6a3ddc0b 100644
--- a/src/crypto/backup.ts
+++ b/src/crypto/backup.ts
@@ -18,30 +18,29 @@ limitations under the License.
* Classes for dealing with key backup.
*/
-import type { IMegolmSessionData } from "../@types/crypto";
-import { MatrixClient } from "../client";
-import { logger } from "../logger";
-import { MEGOLM_ALGORITHM, verifySignature } from "./olmlib";
-import { DeviceInfo } from "./deviceinfo";
-import { DeviceTrustLevel } from "./CrossSigning";
-import { keyFromPassphrase } from "./key_passphrase";
-import { encodeUri, safeSet, sleep } from "../utils";
-import { IndexedDBCryptoStore } from "./store/indexeddb-crypto-store";
-import { encodeRecoveryKey } from "./recoverykey";
-import { calculateKeyCheck, decryptAES, encryptAES, IEncryptedPayload } from "./aes";
+import type { IMegolmSessionData } from "../@types/crypto.ts";
+import { MatrixClient } from "../client.ts";
+import { logger } from "../logger.ts";
+import { MEGOLM_ALGORITHM, verifySignature } from "./olmlib.ts";
+import { DeviceInfo } from "./deviceinfo.ts";
+import { DeviceTrustLevel } from "./CrossSigning.ts";
+import { keyFromPassphrase } from "./key_passphrase.ts";
+import { encodeUri, safeSet, sleep } from "../utils.ts";
+import { IndexedDBCryptoStore } from "./store/indexeddb-crypto-store.ts";
+import { encodeRecoveryKey } from "./recoverykey.ts";
+import { calculateKeyCheck, decryptAES, encryptAES, IEncryptedPayload } from "./aes.ts";
import {
Curve25519SessionData,
IAes256AuthData,
ICurve25519AuthData,
IKeyBackupInfo,
IKeyBackupSession,
-} from "./keybackup";
-import { UnstableValue } from "../NamespacedValue";
-import { CryptoEvent } from "./index";
-import { crypto } from "./crypto";
-import { ClientPrefix, HTTPError, MatrixError, Method } from "../http-api";
-import { BackupTrustInfo } from "../crypto-api/keybackup";
-import { BackupDecryptor } from "../common-crypto/CryptoBackend";
+} from "./keybackup.ts";
+import { UnstableValue } from "../NamespacedValue.ts";
+import { CryptoEvent } from "./index.ts";
+import { ClientPrefix, HTTPError, MatrixError, Method } from "../http-api/index.ts";
+import { BackupTrustInfo } from "../crypto-api/keybackup.ts";
+import { BackupDecryptor } from "../common-crypto/CryptoBackend.ts";
const KEY_BACKUP_KEYS_PER_REQUEST = 200;
const KEY_BACKUP_CHECK_RATE_LIMIT = 5000; // ms
@@ -764,7 +763,7 @@ export class Curve25519 implements BackupAlgorithm {
function randomBytes(size: number): Uint8Array {
const buf = new Uint8Array(size);
- crypto.getRandomValues(buf);
+ globalThis.crypto.getRandomValues(buf);
return buf;
}
diff --git a/src/crypto/crypto.ts b/src/crypto/crypto.ts
index 170dabb0937..4aea59de52b 100644
--- a/src/crypto/crypto.ts
+++ b/src/crypto/crypto.ts
@@ -14,37 +14,5 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { logger } from "../logger";
-
-export let crypto = globalThis.crypto;
-export let subtleCrypto = crypto?.subtle ?? crypto?.webkitSubtle; // TODO: Stop using webkitSubtle fallback
-export let TextEncoder = globalThis.TextEncoder;
-
-/* eslint-disable @typescript-eslint/no-var-requires */
-if (!crypto) {
- try {
- crypto = require("crypto").webcrypto;
- } catch (e) {
- logger.error("Failed to load webcrypto", e);
- }
-}
-if (!subtleCrypto) {
- subtleCrypto = crypto?.subtle;
-}
-if (!TextEncoder) {
- try {
- TextEncoder = require("util").TextEncoder;
- } catch (e) {
- logger.error("Failed to load TextEncoder util", e);
- }
-}
-/* eslint-enable @typescript-eslint/no-var-requires */
-
-export function setCrypto(_crypto: Crypto): void {
- crypto = _crypto;
- subtleCrypto = _crypto.subtle ?? _crypto.webkitSubtle;
-}
-
-export function setTextEncoder(_TextEncoder: typeof TextEncoder): void {
- TextEncoder = _TextEncoder;
-}
+/** @deprecated this is a no-op and should no longer be called. */
+export function setCrypto(_crypto: Crypto): void {}
diff --git a/src/crypto/dehydration.ts b/src/crypto/dehydration.ts
index a24e65e4537..01dafa83c71 100644
--- a/src/crypto/dehydration.ts
+++ b/src/crypto/dehydration.ts
@@ -16,14 +16,14 @@ limitations under the License.
import anotherjson from "another-json";
-import type { IDeviceKeys, IOneTimeKey } from "../@types/crypto";
-import { decodeBase64, encodeBase64 } from "../base64";
-import { IndexedDBCryptoStore } from "../crypto/store/indexeddb-crypto-store";
-import { decryptAES, encryptAES } from "./aes";
-import { logger } from "../logger";
-import { Crypto } from "./index";
-import { Method } from "../http-api";
-import { SecretStorageKeyDescription } from "../secret-storage";
+import type { IDeviceKeys, IOneTimeKey } from "../@types/crypto.ts";
+import { decodeBase64, encodeBase64 } from "../base64.ts";
+import { IndexedDBCryptoStore } from "../crypto/store/indexeddb-crypto-store.ts";
+import { decryptAES, encryptAES } from "./aes.ts";
+import { logger } from "../logger.ts";
+import { Crypto } from "./index.ts";
+import { Method } from "../http-api/index.ts";
+import { SecretStorageKeyDescription } from "../secret-storage.ts";
export interface IDehydratedDevice {
device_id: string; // eslint-disable-line camelcase
diff --git a/src/crypto/device-converter.ts b/src/crypto/device-converter.ts
index cf32ef6141e..a2591150cfc 100644
--- a/src/crypto/device-converter.ts
+++ b/src/crypto/device-converter.ts
@@ -14,8 +14,8 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { Device } from "../models/device";
-import { DeviceInfo } from "./deviceinfo";
+import { Device } from "../models/device.ts";
+import { DeviceInfo } from "./deviceinfo.ts";
/**
* Convert a {@link DeviceInfo} to a {@link Device}.
diff --git a/src/crypto/deviceinfo.ts b/src/crypto/deviceinfo.ts
index 8b41c3c6784..7641af31692 100644
--- a/src/crypto/deviceinfo.ts
+++ b/src/crypto/deviceinfo.ts
@@ -14,8 +14,8 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { ISignatures } from "../@types/signed";
-import { DeviceVerification } from "../models/device";
+import { ISignatures } from "../@types/signed.ts";
+import { DeviceVerification } from "../models/device.ts";
export interface IDevice {
keys: Record;
diff --git a/src/crypto/index.ts b/src/crypto/index.ts
index 4379c2e1272..420160c0de4 100644
--- a/src/crypto/index.ts
+++ b/src/crypto/index.ts
@@ -20,55 +20,60 @@ limitations under the License.
import anotherjson from "another-json";
import { v4 as uuidv4 } from "uuid";
-import type { IDeviceKeys, IEventDecryptionResult, IMegolmSessionData, IOneTimeKey } from "../@types/crypto";
+import type { IDeviceKeys, IEventDecryptionResult, IMegolmSessionData, IOneTimeKey } from "../@types/crypto.ts";
import type { PkDecryption, PkSigning } from "@matrix-org/olm";
-import { EventType, ToDeviceMessageId } from "../@types/event";
-import { TypedReEmitter } from "../ReEmitter";
-import { logger } from "../logger";
-import { IExportedDevice, OlmDevice } from "./OlmDevice";
-import { IOlmDevice } from "./algorithms/megolm";
-import * as olmlib from "./olmlib";
-import { DeviceInfoMap, DeviceList } from "./DeviceList";
-import { DeviceInfo, IDevice } from "./deviceinfo";
-import type { DecryptionAlgorithm, EncryptionAlgorithm } from "./algorithms";
-import * as algorithms from "./algorithms";
-import { createCryptoStoreCacheCallbacks, CrossSigningInfo, DeviceTrustLevel, UserTrustLevel } from "./CrossSigning";
-import { EncryptionSetupBuilder } from "./EncryptionSetup";
-import { SecretStorage as LegacySecretStorage } from "./SecretStorage";
-import { CrossSigningKey, ICreateSecretStorageOpts, IEncryptedEventInfo, IRecoveryKey } from "./api";
-import { OutgoingRoomKeyRequestManager } from "./OutgoingRoomKeyRequestManager";
-import { IndexedDBCryptoStore } from "./store/indexeddb-crypto-store";
-import { VerificationBase } from "./verification/Base";
-import { ReciprocateQRCode, SCAN_QR_CODE_METHOD, SHOW_QR_CODE_METHOD } from "./verification/QRCode";
-import { SAS as SASVerification } from "./verification/SAS";
-import { keyFromPassphrase } from "./key_passphrase";
-import { decodeRecoveryKey, encodeRecoveryKey } from "./recoverykey";
-import { VerificationRequest } from "./verification/request/VerificationRequest";
-import { InRoomChannel, InRoomRequests } from "./verification/request/InRoomChannel";
-import { Request, ToDeviceChannel, ToDeviceRequests } from "./verification/request/ToDeviceChannel";
-import { IllegalMethod } from "./verification/IllegalMethod";
-import { KeySignatureUploadError } from "../errors";
-import { calculateKeyCheck, decryptAES, encryptAES, IEncryptedPayload } from "./aes";
-import { DehydrationManager } from "./dehydration";
-import { BackupManager, LibOlmBackupDecryptor, backupTrustInfoFromLegacyTrustInfo } from "./backup";
-import { IStore } from "../store";
-import { Room, RoomEvent } from "../models/room";
-import { RoomMember, RoomMemberEvent } from "../models/room-member";
-import { EventStatus, IContent, IEvent, MatrixEvent, MatrixEventEvent } from "../models/event";
-import { ToDeviceBatch } from "../models/ToDeviceMessage";
-import { ClientEvent, IKeysUploadResponse, ISignedKey, IUploadKeySignaturesResponse, MatrixClient } from "../client";
-import { IRoomEncryption, RoomList } from "./RoomList";
-import { IKeyBackupInfo } from "./keybackup";
-import { ISyncStateData } from "../sync";
-import { CryptoStore } from "./store/base";
-import { IVerificationChannel } from "./verification/request/Channel";
-import { TypedEventEmitter } from "../models/typed-event-emitter";
-import { IDeviceLists, ISyncResponse, IToDeviceEvent } from "../sync-accumulator";
-import { ISignatures } from "../@types/signed";
-import { IMessage } from "./algorithms/olm";
-import { BackupDecryptor, CryptoBackend, DecryptionError, OnSyncCompletedData } from "../common-crypto/CryptoBackend";
-import { RoomState, RoomStateEvent } from "../models/room-state";
-import { MapWithDefault, recursiveMapToObject } from "../utils";
+import { EventType, ToDeviceMessageId } from "../@types/event.ts";
+import { TypedReEmitter } from "../ReEmitter.ts";
+import { logger } from "../logger.ts";
+import { IExportedDevice, OlmDevice } from "./OlmDevice.ts";
+import { IOlmDevice } from "./algorithms/megolm.ts";
+import * as olmlib from "./olmlib.ts";
+import { DeviceInfoMap, DeviceList } from "./DeviceList.ts";
+import { DeviceInfo, IDevice } from "./deviceinfo.ts";
+import type { DecryptionAlgorithm, EncryptionAlgorithm } from "./algorithms/index.ts";
+import * as algorithms from "./algorithms/index.ts";
+import { createCryptoStoreCacheCallbacks, CrossSigningInfo, DeviceTrustLevel, UserTrustLevel } from "./CrossSigning.ts";
+import { EncryptionSetupBuilder } from "./EncryptionSetup.ts";
+import { SecretStorage as LegacySecretStorage } from "./SecretStorage.ts";
+import { CrossSigningKey, ICreateSecretStorageOpts, IEncryptedEventInfo, IRecoveryKey } from "./api.ts";
+import { OutgoingRoomKeyRequestManager } from "./OutgoingRoomKeyRequestManager.ts";
+import { IndexedDBCryptoStore } from "./store/indexeddb-crypto-store.ts";
+import { VerificationBase } from "./verification/Base.ts";
+import { ReciprocateQRCode, SCAN_QR_CODE_METHOD, SHOW_QR_CODE_METHOD } from "./verification/QRCode.ts";
+import { SAS as SASVerification } from "./verification/SAS.ts";
+import { keyFromPassphrase } from "./key_passphrase.ts";
+import { decodeRecoveryKey, encodeRecoveryKey } from "./recoverykey.ts";
+import { VerificationRequest } from "./verification/request/VerificationRequest.ts";
+import { InRoomChannel, InRoomRequests } from "./verification/request/InRoomChannel.ts";
+import { Request, ToDeviceChannel, ToDeviceRequests } from "./verification/request/ToDeviceChannel.ts";
+import { IllegalMethod } from "./verification/IllegalMethod.ts";
+import { KeySignatureUploadError } from "../errors.ts";
+import { calculateKeyCheck, decryptAES, encryptAES, IEncryptedPayload } from "./aes.ts";
+import { DehydrationManager } from "./dehydration.ts";
+import { BackupManager, LibOlmBackupDecryptor, backupTrustInfoFromLegacyTrustInfo } from "./backup.ts";
+import { IStore } from "../store/index.ts";
+import { Room, RoomEvent } from "../models/room.ts";
+import { RoomMember, RoomMemberEvent } from "../models/room-member.ts";
+import { EventStatus, IContent, IEvent, MatrixEvent, MatrixEventEvent } from "../models/event.ts";
+import { ToDeviceBatch } from "../models/ToDeviceMessage.ts";
+import { ClientEvent, IKeysUploadResponse, ISignedKey, IUploadKeySignaturesResponse, MatrixClient } from "../client.ts";
+import { IRoomEncryption, RoomList } from "./RoomList.ts";
+import { IKeyBackupInfo } from "./keybackup.ts";
+import { ISyncStateData } from "../sync.ts";
+import { CryptoStore } from "./store/base.ts";
+import { IVerificationChannel } from "./verification/request/Channel.ts";
+import { TypedEventEmitter } from "../models/typed-event-emitter.ts";
+import { IDeviceLists, ISyncResponse, IToDeviceEvent } from "../sync-accumulator.ts";
+import { ISignatures } from "../@types/signed.ts";
+import { IMessage } from "./algorithms/olm.ts";
+import {
+ BackupDecryptor,
+ CryptoBackend,
+ DecryptionError,
+ OnSyncCompletedData,
+} from "../common-crypto/CryptoBackend.ts";
+import { RoomState, RoomStateEvent } from "../models/room-state.ts";
+import { MapWithDefault, recursiveMapToObject } from "../utils.ts";
import {
AccountDataClient,
AddSecretStorageKeyOpts,
@@ -77,8 +82,8 @@ import {
SecretStorageKeyObject,
SecretStorageKeyTuple,
ServerSideSecretStorageImpl,
-} from "../secret-storage";
-import { ISecretRequest } from "./SecretSharing";
+} from "../secret-storage.ts";
+import { ISecretRequest } from "./SecretSharing.ts";
import {
BackupTrustInfo,
BootstrapCrossSigningOpts,
@@ -94,18 +99,18 @@ import {
KeyBackupInfo,
OwnDeviceKeys,
VerificationRequest as CryptoApiVerificationRequest,
-} from "../crypto-api";
-import { Device, DeviceMap } from "../models/device";
-import { deviceInfoToDevice } from "./device-converter";
-import { ClientPrefix, MatrixError, Method } from "../http-api";
-import { decodeBase64, encodeBase64 } from "../base64";
-import { KnownMembership } from "../@types/membership";
+} from "../crypto-api/index.ts";
+import { Device, DeviceMap } from "../models/device.ts";
+import { deviceInfoToDevice } from "./device-converter.ts";
+import { ClientPrefix, MatrixError, Method } from "../http-api/index.ts";
+import { decodeBase64, encodeBase64 } from "../base64.ts";
+import { KnownMembership } from "../@types/membership.ts";
/* re-exports for backwards compatibility */
export type {
BootstrapCrossSigningOpts as IBootstrapCrossSigningOpts,
CryptoCallbacks as ICryptoCallbacks,
-} from "../crypto-api";
+} from "../crypto-api/index.ts";
const DeviceVerification = DeviceInfo.DeviceVerification;
@@ -276,7 +281,7 @@ export type CryptoEventHandlerMap = {
* @param deviceId - the id of the verified device
* @param deviceInfo - updated device information
*/
- [CryptoEvent.DeviceVerificationChanged]: (userId: string, deviceId: string, device: DeviceInfo) => void;
+ [CryptoEvent.DeviceVerificationChanged]: (userId: string, deviceId: string, deviceInfo: DeviceInfo) => void;
/**
* Fires when the trust status of a user changes
* If userId is the userId of the logged-in user, this indicated a change
@@ -292,7 +297,7 @@ export type CryptoEventHandlerMap = {
/**
* Fires when we receive a room key request
*
- * @param req - request details
+ * @param request - request details
*/
[CryptoEvent.RoomKeyRequest]: (request: IncomingRoomKeyRequest) => void;
/**
@@ -4374,4 +4379,4 @@ class IncomingRoomKeyRequestCancellation {
}
// a number of types are re-exported for backwards compatibility, in case any applications are referencing it.
-export type { IEventDecryptionResult, IMegolmSessionData } from "../@types/crypto";
+export type { IEventDecryptionResult, IMegolmSessionData } from "../@types/crypto.ts";
diff --git a/src/crypto/key_passphrase.ts b/src/crypto/key_passphrase.ts
index f6fe7b6b7d7..85b9c48fbcd 100644
--- a/src/crypto/key_passphrase.ts
+++ b/src/crypto/key_passphrase.ts
@@ -14,8 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { randomString } from "../randomstring";
-import { subtleCrypto, TextEncoder } from "./crypto";
+import { randomString } from "../randomstring.ts";
const DEFAULT_ITERATIONS = 500000;
@@ -36,10 +35,6 @@ interface IKey {
}
export function keyFromAuthData(authData: IAuthData, password: string): Promise {
- if (!global.Olm) {
- throw new Error("Olm is not available");
- }
-
if (!authData.private_key_salt || !authData.private_key_iterations) {
throw new Error("Salt and/or iterations not found: " + "this backup cannot be restored with a passphrase");
}
@@ -53,10 +48,6 @@ export function keyFromAuthData(authData: IAuthData, password: string): Promise<
}
export async function keyFromPassphrase(password: string): Promise {
- if (!global.Olm) {
- throw new Error("Olm is not available");
- }
-
const salt = randomString(32);
const key = await deriveKey(password, salt, DEFAULT_ITERATIONS, DEFAULT_BITSIZE);
@@ -70,15 +61,19 @@ export async function deriveKey(
iterations: number,
numBits = DEFAULT_BITSIZE,
): Promise {
- if (!subtleCrypto || !TextEncoder) {
+ if (!globalThis.crypto.subtle || !TextEncoder) {
throw new Error("Password-based backup is not available on this platform");
}
- const key = await subtleCrypto.importKey("raw", new TextEncoder().encode(password), { name: "PBKDF2" }, false, [
- "deriveBits",
- ]);
+ const key = await globalThis.crypto.subtle.importKey(
+ "raw",
+ new TextEncoder().encode(password),
+ { name: "PBKDF2" },
+ false,
+ ["deriveBits"],
+ );
- const keybits = await subtleCrypto.deriveBits(
+ const keybits = await globalThis.crypto.subtle.deriveBits(
{
name: "PBKDF2",
salt: new TextEncoder().encode(salt),
diff --git a/src/crypto/keybackup.ts b/src/crypto/keybackup.ts
index 8ef04176cb2..4399a38601f 100644
--- a/src/crypto/keybackup.ts
+++ b/src/crypto/keybackup.ts
@@ -15,7 +15,7 @@ limitations under the License.
*/
// Export for backward compatibility
-import { ImportRoomKeyProgressData } from "../crypto-api";
+import { ImportRoomKeyProgressData } from "../crypto-api/index.ts";
export type {
Curve25519AuthData as ICurve25519AuthData,
@@ -24,7 +24,7 @@ export type {
Curve25519SessionData,
KeyBackupSession as IKeyBackupSession,
KeyBackupRoomSessions as IKeyBackupRoomSessions,
-} from "../crypto-api/keybackup";
+} from "../crypto-api/keybackup.ts";
/* eslint-enable camelcase */
diff --git a/src/crypto/olmlib.ts b/src/crypto/olmlib.ts
index 7396ef47988..9eceaf48bc7 100644
--- a/src/crypto/olmlib.ts
+++ b/src/crypto/olmlib.ts
@@ -21,16 +21,16 @@ limitations under the License.
import anotherjson from "another-json";
import type { PkSigning } from "@matrix-org/olm";
-import type { IOneTimeKey } from "../@types/crypto";
-import { OlmDevice } from "./OlmDevice";
-import { DeviceInfo } from "./deviceinfo";
-import { Logger, logger } from "../logger";
-import { IClaimOTKsResult, MatrixClient } from "../client";
-import { ISignatures } from "../@types/signed";
-import { MatrixEvent } from "../models/event";
-import { EventType } from "../@types/event";
-import { IMessage } from "./algorithms/olm";
-import { MapWithDefault } from "../utils";
+import type { IOneTimeKey } from "../@types/crypto.ts";
+import { OlmDevice } from "./OlmDevice.ts";
+import { DeviceInfo } from "./deviceinfo.ts";
+import { Logger, logger } from "../logger.ts";
+import { IClaimOTKsResult, MatrixClient } from "../client.ts";
+import { ISignatures } from "../@types/signed.ts";
+import { MatrixEvent } from "../models/event.ts";
+import { EventType } from "../@types/event.ts";
+import { IMessage } from "./algorithms/olm.ts";
+import { MapWithDefault } from "../utils.ts";
enum Algorithm {
Olm = "m.olm.v1.curve25519-aes-sha2",
diff --git a/src/crypto/recoverykey.ts b/src/crypto/recoverykey.ts
index 8c6a7e33ed7..3d7c12d4acf 100644
--- a/src/crypto/recoverykey.ts
+++ b/src/crypto/recoverykey.ts
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import * as bs58 from "bs58";
+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)
diff --git a/src/crypto/store/base.ts b/src/crypto/store/base.ts
index 871804b7379..daf11b5b0b3 100644
--- a/src/crypto/store/base.ts
+++ b/src/crypto/store/base.ts
@@ -14,19 +14,19 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { IRoomKeyRequestBody, IRoomKeyRequestRecipient } from "../index";
-import { RoomKeyRequestState } from "../OutgoingRoomKeyRequestManager";
-import { IOlmDevice } from "../algorithms/megolm";
-import { TrackingStatus } from "../DeviceList";
-import { IRoomEncryption } from "../RoomList";
-import { IDevice } from "../deviceinfo";
-import { ICrossSigningInfo } from "../CrossSigning";
-import { Logger } from "../../logger";
-import { InboundGroupSessionData } from "../OlmDevice";
-import { MatrixEvent } from "../../models/event";
-import { DehydrationManager } from "../dehydration";
-import { IEncryptedPayload } from "../aes";
-import { CrossSigningKeyInfo } from "../../crypto-api";
+import { IRoomKeyRequestBody, IRoomKeyRequestRecipient } from "../index.ts";
+import { RoomKeyRequestState } from "../OutgoingRoomKeyRequestManager.ts";
+import { IOlmDevice } from "../algorithms/megolm.ts";
+import { TrackingStatus } from "../DeviceList.ts";
+import { IRoomEncryption } from "../RoomList.ts";
+import { IDevice } from "../deviceinfo.ts";
+import { ICrossSigningInfo } from "../CrossSigning.ts";
+import { Logger } from "../../logger.ts";
+import { InboundGroupSessionData } from "../OlmDevice.ts";
+import { MatrixEvent } from "../../models/event.ts";
+import { DehydrationManager } from "../dehydration.ts";
+import { IEncryptedPayload } from "../aes.ts";
+import { CrossSigningKeyInfo } from "../../crypto-api/index.ts";
/**
* Internal module. Definitions for storage for the crypto module
diff --git a/src/crypto/store/indexeddb-crypto-store-backend.ts b/src/crypto/store/indexeddb-crypto-store-backend.ts
index 08d4c0f6e98..1ef3dd120e2 100644
--- a/src/crypto/store/indexeddb-crypto-store-backend.ts
+++ b/src/crypto/store/indexeddb-crypto-store-backend.ts
@@ -14,8 +14,8 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { Logger, logger } from "../../logger";
-import { deepCompare } from "../../utils";
+import { Logger, logger } from "../../logger.ts";
+import { deepCompare } from "../../utils.ts";
import {
CryptoStore,
IDeviceData,
@@ -31,13 +31,13 @@ import {
SecretStorePrivateKeys,
SESSION_BATCH_SIZE,
ACCOUNT_OBJECT_KEY_MIGRATION_STATE,
-} from "./base";
-import { IRoomKeyRequestBody, IRoomKeyRequestRecipient } from "../index";
-import { IOlmDevice } from "../algorithms/megolm";
-import { IRoomEncryption } from "../RoomList";
-import { InboundGroupSessionData } from "../OlmDevice";
-import { IndexedDBCryptoStore } from "./indexeddb-crypto-store";
-import { CrossSigningKeyInfo } from "../../crypto-api";
+} from "./base.ts";
+import { IRoomKeyRequestBody, IRoomKeyRequestRecipient } from "../index.ts";
+import { IOlmDevice } from "../algorithms/megolm.ts";
+import { IRoomEncryption } from "../RoomList.ts";
+import { InboundGroupSessionData } from "../OlmDevice.ts";
+import { IndexedDBCryptoStore } from "./indexeddb-crypto-store.ts";
+import { CrossSigningKeyInfo } from "../../crypto-api/index.ts";
const PROFILE_TRANSACTIONS = false;
diff --git a/src/crypto/store/indexeddb-crypto-store.ts b/src/crypto/store/indexeddb-crypto-store.ts
index 8fe488e08d0..29d32b5e34c 100644
--- a/src/crypto/store/indexeddb-crypto-store.ts
+++ b/src/crypto/store/indexeddb-crypto-store.ts
@@ -14,12 +14,12 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { logger, Logger } from "../../logger";
-import { LocalStorageCryptoStore } from "./localStorage-crypto-store";
-import { MemoryCryptoStore } from "./memory-crypto-store";
-import * as IndexedDBCryptoStoreBackend from "./indexeddb-crypto-store-backend";
-import { InvalidCryptoStoreError, InvalidCryptoStoreState } from "../../errors";
-import * as IndexedDBHelpers from "../../indexeddb-helpers";
+import { logger, Logger } from "../../logger.ts";
+import { LocalStorageCryptoStore } from "./localStorage-crypto-store.ts";
+import { MemoryCryptoStore } from "./memory-crypto-store.ts";
+import * as IndexedDBCryptoStoreBackend from "./indexeddb-crypto-store-backend.ts";
+import { InvalidCryptoStoreError, InvalidCryptoStoreState } from "../../errors.ts";
+import * as IndexedDBHelpers from "../../indexeddb-helpers.ts";
import {
CryptoStore,
IDeviceData,
@@ -34,12 +34,12 @@ import {
ParkedSharedHistory,
SecretStorePrivateKeys,
ACCOUNT_OBJECT_KEY_MIGRATION_STATE,
-} from "./base";
-import { IRoomKeyRequestBody } from "../index";
-import { IOlmDevice } from "../algorithms/megolm";
-import { IRoomEncryption } from "../RoomList";
-import { InboundGroupSessionData } from "../OlmDevice";
-import { CrossSigningKeyInfo } from "../../crypto-api";
+} from "./base.ts";
+import { IRoomKeyRequestBody } from "../index.ts";
+import { IOlmDevice } from "../algorithms/megolm.ts";
+import { IRoomEncryption } from "../RoomList.ts";
+import { InboundGroupSessionData } from "../OlmDevice.ts";
+import { CrossSigningKeyInfo } from "../../crypto-api/index.ts";
/*
* Internal module. indexeddb storage for e2e.
diff --git a/src/crypto/store/localStorage-crypto-store.ts b/src/crypto/store/localStorage-crypto-store.ts
index 41821ec62a5..d24e648d634 100644
--- a/src/crypto/store/localStorage-crypto-store.ts
+++ b/src/crypto/store/localStorage-crypto-store.ts
@@ -14,8 +14,8 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { logger } from "../../logger";
-import { MemoryCryptoStore } from "./memory-crypto-store";
+import { logger } from "../../logger.ts";
+import { MemoryCryptoStore } from "./memory-crypto-store.ts";
import {
CryptoStore,
IDeviceData,
@@ -28,12 +28,12 @@ import {
Mode,
SecretStorePrivateKeys,
SESSION_BATCH_SIZE,
-} from "./base";
-import { IOlmDevice } from "../algorithms/megolm";
-import { IRoomEncryption } from "../RoomList";
-import { InboundGroupSessionData } from "../OlmDevice";
-import { safeSet } from "../../utils";
-import { CrossSigningKeyInfo } from "../../crypto-api";
+} from "./base.ts";
+import { IOlmDevice } from "../algorithms/megolm.ts";
+import { IRoomEncryption } from "../RoomList.ts";
+import { InboundGroupSessionData } from "../OlmDevice.ts";
+import { safeSet } from "../../utils.ts";
+import { CrossSigningKeyInfo } from "../../crypto-api/index.ts";
/**
* Internal module. Partial localStorage backed storage for e2e.
diff --git a/src/crypto/store/memory-crypto-store.ts b/src/crypto/store/memory-crypto-store.ts
index 4fd8a57f85e..65fca29d7b7 100644
--- a/src/crypto/store/memory-crypto-store.ts
+++ b/src/crypto/store/memory-crypto-store.ts
@@ -14,8 +14,8 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { logger } from "../../logger";
-import { deepCompare, promiseTry, safeSet } from "../../utils";
+import { logger } from "../../logger.ts";
+import { deepCompare, promiseTry, safeSet } from "../../utils.ts";
import {
CryptoStore,
IDeviceData,
@@ -30,12 +30,12 @@ import {
ParkedSharedHistory,
SecretStorePrivateKeys,
SESSION_BATCH_SIZE,
-} from "./base";
-import { IRoomKeyRequestBody } from "../index";
-import { IOlmDevice } from "../algorithms/megolm";
-import { IRoomEncryption } from "../RoomList";
-import { InboundGroupSessionData } from "../OlmDevice";
-import { CrossSigningKeyInfo } from "../../crypto-api";
+} from "./base.ts";
+import { IRoomKeyRequestBody } from "../index.ts";
+import { IOlmDevice } from "../algorithms/megolm.ts";
+import { IRoomEncryption } from "../RoomList.ts";
+import { InboundGroupSessionData } from "../OlmDevice.ts";
+import { CrossSigningKeyInfo } from "../../crypto-api/index.ts";
function encodeSessionKey(senderCurve25519Key: string, sessionId: string): string {
return encodeURIComponent(senderCurve25519Key) + "/" + encodeURIComponent(sessionId);
diff --git a/src/crypto/verification/Base.ts b/src/crypto/verification/Base.ts
index 308ea4401d7..179c868b64b 100644
--- a/src/crypto/verification/Base.ts
+++ b/src/crypto/verification/Base.ts
@@ -19,23 +19,23 @@ limitations under the License.
* Base class for verification methods.
*/
-import { MatrixEvent } from "../../models/event";
-import { EventType } from "../../@types/event";
-import { logger } from "../../logger";
-import { DeviceInfo } from "../deviceinfo";
-import { newTimeoutError } from "./Error";
-import { KeysDuringVerification, requestKeysDuringVerification } from "../CrossSigning";
-import { IVerificationChannel } from "./request/Channel";
-import { MatrixClient } from "../../client";
-import { VerificationRequest } from "./request/VerificationRequest";
-import { TypedEventEmitter } from "../../models/typed-event-emitter";
+import { MatrixEvent } from "../../models/event.ts";
+import { EventType } from "../../@types/event.ts";
+import { logger } from "../../logger.ts";
+import { DeviceInfo } from "../deviceinfo.ts";
+import { newTimeoutError } from "./Error.ts";
+import { KeysDuringVerification, requestKeysDuringVerification } from "../CrossSigning.ts";
+import { IVerificationChannel } from "./request/Channel.ts";
+import { MatrixClient } from "../../client.ts";
+import { VerificationRequest } from "./request/VerificationRequest.ts";
+import { TypedEventEmitter } from "../../models/typed-event-emitter.ts";
import {
ShowQrCodeCallbacks,
ShowSasCallbacks,
Verifier,
VerifierEvent,
VerifierEventHandlerMap,
-} from "../../crypto-api/verification";
+} from "../../crypto-api/verification.ts";
const timeoutException = new Error("Verification timed out");
diff --git a/src/crypto/verification/Error.ts b/src/crypto/verification/Error.ts
index da73ebb847e..4f609db3a8e 100644
--- a/src/crypto/verification/Error.ts
+++ b/src/crypto/verification/Error.ts
@@ -18,8 +18,8 @@ limitations under the License.
* Error messages.
*/
-import { MatrixEvent } from "../../models/event";
-import { EventType } from "../../@types/event";
+import { MatrixEvent } from "../../models/event.ts";
+import { EventType } from "../../@types/event.ts";
export function newVerificationError(code: string, reason: string, extraData?: Record): MatrixEvent {
const content = Object.assign({}, { code, reason }, extraData);
diff --git a/src/crypto/verification/IllegalMethod.ts b/src/crypto/verification/IllegalMethod.ts
index c437e0cd2a9..c556be71785 100644
--- a/src/crypto/verification/IllegalMethod.ts
+++ b/src/crypto/verification/IllegalMethod.ts
@@ -19,11 +19,11 @@ limitations under the License.
* do verification with this method).
*/
-import { VerificationBase as Base, VerificationEvent, VerificationEventHandlerMap } from "./Base";
-import { IVerificationChannel } from "./request/Channel";
-import { MatrixClient } from "../../client";
-import { MatrixEvent } from "../../models/event";
-import { VerificationRequest } from "./request/VerificationRequest";
+import { VerificationBase as Base, VerificationEvent, VerificationEventHandlerMap } from "./Base.ts";
+import { IVerificationChannel } from "./request/Channel.ts";
+import { MatrixClient } from "../../client.ts";
+import { MatrixEvent } from "../../models/event.ts";
+import { VerificationRequest } from "./request/VerificationRequest.ts";
export class IllegalMethod extends Base {
public static factory(
diff --git a/src/crypto/verification/QRCode.ts b/src/crypto/verification/QRCode.ts
index 7ccd4986d53..4caaf42b672 100644
--- a/src/crypto/verification/QRCode.ts
+++ b/src/crypto/verification/QRCode.ts
@@ -18,17 +18,16 @@ limitations under the License.
* QR code key verification.
*/
-import { crypto } from "../crypto";
-import { VerificationBase as Base } from "./Base";
-import { newKeyMismatchError, newUserCancelledError } from "./Error";
-import { decodeBase64, encodeUnpaddedBase64 } from "../../base64";
-import { logger } from "../../logger";
-import { VerificationRequest } from "./request/VerificationRequest";
-import { MatrixClient } from "../../client";
-import { IVerificationChannel } from "./request/Channel";
-import { MatrixEvent } from "../../models/event";
-import { ShowQrCodeCallbacks, VerifierEvent } from "../../crypto-api/verification";
-import { VerificationMethod } from "../../types";
+import { VerificationBase as Base } from "./Base.ts";
+import { newKeyMismatchError, newUserCancelledError } from "./Error.ts";
+import { decodeBase64, encodeUnpaddedBase64 } from "../../base64.ts";
+import { logger } from "../../logger.ts";
+import { VerificationRequest } from "./request/VerificationRequest.ts";
+import { MatrixClient } from "../../client.ts";
+import { IVerificationChannel } from "./request/Channel.ts";
+import { MatrixEvent } from "../../models/event.ts";
+import { ShowQrCodeCallbacks, VerifierEvent } from "../../crypto-api/verification.ts";
+import { VerificationMethod } from "../../types.ts";
export const SHOW_QR_CODE_METHOD = VerificationMethod.ShowQrCode;
export const SCAN_QR_CODE_METHOD = VerificationMethod.ScanQrCode;
@@ -202,7 +201,7 @@ export class QRCodeData {
private static generateSharedSecret(): string {
const secretBytes = new Uint8Array(11);
- crypto.getRandomValues(secretBytes);
+ globalThis.crypto.getRandomValues(secretBytes);
return encodeUnpaddedBase64(secretBytes);
}
diff --git a/src/crypto/verification/SAS.ts b/src/crypto/verification/SAS.ts
index f161278bc43..31e96753728 100644
--- a/src/crypto/verification/SAS.ts
+++ b/src/crypto/verification/SAS.ts
@@ -21,27 +21,27 @@ limitations under the License.
import anotherjson from "another-json";
import { Utility, SAS as OlmSAS } from "@matrix-org/olm";
-import { VerificationBase as Base, SwitchStartEventError } from "./Base";
+import { VerificationBase as Base, SwitchStartEventError } from "./Base.ts";
import {
errorFactory,
newInvalidMessageError,
newKeyMismatchError,
newUnknownMethodError,
newUserCancelledError,
-} from "./Error";
-import { logger } from "../../logger";
-import { IContent, MatrixEvent } from "../../models/event";
-import { generateDecimalSas } from "./SASDecimal";
-import { EventType } from "../../@types/event";
-import { EmojiMapping, GeneratedSas, ShowSasCallbacks, VerifierEvent } from "../../crypto-api/verification";
-import { VerificationMethod } from "../../types";
+} from "./Error.ts";
+import { logger } from "../../logger.ts";
+import { IContent, MatrixEvent } from "../../models/event.ts";
+import { generateDecimalSas } from "./SASDecimal.ts";
+import { EventType } from "../../@types/event.ts";
+import { EmojiMapping, GeneratedSas, ShowSasCallbacks, VerifierEvent } from "../../crypto-api/verification.ts";
+import { VerificationMethod } from "../../types.ts";
// backwards-compatibility exports
export type {
ShowSasCallbacks as ISasEvent,
GeneratedSas as IGeneratedSas,
EmojiMapping,
-} from "../../crypto-api/verification";
+} from "../../crypto-api/verification.ts";
const START_TYPE = EventType.KeyVerificationStart;
diff --git a/src/crypto/verification/request/Channel.ts b/src/crypto/verification/request/Channel.ts
index 48415f977e1..cb45c7b76c7 100644
--- a/src/crypto/verification/request/Channel.ts
+++ b/src/crypto/verification/request/Channel.ts
@@ -14,8 +14,8 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { MatrixEvent } from "../../../models/event";
-import { VerificationRequest } from "./VerificationRequest";
+import { MatrixEvent } from "../../../models/event.ts";
+import { VerificationRequest } from "./VerificationRequest.ts";
export interface IVerificationChannel {
request?: VerificationRequest;
diff --git a/src/crypto/verification/request/InRoomChannel.ts b/src/crypto/verification/request/InRoomChannel.ts
index 59df11d7884..05dcce872d6 100644
--- a/src/crypto/verification/request/InRoomChannel.ts
+++ b/src/crypto/verification/request/InRoomChannel.ts
@@ -15,13 +15,13 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { VerificationRequest, REQUEST_TYPE, READY_TYPE, START_TYPE } from "./VerificationRequest";
-import { logger } from "../../../logger";
-import { IVerificationChannel } from "./Channel";
-import { EventType, TimelineEvents } from "../../../@types/event";
-import { MatrixClient } from "../../../client";
-import { MatrixEvent } from "../../../models/event";
-import { IRequestsMap } from "../..";
+import { VerificationRequest, REQUEST_TYPE, READY_TYPE, START_TYPE } from "./VerificationRequest.ts";
+import { logger } from "../../../logger.ts";
+import { IVerificationChannel } from "./Channel.ts";
+import { EventType, TimelineEvents } from "../../../@types/event.ts";
+import { MatrixClient } from "../../../client.ts";
+import { MatrixEvent } from "../../../models/event.ts";
+import { IRequestsMap } from "../../index.ts";
const MESSAGE_TYPE = EventType.RoomMessage;
const M_REFERENCE = "m.reference";
diff --git a/src/crypto/verification/request/ToDeviceChannel.ts b/src/crypto/verification/request/ToDeviceChannel.ts
index d51b85ac75f..34bf6f51ab5 100644
--- a/src/crypto/verification/request/ToDeviceChannel.ts
+++ b/src/crypto/verification/request/ToDeviceChannel.ts
@@ -15,8 +15,8 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { randomString } from "../../../randomstring";
-import { logger } from "../../../logger";
+import { randomString } from "../../../randomstring.ts";
+import { logger } from "../../../logger.ts";
import {
CANCEL_TYPE,
PHASE_STARTED,
@@ -25,12 +25,12 @@ import {
READY_TYPE,
START_TYPE,
VerificationRequest,
-} from "./VerificationRequest";
-import { errorFromEvent, newUnexpectedMessageError } from "../Error";
-import { MatrixEvent } from "../../../models/event";
-import { IVerificationChannel } from "./Channel";
-import { MatrixClient } from "../../../client";
-import { IRequestsMap } from "../..";
+} from "./VerificationRequest.ts";
+import { errorFromEvent, newUnexpectedMessageError } from "../Error.ts";
+import { MatrixEvent } from "../../../models/event.ts";
+import { IVerificationChannel } from "./Channel.ts";
+import { MatrixClient } from "../../../client.ts";
+import { IRequestsMap } from "../../index.ts";
export type Request = VerificationRequest;
diff --git a/src/crypto/verification/request/VerificationRequest.ts b/src/crypto/verification/request/VerificationRequest.ts
index 5c544f131e2..8a3aca9a287 100644
--- a/src/crypto/verification/request/VerificationRequest.ts
+++ b/src/crypto/verification/request/VerificationRequest.ts
@@ -14,16 +14,16 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { logger } from "../../../logger";
-import { errorFactory, errorFromEvent, newUnexpectedMessageError, newUnknownMethodError } from "../Error";
-import { QRCodeData, SCAN_QR_CODE_METHOD } from "../QRCode";
-import { IVerificationChannel } from "./Channel";
-import { MatrixClient } from "../../../client";
-import { MatrixEvent } from "../../../models/event";
-import { EventType } from "../../../@types/event";
-import { VerificationBase } from "../Base";
-import { VerificationMethod } from "../../index";
-import { TypedEventEmitter } from "../../../models/typed-event-emitter";
+import { logger } from "../../../logger.ts";
+import { errorFactory, errorFromEvent, newUnexpectedMessageError, newUnknownMethodError } from "../Error.ts";
+import { QRCodeData, SCAN_QR_CODE_METHOD } from "../QRCode.ts";
+import { IVerificationChannel } from "./Channel.ts";
+import { MatrixClient } from "../../../client.ts";
+import { MatrixEvent } from "../../../models/event.ts";
+import { EventType } from "../../../@types/event.ts";
+import { VerificationBase } from "../Base.ts";
+import { VerificationMethod } from "../../index.ts";
+import { TypedEventEmitter } from "../../../models/typed-event-emitter.ts";
import {
canAcceptVerificationRequest,
VerificationPhase as Phase,
@@ -31,10 +31,10 @@ import {
VerificationRequestEvent,
VerificationRequestEventHandlerMap,
Verifier,
-} from "../../../crypto-api/verification";
+} from "../../../crypto-api/verification.ts";
// backwards-compatibility exports
-export { VerificationPhase as Phase, VerificationRequestEvent } from "../../../crypto-api/verification";
+export { VerificationPhase as Phase, VerificationRequestEvent } from "../../../crypto-api/verification.ts";
// How long after the event's timestamp that the request times out
const TIMEOUT_FROM_EVENT_TS = 10 * 60 * 1000; // 10 minutes
diff --git a/src/digest.ts b/src/digest.ts
new file mode 100644
index 00000000000..85b5be9643b
--- /dev/null
+++ b/src/digest.ts
@@ -0,0 +1,34 @@
+/*
+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.
+*/
+
+/**
+ * Computes a SHA-256 hash of a string (after utf-8 encoding) and returns it as an ArrayBuffer.
+ *
+ * @param plaintext The string to hash
+ * @returns An ArrayBuffer containing the SHA-256 hash of the input string
+ * @throws If the subtle crypto API is not available, for example if the code is running
+ * in a web page with an insecure context (eg. served over plain HTTP).
+ */
+export async function sha256(plaintext: string): Promise {
+ if (!globalThis.crypto.subtle) {
+ throw new Error("Crypto.subtle is not available: insecure context?");
+ }
+ const utf8 = new TextEncoder().encode(plaintext);
+
+ const digest = await globalThis.crypto.subtle.digest("SHA-256", utf8);
+
+ return digest;
+}
diff --git a/src/embedded.ts b/src/embedded.ts
index 8730c22ee3f..1974ea9f98e 100644
--- a/src/embedded.ts
+++ b/src/embedded.ts
@@ -25,10 +25,15 @@ import {
ISendEventFromWidgetResponseData,
} from "matrix-widget-api";
-import { MatrixEvent, IEvent, IContent, EventStatus } from "./models/event";
-import { ISendEventResponse } from "./@types/requests";
-import { EventType } from "./@types/event";
-import { logger } from "./logger";
+import { MatrixEvent, IEvent, IContent, EventStatus } from "./models/event.ts";
+import {
+ ISendEventResponse,
+ SendDelayedEventRequestOpts,
+ SendDelayedEventResponse,
+ UpdateDelayedEventAction,
+} from "./@types/requests.ts";
+import { EventType, StateEvents } from "./@types/event.ts";
+import { logger } from "./logger.ts";
import {
MatrixClient,
ClientEvent,
@@ -36,15 +41,16 @@ import {
IStartClientOpts,
SendToDeviceContentMap,
IOpenIDToken,
-} from "./client";
-import { SyncApi, SyncState } from "./sync";
-import { SlidingSyncSdk } from "./sliding-sync-sdk";
-import { User } from "./models/user";
-import { Room } from "./models/room";
-import { ToDeviceBatch, ToDevicePayload } from "./models/ToDeviceMessage";
-import { DeviceInfo } from "./crypto/deviceinfo";
-import { IOlmDevice } from "./crypto/algorithms/megolm";
-import { MapWithDefault, recursiveMapToObject } from "./utils";
+ UNSTABLE_MSC4140_DELAYED_EVENTS,
+} from "./client.ts";
+import { SyncApi, SyncState } from "./sync.ts";
+import { SlidingSyncSdk } from "./sliding-sync-sdk.ts";
+import { User } from "./models/user.ts";
+import { Room } from "./models/room.ts";
+import { ToDeviceBatch, ToDevicePayload } from "./models/ToDeviceMessage.ts";
+import { DeviceInfo } from "./crypto/deviceinfo.ts";
+import { IOlmDevice } from "./crypto/algorithms/megolm.ts";
+import { MapWithDefault, recursiveMapToObject } from "./utils.ts";
interface IStateEventRequest {
eventType: string;
@@ -95,6 +101,20 @@ export interface ICapabilities {
* @defaultValue false
*/
turnServers?: boolean;
+
+ /**
+ * Whether this client needs to be able to send delayed events.
+ * @experimental Part of MSC4140 & MSC4157
+ * @defaultValue false
+ */
+ sendDelayedEvents?: boolean;
+
+ /**
+ * Whether this client needs to be able to update delayed events.
+ * @experimental Part of MSC4140 & MSC4157
+ * @defaultValue false
+ */
+ updateDelayedEvents?: boolean;
}
/**
@@ -162,6 +182,18 @@ export class RoomWidgetClient extends MatrixClient {
);
capabilities.sendToDevice?.forEach((eventType) => widgetApi.requestCapabilityToSendToDevice(eventType));
capabilities.receiveToDevice?.forEach((eventType) => widgetApi.requestCapabilityToReceiveToDevice(eventType));
+ if (
+ capabilities.sendDelayedEvents &&
+ (capabilities.sendEvent?.length ||
+ capabilities.sendMessage === true ||
+ (Array.isArray(capabilities.sendMessage) && capabilities.sendMessage.length) ||
+ capabilities.sendState?.length)
+ ) {
+ widgetApi.requestCapability(MatrixCapabilities.MSC4157SendDelayedEvent);
+ }
+ if (capabilities.updateDelayedEvents) {
+ widgetApi.requestCapability(MatrixCapabilities.MSC4157UpdateDelayedEvent);
+ }
if (capabilities.turnServers) {
widgetApi.requestCapability(MatrixCapabilities.MSC3846TurnServers);
}
@@ -218,6 +250,14 @@ export class RoomWidgetClient extends MatrixClient {
});
}) ?? [],
);
+
+ if (opts.clientWellKnownPollPeriod !== undefined) {
+ this.clientWellKnownIntervalID = setInterval(() => {
+ this.fetchClientWellKnown();
+ }, 1000 * opts.clientWellKnownPollPeriod);
+ this.fetchClientWellKnown();
+ }
+
this.setSyncState(SyncState.Syncing);
logger.info("Finished backfilling events");
@@ -240,7 +280,29 @@ export class RoomWidgetClient extends MatrixClient {
throw new Error(`Unknown room: ${roomIdOrAlias}`);
}
- protected async encryptAndSendEvent(room: Room, event: MatrixEvent): Promise {
+ protected async encryptAndSendEvent(room: Room, event: MatrixEvent): Promise;
+ protected async encryptAndSendEvent(
+ room: Room,
+ event: MatrixEvent,
+ delayOpts: SendDelayedEventRequestOpts,
+ ): Promise;
+ protected async encryptAndSendEvent(
+ room: Room,
+ event: MatrixEvent,
+ delayOpts?: SendDelayedEventRequestOpts,
+ ): Promise {
+ if (delayOpts) {
+ // TODO: updatePendingEvent for delayed events?
+ const response = await this.widgetApi.sendRoomEvent(
+ event.getType(),
+ event.getContent(),
+ room.roomId,
+ "delay" in delayOpts ? delayOpts.delay : undefined,
+ "parent_delay_id" in delayOpts ? delayOpts.parent_delay_id : undefined,
+ );
+ return this.validateSendDelayedEventResponse(response);
+ }
+
let response: ISendEventFromWidgetResponseData;
try {
response = await this.widgetApi.sendRoomEvent(event.getType(), event.getContent(), room.roomId);
@@ -249,8 +311,9 @@ export class RoomWidgetClient extends MatrixClient {
throw e;
}
+ // This also checks for an event id on the response
room.updatePendingEvent(event, EventStatus.SENT, response.event_id);
- return { event_id: response.event_id };
+ return { event_id: response.event_id! };
}
public async sendStateEvent(
@@ -259,7 +322,56 @@ export class RoomWidgetClient extends MatrixClient {
content: any,
stateKey = "",
): Promise {
- return await this.widgetApi.sendStateEvent(eventType, stateKey, content, roomId);
+ const response = await this.widgetApi.sendStateEvent(eventType, stateKey, content, roomId);
+ if (response.event_id === undefined) {
+ throw new Error("'event_id' absent from response to an event request");
+ }
+ return { event_id: response.event_id };
+ }
+
+ /**
+ * @experimental This currently relies on an unstable MSC (MSC4140).
+ */
+ // eslint-disable-next-line
+ public async _unstable_sendDelayedStateEvent(
+ roomId: string,
+ delayOpts: SendDelayedEventRequestOpts,
+ eventType: K,
+ content: StateEvents[K],
+ stateKey = "",
+ ): Promise {
+ if (!(await this.doesServerSupportUnstableFeature(UNSTABLE_MSC4140_DELAYED_EVENTS))) {
+ throw Error("Server does not support the delayed events API");
+ }
+
+ const response = await this.widgetApi.sendStateEvent(
+ eventType,
+ stateKey,
+ content,
+ roomId,
+ "delay" in delayOpts ? delayOpts.delay : undefined,
+ "parent_delay_id" in delayOpts ? delayOpts.parent_delay_id : undefined,
+ );
+ return this.validateSendDelayedEventResponse(response);
+ }
+
+ private validateSendDelayedEventResponse(response: ISendEventFromWidgetResponseData): SendDelayedEventResponse {
+ if (response.delay_id === undefined) {
+ throw new Error("'delay_id' absent from response to a delayed event request");
+ }
+ return { delay_id: response.delay_id };
+ }
+
+ /**
+ * @experimental This currently relies on an unstable MSC (MSC4140).
+ */
+ // eslint-disable-next-line
+ public async _unstable_updateDelayedEvent(delayId: string, action: UpdateDelayedEventAction): Promise<{}> {
+ if (!(await this.doesServerSupportUnstableFeature(UNSTABLE_MSC4140_DELAYED_EVENTS))) {
+ throw Error("Server does not support the delayed events API");
+ }
+
+ return await this.widgetApi.updateDelayedEvent(delayId, action);
}
public async sendToDevice(eventType: string, contentMap: SendToDeviceContentMap): Promise<{}> {
diff --git a/src/event-mapper.ts b/src/event-mapper.ts
index 828d87e9510..7dbf6a3c167 100644
--- a/src/event-mapper.ts
+++ b/src/event-mapper.ts
@@ -14,9 +14,9 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { MatrixClient } from "./client";
-import { IEvent, MatrixEvent, MatrixEventEvent } from "./models/event";
-import { RelationType } from "./@types/event";
+import { MatrixClient } from "./client.ts";
+import { IEvent, MatrixEvent, MatrixEventEvent } from "./models/event.ts";
+import { RelationType } from "./@types/event.ts";
export type EventMapper = (obj: Partial) => MatrixEvent;
diff --git a/src/extensible_events_v1/ExtensibleEvent.ts b/src/extensible_events_v1/ExtensibleEvent.ts
index 049659251b6..3bfa0632ee8 100644
--- a/src/extensible_events_v1/ExtensibleEvent.ts
+++ b/src/extensible_events_v1/ExtensibleEvent.ts
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { ExtensibleEventType, IPartialEvent } from "../@types/extensible_events";
+import { ExtensibleEventType, IPartialEvent } from "../@types/extensible_events.ts";
/**
* Represents an Extensible Event in Matrix.
diff --git a/src/extensible_events_v1/MessageEvent.ts b/src/extensible_events_v1/MessageEvent.ts
index 3d049f45809..17457f04972 100644
--- a/src/extensible_events_v1/MessageEvent.ts
+++ b/src/extensible_events_v1/MessageEvent.ts
@@ -16,7 +16,7 @@ limitations under the License.
import { Optional } from "matrix-events-sdk";
-import { ExtensibleEvent } from "./ExtensibleEvent";
+import { ExtensibleEvent } from "./ExtensibleEvent.ts";
import {
ExtensibleEventType,
IMessageRendering,
@@ -26,9 +26,9 @@ import {
M_MESSAGE,
ExtensibleAnyMessageEventContent,
M_TEXT,
-} from "../@types/extensible_events";
-import { isOptionalAString, isProvided } from "./utilities";
-import { InvalidEventError } from "./InvalidEventError";
+} from "../@types/extensible_events.ts";
+import { isOptionalAString, isProvided } from "./utilities.ts";
+import { InvalidEventError } from "./InvalidEventError.ts";
/**
* Represents a message event. Message events are the simplest form of event with
diff --git a/src/extensible_events_v1/PollEndEvent.ts b/src/extensible_events_v1/PollEndEvent.ts
index 243f1906acf..87cd49569ad 100644
--- a/src/extensible_events_v1/PollEndEvent.ts
+++ b/src/extensible_events_v1/PollEndEvent.ts
@@ -20,11 +20,11 @@ import {
isEventTypeSame,
M_TEXT,
REFERENCE_RELATION,
-} from "../@types/extensible_events";
-import { M_POLL_END, PollEndEventContent } from "../@types/polls";
-import { ExtensibleEvent } from "./ExtensibleEvent";
-import { InvalidEventError } from "./InvalidEventError";
-import { MessageEvent } from "./MessageEvent";
+} from "../@types/extensible_events.ts";
+import { M_POLL_END, PollEndEventContent } from "../@types/polls.ts";
+import { ExtensibleEvent } from "./ExtensibleEvent.ts";
+import { InvalidEventError } from "./InvalidEventError.ts";
+import { MessageEvent } from "./MessageEvent.ts";
/**
* Represents a poll end/closure event.
diff --git a/src/extensible_events_v1/PollResponseEvent.ts b/src/extensible_events_v1/PollResponseEvent.ts
index a61fc2e7cb6..9e7659ba731 100644
--- a/src/extensible_events_v1/PollResponseEvent.ts
+++ b/src/extensible_events_v1/PollResponseEvent.ts
@@ -14,11 +14,16 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { ExtensibleEvent } from "./ExtensibleEvent";
-import { M_POLL_RESPONSE, PollResponseEventContent, PollResponseSubtype } from "../@types/polls";
-import { ExtensibleEventType, IPartialEvent, isEventTypeSame, REFERENCE_RELATION } from "../@types/extensible_events";
-import { InvalidEventError } from "./InvalidEventError";
-import { PollStartEvent } from "./PollStartEvent";
+import { ExtensibleEvent } from "./ExtensibleEvent.ts";
+import { M_POLL_RESPONSE, PollResponseEventContent, PollResponseSubtype } from "../@types/polls.ts";
+import {
+ ExtensibleEventType,
+ IPartialEvent,
+ isEventTypeSame,
+ REFERENCE_RELATION,
+} from "../@types/extensible_events.ts";
+import { InvalidEventError } from "./InvalidEventError.ts";
+import { PollStartEvent } from "./PollStartEvent.ts";
/**
* Represents a poll response event.
diff --git a/src/extensible_events_v1/PollStartEvent.ts b/src/extensible_events_v1/PollStartEvent.ts
index 8584bf9e1fc..98b15e2ada9 100644
--- a/src/extensible_events_v1/PollStartEvent.ts
+++ b/src/extensible_events_v1/PollStartEvent.ts
@@ -16,8 +16,8 @@ limitations under the License.
import { NamespacedValue } from "matrix-events-sdk";
-import { MessageEvent } from "./MessageEvent";
-import { ExtensibleEventType, IPartialEvent, isEventTypeSame, M_TEXT } from "../@types/extensible_events";
+import { MessageEvent } from "./MessageEvent.ts";
+import { ExtensibleEventType, IPartialEvent, isEventTypeSame, M_TEXT } from "../@types/extensible_events.ts";
import {
KnownPollKind,
M_POLL_KIND_DISCLOSED,
@@ -26,9 +26,9 @@ import {
PollStartEventContent,
PollStartSubtype,
PollAnswer,
-} from "../@types/polls";
-import { InvalidEventError } from "./InvalidEventError";
-import { ExtensibleEvent } from "./ExtensibleEvent";
+} from "../@types/polls.ts";
+import { InvalidEventError } from "./InvalidEventError.ts";
+import { ExtensibleEvent } from "./ExtensibleEvent.ts";
/**
* Represents a poll answer. Note that this is represented as a subtype and is
diff --git a/src/feature.ts b/src/feature.ts
index 01cadd8e87c..47c914353bb 100644
--- a/src/feature.ts
+++ b/src/feature.ts
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { IServerVersions } from "./client";
+import { IServerVersions } from "./client.ts";
export enum ServerSupport {
Stable,
@@ -33,6 +33,7 @@ export enum Feature {
AccountDataDeletion = "AccountDataDeletion",
RelationsRecursion = "RelationsRecursion",
IntentionalMentions = "IntentionalMentions",
+ MigrateServerNameToVia = "MigrateServerNameToVia",
}
type FeatureSupportCondition = {
@@ -65,6 +66,9 @@ const featureSupportResolver: Record = {
unstablePrefixes: ["org.matrix.msc3952_intentional_mentions"],
matrixVersion: "v1.7",
},
+ [Feature.MigrateServerNameToVia]: {
+ unstablePrefixes: ["org.matrix.msc4156"],
+ },
};
export async function buildFeatureSupportMap(versions: IServerVersions): Promise> {
diff --git a/src/filter-component.ts b/src/filter-component.ts
index 0954e634f6e..41f2903cb73 100644
--- a/src/filter-component.ts
+++ b/src/filter-component.ts
@@ -14,9 +14,9 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { RelationType } from "./@types/event";
-import { MatrixEvent } from "./models/event";
-import { FILTER_RELATED_BY_REL_TYPES, FILTER_RELATED_BY_SENDERS, THREAD_RELATION_TYPE } from "./models/thread";
+import { RelationType } from "./@types/event.ts";
+import { MatrixEvent } from "./models/event.ts";
+import { FILTER_RELATED_BY_REL_TYPES, FILTER_RELATED_BY_SENDERS, THREAD_RELATION_TYPE } from "./models/thread.ts";
/**
* Checks if a value matches a given field value, which may be a * terminated
diff --git a/src/filter.ts b/src/filter.ts
index aea2fb4910d..d5ad00509d4 100644
--- a/src/filter.ts
+++ b/src/filter.ts
@@ -14,10 +14,10 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { EventType, RelationType } from "./@types/event";
-import { UNREAD_THREAD_NOTIFICATIONS } from "./@types/sync";
-import { FilterComponent, IFilterComponent } from "./filter-component";
-import { MatrixEvent } from "./models/event";
+import { EventType, RelationType } from "./@types/event.ts";
+import { UNREAD_THREAD_NOTIFICATIONS } from "./@types/sync.ts";
+import { FilterComponent, IFilterComponent } from "./filter-component.ts";
+import { MatrixEvent } from "./models/event.ts";
/**
*/
diff --git a/src/http-api/errors.ts b/src/http-api/errors.ts
index c5aba882bfb..86cfdc908c0 100644
--- a/src/http-api/errors.ts
+++ b/src/http-api/errors.ts
@@ -14,8 +14,8 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { IUsageLimit } from "../@types/partials";
-import { MatrixEvent } from "../models/event";
+import { IUsageLimit } from "../@types/partials.ts";
+import { MatrixEvent } from "../models/event.ts";
interface IErrorJson extends Partial {
[key: string]: any; // extensible
diff --git a/src/http-api/fetch.ts b/src/http-api/fetch.ts
index 274f39f0d41..3c98c10aa58 100644
--- a/src/http-api/fetch.ts
+++ b/src/http-api/fetch.ts
@@ -18,13 +18,13 @@ limitations under the License.
* This is an internal module. See {@link MatrixHttpApi} for the public class.
*/
-import { checkObjectHasKeys, encodeParams } from "../utils";
-import { TypedEventEmitter } from "../models/typed-event-emitter";
-import { Method } from "./method";
-import { ConnectionError, MatrixError } from "./errors";
-import { HttpApiEvent, HttpApiEventHandlerMap, IHttpOpts, IRequestOpts, Body } from "./interface";
-import { anySignal, parseErrorResponse, timeoutSignal } from "./utils";
-import { QueryDict } from "../utils";
+import { checkObjectHasKeys, encodeParams } from "../utils.ts";
+import { TypedEventEmitter } from "../models/typed-event-emitter.ts";
+import { Method } from "./method.ts";
+import { ConnectionError, MatrixError } from "./errors.ts";
+import { HttpApiEvent, HttpApiEventHandlerMap, IHttpOpts, IRequestOpts, Body } from "./interface.ts";
+import { anySignal, parseErrorResponse, timeoutSignal } from "./utils.ts";
+import { QueryDict } from "../utils.ts";
interface TypedResponse extends Response {
json(): Promise;
diff --git a/src/http-api/index.ts b/src/http-api/index.ts
index cd63f8d289c..abc7391da16 100644
--- a/src/http-api/index.ts
+++ b/src/http-api/index.ts
@@ -14,20 +14,20 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { FetchHttpApi } from "./fetch";
-import { FileType, IContentUri, IHttpOpts, Upload, UploadOpts, UploadResponse } from "./interface";
-import { MediaPrefix } from "./prefix";
-import { defer, QueryDict, removeElement } from "../utils";
-import * as callbacks from "../realtime-callbacks";
-import { Method } from "./method";
-import { ConnectionError } from "./errors";
-import { parseErrorResponse } from "./utils";
-
-export * from "./interface";
-export * from "./prefix";
-export * from "./errors";
-export * from "./method";
-export * from "./utils";
+import { FetchHttpApi } from "./fetch.ts";
+import { FileType, IContentUri, IHttpOpts, Upload, UploadOpts, UploadResponse } from "./interface.ts";
+import { MediaPrefix } from "./prefix.ts";
+import { defer, QueryDict, removeElement } from "../utils.ts";
+import * as callbacks from "../realtime-callbacks.ts";
+import { Method } from "./method.ts";
+import { ConnectionError } from "./errors.ts";
+import { parseErrorResponse } from "./utils.ts";
+
+export * from "./interface.ts";
+export * from "./prefix.ts";
+export * from "./errors.ts";
+export * from "./method.ts";
+export * from "./utils.ts";
export class MatrixHttpApi extends FetchHttpApi {
private uploads: Upload[] = [];
diff --git a/src/http-api/interface.ts b/src/http-api/interface.ts
index ee4456d7cc5..c06b850f311 100644
--- a/src/http-api/interface.ts
+++ b/src/http-api/interface.ts
@@ -14,8 +14,8 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { MatrixError } from "./errors";
-import { Logger } from "../logger";
+import { MatrixError } from "./errors.ts";
+import { Logger } from "../logger.ts";
export type Body = Record | BodyInit;
diff --git a/src/http-api/utils.ts b/src/http-api/utils.ts
index 0b3c3554ffa..861d47ea1b0 100644
--- a/src/http-api/utils.ts
+++ b/src/http-api/utils.ts
@@ -16,9 +16,9 @@ limitations under the License.
import { parse as parseContentType, ParsedMediaType } from "content-type";
-import { logger } from "../logger";
-import { sleep } from "../utils";
-import { ConnectionError, HTTPError, MatrixError } from "./errors";
+import { logger } from "../logger.ts";
+import { sleep } from "../utils.ts";
+import { ConnectionError, HTTPError, MatrixError } from "./errors.ts";
// Ponyfill for https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal/timeout
export function timeoutSignal(ms: number): AbortSignal {
diff --git a/src/index.ts b/src/index.ts
index c9a5dcf65c0..65e798c870f 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -14,12 +14,12 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import * as matrixcs from "./matrix";
+import * as matrixcs from "./matrix.ts";
if (global.__js_sdk_entrypoint) {
throw new Error("Multiple matrix-js-sdk entrypoints detected!");
}
global.__js_sdk_entrypoint = true;
-export * from "./matrix";
+export * from "./matrix.ts";
export default matrixcs;
diff --git a/src/indexeddb-worker.ts b/src/indexeddb-worker.ts
index 68dcf0f8006..15fc1bb8bd2 100644
--- a/src/indexeddb-worker.ts
+++ b/src/indexeddb-worker.ts
@@ -21,4 +21,4 @@ limitations under the License.
*/
/** The {@link IndexedDBStoreWorker} class. */
-export { IndexedDBStoreWorker } from "./store/indexeddb-store-worker";
+export { IndexedDBStoreWorker } from "./store/indexeddb-store-worker.ts";
diff --git a/src/interactive-auth.ts b/src/interactive-auth.ts
index 8ecfc64a0d2..60c31d017f3 100644
--- a/src/interactive-auth.ts
+++ b/src/interactive-auth.ts
@@ -16,12 +16,12 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { logger } from "./logger";
-import { MatrixClient } from "./client";
-import { defer, IDeferred } from "./utils";
-import { MatrixError } from "./http-api";
-import { UIAResponse } from "./@types/uia";
-import { UserIdentifier } from "./@types/auth";
+import { logger } from "./logger.ts";
+import { MatrixClient } from "./client.ts";
+import { defer, IDeferred } from "./utils.ts";
+import { MatrixError } from "./http-api/index.ts";
+import { UIAResponse } from "./@types/uia.ts";
+import { UserIdentifier } from "./@types/auth.ts";
const EMAIL_STAGE_TYPE = "m.login.email.identity";
const MSISDN_STAGE_TYPE = "m.login.msisdn";
diff --git a/src/matrix.ts b/src/matrix.ts
index 793a894e0d0..cac7c91fd21 100644
--- a/src/matrix.ts
+++ b/src/matrix.ts
@@ -16,73 +16,74 @@ limitations under the License.
import { WidgetApi } from "matrix-widget-api";
-import { MemoryCryptoStore } from "./crypto/store/memory-crypto-store";
-import { MemoryStore } from "./store/memory";
-import { MatrixScheduler } from "./scheduler";
-import { MatrixClient, ICreateClientOpts } from "./client";
-import { RoomWidgetClient, ICapabilities } from "./embedded";
-import { CryptoStore } from "./crypto/store/base";
+import { MemoryCryptoStore } from "./crypto/store/memory-crypto-store.ts";
+import { MemoryStore } from "./store/memory.ts";
+import { MatrixScheduler } from "./scheduler.ts";
+import { MatrixClient, ICreateClientOpts } from "./client.ts";
+import { RoomWidgetClient, ICapabilities } from "./embedded.ts";
+import { CryptoStore } from "./crypto/store/base.ts";
-export * from "./client";
-export * from "./embedded";
-export * from "./http-api";
-export * from "./autodiscovery";
-export * from "./sync-accumulator";
-export * from "./errors";
-export * from "./base64";
-export * from "./models/beacon";
-export * from "./models/event";
-export * from "./models/room";
-export * from "./models/event-timeline";
-export * from "./models/event-timeline-set";
-export * from "./models/poll";
-export * from "./models/room-member";
-export * from "./models/room-state";
-export * from "./models/thread";
-export * from "./models/typed-event-emitter";
-export * from "./models/user";
-export * from "./models/device";
-export * from "./models/search-result";
-export * from "./oidc";
-export * from "./scheduler";
-export * from "./filter";
-export * from "./timeline-window";
-export * from "./interactive-auth";
-export * from "./service-types";
-export * from "./store/memory";
-export * from "./store/indexeddb";
-export * from "./crypto/store/memory-crypto-store";
-export * from "./crypto/store/localStorage-crypto-store";
-export * from "./crypto/store/indexeddb-crypto-store";
-export type { OutgoingRoomKeyRequest } from "./crypto/store/base";
-export * from "./content-repo";
-export * from "./@types/common";
-export * from "./@types/uia";
-export * from "./@types/event";
-export * from "./@types/PushRules";
-export * from "./@types/partials";
-export * from "./@types/requests";
-export * from "./@types/search";
-export * from "./@types/beacon";
-export * from "./@types/topic";
-export * from "./@types/location";
-export * from "./@types/threepids";
-export * from "./@types/auth";
-export * from "./@types/polls";
-export * from "./@types/local_notifications";
-export * from "./@types/registration";
-export * from "./@types/read_receipts";
-export * from "./@types/crypto";
-export * from "./@types/extensible_events";
-export * from "./@types/IIdentityServerProvider";
-export * from "./models/room-summary";
-export * from "./models/event-status";
-export type { RoomSummary } from "./client";
-export * as ContentHelpers from "./content-helpers";
-export * as SecretStorage from "./secret-storage";
-export type { ICryptoCallbacks } from "./crypto"; // used to be located here
-export { createNewMatrixCall, CallEvent } from "./webrtc/call";
-export type { MatrixCall } from "./webrtc/call";
+export * from "./client.ts";
+export * from "./serverCapabilities.ts";
+export * from "./embedded.ts";
+export * from "./http-api/index.ts";
+export * from "./autodiscovery.ts";
+export * from "./sync-accumulator.ts";
+export * from "./errors.ts";
+export * from "./base64.ts";
+export * from "./models/beacon.ts";
+export * from "./models/event.ts";
+export * from "./models/room.ts";
+export * from "./models/event-timeline.ts";
+export * from "./models/event-timeline-set.ts";
+export * from "./models/poll.ts";
+export * from "./models/room-member.ts";
+export * from "./models/room-state.ts";
+export * from "./models/thread.ts";
+export * from "./models/typed-event-emitter.ts";
+export * from "./models/user.ts";
+export * from "./models/device.ts";
+export * from "./models/search-result.ts";
+export * from "./oidc/index.ts";
+export * from "./scheduler.ts";
+export * from "./filter.ts";
+export * from "./timeline-window.ts";
+export * from "./interactive-auth.ts";
+export * from "./service-types.ts";
+export * from "./store/memory.ts";
+export * from "./store/indexeddb.ts";
+export * from "./crypto/store/memory-crypto-store.ts";
+export * from "./crypto/store/localStorage-crypto-store.ts";
+export * from "./crypto/store/indexeddb-crypto-store.ts";
+export type { OutgoingRoomKeyRequest } from "./crypto/store/base.ts";
+export * from "./content-repo.ts";
+export * from "./@types/common.ts";
+export * from "./@types/uia.ts";
+export * from "./@types/event.ts";
+export * from "./@types/PushRules.ts";
+export * from "./@types/partials.ts";
+export * from "./@types/requests.ts";
+export * from "./@types/search.ts";
+export * from "./@types/beacon.ts";
+export * from "./@types/topic.ts";
+export * from "./@types/location.ts";
+export * from "./@types/threepids.ts";
+export * from "./@types/auth.ts";
+export * from "./@types/polls.ts";
+export * from "./@types/local_notifications.ts";
+export * from "./@types/registration.ts";
+export * from "./@types/read_receipts.ts";
+export * from "./@types/crypto.ts";
+export * from "./@types/extensible_events.ts";
+export * from "./@types/IIdentityServerProvider.ts";
+export * from "./models/room-summary.ts";
+export * from "./models/event-status.ts";
+export type { RoomSummary } from "./client.ts";
+export * as ContentHelpers from "./content-helpers.ts";
+export * as SecretStorage from "./secret-storage.ts";
+export type { ICryptoCallbacks } from "./crypto/index.ts"; // used to be located here
+export { createNewMatrixCall, CallEvent } from "./webrtc/call.ts";
+export type { MatrixCall } from "./webrtc/call.ts";
export {
GroupCall,
GroupCallEvent,
@@ -90,21 +91,21 @@ export {
GroupCallState,
GroupCallType,
GroupCallStatsReportEvent,
-} from "./webrtc/groupCall";
-export { CryptoEvent } from "./crypto";
-export { SyncState, SetPresence } from "./sync";
-export type { ISyncStateData as SyncStateData } from "./sync";
-export { SlidingSyncEvent } from "./sliding-sync";
-export { MediaHandlerEvent } from "./webrtc/mediaHandler";
-export { CallFeedEvent } from "./webrtc/callFeed";
-export { StatsReport } from "./webrtc/stats/statsReport";
-export { Relations, RelationsEvent } from "./models/relations";
-export { TypedEventEmitter } from "./models/typed-event-emitter";
-export { LocalStorageErrors } from "./store/local-storage-events-emitter";
-export { IdentityProviderBrand, SSOAction } from "./@types/auth";
-export type { ISSOFlow as SSOFlow, LoginFlow } from "./@types/auth";
-export type { IHierarchyRelation as HierarchyRelation, IHierarchyRoom as HierarchyRoom } from "./@types/spaces";
-export { LocationAssetType } from "./@types/location";
+} from "./webrtc/groupCall.ts";
+export { CryptoEvent } from "./crypto/index.ts";
+export { SyncState, SetPresence } from "./sync.ts";
+export type { ISyncStateData as SyncStateData } from "./sync.ts";
+export { SlidingSyncEvent } from "./sliding-sync.ts";
+export { MediaHandlerEvent } from "./webrtc/mediaHandler.ts";
+export { CallFeedEvent } from "./webrtc/callFeed.ts";
+export { StatsReport } from "./webrtc/stats/statsReport.ts";
+export { Relations, RelationsEvent } from "./models/relations.ts";
+export { TypedEventEmitter } from "./models/typed-event-emitter.ts";
+export { LocalStorageErrors } from "./store/local-storage-events-emitter.ts";
+export { IdentityProviderBrand, SSOAction } from "./@types/auth.ts";
+export type { ISSOFlow as SSOFlow, LoginFlow } from "./@types/auth.ts";
+export type { IHierarchyRelation as HierarchyRelation, IHierarchyRoom as HierarchyRoom } from "./@types/spaces.ts";
+export { LocationAssetType } from "./@types/location.ts";
/**
* Types supporting cryptography.
@@ -112,7 +113,7 @@ export { LocationAssetType } from "./@types/location";
* The most important is {@link Crypto.CryptoApi}, an instance of which can be retrieved via
* {@link MatrixClient.getCrypto}.
*/
-export * as Crypto from "./crypto-api";
+export * as Crypto from "./crypto-api/index.ts";
let cryptoStoreFactory = (): CryptoStore => new MemoryCryptoStore();
diff --git a/src/matrixrtc/CallMembership.ts b/src/matrixrtc/CallMembership.ts
index 171751f1d1f..495ce1c4947 100644
--- a/src/matrixrtc/CallMembership.ts
+++ b/src/matrixrtc/CallMembership.ts
@@ -14,52 +14,114 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { MatrixEvent } from "../matrix";
-import { deepCompare } from "../utils";
-import { Focus } from "./focus";
+import { EitherAnd } from "matrix-events-sdk/lib/types";
-type CallScope = "m.room" | "m.user";
+import { MatrixEvent } from "../matrix.ts";
+import { deepCompare } from "../utils.ts";
+import { Focus } from "./focus.ts";
+import { isLivekitFocusActive } from "./LivekitFocus.ts";
+type CallScope = "m.room" | "m.user";
// Represents an entry in the memberships section of an m.call.member event as it is on the wire
-export interface CallMembershipData {
- application?: string;
+
+// There are two different data interfaces. One for the Legacy types and one compliant with MSC4143
+
+// MSC4143 (MatrixRTC) session membership data
+
+export type SessionMembershipData = {
+ application: string;
+ call_id: string;
+ device_id: string;
+
+ focus_active: Focus;
+ foci_preferred: Focus[];
+ created_ts?: number;
+
+ // Application specific data
+ scope?: CallScope;
+};
+
+export const isSessionMembershipData = (data: CallMembershipData): data is SessionMembershipData =>
+ "focus_active" in data;
+
+const checkSessionsMembershipData = (data: any, errors: string[]): data is SessionMembershipData => {
+ const prefix = "Malformed session membership event: ";
+ if (typeof data.device_id !== "string") errors.push(prefix + "device_id must be string");
+ if (typeof data.call_id !== "string") errors.push(prefix + "call_id must be string");
+ if (typeof data.application !== "string") errors.push(prefix + "application must be a string");
+ if (typeof data.focus_active?.type !== "string") errors.push(prefix + "focus_active.type must be a string");
+ if (!Array.isArray(data.foci_preferred)) errors.push(prefix + "foci_preferred must be an array");
+ // optional parameters
+ if (data.created_ts && typeof data.created_ts !== "number") errors.push(prefix + "created_ts must be number");
+
+ // application specific data (we first need to check if they exist)
+ if (data.scope && typeof data.scope !== "string") errors.push(prefix + "scope must be string");
+ return errors.length === 0;
+};
+
+// Legacy session membership data
+
+export type CallMembershipDataLegacy = {
+ application: string;
call_id: string;
scope: CallScope;
device_id: string;
+ membershipID: string;
created_ts?: number;
- expires?: number;
- expires_ts?: number;
foci_active?: Focus[];
- membershipID: string;
-}
+} & EitherAnd<{ expires: number }, { expires_ts: number }>;
+
+export const isLegacyCallMembershipData = (data: CallMembershipData): data is CallMembershipDataLegacy =>
+ "membershipID" in data;
+
+const checkCallMembershipDataLegacy = (data: any, errors: string[]): data is CallMembershipDataLegacy => {
+ const prefix = "Malformed legacy rtc membership event: ";
+ if (!("expires" in data || "expires_ts" in data)) {
+ errors.push(prefix + "expires_ts or expires must be present");
+ }
+ if ("expires" in data) {
+ if (typeof data.expires !== "number") {
+ errors.push(prefix + "expires must be numeric");
+ }
+ }
+ if ("expires_ts" in data) {
+ if (typeof data.expires_ts !== "number") {
+ errors.push(prefix + "expires_ts must be numeric");
+ }
+ }
+
+ if (typeof data.device_id !== "string") errors.push(prefix + "device_id must be string");
+ if (typeof data.call_id !== "string") errors.push(prefix + "call_id must be string");
+ if (typeof data.application !== "string") errors.push(prefix + "application must be a string");
+ if (typeof data.membershipID !== "string") errors.push(prefix + "membershipID must be a string");
+ // optional elements
+ if (data.created_ts && typeof data.created_ts !== "number") errors.push(prefix + "created_ts must be number");
+ // application specific data (we first need to check if they exist)
+ if (data.scope && typeof data.scope !== "string") errors.push(prefix + "scope must be string");
+ return errors.length === 0;
+};
+
+export type CallMembershipData = CallMembershipDataLegacy | SessionMembershipData;
export class CallMembership {
public static equal(a: CallMembership, b: CallMembership): boolean {
- return deepCompare(a.data, b.data);
+ return deepCompare(a.membershipData, b.membershipData);
}
+ private membershipData: CallMembershipData;
public constructor(
private parentEvent: MatrixEvent,
- private data: CallMembershipData,
+ data: any,
) {
- if (!(data.expires || data.expires_ts)) {
- throw new Error("Malformed membership: expires_ts or expires must be present");
- }
- if (data.expires) {
- if (typeof data.expires !== "number") {
- throw new Error("Malformed membership: expires must be numeric");
- }
- }
- if (data.expires_ts) {
- if (typeof data.expires_ts !== "number") {
- throw new Error("Malformed membership: expires_ts must be numeric");
- }
+ const sessionErrors: string[] = [];
+ const legacyErrors: string[] = [];
+ if (!checkSessionsMembershipData(data, sessionErrors) && !checkCallMembershipDataLegacy(data, legacyErrors)) {
+ throw Error(
+ `unknown CallMembership data. Does not match legacy call.member (${legacyErrors.join(" & ")}) events nor MSC4143 (${sessionErrors.join(" & ")})`,
+ );
+ } else {
+ this.membershipData = data;
}
-
- if (typeof data.device_id !== "string") throw new Error("Malformed membership event: device_id must be string");
- if (typeof data.call_id !== "string") throw new Error("Malformed membership event: call_id must be string");
- if (typeof data.scope !== "string") throw new Error("Malformed membership event: scope must be string");
- if (!parentEvent.getSender()) throw new Error("Invalid parent event: sender is null");
}
public get sender(): string | undefined {
@@ -67,62 +129,115 @@ export class CallMembership {
}
public get callId(): string {
- return this.data.call_id;
+ return this.membershipData.call_id;
}
public get deviceId(): string {
- return this.data.device_id;
+ return this.membershipData.device_id;
}
public get application(): string | undefined {
- return this.data.application;
+ return this.membershipData.application;
}
- public get scope(): CallScope {
- return this.data.scope;
+ public get scope(): CallScope | undefined {
+ return this.membershipData.scope;
}
public get membershipID(): string {
- return this.data.membershipID;
+ if (isLegacyCallMembershipData(this.membershipData)) return this.membershipData.membershipID;
+ // the createdTs behaves equivalent to the membershipID.
+ // we only need the field for the legacy member envents where we needed to update them
+ // synapse ignores sending state events if they have the same content.
+ else return this.createdTs().toString();
}
public createdTs(): number {
- return this.data.created_ts ?? this.parentEvent.getTs();
+ return this.membershipData.created_ts ?? this.parentEvent.getTs();
}
- public getAbsoluteExpiry(): number {
- if (this.data.expires) {
- return this.createdTs() + this.data.expires;
+ /**
+ * Gets the absolute expiry time of the membership if applicable to this membership type.
+ * @returns The absolute expiry time of the membership as a unix timestamp in milliseconds or undefined if not applicable
+ */
+ public getAbsoluteExpiry(): number | undefined {
+ // if the membership is not a legacy membership, we assume it is MSC4143
+ if (!isLegacyCallMembershipData(this.membershipData)) return undefined;
+
+ if ("expires" in this.membershipData) {
+ // we know createdTs exists since we already do the isLegacyCallMembershipData check
+ return this.createdTs() + this.membershipData.expires;
} else {
// We know it exists because we checked for this in the constructor.
- return this.data.expires_ts!;
+ return this.membershipData.expires_ts;
}
}
- // gets the expiry time of the event, converted into the device's local time
- public getLocalExpiry(): number {
- if (this.data.expires) {
+ /**
+ * Gets the expiry time of the event, converted into the device's local time.
+ * @deprecated This function has been observed returning bad data and is no longer used by MatrixRTC.
+ * @returns The local expiry time of the membership as a unix timestamp in milliseconds or undefined if not applicable
+ */
+ public getLocalExpiry(): number | undefined {
+ // if the membership is not a legacy membership, we assume it is MSC4143
+ if (!isLegacyCallMembershipData(this.membershipData)) return undefined;
+
+ if ("expires" in this.membershipData) {
+ // we know createdTs exists since we already do the isLegacyCallMembershipData check
const relativeCreationTime = this.parentEvent.getTs() - this.createdTs();
const localCreationTs = this.parentEvent.localTimestamp - relativeCreationTime;
- return localCreationTs + this.data.expires;
+ return localCreationTs + this.membershipData.expires;
} else {
// With expires_ts we cannot convert to local time.
// TODO: Check the server timestamp and compute a diff to local time.
- return this.data.expires_ts!;
+ return this.membershipData.expires_ts;
}
}
- public getMsUntilExpiry(): number {
- return this.getLocalExpiry() - Date.now();
+ /**
+ * @returns The number of milliseconds until the membership expires or undefined if applicable
+ */
+ public getMsUntilExpiry(): number | undefined {
+ if (isLegacyCallMembershipData(this.membershipData)) {
+ // Assume that local clock is sufficiently in sync with other clocks in the distributed system.
+ // We used to try and adjust for the local clock being skewed, but there are cases where this is not accurate.
+ // The current implementation allows for the local clock to be -infinity to +MatrixRTCSession.MEMBERSHIP_EXPIRY_TIME/2
+ return this.getAbsoluteExpiry()! - Date.now();
+ }
+
+ // Assumed to be MSC4143
+ return undefined;
}
+ /**
+ * @returns true if the membership has expired, otherwise false
+ */
public isExpired(): boolean {
- return this.getMsUntilExpiry() <= 0;
+ if (isLegacyCallMembershipData(this.membershipData)) return this.getMsUntilExpiry()! <= 0;
+
+ // MSC4143 events expire by being updated. So if the event exists, its not expired.
+ return false;
+ }
+
+ public getPreferredFoci(): Focus[] {
+ // To support both, the new and the old MatrixRTC memberships have two cases based
+ // on the availablitiy of `foci_preferred`
+ if (isLegacyCallMembershipData(this.membershipData)) return this.membershipData.foci_active ?? [];
+
+ // MSC4143 style membership
+ return this.membershipData.foci_preferred;
}
- public getActiveFoci(): Focus[] {
- return this.data.foci_active ?? [];
+ public getFocusSelection(): string | undefined {
+ if (isLegacyCallMembershipData(this.membershipData)) {
+ return "oldest_membership";
+ } else {
+ const focusActive = this.membershipData.focus_active;
+ if (isLivekitFocusActive(focusActive)) {
+ return focusActive.focus_selection;
+ }
+ }
}
}
diff --git a/src/matrixrtc/LivekitFocus.ts b/src/matrixrtc/LivekitFocus.ts
new file mode 100644
index 00000000000..254c715410e
--- /dev/null
+++ b/src/matrixrtc/LivekitFocus.ts
@@ -0,0 +1,39 @@
+/*
+Copyright 2023 New Vector Ltd
+
+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 { Focus } from "./focus.ts";
+
+export interface LivekitFocusConfig extends Focus {
+ type: "livekit";
+ livekit_service_url: string;
+}
+
+export const isLivekitFocusConfig = (object: any): object is LivekitFocusConfig =>
+ object.type === "livekit" && "livekit_service_url" in object;
+
+export interface LivekitFocus extends LivekitFocusConfig {
+ livekit_alias: string;
+}
+
+export const isLivekitFocus = (object: any): object is LivekitFocus =>
+ isLivekitFocusConfig(object) && "livekit_alias" in object;
+
+export interface LivekitFocusActive extends Focus {
+ type: "livekit";
+ focus_selection: "oldest_membership";
+}
+export const isLivekitFocusActive = (object: any): object is LivekitFocusActive =>
+ object.type === "livekit" && "focus_selection" in object;
diff --git a/src/matrixrtc/MatrixRTCSession.ts b/src/matrixrtc/MatrixRTCSession.ts
index 7421723ecb4..ebd69400a90 100644
--- a/src/matrixrtc/MatrixRTCSession.ts
+++ b/src/matrixrtc/MatrixRTCSession.ts
@@ -14,21 +14,32 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { logger } from "../logger";
-import { TypedEventEmitter } from "../models/typed-event-emitter";
-import { EventTimeline } from "../models/event-timeline";
-import { Room } from "../models/room";
-import { MatrixClient } from "../client";
-import { EventType } from "../@types/event";
-import { CallMembership, CallMembershipData } from "./CallMembership";
-import { RoomStateEvent } from "../models/room-state";
-import { Focus } from "./focus";
-import { randomString, secureRandomBase64Url } from "../randomstring";
-import { EncryptionKeysEventContent } from "./types";
-import { decodeBase64, encodeUnpaddedBase64 } from "../base64";
-import { KnownMembership } from "../@types/membership";
-import { MatrixError } from "../http-api/errors";
-import { MatrixEvent } from "../models/event";
+import { logger as rootLogger } from "../logger.ts";
+import { TypedEventEmitter } from "../models/typed-event-emitter.ts";
+import { EventTimeline } from "../models/event-timeline.ts";
+import { Room } from "../models/room.ts";
+import { MatrixClient } from "../client.ts";
+import { EventType } from "../@types/event.ts";
+import { UpdateDelayedEventAction } from "../@types/requests.ts";
+import {
+ CallMembership,
+ CallMembershipData,
+ CallMembershipDataLegacy,
+ SessionMembershipData,
+ isLegacyCallMembershipData,
+} from "./CallMembership.ts";
+import { RoomStateEvent } from "../models/room-state.ts";
+import { Focus } from "./focus.ts";
+import { randomString, secureRandomBase64Url } from "../randomstring.ts";
+import { EncryptionKeysEventContent } from "./types.ts";
+import { decodeBase64, encodeUnpaddedBase64 } from "../base64.ts";
+import { KnownMembership } from "../@types/membership.ts";
+import { MatrixError } from "../http-api/errors.ts";
+import { MatrixEvent } from "../models/event.ts";
+import { isLivekitFocusActive } from "./LivekitFocus.ts";
+import { ExperimentalGroupCallRoomMemberState } from "../webrtc/groupCall.ts";
+
+const logger = rootLogger.getChild("MatrixRTCSession");
const MEMBERSHIP_EXPIRY_TIME = 60 * 60 * 1000;
const MEMBER_EVENT_CHECK_PERIOD = 2 * 60 * 1000; // How often we check to see if we need to re-send our member event
@@ -47,9 +58,9 @@ const USE_KEY_DELAY = 5000;
const getParticipantId = (userId: string, deviceId: string): string => `${userId}:${deviceId}`;
const getParticipantIdFromMembership = (m: CallMembership): string => getParticipantId(m.sender!, m.deviceId);
-function keysEqual(a: Uint8Array, b: Uint8Array): boolean {
+function keysEqual(a: Uint8Array | undefined, b: Uint8Array | undefined): boolean {
if (a === b) return true;
- return a && b && a.length === b.length && a.every((x, i) => x === b[i]);
+ return !!a && !!b && a.length === b.length && a.every((x, i) => x === b[i]);
}
export enum MatrixRTCSessionEvent {
@@ -57,7 +68,7 @@ export enum MatrixRTCSessionEvent {
MembershipsChanged = "memberships_changed",
// We joined or left the session: our own local idea of whether we are joined,
// separate from MembershipsChanged, ie. independent of whether our member event
- // has succesfully gone through.
+ // has successfully gone through.
JoinStateChanged = "join_state_changed",
// The key used to encrypt media has changed
EncryptionKeyChanged = "encryption_key_changed",
@@ -75,7 +86,20 @@ export type MatrixRTCSessionEventHandlerMap = {
participantId: string,
) => void;
};
-
+export interface JoinSessionConfig {
+ /** If true, generate and share a media key for this participant,
+ * and emit MatrixRTCSessionEvent.EncryptionKeyChanged when
+ * media keys for other participants become available.
+ */
+ manageMediaKeys?: boolean;
+ /** Lets you configure how the events for the session are formatted.
+ * - legacy: use one event with a membership array.
+ * - MSC4143: use one event per membership (with only one membership per event)
+ * More details can be found in MSC4143 and by checking the types:
+ * `CallMembershipDataLegacy` and `SessionMembershipData`
+ */
+ useLegacyMemberEvents?: boolean;
+}
/**
* A MatrixRTCSession manages the membership & properties of a MatrixRTC session.
* This class doesn't deal with media at all, just membership & properties of a session.
@@ -102,16 +126,24 @@ export class MatrixRTCSession extends TypedEventEmitter;
private setNewKeyTimeouts = new Set>();
- private activeFoci: Focus[] | undefined;
+ // This is a Focus with the specified fields for an ActiveFocus (e.g. LivekitFocusActive for type="livekit")
+ private ownFocusActive?: Focus;
+ // This is a Foci array that contains the Focus objects this user is aware of and proposes to use.
+ private ownFociPreferred?: Focus[];
private updateCallMembershipRunning = false;
private needCallMembershipUpdate = false;
private manageMediaKeys = false;
- // userId:deviceId => array of keys
- private encryptionKeys = new Map>();
+ private useLegacyMemberEvents = true;
+ // userId:deviceId => array of (key, timestamp)
+ private encryptionKeys = new Map>();
private lastEncryptionKeyUpdateRequest?: number;
+ // We use this to store the last membership fingerprints we saw, so we can proactively re-send encryption keys
+ // if it looks like a membership has been updated.
+ private lastMembershipFingerprints: Set | undefined;
+
/**
* The callId (sessionId) of the call.
*
@@ -134,21 +166,34 @@ export class MatrixRTCSession extends TypedEventEmitter 1 && "focus_active" in content) {
+ // We have a MSC4143 event membership event
+ membershipContents.push(content);
+ } else if (eventKeysCount === 1 && "memberships" in content) {
+ // we have a legacy (one event for all devices) event
+ if (!Array.isArray(content["memberships"])) {
+ logger.warn(`Malformed member event from ${memberEvent.getSender()}: memberships is not an array`);
+ continue;
+ }
+ membershipContents = content["memberships"];
}
- for (const membershipData of eventMemberships) {
+ if (membershipContents.length === 0) continue;
+
+ for (const membershipData of membershipContents) {
try {
const membership = new CallMembership(memberEvent, membershipData);
if (membership.callId !== "" || membership.scope !== "m.room") {
- // for now, just ignore anything that isn't the a room scope call
+ // for now, just ignore anything that isn't a room scope call
logger.info(`Ignoring user-scoped call`);
continue;
}
@@ -202,6 +247,7 @@ export class MatrixRTCSession extends TypedEventEmitter | undefined {
- return this.encryptionKeys.get(getParticipantId(userId, deviceId));
+ return this.encryptionKeys.get(getParticipantId(userId, deviceId))?.map((entry) => entry.key);
}
/**
@@ -324,7 +396,10 @@ export class MatrixRTCSession extends TypedEventEmitter]> {
- return this.encryptionKeys.entries();
+ // the returned array doesn't contain the timestamps
+ return Array.from(this.encryptionKeys.entries())
+ .map(([participantId, keys]): [string, Uint8Array[]] => [participantId, keys.map((k) => k.key)])
+ .values();
}
private getNewEncryptionKeyIndex(): number {
@@ -339,13 +414,15 @@ export class MatrixRTCSession extends TypedEventEmitter timestamp) {
+ logger.info(
+ `Ignoring new key at index ${encryptionKeyIndex} for ${participantId} as it is older than existing known key`,
+ );
+ return;
+ }
+
+ if (keysEqual(existingKeyAtIndex.key, keyBin)) {
+ existingKeyAtIndex.timestamp = timestamp;
+ return;
+ }
+ }
- if (keysEqual(encryptionKeys[encryptionKeyIndex], keyBin)) return;
+ participantKeys[encryptionKeyIndex] = {
+ key: keyBin,
+ timestamp,
+ };
- encryptionKeys[encryptionKeyIndex] = keyBin;
- this.encryptionKeys.set(participantId, encryptionKeys);
- if (delayBeforeuse) {
+ if (delayBeforeUse) {
const useKeyTimeout = setTimeout(() => {
this.setNewKeyTimeouts.delete(useKeyTimeout);
logger.info(`Delayed-emitting key changed event for ${participantId} idx ${encryptionKeyIndex}`);
@@ -379,7 +477,7 @@ export class MatrixRTCSession extends TypedEventEmitter {
const userId = event.getSender();
const content = event.getContent();
@@ -563,11 +677,19 @@ export class MatrixRTCSession extends TypedEventEmitter
+ m.sender === this.client.getUserId() && m.deviceId === this.client.getDeviceId();
+
+ /**
+ * Examines the latest call memberships and handles any encryption key sending or rotation that is needed.
+ *
+ * This function should be called when the room members or call memberships might have changed.
+ */
public onMembershipUpdate = (): void => {
const oldMemberships = this.memberships;
this.memberships = MatrixRTCSession.callMembershipsForRoom(this.room);
@@ -583,19 +705,22 @@ export class MatrixRTCSession extends TypedEventEmitter
- m.sender === this.client.getUserId() && m.deviceId === this.client.getDeviceId();
-
if (this.manageMediaKeys && this.isJoined() && this.makeNewKeyTimeout === undefined) {
- const oldMebershipIds = new Set(
- oldMemberships.filter((m) => !isMyMembership(m)).map(getParticipantIdFromMembership),
+ const oldMembershipIds = new Set(
+ oldMemberships.filter((m) => !this.isMyMembership(m)).map(getParticipantIdFromMembership),
);
- const newMebershipIds = new Set(
- this.memberships.filter((m) => !isMyMembership(m)).map(getParticipantIdFromMembership),
+ const newMembershipIds = new Set(
+ this.memberships.filter((m) => !this.isMyMembership(m)).map(getParticipantIdFromMembership),
);
- const anyLeft = Array.from(oldMebershipIds).some((x) => !newMebershipIds.has(x));
- const anyJoined = Array.from(newMebershipIds).some((x) => !oldMebershipIds.has(x));
+ // We can use https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Set/symmetricDifference
+ // for this once available
+ const anyLeft = Array.from(oldMembershipIds).some((x) => !newMembershipIds.has(x));
+ const anyJoined = Array.from(newMembershipIds).some((x) => !oldMembershipIds.has(x));
+
+ const oldFingerprints = this.lastMembershipFingerprints;
+ // always store the fingerprints of these latest memberships
+ this.storeLastMembershipFingerprints();
if (anyLeft) {
logger.debug(`Member(s) have left: queueing sender key rotation`);
@@ -603,40 +728,72 @@ export class MatrixRTCSession extends TypedEventEmitter !newFingerprints.has(x)) ||
+ Array.from(newFingerprints).some((x) => !oldFingerprints.has(x));
+ if (candidateUpdates) {
+ logger.debug(`Member(s) have updated/reconnected: re-sending keys`);
+ this.requestKeyEventSend();
+ }
}
}
this.setExpiryTimer();
};
+ private storeLastMembershipFingerprints(): void {
+ this.lastMembershipFingerprints = new Set(
+ this.memberships
+ .filter((m) => !this.isMyMembership(m))
+ .map((m) => `${getParticipantIdFromMembership(m)}:${m.membershipID}:${m.createdTs()}`),
+ );
+ }
+
/**
* Constructs our own membership
* @param prevMembership - The previous value of our call membership, if any
*/
- private makeMyMembership(prevMembership?: CallMembership): CallMembershipData {
+ private makeMyMembershipLegacy(deviceId: string, prevMembership?: CallMembership): CallMembershipDataLegacy {
if (this.relativeExpiry === undefined) {
throw new Error("Tried to create our own membership event when we're not joined!");
}
if (this.membershipId === undefined) {
throw new Error("Tried to create our own membership event when we have no membership ID!");
}
-
- const m: CallMembershipData = {
+ const createdTs = prevMembership?.createdTs();
+ return {
call_id: "",
scope: "m.room",
application: "m.call",
- device_id: this.client.getDeviceId()!,
+ device_id: deviceId,
expires: this.relativeExpiry,
- foci_active: this.activeFoci,
+ // TODO: Date.now() should be the origin_server_ts (now).
+ expires_ts: this.relativeExpiry + (createdTs ?? Date.now()),
+ // we use the fociPreferred since this is the list of foci.
+ // it is named wrong in the Legacy events.
+ foci_active: this.ownFociPreferred,
membershipID: this.membershipId,
+ ...(createdTs ? { created_ts: createdTs } : {}),
+ };
+ }
+ /**
+ * Constructs our own membership
+ */
+ private makeMyMembership(deviceId: string): SessionMembershipData {
+ return {
+ call_id: "",
+ scope: "m.room",
+ application: "m.call",
+ device_id: deviceId,
+ focus_active: { type: "livekit", focus_selection: "oldest_membership" },
+ foci_preferred: this.ownFociPreferred ?? [],
};
-
- if (prevMembership) m.created_ts = prevMembership.createdTs();
- if (m.created_ts) m.expires_ts = m.created_ts + (m.expires ?? 0);
- // TODO: Date.now() should be the origin_server_ts (now).
- else m.expires_ts = Date.now() + (m.expires ?? 0);
-
- return m;
}
/**
@@ -646,36 +803,41 @@ export class MatrixRTCSession extends TypedEventEmitter {
let membershipObj;
try {
@@ -704,10 +866,10 @@ export class MatrixRTCSession extends TypedEventEmitter => {
@@ -741,57 +903,128 @@ export class MatrixRTCSession extends TypedEventEmitter>() ?? {};
- const memberships: CallMembershipData[] = Array.isArray(content["memberships"]) ? content["memberships"] : [];
-
- const myPrevMembershipData = memberships.find((m) => m.device_id === localDeviceId);
- let myPrevMembership;
- try {
- if (myCallMemberEvent && myPrevMembershipData && myPrevMembershipData.membershipID === this.membershipId) {
- myPrevMembership = new CallMembership(myCallMemberEvent, myPrevMembershipData);
+ const callMemberEvents = roomState.events.get(EventType.GroupCallMemberPrefix);
+ const legacy = this.stateEventsContainOngoingLegacySession(callMemberEvents);
+ let newContent: {} | ExperimentalGroupCallRoomMemberState | SessionMembershipData = {};
+ if (legacy) {
+ const myCallMemberEvent = callMemberEvents?.get(localUserId);
+ const content = myCallMemberEvent?.getContent() ?? {};
+ let myPrevMembership: CallMembership | undefined;
+ // We know its CallMembershipDataLegacy
+ const memberships: CallMembershipDataLegacy[] = Array.isArray(content["memberships"])
+ ? content["memberships"]
+ : [];
+ const myPrevMembershipData = memberships.find((m) => m.device_id === localDeviceId);
+ try {
+ if (
+ myCallMemberEvent &&
+ myPrevMembershipData &&
+ isLegacyCallMembershipData(myPrevMembershipData) &&
+ myPrevMembershipData.membershipID === this.membershipId
+ ) {
+ myPrevMembership = new CallMembership(myCallMemberEvent, myPrevMembershipData);
+ }
+ } catch (e) {
+ // This would indicate a bug or something weird if our own call membership
+ // wasn't valid
+ logger.warn("Our previous call membership was invalid - this shouldn't happen.", e);
}
- } catch (e) {
- // This would indicate a bug or something weird if our own call membership
- // wasn't valid
- logger.warn("Our previous call membership was invalid - this shouldn't happen.", e);
- }
-
- if (myPrevMembership) {
- logger.debug(`${myPrevMembership.getMsUntilExpiry()} until our membership expires`);
- }
-
- if (!this.membershipEventNeedsUpdate(myPrevMembershipData, myPrevMembership)) {
- // nothing to do - reschedule the check again
- this.memberEventTimeout = setTimeout(this.triggerCallMembershipEventUpdate, MEMBER_EVENT_CHECK_PERIOD);
- return;
+ if (myPrevMembership) {
+ logger.debug(`${myPrevMembership.getMsUntilExpiry()} until our membership expires`);
+ }
+ if (!this.membershipEventNeedsUpdate(myPrevMembershipData, myPrevMembership)) {
+ // nothing to do - reschedule the check again
+ this.memberEventTimeout = setTimeout(this.triggerCallMembershipEventUpdate, MEMBER_EVENT_CHECK_PERIOD);
+ return;
+ }
+ newContent = this.makeNewLegacyMemberships(memberships, localDeviceId, myCallMemberEvent, myPrevMembership);
+ } else {
+ newContent = this.makeNewMembership(localDeviceId);
}
- const newContent = {
- memberships: this.makeNewMemberships(memberships, myCallMemberEvent, myPrevMembership),
- };
-
+ const stateKey = legacy ? localUserId : this.makeMembershipStateKey(localUserId, localDeviceId);
try {
- await this.client.sendStateEvent(
- this.room.roomId,
- EventType.GroupCallMemberPrefix,
- newContent,
- localUserId,
- );
+ await this.client.sendStateEvent(this.room.roomId, EventType.GroupCallMemberPrefix, newContent, stateKey);
logger.info(`Sent updated call member event.`);
// check periodically to see if we need to refresh our member event
if (this.isJoined()) {
- this.memberEventTimeout = setTimeout(this.triggerCallMembershipEventUpdate, MEMBER_EVENT_CHECK_PERIOD);
+ if (legacy) {
+ this.memberEventTimeout = setTimeout(
+ this.triggerCallMembershipEventUpdate,
+ MEMBER_EVENT_CHECK_PERIOD,
+ );
+ } else {
+ try {
+ // TODO: If delayed event times out, re-join!
+ const res = await this.client._unstable_sendDelayedStateEvent(
+ this.room.roomId,
+ {
+ delay: 8000,
+ },
+ EventType.GroupCallMemberPrefix,
+ {}, // leave event
+ stateKey,
+ );
+ this.scheduleDelayDisconnection(res.delay_id);
+ } catch (e) {
+ logger.error("Failed to send delayed event:", e);
+ }
+ }
}
} catch (e) {
const resendDelay = CALL_MEMBER_EVENT_RETRY_DELAY_MIN + Math.random() * 2000;
- logger.warn(`Failed to send call member event: retrying in ${resendDelay}`);
+ logger.warn(`Failed to send call member event (retrying in ${resendDelay}): ${e}`);
await new Promise((resolve) => setTimeout(resolve, resendDelay));
await this.triggerCallMembershipEventUpdate();
}
}
+ private scheduleDelayDisconnection(delayId: string): void {
+ this.memberEventTimeout = setTimeout(() => this.delayDisconnection(delayId), 5000);
+ }
+
+ private async delayDisconnection(delayId: string): Promise {
+ try {
+ await this.client._unstable_updateDelayedEvent(delayId, UpdateDelayedEventAction.Restart);
+ this.scheduleDelayDisconnection(delayId);
+ } catch (e) {
+ logger.error("Failed to delay our disconnection event", e);
+ }
+ }
+
+ private stateEventsContainOngoingLegacySession(callMemberEvents: Map | undefined): boolean {
+ if (!callMemberEvents?.size) {
+ return this.useLegacyMemberEvents;
+ }
+
+ let containsAnyOngoingSession = false;
+ let containsUnknownOngoingSession = false;
+ for (const callMemberEvent of callMemberEvents.values()) {
+ const content = callMemberEvent.getContent();
+ if (Array.isArray(content["memberships"])) {
+ for (const membership of content.memberships) {
+ if (!new CallMembership(callMemberEvent, membership).isExpired()) {
+ return true;
+ }
+ }
+ } else if (Object.keys(content).length > 0) {
+ containsAnyOngoingSession ||= true;
+ containsUnknownOngoingSession ||= !("focus_active" in content);
+ }
+ }
+ return containsAnyOngoingSession && !containsUnknownOngoingSession ? false : this.useLegacyMemberEvents;
+ }
+
+ private makeMembershipStateKey(localUserId: string, localDeviceId: string): string {
+ const stateKey = `${localUserId}_${localDeviceId}`;
+ if (/^org\.matrix\.msc(3757|3779)\b/.exec(this.room.getVersion())) {
+ return stateKey;
+ } else {
+ return `_${stateKey}`;
+ }
+ }
+
private onRotateKeyTimeout = (): void => {
if (!this.manageMediaKeys) return;
diff --git a/src/matrixrtc/MatrixRTCSessionManager.ts b/src/matrixrtc/MatrixRTCSessionManager.ts
index 188f7b3e176..e64d19f7a6e 100644
--- a/src/matrixrtc/MatrixRTCSessionManager.ts
+++ b/src/matrixrtc/MatrixRTCSessionManager.ts
@@ -14,14 +14,16 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { logger } from "../logger";
-import { MatrixClient, ClientEvent } from "../client";
-import { TypedEventEmitter } from "../models/typed-event-emitter";
-import { Room, RoomEvent } from "../models/room";
-import { RoomState, RoomStateEvent } from "../models/room-state";
-import { MatrixEvent } from "../models/event";
-import { MatrixRTCSession } from "./MatrixRTCSession";
-import { EventType } from "../@types/event";
+import { logger as rootLogger } from "../logger.ts";
+import { MatrixClient, ClientEvent } from "../client.ts";
+import { TypedEventEmitter } from "../models/typed-event-emitter.ts";
+import { Room, RoomEvent } from "../models/room.ts";
+import { RoomState, RoomStateEvent } from "../models/room-state.ts";
+import { MatrixEvent } from "../models/event.ts";
+import { MatrixRTCSession } from "./MatrixRTCSession.ts";
+import { EventType } from "../@types/event.ts";
+
+const logger = rootLogger.getChild("MatrixRTCSessionManager");
export enum MatrixRTCSessionManagerEvents {
// A member has joined the MatrixRTC session, creating an active session in a room where there wasn't previously
@@ -73,9 +75,9 @@ export class MatrixRTCSessionManager extends TypedEventEmitter {
+ private async consumeCallEncryptionEvent(event: MatrixEvent, isRetry = false): Promise {
await this.client.decryptEventIfNeeded(event);
+ if (event.isDecryptionFailure()) {
+ if (!isRetry) {
+ logger.warn(
+ `Decryption failed for event ${event.getId()}: ${event.decryptionFailureReason} will retry once only`,
+ );
+ // retry after 1 second. After this we give up.
+ setTimeout(() => this.consumeCallEncryptionEvent(event, true), 1000);
+ } else {
+ logger.warn(`Decryption failed for event ${event.getId()}: ${event.decryptionFailureReason}`);
+ }
+ return;
+ } else if (isRetry) {
+ logger.info(`Decryption succeeded for event ${event.getId()} after retry`);
+ }
+
if (event.getType() !== EventType.CallEncryptionKeysPrefix) return Promise.resolve();
const room = this.client.getRoom(event.getRoomId());
diff --git a/src/matrixrtc/focus.ts b/src/matrixrtc/focus.ts
index 6892bbf15c0..cf9836dd450 100644
--- a/src/matrixrtc/focus.ts
+++ b/src/matrixrtc/focus.ts
@@ -21,4 +21,5 @@ limitations under the License.
*/
export interface Focus {
type: string;
+ [key: string]: unknown;
}
diff --git a/src/matrixrtc/index.ts b/src/matrixrtc/index.ts
new file mode 100644
index 00000000000..0474f635300
--- /dev/null
+++ b/src/matrixrtc/index.ts
@@ -0,0 +1,22 @@
+/*
+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.
+*/
+
+export * from "./CallMembership.ts";
+export * from "./focus.ts";
+export * from "./LivekitFocus.ts";
+export * from "./MatrixRTCSession.ts";
+export * from "./MatrixRTCSessionManager.ts";
+export * from "./types.ts";
diff --git a/src/matrixrtc/types.ts b/src/matrixrtc/types.ts
index de4c7ac47dc..479e3436699 100644
--- a/src/matrixrtc/types.ts
+++ b/src/matrixrtc/types.ts
@@ -13,7 +13,7 @@ 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 { IMentions } from "../matrix";
+import { IMentions } from "../matrix.ts";
export interface EncryptionKeyEntry {
index: number;
key: string;
diff --git a/src/models/MSC3089Branch.ts b/src/models/MSC3089Branch.ts
index ebae391e33e..503a6e4af5b 100644
--- a/src/models/MSC3089Branch.ts
+++ b/src/models/MSC3089Branch.ts
@@ -14,14 +14,14 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { MatrixClient } from "../client";
-import { RelationType, UNSTABLE_MSC3089_BRANCH } from "../@types/event";
-import { IContent, MatrixEvent } from "./event";
-import { MSC3089TreeSpace } from "./MSC3089TreeSpace";
-import { EventTimeline } from "./event-timeline";
-import { FileType } from "../http-api";
-import type { ISendEventResponse } from "../@types/requests";
-import { EncryptedFile } from "../@types/media";
+import { MatrixClient } from "../client.ts";
+import { RelationType, UNSTABLE_MSC3089_BRANCH } from "../@types/event.ts";
+import { IContent, MatrixEvent } from "./event.ts";
+import { MSC3089TreeSpace } from "./MSC3089TreeSpace.ts";
+import { EventTimeline } from "./event-timeline.ts";
+import { FileType } from "../http-api/index.ts";
+import type { ISendEventResponse } from "../@types/requests.ts";
+import { EncryptedFile } from "../@types/media.ts";
export interface MSC3089EventContent {
active?: boolean;
diff --git a/src/models/MSC3089TreeSpace.ts b/src/models/MSC3089TreeSpace.ts
index 6dc1b6fbb63..8bcc933d7c2 100644
--- a/src/models/MSC3089TreeSpace.ts
+++ b/src/models/MSC3089TreeSpace.ts
@@ -16,11 +16,11 @@ limitations under the License.
import promiseRetry from "p-retry";
-import { MatrixClient } from "../client";
-import { EventType, MsgType, UNSTABLE_MSC3089_BRANCH, UNSTABLE_MSC3089_LEAF } from "../@types/event";
-import { Room } from "./room";
-import { logger } from "../logger";
-import { IContent, MatrixEvent } from "./event";
+import { MatrixClient } from "../client.ts";
+import { EventType, MsgType, UNSTABLE_MSC3089_BRANCH, UNSTABLE_MSC3089_LEAF } from "../@types/event.ts";
+import { Room } from "./room.ts";
+import { logger } from "../logger.ts";
+import { IContent, MatrixEvent } from "./event.ts";
import {
averageBetweenStrings,
DEFAULT_ALPHABET,
@@ -28,14 +28,14 @@ import {
nextString,
prevString,
simpleRetryOperation,
-} from "../utils";
-import { MSC3089Branch } from "./MSC3089Branch";
-import { isRoomSharedHistory } from "../crypto/algorithms/megolm";
-import { ISendEventResponse } from "../@types/requests";
-import { FileType } from "../http-api";
-import { KnownMembership } from "../@types/membership";
-import { RoomPowerLevelsEventContent, SpaceChildEventContent } from "../@types/state_events";
-import type { EncryptedFile, FileContent } from "../@types/media";
+} from "../utils.ts";
+import { MSC3089Branch } from "./MSC3089Branch.ts";
+import { isRoomSharedHistory } from "../crypto/algorithms/megolm.ts";
+import { ISendEventResponse } from "../@types/requests.ts";
+import { FileType } from "../http-api/index.ts";
+import { KnownMembership } from "../@types/membership.ts";
+import { RoomPowerLevelsEventContent, SpaceChildEventContent } from "../@types/state_events.ts";
+import type { EncryptedFile, FileContent } from "../@types/media.ts";
/**
* The recommended defaults for a tree space's power levels. Note that this
diff --git a/src/models/beacon.ts b/src/models/beacon.ts
index 3801831a1ce..95115780e55 100644
--- a/src/models/beacon.ts
+++ b/src/models/beacon.ts
@@ -14,11 +14,16 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { MBeaconEventContent } from "../@types/beacon";
-import { BeaconInfoState, BeaconLocationState, parseBeaconContent, parseBeaconInfoContent } from "../content-helpers";
-import { MatrixEvent } from "./event";
-import { sortEventsByLatestContentTimestamp } from "../utils";
-import { TypedEventEmitter } from "./typed-event-emitter";
+import { MBeaconEventContent } from "../@types/beacon.ts";
+import {
+ BeaconInfoState,
+ BeaconLocationState,
+ parseBeaconContent,
+ parseBeaconInfoContent,
+} from "../content-helpers.ts";
+import { MatrixEvent } from "./event.ts";
+import { sortEventsByLatestContentTimestamp } from "../utils.ts";
+import { TypedEventEmitter } from "./typed-event-emitter.ts";
export enum BeaconEvent {
New = "Beacon.new",
diff --git a/src/models/compare-event-ordering.ts b/src/models/compare-event-ordering.ts
index 6be23ec0345..31d50812812 100644
--- a/src/models/compare-event-ordering.ts
+++ b/src/models/compare-event-ordering.ts
@@ -14,9 +14,9 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { MatrixEvent } from "./event";
-import { Room } from "./room";
-import { inMainTimelineForReceipt, threadIdForReceipt } from "../client";
+import { MatrixEvent } from "./event.ts";
+import { Room } from "./room.ts";
+import { inMainTimelineForReceipt, threadIdForReceipt } from "../client.ts";
/**
* Determine the order of two events in a room.
diff --git a/src/models/event-context.ts b/src/models/event-context.ts
index 0401cd53007..c99b2db379e 100644
--- a/src/models/event-context.ts
+++ b/src/models/event-context.ts
@@ -14,8 +14,8 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { MatrixEvent } from "./event";
-import { Direction } from "./event-timeline";
+import { MatrixEvent } from "./event.ts";
+import { Direction } from "./event-timeline.ts";
export class EventContext {
private timeline: MatrixEvent[];
diff --git a/src/models/event-timeline-set.ts b/src/models/event-timeline-set.ts
index e64d118fdd5..da8e6383373 100644
--- a/src/models/event-timeline-set.ts
+++ b/src/models/event-timeline-set.ts
@@ -14,16 +14,16 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { EventTimeline, IAddEventOptions } from "./event-timeline";
-import { MatrixEvent } from "./event";
-import { logger } from "../logger";
-import { Room, RoomEvent } from "./room";
-import { Filter } from "../filter";
-import { RoomState } from "./room-state";
-import { TypedEventEmitter } from "./typed-event-emitter";
-import { RelationsContainer } from "./relations-container";
-import { MatrixClient } from "../client";
-import { Thread, ThreadFilterType } from "./thread";
+import { EventTimeline, IAddEventOptions } from "./event-timeline.ts";
+import { MatrixEvent } from "./event.ts";
+import { logger } from "../logger.ts";
+import { Room, RoomEvent } from "./room.ts";
+import { Filter } from "../filter.ts";
+import { RoomState } from "./room-state.ts";
+import { TypedEventEmitter } from "./typed-event-emitter.ts";
+import { RelationsContainer } from "./relations-container.ts";
+import { MatrixClient } from "../client.ts";
+import { Thread, ThreadFilterType } from "./thread.ts";
const DEBUG = true;
@@ -118,7 +118,7 @@ export type EventTimelineSetHandlerMap = {
*/
[RoomEvent.TimelineReset]: (
room: Room | undefined,
- eventTimelineSet: EventTimelineSet,
+ timelineSet: EventTimelineSet,
resetAllTimelines: boolean,
) => void;
};
diff --git a/src/models/event-timeline.ts b/src/models/event-timeline.ts
index 912dcaf2130..3489fdaee7b 100644
--- a/src/models/event-timeline.ts
+++ b/src/models/event-timeline.ts
@@ -14,11 +14,11 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { IMarkerFoundOptions, RoomState } from "./room-state";
-import { EventTimelineSet } from "./event-timeline-set";
-import { MatrixEvent } from "./event";
-import { Filter } from "../filter";
-import { EventType } from "../@types/event";
+import { IMarkerFoundOptions, RoomState } from "./room-state.ts";
+import { EventTimelineSet } from "./event-timeline-set.ts";
+import { MatrixEvent } from "./event.ts";
+import { Filter } from "../filter.ts";
+import { EventType } from "../@types/event.ts";
export interface IInitialiseStateOptions extends Pick {
// This is a separate interface without any extra stuff currently added on
@@ -127,7 +127,7 @@ export class EventTimeline {
public constructor(private readonly eventTimelineSet: EventTimelineSet) {
this.roomId = eventTimelineSet.room?.roomId ?? null;
if (this.roomId) {
- this.startState = new RoomState(this.roomId);
+ this.startState = new RoomState(this.roomId, undefined, true);
this.endState = new RoomState(this.roomId);
}
@@ -267,7 +267,7 @@ export class EventTimeline {
/**
* Get a pagination token
*
- * @param direction - EventTimeline.BACKWARDS to get the pagination
+ * @param direction - EventTimeline.BACKWARDS to get the pagination
* token for going backwards in time; EventTimeline.FORWARDS to get the
* pagination token for going forwards in time.
*
diff --git a/src/models/event.ts b/src/models/event.ts
index 7b9365aad50..8c132144381 100644
--- a/src/models/event.ts
+++ b/src/models/event.ts
@@ -21,9 +21,9 @@ limitations under the License.
import { ExtensibleEvent, ExtensibleEvents, Optional } from "matrix-events-sdk";
-import type { IEventDecryptionResult } from "../@types/crypto";
-import { logger } from "../logger";
-import { VerificationRequest } from "../crypto/verification/request/VerificationRequest";
+import type { IEventDecryptionResult } from "../@types/crypto.ts";
+import { logger } from "../logger.ts";
+import { VerificationRequest } from "../crypto/verification/request/VerificationRequest.ts";
import {
EVENT_VISIBILITY_CHANGE_TYPE,
EventType,
@@ -32,25 +32,24 @@ import {
ToDeviceMessageId,
UNSIGNED_THREAD_ID_FIELD,
UNSIGNED_MEMBERSHIP_FIELD,
-} from "../@types/event";
-import { Crypto } from "../crypto";
-import { deepSortedObjectEntries, internaliseString } from "../utils";
-import { RoomMember } from "./room-member";
-import { Thread, THREAD_RELATION_TYPE, ThreadEvent, ThreadEventHandlerMap } from "./thread";
-import { IActionsObject } from "../pushprocessor";
-import { TypedReEmitter } from "../ReEmitter";
-import { MatrixError } from "../http-api";
-import { TypedEventEmitter } from "./typed-event-emitter";
-import { EventStatus } from "./event-status";
-import { CryptoBackend, DecryptionError } from "../common-crypto/CryptoBackend";
-import { WITHHELD_MESSAGES } from "../crypto/OlmDevice";
-import { IAnnotatedPushRule } from "../@types/PushRules";
-import { Room } from "./room";
-import { EventTimeline } from "./event-timeline";
-import { Membership } from "../@types/membership";
-import { DecryptionFailureCode } from "../crypto-api";
-
-export { EventStatus } from "./event-status";
+} from "../@types/event.ts";
+import { Crypto } from "../crypto/index.ts";
+import { deepSortedObjectEntries, internaliseString } from "../utils.ts";
+import { RoomMember } from "./room-member.ts";
+import { Thread, THREAD_RELATION_TYPE, ThreadEvent, ThreadEventHandlerMap } from "./thread.ts";
+import { IActionsObject } from "../pushprocessor.ts";
+import { TypedReEmitter } from "../ReEmitter.ts";
+import { MatrixError } from "../http-api/index.ts";
+import { TypedEventEmitter } from "./typed-event-emitter.ts";
+import { EventStatus } from "./event-status.ts";
+import { CryptoBackend, DecryptionError } from "../common-crypto/CryptoBackend.ts";
+import { IAnnotatedPushRule } from "../@types/PushRules.ts";
+import { Room } from "./room.ts";
+import { EventTimeline } from "./event-timeline.ts";
+import { Membership } from "../@types/membership.ts";
+import { DecryptionFailureCode } from "../crypto-api/index.ts";
+
+export { EventStatus } from "./event-status.ts";
/* eslint-disable camelcase */
export interface IContent {
@@ -77,7 +76,6 @@ export interface IUnsigned {
"invite_room_state"?: StrippedState[];
"m.relations"?: Record; // No common pattern for aggregated relations
[UNSIGNED_THREAD_ID_FIELD.name]?: string;
- [UNSIGNED_MEMBERSHIP_FIELD.name]?: Membership | string;
}
export interface IThreadBundledRelationship {
@@ -313,12 +311,6 @@ export class MatrixEvent extends TypedEventEmitter {
const unsigned = this.getUnsigned();
- if (typeof unsigned[UNSIGNED_MEMBERSHIP_FIELD.name] === "string") {
- return unsigned[UNSIGNED_MEMBERSHIP_FIELD.name];
- } else {
- return undefined;
- }
+ return UNSIGNED_MEMBERSHIP_FIELD.findIn(unsigned);
}
/**
@@ -792,12 +780,14 @@ export class MatrixEvent extends TypedEventEmitter void;
+ [RoomStateEvent.Events]: (event: MatrixEvent, state: RoomState, prevEvent: MatrixEvent | null) => void;
/**
* Fires whenever a member in the members dictionary is updated in any way.
* @param event - The matrix event which caused this event to fire.
@@ -194,10 +194,22 @@ export class RoomState extends TypedEventEmitter
* As the timeline might get reset while they are loading, this state needs to be inherited
* and shared when the room state is cloned for the new timeline.
* This should only be passed from clone.
+ * @param isStartTimelineState - Optional. This state is marked as a start state.
+ * This is used to skip state insertions that are
+ * in the wrong order. The order is determined by the `replaces_state` id.
+ *
+ * Example:
+ * A current state events `replaces_state` value is `1`.
+ * Trying to insert a state event with `event_id` `1` in its place would fail if isStartTimelineState = false.
+ *
+ * A current state events `event_id` is `2`.
+ * Trying to insert a state event where its `replaces_state` value is `2` would fail if isStartTimelineState = true.
*/
+
public constructor(
public readonly roomId: string,
private oobMemberFlags = { status: OobStatus.NotStarted },
+ public readonly isStartTimelineState = false,
) {
super();
this.updateModifiedTime();
@@ -408,7 +420,7 @@ export class RoomState extends TypedEventEmitter
* Fires {@link RoomStateEvent.Events}
* Fires {@link RoomStateEvent.Marker}
*/
- public setStateEvents(stateEvents: MatrixEvent[], markerFoundOptions?: IMarkerFoundOptions): void {
+ public setStateEvents(stateEvents: MatrixEvent[], options?: IMarkerFoundOptions): void {
this.updateModifiedTime();
// update the core event dict
@@ -420,6 +432,22 @@ export class RoomState extends TypedEventEmitter
}
const lastStateEvent = this.getStateEventMatching(event);
+
+ // Safety measure to not update the room (and emit the update) with older state.
+ // The sync loop really should not send old events but it does very regularly.
+ // Logging on return in those two conditions results in a large amount of logging. (on startup and when running element)
+ const lastReplaceId = lastStateEvent?.event.unsigned?.replaces_state;
+ const lastId = lastStateEvent?.event.event_id;
+ const newReplaceId = event.event.unsigned?.replaces_state;
+ const newId = event.event.event_id;
+ if (this.isStartTimelineState) {
+ // Add an event to the start of the timeline. Its replace id should not be the same as the one of the current/last start state event.
+ if (newReplaceId && lastId && newReplaceId === lastId) return;
+ } else {
+ // Add an event to the end of the timeline. It should not be the same as the one replaced by the current/last end state event.
+ if (lastReplaceId && newId && lastReplaceId === newId) return;
+ }
+
this.setStateEvent(event);
if (event.getType() === EventType.RoomMember) {
this.updateDisplayNameCache(event.getStateKey()!, event.getContent().displayname ?? "");
@@ -476,7 +504,7 @@ export class RoomState extends TypedEventEmitter
// assume all our sentinels are now out-of-date
this.sentinels = {};
} else if (UNSTABLE_MSC2716_MARKER.matches(event.getType())) {
- this.emit(RoomStateEvent.Marker, event, markerFoundOptions);
+ this.emit(RoomStateEvent.Marker, event, options);
}
});
diff --git a/src/models/room.ts b/src/models/room.ts
index d8b90a60856..b013e76afaa 100644
--- a/src/models/room.ts
+++ b/src/models/room.ts
@@ -21,17 +21,17 @@ import {
DuplicateStrategy,
IAddLiveEventOptions,
EventTimelineSetHandlerMap,
-} from "./event-timeline-set";
-import { Direction, EventTimeline } from "./event-timeline";
-import { getHttpUriForMxc } from "../content-repo";
-import { compare, removeElement } from "../utils";
-import { normalize, noUnsafeEventProps } from "../utils";
-import { IEvent, IThreadBundledRelationship, MatrixEvent, MatrixEventEvent, MatrixEventHandlerMap } from "./event";
-import { EventStatus } from "./event-status";
-import { RoomMember } from "./room-member";
-import { IRoomSummary, RoomSummary } from "./room-summary";
-import { logger } from "../logger";
-import { TypedReEmitter } from "../ReEmitter";
+} from "./event-timeline-set.ts";
+import { Direction, EventTimeline } from "./event-timeline.ts";
+import { getHttpUriForMxc } from "../content-repo.ts";
+import { removeElement } from "../utils.ts";
+import { normalize, noUnsafeEventProps } from "../utils.ts";
+import { IEvent, IThreadBundledRelationship, MatrixEvent, MatrixEventEvent, MatrixEventHandlerMap } from "./event.ts";
+import { EventStatus } from "./event-status.ts";
+import { RoomMember } from "./room-member.ts";
+import { IRoomSummary, RoomSummary } from "./room-summary.ts";
+import { logger } from "../logger.ts";
+import { TypedReEmitter } from "../ReEmitter.ts";
import {
EventType,
RoomCreateTypeField,
@@ -40,12 +40,12 @@ import {
EVENT_VISIBILITY_CHANGE_TYPE,
RelationType,
UNSIGNED_THREAD_ID_FIELD,
-} from "../@types/event";
-import { IRoomVersionsCapability, MatrixClient, PendingEventOrdering, RoomVersionStability } from "../client";
-import { GuestAccess, HistoryVisibility, JoinRule, ResizeMethod } from "../@types/partials";
-import { Filter, IFilterDefinition } from "../filter";
-import { RoomState, RoomStateEvent, RoomStateEventHandlerMap } from "./room-state";
-import { BeaconEvent, BeaconEventHandlerMap } from "./beacon";
+} from "../@types/event.ts";
+import { MatrixClient, PendingEventOrdering } from "../client.ts";
+import { GuestAccess, HistoryVisibility, JoinRule, ResizeMethod } from "../@types/partials.ts";
+import { Filter, IFilterDefinition } from "../filter.ts";
+import { RoomState, RoomStateEvent, RoomStateEventHandlerMap } from "./room-state.ts";
+import { BeaconEvent, BeaconEventHandlerMap } from "./beacon.ts";
import {
Thread,
ThreadEvent,
@@ -54,22 +54,23 @@ import {
THREAD_RELATION_TYPE,
FILTER_RELATED_BY_SENDERS,
ThreadFilterType,
-} from "./thread";
+} from "./thread.ts";
import {
CachedReceiptStructure,
MAIN_ROOM_TIMELINE,
Receipt,
ReceiptContent,
ReceiptType,
-} from "../@types/read_receipts";
-import { IStateEventWithRoomId } from "../@types/search";
-import { RelationsContainer } from "./relations-container";
-import { ReadReceipt, synthesizeReceipt } from "./read-receipt";
-import { isPollEvent, Poll, PollEvent } from "./poll";
-import { RoomReceipts } from "./room-receipts";
-import { compareEventOrdering } from "./compare-event-ordering";
-import * as utils from "../utils";
-import { KnownMembership, Membership } from "../@types/membership";
+} from "../@types/read_receipts.ts";
+import { IStateEventWithRoomId } from "../@types/search.ts";
+import { RelationsContainer } from "./relations-container.ts";
+import { ReadReceipt, synthesizeReceipt } from "./read-receipt.ts";
+import { isPollEvent, Poll, PollEvent } from "./poll.ts";
+import { RoomReceipts } from "./room-receipts.ts";
+import { compareEventOrdering } from "./compare-event-ordering.ts";
+import * as utils from "../utils.ts";
+import { KnownMembership, Membership } from "../@types/membership.ts";
+import { Capabilities, IRoomVersionsCapability, RoomVersionStability } from "../serverCapabilities.ts";
// These constants are used as sane defaults when the homeserver doesn't support
// the m.room_versions capability. In practice, KNOWN_SAFE_ROOM_VERSION should be
@@ -208,7 +209,7 @@ export type RoomEventHandlerMap = {
* });
* ```
*/
- [RoomEvent.AccountData]: (event: MatrixEvent, room: Room, lastEvent?: MatrixEvent) => void;
+ [RoomEvent.AccountData]: (event: MatrixEvent, room: Room, prevEvent?: MatrixEvent) => void;
/**
* Fires whenever a receipt is received for a room
* @param event - The receipt event
@@ -397,7 +398,8 @@ export class Room extends ReadReceipt {
* Use getLiveTimeline().getState(EventTimeline.FORWARDS) instead.
*/
public currentState!: RoomState;
- public readonly relations = new RelationsContainer(this.client, this);
+
+ public readonly relations;
/**
* A collection of events known by the client
@@ -459,6 +461,7 @@ export class Room extends ReadReceipt {
private readonly opts: IOpts = {},
) {
super();
+
// In some cases, we add listeners for every displayed Matrix event, so it's
// common to have quite a few more than the default limit.
this.setMaxListeners(100);
@@ -469,6 +472,8 @@ export class Room extends ReadReceipt {
this.name = roomId;
this.normalizedName = roomId;
+ this.relations = new RelationsContainer(this.client, this);
+
// Listen to our own receipt event as a more modular way of processing our own
// receipts. No need to remove the listener: it's on ourself anyway.
this.on(RoomEvent.Receipt, this.onReceipt);
@@ -611,7 +616,10 @@ export class Room extends ReadReceipt {
* Resolves to the version the room should be upgraded to.
*/
public async getRecommendedVersion(): Promise {
- const capabilities = await this.client.getCapabilities();
+ let capabilities: Capabilities = {};
+ try {
+ capabilities = await this.client.getCapabilities();
+ } catch (e) {}
let versionCap = capabilities["m.room_versions"];
if (!versionCap) {
versionCap = {
@@ -636,8 +644,12 @@ export class Room extends ReadReceipt {
"to be supporting a newer room version we don't know about.",
);
- const caps = await this.client.getCapabilities(true);
- versionCap = caps["m.room_versions"];
+ try {
+ capabilities = await this.client.fetchCapabilities();
+ } catch (e) {
+ logger.warn("Failed to refresh room version capabilities", e);
+ }
+ versionCap = capabilities["m.room_versions"];
if (!versionCap) {
logger.warn("No room version capability - assuming upgrade required.");
return result;
@@ -3439,7 +3451,8 @@ export class Room extends ReadReceipt {
return true;
});
// make sure members have stable order
- otherMembers.sort((a, b) => compare(a.userId, b.userId));
+ const collator = new Intl.Collator();
+ otherMembers.sort((a, b) => collator.compare(a.userId, b.userId));
// only 5 first members, immitate summaryHeroes
otherMembers = otherMembers.slice(0, 5);
otherNames = otherMembers.map((m) => m.name);
diff --git a/src/models/search-result.ts b/src/models/search-result.ts
index 525b525fc2c..4677371a5c0 100644
--- a/src/models/search-result.ts
+++ b/src/models/search-result.ts
@@ -14,9 +14,9 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { EventContext } from "./event-context";
-import { EventMapper } from "../event-mapper";
-import { IResultContext, ISearchResult } from "../@types/search";
+import { EventContext } from "./event-context.ts";
+import { EventMapper } from "../event-mapper.ts";
+import { IResultContext, ISearchResult } from "../@types/search.ts";
export class SearchResult {
/**
diff --git a/src/models/thread.ts b/src/models/thread.ts
index 6db967d4e89..905c4db3c1f 100644
--- a/src/models/thread.ts
+++ b/src/models/thread.ts
@@ -16,19 +16,19 @@ limitations under the License.
import { Optional } from "matrix-events-sdk";
-import { MatrixClient, PendingEventOrdering } from "../client";
-import { TypedReEmitter } from "../ReEmitter";
-import { RelationType } from "../@types/event";
-import { IThreadBundledRelationship, MatrixEvent, MatrixEventEvent } from "./event";
-import { Direction, EventTimeline } from "./event-timeline";
-import { EventTimelineSet, EventTimelineSetHandlerMap } from "./event-timeline-set";
-import { NotificationCountType, Room, RoomEvent } from "./room";
-import { RoomState } from "./room-state";
-import { ServerControlledNamespacedValue } from "../NamespacedValue";
-import { logger } from "../logger";
-import { ReadReceipt } from "./read-receipt";
-import { CachedReceiptStructure, Receipt, ReceiptType } from "../@types/read_receipts";
-import { Feature, ServerSupport } from "../feature";
+import { MatrixClient, PendingEventOrdering } from "../client.ts";
+import { TypedReEmitter } from "../ReEmitter.ts";
+import { RelationType } from "../@types/event.ts";
+import { IThreadBundledRelationship, MatrixEvent, MatrixEventEvent } from "./event.ts";
+import { Direction, EventTimeline } from "./event-timeline.ts";
+import { EventTimelineSet, EventTimelineSetHandlerMap } from "./event-timeline-set.ts";
+import { NotificationCountType, Room, RoomEvent } from "./room.ts";
+import { RoomState } from "./room-state.ts";
+import { ServerControlledNamespacedValue } from "../NamespacedValue.ts";
+import { logger } from "../logger.ts";
+import { ReadReceipt } from "./read-receipt.ts";
+import { CachedReceiptStructure, Receipt, ReceiptType } from "../@types/read_receipts.ts";
+import { Feature, ServerSupport } from "../feature.ts";
export enum ThreadEvent {
New = "Thread.new",
diff --git a/src/models/user.ts b/src/models/user.ts
index 32614bedc59..90005c2cf4a 100644
--- a/src/models/user.ts
+++ b/src/models/user.ts
@@ -14,9 +14,9 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { MatrixClient } from "../matrix";
-import { MatrixEvent } from "./event";
-import { TypedEventEmitter } from "./typed-event-emitter";
+import { MatrixClient } from "../matrix.ts";
+import { MatrixEvent } from "./event.ts";
+import { TypedEventEmitter } from "./typed-event-emitter.ts";
export enum UserEvent {
DisplayName = "User.displayName",
diff --git a/src/oidc/authorize.ts b/src/oidc/authorize.ts
index 35b93dc48e2..7e3692dfb94 100644
--- a/src/oidc/authorize.ts
+++ b/src/oidc/authorize.ts
@@ -16,18 +16,19 @@ limitations under the License.
import { IdTokenClaims, Log, OidcClient, SigninResponse, SigninState, WebStorageStateStore } from "oidc-client-ts";
-import { subtleCrypto, TextEncoder } from "../crypto/crypto";
-import { logger } from "../logger";
-import { randomString } from "../randomstring";
-import { OidcError } from "./error";
+import { logger } from "../logger.ts";
+import { randomString } from "../randomstring.ts";
+import { OidcError } from "./error.ts";
import {
- validateIdToken,
- ValidatedIssuerMetadata,
- validateStoredUserState,
- UserState,
BearerTokenResponse,
+ UserState,
validateBearerTokenResponse,
-} from "./validate";
+ ValidatedIssuerMetadata,
+ validateIdToken,
+ validateStoredUserState,
+} from "./validate.ts";
+import { sha256 } from "../digest.ts";
+import { encodeUnpaddedBase64Url } from "../base64.ts";
// reexport for backwards compatibility
export type { BearerTokenResponse };
@@ -57,19 +58,14 @@ export const generateScope = (deviceId?: string): string => {
// https://www.rfc-editor.org/rfc/rfc7636
const generateCodeChallenge = async (codeVerifier: string): Promise => {
- if (!subtleCrypto) {
+ if (!globalThis.crypto.subtle) {
// @TODO(kerrya) should this be allowed? configurable?
logger.warn("A secure context is required to generate code challenge. Using plain text code challenge");
return codeVerifier;
}
- const utf8 = new TextEncoder().encode(codeVerifier);
-
- const digest = await subtleCrypto.digest("SHA-256", utf8);
- return btoa(String.fromCharCode(...new Uint8Array(digest)))
- .replace(/=/g, "")
- .replace(/\+/g, "-")
- .replace(/\//g, "_");
+ const hashBuffer = await sha256(codeVerifier);
+ return encodeUnpaddedBase64Url(hashBuffer);
};
/**
diff --git a/src/oidc/discovery.ts b/src/oidc/discovery.ts
index 7199c8715d4..656bb30a5c8 100644
--- a/src/oidc/discovery.ts
+++ b/src/oidc/discovery.ts
@@ -16,9 +16,9 @@ limitations under the License.
import { MetadataService, OidcClientSettingsStore } from "oidc-client-ts";
-import { isValidatedIssuerMetadata, validateOIDCIssuerWellKnown } from "./validate";
-import { Method, timeoutSignal } from "../http-api";
-import { OidcClientConfig } from "./index";
+import { isValidatedIssuerMetadata, validateOIDCIssuerWellKnown } from "./validate.ts";
+import { Method, timeoutSignal } from "../http-api/index.ts";
+import { OidcClientConfig } from "./index.ts";
/**
* @experimental
diff --git a/src/oidc/index.ts b/src/oidc/index.ts
index 7fc31836f83..519b311a617 100644
--- a/src/oidc/index.ts
+++ b/src/oidc/index.ts
@@ -15,14 +15,14 @@ limitations under the License.
*/
import type { SigningKey } from "oidc-client-ts";
-import { ValidatedIssuerConfig, ValidatedIssuerMetadata } from "./validate";
+import { ValidatedIssuerConfig, ValidatedIssuerMetadata } from "./validate.ts";
-export * from "./authorize";
-export * from "./discovery";
-export * from "./error";
-export * from "./register";
-export * from "./tokenRefresher";
-export * from "./validate";
+export * from "./authorize.ts";
+export * from "./discovery.ts";
+export * from "./error.ts";
+export * from "./register.ts";
+export * from "./tokenRefresher.ts";
+export * from "./validate.ts";
/**
* Validated config for native OIDC authentication, as returned by {@link discoverAndValidateOIDCIssuerWellKnown}.
diff --git a/src/oidc/register.ts b/src/oidc/register.ts
index 0c5f0556557..25c3673d3a1 100644
--- a/src/oidc/register.ts
+++ b/src/oidc/register.ts
@@ -14,11 +14,11 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { OidcClientConfig } from ".";
-import { OidcError } from "./error";
-import { Method } from "../http-api";
-import { logger } from "../logger";
-import { NonEmptyArray } from "../@types/common";
+import { OidcClientConfig } from "./index.ts";
+import { OidcError } from "./error.ts";
+import { Method } from "../http-api/index.ts";
+import { logger } from "../logger.ts";
+import { NonEmptyArray } from "../@types/common.ts";
/**
* Client metadata passed to registration endpoint
@@ -49,6 +49,8 @@ interface OidcRegistrationRequestBody {
application_type: "web" | "native";
}
+export const DEVICE_CODE_SCOPE = "urn:ietf:params:oauth:grant-type:device_code";
+
/**
* Attempts dynamic registration against the configured registration endpoint
* @param delegatedAuthConfig - Auth config from {@link discoverAndValidateOIDCIssuerWellKnown}
diff --git a/src/oidc/tokenRefresher.ts b/src/oidc/tokenRefresher.ts
index 84b773531b9..b75de5c2ce3 100644
--- a/src/oidc/tokenRefresher.ts
+++ b/src/oidc/tokenRefresher.ts
@@ -16,10 +16,10 @@ limitations under the License.
import { IdTokenClaims, OidcClient, WebStorageStateStore } from "oidc-client-ts";
-import { AccessTokens } from "../http-api";
-import { generateScope } from "./authorize";
-import { discoverAndValidateOIDCIssuerWellKnown } from "./discovery";
-import { logger } from "../logger";
+import { AccessTokens } from "../http-api/index.ts";
+import { generateScope } from "./authorize.ts";
+import { discoverAndValidateOIDCIssuerWellKnown } from "./discovery.ts";
+import { logger } from "../logger.ts";
/**
* @experimental
diff --git a/src/oidc/validate.ts b/src/oidc/validate.ts
index de50b570b66..72eb7e96e64 100644
--- a/src/oidc/validate.ts
+++ b/src/oidc/validate.ts
@@ -17,8 +17,8 @@ limitations under the License.
import { jwtDecode } from "jwt-decode";
import { IdTokenClaims, OidcMetadata, SigninResponse } from "oidc-client-ts";
-import { logger } from "../logger";
-import { OidcError } from "./error";
+import { logger } from "../logger.ts";
+import { OidcError } from "./error.ts";
export type ValidatedIssuerConfig = {
authorizationEndpoint: string;
diff --git a/src/pushprocessor.ts b/src/pushprocessor.ts
index 734a72751c3..be40c2d1e83 100644
--- a/src/pushprocessor.ts
+++ b/src/pushprocessor.ts
@@ -14,10 +14,10 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { deepCompare, escapeRegExp, globToRegexp, isNullOrUndefined } from "./utils";
-import { logger } from "./logger";
-import { MatrixClient } from "./client";
-import { MatrixEvent } from "./models/event";
+import { deepCompare, escapeRegExp, globToRegexp, isNullOrUndefined } from "./utils.ts";
+import { logger } from "./logger.ts";
+import { MatrixClient } from "./client.ts";
+import { MatrixEvent } from "./models/event.ts";
import {
ConditionKind,
IAnnotatedPushRule,
@@ -38,8 +38,8 @@ import {
PushRuleSet,
RuleId,
TweakName,
-} from "./@types/PushRules";
-import { EventType } from "./@types/event";
+} from "./@types/PushRules.ts";
+import { EventType } from "./@types/event.ts";
const RULEKINDS_IN_ORDER = [
PushRuleKind.Override,
diff --git a/src/randomstring.ts b/src/randomstring.ts
index 36a6e748284..d0cc9e675d2 100644
--- a/src/randomstring.ts
+++ b/src/randomstring.ts
@@ -15,8 +15,7 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { encodeUnpaddedBase64Url } from "./base64";
-import { crypto } from "./crypto/crypto";
+import { encodeUnpaddedBase64Url } from "./base64.ts";
const LOWERCASE = "abcdefghijklmnopqrstuvwxyz";
const UPPERCASE = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
@@ -24,7 +23,7 @@ const DIGITS = "0123456789";
export function secureRandomBase64Url(len: number): string {
const key = new Uint8Array(len);
- crypto.getRandomValues(key);
+ globalThis.crypto.getRandomValues(key);
return encodeUnpaddedBase64Url(key);
}
diff --git a/src/realtime-callbacks.ts b/src/realtime-callbacks.ts
index 1b03a579a28..b59d145344a 100644
--- a/src/realtime-callbacks.ts
+++ b/src/realtime-callbacks.ts
@@ -24,7 +24,7 @@ limitations under the License.
* it will instead fire as soon as possible after resume.
*/
-import { logger } from "./logger";
+import { logger } from "./logger.ts";
// we schedule a callback at least this often, to check if we've missed out on
// some wall-clock time due to being suspended.
diff --git a/src/receipt-accumulator.ts b/src/receipt-accumulator.ts
index ded358ad9a1..707b2ff2714 100644
--- a/src/receipt-accumulator.ts
+++ b/src/receipt-accumulator.ts
@@ -14,11 +14,11 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { IMinimalEvent } from "./sync-accumulator";
-import { EventType } from "./@types/event";
-import { isSupportedReceiptType, MapWithDefault, recursiveMapToObject } from "./utils";
-import { IContent } from "./models/event";
-import { ReceiptContent, ReceiptType } from "./@types/read_receipts";
+import { IMinimalEvent } from "./sync-accumulator.ts";
+import { EventType } from "./@types/event.ts";
+import { isSupportedReceiptType, MapWithDefault, recursiveMapToObject } from "./utils.ts";
+import { IContent } from "./models/event.ts";
+import { ReceiptContent, ReceiptType } from "./@types/read_receipts.ts";
interface AccumulatedReceipt {
data: IMinimalEvent;
diff --git a/src/rendezvous/MSC3906Rendezvous.ts b/src/rendezvous/MSC3906Rendezvous.ts
index e558c224abe..a84a41d687a 100644
--- a/src/rendezvous/MSC3906Rendezvous.ts
+++ b/src/rendezvous/MSC3906Rendezvous.ts
@@ -16,13 +16,18 @@ limitations under the License.
import { UnstableValue } from "matrix-events-sdk";
-import { RendezvousChannel, RendezvousFailureListener, RendezvousFailureReason, RendezvousIntent } from ".";
-import { IGetLoginTokenCapability, MatrixClient, GET_LOGIN_TOKEN_CAPABILITY } from "../client";
-import { buildFeatureSupportMap, Feature, ServerSupport } from "../feature";
-import { logger } from "../logger";
-import { sleep } from "../utils";
-import { CrossSigningKey } from "../crypto-api";
-import { Device } from "../matrix";
+import {
+ RendezvousChannel,
+ RendezvousFailureListener,
+ LegacyRendezvousFailureReason as RendezvousFailureReason,
+ RendezvousIntent,
+} from "./index.ts";
+import { MatrixClient, GET_LOGIN_TOKEN_CAPABILITY } from "../client.ts";
+import { buildFeatureSupportMap, Feature, ServerSupport } from "../feature.ts";
+import { logger } from "../logger.ts";
+import { sleep } from "../utils.ts";
+import { CrossSigningKey } from "../crypto-api/index.ts";
+import { Capabilities, Device, IGetLoginTokenCapability } from "../matrix.ts";
enum PayloadType {
Start = "m.login.start",
@@ -59,6 +64,9 @@ const LOGIN_TOKEN_PROTOCOL = new UnstableValue("login_token", "org.matrix.msc390
* Implements MSC3906 to allow a user to sign in on a new device using QR code.
* This implementation only supports generating a QR code on a device that is already signed in.
* Note that this is UNSTABLE and may have breaking changes without notice.
+ * MSC3886/MSC3903/MSC3906 are now closed and so this functionality will be removed in future.
+ * However, we want to keep this implementation around for some time.
+ * TODO: define an end-of-life date for this implementation.
*/
export class MSC3906Rendezvous {
private newDeviceId?: string;
@@ -101,7 +109,10 @@ export class MSC3906Rendezvous {
logger.info(`Connected to secure channel with checksum: ${checksum} our intent is ${this.ourIntent}`);
// in stable and unstable r1 the availability is exposed as a capability
- const capabilities = await this.client.getCapabilities();
+ let capabilities: Capabilities = {};
+ try {
+ capabilities = await this.client.getCapabilities();
+ } catch (e) {}
// in r0 of MSC3882 the availability is exposed as a feature flag
const features = await buildFeatureSupportMap(await this.client.getVersions());
const capability = GET_LOGIN_TOKEN_CAPABILITY.findIn(capabilities);
diff --git a/src/rendezvous/MSC4108SignInWithQR.ts b/src/rendezvous/MSC4108SignInWithQR.ts
new file mode 100644
index 00000000000..a22b3149e5a
--- /dev/null
+++ b/src/rendezvous/MSC4108SignInWithQR.ts
@@ -0,0 +1,444 @@
+/*
+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 { QrCodeMode } from "@matrix-org/matrix-sdk-crypto-wasm";
+
+import {
+ ClientRendezvousFailureReason,
+ MSC4108FailureReason,
+ RendezvousError,
+ RendezvousFailureListener,
+} from "./index.ts";
+import { MatrixClient } from "../client.ts";
+import { logger } from "../logger.ts";
+import { MSC4108SecureChannel } from "./channels/MSC4108SecureChannel.ts";
+import { MatrixError } from "../http-api/index.ts";
+import { sleep } from "../utils.ts";
+import { DEVICE_CODE_SCOPE, discoverAndValidateOIDCIssuerWellKnown, OidcClientConfig } from "../oidc/index.ts";
+import { CryptoApi } from "../crypto-api/index.ts";
+
+/**
+ * Enum representing the payload types transmissible over [MSC4108](https://github.com/matrix-org/matrix-spec-proposals/pull/4108)
+ * secure channels.
+ * @experimental Note that this is UNSTABLE and may have breaking changes without notice.
+ */
+export enum PayloadType {
+ Protocols = "m.login.protocols",
+ Protocol = "m.login.protocol",
+ Failure = "m.login.failure",
+ Success = "m.login.success",
+ Secrets = "m.login.secrets",
+ ProtocolAccepted = "m.login.protocol_accepted",
+ Declined = "m.login.declined",
+}
+
+/**
+ * Type representing the base payload format for [MSC4108](https://github.com/matrix-org/matrix-spec-proposals/pull/4108)
+ * messages sent over the secure channel.
+ * @experimental Note that this is UNSTABLE and may have breaking changes without notice.
+ */
+export interface MSC4108Payload {
+ type: PayloadType;
+}
+
+interface ProtocolsPayload extends MSC4108Payload {
+ type: PayloadType.Protocols;
+ protocols: string[];
+ homeserver: string;
+}
+
+interface ProtocolPayload extends MSC4108Payload {
+ type: PayloadType.Protocol;
+ protocol: Exclude;
+ device_id: string;
+}
+
+interface DeviceAuthorizationGrantProtocolPayload extends ProtocolPayload {
+ protocol: "device_authorization_grant";
+ device_authorization_grant: {
+ verification_uri: string;
+ verification_uri_complete?: string;
+ };
+}
+
+function isDeviceAuthorizationGrantProtocolPayload(
+ payload: ProtocolPayload,
+): payload is DeviceAuthorizationGrantProtocolPayload {
+ return payload.protocol === "device_authorization_grant";
+}
+
+interface FailurePayload extends MSC4108Payload {
+ type: PayloadType.Failure;
+ reason: MSC4108FailureReason;
+ homeserver?: string;
+}
+
+interface DeclinedPayload extends MSC4108Payload {
+ type: PayloadType.Declined;
+}
+
+interface SuccessPayload extends MSC4108Payload {
+ type: PayloadType.Success;
+}
+
+interface AcceptedPayload extends MSC4108Payload {
+ type: PayloadType.ProtocolAccepted;
+}
+
+interface SecretsPayload extends MSC4108Payload, Awaited>> {
+ type: PayloadType.Secrets;
+}
+
+/**
+ * Prototype of the unstable [MSC4108](https://github.com/matrix-org/matrix-spec-proposals/pull/4108)
+ * sign in with QR + OIDC flow.
+ * @experimental Note that this is UNSTABLE and may have breaking changes without notice.
+ */
+export class MSC4108SignInWithQR {
+ private readonly ourIntent: QrCodeMode;
+ private _code?: Uint8Array;
+ private expectingNewDeviceId?: string;
+
+ /**
+ * Returns the check code for the secure channel or undefined if not generated yet.
+ */
+ public get checkCode(): string | undefined {
+ return this.channel?.getCheckCode();
+ }
+
+ /**
+ * @param channel - The secure channel used for communication
+ * @param client - The Matrix client in used on the device already logged in
+ * @param didScanCode - Whether this side of the channel scanned the QR code from the other party
+ * @param onFailure - Callback for when the rendezvous fails
+ */
+ public constructor(
+ private readonly channel: MSC4108SecureChannel,
+ private readonly didScanCode: boolean,
+ private readonly client?: MatrixClient,
+ public onFailure?: RendezvousFailureListener,
+ ) {
+ this.ourIntent = client ? QrCodeMode.Reciprocate : QrCodeMode.Login;
+ }
+
+ /**
+ * Returns the code representing the rendezvous suitable for rendering in a QR code or undefined if not generated yet.
+ */
+ public get code(): Uint8Array | undefined {
+ return this._code;
+ }
+
+ /**
+ * Generate the code including doing partial set up of the channel where required.
+ */
+ public async generateCode(): Promise {
+ if (this._code) {
+ return;
+ }
+
+ if (this.ourIntent === QrCodeMode.Reciprocate && this.client) {
+ this._code = await this.channel.generateCode(this.ourIntent, this.client.getDomain()!);
+ } else if (this.ourIntent === QrCodeMode.Login) {
+ this._code = await this.channel.generateCode(this.ourIntent);
+ }
+ }
+
+ /**
+ * Returns true if the device is the already logged in device reciprocating a new login on the other side of the channel.
+ */
+ public get isExistingDevice(): boolean {
+ return this.ourIntent === QrCodeMode.Reciprocate;
+ }
+
+ /**
+ * Returns true if the device is the new device logging in being reciprocated by the device on the other side of the channel.
+ */
+ public get isNewDevice(): boolean {
+ return !this.isExistingDevice;
+ }
+
+ /**
+ * The first step in the OIDC QR login process.
+ * To be called after the QR code has been rendered or scanned.
+ * The scanning device has to discover the homeserver details, if they scanned the code then they already have it.
+ * If the new device is the one rendering the QR code then it has to wait be sent the homeserver details via the rendezvous channel.
+ */
+ public async negotiateProtocols(): Promise<{ serverName?: string }> {
+ logger.info(`negotiateProtocols(isNewDevice=${this.isNewDevice} didScanCode=${this.didScanCode})`);
+ await this.channel.connect();
+
+ if (this.didScanCode) {
+ // Secure Channel step 6 completed, we trust the channel
+
+ if (this.isNewDevice) {
+ // MSC4108-Flow: ExistingScanned - take homeserver from QR code which should already be set
+ } else {
+ // MSC4108-Flow: NewScanned -send protocols message
+ let oidcClientConfig: OidcClientConfig | undefined;
+ try {
+ const { issuer } = await this.client!.getAuthIssuer();
+ oidcClientConfig = await discoverAndValidateOIDCIssuerWellKnown(issuer);
+ } catch (e) {
+ logger.error("Failed to discover OIDC metadata", e);
+ }
+
+ if (oidcClientConfig?.metadata.grant_types_supported.includes(DEVICE_CODE_SCOPE)) {
+ await this.send({
+ type: PayloadType.Protocols,
+ protocols: ["device_authorization_grant"],
+ homeserver: this.client!.getDomain()!,
+ });
+ } else {
+ await this.send({
+ type: PayloadType.Failure,
+ reason: MSC4108FailureReason.UnsupportedProtocol,
+ });
+ throw new RendezvousError(
+ "Device code grant unsupported",
+ MSC4108FailureReason.UnsupportedProtocol,
+ );
+ }
+ }
+ } else if (this.isNewDevice) {
+ // MSC4108-Flow: ExistingScanned - wait for protocols message
+ logger.info("Waiting for protocols message");
+ const payload = await this.receive();
+
+ if (payload?.type === PayloadType.Failure) {
+ throw new RendezvousError("Failed", payload.reason);
+ }
+
+ if (payload?.type !== PayloadType.Protocols) {
+ await this.send({
+ type: PayloadType.Failure,
+ reason: MSC4108FailureReason.UnexpectedMessageReceived,
+ });
+ throw new RendezvousError(
+ "Unexpected message received",
+ MSC4108FailureReason.UnexpectedMessageReceived,
+ );
+ }
+
+ return { serverName: payload.homeserver };
+ } else {
+ // MSC4108-Flow: NewScanned - nothing to do
+ }
+ return {};
+ }
+
+ /**
+ * The second & third step in the OIDC QR login process.
+ * To be called after `negotiateProtocols` for the existing device.
+ * To be called after OIDC negotiation for the new device. (Currently unsupported)
+ */
+ public async deviceAuthorizationGrant(): Promise<{
+ verificationUri?: string;
+ userCode?: string;
+ }> {
+ if (this.isNewDevice) {
+ throw new Error("New device flows around OIDC are not yet implemented");
+ } else {
+ // The user needs to do step 7 for the out-of-band confirmation
+ // but, first we receive the protocol chosen by the other device so that
+ // the confirmation_uri is ready to go
+ logger.info("Waiting for protocol message");
+ const payload = await this.receive();
+
+ if (payload?.type === PayloadType.Failure) {
+ throw new RendezvousError("Failed", payload.reason);
+ }
+
+ if (payload?.type !== PayloadType.Protocol) {
+ await this.send({
+ type: PayloadType.Failure,
+ reason: MSC4108FailureReason.UnexpectedMessageReceived,
+ });
+ throw new RendezvousError(
+ "Unexpected message received",
+ MSC4108FailureReason.UnexpectedMessageReceived,
+ );
+ }
+
+ if (isDeviceAuthorizationGrantProtocolPayload(payload)) {
+ const { device_authorization_grant: dag, device_id: expectingNewDeviceId } = payload;
+ const { verification_uri: verificationUri, verification_uri_complete: verificationUriComplete } = dag;
+
+ let deviceAlreadyExists = true;
+ try {
+ await this.client?.getDevice(expectingNewDeviceId);
+ } catch (err: MatrixError | unknown) {
+ if (err instanceof MatrixError && err.httpStatus === 404) {
+ deviceAlreadyExists = false;
+ }
+ }
+
+ if (deviceAlreadyExists) {
+ await this.send({
+ type: PayloadType.Failure,
+ reason: MSC4108FailureReason.DeviceAlreadyExists,
+ });
+ throw new RendezvousError(
+ "Specified device ID already exists",
+ MSC4108FailureReason.DeviceAlreadyExists,
+ );
+ }
+
+ this.expectingNewDeviceId = expectingNewDeviceId;
+
+ return { verificationUri: verificationUriComplete ?? verificationUri };
+ }
+
+ await this.send({
+ type: PayloadType.Failure,
+ reason: MSC4108FailureReason.UnsupportedProtocol,
+ });
+ throw new RendezvousError(
+ "Received a request for an unsupported protocol",
+ MSC4108FailureReason.UnsupportedProtocol,
+ );
+ }
+ }
+
+ /**
+ * The fifth (and final) step in the OIDC QR login process.
+ * To be called after the new device has completed authentication.
+ */
+ public async shareSecrets(): Promise<{ secrets?: Omit }> {
+ if (this.isNewDevice) {
+ await this.send({
+ type: PayloadType.Success,
+ });
+ // then wait for secrets
+ logger.info("Waiting for secrets message");
+ const payload = await this.receive();
+ if (payload?.type === PayloadType.Failure) {
+ throw new RendezvousError("Failed", payload.reason);
+ }
+
+ if (payload?.type !== PayloadType.Secrets) {
+ await this.send({
+ type: PayloadType.Failure,
+ reason: MSC4108FailureReason.UnexpectedMessageReceived,
+ });
+ throw new RendezvousError(
+ "Unexpected message received",
+ MSC4108FailureReason.UnexpectedMessageReceived,
+ );
+ }
+ return { secrets: payload };
+ // then done?
+ } else {
+ if (!this.expectingNewDeviceId) {
+ throw new Error("No new device ID expected");
+ }
+ await this.send({
+ type: PayloadType.ProtocolAccepted,
+ });
+
+ logger.info("Waiting for outcome message");
+ const payload = await this.receive();
+
+ if (payload?.type === PayloadType.Failure) {
+ throw new RendezvousError("Failed", payload.reason);
+ }
+
+ if (payload?.type === PayloadType.Declined) {
+ throw new RendezvousError("User declined", ClientRendezvousFailureReason.UserDeclined);
+ }
+
+ if (payload?.type !== PayloadType.Success) {
+ await this.send({
+ type: PayloadType.Failure,
+ reason: MSC4108FailureReason.UnexpectedMessageReceived,
+ });
+ throw new RendezvousError("Unexpected message", MSC4108FailureReason.UnexpectedMessageReceived);
+ }
+
+ const timeout = Date.now() + 10000; // wait up to 10 seconds
+ do {
+ // is the device visible via the Homeserver?
+ try {
+ const device = await this.client?.getDevice(this.expectingNewDeviceId);
+
+ if (device) {
+ // if so, return the secrets
+ const secretsBundle = await this.client!.getCrypto()!.exportSecretsBundle!();
+ if (this.channel.cancelled) {
+ throw new RendezvousError("User cancelled", MSC4108FailureReason.UserCancelled);
+ }
+ // send secrets
+ await this.send({
+ type: PayloadType.Secrets,
+ ...secretsBundle,
+ });
+ return { secrets: secretsBundle };
+ // let the other side close the rendezvous session
+ }
+ } catch (err: MatrixError | unknown) {
+ if (err instanceof MatrixError && err.httpStatus === 404) {
+ // not found, so keep waiting until timeout
+ } else {
+ throw err;
+ }
+ }
+ await sleep(1000);
+ } while (Date.now() < timeout);
+
+ await this.send({
+ type: PayloadType.Failure,
+ reason: MSC4108FailureReason.DeviceNotFound,
+ });
+ throw new RendezvousError("New device not found", MSC4108FailureReason.DeviceNotFound);
+ }
+ }
+
+ private async receive(): Promise {
+ return (await this.channel.secureReceive()) as T | undefined;
+ }
+
+ private async send(payload: T): Promise {
+ await this.channel.secureSend(payload);
+ }
+
+ /**
+ * Decline the login on the existing device.
+ */
+ public async declineLoginOnExistingDevice(): Promise {
+ if (!this.isExistingDevice) {
+ throw new Error("Can only decline login on existing device");
+ }
+ await this.send({
+ type: PayloadType.Failure,
+ reason: MSC4108FailureReason.UserCancelled,
+ });
+ }
+
+ /**
+ * Cancels the rendezvous session.
+ * @param reason the reason for the cancellation
+ */
+ public async cancel(reason: MSC4108FailureReason | ClientRendezvousFailureReason): Promise {
+ this.onFailure?.(reason);
+ await this.channel.cancel(reason);
+ }
+
+ /**
+ * Closes the rendezvous session.
+ */
+ public async close(): Promise {
+ await this.channel.close();
+ }
+}
diff --git a/src/rendezvous/RendezvousChannel.ts b/src/rendezvous/RendezvousChannel.ts
index 549ebc83f51..ced8523bdb4 100644
--- a/src/rendezvous/RendezvousChannel.ts
+++ b/src/rendezvous/RendezvousChannel.ts
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { RendezvousCode, RendezvousIntent, RendezvousFailureReason } from ".";
+import { RendezvousCode, RendezvousIntent, RendezvousFailureReason } from "./index.ts";
export interface RendezvousChannel {
/**
diff --git a/src/rendezvous/RendezvousCode.ts b/src/rendezvous/RendezvousCode.ts
index 86608aa1c44..e5b89aae67c 100644
--- a/src/rendezvous/RendezvousCode.ts
+++ b/src/rendezvous/RendezvousCode.ts
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { RendezvousTransportDetails, RendezvousIntent } from ".";
+import { RendezvousTransportDetails, RendezvousIntent } from "./index.ts";
export interface RendezvousCode {
intent: RendezvousIntent;
diff --git a/src/rendezvous/RendezvousError.ts b/src/rendezvous/RendezvousError.ts
index b3026d43b87..502538fff61 100644
--- a/src/rendezvous/RendezvousError.ts
+++ b/src/rendezvous/RendezvousError.ts
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { RendezvousFailureReason } from ".";
+import { RendezvousFailureReason } from "./index.ts";
export class RendezvousError extends Error {
public constructor(
diff --git a/src/rendezvous/RendezvousFailureReason.ts b/src/rendezvous/RendezvousFailureReason.ts
index b19a91cec0b..7a0116ca0e1 100644
--- a/src/rendezvous/RendezvousFailureReason.ts
+++ b/src/rendezvous/RendezvousFailureReason.ts
@@ -16,16 +16,47 @@ limitations under the License.
export type RendezvousFailureListener = (reason: RendezvousFailureReason) => void;
-export enum RendezvousFailureReason {
+export type RendezvousFailureReason =
+ | LegacyRendezvousFailureReason
+ | MSC4108FailureReason
+ | ClientRendezvousFailureReason;
+
+export enum LegacyRendezvousFailureReason {
UserDeclined = "user_declined",
- OtherDeviceNotSignedIn = "other_device_not_signed_in",
- OtherDeviceAlreadySignedIn = "other_device_already_signed_in",
Unknown = "unknown",
Expired = "expired",
UserCancelled = "user_cancelled",
- InvalidCode = "invalid_code",
UnsupportedAlgorithm = "unsupported_algorithm",
- DataMismatch = "data_mismatch",
- UnsupportedTransport = "unsupported_transport",
+ UnsupportedProtocol = "unsupported_protocol",
+ HomeserverLacksSupport = "homeserver_lacks_support",
+}
+
+export enum MSC4108FailureReason {
+ AuthorizationExpired = "authorization_expired",
+ DeviceAlreadyExists = "device_already_exists",
+ DeviceNotFound = "device_not_found",
+ UnexpectedMessageReceived = "unexpected_message_received",
+ UnsupportedProtocol = "unsupported_protocol",
+ UserCancelled = "user_cancelled",
+}
+
+export enum ClientRendezvousFailureReason {
+ /** The sign in request has expired */
+ Expired = "expired",
+ /** The homeserver is lacking support for the required features */
HomeserverLacksSupport = "homeserver_lacks_support",
+ /** The secure channel verification failed meaning that it might be compromised */
+ InsecureChannelDetected = "insecure_channel_detected",
+ /** An invalid/incompatible QR code was scanned */
+ InvalidCode = "invalid_code",
+ /** The other device is not signed in */
+ OtherDeviceNotSignedIn = "other_device_not_signed_in",
+ /** The other device is already signed in */
+ OtherDeviceAlreadySignedIn = "other_device_already_signed_in",
+ /** Other */
+ Unknown = "unknown",
+ /** The user declined the sign in request */
+ UserDeclined = "user_declined",
+ /** The rendezvous request is missing an ETag header */
+ ETagMissing = "etag_missing",
}
diff --git a/src/rendezvous/RendezvousTransport.ts b/src/rendezvous/RendezvousTransport.ts
index 08905be65e8..a86db5fc076 100644
--- a/src/rendezvous/RendezvousTransport.ts
+++ b/src/rendezvous/RendezvousTransport.ts
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { RendezvousFailureListener, RendezvousFailureReason } from ".";
+import { RendezvousFailureListener, RendezvousFailureReason } from "./index.ts";
export interface RendezvousTransportDetails {
type: string;
diff --git a/src/rendezvous/channels/MSC3903ECDHv2RendezvousChannel.ts b/src/rendezvous/channels/MSC3903ECDHv2RendezvousChannel.ts
index 872c6ea2c78..47b8e3fd8dc 100644
--- a/src/rendezvous/channels/MSC3903ECDHv2RendezvousChannel.ts
+++ b/src/rendezvous/channels/MSC3903ECDHv2RendezvousChannel.ts
@@ -17,18 +17,17 @@ limitations under the License.
import { SAS } from "@matrix-org/olm";
import {
- RendezvousError,
+ LegacyRendezvousFailureReason as RendezvousFailureReason,
+ RendezvousChannel,
RendezvousCode,
+ RendezvousError,
RendezvousIntent,
- RendezvousChannel,
- RendezvousTransportDetails,
RendezvousTransport,
- RendezvousFailureReason,
-} from "..";
-import { encodeUnpaddedBase64, decodeBase64 } from "../../base64";
-import { crypto, subtleCrypto, TextEncoder } from "../../crypto/crypto";
-import { generateDecimalSas } from "../../crypto/verification/SASDecimal";
-import { UnstableValue } from "../../NamespacedValue";
+ RendezvousTransportDetails,
+} from "../index.ts";
+import { decodeBase64, encodeUnpaddedBase64 } from "../../base64.ts";
+import { generateDecimalSas } from "../../crypto/verification/SASDecimal.ts";
+import { UnstableValue } from "../../NamespacedValue.ts";
const ECDH_V2 = new UnstableValue(
"m.rendezvous.v2.curve25519-aes-sha256",
@@ -56,11 +55,11 @@ export interface EncryptedPayload {
}
async function importKey(key: Uint8Array): Promise {
- if (!subtleCrypto) {
+ if (!globalThis.crypto.subtle) {
throw new Error("Web Crypto is not available");
}
- const imported = subtleCrypto.importKey("raw", key, { name: "AES-GCM" }, false, ["encrypt", "decrypt"]);
+ const imported = globalThis.crypto.subtle.importKey("raw", key, { name: "AES-GCM" }, false, ["encrypt", "decrypt"]);
return imported;
}
@@ -69,6 +68,9 @@ async function importKey(key: Uint8Array): Promise {
* Implementation of the unstable [MSC3903](https://github.com/matrix-org/matrix-spec-proposals/pull/3903)
* X25519/ECDH key agreement based secure rendezvous channel.
* Note that this is UNSTABLE and may have breaking changes without notice.
+ * MSC3886/MSC3903/MSC3906 are now closed and so this functionality will be removed in future.
+ * However, we want to keep this implementation around for some time.
+ * TODO: define an end-of-life date for this implementation.
*/
export class MSC3903ECDHv2RendezvousChannel implements RendezvousChannel {
private olmSAS?: SAS;
@@ -161,16 +163,16 @@ export class MSC3903ECDHv2RendezvousChannel implements RendezvousChannel {
}
private async encrypt(data: T): Promise {
- if (!subtleCrypto) {
+ if (!globalThis.crypto.subtle) {
throw new Error("Web Crypto is not available");
}
const iv = new Uint8Array(32);
- crypto.getRandomValues(iv);
+ globalThis.crypto.getRandomValues(iv);
const encodedData = new TextEncoder().encode(JSON.stringify(data));
- const ciphertext = await subtleCrypto.encrypt(
+ const ciphertext = await globalThis.crypto.subtle.encrypt(
{
name: "AES-GCM",
iv,
@@ -205,11 +207,11 @@ export class MSC3903ECDHv2RendezvousChannel implements RendezvousChannel {
const ciphertextBytes = decodeBase64(ciphertext);
- if (!subtleCrypto) {
+ if (!globalThis.crypto.subtle) {
throw new Error("Web Crypto is not available");
}
- const plaintext = await subtleCrypto.decrypt(
+ const plaintext = await globalThis.crypto.subtle.decrypt(
{
name: "AES-GCM",
iv: decodeBase64(iv),
diff --git a/src/rendezvous/channels/MSC4108SecureChannel.ts b/src/rendezvous/channels/MSC4108SecureChannel.ts
new file mode 100644
index 00000000000..8165000e768
--- /dev/null
+++ b/src/rendezvous/channels/MSC4108SecureChannel.ts
@@ -0,0 +1,270 @@
+/*
+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 {
+ Curve25519PublicKey,
+ Ecies,
+ EstablishedEcies,
+ QrCodeData,
+ QrCodeMode,
+} from "@matrix-org/matrix-sdk-crypto-wasm";
+
+import {
+ ClientRendezvousFailureReason,
+ MSC4108FailureReason,
+ MSC4108Payload,
+ RendezvousError,
+ RendezvousFailureListener,
+} from "../index.ts";
+import { MSC4108RendezvousSession } from "../transports/MSC4108RendezvousSession.ts";
+import { logger } from "../../logger.ts";
+
+/**
+ * Prototype of the unstable [MSC4108](https://github.com/matrix-org/matrix-spec-proposals/pull/4108)
+ * secure rendezvous session protocol.
+ * @experimental Note that this is UNSTABLE and may have breaking changes without notice.
+ * Imports @matrix-org/matrix-sdk-crypto-wasm so should be async-imported to avoid bundling the WASM into the main bundle.
+ */
+export class MSC4108SecureChannel {
+ private readonly secureChannel: Ecies;
+ private establishedChannel?: EstablishedEcies;
+ private connected = false;
+
+ public constructor(
+ private rendezvousSession: MSC4108RendezvousSession,
+ private theirPublicKey?: Curve25519PublicKey,
+ public onFailure?: RendezvousFailureListener,
+ ) {
+ this.secureChannel = new Ecies();
+ }
+
+ /**
+ * Generate a QR code for the current session.
+ * @param mode the mode to generate the QR code in, either `Login` or `Reciprocate`.
+ * @param serverName the name of the homeserver to connect to, as defined by server discovery in the spec, required for `Reciprocate` mode.
+ */
+ public async generateCode(mode: QrCodeMode.Login): Promise;
+ public async generateCode(mode: QrCodeMode.Reciprocate, serverName: string): Promise;
+ public async generateCode(mode: QrCodeMode, serverName?: string): Promise {
+ const { url } = this.rendezvousSession;
+
+ if (!url) {
+ throw new Error("No rendezvous session URL");
+ }
+
+ return new QrCodeData(
+ this.secureChannel.public_key(),
+ url,
+ mode === QrCodeMode.Reciprocate ? serverName : undefined,
+ ).toBytes();
+ }
+
+ /**
+ * Returns the check code for the secure channel or undefined if not generated yet.
+ */
+ public getCheckCode(): string | undefined {
+ const x = this.establishedChannel?.check_code();
+
+ if (!x) {
+ return undefined;
+ }
+ return Array.from(x.as_bytes())
+ .map((b) => `${b % 10}`)
+ .join("");
+ }
+
+ /**
+ * Connects and establishes a secure channel with the other device.
+ */
+ public async connect(): Promise {
+ if (this.connected) {
+ throw new Error("Channel already connected");
+ }
+
+ if (this.theirPublicKey) {
+ // We are the scanning device
+ const result = this.secureChannel.establish_outbound_channel(
+ this.theirPublicKey,
+ "MATRIX_QR_CODE_LOGIN_INITIATE",
+ );
+ this.establishedChannel = result.channel;
+
+ /*
+ Secure Channel step 4. Device S sends the initial message
+
+ Nonce := 0
+ SH := ECDH(Ss, Gp)
+ EncKey := HKDF_SHA256(SH, "MATRIX_QR_CODE_LOGIN|" || Gp || "|" || Sp, 0, 32)
+ TaggedCiphertext := ChaCha20Poly1305_Encrypt(EncKey, Nonce, "MATRIX_QR_CODE_LOGIN_INITIATE")
+ Nonce := Nonce + 2
+ LoginInitiateMessage := UnpaddedBase64(TaggedCiphertext) || "|" || UnpaddedBase64(Sp)
+ */
+ {
+ logger.info("Sending LoginInitiateMessage");
+ await this.rendezvousSession.send(result.initial_message);
+ }
+
+ /*
+ Secure Channel step 6. Verification by Device S
+
+ Nonce_G := 1
+ (TaggedCiphertext, Sp) := Unpack(Message)
+ Plaintext := ChaCha20Poly1305_Decrypt(EncKey, Nonce_G, TaggedCiphertext)
+ Nonce_G := Nonce_G + 2
+
+ unless Plaintext == "MATRIX_QR_CODE_LOGIN_OK":
+ FAIL
+ */
+ {
+ logger.info("Waiting for LoginOkMessage");
+ const ciphertext = await this.rendezvousSession.receive();
+
+ if (!ciphertext) {
+ throw new RendezvousError(
+ "No response from other device",
+ MSC4108FailureReason.UnexpectedMessageReceived,
+ );
+ }
+ const candidateLoginOkMessage = await this.decrypt(ciphertext);
+
+ if (candidateLoginOkMessage !== "MATRIX_QR_CODE_LOGIN_OK") {
+ throw new RendezvousError(
+ "Invalid response from other device",
+ ClientRendezvousFailureReason.InsecureChannelDetected,
+ );
+ }
+
+ // Step 6 is now complete. We trust the channel
+ }
+ } else {
+ /*
+ Secure Channel step 5. Device G confirms
+
+ Nonce_S := 0
+ (TaggedCiphertext, Sp) := Unpack(LoginInitiateMessage)
+ SH := ECDH(Gs, Sp)
+ EncKey := HKDF_SHA256(SH, "MATRIX_QR_CODE_LOGIN|" || Gp || "|" || Sp, 0, 32)
+ Plaintext := ChaCha20Poly1305_Decrypt(EncKey, Nonce_S, TaggedCiphertext)
+ Nonce_S := Nonce_S + 2
+ */
+ // wait for the other side to send us their public key
+ logger.info("Waiting for LoginInitiateMessage");
+ const loginInitiateMessage = await this.rendezvousSession.receive();
+ if (!loginInitiateMessage) {
+ throw new Error("No response from other device");
+ }
+
+ const { channel, message: candidateLoginInitiateMessage } =
+ this.secureChannel.establish_inbound_channel(loginInitiateMessage);
+ this.establishedChannel = channel;
+
+ if (candidateLoginInitiateMessage !== "MATRIX_QR_CODE_LOGIN_INITIATE") {
+ throw new RendezvousError(
+ "Invalid response from other device",
+ ClientRendezvousFailureReason.InsecureChannelDetected,
+ );
+ }
+ logger.info("LoginInitiateMessage received");
+
+ logger.info("Sending LoginOkMessage");
+ const loginOkMessage = await this.encrypt("MATRIX_QR_CODE_LOGIN_OK");
+ await this.rendezvousSession.send(loginOkMessage);
+
+ // Step 5 is complete. We don't yet trust the channel
+
+ // next step will be for the user to confirm the check code on the other device
+ }
+
+ this.connected = true;
+ }
+
+ private async decrypt(ciphertext: string): Promise {
+ if (!this.establishedChannel) {
+ throw new Error("Channel closed");
+ }
+
+ return this.establishedChannel.decrypt(ciphertext);
+ }
+
+ private async encrypt(plaintext: string): Promise {
+ if (!this.establishedChannel) {
+ throw new Error("Channel closed");
+ }
+
+ return this.establishedChannel.encrypt(plaintext);
+ }
+
+ /**
+ * Sends a payload securely to the other device.
+ * @param payload the payload to encrypt and send
+ */
+ public async secureSend(payload: T): Promise {
+ if (!this.connected) {
+ throw new Error("Channel closed");
+ }
+
+ const stringifiedPayload = JSON.stringify(payload);
+ logger.debug(`=> {"type": ${JSON.stringify(payload.type)}, ...}`);
+
+ await this.rendezvousSession.send(await this.encrypt(stringifiedPayload));
+ }
+
+ /**
+ * Receives an encrypted payload from the other device and decrypts it.
+ */
+ public async secureReceive(): Promise | undefined> {
+ if (!this.establishedChannel) {
+ throw new Error("Channel closed");
+ }
+
+ const ciphertext = await this.rendezvousSession.receive();
+ if (!ciphertext) {
+ return undefined;
+ }
+ const plaintext = await this.decrypt(ciphertext);
+ const json = JSON.parse(plaintext);
+
+ logger.debug(`<= {"type": ${JSON.stringify(json.type)}, ...}`);
+ return json as Partial | undefined;
+ }
+
+ /**
+ * Closes the secure channel.
+ */
+ public async close(): Promise {
+ await this.rendezvousSession.close();
+ }
+
+ /**
+ * Cancels the secure channel.
+ * @param reason the reason for the cancellation
+ */
+ public async cancel(reason: MSC4108FailureReason | ClientRendezvousFailureReason): Promise {
+ try {
+ await this.rendezvousSession.cancel(reason);
+ this.onFailure?.(reason);
+ } finally {
+ await this.close();
+ }
+ }
+
+ /**
+ * Returns whether the rendezvous session has been cancelled.
+ */
+ public get cancelled(): boolean {
+ return this.rendezvousSession.cancelled;
+ }
+}
diff --git a/src/rendezvous/channels/index.ts b/src/rendezvous/channels/index.ts
index f157bbeaef1..c525e278485 100644
--- a/src/rendezvous/channels/index.ts
+++ b/src/rendezvous/channels/index.ts
@@ -14,4 +14,8 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-export * from "./MSC3903ECDHv2RendezvousChannel";
+/**
+ * @deprecated in favour of MSC4108-based implementation
+ */
+export * from "./MSC3903ECDHv2RendezvousChannel.ts";
+export * from "./MSC4108SecureChannel.ts";
diff --git a/src/rendezvous/index.ts b/src/rendezvous/index.ts
index 379b13351b8..5b8d83f51e8 100644
--- a/src/rendezvous/index.ts
+++ b/src/rendezvous/index.ts
@@ -14,10 +14,16 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-export * from "./MSC3906Rendezvous";
-export * from "./RendezvousChannel";
-export * from "./RendezvousCode";
-export * from "./RendezvousError";
-export * from "./RendezvousFailureReason";
-export * from "./RendezvousIntent";
-export * from "./RendezvousTransport";
+/**
+ * @deprecated in favour of MSC4108-based implementation
+ */
+export * from "./MSC3906Rendezvous.ts";
+export * from "./MSC4108SignInWithQR.ts";
+export * from "./RendezvousChannel.ts";
+export * from "./RendezvousCode.ts";
+export * from "./RendezvousError.ts";
+export * from "./RendezvousFailureReason.ts";
+export * from "./RendezvousIntent.ts";
+export * from "./RendezvousTransport.ts";
+export * from "./transports/index.ts";
+export * from "./channels/index.ts";
diff --git a/src/rendezvous/transports/MSC3886SimpleHttpRendezvousTransport.ts b/src/rendezvous/transports/MSC3886SimpleHttpRendezvousTransport.ts
index 430ee92d1c7..b8521eda420 100644
--- a/src/rendezvous/transports/MSC3886SimpleHttpRendezvousTransport.ts
+++ b/src/rendezvous/transports/MSC3886SimpleHttpRendezvousTransport.ts
@@ -16,16 +16,16 @@ limitations under the License.
import { UnstableValue } from "matrix-events-sdk";
-import { logger } from "../../logger";
-import { sleep } from "../../utils";
+import { logger } from "../../logger.ts";
+import { sleep } from "../../utils.ts";
import {
RendezvousFailureListener,
- RendezvousFailureReason,
+ LegacyRendezvousFailureReason as RendezvousFailureReason,
RendezvousTransport,
RendezvousTransportDetails,
-} from "..";
-import { MatrixClient } from "../../matrix";
-import { ClientPrefix } from "../../http-api";
+} from "../index.ts";
+import { MatrixClient } from "../../matrix.ts";
+import { ClientPrefix } from "../../http-api/index.ts";
const TYPE = new UnstableValue("http.v1", "org.matrix.msc3886.http.v1");
@@ -37,6 +37,9 @@ export interface MSC3886SimpleHttpRendezvousTransportDetails extends RendezvousT
* Implementation of the unstable [MSC3886](https://github.com/matrix-org/matrix-spec-proposals/pull/3886)
* simple HTTP rendezvous protocol.
* Note that this is UNSTABLE and may have breaking changes without notice.
+ * MSC3886/MSC3903/MSC3906 are now closed and so this functionality will be removed in future.
+ * However, we want to keep this implementation around for some time.
+ * TODO: define an end-of-life date for this implementation.
*/
export class MSC3886SimpleHttpRendezvousTransport implements RendezvousTransport {
private uri?: string;
diff --git a/src/rendezvous/transports/MSC4108RendezvousSession.ts b/src/rendezvous/transports/MSC4108RendezvousSession.ts
new file mode 100644
index 00000000000..98091471fae
--- /dev/null
+++ b/src/rendezvous/transports/MSC4108RendezvousSession.ts
@@ -0,0 +1,270 @@
+/*
+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 { logger } from "../../logger.ts";
+import { sleep } from "../../utils.ts";
+import { ClientRendezvousFailureReason, MSC4108FailureReason, RendezvousFailureListener } from "../index.ts";
+import { MatrixClient, Method } from "../../matrix.ts";
+import { ClientPrefix } from "../../http-api/index.ts";
+
+/**
+ * Prototype of the unstable [MSC4108](https://github.com/matrix-org/matrix-spec-proposals/pull/4108)
+ * insecure rendezvous session protocol.
+ * @experimental Note that this is UNSTABLE and may have breaking changes without notice.
+ */
+export class MSC4108RendezvousSession {
+ public url?: string;
+ private readonly client?: MatrixClient;
+ private readonly fallbackRzServer?: string;
+ private readonly fetchFn?: typeof global.fetch;
+ private readonly onFailure?: RendezvousFailureListener;
+ private etag?: string;
+ private expiresAt?: Date;
+ private expiresTimer?: ReturnType;
+ private _cancelled = false;
+ private _ready = false;
+
+ public constructor({
+ onFailure,
+ url,
+ fetchFn,
+ }: {
+ fetchFn?: typeof global.fetch;
+ onFailure?: RendezvousFailureListener;
+ url: string;
+ });
+ public constructor({
+ onFailure,
+ client,
+ fallbackRzServer,
+ fetchFn,
+ }: {
+ fetchFn?: typeof global.fetch;
+ onFailure?: RendezvousFailureListener;
+ client?: MatrixClient;
+ fallbackRzServer?: string;
+ });
+ public constructor({
+ fetchFn,
+ onFailure,
+ url,
+ client,
+ fallbackRzServer,
+ }: {
+ fetchFn?: typeof global.fetch;
+ onFailure?: RendezvousFailureListener;
+ url?: string;
+ client?: MatrixClient;
+ fallbackRzServer?: string;
+ }) {
+ this.fetchFn = fetchFn;
+ this.onFailure = onFailure;
+ this.client = client;
+ this.fallbackRzServer = fallbackRzServer;
+ this.url = url;
+ }
+
+ /**
+ * Returns whether the channel is ready to be used.
+ */
+ public get ready(): boolean {
+ return this._ready;
+ }
+
+ /**
+ * Returns whether the channel has been cancelled.
+ */
+ public get cancelled(): boolean {
+ return this._cancelled;
+ }
+
+ private fetch(resource: URL | string, options?: RequestInit): ReturnType {
+ if (this.fetchFn) {
+ return this.fetchFn(resource, options);
+ }
+ return global.fetch(resource, options);
+ }
+
+ private async getPostEndpoint(): Promise {
+ if (this.client) {
+ try {
+ if (await this.client.doesServerSupportUnstableFeature("org.matrix.msc4108")) {
+ return this.client.http
+ .getUrl("/org.matrix.msc4108/rendezvous", undefined, ClientPrefix.Unstable)
+ .toString();
+ }
+ } catch (err) {
+ logger.warn("Failed to get unstable features", err);
+ }
+ }
+
+ return this.fallbackRzServer;
+ }
+
+ /**
+ * Sends data via the rendezvous channel.
+ * @param data the payload to send
+ */
+ public async send(data: string): Promise {
+ if (this._cancelled) {
+ return;
+ }
+ const method = this.url ? Method.Put : Method.Post;
+ const uri = this.url ?? (await this.getPostEndpoint());
+
+ if (!uri) {
+ throw new Error("Invalid rendezvous URI");
+ }
+
+ const headers: Record = { "content-type": "text/plain" };
+
+ // if we didn't create the rendezvous channel, we need to fetch the first etag if needed
+ if (!this.etag && this.url) {
+ await this.receive();
+ }
+
+ if (this.etag) {
+ headers["if-match"] = this.etag;
+ }
+
+ logger.info(`=> ${method} ${uri} with ${data} if-match: ${this.etag}`);
+
+ const res = await this.fetch(uri, { method, headers, body: data, redirect: "follow" });
+ if (res.status === 404) {
+ return this.cancel(ClientRendezvousFailureReason.Unknown);
+ }
+ this.etag = res.headers.get("etag") ?? undefined;
+
+ logger.info(`Received etag: ${this.etag}`);
+
+ if (method === Method.Post) {
+ const expires = res.headers.get("expires");
+ if (expires) {
+ if (this.expiresTimer) {
+ clearTimeout(this.expiresTimer);
+ this.expiresTimer = undefined;
+ }
+ this.expiresAt = new Date(expires);
+ this.expiresTimer = setTimeout(() => {
+ this.expiresTimer = undefined;
+ this.cancel(ClientRendezvousFailureReason.Expired);
+ }, this.expiresAt.getTime() - Date.now());
+ }
+ // MSC4108: we expect a JSON response with a rendezvous URL
+ const json = await res.json();
+ if (typeof json.url !== "string") {
+ throw new Error("No rendezvous URL given");
+ }
+ this.url = json.url;
+ this._ready = true;
+ }
+ }
+
+ /**
+ * Receives data from the rendezvous channel.
+ * @return the returned promise won't resolve until new data is acquired or the channel is closed either by the server or the other party.
+ */
+ public async receive(): Promise {
+ if (!this.url) {
+ throw new Error("Rendezvous not set up");
+ }
+ // eslint-disable-next-line no-constant-condition
+ while (true) {
+ if (this._cancelled) {
+ return undefined;
+ }
+
+ const headers: Record = {};
+ if (this.etag) {
+ headers["if-none-match"] = this.etag;
+ }
+
+ logger.info(`=> GET ${this.url} if-none-match: ${this.etag}`);
+ const poll = await this.fetch(this.url, { method: Method.Get, headers });
+
+ if (poll.status === 404) {
+ await this.cancel(ClientRendezvousFailureReason.Unknown);
+ return undefined;
+ }
+
+ // rely on server expiring the channel rather than checking ourselves
+
+ const etag = poll.headers.get("etag") ?? undefined;
+ if (poll.headers.get("content-type") !== "text/plain") {
+ this.etag = etag;
+ } else if (poll.status === 200) {
+ if (!etag) {
+ // Some browsers & extensions block the ETag header for anti-tracking purposes
+ // We try and detect this so the client can give the user a somewhat helpful message
+ await this.cancel(ClientRendezvousFailureReason.ETagMissing);
+ return undefined;
+ }
+
+ this.etag = etag;
+ const text = await poll.text();
+ logger.info(`Received: ${text} with etag ${this.etag}`);
+ return text;
+ }
+ await sleep(1000);
+ }
+ }
+
+ /**
+ * Cancels the rendezvous channel.
+ * If the reason is user_declined or user_cancelled then the channel will also be closed.
+ * @param reason the reason to cancel with
+ */
+ public async cancel(reason: MSC4108FailureReason | ClientRendezvousFailureReason): Promise {
+ if (this._cancelled) return;
+ if (this.expiresTimer) {
+ clearTimeout(this.expiresTimer);
+ this.expiresTimer = undefined;
+ }
+
+ if (
+ reason === ClientRendezvousFailureReason.Unknown &&
+ this.expiresAt &&
+ this.expiresAt.getTime() < Date.now()
+ ) {
+ reason = ClientRendezvousFailureReason.Expired;
+ }
+
+ this._cancelled = true;
+ this._ready = false;
+ this.onFailure?.(reason);
+
+ if (reason === ClientRendezvousFailureReason.UserDeclined || reason === MSC4108FailureReason.UserCancelled) {
+ await this.close();
+ }
+ }
+
+ /**
+ * Closes the rendezvous channel.
+ */
+ public async close(): Promise {
+ if (this.expiresTimer) {
+ clearTimeout(this.expiresTimer);
+ this.expiresTimer = undefined;
+ }
+
+ if (!this.url) return;
+ try {
+ await this.fetch(this.url, { method: Method.Delete });
+ } catch (e) {
+ logger.warn(e);
+ }
+ }
+}
diff --git a/src/rendezvous/transports/index.ts b/src/rendezvous/transports/index.ts
index 6d8d64245e4..88fe91ba1d9 100644
--- a/src/rendezvous/transports/index.ts
+++ b/src/rendezvous/transports/index.ts
@@ -14,4 +14,8 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-export * from "./MSC3886SimpleHttpRendezvousTransport";
+/**
+ * @deprecated in favour of MSC4108-based implementation
+ */
+export * from "./MSC3886SimpleHttpRendezvousTransport.ts";
+export * from "./MSC4108RendezvousSession.ts";
diff --git a/src/room-hierarchy.ts b/src/room-hierarchy.ts
index 5c0b61d743f..58e952545af 100644
--- a/src/room-hierarchy.ts
+++ b/src/room-hierarchy.ts
@@ -14,11 +14,11 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-import { Room } from "./models/room";
-import { IHierarchyRoom, IHierarchyRelation } from "./@types/spaces";
-import { MatrixClient } from "./client";
-import { EventType } from "./@types/event";
-import { MatrixError } from "./http-api";
+import { Room } from "./models/room.ts";
+import { IHierarchyRoom, IHierarchyRelation } from "./@types/spaces.ts";
+import { MatrixClient } from "./client.ts";
+import { EventType } from "./@types/event.ts";
+import { MatrixError } from "./http-api/index.ts";
export class RoomHierarchy {
// Map from room id to list of servers which are listed as a via somewhere in the loaded hierarchy
diff --git a/src/rust-crypto/CrossSigningIdentity.ts b/src/rust-crypto/CrossSigningIdentity.ts
index 7a994a8d049..76f7189db9b 100644
--- a/src/rust-crypto/CrossSigningIdentity.ts
+++ b/src/rust-crypto/CrossSigningIdentity.ts
@@ -17,11 +17,11 @@ limitations under the License.
import { OlmMachine, CrossSigningStatus, CrossSigningBootstrapRequests } from "@matrix-org/matrix-sdk-crypto-wasm";
import * as RustSdkCryptoJs from "@matrix-org/matrix-sdk-crypto-wasm";
-import { BootstrapCrossSigningOpts } from "../crypto-api";
-import { logger } from "../logger";
-import { OutgoingRequestProcessor } from "./OutgoingRequestProcessor";
-import { UIAuthCallback } from "../interactive-auth";
-import { ServerSideSecretStorage } from "../secret-storage";
+import { BootstrapCrossSigningOpts } from "../crypto-api/index.ts";
+import { logger } from "../logger.ts";
+import { OutgoingRequestProcessor } from "./OutgoingRequestProcessor.ts";
+import { UIAuthCallback } from "../interactive-auth.ts";
+import { ServerSideSecretStorage } from "../secret-storage.ts";
/** Manages the cross-signing keys for our own user.
*
diff --git a/src/rust-crypto/DehydratedDeviceManager.ts b/src/rust-crypto/DehydratedDeviceManager.ts
index 56f6052b724..ca6be006f1b 100644
--- a/src/rust-crypto/DehydratedDeviceManager.ts
+++ b/src/rust-crypto/DehydratedDeviceManager.ts
@@ -16,14 +16,13 @@ limitations under the License.
import * as RustSdkCryptoJs from "@matrix-org/matrix-sdk-crypto-wasm";
-import { OutgoingRequestProcessor } from "./OutgoingRequestProcessor";
-import { encodeUri } from "../utils";
-import { IHttpOpts, MatrixError, MatrixHttpApi, Method } from "../http-api";
-import { IToDeviceEvent } from "../sync-accumulator";
-import { ServerSideSecretStorage } from "../secret-storage";
-import { crypto } from "../crypto/crypto";
-import { decodeBase64, encodeUnpaddedBase64 } from "../base64";
-import { Logger } from "../logger";
+import { OutgoingRequestProcessor } from "./OutgoingRequestProcessor.ts";
+import { encodeUri } from "../utils.ts";
+import { IHttpOpts, MatrixError, MatrixHttpApi, Method } from "../http-api/index.ts";
+import { IToDeviceEvent } from "../sync-accumulator.ts";
+import { ServerSideSecretStorage } from "../secret-storage.ts";
+import { decodeBase64, encodeUnpaddedBase64 } from "../base64.ts";
+import { Logger } from "../logger.ts";
/**
* The response body of `GET /_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device`.
@@ -155,7 +154,7 @@ export class DehydratedDeviceManager {
*/
public async resetKey(): Promise {
const key = new Uint8Array(32);
- crypto.getRandomValues(key);
+ globalThis.crypto.getRandomValues(key);
await this.secretStorage.store(SECRET_STORAGE_NAME, encodeUnpaddedBase64(key));
this.key = key;
}
diff --git a/src/rust-crypto/KeyClaimManager.ts b/src/rust-crypto/KeyClaimManager.ts
index aaeed4d1435..3023de8c2f8 100644
--- a/src/rust-crypto/KeyClaimManager.ts
+++ b/src/rust-crypto/KeyClaimManager.ts
@@ -16,8 +16,8 @@ limitations under the License.
import { OlmMachine, UserId } from "@matrix-org/matrix-sdk-crypto-wasm";
-import { OutgoingRequestProcessor } from "./OutgoingRequestProcessor";
-import { LogSpan } from "../logger";
+import { OutgoingRequestProcessor } from "./OutgoingRequestProcessor.ts";
+import { LogSpan } from "../logger.ts";
/**
* KeyClaimManager: linearises calls to OlmMachine.getMissingSessions to avoid races
diff --git a/src/rust-crypto/OutgoingRequestProcessor.ts b/src/rust-crypto/OutgoingRequestProcessor.ts
index d3ae4d9c4a3..ec8e38fcf53 100644
--- a/src/rust-crypto/OutgoingRequestProcessor.ts
+++ b/src/rust-crypto/OutgoingRequestProcessor.ts
@@ -27,13 +27,13 @@ import {
UploadSigningKeysRequest,
} from "@matrix-org/matrix-sdk-crypto-wasm";
-import { logger } from "../logger";
-import { calculateRetryBackoff, IHttpOpts, MatrixHttpApi, Method } from "../http-api";
-import { logDuration, QueryDict, sleep } from "../utils";
-import { AuthDict, UIAuthCallback } from "../interactive-auth";
-import { UIAResponse } from "../@types/uia";
-import { ToDeviceMessageId } from "../@types/event";
-import { UnstablePrefix as DehydrationUnstablePrefix } from "./DehydratedDeviceManager";
+import { logger } from "../logger.ts";
+import { calculateRetryBackoff, IHttpOpts, MatrixHttpApi, Method } from "../http-api/index.ts";
+import { logDuration, QueryDict, sleep } from "../utils.ts";
+import { AuthDict, UIAuthCallback } from "../interactive-auth.ts";
+import { UIAResponse } from "../@types/uia.ts";
+import { ToDeviceMessageId } from "../@types/event.ts";
+import { UnstablePrefix as DehydrationUnstablePrefix } from "./DehydratedDeviceManager.ts";
/**
* Common interface for all the request types returned by `OlmMachine.outgoingRequests`.
diff --git a/src/rust-crypto/OutgoingRequestsManager.ts b/src/rust-crypto/OutgoingRequestsManager.ts
index 81b3001c83a..72823d88b60 100644
--- a/src/rust-crypto/OutgoingRequestsManager.ts
+++ b/src/rust-crypto/OutgoingRequestsManager.ts
@@ -16,9 +16,9 @@ limitations under the License.
import { OlmMachine } from "@matrix-org/matrix-sdk-crypto-wasm";
-import { OutgoingRequest, OutgoingRequestProcessor } from "./OutgoingRequestProcessor";
-import { Logger } from "../logger";
-import { defer, IDeferred, logDuration } from "../utils";
+import { OutgoingRequest, OutgoingRequestProcessor } from "./OutgoingRequestProcessor.ts";
+import { Logger } from "../logger.ts";
+import { defer, IDeferred, logDuration } from "../utils.ts";
/**
* OutgoingRequestsManager: responsible for processing outgoing requests from the OlmMachine.
diff --git a/src/rust-crypto/PerSessionKeyBackupDownloader.ts b/src/rust-crypto/PerSessionKeyBackupDownloader.ts
index ad5a649c51f..e463cbaa7d9 100644
--- a/src/rust-crypto/PerSessionKeyBackupDownloader.ts
+++ b/src/rust-crypto/PerSessionKeyBackupDownloader.ts
@@ -17,13 +17,13 @@ limitations under the License.
import * as RustSdkCryptoJs from "@matrix-org/matrix-sdk-crypto-wasm";
import { OlmMachine } from "@matrix-org/matrix-sdk-crypto-wasm";
-import { Curve25519AuthData, KeyBackupInfo, KeyBackupSession } from "../crypto-api/keybackup";
-import { Logger } from "../logger";
-import { ClientPrefix, IHttpOpts, MatrixError, MatrixHttpApi, Method } from "../http-api";
-import { RustBackupManager } from "./backup";
-import { CryptoEvent } from "../matrix";
-import { encodeUri, sleep } from "../utils";
-import { BackupDecryptor } from "../common-crypto/CryptoBackend";
+import { Curve25519AuthData, KeyBackupInfo, KeyBackupSession } from "../crypto-api/keybackup.ts";
+import { Logger } from "../logger.ts";
+import { ClientPrefix, IHttpOpts, MatrixError, MatrixHttpApi, Method } from "../http-api/index.ts";
+import { RustBackupManager } from "./backup.ts";
+import { CryptoEvent } from "../matrix.ts";
+import { encodeUri, sleep } from "../utils.ts";
+import { BackupDecryptor } from "../common-crypto/CryptoBackend.ts";
// The minimum time to wait between two retries in case of errors. To avoid hammering the server.
const KEY_BACKUP_BACKOFF = 5000; // ms
diff --git a/src/rust-crypto/RoomEncryptor.ts b/src/rust-crypto/RoomEncryptor.ts
index 7447ae61a74..3b6a6c80cc0 100644
--- a/src/rust-crypto/RoomEncryptor.ts
+++ b/src/rust-crypto/RoomEncryptor.ts
@@ -14,27 +14,28 @@ 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 {
+ CollectStrategy,
EncryptionAlgorithm,
EncryptionSettings,
+ HistoryVisibility as RustHistoryVisibility,
OlmMachine,
RoomId,
- UserId,
- HistoryVisibility as RustHistoryVisibility,
ToDeviceRequest,
+ UserId,
} from "@matrix-org/matrix-sdk-crypto-wasm";
-import * as RustSdkCryptoJs from "@matrix-org/matrix-sdk-crypto-wasm";
-import { EventType } from "../@types/event";
-import { IContent, MatrixEvent } from "../models/event";
-import { Room } from "../models/room";
-import { Logger, logger, LogSpan } from "../logger";
-import { KeyClaimManager } from "./KeyClaimManager";
-import { RoomMember } from "../models/room-member";
-import { HistoryVisibility } from "../@types/partials";
-import { OutgoingRequestsManager } from "./OutgoingRequestsManager";
-import { logDuration } from "../utils";
-import { KnownMembership } from "../@types/membership";
+import { EventType } from "../@types/event.ts";
+import { IContent, MatrixEvent } from "../models/event.ts";
+import { Room } from "../models/room.ts";
+import { Logger, logger, LogSpan } from "../logger.ts";
+import { KeyClaimManager } from "./KeyClaimManager.ts";
+import { RoomMember } from "../models/room-member.ts";
+import { HistoryVisibility } from "../@types/partials.ts";
+import { OutgoingRequestsManager } from "./OutgoingRequestsManager.ts";
+import { logDuration } from "../utils.ts";
+import { KnownMembership } from "../@types/membership.ts";
/**
* RoomEncryptor: responsible for encrypting messages to a given room
@@ -105,10 +106,8 @@ export class RoomEncryptor {
(member.membership == KnownMembership.Invite && this.room.shouldEncryptForInvitedMembers())
) {
// make sure we are tracking the deviceList for this user
- logDuration(this.prefixedLogger, "updateTrackedUsers", async () => {
- this.olmMachine.updateTrackedUsers([new UserId(member.userId)]).catch((e) => {
- this.prefixedLogger.error("Unable to update tracked users", e);
- });
+ this.olmMachine.updateTrackedUsers([new UserId(member.userId)]).catch((e) => {
+ this.prefixedLogger.error("Unable to update tracked users", e);
});
}
@@ -144,7 +143,7 @@ export class RoomEncryptor {
* @param globalBlacklistUnverifiedDevices - When `true`, it will not send encrypted messages to unverified devices
*/
public encryptEvent(event: MatrixEvent | null, globalBlacklistUnverifiedDevices: boolean): Promise {
- const logger = new LogSpan(this.prefixedLogger, event ? event.getTxnId() ?? "" : "prepareForEncryption");
+ const logger = new LogSpan(this.prefixedLogger, event ? (event.getTxnId() ?? "") : "prepareForEncryption");
// Ensure order of encryption to avoid message ordering issues, as the scheduler only ensures
// events order after they have been encrypted.
const prom = this.currentEncryptionPromise
@@ -254,8 +253,11 @@ export class RoomEncryptor {
// When this.room.getBlacklistUnverifiedDevices() === null, the global settings should be used
// See Room#getBlacklistUnverifiedDevices
- rustEncryptionSettings.onlyAllowTrustedDevices =
- this.room.getBlacklistUnverifiedDevices() ?? globalBlacklistUnverifiedDevices;
+ if (this.room.getBlacklistUnverifiedDevices() ?? globalBlacklistUnverifiedDevices) {
+ rustEncryptionSettings.sharingStrategy = CollectStrategy.DeviceBasedStrategyOnlyTrustedDevices;
+ } else {
+ rustEncryptionSettings.sharingStrategy = CollectStrategy.DeviceBasedStrategyAllDevices;
+ }
await logDuration(this.prefixedLogger, "shareRoomKey", async () => {
const shareMessages: ToDeviceRequest[] = await this.olmMachine.shareRoomKey(
diff --git a/src/rust-crypto/backup.ts b/src/rust-crypto/backup.ts
index 8eb84887448..c4407da21f8 100644
--- a/src/rust-crypto/backup.ts
+++ b/src/rust-crypto/backup.ts
@@ -24,19 +24,19 @@ import {
KeyBackupInfo,
KeyBackupSession,
Curve25519SessionData,
-} from "../crypto-api/keybackup";
-import { logger } from "../logger";
-import { ClientPrefix, IHttpOpts, MatrixError, MatrixHttpApi, Method } from "../http-api";
-import { CryptoEvent, IMegolmSessionData } from "../crypto";
-import { TypedEventEmitter } from "../models/typed-event-emitter";
-import { encodeUri, logDuration } from "../utils";
-import { OutgoingRequestProcessor } from "./OutgoingRequestProcessor";
-import { sleep } from "../utils";
-import { BackupDecryptor } from "../common-crypto/CryptoBackend";
-import { IEncryptedPayload } from "../crypto/aes";
-import { ImportRoomKeyProgressData, ImportRoomKeysOpts } from "../crypto-api";
-import { IKeyBackupInfo } from "../crypto/keybackup";
-import { IKeyBackup } from "../crypto/backup";
+} from "../crypto-api/keybackup.ts";
+import { logger } from "../logger.ts";
+import { ClientPrefix, IHttpOpts, MatrixError, MatrixHttpApi, Method } from "../http-api/index.ts";
+import { CryptoEvent, IMegolmSessionData } from "../crypto/index.ts";
+import { TypedEventEmitter } from "../models/typed-event-emitter.ts";
+import { encodeUri, logDuration } from "../utils.ts";
+import { OutgoingRequestProcessor } from "./OutgoingRequestProcessor.ts";
+import { sleep } from "../utils.ts";
+import { BackupDecryptor } from "../common-crypto/CryptoBackend.ts";
+import { IEncryptedPayload } from "../crypto/aes.ts";
+import { ImportRoomKeyProgressData, ImportRoomKeysOpts } from "../crypto-api/index.ts";
+import { IKeyBackupInfo } from "../crypto/keybackup.ts";
+import { IKeyBackup } from "../crypto/backup.ts";
/** Authentification of the backup info, depends on algorithm */
type AuthData = KeyBackupInfo["auth_data"];
diff --git a/src/rust-crypto/device-converter.ts b/src/rust-crypto/device-converter.ts
index 587640cb0e9..80e8bd373c1 100644
--- a/src/rust-crypto/device-converter.ts
+++ b/src/rust-crypto/device-converter.ts
@@ -16,8 +16,8 @@ limitations under the License.
import * as RustSdkCryptoJs from "@matrix-org/matrix-sdk-crypto-wasm";
-import { Device, DeviceVerification } from "../models/device";
-import { DeviceKeys } from "../client";
+import { Device, DeviceVerification } from "../models/device.ts";
+import { DeviceKeys } from "../client.ts";
/**
* Convert a {@link RustSdkCryptoJs.Device} to a {@link Device}
diff --git a/src/rust-crypto/index.ts b/src/rust-crypto/index.ts
index dc9a42af743..61f15a192a1 100644
--- a/src/rust-crypto/index.ts
+++ b/src/rust-crypto/index.ts
@@ -17,17 +17,17 @@ 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";
-import { IHttpOpts, MatrixHttpApi } from "../http-api";
-import { ServerSideSecretStorage } from "../secret-storage";
-import { ICryptoCallbacks } from "../crypto";
-import { Logger } from "../logger";
-import { CryptoStore, MigrationState } from "../crypto/store/base";
+import { RustCrypto } from "./rust-crypto.ts";
+import { IHttpOpts, MatrixHttpApi } from "../http-api/index.ts";
+import { ServerSideSecretStorage } from "../secret-storage.ts";
+import { ICryptoCallbacks } from "../crypto/index.ts";
+import { Logger } from "../logger.ts";
+import { CryptoStore, MigrationState } from "../crypto/store/base.ts";
import {
migrateFromLegacyCrypto,
migrateLegacyLocalTrustIfNeeded,
migrateRoomSettingsFromLegacyCrypto,
-} from "./libolm_migration";
+} from "./libolm_migration.ts";
/**
* Create a new `RustCrypto` implementation
@@ -174,6 +174,9 @@ async function initOlmMachine(
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),
);
diff --git a/src/rust-crypto/libolm_migration.ts b/src/rust-crypto/libolm_migration.ts
index ec01847262c..50d92a626e1 100644
--- a/src/rust-crypto/libolm_migration.ts
+++ b/src/rust-crypto/libolm_migration.ts
@@ -16,18 +16,18 @@ limitations under the License.
import * as RustSdkCryptoJs from "@matrix-org/matrix-sdk-crypto-wasm";
-import { Logger } from "../logger";
-import { CryptoStore, MigrationState, SecretStorePrivateKeys } from "../crypto/store/base";
-import { IndexedDBCryptoStore } from "../crypto/store/indexeddb-crypto-store";
-import { decryptAES, IEncryptedPayload } from "../crypto/aes";
-import { IHttpOpts, MatrixHttpApi } from "../http-api";
-import { requestKeyBackupVersion } from "./backup";
-import { IRoomEncryption } from "../crypto/RoomList";
-import { CrossSigningKeyInfo, Curve25519AuthData } from "../crypto-api";
-import { RustCrypto } from "./rust-crypto";
-import { KeyBackupInfo } from "../crypto-api/keybackup";
-import { sleep } from "../utils";
-import { encodeBase64 } from "../base64";
+import { Logger } from "../logger.ts";
+import { CryptoStore, MigrationState, SecretStorePrivateKeys } from "../crypto/store/base.ts";
+import { IndexedDBCryptoStore } from "../crypto/store/indexeddb-crypto-store.ts";
+import { decryptAES, IEncryptedPayload } from "../crypto/aes.ts";
+import { IHttpOpts, MatrixHttpApi } from "../http-api/index.ts";
+import { requestKeyBackupVersion } from "./backup.ts";
+import { IRoomEncryption } from "../crypto/RoomList.ts";
+import { CrossSigningKeyInfo, Curve25519AuthData } from "../crypto-api/index.ts";
+import { RustCrypto } from "./rust-crypto.ts";
+import { KeyBackupInfo } from "../crypto-api/keybackup.ts";
+import { sleep } from "../utils.ts";
+import { encodeBase64 } from "../base64.ts";
/**
* Determine if any data needs migrating from the legacy store, and do so.
diff --git a/src/rust-crypto/rust-crypto.ts b/src/rust-crypto/rust-crypto.ts
index 8cbfba4b0c5..2a4ba09c5eb 100644
--- a/src/rust-crypto/rust-crypto.ts
+++ b/src/rust-crypto/rust-crypto.ts
@@ -17,20 +17,25 @@ limitations under the License.
import anotherjson from "another-json";
import * as RustSdkCryptoJs from "@matrix-org/matrix-sdk-crypto-wasm";
-import type { IEventDecryptionResult, IMegolmSessionData } from "../@types/crypto";
-import { KnownMembership } from "../@types/membership";
-import type { IDeviceLists, IToDeviceEvent } from "../sync-accumulator";
-import type { IEncryptedEventInfo } from "../crypto/api";
-import { IContent, MatrixEvent, MatrixEventEvent } from "../models/event";
-import { Room } from "../models/room";
-import { RoomMember } from "../models/room-member";
-import { BackupDecryptor, CryptoBackend, DecryptionError, OnSyncCompletedData } from "../common-crypto/CryptoBackend";
-import { logger, Logger } from "../logger";
-import { IHttpOpts, MatrixHttpApi, Method } from "../http-api";
-import { RoomEncryptor } from "./RoomEncryptor";
-import { OutgoingRequestProcessor } from "./OutgoingRequestProcessor";
-import { KeyClaimManager } from "./KeyClaimManager";
-import { logDuration, MapWithDefault } from "../utils";
+import type { IEventDecryptionResult, IMegolmSessionData } from "../@types/crypto.ts";
+import { KnownMembership } from "../@types/membership.ts";
+import type { IDeviceLists, IToDeviceEvent } from "../sync-accumulator.ts";
+import type { IEncryptedEventInfo } from "../crypto/api.ts";
+import { MatrixEvent, MatrixEventEvent } from "../models/event.ts";
+import { Room } from "../models/room.ts";
+import { RoomMember } from "../models/room-member.ts";
+import {
+ BackupDecryptor,
+ CryptoBackend,
+ DecryptionError,
+ OnSyncCompletedData,
+} from "../common-crypto/CryptoBackend.ts";
+import { logger, Logger } from "../logger.ts";
+import { IHttpOpts, MatrixHttpApi, Method } from "../http-api/index.ts";
+import { RoomEncryptor } from "./RoomEncryptor.ts";
+import { OutgoingRequestProcessor } from "./OutgoingRequestProcessor.ts";
+import { KeyClaimManager } from "./KeyClaimManager.ts";
+import { logDuration, MapWithDefault } from "../utils.ts";
import {
BackupTrustInfo,
BootstrapCrossSigningOpts,
@@ -38,6 +43,7 @@ import {
CrossSigningKey,
CrossSigningKeyInfo,
CrossSigningStatus,
+ CryptoApi,
CryptoCallbacks,
Curve25519AuthData,
DecryptionFailureCode,
@@ -52,30 +58,29 @@ import {
OwnDeviceKeys,
UserVerificationStatus,
VerificationRequest,
-} from "../crypto-api";
-import { deviceKeysToDeviceMap, rustDeviceToJsDevice } from "./device-converter";
-import { IDownloadKeyResult, IQueryKeysRequest } from "../client";
-import { Device, DeviceMap } from "../models/device";
-import { SECRET_STORAGE_ALGORITHM_V1_AES, ServerSideSecretStorage } from "../secret-storage";
-import { CrossSigningIdentity } from "./CrossSigningIdentity";
-import { secretStorageCanAccessSecrets, secretStorageContainsCrossSigningKeys } from "./secret-storage";
-import { keyFromPassphrase } from "../crypto/key_passphrase";
-import { encodeRecoveryKey } from "../crypto/recoverykey";
-import { crypto } from "../crypto/crypto";
-import { isVerificationEvent, RustVerificationRequest, verificationMethodIdentifierToMethod } from "./verification";
-import { EventType, MsgType } from "../@types/event";
-import { CryptoEvent } from "../crypto";
-import { TypedEventEmitter } from "../models/typed-event-emitter";
-import { RustBackupCryptoEventMap, RustBackupCryptoEvents, RustBackupManager } from "./backup";
-import { TypedReEmitter } from "../ReEmitter";
-import { randomString } from "../randomstring";
-import { ClientStoppedError } from "../errors";
-import { ISignatures } from "../@types/signed";
-import { encodeBase64 } from "../base64";
-import { OutgoingRequestsManager } from "./OutgoingRequestsManager";
-import { PerSessionKeyBackupDownloader } from "./PerSessionKeyBackupDownloader";
-import { DehydratedDeviceManager } from "./DehydratedDeviceManager";
-import { VerificationMethod } from "../types";
+} from "../crypto-api/index.ts";
+import { deviceKeysToDeviceMap, rustDeviceToJsDevice } from "./device-converter.ts";
+import { IDownloadKeyResult, IQueryKeysRequest } from "../client.ts";
+import { Device, DeviceMap } from "../models/device.ts";
+import { SECRET_STORAGE_ALGORITHM_V1_AES, ServerSideSecretStorage } from "../secret-storage.ts";
+import { CrossSigningIdentity } from "./CrossSigningIdentity.ts";
+import { secretStorageCanAccessSecrets, secretStorageContainsCrossSigningKeys } from "./secret-storage.ts";
+import { keyFromPassphrase } from "../crypto/key_passphrase.ts";
+import { encodeRecoveryKey } from "../crypto/recoverykey.ts";
+import { isVerificationEvent, RustVerificationRequest, verificationMethodIdentifierToMethod } from "./verification.ts";
+import { EventType, MsgType } from "../@types/event.ts";
+import { CryptoEvent } from "../crypto/index.ts";
+import { TypedEventEmitter } from "../models/typed-event-emitter.ts";
+import { RustBackupCryptoEventMap, RustBackupCryptoEvents, RustBackupManager } from "./backup.ts";
+import { TypedReEmitter } from "../ReEmitter.ts";
+import { randomString } from "../randomstring.ts";
+import { ClientStoppedError } from "../errors.ts";
+import { ISignatures } from "../@types/signed.ts";
+import { encodeBase64 } from "../base64.ts";
+import { OutgoingRequestsManager } from "./OutgoingRequestsManager.ts";
+import { PerSessionKeyBackupDownloader } from "./PerSessionKeyBackupDownloader.ts";
+import { DehydratedDeviceManager } from "./DehydratedDeviceManager.ts";
+import { VerificationMethod } from "../types.ts";
const ALL_VERIFICATION_METHODS = [
VerificationMethod.Sas,
@@ -308,6 +313,40 @@ export class RustCrypto extends TypedEventEmitter): Promise {
+ if (backupInfo.algorithm != "m.megolm_backup.v1.curve25519-aes-sha2") {
+ throw new Error(`getBackupDecryptor Unsupported algorithm ${backupInfo.algorithm}`);
+ }
+
+ const authData = backupInfo.auth_data;
+
+ if (!(privKey instanceof Uint8Array)) {
+ throw new Error(`getBackupDecryptor expects Uint8Array`);
+ }
+
+ const backupDecryptionKey = RustSdkCryptoJs.BackupDecryptionKey.fromBase64(encodeBase64(privKey));
+
+ if (authData.public_key != backupDecryptionKey.megolmV1PublicKey.publicKeyBase64) {
+ throw new Error(`getBackupDecryptor key mismatch error`);
+ }
+
+ return this.backupManager.createBackupDecryptor(backupDecryptionKey);
+ }
+
+ /**
+ * Implementation of {@link CryptoBackend#importBackedUpRoomKeys}.
+ */
+ public async importBackedUpRoomKeys(
+ keys: IMegolmSessionData[],
+ backupVersion: string,
+ opts?: ImportRoomKeysOpts,
+ ): Promise {
+ return await this.backupManager.importBackedUpRoomKeys(keys, backupVersion, opts);
+ }
+
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
//
// CryptoApi implementation
@@ -856,7 +895,7 @@ export class RustCrypto extends TypedEventEmitter(obj: T): Promise {
@@ -1192,54 +1232,40 @@ export class RustCrypto extends TypedEventEmitter): Promise {
- if (backupInfo.algorithm != "m.megolm_backup.v1.curve25519-aes-sha2") {
- throw new Error(`getBackupDecryptor Unsupported algorithm ${backupInfo.algorithm}`);
- }
-
- const authData = backupInfo.auth_data;
-
- if (!(privKey instanceof Uint8Array)) {
- throw new Error(`getBackupDecryptor expects Uint8Array`);
- }
-
- const backupDecryptionKey = RustSdkCryptoJs.BackupDecryptionKey.fromBase64(encodeBase64(privKey));
-
- if (authData.public_key != backupDecryptionKey.megolmV1PublicKey.publicKeyBase64) {
- throw new Error(`getBackupDecryptor key mismatch error`);
- }
-
- return this.backupManager.createBackupDecryptor(backupDecryptionKey);
+ public async isDehydrationSupported(): Promise {
+ return await this.dehydratedDeviceManager.isSupported();
}
/**
- * Implementation of {@link CryptoBackend#importBackedUpRoomKeys}.
+ * Implementation of {@link CryptoApi#startDehydration}.
*/
- public async importBackedUpRoomKeys(
- keys: IMegolmSessionData[],
- backupVersion: string,
- opts?: ImportRoomKeysOpts,
- ): Promise {
- return await this.backupManager.importBackedUpRoomKeys(keys, backupVersion, opts);
+ public async startDehydration(createNewKey?: boolean): Promise {
+ if (!(await this.isCrossSigningReady()) || !(await this.isSecretStorageReady())) {
+ throw new Error("Device dehydration requires cross-signing and secret storage to be set up");
+ }
+ return await this.dehydratedDeviceManager.start(createNewKey);
}
/**
- * Implementation of {@link CryptoBackend#isDehydrationSupported}.
+ * Implementation of {@link CryptoApi#importSecretsBundle}.
*/
- public async isDehydrationSupported(): Promise {
- return await this.dehydratedDeviceManager.isSupported();
+ public async importSecretsBundle(
+ secrets: Parameters>[0],
+ ): Promise {
+ const secretsBundle = RustSdkCryptoJs.SecretsBundle.from_json(secrets);
+ await this.getOlmMachineOrThrow().importSecretsBundle(secretsBundle); // this method frees the SecretsBundle
}
/**
- * Implementation of {@link CryptoBackend#startDehydration}.
+ * Implementation of {@link CryptoApi#exportSecretsBundle}.
*/
- public async startDehydration(createNewKey?: boolean): Promise {
- if (!(await this.isCrossSigningReady()) || !(await this.isSecretStorageReady())) {
- throw new Error("Device dehydration requires cross-signing and secret storage to be set up");
- }
- return await this.dehydratedDeviceManager.start(createNewKey);
+ public async exportSecretsBundle(): ReturnType> {
+ const secretsBundle = await this.getOlmMachineOrThrow().exportSecretsBundle();
+ const secrets = secretsBundle.to_json();
+ secretsBundle.free();
+ return secrets;
}
///////////////////////////////////////////////////////////////////////////////////////////////////////////////////
@@ -1293,7 +1319,11 @@ export class RustCrypto extends TypedEventEmitter {
+ for (const session of withheld) {
+ this.logger.debug(`Got withheld message for session ${session.sessionId} in ${session.roomId.toString()}`);
+ const pendingList = this.eventDecryptor.getEventsPendingRoomKey(
+ session.roomId.toString(),
+ session.sessionId,
+ );
+ if (pendingList.length === 0) return;
+
+ // The easiest way to update the status of the event is to have another go at decrypting it.
+ this.logger.debug(
+ "Retrying decryption on events:",
+ pendingList.map((e) => `${e.getId()}`),
+ );
+
+ for (const ev of pendingList) {
+ ev.attemptDecryption(this, { isRetry: true }).catch((_e) => {
+ // It's somewhat expected that we still can't decrypt here.
+ });
+ }
+ }
+ }
+
/**
* Callback for `OlmMachine.registerUserIdentityUpdatedCallback`
*
@@ -1575,7 +1637,7 @@ export class RustCrypto extends TypedEventEmitter => {
// Process only verification event
if (isVerificationEvent(event)) {
- await this.onKeyVerificationRequest(evt);
+ await this.onKeyVerificationEvent(evt);
}
};
@@ -1602,11 +1664,11 @@ export class RustCrypto extends TypedEventEmitter {
+ private async onKeyVerificationEvent(event: MatrixEvent): Promise {
const roomId = event.getRoomId();
if (!roomId) {
@@ -1633,27 +1695,7 @@ export class RustCrypto extends TypedEventEmitter>>(
() => new MapWithDefault