Johannes Marbach
05ba27f36b
* Change imports for Node.js compatibility Fixes: #4287 Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org> * Run prettier * Run prettier (again) * Add comment * Update babel.config.cjs --------- Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org> Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
977 lines
38 KiB
TypeScript
977 lines
38 KiB
TypeScript
/*
|
|
Copyright 2018 - 2021 The Matrix.org Foundation C.I.C.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
import { logger } from "../../../logger.ts";
|
|
import { errorFactory, errorFromEvent, newUnexpectedMessageError, newUnknownMethodError } from "../Error.ts";
|
|
import { QRCodeData, SCAN_QR_CODE_METHOD } from "../QRCode.ts";
|
|
import { IVerificationChannel } from "./Channel.ts";
|
|
import { MatrixClient } from "../../../client.ts";
|
|
import { MatrixEvent } from "../../../models/event.ts";
|
|
import { EventType } from "../../../@types/event.ts";
|
|
import { VerificationBase } from "../Base.ts";
|
|
import { VerificationMethod } from "../../index.ts";
|
|
import { TypedEventEmitter } from "../../../models/typed-event-emitter.ts";
|
|
import {
|
|
canAcceptVerificationRequest,
|
|
VerificationPhase as Phase,
|
|
VerificationRequest as IVerificationRequest,
|
|
VerificationRequestEvent,
|
|
VerificationRequestEventHandlerMap,
|
|
Verifier,
|
|
} from "../../../crypto-api/verification.ts";
|
|
|
|
// backwards-compatibility exports
|
|
export { VerificationPhase as Phase, VerificationRequestEvent } from "../../../crypto-api/verification.ts";
|
|
|
|
// How long after the event's timestamp that the request times out
|
|
const TIMEOUT_FROM_EVENT_TS = 10 * 60 * 1000; // 10 minutes
|
|
|
|
// How long after we receive the event that the request times out
|
|
const TIMEOUT_FROM_EVENT_RECEIPT = 2 * 60 * 1000; // 2 minutes
|
|
|
|
// to avoid almost expired verification notifications
|
|
// from showing a notification and almost immediately
|
|
// disappearing, also ignore verification requests that
|
|
// are this amount of time away from expiring.
|
|
const VERIFICATION_REQUEST_MARGIN = 3 * 1000; // 3 seconds
|
|
|
|
export const EVENT_PREFIX = "m.key.verification.";
|
|
export const REQUEST_TYPE = EVENT_PREFIX + "request";
|
|
export const START_TYPE = EVENT_PREFIX + "start";
|
|
export const CANCEL_TYPE = EVENT_PREFIX + "cancel";
|
|
export const DONE_TYPE = EVENT_PREFIX + "done";
|
|
export const READY_TYPE = EVENT_PREFIX + "ready";
|
|
|
|
// Legacy export fields
|
|
export const PHASE_UNSENT = Phase.Unsent;
|
|
export const PHASE_REQUESTED = Phase.Requested;
|
|
export const PHASE_READY = Phase.Ready;
|
|
export const PHASE_STARTED = Phase.Started;
|
|
export const PHASE_CANCELLED = Phase.Cancelled;
|
|
export const PHASE_DONE = Phase.Done;
|
|
|
|
interface ITargetDevice {
|
|
userId?: string;
|
|
deviceId?: string;
|
|
}
|
|
|
|
interface ITransition {
|
|
phase: Phase;
|
|
event?: MatrixEvent;
|
|
}
|
|
|
|
/**
|
|
* 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 class VerificationRequest<C extends IVerificationChannel = IVerificationChannel>
|
|
extends TypedEventEmitter<VerificationRequestEvent, VerificationRequestEventHandlerMap>
|
|
implements IVerificationRequest
|
|
{
|
|
private eventsByUs = new Map<string, MatrixEvent>();
|
|
private eventsByThem = new Map<string, MatrixEvent>();
|
|
private _observeOnly = false;
|
|
private timeoutTimer: ReturnType<typeof setTimeout> | null = null;
|
|
private _accepting = false;
|
|
private _declining = false;
|
|
private verifierHasFinished = false;
|
|
private _cancelled = false;
|
|
private _chosenMethod: VerificationMethod | null = null;
|
|
// we keep a copy of the QR Code data (including other user master key) around
|
|
// for QR reciprocate verification, to protect against
|
|
// cross-signing identity reset between the .ready and .start event
|
|
// and signing the wrong key after .start
|
|
private _qrCodeData: QRCodeData | null = null;
|
|
|
|
// The timestamp when we received the request event from the other side
|
|
private requestReceivedAt: number | null = null;
|
|
|
|
private commonMethods: VerificationMethod[] = [];
|
|
private _phase!: Phase;
|
|
public _cancellingUserId?: string; // Used in tests only
|
|
private _verifier?: VerificationBase<any, any>;
|
|
|
|
public constructor(
|
|
public readonly channel: C,
|
|
private readonly verificationMethods: Map<VerificationMethod, typeof VerificationBase>,
|
|
private readonly client: MatrixClient,
|
|
) {
|
|
super();
|
|
this.channel.request = this;
|
|
this.setPhase(PHASE_UNSENT, false);
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
public static validateEvent(type: string, event: MatrixEvent, client: MatrixClient): boolean {
|
|
const content = event.getContent();
|
|
|
|
if (!type || !type.startsWith(EVENT_PREFIX)) {
|
|
return false;
|
|
}
|
|
|
|
// 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 (!content) {
|
|
logger.log("VerificationRequest: validateEvent: no content");
|
|
return false;
|
|
}
|
|
|
|
if (type === REQUEST_TYPE || type === READY_TYPE) {
|
|
if (!Array.isArray(content.methods)) {
|
|
logger.log("VerificationRequest: validateEvent: " + "fail because methods");
|
|
return false;
|
|
}
|
|
}
|
|
|
|
if (type === REQUEST_TYPE || type === READY_TYPE || type === START_TYPE) {
|
|
if (typeof content.from_device !== "string" || content.from_device.length === 0) {
|
|
logger.log("VerificationRequest: validateEvent: " + "fail because from_device");
|
|
return false;
|
|
}
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
public get transactionId(): string | undefined {
|
|
return this.channel.transactionId;
|
|
}
|
|
|
|
/**
|
|
* For an in-room verification, the ID of the room.
|
|
*/
|
|
public get roomId(): string | undefined {
|
|
return this.channel.roomId;
|
|
}
|
|
|
|
public get invalid(): boolean {
|
|
return this.phase === PHASE_UNSENT;
|
|
}
|
|
|
|
/** returns whether the phase is PHASE_REQUESTED */
|
|
public get requested(): boolean {
|
|
return this.phase === PHASE_REQUESTED;
|
|
}
|
|
|
|
/** returns whether the phase is PHASE_CANCELLED */
|
|
public get cancelled(): boolean {
|
|
return this.phase === PHASE_CANCELLED;
|
|
}
|
|
|
|
/** returns whether the phase is PHASE_READY */
|
|
public get ready(): boolean {
|
|
return this.phase === PHASE_READY;
|
|
}
|
|
|
|
/** returns whether the phase is PHASE_STARTED */
|
|
public get started(): boolean {
|
|
return this.phase === PHASE_STARTED;
|
|
}
|
|
|
|
/** returns whether the phase is PHASE_DONE */
|
|
public get done(): boolean {
|
|
return this.phase === PHASE_DONE;
|
|
}
|
|
|
|
/** once the phase is PHASE_STARTED (and !initiatedByMe) or PHASE_READY: common methods supported by both sides */
|
|
public get methods(): VerificationMethod[] {
|
|
return this.commonMethods;
|
|
}
|
|
|
|
/** the method picked in the .start event */
|
|
public get chosenMethod(): VerificationMethod | null {
|
|
return this._chosenMethod;
|
|
}
|
|
|
|
public calculateEventTimeout(event: MatrixEvent): number {
|
|
let effectiveExpiresAt = this.channel.getTimestamp(event) + TIMEOUT_FROM_EVENT_TS;
|
|
|
|
if (this.requestReceivedAt && !this.initiatedByMe && this.phase <= PHASE_REQUESTED) {
|
|
const expiresAtByReceipt = this.requestReceivedAt + TIMEOUT_FROM_EVENT_RECEIPT;
|
|
effectiveExpiresAt = Math.min(effectiveExpiresAt, expiresAtByReceipt);
|
|
}
|
|
|
|
return Math.max(0, effectiveExpiresAt - Date.now());
|
|
}
|
|
|
|
/** The current remaining amount of ms before the request should be automatically cancelled */
|
|
public get timeout(): number {
|
|
const requestEvent = this.getEventByEither(REQUEST_TYPE);
|
|
if (requestEvent) {
|
|
return this.calculateEventTimeout(requestEvent);
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
/**
|
|
* The key verification request event.
|
|
* @returns The request event, or falsey if not found.
|
|
*/
|
|
public get requestEvent(): MatrixEvent | undefined {
|
|
return this.getEventByEither(REQUEST_TYPE);
|
|
}
|
|
|
|
/** current phase of the request. Some properties might only be defined in a current phase. */
|
|
public get phase(): Phase {
|
|
return this._phase;
|
|
}
|
|
|
|
/** The verifier to do the actual verification, once the method has been established. Only defined when the `phase` is PHASE_STARTED. */
|
|
public get verifier(): VerificationBase<any, any> | undefined {
|
|
return this._verifier;
|
|
}
|
|
|
|
public get canAccept(): boolean {
|
|
return canAcceptVerificationRequest(this);
|
|
}
|
|
|
|
public get accepting(): boolean {
|
|
return this._accepting;
|
|
}
|
|
|
|
public get declining(): boolean {
|
|
return this._declining;
|
|
}
|
|
|
|
/** whether this request has sent it's initial event and needs more events to complete */
|
|
public get pending(): boolean {
|
|
return !this.observeOnly && this._phase !== PHASE_DONE && this._phase !== PHASE_CANCELLED;
|
|
}
|
|
|
|
/** Only set after a .ready if the other party can scan a QR code
|
|
*
|
|
* @deprecated Prefer `generateQRCode`.
|
|
*/
|
|
public get qrCodeData(): QRCodeData | null {
|
|
return this._qrCodeData;
|
|
}
|
|
|
|
/**
|
|
* 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`.
|
|
*/
|
|
public getQRCodeBytes(): Buffer | undefined {
|
|
return this._qrCodeData?.getBuffer();
|
|
}
|
|
|
|
/**
|
|
* 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`.
|
|
*/
|
|
public async generateQRCode(): Promise<Buffer | undefined> {
|
|
return this.getQRCodeBytes();
|
|
}
|
|
|
|
/** 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 */
|
|
public otherPartySupportsMethod(method: string, force = false): boolean {
|
|
if (!force && !this.ready && !this.started) {
|
|
return false;
|
|
}
|
|
const theirMethodEvent = this.eventsByThem.get(REQUEST_TYPE) || this.eventsByThem.get(READY_TYPE);
|
|
if (!theirMethodEvent) {
|
|
// if we started straight away with .start event,
|
|
// we are assuming that the other side will support the
|
|
// chosen method, so return true for that.
|
|
if (this.started && this.initiatedByMe) {
|
|
const myStartEvent = this.eventsByUs.get(START_TYPE);
|
|
const content = myStartEvent && myStartEvent.getContent();
|
|
const myStartMethod = content && content.method;
|
|
return method == myStartMethod;
|
|
}
|
|
return false;
|
|
}
|
|
const content = theirMethodEvent.getContent();
|
|
if (!content) {
|
|
return false;
|
|
}
|
|
const { methods } = content;
|
|
if (!Array.isArray(methods)) {
|
|
return false;
|
|
}
|
|
|
|
return methods.includes(method);
|
|
}
|
|
|
|
/** 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
|
|
*/
|
|
public get initiatedByMe(): boolean {
|
|
// event created by us but no remote echo has been received yet
|
|
const noEventsYet = this.eventsByUs.size + this.eventsByThem.size === 0;
|
|
if (this._phase === PHASE_UNSENT && noEventsYet) {
|
|
return true;
|
|
}
|
|
const hasMyRequest = this.eventsByUs.has(REQUEST_TYPE);
|
|
const hasTheirRequest = this.eventsByThem.has(REQUEST_TYPE);
|
|
if (hasMyRequest && !hasTheirRequest) {
|
|
return true;
|
|
}
|
|
if (!hasMyRequest && hasTheirRequest) {
|
|
return false;
|
|
}
|
|
const hasMyStart = this.eventsByUs.has(START_TYPE);
|
|
const hasTheirStart = this.eventsByThem.has(START_TYPE);
|
|
if (hasMyStart && !hasTheirStart) {
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/** The id of the user that initiated the request */
|
|
public get requestingUserId(): string {
|
|
if (this.initiatedByMe) {
|
|
return this.client.getUserId()!;
|
|
} else {
|
|
return this.otherUserId;
|
|
}
|
|
}
|
|
|
|
/** The id of the user that (will) receive(d) the request */
|
|
public get receivingUserId(): string {
|
|
if (this.initiatedByMe) {
|
|
return this.otherUserId;
|
|
} else {
|
|
return this.client.getUserId()!;
|
|
}
|
|
}
|
|
|
|
/** The user id of the other party in this request */
|
|
public get otherUserId(): string {
|
|
return this.channel.userId!;
|
|
}
|
|
|
|
/** The device id of the other party in this request, for requests happening over to-device messages only. */
|
|
public get otherDeviceId(): string | undefined {
|
|
return this.channel.deviceId;
|
|
}
|
|
|
|
public get isSelfVerification(): boolean {
|
|
return this.client.getUserId() === this.otherUserId;
|
|
}
|
|
|
|
/**
|
|
* The id of the user that cancelled the request,
|
|
* only defined when phase is PHASE_CANCELLED
|
|
*/
|
|
public get cancellingUserId(): string | undefined {
|
|
const myCancel = this.eventsByUs.get(CANCEL_TYPE);
|
|
const theirCancel = this.eventsByThem.get(CANCEL_TYPE);
|
|
|
|
if (myCancel && (!theirCancel || myCancel.getId()! < theirCancel.getId()!)) {
|
|
return myCancel.getSender();
|
|
}
|
|
if (theirCancel) {
|
|
return theirCancel.getSender();
|
|
}
|
|
return undefined;
|
|
}
|
|
|
|
/**
|
|
* The cancellation code e.g m.user which is responsible for cancelling this verification
|
|
*/
|
|
public get cancellationCode(): string {
|
|
const ev = this.getEventByEither(CANCEL_TYPE);
|
|
return ev ? ev.getContent().code : null;
|
|
}
|
|
|
|
public get observeOnly(): boolean {
|
|
return this._observeOnly;
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
public get targetDevice(): ITargetDevice {
|
|
const theirFirstEvent =
|
|
this.eventsByThem.get(REQUEST_TYPE) ||
|
|
this.eventsByThem.get(READY_TYPE) ||
|
|
this.eventsByThem.get(START_TYPE);
|
|
const theirFirstContent = theirFirstEvent?.getContent();
|
|
const fromDevice = theirFirstContent?.from_device;
|
|
return {
|
|
userId: this.otherUserId,
|
|
deviceId: fromDevice,
|
|
};
|
|
}
|
|
|
|
/* Start the key verification, creating a verifier and sending a .start event.
|
|
* If no previous events have been sent, pass in `targetDevice` to set who to direct this request to.
|
|
* @param method - the name of the verification method to use.
|
|
* @param targetDevice.userId the id of the user to direct this request to
|
|
* @param targetDevice.deviceId the id of the device to direct this request to
|
|
* @returns the verifier of the given method
|
|
*/
|
|
public beginKeyVerification(
|
|
method: VerificationMethod,
|
|
targetDevice: ITargetDevice | null = null,
|
|
): VerificationBase<any, any> {
|
|
// need to allow also when unsent in case of to_device
|
|
if (!this.observeOnly && !this._verifier) {
|
|
const validStartPhase =
|
|
this.phase === PHASE_REQUESTED ||
|
|
this.phase === PHASE_READY ||
|
|
(this.phase === PHASE_UNSENT && this.channel.canCreateRequest(START_TYPE));
|
|
if (validStartPhase) {
|
|
// when called on a request that was initiated with .request event
|
|
// check the method is supported by both sides
|
|
if (this.commonMethods.length && !this.commonMethods.includes(method)) {
|
|
throw newUnknownMethodError();
|
|
}
|
|
this._verifier = this.createVerifier(method, null, targetDevice);
|
|
if (!this._verifier) {
|
|
throw newUnknownMethodError();
|
|
}
|
|
this._chosenMethod = method;
|
|
}
|
|
}
|
|
return this._verifier!;
|
|
}
|
|
|
|
public async startVerification(method: string): Promise<Verifier> {
|
|
const verifier = this.beginKeyVerification(method);
|
|
// kick off the verification in the background, but *don't* wait for to complete: we need to return the `Verifier`.
|
|
verifier.verify();
|
|
return verifier;
|
|
}
|
|
|
|
public scanQRCode(qrCodeData: Uint8Array): Promise<Verifier> {
|
|
throw new Error("QR code scanning not supported by legacy crypto");
|
|
}
|
|
|
|
/**
|
|
* sends the initial .request event.
|
|
* @returns resolves when the event has been sent.
|
|
*/
|
|
public async sendRequest(): Promise<void> {
|
|
if (!this.observeOnly && this._phase === PHASE_UNSENT) {
|
|
const methods = [...this.verificationMethods.keys()];
|
|
await this.channel.send(REQUEST_TYPE, { methods });
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
public async cancel({ reason = "User declined", code = "m.user" } = {}): Promise<void> {
|
|
if (!this.observeOnly && this._phase !== PHASE_CANCELLED) {
|
|
this._declining = true;
|
|
this.emit(VerificationRequestEvent.Change);
|
|
if (this._verifier) {
|
|
return this._verifier.cancel(errorFactory(code, reason)());
|
|
} else {
|
|
this._cancellingUserId = this.client.getUserId()!;
|
|
await this.channel.send(CANCEL_TYPE, { code, reason });
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Accepts the request, sending a .ready event to the other party
|
|
* @returns resolves when the event has been sent.
|
|
*/
|
|
public async accept(): Promise<void> {
|
|
if (!this.observeOnly && this.phase === PHASE_REQUESTED && !this.initiatedByMe) {
|
|
const methods = [...this.verificationMethods.keys()];
|
|
this._accepting = true;
|
|
this.emit(VerificationRequestEvent.Change);
|
|
await this.channel.send(READY_TYPE, { methods });
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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
|
|
*/
|
|
public waitFor(fn: (request: VerificationRequest) => boolean): Promise<VerificationRequest> {
|
|
return new Promise((resolve, reject) => {
|
|
const check = (): boolean => {
|
|
let handled = false;
|
|
if (fn(this)) {
|
|
resolve(this);
|
|
handled = true;
|
|
} else if (this.cancelled) {
|
|
reject(new Error("cancelled"));
|
|
handled = true;
|
|
}
|
|
if (handled) {
|
|
this.off(VerificationRequestEvent.Change, check);
|
|
}
|
|
return handled;
|
|
};
|
|
if (!check()) {
|
|
this.on(VerificationRequestEvent.Change, check);
|
|
}
|
|
});
|
|
}
|
|
|
|
private setPhase(phase: Phase, notify = true): void {
|
|
this._phase = phase;
|
|
if (notify) {
|
|
this.emit(VerificationRequestEvent.Change);
|
|
}
|
|
}
|
|
|
|
private getEventByEither(type: string): MatrixEvent | undefined {
|
|
return this.eventsByThem.get(type) || this.eventsByUs.get(type);
|
|
}
|
|
|
|
private getEventBy(type: string, byThem = false): MatrixEvent | undefined {
|
|
if (byThem) {
|
|
return this.eventsByThem.get(type);
|
|
} else {
|
|
return this.eventsByUs.get(type);
|
|
}
|
|
}
|
|
|
|
private calculatePhaseTransitions(): ITransition[] {
|
|
const transitions: ITransition[] = [{ phase: PHASE_UNSENT }];
|
|
const phase = (): Phase => transitions[transitions.length - 1].phase;
|
|
|
|
// always pass by .request first to be sure channel.userId has been set
|
|
const hasRequestByThem = this.eventsByThem.has(REQUEST_TYPE);
|
|
const requestEvent = this.getEventBy(REQUEST_TYPE, hasRequestByThem);
|
|
if (requestEvent) {
|
|
transitions.push({ phase: PHASE_REQUESTED, event: requestEvent });
|
|
}
|
|
|
|
const readyEvent = requestEvent && this.getEventBy(READY_TYPE, !hasRequestByThem);
|
|
if (readyEvent && phase() === PHASE_REQUESTED) {
|
|
transitions.push({ phase: PHASE_READY, event: readyEvent });
|
|
}
|
|
|
|
let startEvent: MatrixEvent | undefined;
|
|
if (readyEvent || !requestEvent) {
|
|
const theirStartEvent = this.eventsByThem.get(START_TYPE);
|
|
const ourStartEvent = this.eventsByUs.get(START_TYPE);
|
|
// any party can send .start after a .ready or unsent
|
|
if (theirStartEvent && ourStartEvent) {
|
|
startEvent =
|
|
theirStartEvent.getSender()! < ourStartEvent.getSender()! ? theirStartEvent : ourStartEvent;
|
|
} else {
|
|
startEvent = theirStartEvent ? theirStartEvent : ourStartEvent;
|
|
}
|
|
} else {
|
|
startEvent = this.getEventBy(START_TYPE, !hasRequestByThem);
|
|
}
|
|
if (startEvent) {
|
|
const fromRequestPhase =
|
|
phase() === PHASE_REQUESTED && requestEvent?.getSender() !== startEvent.getSender();
|
|
const fromUnsentPhase = phase() === PHASE_UNSENT && this.channel.canCreateRequest(START_TYPE);
|
|
if (fromRequestPhase || phase() === PHASE_READY || fromUnsentPhase) {
|
|
transitions.push({ phase: PHASE_STARTED, event: startEvent });
|
|
}
|
|
}
|
|
|
|
const ourDoneEvent = this.eventsByUs.get(DONE_TYPE);
|
|
if (this.verifierHasFinished || (ourDoneEvent && phase() === PHASE_STARTED)) {
|
|
transitions.push({ phase: PHASE_DONE });
|
|
}
|
|
|
|
const cancelEvent = this.getEventByEither(CANCEL_TYPE);
|
|
if ((this._cancelled || cancelEvent) && phase() !== PHASE_DONE) {
|
|
transitions.push({ phase: PHASE_CANCELLED, event: cancelEvent });
|
|
return transitions;
|
|
}
|
|
|
|
return transitions;
|
|
}
|
|
|
|
private transitionToPhase(transition: ITransition): void {
|
|
const { phase, event } = transition;
|
|
// get common methods
|
|
if (phase === PHASE_REQUESTED || phase === PHASE_READY) {
|
|
if (!this.wasSentByOwnDevice(event)) {
|
|
const content = event!.getContent<{
|
|
methods: string[];
|
|
}>();
|
|
this.commonMethods = content.methods.filter((m) => this.verificationMethods.has(m));
|
|
}
|
|
}
|
|
// detect if we're not a party in the request, and we should just observe
|
|
if (!this.observeOnly) {
|
|
// if requested or accepted by one of my other devices
|
|
if (phase === PHASE_REQUESTED || phase === PHASE_STARTED || phase === PHASE_READY) {
|
|
if (
|
|
this.channel.receiveStartFromOtherDevices &&
|
|
this.wasSentByOwnUser(event) &&
|
|
!this.wasSentByOwnDevice(event)
|
|
) {
|
|
this._observeOnly = true;
|
|
}
|
|
}
|
|
}
|
|
// create verifier
|
|
if (phase === PHASE_STARTED) {
|
|
const { method } = event!.getContent();
|
|
if (!this._verifier && !this.observeOnly) {
|
|
this._verifier = this.createVerifier(method, event);
|
|
if (!this._verifier) {
|
|
this.cancel({
|
|
code: "m.unknown_method",
|
|
reason: `Unknown method: ${method}`,
|
|
});
|
|
} else {
|
|
this._chosenMethod = method;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
private applyPhaseTransitions(): ITransition[] {
|
|
const transitions = this.calculatePhaseTransitions();
|
|
const existingIdx = transitions.findIndex((t) => t.phase === this.phase);
|
|
// trim off phases we already went through, if any
|
|
const newTransitions = transitions.slice(existingIdx + 1);
|
|
// transition to all new phases
|
|
for (const transition of newTransitions) {
|
|
this.transitionToPhase(transition);
|
|
}
|
|
return newTransitions;
|
|
}
|
|
|
|
private isWinningStartRace(newEvent: MatrixEvent): boolean {
|
|
if (newEvent.getType() !== START_TYPE) {
|
|
return false;
|
|
}
|
|
const oldEvent = this._verifier!.startEvent;
|
|
|
|
let oldRaceIdentifier;
|
|
if (this.isSelfVerification) {
|
|
// if the verifier does not have a startEvent,
|
|
// it is because it's still sending and we are on the initator side
|
|
// we know we are sending a .start event because we already
|
|
// have a verifier (checked in calling method)
|
|
if (oldEvent) {
|
|
const oldContent = oldEvent.getContent();
|
|
oldRaceIdentifier = oldContent && oldContent.from_device;
|
|
} else {
|
|
oldRaceIdentifier = this.client.getDeviceId();
|
|
}
|
|
} else {
|
|
if (oldEvent) {
|
|
oldRaceIdentifier = oldEvent.getSender();
|
|
} else {
|
|
oldRaceIdentifier = this.client.getUserId();
|
|
}
|
|
}
|
|
|
|
let newRaceIdentifier;
|
|
if (this.isSelfVerification) {
|
|
const newContent = newEvent.getContent();
|
|
newRaceIdentifier = newContent && newContent.from_device;
|
|
} else {
|
|
newRaceIdentifier = newEvent.getSender();
|
|
}
|
|
return newRaceIdentifier < oldRaceIdentifier;
|
|
}
|
|
|
|
public hasEventId(eventId: string): boolean {
|
|
for (const event of this.eventsByUs.values()) {
|
|
if (event.getId() === eventId) {
|
|
return true;
|
|
}
|
|
}
|
|
for (const event of this.eventsByThem.values()) {
|
|
if (event.getId() === eventId) {
|
|
return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* 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.
|
|
*/
|
|
public async handleEvent(
|
|
type: string,
|
|
event: MatrixEvent,
|
|
isLiveEvent: boolean,
|
|
isRemoteEcho: boolean,
|
|
isSentByUs: boolean,
|
|
): Promise<void> {
|
|
// if reached phase cancelled or done, ignore anything else that comes
|
|
if (this.done || this.cancelled) {
|
|
return;
|
|
}
|
|
const wasObserveOnly = this._observeOnly;
|
|
|
|
this.adjustObserveOnly(event, isLiveEvent);
|
|
|
|
if (!this.observeOnly && !isRemoteEcho) {
|
|
if (await this.cancelOnError(type, event)) {
|
|
return;
|
|
}
|
|
}
|
|
|
|
// This assumes verification won't need to send an event with
|
|
// the same type for the same party twice.
|
|
// This is true for QR and SAS verification, and was
|
|
// added here to prevent verification getting cancelled
|
|
// when the server duplicates an event (https://github.com/matrix-org/synapse/issues/3365)
|
|
const isDuplicateEvent = isSentByUs ? this.eventsByUs.has(type) : this.eventsByThem.has(type);
|
|
if (isDuplicateEvent) {
|
|
return;
|
|
}
|
|
|
|
const oldPhase = this.phase;
|
|
this.addEvent(type, event, isSentByUs);
|
|
|
|
// this will create if needed the verifier so needs to happen before calling it
|
|
const newTransitions = this.applyPhaseTransitions();
|
|
try {
|
|
// only pass events from the other side to the verifier,
|
|
// no remote echos of our own events
|
|
if (this._verifier && !this.observeOnly) {
|
|
const newEventWinsRace = this.isWinningStartRace(event);
|
|
if (this._verifier.canSwitchStartEvent(event) && newEventWinsRace) {
|
|
this._verifier.switchStartEvent(event);
|
|
} else if (!isRemoteEcho) {
|
|
if (type === CANCEL_TYPE || this._verifier.events?.includes(type)) {
|
|
this._verifier.handleEvent(event);
|
|
}
|
|
}
|
|
}
|
|
|
|
if (newTransitions.length) {
|
|
// create QRCodeData if the other side can scan
|
|
// important this happens before emitting a phase change,
|
|
// so listeners can rely on it being there already
|
|
// We only do this for live events because it is important that
|
|
// we sign the keys that were in the QR code, and not the keys
|
|
// we happen to have at some later point in time.
|
|
if (isLiveEvent && newTransitions.some((t) => t.phase === PHASE_READY)) {
|
|
const shouldGenerateQrCode = this.otherPartySupportsMethod(SCAN_QR_CODE_METHOD, true);
|
|
if (shouldGenerateQrCode) {
|
|
this._qrCodeData = await QRCodeData.create(this, this.client);
|
|
}
|
|
}
|
|
|
|
const lastTransition = newTransitions[newTransitions.length - 1];
|
|
const { phase } = lastTransition;
|
|
|
|
this.setupTimeout(phase);
|
|
// set phase as last thing as this emits the "change" event
|
|
this.setPhase(phase);
|
|
} else if (this._observeOnly !== wasObserveOnly) {
|
|
this.emit(VerificationRequestEvent.Change);
|
|
}
|
|
} finally {
|
|
// log events we processed so we can see from rageshakes what events were added to a request
|
|
logger.log(
|
|
`Verification request ${this.channel.transactionId}: ` +
|
|
`${type} event with id:${event.getId()}, ` +
|
|
`content:${JSON.stringify(event.getContent())} ` +
|
|
`deviceId:${this.channel.deviceId}, ` +
|
|
`sender:${event.getSender()}, isSentByUs:${isSentByUs}, ` +
|
|
`isLiveEvent:${isLiveEvent}, isRemoteEcho:${isRemoteEcho}, ` +
|
|
`phase:${oldPhase}=>${this.phase}, ` +
|
|
`observeOnly:${wasObserveOnly}=>${this._observeOnly}`,
|
|
);
|
|
}
|
|
}
|
|
|
|
private setupTimeout(phase: Phase): void {
|
|
const shouldTimeout = !this.timeoutTimer && !this.observeOnly && phase === PHASE_REQUESTED;
|
|
|
|
if (shouldTimeout) {
|
|
this.timeoutTimer = setTimeout(this.cancelOnTimeout, this.timeout);
|
|
}
|
|
if (this.timeoutTimer) {
|
|
const shouldClear =
|
|
phase === PHASE_STARTED || phase === PHASE_READY || phase === PHASE_DONE || phase === PHASE_CANCELLED;
|
|
if (shouldClear) {
|
|
clearTimeout(this.timeoutTimer);
|
|
this.timeoutTimer = null;
|
|
}
|
|
}
|
|
}
|
|
|
|
private cancelOnTimeout = async (): Promise<void> => {
|
|
try {
|
|
if (this.initiatedByMe) {
|
|
await this.cancel({
|
|
reason: "Other party didn't accept in time",
|
|
code: "m.timeout",
|
|
});
|
|
} else {
|
|
await this.cancel({
|
|
reason: "User didn't accept in time",
|
|
code: "m.timeout",
|
|
});
|
|
}
|
|
} catch (err) {
|
|
logger.error("Error while cancelling verification request", err);
|
|
}
|
|
};
|
|
|
|
private async cancelOnError(type: string, event: MatrixEvent): Promise<boolean> {
|
|
if (type === START_TYPE) {
|
|
const method = event.getContent().method;
|
|
if (!this.verificationMethods.has(method)) {
|
|
await this.cancel(errorFromEvent(newUnknownMethodError()));
|
|
return true;
|
|
}
|
|
}
|
|
|
|
const isUnexpectedRequest = type === REQUEST_TYPE && this.phase !== PHASE_UNSENT;
|
|
const isUnexpectedReady = type === READY_TYPE && this.phase !== PHASE_REQUESTED && this.phase !== PHASE_STARTED;
|
|
// only if phase has passed from PHASE_UNSENT should we cancel, because events
|
|
// are allowed to come in in any order (at least with InRoomChannel). So we only know
|
|
// we're dealing with a valid request we should participate in once we've moved to PHASE_REQUESTED.
|
|
// Before that, we could be looking at somebody else's verification request and we just
|
|
// happen to be in the room
|
|
if (this.phase !== PHASE_UNSENT && (isUnexpectedRequest || isUnexpectedReady)) {
|
|
logger.warn(`Cancelling, unexpected ${type} verification ` + `event from ${event.getSender()}`);
|
|
const reason = `Unexpected ${type} event in phase ${this.phase}`;
|
|
await this.cancel(errorFromEvent(newUnexpectedMessageError({ reason })));
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
private adjustObserveOnly(event: MatrixEvent, isLiveEvent = false): void {
|
|
// don't send out events for historical requests
|
|
if (!isLiveEvent) {
|
|
this._observeOnly = true;
|
|
}
|
|
if (this.calculateEventTimeout(event) < VERIFICATION_REQUEST_MARGIN) {
|
|
this._observeOnly = true;
|
|
}
|
|
}
|
|
|
|
private addEvent(type: string, event: MatrixEvent, isSentByUs = false): void {
|
|
if (isSentByUs) {
|
|
this.eventsByUs.set(type, event);
|
|
} else {
|
|
this.eventsByThem.set(type, event);
|
|
}
|
|
|
|
// once we know the userId of the other party (from the .request event)
|
|
// see if any event by anyone else crept into this.eventsByThem
|
|
if (type === REQUEST_TYPE) {
|
|
for (const [type, event] of this.eventsByThem.entries()) {
|
|
if (event.getSender() !== this.otherUserId) {
|
|
this.eventsByThem.delete(type);
|
|
}
|
|
}
|
|
// also remember when we received the request event
|
|
this.requestReceivedAt = Date.now();
|
|
}
|
|
}
|
|
|
|
private createVerifier(
|
|
method: VerificationMethod,
|
|
startEvent: MatrixEvent | null = null,
|
|
targetDevice: ITargetDevice | null = null,
|
|
): VerificationBase<any, any> | undefined {
|
|
if (!targetDevice) {
|
|
targetDevice = this.targetDevice;
|
|
}
|
|
const { userId, deviceId } = targetDevice;
|
|
|
|
const VerifierCtor = this.verificationMethods.get(method);
|
|
if (!VerifierCtor) {
|
|
logger.warn("could not find verifier constructor for method", method);
|
|
return;
|
|
}
|
|
return new VerifierCtor(this.channel, this.client, userId!, deviceId!, startEvent, this);
|
|
}
|
|
|
|
private wasSentByOwnUser(event?: MatrixEvent): boolean {
|
|
return event?.getSender() === this.client.getUserId();
|
|
}
|
|
|
|
// only for .request, .ready or .start
|
|
private wasSentByOwnDevice(event?: MatrixEvent): boolean {
|
|
if (!this.wasSentByOwnUser(event)) {
|
|
return false;
|
|
}
|
|
const content = event!.getContent();
|
|
if (!content || content.from_device !== this.client.getDeviceId()) {
|
|
return false;
|
|
}
|
|
return true;
|
|
}
|
|
|
|
public onVerifierCancelled(): void {
|
|
this._cancelled = true;
|
|
// move to cancelled phase
|
|
const newTransitions = this.applyPhaseTransitions();
|
|
if (newTransitions.length) {
|
|
this.setPhase(newTransitions[newTransitions.length - 1].phase);
|
|
}
|
|
}
|
|
|
|
public onVerifierFinished(): void {
|
|
this.channel.send(EventType.KeyVerificationDone, {});
|
|
this.verifierHasFinished = true;
|
|
// move to .done phase
|
|
const newTransitions = this.applyPhaseTransitions();
|
|
if (newTransitions.length) {
|
|
this.setPhase(newTransitions[newTransitions.length - 1].phase);
|
|
}
|
|
}
|
|
|
|
public getEventFromOtherParty(type: string): MatrixEvent | undefined {
|
|
return this.eventsByThem.get(type);
|
|
}
|
|
}
|