Skip to content

fix: Handle ProviderException in PKCS1→OAEP key migration to prevent saveCredentials() crash #924

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
utkrishtsahu merged 6 commits into from
Mar 11, 2026
Merged

fix: Handle ProviderException in PKCS1→OAEP key migration to prevent saveCredentials() crash #924

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
43f9358
SDK-7858 fix: Handle ProviderException in PKCS1→OAEP key migration to…
utkrishtsahu Feb 26, 2026
15eb856
fix: Wrap ProviderException as CryptoException to enable key recovery…
utkrishtsahu Mar 6, 2026
493a9ba
fix: Wrap ProviderException as CryptoException to enable key recovery…
utkrishtsahu Mar 6, 2026
719cb1c
fix: Revert sample app changes
utkrishtsahu Mar 6, 2026
307cebe
Merge branch 'main' into SDK-7858-fix-Handle-ProviderException-in-PKC…
pmathew92 Mar 10, 2026
f249712
adding UT cases as per review comments
utkrishtsahu Mar 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 52 additions & 10 deletions auth0/src/main/java/com/auth0/android/authentication/storage/CryptoUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,10 +343,9 @@ byte[] RSADecrypt(byte[] encryptedInput) throws IncompatibleDeviceException, Cry
Cipher cipher = Cipher.getInstance(RSA_TRANSFORMATION);
cipher.init(Cipher.DECRYPT_MODE, privateKey, OAEP_SPEC);
return cipher.doFinal(encryptedInput);
} catch (NoSuchAlgorithmException | NoSuchPaddingException | InvalidKeyException | InvalidAlgorithmParameterException e) {
} catch (NoSuchAlgorithmException | NoSuchPaddingException | InvalidKeyException
| InvalidAlgorithmParameterException e) {
/*
* This exceptions are safe to be ignored:
*
* - NoSuchPaddingException:
* Thrown if PKCS1Padding is not available. Was introduced in API 1.
* - NoSuchAlgorithmException:
Expand All @@ -361,6 +360,24 @@ byte[] RSADecrypt(byte[] encryptedInput) throws IncompatibleDeviceException, Cry
*/
Log.e(TAG, "The device can't decrypt input using a RSA Key.", e);
throw new IncompatibleDeviceException(e);
} catch (ProviderException e) {
/*
* - ProviderException:
* Thrown on Android 12+ (API 31+, Keystore2) when the RSA key's padding
* restriction does not match the cipher transformation. For example, an RSA
* key generated with ENCRYPTION_PADDING_RSA_PKCS1 will trigger this when
* initialised with an OAEPWithSHA-1AndMGF1Padding cipher. On API 23-30 the
* same condition surfaces as InvalidKeyException.
*
* This is NOT a device-level incompatibility -- the key can be deleted and
* regenerated with the correct padding. Wrapping as CryptoException (rather
* than IncompatibleDeviceException) ensures the caller falls through to key
* cleanup and regeneration instead of permanently blocking the user.
*/
Log.e(TAG, "RSA key padding mismatch detected (Android 12+ Keystore2).", e);
deleteAESKeys();
throw new CryptoException(
"The RSA key's padding mode is incompatible with the current cipher.", e);
} catch (IllegalArgumentException | IllegalBlockSizeException | BadPaddingException e) {
/*
* Any of this exceptions mean the encrypted input is somehow corrupted and cannot be recovered.
Expand Down Expand Up @@ -394,10 +411,9 @@ byte[] RSAEncrypt(byte[] decryptedInput) throws IncompatibleDeviceException, Cry
Cipher cipher = Cipher.getInstance(RSA_TRANSFORMATION);
cipher.init(Cipher.ENCRYPT_MODE, certificate.getPublicKey(), OAEP_SPEC);
return cipher.doFinal(decryptedInput);
} catch (NoSuchAlgorithmException | NoSuchPaddingException | InvalidKeyException | InvalidAlgorithmParameterException e) {
} catch (NoSuchAlgorithmException | NoSuchPaddingException | InvalidKeyException
| InvalidAlgorithmParameterException e) {
/*
* This exceptions are safe to be ignored:
*
* - NoSuchPaddingException:
* Thrown if PKCS1Padding is not available. Was introduced in API 1.
* - NoSuchAlgorithmException:
Expand All @@ -412,6 +428,24 @@ byte[] RSAEncrypt(byte[] decryptedInput) throws IncompatibleDeviceException, Cry
*/
Log.e(TAG, "The device can't encrypt input using a RSA Key.", e);
throw new IncompatibleDeviceException(e);
} catch (ProviderException e) {
/*
* - ProviderException:
* Thrown on Android 12+ (API 31+, Keystore2) when the RSA key's padding
* restriction does not match the cipher transformation. For example, an RSA
* key generated with ENCRYPTION_PADDING_RSA_PKCS1 will trigger this when
* initialised with an OAEPWithSHA-1AndMGF1Padding cipher. On API 23-30 the
* same condition surfaces as InvalidKeyException.
*
* This is NOT a device-level incompatibility -- the key can be deleted and
* regenerated with the correct padding. Wrapping as CryptoException (rather
* than IncompatibleDeviceException) ensures the caller falls through to key
* cleanup and regeneration instead of permanently blocking the user.
*/
Log.e(TAG, "RSA key padding mismatch detected (Android 12+ Keystore2).", e);
deleteAESKeys();
throw new CryptoException(
"The RSA key's padding mode is incompatible with the current cipher.", e);
} catch (IllegalBlockSizeException | BadPaddingException e) {
/*
* They really should not be thrown at all since padding is requested in the transformation.
Expand Down Expand Up @@ -467,10 +501,12 @@ private byte[] attemptPKCS1Migration(byte[] encryptedAESBytes) {

} catch (BadPaddingException | IllegalBlockSizeException e) {
Log.e(TAG, "PKCS1 decryption failed. Data may be corrupted.", e);
} catch (KeyStoreException | CertificateException | IOException |
} catch (KeyStoreException | CertificateException | IOException |
NoSuchAlgorithmException | UnrecoverableEntryException |
NoSuchPaddingException | InvalidKeyException e) {
Log.e(TAG, "Migration failed due to key access error.", e);
} catch (ProviderException e) {
Log.e(TAG, "PKCS1 migration failed: key padding incompatible (Android 12+ Keystore2).", e);
} catch (CryptoException e) {
Log.e(TAG, "Failed to re-encrypt AES key with OAEP.", e);
}
Expand Down Expand Up @@ -593,7 +629,9 @@ private byte[] tryMigrateLegacyAESKey() {
KeyStore.PrivateKeyEntry rsaKeyEntry = getRSAKeyEntry();

byte[] decryptedAESKey = RSADecryptLegacyPKCS1(encryptedOldAESBytes, rsaKeyEntry.getPrivateKey());


deleteRSAKeys();

// Re-encrypt with OAEP and store at new location
byte[] encryptedAESWithOAEP = RSAEncrypt(decryptedAESKey);
String newEncodedEncryptedAES = new String(Base64.encode(encryptedAESWithOAEP, Base64.DEFAULT), StandardCharsets.UTF_8);
Expand All @@ -603,7 +641,8 @@ private byte[] tryMigrateLegacyAESKey() {
Log.d(TAG, "Legacy AES key migrated successfully");
return decryptedAESKey;
} catch (CryptoException | NoSuchPaddingException | NoSuchAlgorithmException | InvalidKeyException |
BadPaddingException | IllegalBlockSizeException | IllegalArgumentException e) {
BadPaddingException | IllegalBlockSizeException | IllegalArgumentException |
ProviderException e) {
Log.e(TAG, "Could not migrate legacy AES key. Will generate new key.", e);
deleteAESKeys();
return null;
Expand Down Expand Up @@ -632,8 +671,11 @@ private byte[] generateNewAESKey() throws IncompatibleDeviceException, CryptoExc
} catch (NoSuchAlgorithmException e) {
Log.e(TAG, "AES algorithm not available.", e);
throw new IncompatibleDeviceException(e);
} catch (IncompatibleDeviceException e) {
deleteRSAKeys();
deleteAESKeys();
throw e;
} catch (CryptoException e) {
// Re-throw CryptoException and its subclasses (including IncompatibleDeviceException)
throw e;
} catch (Exception e) {
Log.e(TAG, "Unexpected error while creating new AES key.", e);
Expand Down
Loading