Package org.matrix.android.sdk.api.session.crypto.keysbackup

Types

Link copied to clipboard
class BackupRecoveryKey : IBackupRecoveryKey
Link copied to clipboard
object BackupUtils
Link copied to clipboard
interface IBackupRecoveryKey
Link copied to clipboard
interface IMegolmV1PublicKey
Link copied to clipboard
interface KeysBackupLastVersionResult
Link copied to clipboard
interface KeysBackupService
Link copied to clipboard
enum KeysBackupState : Enum<KeysBackupState>

E2e keys backup states.

Link copied to clipboard
interface KeysBackupStateListener
Link copied to clipboard
data class KeysBackupVersionTrust(val usable: Boolean, val signatures: List<KeysBackupVersionTrustSignature> = emptyList())

Data model for response to KeysBackup.getKeysBackupTrust().

Link copied to clipboard
sealed class KeysBackupVersionTrustSignature

A signature in a KeysBackupVersionTrust object.

Link copied to clipboard
@JsonClass(generateAdapter = true)
data class KeysVersion(@Json(name = "version") val version: String)
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class KeysVersionResult(    @Json(name = "algorithm") val algorithm: String,     @Json(name = "auth_data") val authData: JsonDict,     @Json(name = "version") val version: String,     @Json(name = "etag") val hash: String,     @Json(name = "count") val count: Int) : KeysAlgorithmAndData
Link copied to clipboard
@JsonClass(generateAdapter = true)
data class MegolmBackupAuthData(    @Json(name = "public_key") val publicKey: String,     @Json(name = "private_key_salt") val privateKeySalt: String? = null,     @Json(name = "private_key_iterations") val privateKeyIterations: Int? = null,     @Json(name = "signatures") val signatures: Map<String, Map<String, String>>? = null)

Data model for org.matrix.androidsdk.rest.model.keys.KeysAlgorithmAndData.authData in case of org.matrix.androidsdk.crypto.MXCRYPTO_ALGORITHM_MEGOLM_BACKUP.

Link copied to clipboard
data class MegolmBackupCreationInfo(    val algorithm: String,     val authData: MegolmBackupAuthData,     val recoveryKey: IBackupRecoveryKey)

Data retrieved from Olm library. algorithm and authData will be send to the homeserver, and recoveryKey will be displayed to the user

Link copied to clipboard
data class SavedKeyBackupKeyInfo(val recoveryKey: IBackupRecoveryKey, val version: String)

Functions

Link copied to clipboard
fun computeRecoveryKey(curve25519Key: ByteArray): String

Compute recovery key from curve25519 key.

Link copied to clipboard
fun extractCurveKeyFromRecoveryKey(recoveryKey: String?): ByteArray?

Please call .isValidRecoveryKey and ensure it returns true before calling this method.

Link copied to clipboard
fun isValidRecoveryKey(recoveryKey: String?): Boolean

Tell if the format of the recovery key is correct.

Link copied to clipboard