Encryptor and Decryptor for data encryption.decryption using the Android KeyStore.

DeCryptor.java

/**
  _____        _____                  _             
 |  __ \      / ____|                | |            
 | |  | | ___| |     _ __ _   _ _ __ | |_ ___  _ __ 
 | |  | |/ _ \ |    | '__| | | | '_ \| __/ _ \| '__|
 | |__| |  __/ |____| |  | |_| | |_) | || (_) | |   
 |_____/ \___|\_____|_|   \__, | .__/ \__\___/|_|   
                           __/ | |                  
                          |___/|_|                  
 */
class DeCryptor {

    private static final String TRANSFORMATION = "AES/GCM/NoPadding";
    private static final String ANDROID_KEY_STORE = "AndroidKeyStore";

    private KeyStore keyStore;

    DeCryptor() throws CertificateException, NoSuchAlgorithmException, KeyStoreException,
            IOException {
        initKeyStore();
    }

    private void initKeyStore() throws KeyStoreException, CertificateException,
            NoSuchAlgorithmException, IOException {
        keyStore = KeyStore.getInstance(ANDROID_KEY_STORE);
        keyStore.load(null);
    }

    String decryptData(final String alias, final byte[] encryptedData, final byte[] encryptionIv)
            throws UnrecoverableEntryException, NoSuchAlgorithmException, KeyStoreException,
            NoSuchProviderException, NoSuchPaddingException, InvalidKeyException, IOException,
            BadPaddingException, IllegalBlockSizeException, InvalidAlgorithmParameterException {

        final Cipher cipher = Cipher.getInstance(TRANSFORMATION);
        final GCMParameterSpec spec = new GCMParameterSpec(128, encryptionIv);
        cipher.init(Cipher.DECRYPT_MODE, getSecretKey(alias), spec);

        return new String(cipher.doFinal(encryptedData), "UTF-8");
    }

    private SecretKey getSecretKey(final String alias) throws NoSuchAlgorithmException,
            UnrecoverableEntryException, KeyStoreException {
        return ((KeyStore.SecretKeyEntry) keyStore.getEntry(alias, null)).getSecretKey();
    }
}

EnCryptor.java

/**
  ______        _____                  _             
 |  ____|      / ____|                | |            
 | |__   _ __ | |     _ __ _   _ _ __ | |_ ___  _ __ 
 |  __| | '_ \| |    | '__| | | | '_ \| __/ _ \| '__|
 | |____| | | | |____| |  | |_| | |_) | || (_) | |   
 |______|_| |_|\_____|_|   \__, | .__/ \__\___/|_|   
                            __/ | |                  
                           |___/|_|                  
 */
class EnCryptor {

    private static final String TRANSFORMATION = "AES/GCM/NoPadding";
    private static final String ANDROID_KEY_STORE = "AndroidKeyStore";

    private byte[] encryption;
    private byte[] iv;

    EnCryptor() {
    }

    byte[] encryptText(final String alias, final String textToEncrypt)
            throws UnrecoverableEntryException, NoSuchAlgorithmException, KeyStoreException,
            NoSuchProviderException, NoSuchPaddingException, InvalidKeyException, IOException,
            InvalidAlgorithmParameterException, SignatureException, BadPaddingException,
            IllegalBlockSizeException {

        final Cipher cipher = Cipher.getInstance(TRANSFORMATION);
        cipher.init(Cipher.ENCRYPT_MODE, getSecretKey(alias));

        iv = cipher.getIV();

        return (encryption = cipher.doFinal(textToEncrypt.getBytes("UTF-8")));
    }

    @NonNull
    private SecretKey getSecretKey(final String alias) throws NoSuchAlgorithmException,
            NoSuchProviderException, InvalidAlgorithmParameterException {

        final KeyGenerator keyGenerator = KeyGenerator
                .getInstance(KeyProperties.KEY_ALGORITHM_AES, ANDROID_KEY_STORE);

        keyGenerator.init(new KeyGenParameterSpec.Builder(alias,
                KeyProperties.PURPOSE_ENCRYPT | KeyProperties.PURPOSE_DECRYPT)
                .setBlockModes(KeyProperties.BLOCK_MODE_GCM)
                .setEncryptionPaddings(KeyProperties.ENCRYPTION_PADDING_NONE)
                .build());

        return keyGenerator.generateKey();
    }

