summaryrefslogtreecommitdiff
path: root/includes/external/matrix/node_modules/matrix-js-sdk/lib/crypto/CrossSigning.d.ts
diff options
context:
space:
mode:
authorRaindropsSys <raindrops@equestria.dev>2023-11-17 23:25:29 +0100
committerRaindropsSys <raindrops@equestria.dev>2023-11-17 23:25:29 +0100
commit953ddd82e48dd206cef5ac94456549aed13b3ad5 (patch)
tree8f003106ee2e7f422e5a22d2ee04d0db302e66c0 /includes/external/matrix/node_modules/matrix-js-sdk/lib/crypto/CrossSigning.d.ts
parent62a9199846b0c07c03218703b33e8385764f42d9 (diff)
downloadpluralconnect-953ddd82e48dd206cef5ac94456549aed13b3ad5.tar.gz
pluralconnect-953ddd82e48dd206cef5ac94456549aed13b3ad5.tar.bz2
pluralconnect-953ddd82e48dd206cef5ac94456549aed13b3ad5.zip
Updated 30 files and deleted 2976 files (automated)
Diffstat (limited to 'includes/external/matrix/node_modules/matrix-js-sdk/lib/crypto/CrossSigning.d.ts')
-rw-r--r--includes/external/matrix/node_modules/matrix-js-sdk/lib/crypto/CrossSigning.d.ts214
1 files changed, 0 insertions, 214 deletions
diff --git a/includes/external/matrix/node_modules/matrix-js-sdk/lib/crypto/CrossSigning.d.ts b/includes/external/matrix/node_modules/matrix-js-sdk/lib/crypto/CrossSigning.d.ts
deleted file mode 100644
index d9d17d9..0000000
--- a/includes/external/matrix/node_modules/matrix-js-sdk/lib/crypto/CrossSigning.d.ts
+++ /dev/null
@@ -1,214 +0,0 @@
-/**
- * Cross signing methods
- */
-import { PkSigning } from "@matrix-org/olm";
-import { DeviceInfo } from "./deviceinfo";
-import { SecretStorage } from "./SecretStorage";
-import { ICrossSigningKey, ISignedKey, MatrixClient } from "../client";
-import { OlmDevice } from "./OlmDevice";
-import { ICryptoCallbacks } from ".";
-import { ISignatures } from "../@types/signed";
-import { CryptoStore } from "./store/base";
-export interface ICacheCallbacks {
- getCrossSigningKeyCache?(type: string, expectedPublicKey?: string): Promise<Uint8Array | null>;
- storeCrossSigningKeyCache?(type: string, key?: Uint8Array): Promise<void>;
-}
-export interface ICrossSigningInfo {
- keys: Record<string, ICrossSigningKey>;
- firstUse: boolean;
- crossSigningVerifiedBefore: boolean;
-}
-export declare class CrossSigningInfo {
- readonly userId: string;
- private callbacks;
- private cacheCallbacks;
- keys: Record<string, ICrossSigningKey>;
- firstUse: boolean;
- private crossSigningVerifiedBefore;
- /**
- * Information about a user's cross-signing keys
- *
- * @param userId - the user that the information is about
- * @param callbacks - Callbacks used to interact with the app
- * Requires getCrossSigningKey and saveCrossSigningKeys
- * @param cacheCallbacks - Callbacks used to interact with the cache
- */
- constructor(userId: string, callbacks?: ICryptoCallbacks, cacheCallbacks?: ICacheCallbacks);
- static fromStorage(obj: ICrossSigningInfo, userId: string): CrossSigningInfo;
- toStorage(): ICrossSigningInfo;
- /**
- * Calls the app callback to ask for a private key
- *
- * @param type - The key type ("master", "self_signing", or "user_signing")
- * @param expectedPubkey - The matching public key or undefined to use
- * the stored public key for the given key type.
- * @returns An array with [ public key, Olm.PkSigning ]
- */
- getCrossSigningKey(type: string, expectedPubkey?: string): Promise<[string, PkSigning]>;
- /**
- * Check whether the private keys exist in secret storage.
- * XXX: This could be static, be we often seem to have an instance when we
- * want to know this anyway...
- *
- * @param secretStorage - The secret store using account data
- * @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
- */
- isStoredInSecretStorage(secretStorage: SecretStorage<MatrixClient | undefined>): Promise<Record<string, object> | null>;
- /**
- * Store private keys in secret storage for use by other devices. This is
- * typically called in conjunction with the creation of new cross-signing
- * keys.
- *
- * @param keys - The keys to store
- * @param secretStorage - The secret store using account data
- */
- static storeInSecretStorage(keys: Map<string, Uint8Array>, secretStorage: SecretStorage<undefined>): Promise<void>;
- /**
- * Get private keys from secret storage created by some other device. This
- * also passes the private keys to the app-specific callback.
- *
- * @param type - The type of key to get. One of "master",
- * "self_signing", or "user_signing".
- * @param secretStorage - The secret store using account data
- * @returns The private key
- */
- static getFromSecretStorage(type: string, secretStorage: SecretStorage): Promise<Uint8Array | null>;
- /**
- * Check whether the private keys exist in the local key cache.
- *
- * @param type - The type of key to get. One of "master",
- * "self_signing", or "user_signing". Optional, will check all by default.
- * @returns True if all keys are stored in the local cache.
- */
- isStoredInKeyCache(type?: string): Promise<boolean>;
- /**
- * Get cross-signing private keys from the local cache.
- *
- * @returns A map from key type (string) to private key (Uint8Array)
- */
- getCrossSigningKeysFromCache(): Promise<Map<string, Uint8Array>>;
- /**
- * Get the ID used to identify the user. This can also be used to test for
- * the existence of a given key type.
- *
- * @param type - The type of key to get the ID of. One of "master",
- * "self_signing", or "user_signing". Defaults to "master".
- *
- * @returns the ID
- */
- getId(type?: string): string | null;
- /**
- * Create new cross-signing keys for the given key types. The public keys
- * will be held in this class, while the private keys are passed off to the
- * `saveCrossSigningKeys` application callback.
- *
- * @param level - The key types to reset
- */
- resetKeys(level?: CrossSigningLevel): Promise<void>;
- /**
- * unsets the keys, used when another session has reset the keys, to disable cross-signing
- */
- clearKeys(): void;
- setKeys(keys: Record<string, ICrossSigningKey>): void;
- updateCrossSigningVerifiedBefore(isCrossSigningVerified: boolean): void;
- signObject<T extends object>(data: T, type: string): Promise<T & {
- signatures: ISignatures;
- }>;
- signUser(key: CrossSigningInfo): Promise<ICrossSigningKey | undefined>;
- signDevice(userId: string, device: DeviceInfo): Promise<ISignedKey | undefined>;
- /**
- * Check whether a given user is trusted.
- *
- * @param userCrossSigning - Cross signing info for user
- *
- * @returns
- */
- checkUserTrust(userCrossSigning: CrossSigningInfo): UserTrustLevel;
- /**
- * Check whether a given device is trusted.
- *
- * @param userCrossSigning - Cross signing info for user
- * @param device - The device to check
- * @param localTrust - Whether the device is trusted locally
- * @param trustCrossSignedDevices - Whether we trust cross signed devices
- *
- * @returns
- */
- checkDeviceTrust(userCrossSigning: CrossSigningInfo, device: DeviceInfo, localTrust: boolean, trustCrossSignedDevices: boolean): DeviceTrustLevel;
- /**
- * @returns Cache callbacks
- */
- getCacheCallbacks(): ICacheCallbacks;
-}
-export declare enum CrossSigningLevel {
- MASTER = 4,
- USER_SIGNING = 2,
- SELF_SIGNING = 1
-}
-/**
- * Represents the ways in which we trust a user
- */
-export declare class UserTrustLevel {
- private readonly crossSigningVerified;
- private readonly crossSigningVerifiedBefore;
- private readonly tofu;
- constructor(crossSigningVerified: boolean, crossSigningVerifiedBefore: boolean, tofu: boolean);
- /**
- * @returns true if this user is verified via any means
- */
- isVerified(): boolean;
- /**
- * @returns true if this user is verified via cross signing
- */
- isCrossSigningVerified(): boolean;
- /**
- * @returns true if we ever verified this user before (at least for
- * the history of verifications observed by this device).
- */
- wasCrossSigningVerified(): boolean;
- /**
- * @returns true if this user's key is trusted on first use
- */
- isTofu(): boolean;
-}
-/**
- * Represents the ways in which we trust a device
- */
-export declare class DeviceTrustLevel {
- readonly crossSigningVerified: boolean;
- readonly tofu: boolean;
- private readonly localVerified;
- private readonly trustCrossSignedDevices;
- constructor(crossSigningVerified: boolean, tofu: boolean, localVerified: boolean, trustCrossSignedDevices: boolean);
- static fromUserTrustLevel(userTrustLevel: UserTrustLevel, localVerified: boolean, trustCrossSignedDevices: boolean): DeviceTrustLevel;
- /**
- * @returns true if this device is verified via any means
- */
- isVerified(): boolean;
- /**
- * @returns true if this device is verified via cross signing
- */
- isCrossSigningVerified(): boolean;
- /**
- * @returns true if this device is verified locally
- */
- isLocallyVerified(): boolean;
- /**
- * @returns true if this device is trusted from a user's key
- * that is trusted on first use
- */
- isTofu(): boolean;
-}
-export declare function createCryptoStoreCacheCallbacks(store: CryptoStore, olmDevice: OlmDevice): ICacheCallbacks;
-export type KeysDuringVerification = [[string, PkSigning], [string, PkSigning], [string, PkSigning], void];
-/**
- * Request cross-signing keys from another device during verification.
- *
- * @param baseApis - base Matrix API interface
- * @param userId - The user ID being verified
- * @param deviceId - The device ID being verified
- */
-export declare function requestKeysDuringVerification(baseApis: MatrixClient, userId: string, deviceId: string): Promise<KeysDuringVerification | void>;
-//# sourceMappingURL=CrossSigning.d.ts.map \ No newline at end of file