feat: complete Ancestor quote bot with production-ready Docker support

node_modules/matrix-js-sdk/lib/common-crypto/CryptoBackend.d.ts

@@ -1,9 +1,10 @@
-import type { IDeviceLists, IToDeviceEvent, ReceivedToDeviceMessage } from "../sync-accumulator.ts";
-import { type IClearEvent, type MatrixEvent } from "../models/event.ts";
-import { type Room } from "../models/room.ts";
-import { type CryptoApi, type DecryptionFailureCode, type ImportRoomKeysOpts } from "../crypto-api/index.ts";
-import { type KeyBackupInfo, type KeyBackupSession } from "../crypto-api/keybackup.ts";
-import { type IMegolmSessionData } from "../@types/crypto.ts";
+import type { IDeviceLists, IToDeviceEvent } from "../sync-accumulator";
+import { MatrixEvent } from "../models/event";
+import { Room } from "../models/room";
+import { CryptoApi } from "../crypto-api";
+import { CrossSigningInfo, UserTrustLevel } from "../crypto/CrossSigning";
+import { IEncryptedEventInfo } from "../crypto/api";
+import { IEventDecryptionResult } from "../@types/crypto";
 /**
  * Common interface for the crypto implementations
  *
@@ -16,14 +17,22 @@ export interface CryptoBackend extends SyncCryptoCallbacks, CryptoApi {
      * symmetry with setGlobalBlacklistUnverifiedDevices but there is currently
      * no room-level equivalent for this setting.
      *
-     * @remarks This has no effect in Rust Crypto; it exists only for the sake of
-     * the accessors in MatrixClient.
+     * @remarks this is here, rather than in `CryptoApi`, because I don't think we're
+     * going to support it in the rust crypto implementation.
      */
     globalErrorOnUnknownDevices: boolean;
     /**
      * Shut down any background processes related to crypto
      */
     stop(): void;
+    /**
+     * Get the verification level for a given user
+     *
+     * TODO: define this better
+     *
+     * @param userId - user to be checked
+     */
+    checkUserTrust(userId: string): UserTrustLevel;
     /**
      * Encrypt an event according to the configuration of the room.
      *
@@ -41,50 +50,31 @@ export interface CryptoBackend extends SyncCryptoCallbacks, CryptoApi {
      * @returns a promise which resolves once we have finished decrypting.
      * Rejects with an error if there is a problem decrypting the event.
      */
-    decryptEvent(event: MatrixEvent): Promise<EventDecryptionResult>;
+    decryptEvent(event: MatrixEvent): Promise<IEventDecryptionResult>;
     /**
-     * Get a backup decryptor capable of decrypting megolm session data encrypted with the given backup information.
-     * @param backupInfo - The backup information
-     * @param privKey - The private decryption key.
+     * Get information about the encryption of an event
+     *
+     * @param event - event to be checked
      */
-    getBackupDecryptor(backupInfo: KeyBackupInfo, privKey: Uint8Array): Promise<BackupDecryptor>;
+    getEventEncryptionInfo(event: MatrixEvent): IEncryptedEventInfo;
     /**
-     * Import a list of room keys restored from backup
+     * Get the cross signing information for a given user.
      *
-     * @param keys - a list of session export objects
-     * @param backupVersion - the version of the backup these keys came from.
-     * @param opts - options object
-     * @returns a promise which resolves once the keys have been imported
+     * The cross-signing API is currently UNSTABLE and may change without notice.
+     *
+     * @param userId - the user ID to get the cross-signing info for.
+     *
+     * @returns the cross signing information for the user.
      */
-    importBackedUpRoomKeys(keys: IMegolmSessionData[], backupVersion: string, opts?: ImportRoomKeysOpts): Promise<void>;
+    getStoredCrossSigningForUser(userId: string): CrossSigningInfo | null;
     /**
-     * Share any shareable E2EE history in the given room with the given recipient,
-     * as per [MSC4268](https://github.com/matrix-org/matrix-spec-proposals/pull/4268)
+     * Check the cross signing trust of the current user
+     *
+     * @param opts - Options object.
+     *
+     * @deprecated Unneeded for the new crypto
      */
