Merge pull request #127 from koosc/allow-unknown

Add option for allowing unknown devices in rooms

README.md

@@ -5,6 +5,8 @@
 
 Join our public Matrix room for help: [#node-red-contrib-matrix-chat:skylar.tech](https://app.element.io/#/room/#node-red-contrib-matrix-chat:skylar.tech)
 
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/B0B51BM7C)
+
 ### Features
 
 Supported functionality in this package includes:
@@ -59,7 +61,9 @@ Interested in helping? Contributions to finalize E2EE support are welcome!
 
 This module includes a node to register users using the Synapse secret registration endpoint. It returns both an `access_token` and a `device_id`, perfect for setting up the bot.
 
-[See how to register a user here](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#readme).
+[Guide on registering a user via the web browser](https://skylar.tech/matrix-chat-bot-module-for-node-red/)
+
+[Guide on registering using shared secret registration](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#readme) (for server owners)
 
 ### Other Packages
 

package.json

@@ -1,16 +1,15 @@
 {
   "name": "node-red-contrib-matrix-chat",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "Matrix chat server client for Node-RED",
   "dependencies": {
-    "@matrix-org/matrix-sdk-crypto-nodejs": "^0.2.0-beta.1",
     "abort-controller": "^3.0.0",
     "fluent-ffmpeg": "^2.1.2",
     "fs-extra": "^11.1.0",
     "got": "^12.0.2",
     "image-size": "^1.0.2",
     "isomorphic-webcrypto": "^2.3.8",
-    "matrix-js-sdk": "^34.5.0",
+    "matrix-js-sdk": "34.11.1",
     "mime": "^3.0.0",
     "node-fetch": "^3.3.0",
     "node-localstorage": "^2.2.1",

src/matrix-event-relations.js

@@ -1,3 +1,5 @@
+const {RelationType, EventType, Direction} = require("matrix-js-sdk");
+
 module.exports = function(RED) {
     function MatrixFetchRelations(n) {
         RED.nodes.createNode(this, n);
@@ -41,8 +43,6 @@ module.exports = function(RED) {
         });
 
         node.on("input", async function(msg) {
-            const {Direction} = await import("matrix-js-sdk");
-
             if (!node.server || !node.server.matrixClient) {
                 node.error("No matrix server selected", msg);
                 return;

src/matrix-get-event.html

@@ -19,14 +19,18 @@
         },
         oneditprepare: function() {
             $("#node-input-roomId").typedInput({
-                type: this.roomIdType,
+                types: ['msg','flow','global','str'],
-                types:['msg','flow','global','str'],
+                typeField: "#node-input-roomId"
-            }).typedInput('value', this.roomIdValue);
+            });
+            $("#node-input-roomId").typedInput("type", this.roomIdType || "msg");
+            $("#node-input-roomId").typedInput("value", this.roomIdValue || "topic");
 
             $("#node-input-eventId").typedInput({
-                type: this.eventIdType,
+                types: ['msg','flow','global','str'],
-                types:['msg','flow','global','str'],
+                typeField: "#node-input-eventId"
-            }).typedInput('value', this.eventIdValue);
+            });
+            $("#node-input-eventId").typedInput("type", this.eventIdType || "msg");
+            $("#node-input-eventId").typedInput("value", this.eventIdValue || "eventId");
         },
         oneditsave: function() {
             this.roomIdType = $("#node-input-roomId").typedInput('type');
@@ -58,18 +62,6 @@
         <label for="node-input-eventId"><i class="fa fa-file"></i> Event ID</label>
         <input type="text" id="node-input-eventId">
     </div>
-
-    <script type="text/javascript">
-        $(function(){
-            $("#node-input-roomId").on("keyup", function() {
-                if($(this).val() && !$(this).val().startsWith("!")) {
-                    $("#node-input-roomId-error").html(`Room IDs start with exclamation point "!"<br />Example: !OGEhHVWSdvArJzumhm:matrix.org`).show();
-                } else {
-                    $("#node-input-roomId-error").hide();
-                }
-            }).trigger('keyup');
-        });
-</script>
 </script>
 
 <script type="text/html" data-help-name="matrix-get-event">

src/matrix-mark-read.js

@@ -1,3 +1,5 @@
+const {TimelineWindow, RelationType, Filter} = require("matrix-js-sdk");
+const crypto = require('crypto');
 module.exports = function(RED) {
     function MatrixReceiveMessage(n) {
         RED.nodes.createNode(this, n);

src/matrix-paginate-room.js

@@ -1,3 +1,5 @@
+const {TimelineWindow, RelationType, Filter} = require("matrix-js-sdk");
+const crypto = require('crypto');
 module.exports = function(RED) {
     function MatrixReceiveMessage(n) {
         RED.nodes.createNode(this, n);
@@ -32,9 +34,6 @@ module.exports = function(RED) {
         });
 
         node.on("input", async function (msg) {
-            const {TimelineWindow, RelationType, Filter} = await import("matrix-js-sdk");
-            const crypto = await import('crypto');
-
             if (! node.server || ! node.server.matrixClient) {
                 node.error("No matrix server selected", msg);
                 return;

src/matrix-receive.html

@@ -13,6 +13,7 @@
             acceptOwnEvents: {"value": false},
             acceptText: {"value": true},
             acceptEmotes: {"value": true},
+            acceptNotices: {"value": true},
             acceptStickers: {"value": true},
             acceptReactions: {"value": true},
             acceptFiles: {"value": true},
@@ -66,6 +67,16 @@
             Accept text <code style="text-transform: none;">m.text</code>
         </label>
     </div>
+    <div class="form-row" style="margin-bottom:0;">
+        <input
+                type="checkbox"
+                id="node-input-acceptNotices"
+                style="width: auto; margin-left: 125px; vertical-align: top"
+        />
+        <label for="node-input-acceptNotices" style="width: auto">
+            Accept notices <code style="text-transform: none;">m.notice</code>
+        </label>
+    </div>
     <div class="form-row" style="margin-bottom:0;">
         <input
                 type="checkbox"

src/matrix-receive.js

@@ -1,3 +1,4 @@
+const {RelationType} = require("matrix-js-sdk");
 module.exports = function(RED) {
     function MatrixReceiveMessage(n) {
         RED.nodes.createNode(this, n);
@@ -9,6 +10,7 @@ module.exports = function(RED) {
         this.acceptOwnEvents = n.acceptOwnEvents;
         this.acceptText = n.acceptText;
         this.acceptEmotes = n.acceptEmotes;
+        this.acceptNotices = n.acceptNotices;
         this.acceptStickers = n.acceptStickers;
         this.acceptReactions = n.acceptReactions;
         this.acceptFiles = n.acceptFiles;
@@ -68,6 +70,10 @@ module.exports = function(RED) {
                     if (!node.acceptEmotes) return;
                     break;
 
+                case 'm.notice':
+                    if (!node.acceptNotices) return;
+                    break;
+
                 case 'm.text':
                     if (!node.acceptText) return;
                     break;

src/matrix-send-message.js

@@ -1,3 +1,5 @@
+const {RelationType} = require("matrix-js-sdk");
+
 module.exports = function(RED) {
     function MatrixSendImage(n) {
         RED.nodes.createNode(this, n);
@@ -66,8 +68,7 @@ module.exports = function(RED) {
             node.status({ fill: "green", shape: "ring", text: "connected" });
         });
 
-        node.on("input", async function (msg) {
+        node.on("input", function (msg) {
-            const {RelationType} = await import("matrix-js-sdk");
             function getToValue(msg, type, property) {
                 let value = property;
                 if (type === "msg") {
@@ -126,7 +127,7 @@ module.exports = function(RED) {
                 }
 
                 if(msgFormat === 'msg.format') {
-                    if(!msg.format) {
+                    if(!Object.hasOwn(msg, 'format')) {
                         node.error("Message format is set to be passed in via msg.format but was not defined", msg);
                         return;
                     }

src/matrix-server-config.html

@@ -36,7 +36,8 @@
             name: { value: null },
             autoAcceptRoomInvites: { value: true },
             enableE2ee: { type: "checkbox", value: true },
-            global: { type: "checkbox", value: true }
+            global: { type: "checkbox", value: true },
+            allowUnknownDevices: { type: "checkbox", value: false }
         },
         icon: "matrix.png",
         label: function() {
@@ -130,6 +131,20 @@
             <code style="white-space: normal;">let client = global.get("matrixClient['@bot:example.com']");</code>
         </div>
     </div>
+
+    <div class="form-row">
+        <input
+                type="checkbox"
+                id="node-config-input-allowUnknownDevices"
+                style="width: auto; margin-left: 125px; vertical-align: top"
+        />
+        <label for="node-config-input-allowUnknownDevices" style="width: auto">
+            Allow unverified devices in rooms
+        </label>
+        <div class="form-tips" style="margin-bottom: 12px;">
+            Allow sending messages to a room with unknown devices which have not been verified.
+        </div>
+    </div>
     <script type="text/javascript">
         $("#matrix-login-btn").on("click", function() {
             function prettyPrintJson(json) {

src/matrix-server-config.js

@@ -1,10 +1,13 @@
+const {RelationType, TimelineWindow} = require("matrix-js-sdk");
+
 global.Olm = require('olm');
 const fs = require("fs-extra");
+const sdk = require("matrix-js-sdk");
 const { resolve } = require('path');
 const { LocalStorage } = require('node-localstorage');
-globalThis.crypto = require('crypto');
+const { LocalStorageCryptoStore } = require('matrix-js-sdk/lib/crypto/store/localStorage-crypto-store');
+const {RoomEvent, RoomMemberEvent, HttpApiEvent, ClientEvent, MemoryStore} = require("matrix-js-sdk");
 require("abort-controller/polyfill"); // polyfill abort-controller if we don't have it
-
 if (!globalThis.fetch) {
     // polyfill fetch if we don't have it
     if (!globalThis.fetch) {
@@ -15,22 +18,16 @@ if (!globalThis.fetch) {
 }
 
 module.exports = function(RED) {
-    // Prepare dynamic imports
-    const sdkPromise = import("matrix-js-sdk");
-    const LocalStorageCryptoStorePromise = import('matrix-js-sdk/lib/crypto/store/localStorage-crypto-store.js');
-    const loggerPromise = import('matrix-js-sdk/lib/logger.js');
-
     // disable logging if set to "off"
-    // let loggingSettings = RED.settings.get('logging');
+    let loggingSettings = RED.settings.get('logging');
-    // if(
+    if(
-    //     typeof loggingSettings.console !== 'undefined' &&
+        typeof loggingSettings.console !== 'undefined' &&
-    //     typeof loggingSettings.console.level !== 'undefined' &&
+        typeof loggingSettings.console.level !== 'undefined' &&
-    //     ['info','debug','trace'].indexOf(loggingSettings.console.level.toLowerCase()) >= 0
+        ['info','debug','trace'].indexOf(loggingSettings.console.level.toLowerCase()) >= 0
-    // ) {
+    ) {
-    //     loggerPromise.then(({ logger }) => {
+        const { logger } = require('matrix-js-sdk/lib/logger');
-    //         logger.disableAll();
+        logger.disableAll();
-    //     });
+    }
-    // }
 
     function MatrixFolderNameFromUserId(name) {
         return name.replace(/[^a-z0-9]/gi, '_').toLowerCase();
@@ -58,6 +55,7 @@ module.exports = function(RED) {
         this.autoAcceptRoomInvites = n.autoAcceptRoomInvites;
         this.e2ee = n.enableE2ee || false;
         this.globalAccess = n.global;
+        this.allowUnknownDevices = n.allowUnknownDevices || false;
         this.initializedAt = new Date();
         node.initialSyncLimit = 25;
 
@@ -85,7 +83,7 @@ module.exports = function(RED) {
         } else if(!this.url) {
             node.error("Matrix connection failed: missing server URL in configuration.", {});
         } else {
-            node.setConnected = function(connected, cb) {
+            node.setConnected = async function(connected, cb) {
                 if (node.connected !== connected) {
                     node.connected = connected;
                     if(typeof cb === 'function') {
@@ -147,17 +145,11 @@ module.exports = function(RED) {
 
             fs.ensureDirSync(storageDir); // create storage directory if it doesn't exist
             upgradeDirectoryIfNecessary(node, storageDir);
-
-            // Wait for the dynamic imports to resolve
-            Promise.all([sdkPromise, LocalStorageCryptoStorePromise]).then(([sdkModule, LocalStorageCryptoStoreModule]) => {
-                const sdk = sdkModule.default || sdkModule;
-                const { LocalStorageCryptoStore } = LocalStorageCryptoStoreModule;
-
             node.matrixClient = sdk.createClient({
                 baseUrl: this.url,
                 accessToken: this.credentials.accessToken,
                 cryptoStore: new LocalStorageCryptoStore(localStorage),
-                    store: new sdk.MemoryStore({
+                store: new MemoryStore({
                     localStorage: localStorage,
                 }),
                 userId: this.userId,
@@ -199,8 +191,6 @@ module.exports = function(RED) {
                 return node.connected;
             };
 
-                const { RelationType, RoomEvent, RoomMemberEvent, HttpApiEvent, ClientEvent } = sdk;
-
             node.matrixClient.on(RoomEvent.Timeline, async function(event, room, toStartOfTimeline, removed, data) {
                 if (toStartOfTimeline) {
                     node.log("Ignoring" + (event.isEncrypted() ? ' encrypted' : '') +" timeline event [" + (event.getContent()['msgtype'] || event.getType()) + "]: (" + room.name + ") " + event.getId() + " for reason: paginated result");
@@ -254,18 +244,42 @@ module.exports = function(RED) {
                 };
 
                 // remove keys from user property that start with an underscore
-                    if (msg.user) {
                 Object.keys(msg.user).forEach(function (key) {
                     if (/^_/.test(key)) {
                         delete msg.user[key];
                     }
                 });
-                    }
 
                 node.log(`Received ${msg.encrypted ? 'encrypted ' : ''}timeline event [${msg.type}]: (${room.name}) ${event.getSender()} :: ${msg.content.body} ${toStartOfTimeline ? ' [PAGINATED]' : ''}`);
                 node.emit("Room.timeline", event, room, toStartOfTimeline, removed, data, msg);
             });
 
+            /**
+             * Fires when we want to suggest to the user that they restore their megolm keys
+             * from backup or by cross-signing the device.
+             *
+             * @event module:client~MatrixClient#"crypto.suggestKeyRestore"
+             */
+            // node.matrixClient.on("crypto.suggestKeyRestore", function(){
+            //
+            // });
+
+            // node.matrixClient.on("RoomMember.typing", async function(event, member) {
+            //     let isTyping = member.typing;
+            //     let roomId = member.roomId;
+            // });
+
+            // node.matrixClient.on("RoomMember.powerLevel", async function(event, member) {
+            //     let newPowerLevel = member.powerLevel;
+            //     let newNormPowerLevel = member.powerLevelNorm;
+            //     let roomId = member.roomId;
+            // });
+
+            // node.matrixClient.on("RoomMember.name", async function(event, member) {
+            //     let newName = member.name;
+            //     let roomId = member.roomId;
+            // });
+
             // handle auto-joining rooms
 
             node.matrixClient.on(RoomMemberEvent.Membership, async function(event, member) {
@@ -365,6 +379,17 @@ module.exports = function(RED) {
 
 
             node.matrixClient.on(HttpApiEvent.SessionLoggedOut, async function(errorObj){
+                // Example if user auth token incorrect:
+                // {
+                //     errcode: 'M_UNKNOWN_TOKEN',
+                //     data: {
+                //         errcode: 'M_UNKNOWN_TOKEN',
+                //         error: 'Invalid macaroon passed.',
+                //         soft_logout: false
+                //     },
+                //     httpStatus: 401
+                // }
+
                 node.error("Authentication failure: " + errorObj, {});
                 stopClient();
             });
@@ -372,21 +397,16 @@ module.exports = function(RED) {
             async function run() {
                 try {
                     if(node.e2ee){
-                            node.matrixClient.on("crypto.legacyCryptoStoreMigrationProgress", function(progress, total){
+                        node.log("Initializing crypto...");
-                                node.log(`Migrating from legacy crypto to rust crypto. ${progress}/${total}`);
+                        await node.matrixClient.initCrypto();
-                            });
-                            await node.matrixClient.initRustCrypto({
-                                useIndexedDB: false
-                            });
-                            console.log(`CRYPTO VERSION: ${node.matrixClient.getCrypto()?.getVersion()}`);
                         node.matrixClient.getCrypto().globalBlacklistUnverifiedDevices = false; // prevent errors from unverified devices
+                        node.matrixClient.getCrypto().globalErrorOnUnknownDevices  = !node.allowUnknownDevices;
                     }
                     node.log("Connecting to Matrix server...");
                     await node.matrixClient.startClient({
                         initialSyncLimit: node.initialSyncLimit
                     });
                 } catch(error) {
-                        node.error(error);
                     node.error(error, {});
                 }
             }
@@ -432,9 +452,6 @@ module.exports = function(RED) {
                         }
                     )
             })();
-            }).catch((error) => {
-                node.error("Failed to load Matrix SDK modules: " + error, {});
-            });
         }
     }
 
@@ -458,17 +475,15 @@ module.exports = function(RED) {
                 deviceId = req.body.deviceId || undefined,
                 displayName = req.body.displayName || undefined;
 
-            sdkPromise.then((sdkModule) => {
-                const sdk = sdkModule.default || sdk;
-
             const matrixClient = sdk.createClient({
                 baseUrl: baseUrl,
                 deviceId: deviceId,
                 timelineSupport: true,
-                    localTimeoutMs: '30000',
+                localTimeoutMs: '30000'
-                    request
             });
 
+            new TimelineWindow()
+
             matrixClient.timelineSupport = true;
 
             matrixClient.login(
@@ -496,12 +511,6 @@ module.exports = function(RED) {
                         });
                     }
                 );
-            }).catch((error) => {
-                res.json({
-                    'result': 'error',
-                    'message': "Failed to load Matrix SDK: " + error
-                });
-            });
         });
 
     function upgradeDirectoryIfNecessary(node, storageDir) {