@textrp/briij-js-sdk 41.0.0

package/lib/secret-storage.js

@@ -0,0 +1,487 @@
+import _asyncToGenerator from "@babel/runtime/helpers/asyncToGenerator";
+/*
+Copyright 2021-2023 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+/**
+ * Implementation of server-side secret storage
+ *
+ * @see https://spec.matrix.org/v1.6/client-server-api/#storage
+ */
+
+import { ClientEvent } from "./client.js";
+import { secureRandomString } from "./randomstring.js";
+import { logger } from "./logger.js";
+import encryptAESSecretStorageItem from "./utils/encryptAESSecretStorageItem.js";
+import decryptAESSecretStorageItem from "./utils/decryptAESSecretStorageItem.js";
+export var SECRET_STORAGE_ALGORITHM_V1_AES = "m.secret_storage.v1.aes-hmac-sha2";
+
+/**
+ * Common base interface for Secret Storage Keys.
+ *
+ * The common properties for all encryption keys used in server-side secret storage.
+ *
+ * @see https://spec.matrix.org/v1.6/client-server-api/#key-storage
+ */
+
+/**
+ * Properties for a SSSS key using the `m.secret_storage.v1.aes-hmac-sha2` algorithm.
+ *
+ * Corresponds to `AesHmacSha2KeyDescription` in the specification.
+ *
+ * @see https://spec.matrix.org/v1.6/client-server-api/#msecret_storagev1aes-hmac-sha2
+ */
+
+/**
+ * Union type for secret storage keys.
+ *
+ * For now, this is only {@link SecretStorageKeyDescriptionAesV1}, but other interfaces may be added in future.
+ */
+
+/**
+ * Information on how to generate the key from a passphrase.
+ *
+ * @see https://spec.matrix.org/v1.6/client-server-api/#deriving-keys-from-passphrases
+ */
+
+/**
+ * Options for {@link ServerSideSecretStorageImpl#addKey}.
+ */
+
+/**
+ * Return type for {@link ServerSideSecretStorageImpl#getKey}.
+ */
+
+/**
+ * Return type for {@link ServerSideSecretStorageImpl#addKey}.
+ */
+
+/** Interface for managing account data on the server.
+ *
+ * A subset of {@link BriijClient}.
+ */
+
+/**
+ *  Application callbacks for use with {@link SecretStorage.ServerSideSecretStorageImpl}
+ */
+
+/**
+ * Account Data event types which can store secret-storage-encrypted information.
+ */
+
+/**
+ * Account Data event content type for storing secret-storage-encrypted information.
+ *
+ * See https://spec.matrix.org/v1.13/client-server-api/#msecret_storagev1aes-hmac-sha2-1
+ */
+
+/**
+ * Interface provided by SecretStorage implementations
+ *
+ * Normally this will just be an {@link ServerSideSecretStorageImpl}, but for backwards
+ * compatibility some methods allow other implementations.
+ */
+
+/**
+ * Implementation of Server-side secret storage.
+ *
+ * Secret *sharing* is *not* implemented here: this class is strictly about the storage component of
+ * SSSS.
+ *
+ * @see https://spec.matrix.org/v1.6/client-server-api/#storage
+ */
+export class ServerSideSecretStorageImpl {
+  /**
+   * Construct a new `SecretStorage`.
+   *
+   * Normally, it is unnecessary to call this directly, since BriijClient automatically constructs one.
+   * However, it may be useful to construct a new `SecretStorage`, if custom `callbacks` are required, for example.
+   *
+   * @param accountDataAdapter - interface for fetching and setting account data on the server. Normally an instance
+   *   of {@link BriijClient}.
+   * @param callbacks - application level callbacks for retrieving secret keys
+   */
+  constructor(accountDataAdapter, callbacks) {
+    this.accountDataAdapter = accountDataAdapter;
+    this.callbacks = callbacks;
+  }
+
+  /**
+   * Get the current default key ID for encrypting secrets.
+   *
+   * @returns The default key ID or null if no default key ID is set
+   */
+  getDefaultKeyId() {
+    var _this = this;
+    return _asyncToGenerator(function* () {
+      var _defaultKey$key;
+      var defaultKey = yield _this.accountDataAdapter.getAccountDataFromServer("m.secret_storage.default_key");
+      if (!defaultKey) return null;
+      return (_defaultKey$key = defaultKey.key) !== null && _defaultKey$key !== void 0 ? _defaultKey$key : null;
+    })();
+  }
+
+  /**
+   * Implementation of {@link ServerSideSecretStorage#setDefaultKeyId}.
+   */
+  setDefaultKeyId(keyId) {
+    return new Promise((resolve, reject) => {
+      var listener = ev => {
+        if (ev.getType() !== "m.secret_storage.default_key") {
+          //  Different account data item
+          return;
+        }
+
+        // If keyId === null, the content should be an empty object.
+        // Otherwise, the `key` in the content object should match keyId.
+        var content = ev.getContent();
+        var isSameKey = keyId === null ? Object.keys(content).length === 0 : content.key === keyId;
+        if (isSameKey) {
+          this.accountDataAdapter.removeListener(ClientEvent.AccountData, listener);
+          resolve();
+        }
+      };
+      this.accountDataAdapter.on(ClientEvent.AccountData, listener);
+
+      // The spec [1] says that the value of the account data entry should be an object with a `key` property.
+      // It doesn't specify how to delete the default key; we do it by setting the account data to an empty object.
+      //
+      // [1]: https://spec.matrix.org/v1.13/client-server-api/#key-storage
+      var newValue = keyId === null ? {} : {
+        key: keyId
+      };
+      this.accountDataAdapter.setAccountData("m.secret_storage.default_key", newValue).catch(e => {
+        this.accountDataAdapter.removeListener(ClientEvent.AccountData, listener);
+        reject(e);
+      });
+    });
+  }
+
+  /**
+   * Add a key for encrypting secrets.
+   *
+   * @param algorithm - the algorithm used by the key.
+   * @param opts - the options for the algorithm.  The properties used
+   *     depend on the algorithm given.
+   * @param keyId - the ID of the key.  If not given, a random
+   *     ID will be generated.
+   *
+   * @returns An object with:
+   *     keyId: the ID of the key
+   *     keyInfo: details about the key (iv, mac, passphrase)
+   */
+  addKey(algorithm, opts, keyId) {
+    var _this2 = this;
+    return _asyncToGenerator(function* () {
+      if (algorithm !== SECRET_STORAGE_ALGORITHM_V1_AES) {
+        throw new Error("Unknown key algorithm ".concat(algorithm));
+      }
+      var keyInfo = {
+        algorithm
+      };
+      if (opts.name) {
+        keyInfo.name = opts.name;
+      }
+      if (opts.passphrase) {
+        keyInfo.passphrase = opts.passphrase;
+      }
+      var {
+        iv,
+        mac
+      } = yield calculateKeyCheck(opts.key);
+      keyInfo.iv = iv;
+      keyInfo.mac = mac;
+
+      // Create a unique key id. XXX: this is racey.
+      if (!keyId) {
+        do {
+          keyId = secureRandomString(32);
+        } while (yield _this2.accountDataAdapter.getAccountDataFromServer("m.secret_storage.key.".concat(keyId)));
+      }
+      yield _this2.accountDataAdapter.setAccountData("m.secret_storage.key.".concat(keyId), keyInfo);
+      return {
+        keyId,
+        keyInfo
+      };
+    })();
+  }
+
+  /**
+   * Get the key information for a given ID.
+   *
+   * @param keyId - The ID of the key to check
+   *     for. Defaults to the default key ID if not provided.
+   * @returns If the key was found, the return value is an array of
+   *     the form [keyId, keyInfo].  Otherwise, null is returned.
+   *     XXX: why is this an array when addKey returns an object?
+   */
+  getKey(keyId) {
+    var _this3 = this;
+    return _asyncToGenerator(function* () {
+      if (!keyId) {
+        keyId = yield _this3.getDefaultKeyId();
+      }
+      if (!keyId) {
+        return null;
+      }
+      var keyInfo = yield _this3.accountDataAdapter.getAccountDataFromServer("m.secret_storage.key.".concat(keyId));
+      return keyInfo ? [keyId, keyInfo] : null;
+    })();
+  }
+
+  /**
+   * Check whether we have a key with a given ID.
+   *
+   * @param keyId - The ID of the key to check
+   *     for. Defaults to the default key ID if not provided.
+   * @returns Whether we have the key.
+   */
+  hasKey(keyId) {
+    var _this4 = this;
+    return _asyncToGenerator(function* () {
+      var key = yield _this4.getKey(keyId);
+      return Boolean(key);
+    })();
+  }
+
+  /**
+   * Check whether a key matches what we expect based on the key info
+   *
+   * @param key - the key to check
+   * @param info - the key info
+   *
+   * @returns whether or not the key matches
+   */
+  checkKey(key, info) {
+    return _asyncToGenerator(function* () {
+      if (info.algorithm === SECRET_STORAGE_ALGORITHM_V1_AES) {
+        if (info.mac) {
+          var {
+            mac
+          } = yield calculateKeyCheck(key, info.iv);
+          return trimTrailingEquals(info.mac) === trimTrailingEquals(mac);
+        } else {
+          // if we have no information, we have to assume the key is right
+          return true;
+        }
+      } else {
+        throw new Error("Unknown algorithm");
+      }
+    })();
+  }
+
+  /**
+   * Implementation of {@link ServerSideSecretStorage#store}.
+   */
+  store(name, secret, keys) {
+    var _this5 = this;
+    return _asyncToGenerator(function* () {
+      if (secret === null) {
+        // remove secret
+        yield _this5.accountDataAdapter.setAccountData(name, {});
+        return;
+      }
+      var encrypted = {};
+      if (!keys) {
+        var defaultKeyId = yield _this5.getDefaultKeyId();
+        if (!defaultKeyId) {
+          throw new Error("No keys specified and no default key present");
+        }
+        keys = [defaultKeyId];
+      }
+      if (keys.length === 0) {
+        throw new Error("Zero keys given to encrypt with!");
+      }
+      for (var _keyId of keys) {
+        // get key information from key storage
+        var _keyInfo = yield _this5.accountDataAdapter.getAccountDataFromServer("m.secret_storage.key.".concat(_keyId));
+        if (!_keyInfo) {
+          throw new Error("Unknown key: " + _keyId);
+        }
+
+        // encrypt secret, based on the algorithm
+        if (_keyInfo.algorithm === SECRET_STORAGE_ALGORITHM_V1_AES) {
+          var _keys = {
+            [_keyId]: _keyInfo
+          };
+          var [, encryption] = yield _this5.getSecretStorageKey(_keys, name);
+          encrypted[_keyId] = yield encryption.encrypt(secret);
+        } else {
+          logger.warn("unknown algorithm for secret storage key " + _keyId + ": " + _keyInfo.algorithm);
+          // do nothing if we don't understand the encryption algorithm
+        }
+      }
+
+      // save encrypted secret
+      yield _this5.accountDataAdapter.setAccountData(name, {
+        encrypted
+      });
+    })();
+  }
+
+  /**
+   * Get a secret from storage, and decrypt it.
+   *
+   * {@link SecretStorageCallbacks#getSecretStorageKey} will be called to obtain a secret storage
+   * key to decrypt the secret.
+   *
+   * @param name - the name of the secret - i.e., the "event type" stored in the account data
+   *
+   * @returns the decrypted contents of the secret, or "undefined" if `name` is not found in
+   *    the user's account data.
+   */
+  get(name) {
+    var _this6 = this;
+    return _asyncToGenerator(function* () {
+      var secretInfo = yield _this6.accountDataAdapter.getAccountDataFromServer(name);
+      if (!secretInfo) {
+        return;
+      }
+      if (!secretInfo.encrypted) {
+        throw new Error("Content is not encrypted!");
+      }
+
+      // get possible keys to decrypt
+      var keys = {};
+      for (var _keyId2 of Object.keys(secretInfo.encrypted)) {
+        // get key information from key storage
+        var _keyInfo2 = yield _this6.accountDataAdapter.getAccountDataFromServer("m.secret_storage.key.".concat(_keyId2));
+        var _encInfo = secretInfo.encrypted[_keyId2];
+        // only use keys we understand the encryption algorithm of
+        if ((_keyInfo2 === null || _keyInfo2 === void 0 ? void 0 : _keyInfo2.algorithm) === SECRET_STORAGE_ALGORITHM_V1_AES) {
+          if (_encInfo.iv && _encInfo.ciphertext && _encInfo.mac) {
+            keys[_keyId2] = _keyInfo2;
+          }
+        }
+      }
+      if (Object.keys(keys).length === 0) {
+        throw new Error("Could not decrypt ".concat(name, " because none of ") + "the keys it is encrypted with are for a supported algorithm");
+      }
+
+      // fetch private key from app
+      var [keyId, decryption] = yield _this6.getSecretStorageKey(keys, name);
+      var encInfo = secretInfo.encrypted[keyId];
+      return decryption.decrypt(encInfo);
+    })();
+  }
+
+  /**
+   * Check if a secret is stored on the server.
+   *
+   * @param name - the name of the secret
+   *
+   * @returns map of key name to key info the secret is encrypted
+   *     with, or null if it is not present or not encrypted with a trusted
+   *     key
+   */
+  isStored(name) {
+    var _this7 = this;
+    return _asyncToGenerator(function* () {
+      // check if secret exists
+      var secretInfo = yield _this7.accountDataAdapter.getAccountDataFromServer(name);
+      if (!(secretInfo !== null && secretInfo !== void 0 && secretInfo.encrypted)) return null;
+      var ret = {};
+
+      // filter secret encryption keys with supported algorithm
+      for (var _keyId3 of Object.keys(secretInfo.encrypted)) {
+        // get key information from key storage
+        var _keyInfo3 = yield _this7.accountDataAdapter.getAccountDataFromServer("m.secret_storage.key.".concat(_keyId3));
+        if (!_keyInfo3) continue;
+        var encInfo = secretInfo.encrypted[_keyId3];
+
+        // only use keys we understand the encryption algorithm of
+        if (_keyInfo3.algorithm === SECRET_STORAGE_ALGORITHM_V1_AES) {
+          if (encInfo.iv && encInfo.ciphertext && encInfo.mac) {
+            ret[_keyId3] = _keyInfo3;
+          }
+        }
+      }
+      return Object.keys(ret).length ? ret : null;
+    })();
+  }
+  getSecretStorageKey(keys, name) {
+    var _this8 = this;
+    return _asyncToGenerator(function* () {
+      if (!_this8.callbacks.getSecretStorageKey) {
+        throw new Error("No getSecretStorageKey callback supplied");
+      }
+      var returned = yield _this8.callbacks.getSecretStorageKey({
+        keys
+      }, name);
+      if (!returned) {
+        throw new Error("getSecretStorageKey callback returned falsey");
+      }
+      if (returned.length < 2) {
+        throw new Error("getSecretStorageKey callback returned invalid data");
+      }
+      var [keyId, privateKey] = returned;
+      if (!keys[keyId]) {
+        throw new Error("App returned unknown key from getSecretStorageKey!");
+      }
+      if (keys[keyId].algorithm === SECRET_STORAGE_ALGORITHM_V1_AES) {
+        var decryption = {
+          encrypt: function encrypt(secret) {
+            return encryptAESSecretStorageItem(secret, privateKey, name);
+          },
+          decrypt: function decrypt(encInfo) {
+            return decryptAESSecretStorageItem(encInfo, privateKey, name);
+          }
+        };
+        return [keyId, decryption];
+      } else {
+        throw new Error("Unknown key type: " + keys[keyId].algorithm);
+      }
+    })();
+  }
+}
+
+/** trim trailing instances of '=' from a string
+ *
+ * @internal
+ *
+ * @param input - input string
+ */
+export function trimTrailingEquals(input) {
+  // according to Sonar and CodeQL, a regex such as /=+$/ is superlinear.
+  // Not sure I believe it, but it's easy enough to work around.
+
+  // find the number of characters before the trailing =
+  var i = input.length;
+  while (i >= 1 && input.charCodeAt(i - 1) == 0x3d) i--;
+
+  // trim to the calculated length
+  if (i < input.length) {
+    return input.substring(0, i);
+  } else {
+    return input;
+  }
+}
+
+// string of zeroes, for calculating the key check
+var ZERO_STR = "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0";
+
+/**
+ * Calculate the MAC for checking the key.
+ * See https://spec.matrix.org/v1.11/client-server-api/#msecret_storagev1aes-hmac-sha2, steps 3 and 4.
+ *
+ * @param key - the key to use
+ * @param iv - The initialization vector as a base64-encoded string.
+ *     If omitted, a random initialization vector will be created.
+ * @returns An object that contains, `mac` and `iv` properties.
+ */
+export function calculateKeyCheck(key, iv) {
+  return encryptAESSecretStorageItem(ZERO_STR, key, "", iv);
+}
+//# sourceMappingURL=secret-storage.js.map

