.env.sample

@@ -0,0 +1,7 @@
+MATRIX_SERVER_URL=
+BOT_DISPLAY_NAME=
+BOT_USERNAME=
+BOT_PASSWORD=
+BOT_USERID=
+FACILITATOR_ROOM_ID=
+CHAT_OFFLINE_MESSAGE=

.gitignore

@@ -3,4 +3,3 @@ node_modules
 *.log
 __mocks__/test_transcript.txt
 transcripts/*.txt
-config.json

Dockerfile

@@ -1,10 +1,5 @@
 FROM node:10-alpine
 
-RUN apk add g++ make python
-RUN apk add tzdata
-
-ENV TZ America/Montreal
-
 RUN mkdir -p /home/node/app/node_modules && chown -R node:node /home/node/app
 
 WORKDIR /home/node/app

README.md

@@ -1,10 +1,20 @@
 # Safe Support Chat Bot
 
-A simple Matrix bot that handles inviting, uninviting, and notifying Riot users on the recieving end of the [Safe Support chatbox](https://github.com/Safe-Support-Chat/ocrcc-chatbox).
-
-The bot configuration file is `config.json`. It can also pull in user-set configurations from the Safe Support Chat Admin app. To do so, run the command `yarn setup` before starting the bot.
+A simple Matrix bot that handles inviting, uninviting, and notifying Riot users on the recieving end of the [Safe Support chatbox](https://github.com/nomadic-labs/safesupport-chatbox). 
 
+The bot can be configured with an `.env` file with the following variables:
 
+```
+MATRIX_SERVER_URL=
+BOT_DISPLAY_NAME=
+BOT_USERNAME=
+BOT_PASSWORD=
+BOT_USERID=
+FACILITATOR_ROOM_ID=
+FACILITATOR_GROUP_ID=
+CHAT_OFFLINE_MESSAGE=
+CAPTURE_TRANSCRIPTS=
+```
 ## What does the bot do?
 * The bot receives an invitation to every chatroom created by the embedded chatbox, and automatically accepts
 * Upon joining a new room, the bot invites all of the members of the Facilitators community
@@ -30,7 +40,7 @@ If you prefer to develop locally instead of on Glitch:
 
 Clone the project
 ```
-git clone https://github.com/Safe-Support-Chat/ocrcc-bot.git
+git clone https://github.com/nomadic-labs/safesupport-bot.git
 ```
 
 Install dependencies
@@ -39,14 +49,9 @@ cd safesupport-bot
 yarn
 ```
 
-Copy the sample config file and add in the missing values.
+Copy the sample `.env` file and add in your own variables
 ```
-cp sample.config.json config.json
-```
-
-Pull in the user-defined settings (if there are any).
-```
-yarn setup
+cp .env.sample .env
 ```
 
 Start the local server

__mocks__/matrix-js-sdk.js

@@ -157,10 +157,6 @@ export const mockGetGroupUsers = jest.fn(() => {
 
 export const mockGetUser = jest.fn().mockReturnValue({ presence: 'online'});
 
-export const mockSendStateEvent = jest.fn(() => {
-  return Promise.resolve();
-});
-
 export const mockClient = {
   registerRequest: mockRegisterRequest,
   initCrypto: mockInitCrypto,
@@ -190,7 +186,6 @@ export const mockClient = {
   getJoinedRoomMembers: mockGetJoinedRoomMembers,
   getUser: mockGetUser,
   getGroupUsers: mockGetGroupUsers,
-  sendStateEvent: mockSendStateEvent,
 }
 
 export const WebStorageSessionStore = jest.fn()

dist/bot.test.js

@@ -18,36 +18,6 @@ var _bot = _interopRequireDefault(require("./bot"));
 
 require('dotenv').config();
 
-const ENCRYPTION_CONFIG = {
-  algorithm: "m.megolm.v1.aes-sha2"
-};
-const KICK_REASON = "A facilitator has already joined this chat.";
-const BOT_ERROR_MESSAGE = "Something went wrong on our end, please restart the chat and try again.";
-const MAX_RETRIES = 3;
-const {
-  MATRIX_SERVER_URL,
-  BOT_USERNAME,
-  BOT_USERID,
-  BOT_PASSWORD,
-  BOT_DISPLAY_NAME,
-  FACILITATOR_ROOM_ID,
-  CHAT_OFFLINE_MESSAGE,
-  CAPTURE_TRANSCRIPTS
-} = process.env;
-const botConfig = {
-  ENCRYPTION_CONFIG,
-  KICK_REASON,
-  BOT_ERROR_MESSAGE,
-  MAX_RETRIES,
-  MATRIX_SERVER_URL,
-  BOT_USERNAME,
-  BOT_USERID,
-  BOT_PASSWORD,
-  BOT_DISPLAY_NAME,
-  FACILITATOR_ROOM_ID,
-  CHAT_OFFLINE_MESSAGE,
-  CAPTURE_TRANSCRIPTS
-};
 const mockAppendFileSync = jest.fn();
 fs.appendFileSync = mockAppendFileSync;
 describe('OcrccBot', () => {
@@ -103,21 +73,21 @@ describe('OcrccBot', () => {
     mockAppendFileSync.mockClear();
 
     _matrixJsSdk.mockGetGroupUsers.mockClear();
-
-    _matrixJsSdk.mockSendStateEvent.mockClear();
   });
   test('constructor should inititialize class variables', () => {
-    const bot = new _bot.default(botConfig);
+    const bot = new _bot.default();
     expect(bot.joinedRooms).toEqual([]);
+    expect(bot.awaitingFacilitator).toEqual({});
+    expect(bot.activeChatrooms).toEqual({});
   });
   test('#createLocalStorage should have correct storage location', () => {
-    const bot = new _bot.default(botConfig);
+    const bot = new _bot.default();
     const localStorage = bot.createLocalStorage();
     const localStoragePath = path.resolve(path.join(os.homedir(), ".local-storage", `matrix-chatbot-${process.env.BOT_USERNAME}`));
     expect(localStorage._location).toBe(localStoragePath);
   });
   test('#sendMessage should send a text message', () => {
-    const bot = new _bot.default(botConfig);
+    const bot = new _bot.default();
     bot.start();
     (0, _waitForExpect.default)(() => {
       expect(_matrixJsSdk.mockStartClient).toHaveBeenCalled();
@@ -133,7 +103,7 @@ describe('OcrccBot', () => {
     });
   });
   test('#inviteUserToRoom should add member to room and retry on rate limit error', () => {
-    const bot = new _bot.default(botConfig);
+    const bot = new _bot.default();
     bot.start();
     (0, _waitForExpect.default)(() => {
       expect(_matrixJsSdk.mockStartClient).toHaveBeenCalled();
@@ -144,7 +114,7 @@ describe('OcrccBot', () => {
     });
   });
   test('#kickUserFromRoom should remove member from room and retry on rate limit error', () => {
-    const bot = new _bot.default(botConfig);
+    const bot = new _bot.default();
     bot.start();
     (0, _waitForExpect.default)(() => {
       expect(_matrixJsSdk.mockStartClient).toHaveBeenCalled();
@@ -155,7 +125,7 @@ describe('OcrccBot', () => {
     });
   });
   test('#inviteFacilitators should invite all members from Facilitator room', () => {
-    const bot = new _bot.default(botConfig);
+    const bot = new _bot.default();
     bot.start();
     (0, _waitForExpect.default)(() => {
       expect(_matrixJsSdk.mockStartClient).toHaveBeenCalled();
@@ -172,7 +142,7 @@ describe('OcrccBot', () => {
     });
   });
   test('#uninviteFacilitators should remove all members that have not accepted the invite', () => {
-    const bot = new _bot.default(botConfig);
+    const bot = new _bot.default();
     bot.start();
     (0, _waitForExpect.default)(() => {
       expect(_matrixJsSdk.mockStartClient).toHaveBeenCalled();
@@ -189,7 +159,7 @@ describe('OcrccBot', () => {
     });
   });
   test('#handleBotCrash should notify rooms', () => {
-    const bot = new _bot.default(botConfig);
+    const bot = new _bot.default();
     bot.start();
     (0, _waitForExpect.default)(() => {
       expect(_matrixJsSdk.mockStartClient).toHaveBeenCalled();
@@ -203,9 +173,11 @@ describe('OcrccBot', () => {
     });
   });
   test('#writeToTranscript should parse event and write to transcript file', () => {
-    const bot = new _bot.default(botConfig);
+    const bot = new _bot.default();
     bot.start();
-    bot.localStorage.setItem(`test_room_id-transcript`, '__mocks__/test_transcript.txt');
+    bot.activeChatrooms['test_room_id'] = {
+      transcriptFile: '__mocks__/test_transcript.txt'
+    };
     (0, _waitForExpect.default)(() => {
       expect(_matrixJsSdk.mockStartClient).toHaveBeenCalled();
     });
@@ -227,7 +199,7 @@ describe('OcrccBot', () => {
     });
   });
   test('#deleteOldDevices should delete old sessions', () => {
-    const bot = new _bot.default(botConfig);
+    const bot = new _bot.default();
     bot.start();
     (0, _waitForExpect.default)(() => {
       expect(_matrixJsSdk.mockStartClient).toHaveBeenCalled();
@@ -245,7 +217,7 @@ describe('OcrccBot', () => {
   }); // TODO test listeners for membership events and message events
 
   test('#start should start bot and set up listeners', () => {
-    const bot = new _bot.default(botConfig);
+    const bot = new _bot.default();
     bot.start();
     (0, _waitForExpect.default)(() => {
       expect(_matrixJsSdk.mockLogin).toHaveBeenCalled();
@@ -278,16 +250,4 @@ describe('OcrccBot', () => {
       expect(_matrixJsSdk.mockStartClient).toHaveBeenCalled();
     });
   });
-  test('#sendBotSignal should send custom state event', () => {
-    const bot = new _bot.default(botConfig);
-    bot.start();
-    const test_room_id = 'test_room_id';
-    const signal = 'END_CHAT';
-    bot.sendBotSignal(test_room_id, signal);
-    (0, _waitForExpect.default)(() => {
-      expect(_matrixJsSdk.mockSendStateEvent).toHaveBeenCalledWith(test_room_id, 'm.bot.signal', {
-        signal
-      });
-    });
-  });
 });

dist/encrypt-attachment.js

@@ -1,173 +0,0 @@
-"use strict";
-
-// this is from https://github.com/matrix-org/browser-encrypt-attachment
-// which is the library used by matrix-reack-sdk to encrypt and decrypt attachments
-// just dropped in node-webcrypto-ossl to replace window.crypto
-// and Buffer for base64 encoding/decoding instead of window.btoa/window.atob
-
-/**
- * Encrypt an attachment.
- * @param {ArrayBuffer} plaintextBuffer The attachment data buffer.
- * @return {Promise} A promise that resolves with an object when the attachment is encrypted.
- *      The object has a "data" key with an ArrayBuffer of encrypted data and an "info" key
- *      with an object containing the info needed to decrypt the data.
- */
-const {
-  Crypto
-} = require("node-webcrypto-ossl");
-
-const crypto = new Crypto();
-
-function encryptAttachment(plaintextBuffer) {
-  var cryptoKey; // The AES key object.
-
-  var exportedKey; // The AES key exported as JWK.
-
-  var ciphertextBuffer; // ArrayBuffer of encrypted data.
-
-  var sha256Buffer; // ArrayBuffer of digest.
-
-  var ivArray; // Uint8Array of AES IV
-  // Generate an IV where the first 8 bytes are random and the high 8 bytes
-  // are zero. We set the counter low bits to 0 since it makes it unlikely
-  // that the 64 bit counter will overflow.
-
-  ivArray = new Uint8Array(16);
-  crypto.getRandomValues(ivArray.subarray(0, 8)); // Load the encryption key.
-
-  return crypto.subtle.generateKey({
-    "name": "AES-CTR",
-    length: 256
-  }, true, ["encrypt", "decrypt"]).then(function (generateKeyResult) {
-    cryptoKey = generateKeyResult; // Export the Key as JWK.
-
-    return crypto.subtle.exportKey("jwk", cryptoKey);
-  }).then(function (exportKeyResult) {
-    exportedKey = exportKeyResult; // Encrypt the input ArrayBuffer.
-    // Use half of the iv as the counter by setting the "length" to 64.
-
-    return crypto.subtle.encrypt({
-      name: "AES-CTR",
-      counter: ivArray,
-      length: 64
-    }, cryptoKey, plaintextBuffer);
-  }).then(function (encryptResult) {
-    ciphertextBuffer = encryptResult; // SHA-256 the encrypted data.
-
-    return crypto.subtle.digest("SHA-256", ciphertextBuffer);
-  }).then(function (digestResult) {
-    sha256Buffer = digestResult;
-    return {
-      data: ciphertextBuffer,
-      info: {
-        v: "v2",
-        key: exportedKey,
-        iv: encodeBase64(ivArray),
-        hashes: {
-          sha256: encodeBase64(new Uint8Array(sha256Buffer))
-        }
-      }
-    };
-  });
-}
-/**
- * Decrypt an attachment.
- * @param {ArrayBuffer} ciphertextBuffer The encrypted attachment data buffer.
- * @param {Object} info The information needed to decrypt the attachment.
- * @param {Object} info.key AES-CTR JWK key object.
- * @param {string} info.iv Base64 encoded 16 byte AES-CTR IV.
- * @param {string} info.hashes.sha256 Base64 encoded SHA-256 hash of the ciphertext.
- * @return {Promise} A promise that resolves with an ArrayBuffer when the attachment is decrypted.
- */
-
-
-function decryptAttachment(ciphertextBuffer, info) {
-  if (info === undefined || info.key === undefined || info.iv === undefined || info.hashes === undefined || info.hashes.sha256 === undefined) {
-    throw new Error("Invalid info. Missing info.key, info.iv or info.hashes.sha256 key");
-  }
-
-  var cryptoKey; // The AES key object.
-
-  var ivArray = decodeBase64(info.iv);
-  var expectedSha256base64 = info.hashes.sha256; // Load the AES from the "key" key of the info object.
-
-  return crypto.subtle.importKey("jwk", info.key, {
-    "name": "AES-CTR"
-  }, false, ["encrypt", "decrypt"]).then(function (importKeyResult) {
-    cryptoKey = importKeyResult; // Check the sha256 hash
-
-    return crypto.subtle.digest("SHA-256", ciphertextBuffer);
-  }).then(function (digestResult) {
-    if (encodeBase64(new Uint8Array(digestResult)) != expectedSha256base64) {
-      throw new Error("Mismatched SHA-256 digest");
-    }
-
-    var counterLength;
-
-    if (info.v == "v1" || info.v == "v2") {
-      // Version 1 and 2 use a 64 bit counter.
-      counterLength = 64;
-    } else {
-      // Version 0 uses a 128 bit counter.
-      counterLength = 128;
-    }
-
-    return crypto.subtle.decrypt({
-      name: "AES-CTR",
-      counter: ivArray,
-      length: counterLength
-    }, cryptoKey, ciphertextBuffer);
-  });
-}
-/**
- * Encode a typed array of uint8 as base64.
- * @param {Uint8Array} uint8Array The data to encode.
- * @return {string} The base64 without padding.
- */
-
-
-function encodeBase64(uint8Array) {
-  // Misinterpt the Uint8Array as Latin-1.
-  // window.btoa expects a unicode string with codepoints in the range 0-255.
-  var latin1String = String.fromCharCode.apply(null, uint8Array); // Use the builtin base64 encoder.
-  // var paddedBase64 = window.btoa(latin1String);
-
-  var paddedBase64 = Buffer.from(latin1String, 'binary').toString('base64'); // Calculate the unpadded length.
-
-  var inputLength = uint8Array.length;
-  var outputLength = 4 * Math.floor((inputLength + 2) / 3) + (inputLength + 2) % 3 - 2; // Return the unpadded base64.
-
-  return paddedBase64.slice(0, outputLength);
-}
-/**
- * Decode a base64 string to a typed array of uint8.
- * This will decode unpadded base64, but will also accept base64 with padding.
- * @param {string} base64 The unpadded base64 to decode.
- * @return {Uint8Array} The decoded data.
- */
-
-
-function decodeBase64(base64) {
-  // Pad the base64 up to the next multiple of 4.
-  var paddedBase64 = base64 + "===".slice(0, (4 - base64.length % 4) % 4); // Decode the base64 as a misinterpreted Latin-1 string.
-  // window.atob returns a unicode string with codepoints in the range 0-255.
-  // var latin1String = window.atob(paddedBase64);
-
-  var latin1String = Buffer.from(paddedBase64, 'base64').toString('binary'); // Encode the string as a Uint8Array as Latin-1.
-
-  var uint8Array = new Uint8Array(latin1String.length);
-
-  for (var i = 0; i < latin1String.length; i++) {
-    uint8Array[i] = latin1String.charCodeAt(i);
-  }
-
-  return uint8Array;
-}
-
-try {
-  exports.encryptAttachment = encryptAttachment;
-  exports.decryptAttachment = decryptAttachment;
-} catch (e) {// Ignore unknown variable "exports" errors when this is loaded directly into a browser
-  // This means that we can test it without having to use browserify.
-  // The intention is that the library is used using browserify.
-}

