Interface CryptoApi

Public interface to the cryptography parts of the js-sdk

Remarks

Currently, this is a work-in-progress. In time, more methods will be added here.

Hierarchy

Properties

globalBlacklistUnverifiedDevices

Methods

exportRoomKeys forceDiscardSession prepareToEncrypt userHasCrossSigningKeys

Properties

globalBlacklistUnverifiedDevices

globalBlacklistUnverifiedDevices: boolean

Global override for whether the client should ever send encrypted messages to unverified devices. This provides the default for rooms which do not specify a value.

If true, all unverified devices will be blacklisted by default

Methods

exportRoomKeys

  • Get a list containing all of the room keys

    This should be encrypted before returning it to the user.

    Returns

    a promise which resolves to a list of session export objects

    Returns Promise<IMegolmSessionData[]>

forceDiscardSession

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

prepareToEncrypt

  • 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

userHasCrossSigningKeys

  • 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

    true if the user has previously published cross-signing keys

    Returns Promise<boolean>

Settings

Member Visibility

Theme

Generated using TypeDoc