package/lib/secret-storage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"secret-storage.js","names":["ClientEvent","secureRandomString","logger","encryptAESSecretStorageItem","decryptAESSecretStorageItem","SECRET_STORAGE_ALGORITHM_V1_AES","ServerSideSecretStorageImpl","constructor","accountDataAdapter","callbacks","getDefaultKeyId","_this","_asyncToGenerator","_defaultKey$key","defaultKey","getAccountDataFromServer","key","setDefaultKeyId","keyId","Promise","resolve","reject","listener","ev","getType","content","getContent","isSameKey","Object","keys","length","removeListener","AccountData","on","newValue","setAccountData","catch","e","addKey","algorithm","opts","_this2","Error","concat","keyInfo","name","passphrase","iv","mac","calculateKeyCheck","getKey","_this3","hasKey","_this4","Boolean","checkKey","info","trimTrailingEquals","store","secret","_this5","encrypted","defaultKeyId","encryption","getSecretStorageKey","encrypt","warn","get","_this6","secretInfo","encInfo","ciphertext","decryption","decrypt","isStored","_this7","ret","_this8","returned","privateKey","input","i","charCodeAt","substring","ZERO_STR"],"sources":["../src/secret-storage.ts"],"sourcesContent":["/*\nCopyright 2021-2023 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\n\n/**\n * Implementation of server-side secret storage\n *\n * @see https://spec.matrix.org/v1.6/client-server-api/#storage\n */\n\nimport { type TypedEventEmitter } from \"./models/typed-event-emitter.ts\";\nimport { ClientEvent, type ClientEventHandlerMap } from \"./client.ts\";\nimport { type BriijEvent } from \"./models/event.ts\";\nimport { secureRandomString } from \"./randomstring.ts\";\nimport { logger } from \"./logger.ts\";\nimport encryptAESSecretStorageItem from \"./utils/encryptAESSecretStorageItem.ts\";\nimport decryptAESSecretStorageItem from \"./utils/decryptAESSecretStorageItem.ts\";\nimport { type AESEncryptedSecretStoragePayload } from \"./@types/AESEncryptedSecretStoragePayload.ts\";\nimport { type AccountDataEvents, type SecretStorageAccountDataEvents } from \"./@types/event.ts\";\nimport { type EmptyObject } from \"./@types/common.ts\";\n\nexport const SECRET_STORAGE_ALGORITHM_V1_AES = \"m.secret_storage.v1.aes-hmac-sha2\";\n\n/**\n * Common base interface for Secret Storage Keys.\n *\n * The common properties for all encryption keys used in server-side secret storage.\n *\n * @see https://spec.matrix.org/v1.6/client-server-api/#key-storage\n */\nexport interface SecretStorageKeyDescriptionCommon {\n    /** A human-readable name for this key. */\n    // XXX: according to the spec, this is optional\n    name: string;\n\n    /** The encryption algorithm used with this key. */\n    algorithm: string;\n\n    /** Information for deriving this key from a passphrase. */\n    // XXX: according to the spec, this is optional\n    passphrase: PassphraseInfo;\n}\n\n/**\n * Properties for a SSSS key using the `m.secret_storage.v1.aes-hmac-sha2` algorithm.\n *\n * Corresponds to `AesHmacSha2KeyDescription` in the specification.\n *\n * @see https://spec.matrix.org/v1.6/client-server-api/#msecret_storagev1aes-hmac-sha2\n */\nexport interface SecretStorageKeyDescriptionAesV1 extends SecretStorageKeyDescriptionCommon {\n    // XXX: strictly speaking, we should be able to enforce the algorithm here. But\n    //   this interface ends up being incorrectly used where other algorithms are in use (notably\n    //   in device-dehydration support), and unpicking that is too much like hard work\n    //   at the moment.\n    // algorithm: \"m.secret_storage.v1.aes-hmac-sha2\";\n\n    /** The 16-byte AES initialization vector, encoded as base64. */\n    iv: string;\n\n    /** The MAC of the result of encrypting 32 bytes of 0, encoded as base64. */\n    mac: string;\n}\n\n/**\n * Union type for secret storage keys.\n *\n * For now, this is only {@link SecretStorageKeyDescriptionAesV1}, but other interfaces may be added in future.\n */\nexport type SecretStorageKeyDescription = SecretStorageKeyDescriptionAesV1;\n\n/**\n * Information on how to generate the key from a passphrase.\n *\n * @see https://spec.matrix.org/v1.6/client-server-api/#deriving-keys-from-passphrases\n */\nexport interface PassphraseInfo {\n    /** The algorithm to be used to derive the key. */\n    algorithm: \"m.pbkdf2\";\n\n    /** The number of PBKDF2 iterations to use. */\n    iterations: number;\n\n    /** The salt to be used for PBKDF2. */\n    salt: string;\n\n    /** The number of bits to generate. Defaults to 256. */\n    bits?: number;\n}\n\n/**\n * Options for {@link ServerSideSecretStorageImpl#addKey}.\n */\nexport interface AddSecretStorageKeyOpts {\n    /** Information for deriving the key from a passphrase if any. */\n    passphrase?: PassphraseInfo;\n    /** Optional name of the key. */\n    name?: string;\n    /** The private key. Will be used to generate the key check values in the key info; it will not be stored on the server */\n    key: Uint8Array<ArrayBuffer>;\n}\n\n/**\n * Return type for {@link ServerSideSecretStorageImpl#getKey}.\n */\nexport type SecretStorageKeyTuple = [keyId: string, keyInfo: SecretStorageKeyDescription];\n\n/**\n * Return type for {@link ServerSideSecretStorageImpl#addKey}.\n */\nexport type SecretStorageKeyObject = {\n    /** The ID of the key */\n    keyId: string;\n    /**  details about the key */\n    keyInfo: SecretStorageKeyDescription;\n};\n\n/** Interface for managing account data on the server.\n *\n * A subset of {@link BriijClient}.\n */\nexport interface AccountDataClient extends TypedEventEmitter<ClientEvent.AccountData, ClientEventHandlerMap> {\n    /**\n     * Get account data event of given type for the current user. This variant\n     * gets account data directly from the homeserver if the local store is not\n     * ready, which can be useful very early in startup before the initial sync.\n     *\n     * @param eventType - The type of account data\n     * @returns The contents of the given account data event, or `null` if the event is not found\n     */\n    getAccountDataFromServer: <K extends keyof AccountDataEvents>(eventType: K) => Promise<AccountDataEvents[K] | null>;\n\n    /**\n     * Set account data event for the current user, with retries\n     *\n     * @param eventType - The type of account data\n     * @param content - the content object to be set\n     * @returns an empty object\n     */\n    setAccountData: <K extends keyof AccountDataEvents>(\n        eventType: K,\n        content: AccountDataEvents[K] | Record<string, never>,\n    ) => Promise<EmptyObject>;\n}\n\n/**\n *  Application callbacks for use with {@link SecretStorage.ServerSideSecretStorageImpl}\n */\nexport interface SecretStorageCallbacks {\n    /**\n     * Called to retrieve a secret storage encryption key\n     *\n     * Before a secret can be stored in server-side storage, it must be encrypted with one or more\n     * keys. Similarly, after it has been retrieved from storage, it must be decrypted with one of\n     * the keys it was encrypted with. These encryption keys are known as \"secret storage keys\".\n     *\n     * Descriptions of the secret storage keys are also stored in server-side storage, per the\n     * [matrix specification](https://spec.matrix.org/v1.6/client-server-api/#key-storage), so\n     * before a key can be used in this way, it must have been stored on the server. This is\n     * done via {@link ServerSideSecretStorage#addKey}.\n     *\n     * Obviously the keys themselves are not stored server-side, so the js-sdk calls this callback\n     * in order to retrieve a secret storage key from the application.\n     *\n     * @param keys - An options object, containing only the property `keys`.\n     *\n     * @param name - the name of the *secret* (NB: not the encryption key) being stored or retrieved.\n     *    This is the \"event type\" stored in account data.\n     *\n     * @returns a pair [`keyId`, `privateKey`], where `keyId` is one of the keys from the `keys` parameter,\n     *    and `privateKey` is the raw private encryption key, as appropriate for the encryption algorithm.\n     *    (For `m.secret_storage.v1.aes-hmac-sha2`, it is the input to an HKDF as defined in the\n     *    [specification](https://spec.matrix.org/v1.6/client-server-api/#msecret_storagev1aes-hmac-sha2).)\n     *\n     *    Alternatively, if none of the keys are known, may return `null` — in which case the original\n     *    storage/retrieval operation will fail with an exception.\n     */\n    getSecretStorageKey?: (\n        keys: {\n            /**\n             * details of the secret storage keys required: a map from the key ID\n             * (excluding the `m.secret_storage.key.` prefix) to details of the key.\n             *\n             * When storing a secret, `keys` will contain exactly one entry; this method will be called\n             * once for each secret storage key to be used for encryption.\n             *\n             * For secret retrieval, `keys` may contain several entries, and the application can return\n             * any one of the requested keys.\n             */\n            keys: Record<string, SecretStorageKeyDescription>;\n        },\n        name: string,\n    ) => Promise<[string, Uint8Array<ArrayBuffer>] | null>;\n}\n\n/**\n * Account Data event types which can store secret-storage-encrypted information.\n */\nexport type SecretStorageKey = keyof SecretStorageAccountDataEvents;\n\n/**\n * Account Data event content type for storing secret-storage-encrypted information.\n *\n * See https://spec.matrix.org/v1.13/client-server-api/#msecret_storagev1aes-hmac-sha2-1\n */\nexport interface SecretInfo {\n    encrypted: {\n        [keyId: string]: AESEncryptedSecretStoragePayload;\n    };\n}\n\ninterface Decryptors {\n    encrypt: (plaintext: string) => Promise<AESEncryptedSecretStoragePayload>;\n    decrypt: (ciphertext: AESEncryptedSecretStoragePayload) => Promise<string>;\n}\n\n/**\n * Interface provided by SecretStorage implementations\n *\n * Normally this will just be an {@link ServerSideSecretStorageImpl}, but for backwards\n * compatibility some methods allow other implementations.\n */\nexport interface ServerSideSecretStorage {\n    /**\n     * Add a key for encrypting secrets.\n     *\n     * @param algorithm - the algorithm used by the key.\n     * @param opts - the options for the algorithm.  The properties used\n     *     depend on the algorithm given.\n     * @param keyId - the ID of the key.  If not given, a random\n     *     ID will be generated.\n     *\n     * @returns details about the key.\n     */\n    addKey(algorithm: string, opts: AddSecretStorageKeyOpts, keyId?: string): Promise<SecretStorageKeyObject>;\n\n    /**\n     * Get the key information for a given ID.\n     *\n     * @param keyId - The ID of the key to check\n     *     for. Defaults to the default key ID if not provided.\n     * @returns If the key was found, the return value is an array of\n     *     the form [keyId, keyInfo].  Otherwise, null is returned.\n     *     XXX: why is this an array when addKey returns an object?\n     */\n    getKey(keyId?: string | null): Promise<SecretStorageKeyTuple | null>;\n\n    /**\n     * Check whether we have a key with a given ID.\n     *\n     * @param keyId - The ID of the key to check\n     *     for. Defaults to the default key ID if not provided.\n     * @returns Whether we have the key.\n     */\n    hasKey(keyId?: string): Promise<boolean>;\n\n    /**\n     * Check whether a key matches what we expect based on the key info\n     *\n     * @param key - the key to check\n     * @param info - the key info\n     *\n     * @returns whether or not the key matches\n     */\n    checkKey(key: Uint8Array, info: SecretStorageKeyDescriptionAesV1): Promise<boolean>;\n\n    /**\n     * Store an encrypted secret on the server.\n     *\n     * Details of the encryption keys to be used must previously have been stored in account data\n     * (for example, via {@link ServerSideSecretStorageImpl#addKey}. {@link SecretStorageCallbacks#getSecretStorageKey} will be called to obtain a secret storage\n     * key to decrypt the secret.\n     *\n     * If the secret is `null`, the secret value in the account data will be set to an empty object.\n     * This is considered as \"removing\" the secret.\n     *\n     * @param name - The name of the secret - i.e., the \"event type\" to be stored in the account data\n     * @param secret - The secret contents.\n     * @param keys - The IDs of the keys to use to encrypt the secret, or null/undefined to use the default key\n     *     (will throw if no default key is set).\n     */\n    store(name: string, secret: string | null, keys?: string[] | null): Promise<void>;\n\n    /**\n     * Get a secret from storage, and decrypt it.\n     *\n     * @param name - the name of the secret - i.e., the \"event type\" stored in the account data\n     *\n     * @returns the decrypted contents of the secret, or \"undefined\" if `name` is not found in\n     *    the user's account data.\n     */\n    get(name: string): Promise<string | undefined>;\n\n    /**\n     * Check if a secret is stored on the server.\n     *\n     * @param name - the name of the secret\n     *\n     * @returns map of key name to key info the secret is encrypted\n     *     with, or null if it is not present or not encrypted with a trusted\n     *     key\n     */\n    isStored(name: SecretStorageKey): Promise<Record<string, SecretStorageKeyDescriptionAesV1> | null>;\n\n    /**\n     * Get the current default key ID for encrypting secrets.\n     *\n     * @returns The default key ID or null if no default key ID is set\n     */\n    getDefaultKeyId(): Promise<string | null>;\n\n    /**\n     * Set the default key ID for encrypting secrets.\n     *\n     * If keyId is `null`, the default key id value in the account data will be set to an empty object.\n     * This is considered as \"disabling\" the default key.\n     *\n     * @param keyId - The new default key ID\n     */\n    setDefaultKeyId(keyId: string | null): Promise<void>;\n}\n\n/**\n * Implementation of Server-side secret storage.\n *\n * Secret *sharing* is *not* implemented here: this class is strictly about the storage component of\n * SSSS.\n *\n * @see https://spec.matrix.org/v1.6/client-server-api/#storage\n */\nexport class ServerSideSecretStorageImpl implements ServerSideSecretStorage {\n    /**\n     * Construct a new `SecretStorage`.\n     *\n     * Normally, it is unnecessary to call this directly, since BriijClient automatically constructs one.\n     * However, it may be useful to construct a new `SecretStorage`, if custom `callbacks` are required, for example.\n     *\n     * @param accountDataAdapter - interface for fetching and setting account data on the server. Normally an instance\n     *   of {@link BriijClient}.\n     * @param callbacks - application level callbacks for retrieving secret keys\n     */\n    public constructor(\n        private readonly accountDataAdapter: AccountDataClient,\n        private readonly callbacks: SecretStorageCallbacks,\n    ) {}\n\n    /**\n     * Get the current default key ID for encrypting secrets.\n     *\n     * @returns The default key ID or null if no default key ID is set\n     */\n    public async getDefaultKeyId(): Promise<string | null> {\n        const defaultKey = await this.accountDataAdapter.getAccountDataFromServer(\"m.secret_storage.default_key\");\n        if (!defaultKey) return null;\n        return defaultKey.key ?? null;\n    }\n\n    /**\n     * Implementation of {@link ServerSideSecretStorage#setDefaultKeyId}.\n     */\n    public setDefaultKeyId(keyId: string | null): Promise<void> {\n        return new Promise<void>((resolve, reject) => {\n            const listener = (ev: BriijEvent): void => {\n                if (ev.getType() !== \"m.secret_storage.default_key\") {\n                    //  Different account data item\n                    return;\n                }\n\n                // If keyId === null, the content should be an empty object.\n                // Otherwise, the `key` in the content object should match keyId.\n                const content = ev.getContent();\n                const isSameKey = keyId === null ? Object.keys(content).length === 0 : content.key === keyId;\n                if (isSameKey) {\n                    this.accountDataAdapter.removeListener(ClientEvent.AccountData, listener);\n                    resolve();\n                }\n            };\n            this.accountDataAdapter.on(ClientEvent.AccountData, listener);\n\n            // The spec [1] says that the value of the account data entry should be an object with a `key` property.\n            // It doesn't specify how to delete the default key; we do it by setting the account data to an empty object.\n            //\n            // [1]: https://spec.matrix.org/v1.13/client-server-api/#key-storage\n            const newValue: Record<string, never> | { key: string } = keyId === null ? {} : { key: keyId };\n            this.accountDataAdapter.setAccountData(\"m.secret_storage.default_key\", newValue).catch((e) => {\n                this.accountDataAdapter.removeListener(ClientEvent.AccountData, listener);\n                reject(e);\n            });\n        });\n    }\n\n    /**\n     * Add a key for encrypting secrets.\n     *\n     * @param algorithm - the algorithm used by the key.\n     * @param opts - the options for the algorithm.  The properties used\n     *     depend on the algorithm given.\n     * @param keyId - the ID of the key.  If not given, a random\n     *     ID will be generated.\n     *\n     * @returns An object with:\n     *     keyId: the ID of the key\n     *     keyInfo: details about the key (iv, mac, passphrase)\n     */\n    public async addKey(\n        algorithm: string,\n        opts: AddSecretStorageKeyOpts,\n        keyId?: string,\n    ): Promise<SecretStorageKeyObject> {\n        if (algorithm !== SECRET_STORAGE_ALGORITHM_V1_AES) {\n            throw new Error(`Unknown key algorithm ${algorithm}`);\n        }\n\n        const keyInfo = { algorithm } as SecretStorageKeyDescriptionAesV1;\n\n        if (opts.name) {\n            keyInfo.name = opts.name;\n        }\n\n        if (opts.passphrase) {\n            keyInfo.passphrase = opts.passphrase;\n        }\n\n        const { iv, mac } = await calculateKeyCheck(opts.key);\n        keyInfo.iv = iv;\n        keyInfo.mac = mac;\n\n        // Create a unique key id. XXX: this is racey.\n        if (!keyId) {\n            do {\n                keyId = secureRandomString(32);\n            } while (await this.accountDataAdapter.getAccountDataFromServer(`m.secret_storage.key.${keyId}`));\n        }\n\n        await this.accountDataAdapter.setAccountData(`m.secret_storage.key.${keyId}`, keyInfo);\n\n        return {\n            keyId,\n            keyInfo,\n        };\n    }\n\n    /**\n     * Get the key information for a given ID.\n     *\n     * @param keyId - The ID of the key to check\n     *     for. Defaults to the default key ID if not provided.\n     * @returns If the key was found, the return value is an array of\n     *     the form [keyId, keyInfo].  Otherwise, null is returned.\n     *     XXX: why is this an array when addKey returns an object?\n     */\n    public async getKey(keyId?: string | null): Promise<SecretStorageKeyTuple | null> {\n        if (!keyId) {\n            keyId = await this.getDefaultKeyId();\n        }\n        if (!keyId) {\n            return null;\n        }\n\n        const keyInfo = await this.accountDataAdapter.getAccountDataFromServer(`m.secret_storage.key.${keyId}`);\n        return keyInfo ? [keyId, keyInfo] : null;\n    }\n\n    /**\n     * Check whether we have a key with a given ID.\n     *\n     * @param keyId - The ID of the key to check\n     *     for. Defaults to the default key ID if not provided.\n     * @returns Whether we have the key.\n     */\n    public async hasKey(keyId?: string): Promise<boolean> {\n        const key = await this.getKey(keyId);\n        return Boolean(key);\n    }\n\n    /**\n     * Check whether a key matches what we expect based on the key info\n     *\n     * @param key - the key to check\n     * @param info - the key info\n     *\n     * @returns whether or not the key matches\n     */\n    public async checkKey(key: Uint8Array<ArrayBuffer>, info: SecretStorageKeyDescriptionAesV1): Promise<boolean> {\n        if (info.algorithm === SECRET_STORAGE_ALGORITHM_V1_AES) {\n            if (info.mac) {\n                const { mac } = await calculateKeyCheck(key, info.iv);\n                return trimTrailingEquals(info.mac) === trimTrailingEquals(mac);\n            } else {\n                // if we have no information, we have to assume the key is right\n                return true;\n            }\n        } else {\n            throw new Error(\"Unknown algorithm\");\n        }\n    }\n\n    /**\n     * Implementation of {@link ServerSideSecretStorage#store}.\n     */\n    public async store(name: SecretStorageKey, secret: string | null, keys?: string[] | null): Promise<void> {\n        if (secret === null) {\n            // remove secret\n            await this.accountDataAdapter.setAccountData(name, {});\n            return;\n        }\n\n        const encrypted: Record<string, AESEncryptedSecretStoragePayload> = {};\n\n        if (!keys) {\n            const defaultKeyId = await this.getDefaultKeyId();\n            if (!defaultKeyId) {\n                throw new Error(\"No keys specified and no default key present\");\n            }\n            keys = [defaultKeyId];\n        }\n\n        if (keys.length === 0) {\n            throw new Error(\"Zero keys given to encrypt with!\");\n        }\n\n        for (const keyId of keys) {\n            // get key information from key storage\n            const keyInfo = await this.accountDataAdapter.getAccountDataFromServer(`m.secret_storage.key.${keyId}`);\n            if (!keyInfo) {\n                throw new Error(\"Unknown key: \" + keyId);\n            }\n\n            // encrypt secret, based on the algorithm\n            if (keyInfo.algorithm === SECRET_STORAGE_ALGORITHM_V1_AES) {\n                const keys = { [keyId]: keyInfo };\n                const [, encryption] = await this.getSecretStorageKey(keys, name);\n                encrypted[keyId] = await encryption.encrypt(secret);\n            } else {\n                logger.warn(\"unknown algorithm for secret storage key \" + keyId + \": \" + keyInfo.algorithm);\n                // do nothing if we don't understand the encryption algorithm\n            }\n        }\n\n        // save encrypted secret\n        await this.accountDataAdapter.setAccountData(name, { encrypted });\n    }\n\n    /**\n     * Get a secret from storage, and decrypt it.\n     *\n     * {@link SecretStorageCallbacks#getSecretStorageKey} will be called to obtain a secret storage\n     * key to decrypt the secret.\n     *\n     * @param name - the name of the secret - i.e., the \"event type\" stored in the account data\n     *\n     * @returns the decrypted contents of the secret, or \"undefined\" if `name` is not found in\n     *    the user's account data.\n     */\n    public async get(name: SecretStorageKey): Promise<string | undefined> {\n        const secretInfo = await this.accountDataAdapter.getAccountDataFromServer(name);\n        if (!secretInfo) {\n            return;\n        }\n        if (!secretInfo.encrypted) {\n            throw new Error(\"Content is not encrypted!\");\n        }\n\n        // get possible keys to decrypt\n        const keys: Record<string, SecretStorageKeyDescriptionAesV1> = {};\n        for (const keyId of Object.keys(secretInfo.encrypted)) {\n            // get key information from key storage\n            const keyInfo = await this.accountDataAdapter.getAccountDataFromServer(`m.secret_storage.key.${keyId}`);\n            const encInfo = secretInfo.encrypted[keyId];\n            // only use keys we understand the encryption algorithm of\n            if (keyInfo?.algorithm === SECRET_STORAGE_ALGORITHM_V1_AES) {\n                if (encInfo.iv && encInfo.ciphertext && encInfo.mac) {\n                    keys[keyId] = keyInfo;\n                }\n            }\n        }\n\n        if (Object.keys(keys).length === 0) {\n            throw new Error(\n                `Could not decrypt ${name} because none of ` +\n                    `the keys it is encrypted with are for a supported algorithm`,\n            );\n        }\n\n        // fetch private key from app\n        const [keyId, decryption] = await this.getSecretStorageKey(keys, name);\n        const encInfo = secretInfo.encrypted[keyId];\n\n        return decryption.decrypt(encInfo);\n    }\n\n    /**\n     * Check if a secret is stored on the server.\n     *\n     * @param name - the name of the secret\n     *\n     * @returns map of key name to key info the secret is encrypted\n     *     with, or null if it is not present or not encrypted with a trusted\n     *     key\n     */\n    public async isStored(name: SecretStorageKey): Promise<Record<string, SecretStorageKeyDescriptionAesV1> | null> {\n        // check if secret exists\n        const secretInfo = await this.accountDataAdapter.getAccountDataFromServer(name);\n        if (!secretInfo?.encrypted) return null;\n\n        const ret: Record<string, SecretStorageKeyDescriptionAesV1> = {};\n\n        // filter secret encryption keys with supported algorithm\n        for (const keyId of Object.keys(secretInfo.encrypted)) {\n            // get key information from key storage\n            const keyInfo = await this.accountDataAdapter.getAccountDataFromServer(`m.secret_storage.key.${keyId}`);\n            if (!keyInfo) continue;\n            const encInfo = secretInfo.encrypted[keyId];\n\n            // only use keys we understand the encryption algorithm of\n            if (keyInfo.algorithm === SECRET_STORAGE_ALGORITHM_V1_AES) {\n                if (encInfo.iv && encInfo.ciphertext && encInfo.mac) {\n                    ret[keyId] = keyInfo;\n                }\n            }\n        }\n        return Object.keys(ret).length ? ret : null;\n    }\n\n    private async getSecretStorageKey(\n        keys: Record<string, SecretStorageKeyDescriptionAesV1>,\n        name: string,\n    ): Promise<[string, Decryptors]> {\n        if (!this.callbacks.getSecretStorageKey) {\n            throw new Error(\"No getSecretStorageKey callback supplied\");\n        }\n\n        const returned = await this.callbacks.getSecretStorageKey({ keys }, name);\n\n        if (!returned) {\n            throw new Error(\"getSecretStorageKey callback returned falsey\");\n        }\n        if (returned.length < 2) {\n            throw new Error(\"getSecretStorageKey callback returned invalid data\");\n        }\n\n        const [keyId, privateKey] = returned;\n        if (!keys[keyId]) {\n            throw new Error(\"App returned unknown key from getSecretStorageKey!\");\n        }\n\n        if (keys[keyId].algorithm === SECRET_STORAGE_ALGORITHM_V1_AES) {\n            const decryption = {\n                encrypt: function (secret: string): Promise<AESEncryptedSecretStoragePayload> {\n                    return encryptAESSecretStorageItem(secret, privateKey, name);\n                },\n                decrypt: function (encInfo: AESEncryptedSecretStoragePayload): Promise<string> {\n                    return decryptAESSecretStorageItem(encInfo, privateKey, name);\n                },\n            };\n            return [keyId, decryption];\n        } else {\n            throw new Error(\"Unknown key type: \" + keys[keyId].algorithm);\n        }\n    }\n}\n\n/** trim trailing instances of '=' from a string\n *\n * @internal\n *\n * @param input - input string\n */\nexport function trimTrailingEquals(input: string): string {\n    // according to Sonar and CodeQL, a regex such as /=+$/ is superlinear.\n    // Not sure I believe it, but it's easy enough to work around.\n\n    // find the number of characters before the trailing =\n    let i = input.length;\n    while (i >= 1 && input.charCodeAt(i - 1) == 0x3d) i--;\n\n    // trim to the calculated length\n    if (i < input.length) {\n        return input.substring(0, i);\n    } else {\n        return input;\n    }\n}\n\n// string of zeroes, for calculating the key check\nconst ZERO_STR = \"\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\\0\";\n\n/**\n * Calculate the MAC for checking the key.\n * See https://spec.matrix.org/v1.11/client-server-api/#msecret_storagev1aes-hmac-sha2, steps 3 and 4.\n *\n * @param key - the key to use\n * @param iv - The initialization vector as a base64-encoded string.\n *     If omitted, a random initialization vector will be created.\n * @returns An object that contains, `mac` and `iv` properties.\n */\nexport function calculateKeyCheck(\n    key: Uint8Array<ArrayBuffer>,\n    iv?: string,\n): Promise<AESEncryptedSecretStoragePayload> {\n    return encryptAESSecretStorageItem(ZERO_STR, key, \"\", iv);\n}\n"],"mappings":";AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;;AAGA,SAASA,WAAW,QAAoC,aAAa;AAErE,SAASC,kBAAkB,QAAQ,mBAAmB;AACtD,SAASC,MAAM,QAAQ,aAAa;AACpC,OAAOC,2BAA2B,MAAM,wCAAwC;AAChF,OAAOC,2BAA2B,MAAM,wCAAwC;AAKhF,OAAO,IAAMC,+BAA+B,GAAG,mCAAmC;;AAElF;AACA;AACA;AACA;AACA;AACA;AACA;;AAcA;AACA;AACA;AACA;AACA;AACA;AACA;;AAeA;AACA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;;AAeA;AACA;AACA;;AAUA;AACA;AACA;;AAGA;AACA;AACA;;AAQA;AACA;AACA;AACA;;AAyBA;AACA;AACA;;AAgDA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;;AAYA;AACA;AACA;AACA;AACA;AACA;;AAqGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,2BAA2B,CAAoC;EACxE;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACWC,WAAWA,CACGC,kBAAqC,EACrCC,SAAiC,EACpD;IAAA,KAFmBD,kBAAqC,GAArCA,kBAAqC;IAAA,KACrCC,SAAiC,GAAjCA,SAAiC;EACnD;;EAEH;AACJ;AACA;AACA;AACA;EACiBC,eAAeA,CAAA,EAA2B;IAAA,IAAAC,KAAA;IAAA,OAAAC,iBAAA;MAAA,IAAAC,eAAA;MACnD,IAAMC,UAAU,SAASH,KAAI,CAACH,kBAAkB,CAACO,wBAAwB,CAAC,8BAA8B,CAAC;MACzG,IAAI,CAACD,UAAU,EAAE,OAAO,IAAI;MAC5B,QAAAD,eAAA,GAAOC,UAAU,CAACE,GAAG,cAAAH,eAAA,cAAAA,eAAA,GAAI,IAAI;IAAC;EAClC;;EAEA;AACJ;AACA;EACWI,eAAeA,CAACC,KAAoB,EAAiB;IACxD,OAAO,IAAIC,OAAO,CAAO,CAACC,OAAO,EAAEC,MAAM,KAAK;MAC1C,IAAMC,QAAQ,GAAIC,EAAc,IAAW;QACvC,IAAIA,EAAE,CAACC,OAAO,CAAC,CAAC,KAAK,8BAA8B,EAAE;UACjD;UACA;QACJ;;QAEA;QACA;QACA,IAAMC,OAAO,GAAGF,EAAE,CAACG,UAAU,CAAC,CAAC;QAC/B,IAAMC,SAAS,GAAGT,KAAK,KAAK,IAAI,GAAGU,MAAM,CAACC,IAAI,CAACJ,OAAO,CAAC,CAACK,MAAM,KAAK,CAAC,GAAGL,OAAO,CAACT,GAAG,KAAKE,KAAK;QAC5F,IAAIS,SAAS,EAAE;UACX,IAAI,CAACnB,kBAAkB,CAACuB,cAAc,CAAC/B,WAAW,CAACgC,WAAW,EAAEV,QAAQ,CAAC;UACzEF,OAAO,CAAC,CAAC;QACb;MACJ,CAAC;MACD,IAAI,CAACZ,kBAAkB,CAACyB,EAAE,CAACjC,WAAW,CAACgC,WAAW,EAAEV,QAAQ,CAAC;;MAE7D;MACA;MACA;MACA;MACA,IAAMY,QAAiD,GAAGhB,KAAK,KAAK,IAAI,GAAG,CAAC,CAAC,GAAG;QAAEF,GAAG,EAAEE;MAAM,CAAC;MAC9F,IAAI,CAACV,kBAAkB,CAAC2B,cAAc,CAAC,8BAA8B,EAAED,QAAQ,CAAC,CAACE,KAAK,CAAEC,CAAC,IAAK;QAC1F,IAAI,CAAC7B,kBAAkB,CAACuB,cAAc,CAAC/B,WAAW,CAACgC,WAAW,EAAEV,QAAQ,CAAC;QACzED,MAAM,CAACgB,CAAC,CAAC;MACb,CAAC,CAAC;IACN,CAAC,CAAC;EACN;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACiBC,MAAMA,CACfC,SAAiB,EACjBC,IAA6B,EAC7BtB,KAAc,EACiB;IAAA,IAAAuB,MAAA;IAAA,OAAA7B,iBAAA;MAC/B,IAAI2B,SAAS,KAAKlC,+BAA+B,EAAE;QAC/C,MAAM,IAAIqC,KAAK,0BAAAC,MAAA,CAA0BJ,SAAS,CAAE,CAAC;MACzD;MAEA,IAAMK,OAAO,GAAG;QAAEL;MAAU,CAAqC;MAEjE,IAAIC,IAAI,CAACK,IAAI,EAAE;QACXD,OAAO,CAACC,IAAI,GAAGL,IAAI,CAACK,IAAI;MAC5B;MAEA,IAAIL,IAAI,CAACM,UAAU,EAAE;QACjBF,OAAO,CAACE,UAAU,GAAGN,IAAI,CAACM,UAAU;MACxC;MAEA,IAAM;QAAEC,EAAE;QAAEC;MAAI,CAAC,SAASC,iBAAiB,CAACT,IAAI,CAACxB,GAAG,CAAC;MACrD4B,OAAO,CAACG,EAAE,GAAGA,EAAE;MACfH,OAAO,CAACI,GAAG,GAAGA,GAAG;;MAEjB;MACA,IAAI,CAAC9B,KAAK,EAAE;QACR,GAAG;UACCA,KAAK,GAAGjB,kBAAkB,CAAC,EAAE,CAAC;QAClC,CAAC,cAAcwC,MAAI,CAACjC,kBAAkB,CAACO,wBAAwB,yBAAA4B,MAAA,CAAyBzB,KAAK,CAAE,CAAC;MACpG;MAEA,MAAMuB,MAAI,CAACjC,kBAAkB,CAAC2B,cAAc,yBAAAQ,MAAA,CAAyBzB,KAAK,GAAI0B,OAAO,CAAC;MAEtF,OAAO;QACH1B,KAAK;QACL0B;MACJ,CAAC;IAAC;EACN;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACiBM,MAAMA,CAAChC,KAAqB,EAAyC;IAAA,IAAAiC,MAAA;IAAA,OAAAvC,iBAAA;MAC9E,IAAI,CAACM,KAAK,EAAE;QACRA,KAAK,SAASiC,MAAI,CAACzC,eAAe,CAAC,CAAC;MACxC;MACA,IAAI,CAACQ,KAAK,EAAE;QACR,OAAO,IAAI;MACf;MAEA,IAAM0B,OAAO,SAASO,MAAI,CAAC3C,kBAAkB,CAACO,wBAAwB,yBAAA4B,MAAA,CAAyBzB,KAAK,CAAE,CAAC;MACvG,OAAO0B,OAAO,GAAG,CAAC1B,KAAK,EAAE0B,OAAO,CAAC,GAAG,IAAI;IAAC;EAC7C;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;EACiBQ,MAAMA,CAAClC,KAAc,EAAoB;IAAA,IAAAmC,MAAA;IAAA,OAAAzC,iBAAA;MAClD,IAAMI,GAAG,SAASqC,MAAI,CAACH,MAAM,CAAChC,KAAK,CAAC;MACpC,OAAOoC,OAAO,CAACtC,GAAG,CAAC;IAAC;EACxB;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;EACiBuC,QAAQA,CAACvC,GAA4B,EAAEwC,IAAsC,EAAoB;IAAA,OAAA5C,iBAAA;MAC1G,IAAI4C,IAAI,CAACjB,SAAS,KAAKlC,+BAA+B,EAAE;QACpD,IAAImD,IAAI,CAACR,GAAG,EAAE;UACV,IAAM;YAAEA;UAAI,CAAC,SAASC,iBAAiB,CAACjC,GAAG,EAAEwC,IAAI,CAACT,EAAE,CAAC;UACrD,OAAOU,kBAAkB,CAACD,IAAI,CAACR,GAAG,CAAC,KAAKS,kBAAkB,CAACT,GAAG,CAAC;QACnE,CAAC,MAAM;UACH;UACA,OAAO,IAAI;QACf;MACJ,CAAC,MAAM;QACH,MAAM,IAAIN,KAAK,CAAC,mBAAmB,CAAC;MACxC;IAAC;EACL;;EAEA;AACJ;AACA;EACiBgB,KAAKA,CAACb,IAAsB,EAAEc,MAAqB,EAAE9B,IAAsB,EAAiB;IAAA,IAAA+B,MAAA;IAAA,OAAAhD,iBAAA;MACrG,IAAI+C,MAAM,KAAK,IAAI,EAAE;QACjB;QACA,MAAMC,MAAI,CAACpD,kBAAkB,CAAC2B,cAAc,CAACU,IAAI,EAAE,CAAC,CAAC,CAAC;QACtD;MACJ;MAEA,IAAMgB,SAA2D,GAAG,CAAC,CAAC;MAEtE,IAAI,CAAChC,IAAI,EAAE;QACP,IAAMiC,YAAY,SAASF,MAAI,CAAClD,eAAe,CAAC,CAAC;QACjD,IAAI,CAACoD,YAAY,EAAE;UACf,MAAM,IAAIpB,KAAK,CAAC,8CAA8C,CAAC;QACnE;QACAb,IAAI,GAAG,CAACiC,YAAY,CAAC;MACzB;MAEA,IAAIjC,IAAI,CAACC,MAAM,KAAK,CAAC,EAAE;QACnB,MAAM,IAAIY,KAAK,CAAC,kCAAkC,CAAC;MACvD;MAEA,KAAK,IAAMxB,MAAK,IAAIW,IAAI,EAAE;QACtB;QACA,IAAMe,QAAO,SAASgB,MAAI,CAACpD,kBAAkB,CAACO,wBAAwB,yBAAA4B,MAAA,CAAyBzB,MAAK,CAAE,CAAC;QACvG,IAAI,CAAC0B,QAAO,EAAE;UACV,MAAM,IAAIF,KAAK,CAAC,eAAe,GAAGxB,MAAK,CAAC;QAC5C;;QAEA;QACA,IAAI0B,QAAO,CAACL,SAAS,KAAKlC,+BAA+B,EAAE;UACvD,IAAMwB,KAAI,GAAG;YAAE,CAACX,MAAK,GAAG0B;UAAQ,CAAC;UACjC,IAAM,GAAGmB,UAAU,CAAC,SAASH,MAAI,CAACI,mBAAmB,CAACnC,KAAI,EAAEgB,IAAI,CAAC;UACjEgB,SAAS,CAAC3C,MAAK,CAAC,SAAS6C,UAAU,CAACE,OAAO,CAACN,MAAM,CAAC;QACvD,CAAC,MAAM;UACHzD,MAAM,CAACgE,IAAI,CAAC,2CAA2C,GAAGhD,MAAK,GAAG,IAAI,GAAG0B,QAAO,CAACL,SAAS,CAAC;UAC3F;QACJ;MACJ;;MAEA;MACA,MAAMqB,MAAI,CAACpD,kBAAkB,CAAC2B,cAAc,CAACU,IAAI,EAAE;QAAEgB;MAAU,CAAC,CAAC;IAAC;EACtE;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACiBM,GAAGA,CAACtB,IAAsB,EAA+B;IAAA,IAAAuB,MAAA;IAAA,OAAAxD,iBAAA;MAClE,IAAMyD,UAAU,SAASD,MAAI,CAAC5D,kBAAkB,CAACO,wBAAwB,CAAC8B,IAAI,CAAC;MAC/E,IAAI,CAACwB,UAAU,EAAE;QACb;MACJ;MACA,IAAI,CAACA,UAAU,CAACR,SAAS,EAAE;QACvB,MAAM,IAAInB,KAAK,CAAC,2BAA2B,CAAC;MAChD;;MAEA;MACA,IAAMb,IAAsD,GAAG,CAAC,CAAC;MACjE,KAAK,IAAMX,OAAK,IAAIU,MAAM,CAACC,IAAI,CAACwC,UAAU,CAACR,SAAS,CAAC,EAAE;QACnD;QACA,IAAMjB,SAAO,SAASwB,MAAI,CAAC5D,kBAAkB,CAACO,wBAAwB,yBAAA4B,MAAA,CAAyBzB,OAAK,CAAE,CAAC;QACvG,IAAMoD,QAAO,GAAGD,UAAU,CAACR,SAAS,CAAC3C,OAAK,CAAC;QAC3C;QACA,IAAI,CAAA0B,SAAO,aAAPA,SAAO,uBAAPA,SAAO,CAAEL,SAAS,MAAKlC,+BAA+B,EAAE;UACxD,IAAIiE,QAAO,CAACvB,EAAE,IAAIuB,QAAO,CAACC,UAAU,IAAID,QAAO,CAACtB,GAAG,EAAE;YACjDnB,IAAI,CAACX,OAAK,CAAC,GAAG0B,SAAO;UACzB;QACJ;MACJ;MAEA,IAAIhB,MAAM,CAACC,IAAI,CAACA,IAAI,CAAC,CAACC,MAAM,KAAK,CAAC,EAAE;QAChC,MAAM,IAAIY,KAAK,CACX,qBAAAC,MAAA,CAAqBE,IAAI,sFAE7B,CAAC;MACL;;MAEA;MACA,IAAM,CAAC3B,KAAK,EAAEsD,UAAU,CAAC,SAASJ,MAAI,CAACJ,mBAAmB,CAACnC,IAAI,EAAEgB,IAAI,CAAC;MACtE,IAAMyB,OAAO,GAAGD,UAAU,CAACR,SAAS,CAAC3C,KAAK,CAAC;MAE3C,OAAOsD,UAAU,CAACC,OAAO,CAACH,OAAO,CAAC;IAAC;EACvC;;EAEA;AACJ;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACiBI,QAAQA,CAAC7B,IAAsB,EAAoE;IAAA,IAAA8B,MAAA;IAAA,OAAA/D,iBAAA;MAC5G;MACA,IAAMyD,UAAU,SAASM,MAAI,CAACnE,kBAAkB,CAACO,wBAAwB,CAAC8B,IAAI,CAAC;MAC/E,IAAI,EAACwB,UAAU,aAAVA,UAAU,eAAVA,UAAU,CAAER,SAAS,GAAE,OAAO,IAAI;MAEvC,IAAMe,GAAqD,GAAG,CAAC,CAAC;;MAEhE;MACA,KAAK,IAAM1D,OAAK,IAAIU,MAAM,CAACC,IAAI,CAACwC,UAAU,CAACR,SAAS,CAAC,EAAE;QACnD;QACA,IAAMjB,SAAO,SAAS+B,MAAI,CAACnE,kBAAkB,CAACO,wBAAwB,yBAAA4B,MAAA,CAAyBzB,OAAK,CAAE,CAAC;QACvG,IAAI,CAAC0B,SAAO,EAAE;QACd,IAAM0B,OAAO,GAAGD,UAAU,CAACR,SAAS,CAAC3C,OAAK,CAAC;;QAE3C;QACA,IAAI0B,SAAO,CAACL,SAAS,KAAKlC,+BAA+B,EAAE;UACvD,IAAIiE,OAAO,CAACvB,EAAE,IAAIuB,OAAO,CAACC,UAAU,IAAID,OAAO,CAACtB,GAAG,EAAE;YACjD4B,GAAG,CAAC1D,OAAK,CAAC,GAAG0B,SAAO;UACxB;QACJ;MACJ;MACA,OAAOhB,MAAM,CAACC,IAAI,CAAC+C,GAAG,CAAC,CAAC9C,MAAM,GAAG8C,GAAG,GAAG,IAAI;IAAC;EAChD;EAEcZ,mBAAmBA,CAC7BnC,IAAsD,EACtDgB,IAAY,EACiB;IAAA,IAAAgC,MAAA;IAAA,OAAAjE,iBAAA;MAC7B,IAAI,CAACiE,MAAI,CAACpE,SAAS,CAACuD,mBAAmB,EAAE;QACrC,MAAM,IAAItB,KAAK,CAAC,0CAA0C,CAAC;MAC/D;MAEA,IAAMoC,QAAQ,SAASD,MAAI,CAACpE,SAAS,CAACuD,mBAAmB,CAAC;QAAEnC;MAAK,CAAC,EAAEgB,IAAI,CAAC;MAEzE,IAAI,CAACiC,QAAQ,EAAE;QACX,MAAM,IAAIpC,KAAK,CAAC,8CAA8C,CAAC;MACnE;MACA,IAAIoC,QAAQ,CAAChD,MAAM,GAAG,CAAC,EAAE;QACrB,MAAM,IAAIY,KAAK,CAAC,oDAAoD,CAAC;MACzE;MAEA,IAAM,CAACxB,KAAK,EAAE6D,UAAU,CAAC,GAAGD,QAAQ;MACpC,IAAI,CAACjD,IAAI,CAACX,KAAK,CAAC,EAAE;QACd,MAAM,IAAIwB,KAAK,CAAC,oDAAoD,CAAC;MACzE;MAEA,IAAIb,IAAI,CAACX,KAAK,CAAC,CAACqB,SAAS,KAAKlC,+BAA+B,EAAE;QAC3D,IAAMmE,UAAU,GAAG;UACfP,OAAO,EAAE,SAATA,OAAOA,CAAYN,MAAc,EAA6C;YAC1E,OAAOxD,2BAA2B,CAACwD,MAAM,EAAEoB,UAAU,EAAElC,IAAI,CAAC;UAChE,CAAC;UACD4B,OAAO,EAAE,SAATA,OAAOA,CAAYH,OAAyC,EAAmB;YAC3E,OAAOlE,2BAA2B,CAACkE,OAAO,EAAES,UAAU,EAAElC,IAAI,CAAC;UACjE;QACJ,CAAC;QACD,OAAO,CAAC3B,KAAK,EAAEsD,UAAU,CAAC;MAC9B,CAAC,MAAM;QACH,MAAM,IAAI9B,KAAK,CAAC,oBAAoB,GAAGb,IAAI,CAACX,KAAK,CAAC,CAACqB,SAAS,CAAC;MACjE;IAAC;EACL;AACJ;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASkB,kBAAkBA,CAACuB,KAAa,EAAU;EACtD;EACA;;EAEA;EACA,IAAIC,CAAC,GAAGD,KAAK,CAAClD,MAAM;EACpB,OAAOmD,CAAC,IAAI,CAAC,IAAID,KAAK,CAACE,UAAU,CAACD,CAAC,GAAG,CAAC,CAAC,IAAI,IAAI,EAAEA,CAAC,EAAE;;EAErD;EACA,IAAIA,CAAC,GAAGD,KAAK,CAAClD,MAAM,EAAE;IAClB,OAAOkD,KAAK,CAACG,SAAS,CAAC,CAAC,EAAEF,CAAC,CAAC;EAChC,CAAC,MAAM;IACH,OAAOD,KAAK;EAChB;AACJ;;AAEA;AACA,IAAMI,QAAQ,GAAG,kEAAkE;;AAEnF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAASnC,iBAAiBA,CAC7BjC,GAA4B,EAC5B+B,EAAW,EAC8B;EACzC,OAAO5C,2BAA2B,CAACiF,QAAQ,EAAEpE,GAAG,EAAE,EAAE,EAAE+B,EAAE,CAAC;AAC7D","ignoreList":[]}