dist/index.js

@@ -2,14 +2,41 @@
 
 var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
 
-var _config = _interopRequireDefault(require("../config.json"));
-
 var _bot = _interopRequireDefault(require("./bot"));
 
-const bot = new _bot.default(_config.default);
+require('dotenv').config();
 
-try {
-  bot.start();
-} catch (err) {
-  console.log("Unable to start bot", err);
-}
+const ENCRYPTION_CONFIG = {
+  algorithm: "m.megolm.v1.aes-sha2"
+};
+const KICK_REASON = "A facilitator has already joined this chat.";
+const BOT_ERROR_MESSAGE = "Something went wrong on our end, please restart the chat and try again.";
+const MAX_RETRIES = 3;
+const {
+  MATRIX_SERVER_URL,
+  BOT_USERNAME,
+  BOT_USERID,
+  BOT_PASSWORD,
+  BOT_DISPLAY_NAME,
+  FACILITATOR_GROUP_ID,
+  FACILITATOR_ROOM_ID,
+  CHAT_OFFLINE_MESSAGE,
+  CAPTURE_TRANSCRIPTS
+} = process.env;
+const botConfig = {
+  ENCRYPTION_CONFIG,
+  KICK_REASON,
+  BOT_ERROR_MESSAGE,
+  MAX_RETRIES,
+  MATRIX_SERVER_URL,
+  BOT_USERNAME,
+  BOT_USERID,
+  BOT_PASSWORD,
+  BOT_DISPLAY_NAME,
+  FACILITATOR_GROUP_ID,
+  FACILITATOR_ROOM_ID,
+  CHAT_OFFLINE_MESSAGE,
+  CAPTURE_TRANSCRIPTS
+};
+const bot = new _bot.default(botConfig);
+bot.start();

