@unwanted/matrix-sdk-mini 34.12.0-1

package/lib/crypto/verification/request/Channel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Channel.js","names":[],"sources":["../../../../src/crypto/verification/request/Channel.ts"],"sourcesContent":["/*\nCopyright 2021 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport { MatrixEvent } from \"../../../models/event.ts\";\nimport { VerificationRequest } from \"./VerificationRequest.ts\";\n\nexport interface IVerificationChannel {\n    request?: VerificationRequest;\n    readonly userId?: string;\n    readonly roomId?: string;\n    readonly deviceId?: string;\n    readonly transactionId?: string;\n    readonly receiveStartFromOtherDevices?: boolean;\n    getTimestamp(event: MatrixEvent): number;\n    send(type: string, uncompletedContent: Record<string, any>): Promise<void>;\n    completeContent(type: string, content: Record<string, any>): Record<string, any>;\n    sendCompleted(type: string, content: Record<string, any>): Promise<void>;\n    completedContentFromEvent(event: MatrixEvent): Record<string, any>;\n    canCreateRequest(type: string): boolean;\n    handleEvent(event: MatrixEvent, request: VerificationRequest, isLiveEvent: boolean): Promise<void>;\n}\n"],"mappings":"","ignoreList":[]}

package/lib/crypto/verification/request/InRoomChannel.d.ts

@@ -0,0 +1,113 @@
+import { VerificationRequest } from "./VerificationRequest.ts";
+import { IVerificationChannel } from "./Channel.ts";
+import { MatrixClient } from "../../../client.ts";
+import { MatrixEvent } from "../../../models/event.ts";
+import { IRequestsMap } from "../../index.ts";
+/**
+ * A key verification channel that sends verification events in the timeline of a room.
+ * Uses the event id of the initial m.key.verification.request event as a transaction id.
+ */
+export declare class InRoomChannel implements IVerificationChannel {
+    private readonly client;
+    readonly roomId: string;
+    userId?: string | undefined;
+    private requestEventId?;
+    /**
+     * @param client - the matrix client, to send messages with and get current user & device from.
+     * @param roomId - id of the room where verification events should be posted in, should be a DM with the given user.
+     * @param userId - id of user that the verification request is directed at, should be present in the room.
+     */
+    constructor(client: MatrixClient, roomId: string, userId?: string | undefined);
+    get receiveStartFromOtherDevices(): boolean;
+    /** The transaction id generated/used by this verification channel */
+    get transactionId(): string | undefined;
+    static getOtherPartyUserId(event: MatrixEvent, client: MatrixClient): string | undefined;
+    /**
+     * @param event - the event to get the timestamp of
+     * @returns the timestamp when the event was sent
+     */
+    getTimestamp(event: MatrixEvent): number;
+    /**
+     * Checks whether the given event type should be allowed to initiate a new VerificationRequest over this channel
+     * @param type - the event type to check
+     * @returns boolean flag
+     */
+    static canCreateRequest(type: string): boolean;
+    canCreateRequest(type: string): boolean;
+    /**
+     * Extract the transaction id used by a given key verification event, if any
+     * @param event - the event
+     * @returns the transaction id
+     */
+    static getTransactionId(event: MatrixEvent): string | undefined;
+    /**
+     * Checks whether this event is a well-formed key verification event.
+     * This only does checks that don't rely on the current state of a potentially already channel
+     * so we can prevent channels being created by invalid events.
+     * `handleEvent` can do more checks and choose to ignore invalid events.
+     * @param event - the event to validate
+     * @param client - the client to get the current user and device id from
+     * @returns whether the event is valid and should be passed to handleEvent
+     */
+    static validateEvent(event: MatrixEvent, client: MatrixClient): boolean;
+    /**
+     * As m.key.verification.request events are as m.room.message events with the InRoomChannel
+     * to have a fallback message in non-supporting clients, we map the real event type
+     * to the symbolic one to keep things in unison with ToDeviceChannel
+     * @param event - the event to get the type of
+     * @returns the "symbolic" event type
+     */
+    static getEventType(event: MatrixEvent): string;
+    /**
+     * Changes the state of the channel, request, and verifier in response to a key verification event.
+     * @param event - to handle
+     * @param request - the request to forward handling to
+     * @param isLiveEvent - whether this is an even received through sync or not
+     * @returns a promise that resolves when any requests as an answer to the passed-in event are sent.
+     */
+    handleEvent(event: MatrixEvent, request: VerificationRequest, isLiveEvent?: boolean): Promise<void>;
+    /**
+     * Adds the transaction id (relation) back to a received event
+     * so it has the same format as returned by `completeContent` before sending.
+     * The relation can not appear on the event content because of encryption,
+     * relations are excluded from encryption.
+     * @param event - the received event
+     * @returns the content object with the relation added again
+     */
+    completedContentFromEvent(event: MatrixEvent): Record<string, any>;
+    /**
+     * Add all the fields to content needed for sending it over this channel.
+     * This is public so verification methods (SAS uses this) can get the exact
+     * content that will be sent independent of the used channel,
+     * as they need to calculate the hash of it.
+     * @param type - the event type
+     * @param content - the (incomplete) content
+     * @returns the complete content, as it will be sent.
+     */
+    completeContent(type: string, content: Record<string, any>): Record<string, any>;
+    /**
+     * Send an event over the channel with the content not having gone through `completeContent`.
+     * @param type - the event type
+     * @param uncompletedContent - the (incomplete) content
+     * @returns the promise of the request
+     */
+    send(type: string, uncompletedContent: Record<string, any>): Promise<void>;
+    /**
+     * Send an event over the channel with the content having gone through `completeContent` already.
+     * @param type - the event type
+     * @returns the promise of the request
+     */
+    sendCompleted(type: string, content: Record<string, any>): Promise<void>;
+}
+export declare class InRoomRequests implements IRequestsMap {
+    private requestsByRoomId;
+    getRequest(event: MatrixEvent): VerificationRequest | undefined;
+    getRequestByChannel(channel: InRoomChannel): VerificationRequest | undefined;
+    private getRequestByTxnId;
+    setRequest(event: MatrixEvent, request: VerificationRequest): void;
+    setRequestByChannel(channel: IVerificationChannel, request: VerificationRequest): void;
+    private doSetRequest;
+    removeRequest(event: MatrixEvent): void;
+    findRequestInProgress(roomId: string, userId?: string): VerificationRequest | undefined;
+}
+//# sourceMappingURL=InRoomChannel.d.ts.map

