matrix-sdk-android/org.matrix.android.sdk.api.session.crypto.crosssigning/CrossSigningService

CrossSigningService

interface CrossSigningService

Functions

allPrivateKeysKnown

abstract fun allPrivateKeysKnown(): Boolean

Do we have all our private cross signing keys in storage?

canCrossSign

abstract fun canCrossSign(): Boolean

Can we sign our other devices or other users?

checkDeviceTrust

abstract suspend fun checkDeviceTrust( otherUserId: String, otherDeviceId: String, locallyTrusted: Boolean?): DeviceTrustResult

Check if a device is trusted

checkOtherMSKTrusted

abstract fun checkOtherMSKTrusted(myCrossSigningInfo: MXCrossSigningInfo?, otherInfo: MXCrossSigningInfo?): UserTrustResult

checkSelfTrust

abstract fun checkSelfTrust(myCrossSigningInfo: MXCrossSigningInfo?, myDevices: List<CryptoDeviceInfo>?): UserTrustResult

checkTrustAndAffectedRoomShields

abstract suspend fun checkTrustAndAffectedRoomShields(userIds: List<String>)

checkTrustFromPrivateKeys

abstract suspend fun checkTrustFromPrivateKeys( masterKeyPrivateKey: String?, uskKeyPrivateKey: String?, sskPrivateKey: String?): UserTrustResult

Inject the private cross signing keys, likely from backup, into our store.

checkUserTrust

abstract suspend fun checkUserTrust(otherUserId: String): UserTrustResult

Will not force a download of the key, but will verify signatures trust chain. Checks that my trusted user key has signed the other user UserKey

getCrossSigningPrivateKeys

abstract suspend fun getCrossSigningPrivateKeys(): PrivateKeysInfo?

Get our own private cross signing keys.

getLiveCrossSigningKeys

abstract fun getLiveCrossSigningKeys(userId: String): LiveData<Optional<MXCrossSigningInfo>>

getLiveCrossSigningPrivateKeys

abstract fun getLiveCrossSigningPrivateKeys(): LiveData<Optional<PrivateKeysInfo>>

getMyCrossSigningKeys

abstract suspend fun getMyCrossSigningKeys(): MXCrossSigningInfo?

Get our own public cross signing keys.

getUserCrossSigningKeys

abstract suspend fun getUserCrossSigningKeys(otherUserId: String): MXCrossSigningInfo?

Get the public cross signing keys for the given user.

initializeCrossSigning

abstract suspend fun initializeCrossSigning(uiaInterceptor: UserInteractiveAuthInterceptor?)

Initialize cross signing for this user. Users needs to enter credentials

isCrossSigningInitialized

open suspend fun isCrossSigningInitialized(): Boolean

Does our own user have a valid cross signing identity uploaded.

isCrossSigningVerified

abstract suspend fun isCrossSigningVerified(): Boolean

Is our published identity trusted.

isUserTrusted

abstract suspend fun isUserTrusted(otherUserId: String): Boolean

markMyMasterKeyAsTrusted

abstract suspend fun markMyMasterKeyAsTrusted()

Mark our own master key as trusted.

onSecretMSKGossip

abstract suspend fun onSecretMSKGossip(mskPrivateKey: String)

onSecretSSKGossip

abstract suspend fun onSecretSSKGossip(sskPrivateKey: String)

onSecretUSKGossip

abstract suspend fun onSecretUSKGossip(uskPrivateKey: String)

shieldForGroup

abstract suspend fun shieldForGroup(userIds: List<String>): RoomEncryptionTrustLevel

trustDevice

abstract suspend fun trustDevice(deviceId: String)

Sign one of your devices and upload the signature.

trustUser

abstract suspend fun trustUser(otherUserId: String)

Mark a user identity as trusted and sign and upload signatures of our user-signing key to the server.