Class CrossSigningInfo

constructor

• new CrossSigningInfo(userId, callbacks?, cacheCallbacks?): CrossSigningInfo

• Information about a user's cross-signing keys

  Parameters

  • userId: string

    the user that the information is about
  • callbacks: CryptoCallbacks = {}

    Callbacks used to interact with the app Requires getCrossSigningKey and saveCrossSigningKeys
  • cacheCallbacks: ICacheCallbacks = {}

    Callbacks used to interact with the cache

  Returns CrossSigningInfo

firstUse

keys

ReadonlyuserId

checkDeviceTrust

• checkDeviceTrust(userCrossSigning, device, localTrust, trustCrossSignedDevices): DeviceTrustLevel

• Check whether a given device is trusted.

  Parameters

  • userCrossSigning: CrossSigningInfo

    Cross signing info for user
  • device: DeviceInfo

    The device to check
  • localTrust: boolean

    Whether the device is trusted locally
  • trustCrossSignedDevices: boolean

    Whether we trust cross signed devices

  Returns DeviceTrustLevel

checkUserTrust

• checkUserTrust(userCrossSigning): UserVerificationStatus

• Check whether a given user is trusted.

  Parameters

  • userCrossSigning: CrossSigningInfo

    Cross signing info for user

  Returns UserVerificationStatus

clearKeys

• clearKeys(): void

• unsets the keys, used when another session has reset the keys, to disable cross-signing

  Returns void

getCacheCallbacks

• getCacheCallbacks(): ICacheCallbacks

• Returns ICacheCallbacks

  Cache callbacks

getCrossSigningKey

• getCrossSigningKey(type, expectedPubkey?): Promise<[string, PkSigning]>

• Calls the app callback to ask for a private key

  Parameters

  • type: string

    The key type ("master", "self_signing", or "user_signing")
  • OptionalexpectedPubkey: string

    The matching public key or undefined to use the stored public key for the given key type.

  Returns Promise<[string, PkSigning]>

  An array with [ public key, Olm.PkSigning ]

getCrossSigningKeysFromCache

• getCrossSigningKeysFromCache(): Promise<Map<string, Uint8Array>>

• Get cross-signing private keys from the local cache.

  Returns Promise<Map<string, Uint8Array>>

  A map from key type (string) to private key (Uint8Array)

getId

• getId(type?): null | string

• Get the ID used to identify the user. This can also be used to test for the existence of a given key type.

  Parameters

  • type: string = "master"

    The type of key to get the ID of. One of "master", "self_signing", or "user_signing". Defaults to "master".

  Returns null | string

  the ID

isStoredInKeyCache

• isStoredInKeyCache(type?): Promise<boolean>

• Check whether the private keys exist in the local key cache.

  Parameters

  • Optionaltype: string

    The type of key to get. One of "master", "self_signing", or "user_signing". Optional, will check all by default.

  Returns Promise<boolean>

  True if all keys are stored in the local cache.

isStoredInSecretStorage

• isStoredInSecretStorage(secretStorage): Promise<null | Record<string, object>>

• 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...

  Parameters

  • secretStorage: ServerSideSecretStorage

    The secret store using account data

  Returns Promise<null | Record<string, object>>

  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

resetKeys

• resetKeys(level?): Promise<void>

• 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.

  Parameters

  • Optionallevel: CrossSigningLevel

    The key types to reset

  Returns Promise<void>

setKeys

• setKeys(keys): void

• Parameters

  • keys: Record<string, CrossSigningKeyInfo>

  Returns void

signDevice

• signDevice(userId, device): Promise<undefined | ISignedKey>

• Parameters

  • userId: string
  • device: DeviceInfo

  Returns Promise<undefined | ISignedKey>

signObject

• signObject<T>(data, type): Promise<T & {
      signatures: ISignatures;
  }>

• Type Parameters

  • T extends object

  Parameters

  • data: T
  • type: string

  Returns Promise<T & {
      signatures: ISignatures;
  }>

signUser

• signUser(key): Promise<undefined | CrossSigningKeyInfo>

• Parameters

  • key: CrossSigningInfo

  Returns Promise<undefined | CrossSigningKeyInfo>

toStorage

• toStorage(): ICrossSigningInfo

• Returns ICrossSigningInfo

updateCrossSigningVerifiedBefore

• updateCrossSigningVerifiedBefore(isCrossSigningVerified): void

• Parameters

  • isCrossSigningVerified: boolean

  Returns void

StaticfromStorage

• fromStorage(obj, userId): CrossSigningInfo

• Parameters

  • obj: ICrossSigningInfo
  • userId: string

  Returns CrossSigningInfo

StaticgetFromSecretStorage

• getFromSecretStorage(type, secretStorage): Promise<null | Uint8Array>

• Get private keys from secret storage created by some other device. This also passes the private keys to the app-specific callback.

  Parameters

  • type: string

    The type of key to get. One of "master", "self_signing", or "user_signing".
  • secretStorage: ServerSideSecretStorage

    The secret store using account data

  Returns Promise<null | Uint8Array>

  The private key

StaticstoreInSecretStorage

• storeInSecretStorage(keys, secretStorage): Promise<void>

• 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.

  Parameters

  • keys: Map<string, Uint8Array>

    The keys to store
  • secretStorage: ServerSideSecretStorage

    The secret store using account data

  Returns Promise<void>