package/lib/crypto/verification/request/InRoomChannel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"InRoomChannel.d.ts","sourceRoot":"","sources":["../../../../src/crypto/verification/request/InRoomChannel.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,mBAAmB,EAAwC,MAAM,0BAA0B,CAAC;AAErG,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAEpD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAM9C;;;GAGG;AACH,qBAAa,aAAc,YAAW,oBAAoB;IASlD,OAAO,CAAC,QAAQ,CAAC,MAAM;aACP,MAAM,EAAE,MAAM;IACvB,MAAM,CAAC,EAAE,MAAM;IAV1B,OAAO,CAAC,cAAc,CAAC,CAAS;IAEhC;;;;OAIG;gBAEkB,MAAM,EAAE,YAAY,EACrB,MAAM,EAAE,MAAM,EACvB,MAAM,CAAC,EAAE,MAAM,YAAA;IAG1B,IAAW,4BAA4B,IAAI,OAAO,CAEjD;IAED,qEAAqE;IACrE,IAAW,aAAa,IAAI,MAAM,GAAG,SAAS,CAE7C;WAEa,mBAAmB,CAAC,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,GAAG,MAAM,GAAG,SAAS;IAiB/F;;;OAGG;IACI,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM;IAI/C;;;;OAIG;WACW,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI9C,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI9C;;;;OAIG;WACW,gBAAgB,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,GAAG,SAAS;IAWtE;;;;;;;;OAQG;WACW,aAAa,CAAC,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO;IA8B9E;;;;;;OAMG;WACW,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM;IAkBtD;;;;;;OAMG;IACU,WAAW,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,mBAAmB,EAAE,WAAW,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IA8C9G;;;;;;;OAOG;IACI,yBAAyB,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAQzE;;;;;;;;OAQG;IACI,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IA4BvF;;;;;OAKG;IACI,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAKjF;;;;OAIG;IACU,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAcxF;AAED,qBAAa,cAAe,YAAW,YAAY;IAC/C,OAAO,CAAC,gBAAgB,CAAuD;IAExE,UAAU,CAAC,KAAK,EAAE,WAAW,GAAG,mBAAmB,GAAG,SAAS;IAM/D,mBAAmB,CAAC,OAAO,EAAE,aAAa,GAAG,mBAAmB,GAAG,SAAS;IAInF,OAAO,CAAC,iBAAiB;IAOlB,UAAU,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,mBAAmB,GAAG,IAAI;IAIlE,mBAAmB,CAAC,OAAO,EAAE,oBAAoB,EAAE,OAAO,EAAE,mBAAmB,GAAG,IAAI;IAI7F,OAAO,CAAC,YAAY;IASb,aAAa,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IAWvC,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,mBAAmB,GAAG,SAAS;CAUjG"}

package/lib/crypto/verification/request/InRoomChannel.js

@@ -0,0 +1,351 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+import _defineProperty from "@babel/runtime/helpers/defineProperty";
+/*
+Copyright 2018 New Vector Ltd
+Copyright 2019 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 { VerificationRequest, REQUEST_TYPE, READY_TYPE, START_TYPE } from "./VerificationRequest.js";
+import { logger } from "../../../logger.js";
+import { EventType } from "../../../@types/event.js";
+var MESSAGE_TYPE = EventType.RoomMessage;
+var M_REFERENCE = "m.reference";
+var M_RELATES_TO = "m.relates_to";
+
+/**
+ * A key verification channel that sends verification events in the timeline of a room.
+ * Uses the event id of the initial m.key.verification.request event as a transaction id.
+ */
+export class InRoomChannel {
+  /**
+   * @param client - the matrix client, to send messages with and get current user & device from.
+   * @param roomId - id of the room where verification events should be posted in, should be a DM with the given user.
+   * @param userId - id of user that the verification request is directed at, should be present in the room.
+   */
+  constructor(client, roomId, userId) {
+    this.client = client;
+    this.roomId = roomId;
+    this.userId = userId;
+    _defineProperty(this, "requestEventId", void 0);
+  }
+  get receiveStartFromOtherDevices() {
+    return true;
+  }
+
+  /** The transaction id generated/used by this verification channel */
+  get transactionId() {
+    return this.requestEventId;
+  }
+  static getOtherPartyUserId(event, client) {
+    var type = InRoomChannel.getEventType(event);
+    if (type !== REQUEST_TYPE) {
+      return;
+    }
+    var ownUserId = client.getUserId();
+    var sender = event.getSender();
+    var content = event.getContent();
+    var receiver = content.to;
+    if (sender === ownUserId) {
+      return receiver;
+    } else if (receiver === ownUserId) {
+      return sender;
+    }
+  }
+
+  /**
+   * @param event - the event to get the timestamp of
+   * @returns the timestamp when the event was sent
+   */
+  getTimestamp(event) {
+    return event.getTs();
+  }
+
+  /**
+   * Checks whether the given event type should be allowed to initiate a new VerificationRequest over this channel
+   * @param type - the event type to check
+   * @returns boolean flag
+   */
+  static canCreateRequest(type) {
+    return type === REQUEST_TYPE;
+  }
+  canCreateRequest(type) {
+    return InRoomChannel.canCreateRequest(type);
+  }
+
+  /**
+   * Extract the transaction id used by a given key verification event, if any
+   * @param event - the event
+   * @returns the transaction id
+   */
+  static getTransactionId(event) {
+    if (InRoomChannel.getEventType(event) === REQUEST_TYPE) {
+      return event.getId();
+    } else {
+      var relation = event.getRelation();
+      if ((relation === null || relation === void 0 ? void 0 : relation.rel_type) === M_REFERENCE) {
+        return relation.event_id;
+      }
+    }
+  }
+
+  /**
+   * Checks whether this event is a well-formed key verification event.
+   * This only does checks that don't rely on the current state of a potentially already channel
+   * so we can prevent channels being created by invalid events.
+   * `handleEvent` can do more checks and choose to ignore invalid events.
+   * @param event - the event to validate
+   * @param client - the client to get the current user and device id from
+   * @returns whether the event is valid and should be passed to handleEvent
+   */
+  static validateEvent(event, client) {
+    var txnId = InRoomChannel.getTransactionId(event);
+    if (typeof txnId !== "string" || txnId.length === 0) {
+      return false;
+    }
+    var type = InRoomChannel.getEventType(event);
+    var content = event.getContent();
+
+    // from here on we're fairly sure that this is supposed to be
+    // part of a verification request, so be noisy when rejecting something
+    if (type === REQUEST_TYPE) {
+      if (!content || typeof content.to !== "string" || !content.to.length) {
+        logger.log("InRoomChannel: validateEvent: " + "no valid to " + content.to);
+        return false;
+      }
+
+      // ignore requests that are not direct to or sent by the syncing user
+      if (!InRoomChannel.getOtherPartyUserId(event, client)) {
+        logger.log("InRoomChannel: validateEvent: " + "not directed to or sent by me: ".concat(event.getSender()) + ", ".concat(content.to));
+        return false;
+      }
+    }
+    return VerificationRequest.validateEvent(type, event, client);
+  }
+
+  /**
+   * As m.key.verification.request events are as m.room.message events with the InRoomChannel
+   * to have a fallback message in non-supporting clients, we map the real event type
+   * to the symbolic one to keep things in unison with ToDeviceChannel
+   * @param event - the event to get the type of
+   * @returns the "symbolic" event type
+   */
+  static getEventType(event) {
+    var type = event.getType();
+    if (type === MESSAGE_TYPE) {
+      var content = event.getContent();
+      if (content) {
+        var {
+          msgtype
+        } = content;
+        if (msgtype === REQUEST_TYPE) {
+          return REQUEST_TYPE;
+        }
+      }
+    }
+    if (type && type !== REQUEST_TYPE) {
+      return type;
+    } else {
+      return "";
+    }
+  }
+
+  /**
+   * Changes the state of the channel, request, and verifier in response to a key verification event.
+   * @param event - to handle
+   * @param request - the request to forward handling to
+   * @param isLiveEvent - whether this is an even received through sync or not
+   * @returns a promise that resolves when any requests as an answer to the passed-in event are sent.
+   */
+  handleEvent(event, request) {
+    var _arguments = arguments,
+      _this = this;
+    return _asyncToGenerator(function* () {
+      var isLiveEvent = _arguments.length > 2 && _arguments[2] !== undefined ? _arguments[2] : false;
+      // prevent processing the same event multiple times, as under
+      // some circumstances Room.timeline can get emitted twice for the same event
+      if (request.hasEventId(event.getId())) {
+        return;
+      }
+      var type = InRoomChannel.getEventType(event);
+      // do validations that need state (roomId, userId),
+      // ignore if invalid
+
+      if (event.getRoomId() !== _this.roomId) {
+        return;
+      }
+      // set userId if not set already
+      if (!_this.userId) {
+        var _userId = InRoomChannel.getOtherPartyUserId(event, _this.client);
+        if (_userId) {
+          _this.userId = _userId;
+        }
+      }
+      // ignore events not sent by us or the other party
+      var ownUserId = _this.client.getUserId();
+      var sender = event.getSender();
+      if (_this.userId) {
+        if (sender !== ownUserId && sender !== _this.userId) {
+          logger.log("InRoomChannel: ignoring verification event from non-participating sender ".concat(sender));
+          return;
+        }
+      }
+      if (!_this.requestEventId) {
+        _this.requestEventId = InRoomChannel.getTransactionId(event);
+      }
+
+      // With pendingEventOrdering: "chronological", we will see events that have been sent but not yet reflected
+      // back via /sync. These are "local echoes" and are identifiable by their txnId
+      var isLocalEcho = !!event.getTxnId();
+
+      // Alternatively, we may see an event that we sent that is reflected back via /sync. These are "remote echoes"
+      // and have a transaction ID in the "unsigned" data
+      var isRemoteEcho = !!event.getUnsigned().transaction_id;
+      var isSentByUs = event.getSender() === _this.client.getUserId();
+      return request.handleEvent(type, event, isLiveEvent, isLocalEcho || isRemoteEcho, isSentByUs);
+    })();
+  }
+
+  /**
+   * Adds the transaction id (relation) back to a received event
+   * so it has the same format as returned by `completeContent` before sending.
+   * The relation can not appear on the event content because of encryption,
+   * relations are excluded from encryption.
+   * @param event - the received event
+   * @returns the content object with the relation added again
+   */
+  completedContentFromEvent(event) {
+    // ensure m.related_to is included in e2ee rooms
+    // as the field is excluded from encryption
+    var content = Object.assign({}, event.getContent());
+    content[M_RELATES_TO] = event.getRelation();
+    return content;
+  }
+
+  /**
+   * Add all the fields to content needed for sending it over this channel.
+   * This is public so verification methods (SAS uses this) can get the exact
+   * content that will be sent independent of the used channel,
+   * as they need to calculate the hash of it.
+   * @param type - the event type
+   * @param content - the (incomplete) content
+   * @returns the complete content, as it will be sent.
+   */
+  completeContent(type, content) {
+    content = Object.assign({}, content);
+    if (type === REQUEST_TYPE || type === READY_TYPE || type === START_TYPE) {
+      content.from_device = this.client.getDeviceId();
+    }
+    if (type === REQUEST_TYPE) {
+      // type is mapped to m.room.message in the send method
+      content = {
+        body: this.client.getUserId() + " is requesting to verify " + "your key, but your client does not support in-chat key " + "verification.  You will need to use legacy key " + "verification to verify keys.",
+        msgtype: REQUEST_TYPE,
+        to: this.userId,
+        from_device: content.from_device,
+        methods: content.methods
+      };
+    } else {
+      content[M_RELATES_TO] = {
+        rel_type: M_REFERENCE,
+        event_id: this.transactionId
+      };
+    }
+    return content;
+  }
+
+  /**
+   * Send an event over the channel with the content not having gone through `completeContent`.
+   * @param type - the event type
+   * @param uncompletedContent - the (incomplete) content
+   * @returns the promise of the request
+   */
+  send(type, uncompletedContent) {
+    var content = this.completeContent(type, uncompletedContent);
+    return this.sendCompleted(type, content);
+  }
+
+  /**
+   * Send an event over the channel with the content having gone through `completeContent` already.
+   * @param type - the event type
+   * @returns the promise of the request
+   */
+  sendCompleted(type, content) {
+    var _this2 = this;
+    return _asyncToGenerator(function* () {
+      var sendType = type;
+      if (type === REQUEST_TYPE) {
+        sendType = MESSAGE_TYPE;
+      }
+      var response = yield _this2.client.sendEvent(_this2.roomId, sendType, content);
+      if (type === REQUEST_TYPE) {
+        _this2.requestEventId = response.event_id;
+      }
+    })();
+  }
+}
+export class InRoomRequests {
+  constructor() {
+    _defineProperty(this, "requestsByRoomId", new Map());
+  }
+  getRequest(event) {
+    var roomId = event.getRoomId();
+    var txnId = InRoomChannel.getTransactionId(event);
+    return this.getRequestByTxnId(roomId, txnId);
+  }
+  getRequestByChannel(channel) {
+    return this.getRequestByTxnId(channel.roomId, channel.transactionId);
+  }
+  getRequestByTxnId(roomId, txnId) {
+    var requestsByTxnId = this.requestsByRoomId.get(roomId);
+    if (requestsByTxnId) {
+      return requestsByTxnId.get(txnId);
+    }
+  }
+  setRequest(event, request) {
+    this.doSetRequest(event.getRoomId(), InRoomChannel.getTransactionId(event), request);
+  }
+  setRequestByChannel(channel, request) {
+    this.doSetRequest(channel.roomId, channel.transactionId, request);
+  }
+  doSetRequest(roomId, txnId, request) {
+    var requestsByTxnId = this.requestsByRoomId.get(roomId);
+    if (!requestsByTxnId) {
+      requestsByTxnId = new Map();
+      this.requestsByRoomId.set(roomId, requestsByTxnId);
+    }
+    requestsByTxnId.set(txnId, request);
+  }
+  removeRequest(event) {
+    var roomId = event.getRoomId();
+    var requestsByTxnId = this.requestsByRoomId.get(roomId);
+    if (requestsByTxnId) {
+      requestsByTxnId.delete(InRoomChannel.getTransactionId(event));
+      if (requestsByTxnId.size === 0) {
+        this.requestsByRoomId.delete(roomId);
+      }
+    }
+  }
+  findRequestInProgress(roomId, userId) {
+    var requestsByTxnId = this.requestsByRoomId.get(roomId);
+    if (requestsByTxnId) {
+      for (var request of requestsByTxnId.values()) {
+        if (request.pending && (userId === undefined || request.requestingUserId === userId)) {
+          return request;
+        }
+      }
+    }
+  }
+}
+//# sourceMappingURL=InRoomChannel.js.map