package/lib/serverCapabilities.d.ts

@@ -0,0 +1,78 @@
+import { type IHttpOpts, type BriijHttpApi } from "./http-api/index.ts";
+import { type Logger } from "./logger.ts";
+export interface ICapability {
+    enabled: boolean;
+}
+export interface IChangePasswordCapability extends ICapability {
+}
+export interface IThreadsCapability extends ICapability {
+}
+export interface IGetLoginTokenCapability extends ICapability {
+}
+export interface ISetDisplayNameCapability extends ICapability {
+}
+export interface ISetAvatarUrlCapability extends ICapability {
+}
+export interface IProfileFieldsCapability extends ICapability {
+}
+export declare enum RoomVersionStability {
+    Stable = "stable",
+    Unstable = "unstable"
+}
+export interface IRoomVersionsCapability {
+    default: string;
+    available: Record<string, RoomVersionStability>;
+}
+/**
+ * A representation of the capabilities advertised by a homeserver as defined by
+ * [Capabilities negotiation](https://spec.matrix.org/v1.6/client-server-api/#get_matrixclientv3capabilities).
+ */
+export interface Capabilities {
+    [key: string]: any;
+    "m.change_password"?: IChangePasswordCapability;
+    "m.room_versions"?: IRoomVersionsCapability;
+    "io.element.thread"?: IThreadsCapability;
+    "m.get_login_token"?: IGetLoginTokenCapability;
+    "org.matrix.msc3882.get_login_token"?: IGetLoginTokenCapability;
+    "m.set_displayname"?: ISetDisplayNameCapability;
+    "m.set_avatar_url"?: ISetAvatarUrlCapability;
+    "uk.tcpip.msc4133.profile_fields"?: IProfileFieldsCapability;
+    /**
+     * Since Matrix v1.16
+     */
+    "m.profile_fields"?: IProfileFieldsCapability;
+}
+/**
+ * Manages storing and periodically refreshing the server capabilities.
+ */
+export declare class ServerCapabilities {
+    private readonly logger;
+    private readonly http;
+    private capabilities?;
+    private retryTimeout?;
+    private refreshTimeout?;
+    constructor(logger: Logger, http: BriijHttpApi<IHttpOpts & {
+        onlyData: true;
+    }>);
+    /**
+     * Starts periodically fetching the server capabilities.
+     */
+    start(): void;
+    /**
+     * Stops the service
+     */
+    stop(): void;
+    /**
+     * Returns the cached capabilities, or undefined if none are cached.
+     * @returns the current capabilities, if any.
+     */
+    getCachedCapabilities(): Capabilities | undefined;
+    /**
+     * Fetches the latest server capabilities from the homeserver and returns them, or rejects
+     * on failure.
+     */
+    fetchCapabilities: () => Promise<Capabilities>;
+    private poll;
+    private clearTimeouts;
+}
+//# sourceMappingURL=serverCapabilities.d.ts.map

