supoort native encryption

config/default.yaml

@@ -9,6 +9,19 @@ rawHomeserverUrl: "https://matrix.org"
 # Matrix Access Token to use, Mjolnir will only use this if pantalaimon.use is false.
 accessToken: "YOUR_TOKEN_HERE"
 
+# Options related to native encryption
+encryption:
+  # whether to use native encryption in mjolnir, rather than using pantalaimon as a proxy
+  # note that if encryption is enabled here, pantaliamon must be disabled, and vice versa
+  use: true
+
+  # the username to log in with
+  username: "mjolnir"
+
+  # the password to log in with
+  password: "password"
+
+
 # Options related to Pantalaimon (https://github.com/matrix-org/pantalaimon)
 pantalaimon:
   # Whether or not Mjolnir will use pantalaimon to access the matrix homeserver,

config/harness.yaml

@@ -9,14 +9,19 @@ homeserverUrl: "http://localhost:8081"
 # Where the homeserver is located (client-server URL). NOT pantalaimon.
 rawHomeserverUrl: "http://localhost:8081"
 
+encryption:
+  use: true
+  username: test
+  password: testPassword
+
 # README: We use the Pantalaimon client WITHOUT Pantalaimon itself in tests (and the manual test)
 # as an easy way to login with passwords from the config without having
 # to resolve a chicken-vs-egg problem in regards to access tokens.
 # Pantalaimon options (https://github.com/matrix-org/pantalaimon)
 pantalaimon:
   # If true, accessToken above is ignored and the username/password below will be
   # used instead. The access token of the bot will be stored in the dataPath.
-  use: true
+  use: false
 
   # The username to login with.
   username: mjolnir

package.json

@@ -63,7 +63,8 @@
     "prom-client": "^14.1.0",
     "shell-quote": "^1.7.3",
     "ulidx": "^0.3.0",
