Encrypt credentials in memory #2723
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -34,4 +34,5 @@ app/libs/javarosa-libraries.jar | |
| build/ | ||
| **/*~ | ||
| app/google-services.json | ||
| app/fabric.properties | ||
| app/src/META-INF/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -136,42 +136,50 @@ dependencies { | |
| } | ||
|
|
||
| ext { | ||
| // Obtained from ~/.gradle/gradle.properties on build server (mobile agent), or your local | ||
| // ~/.gradle/gradle.properties file, or loads default empty strings if neither is present | ||
| MAPBOX_SDK_API_KEY = project.properties['MAPBOX_SDK_API_KEY'] ?: '' | ||
| ANALYTICS_TRACKING_ID_DEV = project.properties['ANALYTICS_TRACKING_ID_DEV'] ?: '' | ||
| ANALYTICS_TRACKING_ID_LIVE = project.properties['ANALYTICS_TRACKING_ID_LIVE'] ?: '' | ||
| GOOGLE_PLAY_MAPS_API_KEY = project.properties['GOOGLE_PLAY_MAPS_API_KEY'] ?: '' | ||
| RELEASE_STORE_FILE = project.properties['RELEASE_STORE_FILE'] ?: '.' | ||
| RELEASE_STORE_PASSWORD = project.properties['RELEASE_STORE_PASSWORD'] ?: '' | ||
| RELEASE_KEY_ALIAS = project.properties['RELEASE_KEY_ALIAS'] ?: '' | ||
| RELEASE_KEY_PASSWORD = project.properties['RELEASE_KEY_PASSWORD'] ?: '' | ||
| TRUSTED_SOURCE_PUBLIC_KEY = project.properties['TRUSTED_SOURCE_PUBLIC_KEY'] ?: | ||
| "MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDHiuy2ULV4pobkuQN2TEjmR1tn" + | ||
| "HJ+F335hm/lVdaFQzvBmeq64MUMbumheVLDJaSUiAVzqSHDKJWH01ZQRowqBYjwo" + | ||
| "ycVSQSeO2glc6XZZ+CJudAPXe8iFWLQp3kBBnBmVcBXCOQFO7aLgQMv4nqKZsLW0" + | ||
| "HaAJkjpnc165Os+aYwIDAQAB" | ||
| GOOGLE_SERVICES_API_KEY = project.properties['GOOGLE_SERVICES_API_KEY'] ?: '' | ||
| QA_BETA_APP_ID = '' | ||
| STANDALONE_APP_ID = '' | ||
| LTS_APP_ID = '' | ||
| COMMCARE_APP_ID = '' | ||
| HQ_API_USERNAME = project.properties['HQ_API_USERNAME'] ?: '' | ||
| HQ_API_PASSWORD = project.properties['HQ_API_PASSWORD'] ?: '' | ||
| TEST_BUILD_TYPE = project.properties['TEST_BUILD_TYPE'] ?: 'debug' | ||
| FIREBASE_DATABASE_URL = project.properties['FIREBASE_DATABASE_URL'] ?: '' | ||
|
|
||
| // properties related to Service providers part of the Java SPI pattern | ||
| SERVICE_PROVIDERS_REL_DIR = 'META-INF/services' | ||
| /** | ||
| * Service provider implementations and respective service interfaces should be added to this | ||
| * map. The task registerServiceProviders is responsible for iterating over it and create the | ||
| * configuration files under META-INF/services | ||
| */ | ||
| SERVICE_PROVIDERS = ['org.commcare.util.IEncryptionKeyProvider' : 'org.commcare.utils.EncryptionKeyProvider'] | ||
| } | ||
|
|
||
| afterEvaluate { | ||
| // Hack to get assets to show up in robolectric tests; try to eventually remove this | ||
| preCommcareDebugUnitTestBuild.dependsOn mergeCommcareDebugAssets, registerServiceProviders | ||
| processStandaloneDebugGoogleServices.dependsOn injectPropertiesIntoFirebaseConfigFile, registerServiceProviders | ||
| processStandaloneReleaseGoogleServices.dependsOn injectPropertiesIntoFirebaseConfigFile, registerServiceProviders | ||
| processLtsDebugGoogleServices.dependsOn injectPropertiesIntoFirebaseConfigFile, registerServiceProviders | ||
| processLtsReleaseGoogleServices.dependsOn injectPropertiesIntoFirebaseConfigFile, registerServiceProviders | ||
| processCommcareDebugGoogleServices.dependsOn injectPropertiesIntoFirebaseConfigFile, registerServiceProviders | ||
| processCommcareReleaseGoogleServices.dependsOn injectPropertiesIntoFirebaseConfigFile, registerServiceProviders | ||
| } | ||
|
|
||
| /** | ||
|
|
@@ -632,3 +640,17 @@ downloadLicenses { | |
| includeProjectDependencies = true | ||
| dependencyConfiguration = 'compile' | ||
| } | ||
|
|
||
| task registerServiceProviders { | ||
|
There was a problem hiding this comment. Why add it at build time instead of just having a static file ? There was a problem hiding this comment. @shubham1g5 that was the initial approach but I thought about making it easy for future additions and also to put this on others radar, a static file can very easily be overlooked. So, not necessarily strong reasons. There was a problem hiding this comment. Got it, I would still prefer a static file if we go with service provider approach as this adds an unnecessary build step without any strong advantages. |
||
| doLast { | ||
| def servProvAbsPath = android.sourceSets.main.java.srcDirs[0].path + File.separator + project.ext.SERVICE_PROVIDERS_REL_DIR | ||
| project.ext.SERVICE_PROVIDERS.each { servProv -> | ||
| println(servProvAbsPath + File.separator + "$servProv.key") | ||
| def file = new File(servProvAbsPath + File.separator + "$servProv.key") | ||
| if(!file.getParentFile().exists()) { | ||
| file.getParentFile().mkdirs() | ||
| } | ||
| file.write("$servProv.value") | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| package org.commcare.utils; | ||
|
|
||
| import android.os.Build; | ||
| import android.security.KeyPairGeneratorSpec; | ||
| import android.security.keystore.KeyGenParameterSpec; | ||
| import android.security.keystore.KeyProperties; | ||
|
|
||
| import org.commcare.CommCareApplication; | ||
| import org.commcare.util.EncryptionKeyAndTransformation; | ||
| import org.commcare.util.EncryptionUtils; | ||
| import org.commcare.util.IEncryptionKeyProvider; | ||
|
|
||
| import java.io.IOException; | ||
| import java.math.BigInteger; | ||
| import java.security.InvalidAlgorithmParameterException; | ||
| import java.security.Key; | ||
| import java.security.KeyPairGenerator; | ||
| import java.security.KeyStore; | ||
| import java.security.KeyStoreException; | ||
| import java.security.NoSuchAlgorithmException; | ||
| import java.security.NoSuchProviderException; | ||
| import java.security.Security; | ||
| import java.security.UnrecoverableEntryException; | ||
| import java.security.cert.CertificateException; | ||
| import java.util.GregorianCalendar; | ||
|
|
||
| import javax.crypto.KeyGenerator; | ||
| import javax.security.auth.x500.X500Principal; | ||
|
|
||
| import androidx.annotation.RequiresApi; | ||
|
|
||
| import static org.commcare.utils.GlobalConstants.KEYSTORE_NAME; | ||
|
|
||
| /** | ||
| * Class for providing encryption keys backed by Android Keystore | ||
| * | ||
| * @author dviggiano | ||
| */ | ||
| public class EncryptionKeyProvider implements IEncryptionKeyProvider { | ||
|
|
||
| @RequiresApi(api = Build.VERSION_CODES.M) | ||
| private static final String ALGORITHM = KeyProperties.KEY_ALGORITHM_AES; | ||
| @RequiresApi(api = Build.VERSION_CODES.M) | ||
| private static final String BLOCK_MODE = KeyProperties.BLOCK_MODE_GCM; | ||
| @RequiresApi(api = Build.VERSION_CODES.M) | ||
| private static final String PADDING = KeyProperties.ENCRYPTION_PADDING_NONE; | ||
| private static KeyStore keystoreSingleton = null; | ||
|
|
||
| private static KeyStore getKeyStore() throws KeyStoreException, CertificateException, | ||
| IOException, NoSuchAlgorithmException { | ||
| if (keystoreSingleton == null) { | ||
| keystoreSingleton = KeyStore.getInstance(KEYSTORE_NAME); | ||
| keystoreSingleton.load(null); | ||
| } | ||
| return keystoreSingleton; | ||
| } | ||
|
|
||
| @Override | ||
| public EncryptionKeyAndTransformation retrieveKeyFromKeyStore(String keyAlias, | ||
| EncryptionUtils.CryptographicOperation operation) | ||
| throws KeyStoreException, UnrecoverableEntryException, NoSuchAlgorithmException, | ||
| CertificateException, IOException { | ||
| Key key; | ||
| if (getKeyStore().containsAlias(keyAlias)) { | ||
| KeyStore.Entry keyEntry = getKeyStore().getEntry(keyAlias, null); | ||
| if (keyEntry instanceof KeyStore.PrivateKeyEntry) { | ||
| if (operation == EncryptionUtils.CryptographicOperation.Encryption) { | ||
| key = ((KeyStore.PrivateKeyEntry)keyEntry).getCertificate().getPublicKey(); | ||
| } else { | ||
| key = ((KeyStore.PrivateKeyEntry)keyEntry).getPrivateKey(); | ||
| } | ||
| } else { | ||
| key = ((KeyStore.SecretKeyEntry)keyEntry).getSecretKey(); | ||
| } | ||
| } else { | ||
| throw new KeyStoreException("Key not found in KeyStore"); | ||
| } | ||
| if (key != null) { | ||
| return new EncryptionKeyAndTransformation(key, getTransformationString(key.getAlgorithm())); | ||
| } else { | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| // Generates a cryptrographic key and adds it to the Android KeyStore | ||
| public void generateCryptographicKeyInKeyStore(String keyAlias) { | ||
| if (isKeyStoreAvailable()) { | ||
| try { | ||
| if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.M) { | ||
| KeyGenerator keyGenerator = KeyGenerator | ||
| .getInstance(getAESKeyAlgorithmRepresentation(), KEYSTORE_NAME); | ||
| KeyGenParameterSpec keyGenParameterSpec = new KeyGenParameterSpec.Builder(keyAlias, | ||
| KeyProperties.PURPOSE_ENCRYPT | KeyProperties.PURPOSE_DECRYPT) | ||
| .setBlockModes(BLOCK_MODE) | ||
| .setEncryptionPaddings(PADDING) | ||
| .build(); | ||
| keyGenerator.init(keyGenParameterSpec); | ||
| keyGenerator.generateKey(); | ||
| } else { | ||
| // Because KeyGenParameterSpec was introduced in Android SDK 23, prior versions | ||
| // need to resource to KeyPairGenerator which only generates asymmetric keys, | ||
| // hence the need to switch to a correspondent algorithm as well, RSA | ||
| // TODO: Add link to StackOverflow page | ||
| KeyPairGenerator keyGenerator = KeyPairGenerator | ||
| .getInstance(getRSAKeyAlgorithmRepresentation(), KEYSTORE_NAME); | ||
| GregorianCalendar start = new GregorianCalendar(); | ||
| GregorianCalendar end = new GregorianCalendar(); | ||
| end.add(GregorianCalendar.YEAR, 100); | ||
|
|
||
| KeyPairGeneratorSpec keySpec = new KeyPairGeneratorSpec.Builder(CommCareApplication.instance()) | ||
| // Key alias to be used to retrieve it from the KeyStore | ||
| .setAlias(keyAlias) | ||
| // The subject used for the self-signed certificate of the generated pair | ||
| .setSubject(new X500Principal(String.format("CN=%s", keyAlias))) | ||
| // The serial number used for the self-signed certificate of the | ||
| // generated pair | ||
| .setSerialNumber(BigInteger.valueOf(1337)) | ||
| // Date range of validity for the generated pair | ||
| .setStartDate(start.getTime()) | ||
| .setEndDate(end.getTime()) | ||
| .build(); | ||
|
|
||
| keyGenerator.initialize(keySpec); | ||
| keyGenerator.generateKeyPair(); | ||
| } | ||
|
|
||
| } catch (NoSuchAlgorithmException | NoSuchProviderException | | ||
| InvalidAlgorithmParameterException e) { | ||
| throw new RuntimeException(e); | ||
| } | ||
| } else { | ||
| throw new RuntimeException("KeyStore not available"); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public boolean isKeyStoreAvailable() { | ||
| return Security.getProvider(KEYSTORE_NAME) != null; | ||
| } | ||
|
|
||
| @Override | ||
| public String getAESKeyAlgorithmRepresentation() { | ||
| return ALGORITHM; | ||
| } | ||
|
|
||
| @Override | ||
| public String getRSAKeyAlgorithmRepresentation() { | ||
| return "RSA"; | ||
| } | ||
|
|
||
| @Override | ||
| public String getTransformationString(String algorithm) { | ||
| String transformation = null; | ||
| if (algorithm.equals(getRSAKeyAlgorithmRepresentation())) { | ||
| transformation = "RSA/ECB/PKCS1Padding"; | ||
| } else if (algorithm.equals(getAESKeyAlgorithmRepresentation())) { | ||
| transformation = String.format("%s/%s/%s", algorithm, BLOCK_MODE, PADDING); | ||
| } | ||
| // This will cause an error if null | ||
| return transformation; | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the reasoning behind specifying it here instead of Java -
registerServiceKeyProvider(new EncryptionKeyProvider()?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@shubham1g5 this is just to create the static configuration files, the instantiation is done by the JRE using the
ServiceLoader. The reasoning here is to decouple the service interface from its implementations, more concretely, it removes any dependency betweencommcare-androidandcommcare-corewhen it comes to IEncryptionKeyProvider implementations.