How to resolve KeyStoreConnectException on Android 10?

Question

My app is working pretty well on all the Android OS except Android 10. I am using the Motorola One Power device which got updated with Android 10. We are using Android Keystore to encrypt databases.

App is getting crash on luanch with below error.

android.security.keystore.KeyStoreConnectException: Failed to communicate with keystore service at android.security.keystore.AndroidKeyStoreCipherSpiBase.ensureKeystoreOperationInitialized(AndroidKeyStoreCipherSpiBase.java:256) at android.security.keystore.AndroidKeyStoreCipherSpiBase.engineInit(AndroidKeyStoreCipherSpiBase.java:148) at javax.crypto.Cipher.tryTransformWithProvider(Cipher.java:2980)

Its a KeyStoreConnectException issue. The app is taking time to connect to KeyStoreConnectException.

Note: If I run the app in debugged mode then it's working fine.

Please help me to find solution. Thanks in advance.

I have the same issue and I realized that it only happens when using the cipher on a background thread. If I do it on the main thread it works just fine. Did you found any solution to this? — Logain, Mar 29 '20 at 01:53
I use it on the main thread and still get this error in Crashlytics — Mladen Rakonjac, Apr 27 '20 at 07:33

georgiptr · Answer 1 · 2021-06-19T06:25:01.003

As MatPag pointed out, this is a known bug in Android 10 that's not present in earlier or later versions. As I call Cipher::init() in several places, here is a convenient wrapper function in Kotlin:

private fun keyStoreWorkaroundForAndroid10(f: () -> Unit) {
    for (i in 0..3) {
        try {
            f()
            return
        } catch (e: ProviderException) {
            Timber.d("Applying Android 10 KeyStoreConnectException bug workaround. Counter: ${i}, Exception: ${e.message}")
            Thread.sleep(100)
            continue
        }
    }
}

And then you call it like this (remember - in a background thread):

keyStoreWorkaroundForAndroid10 {
    cipherEncrypt.init(Cipher.ENCRYPT_MODE, publicKey)
}

score 0 · Answer 2 · answered Aug 07 '20 at 09:30

0

This is a known bug tracked here https://issuetracker.google.com/issues/147384380

Google fixed it and probably will be available in Android 11.

We currently don't know if it will be fixed with security patches on Android 10 at some point

answered Aug 07 '20 at 09:30

MatPag

41,742
14
105
114

still have this bug in android 12 and android 13 – Wackaloon Jan 13 '23 at 09:23

score -1 · Answer 3 · answered Mar 31 '20 at 03:02

-1

I think your code run takes long time, you can move to the thread, try it!

answered Mar 31 '20 at 03:02

kevin.xu

29
2

How to resolve KeyStoreConnectException on Android 10?

3 Answers3