@unwanted/matrix-sdk-mini 34.12.0-1

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

@@ -0,0 +1,328 @@
+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 { randomString } from "../../../randomstring.js";
+import { logger } from "../../../logger.js";
+import { CANCEL_TYPE, PHASE_STARTED, PHASE_READY, REQUEST_TYPE, READY_TYPE, START_TYPE, VerificationRequest } from "./VerificationRequest.js";
+import { errorFromEvent, newUnexpectedMessageError } from "../Error.js";
+import { MatrixEvent } from "../../../models/event.js";
+/**
+ * A key verification channel that sends verification events over to_device messages.
+ * Generates its own transaction ids.
+ */
+export class ToDeviceChannel {
+  // userId and devices of user we're about to verify
+  constructor(client, userId, devices, transactionId, deviceId) {
+    this.client = client;
+    this.userId = userId;
+    this.devices = devices;
+    this.transactionId = transactionId;
+    this.deviceId = deviceId;
+    _defineProperty(this, "request", void 0);
+  }
+  isToDevices(devices) {
+    if (devices.length === this.devices.length) {
+      for (var device of devices) {
+        if (!this.devices.includes(device)) {
+          return false;
+        }
+      }
+      return true;
+    } else {
+      return false;
+    }
+  }
+  static getEventType(event) {
+    return event.getType();
+  }
+
+  /**
+   * Extract the transaction id used by a given key verification event, if any
+   * @param event - the event
+   * @returns the transaction id
+   */
+  static getTransactionId(event) {
+    var content = event.getContent();
+    return content && content.transaction_id;
+  }
+
+  /**
+   * 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 || type === START_TYPE;
+  }
+  canCreateRequest(type) {
+    return ToDeviceChannel.canCreateRequest(type);
+  }
+
+  /**
+   * 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) {
+    if (event.isCancelled()) {
+      logger.warn("Ignoring flagged verification request from " + event.getSender());
+      return false;
+    }
+    var content = event.getContent();
+    if (!content) {
+      logger.warn("ToDeviceChannel.validateEvent: invalid: no content");
+      return false;
+    }
+    if (!content.transaction_id) {
+      logger.warn("ToDeviceChannel.validateEvent: invalid: no transaction_id");
+      return false;
+    }
+    var type = event.getType();
+    if (type === REQUEST_TYPE) {
+      if (!Number.isFinite(content.timestamp)) {
+        logger.warn("ToDeviceChannel.validateEvent: invalid: no timestamp");
+        return false;
+      }
+      if (event.getSender() === client.getUserId() && content.from_device == client.getDeviceId()) {
+        // ignore requests from ourselves, because it doesn't make sense for a
+        // device to verify itself
+        logger.warn("ToDeviceChannel.validateEvent: invalid: from own device");
+        return false;
+      }
+    }
+    return VerificationRequest.validateEvent(type, event, client);
+  }
+
+  /**
+   * @param event - the event to get the timestamp of
+   * @returns the timestamp when the event was sent
+   */
+  getTimestamp(event) {
+    var content = event.getContent();
+    return content && content.timestamp;
+  }
+
+  /**
+   * 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;
+      var type = event.getType();
+      var content = event.getContent();
+      if (type === REQUEST_TYPE || type === READY_TYPE || type === START_TYPE) {
+        if (!_this.transactionId) {
+          _this.transactionId = content.transaction_id;
+        }
+        var _deviceId = content.from_device;
+        // adopt deviceId if not set before and valid
+        if (!_this.deviceId && _this.devices.includes(_deviceId)) {
+          _this.deviceId = _deviceId;
+        }
+        // if no device id or different from adopted one, cancel with sender
+        if (!_this.deviceId || _this.deviceId !== _deviceId) {
+          // also check that message came from the device we sent the request to earlier on
+          // and do send a cancel message to that device
+          // (but don't cancel the request for the device we should be talking to)
+          var cancelContent = _this.completeContent(CANCEL_TYPE, errorFromEvent(newUnexpectedMessageError()));
+          return _this.sendToDevices(CANCEL_TYPE, cancelContent, [_deviceId]);
+        }
+      }
+      var wasStarted = request.phase === PHASE_STARTED || request.phase === PHASE_READY;
+      yield request.handleEvent(event.getType(), event, isLiveEvent, false, false);
+      var isStarted = request.phase === PHASE_STARTED || request.phase === PHASE_READY;
+      var isAcceptingEvent = type === START_TYPE || type === READY_TYPE;
+      // the request has picked a ready or start event, tell the other devices about it
+      if (isAcceptingEvent && !wasStarted && isStarted && _this.deviceId) {
+        var nonChosenDevices = _this.devices.filter(d => d !== _this.deviceId && d !== _this.client.getDeviceId());
+        if (nonChosenDevices.length) {
+          var message = _this.completeContent(CANCEL_TYPE, {
+            code: "m.accepted",
+            reason: "Verification request accepted by another device"
+          });
+          yield _this.sendToDevices(CANCEL_TYPE, message, nonChosenDevices);
+        }
+      }
+    })();
+  }
+
+  /**
+   * See {@link InRoomChannel#completedContentFromEvent} for why this is needed.
+   * @param event - the received event
+   * @returns the content object
+   */
+  completedContentFromEvent(event) {
+    return event.getContent();
+  }
+
+  /**
+   * 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) {
+    // make a copy
+    content = Object.assign({}, content);
+    if (this.transactionId) {
+      content.transaction_id = this.transactionId;
+    }
+    if (type === REQUEST_TYPE || type === READY_TYPE || type === START_TYPE) {
+      content.from_device = this.client.getDeviceId();
+    }
+    if (type === REQUEST_TYPE) {
+      content.timestamp = Date.now();
+    }
+    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) {
+    var uncompletedContent = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+    // create transaction id when sending request
+    if ((type === REQUEST_TYPE || type === START_TYPE) && !this.transactionId) {
+      this.transactionId = ToDeviceChannel.makeTransactionId();
+    }
+    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 result;
+      if (type === REQUEST_TYPE || type === CANCEL_TYPE && !_this2.deviceId) {
+        result = yield _this2.sendToDevices(type, content, _this2.devices);
+      } else {
+        result = yield _this2.sendToDevices(type, content, [_this2.deviceId]);
+      }
+      // the VerificationRequest state machine requires remote echos of the event
+      // the client sends itself, so we fake this for to_device messages
+      var remoteEchoEvent = new MatrixEvent({
+        sender: _this2.client.getUserId(),
+        content,
+        type
+      });
+      yield _this2.request.handleEvent(type, remoteEchoEvent, /*isLiveEvent=*/true, /*isRemoteEcho=*/true, /*isSentByUs=*/true);
+      return result;
+    })();
+  }
+  sendToDevices(type, content, devices) {
+    var _this3 = this;
+    return _asyncToGenerator(function* () {
+      if (devices.length) {
+        var deviceMessages = new Map();
+        for (var _deviceId2 of devices) {
+          deviceMessages.set(_deviceId2, content);
+        }
+        yield _this3.client.sendToDevice(type, new Map([[_this3.userId, deviceMessages]]));
+      }
+    })();
+  }
+
+  /**
+   * Allow Crypto module to create and know the transaction id before the .start event gets sent.
+   * @returns the transaction id
+   */
+  static makeTransactionId() {
+    return randomString(32);
+  }
+}
+export class ToDeviceRequests {
+  constructor() {
+    _defineProperty(this, "requestsByUserId", new Map());
+  }
+  getRequest(event) {
+    return this.getRequestBySenderAndTxnId(event.getSender(), ToDeviceChannel.getTransactionId(event));
+  }
+  getRequestByChannel(channel) {
+    return this.getRequestBySenderAndTxnId(channel.userId, channel.transactionId);
+  }
+  getRequestBySenderAndTxnId(sender, txnId) {
+    var requestsByTxnId = this.requestsByUserId.get(sender);
+    if (requestsByTxnId) {
+      return requestsByTxnId.get(txnId);
+    }
+  }
+  setRequest(event, request) {
+    this.setRequestBySenderAndTxnId(event.getSender(), ToDeviceChannel.getTransactionId(event), request);
+  }
+  setRequestByChannel(channel, request) {
+    this.setRequestBySenderAndTxnId(channel.userId, channel.transactionId, request);
+  }
+  setRequestBySenderAndTxnId(sender, txnId, request) {
+    var requestsByTxnId = this.requestsByUserId.get(sender);
+    if (!requestsByTxnId) {
+      requestsByTxnId = new Map();
+      this.requestsByUserId.set(sender, requestsByTxnId);
+    }
+    requestsByTxnId.set(txnId, request);
+  }
+  removeRequest(event) {
+    var userId = event.getSender();
+    var requestsByTxnId = this.requestsByUserId.get(userId);
+    if (requestsByTxnId) {
+      requestsByTxnId.delete(ToDeviceChannel.getTransactionId(event));
+      if (requestsByTxnId.size === 0) {
+        this.requestsByUserId.delete(userId);
+      }
+    }
+  }
+  findRequestInProgress(userId, devices) {
+    var requestsByTxnId = this.requestsByUserId.get(userId);
+    if (requestsByTxnId) {
+      for (var request of requestsByTxnId.values()) {
+        if (request.pending && request.channel.isToDevices(devices)) {
+          return request;
+        }
+      }
+    }
+  }
+  getRequestsInProgress(userId) {
+    var requestsByTxnId = this.requestsByUserId.get(userId);
+    if (requestsByTxnId) {
+      return Array.from(requestsByTxnId.values()).filter(r => r.pending);
+    }
+    return [];
+  }
+}
+//# sourceMappingURL=ToDeviceChannel.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ToDeviceChannel.js","names":["randomString","logger","CANCEL_TYPE","PHASE_STARTED","PHASE_READY","REQUEST_TYPE","READY_TYPE","START_TYPE","VerificationRequest","errorFromEvent","newUnexpectedMessageError","MatrixEvent","ToDeviceChannel","constructor","client","userId","devices","transactionId","deviceId","_defineProperty","isToDevices","length","device","includes","getEventType","event","getType","getTransactionId","content","getContent","transaction_id","canCreateRequest","type","validateEvent","isCancelled","warn","getSender","Number","isFinite","timestamp","getUserId","from_device","getDeviceId","getTimestamp","handleEvent","request","_arguments","arguments","_this","_asyncToGenerator","isLiveEvent","undefined","cancelContent","completeContent","sendToDevices","wasStarted","phase","isStarted","isAcceptingEvent","nonChosenDevices","filter","d","message","code","reason","completedContentFromEvent","Object","assign","Date","now","send","uncompletedContent","makeTransactionId","sendCompleted","_this2","result","remoteEchoEvent","sender","_this3","deviceMessages","Map","set","sendToDevice","ToDeviceRequests","getRequest","getRequestBySenderAndTxnId","getRequestByChannel","channel","txnId","requestsByTxnId","requestsByUserId","get","setRequest","setRequestBySenderAndTxnId","setRequestByChannel","removeRequest","delete","size","findRequestInProgress","values","pending","getRequestsInProgress","Array","from","r"],"sources":["../../../../src/crypto/verification/request/ToDeviceChannel.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 { randomString } from \"../../../randomstring.ts\";\nimport { logger } from \"../../../logger.ts\";\nimport {\n    CANCEL_TYPE,\n    PHASE_STARTED,\n    PHASE_READY,\n    REQUEST_TYPE,\n    READY_TYPE,\n    START_TYPE,\n    VerificationRequest,\n} from \"./VerificationRequest.ts\";\nimport { errorFromEvent, newUnexpectedMessageError } from \"../Error.ts\";\nimport { MatrixEvent } from \"../../../models/event.ts\";\nimport { IVerificationChannel } from \"./Channel.ts\";\nimport { MatrixClient } from \"../../../client.ts\";\nimport { IRequestsMap } from \"../../index.ts\";\n\nexport type Request = VerificationRequest<ToDeviceChannel>;\n\n/**\n * A key verification channel that sends verification events over to_device messages.\n * Generates its own transaction ids.\n */\nexport class ToDeviceChannel implements IVerificationChannel {\n    public request?: VerificationRequest;\n\n    // userId and devices of user we're about to verify\n    public constructor(\n        private readonly client: MatrixClient,\n        public readonly userId: string,\n        private readonly devices: string[],\n        public transactionId?: string,\n        public deviceId?: string,\n    ) {}\n\n    public isToDevices(devices: string[]): boolean {\n        if (devices.length === this.devices.length) {\n            for (const device of devices) {\n                if (!this.devices.includes(device)) {\n                    return false;\n                }\n            }\n            return true;\n        } else {\n            return false;\n        }\n    }\n\n    public static getEventType(event: MatrixEvent): string {\n        return event.getType();\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 {\n        const content = event.getContent();\n        return content && content.transaction_id;\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 || type === START_TYPE;\n    }\n\n    public canCreateRequest(type: string): boolean {\n        return ToDeviceChannel.canCreateRequest(type);\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        if (event.isCancelled()) {\n            logger.warn(\"Ignoring flagged verification request from \" + event.getSender());\n            return false;\n        }\n        const content = event.getContent();\n        if (!content) {\n            logger.warn(\"ToDeviceChannel.validateEvent: invalid: no content\");\n            return false;\n        }\n\n        if (!content.transaction_id) {\n            logger.warn(\"ToDeviceChannel.validateEvent: invalid: no transaction_id\");\n            return false;\n        }\n\n        const type = event.getType();\n\n        if (type === REQUEST_TYPE) {\n            if (!Number.isFinite(content.timestamp)) {\n                logger.warn(\"ToDeviceChannel.validateEvent: invalid: no timestamp\");\n                return false;\n            }\n            if (event.getSender() === client.getUserId() && content.from_device == client.getDeviceId()) {\n                // ignore requests from ourselves, because it doesn't make sense for a\n                // device to verify itself\n                logger.warn(\"ToDeviceChannel.validateEvent: invalid: from own device\");\n                return false;\n            }\n        }\n\n        return VerificationRequest.validateEvent(type, event, client);\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        const content = event.getContent();\n        return content && content.timestamp;\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: Request, isLiveEvent = false): Promise<void> {\n        const type = event.getType();\n        const content = event.getContent();\n        if (type === REQUEST_TYPE || type === READY_TYPE || type === START_TYPE) {\n            if (!this.transactionId) {\n                this.transactionId = content.transaction_id;\n            }\n            const deviceId = content.from_device;\n            // adopt deviceId if not set before and valid\n            if (!this.deviceId && this.devices.includes(deviceId)) {\n                this.deviceId = deviceId;\n            }\n            // if no device id or different from adopted one, cancel with sender\n            if (!this.deviceId || this.deviceId !== deviceId) {\n                // also check that message came from the device we sent the request to earlier on\n                // and do send a cancel message to that device\n                // (but don't cancel the request for the device we should be talking to)\n                const cancelContent = this.completeContent(CANCEL_TYPE, errorFromEvent(newUnexpectedMessageError()));\n                return this.sendToDevices(CANCEL_TYPE, cancelContent, [deviceId]);\n            }\n        }\n        const wasStarted = request.phase === PHASE_STARTED || request.phase === PHASE_READY;\n\n        await request.handleEvent(event.getType(), event, isLiveEvent, false, false);\n\n        const isStarted = request.phase === PHASE_STARTED || request.phase === PHASE_READY;\n\n        const isAcceptingEvent = type === START_TYPE || type === READY_TYPE;\n        // the request has picked a ready or start event, tell the other devices about it\n        if (isAcceptingEvent && !wasStarted && isStarted && this.deviceId) {\n            const nonChosenDevices = this.devices.filter((d) => d !== this.deviceId && d !== this.client.getDeviceId());\n            if (nonChosenDevices.length) {\n                const message = this.completeContent(CANCEL_TYPE, {\n                    code: \"m.accepted\",\n                    reason: \"Verification request accepted by another device\",\n                });\n                await this.sendToDevices(CANCEL_TYPE, message, nonChosenDevices);\n            }\n        }\n    }\n\n    /**\n     * See {@link InRoomChannel#completedContentFromEvent} for why this is needed.\n     * @param event - the received event\n     * @returns the content object\n     */\n    public completedContentFromEvent(event: MatrixEvent): Record<string, any> {\n        return event.getContent();\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        // make a copy\n        content = Object.assign({}, content);\n        if (this.transactionId) {\n            content.transaction_id = this.transactionId;\n        }\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            content.timestamp = Date.now();\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        // create transaction id when sending request\n        if ((type === REQUEST_TYPE || type === START_TYPE) && !this.transactionId) {\n            this.transactionId = ToDeviceChannel.makeTransactionId();\n        }\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 result;\n        if (type === REQUEST_TYPE || (type === CANCEL_TYPE && !this.deviceId)) {\n            result = await this.sendToDevices(type, content, this.devices);\n        } else {\n            result = await this.sendToDevices(type, content, [this.deviceId!]);\n        }\n        // the VerificationRequest state machine requires remote echos of the event\n        // the client sends itself, so we fake this for to_device messages\n        const remoteEchoEvent = new MatrixEvent({\n            sender: this.client.getUserId()!,\n            content,\n            type,\n        });\n        await this.request!.handleEvent(\n            type,\n            remoteEchoEvent,\n            /*isLiveEvent=*/ true,\n            /*isRemoteEcho=*/ true,\n            /*isSentByUs=*/ true,\n        );\n        return result;\n    }\n\n    private async sendToDevices(type: string, content: Record<string, any>, devices: string[]): Promise<void> {\n        if (devices.length) {\n            const deviceMessages: Map<string, Record<string, any>> = new Map();\n            for (const deviceId of devices) {\n                deviceMessages.set(deviceId, content);\n            }\n\n            await this.client.sendToDevice(type, new Map([[this.userId, deviceMessages]]));\n        }\n    }\n\n    /**\n     * Allow Crypto module to create and know the transaction id before the .start event gets sent.\n     * @returns the transaction id\n     */\n    public static makeTransactionId(): string {\n        return randomString(32);\n    }\n}\n\nexport class ToDeviceRequests implements IRequestsMap {\n    private requestsByUserId = new Map<string, Map<string, Request>>();\n\n    public getRequest(event: MatrixEvent): Request | undefined {\n        return this.getRequestBySenderAndTxnId(event.getSender()!, ToDeviceChannel.getTransactionId(event));\n    }\n\n    public getRequestByChannel(channel: ToDeviceChannel): Request | undefined {\n        return this.getRequestBySenderAndTxnId(channel.userId, channel.transactionId!);\n    }\n\n    public getRequestBySenderAndTxnId(sender: string, txnId: string): Request | undefined {\n        const requestsByTxnId = this.requestsByUserId.get(sender);\n        if (requestsByTxnId) {\n            return requestsByTxnId.get(txnId);\n        }\n    }\n\n    public setRequest(event: MatrixEvent, request: Request): void {\n        this.setRequestBySenderAndTxnId(event.getSender()!, ToDeviceChannel.getTransactionId(event), request);\n    }\n\n    public setRequestByChannel(channel: ToDeviceChannel, request: Request): void {\n        this.setRequestBySenderAndTxnId(channel.userId, channel.transactionId!, request);\n    }\n\n    public setRequestBySenderAndTxnId(sender: string, txnId: string, request: Request): void {\n        let requestsByTxnId = this.requestsByUserId.get(sender);\n        if (!requestsByTxnId) {\n            requestsByTxnId = new Map();\n            this.requestsByUserId.set(sender, requestsByTxnId);\n        }\n        requestsByTxnId.set(txnId, request);\n    }\n\n    public removeRequest(event: MatrixEvent): void {\n        const userId = event.getSender()!;\n        const requestsByTxnId = this.requestsByUserId.get(userId);\n        if (requestsByTxnId) {\n            requestsByTxnId.delete(ToDeviceChannel.getTransactionId(event));\n            if (requestsByTxnId.size === 0) {\n                this.requestsByUserId.delete(userId);\n            }\n        }\n    }\n\n    public findRequestInProgress(userId: string, devices: string[]): Request | undefined {\n        const requestsByTxnId = this.requestsByUserId.get(userId);\n        if (requestsByTxnId) {\n            for (const request of requestsByTxnId.values()) {\n                if (request.pending && request.channel.isToDevices(devices)) {\n                    return request;\n                }\n            }\n        }\n    }\n\n    public getRequestsInProgress(userId: string): Request[] {\n        const requestsByTxnId = this.requestsByUserId.get(userId);\n        if (requestsByTxnId) {\n            return Array.from(requestsByTxnId.values()).filter((r) => r.pending);\n        }\n        return [];\n    }\n}\n"],"mappings":";;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA,SAASA,YAAY,QAAQ,0BAA0B;AACvD,SAASC,MAAM,QAAQ,oBAAoB;AAC3C,SACIC,WAAW,EACXC,aAAa,EACbC,WAAW,EACXC,YAAY,EACZC,UAAU,EACVC,UAAU,EACVC,mBAAmB,QAChB,0BAA0B;AACjC,SAASC,cAAc,EAAEC,yBAAyB,QAAQ,aAAa;AACvE,SAASC,WAAW,QAAQ,0BAA0B;AAOtD;AACA;AACA;AACA;AACA,OAAO,MAAMC,eAAe,CAAiC;EAGzD;EACOC,WAAWA,CACGC,MAAoB,EACrBC,MAAc,EACbC,OAAiB,EAC3BC,aAAsB,EACtBC,QAAiB,EAC1B;IAAA,KALmBJ,MAAoB,GAApBA,MAAoB;IAAA,KACrBC,MAAc,GAAdA,MAAc;IAAA,KACbC,OAAiB,GAAjBA,OAAiB;IAAA,KAC3BC,aAAsB,GAAtBA,aAAsB;IAAA,KACtBC,QAAiB,GAAjBA,QAAiB;IAAAC,eAAA;EACzB;EAEIC,WAAWA,CAACJ,OAAiB,EAAW;IAC3C,IAAIA,OAAO,CAACK,MAAM,KAAK,IAAI,CAACL,OAAO,CAACK,MAAM,EAAE;MACxC,KAAK,IAAMC,MAAM,IAAIN,OAAO,EAAE;QAC1B,IAAI,CAAC,IAAI,CAACA,OAAO,CAACO,QAAQ,CAACD,MAAM,CAAC,EAAE;UAChC,OAAO,KAAK;QAChB;MACJ;MACA,OAAO,IAAI;IACf,CAAC,MAAM;MACH,OAAO,KAAK;IAChB;EACJ;EAEA,OAAcE,YAAYA,CAACC,KAAkB,EAAU;IACnD,OAAOA,KAAK,CAACC,OAAO,CAAC,CAAC;EAC1B;;EAEA;AACJ;AACA;AACA;AACA;EACI,OAAcC,gBAAgBA,CAACF,KAAkB,EAAU;IACvD,IAAMG,OAAO,GAAGH,KAAK,CAACI,UAAU,CAAC,CAAC;IAClC,OAAOD,OAAO,IAAIA,OAAO,CAACE,cAAc;EAC5C;;EAEA;AACJ;AACA;AACA;AACA;EACI,OAAcC,gBAAgBA,CAACC,IAAY,EAAW;IAClD,OAAOA,IAAI,KAAK3B,YAAY,IAAI2B,IAAI,KAAKzB,UAAU;EACvD;EAEOwB,gBAAgBA,CAACC,IAAY,EAAW;IAC3C,OAAOpB,eAAe,CAACmB,gBAAgB,CAACC,IAAI,CAAC;EACjD;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACI,OAAcC,aAAaA,CAACR,KAAkB,EAAEX,MAAoB,EAAW;IAC3E,IAAIW,KAAK,CAACS,WAAW,CAAC,CAAC,EAAE;MACrBjC,MAAM,CAACkC,IAAI,CAAC,6CAA6C,GAAGV,KAAK,CAACW,SAAS,CAAC,CAAC,CAAC;MAC9E,OAAO,KAAK;IAChB;IACA,IAAMR,OAAO,GAAGH,KAAK,CAACI,UAAU,CAAC,CAAC;IAClC,IAAI,CAACD,OAAO,EAAE;MACV3B,MAAM,CAACkC,IAAI,CAAC,oDAAoD,CAAC;MACjE,OAAO,KAAK;IAChB;IAEA,IAAI,CAACP,OAAO,CAACE,cAAc,EAAE;MACzB7B,MAAM,CAACkC,IAAI,CAAC,2DAA2D,CAAC;MACxE,OAAO,KAAK;IAChB;IAEA,IAAMH,IAAI,GAAGP,KAAK,CAACC,OAAO,CAAC,CAAC;IAE5B,IAAIM,IAAI,KAAK3B,YAAY,EAAE;MACvB,IAAI,CAACgC,MAAM,CAACC,QAAQ,CAACV,OAAO,CAACW,SAAS,CAAC,EAAE;QACrCtC,MAAM,CAACkC,IAAI,CAAC,sDAAsD,CAAC;QACnE,OAAO,KAAK;MAChB;MACA,IAAIV,KAAK,CAACW,SAAS,CAAC,CAAC,KAAKtB,MAAM,CAAC0B,SAAS,CAAC,CAAC,IAAIZ,OAAO,CAACa,WAAW,IAAI3B,MAAM,CAAC4B,WAAW,CAAC,CAAC,EAAE;QACzF;QACA;QACAzC,MAAM,CAACkC,IAAI,CAAC,yDAAyD,CAAC;QACtE,OAAO,KAAK;MAChB;IACJ;IAEA,OAAO3B,mBAAmB,CAACyB,aAAa,CAACD,IAAI,EAAEP,KAAK,EAAEX,MAAM,CAAC;EACjE;;EAEA;AACJ;AACA;AACA;EACW6B,YAAYA,CAAClB,KAAkB,EAAU;IAC5C,IAAMG,OAAO,GAAGH,KAAK,CAACI,UAAU,CAAC,CAAC;IAClC,OAAOD,OAAO,IAAIA,OAAO,CAACW,SAAS;EACvC;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACiBK,WAAWA,CAACnB,KAAkB,EAAEoB,OAAgB,EAAsC;IAAA,IAAAC,UAAA,GAAAC,SAAA;MAAAC,KAAA;IAAA,OAAAC,iBAAA;MAAA,IAApCC,WAAW,GAAAJ,UAAA,CAAAzB,MAAA,QAAAyB,UAAA,QAAAK,SAAA,GAAAL,UAAA,MAAG,KAAK;MAC9E,IAAMd,IAAI,GAAGP,KAAK,CAACC,OAAO,CAAC,CAAC;MAC5B,IAAME,OAAO,GAAGH,KAAK,CAACI,UAAU,CAAC,CAAC;MAClC,IAAIG,IAAI,KAAK3B,YAAY,IAAI2B,IAAI,KAAK1B,UAAU,IAAI0B,IAAI,KAAKzB,UAAU,EAAE;QACrE,IAAI,CAACyC,KAAI,CAAC/B,aAAa,EAAE;UACrB+B,KAAI,CAAC/B,aAAa,GAAGW,OAAO,CAACE,cAAc;QAC/C;QACA,IAAMZ,SAAQ,GAAGU,OAAO,CAACa,WAAW;QACpC;QACA,IAAI,CAACO,KAAI,CAAC9B,QAAQ,IAAI8B,KAAI,CAAChC,OAAO,CAACO,QAAQ,CAACL,SAAQ,CAAC,EAAE;UACnD8B,KAAI,CAAC9B,QAAQ,GAAGA,SAAQ;QAC5B;QACA;QACA,IAAI,CAAC8B,KAAI,CAAC9B,QAAQ,IAAI8B,KAAI,CAAC9B,QAAQ,KAAKA,SAAQ,EAAE;UAC9C;UACA;UACA;UACA,IAAMkC,aAAa,GAAGJ,KAAI,CAACK,eAAe,CAACnD,WAAW,EAAEO,cAAc,CAACC,yBAAyB,CAAC,CAAC,CAAC,CAAC;UACpG,OAAOsC,KAAI,CAACM,aAAa,CAACpD,WAAW,EAAEkD,aAAa,EAAE,CAAClC,SAAQ,CAAC,CAAC;QACrE;MACJ;MACA,IAAMqC,UAAU,GAAGV,OAAO,CAACW,KAAK,KAAKrD,aAAa,IAAI0C,OAAO,CAACW,KAAK,KAAKpD,WAAW;MAEnF,MAAMyC,OAAO,CAACD,WAAW,CAACnB,KAAK,CAACC,OAAO,CAAC,CAAC,EAAED,KAAK,EAAEyB,WAAW,EAAE,KAAK,EAAE,KAAK,CAAC;MAE5E,IAAMO,SAAS,GAAGZ,OAAO,CAACW,KAAK,KAAKrD,aAAa,IAAI0C,OAAO,CAACW,KAAK,KAAKpD,WAAW;MAElF,IAAMsD,gBAAgB,GAAG1B,IAAI,KAAKzB,UAAU,IAAIyB,IAAI,KAAK1B,UAAU;MACnE;MACA,IAAIoD,gBAAgB,IAAI,CAACH,UAAU,IAAIE,SAAS,IAAIT,KAAI,CAAC9B,QAAQ,EAAE;QAC/D,IAAMyC,gBAAgB,GAAGX,KAAI,CAAChC,OAAO,CAAC4C,MAAM,CAAEC,CAAC,IAAKA,CAAC,KAAKb,KAAI,CAAC9B,QAAQ,IAAI2C,CAAC,KAAKb,KAAI,CAAClC,MAAM,CAAC4B,WAAW,CAAC,CAAC,CAAC;QAC3G,IAAIiB,gBAAgB,CAACtC,MAAM,EAAE;UACzB,IAAMyC,OAAO,GAAGd,KAAI,CAACK,eAAe,CAACnD,WAAW,EAAE;YAC9C6D,IAAI,EAAE,YAAY;YAClBC,MAAM,EAAE;UACZ,CAAC,CAAC;UACF,MAAMhB,KAAI,CAACM,aAAa,CAACpD,WAAW,EAAE4D,OAAO,EAAEH,gBAAgB,CAAC;QACpE;MACJ;IAAC;EACL;;EAEA;AACJ;AACA;AACA;AACA;EACWM,yBAAyBA,CAACxC,KAAkB,EAAuB;IACtE,OAAOA,KAAK,CAACI,UAAU,CAAC,CAAC;EAC7B;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACWwB,eAAeA,CAACrB,IAAY,EAAEJ,OAA4B,EAAuB;IACpF;IACAA,OAAO,GAAGsC,MAAM,CAACC,MAAM,CAAC,CAAC,CAAC,EAAEvC,OAAO,CAAC;IACpC,IAAI,IAAI,CAACX,aAAa,EAAE;MACpBW,OAAO,CAACE,cAAc,GAAG,IAAI,CAACb,aAAa;IAC/C;IACA,IAAIe,IAAI,KAAK3B,YAAY,IAAI2B,IAAI,KAAK1B,UAAU,IAAI0B,IAAI,KAAKzB,UAAU,EAAE;MACrEqB,OAAO,CAACa,WAAW,GAAG,IAAI,CAAC3B,MAAM,CAAC4B,WAAW,CAAC,CAAC;IACnD;IACA,IAAIV,IAAI,KAAK3B,YAAY,EAAE;MACvBuB,OAAO,CAACW,SAAS,GAAG6B,IAAI,CAACC,GAAG,CAAC,CAAC;IAClC;IACA,OAAOzC,OAAO;EAClB;;EAEA;AACJ;AACA;AACA;AACA;AACA;EACW0C,IAAIA,CAACtC,IAAY,EAA+D;IAAA,IAA7DuC,kBAAuC,GAAAxB,SAAA,CAAA1B,MAAA,QAAA0B,SAAA,QAAAI,SAAA,GAAAJ,SAAA,MAAG,CAAC,CAAC;IAClE;IACA,IAAI,CAACf,IAAI,KAAK3B,YAAY,IAAI2B,IAAI,KAAKzB,UAAU,KAAK,CAAC,IAAI,CAACU,aAAa,EAAE;MACvE,IAAI,CAACA,aAAa,GAAGL,eAAe,CAAC4D,iBAAiB,CAAC,CAAC;IAC5D;IACA,IAAM5C,OAAO,GAAG,IAAI,CAACyB,eAAe,CAACrB,IAAI,EAAEuC,kBAAkB,CAAC;IAC9D,OAAO,IAAI,CAACE,aAAa,CAACzC,IAAI,EAAEJ,OAAO,CAAC;EAC5C;;EAEA;AACJ;AACA;AACA;AACA;EACiB6C,aAAaA,CAACzC,IAAY,EAAEJ,OAA4B,EAAiB;IAAA,IAAA8C,MAAA;IAAA,OAAAzB,iBAAA;MAClF,IAAI0B,MAAM;MACV,IAAI3C,IAAI,KAAK3B,YAAY,IAAK2B,IAAI,KAAK9B,WAAW,IAAI,CAACwE,MAAI,CAACxD,QAAS,EAAE;QACnEyD,MAAM,SAASD,MAAI,CAACpB,aAAa,CAACtB,IAAI,EAAEJ,OAAO,EAAE8C,MAAI,CAAC1D,OAAO,CAAC;MAClE,CAAC,MAAM;QACH2D,MAAM,SAASD,MAAI,CAACpB,aAAa,CAACtB,IAAI,EAAEJ,OAAO,EAAE,CAAC8C,MAAI,CAACxD,QAAQ,CAAE,CAAC;MACtE;MACA;MACA;MACA,IAAM0D,eAAe,GAAG,IAAIjE,WAAW,CAAC;QACpCkE,MAAM,EAAEH,MAAI,CAAC5D,MAAM,CAAC0B,SAAS,CAAC,CAAE;QAChCZ,OAAO;QACPI;MACJ,CAAC,CAAC;MACF,MAAM0C,MAAI,CAAC7B,OAAO,CAAED,WAAW,CAC3BZ,IAAI,EACJ4C,eAAe,EACf,gBAAiB,IAAI,EACrB,iBAAkB,IAAI,EACtB,eAAgB,IACpB,CAAC;MACD,OAAOD,MAAM;IAAC;EAClB;EAEcrB,aAAaA,CAACtB,IAAY,EAAEJ,OAA4B,EAAEZ,OAAiB,EAAiB;IAAA,IAAA8D,MAAA;IAAA,OAAA7B,iBAAA;MACtG,IAAIjC,OAAO,CAACK,MAAM,EAAE;QAChB,IAAM0D,cAAgD,GAAG,IAAIC,GAAG,CAAC,CAAC;QAClE,KAAK,IAAM9D,UAAQ,IAAIF,OAAO,EAAE;UAC5B+D,cAAc,CAACE,GAAG,CAAC/D,UAAQ,EAAEU,OAAO,CAAC;QACzC;QAEA,MAAMkD,MAAI,CAAChE,MAAM,CAACoE,YAAY,CAAClD,IAAI,EAAE,IAAIgD,GAAG,CAAC,CAAC,CAACF,MAAI,CAAC/D,MAAM,EAAEgE,cAAc,CAAC,CAAC,CAAC,CAAC;MAClF;IAAC;EACL;;EAEA;AACJ;AACA;AACA;EACI,OAAcP,iBAAiBA,CAAA,EAAW;IACtC,OAAOxE,YAAY,CAAC,EAAE,CAAC;EAC3B;AACJ;AAEA,OAAO,MAAMmF,gBAAgB,CAAyB;EAAAtE,YAAA;IAAAM,eAAA,2BACvB,IAAI6D,GAAG,CAA+B,CAAC;EAAA;EAE3DI,UAAUA,CAAC3D,KAAkB,EAAuB;IACvD,OAAO,IAAI,CAAC4D,0BAA0B,CAAC5D,KAAK,CAACW,SAAS,CAAC,CAAC,EAAGxB,eAAe,CAACe,gBAAgB,CAACF,KAAK,CAAC,CAAC;EACvG;EAEO6D,mBAAmBA,CAACC,OAAwB,EAAuB;IACtE,OAAO,IAAI,CAACF,0BAA0B,CAACE,OAAO,CAACxE,MAAM,EAAEwE,OAAO,CAACtE,aAAc,CAAC;EAClF;EAEOoE,0BAA0BA,CAACR,MAAc,EAAEW,KAAa,EAAuB;IAClF,IAAMC,eAAe,GAAG,IAAI,CAACC,gBAAgB,CAACC,GAAG,CAACd,MAAM,CAAC;IACzD,IAAIY,eAAe,EAAE;MACjB,OAAOA,eAAe,CAACE,GAAG,CAACH,KAAK,CAAC;IACrC;EACJ;EAEOI,UAAUA,CAACnE,KAAkB,EAAEoB,OAAgB,EAAQ;IAC1D,IAAI,CAACgD,0BAA0B,CAACpE,KAAK,CAACW,SAAS,CAAC,CAAC,EAAGxB,eAAe,CAACe,gBAAgB,CAACF,KAAK,CAAC,EAAEoB,OAAO,CAAC;EACzG;EAEOiD,mBAAmBA,CAACP,OAAwB,EAAE1C,OAAgB,EAAQ;IACzE,IAAI,CAACgD,0BAA0B,CAACN,OAAO,CAACxE,MAAM,EAAEwE,OAAO,CAACtE,aAAa,EAAG4B,OAAO,CAAC;EACpF;EAEOgD,0BAA0BA,CAAChB,MAAc,EAAEW,KAAa,EAAE3C,OAAgB,EAAQ;IACrF,IAAI4C,eAAe,GAAG,IAAI,CAACC,gBAAgB,CAACC,GAAG,CAACd,MAAM,CAAC;IACvD,IAAI,CAACY,eAAe,EAAE;MAClBA,eAAe,GAAG,IAAIT,GAAG,CAAC,CAAC;MAC3B,IAAI,CAACU,gBAAgB,CAACT,GAAG,CAACJ,MAAM,EAAEY,eAAe,CAAC;IACtD;IACAA,eAAe,CAACR,GAAG,CAACO,KAAK,EAAE3C,OAAO,CAAC;EACvC;EAEOkD,aAAaA,CAACtE,KAAkB,EAAQ;IAC3C,IAAMV,MAAM,GAAGU,KAAK,CAACW,SAAS,CAAC,CAAE;IACjC,IAAMqD,eAAe,GAAG,IAAI,CAACC,gBAAgB,CAACC,GAAG,CAAC5E,MAAM,CAAC;IACzD,IAAI0E,eAAe,EAAE;MACjBA,eAAe,CAACO,MAAM,CAACpF,eAAe,CAACe,gBAAgB,CAACF,KAAK,CAAC,CAAC;MAC/D,IAAIgE,eAAe,CAACQ,IAAI,KAAK,CAAC,EAAE;QAC5B,IAAI,CAACP,gBAAgB,CAACM,MAAM,CAACjF,MAAM,CAAC;MACxC;IACJ;EACJ;EAEOmF,qBAAqBA,CAACnF,MAAc,EAAEC,OAAiB,EAAuB;IACjF,IAAMyE,eAAe,GAAG,IAAI,CAACC,gBAAgB,CAACC,GAAG,CAAC5E,MAAM,CAAC;IACzD,IAAI0E,eAAe,EAAE;MACjB,KAAK,IAAM5C,OAAO,IAAI4C,eAAe,CAACU,MAAM,CAAC,CAAC,EAAE;QAC5C,IAAItD,OAAO,CAACuD,OAAO,IAAIvD,OAAO,CAAC0C,OAAO,CAACnE,WAAW,CAACJ,OAAO,CAAC,EAAE;UACzD,OAAO6B,OAAO;QAClB;MACJ;IACJ;EACJ;EAEOwD,qBAAqBA,CAACtF,MAAc,EAAa;IACpD,IAAM0E,eAAe,GAAG,IAAI,CAACC,gBAAgB,CAACC,GAAG,CAAC5E,MAAM,CAAC;IACzD,IAAI0E,eAAe,EAAE;MACjB,OAAOa,KAAK,CAACC,IAAI,CAACd,eAAe,CAACU,MAAM,CAAC,CAAC,CAAC,CAACvC,MAAM,CAAE4C,CAAC,IAAKA,CAAC,CAACJ,OAAO,CAAC;IACxE;IACA,OAAO,EAAE;EACb;AACJ","ignoreList":[]}

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

