Log & expose device ID and identity at startup for visibility (#374)

* Log & expose device ID and identity at startup for visibility * appease the linter * copy/paste more test * force-set device ID
turt2live · Jan 27, 2025 · 9d63bfd · 9d63bfd
1 parent 6174c38
commit 9d63bfd
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 1 deletion.
diff --git a/src/e2ee/CryptoClient.ts b/src/e2ee/CryptoClient.ts
@@ -55,6 +55,13 @@ export class CryptoClient {
         return this.deviceId;
     }
 
+    /**
+     * The device's Ed25519 identity
+     */
+    public get clientDeviceEd25519(): string {
+        return this.deviceEd25519;
+    }
+
     /**
      * Whether or not the crypto client is ready to be used. If not ready, prepare() should be called.
      * @see prepare
@@ -84,7 +91,7 @@ export class CryptoClient {
             await this.client.cryptoStore.setDeviceId(this.deviceId);
         }
 
-        LogService.debug("CryptoClient", "Starting with device ID:", this.deviceId);
+        LogService.info("CryptoClient", "Starting with device ID:", this.deviceId); // info so all bots know for debugging
 
         const machine = await OlmMachine.initialize(
             new UserId(await this.client.getUserId()),
@@ -99,6 +106,8 @@ export class CryptoClient {
         this.deviceCurve25519 = identity.curve25519.toBase64();
         this.deviceEd25519 = identity.ed25519.toBase64();
 
+        LogService.debug("CryptoClient", "Running with device Ed25519 identity:", this.deviceEd25519); // info so all bots know for debugging
+
         this.ready = true;
     }
 

diff --git a/test/encryption/CryptoClientTest.ts b/test/encryption/CryptoClientTest.ts
@@ -83,6 +83,19 @@ describe('CryptoClient', () => {
             expect(whoamiSpy.callCount).toEqual(0);
             expect(client.crypto.clientDeviceId).toEqual(TEST_DEVICE_ID);
         }));
+
+        it('should expose the device Ed25519 identity', () => testCryptoStores(async (cryptoStoreType) => {
+            const userId = "@alice:example.org";
+            const { client, http } = createTestClient(null, userId, cryptoStoreType);
+
+            await client.cryptoStore.setDeviceId(TEST_DEVICE_ID);
+            bindNullEngine(http);
+            await Promise.all([
+                client.crypto.prepare([]),
+                http.flushAllExpected(),
+            ]);
+            expect(client.crypto.clientDeviceEd25519).toBeTruthy();
+        }));
     });
 
     describe('isRoomEncrypted', () => {