package/lib/serverCapabilities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"serverCapabilities.d.ts","sourceRoot":"","sources":["../src/serverCapabilities.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,KAAK,SAAS,EAAE,KAAK,YAAY,EAAU,MAAM,qBAAqB,CAAC;AAChF,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,aAAa,CAAC;AAS1C,MAAM,WAAW,WAAW;IACxB,OAAO,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,yBAA0B,SAAQ,WAAW;CAAG;AAEjE,MAAM,WAAW,kBAAmB,SAAQ,WAAW;CAAG;AAE1D,MAAM,WAAW,wBAAyB,SAAQ,WAAW;CAAG;AAEhE,MAAM,WAAW,yBAA0B,SAAQ,WAAW;CAAG;AAEjE,MAAM,WAAW,uBAAwB,SAAQ,WAAW;CAAG;AAE/D,MAAM,WAAW,wBAAyB,SAAQ,WAAW;CAAG;AAEhE,oBAAY,oBAAoB;IAC5B,MAAM,WAAW;IACjB,QAAQ,aAAa;CACxB;AAED,MAAM,WAAW,uBAAuB;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,oBAAoB,CAAC,CAAC;CACnD;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;IACnB,mBAAmB,CAAC,EAAE,yBAAyB,CAAC;IAChD,iBAAiB,CAAC,EAAE,uBAAuB,CAAC;IAC5C,mBAAmB,CAAC,EAAE,kBAAkB,CAAC;IACzC,mBAAmB,CAAC,EAAE,wBAAwB,CAAC;IAC/C,oCAAoC,CAAC,EAAE,wBAAwB,CAAC;IAChE,mBAAmB,CAAC,EAAE,yBAAyB,CAAC;IAChD,kBAAkB,CAAC,EAAE,uBAAuB,CAAC;IAC7C,iCAAiC,CAAC,EAAE,wBAAwB,CAAC;IAC7D;;OAEG;IACH,kBAAkB,CAAC,EAAE,wBAAwB,CAAC;CACjD;AAMD;;GAEG;AACH,qBAAa,kBAAkB;IAMvB,OAAO,CAAC,QAAQ,CAAC,MAAM;IACvB,OAAO,CAAC,QAAQ,CAAC,IAAI;IANzB,OAAO,CAAC,YAAY,CAAC,CAAe;IACpC,OAAO,CAAC,YAAY,CAAC,CAAgC;IACrD,OAAO,CAAC,cAAc,CAAC,CAAiC;gBAGnC,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,YAAY,CAAC,SAAS,GAAG;QAAE,QAAQ,EAAE,IAAI,CAAA;KAAE,CAAC;IAGvE;;OAEG;IACI,KAAK,IAAI,IAAI;IAIpB;;OAEG;IACI,IAAI,IAAI,IAAI;IAInB;;;OAGG;IACI,qBAAqB,IAAI,YAAY,GAAG,SAAS;IAIxD;;;OAGG;IACI,iBAAiB,QAAa,OAAO,CAAC,YAAY,CAAC,CAIxD;IAEF,OAAO,CAAC,IAAI,CAYV;IAEF,OAAO,CAAC,aAAa;CAUxB"}