Enabling using secret values during a deployment #1755
+3,080
−199
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,17 @@ | ||
| package org.cloudfoundry.multiapps.controller.core.security.encryption; | ||
|
|
||
| public class AESDecryptionException extends RuntimeException { | ||
|
|
||
| public AESDecryptionException(String message) { | ||
| super(message); | ||
| } | ||
|
|
||
| public AESDecryptionException(String message, Throwable cause) { | ||
| super(message, cause); | ||
| } | ||
|
|
||
| public AESDecryptionException(Throwable cause) { | ||
| super(cause); | ||
| } | ||
|
|
||
| } |
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,17 @@ | ||
| package org.cloudfoundry.multiapps.controller.core.security.encryption; | ||
|
|
||
| public class AESEncryptionException extends RuntimeException { | ||
|
|
||
| public AESEncryptionException(String message) { | ||
| super(message); | ||
| } | ||
|
|
||
| public AESEncryptionException(String message, Throwable cause) { | ||
| super(message, cause); | ||
| } | ||
|
|
||
| public AESEncryptionException(Throwable cause) { | ||
| super(cause); | ||
| } | ||
|
|
||
| } |
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,63 @@ | ||
| package org.cloudfoundry.multiapps.controller.core.security.encryption; | ||
|
|
||
| import java.nio.charset.StandardCharsets; | ||
| import java.security.SecureRandom; | ||
| import javax.crypto.Cipher; | ||
| import javax.crypto.spec.GCMParameterSpec; | ||
| import javax.crypto.spec.SecretKeySpec; | ||
|
|
||
| import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider; | ||
| 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. |
||
| try { | ||
| byte[] gcmInitialisationVector = new byte[Constants.INITIALISATION_VECTOR_LENGTH]; | ||
| new SecureRandom().nextBytes(gcmInitialisationVector); | ||
|
|
||
| Cipher cipherObject = Cipher.getInstance(Constants.CYPHER_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); | ||
|
|
||
| cipherObject.init(Cipher.ENCRYPT_MODE, secretKeySpec, gcmParameterSpec); | ||
|
Comment on lines
+20
to
+24
Contributor
There was a problem hiding this comment. The cipher initialization logic in |
||
|
|
||
| byte[] cipherValue = cipherObject.doFinal(plainText.getBytes(StandardCharsets.UTF_8)); | ||
|
|
||
| byte[] combinedCypherValueAndInitialisationVector = new byte[gcmInitialisationVector.length + cipherValue.length]; | ||
|
|
||
| System.arraycopy(gcmInitialisationVector, 0, combinedCypherValueAndInitialisationVector, 0, gcmInitialisationVector.length); | ||
| System.arraycopy(cipherValue, 0, combinedCypherValueAndInitialisationVector, gcmInitialisationVector.length, | ||
| cipherValue.length); | ||
|
|
||
| return combinedCypherValueAndInitialisationVector; | ||
| } catch (Exception e) { | ||
| throw new AESEncryptionException(Messages.ENCRYPTION_BOUNCY_CASTLE_AES256_HAS_FAILED | ||
| + e.getMessage(), e); | ||
|
Comment on lines
+36
to
+37
Contributor
There was a problem hiding this comment. Use MessageFormat for better formatting of the error message |
||
| } | ||
| } | ||
|
|
||
| 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 - 12]; | ||
| System.arraycopy(encryptedValue, 12, cipherValue, 0, cipherValue.length); | ||
|
Comment on lines
+47
to
+48
Contributor
There was a problem hiding this comment. Extract the hardcoded 12 in a constant. |
||
|
|
||
| Cipher cipherObject = Cipher.getInstance(Constants.CYPHER_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); | ||
| cipherObject.init(Cipher.DECRYPT_MODE, secretKeySpec, gcmParameterSpec); | ||
|
|
||
| byte[] resultInBytes = cipherObject.doFinal(cipherValue); | ||
| return new String(resultInBytes, StandardCharsets.UTF_8); | ||
| } catch (Exception e) { | ||
| throw new AESDecryptionException(Messages.DECRYPTION_BOUNCY_CASTLE_AES256_HAS_FAILED | ||
|
Contributor
There was a problem hiding this comment. same as above |
||
| + e.getMessage(), e); | ||
| } | ||
| } | ||
|
|
||
| } | ||
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,76 @@ | ||
| 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 { | ||
|
Contributor
There was a problem hiding this comment. There still a few places where is SecureSerialization is used. For example in ProcessDescriptorStep |
||
|
|
||
| private final SecureSerializerConfiguration secureSerializerConfiguration; | ||
|
|
||
| DynamicSecureSerialization(SecureSerializerConfiguration secureSerializerConfiguration) { | ||
|
Contributor
There was a problem hiding this comment. why no modifier? |
||
| this.secureSerializerConfiguration = secureSerializerConfiguration; | ||
| } | ||
|
|
||
| public String toJson(Object object) { | ||
| SecureJsonSerializer secureJsonSerializer = createDynamicJsonSerializer(object, secureSerializerConfiguration); | ||
|
Contributor
There was a problem hiding this comment. why do you pass this parameter everywhere when you have it as a field? |
||
| return secureJsonSerializer.serialize(object); | ||
| } | ||
|
|
||
| private static SecureJsonSerializer createDynamicJsonSerializer(Object object, | ||
| SecureSerializerConfiguration secureSerializerConfiguration) { | ||
| SecureJsonSerializer secureJsonSerializer = createDynamicJsonSerializerForVersionedEntity(object, secureSerializerConfiguration); | ||
| if (secureJsonSerializer == null) { | ||
| return new SecureJsonSerializer(secureSerializerConfiguration); | ||
| } | ||
|
|
||
| return secureJsonSerializer; | ||
| } | ||
|
|
||
| private static SecureJsonSerializer createDynamicJsonSerializerForVersionedEntity(Object object, | ||
| SecureSerializerConfiguration secureSerializerConfiguration) { | ||
| if (object instanceof VersionedEntity) { | ||
| return createDynamicJsonSerializerForVersionedEntity((VersionedEntity) object, secureSerializerConfiguration); | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| private static SecureJsonSerializer createDynamicJsonSerializerForVersionedEntity(VersionedEntity versionedEntity, | ||
|
Contributor
There was a problem hiding this comment. Hooks with secret values were printed in Operation log. Maybe should be addressed here? |
||
| SecureSerializerConfiguration secureSerializerConfiguration) { | ||
| 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.
what is this used for?