85 lines
2.7 KiB
TypeScript
85 lines
2.7 KiB
TypeScript
/*
|
|
Copyright 2020 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.
|
|
*/
|
|
|
|
|
|
/**
|
|
* @property {object} event the plaintext event (type and content property)
|
|
* @property {string} senderCurve25519Key the curve25519 sender key of the olm event
|
|
* @property {string} claimedEd25519Key The ed25519 fingerprint key retrieved from the decryption payload.
|
|
* The sender of the olm event claims this is the ed25519 fingerprint key
|
|
* that matches the curve25519 sender key.
|
|
* The caller needs to check if this key does indeed match the senderKey
|
|
* for a device with a valid signature returned from /keys/query,
|
|
* see DeviceTracker
|
|
*/
|
|
|
|
import type {DeviceIdentity} from "../storage/idb/stores/DeviceIdentityStore";
|
|
|
|
type DecryptedEvent = {
|
|
type?: string,
|
|
content?: Record<string, any>
|
|
}
|
|
|
|
export class DecryptionResult {
|
|
private device?: DeviceIdentity;
|
|
private roomTracked: boolean = true;
|
|
|
|
constructor(
|
|
public readonly event: DecryptedEvent,
|
|
public readonly senderCurve25519Key: string,
|
|
public readonly claimedEd25519Key: string
|
|
) {}
|
|
|
|
setDevice(device: DeviceIdentity): void {
|
|
this.device = device;
|
|
}
|
|
|
|
setRoomNotTrackedYet(): void {
|
|
this.roomTracked = false;
|
|
}
|
|
|
|
get isVerified(): boolean {
|
|
if (this.device) {
|
|
const comesFromDevice = this.device.ed25519Key === this.claimedEd25519Key;
|
|
return comesFromDevice;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
get isUnverified(): boolean {
|
|
if (this.device) {
|
|
return !this.isVerified;
|
|
} else if (this.isVerificationUnknown) {
|
|
return false;
|
|
} else {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
get userId(): string | undefined {
|
|
return this.device?.userId;
|
|
}
|
|
|
|
get deviceId(): string | undefined {
|
|
return this.device?.deviceId;
|
|
}
|
|
|
|
get isVerificationUnknown(): boolean {
|
|
// verification is unknown if we haven't yet fetched the devices for the room
|
|
return !this.device && !this.roomTracked;
|
|
}
|
|
}
|