Class OlmAdapter

This class implements an End-to-End Encrypted communication channel between every two peers in the conference. This channel uses libolm to achieve E2EE.

The created channel is then used to exchange the secret key that each participant will use to encrypt the actual media (see E2EEContext).

A simple JSON message based protocol is implemented, which follows a request - response model:

session-init: Initiates an olm session establishment procedure. This message will be sent by the participant who just joined, to everyone else.
session-ack: Completes the olm session etablishment. This messsage may contain ancilliary encrypted data, more specifically the sender's current key.
key-info: Includes the sender's most up to date key information.
key-info-ack: Acknowledges the reception of a key-info request. In addition, it may contain the sender's key information, if available.
error: Indicates a request processing error has occurred.

These requessts and responses are transport independent. Currently they are sent using XMPP MUC private messages.

Hierarchy (View Summary)

Listenable
- OlmAdapter

Constructors

constructor

new OlmAdapter(conference: any): OlmAdapter
Creates an adapter instance for the given conference.
Parameters
- conference: any
Returns OlmAdapter
Overrides Listenable.constructor
- Defined in modules/e2ee/OlmAdapter.js:71

Properties

_conf

_conf: any

_idKeys

_idKeys: any

_init

_init: Deferred<any>

_mediaKey

_mediaKey: boolean | Uint8Array<ArrayBufferLike>

_mediaKeyIndex

_mediaKeyIndex: number

_olmAccount

_olmAccount: any

_reqs

_reqs: Map<any, any>

_sessionInitialization

_sessionInitialization: Deferred<any>

`Static`events

events: {
    PARTICIPANT_E2EE_CHANNEL_READY: string;
    PARTICIPANT_KEY_UPDATED: string;
    PARTICIPANT_SAS_AVAILABLE: string;
    PARTICIPANT_SAS_READY: string;
    PARTICIPANT_VERIFICATION_COMPLETED: string;
}

Accessors

myId

get myId(): string
Returns the current participants conference ID.

Returns string
- Defined in modules/e2ee/OlmAdapter.js:99

Methods

_computeCommitment

_computeCommitment(pubKey: any, data: any): any
Computes the commitment.
Parameters
- pubKey: any
- data: any
Returns any
- Defined in modules/e2ee/OlmAdapter.js:1086

_sendError

_sendError(participant: JitsiParticipant, error: string): void
Builds and sends an error message to the target participant.
Parameters
- participant: JitsiParticipant
  The target participant.
- error: string
  The error message.
Returns void
- Defined in modules/e2ee/OlmAdapter.js:948

_sendMessage

_sendMessage(data: any, participantId: string): void
Internal helper to send the given object to the given participant ID. This function merely exists so the transport can be easily swapped. Currently messages are transmitted via XMPP MUC private messages.
Parameters
- data: any
  The data that will be sent to the target participant.
- participantId: string
  ID of the target participant.
Returns void
- Defined in modules/e2ee/OlmAdapter.js:971

_sendSasMac

_sendSasMac(participant: any): void
Builds and sends the SAS MAC message to the given participant. The second phase of the verification process, the Key verification phase https://spec.matrix.org/latest/client-server-api/#short-authentication-string-sas-verification
Parameters
- participant: any
Returns void
- Defined in modules/e2ee/OlmAdapter.js:1046

addCancellableListener

addCancellableListener(eventName: string, listener: EventListener): () => void
Adds new cancellable listener.
Parameters
- eventName: string
  the name of the event
- listener: EventListener
  the listener.
Returns () => void
- The unsubscribe function.
Inherited from Listenable.addCancellableListener
- Defined in modules/util/Listenable.ts:73

addEventListener

addEventListener(eventId: string, handler: EventListener): void
Alias for on method.
Parameters
- eventId: string
  The event ID.
- handler: EventListener
  Handler for the event.
Returns void
Inherited from Listenable.addEventListener
- Defined in modules/util/Listenable.ts:54

addListener

addListener(eventName: string, listener: EventListener): EventEmitter
Adds new listener.
Parameters
- eventName: string
  the name of the event
- listener: EventListener
  the listener.
Returns EventEmitter
- The emitter, so that calls can be chained.
Inherited from Listenable.addListener
- Defined in modules/util/Listenable.ts:85

clearAllParticipantsSessions

clearAllParticipantsSessions(): void
Frees the olmData sessions for all participants.

Returns void
- Defined in modules/e2ee/OlmAdapter.js:226

clearParticipantSession

clearParticipantSession(participant: any): void
Frees the olmData session for the given participant.
Parameters
- participant: any
Returns void
- Defined in modules/e2ee/OlmAdapter.js:213

emit

