mirrors/vector-im-hydrogen-web
1
0
Fork 0
mirror of https://github.com/vector-im/hydrogen-web.git synced 2024-11-20 03:25:52 +01:00
Code Issues Projects Releases Wiki Activity

Refactor to avoid passing crosssigning

Browse Source
This commit is contained in:
RMidhunSuresh 2023-04-10 19:44:44 +05:30
parent 1f2e8332fe
commit 660db4ced3
5 changed files with 47 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/domain/session/verification/DeviceVerificationViewModel.ts
View File

@ -55,7 +55,7 @@ export class DeviceVerificationViewModel extends ErrorReportViewModel<SegmentTyp
if (typeof requestOrUserId === "string") { if (typeof requestOrUserId === "string") {
this.updateCurrentStageViewModel(new WaitingForOtherUserViewModel(this.childOptions({ sas: this.sas }))); this.updateCurrentStageViewModel(new WaitingForOtherUserViewModel(this.childOptions({ sas: this.sas })));
} }
return this.sas.start(); return crossSigning.signDevice(this.sas, log);
}); });
} }

23
src/matrix/verification/CrossSigning.ts
View File

@ -78,6 +78,11 @@ enum MSKVerification {
Valid Valid
} }
export interface IVerificationMethod {
verify(): Promise<boolean>;
otherDeviceId: string;
}
export class CrossSigning { export class CrossSigning {
private readonly storage: Storage; private readonly storage: Storage;
private readonly secretStorage: SecretStorage; private readonly secretStorage: SecretStorage;
@ -202,7 +207,6 @@ export class CrossSigning {
deviceTracker: this.deviceTracker, deviceTracker: this.deviceTracker,
hsApi: this.hsApi, hsApi: this.hsApi,
clock: this.platform.clock, clock: this.platform.clock,
crossSigning: this,
}); });
return this.sasVerificationInProgress; return this.sasVerificationInProgress;
} }
@ -249,13 +253,19 @@ export class CrossSigning {
} }
/** @return the signed device key for the given device id */ /** @return the signed device key for the given device id */
async signDevice(deviceId: string, log: ILogItem): Promise<DeviceKey | undefined> { async signDevice(verification: IVerificationMethod, log: ILogItem): Promise<DeviceKey | undefined> {
return log.wrap("CrossSigning.signDevice", async log => { return log.wrap("CrossSigning.signDevice", async log => {
log.set("id", deviceId);
if (!this._isMasterKeyTrusted) { if (!this._isMasterKeyTrusted) {
log.set("mskNotTrusted", true); log.set("mskNotTrusted", true);
return; return;
} }
const shouldSign = await verification.verify();
log.set("shouldSign", shouldSign);
if (!shouldSign) {
return;
}
const deviceId = verification.otherDeviceId;
log.set("id", deviceId);
const keyToSign = await this.deviceTracker.deviceForId(this.ownUserId, deviceId, this.hsApi, log); const keyToSign = await this.deviceTracker.deviceForId(this.ownUserId, deviceId, this.hsApi, log);
if (!keyToSign) { if (!keyToSign) {
return undefined; return undefined;
@ -266,7 +276,7 @@ export class CrossSigning {
} }
/** @return the signed MSK for the given user id */ /** @return the signed MSK for the given user id */
async signUser(userId: string, log: ILogItem): Promise<CrossSigningKey | undefined> { async signUser(userId: string, verification: IVerificationMethod, log: ILogItem): Promise<CrossSigningKey | undefined> {
return log.wrap("CrossSigning.signUser", async log => { return log.wrap("CrossSigning.signUser", async log => {
log.set("id", userId); log.set("id", userId);
if (!this._isMasterKeyTrusted) { if (!this._isMasterKeyTrusted) {
@ -277,6 +287,11 @@ export class CrossSigning {
if (userId === this.ownUserId) { if (userId === this.ownUserId) {
return; return;
} }
const shouldSign = await verification.verify();
log.set("shouldSign", shouldSign);
if (!shouldSign) {
return;
}
const keyToSign = await this.deviceTracker.getCrossSigningKeyForUser(userId, KeyUsage.Master, this.hsApi, log); const keyToSign = await this.deviceTracker.getCrossSigningKeyForUser(userId, KeyUsage.Master, this.hsApi, log);
if (!keyToSign) { if (!keyToSign) {
return; return;

52
src/matrix/verification/SAS/SASVerification.ts
View File

@ -23,13 +23,13 @@ import type {IChannel} from "./channel/IChannel";
import type {HomeServerApi} from "../../net/HomeServerApi"; import type {HomeServerApi} from "../../net/HomeServerApi";
import type {Timeout} from "../../../platform/types/types"; import type {Timeout} from "../../../platform/types/types";
import type {Clock} from "../../../platform/web/dom/Clock.js"; import type {Clock} from "../../../platform/web/dom/Clock.js";
import type {IVerificationMethod} from "../CrossSigning";
import {CancelReason, VerificationEventType} from "./channel/types"; import {CancelReason, VerificationEventType} from "./channel/types";
import {SendReadyStage} from "./stages/SendReadyStage"; import {SendReadyStage} from "./stages/SendReadyStage";
import {SelectVerificationMethodStage} from "./stages/SelectVerificationMethodStage"; import {SelectVerificationMethodStage} from "./stages/SelectVerificationMethodStage";
import {VerificationCancelledError} from "./VerificationCancelledError"; import {VerificationCancelledError} from "./VerificationCancelledError";
import {EventEmitter} from "../../../utils/EventEmitter"; import {EventEmitter} from "../../../utils/EventEmitter";
import {SASProgressEvents} from "./types"; import {SASProgressEvents} from "./types";
import type {CrossSigning} from "../CrossSigning";
type Olm = typeof OlmNamespace; type Olm = typeof OlmNamespace;
@ -45,10 +45,9 @@ type Options = {
deviceTracker: DeviceTracker; deviceTracker: DeviceTracker;
hsApi: HomeServerApi; hsApi: HomeServerApi;
clock: Clock; clock: Clock;
crossSigning: CrossSigning
} }
export class SASVerification extends EventEmitter<SASProgressEvents> { export class SASVerification extends EventEmitter<SASProgressEvents> implements IVerificationMethod {
private startStage: BaseSASVerificationStage; private startStage: BaseSASVerificationStage;
private olmSas: Olm.SAS; private olmSas: Olm.SAS;
public finished: boolean = false; public finished: boolean = false;
@ -74,7 +73,7 @@ export class SASVerification extends EventEmitter<SASProgressEvents> {
} }
} }
private async setupCancelAfterTimeout(clock: Clock) { private async setupCancelAfterTimeout(clock: Clock): Promise<void> {
try { try {
const tenMinutes = 10 * 60 * 1000; const tenMinutes = 10 * 60 * 1000;
this.timeout = clock.createTimeout(tenMinutes); this.timeout = clock.createTimeout(tenMinutes);
@ -86,11 +85,12 @@ export class SASVerification extends EventEmitter<SASProgressEvents> {
} }
} }
async abort() { async abort(): Promise<void> {
await this.channel.cancelVerification(CancelReason.UserCancelled); await this.channel.cancelVerification(CancelReason.UserCancelled);
} }
async start() { async verify(): Promise<boolean> {
let success = true;
try { try {
let stage = this.startStage; let stage = this.startStage;
do { do {
@ -102,6 +102,7 @@ export class SASVerification extends EventEmitter<SASProgressEvents> {
if (!(e instanceof VerificationCancelledError)) { if (!(e instanceof VerificationCancelledError)) {
throw e; throw e;
} }
success = false;
} }
finally { finally {
if (this.channel.isCancelled) { if (this.channel.isCancelled) {
@ -111,6 +112,11 @@ export class SASVerification extends EventEmitter<SASProgressEvents> {
this.timeout.abort(); this.timeout.abort();
this.finished = true; this.finished = true;
} }
return success;
}
get otherDeviceId(): string {
return this.channel.otherUserDeviceId;
} }
} }
@ -189,7 +195,6 @@ export function tests() {
olm, olm,
startingMessage, startingMessage,
); );
const crossSigning = new MockCrossSigning() as unknown as CrossSigning;
const clock = new MockClock(); const clock = new MockClock();
const logger = new NullLogger(); const logger = new NullLogger();
return logger.run("log", (log) => { return logger.run("log", (log) => {
@ -207,7 +212,6 @@ export function tests() {
ourUserId, ourUserId,
ourUserDeviceId: ourDeviceId, ourUserDeviceId: ourDeviceId,
log, log,
crossSigning
}); });
// @ts-ignore // @ts-ignore
channel.setOlmSas(sas.olmSas); channel.setOlmSas(sas.olmSas);
@ -218,16 +222,6 @@ export function tests() {
}); });
} }
class MockCrossSigning {
signDevice(deviceId: string, log: ILogItem) {
return Promise.resolve({}); // device keys, means signing succeeded
}
signUser(userId: string, log: ILogItem) {
return Promise.resolve({}); // cross-signing keys, means signing succeeded
}
}
return { return {
"Order of stages created matches expected order when I sent request, they sent start": async (assert) => { "Order of stages created matches expected order when I sent request, they sent start": async (assert) => {
const ourDeviceId = "ILQHOACESQ"; const ourDeviceId = "ILQHOACESQ";
@ -247,7 +241,7 @@ export function tests() {
txnId, txnId,
receivedMessages receivedMessages
); );
await sas.start(); await sas.verify();
const expectedOrder = [ const expectedOrder = [
SendRequestVerificationStage, SendRequestVerificationStage,
SelectVerificationMethodStage, SelectVerificationMethodStage,
@ -289,7 +283,7 @@ export function tests() {
await stage?.selectEmojiMethod(log); await stage?.selectEmojiMethod(log);
}); });
}); });
await sas.start(); await sas.verify();
const expectedOrder = [ const expectedOrder = [
SendRequestVerificationStage, SendRequestVerificationStage,
SelectVerificationMethodStage, SelectVerificationMethodStage,
@ -326,7 +320,7 @@ export function tests() {
receivedMessages, receivedMessages,
startingMessage, startingMessage,
); );
await sas.start(); await sas.verify();
const expectedOrder = [ const expectedOrder = [
SelectVerificationMethodStage, SelectVerificationMethodStage,
SendAcceptVerificationStage, SendAcceptVerificationStage,
@ -364,7 +358,7 @@ export function tests() {
txnId, txnId,
receivedMessages receivedMessages
); );
await sas.start(); await sas.verify();
const expectedOrder = [ const expectedOrder = [
SendRequestVerificationStage, SendRequestVerificationStage,
SelectVerificationMethodStage, SelectVerificationMethodStage,
@ -408,7 +402,7 @@ export function tests() {
await stage?.selectEmojiMethod(log); await stage?.selectEmojiMethod(log);
}); });
}); });
await sas.start(); await sas.verify();
const expectedOrder = [ const expectedOrder = [
SendRequestVerificationStage, SendRequestVerificationStage,
SelectVerificationMethodStage, SelectVerificationMethodStage,
@ -448,7 +442,7 @@ export function tests() {
receivedMessages, receivedMessages,
startingMessage, startingMessage,
); );
await sas.start(); await sas.verify();
const expectedOrder = [ const expectedOrder = [
SelectVerificationMethodStage, SelectVerificationMethodStage,
SendAcceptVerificationStage, SendAcceptVerificationStage,
@ -494,7 +488,7 @@ export function tests() {
await stage?.selectEmojiMethod(log); await stage?.selectEmojiMethod(log);
}); });
}); });
await sas.start(); await sas.verify();
const expectedOrder = [ const expectedOrder = [
SelectVerificationMethodStage, SelectVerificationMethodStage,
SendKeyStage, SendKeyStage,
@ -537,7 +531,7 @@ export function tests() {
await stage?.selectEmojiMethod(log); await stage?.selectEmojiMethod(log);
}); });
}); });
await sas.start(); await sas.verify();
const expectedOrder = [ const expectedOrder = [
SendRequestVerificationStage, SendRequestVerificationStage,
SelectVerificationMethodStage, SelectVerificationMethodStage,
@ -575,7 +569,7 @@ export function tests() {
txnId, txnId,
receivedMessages receivedMessages
); );
await sas.start(); await sas.verify();
const expectedOrder = [ const expectedOrder = [
SendRequestVerificationStage, SendRequestVerificationStage,
SelectVerificationMethodStage, SelectVerificationMethodStage,
@ -613,7 +607,7 @@ export function tests() {
txnId, txnId,
receivedMessages receivedMessages
); );
const promise = sas.start(); const promise = sas.verify();
clock.elapse(10 * 60 * 1000); clock.elapse(10 * 60 * 1000);
try { try {
await promise; await promise;
@ -643,7 +637,7 @@ export function tests() {
receivedMessages receivedMessages
); );
try { try {
await sas.start() await sas.verify()
} }
catch (e) { catch (e) {
assert.strictEqual(e instanceof VerificationCancelledError, true); assert.strictEqual(e instanceof VerificationCancelledError, true);

2
src/matrix/verification/SAS/stages/BaseSASVerificationStage.ts
View File

@ -16,7 +16,6 @@ limitations under the License.
import type {ILogItem} from "../../../../logging/types"; import type {ILogItem} from "../../../../logging/types";
import type {Account} from "../../../e2ee/Account.js"; import type {Account} from "../../../e2ee/Account.js";
import type {DeviceTracker} from "../../../e2ee/DeviceTracker.js"; import type {DeviceTracker} from "../../../e2ee/DeviceTracker.js";
import type {CrossSigning} from "../../CrossSigning";
import {IChannel} from "../channel/IChannel"; import {IChannel} from "../channel/IChannel";
import {HomeServerApi} from "../../../net/HomeServerApi"; import {HomeServerApi} from "../../../net/HomeServerApi";
import {SASProgressEvents} from "../types"; import {SASProgressEvents} from "../types";
@ -34,7 +33,6 @@ export type Options = {
deviceTracker: DeviceTracker; deviceTracker: DeviceTracker;
hsApi: HomeServerApi; hsApi: HomeServerApi;
eventEmitter: EventEmitter<SASProgressEvents> eventEmitter: EventEmitter<SASProgressEvents>
crossSigning: CrossSigning
} }
export abstract class BaseSASVerificationStage { export abstract class BaseSASVerificationStage {

14
src/matrix/verification/SAS/stages/VerifyMacStage.ts
View File

@ -68,11 +68,8 @@ export class VerifyMacStage extends BaseSASVerificationStage {
const deviceIdOrMSK = keyId.split(":", 2)[1]; const deviceIdOrMSK = keyId.split(":", 2)[1];
const device = await this.deviceTracker.deviceForId(userId, deviceIdOrMSK, this.hsApi, log); const device = await this.deviceTracker.deviceForId(userId, deviceIdOrMSK, this.hsApi, log);
if (device) { if (device) {
if (verifier(keyId, getDeviceEd25519Key(device), keyInfo)) { if (!verifier(keyId, getDeviceEd25519Key(device), keyInfo)) {
await log.wrap("signing device", async log => { throw new Error(`MAC verification failed for key ${keyInfo}`);
const signedKey = await this.options.crossSigning.signDevice(device.device_id, log);
log.set("success", !!signedKey);
});
} }
} else { } else {
// If we were not able to find the device, then deviceIdOrMSK is actually the MSK! // If we were not able to find the device, then deviceIdOrMSK is actually the MSK!
@ -82,11 +79,8 @@ export class VerifyMacStage extends BaseSASVerificationStage {
throw new Error("Fetching MSK for user failed!"); throw new Error("Fetching MSK for user failed!");
} }
const masterKey = getKeyEd25519Key(key); const masterKey = getKeyEd25519Key(key);
if(masterKey && verifier(keyId, masterKey, keyInfo)) { if(!(masterKey && verifier(keyId, masterKey, keyInfo))) {
await log.wrap("signing user", async log => { throw new Error(`MAC verification failed for key ${keyInfo}`);
const signedKey = await this.options.crossSigning.signUser(userId, log);
log.set("success", !!signedKey);
});
} }
} }
} }