package/lib/crypto/verification/request/InRoomChannel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InRoomChannel.js","names":["VerificationRequest","REQUEST_TYPE","READY_TYPE","START_TYPE","logger","EventType","MESSAGE_TYPE","RoomMessage","M_REFERENCE","M_RELATES_TO","InRoomChannel","constructor","client","roomId","userId","_defineProperty","receiveStartFromOtherDevices","transactionId","requestEventId","getOtherPartyUserId","event","type","getEventType","ownUserId","getUserId","sender","getSender","content","getContent","receiver","to","getTimestamp","getTs","canCreateRequest","getTransactionId","getId","relation","getRelation","rel_type","event_id","validateEvent","txnId","length","log","concat","getType","msgtype","handleEvent","request","_arguments","arguments","_this","_asyncToGenerator","isLiveEvent","undefined","hasEventId","getRoomId","isLocalEcho","getTxnId","isRemoteEcho","getUnsigned","transaction_id","isSentByUs","completedContentFromEvent","Object","assign","completeContent","from_device","getDeviceId","body","methods","send","uncompletedContent","sendCompleted","_this2","sendType","response","sendEvent","InRoomRequests","Map","getRequest","getRequestByTxnId","getRequestByChannel","channel","requestsByTxnId","requestsByRoomId","get","setRequest","doSetRequest","setRequestByChannel","set","removeRequest","delete","size","findRequestInProgress","values","pending","requestingUserId"],"sources":["../../../../src/crypto/verification/request/InRoomChannel.ts"],"sourcesContent":["/*\nCopyright 2018 New Vector Ltd\nCopyright 2019 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\nimport { VerificationRequest, REQUEST_TYPE, READY_TYPE, START_TYPE } from \"./VerificationRequest.ts\";\nimport { logger } from \"../../../logger.ts\";\nimport { IVerificationChannel } from \"./Channel.ts\";\nimport { EventType, TimelineEvents } from \"../../../@types/event.ts\";\nimport { MatrixClient } from \"../../../client.ts\";\nimport { MatrixEvent } from \"../../../models/event.ts\";\nimport { IRequestsMap } from \"../../index.ts\";\n\nconst MESSAGE_TYPE = EventType.RoomMessage;\nconst M_REFERENCE = \"m.reference\";\nconst M_RELATES_TO = \"m.relates_to\";\n\n/**\n * A key verification channel that sends verification events in the timeline of a room.\n * Uses the event id of the initial m.key.verification.request event as a transaction id.\n */\nexport class InRoomChannel implements IVerificationChannel {\n    private requestEventId?: string;\n\n    /**\n     * @param client - the matrix client, to send messages with and get current user & device from.\n     * @param roomId - id of the room where verification events should be posted in, should be a DM with the given user.\n     * @param userId - id of user that the verification request is directed at, should be present in the room.\n     */\n    public constructor(\n        private readonly client: MatrixClient,\n        public readonly roomId: string,\n        public userId?: string,\n    ) {}\n\n    public get receiveStartFromOtherDevices(): boolean {\n        return true;\n    }\n\n    /** The transaction id generated/used by this verification channel */\n    public get transactionId(): string | undefined {\n        return this.requestEventId;\n    }\n\n    public static getOtherPartyUserId(event: MatrixEvent, client: MatrixClient): string | undefined {\n        const type = InRoomChannel.getEventType(event);\n        if (type !== REQUEST_TYPE) {\n            return;\n        }\n        const ownUserId = client.getUserId();\n        const sender = event.getSender();\n        const content = event.getContent();\n        const receiver = content.to;\n\n        if (sender === ownUserId) {\n            return receiver;\n        } else if (receiver === ownUserId) {\n            return sender;\n        }\n    }\n\n    /**\n     * @param event - the event to get the timestamp of\n     * @returns the timestamp when the event was sent\n     */\n    public getTimestamp(event: MatrixEvent): number {\n        return event.getTs();\n    }\n\n    /**\n     * Checks whether the given event type should be allowed to initiate a new VerificationRequest over this channel\n     * @param type - the event type to check\n     * @returns boolean flag\n     */\n    public static canCreateRequest(type: string): boolean {\n        return type === REQUEST_TYPE;\n    }\n\n    public canCreateRequest(type: string): boolean {\n        return InRoomChannel.canCreateRequest(type);\n    }\n\n    /**\n     * Extract the transaction id used by a given key verification event, if any\n     * @param event - the event\n     * @returns the transaction id\n     */\n    public static getTransactionId(event: MatrixEvent): string | undefined {\n        if (InRoomChannel.getEventType(event) === REQUEST_TYPE) {\n            return event.getId();\n        } else {\n            const relation = event.getRelation();\n            if (relation?.rel_type === M_REFERENCE) {\n                return relation.event_id;\n            }\n        }\n    }\n\n    /**\n     * Checks whether this event is a well-formed key verification event.\n     * This only does checks that don't rely on the current state of a potentially already channel\n     * so we can prevent channels being created by invalid events.\n     * `handleEvent` can do more checks and choose to ignore invalid events.\n     * @param event - the event to validate\n     * @param client - the client to get the current user and device id from\n     * @returns whether the event is valid and should be passed to handleEvent\n     */\n    public static validateEvent(event: MatrixEvent, client: MatrixClient): boolean {\n        const txnId = InRoomChannel.getTransactionId(event);\n        if (typeof txnId !== \"string\" || txnId.length === 0) {\n            return false;\n        }\n        const type = InRoomChannel.getEventType(event);\n        const content = event.getContent();\n\n        // from here on we're fairly sure that this is supposed to be\n        // part of a verification request, so be noisy when rejecting something\n        if (type === REQUEST_TYPE) {\n            if (!content || typeof content.to !== \"string\" || !content.to.length) {\n                logger.log(\"InRoomChannel: validateEvent: \" + \"no valid to \" + content.to);\n                return false;\n            }\n\n            // ignore requests that are not direct to or sent by the syncing user\n            if (!InRoomChannel.getOtherPartyUserId(event, client)) {\n                logger.log(\n                    \"InRoomChannel: validateEvent: \" +\n                        `not directed to or sent by me: ${event.getSender()}` +\n                        `, ${content.to}`,\n                );\n                return false;\n            }\n        }\n\n        return VerificationRequest.validateEvent(type, event, client);\n    }\n\n    /**\n     * As m.key.verification.request events are as m.room.message events with the InRoomChannel\n     * to have a fallback message in non-supporting clients, we map the real event type\n     * to the symbolic one to keep things in unison with ToDeviceChannel\n     * @param event - the event to get the type of\n     * @returns the \"symbolic\" event type\n     */\n    public static getEventType(event: MatrixEvent): string {\n        const type = event.getType();\n        if (type === MESSAGE_TYPE) {\n            const content = event.getContent();\n            if (content) {\n                const { msgtype } = content;\n                if (msgtype === REQUEST_TYPE) {\n                    return REQUEST_TYPE;\n                }\n            }\n        }\n        if (type && type !== REQUEST_TYPE) {\n            return type;\n        } else {\n            return \"\";\n        }\n    }\n\n    /**\n     * Changes the state of the channel, request, and verifier in response to a key verification event.\n     * @param event - to handle\n     * @param request - the request to forward handling to\n     * @param isLiveEvent - whether this is an even received through sync or not\n     * @returns a promise that resolves when any requests as an answer to the passed-in event are sent.\n     */\n    public async handleEvent(event: MatrixEvent, request: VerificationRequest, isLiveEvent = false): Promise<void> {\n        // prevent processing the same event multiple times, as under\n        // some circumstances Room.timeline can get emitted twice for the same event\n        if (request.hasEventId(event.getId()!)) {\n            return;\n        }\n        const type = InRoomChannel.getEventType(event);\n        // do validations that need state (roomId, userId),\n        // ignore if invalid\n\n        if (event.getRoomId() !== this.roomId) {\n            return;\n        }\n        // set userId if not set already\n        if (!this.userId) {\n            const userId = InRoomChannel.getOtherPartyUserId(event, this.client);\n            if (userId) {\n                this.userId = userId;\n            }\n        }\n        // ignore events not sent by us or the other party\n        const ownUserId = this.client.getUserId();\n        const sender = event.getSender();\n        if (this.userId) {\n            if (sender !== ownUserId && sender !== this.userId) {\n                logger.log(`InRoomChannel: ignoring verification event from non-participating sender ${sender}`);\n                return;\n            }\n        }\n        if (!this.requestEventId) {\n            this.requestEventId = InRoomChannel.getTransactionId(event);\n        }\n\n        // With pendingEventOrdering: \"chronological\", we will see events that have been sent but not yet reflected\n        // back via /sync. These are \"local echoes\" and are identifiable by their txnId\n        const isLocalEcho = !!event.getTxnId();\n\n        // Alternatively, we may see an event that we sent that is reflected back via /sync. These are \"remote echoes\"\n        // and have a transaction ID in the \"unsigned\" data\n        const isRemoteEcho = !!event.getUnsigned().transaction_id;\n\n        const isSentByUs = event.getSender() === this.client.getUserId();\n\n        return request.handleEvent(type, event, isLiveEvent, isLocalEcho || isRemoteEcho, isSentByUs);\n    }\n\n    /**\n     * Adds the transaction id (relation) back to a received event\n     * so it has the same format as returned by `completeContent` before sending.\n     * The relation can not appear on the event content because of encryption,\n     * relations are excluded from encryption.\n     * @param event - the received event\n     * @returns the content object with the relation added again\n     */\n    public completedContentFromEvent(event: MatrixEvent): Record<string, any> {\n        // ensure m.related_to is included in e2ee rooms\n        // as the field is excluded from encryption\n        const content = Object.assign({}, event.getContent());\n        content[M_RELATES_TO] = event.getRelation()!;\n        return content;\n    }\n\n    /**\n     * Add all the fields to content needed for sending it over this channel.\n     * This is public so verification methods (SAS uses this) can get the exact\n     * content that will be sent independent of the used channel,\n     * as they need to calculate the hash of it.\n     * @param type - the event type\n     * @param content - the (incomplete) content\n     * @returns the complete content, as it will be sent.\n     */\n    public completeContent(type: string, content: Record<string, any>): Record<string, any> {\n        content = Object.assign({}, content);\n        if (type === REQUEST_TYPE || type === READY_TYPE || type === START_TYPE) {\n            content.from_device = this.client.getDeviceId();\n        }\n        if (type === REQUEST_TYPE) {\n            // type is mapped to m.room.message in the send method\n            content = {\n                body:\n                    this.client.getUserId() +\n                    \" is requesting to verify \" +\n                    \"your key, but your client does not support in-chat key \" +\n                    \"verification.  You will need to use legacy key \" +\n                    \"verification to verify keys.\",\n                msgtype: REQUEST_TYPE,\n                to: this.userId,\n                from_device: content.from_device,\n                methods: content.methods,\n            };\n        } else {\n            content[M_RELATES_TO] = {\n                rel_type: M_REFERENCE,\n                event_id: this.transactionId,\n            };\n        }\n        return content;\n    }\n\n    /**\n     * Send an event over the channel with the content not having gone through `completeContent`.\n     * @param type - the event type\n     * @param uncompletedContent - the (incomplete) content\n     * @returns the promise of the request\n     */\n    public send(type: string, uncompletedContent: Record<string, any>): Promise<void> {\n        const content = this.completeContent(type, uncompletedContent);\n        return this.sendCompleted(type, content);\n    }\n\n    /**\n     * Send an event over the channel with the content having gone through `completeContent` already.\n     * @param type - the event type\n     * @returns the promise of the request\n     */\n    public async sendCompleted(type: string, content: Record<string, any>): Promise<void> {\n        let sendType = type;\n        if (type === REQUEST_TYPE) {\n            sendType = MESSAGE_TYPE;\n        }\n        const response = await this.client.sendEvent(\n            this.roomId,\n            sendType as keyof TimelineEvents,\n            content as TimelineEvents[keyof TimelineEvents],\n        );\n        if (type === REQUEST_TYPE) {\n            this.requestEventId = response.event_id;\n        }\n    }\n}\n\nexport class InRoomRequests implements IRequestsMap {\n    private requestsByRoomId = new Map<string, Map<string, VerificationRequest>>();\n\n    public getRequest(event: MatrixEvent): VerificationRequest | undefined {\n        const roomId = event.getRoomId()!;\n        const txnId = InRoomChannel.getTransactionId(event)!;\n        return this.getRequestByTxnId(roomId, txnId);\n    }\n\n    public getRequestByChannel(channel: InRoomChannel): VerificationRequest | undefined {\n        return this.getRequestByTxnId(channel.roomId, channel.transactionId!);\n    }\n\n    private getRequestByTxnId(roomId: string, txnId: string): VerificationRequest | undefined {\n        const requestsByTxnId = this.requestsByRoomId.get(roomId);\n        if (requestsByTxnId) {\n            return requestsByTxnId.get(txnId);\n        }\n    }\n\n    public setRequest(event: MatrixEvent, request: VerificationRequest): void {\n        this.doSetRequest(event.getRoomId()!, InRoomChannel.getTransactionId(event)!, request);\n    }\n\n    public setRequestByChannel(channel: IVerificationChannel, request: VerificationRequest): void {\n        this.doSetRequest(channel.roomId!, channel.transactionId!, request);\n    }\n\n    private doSetRequest(roomId: string, txnId: string, request: VerificationRequest): void {\n        let requestsByTxnId = this.requestsByRoomId.get(roomId);\n        if (!requestsByTxnId) {\n            requestsByTxnId = new Map();\n            this.requestsByRoomId.set(roomId, requestsByTxnId);\n        }\n        requestsByTxnId.set(txnId, request);\n    }\n\n    public removeRequest(event: MatrixEvent): void {\n        const roomId = event.getRoomId()!;\n        const requestsByTxnId = this.requestsByRoomId.get(roomId);\n        if (requestsByTxnId) {\n            requestsByTxnId.delete(InRoomChannel.getTransactionId(event)!);\n            if (requestsByTxnId.size === 0) {\n                this.requestsByRoomId.delete(roomId);\n            }\n        }\n    }\n\n    public findRequestInProgress(roomId: string, userId?: string): VerificationRequest | undefined {\n        const requestsByTxnId = this.requestsByRoomId.get(roomId);\n        if (requestsByTxnId) {\n            for (const request of requestsByTxnId.values()) {\n                if (request.pending && (userId === undefined || request.requestingUserId === userId)) {\n                    return request;\n                }\n            }\n        }\n    }\n}\n"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,mBAAmB,EAAEC,YAAY,EAAEC,UAAU,EAAEC,UAAU,QAAQ,0BAA0B;AACpG,SAASC,MAAM,QAAQ,oBAAoB;AAE3C,SAASC,SAAS,QAAwB,0BAA0B;AAKpE,IAAMC,YAAY,GAAGD,SAAS,CAACE,WAAW;AAC1C,IAAMC,WAAW,GAAG,aAAa;AACjC,IAAMC,YAAY,GAAG,cAAc;;AAEnC;AACA;AACA;AACA;AACA,OAAO,MAAMC,aAAa,CAAiC;EAGvD;AACJ;AACA;AACA;AACA;EACWC,WAAWA,CACGC,MAAoB,EACrBC,MAAc,EACvBC,MAAe,EACxB;IAAA,KAHmBF,MAAoB,GAApBA,MAAoB;IAAA,KACrBC,MAAc,GAAdA,MAAc;IAAA,KACvBC,MAAe,GAAfA,MAAe;IAAAC,eAAA;EACvB;EAEH,IAAWC,4BAA4BA,CAAA,EAAY;IAC/C,OAAO,IAAI;EACf;;EAEA;EACA,IAAWC,aAAaA,CAAA,EAAuB;IAC3C,OAAO,IAAI,CAACC,cAAc;EAC9B;EAEA,OAAcC,mBAAmBA,CAACC,KAAkB,EAAER,MAAoB,EAAsB;IAC5F,IAAMS,IAAI,GAAGX,aAAa,CAACY,YAAY,CAACF,KAAK,CAAC;IAC9C,IAAIC,IAAI,KAAKpB,YAAY,EAAE;MACvB;IACJ;IACA,IAAMsB,SAAS,GAAGX,MAAM,CAACY,SAAS,CAAC,CAAC;IACpC,IAAMC,MAAM,GAAGL,KAAK,CAACM,SAAS,CAAC,CAAC;IAChC,IAAMC,OAAO,GAAGP,KAAK,CAACQ,UAAU,CAAC,CAAC;IAClC,IAAMC,QAAQ,GAAGF,OAAO,CAACG,EAAE;IAE3B,IAAIL,MAAM,KAAKF,SAAS,EAAE;MACtB,OAAOM,QAAQ;IACnB,CAAC,MAAM,IAAIA,QAAQ,KAAKN,SAAS,EAAE;MAC/B,OAAOE,MAAM;IACjB;EACJ;;EAEA;AACJ;AACA;AACA;EACWM,YAAYA,CAACX,KAAkB,EAAU;IAC5C,OAAOA,KAAK,CAACY,KAAK,CAAC,CAAC;EACxB;;EAEA;AACJ;AACA;AACA;AACA;EACI,OAAcC,gBAAgBA,CAACZ,IAAY,EAAW;IAClD,OAAOA,IAAI,KAAKpB,YAAY;EAChC;EAEOgC,gBAAgBA,CAACZ,IAAY,EAAW;IAC3C,OAAOX,aAAa,CAACuB,gBAAgB,CAACZ,IAAI,CAAC;EAC/C;;EAEA;AACJ;AACA;AACA;AACA;EACI,OAAca,gBAAgBA,CAACd,KAAkB,EAAsB;IACnE,IAAIV,aAAa,CAACY,YAAY,CAACF,KAAK,CAAC,KAAKnB,YAAY,EAAE;MACpD,OAAOmB,KAAK,CAACe,KAAK,CAAC,CAAC;IACxB,CAAC,MAAM;MACH,IAAMC,QAAQ,GAAGhB,KAAK,CAACiB,WAAW,CAAC,CAAC;MACpC,IAAI,CAAAD,QAAQ,aAARA,QAAQ,uBAARA,QAAQ,CAAEE,QAAQ,MAAK9B,WAAW,EAAE;QACpC,OAAO4B,QAAQ,CAACG,QAAQ;MAC5B;IACJ;EACJ;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACI,OAAcC,aAAaA,CAACpB,KAAkB,EAAER,MAAoB,EAAW;IAC3E,IAAM6B,KAAK,GAAG/B,aAAa,CAACwB,gBAAgB,CAACd,KAAK,CAAC;IACnD,IAAI,OAAOqB,KAAK,KAAK,QAAQ,IAAIA,KAAK,CAACC,MAAM,KAAK,CAAC,EAAE;MACjD,OAAO,KAAK;IAChB;IACA,IAAMrB,IAAI,GAAGX,aAAa,CAACY,YAAY,CAACF,KAAK,CAAC;IAC9C,IAAMO,OAAO,GAAGP,KAAK,CAACQ,UAAU,CAAC,CAAC;;IAElC;IACA;IACA,IAAIP,IAAI,KAAKpB,YAAY,EAAE;MACvB,IAAI,CAAC0B,OAAO,IAAI,OAAOA,OAAO,CAACG,EAAE,KAAK,QAAQ,IAAI,CAACH,OAAO,CAACG,EAAE,CAACY,MAAM,EAAE;QAClEtC,MAAM,CAACuC,GAAG,CAAC,gCAAgC,GAAG,cAAc,GAAGhB,OAAO,CAACG,EAAE,CAAC;QAC1E,OAAO,KAAK;MAChB;;MAEA;MACA,IAAI,CAACpB,aAAa,CAACS,mBAAmB,CAACC,KAAK,EAAER,MAAM,CAAC,EAAE;QACnDR,MAAM,CAACuC,GAAG,CACN,gCAAgC,qCAAAC,MAAA,CACMxB,KAAK,CAACM,SAAS,CAAC,CAAC,CAAE,QAAAkB,MAAA,CAChDjB,OAAO,CAACG,EAAE,CACvB,CAAC;QACD,OAAO,KAAK;MAChB;IACJ;IAEA,OAAO9B,mBAAmB,CAACwC,aAAa,CAACnB,IAAI,EAAED,KAAK,EAAER,MAAM,CAAC;EACjE;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACI,OAAcU,YAAYA,CAACF,KAAkB,EAAU;IACnD,IAAMC,IAAI,GAAGD,KAAK,CAACyB,OAAO,CAAC,CAAC;IAC5B,IAAIxB,IAAI,KAAKf,YAAY,EAAE;MACvB,IAAMqB,OAAO,GAAGP,KAAK,CAACQ,UAAU,CAAC,CAAC;MAClC,IAAID,OAAO,EAAE;QACT,IAAM;UAAEmB;QAAQ,CAAC,GAAGnB,OAAO;QAC3B,IAAImB,OAAO,KAAK7C,YAAY,EAAE;UAC1B,OAAOA,YAAY;QACvB;MACJ;IACJ;IACA,IAAIoB,IAAI,IAAIA,IAAI,KAAKpB,YAAY,EAAE;MAC/B,OAAOoB,IAAI;IACf,CAAC,MAAM;MACH,OAAO,EAAE;IACb;EACJ;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACiB0B,WAAWA,CAAC3B,KAAkB,EAAE4B,OAA4B,EAAsC;IAAA,IAAAC,UAAA,GAAAC,SAAA;MAAAC,KAAA;IAAA,OAAAC,iBAAA;MAAA,IAApCC,WAAW,GAAAJ,UAAA,CAAAP,MAAA,QAAAO,UAAA,QAAAK,SAAA,GAAAL,UAAA,MAAG,KAAK;MAC1F;MACA;MACA,IAAID,OAAO,CAACO,UAAU,CAACnC,KAAK,CAACe,KAAK,CAAC,CAAE,CAAC,EAAE;QACpC;MACJ;MACA,IAAMd,IAAI,GAAGX,aAAa,CAACY,YAAY,CAACF,KAAK,CAAC;MAC9C;MACA;;MAEA,IAAIA,KAAK,CAACoC,SAAS,CAAC,CAAC,KAAKL,KAAI,CAACtC,MAAM,EAAE;QACnC;MACJ;MACA;MACA,IAAI,CAACsC,KAAI,CAACrC,MAAM,EAAE;QACd,IAAMA,OAAM,GAAGJ,aAAa,CAACS,mBAAmB,CAACC,KAAK,EAAE+B,KAAI,CAACvC,MAAM,CAAC;QACpE,IAAIE,OAAM,EAAE;UACRqC,KAAI,CAACrC,MAAM,GAAGA,OAAM;QACxB;MACJ;MACA;MACA,IAAMS,SAAS,GAAG4B,KAAI,CAACvC,MAAM,CAACY,SAAS,CAAC,CAAC;MACzC,IAAMC,MAAM,GAAGL,KAAK,CAACM,SAAS,CAAC,CAAC;MAChC,IAAIyB,KAAI,CAACrC,MAAM,EAAE;QACb,IAAIW,MAAM,KAAKF,SAAS,IAAIE,MAAM,KAAK0B,KAAI,CAACrC,MAAM,EAAE;UAChDV,MAAM,CAACuC,GAAG,6EAAAC,MAAA,CAA6EnB,MAAM,CAAE,CAAC;UAChG;QACJ;MACJ;MACA,IAAI,CAAC0B,KAAI,CAACjC,cAAc,EAAE;QACtBiC,KAAI,CAACjC,cAAc,GAAGR,aAAa,CAACwB,gBAAgB,CAACd,KAAK,CAAC;MAC/D;;MAEA;MACA;MACA,IAAMqC,WAAW,GAAG,CAAC,CAACrC,KAAK,CAACsC,QAAQ,CAAC,CAAC;;MAEtC;MACA;MACA,IAAMC,YAAY,GAAG,CAAC,CAACvC,KAAK,CAACwC,WAAW,CAAC,CAAC,CAACC,cAAc;MAEzD,IAAMC,UAAU,GAAG1C,KAAK,CAACM,SAAS,CAAC,CAAC,KAAKyB,KAAI,CAACvC,MAAM,CAACY,SAAS,CAAC,CAAC;MAEhE,OAAOwB,OAAO,CAACD,WAAW,CAAC1B,IAAI,EAAED,KAAK,EAAEiC,WAAW,EAAEI,WAAW,IAAIE,YAAY,EAAEG,UAAU,CAAC;IAAC;EAClG;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;EACWC,yBAAyBA,CAAC3C,KAAkB,EAAuB;IACtE;IACA;IACA,IAAMO,OAAO,GAAGqC,MAAM,CAACC,MAAM,CAAC,CAAC,CAAC,EAAE7C,KAAK,CAACQ,UAAU,CAAC,CAAC,CAAC;IACrDD,OAAO,CAAClB,YAAY,CAAC,GAAGW,KAAK,CAACiB,WAAW,CAAC,CAAE;IAC5C,OAAOV,OAAO;EAClB;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACWuC,eAAeA,CAAC7C,IAAY,EAAEM,OAA4B,EAAuB;IACpFA,OAAO,GAAGqC,MAAM,CAACC,MAAM,CAAC,CAAC,CAAC,EAAEtC,OAAO,CAAC;IACpC,IAAIN,IAAI,KAAKpB,YAAY,IAAIoB,IAAI,KAAKnB,UAAU,IAAImB,IAAI,KAAKlB,UAAU,EAAE;MACrEwB,OAAO,CAACwC,WAAW,GAAG,IAAI,CAACvD,MAAM,CAACwD,WAAW,CAAC,CAAC;IACnD;IACA,IAAI/C,IAAI,KAAKpB,YAAY,EAAE;MACvB;MACA0B,OAAO,GAAG;QACN0C,IAAI,EACA,IAAI,CAACzD,MAAM,CAACY,SAAS,CAAC,CAAC,GACvB,2BAA2B,GAC3B,yDAAyD,GACzD,iDAAiD,GACjD,8BAA8B;QAClCsB,OAAO,EAAE7C,YAAY;QACrB6B,EAAE,EAAE,IAAI,CAAChB,MAAM;QACfqD,WAAW,EAAExC,OAAO,CAACwC,WAAW;QAChCG,OAAO,EAAE3C,OAAO,CAAC2C;MACrB,CAAC;IACL,CAAC,MAAM;MACH3C,OAAO,CAAClB,YAAY,CAAC,GAAG;QACpB6B,QAAQ,EAAE9B,WAAW;QACrB+B,QAAQ,EAAE,IAAI,CAACtB;MACnB,CAAC;IACL;IACA,OAAOU,OAAO;EAClB;;EAEA;AACJ;AACA;AACA;AACA;AACA;EACW4C,IAAIA,CAAClD,IAAY,EAAEmD,kBAAuC,EAAiB;IAC9E,IAAM7C,OAAO,GAAG,IAAI,CAACuC,eAAe,CAAC7C,IAAI,EAAEmD,kBAAkB,CAAC;IAC9D,OAAO,IAAI,CAACC,aAAa,CAACpD,IAAI,EAAEM,OAAO,CAAC;EAC5C;;EAEA;AACJ;AACA;AACA;AACA;EACiB8C,aAAaA,CAACpD,IAAY,EAAEM,OAA4B,EAAiB;IAAA,IAAA+C,MAAA;IAAA,OAAAtB,iBAAA;MAClF,IAAIuB,QAAQ,GAAGtD,IAAI;MACnB,IAAIA,IAAI,KAAKpB,YAAY,EAAE;QACvB0E,QAAQ,GAAGrE,YAAY;MAC3B;MACA,IAAMsE,QAAQ,SAASF,MAAI,CAAC9D,MAAM,CAACiE,SAAS,CACxCH,MAAI,CAAC7D,MAAM,EACX8D,QAAQ,EACRhD,OACJ,CAAC;MACD,IAAIN,IAAI,KAAKpB,YAAY,EAAE;QACvByE,MAAI,CAACxD,cAAc,GAAG0D,QAAQ,CAACrC,QAAQ;MAC3C;IAAC;EACL;AACJ;AAEA,OAAO,MAAMuC,cAAc,CAAyB;EAAAnE,YAAA;IAAAI,eAAA,2BACrB,IAAIgE,GAAG,CAA2C,CAAC;EAAA;EAEvEC,UAAUA,CAAC5D,KAAkB,EAAmC;IACnE,IAAMP,MAAM,GAAGO,KAAK,CAACoC,SAAS,CAAC,CAAE;IACjC,IAAMf,KAAK,GAAG/B,aAAa,CAACwB,gBAAgB,CAACd,KAAK,CAAE;IACpD,OAAO,IAAI,CAAC6D,iBAAiB,CAACpE,MAAM,EAAE4B,KAAK,CAAC;EAChD;EAEOyC,mBAAmBA,CAACC,OAAsB,EAAmC;IAChF,OAAO,IAAI,CAACF,iBAAiB,CAACE,OAAO,CAACtE,MAAM,EAAEsE,OAAO,CAAClE,aAAc,CAAC;EACzE;EAEQgE,iBAAiBA,CAACpE,MAAc,EAAE4B,KAAa,EAAmC;IACtF,IAAM2C,eAAe,GAAG,IAAI,CAACC,gBAAgB,CAACC,GAAG,CAACzE,MAAM,CAAC;IACzD,IAAIuE,eAAe,EAAE;MACjB,OAAOA,eAAe,CAACE,GAAG,CAAC7C,KAAK,CAAC;IACrC;EACJ;EAEO8C,UAAUA,CAACnE,KAAkB,EAAE4B,OAA4B,EAAQ;IACtE,IAAI,CAACwC,YAAY,CAACpE,KAAK,CAACoC,SAAS,CAAC,CAAC,EAAG9C,aAAa,CAACwB,gBAAgB,CAACd,KAAK,CAAC,EAAG4B,OAAO,CAAC;EAC1F;EAEOyC,mBAAmBA,CAACN,OAA6B,EAAEnC,OAA4B,EAAQ;IAC1F,IAAI,CAACwC,YAAY,CAACL,OAAO,CAACtE,MAAM,EAAGsE,OAAO,CAAClE,aAAa,EAAG+B,OAAO,CAAC;EACvE;EAEQwC,YAAYA,CAAC3E,MAAc,EAAE4B,KAAa,EAAEO,OAA4B,EAAQ;IACpF,IAAIoC,eAAe,GAAG,IAAI,CAACC,gBAAgB,CAACC,GAAG,CAACzE,MAAM,CAAC;IACvD,IAAI,CAACuE,eAAe,EAAE;MAClBA,eAAe,GAAG,IAAIL,GAAG,CAAC,CAAC;MAC3B,IAAI,CAACM,gBAAgB,CAACK,GAAG,CAAC7E,MAAM,EAAEuE,eAAe,CAAC;IACtD;IACAA,eAAe,CAACM,GAAG,CAACjD,KAAK,EAAEO,OAAO,CAAC;EACvC;EAEO2C,aAAaA,CAACvE,KAAkB,EAAQ;IAC3C,IAAMP,MAAM,GAAGO,KAAK,CAACoC,SAAS,CAAC,CAAE;IACjC,IAAM4B,eAAe,GAAG,IAAI,CAACC,gBAAgB,CAACC,GAAG,CAACzE,MAAM,CAAC;IACzD,IAAIuE,eAAe,EAAE;MACjBA,eAAe,CAACQ,MAAM,CAAClF,aAAa,CAACwB,gBAAgB,CAACd,KAAK,CAAE,CAAC;MAC9D,IAAIgE,eAAe,CAACS,IAAI,KAAK,CAAC,EAAE;QAC5B,IAAI,CAACR,gBAAgB,CAACO,MAAM,CAAC/E,MAAM,CAAC;MACxC;IACJ;EACJ;EAEOiF,qBAAqBA,CAACjF,MAAc,EAAEC,MAAe,EAAmC;IAC3F,IAAMsE,eAAe,GAAG,IAAI,CAACC,gBAAgB,CAACC,GAAG,CAACzE,MAAM,CAAC;IACzD,IAAIuE,eAAe,EAAE;MACjB,KAAK,IAAMpC,OAAO,IAAIoC,eAAe,CAACW,MAAM,CAAC,CAAC,EAAE;QAC5C,IAAI/C,OAAO,CAACgD,OAAO,KAAKlF,MAAM,KAAKwC,SAAS,IAAIN,OAAO,CAACiD,gBAAgB,KAAKnF,MAAM,CAAC,EAAE;UAClF,OAAOkC,OAAO;QAClB;MACJ;IACJ;EACJ;AACJ","ignoreList":[]}

package/lib/crypto/verification/request/ToDeviceChannel.d.ts

@@ -0,0 +1,105 @@
+import { VerificationRequest } from "./VerificationRequest.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<ToDeviceChannel>;
+/**
+ * A key verification channel that sends verification events over to_device messages.
+ * Generates its own transaction ids.
+ */
+export declare class ToDeviceChannel implements IVerificationChannel {
+    private readonly client;
+    readonly userId: string;
+    private readonly devices;
+    transactionId?: string | undefined;
+    deviceId?: string | undefined;
+    request?: VerificationRequest;
+    constructor(client: MatrixClient, userId: string, devices: string[], transactionId?: string | undefined, deviceId?: string | undefined);
+    isToDevices(devices: string[]): boolean;
+    static getEventType(event: MatrixEvent): string;
+    /**
+     * Extract the transaction id used by a given key verification event, if any
+     * @param event - the event
+     * @returns the transaction id
+     */
+    static getTransactionId(event: MatrixEvent): string;
+    /**
+     * Checks whether the given event type should be allowed to initiate a new VerificationRequest over this channel
+     * @param type - the event type to check
+     * @returns boolean flag
+     */
+    static canCreateRequest(type: string): boolean;
+    canCreateRequest(type: string): boolean;
+    /**
+     * Checks whether this event is a well-formed key verification event.
+     * This only does checks that don't rely on the current state of a potentially already channel
+     * so we can prevent channels being created by invalid events.
+     * `handleEvent` can do more checks and choose to ignore invalid events.
+     * @param event - the event to validate
+     * @param client - the client to get the current user and device id from
+     * @returns whether the event is valid and should be passed to handleEvent
+     */
+    static validateEvent(event: MatrixEvent, client: MatrixClient): boolean;
+    /**
+     * @param event - the event to get the timestamp of
+     * @returns the timestamp when the event was sent
+     */
+    getTimestamp(event: MatrixEvent): number;
+    /**
+     * Changes the state of the channel, request, and verifier in response to a key verification event.
+     * @param event - to handle
+     * @param request - the request to forward handling to
+     * @param isLiveEvent - whether this is an even received through sync or not
+     * @returns a promise that resolves when any requests as an answer to the passed-in event are sent.
+     */
+    handleEvent(event: MatrixEvent, request: Request, isLiveEvent?: boolean): Promise<void>;
+    /**
+     * See {@link InRoomChannel#completedContentFromEvent} for why this is needed.
+     * @param event - the received event
+     * @returns the content object
+     */
+    completedContentFromEvent(event: MatrixEvent): Record<string, any>;
+    /**
+     * Add all the fields to content needed for sending it over this channel.
+     * This is public so verification methods (SAS uses this) can get the exact
+     * content that will be sent independent of the used channel,
+     * as they need to calculate the hash of it.
+     * @param type - the event type
+     * @param content - the (incomplete) content
+     * @returns the complete content, as it will be sent.
+     */
+    completeContent(type: string, content: Record<string, any>): Record<string, any>;
+    /**
+     * Send an event over the channel with the content not having gone through `completeContent`.
+     * @param type - the event type
+     * @param uncompletedContent - the (incomplete) content
+     * @returns the promise of the request
+     */
+    send(type: string, uncompletedContent?: Record<string, any>): Promise<void>;
+    /**
+     * Send an event over the channel with the content having gone through `completeContent` already.
+     * @param type - the event type
+     * @returns the promise of the request
+     */
+    sendCompleted(type: string, content: Record<string, any>): Promise<void>;
+    private sendToDevices;
+    /**
+     * Allow Crypto module to create and know the transaction id before the .start event gets sent.
+     * @returns the transaction id
+     */
+    static makeTransactionId(): string;
+}
+export declare class ToDeviceRequests implements IRequestsMap {
+    private requestsByUserId;
+    getRequest(event: MatrixEvent): Request | undefined;
+    getRequestByChannel(channel: ToDeviceChannel): Request | undefined;
+    getRequestBySenderAndTxnId(sender: string, txnId: string): Request | undefined;
+    setRequest(event: MatrixEvent, request: Request): void;
+    setRequestByChannel(channel: ToDeviceChannel, request: Request): void;
+    setRequestBySenderAndTxnId(sender: string, txnId: string, request: Request): void;
+    removeRequest(event: MatrixEvent): void;
+    findRequestInProgress(userId: string, devices: string[]): Request | undefined;
+    getRequestsInProgress(userId: string): Request[];
+}
+//# sourceMappingURL=ToDeviceChannel.d.ts.map

package/lib/crypto/verification/request/ToDeviceChannel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ToDeviceChannel.d.ts","sourceRoot":"","sources":["../../../../src/crypto/verification/request/ToDeviceChannel.ts"],"names":[],"mappings":"AAmBA,OAAO,EAOH,mBAAmB,EACtB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,MAAM,MAAM,OAAO,GAAG,mBAAmB,CAAC,eAAe,CAAC,CAAC;AAE3D;;;GAGG;AACH,qBAAa,eAAgB,YAAW,oBAAoB;IAKpD,OAAO,CAAC,QAAQ,CAAC,MAAM;aACP,MAAM,EAAE,MAAM;IAC9B,OAAO,CAAC,QAAQ,CAAC,OAAO;IACjB,aAAa,CAAC,EAAE,MAAM;IACtB,QAAQ,CAAC,EAAE,MAAM;IARrB,OAAO,CAAC,EAAE,mBAAmB,CAAC;gBAIhB,MAAM,EAAE,YAAY,EACrB,MAAM,EAAE,MAAM,EACb,OAAO,EAAE,MAAM,EAAE,EAC3B,aAAa,CAAC,EAAE,MAAM,YAAA,EACtB,QAAQ,CAAC,EAAE,MAAM,YAAA;IAGrB,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO;WAahC,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM;IAItD;;;;OAIG;WACW,gBAAgB,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM;IAK1D;;;;OAIG;WACW,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI9C,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;IAI9C;;;;;;;;OAQG;WACW,aAAa,CAAC,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO;IAkC9E;;;OAGG;IACI,YAAY,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM;IAK/C;;;;;;OAMG;IACU,WAAW,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,UAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAyClG;;;;OAIG;IACI,yBAAyB,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAIzE;;;;;;;;OAQG;IACI,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAevF;;;;;OAKG;IACI,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,kBAAkB,GAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAStF;;;;OAIG;IACU,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;YAwBvE,aAAa;IAW3B;;;OAGG;WACW,iBAAiB,IAAI,MAAM;CAG5C;AAED,qBAAa,gBAAiB,YAAW,YAAY;IACjD,OAAO,CAAC,gBAAgB,CAA2C;IAE5D,UAAU,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,GAAG,SAAS;IAInD,mBAAmB,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,GAAG,SAAS;IAIlE,0BAA0B,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS;IAO9E,UAAU,CAAC,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI;IAItD,mBAAmB,CAAC,OAAO,EAAE,eAAe,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI;IAIrE,0BAA0B,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,GAAG,IAAI;IASjF,aAAa,CAAC,KAAK,EAAE,WAAW,GAAG,IAAI;IAWvC,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,GAAG,SAAS;IAW7E,qBAAqB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,EAAE;CAO1D"}