summaryrefslogtreecommitdiff
path: root/includes/external/matrix/node_modules/matrix-js-sdk/src/secret-storage.ts
diff options
context:
space:
mode:
authorRaindropsSys <contact@minteck.org>2023-04-24 14:03:36 +0200
committerRaindropsSys <contact@minteck.org>2023-04-24 14:03:36 +0200
commit633c92eae865e957121e08de634aeee11a8b3992 (patch)
tree09d881bee1dae0b6eee49db1dfaf0f500240606c /includes/external/matrix/node_modules/matrix-js-sdk/src/secret-storage.ts
parentc4657e4509733699c0f26a3c900bab47e915d5a0 (diff)
downloadpluralconnect-633c92eae865e957121e08de634aeee11a8b3992.tar.gz
pluralconnect-633c92eae865e957121e08de634aeee11a8b3992.tar.bz2
pluralconnect-633c92eae865e957121e08de634aeee11a8b3992.zip
Updated 18 files, added 1692 files and deleted includes/system/compare.inc (automated)
Diffstat (limited to 'includes/external/matrix/node_modules/matrix-js-sdk/src/secret-storage.ts')
-rw-r--r--includes/external/matrix/node_modules/matrix-js-sdk/src/secret-storage.ts88
1 files changed, 88 insertions, 0 deletions
diff --git a/includes/external/matrix/node_modules/matrix-js-sdk/src/secret-storage.ts b/includes/external/matrix/node_modules/matrix-js-sdk/src/secret-storage.ts
new file mode 100644
index 0000000..f0c19c4
--- /dev/null
+++ b/includes/external/matrix/node_modules/matrix-js-sdk/src/secret-storage.ts
@@ -0,0 +1,88 @@
+/*
+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
+ */
+
+/**
+ * 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
+ */
+export interface SecretStorageKeyDescriptionCommon {
+ /** A human-readable name for this key. */
+ // XXX: according to the spec, this is optional
+ name: string;
+
+ /** The encryption algorithm used with this key. */
+ algorithm: string;
+
+ /** Information for deriving this key from a passphrase. */
+ // XXX: according to the spec, this is optional
+ passphrase: PassphraseInfo;
+}
+
+/**
+ * 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
+ */
+export interface SecretStorageKeyDescriptionAesV1 extends SecretStorageKeyDescriptionCommon {
+ // XXX: strictly speaking, we should be able to enforce the algorithm here. But
+ // this interface ends up being incorrectly used where other algorithms are in use (notably
+ // in device-dehydration support), and unpicking that is too much like hard work
+ // at the moment.
+ // algorithm: "m.secret_storage.v1.aes-hmac-sha2";
+
+ /** The 16-byte AES initialization vector, encoded as base64. */
+ iv: string;
+
+ /** The MAC of the result of encrypting 32 bytes of 0, encoded as base64. */
+ mac: string;
+}
+
+/**
+ * Union type for secret storage keys.
+ *
+ * For now, this is only {@link SecretStorageKeyDescriptionAesV1}, but other interfaces may be added in future.
+ */
+export type SecretStorageKeyDescription = SecretStorageKeyDescriptionAesV1;
+
+/**
+ * Information on how to generate the key from a passphrase.
+ *
+ * @see https://spec.matrix.org/v1.6/client-server-api/#deriving-keys-from-passphrases
+ */
+export interface PassphraseInfo {
+ /** The algorithm to be used to derive the key. */
+ algorithm: "m.pbkdf2";
+
+ /** The number of PBKDF2 iterations to use. */
+ iterations: number;
+
+ /** The salt to be used for PBKDF2. */
+ salt: string;
+
+ /** The number of bits to generate. Defaults to 256. */
+ bits?: number;
+}