    byte[] getEncryption() {
        return encryption;
    }

    byte[] getIv() {
        return iv;
    }
}

SampleUsage.java

/**
   _____                       _        _    _                      
  / ____|                     | |      | |  | |                     
 | (___   __ _ _ __ ___  _ __ | | ___  | |  | |___  __ _  __ _  ___ 
  \___ \ / _` | '_ ` _ \| '_ \| |/ _ \ | |  | / __|/ _` |/ _` |/ _ \
  ____) | (_| | | | | | | |_) | |  __/ | |__| \__ \ (_| | (_| |  __/
 |_____/ \__,_|_| |_| |_| .__/|_|\___|  \____/|___/\__,_|\__, |\___|
                        | |                               __/ |     
                        |_|                              |___/      
 */
public class MainActivity extends AppCompatActivity {

    private static final String TAG = MainActivity.class.getSimpleName();
    private static final String SAMPLE_ALIAS = "MYALIAS";

    @BindView (R.id.toolbar)
    Toolbar toolbar;

    @BindView (R.id.ed_text_to_encrypt)
    EditText edTextToEncrypt;

    @BindView (R.id.tv_encrypted_text)
    TextView tvEncryptedText;

    @BindView (R.id.tv_decrypted_text)
    TextView tvDecryptedText;

    private EnCryptor encryptor;
    private DeCryptor decryptor;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        ButterKnife.bind(this);
        setSupportActionBar(toolbar);

        encryptor = new EnCryptor();

        try {
            decryptor = new DeCryptor();
        } catch (CertificateException | NoSuchAlgorithmException | KeyStoreException |
                IOException e) {
            e.printStackTrace();
        }
    }

    @OnClick ({R.id.btn_encrypt, R.id.btn_decrypt})
    public void onClick(final View view) {

        final int id = view.getId();

        switch (id) {
            case R.id.btn_encrypt:
                encryptText();
                break;
            case R.id.btn_decrypt:
                decryptText();
                break;
        }
    }

    private void decryptText() {
        try {
            tvDecryptedText.setText(decryptor
                    .decryptData(SAMPLE_ALIAS, encryptor.getEncryption(), encryptor.getIv()));
        } catch (UnrecoverableEntryException | NoSuchAlgorithmException |
                KeyStoreException | NoSuchPaddingException | NoSuchProviderException |
                IOException | InvalidKeyException e) {
            Log.e(TAG, "decryptData() called with: " + e.getMessage(), e);
        } catch (IllegalBlockSizeException | BadPaddingException | InvalidAlgorithmParameterException e) {
            e.printStackTrace();
        }
    }

    private void encryptText() {

        try {
            final byte[] encryptedText = encryptor
                    .encryptText(SAMPLE_ALIAS, edTextToEncrypt.getText().toString());
            tvEncryptedText.setText(Base64.encodeToString(encryptedText, Base64.DEFAULT));
        } catch (UnrecoverableEntryException | NoSuchAlgorithmException | NoSuchProviderException |
                KeyStoreException | IOException | NoSuchPaddingException | InvalidKeyException e) {
            Log.e(TAG, "onClick() called with: " + e.getMessage(), e);
        } catch (InvalidAlgorithmParameterException | SignatureException |
                IllegalBlockSizeException | BadPaddingException e) {
            e.printStackTrace();
        }
    }
}

I am curious, why did you choose this transformation specifically :AES/GCM/NoPadding ?

