Matrix/node-red-contrib-matrix-chat-jw
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

- Fixed not being able to disable e2ee

Browse Source 
- Session.logged_out events are now processed to display an error from the node (helps user figure out why their login failed).
- Update description for matrix-server-config
- Updated readme & examples
This commit is contained in:
Skylar Sadlier 2021-08-30 19:21:02 -06:00
parent b93a54f041
commit 2c4621e293
15 changed files with 222 additions and 127 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -29,8 +29,8 @@ The following is supported from this package:
Therefore, you can easily build a bot, chat relay, or administrate your Matrix server from within [Node-RED](https://nodered.org/).
### Examples
We have examples! [Check them out](examples)
### Usage
We have examples! [Check them out](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#readme)
### Installing
@ -39,9 +39,19 @@ You can either install from within Node-RED by searching for `node-red-contrib-m
npm install node-red-contrib-matrix-chat
```
### Usage
### End-to-End Encryption Notes
Currently this module has no way of getting encryption keys from other devices on the same account. Therefore it is recommended you use the bot exclusively with Node-RED after it's creation. Failure to do so will lead to your bot being unable to receive messages from e2ee rooms it joined from another client. Shared secret registration makes this super easy since it returns a token and device ID.
This module stores a folder in your Node-RED directory called `matrix-local-storage` and is it vital that you periodically back this up if you are using e2ee. This is where the client stores all the keys necessary to decrypt messages and if lost you will lose access to e2e rooms. If you move your client to another NR install make sure to migrate this folder as well (and do not let both the old and new client run at same time).
Want to contribute? Any help on getting the last pieces of e2ee figured out would be greatly appreciated :)
### Generate user
You will need a user to use this module. Luckily this module comes with a node that allows you to register users to a homeserver using the secret registration endpoint. This is perfect because it returns an `access_token` as well as a `device_id` which is exactly what we need.
[Click here](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#readme) to see how to generate a user using secret registration
Using this package is very straightforward. Examples coming soon!
### Other Packages
@ -49,4 +59,5 @@ Using this package is very straightforward. Examples coming soon!
### Contributing
All contributions are welcome! If you do add a feature please do a pull request so that everyone benefits :)
Sharing is caring.
Sharing is caring!

40
examples/README.md
View File

@ -7,14 +7,38 @@ Build something cool with these nodes? Feel free to submit a pull request to sha
## Index
- [Create User with Shared Secret Registration](#create-user-with-shared-secret-registration)
- [Create/Edit Synapse User](#createedit-synapse-user)
- [Respond to "ping" with "pong"](#respond-to-ping-with-pong)
- [Respond to "html" with an HTML message](#respond-to-html-with-an-html-message)
- [Create user using Synapse v1 API](#create-user-using-synapse-v1-api)
- [Respond to "image" with an uploaded image](#respond-to-image-with-an-uploaded-image)
- [Respond to "file" with an uploaded file](#respond-to-file-with-an-uploaded-file)
- [Respond to "react" with a reaction](#respond-to-react-with-a-reaction)
- [Respond to "users" with full list of server users](#respond-to-users-with-full-list-of-server-users)
### Create user with Shared Secret Registration
[View JSON](shared-secret-registration.json)
Use this flow to create users on servers with closed registration. You also use this endpoint to create your first admin user as it is the same as running the local python script on the server. This requires your registration secret from your homeserver.yaml Synapse server configuration file.
Edit the object on the inject node to the user/pass combo you want to create and hit the inject button (to the left of the inject node).
**Note:** This only works on Synapse servers.
![img.png](shared-secret-registration.png)
### Create/Edit Synapse User
[View JSON](add-user-with-admin-user.json)
Allows an administrator to create or modify a user account with a specified `msg.userId`.
![img.png](add-user-with-admin-user.png)
### Respond to "ping" with "pong"
[View JSON](respond-to-html-with-html.json)
@ -35,20 +59,6 @@ Use this flow to respond to anyone that says "html" with an example HTML message
### Create user using Synapse v1 API
[View JSON](create-user-synapse-v1-api.json)
Use this flow to create users on servers with closed registration. You also use this endpoint to create your first admin user as it is the same as running the local python script on the server. This requires your registration secret from your homeserver.yaml Synapse server configuration file.
Edit the object on the inject node to the user/pass combo you want to create and hit the inject button (to the left of the inject node).
**Note:** This only works on Synapse servers.
![img.png](create-user-synapse-v1-api.png)
### Respond to "image" with an uploaded image
[View JSON](respond-image-with-image.json)

92
examples/add-user-with-admin-user.json Normal file
View File

@ -0,0 +1,92 @@
[
{
"id": "56b6ae18958287f3",
"type": "inject",
"z": "f025a8b9fbd1b054",
"name": "",
"props": [
{
"p": "payload"
},
{
"p": "userId",
"v": "@example:matrix.org",
"vt": "str"
}
],
"repeat": "",
"crontab": "",
"once": false,
"onceDelay": 0.1,
"topic": "",
"payload": "{\"password\":\"example-password\",\"displayname\":\"Example User\",\"admin\":false,\"deactivated\":false}",
"payloadType": "json",
"x": 370,
"y": 1500,
"wires": [
[
"bc882759b3b11884"
]
]
},
{
"id": "bc882759b3b11884",
"type": "matrix-synapse-create-edit-user",
"z": "f025a8b9fbd1b054",
"name": "",
"x": 570,
"y": 1500,
"wires": [
[
"624f5aa29b67602f"
],
[
"9f71a73d53f06853"
]
]
},
{
"id": "7ac657a41b57e680",
"type": "comment",
"z": "f025a8b9fbd1b054",
"name": "Create or edit Synapse User",
"info": "",
"x": 440,
"y": 1460,
"wires": []
},
{
"id": "624f5aa29b67602f",
"type": "debug",
"z": "f025a8b9fbd1b054",
"name": "",
"active": true,
"tosidebar": true,
"console": false,
"tostatus": false,
"complete": "true",
"targetType": "full",
"statusVal": "",
"statusType": "auto",
"x": 750,
"y": 1480,
"wires": []
},
{
"id": "9f71a73d53f06853",
"type": "debug",
"z": "f025a8b9fbd1b054",
"name": "",
"active": true,
"tosidebar": true,
"console": false,
"tostatus": false,
"complete": "true",
"targetType": "full",
"statusVal": "",
"statusType": "auto",
"x": 750,
"y": 1520,
"wires": []
}
]

BIN
examples/add-user-with-admin-user.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 14 KiB

49
examples/create-user-synapse-v1-api.json
View File

@ -1,49 +0,0 @@
[
{
"id": "dc757ef02529f228",
"type": "inject",
"z": "f025a8b9fbd1b054",
"name": "",
"props": [
{
"p": "payload"
}
],
"repeat": "",
"crontab": "",
"once": false,
"onceDelay": 0.1,
"topic": "",
"payload": "{\"username\":\"example\",\"password\":\"replaceme\"}",
"payloadType": "json",
"x": 130,
"y": 600,
"wires": [
[
"62f9049cf48342da"
]
]
},
{
"id": "62f9049cf48342da",
"type": "matrix-synapse-register",
"z": "f025a8b9fbd1b054",
"name": "",
"x": 330,
"y": 600,
"wires": [
[],
[]
]
},
{
"id": "3f9d486ca3c75bf2",
"type": "comment",
"z": "f025a8b9fbd1b054",
"name": "Register user using API v1",
"info": "",
"x": 170,
"y": 560,
"wires": []
}
]

BIN
examples/create-user-synapse-v1-api.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 8.7 KiB

8
examples/respond-file-with-file.json
View File

@ -4,7 +4,6 @@
"type": "matrix-receive",
"z": "f025a8b9fbd1b054",
"name": "",
"server": "4de4e868e02a9051",
"roomId": "",
"ignoreText": false,
"ignoreReactions": false,
@ -138,7 +137,6 @@
"type": "matrix-send-file",
"z": "f025a8b9fbd1b054",
"name": "",
"server": "4de4e868e02a9051",
"roomId": "",
"contentType": "application/pdf",
"x": 1160,
@ -151,11 +149,5 @@
"f6826747cd96b814"
]
]
},
{
"id": "4de4e868e02a9051",
"type": "matrix-server-config",
"name": "Your Server",
"autoAcceptRoomInvites": true
}
]

8
examples/respond-image-with-image.json
View File

@ -4,7 +4,6 @@
"type": "matrix-receive",
"z": "f025a8b9fbd1b054",
"name": "",
"server": "4de4e868e02a9051",
"roomId": "",
"ignoreText": false,
"ignoreReactions": false,
@ -77,7 +76,6 @@
"type": "matrix-send-image",
"z": "f025a8b9fbd1b054",
"name": "",
"server": "4de4e868e02a9051",
"roomId": "",
"contentType": "image/png",
"x": 1030,
@ -86,11 +84,5 @@
[],
[]
]
},
{
"id": "4de4e868e02a9051",
"type": "matrix-server-config",
"name": "Your Server",
"autoAcceptRoomInvites": true
}
]

8
examples/respond-ping-pong.json
View File

@ -4,7 +4,6 @@
"type": "matrix-receive",
"z": "f025a8b9fbd1b054",
"name": "",
"server": "4de4e868e02a9051",
"roomId": "",
"ignoreText": false,
"ignoreReactions": false,
@ -85,7 +84,6 @@
"type": "matrix-send-message",
"z": "f025a8b9fbd1b054",
"name": "",
"server": "4de4e868e02a9051",
"roomId": "",
"messageType": "m.text",
"messageFormat": "",
@ -133,11 +131,5 @@
"x": 1250,
"y": 140,
"wires": []
},
{
"id": "4de4e868e02a9051",
"type": "matrix-server-config",
"name": "Your Server",
"autoAcceptRoomInvites": true
}
]

8
examples/respond-react-with-reaction.json
View File

@ -4,7 +4,6 @@
"type": "matrix-receive",
"z": "f025a8b9fbd1b054",
"name": "",
"server": "4de4e868e02a9051",
"roomId": "",
"ignoreText": false,
"ignoreReactions": false,
@ -119,7 +118,6 @@
"type": "matrix-react",
"z": "f025a8b9fbd1b054",
"name": "",
"server": "4de4e868e02a9051",
"roomId": "",
"x": 1030,
"y": 120,
@ -131,11 +129,5 @@
"07b598284bcadc58"
]
]
},
{
"id": "4de4e868e02a9051",
"type": "matrix-server-config",
"name": "Your Server",
"autoAcceptRoomInvites": true
}
]

