matrix-sdk-android/org.matrix.android.sdk.api.session.crypto/CryptoService

CryptoService

interface CryptoService

Functions

addNewSessionListener

abstract fun addNewSessionListener(newSessionListener: NewSessionListener)

addRoomKeysRequestListener

abstract fun addRoomKeysRequestListener(listener: GossipingRequestListener)

abstract fun close()

crossSigningService

abstract fun crossSigningService(): CrossSigningService

abstract suspend fun decryptEvent(event: Event, timeline: String): MXEventDecryptionResult

abstract suspend fun deleteDevice(deviceId: String, userInteractiveAuthInterceptor: UserInteractiveAuthInterceptor)

abstract suspend fun deleteDevices(@Size(min = 1) deviceIds: List<String>, userInteractiveAuthInterceptor: UserInteractiveAuthInterceptor)

deviceWithIdentityKey

abstract suspend fun deviceWithIdentityKey(userId: String, senderKey: String, algorithm: String): CryptoDeviceInfo?

discardOutboundSession

abstract fun discardOutboundSession(roomId: String)

downloadKeysIfNeeded

abstract suspend fun downloadKeysIfNeeded(userIds: List<String>, forceDownload: Boolean = false): MXUsersDevicesMap<CryptoDeviceInfo>

enableKeyGossiping

abstract fun enableKeyGossiping(enable: Boolean)

Enable or disable key gossiping. Default is true. If set to false this device won't send key_request nor will accept key forwarded

enableShareKeyOnInvite

abstract fun enableShareKeyOnInvite(enable: Boolean)

As per MSC3061. If true will make it possible to share part of e2ee room history on invite depending on the room visibility setting.

encryptEventContent

abstract suspend fun encryptEventContent(eventContent: Content, eventType: String, roomId: String): MXEncryptEventContentResult

abstract suspend fun exportRoomKeys(password: String): ByteArray

fetchDeviceInfo

abstract suspend fun fetchDeviceInfo(deviceId: String): DeviceInfo

fetchDevicesList

abstract suspend fun fetchDevicesList(): List<DeviceInfo>

getCryptoDeviceInfo

abstract suspend fun getCryptoDeviceInfo(userId: String): List<CryptoDeviceInfo>

abstract suspend fun getCryptoDeviceInfo(userId: String, deviceId: String?): CryptoDeviceInfo?

getCryptoDeviceInfoList

abstract suspend fun getCryptoDeviceInfoList(userId: String): List<CryptoDeviceInfo>

getEncryptionAlgorithm

abstract fun getEncryptionAlgorithm(roomId: String): String?

getGlobalBlacklistUnverifiedDevices

abstract fun getGlobalBlacklistUnverifiedDevices(): Boolean

getGossipingEvents

abstract fun getGossipingEvents(): List<AuditTrail>

getGossipingEventsTrail

abstract fun getGossipingEventsTrail(): LiveData<PagedList<AuditTrail>>

getIncomingRoomKeyRequests

abstract fun getIncomingRoomKeyRequests(): List<IncomingRoomKeyRequest>

getIncomingRoomKeyRequestsPaged

abstract fun getIncomingRoomKeyRequestsPaged(): LiveData<PagedList<IncomingRoomKeyRequest>>

getLiveBlockUnverifiedDevices

abstract fun getLiveBlockUnverifiedDevices(roomId: String): LiveData<Boolean>

getLiveCryptoDeviceInfo

abstract fun getLiveCryptoDeviceInfo(): LiveData<List<CryptoDeviceInfo>>

abstract fun getLiveCryptoDeviceInfo(userId: String): LiveData<List<CryptoDeviceInfo>>

abstract fun getLiveCryptoDeviceInfo(userIds: List<String>): LiveData<List<CryptoDeviceInfo>>

getLiveCryptoDeviceInfoWithId

abstract fun getLiveCryptoDeviceInfoWithId(deviceId: String): LiveData<Optional<CryptoDeviceInfo>>

getLiveGlobalCryptoConfig

abstract fun getLiveGlobalCryptoConfig(): LiveData<GlobalCryptoConfig>

getMyCryptoDevice

abstract suspend fun getMyCryptoDevice(): CryptoDeviceInfo

getMyDevicesInfo

abstract fun getMyDevicesInfo(): List<DeviceInfo>

getMyDevicesInfoLive

abstract fun getMyDevicesInfoLive(): LiveData<List<DeviceInfo>>

abstract fun getMyDevicesInfoLive(deviceId: String): LiveData<Optional<DeviceInfo>>

getOutgoingRoomKeyRequests

abstract fun getOutgoingRoomKeyRequests(): List<OutgoingKeyRequest>

getOutgoingRoomKeyRequestsPaged

abstract fun getOutgoingRoomKeyRequestsPaged(): LiveData<PagedList<OutgoingKeyRequest>>