-    shareRoomHistoryWithUser(roomId: string, userId: string): Promise<void>;
-    /**
-     * Having accepted an invite for the given room from the given user, attempt to
-     * find information about a room key bundle and, if found, download the
-     * bundle and import the room keys, as per {@link https://github.com/matrix-org/matrix-spec-proposals/pull/4268|MSC4268}.
-     *
-     * @param roomId - The room we were invited to, for which we want to check if a room
-     *   key bundle was received.
-     *
-     * @param inviter - The user who invited us to the room and is expected to have
-     *   sent the room key bundle.
-     *
-     * @returns `true` if the key bundle was successfuly downloaded and imported.
-     */
-    maybeAcceptKeyBundle(roomId: string, inviter: string): Promise<boolean>;
-    /**
-     * Mark a room as pending a key bundle under MSC4268. The backend will listen for room key bundle messages, and if
-     * it sees one matching the room specified, it will automatically import it as long as the message author's ID matches
-     * the inviter's ID.
-     *
-     * @param roomId - The room we were invited to, for which we did not receive a key bundle before accepting the invite.
-     * @param inviterId - The user who invited us to the room and is expected to send the room key bundle.
-     */
-    markRoomAsPendingKeyBundle(roomId: string, inviterId: string): Promise<void>;
+    checkOwnCrossSigningTrust(opts?: CheckOwnCrossSigningTrustOpts): Promise<void>;
 }
 /** The methods which crypto implementations should expose to the Sync api
  *
@@ -101,11 +91,9 @@ export interface SyncCryptoCallbacks {
      * messages, rather than the results of any decryption attempts.
      *
      * @param events - the received to-device messages
-     * @returns A list of preprocessed to-device messages. This will not map 1:1 to the input list, as some messages may be invalid or
-     * failed to decrypt, and so will be omitted from the output list.
-     *
+     * @returns A list of preprocessed to-device messages.
      */
-    preprocessToDeviceMessages(events: IToDeviceEvent[]): Promise<ReceivedToDeviceMessage[]>;
+    preprocessToDeviceMessages(events: IToDeviceEvent[]): Promise<IToDeviceEvent[]>;
     /**
      * Called by the /sync loop when one time key counts and unused fallback key details are received.
      *
@@ -141,14 +129,6 @@ export interface SyncCryptoCallbacks {
      * @param syncState - information about the completed sync.
      */
     onSyncCompleted(syncState: OnSyncCompletedData): void;
-    /**
-     * Mark all tracked users' device lists as dirty.
-     *
-     * This method will cause additional `/keys/query` requests on the server, so should be used only
-     * when the client has desynced tracking device list deltas from the server.
-     * In MSC4186: Simplified Sliding Sync, this can happen when the server expires the connection.
-     */
-    markAllTrackedUsersAsDirty(): Promise<void>;
 }
 /**
  * @internal
@@ -164,76 +144,9 @@ export interface OnSyncCompletedData {
     catchingUp?: boolean;
 }
 /**
- * The result of a (successful) call to {@link CryptoBackend.decryptEvent}
+ * Options object for {@link CryptoBackend#checkOwnCrossSigningTrust}.
  */
-export interface EventDecryptionResult {
-    /**
-     * The plaintext payload for the event (typically containing <tt>type</tt> and <tt>content</tt> fields).
-     */
-    clearEvent: IClearEvent;
-    /**
-     * No longer used.
-     * See {@link MatrixEvent#getForwardingCurve25519KeyChain}.
-     * @deprecated
-     */
-    forwardingCurve25519KeyChain?: string[];
-    /**
-     * Key owned by the sender of this event.  See {@link MatrixEvent#getSenderKey}.
-     */
-    senderCurve25519Key?: string;
-    /**
-     * ed25519 key claimed by the sender of this event. See {@link MatrixEvent#getClaimedEd25519Key}.
-     */
-    claimedEd25519Key?: string;
-    /**
-     * If another user forwarded the key to this message
-     * (eg via [MSC4268](https://github.com/matrix-org/matrix-spec-proposals/pull/4268)),
-     * the ID of that user.
-     */
-    keyForwardedBy?: string;
-}
-/**
- * Responsible for decrypting megolm session data retrieved from a remote backup.
- * The result of {@link CryptoBackend#getBackupDecryptor}.
- */
-export interface BackupDecryptor {
-    /**
-     * Whether keys retrieved from this backup can be trusted.
-     *
-     * Depending on the backup algorithm, keys retrieved from the backup can be trusted or not.
-     * If false, keys retrieved from the backup  must be considered unsafe (authenticity cannot be guaranteed).
-     * It could be by design (deniability) or for some technical reason (eg asymmetric encryption).
-     */
-    readonly sourceTrusted: boolean;
-    /**
-     *
-     * Decrypt megolm session data retrieved from backup.
-     *
-     * @param ciphertexts - a Record of sessionId to session data.
-     *
-     * @returns An array of decrypted `IMegolmSessionData`
-     */
-    decryptSessions(ciphertexts: Record<string, KeyBackupSession>): Promise<IMegolmSessionData[]>;
-    /**
-     * Free any resources held by this decryptor.
-     *
-     * Should be called once the decryptor is no longer needed.
-     */
-    free(): void;
-}
-/**
- * Exception thrown when decryption fails
- *
- * @param code - Reason code for the failure.
- *
- * @param msg - user-visible message describing the problem
- *
- * @param details - key/value pairs reported in the logs but not shown
- *   to the user.
- */
-export declare class DecryptionError extends Error {
-    readonly code: DecryptionFailureCode;
-    readonly detailedString: string;
-    constructor(code: DecryptionFailureCode, msg: string, details?: Record<string, string | Error>);
+export interface CheckOwnCrossSigningTrustOpts {
+    allowPrivateKeyRequests?: boolean;
 }
 //# sourceMappingURL=CryptoBackend.d.ts.map