8
examples/respond-to-html-with-html.json
View File

@ -4,7 +4,6 @@
"type": "matrix-receive",
"z": "f025a8b9fbd1b054",
"name": "",
"server": "4de4e868e02a9051",
"roomId": "",
"ignoreText": false,
"ignoreReactions": false,
@ -48,7 +47,6 @@
"type": "matrix-send-message",
"z": "f025a8b9fbd1b054",
"name": "Send HTML Message",
"server": "4de4e868e02a9051",
"roomId": "",
"messageType": "m.text",
"messageFormat": "html",
@ -133,11 +131,5 @@
"x": 530,
"y": 80,
"wires": []
},
{
"id": "4de4e868e02a9051",
"type": "matrix-server-config",
"name": "Your Server",
"autoAcceptRoomInvites": true
}
]

9
examples/respond-users-list.json
View File

@ -4,7 +4,6 @@
"type": "matrix-receive",
"z": "f025a8b9fbd1b054",
"name": "",
"server": "4de4e868e02a9051",
"roomId": "",
"ignoreText": false,
"ignoreReactions": false,
@ -48,7 +47,6 @@
"type": "matrix-synapse-users",
"z": "f025a8b9fbd1b054",
"name": "",
"server": "4de4e868e02a9051",
"x": 890,
"y": 120,
"wires": [
@ -63,7 +61,6 @@
"type": "matrix-send-message",
"z": "f025a8b9fbd1b054",
"name": "Send HTML Notice",
"server": "4de4e868e02a9051",
"roomId": "",
"messageType": "m.notice",
"messageFormat": "html",
@ -102,11 +99,5 @@
"x": 550,
"y": 80,
"wires": []
},
{
"id": "4de4e868e02a9051",
"type": "matrix-server-config",
"name": "Your Server",
"autoAcceptRoomInvites": true
}
]