dist/setup.js

@@ -1,54 +0,0 @@
-"use strict";
-
-const fs = require('fs');
-
-const fetch = require('node-fetch');
-
-const config = require('../config.json');
-
-const getSettings = async () => {
-  try {
-    const url = `${config.settingsEndpoint}?homeserver=${encodeURIComponent(config.matrixServerUrl)}`;
-
-    if (!config.matrixServerUrl) {
-      throw new Error("The matrix server url is not provided");
-    }
-
-    console.log(`Fetching settings for ${config.matrixServerUrl}`);
-    const res = await fetch(url);
-    const data = await res.json();
-    const {
-      fields,
-      schedule = []
-    } = data;
-    return Object.entries(fields).reduce((settingsObj, [k, v]) => {
-      const [scope, key] = k.split('_');
-
-      if (scope === 'platform') {
-        settingsObj[key] = v;
-      }
-
-      return settingsObj;
-    }, {});
-  } catch (err) {
-    console.log("Error fetching settings", err);
-    return null;
-  }
-};
-
-const writeConfig = async () => {
-  const settings = await getSettings();
-
-  if (!settings) {
-    return console.log('No settings to update');
-  }
-
-  const updatedSettings = Object.assign(config, settings);
-  fs.writeFile('config.json', JSON.stringify(updatedSettings, null, 2), function (err) {
-    if (err) return console.log("Error updating settings", err);
-    console.log(`Updated settings to config.json`);
-    console.log(updatedSettings);
-  });
-};
-
-writeConfig();

