Class DecryptionAlgorithm`Abstract`

base type for decryption implementations

Alias

module:crypto/algorithms/base.DecryptionAlgorithm

Param

parameters

Param

The UserID for the local user

Param

crypto core

Param

olm.js wrapper

Param

base matrix api interface

Param

The ID of the room we will be receiving from. Null for to-device events.

Hierarchy

DecryptionAlgorithm

Index

Constructors

Properties

baseApis crypto olmDevice roomId? userId

Methods

decryptEvent hasKeysForKeyRequest importRoomKey onRoomKeyEvent onRoomKeyWithheldEvent? retryDecryptionFromSender sendSharedHistoryInboundSessions? shareKeysWithDevice

Constructors

constructor

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

Properties

`Protected` `Readonly` baseApis

baseApis: MatrixClient

`Protected` `Readonly` crypto

crypto: Crypto

`Protected` `Readonly` olmDevice

olmDevice: OlmDevice

`Protected` `Optional` `Readonly` roomId

roomId?: string

`Protected` `Readonly` userId

userId: string

Methods

`Abstract` decryptEvent

decryptEvent(event: MatrixEvent): Promise<IEventDecryptionResult>
Decrypt an event

Method
module:crypto/algorithms/base.DecryptionAlgorithm#decryptEvent

Abstract

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

hasKeysForKeyRequest

hasKeysForKeyRequest(keyRequest: IncomingRoomKeyRequest): Promise<boolean>
Determine if we have the keys necessary to respond to a room key request

Returns
true if we have the keys and could (theoretically) share them; else false.
Parameters
- keyRequest: IncomingRoomKeyRequest
Returns Promise<boolean>
- Defined in src/crypto/algorithms/base.ts:203

importRoomKey

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

onRoomKeyEvent

onRoomKeyEvent(params: MatrixEvent): Promise<void>
Handle a key event

Method
module:crypto/algorithms/base.DecryptionAlgorithm#onRoomKeyEvent
Parameters
- params: MatrixEvent
  
  event key event
Returns Promise<void>
- Defined in src/crypto/algorithms/base.ts:182

`Optional` onRoomKeyWithheldEvent

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

retryDecryptionFromSender

retryDecryptionFromSender(senderKey: string): 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:222

`Optional` sendSharedHistoryInboundSessions

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

shareKeysWithDevice

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

Generated using TypeDoc