@JosiasSena You're code should be able to encrypt multiple values, right? I can't get that to work and not sure what I'm doing wrong.

    val enCryptor = EnCryptor()
    val alias = "My_AndroidKeyStore_Alias"
    val encryptText = enCryptor.encryptText(alias, "asdfasdfasdf")
    val iv = enCryptor.getIv()

    val deCryptor = DeCryptor()
    deCryptor.decryptData(alias, encryptText, iv).also { println("Decrypted1: $it") }

    // val enCryptor2 = enCryptor // also tried this, no difference
    val enCryptor2 = EnCryptor()
    val encryptText2 = enCryptor2.encryptText(alias, "asdfasdfasdf3")

    val iv2 = enCryptor2.getIv()
    deCryptor.decryptData(alias, encryptText2, iv2).also { println("Decrypted2: $it") }

    deCryptor.decryptData(alias, encryptText, iv).also { println("Decrypted1: $it") } 
    // Caused by: android.security.KeyStoreException: Signature/MAC verification failed

@JosiasSena
I get an AEADBadTagException trying to in the decrypt method, when calling:
return new String(cipher.doFinal(encryptedBytes), "UTF-8");

The android documentation of Cipher says:

if this cipher is decrypting in an AEAD mode (such as GCM/CCM), and the received authentication tag does not match the calculated value

Can you please explain this problem and its solution? What could be wrong?

Thank you!

working excellent at first run. Very useful.

@ebabel I also had to create a custom implementation to encrypt several values.
@raptus93 I got that same exception.

I guess more context on your implementation would be necessary, but I'll explain what I did in case it helps anyone.
In my case I was encrypting several Strings, save them to preferences, and then try to decrypt all of them resulting in AEADBadTagException.
My mistake: I was building a new KeyGenarator each time encryptText() was called.
The fix was to retrieve the existing entry:

   if(!keyStore.containsAlias(alias)) {
                    keyGenerator.init(new KeyGenParameterSpec.Builder(alias,
                            KeyProperties.PURPOSE_ENCRYPT | KeyProperties.PURPOSE_DECRYPT)
                            .setBlockModes(KeyProperties.BLOCK_MODE_GCM)
                            .setEncryptionPaddings(KeyProperties.ENCRYPTION_PADDING_NONE)
                            .build());
                } else {
                    return ((KeyStore.SecretKeyEntry) keyStore.getEntry(alias, null)).getSecretKey();
                }

@JosiasSena thanks for sharing

Hope it helps.

@JosiasSena
I get an AEADBadTagException trying to in the decrypt method, when calling:
return new String(cipher.doFinal(encryptedBytes), "UTF-8");

The android documentation of Cipher says:

if this cipher is decrypting in an AEAD mode (such as GCM/CCM), and the received authentication tag does not match the calculated value

Can you please explain this problem and its solution? What could be wrong?

Thank you!

Similar to me. Looking for response

@JosiasSena
I get an AEADBadTagException trying to in the decrypt method, when calling:
return new String(cipher.doFinal(encryptedBytes), "UTF-8");
The android documentation of Cipher says:

if this cipher is decrypting in an AEAD mode (such as GCM/CCM), and the received authentication tag does not match the calculated value

Can you please explain this problem and its solution? What could be wrong?
Thank you!

Similar to me. Looking for response

I have the same problem. the AEADBadTagException appears to be triggered by the following exception

Caused by: android.security.KeyStoreException: Signature/MAC verification failed
at android.security.KeyStore.getKeyStoreException(KeyStore.java:682)

Android 7

I have a requirement I will get key from server and then I need to store that inside my AndroidKeystore and use it to encrypt and Decrypt my database , so by this private static final String SAMPLE_ALIAS = "MYALIAS"; does it means it can get any key and based on this it will generate private key to encrypt and decrypt the data ?

@JosiasSena
I get an AEADBadTagException trying to in the decrypt method when calling:
return new String(cipher.doFinal(encryptedBytes), "UTF-8");

Same problem here - you can check it out at https://stackoverflow.com/questions/54077125/aeadbadtagexception-when-decrypting-using-androidkeystore

@JosiasSena
I get an AEADBadTagException trying to in the decrypt method, when calling:
return new String(cipher.doFinal(encryptedBytes), "UTF-8");
The android documentation of Cipher says:

if this cipher is decrypting in an AEAD mode (such as GCM/CCM), and the received authentication tag does not match the calculated value

Can you please explain this problem and its solution? What could be wrong?
Thank you!

Similar to me. Looking for response

I have the same problem. the AEADBadTagException appears to be triggered by the following exception

Caused by: android.security.KeyStoreException: Signature/MAC verification failed
at android.security.KeyStore.getKeyStoreException(KeyStore.java:682)

Android 7

Yes, I am also having the same problem of the AEADBadTagException caused by Signature/MAC verification failed, on Android 8.

Caused by: android.security.KeyStoreException: Signature/MAC verification failed
at android.security.KeyStore.getKeyStoreException(KeyStore.java:682)

I was able to fix this error by following the approach which @oliverspryn has mentioned in his comment. However, I have doubts about saving the iv in shared prefs. When an attacker found out the encrypted data which we saved in shared pref, don't we support him by giving the iv as well?

I also received exception on Android 8 javax.crypto.AEADBadTagException due to android.security.KeyStoreException: Signature/MAC verification failed.

@JosiasSena - Have you found fix for this exception?

The solution I found is to store the encrypted data and cypher IV in Base64 and then decode it when needed.
Like the code showed by oliverspryn, only I do it to for the encryptedString
I don't have the AEADBadTagException anymore, it works fine !

Thank you so much, i'm sorry

Why does keyGenerator.generateKey() invoked on every Encryptor::getSecretKey()?
Don't you need to check keyStore.getEntry(alias, null) != null to reuse previously generated key?

New single-file version for more recent

Since I had trouble using this code when developing for Android SDK>=28 (since it gave several errors), I implemented my own version as a standalone file using "AES/CBC/PKCS7Padding" that can be used like so:

Cryptography c = new Cryptography("CHOOSE_YOUR_KEYNAME_FOR_STORAGE");

String encrypted = c.encrypt("plain text"); // returns base 64 data: 'BASE64_DATA,BASE64_IV'

String decrypted = c.decrypt("encrypted"); // returns "plain text"

It's available in this gist

* This also takes care of proper IV usage and ensures the same key is used even if the user exits and reopens the app

So in this example, We need to store IV in somewhere, right?. That's can be more risky in secure. Can we do any other without store any data?

@ebabel I also had to create a custom implementation to encrypt several values.
@raptus93 I got that same exception.

I guess more context on your implementation would be necessary, but I'll explain what I did in case it helps anyone.
In my case I was encrypting several Strings, save them to preferences, and then try to decrypt all of them resulting in AEADBadTagException.
My mistake: I was building a new KeyGenarator each time encryptText() was called.
The fix was to retrieve the existing entry:

   if(!keyStore.containsAlias(alias)) {
                    keyGenerator.init(new KeyGenParameterSpec.Builder(alias,
                            KeyProperties.PURPOSE_ENCRYPT | KeyProperties.PURPOSE_DECRYPT)
                            .setBlockModes(KeyProperties.BLOCK_MODE_GCM)
                            .setEncryptionPaddings(KeyProperties.ENCRYPTION_PADDING_NONE)
                            .build());
                } else {
                    return ((KeyStore.SecretKeyEntry) keyStore.getEntry(alias, null)).getSecretKey();
                }

@JosiasSena thanks for sharing

Hope it helps.

cheers Bro, Had the same issue with the AEADBadTagException when decrypting a string saved in shareprefs.

@ebabel I also had to create a custom implementation to encrypt several values.
@raptus93 I got that same exception.

I guess more context on your implementation would be necessary, but I'll explain what I did in case it helps anyone.
In my case I was encrypting several Strings, save them to preferences, and then try to decrypt all of them resulting in AEADBadTagException.
My mistake: I was building a new KeyGenarator each time encryptText() was called.
The fix was to retrieve the existing entry:

   if(!keyStore.containsAlias(alias)) {
                    keyGenerator.init(new KeyGenParameterSpec.Builder(alias,
                            KeyProperties.PURPOSE_ENCRYPT | KeyProperties.PURPOSE_DECRYPT)
                            .setBlockModes(KeyProperties.BLOCK_MODE_GCM)
                            .setEncryptionPaddings(KeyProperties.ENCRYPTION_PADDING_NONE)
                            .build());
                } else {
                    return ((KeyStore.SecretKeyEntry) keyStore.getEntry(alias, null)).getSecretKey();
                }