87
examples/shared-secret-registration.json Normal file
View File

@ -0,0 +1,87 @@
[
{
"id": "8a694cb7ebec1684",
"type": "inject",
"z": "f025a8b9fbd1b054",
"name": "",
"props": [
{
"p": "payload"
}
],
"repeat": "",
"crontab": "",
"once": false,
"onceDelay": 0.1,
"topic": "",
"payload": "{\"username\":\"example\",\"displayname\":\"Example User\",\"password\":\"super-secret-password\",\"admin\":true}",
"payloadType": "json",
"x": 470,
"y": 1780,
"wires": [
[
"f19521453aeaa6ba"
]
]
},
{
"id": "f19521453aeaa6ba",
"type": "matrix-synapse-register",
"z": "f025a8b9fbd1b054",
"name": "",
"x": 670,
"y": 1780,
"wires": [
[
"cd2ea4e791098aa0"
],
[
"a365bedfad2280fe"
]
]
},
{
"id": "66fbaa12bfadd0b4",
"type": "comment",
"z": "f025a8b9fbd1b054",
"name": "Register user using secret registration",
"info": "",
"x": 630,
"y": 1740,
"wires": []
},
{
"id": "cd2ea4e791098aa0",
"type": "debug",
"z": "f025a8b9fbd1b054",
"name": "",
"active": true,
"tosidebar": true,
"console": false,
"tostatus": false,
"complete": "true",
"targetType": "full",
"statusVal": "",
"statusType": "auto",
"x": 870,
"y": 1760,
"wires": []
},
{
"id": "a365bedfad2280fe",
"type": "debug",
"z": "f025a8b9fbd1b054",
"name": "",
"active": true,
"tosidebar": true,
"console": false,
"tostatus": false,
"complete": "true",
"targetType": "full",
"statusVal": "",
"statusType": "auto",
"x": 870,
"y": 1800,
"wires": []
}
]

BIN
examples/shared-secret-registration.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 13 KiB

9
src/matrix-server-config.html
View File

@ -74,13 +74,6 @@
</script>
<script type="text/html" data-help-name="matrix-server-config">
<p>Some useful help text to introduce the node.</p>
<h3>Outputs</h3>
<dl class="message-properties">
<dt>payload
<span class="property-type">string | buffer</span>
</dt>
<h3>Details</h3>
<p>Some more information about the node.</p>
</dl>
<p>Matrix client configuration node</p>
</script>