├── settings.gradle ├── app ├── src │ ├── main │ │ ├── res │ │ │ ├── values │ │ │ │ ├── strings.xml │ │ │ │ ├── colors.xml │ │ │ │ └── styles.xml │ │ │ ├── mipmap-hdpi │ │ │ │ ├── ic_launcher.png │ │ │ │ └── ic_launcher_round.png │ │ │ ├── mipmap-mdpi │ │ │ │ ├── ic_launcher.png │ │ │ │ └── ic_launcher_round.png │ │ │ ├── mipmap-xhdpi │ │ │ │ ├── ic_launcher.png │ │ │ │ └── ic_launcher_round.png │ │ │ ├── mipmap-xxhdpi │ │ │ │ ├── ic_launcher.png │ │ │ │ └── ic_launcher_round.png │ │ │ ├── mipmap-xxxhdpi │ │ │ │ ├── ic_launcher.png │ │ │ │ └── ic_launcher_round.png │ │ │ └── layout │ │ │ │ └── activity_main.xml │ │ ├── AndroidManifest.xml │ │ └── java │ │ │ └── com │ │ │ └── example │ │ │ └── keystore │ │ │ ├── MainActivity.java │ │ │ ├── EncryptionUtils.java │ │ │ ├── SecurityKey.java │ │ │ └── EncryptionKeyGenerator.java │ ├── test │ │ └── java │ │ │ └── com │ │ │ └── mm │ │ │ └── keystoresample │ │ │ └── ExampleUnitTest.java │ └── androidTest │ │ └── java │ │ └── com │ │ └── mm │ │ └── keystoresample │ │ └── ExampleInstrumentedTest.java ├── build.gradle └── proguard-rules.pro ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── .gitignore ├── README.md └── LICENSE /settings.gradle: -------------------------------------------------------------------------------- 1 | include ':app' 2 | -------------------------------------------------------------------------------- /app/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | KeyStore Example 3 | 4 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/phanirajabhandari/android-keystore-example/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/phanirajabhandari/android-keystore-example/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/phanirajabhandari/android-keystore-example/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/phanirajabhandari/android-keystore-example/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/phanirajabhandari/android-keystore-example/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/phanirajabhandari/android-keystore-example/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/phanirajabhandari/android-keystore-example/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/phanirajabhandari/android-keystore-example/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/phanirajabhandari/android-keystore-example/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/phanirajabhandari/android-keystore-example/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/phanirajabhandari/android-keystore-example/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/values/colors.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | #3F51B5 4 | #303F9F 5 | #FF4081 6 | 7 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Tue Mar 14 14:01:47 IST 2017 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | distributionUrl=https\://services.gradle.org/distributions/gradle-3.3-all.zip 7 | -------------------------------------------------------------------------------- /app/src/main/res/values/styles.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /app/src/test/java/com/mm/keystoresample/ExampleUnitTest.java: -------------------------------------------------------------------------------- 1 | package com.mm.keystoresample; 2 | 3 | import org.junit.Test; 4 | 5 | import static org.junit.Assert.*; 6 | 7 | /** 8 | * Example local unit test, which will execute on the development machine (host). 9 | * 10 | * @see Testing documentation 11 | */ 12 | public class ExampleUnitTest { 13 | @Test public void addition_isCorrect() throws Exception { 14 | assertEquals(4, 2 + 2); 15 | } 16 | } -------------------------------------------------------------------------------- /app/src/main/res/layout/activity_main.xml: -------------------------------------------------------------------------------- 1 | 2 | 9 | 10 | 15 | 16 | 17 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Built application files 2 | *.apk 3 | *.ap_ 4 | 5 | # Files for the ART/Dalvik VM 6 | *.dex 7 | 8 | # Java class files 9 | *.class 10 | 11 | # Generated files 12 | bin/ 13 | gen/ 14 | out/ 15 | 16 | # Gradle files 17 | .gradle/ 18 | gradlew.bat 19 | gradlew 20 | build/ 21 | gradle.properties 22 | 23 | # Local configuration file (sdk path, etc) 24 | local.properties 25 | 26 | # Proguard folder generated by Eclipse 27 | proguard/ 28 | 29 | # Log Files 30 | *.log 31 | 32 | # Android Studio Navigation editor temp files 33 | .navigation/ 34 | 35 | # Android Studio captures folder 36 | captures/ 37 | 38 | # Intellij 39 | *.iml 40 | *.iws 41 | .idea 42 | .idea/tasks.xml 43 | .idea/workspace.xml 44 | 45 | # OS 46 | .DS_Store 47 | 48 | # Keystore files 49 | *.jks -------------------------------------------------------------------------------- /app/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | -------------------------------------------------------------------------------- /app/src/main/java/com/example/keystore/MainActivity.java: -------------------------------------------------------------------------------- 1 | package com.example.keystore; 2 | 3 | import android.os.Bundle; 4 | import android.support.v7.app.AppCompatActivity; 5 | import timber.log.Timber; 6 | 7 | public class MainActivity extends AppCompatActivity { 8 | 9 | @Override protected void onCreate(Bundle savedInstanceState) { 10 | super.onCreate(savedInstanceState); 11 | setContentView(R.layout.activity_main); 12 | Timber.plant(new Timber.DebugTree()); 13 | 14 | String value = "Password/Token to be encrypted"; 15 | 16 | String encryptedValue = EncryptionUtils.encrypt(this, value); 17 | Timber.d(" Encrypted Value :" + encryptedValue); 18 | 19 | String decryptedValue = EncryptionUtils.decrypt(this, encryptedValue); 20 | Timber.d(" Decrypted Value :" + decryptedValue); 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /app/src/androidTest/java/com/mm/keystoresample/ExampleInstrumentedTest.java: -------------------------------------------------------------------------------- 1 | package com.mm.keystoresample; 2 | 3 | import android.content.Context; 4 | import android.support.test.InstrumentationRegistry; 5 | import android.support.test.runner.AndroidJUnit4; 6 | 7 | import org.junit.Test; 8 | import org.junit.runner.RunWith; 9 | 10 | import static org.junit.Assert.*; 11 | 12 | /** 13 | * Instrumentation test, which will execute on an Android device. 14 | * 15 | * @see Testing documentation 16 | */ 17 | @RunWith(AndroidJUnit4.class) public class ExampleInstrumentedTest { 18 | @Test public void useAppContext() throws Exception { 19 | // Context of the app under test. 20 | Context appContext = InstrumentationRegistry.getTargetContext(); 21 | 22 | assertEquals("com.mm.keystoresample", appContext.getPackageName()); 23 | } 24 | } 25 | -------------------------------------------------------------------------------- /app/build.gradle: -------------------------------------------------------------------------------- 1 | apply plugin: 'com.android.application' 2 | 3 | android { 4 | compileSdkVersion 25 5 | buildToolsVersion "25.0.2" 6 | defaultConfig { 7 | applicationId "com.example.keystore" 8 | minSdkVersion 16 9 | targetSdkVersion 25 10 | versionCode 1 11 | versionName "1.0" 12 | testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner" 13 | } 14 | buildTypes { 15 | release { 16 | minifyEnabled false 17 | proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' 18 | } 19 | } 20 | } 21 | 22 | dependencies { 23 | compile fileTree(dir: 'libs', include: ['*.jar']) 24 | androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', { 25 | exclude group: 'com.android.support', module: 'support-annotations' 26 | }) 27 | compile 'com.android.support:appcompat-v7:25.1.1' 28 | 29 | compile 'com.jakewharton.timber:timber:4.5.1' 30 | 31 | testCompile 'junit:junit:4.12' 32 | } 33 | -------------------------------------------------------------------------------- /app/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # By default, the flags in this file are appended to flags specified 3 | # in /Users/phanirajabhandari/Development/android-sdk_expy/tools/proguard/proguard-android.txt 4 | # You can edit the include path and order by changing the proguardFiles 5 | # directive in build.gradle. 6 | # 7 | # For more details, see 8 | # http://developer.android.com/guide/developing/tools/proguard.html 9 | 10 | # Add any project specific keep options here: 11 | 12 | # If your project uses WebView with JS, uncomment the following 13 | # and specify the fully qualified class name to the JavaScript interface 14 | # class: 15 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 16 | # public *; 17 | #} 18 | 19 | # Uncomment this to preserve the line number information for 20 | # debugging stack traces. 21 | #-keepattributes SourceFile,LineNumberTable 22 | 23 | # If you keep the line number information, uncomment this to 24 | # hide the original source file name. 25 | #-renamesourcefileattribute SourceFile 26 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | #Android Keystore Example 2 | 3 | Example demonstrating how to use [KeyStore](https://developer.android.com/reference/java/security/KeyStore.html) and generate keys, store them in keystore, and use them for encryption and decryption. 4 | 5 | References 6 | 7 | * [Android Keystore System](https://developer.android.com/training/articles/keystore.html) 8 | * [KeyGenerator](https://developer.android.com/reference/javax/crypto/KeyGenerator.html) 9 | * [KeyPairGenerator](https://developer.android.com/reference/java/security/KeyPairGenerator.html) 10 | * [KeyGenParameterSpec](https://developer.android.com/reference/android/security/keystore/KeyGenParameterSpec.html) 11 | * [Cipher](https://developer.android.com/reference/javax/crypto/Cipher.html) 12 | 13 | 14 | This sample project is still in development, and could easily break or have some messy code. However, any idea or suggestion to improve it will be welcomed. 15 | 16 | 17 | #License 18 | 19 | Copyright 2017 Phaniraja Bhandari 20 | 21 | Licensed under the Apache License, Version 2.0 (the "License"); 22 | you may not use this file except in compliance with the License. 23 | You may obtain a copy of the License at 24 | 25 | http://www.apache.org/licenses/LICENSE-2.0 26 | 27 | Unless required by applicable law or agreed to in writing, software 28 | distributed under the License is distributed on an "AS IS" BASIS, 29 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 30 | See the License for the specific language governing permissions and 31 | limitations under the License. -------------------------------------------------------------------------------- /app/src/main/java/com/example/keystore/EncryptionUtils.java: -------------------------------------------------------------------------------- 1 | package com.example.keystore; 2 | 3 | import android.content.Context; 4 | import android.os.Build; 5 | import java.io.IOException; 6 | import java.security.KeyStore; 7 | import java.security.KeyStoreException; 8 | import java.security.NoSuchAlgorithmException; 9 | import java.security.cert.CertificateException; 10 | import timber.log.Timber; 11 | 12 | public class EncryptionUtils { 13 | 14 | public static String encrypt(Context context, String token) { 15 | SecurityKey securityKey = getSecurityKey(context); 16 | return securityKey != null ? securityKey.encrypt(token) : null; 17 | } 18 | 19 | public static String decrypt(Context context, String token) { 20 | SecurityKey securityKey = getSecurityKey(context); 21 | return securityKey != null ? securityKey.decrypt(token) : null; 22 | } 23 | 24 | private static SecurityKey getSecurityKey(Context context) { 25 | if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) { 26 | return EncryptionKeyGenerator.generateSecretKey(getKeyStore()); 27 | } else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.JELLY_BEAN_MR2) { 28 | return EncryptionKeyGenerator.generateKeyPairPreM(context, getKeyStore()); 29 | } else { 30 | return EncryptionKeyGenerator.generateSecretKeyPre18(context); 31 | } 32 | } 33 | 34 | private static KeyStore getKeyStore() { 35 | KeyStore keyStore = null; 36 | try { 37 | keyStore = KeyStore.getInstance(EncryptionKeyGenerator.ANDROID_KEY_STORE); 38 | keyStore.load(null); 39 | } catch (KeyStoreException | CertificateException | NoSuchAlgorithmException | IOException e) { 40 | Timber.e(e); 41 | } 42 | return keyStore; 43 | } 44 | 45 | public static void clear() { 46 | KeyStore keyStore = getKeyStore(); 47 | try { 48 | if (keyStore.containsAlias(EncryptionKeyGenerator.KEY_ALIAS)) { 49 | keyStore.deleteEntry(EncryptionKeyGenerator.KEY_ALIAS); 50 | } 51 | } catch (KeyStoreException e) { 52 | Timber.e(e); 53 | } 54 | } 55 | } 56 | -------------------------------------------------------------------------------- /app/src/main/java/com/example/keystore/SecurityKey.java: -------------------------------------------------------------------------------- 1 | package com.example.keystore; 2 | 3 | import android.os.Build; 4 | import android.util.Base64; 5 | import java.security.GeneralSecurityException; 6 | import java.security.KeyPair; 7 | import javax.crypto.Cipher; 8 | import javax.crypto.SecretKey; 9 | import javax.crypto.spec.GCMParameterSpec; 10 | import javax.crypto.spec.IvParameterSpec; 11 | import timber.log.Timber; 12 | 13 | class SecurityKey { 14 | private static final String RSA_MODE = "RSA/ECB/PKCS1Padding"; 15 | private static final String AES_MODE_FOR_POST_API_23 = "AES/GCM/NoPadding"; 16 | private static final String AES_MODE_FOR_PRE_API_18 = "AES/CBC/PKCS5Padding"; 17 | 18 | private SecretKey secretKey; 19 | private KeyPair keyPair; 20 | 21 | SecurityKey(SecretKey secretKey) { 22 | this.secretKey = secretKey; 23 | } 24 | 25 | SecurityKey(KeyPair keyPair) { 26 | this.keyPair = keyPair; 27 | } 28 | 29 | String encrypt(String token) { 30 | if (token == null) return null; 31 | 32 | try { 33 | Cipher cipher = getCipher(Cipher.ENCRYPT_MODE); 34 | 35 | byte[] encrypted = cipher.doFinal(token.getBytes()); 36 | return Base64.encodeToString(encrypted, Base64.URL_SAFE); 37 | } catch (GeneralSecurityException e) { 38 | Timber.e(e); 39 | } 40 | //Unable to encrypt Token 41 | return null; 42 | } 43 | 44 | String decrypt(String encryptedToken) { 45 | if (encryptedToken == null) return null; 46 | 47 | try { 48 | Cipher cipher = getCipher(Cipher.DECRYPT_MODE); 49 | 50 | byte[] decoded = Base64.decode(encryptedToken, Base64.URL_SAFE); 51 | byte[] original = cipher.doFinal(decoded); 52 | return new String(original); 53 | } catch (GeneralSecurityException e) { 54 | Timber.e(e); 55 | } 56 | //Unable to decrypt encrypted Token 57 | return null; 58 | } 59 | 60 | private Cipher getCipher(int mode) throws GeneralSecurityException { 61 | Cipher cipher; 62 | 63 | if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) { 64 | cipher = Cipher.getInstance(AES_MODE_FOR_POST_API_23); 65 | cipher.init(mode, secretKey, new GCMParameterSpec(128, AES_MODE_FOR_POST_API_23.getBytes(), 0, 12)); 66 | } else if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.JELLY_BEAN_MR2) { 67 | cipher = Cipher.getInstance(RSA_MODE); 68 | cipher.init(mode, mode == Cipher.DECRYPT_MODE ? keyPair.getPublic() : keyPair.getPrivate()); 69 | } else { 70 | cipher = Cipher.getInstance(AES_MODE_FOR_PRE_API_18); 71 | cipher.init(mode, secretKey, new IvParameterSpec(new byte[cipher.getBlockSize()])); 72 | } 73 | return cipher; 74 | } 75 | } -------------------------------------------------------------------------------- /app/src/main/java/com/example/keystore/EncryptionKeyGenerator.java: -------------------------------------------------------------------------------- 1 | package com.example.keystore; 2 | 3 | import android.annotation.TargetApi; 4 | import android.content.Context; 5 | import android.os.Build; 6 | import android.security.KeyPairGeneratorSpec; 7 | import android.security.keystore.KeyGenParameterSpec; 8 | import android.security.keystore.KeyProperties; 9 | import java.io.FileNotFoundException; 10 | import java.io.IOException; 11 | import java.math.BigInteger; 12 | import java.security.InvalidAlgorithmParameterException; 13 | import java.security.KeyPair; 14 | import java.security.KeyPairGenerator; 15 | import java.security.KeyStore; 16 | import java.security.KeyStoreException; 17 | import java.security.NoSuchAlgorithmException; 18 | import java.security.NoSuchProviderException; 19 | import java.security.UnrecoverableEntryException; 20 | import java.security.cert.CertificateException; 21 | import java.util.Calendar; 22 | import javax.crypto.KeyGenerator; 23 | import javax.security.auth.x500.X500Principal; 24 | import timber.log.Timber; 25 | 26 | public class EncryptionKeyGenerator { 27 | public static final String ANDROID_KEY_STORE = "AndroidKeyStore"; 28 | public static final String KEY_ALIAS = "KEY_ALIAS"; 29 | private static final String KEY_STORE_FILE_NAME = "KEY_STORE"; 30 | private static final String KEY_STORE_PASSWORD = "KEY_STORE_PASSWORD"; 31 | 32 | @TargetApi(Build.VERSION_CODES.M) static SecurityKey generateSecretKey(KeyStore keyStore) { 33 | try { 34 | if (!keyStore.containsAlias(KEY_ALIAS)) { 35 | KeyGenerator keyGenerator = 36 | KeyGenerator.getInstance(KeyProperties.KEY_ALGORITHM_AES, ANDROID_KEY_STORE); 37 | keyGenerator.init(new KeyGenParameterSpec.Builder(KEY_ALIAS, 38 | KeyProperties.PURPOSE_ENCRYPT | KeyProperties.PURPOSE_DECRYPT).setBlockModes( 39 | KeyProperties.BLOCK_MODE_GCM) 40 | .setEncryptionPaddings(KeyProperties.ENCRYPTION_PADDING_NONE) 41 | .setRandomizedEncryptionRequired(false) 42 | .build()); 43 | return new SecurityKey(keyGenerator.generateKey()); 44 | } 45 | } catch (KeyStoreException | NoSuchProviderException | NoSuchAlgorithmException | InvalidAlgorithmParameterException e) { 46 | Timber.e(e); 47 | } 48 | try { 49 | final KeyStore.SecretKeyEntry entry = 50 | (KeyStore.SecretKeyEntry) keyStore.getEntry(KEY_ALIAS, null); 51 | return new SecurityKey(entry.getSecretKey()); 52 | } catch (KeyStoreException | NoSuchAlgorithmException | UnrecoverableEntryException e) { 53 | Timber.e(e); 54 | } 55 | return null; 56 | } 57 | 58 | @TargetApi(Build.VERSION_CODES.JELLY_BEAN_MR2) 59 | static SecurityKey generateKeyPairPreM(Context context, KeyStore keyStore) { 60 | try { 61 | if (!keyStore.containsAlias(KEY_ALIAS)) { 62 | Calendar start = Calendar.getInstance(); 63 | Calendar end = Calendar.getInstance(); 64 | //1 Year validity 65 | end.add(Calendar.YEAR, 1); 66 | 67 | KeyPairGeneratorSpec spec = new KeyPairGeneratorSpec.Builder(context).setAlias(KEY_ALIAS) 68 | .setSubject(new X500Principal("CN=" + KEY_ALIAS)) 69 | .setSerialNumber(BigInteger.TEN) 70 | .setStartDate(start.getTime()) 71 | .setEndDate(end.getTime()) 72 | .build(); 73 | 74 | KeyPairGenerator kpg = KeyPairGenerator.getInstance("RSA", ANDROID_KEY_STORE); 75 | kpg.initialize(spec); 76 | kpg.generateKeyPair(); 77 | } 78 | } catch (KeyStoreException | NoSuchAlgorithmException | InvalidAlgorithmParameterException | NoSuchProviderException e) { 79 | Timber.e(e); 80 | } 81 | 82 | try { 83 | final KeyStore.PrivateKeyEntry entry = 84 | (KeyStore.PrivateKeyEntry) keyStore.getEntry(KEY_ALIAS, null); 85 | return new SecurityKey( 86 | new KeyPair(entry.getCertificate().getPublicKey(), entry.getPrivateKey())); 87 | } catch (KeyStoreException | NoSuchAlgorithmException | UnrecoverableEntryException e) { 88 | Timber.e(e); 89 | } 90 | return null; 91 | } 92 | 93 | static SecurityKey generateSecretKeyPre18(Context context) { 94 | 95 | try { 96 | KeyStore androidCAStore = KeyStore.getInstance(KeyStore.getDefaultType()); 97 | 98 | char[] password = KEY_STORE_PASSWORD.toCharArray(); 99 | 100 | boolean isKeyStoreLoaded = loadKeyStore(context, androidCAStore, password); 101 | KeyStore.ProtectionParameter protParam = new KeyStore.PasswordProtection(password); 102 | if (!isKeyStoreLoaded || !androidCAStore.containsAlias(KEY_ALIAS)) { 103 | //Create and save new secret key 104 | saveMyKeystore(context, androidCAStore, password, protParam); 105 | } 106 | 107 | // Fetch Secret Key 108 | KeyStore.SecretKeyEntry pkEntry = 109 | (KeyStore.SecretKeyEntry) androidCAStore.getEntry(KEY_ALIAS, protParam); 110 | 111 | Timber.d("Secret Key Fetched :" + new String(pkEntry.getSecretKey().getEncoded(), "UTF-8")); 112 | return new SecurityKey(pkEntry.getSecretKey()); 113 | } catch (KeyStoreException | IOException | CertificateException | NoSuchAlgorithmException | UnrecoverableEntryException e) { 114 | Timber.e(e); 115 | } 116 | return null; 117 | } 118 | 119 | private static boolean loadKeyStore(Context context, KeyStore androidCAStore, char[] password) { 120 | java.io.FileInputStream fis; 121 | try { 122 | fis = context.openFileInput(KEY_STORE_FILE_NAME); 123 | } catch (FileNotFoundException e) { 124 | Timber.e(e); 125 | return false; 126 | } 127 | try { 128 | androidCAStore.load(fis, password); 129 | return true; 130 | } catch (IOException | NoSuchAlgorithmException | CertificateException e) { 131 | Timber.e(e); 132 | } 133 | return false; 134 | } 135 | 136 | private static void saveMyKeystore(Context context, KeyStore androidCAStore, char[] password, 137 | KeyStore.ProtectionParameter protParam) 138 | throws NoSuchAlgorithmException, KeyStoreException, IOException, CertificateException { 139 | 140 | javax.crypto.SecretKey mySecretKey = KeyGenerator.getInstance("AES").generateKey(); 141 | 142 | KeyStore.SecretKeyEntry skEntry = new KeyStore.SecretKeyEntry(mySecretKey); 143 | androidCAStore.load(null); 144 | androidCAStore.setEntry(KEY_ALIAS, skEntry, protParam); 145 | java.io.FileOutputStream fos = null; 146 | try { 147 | fos = context.openFileOutput(KEY_STORE_FILE_NAME, Context.MODE_PRIVATE); 148 | 149 | androidCAStore.store(fos, password); 150 | } finally { 151 | if (fos != null) { 152 | fos.close(); 153 | } 154 | } 155 | Timber.d("Secret Key Saved : " + new String(mySecretKey.getEncoded(), "UTF-8")); 156 | } 157 | } 158 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------