@unwanted/matrix-sdk-mini 34.12.0 → 36.0.0

package/lib/crypto/CrossSigning.d.ts

@@ -1,184 +0,0 @@
-/**
- * Cross signing methods
- */
-import type { PkSigning } from "@matrix-org/olm";
-import { DeviceInfo } from "./deviceinfo.ts";
-import { ISignedKey, MatrixClient } from "../client.ts";
-import { OlmDevice } from "./OlmDevice.ts";
-import { ICryptoCallbacks } from "./index.ts";
-import { ISignatures } from "../@types/signed.ts";
-import { CryptoStore } from "./store/base.ts";
-import { ServerSideSecretStorage } from "../secret-storage.ts";
-import { CrossSigningKeyInfo, DeviceVerificationStatus, UserVerificationStatus as UserTrustLevel } from "../crypto-api/index.ts";
-export { UserTrustLevel };
-export interface ICacheCallbacks {
-    getCrossSigningKeyCache?(type: string, expectedPublicKey?: string): Promise<Uint8Array | null>;
-    storeCrossSigningKeyCache?(type: string, key?: Uint8Array): Promise<void>;
-}
-export interface ICrossSigningInfo {
-    keys: Record<string, CrossSigningKeyInfo>;
-    firstUse: boolean;
-    crossSigningVerifiedBefore: boolean;
-}
-export declare class CrossSigningInfo {
-    readonly userId: string;
-    private callbacks;
-    private cacheCallbacks;
-    keys: Record<string, CrossSigningKeyInfo>;
-    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: ServerSideSecretStorage): 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: ServerSideSecretStorage): 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: ServerSideSecretStorage): 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, CrossSigningKeyInfo>): void;
-    updateCrossSigningVerifiedBefore(isCrossSigningVerified: boolean): void;
-    signObject<T extends object>(data: T, type: string): Promise<T & {
-        signatures: ISignatures;
-    }>;
-    signUser(key: CrossSigningInfo): Promise<CrossSigningKeyInfo | 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 device.
- *
- * @deprecated Use {@link DeviceVerificationStatus}.
- */
-export declare class DeviceTrustLevel extends DeviceVerificationStatus {
-    constructor(crossSigningVerified: boolean, tofu: boolean, localVerified: boolean, trustCrossSignedDevices: boolean, signedByOwner?: boolean);
-    static fromUserTrustLevel(userTrustLevel: UserTrustLevel, localVerified: boolean, trustCrossSignedDevices: boolean): DeviceTrustLevel;
-    /**
-     * @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

package/lib/crypto/CrossSigning.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"CrossSigning.d.ts","sourceRoot":"","sources":["../../src/crypto/CrossSigning.ts"],"names":[],"mappings":"AAgBA;;GAEG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAIjD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAClD,OAAO,EAAE,WAAW,EAA0B,MAAM,iBAAiB,CAAC;AACtE,OAAO,EAAE,uBAAuB,EAA+B,MAAM,sBAAsB,CAAC;AAC5F,OAAO,EACH,mBAAmB,EACnB,wBAAwB,EACxB,sBAAsB,IAAI,cAAc,EAC3C,MAAM,wBAAwB,CAAC;AAMhC,OAAO,EAAE,cAAc,EAAE,CAAC;AAW1B,MAAM,WAAW,eAAe;IAC5B,uBAAuB,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,iBAAiB,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC,CAAC;IAC/F,yBAAyB,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC7E;AAED,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IAC1C,QAAQ,EAAE,OAAO,CAAC;IAClB,0BAA0B,EAAE,OAAO,CAAC;CACvC;AAED,qBAAa,gBAAgB;aAmBL,MAAM,EAAE,MAAM;IAC9B,OAAO,CAAC,SAAS;IACjB,OAAO,CAAC,cAAc;IApBnB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAM;IAC/C,QAAQ,UAAQ;IAMvB,OAAO,CAAC,0BAA0B,CAAS;IAE3C;;;;;;;OAOG;gBAEiB,MAAM,EAAE,MAAM,EACtB,SAAS,GAAE,gBAAqB,EAChC,cAAc,GAAE,eAAoB;WAGlC,WAAW,CAAC,GAAG,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,GAAG,gBAAgB;IAW5E,SAAS,IAAI,iBAAiB;IAQrC;;;;;;;OAOG;IACU,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;IAiDpG;;;;;;;;;OASG;IACU,uBAAuB,CAChC,aAAa,EAAE,uBAAuB,GACvC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC;IAiBzC;;;;;;;OAOG;WACiB,oBAAoB,CACpC,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,EAC7B,aAAa,EAAE,uBAAuB,GACvC,OAAO,CAAC,IAAI,CAAC;IAOhB;;;;;;;;OAQG;WACiB,oBAAoB,CACpC,IAAI,EAAE,MAAM,EACZ,aAAa,EAAE,uBAAuB,GACvC,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAQ7B;;;;;;OAMG;IACU,kBAAkB,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAYhE;;;;OAIG;IACU,4BAA4B,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAc7E;;;;;;;;OAQG;IACI,KAAK,CAAC,IAAI,SAAW,GAAG,MAAM,GAAG,IAAI;IAM5C;;;;;;OAMG;IACU,SAAS,CAAC,KAAK,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IA8EhE;;OAEG;IACI,SAAS,IAAI,IAAI;IAIjB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAAG,IAAI;IAoExD,gCAAgC,CAAC,sBAAsB,EAAE,OAAO,GAAG,IAAI;IAQjE,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG;QAAE,UAAU,EAAE,WAAW,CAAA;KAAE,CAAC;IAa7F,QAAQ,CAAC,GAAG,EAAE,gBAAgB,GAAG,OAAO,CAAC,mBAAmB,GAAG,SAAS,CAAC;IAQzE,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAmB5F;;;;;;OAMG;IACI,cAAc,CAAC,gBAAgB,EAAE,gBAAgB,GAAG,cAAc;IA+BzE;;;;;;;;;OASG;IACI,gBAAgB,CACnB,gBAAgB,EAAE,gBAAgB,EAClC,MAAM,EAAE,UAAU,EAClB,UAAU,EAAE,OAAO,EACnB,uBAAuB,EAAE,OAAO,GACjC,gBAAgB;IAuBnB;;OAEG;IACI,iBAAiB,IAAI,eAAe;CAG9C;AAmBD,oBAAY,iBAAiB;IACzB,MAAM,IAAI;IACV,YAAY,IAAI;IAChB,YAAY,IAAI;CACnB;AAED;;;;GAIG;AACH,qBAAa,gBAAiB,SAAQ,wBAAwB;gBAEtD,oBAAoB,EAAE,OAAO,EAC7B,IAAI,EAAE,OAAO,EACb,aAAa,EAAE,OAAO,EACtB,uBAAuB,EAAE,OAAO,EAChC,aAAa,UAAQ;WAKX,kBAAkB,CAC5B,cAAc,EAAE,cAAc,EAC9B,aAAa,EAAE,OAAO,EACtB,uBAAuB,EAAE,OAAO,GACjC,gBAAgB;IAUnB;;OAEG;IACI,sBAAsB,IAAI,OAAO;IAIxC;;OAEG;IACI,iBAAiB,IAAI,OAAO;IAInC;;;OAGG;IACI,MAAM,IAAI,OAAO;CAG3B;AAED,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,GAAG,eAAe,CAkCzG;AAED,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,SAAS,CAAC,EAAE,IAAI,CAAC,CAAC;AAE3G;;;;;;GAMG;AACH,wBAAsB,6BAA6B,CAC/C,QAAQ,EAAE,YAAY,EACtB,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,GACjB,OAAO,CAAC,sBAAsB,GAAG,IAAI,CAAC,CAwExC"}