Enabling using secret values during a deployment #1755
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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,80 @@ | ||
| package org.cloudfoundry.multiapps.controller.core.security.encryption; | ||
|
|
||
| import java.nio.charset.StandardCharsets; | ||
| import java.security.InvalidAlgorithmParameterException; | ||
| import java.security.InvalidKeyException; | ||
| import java.security.NoSuchAlgorithmException; | ||
| import java.security.NoSuchProviderException; | ||
| import java.security.SecureRandom; | ||
| import java.text.MessageFormat; | ||
| import javax.crypto.Cipher; | ||
| import javax.crypto.NoSuchPaddingException; | ||
| import javax.crypto.spec.GCMParameterSpec; | ||
| import javax.crypto.spec.SecretKeySpec; | ||
|
|
||
| import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider; | ||
| import org.cloudfoundry.multiapps.common.SLException; | ||
| import org.cloudfoundry.multiapps.controller.core.Constants; | ||
| import org.cloudfoundry.multiapps.controller.core.Messages; | ||
|
|
||
| public class AesEncryptionUtil { | ||
|
|
||
| public static byte[] encrypt(String plainText, byte[] encryptionKey) { | ||
|
Contributor
There was a problem hiding this comment. Minor spelling issue: the variable name uses “Cypher” instead of “Cipher”. Consider updating the variable names to use “Cipher” for clarity and consistency.
Contributor
Author
There was a problem hiding this comment. thanks for pointing out! |
||
| try { | ||
| if (plainText == null) { | ||
| plainText = ""; | ||
| } | ||
| byte[] gcmInitialisationVector = new byte[Constants.INITIALISATION_VECTOR_LENGTH]; | ||
| new SecureRandom().nextBytes(gcmInitialisationVector); | ||
|
|
||
| Cipher cipherObject = setUpCipherObject(encryptionKey, gcmInitialisationVector, true); | ||
|
|
||
| byte[] cipherValue = cipherObject.doFinal(plainText.getBytes(StandardCharsets.UTF_8)); | ||
|
|
||
| byte[] combinedCipherValueAndInitialisationVector = new byte[gcmInitialisationVector.length + cipherValue.length]; | ||
|
|
||
| System.arraycopy(gcmInitialisationVector, 0, combinedCipherValueAndInitialisationVector, 0, gcmInitialisationVector.length); | ||
| System.arraycopy(cipherValue, 0, combinedCipherValueAndInitialisationVector, gcmInitialisationVector.length, | ||
| cipherValue.length); | ||
|
|
||
| return combinedCipherValueAndInitialisationVector; | ||
| } catch (Exception e) { | ||
| throw new SLException(MessageFormat.format(Messages.ENCRYPTION_HAS_FAILED, e.getMessage()), e); | ||
| } | ||
| } | ||
|
|
||
| public static String decrypt(byte[] encryptedValue, byte[] encryptionKey) { | ||
| try { | ||
| byte[] gcmInitialisationVector = new byte[Constants.INITIALISATION_VECTOR_LENGTH]; | ||
| System.arraycopy(encryptedValue, 0, gcmInitialisationVector, 0, | ||
| gcmInitialisationVector.length); | ||
|
|
||
| byte[] cipherValue = new byte[encryptedValue.length - Constants.INITIALISATION_VECTOR_LENGTH]; | ||
| System.arraycopy(encryptedValue, Constants.INITIALIZATION_VECTOR_POSITION, cipherValue, 0, cipherValue.length); | ||
|
|
||
| Cipher cipherObject = setUpCipherObject(encryptionKey, gcmInitialisationVector, false); | ||
|
|
||
| byte[] resultInBytes = cipherObject.doFinal(cipherValue); | ||
| return new String(resultInBytes, StandardCharsets.UTF_8); | ||
| } catch (Exception e) { | ||
| throw new SLException(MessageFormat.format(Messages.DECRYPTION_HAS_FAILED, e.getMessage()), e); | ||
| } | ||
| } | ||
|
|
||
| private static Cipher setUpCipherObject(byte[] encryptionKey, byte[] gcmInitialisationVector, boolean shouldEncrypt) | ||
| throws InvalidAlgorithmParameterException, InvalidKeyException, NoSuchPaddingException, NoSuchAlgorithmException, | ||
| NoSuchProviderException { | ||
| Cipher cipherObject = Cipher.getInstance(Constants.CIPHER_TRANSFORMATION_NAME, BouncyCastleFipsProvider.PROVIDER_NAME); | ||
| SecretKeySpec secretKeySpec = new SecretKeySpec(encryptionKey, Constants.ENCRYPTION_DECRYPTION_ALGORITHM_NAME); | ||
| GCMParameterSpec gcmParameterSpec = new GCMParameterSpec(Constants.GCM_AUTHENTICATION_TAG_LENGTH, gcmInitialisationVector); | ||
|
|
||
| if (shouldEncrypt) { | ||
| cipherObject.init(Cipher.ENCRYPT_MODE, secretKeySpec, gcmParameterSpec); | ||
| } else { | ||
| cipherObject.init(Cipher.DECRYPT_MODE, secretKeySpec, gcmParameterSpec); | ||
| } | ||
|
|
||
| return cipherObject; | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or 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,73 @@ | ||
| package org.cloudfoundry.multiapps.controller.core.security.serialization; | ||
|
|
||
| import org.cloudfoundry.multiapps.controller.core.security.serialization.model.DeploymentDescriptorSerializer; | ||
| import org.cloudfoundry.multiapps.controller.core.security.serialization.model.ModuleSerializer; | ||
| import org.cloudfoundry.multiapps.controller.core.security.serialization.model.ProvidedDependencySerializer; | ||
| import org.cloudfoundry.multiapps.controller.core.security.serialization.model.RequiredDependencySerializer; | ||
| import org.cloudfoundry.multiapps.controller.core.security.serialization.model.ResourceSerializer; | ||
| import org.cloudfoundry.multiapps.mta.model.DeploymentDescriptor; | ||
| import org.cloudfoundry.multiapps.mta.model.Module; | ||
| import org.cloudfoundry.multiapps.mta.model.ProvidedDependency; | ||
| import org.cloudfoundry.multiapps.mta.model.RequiredDependency; | ||
| import org.cloudfoundry.multiapps.mta.model.Resource; | ||
| import org.cloudfoundry.multiapps.mta.model.VersionedEntity; | ||
|
|
||
| public final class DynamicSecureSerialization { | ||
IvanBorislavovDimitrov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| private final SecureSerializerConfiguration secureSerializerConfiguration; | ||
|
|
||
| public DynamicSecureSerialization(SecureSerializerConfiguration secureSerializerConfiguration) { | ||
| this.secureSerializerConfiguration = secureSerializerConfiguration; | ||
| } | ||
|
|
||
| public String toJson(Object object) { | ||
| SecureJsonSerializer secureJsonSerializer = createDynamicJsonSerializer(object); | ||
| return secureJsonSerializer.serialize(object); | ||
| } | ||
|
|
||
| private SecureJsonSerializer createDynamicJsonSerializer(Object object) { | ||
| SecureJsonSerializer secureJsonSerializer = createDynamicJsonSerializerForVersionedEntity(object); | ||
| if (secureJsonSerializer == null) { | ||
| return new SecureJsonSerializer(secureSerializerConfiguration); | ||
| } | ||
|
|
||
| return secureJsonSerializer; | ||
| } | ||
|
|
||
| private SecureJsonSerializer createDynamicJsonSerializerForVersionedEntity(Object object) { | ||
| if (object instanceof VersionedEntity) { | ||
| return createDynamicJsonSerializerForVersionedEntity((VersionedEntity) object); | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| private SecureJsonSerializer createDynamicJsonSerializerForVersionedEntity(VersionedEntity versionedEntity) { | ||
| if (versionedEntity.getMajorSchemaVersion() < 3) { | ||
| return null; | ||
| } | ||
|
|
||
| if (versionedEntity instanceof DeploymentDescriptor) { | ||
| return new DeploymentDescriptorSerializer(secureSerializerConfiguration); | ||
| } | ||
|
|
||
| if (versionedEntity instanceof Module) { | ||
| return new ModuleSerializer(secureSerializerConfiguration); | ||
| } | ||
|
|
||
| if (versionedEntity instanceof ProvidedDependency) { | ||
| return new ProvidedDependencySerializer(secureSerializerConfiguration); | ||
| } | ||
|
|
||
| if (versionedEntity instanceof RequiredDependency) { | ||
| return new RequiredDependencySerializer(secureSerializerConfiguration); | ||
| } | ||
|
|
||
| if (versionedEntity instanceof Resource) { | ||
| return new ResourceSerializer(secureSerializerConfiguration); | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or 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,18 @@ | ||
| package org.cloudfoundry.multiapps.controller.core.security.serialization; | ||
|
|
||
| import java.util.Collection; | ||
|
|
||
| public final class SecureSerializationFactory { | ||
|
|
||
| private SecureSerializationFactory() { | ||
|
|
||
| } | ||
|
|
||
| public static DynamicSecureSerialization ofAdditionalValues(Collection<String> additionalSensitiveElementNames) { | ||
| SecureSerializerConfiguration secureSerializerConfigurationWithAdditionalValues = new SecureSerializerConfiguration(); | ||
|
|
||
| secureSerializerConfigurationWithAdditionalValues.setAdditionalSensitiveElementNames(additionalSensitiveElementNames); | ||
| return new DynamicSecureSerialization(secureSerializerConfigurationWithAdditionalValues); | ||
| } | ||
|
|
||
| } |
This file contains hidden or 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.
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.
I am not able to run the test in IDE? Could you check. I had to exclude:
com.aliyun.oss
aliyun-sdk-oss
org.ini4j
ini4j
javax.xml.bind
jaxb-api
org.bouncycastle
bcprov-jdk18on
${aliyun-sdk-oss.version}