getSharedWithInfo

abstract fun getSharedWithInfo(roomId: String?, sessionId: String): MXUsersDevicesMap<Int>

abstract suspend fun getUserDevices(userId: String): List<CryptoDeviceInfo>

getWithHeldMegolmSession

abstract fun getWithHeldMegolmSession(roomId: String, sessionId: String): RoomKeyWithHeldContent?

abstract suspend fun importRoomKeys(roomKeysAsArray: ByteArray, password: String, progressListener: ProgressListener?): ImportRoomKeysResult

inboundGroupSessionsCount

abstract suspend fun inboundGroupSessionsCount(onlyBackedUp: Boolean): Int

isCryptoEnabled

abstract fun isCryptoEnabled(): Boolean

isKeyGossipingEnabled

abstract fun isKeyGossipingEnabled(): Boolean

isRoomBlacklistUnverifiedDevices

abstract fun isRoomBlacklistUnverifiedDevices(roomId: String?): Boolean

isRoomEncrypted

abstract fun isRoomEncrypted(roomId: String): Boolean

isShareKeysOnInviteEnabled

abstract fun isShareKeysOnInviteEnabled(): Boolean

As per MSC3061. If true will make it possible to share part of e2ee room history on invite depending on the room visibility setting.

abstract fun isStarted(): Boolean

keysBackupService

abstract fun keysBackupService(): KeysBackupService

abstract fun logDbUsageInfo()

manuallyAcceptRoomKeyRequest

abstract suspend fun manuallyAcceptRoomKeyRequest(request: IncomingRoomKeyRequest)

Can be called by the app layer to accept a request manually. Use carefully as it is prone to social attacks.

abstract fun name(): String

onE2ERoomMemberLoadedFromServer

abstract fun onE2ERoomMemberLoadedFromServer(roomId: String)

When LL all room members might not be loaded when setting up encryption. This is called after room members have been loaded ... not sure if shoud be API

abstract suspend fun onLiveEvent(roomId: String, event: Event, isInitialSync: Boolean, cryptoStoreAggregator: CryptoStoreAggregator?)

open suspend fun onStateEvent(roomId: String, event: Event, cryptoStoreAggregator: CryptoStoreAggregator?)

onSyncCompleted

abstract suspend fun onSyncCompleted(syncResponse: SyncResponse, cryptoStoreAggregator: CryptoStoreAggregator)

onSyncWillProcess

abstract suspend fun onSyncWillProcess(isInitialSync: Boolean)

prepareToEncrypt

abstract suspend fun prepareToEncrypt(roomId: String)

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

receiveSyncChanges

abstract suspend fun receiveSyncChanges(toDevice: ToDeviceSyncResponse?, deviceChanges: DeviceListResponse?, keyCounts: DeviceOneTimeKeysCountSyncResponse?, deviceUnusedFallbackKeyTypes: List<String>?, nextBatch: String?)

removeRoomKeysRequestListener

abstract fun removeRoomKeysRequestListener(listener: GossipingRequestListener)

removeSessionListener

abstract fun removeSessionListener(listener: NewSessionListener)

reRequestRoomKeyForEvent

abstract suspend fun reRequestRoomKeyForEvent(event: Event)

sendSharedHistoryKeys

abstract suspend fun sendSharedHistoryKeys(roomId: String, userId: String, sessionInfoSet: Set<SessionInfo>?)

Share all inbound sessions of the last chunk messages to the provided userId devices.

abstract suspend fun setDeviceName(deviceId: String, deviceName: String)

setDeviceVerification

abstract suspend fun setDeviceVerification(trustLevel: DeviceTrustLevel, userId: String, deviceId: String)

setGlobalBlacklistUnverifiedDevices

abstract fun setGlobalBlacklistUnverifiedDevices(block: Boolean)

setRoomBlockUnverifiedDevices

abstract fun setRoomBlockUnverifiedDevices(roomId: String, block: Boolean)

setRoomUnBlockUnverifiedDevices

abstract fun setRoomUnBlockUnverifiedDevices(roomId: String)

setWarnOnUnknownDevices

abstract fun setWarnOnUnknownDevices(warn: Boolean)

shouldEncryptForInvitedMembers

abstract fun shouldEncryptForInvitedMembers(roomId: String): Boolean

abstract fun start()

supportKeyRequestInspection

abstract fun supportKeyRequestInspection(): Boolean

supportsDisablingKeyGossiping

abstract fun supportsDisablingKeyGossiping(): Boolean

supportsForwardedKeyWiththeld

abstract fun supportsForwardedKeyWiththeld(): Boolean

supportsKeyWithheld

abstract fun supportsKeyWithheld(): Boolean

supportsShareKeysOnInvite

abstract fun supportsShareKeysOnInvite(): Boolean

verificationService

abstract fun verificationService(): VerificationService