package.json

@@ -1,12 +1,11 @@
 {
-  "name": "private-safesupport-bot",
-  "version": "3.1.0",
+  "name": "safesupport-bot",
+  "version": "1.0.0",
   "description": "Chatbot to manage interactions on Safe Support Chat",
   "main": "dist/index.js",
   "scripts": {
     "develop": "nodemon --exec babel-node src/index.js",
     "build": "babel src -d dist",
-    "setup": "node src/setup.js",
     "start": "yarn build && node dist/index.js",
     "test": "jest"
   },
@@ -14,10 +13,8 @@
   "license": "ISC",
   "dependencies": {
     "dotenv": "^8.2.0",
-    "matrix-js-sdk": "^6.2.1",
-    "node-fetch": "^2.6.1",
+    "matrix-js-sdk": "^5.0.1",
     "node-localstorage": "^2.1.5",
-    "node-webcrypto-ossl": "^2.1.0",
     "olm": "https://packages.matrix.org/npm/olm/olm-3.1.4.tgz",
     "uuidv4": "^6.0.2",
     "winston": "^3.2.1"

sample.config.json

@@ -1,16 +0,0 @@
-{
-  "matrixServerUrl": "",
-  "settingsEndpoint": "",
-  "facilitatorRoomId": "",
-  "kickReason": "A facilitator has already joined this chat.",
-  "botErrorMessage": "Something went wrong on our end, please restart the chat and try again.",
-  "botUserId": "",
-  "botUsername": "",
-  "botPassword": "",
-  "botDisplayName": "Help Bot",
-  "captureTranscripts": true,
-  "chatNotAvailableMessage": "The support chat is not available right now.",
-  "chatInactiveMessage": "This chat has been closed due to inactivity.",
-  "maxWaitTime": 180,
-  "maxInactiveTime": 3600
-}

src/bot.test.js

@@ -32,8 +32,7 @@ import {
   mockKick,
   mockGetJoinedRoomMembers,
   mockGetUser,
-  mockGetGroupUsers,
-  mockSendStateEvent,
+  mockGetGroupUsers
 } from "matrix-js-sdk";
 
 import OcrccBot from './bot'
@@ -49,6 +48,7 @@ const {
   BOT_USERID,
   BOT_PASSWORD,
   BOT_DISPLAY_NAME,
+  FACILITATOR_GROUP_ID,
   FACILITATOR_ROOM_ID,
   CHAT_OFFLINE_MESSAGE,
   CAPTURE_TRANSCRIPTS
@@ -64,6 +64,7 @@ const botConfig = {
   BOT_USERID,
   BOT_PASSWORD,
   BOT_DISPLAY_NAME,
+  FACILITATOR_GROUP_ID,
   FACILITATOR_ROOM_ID,
   CHAT_OFFLINE_MESSAGE,
   CAPTURE_TRANSCRIPTS
@@ -101,7 +102,6 @@ describe('OcrccBot', () => {
     mockSendTextMessage.mockClear()
     mockAppendFileSync.mockClear()
     mockGetGroupUsers.mockClear()
-    mockSendStateEvent.mockClear()
   })
 
 
@@ -327,17 +327,4 @@ describe('OcrccBot', () => {
       expect(mockStartClient).toHaveBeenCalled()
     })
   })
-
-  test('#sendBotSignal should send custom state event', () => {
-    const bot = new OcrccBot(botConfig)
-    bot.start()
-    const test_room_id = 'test_room_id'
-    const signal = 'END_CHAT'
-
-    bot.sendBotSignal(test_room_id, signal)
-
-    waitForExpect(() => {
-      expect(mockSendStateEvent).toHaveBeenCalledWith(test_room_id, 'm.bot.signal', { signal })
-    })
-  })
 })