@@ -0,0 +1,227 @@
+import { QRCodeData } from "../QRCode.ts";
+import { IVerificationChannel } from "./Channel.ts";
+import { MatrixClient } from "../../../client.ts";
+import { MatrixEvent } from "../../../models/event.ts";
+import { VerificationBase } from "../Base.ts";
+import { VerificationMethod } from "../../index.ts";
+import { TypedEventEmitter } from "../../../models/typed-event-emitter.ts";
+import { VerificationPhase as Phase, VerificationRequest as IVerificationRequest, VerificationRequestEvent, VerificationRequestEventHandlerMap, Verifier } from "../../../crypto-api/verification.ts";
+export { VerificationPhase as Phase, VerificationRequestEvent } from "../../../crypto-api/verification.ts";
+export declare const EVENT_PREFIX = "m.key.verification.";
+export declare const REQUEST_TYPE: string;
+export declare const START_TYPE: string;
+export declare const CANCEL_TYPE: string;
+export declare const DONE_TYPE: string;
+export declare const READY_TYPE: string;
+export declare const PHASE_UNSENT = Phase.Unsent;
+export declare const PHASE_REQUESTED = Phase.Requested;
+export declare const PHASE_READY = Phase.Ready;
+export declare const PHASE_STARTED = Phase.Started;
+export declare const PHASE_CANCELLED = Phase.Cancelled;
+export declare const PHASE_DONE = Phase.Done;
+interface ITargetDevice {
+    userId?: string;
+    deviceId?: string;
+}
+/**
+ * State machine for verification requests.
+ * Things that differ based on what channel is used to
+ * send and receive verification events are put in `InRoomChannel` or `ToDeviceChannel`.
+ *
+ * @deprecated Avoid direct references: instead prefer {@link Crypto.VerificationRequest}.
+ */
+export declare class VerificationRequest<C extends IVerificationChannel = IVerificationChannel> extends TypedEventEmitter<VerificationRequestEvent, VerificationRequestEventHandlerMap> implements IVerificationRequest {
+    readonly channel: C;
+    private readonly verificationMethods;
+    private readonly client;
+    private eventsByUs;
+    private eventsByThem;
+    private _observeOnly;
+    private timeoutTimer;
+    private _accepting;
+    private _declining;
+    private verifierHasFinished;
+    private _cancelled;
+    private _chosenMethod;
+    private _qrCodeData;
+    private requestReceivedAt;
+    private commonMethods;
+    private _phase;
+    _cancellingUserId?: string;
+    private _verifier?;
+    constructor(channel: C, verificationMethods: Map<VerificationMethod, typeof VerificationBase>, client: MatrixClient);
+    /**
+     * Stateless validation logic not specific to the channel.
+     * Invoked by the same static method in either channel.
+     * @param type - the "symbolic" event type, as returned by the `getEventType` function on the channel.
+     * @param event - the event to validate. Don't call getType() on it but use the `type` parameter instead.
+     * @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(type: string, event: MatrixEvent, client: MatrixClient): boolean;
+    /**
+     * Unique ID for this verification request.
+     *
+     * An ID isn't assigned until the first message is sent, so this may be `undefined` in the early phases.
+     */
+    get transactionId(): string | undefined;
+    /**
+     * For an in-room verification, the ID of the room.
+     */
+    get roomId(): string | undefined;
+    get invalid(): boolean;
+    /** returns whether the phase is PHASE_REQUESTED */
+    get requested(): boolean;
+    /** returns whether the phase is PHASE_CANCELLED */
+    get cancelled(): boolean;
+    /** returns whether the phase is PHASE_READY */
+    get ready(): boolean;
+    /** returns whether the phase is PHASE_STARTED */
+    get started(): boolean;
+    /** returns whether the phase is PHASE_DONE */
+    get done(): boolean;
+    /** once the phase is PHASE_STARTED (and !initiatedByMe) or PHASE_READY: common methods supported by both sides */
+    get methods(): VerificationMethod[];
+    /** the method picked in the .start event */
+    get chosenMethod(): VerificationMethod | null;
+    calculateEventTimeout(event: MatrixEvent): number;
+    /** The current remaining amount of ms before the request should be automatically cancelled */
+    get timeout(): number;
+    /**
+     * The key verification request event.
+     * @returns The request event, or falsey if not found.
+     */
+    get requestEvent(): MatrixEvent | undefined;
+    /** current phase of the request. Some properties might only be defined in a current phase. */
+    get phase(): Phase;
+    /** The verifier to do the actual verification, once the method has been established. Only defined when the `phase` is PHASE_STARTED. */
+    get verifier(): VerificationBase<any, any> | undefined;
+    get canAccept(): boolean;
+    get accepting(): boolean;
+    get declining(): boolean;
+    /** whether this request has sent it's initial event and needs more events to complete */
+    get pending(): boolean;
+    /** Only set after a .ready if the other party can scan a QR code
+     *
+     * @deprecated Prefer `generateQRCode`.
+     */
+    get qrCodeData(): QRCodeData | null;
+    /**
+     * Get the data for a QR code allowing the other device to verify this one, if it supports it.
+     *
+     * Only set after a .ready if the other party can scan a QR code, otherwise undefined.
+     *
+     * @deprecated Prefer `generateQRCode`.
+     */
+    getQRCodeBytes(): Buffer | undefined;
+    /**
+     * Generate the data for a QR code allowing the other device to verify this one, if it supports it.
+     *
+     * Only returns data once `phase` is `Ready` and the other party can scan a QR code;
+     * otherwise returns `undefined`.
+     */
+    generateQRCode(): Promise<Buffer | undefined>;
+    /** Checks whether the other party supports a given verification method.
+     *  This is useful when setting up the QR code UI, as it is somewhat asymmetrical:
+     *  if the other party supports SCAN_QR, we should show a QR code in the UI, and vice versa.
+     *  For methods that need to be supported by both ends, use the `methods` property.
+     *  @param method - the method to check
+     *  @param force - to check even if the phase is not ready or started yet, internal usage
+     *  @returns whether or not the other party said the supported the method */
+    otherPartySupportsMethod(method: string, force?: boolean): boolean;
+    /** Whether this request was initiated by the syncing user.
+     * For InRoomChannel, this is who sent the .request event.
+     * For ToDeviceChannel, this is who sent the .start event
+     */
+    get initiatedByMe(): boolean;
+    /** The id of the user that initiated the request */
+    get requestingUserId(): string;
+    /** The id of the user that (will) receive(d) the request */
+    get receivingUserId(): string;
+    /** The user id of the other party in this request */
+    get otherUserId(): string;
+    /** The device id of the other party in this request, for requests happening over to-device messages only. */
+    get otherDeviceId(): string | undefined;
+    get isSelfVerification(): boolean;
+    /**
+     * The id of the user that cancelled the request,
+     * only defined when phase is PHASE_CANCELLED
+     */
+    get cancellingUserId(): string | undefined;
+    /**
+     * The cancellation code e.g m.user which is responsible for cancelling this verification
+     */
+    get cancellationCode(): string;
+    get observeOnly(): boolean;
+    /**
+     * Gets which device the verification should be started with
+     * given the events sent so far in the verification. This is the
+     * same algorithm used to determine which device to send the
+     * verification to when no specific device is specified.
+     * @returns The device information
+     */
+    get targetDevice(): ITargetDevice;
+    beginKeyVerification(method: VerificationMethod, targetDevice?: ITargetDevice | null): VerificationBase<any, any>;
+    startVerification(method: string): Promise<Verifier>;
+    scanQRCode(qrCodeData: Uint8Array): Promise<Verifier>;
+    /**
+     * sends the initial .request event.
+     * @returns resolves when the event has been sent.
+     */
+    sendRequest(): Promise<void>;
+    /**
+     * Cancels the request, sending a cancellation to the other party
+     * @param params
+     * @param params.reason - the error reason to send the cancellation with
+     * @param params.code - the error code to send the cancellation with
+     * @returns resolves when the event has been sent.
+     */
+    cancel({ reason, code }?: {
+        reason?: string | undefined;
+        code?: string | undefined;
+    }): Promise<void>;
+    /**
+     * Accepts the request, sending a .ready event to the other party
+     * @returns resolves when the event has been sent.
+     */
+    accept(): Promise<void>;
+    /**
+     * Can be used to listen for state changes until the callback returns true.
+     * @param fn - callback to evaluate whether the request is in the desired state.
+     *                      Takes the request as an argument.
+     * @returns that resolves once the callback returns true
+     * @throws Error when the request is cancelled
+     */
+    waitFor(fn: (request: VerificationRequest) => boolean): Promise<VerificationRequest>;
+    private setPhase;
+    private getEventByEither;
+    private getEventBy;
+    private calculatePhaseTransitions;
+    private transitionToPhase;
+    private applyPhaseTransitions;
+    private isWinningStartRace;
+    hasEventId(eventId: string): boolean;
+    /**
+     * Changes the state of the request and verifier in response to a key verification event.
+     * @param type - the "symbolic" event type, as returned by the `getEventType` function on the channel.
+     * @param event - the event to handle. Don't call getType() on it but use the `type` parameter instead.
+     * @param isLiveEvent - whether this is an even received through sync or not
+     * @param isRemoteEcho - whether this is the remote echo of an event sent by the same device
+     * @param isSentByUs - whether this event is sent by a party that can accept and/or observe the request like one of our peers.
+     *   For InRoomChannel this means any device for the syncing user. For ToDeviceChannel, just the syncing device.
+     * @returns a promise that resolves when any requests as an answer to the passed-in event are sent.
+     */
+    handleEvent(type: string, event: MatrixEvent, isLiveEvent: boolean, isRemoteEcho: boolean, isSentByUs: boolean): Promise<void>;
+    private setupTimeout;
+    private cancelOnTimeout;
+    private cancelOnError;
+    private adjustObserveOnly;
+    private addEvent;
+    private createVerifier;
+    private wasSentByOwnUser;
+    private wasSentByOwnDevice;
+    onVerifierCancelled(): void;
+    onVerifierFinished(): void;
+    getEventFromOtherParty(type: string): MatrixEvent | undefined;
+}
+//# sourceMappingURL=VerificationRequest.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"VerificationRequest.d.ts","sourceRoot":"","sources":["../../../../src/crypto/verification/request/VerificationRequest.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,UAAU,EAAuB,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AACpD,OAAO,EAAE,iBAAiB,EAAE,MAAM,wCAAwC,CAAC;AAC3E,OAAO,EAEH,iBAAiB,IAAI,KAAK,EAC1B,mBAAmB,IAAI,oBAAoB,EAC3C,wBAAwB,EACxB,kCAAkC,EAClC,QAAQ,EACX,MAAM,qCAAqC,CAAC;AAG7C,OAAO,EAAE,iBAAiB,IAAI,KAAK,EAAE,wBAAwB,EAAE,MAAM,qCAAqC,CAAC;AAc3G,eAAO,MAAM,YAAY,wBAAwB,CAAC;AAClD,eAAO,MAAM,YAAY,QAA2B,CAAC;AACrD,eAAO,MAAM,UAAU,QAAyB,CAAC;AACjD,eAAO,MAAM,WAAW,QAA0B,CAAC;AACnD,eAAO,MAAM,SAAS,QAAwB,CAAC;AAC/C,eAAO,MAAM,UAAU,QAAyB,CAAC;AAGjD,eAAO,MAAM,YAAY,eAAe,CAAC;AACzC,eAAO,MAAM,eAAe,kBAAkB,CAAC;AAC/C,eAAO,MAAM,WAAW,cAAc,CAAC;AACvC,eAAO,MAAM,aAAa,gBAAgB,CAAC;AAC3C,eAAO,MAAM,eAAe,kBAAkB,CAAC;AAC/C,eAAO,MAAM,UAAU,aAAa,CAAC;AAErC,UAAU,aAAa;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAOD;;;;;;GAMG;AACH,qBAAa,mBAAmB,CAAC,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,CAClF,SAAQ,iBAAiB,CAAC,wBAAwB,EAAE,kCAAkC,CACtF,YAAW,oBAAoB;aA0BX,OAAO,EAAE,CAAC;IAC1B,OAAO,CAAC,QAAQ,CAAC,mBAAmB;IACpC,OAAO,CAAC,QAAQ,CAAC,MAAM;IA1B3B,OAAO,CAAC,UAAU,CAAkC;IACpD,OAAO,CAAC,YAAY,CAAkC;IACtD,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,YAAY,CAA8C;IAClE,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,aAAa,CAAmC;IAKxD,OAAO,CAAC,WAAW,CAA2B;IAG9C,OAAO,CAAC,iBAAiB,CAAuB;IAEhD,OAAO,CAAC,aAAa,CAA4B;IACjD,OAAO,CAAC,MAAM,CAAS;IAChB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAClC,OAAO,CAAC,SAAS,CAAC,CAA6B;gBAG3B,OAAO,EAAE,CAAC,EACT,mBAAmB,EAAE,GAAG,CAAC,kBAAkB,EAAE,OAAO,gBAAgB,CAAC,EACrE,MAAM,EAAE,YAAY;IAOzC;;;;;;;OAOG;WACW,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO;IA+B5F;;;;OAIG;IACH,IAAW,aAAa,IAAI,MAAM,GAAG,SAAS,CAE7C;IAED;;OAEG;IACH,IAAW,MAAM,IAAI,MAAM,GAAG,SAAS,CAEtC;IAED,IAAW,OAAO,IAAI,OAAO,CAE5B;IAED,mDAAmD;IACnD,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED,mDAAmD;IACnD,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED,+CAA+C;IAC/C,IAAW,KAAK,IAAI,OAAO,CAE1B;IAED,iDAAiD;IACjD,IAAW,OAAO,IAAI,OAAO,CAE5B;IAED,8CAA8C;IAC9C,IAAW,IAAI,IAAI,OAAO,CAEzB;IAED,kHAAkH;IAClH,IAAW,OAAO,IAAI,kBAAkB,EAAE,CAEzC;IAED,4CAA4C;IAC5C,IAAW,YAAY,IAAI,kBAAkB,GAAG,IAAI,CAEnD;IAEM,qBAAqB,CAAC,KAAK,EAAE,WAAW,GAAG,MAAM;IAWxD,8FAA8F;IAC9F,IAAW,OAAO,IAAI,MAAM,CAM3B;IAED;;;OAGG;IACH,IAAW,YAAY,IAAI,WAAW,GAAG,SAAS,CAEjD;IAED,8FAA8F;IAC9F,IAAW,KAAK,IAAI,KAAK,CAExB;IAED,wIAAwI;IACxI,IAAW,QAAQ,IAAI,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,SAAS,CAE5D;IAED,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED,IAAW,SAAS,IAAI,OAAO,CAE9B;IAED,yFAAyF;IACzF,IAAW,OAAO,IAAI,OAAO,CAE5B;IAED;;;OAGG;IACH,IAAW,UAAU,IAAI,UAAU,GAAG,IAAI,CAEzC;IAED;;;;;;OAMG;IACI,cAAc,IAAI,MAAM,GAAG,SAAS;IAI3C;;;;;OAKG;IACU,cAAc,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAI1D;;;;;;gFAM4E;IACrE,wBAAwB,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,UAAQ,GAAG,OAAO;IA6BvE;;;OAGG;IACH,IAAW,aAAa,IAAI,OAAO,CAoBlC;IAED,oDAAoD;IACpD,IAAW,gBAAgB,IAAI,MAAM,CAMpC;IAED,4DAA4D;IAC5D,IAAW,eAAe,IAAI,MAAM,CAMnC;IAED,qDAAqD;IACrD,IAAW,WAAW,IAAI,MAAM,CAE/B;IAED,6GAA6G;IAC7G,IAAW,aAAa,IAAI,MAAM,GAAG,SAAS,CAE7C;IAED,IAAW,kBAAkB,IAAI,OAAO,CAEvC;IAED;;;OAGG;IACH,IAAW,gBAAgB,IAAI,MAAM,GAAG,SAAS,CAWhD;IAED;;OAEG;IACH,IAAW,gBAAgB,IAAI,MAAM,CAGpC;IAED,IAAW,WAAW,IAAI,OAAO,CAEhC;IAED;;;;;;OAMG;IACH,IAAW,YAAY,IAAI,aAAa,CAWvC;IASM,oBAAoB,CACvB,MAAM,EAAE,kBAAkB,EAC1B,YAAY,GAAE,aAAa,GAAG,IAAW,GAC1C,gBAAgB,CAAC,GAAG,EAAE,GAAG,CAAC;IAuBhB,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAO1D,UAAU,CAAC,UAAU,EAAE,UAAU,GAAG,OAAO,CAAC,QAAQ,CAAC;IAI5D;;;OAGG;IACU,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;IAOzC;;;;;;OAMG;IACU,MAAM,CAAC,EAAE,MAAwB,EAAE,IAAe,EAAE;;;KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;IAatF;;;OAGG;IACU,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IASpC;;;;;;OAMG;IACI,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,OAAO,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAsB3F,OAAO,CAAC,QAAQ;IAOhB,OAAO,CAAC,gBAAgB;IAIxB,OAAO,CAAC,UAAU;IAQlB,OAAO,CAAC,yBAAyB;IAqDjC,OAAO,CAAC,iBAAiB;IAyCzB,OAAO,CAAC,qBAAqB;IAY7B,OAAO,CAAC,kBAAkB;IAoCnB,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;IAc3C;;;;;;;;;OASG;IACU,WAAW,CACpB,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,WAAW,EAClB,WAAW,EAAE,OAAO,EACpB,YAAY,EAAE,OAAO,EACrB,UAAU,EAAE,OAAO,GACpB,OAAO,CAAC,IAAI,CAAC;IAkFhB,OAAO,CAAC,YAAY;IAgBpB,OAAO,CAAC,eAAe,CAgBrB;YAEY,aAAa;IAyB3B,OAAO,CAAC,iBAAiB;IAUzB,OAAO,CAAC,QAAQ;IAoBhB,OAAO,CAAC,cAAc;IAkBtB,OAAO,CAAC,gBAAgB;IAKxB,OAAO,CAAC,kBAAkB;IAWnB,mBAAmB,IAAI,IAAI;IAS3B,kBAAkB,IAAI,IAAI;IAU1B,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW,GAAG,SAAS;CAGvE"}