emit(event: string, ...args: any[]): void
Emits an event.
Parameters
- event: string
  event name
- ...args: any[]
Returns void
Inherited from Listenable.emit
- Defined in modules/util/Listenable.ts:104

initSessions

initSessions(): Promise<void>
Starts new olm sessions with every other participant that has the participantId "smaller" the localParticipantId.

Returns Promise<void>
- Defined in modules/e2ee/OlmAdapter.js:106

listenerCount

listenerCount(eventName?: string): number
Returns the number of listeners for the specified event.
Parameters
- OptionaleventName: string
  The name of the event.
Returns number
- The number of listeners for the event.
Inherited from Listenable.listenerCount
- Defined in modules/util/Listenable.ts:120

markParticipantVerified

markParticipantVerified(participant: any, isVerified: any): void
Sends sacMac if channel verification waas successful.
Parameters
- participant: any
- isVerified: any
Returns void
- Defined in modules/e2ee/OlmAdapter.js:236

off

off(eventId: string, handler?: EventListener): void
Removes event listener.
Parameters
- eventId: string
  The event ID.
- Optionalhandler: EventListener
  Optional, the specific handler to unbind.
Returns void
Inherited from Listenable.off
- Defined in modules/util/Listenable.ts:36

on

on(eventId: string, handler: EventListener): void
Attaches a handler for events (e.g., "participant joined") in the conference. All possible events are defined in JitsiConferenceEvents.
Parameters
- eventId: string
  The event ID.
- handler: EventListener
  Handler for the event.
Returns void
Inherited from Listenable.on
- Defined in modules/util/Listenable.ts:27

once

once(eventId: string, handler: EventListener): void
Adds a one-time listener function for the event.
Parameters
- eventId: string
  The event ID.
- handler: EventListener
  Handler for the event.
Returns void
Inherited from Listenable.once
- Defined in modules/util/Listenable.ts:45

removeAllListeners

removeAllListeners(): void
Removes all listeners for the event emitter.

Returns void
Inherited from Listenable.removeAllListeners
- Defined in modules/util/Listenable.ts:111

removeEventListener

removeEventListener(eventId: string, handler?: EventListener): void
Alias for off method.
Parameters
- eventId: string
  The event ID.
- Optionalhandler: EventListener
  Optional, the specific handler to unbind.
Returns void
Inherited from Listenable.removeEventListener
- Defined in modules/util/Listenable.ts:63

removeListener

removeListener(eventName: string, listener: EventListener): EventEmitter
Removes listener.
Parameters
- eventName: string
  the name of the event that triggers the listener
- listener: EventListener
  the listener.
Returns EventEmitter
- The emitter, so that calls can be chained.
Inherited from Listenable.removeListener
- Defined in modules/util/Listenable.ts:96

updateCurrentMediaKey

updateCurrentMediaKey(key: boolean | Uint8Array<ArrayBufferLike>): number
Updates the current participant key.
Parameters
- key: boolean | Uint8Array<ArrayBufferLike>
  The new key.
Returns number
- Defined in modules/e2ee/OlmAdapter.js:203

updateKey

updateKey(key: boolean | Uint8Array<ArrayBufferLike>): Promise<number>
Updates the current participant key and distributes it to all participants in the conference by sending a key-info message.
Parameters
- key: boolean | Uint8Array<ArrayBufferLike>
  The new key.
Returns Promise<number>
Retrns
- Defined in modules/e2ee/OlmAdapter.js:148

`Static`isSupported

isSupported(): boolean
Indicates if olm is supported on the current platform.

Returns boolean
- Defined in modules/e2ee/OlmAdapter.js:137

Class OlmAdapter

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns OlmAdapter

Properties

_conf

_idKeys

_init

_mediaKey

_mediaKeyIndex

_olmAccount

_reqs

_sessionInitialization

Staticevents

Accessors

myId

Returns string

Methods

_computeCommitment

Parameters

Returns any

_sendError

Parameters

Returns void

_sendMessage

Parameters

Returns void

_sendSasMac

Parameters

Returns void

addCancellableListener

Parameters

Returns () => void

addEventListener

Parameters

Returns void

addListener

Parameters

Returns EventEmitter

clearAllParticipantsSessions

Returns void

clearParticipantSession

Parameters

Returns void

emit

Parameters

Returns void

initSessions

Returns Promise<void>

listenerCount

Parameters

Returns number

markParticipantVerified

Parameters

Returns void

off

Parameters

Returns void

on

Parameters

Returns void

once

Parameters

Returns void

removeAllListeners

Returns void

removeEventListener

Parameters

Returns void

removeListener

Parameters

Returns EventEmitter

updateCurrentMediaKey

`Static`events

`Static`isSupported