Add isEncryptedDisabledForUnverifiedDevices properties to event

Author: florianduros

spec/unit/models/event.spec.ts

@@ -126,11 +126,10 @@ describe("MatrixEvent", () => {
             expect(encryptedEvent.isEncrypted()).toBeTruthy();
             expect(encryptedEvent.isBeingDecrypted()).toBeFalsy();
             expect(encryptedEvent.isDecryptionFailure()).toBeTruthy();
-            expect(encryptedEvent.isEncryptedDisabledForUnverifiedDevices()).toBeFalsy();
+            expect(encryptedEvent.isEncryptedDisabledForUnverifiedDevices).toBeFalsy();
             expect(encryptedEvent.getContent()).toEqual({
                 msgtype: "m.bad.encrypted",
                 body: "** Unable to decrypt: Error: test error **",
-                reason: "Error: test error",
             });
         });
 
@@ -145,11 +144,10 @@ describe("MatrixEvent", () => {
             expect(encryptedEvent.isEncrypted()).toBeTruthy();
             expect(encryptedEvent.isBeingDecrypted()).toBeFalsy();
             expect(encryptedEvent.isDecryptionFailure()).toBeTruthy();
-            expect(encryptedEvent.isEncryptedDisabledForUnverifiedDevices()).toBeTruthy();
+            expect(encryptedEvent.isEncryptedDisabledForUnverifiedDevices).toBeTruthy();
             expect(encryptedEvent.getContent()).toEqual({
                 msgtype: "m.bad.encrypted",
                 body: "** Unable to decrypt: DecryptionError: The sender has disabled encrypting to unverified devices. **",
-                reason: "DecryptionError: The sender has disabled encrypting to unverified devices.",
             });
         });
 

src/@types/crypto.ts

@@ -44,6 +44,10 @@ export interface IEventDecryptionResult {
      */
     claimedEd25519Key?: string;
     untrusted?: boolean;
+    /**
+     * The sender doesn't authorize the unverified devices to decrypt his messages
+     */
+    isEncryptedDisabledForUnverifiedDevices?: boolean;
 }
 
 interface Extensible {

src/models/event.ts

@@ -324,6 +324,12 @@ export class MatrixEvent extends TypedEventEmitter<MatrixEventEmittedEvents, Mat
      */
     public verificationRequest?: VerificationRequest;
 
+    /*
+     * True if this event is an encrypted event which we failed to decrypt, the receiver's device is unverified and
+     * the sender has disabled encrypting to unverified devices.
+     */
+    public isEncryptedDisabledForUnverifiedDevices = false;
+
     private readonly reEmitter: TypedReEmitter<MatrixEventEmittedEvents, MatrixEventHandlerMap>;
 
     /**
@@ -704,22 +710,6 @@ export class MatrixEvent extends TypedEventEmitter<MatrixEventEmittedEvents, Mat
         return this.clearEvent?.content?.msgtype === "m.bad.encrypted";
     }
 
-    /**
-     * Check if this event is an encrypted event which we failed to decrypt, the receiver's device is unverified and
-     * the sender has disabled encrypting to unverified devices.
-     *
-     * (This implies that we might retry decryption at some point in the future)
-     *
-     * @returns boolean
-     */
-    public isEncryptedDisabledForUnverifiedDevices(): boolean {
-        return (
-            this.isDecryptionFailure() &&
-            this.clearEvent?.content?.reason ===
-                "DecryptionError: The sender has disabled encrypting to unverified devices."
-        );
-    }
-
     public shouldAttemptDecryption(): boolean {
         if (this.isRedacted()) return false;
         if (this.isBeingDecrypted()) return false;
@@ -913,9 +903,10 @@ export class MatrixEvent extends TypedEventEmitter<MatrixEventEmittedEvents, Mat
                 content: {
                     msgtype: "m.bad.encrypted",
                     body: "** Unable to decrypt: " + reason + " **",
-                    reason,
                 },
             },
+            isEncryptedDisabledForUnverifiedDevices:
+                reason === "DecryptionError: The sender has disabled encrypting to unverified devices.",
         };
     }
 
@@ -937,6 +928,8 @@ export class MatrixEvent extends TypedEventEmitter<MatrixEventEmittedEvents, Mat
         this.claimedEd25519Key = decryptionResult.claimedEd25519Key ?? null;
         this.forwardingCurve25519KeyChain = decryptionResult.forwardingCurve25519KeyChain || [];
         this.untrusted = decryptionResult.untrusted || false;
+        this.isEncryptedDisabledForUnverifiedDevices =
+            decryptionResult.isEncryptedDisabledForUnverifiedDevices || false;
         this.invalidateExtensibleEvent();
     }