matrix-js-sdk
    Preparing search index...

    Interface SecretStorageStatus

    The result of a call to CryptoApi.getSecretStorageStatus.

    interface SecretStorageStatus {
        defaultKeyId: null | string;
        ready: boolean;
        secretStorageKeyValidityMap: {
            "m.cross_signing.master"?: boolean;
            "m.cross_signing.self_signing"?: boolean;
            "m.cross_signing.user_signing"?: boolean;
            "m.megolm_backup.v1"?: boolean;
            mysecret?: boolean;
            "org.matrix.msc3814"?: boolean;
            secretA?: boolean;
            secretB?: boolean;
            secretC?: boolean;
            secretD?: boolean;
            secretE?: boolean;
            Unknown?: boolean;
        };
    }
    Index

    Properties

    defaultKeyId ready secretStorageKeyValidityMap

    Properties

    defaultKeyId: null | string

    The ID of the current default secret storage key.

    ready: boolean

    Whether secret storage is fully populated. The same as CryptoApi.isSecretStorageReady.

    secretStorageKeyValidityMap: {
        "m.cross_signing.master"?: boolean;
        "m.cross_signing.self_signing"?: boolean;
        "m.cross_signing.user_signing"?: boolean;
        "m.megolm_backup.v1"?: boolean;
        mysecret?: boolean;
        "org.matrix.msc3814"?: boolean;
        secretA?: boolean;
        secretB?: boolean;
        secretC?: boolean;
        secretD?: boolean;
        secretE?: boolean;
        Unknown?: boolean;
    }

    For each secret that we checked whether it is correctly stored in secret storage with the default secret storage key.

    Note that we will only check that the key backup key is stored if key backup is currently enabled (i.e. that CryptoApi.getActiveSessionBackupVersion returns non-null). m.megolm_backup.v1 will only be present in that case.

    (This is an object rather than a Map so that it JSON.stringify()s nicely, since its main purpose is to end up in logs.)

    Settings

    Member Visibility

    On This Page

    Properties