@JosiasSena thanks for sharing

Hope it helps.

Hi, can you explain how do you decrypt all of the encrypted Strings? Because I've tried a lot of solutions but I always got the last value encrypted. Thanks in advance.

I also have the same issue on this solution when I try to encrypt and decrypt multiple keys. After decryption, I am getting only last value encrypted.

I also have the same issue with this solution when I try to encrypt and decrypt multiple keys. After decryption, I am getting only the last value encrypted.

@sharmpuneet are you able to solve this

Here's what I have done to handle API < 23:

private SecretKey getSecretKey(final String alias) throws NoSuchAlgorithmException,
            NoSuchProviderException, InvalidAlgorithmParameterException {

        KeyGenerator keyGenerator;

        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) {
            keyGenerator = KeyGenerator.getInstance(KeyProperties.KEY_ALGORITHM_AES, ANDROID_KEY_STORE);
            keyGenerator.init(new KeyGenParameterSpec.Builder(alias, 
                     KeyProperties.PURPOSE_ENCRYPT | KeyProperties.PURPOSE_DECRYPT)
                    .setBlockModes(KeyProperties.BLOCK_MODE_GCM)
                    .setEncryptionPaddings(KeyProperties.ENCRYPTION_PADDING_NONE)
                    .build());
        } else {
            keyGenerator = KeyGenerator.getInstance("AES", ANDROID_KEY_STORE);
            SecureRandom secureRandom = new SecureRandom(alias.getBytes());
            keyGenerator.init(KEY_SIZE, secureRandom);
        }
        return keyGenerator.generateKey();
    }

And how to delete key?

Hi, what is the license on this code?

@Matthcw none, feel free to do whatever you want with it

Perfect, thanks!

…

________________________________ From: Josias Sena ***@***.***> Sent: 09 April 2021 22:07 To: JosiasSena ***@***.***> Cc: Matthew Mukalere ***@***.***>; Mention ***@***.***> Subject: Re: JosiasSena/DeCryptor.java @JosiasSena commented on this gist.

________________________________ @Matthcw<https://emea01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2FMatthcw&data=04%7C01%7C%7C8744b6fcb694401ebc6a08d8fb9b78da%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637535992448198726%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=4OlUI%2BNl34lFEQaxTNnuqxrdRJpOvbZ5SdGt4gRBAV4%3D&reserved=0> none, feel free to do whatever you want with it — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub<https://emea01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgist.github.com%2F3bf4ca59777f7dedcaf41a495d96d984%23gistcomment-3700185&data=04%7C01%7C%7C8744b6fcb694401ebc6a08d8fb9b78da%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637535992448208681%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=uzT2gdMDA40QCYSfGp7rJodDFZ5nPJPtD%2BpcP97dBBk%3D&reserved=0>, or unsubscribe<https://emea01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FADHJSARIRCNH2C2XBIHKI2DTH5UAVANCNFSM4HY56TPA&data=04%7C01%7C%7C8744b6fcb694401ebc6a08d8fb9b78da%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637535992448208681%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=XM0p1OHM%2BWvsF05Hs2k72ToNC6iCjxH4MuMOcub6v2c%3D&reserved=0>.

Hello, my question is if there is a way to retrieve a stored value with just knowing the alias. The thing is that the method to retreive it is coupled with the encryption and the iv... thanks!!

it gave error javax.crypto.illegalblocksizeexception while decrypting the code could you help me out

Thanks for sharing! This code is really helpful!
Anyway, can i use this code for encrypting/decrypting android fingerprint information (data)?

If someone needs it, I have created Example app for this code: https://github.com/luskan/EncryptDecryptApp