skylord123
67920840e1
Adds two interactive admin tools to the matrix-server-config node so device verification and session management can be done from the editor without building a flow. Both open as modal dialogs and are backed by new flows.write-protected admin endpoints. Pending verifications - New "Pending verification requests" button opens a modal listing incoming and in-progress verification requests, refreshed every 5 seconds. - Each entry shows the type (device or room), who it is from, a live age, and a live expiry countdown; the list is capped at the newest 20 with a hidden-count note. - Clicking an entry drives the SAS flow (accept, start, show emoji, confirm/cancel) within the modal. - New /matrix-chat/verification endpoint with list, advance, confirm, mismatch, and cancel actions. - trackVerificationRequest now records a seen-at timestamp and keeps finished requests for two minutes so their outcome can still be reported to the editor. Sessions - New "Manage sessions" button opens a modal listing the account's sessions, modelled on Element's session manager: the current session with a verified / not-verified status box, then other sessions, each with a green or red shield, last activity, and IP address. - Clicking a session shows its details (session ID, last activity, IP), a Rename action, and a password-confirmed Remove. Unverified sessions offer a Verify action that hands off into the verification modal. - New /matrix-chat/sessions endpoint with list, rename, remove, and verify actions.
node-red-contrib-matrix-chat
Matrix chat server client for Node-RED
Currently in beta. Please report any issues in our repository to help us reach a stable, well-tested release. Breaking changes may occur before our first stable release, so be sure to check the changelog before updating.
Join our public Matrix room for help: #node-red-contrib-matrix-chat:skylar.tech
Features
Supported functionality in this package includes:
- End-to-end encryption (E2EE) — send and receive encrypted messages (see the encryption notes)
- Cross-signing & secure backup — interactive setup from the server config node so the bot's own device shows as verified
- Device verification — flow-driven SAS (emoji) verification via the
matrix-verificationandmatrix-verification-actionnodes - Receive events from rooms: Messages, reactions, images, audio, locations, files, encrypted or unencrypted
- Fetch/modify room state: Update room settings
- Paginate room history
- Send files to rooms, encrypted or unencrypted
- Send/edit messages (supports plain text and HTML formats)
- Send typing notifications
- Delete events (messages, reactions, etc.)
- Decrypt files in E2EE rooms
- React to messages
- Admin tools:
- Register users on closed Synapse servers (
registration_shared_secret) - Manage users, including listing, adding, editing, deactivating (Synapse API)
- Force-add users to rooms
- Register users on closed Synapse servers (
- Room management: Invite, kick, ban, join, create, and leave rooms
These features allow you to easily build bots, set up chat relays, or even administrate your Matrix server directly from Node-RED.
Installing
Requires Node.js 22 or newer (this is a requirement of the bundled matrix-js-sdk).
Install through Node-RED's UI by searching for node-red-contrib-matrix-chat, or use the following command inside your Node-RED directory:
npm install node-red-contrib-matrix-chat
Usage
Explore our examples to see the module in action.
Extending functionality
You're not limited to just the nodes we've created. Enable global access in your Matrix Client to directly interact with the client from function nodes and create custom logic.
End-to-End Encryption Notes
- E2EE uses the Rust crypto stack from
matrix-js-sdk. The first time a bot starts after upgrading from an older version, any existing (legacy libolm) crypto state is migrated automatically. - Storage: E2EE state is saved in a folder called
matrix-client-storagewithin your Node-RED directory. Each account's Rust crypto store is persisted there asrust-crypto-store.v8(snapshotted on shutdown and every 5 minutes). Back up this folder regularly! If lost, you won’t be able to decrypt messages from E2EE rooms. - To move your bot to a different installation, migrate this folder and ensure the old and new clients don't run simultaneously.
- It’s simplest to dedicate the account to the bot and run it only within Node-RED. The account can also be signed in elsewhere — if so, verify those sessions against the bot (see below) so they trust each other and share keys.
- Cross-signing & secure backup: open the server config node and use the Set up secure backup & cross-signing button. It checks the account and lets you unlock an existing secure backup with its recovery key, or create a fresh one — after which the bot's own device is cross-signed and shows as verified to others.
- Device verification: the
matrix-verificationnode emits verification requests and phase changes, andmatrix-verification-actionaccepts, starts, confirms, or cancels them — so you can build your own approval flow (e.g. emailing the SAS emoji for a human to confirm). See the device verification example.
Registering a User
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.
Guide on registering a user via the web browser
Guide on registering using shared secret registration (for server owners)
Other Packages
- node-red-contrib-gamedig - Query game servers from Node-RED.
Contributing
We welcome all contributions! Please submit a pull request if you add a feature so the whole community can benefit.
Sharing is caring!