src/encrypt-attachment.js

@@ -1,156 +0,0 @@
-// this is from https://github.com/matrix-org/browser-encrypt-attachment
-// which is the library used by matrix-reack-sdk to encrypt and decrypt attachments
-// just dropped in node-webcrypto-ossl to replace window.crypto
-// and Buffer for base64 encoding/decoding instead of window.btoa/window.atob
-
-
-/**
- * Encrypt an attachment.
- * @param {ArrayBuffer} plaintextBuffer The attachment data buffer.
- * @return {Promise} A promise that resolves with an object when the attachment is encrypted.
- *      The object has a "data" key with an ArrayBuffer of encrypted data and an "info" key
- *      with an object containing the info needed to decrypt the data.
- */
-
-const { Crypto } = require("node-webcrypto-ossl");
-const crypto = new Crypto();
-
-function encryptAttachment(plaintextBuffer) {
-    var cryptoKey; // The AES key object.
-    var exportedKey; // The AES key exported as JWK.
-    var ciphertextBuffer; // ArrayBuffer of encrypted data.
-    var sha256Buffer; // ArrayBuffer of digest.
-    var ivArray; // Uint8Array of AES IV
-    // Generate an IV where the first 8 bytes are random and the high 8 bytes
-    // are zero. We set the counter low bits to 0 since it makes it unlikely
-    // that the 64 bit counter will overflow.
-    ivArray = new Uint8Array(16);
-    crypto.getRandomValues(ivArray.subarray(0,8));
-    // Load the encryption key.
-    return crypto.subtle.generateKey(
-        {"name": "AES-CTR", length: 256}, true, ["encrypt", "decrypt"]
-    ).then(function(generateKeyResult) {
-        cryptoKey = generateKeyResult;
-        // Export the Key as JWK.
-        return crypto.subtle.exportKey("jwk", cryptoKey);
-    }).then(function(exportKeyResult) {
-        exportedKey = exportKeyResult;
-        // Encrypt the input ArrayBuffer.
-        // Use half of the iv as the counter by setting the "length" to 64.
-        return crypto.subtle.encrypt(
-            {name: "AES-CTR", counter: ivArray, length: 64}, cryptoKey, plaintextBuffer
-        );
-    }).then(function(encryptResult) {
-        ciphertextBuffer = encryptResult;
-        // SHA-256 the encrypted data.
-        return crypto.subtle.digest("SHA-256", ciphertextBuffer);
-    }).then(function (digestResult) {
-        sha256Buffer = digestResult;
-
-        return {
-            data: ciphertextBuffer,
-            info: {
-                v: "v2",
-                key: exportedKey,
-                iv: encodeBase64(ivArray),
-                hashes: {
-                    sha256: encodeBase64(new Uint8Array(sha256Buffer)),
-                },
-            },
-        };
-    });
-}
-
-/**
- * Decrypt an attachment.
- * @param {ArrayBuffer} ciphertextBuffer The encrypted attachment data buffer.
- * @param {Object} info The information needed to decrypt the attachment.
- * @param {Object} info.key AES-CTR JWK key object.
- * @param {string} info.iv Base64 encoded 16 byte AES-CTR IV.
- * @param {string} info.hashes.sha256 Base64 encoded SHA-256 hash of the ciphertext.
- * @return {Promise} A promise that resolves with an ArrayBuffer when the attachment is decrypted.
- */
-function decryptAttachment(ciphertextBuffer, info) {
-
-    if (info === undefined || info.key === undefined || info.iv === undefined
-        || info.hashes === undefined || info.hashes.sha256 === undefined) {
-       throw new Error("Invalid info. Missing info.key, info.iv or info.hashes.sha256 key");
-    }
-
-    var cryptoKey; // The AES key object.
-    var ivArray = decodeBase64(info.iv);
-    var expectedSha256base64 = info.hashes.sha256;
-    // Load the AES from the "key" key of the info object.
-    return crypto.subtle.importKey(
-        "jwk", info.key, {"name": "AES-CTR"}, false, ["encrypt", "decrypt"]
-    ).then(function (importKeyResult) {
-        cryptoKey = importKeyResult;
-        // Check the sha256 hash
-        return crypto.subtle.digest("SHA-256", ciphertextBuffer);
-    }).then(function (digestResult) {
-        if (encodeBase64(new Uint8Array(digestResult)) != expectedSha256base64) {
-            throw new Error("Mismatched SHA-256 digest");
-        }
-        var counterLength;
-        if (info.v == "v1" || info.v == "v2") {
-            // Version 1 and 2 use a 64 bit counter.
-            counterLength = 64;
-        } else {
-            // Version 0 uses a 128 bit counter.
-            counterLength = 128;
-        }
-        return crypto.subtle.decrypt(
-            {name: "AES-CTR", counter: ivArray, length: counterLength}, cryptoKey, ciphertextBuffer
-        );
-    });
-}
-
-/**
- * Encode a typed array of uint8 as base64.
- * @param {Uint8Array} uint8Array The data to encode.
- * @return {string} The base64 without padding.
- */
-function encodeBase64(uint8Array) {
-    // Misinterpt the Uint8Array as Latin-1.
-    // window.btoa expects a unicode string with codepoints in the range 0-255.
-    var latin1String = String.fromCharCode.apply(null, uint8Array);
-    // Use the builtin base64 encoder.
-    // var paddedBase64 = window.btoa(latin1String);
-    var paddedBase64 = Buffer.from(latin1String, 'binary').toString('base64')
-    // Calculate the unpadded length.
-    var inputLength = uint8Array.length;
-    var outputLength = 4 * Math.floor((inputLength + 2) / 3) + (inputLength + 2) % 3 - 2;
-    // Return the unpadded base64.
-    return paddedBase64.slice(0, outputLength);
-}
-
-/**
- * Decode a base64 string to a typed array of uint8.
- * This will decode unpadded base64, but will also accept base64 with padding.
- * @param {string} base64 The unpadded base64 to decode.
- * @return {Uint8Array} The decoded data.
- */
-function decodeBase64(base64) {
-    // Pad the base64 up to the next multiple of 4.
-    var paddedBase64 = base64 + "===".slice(0, (4 - base64.length % 4) % 4);
-    // Decode the base64 as a misinterpreted Latin-1 string.
-    // window.atob returns a unicode string with codepoints in the range 0-255.
-    // var latin1String = window.atob(paddedBase64);
-    var latin1String = Buffer.from(paddedBase64, 'base64').toString('binary')
-    // Encode the string as a Uint8Array as Latin-1.
-    var uint8Array = new Uint8Array(latin1String.length);
-    for (var i = 0; i < latin1String.length; i++) {
-        uint8Array[i] = latin1String.charCodeAt(i);
-    }
-    return uint8Array;
-}
-
-try {
-    exports.encryptAttachment = encryptAttachment;
-    exports.decryptAttachment = decryptAttachment;
-}
-catch (e) {
-    // Ignore unknown variable "exports" errors when this is loaded directly into a browser
-    // This means that we can test it without having to use browserify.
-    // The intention is that the library is used using browserify.
-}

