Interface CryptoApi

globalBlacklistUnverifiedDevices

bootstrapCrossSigning

• bootstrapCrossSigning(opts): Promise<void>

• Bootstrap cross-signing by creating keys if needed.

  If everything is already set up, then no changes are made, so this is safe to run to ensure cross-signing is ready for use.

  This function:

  • creates new cross-signing keys if they are not found locally cached nor in secret storage (if it has been set up)
  • publishes the public keys to the server if they are not already published
  • stores the private keys in secret storage if secret storage is set up.

  Parameters

  • opts: BootstrapCrossSigningOpts

    options object

  Returns Promise<void>

exportRoomKeys

• exportRoomKeys(): Promise<IMegolmSessionData[]>

• Get a list containing all of the room keys

  This should be encrypted before returning it to the user.

  Returns Promise<IMegolmSessionData[]>

  a promise which resolves to a list of session export objects

forceDiscardSession

• forceDiscardSession(roomId): Promise<void>

• Discard any existing megolm session for the given room.

  This will ensure that a new session is created on the next call to prepareToEncrypt, or the next time a message is sent.

  This should not normally be necessary: it should only be used as a debugging tool if there has been a problem with encryption.

  Parameters

  • roomId: string

    the room to discard sessions for

  Returns Promise<void>

getCrossSigningKeyId

• getCrossSigningKeyId(type?): Promise<null | string>

• Get the ID of one of the user's cross-signing keys.

  Parameters

  • Optional type: CrossSigningKey

    The type of key to get the ID of. One of CrossSigningKey.Master, CrossSigningKey.SelfSigning, or CrossSigningKey.UserSigning. Defaults to CrossSigningKey.Master.

  Returns Promise<null | string>

  If cross-signing has been initialised on this device, the ID of the given key. Otherwise, null

getDeviceVerificationStatus

• getDeviceVerificationStatus(userId, deviceId): Promise<null | DeviceVerificationStatus>

• Get the verification status of a given device.

  Parameters

  • userId: string

    The ID of the user whose device is to be checked.

  • deviceId: string

    The ID of the device to check

  Returns Promise<null | DeviceVerificationStatus>

  null if the device is unknown, or has not published any encryption keys (implying it does not support encryption); otherwise the verification status of the device.

getTrustCrossSignedDevices

• getTrustCrossSignedDevices(): boolean

• Return whether we trust other user's signatures of their devices.

  See

  setTrustCrossSignedDevices

  Returns boolean

  true if we trust cross-signed devices, otherwise false.

getUserDeviceInfo

• getUserDeviceInfo(userIds, downloadUncached?): Promise<DeviceMap>

• Get the device information for the given list of users.

  For any users whose device lists are cached (due to sharing an encrypted room with the user), the cached device data is returned.

  If there are uncached users, and the downloadUncached parameter is set to true, a /keys/query request is made to the server to retrieve these devices.

  Parameters

  • userIds: string[]

    The users to fetch.

  • Optional downloadUncached: boolean

    If true, download the device list for users whose device list we are not currently tracking. Defaults to false, in which case such users will not appear at all in the result map.

  Returns Promise<DeviceMap>

  A map {@link DeviceMap}.

isCrossSigningReady

• isCrossSigningReady(): Promise<boolean>

• Checks whether cross signing:

  • is enabled on this account and trusted by this device
  • has private keys either cached locally or stored in secret storage

  If this function returns false, bootstrapCrossSigning() can be used to fix things such that it returns true. That is to say, after bootstrapCrossSigning() completes successfully, this function should return true.

  Returns Promise<boolean>

  True if cross-signing is ready to be used on this device

isSecretStorageReady

• isSecretStorageReady(): Promise<boolean>

• Checks whether secret storage:

  • is enabled on this account
  • is storing cross-signing private keys
  • is storing session backup key (if enabled)

  If this function returns false, bootstrapSecretStorage() can be used to fix things such that it returns true. That is to say, after bootstrapSecretStorage() completes successfully, this function should return true.

  Returns Promise<boolean>

  True if secret storage is ready to be used on this device

prepareToEncrypt

• prepareToEncrypt(room): void

• Perform any background tasks that can be done before a message is ready to send, in order to speed up sending of the message.

  Parameters

  • room: Room

    the room the event is in

  Returns void

setTrustCrossSignedDevices

• setTrustCrossSignedDevices(val): void

• Set whether to trust other user's signatures of their devices.

  If false, devices will only be considered 'verified' if we have verified that device individually (effectively disabling cross-signing).

  true by default.

  Parameters

  • val: boolean

    the new value

  Returns void

userHasCrossSigningKeys

• userHasCrossSigningKeys(): Promise<boolean>

• Checks if the user has previously published cross-signing keys

  This means downloading the devicelist for the user and checking if the list includes the cross-signing pseudo-device.

  Returns Promise<boolean>

  true if the user has previously published cross-signing keys