[Feature] Add Support for encrypting config fields #278
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
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,36 @@ | ||
| /* | ||
| * 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 org.apache.seatunnel.app.config; | ||
|
|
||
| import org.springframework.boot.context.properties.ConfigurationProperties; | ||
| import org.springframework.context.annotation.Configuration; | ||
|
|
||
| import lombok.Data; | ||
|
|
||
| import java.util.HashSet; | ||
| import java.util.Set; | ||
|
|
||
| import static org.apache.seatunnel.app.common.Constants.ENCRYPTION_TYPE_NONE; | ||
|
|
||
| @Data | ||
| @Configuration | ||
| @ConfigurationProperties(prefix = "seatunnel-web.datasource.encryption") | ||
| public class EncryptionConfig { | ||
| private String type = ENCRYPTION_TYPE_NONE; | ||
| private Set<String> keysToEncrypt = new HashSet<>(); | ||
| } |
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,89 @@ | ||
| /* | ||
| * 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 org.apache.seatunnel.app.utils; | ||
|
|
||
| import org.apache.seatunnel.app.config.EncryptionConfig; | ||
| import org.apache.seatunnel.core.starter.utils.ConfigShadeUtils; | ||
| import org.apache.seatunnel.server.common.SeatunnelErrorEnum; | ||
| import org.apache.seatunnel.server.common.SeatunnelException; | ||
|
|
||
| import org.apache.commons.lang3.StringUtils; | ||
|
|
||
| import org.springframework.beans.factory.annotation.Autowired; | ||
| import org.springframework.stereotype.Component; | ||
|
|
||
| import lombok.extern.slf4j.Slf4j; | ||
|
|
||
| import java.util.Map; | ||
|
|
||
| import static org.apache.seatunnel.app.common.Constants.ENCRYPTION_TYPE_NONE; | ||
|
|
||
| @Slf4j | ||
| @Component | ||
| public class ConfigShadeUtil { | ||
|
|
||
| @Autowired private EncryptionConfig encryptionConfig; | ||
|
|
||
| public void encryptData(Map<String, String> datasourceConfig) { | ||
| if (encryptionConfig.getType().equals(ENCRYPTION_TYPE_NONE)) { | ||
| return; | ||
| } | ||
| for (String key : encryptionConfig.getKeysToEncrypt()) { | ||
| String value = datasourceConfig.get(key); | ||
| if (StringUtils.isNotEmpty(value)) { | ||
| try { | ||
| String processedValue = | ||
| ConfigShadeUtils.encryptOption(encryptionConfig.getType(), value); | ||
| datasourceConfig.replace(key, processedValue); | ||
| } catch (IllegalArgumentException ex) { | ||
| log.error("encryption for key {} failed", key); | ||
| throw new SeatunnelException( | ||
| SeatunnelErrorEnum.ERROR_CONFIG, | ||
| String.format( | ||
| "encryption failed for key: %s, check if the keys were persisted in expected format", | ||
| key), | ||
| ex); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public void decryptData(Map<String, String> datasourceConfig) { | ||
| if (encryptionConfig.getType().equals(ENCRYPTION_TYPE_NONE)) { | ||
| return; | ||
| } | ||
| for (String key : encryptionConfig.getKeysToEncrypt()) { | ||
| String value = datasourceConfig.get(key); | ||
| if (StringUtils.isNotEmpty(value)) { | ||
| try { | ||
| String processedValue = | ||
| ConfigShadeUtils.decryptOption(encryptionConfig.getType(), value); | ||
| datasourceConfig.replace(key, processedValue); | ||
| } catch (IllegalArgumentException ex) { | ||
| log.error("decryption for key {} failed", key); | ||
| throw new SeatunnelException( | ||
| SeatunnelErrorEnum.ERROR_CONFIG, | ||
| String.format( | ||
| "decryption failed for key: %s, check if the keys were persisted in expected format", | ||
| key), | ||
| ex); | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
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
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.
When encryption type is default it does not do any encoding/decoding. can we simply return from where when encoding is default.