-    "yaml": "^2.2.2"
+    "yaml": "^2.2.2",
+    "@vector-im/matrix-bot-sdk": "^0.7.1-element.0"
   },
   "engines": {
     "node": ">=18.0.0"

src/ManagementRoomOutput.ts

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import * as Sentry from "@sentry/node";
-import { extractRequestError, LogLevel, LogService, MessageType, Permalinks, TextualMessageEventContent, UserID } from "matrix-bot-sdk";
+import { extractRequestError, LogLevel, LogService, MessageType, Permalinks, TextualMessageEventContent, UserID } from "@vector-im/matrix-bot-sdk";
 import { IConfig } from "./config";
 import { MatrixSendClient } from "./MatrixEmitter";
 import { htmlEscape } from "./utils";

src/MatrixEmitter.ts

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import EventEmitter from "events";
-import { MatrixClient } from "matrix-bot-sdk";
+import { MatrixClient } from "@vector-im/matrix-bot-sdk";
 
 /**
  * This is an interface created in order to keep the event listener

src/Mjolnir.ts

@@ -19,7 +19,8 @@ import {
     LogLevel,
     LogService,
     MembershipEvent,
-} from "matrix-bot-sdk";
+    MatrixClient
+} from "@vector-im/matrix-bot-sdk";
 
 import { ALL_RULE_TYPES as ALL_BAN_LIST_RULE_TYPES } from "./models/ListRule";
 import { COMMAND_PREFIX, handleCommand } from "./commands/CommandHandler";
@@ -136,10 +137,10 @@ export class Mjolnir {
 
     /**
      * Create a new Mjolnir instance from a client and the options in the configuration file, ready to be started.
-     * @param {MatrixSendClient} client The client for Mjolnir to use.
+     * @param {MatrixClient} client The client for Mjolnir to use.
      * @returns A new Mjolnir instance that can be started without further setup.
      */
-    static async setupMjolnirFromConfig(client: MatrixSendClient, matrixEmitter: MatrixEmitter, config: IConfig): Promise<Mjolnir> {
+    static async setupMjolnirFromConfig(client: MatrixClient, matrixEmitter: MatrixEmitter, config: IConfig): Promise<Mjolnir> {
         if (!config.autojoinOnlyIfManager && config.acceptInvitesFromSpace === getDefaultConfig().acceptInvitesFromSpace) {
             throw new TypeError("`autojoinOnlyIfManager` has been disabled but you have not set `acceptInvitesFromSpace`. Please make it empty to accept invites from everywhere or give it a namespace alias or room id.");
         }

src/ProtectedRoomsConfig.ts

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import AwaitLock from 'await-lock';
-import { extractRequestError, LogService, Permalinks } from "matrix-bot-sdk";
+import { extractRequestError, LogService, Permalinks } from "@vector-im/matrix-bot-sdk";
 import { IConfig } from "./config";
 import { MatrixSendClient } from './MatrixEmitter';
 const PROTECTED_ROOMS_EVENT_TYPE = "org.matrix.mjolnir.protected_rooms";

src/ProtectedRoomsSet.ts

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import { LogLevel, LogService, MatrixGlob, Permalinks, UserID } from "matrix-bot-sdk";
+import { LogLevel, LogService, MatrixGlob, Permalinks, UserID } from "@vector-im/matrix-bot-sdk";
 import { IConfig } from "./config";
 import ErrorCache, { ERROR_KIND_FATAL, ERROR_KIND_PERMISSION } from "./ErrorCache";
 import ManagementRoomOutput from "./ManagementRoomOutput";

src/appservice/AccessControl.ts

@@ -17,7 +17,7 @@ limitations under the License.
 import { Bridge } from "matrix-appservice-bridge";
 import AccessControlUnit, { EntityAccess } from "../models/AccessControlUnit";
 import PolicyList from "../models/PolicyList";
-import { Permalinks } from "matrix-bot-sdk";
+import { Permalinks } from "@vector-im/matrix-bot-sdk";
 
 /**
  * Utility to manage which users have access to the application service,
@@ -47,6 +47,7 @@ export class AccessControl {
         const accessControlList = new PolicyList(
             accessControlListId,
             Permalinks.forRoom(accessControlListId),
+            // @ts-ignore
             bridge.getBot().getClient()
         );
         const accessControlUnit = new AccessControlUnit([accessControlList]);

src/appservice/MjolnirManager.ts

@@ -3,7 +3,7 @@ import { Request, WeakEvent, BridgeContext, Bridge, Intent, Logger } from "matri
 import { getProvisionedMjolnirConfig } from "../config";
 import { IConfig as IAppserviceConfig } from "./config/config";
 import PolicyList from "../models/PolicyList";
-import { Permalinks, MatrixClient } from "matrix-bot-sdk";
+import { Permalinks, MatrixClient } from "@vector-im/matrix-bot-sdk";
 import { DataStore } from "./datastore";
 import { AccessControl } from "./AccessControl";
 import { Access } from "../models/AccessControlUnit";
@@ -140,7 +140,7 @@ export class MjolnirManager {
                 invite: [requestingUserId],
                 name: `${requestingUserId}'s mjolnir`
             });
-
+            // @ts-ignore
             const mjolnir = await this.makeInstance(requestingUserId, managementRoomId, mjIntent.matrixClient);
             await mjolnir.createFirstList(requestingUserId, "list");
 
@@ -183,6 +183,7 @@ export class MjolnirManager {
                 await this.makeInstance(
                     mjolnirRecord.owner,
                     mjolnirRecord.management_room,
+                    // @ts-ignore
                     mjIntent.matrixClient,
                 ).catch((e: any) => {
                     log.error(`Could not start mjolnir ${mjolnirRecord.local_part} for ${mjolnirRecord.owner}:`, e);

src/commands/AddRemoveProtectedRoomsCommand.ts

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import { Mjolnir } from "../Mjolnir";
-import { extractRequestError, LogLevel, LogService } from "matrix-bot-sdk";
+import { extractRequestError, LogLevel, LogService } from "@vector-im/matrix-bot-sdk";
 
 // !mjolnir rooms add <room alias/ID>
 export async function execAddProtectedRoom(roomId: string, event: any, mjolnir: Mjolnir, parts: string[]) {

src/commands/AddRemoveRoomFromDirectoryCommand.ts

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import { Mjolnir } from "../Mjolnir";
-import { RichReply } from "matrix-bot-sdk";
+import { RichReply } from "@vector-im/matrix-bot-sdk";
 
 async function addRemoveFromDirectory(inRoomId: string, event: any, mjolnir: Mjolnir, roomRef: string, visibility: "public" | "private") {
     const isAdmin = await mjolnir.isSynapseAdmin();

src/commands/AliasCommands.ts

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import { Mjolnir } from "../Mjolnir";
-import { RichReply } from "matrix-bot-sdk";
+import { RichReply } from "@vector-im/matrix-bot-sdk";
 import { htmlEscape } from "../utils";
 
 // !mjolnir move <alias> <new room ID>

src/commands/CommandHandler.ts

@@ -18,7 +18,7 @@ import { Mjolnir } from "../Mjolnir";
 import { execStatusCommand } from "./StatusCommand";
 import { execBanCommand, execUnbanCommand } from "./UnbanBanCommand";
 import { execDumpRulesCommand, execRulesMatchingCommand } from "./DumpRulesCommand";
-import { extractRequestError, LogService, RichReply } from "matrix-bot-sdk";
+import { extractRequestError, LogService, RichReply } from "@vector-im/matrix-bot-sdk";
 import { htmlEscape } from "../utils";
 import { execSyncCommand } from "./SyncCommand";
 import { execPermissionCheckCommand } from "./PermissionCheckCommand";

src/commands/CreateBanListCommand.ts

@@ -16,7 +16,7 @@ limitations under the License.
 
 import { Mjolnir } from "../Mjolnir";
 import PolicyList from "../models/PolicyList";
-import { Permalinks, RichReply } from "matrix-bot-sdk";
+import { Permalinks, RichReply } from "@vector-im/matrix-bot-sdk";
 
 // !mjolnir list create <shortcode> <alias localpart>
 export async function execCreateListCommand(roomId: string, event: any, mjolnir: Mjolnir, parts: string[]) {

src/commands/DeactivateCommand.ts

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import { Mjolnir } from "../Mjolnir";
-import { RichReply } from "matrix-bot-sdk";
+import { RichReply } from "@vector-im/matrix-bot-sdk";
 
 // !mjolnir deactivate <user ID>
 export async function execDeactivateCommand(roomId: string, event: any, mjolnir: Mjolnir, parts: string[]) {

src/commands/DumpRulesCommand.ts

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-import { RichReply } from "matrix-bot-sdk";
+import { RichReply } from "@vector-im/matrix-bot-sdk";
 import { Mjolnir } from "../Mjolnir";
 import { EntityType } from "../models/ListRule";
 import { htmlEscape } from "../utils";

src/commands/ImportCommand.ts

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import { Mjolnir } from "../Mjolnir";
-import { RichReply } from "matrix-bot-sdk";
+import { RichReply } from "@vector-im/matrix-bot-sdk";
 import { EntityType } from "../models/ListRule";
 import PolicyList from "../models/PolicyList";
 

src/commands/KickCommand.ts

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import { Mjolnir } from "../Mjolnir";
-import { LogLevel, MatrixGlob, RichReply } from "matrix-bot-sdk";
+import { LogLevel, MatrixGlob, RichReply } from "@vector-im/matrix-bot-sdk";
 
 // !mjolnir kick <user|filter> [room] [reason]
 export async function execKickCommand(roomId: string, event: any, mjolnir: Mjolnir, parts: string[]) {

src/commands/ListProtectedRoomsCommand.ts

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import { Mjolnir } from "../Mjolnir";
-import { Permalinks, RichReply } from "matrix-bot-sdk";
+import { Permalinks, RichReply } from "@vector-im/matrix-bot-sdk";
 
 // !mjolnir rooms
 export async function execListProtectedRooms(roomId: string, event: any, mjolnir: Mjolnir) {

src/commands/MakeRoomAdminCommand.ts

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import { Mjolnir } from "../Mjolnir";
-import { RichReply } from "matrix-bot-sdk";
+import { RichReply } from "@vector-im/matrix-bot-sdk";
 
 // !mjolnir make admin <room> [<user ID>]
 export async function execMakeRoomAdminCommand(roomId: string, event: any, mjolnir: Mjolnir, parts: string[]) {

src/commands/ProtectionsCommands.ts

@@ -16,7 +16,7 @@ limitations under the License.
 
 import { htmlEscape } from "../utils";
 import { Mjolnir } from "../Mjolnir";
-import { extractRequestError, LogService, RichReply } from "matrix-bot-sdk";
+import { extractRequestError, LogService, RichReply } from "@vector-im/matrix-bot-sdk";
 import { isListSetting } from "../protections/ProtectionSettings";
 
 // !mjolnir enable <protection>

src/commands/RedactCommand.ts

@@ -16,7 +16,7 @@ limitations under the License.
 
 import { Mjolnir } from "../Mjolnir";
 import { redactUserMessagesIn } from "../utils";
-import { Permalinks } from "matrix-bot-sdk";
+import { Permalinks } from "@vector-im/matrix-bot-sdk";
 
 // !mjolnir redact <user ID> [room alias] [limit]
 export async function execRedactCommand(roomId: string, event: any, mjolnir: Mjolnir, parts: string[]) {

src/commands/SetDefaultBanListCommand.ts

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import { Mjolnir } from "../Mjolnir";
-import { RichReply } from "matrix-bot-sdk";
+import { RichReply } from "@vector-im/matrix-bot-sdk";
 
 export const DEFAULT_LIST_EVENT_TYPE = "org.matrix.mjolnir.default_list";
 

src/commands/SetPowerLevelCommand.ts

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import { Mjolnir } from "../Mjolnir";
-import { extractRequestError, LogLevel, LogService } from "matrix-bot-sdk";
+import { extractRequestError, LogLevel, LogService } from "@vector-im/matrix-bot-sdk";
 
 // !mjolnir powerlevel <user ID> <level> [room]
 export async function execSetPowerLevelCommand(roomId: string, event: any, mjolnir: Mjolnir, parts: string[]) {

src/commands/SetupDecentralizedReportingCommand.ts

@@ -1,5 +1,5 @@
 import { Mjolnir } from "../Mjolnir";
-import { LogLevel } from "matrix-bot-sdk";
+import { LogLevel } from "@vector-im/matrix-bot-sdk";
 
 const EVENT_MODERATED_BY = "org.matrix.msc3215.room.moderation.moderated_by";
 const EVENT_MODERATOR_OF = "org.matrix.msc3215.room.moderation.moderator_of";

src/commands/ShutdownRoomCommand.ts

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import { Mjolnir } from "../Mjolnir";
-import { RichReply } from "matrix-bot-sdk";
+import { RichReply } from "@vector-im/matrix-bot-sdk";
 
 // !mjolnir shutdown room <room> [<message>]
 export async function execShutdownRoomCommand(roomId: string, event: any, mjolnir: Mjolnir, parts: string[]) {

src/commands/SinceCommand.ts

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import { Mjolnir } from "../Mjolnir";
-import { LogLevel, LogService, RichReply } from "matrix-bot-sdk";
+import { LogLevel, LogService, RichReply } from "@vector-im/matrix-bot-sdk";
 import { htmlEscape, parseDuration } from "../utils";
 import { ParseEntry } from "shell-quote";
 import { HumanizeDurationLanguage, HumanizeDuration } from "humanize-duration-ts";

src/commands/StatusCommand.ts

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import { Mjolnir, STATE_CHECKING_PERMISSIONS, STATE_NOT_STARTED, STATE_RUNNING, STATE_SYNCING } from "../Mjolnir";
-import { RichReply } from "matrix-bot-sdk";
+import { RichReply } from "@vector-im/matrix-bot-sdk";
 import { htmlEscape, parseDuration } from "../utils";
 import { HumanizeDurationLanguage, HumanizeDuration } from "humanize-duration-ts";
 import PolicyList from "../models/PolicyList";

src/commands/SuspendCommand.ts

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import {Mjolnir} from "../Mjolnir";
-import {RichReply} from "matrix-bot-sdk";
+import {RichReply} from "@vector-im/matrix-bot-sdk";
 
 export async function execSuspendCommand(roomId: string, event: any, mjolnir: Mjolnir, parts: string[]) {
     const target = parts[2];

src/commands/UnbanBanCommand.ts

@@ -16,7 +16,7 @@ limitations under the License.
 
 import { Mjolnir } from "../Mjolnir";
 import PolicyList from "../models/PolicyList";
-import { extractRequestError, LogLevel, LogService, MatrixGlob, RichReply } from "matrix-bot-sdk";
+import { extractRequestError, LogLevel, LogService, MatrixGlob, RichReply } from "@vector-im/matrix-bot-sdk";
 import { RULE_ROOM, RULE_SERVER, RULE_USER, USER_RULE_TYPES } from "../models/ListRule";
 import { DEFAULT_LIST_EVENT_TYPE } from "./SetDefaultBanListCommand";
 

src/commands/UnsuspendCommand.ts

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import {Mjolnir} from "../Mjolnir";
-import {RichReply} from "matrix-bot-sdk";
+import {RichReply} from "@vector-im/matrix-bot-sdk";
 
 export async function execUnsuspendCommand(roomId: string, event: any, mjolnir: Mjolnir, parts: string[]) {
     const target = parts[2];

src/commands/WatchUnwatchCommand.ts

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import { Mjolnir } from "../Mjolnir";
-import { Permalinks, RichReply } from "matrix-bot-sdk";
+import { Permalinks, RichReply } from "@vector-im/matrix-bot-sdk";
 
 // !mjolnir watch <room alias or ID>
 export async function execWatchCommand(roomId: string, event: any, mjolnir: Mjolnir, parts: string[]) {

src/config.ts

@@ -16,7 +16,7 @@ limitations under the License.
 
 import * as fs from "fs";
 import { load } from "js-yaml";
-import { MatrixClient, LogService } from "matrix-bot-sdk";
+import { MatrixClient, LogService } from "@vector-im/matrix-bot-sdk";
 import Config from "config";
 
 export interface IHealthConfig {
@@ -70,6 +70,11 @@ export interface IConfig {
     homeserverUrl: string;
     rawHomeserverUrl: string;
     accessToken: string;
+    encryption: {
+        use: boolean;
+        username: string;
+        password: string;
+    }
     pantalaimon: {
         use: boolean;
         username: string;
@@ -189,6 +194,11 @@ const defaultConfig: IConfig = {
     homeserverUrl: "http://localhost:8008",
     rawHomeserverUrl: "http://localhost:8008",
     accessToken: "NONE_PROVIDED",
+    encryption: {
+        use: true,
+        username: "",
+        password: "",
+    },
     pantalaimon: {
         use: false,
         username: "",

src/health/healthz.ts

@@ -15,7 +15,7 @@ limitations under the License.
 */
 
 import * as http from "http";
-import { LogService } from "matrix-bot-sdk";
+import { LogService } from "@vector-im/matrix-bot-sdk";
 import { IConfig } from "../config";
 // allowed to use the global configuration since this is only intended to be used by `src/index.ts`.