-
Notifications
You must be signed in to change notification settings - Fork 1.4k
add rabbitmq jasypt property encryption facility #13676
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
DaanHoogland
wants to merge
2
commits into
apache:4.22
Choose a base branch
from
shapeblue:ghi13352-rabbitmqEncryption
base: 4.22
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+140
−0
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
62 changes: 62 additions & 0 deletions
62
utils/src/main/java/com/cloud/utils/crypt/EncryptablePropertyPlaceholderConfigurer.java
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,62 @@ | ||
| // | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
| // | ||
|
|
||
| package com.cloud.utils.crypt; | ||
|
|
||
| import org.springframework.beans.factory.config.PropertyPlaceholderConfigurer; | ||
|
|
||
| /** | ||
| * Spring bean that resolves property placeholders, decrypting any value wrapped as | ||
| * {@code ENC(...)} with the management server's own secret key, via | ||
| * {@link EncryptionSecretKeyChecker} (the same AES-GCM based mechanism already used to | ||
| * encrypt {@code db.properties}). Values that are not wrapped are passed through unchanged, | ||
| * and if encryption has not been configured on the management server, decryption is skipped | ||
| * entirely and the raw (still-wrapped) value is returned. | ||
| * | ||
| * This replaces {@code org.jasypt.spring3.properties.EncryptablePropertyPlaceholderConfigurer} | ||
| * (from the jasypt-spring3 artifact), which is not on the classpath and is incompatible with | ||
| * Spring 5, so beans referencing it fail with a ClassNotFoundException. Unlike that class, this | ||
| * one needs no separate {@code StringEncryptor}/algorithm bean wired in: declare it as | ||
| * <pre>{@code | ||
| * <bean id="propertyConfigurer" class="com.cloud.utils.crypt.EncryptablePropertyPlaceholderConfigurer"> | ||
| * <property name="location" value="classpath:/cred.properties" /> | ||
| * </bean> | ||
| * }</pre> | ||
| * and it reuses whichever secret key the management server was configured with (file/env/web, | ||
| * see {@code password.encryption.type} in db.properties). | ||
| */ | ||
| public class EncryptablePropertyPlaceholderConfigurer extends PropertyPlaceholderConfigurer { | ||
|
|
||
| private static final String ENC_PREFIX = "ENC("; | ||
| private static final String ENC_SUFFIX = ")"; | ||
|
|
||
| @Override | ||
| protected String convertPropertyValue(String originalValue) { | ||
| if (originalValue == null || !EncryptionSecretKeyChecker.useEncryption()) { | ||
| return originalValue; | ||
| } | ||
|
|
||
| String trimmedValue = originalValue.trim(); | ||
| if (trimmedValue.startsWith(ENC_PREFIX) && trimmedValue.endsWith(ENC_SUFFIX)) { | ||
| return EncryptionSecretKeyChecker.decryptPropertyIfNeeded(trimmedValue); | ||
| } | ||
|
|
||
| return originalValue; | ||
| } | ||
| } | ||
78 changes: 78 additions & 0 deletions
78
utils/src/test/java/com/cloud/utils/crypt/EncryptablePropertyPlaceholderConfigurerTest.java
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,78 @@ | ||
| // | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
| // | ||
|
|
||
| package com.cloud.utils.crypt; | ||
|
|
||
| import org.junit.After; | ||
| import org.junit.Assert; | ||
| import org.junit.Before; | ||
| import org.junit.Test; | ||
|
|
||
| public class EncryptablePropertyPlaceholderConfigurerTest { | ||
|
|
||
| private static final String ENCRYPTED_VALUE = "ENC(iYVsCZXiGiC6SzZLMNBvBL93hoUpntxkuRjyaqC8L+JYKXw=)"; | ||
|
|
||
| private final EncryptablePropertyPlaceholderConfigurer configurer = new EncryptablePropertyPlaceholderConfigurer(); | ||
|
|
||
| @After | ||
| public void tearDown() { | ||
| EncryptionSecretKeyChecker.resetEncryptor(); | ||
| } | ||
|
|
||
| @Test | ||
| public void convertPropertyValueDecryptsWrappedValueWhenEncryptionEnabled() { | ||
| EncryptionSecretKeyChecker.initEncryptor("managementkey"); | ||
|
|
||
| String result = configurer.convertPropertyValue(ENCRYPTED_VALUE); | ||
|
|
||
| Assert.assertEquals("encthis", result); | ||
| } | ||
|
|
||
| @Test | ||
| public void convertPropertyValueTrimsSurroundingWhitespaceBeforeDecrypting() { | ||
| EncryptionSecretKeyChecker.initEncryptor("managementkey"); | ||
|
|
||
| String result = configurer.convertPropertyValue(" " + ENCRYPTED_VALUE + " "); | ||
|
|
||
| Assert.assertEquals("encthis", result); | ||
| } | ||
|
|
||
| @Test | ||
| public void convertPropertyValuePassesThroughWrappedValueWhenEncryptionNotConfigured() { | ||
| String result = configurer.convertPropertyValue(ENCRYPTED_VALUE); | ||
|
|
||
| Assert.assertEquals(ENCRYPTED_VALUE, result); | ||
| } | ||
|
|
||
| @Test | ||
| public void convertPropertyValuePassesThroughPlainValues() { | ||
| EncryptionSecretKeyChecker.initEncryptor("managementkey"); | ||
|
|
||
| String result = configurer.convertPropertyValue("guest"); | ||
|
|
||
| Assert.assertEquals("guest", result); | ||
| } | ||
|
|
||
| @Test | ||
| public void convertPropertyValueHandlesNull() { | ||
| EncryptionSecretKeyChecker.initEncryptor("managementkey"); | ||
|
|
||
| Assert.assertNull(configurer.convertPropertyValue(null)); | ||
| } | ||
| } |
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.
Uh oh!
There was an error while loading. Please reload this page.