5️⃣ Backup

Back up your user's data so you can restore their Keyless account when necessary.

Create a backup

Create backups after authentication, and push them into your backup system. Each backup is encrypted with aes-gcm using the backupKey as symmetric key. You need both backupData and backupKey to restore an account with Keyless.

Android

val configuration = AuthenticationConfiguration.builder
   .retrievingBackup()
   .build()

Keyless.authenticate(
    authenticationConfiguration = configuration,
    onCompletion = { authResult ->
        when (authResult) {
            is Keyless.KeylessResult.Success -> {
                // use the backup
                val backup: KeylessBackup? = authResult.value.backup
            }
            is Keyless.KeylessResult.Failure -> Log.d("KeylessSDK ", "Authentication failure - error code ${result.error.code}")
        }
    }
)

iOS

let authenticationConfiguration = Keyless.AuthenticationConfiguration.builder
    .retrievingBackup()
    .build()

Keyless.authenticate(authenticationConfiguration: authenticationConfiguration) { result in
    switch result {
    case .success(let authenticationSuccess):
        // Handle your backup system logic
        print("Retrieve data for backup successful")
        print("Backup data: \(authenticationSuccess.backup?.data)")
        print("Backup key: \(authenticationSuccess.backup?.key)")
    case .failure(let error):
        // Handle error and display an error to the user.
        print("Retrieve data for backup failed with error: \(error.message)")
    }
}

Restore from a backup

Restore the user account by providing backupData and backupKey to the withBackup method:

Android

val configuration = EnrollmentConfiguration.builder
  .withBackup(
    backupKey = backupKey,
    backupData = backupData
  )
  .build()


Keyless.enroll(
  enrollmentConfiguration = configuration,
  onCompletion = { result ->
    when (result) {
      is Keyless.KeylessResult.Success -> Log.d("KeylessSDK ", "Enroll success - userId ${result.value.keylessId}")
      is Keyless.KeylessResult.Failure -> Log.d("KeylessSDK ", "Enroll failure - error code ${result.error.code}")
    }
  })

iOS

let enrollmentConfiguration = Keyless.EnrollmentConfiguration.builder
    .withBackup(Keyless.Backup(data: backupData, key: backupKey))
    .build()

Keyless.enroll(enrollmentConfiguration: enrollmentConfiguration) { result in
    switch result {
    case .success(let enrollmentSuccess):
        print("Enrollment from backup finished successfully")
    case .failure(let error):
        print("Enrollment from backup finished with error: \(error.message)")
    }
}