├── LICENSE ├── README.md ├── app.js ├── config ├── config.sample.yaml └── rocket-chat-config-schema.yaml └── package.json /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # matrix-appservice-rocketchat 2 | A Rocket Chat application service 3 | 4 | This is currently a very barebones bridge, it just does basic text in pre-enumerated channels. 5 | 6 | To install: 7 | 8 | ```bash 9 | $ npm install 10 | ``` 11 | 12 | To set up on the Rocket Chat side: 13 | * Add inbound & outbound webhook integrations to the room you want to bridge. 14 | * For the inbound webhook, note down the webhook URL that Rocket Chat provisions for you - e.g. http://matrix.org:3000/hooks/xxx/yyy 15 | * For the outbound webhook, you'll need to expose your bridge to the internet and hand the URL to Rocket Chat - e.g. https://rocketchatbridge.matrix.org 16 | 17 | To set up on the Matrix side: 18 | Create a config.yaml file (there's a skeleton one in config/config.sample.yaml). Add the homeserver details, the port of the listener, the Matrix Room ID and the Rocket Chat webhook URL to this file. 19 | 20 | You might want to restrict the AS to a room. This is done by adding the following to the config: 21 | ``` 22 | rooms: 23 | - exclusive: false 24 | regex: "!xxx:matrix.org" 25 | ``` 26 | Then generate a registration file by running: 27 | 28 | ```bash 29 | $ node app.js -r -c config.yaml -u "http://localhost:9000" 30 | ``` 31 | 32 | Reference the registration yaml file from your homeserver's homeserver.yaml config and restart the server to pick it up. 33 | 34 | Start your application service: 35 | 36 | ```bash 37 | $ node app.js -c config.yaml -p 9000 38 | ``` 39 | 40 | See also https://github.com/matrix-org/matrix-appservice-bridge/blob/master/HOWTO.md for the general theory of all this :) 41 | 42 | -------------------------------------------------------------------------------- /app.js: -------------------------------------------------------------------------------- 1 | // Usage: 2 | // Generate a registration file by running: 3 | // node app.js -r -u "http://localhost:9000" 4 | // add the registration file to the app_service_config_files array in your synapse config 5 | // start the bridge by running: 6 | // node app.js -p 9000 -c config.yaml 7 | 8 | var qs = require("querystring"); 9 | var requestLib = require("request"); 10 | var rp = require('request-promise'); 11 | var bridgeLib = require("matrix-appservice-bridge"); 12 | var bridge; 13 | 14 | function startServer(config, callback) { 15 | var createServer; 16 | if (config.tls) { 17 | var fs = require("fs"); 18 | var tls_options = { 19 | key: fs.readFileSync(config.tls.key_file), 20 | cert: fs.readFileSync(config.tls.crt_file) 21 | }; 22 | createServer = function(cb) { 23 | return require("https").createServer(tls_options, cb); 24 | }; 25 | } 26 | else { 27 | createServer = require("http").createServer; 28 | } 29 | 30 | createServer(function(request, response) { 31 | console.log(request.method + " " + request.url); 32 | 33 | var body = ""; 34 | request.on("data", function(chunk) { 35 | body += chunk; 36 | }); 37 | 38 | request.on("end", function() { 39 | var params = qs.parse(body); 40 | rocket_chat_event = JSON.parse(body); 41 | 42 | console.log("RC event: " + rocket_chat_event); 43 | 44 | // avoid echoing 45 | if (rocket_chat_event.user_id !== config.bot_username) { 46 | var intent = bridge.getIntent("@" + config.username_prefix + rocket_chat_event.user_name + ":" + config.homeserver.server_name); 47 | intent.sendText(config.rooms[0].matrix_room_id, rocket_chat_event.text); 48 | } 49 | response.writeHead(200, {"Content-Type": "application/json"}); 50 | response.write(JSON.stringify({})); 51 | response.end(); 52 | }); 53 | }).listen(config.rocket_chat_webhook_port, function() { 54 | var protocol = config.tls ? "https" : "http"; 55 | console.log("Rocket Chat-side listening on port " + 56 | config.rocket_chat_webhook_port + " over " + protocol); 57 | callback(); 58 | }); 59 | } 60 | 61 | 62 | var Cli = bridgeLib.Cli; 63 | var Bridge = bridgeLib.Bridge; 64 | var AppServiceRegistration = bridgeLib.AppServiceRegistration; 65 | 66 | var cli = new Cli({ 67 | registrationPath: "rocket-chat-registration.yaml", 68 | bridgeConfig: { 69 | schema: "config/rocket-chat-config-schema.yaml", 70 | affectsRegistration: true 71 | }, 72 | generateRegistration: function(reg, callback) { 73 | var config = cli.getConfig(); 74 | reg.setId(AppServiceRegistration.generateToken()); 75 | reg.setHomeserverToken(AppServiceRegistration.generateToken()); 76 | reg.setAppServiceToken(AppServiceRegistration.generateToken()); 77 | reg.setSenderLocalpart(config.bot_username); 78 | reg.addRegexPattern("users", "@" + config.username_prefix + ".*", true); 79 | callback(reg); 80 | }, 81 | run: function(port, config) { 82 | bridge = new Bridge({ 83 | homeserverUrl: config.homeserver.url, 84 | domain: config.homeserver.server_name, 85 | registration: "rocket-chat-registration.yaml", 86 | 87 | controller: { 88 | onUserQuery: function(queriedUser) { 89 | console.log("query from " + queriedUser); 90 | return {}; // auto-provision users with no additional data 91 | }, 92 | 93 | onEvent: function(request, context) { 94 | var event = request.getData(); 95 | console.log("event recieved: " + JSON.stringify(event)); 96 | if (event.type !== "m.room.message" || !event.content || event.room_id !== config.rooms[0].matrix_room_id) { 97 | return; 98 | } 99 | var getProfileParams = { 100 | uri: config.homeserver.url + "/_matrix/client/r0/profile/" + qs.escape(event.user_id), 101 | method: "GET", 102 | json: true 103 | }; 104 | var sendMessageParams = { 105 | method: "POST", 106 | json: true, 107 | uri: config.rooms[0].webhook_url, 108 | body: { 109 | text: event.content.body 110 | } 111 | }; 112 | 113 | // attempt to look up displayname and avatar_url - then send the message 114 | rp(getProfileParams).then(function(res) { 115 | if (res) { 116 | if (res.displayname) { 117 | sendMessageParams.body.username = res.displayname; 118 | console.log("found displayname: " + res.displayname); 119 | } 120 | if (res.avatar_url && res.avatar_url.indexOf("mxc://") === 0) { 121 | console.log("found avatar_url: " + res.avatar_url); 122 | sendMessageParams.body.icon_url = config.homeserver.url + "/_matrix/media/v1/download/" + res.avatar_url.substring("mxc://".length); 123 | } 124 | } 125 | }).finally(function() { 126 | sendMessage(sendMessageParams) 127 | }); 128 | } 129 | } 130 | }); 131 | startServer(config, function() { 132 | console.log("Matrix-side listening on port %s", port); 133 | bridge.run(port, config); 134 | }); 135 | } 136 | }); 137 | cli.run(); 138 | 139 | 140 | var sendMessage = function(options) { 141 | rp(options).then(function(res) { 142 | if (!res) { 143 | console.log("HTTP Error: %s", res); 144 | } 145 | else { 146 | console.log("HTTP Msg sent! %s", res); 147 | } 148 | }); 149 | }; 150 | 151 | -------------------------------------------------------------------------------- /config/config.sample.yaml: -------------------------------------------------------------------------------- 1 | rocket_chat_webhook_port: 8003 2 | bot_username: "rocket.cat" 3 | username_prefix: "_rocketchat_" 4 | 5 | homeserver: 6 | url: "http://localhost:8008" 7 | server_name: "my.server" 8 | 9 | # Optional 10 | tls: 11 | key_file: /path/to/tls.key 12 | crt_file: /path/to/tls.crt 13 | 14 | rooms: 15 | - matrix_room_id: "!xxx:matrix.org" 16 | webhook_url: "http://example.com:3000/hooks/xxx/yyy" 17 | 18 | -------------------------------------------------------------------------------- /config/rocket-chat-config-schema.yaml: -------------------------------------------------------------------------------- 1 | type: object 2 | required: ["homeserver", "rocket_chat_webhook_port", "bot_username", "username_prefix"] 3 | properties: 4 | homeserver: 5 | type: object 6 | required: ["server_name", "url"] 7 | properties: 8 | server_name: 9 | type: string 10 | url: 11 | type: string 12 | tls: 13 | type: object 14 | required: ["key_file", "crt_file"] 15 | properties: 16 | key_file: 17 | type: string 18 | crt_file: 19 | type: string 20 | rocket_chat_webhook_port: 21 | type: integer 22 | rooms: 23 | type: array 24 | items: 25 | type: object 26 | required: ["matrix_room_id", "webhook_url"] 27 | properties: 28 | matrix_room_id: 29 | type: string 30 | webhook_url: 31 | type: string 32 | bot_username: 33 | type: string 34 | username_prefix: 35 | type: string 36 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "rocket-chat-bridge", 3 | "version": "1.0.0", 4 | "description": "application service for matrix<->rocket chat support", 5 | "main": "index.js", 6 | "dependencies": { 7 | "matrix-appservice-bridge": "^0.3.1", 8 | "request": "^2.74.0", 9 | "request-promise": "^4.0.2" 10 | }, 11 | "devDependencies": {}, 12 | "author": "Matrix.org team", 13 | "license": "Apache-2.0", 14 | "scripts": { 15 | "test": "echo \"Error: no test specified\" && exit 1" 16 | } 17 | } 18 | --------------------------------------------------------------------------------