Class DecryptionAlgorithm`Abstract`

base type for decryption implementations

Index

Constructors

Properties

baseApis crypto olmDevice userId

Methods

decryptEvent hasKeysForKeyRequest importRoomKey onRoomKeyEvent onRoomKeyWithheldEvent? retryDecryptionFromSender sendSharedHistoryInboundSessions? shareKeysWithDevice

Constructors

constructor

new DecryptionAlgorithm(params): DecryptionAlgorithm
Parameters
- params: DecryptionClassParams<IParams>
Returns DecryptionAlgorithm
- Defined in src/crypto/algorithms/base.ts:129

Properties

`Protected` `Readonly`baseApis

baseApis: MatrixClient

`Protected` `Readonly`crypto

crypto: Crypto

`Protected` `Readonly`olmDevice

olmDevice: OlmDevice

`Protected` `Readonly`userId

userId: string

Methods

`Abstract`decryptEvent

decryptEvent(event): Promise<IEventDecryptionResult>
Decrypt an event
Parameters
- event: MatrixEvent
  undecrypted event
Returns Promise<IEventDecryptionResult>
promise which resolves once we have finished decrypting. Rejects with an algorithms.DecryptionError if there is a problem decrypting the event.
- Defined in src/crypto/algorithms/base.ts:145

hasKeysForKeyRequest

hasKeysForKeyRequest(keyRequest): Promise<boolean>
Determine if we have the keys necessary to respond to a room key request
Parameters
- keyRequest: IncomingRoomKeyRequest
Returns Promise<boolean>
true if we have the keys and could (theoretically) share them; else false.
- Defined in src/crypto/algorithms/base.ts:171

importRoomKey

importRoomKey(session, opts): Promise<void>
Import a room key
Parameters
- session: IMegolmSessionData
- opts: object
  object
Returns Promise<void>
- Defined in src/crypto/algorithms/base.ts:161

onRoomKeyEvent

onRoomKeyEvent(params): Promise<void>
Handle a key event
Parameters
- params: MatrixEvent
  event key event
Returns Promise<void>
- Defined in src/crypto/algorithms/base.ts:152

`Optional`onRoomKeyWithheldEvent

onRoomKeyWithheldEvent(event): Promise<void>
Parameters
- event: MatrixEvent
Returns Promise<void>
- Defined in src/crypto/algorithms/base.ts:194

retryDecryptionFromSender

retryDecryptionFromSender(senderKey): Promise<boolean>
Retry decrypting all the events from a sender that haven't been decrypted yet.
Parameters
- senderKey: string
  the sender's key
Returns Promise<boolean>
- Defined in src/crypto/algorithms/base.ts:189

`Optional`sendSharedHistoryInboundSessions

sendSharedHistoryInboundSessions(devicesByUser): Promise<void>
Parameters
- devicesByUser: Map<string, DeviceInfo[]>
Returns Promise<void>
- Defined in src/crypto/algorithms/base.ts:195

shareKeysWithDevice

shareKeysWithDevice(keyRequest): void
Send the response to a room key request
Parameters
- keyRequest: IncomingRoomKeyRequest
Returns void
- Defined in src/crypto/algorithms/base.ts:179