src/index.js

@@ -1,9 +1,39 @@
-import config from '../config.json';
-import OcrccBot from './bot';
+require('dotenv').config()
 
-const bot = new OcrccBot(config);
-try {
-  bot.start();
-} catch(err) {
-  console.log("Unable to start bot", err)
+const ENCRYPTION_CONFIG = { algorithm: "m.megolm.v1.aes-sha2" };
+const KICK_REASON = "A facilitator has already joined this chat.";
+const BOT_ERROR_MESSAGE =
+  "Something went wrong on our end, please restart the chat and try again.";
+const MAX_RETRIES = 3;
+const {
+  MATRIX_SERVER_URL,
+  BOT_USERNAME,
+  BOT_USERID,
+  BOT_PASSWORD,
+  BOT_DISPLAY_NAME,
+  FACILITATOR_GROUP_ID,
+  FACILITATOR_ROOM_ID,
+  CHAT_OFFLINE_MESSAGE,
+  CAPTURE_TRANSCRIPTS
+} = process.env;
+
+const botConfig = {
+  ENCRYPTION_CONFIG,
+  KICK_REASON,
+  BOT_ERROR_MESSAGE,
+  MAX_RETRIES,
+  MATRIX_SERVER_URL,
+  BOT_USERNAME,
+  BOT_USERID,
+  BOT_PASSWORD,
+  BOT_DISPLAY_NAME,
+  FACILITATOR_GROUP_ID,
+  FACILITATOR_ROOM_ID,
+  CHAT_OFFLINE_MESSAGE,
+  CAPTURE_TRANSCRIPTS
 }
+
+import OcrccBot from './bot'
+
+const bot = new OcrccBot(botConfig);
+bot.start();

src/setup.js

@@ -1,50 +0,0 @@
-const fs = require('fs');
-const fetch = require('node-fetch');
-const config = require('../config.json');
-
-const getSettings = async () => {
-  try {
-    const url = `${config.settingsEndpoint}?homeserver=${encodeURIComponent(config.matrixServerUrl)}`;
-
-    if (!config.matrixServerUrl) {
-      throw new Error("The matrix server url is not provided")
-    }
-
-    console.log(`Fetching settings for ${config.matrixServerUrl}`);
-
-    const res = await fetch(url);
-    const data = await res.json();
-
-    const { fields, schedule = [] } = data;
-
-    return Object.entries(fields).reduce(((settingsObj, [k,v]) => {
-      const [scope, key] = k.split('_');
-
-      if (scope === 'platform') {
-        settingsObj[key] = v;
-      }
-
-      return settingsObj
-    }), {});
-  } catch (err) {
-    console.log("Error fetching settings", err);
-    return null
-  }
-};
-
-const writeConfig = async () => {
-  const settings = await getSettings()
-  if (!settings) {
-    return console.log('No settings to update')
-  }
-
-  const updatedSettings = Object.assign(config, settings)
-
-  fs.writeFile('config.json', JSON.stringify(updatedSettings, null, 2), function (err) {
-    if (err) return console.log("Error updating settings", err);
-    console.log(`Updated settings to config.json`);
-    console.log(updatedSettings);
-  });
-}
-
-writeConfig();

yarn.lock

@@ -1257,23 +1257,6 @@
     "@types/yargs" "^15.0.0"
     chalk "^3.0.0"
 
-"@peculiar/asn1-schema@^2.0.1":
-  version "2.0.8"
-  resolved "https://registry.yarnpkg.com/@peculiar/asn1-schema/-/asn1-schema-2.0.8.tgz#bafb74388590f6ec3d53d1b2a4fdbe66d44224a4"
-  integrity sha512-D8ZqT61DdzuXfrILNvtdf7MUcTY2o9WHwmF0WgTKPEGNY5SDxNAjBY3enuwV9SXcSuCAwWac9c9v0vsswB1NIw==
-  dependencies:
-    "@types/asn1js" "^0.0.1"
-    asn1js "^2.0.26"
-    pvtsutils "^1.0.10"
-    tslib "^1.11.1"
-
-"@peculiar/json-schema@^1.1.10":
-  version "1.1.12"
-  resolved "https://registry.yarnpkg.com/@peculiar/json-schema/-/json-schema-1.1.12.tgz#fe61e85259e3b5ba5ad566cb62ca75b3d3cd5339"
-  integrity sha512-coUfuoMeIB7B8/NMekxaDzLhaYmp0HZNPEjYRm9goRou8UZIC3z21s0sL9AWoCw4EG876QyO3kYrc61WNF9B/w==
-  dependencies:
-    tslib "^2.0.0"
-
 "@sinonjs/commons@^1.7.0":
   version "1.7.1"
   resolved "https://registry.yarnpkg.com/@sinonjs/commons/-/commons-1.7.1.tgz#da5fd19a5f71177a53778073978873964f49acf1"
@@ -1281,13 +1264,6 @@
   dependencies:
     type-detect "4.0.8"
 
-"@types/asn1js@^0.0.1":
-  version "0.0.1"
-  resolved "https://registry.yarnpkg.com/@types/asn1js/-/asn1js-0.0.1.tgz#ef8b9f9708cb1632a1c3a9cd27717caabe793bc2"
-  integrity sha1-74uflwjLFjKhw6nNJ3F8qr55O8I=
-  dependencies:
-    "@types/pvutils" "*"
-
 "@types/babel__core@^7.1.0":
   version "7.1.6"
   resolved "https://registry.yarnpkg.com/@types/babel__core/-/babel__core-7.1.6.tgz#16ff42a5ae203c9af1c6e190ed1f30f83207b610"
@@ -1346,11 +1322,6 @@
     "@types/istanbul-lib-coverage" "*"
     "@types/istanbul-lib-report" "*"
 
-"@types/pvutils@*":
-  version "0.0.2"
-  resolved "https://registry.yarnpkg.com/@types/pvutils/-/pvutils-0.0.2.tgz#e21684962cfa58ac920fd576d90556032dc86009"
-  integrity sha512-CgQAm7pjyeF3Gnv78ty4RBVIfluB+Td+2DR8iPaU0prF18pkzptHHP+DoKPfpsJYknKsVZyVsJEu5AuGgAqQ5w==
-
 "@types/stack-utils@^1.0.1":
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/@types/stack-utils/-/stack-utils-1.0.1.tgz#0a851d3bd96498fa25c33ab7278ed3bd65f06c3e"
@@ -1515,13 +1486,6 @@ asn1@~0.2.3:
   dependencies:
     safer-buffer "~2.1.0"
 
-asn1js@^2.0.26:
-  version "2.0.26"
-  resolved "https://registry.yarnpkg.com/asn1js/-/asn1js-2.0.26.tgz#0a6d435000f556a96c6012969d9704d981b71251"
-  integrity sha512-yG89F0j9B4B0MKIcFyWWxnpZPLaNTjCj4tkE3fjbAoo0qmpGw0PYYqSbX/4ebnd9Icn8ZgK4K1fvDyEtW1JYtQ==
-  dependencies:
-    pvutils latest
-
 assert-plus@1.0.0, assert-plus@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/assert-plus/-/assert-plus-1.0.0.tgz#f12e0f3c5d77b0b1cdd9146942e4e96c1e4dd525"
@@ -3798,10 +3762,10 @@ map-visit@^1.0.0:
   dependencies:
     object-visit "^1.0.0"
 
-matrix-js-sdk@^6.2.1:
-  version "6.2.1"
-  resolved "https://registry.yarnpkg.com/matrix-js-sdk/-/matrix-js-sdk-6.2.1.tgz#d5f76491a650c0a36fcdd078cff59f2da96edd7b"
-  integrity sha512-X12Y2SMg8MOJwE5P3VMsMV/mnQHOmyJkF+FZRida124w4B4tBJouaNxteYyYaH34w+wyaKGxuqEBXecfSpfvbw==
+matrix-js-sdk@^5.0.1:
+  version "5.1.0"
+  resolved "https://registry.yarnpkg.com/matrix-js-sdk/-/matrix-js-sdk-5.1.0.tgz#9b3b02af227ecc2d0cc35fb7312c92b8a6754293"
+  integrity sha512-IGRq5iACiKp3iIxAghwtdBPrbdgORowc0i8YuIMkZZMpRJDXnNaudt2BFwyQdukV7gvzz7F0sfxBUerySfOnKA==
   dependencies:
     "@babel/runtime" "^7.8.3"
     another-json "^0.2.0"
@@ -3899,11 +3863,6 @@ mkdirp@^0.5.1:
   dependencies:
     minimist "0.0.8"
 
-mkdirp@^1.0.4:
-  version "1.0.4"
-  resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-1.0.4.tgz#3eb5ed62622756d79a5f0e2a221dfebad75c2f7e"
-  integrity sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==
-
 ms@2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/ms/-/ms-2.0.0.tgz#5608aeadfc00be6c2901df5f9861788de0d597c8"
@@ -3914,7 +3873,7 @@ ms@^2.1.1:
   resolved "https://registry.yarnpkg.com/ms/-/ms-2.1.2.tgz#d09d1f357b443f493382a8eb3ccd183872ae6009"
   integrity sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==
 
-nan@^2.12.1, nan@^2.14.1:
+nan@^2.12.1:
   version "2.14.1"
   resolved "https://registry.yarnpkg.com/nan/-/nan-2.14.1.tgz#d7be34dfa3105b91494c3147089315eff8874b01"
   integrity sha512-isWHgVjnFjh2x2yuJ/tj3JbwoHu3UC2dX5G/88Cm24yB6YopVgxvBObDY7n5xW6ExmFhJpSEQqFPvq9zaXc8Jw==
@@ -3954,11 +3913,6 @@ node-environment-flags@^1.0.5:
     object.getownpropertydescriptors "^2.0.3"
     semver "^5.7.0"
 
-node-fetch@^2.6.1:
-  version "2.6.1"
-  resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.1.tgz#045bd323631f76ed2e2b55573394416b639a0052"
-  integrity sha512-V4aYg89jEoVRxRb2fJdAg8FHvI7cEyYdVAh94HH0UIK8oJxUfkjlDQN9RbMx+bEjP7+ggMiFRprSti032Oipxw==
-
 node-int64@^0.4.0:
   version "0.4.0"
   resolved "https://registry.yarnpkg.com/node-int64/-/node-int64-0.4.0.tgz#87a9065cdb355d3182d8f94ce11188b825c68a3b"
@@ -3999,17 +3953,6 @@ node-releases@^1.1.53:
   resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-1.1.53.tgz#2d821bfa499ed7c5dffc5e2f28c88e78a08ee3f4"
   integrity sha512-wp8zyQVwef2hpZ/dJH7SfSrIPD6YoJz6BDQDpGEkcA0s3LpAQoxBIYmfIq6QAhC1DhwsyCgTaTTcONwX8qzCuQ==
 
-node-webcrypto-ossl@^2.1.0:
-  version "2.1.0"
-  resolved "https://registry.yarnpkg.com/node-webcrypto-ossl/-/node-webcrypto-ossl-2.1.0.tgz#cee0e22fa9d9325a19f260539d0854ba143595db"
-  integrity sha512-diC2LLQKKo41XxrgdT2MmH4mxWNoeCwjS0+uSLfui3rCtxai8cdLLs0TKT0z9Mq8LZ4eMAkuU4FFmEOHk6CbsQ==
-  dependencies:
-    mkdirp "^1.0.4"
-    nan "^2.14.1"
-    pvtsutils "^1.0.10"
-    tslib "^1.11.2"
-    webcrypto-core "^1.1.0"
-
 nodemon@^2.0.2:
   version "2.0.2"
   resolved "https://registry.yarnpkg.com/nodemon/-/nodemon-2.0.2.tgz#9c7efeaaf9b8259295a97e5d4585ba8f0cbe50b0"
@@ -4411,18 +4354,6 @@ punycode@^2.1.0, punycode@^2.1.1:
   resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.1.1.tgz#b58b010ac40c22c5657616c8d2c2c02c7bf479ec"
   integrity sha512-XRsRjdf+j5ml+y/6GKHPZbrF/8p2Yga0JPtdqTIY2Xe5ohJPD9saDJJLPvp9+NSBprVvevdXZybnj2cv8OEd0A==
 
-pvtsutils@^1.0.10:
-  version "1.0.10"
-  resolved "https://registry.yarnpkg.com/pvtsutils/-/pvtsutils-1.0.10.tgz#157d0fcb853f570d32e0f8788179f3057eacdf38"
-  integrity sha512-8ZKQcxnZKTn+fpDh7wL4yKax5fdl3UJzT8Jv49djZpB/dzPxacyN1Sez90b6YLdOmvIr9vaySJ5gw4aUA1EdSw==
-  dependencies:
-    tslib "^1.10.0"
-
-pvutils@latest:
-  version "1.0.17"
-  resolved "https://registry.yarnpkg.com/pvutils/-/pvutils-1.0.17.tgz#ade3c74dfe7178944fe44806626bd2e249d996bf"
-  integrity sha512-wLHYUQxWaXVQvKnwIDWFVKDJku9XDCvyhhxoq8dc5MFdIlRenyPI9eSfEtcvgHgD7FlvCyGAlWgOzRnZD99GZQ==
-
 qs@^6.5.2:
   version "6.9.1"
   resolved "https://registry.yarnpkg.com/qs/-/qs-6.9.1.tgz#20082c65cb78223635ab1a9eaca8875a29bf8ec9"
@@ -5230,16 +5161,6 @@ triple-beam@^1.2.0, triple-beam@^1.3.0:
   resolved "https://registry.yarnpkg.com/triple-beam/-/triple-beam-1.3.0.tgz#a595214c7298db8339eeeee083e4d10bd8cb8dd9"
   integrity sha512-XrHUvV5HpdLmIj4uVMxHggLbFSZYIn7HEWsqePZcI50pco+MPqJ50wMGY794X7AOOhxOBAjbkqfAbEe/QMp2Lw==
 
-tslib@^1.10.0, tslib@^1.11.1, tslib@^1.11.2:
-  version "1.13.0"
-  resolved "https://registry.yarnpkg.com/tslib/-/tslib-1.13.0.tgz#c881e13cc7015894ed914862d276436fa9a47043"
-  integrity sha512-i/6DQjL8Xf3be4K/E6Wgpekn5Qasl1usyw++dAA35Ue5orEn65VIxOA+YvNNl9HV3qv70T7CNwjODHZrLwvd1Q==
-
-tslib@^2.0.0:
-  version "2.0.0"
-  resolved "https://registry.yarnpkg.com/tslib/-/tslib-2.0.0.tgz#18d13fc2dce04051e20f074cc8387fd8089ce4f3"
-  integrity sha512-lTqkx847PI7xEDYJntxZH89L2/aXInsyF2luSafe/+0fHOMjlBNXdH6th7f70qxLDhul7KZK0zC8V5ZIyHl0/g==
-
 tunnel-agent@^0.6.0:
   version "0.6.0"
   resolved "https://registry.yarnpkg.com/tunnel-agent/-/tunnel-agent-0.6.0.tgz#27a5dea06b36b04a0a9966774b290868f0fc40fd"
@@ -5471,17 +5392,6 @@ walker@^1.0.7, walker@~1.0.5:
   dependencies:
     makeerror "1.0.x"
 
-webcrypto-core@^1.1.0:
-  version "1.1.2"
-  resolved "https://registry.yarnpkg.com/webcrypto-core/-/webcrypto-core-1.1.2.tgz#c522a9e5596688f2b6bb19e2d336f68efa8bdd57"
-  integrity sha512-LxM/dTcXr/ZnwwKLox0tGEOIqvP7KIJ4Hk/fFPX20tr1EgqTmpEFZinmu4FzoGVbs6e4jI1priQKCDrOBD3L6w==
-  dependencies:
-    "@peculiar/asn1-schema" "^2.0.1"
-    "@peculiar/json-schema" "^1.1.10"
-    asn1js "^2.0.26"
-    pvtsutils "^1.0.10"
-    tslib "^1.11.2"
-
 webidl-conversions@^4.0.2:
   version "4.0.2"
   resolved "https://registry.yarnpkg.com/webidl-conversions/-/webidl-conversions-4.0.2.tgz#a855980b1f0b6b359ba1d5d9fb39ae941faa63ad"