-
Notifications
You must be signed in to change notification settings - Fork 288
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Feature] Add Support for encrypting config fields
While writing intermediate config to submit job via seatunnel client,
we are required to encrypt certain fields like password, auth, username
By Default no encryption would be done, to enable the encryption
provide the following properties
```
seatunnel-web:
datasource:
encryption:
type: your_encryption
keys-to-encrypt:
- password
- auth
```
ref: https://seatunnel.apache.org/docs/2.3.9/connector-v2/Config-Encryption-Decryption/
Co-authored-by: BilwaST <[email protected]>
Co-authored-by: Shashwat Tiwari <[email protected]>- Loading branch information
1 parent
20ac01b
commit a30d3d1
Showing
6 changed files
with
163 additions
and
3 deletions.
There are no files selected for viewing
36 changes: 36 additions & 0 deletions
36
...eatunnel-app/src/main/java/org/apache/seatunnel/app/config/SeatunnelEncryptionConfig.java
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.DEFAULT; | ||
|
|
||
| @Data | ||
| @Configuration | ||
| @ConfigurationProperties(prefix = "seatunnel-web.datasource.encryption") | ||
| public class SeatunnelEncryptionConfig { | ||
| private String type = DEFAULT; | ||
| 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
83 changes: 83 additions & 0 deletions
83
...el-server/seatunnel-app/src/main/java/org/apache/seatunnel/app/utils/ConfigShadeUtil.java
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,83 @@ | ||
| /* | ||
| * 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.SeatunnelEncryptionConfig; | ||
| 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; | ||
|
|
||
| @Slf4j | ||
| @Component | ||
| public class ConfigShadeUtil { | ||
|
|
||
| @Autowired private SeatunnelEncryptionConfig seatunnelEncryptionConfig; | ||
|
|
||
| public void encryptData(Map<String, String> datasourceConfig) { | ||
| for (String key : seatunnelEncryptionConfig.getKeysToEncrypt()) { | ||
| String value = datasourceConfig.get(key); | ||
| if (StringUtils.isNotEmpty(value)) { | ||
| try { | ||
| String processedValue = | ||
| ConfigShadeUtils.encryptOption( | ||
| seatunnelEncryptionConfig.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) { | ||
| for (String key : seatunnelEncryptionConfig.getKeysToEncrypt()) { | ||
| String value = datasourceConfig.get(key); | ||
| if (StringUtils.isNotEmpty(value)) { | ||
| try { | ||
| String processedValue = | ||
| ConfigShadeUtils.decryptOption( | ||
| seatunnelEncryptionConfig.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